~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Aaron Bentley
  • Date: 2005-07-26 14:06:11 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 982.
  • Revision ID: abentley@panoramicfeedback.com-20050726140611-403e366f3c79c1f1
Fixed python invocation

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
 
20
from osutils import pumpfile, appendpath, fingerprint_file
 
21
import os
22
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
 
23
from bzrlib.trace import mutter, note
 
24
from bzrlib.errors import BzrError
30
25
 
31
26
import bzrlib
32
27
 
33
 
class Tree:
 
28
exporters = {}
 
29
 
 
30
class Tree(object):
34
31
    """Abstract file tree.
35
32
 
36
33
    There are several subclasses:
59
56
    def has_id(self, file_id):
60
57
        return self.inventory.has_id(file_id)
61
58
 
62
 
    def id_set(self):
63
 
        """Return set of all ids in this tree."""
64
 
        return self.inventory.id_set()
 
59
    __contains__ = has_id
 
60
 
 
61
    def __iter__(self):
 
62
        return iter(self.inventory)
65
63
 
66
64
    def id2path(self, file_id):
67
65
        return self.inventory.id2path(file_id)
76
74
        fp = fingerprint_file(f)
77
75
        f.seek(0)
78
76
        
79
 
        if ie.text_size is not None:
 
77
        if ie.text_size != None:
80
78
            if ie.text_size != fp['size']:
81
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
79
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
82
80
                        ["inventory expects %d bytes" % ie.text_size,
83
81
                         "file is actually %d bytes" % fp['size'],
84
82
                         "store is probably damaged/corrupt"])
85
83
 
86
84
        if ie.text_sha1 != fp['sha1']:
87
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
85
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
88
86
                    ["inventory expects %s" % ie.text_sha1,
89
87
                     "file is actually %s" % fp['sha1'],
90
88
                     "store is probably damaged/corrupt"])
91
89
 
92
90
 
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
 
        
 
91
    def print_file(self, fileid):
 
92
        """Print file with id `fileid` to stdout."""
 
93
        import sys
 
94
        pumpfile(self.get_file(fileid), sys.stdout)
 
95
        
 
96
        
 
97
    def export(self, dest, format='dir', root=None):
 
98
        """Export this tree."""
 
99
        try:
 
100
            exporter = exporters[format]
 
101
        except KeyError:
 
102
            from bzrlib.errors import BzrCommandError
 
103
            raise BzrCommandError("export format %r not supported" % format)
 
104
        exporter(self, dest, root)
 
105
 
 
106
 
327
107
 
328
108
class RevisionTree(Tree):
329
109
    """Tree viewing a previous revision.
330
110
 
331
111
    File text can be retrieved from the text store.
332
112
 
333
 
    :todo: Some kind of `__repr__` method, but a good one
 
113
    TODO: Some kind of `__repr__` method, but a good one
334
114
           probably means knowing the branch and revision number,
335
115
           or at least passing a description to the constructor.
336
116
    """
363
143
 
364
144
 
365
145
class EmptyTree(Tree):
366
 
    def __init__(self):
367
 
        self._inventory = Inventory()
 
146
    def __init__(self, root_id):
 
147
        from bzrlib.inventory import Inventory
 
148
        self._inventory = Inventory(root_id)
368
149
 
369
150
    def has_filename(self, filename):
370
151
        return False
430
211
 
431
212
    
432
213
 
 
214
def find_renames(old_inv, new_inv):
 
215
    for file_id in old_inv:
 
216
        if file_id not in new_inv:
 
217
            continue
 
218
        old_name = old_inv.id2path(file_id)
 
219
        new_name = new_inv.id2path(file_id)
 
220
        if old_name != new_name:
 
221
            yield (old_name, new_name)
 
222
            
 
223
 
 
224
 
 
225
######################################################################
 
226
# export
 
227
 
 
228
def dir_exporter(tree, dest, root):
 
229
    """Export this tree to a new directory.
 
230
 
 
231
    `dest` should not exist, and will be created holding the
 
232
    contents of this tree.
 
233
 
 
234
    TODO: To handle subdirectories we need to create the
 
235
           directories first.
 
236
 
 
237
    :note: If the export fails, the destination directory will be
 
238
           left in a half-assed state.
 
