~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-08-22 17:52:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050822175211-90caf03af7d0cf07
- fix bug where bzr upgrade aborts when trying to fix trees that mention revisions
  which are not locally present

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from sets import Set
21
 
import os.path, os, fnmatch
22
 
 
23
 
from inventory import Inventory
24
 
from trace import mutter, note
25
 
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
26
 
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
27
 
from errors import bailout
28
 
import branch
29
 
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
 
20
import os
30
21
 
31
22
import bzrlib
32
 
 
33
 
class Tree:
 
23
from bzrlib.trace import mutter, note
 
24
from bzrlib.errors import BzrError
 
25
from bzrlib.inventory import Inventory
 
26
from bzrlib.osutils import pumpfile, appendpath, fingerprint_file
 
27
 
 
28
 
 
29
exporters = {}
 
30
 
 
31
class Tree(object):
34
32
    """Abstract file tree.
35
33
 
36
34
    There are several subclasses:
59
57
    def has_id(self, file_id):
60
58
        return self.inventory.has_id(file_id)
61
59
 
62
 
    def id_set(self):
63
 
        """Return set of all ids in this tree."""
64
 
        return self.inventory.id_set()
 
60
    __contains__ = has_id
 
61
 
 
62
    def __iter__(self):
 
63
        return iter(self.inventory)
65
64
 
66
65
    def id2path(self, file_id):
67
66
        return self.inventory.id2path(file_id)
68
67
 
69
68
    def _get_inventory(self):
70
69
        return self._inventory
 
70
    
 
71
    def get_file_by_path(self, path):
 
72
        return self.get_file(self._inventory.path2id(path))
71
73
 
72
74
    inventory = property(_get_inventory,
73
75
                         doc="Inventory of this Tree")
76
78
        fp = fingerprint_file(f)
77
79
        f.seek(0)
78
80
        
79
 
        if ie.text_size is not None:
 
81
        if ie.text_size != None:
80
82
            if ie.text_size != fp['size']:
81
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
83
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
82
84
                        ["inventory expects %d bytes" % ie.text_size,
83
85
                         "file is actually %d bytes" % fp['size'],
84
86
                         "store is probably damaged/corrupt"])
85
87
 
86
88
        if ie.text_sha1 != fp['sha1']:
87
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
89
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
88
90
                    ["inventory expects %s" % ie.text_sha1,
89
91
                     "file is actually %s" % fp['sha1'],
90
92
                     "store is probably damaged/corrupt"])
91
93
 
92
94
 
93
 
    def export(self, dest):
94
 
        """Export this tree to a new directory.
95
 
 
96
 
        `dest` should not exist, and will be created holding the
97
 
        contents of this tree.
98
 
 
99
 
        :todo: To handle subdirectories we need to create the
100
 
               directories first.
101
 
 
102
 
        :note: If the export fails, the destination directory will be
103
 
               left in a half-assed state.
104
 
        """
105
 
        os.mkdir(dest)
106
 
        mutter('export version %r' % self)
107
 
        inv = self.inventory
108
 
        for dp, ie in inv.iter_entries():
109
 
            kind = ie.kind
110
 
            fullpath = appendpath(dest, dp)
111
 
            if kind == 'directory':
112
 
                os.mkdir(fullpath)
113
 
            elif kind == 'file':
114
 
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
115
 
            else:
116
 
                bailout("don't know how to export {%s} of kind %r", fid, kind)
117
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
118
 
 
119
 
 
120
 
 
121
 
class WorkingTree(Tree):
122
 
    """Working copy tree.
123
 
 
124
 
    The inventory is held in the `Branch` working-inventory, and the
125
 
    files are in a directory on disk.
126
 
 
127
 
    It is possible for a `WorkingTree` to have a filename which is
128
 
    not listed in the Inventory and vice versa.
129
 
    """
130
 
    def __init__(self, basedir, inv):
131
 
        self._inventory = inv
132
 
        self.basedir = basedir
133
 
        self.path2id = inv.path2id
134
 
 
135
 
    def __repr__(self):
136
 
        return "<%s of %s>" % (self.__class__.__name__,
137
 
                               self.basedir)
138
 
 
139
 
    def abspath(self, filename):
140
 
        return os.path.join(self.basedir, filename)
141
 
 
142
 
    def has_filename(self, filename):
143
 
        return os.path.exists(self.abspath(filename))
144
 
 
145
 
    def get_file(self, file_id):
146
 
        return self.get_file_byname(self.id2path(file_id))
147
 
 
148
 
    def get_file_byname(self, filename):
149
 
        return file(self.abspath(filename), 'rb')
150
 
 
151
 
    def _get_store_filename(self, file_id):
152
 
        return self.abspath(self.id2path(file_id))
153
 
 
154
 
    def has_id(self, file_id):
155
 
        # files that have been deleted are excluded
156
 
        if not self.inventory.has_id(file_id):
157
 
            return False
158
 
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
159
 
 
160
 
    def get_file_size(self, file_id):
161
 
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
162
 
 
163
 
    def get_file_sha1(self, file_id):
164
 
        f = self.get_file(file_id)
165
 
        return sha_file(f)
166
 
 
167
 
 
168
 
    def file_class(self, filename):
169
 
        if self.path2id(filename):
170
 
            return 'V'
171
 
        elif self.is_ignored(filename):
172
 
            return 'I'
173
 
        else:
174
 
            return '?'
175
 
 
176
 
 
177
 
    def list_files(self):
178
 
        """Recursively list all files as (path, class, kind, id).
179
 
 
180
 
        Lists, but does not descend into unversioned directories.
181
 
 
182
 
        This does not include files that have been deleted in this
183
 
        tree.
184
 
 
185
 
        Skips the control directory.
186
 
        """
187
 
        inv = self.inventory
188
 
 
189
 
        def descend(from_dir, from_dir_id, dp):
190
 
            ls = os.listdir(dp)
191
 
            ls.sort()
192
 
            for f in ls:
193
 
                ## TODO: If we find a subdirectory with its own .bzr
194
 
                ## directory, then that is a separate tree and we
195
 
                ## should exclude it.
196
 
                if bzrlib.BZRDIR == f:
197
 
                    continue
198
 
 
199
 
                # path within tree
200
 
                fp = appendpath(from_dir, f)
201
 
 
202
 
                # absolute path
203
 
                fap = appendpath(dp, f)
204
 
                
205
 
                f_ie = inv.get_child(from_dir_id, f)
206
 
                if f_ie:
207
 
                    c = 'V'
208
 
                elif self.is_ignored(fp):
209
 
                    c = 'I'
210
 
                else:
211
 
                    c = '?'
212
 
 
213
 
                fk = file_kind(fap)
214
 
 
215
 
                if f_ie:
216
 
                    if f_ie.kind != fk:
217
 
                        bailout("file %r entered as kind %r id %r, now of kind %r"
218
 
                                % (fap, f_ie.kind, f_ie.file_id, fk))
219
 
 
220
 
                yield fp, c, fk, (f_ie and f_ie.file_id)
221
 
 
222
 
                if fk != 'directory':
223
 
                    continue
224
 
 
225
 
                if c != 'V':
226
 
                    # don't descend unversioned directories
227
 
                    continue
228
 
                
229
 
                for ff in descend(fp, f_ie.file_id, fap):
230
 
                    yield ff
231
 
 
232
 
        for f in descend('', None, self.basedir):
233
 
            yield f
234
 
            
235
 
 
236
 
 
237
 
    def unknowns(self):
238
 
        for subp in self.extras():
239
 
            if not self.is_ignored(subp):
240
 
                yield subp
241
 
 
242
 
 
243
 
    def extras(self):
244
 
        """Yield all unknown files in this WorkingTree.
245
 
 
246
 
        If there are any unknown directories then only the directory is
247
 
        returned, not all its children.  But if there are unknown files
248
 
        under a versioned subdirectory, they are returned.
249
 
 
250
 
        Currently returned depth-first, sorted by name within directories.
251
 
        """
252
 
        ## TODO: Work from given directory downwards
253
 
        
254
 
        for path, dir_entry in self.inventory.directories():
255
 
            mutter("search for unknowns in %r" % path)
256
 
            dirabs = self.abspath(path)
257
 
            if not isdir(dirabs):
258
 
                # e.g. directory deleted
259
 
                continue
260
 
 
261
 
            fl = []
262
 
            for subf in os.listdir(dirabs):
263
 
                if (subf != '.bzr'
264
 
                    and (subf not in dir_entry.children)):
265
 
                    fl.append(subf)
266
 
            
267
 
            fl.sort()
268
 
            for subf in fl:
269
 
                subp = appendpath(path, subf)
270
 
                yield subp
271
 
                
272
 
 
273
 
    def ignored_files(self):
274
 
        """Yield list of PATH, IGNORE_PATTERN"""
275
 
        for subp in self.extras():
276
 
            pat = self.is_ignored(subp)
277
 
            if pat != None:
278
 
                yield subp, pat
279
 
 
280
 
 
281
 
    def get_ignore_list(self):
282
 
        """Return list of ignore patterns.