239
    """
 
240
    import os
 
241
    os.mkdir(dest)
 
242
    mutter('export version %r' % tree)
 
243
    inv = tree.inventory
 
244
    for dp, ie in inv.iter_entries():
 
245
        kind = ie.kind
 
246
        fullpath = appendpath(dest, dp)
 
247
        if kind == 'directory':
 
248
            os.mkdir(fullpath)
 
249
        elif kind == 'file':
 
250
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
 
251
        else:
 
252
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
 
253
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
254
exporters['dir'] = dir_exporter
 
255
 
 
256
try:
 
257
    import tarfile
 
258
except ImportError:
 
259
    pass
 
260
else:
 
261
    def get_root_name(dest):
 
262
        """Get just the root name for a tarball.
 
263
 
 
264
        >>> get_root_name('mytar.tar')
 
265
        'mytar'
 
266
        >>> get_root_name('mytar.tar.bz2')
 
267
        'mytar'
 
268
        >>> get_root_name('tar.tar.tar.tgz')
 
269
        'tar.tar.tar'
 
270
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
271
        'bzr-0.0.5'
 
272
        >>> get_root_name('a/long/path/mytar.tgz')
 
273
        'mytar'
 
274
        >>> get_root_name('../parent/../dir/other.tbz2')
 
275
        'other'
 
276
        """
 
277
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
278
        dest = os.path.basename(dest)
 
279
        for end in endings:
 
280
            if dest.endswith(end):
 
281
                return dest[:-len(end)]
 
282
 
 
283
    def tar_exporter(tree, dest, root, compression=None):
 
284
        """Export this tree to a new tar file.
 
285
 
 
286
        `dest` will be created holding the contents of this tree; if it
 
287
        already exists, it will be clobbered, like with "tar -c".
 
288
        """
 
289
        from time import time
 
290
        now = time()
 
291
        compression = str(compression or '')
 
292
        if root is None:
 
293
            root = get_root_name(dest)
 
294
        try:
 
295
            ball = tarfile.open(dest, 'w:' + compression)
 
296
        except tarfile.CompressionError, e:
 
297
            raise BzrError(str(e))
 
298
        mutter('export version %r' % tree)
 
299
        inv = tree.inventory
 
300
        for dp, ie in inv.iter_entries():
 
301
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
302
            item = tarfile.TarInfo(os.path.join(root, dp))
 
303
            # TODO: would be cool to actually set it to the timestamp of the
 
304
            # revision it was last changed
 
305
            item.mtime = now
 
306
            if ie.kind == 'directory':
 
307
                item.type = tarfile.DIRTYPE
 
308
                fileobj = None
 
309
                item.name += '/'
 
310
                item.size = 0
 
311
                item.mode = 0755
 
312
            elif ie.kind == 'file':
 
313
                item.type = tarfile.REGTYPE
 
314
                fileobj = tree.get_file(ie.file_id)
 
315
                item.size = _find_file_size(fileobj)
 
316
                item.mode = 0644
 
317
            else:
 
318
                raise BzrError("don't know how to export {%s} of kind %r" %
 
319
                        (ie.file_id, ie.kind))
 
320
 
 
321
            ball.addfile(item, fileobj)
 
322
        ball.close()
 
323
    exporters['tar'] = tar_exporter
 
324
 
 
325
    def tgz_exporter(tree, dest, root):
 
326
        tar_exporter(tree, dest, root, compression='gz')
 
327
    exporters['tgz'] = tgz_exporter
 
328
 
 
329
    def tbz_exporter(tree, dest, root):
 
330
        tar_exporter(tree, dest, root, compression='bz2')
 
331
    exporters['tbz2'] = tbz_exporter
 
332
 
 
333
 
 
334
def _find_file_size(fileobj):
 
335
    offset = fileobj.tell()
 
336
    try:
 
337
        fileobj.seek(0, 2)
 
338
        size = fileobj.tell()
 
339
    except TypeError:
 
340
        # gzip doesn't accept second argument to seek()
 
341
        fileobj.seek(0)
 
342
        size = 0
 
343
        while True:
 
344
            nread = len(fileobj.read())
 
345
            if nread == 0:
 
346
                break
 
347
            size += nread
 
348
    fileobj.seek(offset)
 
349
    return size