283
 
 
284
 
        Cached in the Tree object after the first call.
285
 
        """
286
 
        if hasattr(self, '_ignorelist'):
287
 
            return self._ignorelist
288
 
 
289
 
        l = bzrlib.DEFAULT_IGNORE[:]
290
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
291
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
292
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
293
 
        self._ignorelist = l
294
 
        return l
295
 
 
296
 
 
297
 
    def is_ignored(self, filename):
298
 
        """Check whether the filename matches an ignore pattern.
299
 
 
300
 
        Patterns containing '/' need to match the whole path; others
301
 
        match against only the last component.
302
 
 
303
 
        If the file is ignored, returns the pattern which caused it to
304
 
        be ignored, otherwise None.  So this can simply be used as a
305
 
        boolean if desired."""
306
 
 
307
 
        ## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
308
 
        
309
 
        for pat in self.get_ignore_list():
310
 
            if '/' in pat:
311
 
                # as a special case, you can put ./ at the start of a pattern;
312
 
                # this is good to match in the top-level only;
313
 
                if pat[:2] == './':
314
 
                    newpat = pat[2:]
315
 
                else:
316
 
                    newpat = pat
317
 
                if fnmatch.fnmatchcase(filename, newpat):
318
 
                    return pat
319
 
            else:
320
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
321
 
                    return pat
322
 
        return None
323
 
        
324
 
 
325
 
        
326
 
        
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
 
97
        import sys
 
98
        pumpfile(self.get_file(fileid), sys.stdout)
 
99
        
 
100
        
 
101
    def export(self, dest, format='dir', root=None):
 
102
        """Export this tree."""
 
103
        try:
 
104
            exporter = exporters[format]
 
105
        except KeyError:
 
106
            from bzrlib.errors import BzrCommandError
 
107
            raise BzrCommandError("export format %r not supported" % format)
 
108
        exporter(self, dest, root)
 
109
 
 
110
 
327
111
 
328
112
class RevisionTree(Tree):
329
113
    """Tree viewing a previous revision.
330
114
 
331
115
    File text can be retrieved from the text store.
332
116
 
333
 
    :todo: Some kind of `__repr__` method, but a good one
 
117
    TODO: Some kind of `__repr__` method, but a good one
334
118
           probably means knowing the branch and revision number,
335
119
           or at least passing a description to the constructor.
336
120
    """
351
135
 
352
136
    def get_file_sha1(self, file_id):
353
137
        ie = self._inventory[file_id]
354
 
        return ie.text_sha1
 
138
        if ie.kind == "file":
 
139
            return ie.text_sha1
355
140
 
356
141
    def has_filename(self, filename):
357
142
        return bool(self.inventory.path2id(filename))
373
158
        if False:  # just to make it a generator
374
159
            yield None
375
160
    
 
161
    def __contains__(self, file_id):
 
162
        return file_id in self._inventory
 
163
 
 
164
    def get_file_sha1(self, file_id):
 
165
        assert self._inventory[file_id].kind == "root_directory"
 
166
        return None
 
167
 
 
168
 
376
169
 
377
170
 
378
171
######################################################################
430
223
 
431
224
    
432
225
 
 
226
def find_renames(old_inv, new_inv):
 
227
    for file_id in old_inv:
 
228
        if file_id not in new_inv:
 
229
            continue
 
230
        old_name = old_inv.id2path(file_id)
 
231
        new_name = new_inv.id2path(file_id)
 
232
        if old_name != new_name:
 
233
            yield (old_name, new_name)
 
234
            
 
235
 
 
236
 
 
237
######################################################################
 
238
# export
 
239
 
 
240
def dir_exporter(tree, dest, root):
 
241
    """Export this tree to a new directory.
 
242
 
 
243
    `dest` should not exist, and will be created holding the
 
244
    contents of this tree.
 
245
 
 
246
    TODO: To handle subdirectories we need to create the
 
247
           directories first.
 
248
 
 
249
    :note: If the export fails, the destination directory will be
 
250
           left in a half-assed state.
 
251
    """
 
252
    import os
 
253
    os.mkdir(dest)
 
254
    mutter('export version %r' % tree)
 
255
    inv = tree.inventory
 
256
    for dp, ie in inv.iter_entries():
 
257
        kind = ie.kind
 
258
        fullpath = appendpath(dest, dp)
 
259
        if kind == 'directory':
 
260
            os.mkdir(fullpath)
 
261
        elif kind == 'file':
 
262
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
 
263
        else:
 
264
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
265
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
266
exporters['dir'] = dir_exporter
 
267
 
 
268
try:
 
269
    import tarfile
 
270
except ImportError:
 
271
    pass
 
272
else:
 
273
    def get_root_name(dest):
 
274
        """Get just the root name for a tarball.
 
275
 
 
276
        >>> get_root_name('mytar.tar')
 
277
        'mytar'
 
278
        >>> get_root_name('mytar.tar.bz2')
 
279
        'mytar'
 
280
        >>> get_root_name('tar.tar.tar.tgz')
 
281
        'tar.tar.tar'
 
282
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
283
        'bzr-0.0.5'
 
284
        >>> get_root_name('a/long/path/mytar.tgz')
 
285
        'mytar'
 
286
        >>> get_root_name('../parent/../dir/other.tbz2')
 
287
        'other'
 
288
        """
 
289
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
290
        dest = os.path.basename(dest)
 
291
        for end in endings:
 
292
            if dest.endswith(end):
 
293
                return dest[:-len(end)]
 
294
 
 
295
    def tar_exporter(tree, dest, root, compression=None):
 
296
        """Export this tree to a new tar file.
 
297
 
 
298
        `dest` will be created holding the contents of this tree; if it
 
299
        already exists, it will be clobbered, like with "tar -c".
 
300
        """
 
301
        from time import time
 
302
        now = time()
 
303
        compression = str(compression or '')
 
304
        if root is None:
 
305
            root = get_root_name(dest)
 
306
        try:
 
307
            ball = tarfile.open(dest, 'w:' + compression)
 
308
        except tarfile.CompressionError, e:
 
309
            raise BzrError(str(e))
 
310
        mutter('export version %r' % tree)
 
311
        inv = tree.inventory
 
312
        for dp, ie in inv.iter_entries():
 
313
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
314
            item = tarfile.TarInfo(os.path.join(root, dp))
 
315
            # TODO: would be cool to actually set it to the timestamp of the
 
316
            # revision it was last changed
 
317
            item.mtime = now
 
318
            if ie.kind == 'directory':
 
319
                item.type = tarfile.DIRTYPE
 
320
                fileobj = None
 
321
                item.name += '/'
 
322
                item.size = 0
 
323
                item.mode = 0755
 
324
            elif ie.kind == 'file':
 
325
                item.type = tarfile.REGTYPE
 
326
                fileobj = tree.get_file(ie.file_id)
 
327
                item.size = _find_file_size(fileobj)
 
328
                item.mode = 0644
 
329
            else:
 
330
                raise BzrError("don't know how to export {%s} of kind %r" %
 
331
                        (ie.file_id, ie.kind))
 
332
 
 
333
            ball.addfile(item, fileobj)
 
334
        ball.close()
 
335
    exporters['tar'] = tar_exporter
 
336
 
 
337
    def tgz_exporter(tree, dest, root):
 
338
        tar_exporter(tree, dest, root, compression='gz')
 
339
    exporters['tgz'] = tgz_exporter
 
340
 
 
341
    def tbz_exporter(tree, dest, root):
 
342
        tar_exporter(tree, dest, root, compression='bz2')
 
343
    exporters['tbz2'] = tbz_exporter
 
344
 
 
345
 
 
346
def _find_file_size(fileobj):
 
347
    offset = fileobj.tell()
 
348
    try:
 
349
        fileobj.seek(0, 2)
 
350
        size = fileobj.tell()
 
351
    except TypeError:
 
352
        # gzip doesn't accept second argument to seek()
 
353
        fileobj.seek(0)
 
354
        size = 0
 
355
        while True:
 
356
            nread = len(fileobj.read())
 
357
            if nread == 0:
 
358
                break
 
359
            size += nread
 
360
    fileobj.seek(offset)
 
361
    return size