~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-29 03:02:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050329030234-533d2aff52d93eee
- new 'ignored' command

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 osutils import pumpfile, appendpath, fingerprint_file
21
 
import os
 
20
from sets import Set
 
21
import os.path, os, fnmatch
22
22
 
23
 
from bzrlib.trace import mutter, note
24
 
from bzrlib.errors import BzrError
 
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
25
30
 
26
31
import bzrlib
27
32
 
28
 
exporters = {}
29
 
 
30
 
class Tree(object):
 
33
class Tree:
31
34
    """Abstract file tree.
32
35
 
33
36
    There are several subclasses:
56
59
    def has_id(self, file_id):
57
60
        return self.inventory.has_id(file_id)
58
61
 
59
 
    __contains__ = has_id
60
 
 
61
 
    def __iter__(self):
62
 
        return iter(self.inventory)
 
62
    def id_set(self):
 
63
        """Return set of all ids in this tree."""
 
64
        return self.inventory.id_set()
63
65
 
64
66
    def id2path(self, file_id):
65
67
        return self.inventory.id2path(file_id)
66
68
 
67
69
    def _get_inventory(self):
68
70
        return self._inventory
69
 
    
70
 
    def get_file_by_path(self, path):
71
 
        return self.get_file(self._inventory.path2id(path))
72
71
 
73
72
    inventory = property(_get_inventory,
74
73
                         doc="Inventory of this Tree")
77
76
        fp = fingerprint_file(f)
78
77
        f.seek(0)
79
78
        
80
 
        if ie.text_size != None:
 
79
        if ie.text_size is not None:
81
80
            if ie.text_size != fp['size']:
82
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
81
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
83
82
                        ["inventory expects %d bytes" % ie.text_size,
84
83
                         "file is actually %d bytes" % fp['size'],
85
84
                         "store is probably damaged/corrupt"])
86
85
 
87
86
        if ie.text_sha1 != fp['sha1']:
88
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
87
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
89
88
                    ["inventory expects %s" % ie.text_sha1,
90
89
                     "file is actually %s" % fp['sha1'],
91
90
                     "store is probably damaged/corrupt"])
92
91
 
93
92
 
94
 
    def print_file(self, fileid):
95
 
        """Print file with id `fileid` to stdout."""
96
 
        import sys
97
 
        pumpfile(self.get_file(fileid), sys.stdout)
98
 
        
99
 
        
100
 
    def export(self, dest, format='dir', root=None):
101
 
        """Export this tree."""
102
 
        try:
103
 
            exporter = exporters[format]
104
 
        except KeyError:
105
 
            from bzrlib.errors import BzrCommandError
106
 
            raise BzrCommandError("export format %r not supported" % format)
107
 
        exporter(self, dest, root)
108
 
 
109
 
 
 
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 file_kind(self, filename):
 
178
        if isfile(self.abspath(filename)):
 
179
            return 'file'
 
180
        elif isdir(self.abspath(filename)):
 
181
            return 'directory'
 
182
        else:
 
183
            return 'unknown'
 
184
 
 
185
 
 
186
    def list_files(self):
 
187
        """Recursively list all files as (path, class, kind, id).
 
188
 
 
189
        Lists, but does not descend into unversioned directories.
 
190
 
 
191
        This does not include files that have been deleted in this
 
192
        tree.
 
193
 
 
194
        Skips the control directory.
 
195
        """
 
196
        inv = self.inventory
 
197
 
 
198
        def descend(from_dir, from_dir_id, dp):
 
199
            ls = os.listdir(dp)
 
200
            ls.sort()
 
201
            for f in ls:
 
202
                if bzrlib.BZRDIR == f:
 
203
                    continue
 
204
 
 
205
                # path within tree
 
206
                fp = appendpath(from_dir, f)
 
207
 
 
208
                # absolute path
 
209
                fap = appendpath(dp, f)
 
210
                
 
211
                f_ie = inv.get_child(from_dir_id, f)
 
212
                if f_ie:
 
213
                    c = 'V'
 
214
                elif self.is_ignored(fp):
 
215
                    c = 'I'
 
216
                else:
 
217
                    c = '?'
 
218
 
 
219
                fk = file_kind(fap)
 
220
 
 
221
                if f_ie:
 
222
                    if f_ie.kind != fk:
 
223
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
224
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
225
 
 
226
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
227
 
 
228
                if fk != 'directory':
 
229
                    continue
 
230
 
 
231
                if c != 'V':
 
232
                    # don't descend unversioned directories
 
233
                    continue
 
234
                
 
235
                for ff in descend(fp, f_ie.file_id, fap):
 
236
                    yield ff
 
237
 
 
238
        for f in descend('', None, self.basedir):
 
239
            yield f
 
240
            
 
241
 
 
242
 
 
243
    def unknowns(self, path='', dir_id=None):
 
244
        """Yield names of 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
        for fpath, fclass, fkind, fid in self.list_files():
 
253
            if fclass == '?':
 
254
                yield fpath
 
255
                
 
256
 
 
257
    def ignored_files(self):
 
258
        for fpath, fclass, fkind, fid in self.list_files():
 
259
            if fclass == 'I':
 
260
                yield fpath
 
261
 
 
262
 
 
263
    def get_ignore_list(self):
 
264
        """Return list of ignore patterns.
 
265
 
 
266
        Cached in the Tree object after the first call.
 
267
        """
 
268
        if hasattr(self, '_ignorelist'):
 
269
            return self._ignorelist
 
270
 
 
271
        l = bzrlib.DEFAULT_IGNORE[:]
 
272
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
273
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
274
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
275
        self._ignorelist = l
 
276
        return l
 
277
 
 
278
 
 
279
    def is_ignored(self, filename):
 
280
        """Check whether the filename matches an ignore pattern.
 
281
 
 
282
        Patterns containing '/' need to match the whole path; others
 
283
        match against only the last component.
 
284
 
 
285
        If the file is ignored, returns the pattern which caused it to
 
286
        be ignored, otherwise None.  So this can simply be used as a
 
287
        boolean if desired."""
 
288
 
 
289
        ## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
 
290
        
 
291
        for pat in self.get_ignore_list():
 
292
            if '/' in pat:
 
293
                if fnmatch.fnmatchcase(filename, pat):
 
294
                    return pat
 
295
            else:
 
296
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
297
                    return pat
 
298
        return None
 
299
        
 
300
 
 
301
        
 
302
        
110
303
 
111
304
class RevisionTree(Tree):
112
305
    """Tree viewing a previous revision.
113
306
 
114
307
    File text can be retrieved from the text store.
115
308
 
116
 
    TODO: Some kind of `__repr__` method, but a good one
 
309
    :todo: Some kind of `__repr__` method, but a good one
117
310
           probably means knowing the branch and revision number,
118
311
           or at least passing a description to the constructor.
119
312
    """
146
339
 
147
340
 
148
341
class EmptyTree(Tree):
149
 
    def __init__(self, root_id):
150
 
        from bzrlib.inventory import Inventory
151
 
        self._inventory = Inventory(root_id)
 
342
    def __init__(self):
 
343
        self._inventory = Inventory()
152
344
 
153
345
    def has_filename(self, filename):
154
346
        return False
214
406
 
215
407
    
216
408
 
217
 
def find_renames(old_inv, new_inv):
218
 
    for file_id in old_inv:
219
 
        if file_id not in new_inv:
220
 
            continue
221
 
        old_name = old_inv.id2path(file_id)
222
 
        new_name = new_inv.id2path(file_id)
223
 
        if old_name != new_name:
224
 
            yield (old_name, new_name)
225
 
            
226
 
 
227
 
 
228
 
######################################################################
229
 
# export
230
 
 
231
 
def dir_exporter(tree, dest, root):
232
 
    """Export this tree to a new directory.
233
 
 
234
 
    `dest` should not exist, and will be created holding the
235
 
    contents of this tree.
236
 
 
237
 
    TODO: To handle subdirectories we need to create the
238
 
           directories first.
239
 
 
240
 
    :note: If the export fails, the destination directory will be
241
 
           left in a half-assed state.
242
 
    """
243
 
    import os
244
 
    os.mkdir(dest)
245
 
    mutter('export version %r' % tree)
246
 
    inv = tree.inventory
247
 
    for dp, ie in inv.iter_entries():
248
 
        kind = ie.kind
249
 
        fullpath = appendpath(dest, dp)
250
 
        if kind == 'directory':
251
 
            os.mkdir(fullpath)
252
 
        elif kind == 'file':
253
 
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
254
 
        else:
255
 
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
256
 
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
257
 
exporters['dir'] = dir_exporter
258
 
 
259
 
try:
260
 
    import tarfile
261
 
except ImportError:
262
 
    pass
263
 
else:
264
 
    def get_root_name(dest):
265
 
        """Get just the root name for a tarball.
266
 
 
267
 
        >>> get_root_name('mytar.tar')
268
 
        'mytar'
269
 
        >>> get_root_name('mytar.tar.bz2')
270
 
        'mytar'
271
 
        >>> get_root_name('tar.tar.tar.tgz')
272
 
        'tar.tar.tar'
273
 
        >>> get_root_name('bzr-0.0.5.tar.gz')
274
 
        'bzr-0.0.5'
275
 
        >>> get_root_name('a/long/path/mytar.tgz')
276
 
        'mytar'
277
 
        >>> get_root_name('../parent/../dir/other.tbz2')
278
 
        'other'
279
 
        """
280
 
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
281
 
        dest = os.path.basename(dest)
282
 
        for end in endings:
283
 
            if dest.endswith(end):
284
 
                return dest[:-len(end)]
285
 
 
286
 
    def tar_exporter(tree, dest, root, compression=None):
287
 
        """Export this tree to a new tar file.
288
 
 
289
 
        `dest` will be created holding the contents of this tree; if it
290
 
        already exists, it will be clobbered, like with "tar -c".
291
 
        """
292
 
        from time import time
293
 
        now = time()
294
 
        compression = str(compression or '')
295
 
        if root is None:
296
 
            root = get_root_name(dest)
297
 
        try:
298
 
            ball = tarfile.open(dest, 'w:' + compression)
299
 
        except tarfile.CompressionError, e:
300
 
            raise BzrError(str(e))
301
 
        mutter('export version %r' % tree)
302
 
        inv = tree.inventory
303
 
        for dp, ie in inv.iter_entries():
304
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
305
 
            item = tarfile.TarInfo(os.path.join(root, dp))
306
 
            # TODO: would be cool to actually set it to the timestamp of the
307
 
            # revision it was last changed
308
 
            item.mtime = now
309
 
            if ie.kind == 'directory':
310
 
                item.type = tarfile.DIRTYPE
311
 
                fileobj = None
312
 
                item.name += '/'
313
 
                item.size = 0
314
 
                item.mode = 0755
315
 
            elif ie.kind == 'file':
316
 
                item.type = tarfile.REGTYPE
317
 
                fileobj = tree.get_file(ie.file_id)
318
 
                item.size = _find_file_size(fileobj)
319
 
                item.mode = 0644
320
 
            else:
321
 
                raise BzrError("don't know how to export {%s} of kind %r" %
322
 
                        (ie.file_id, ie.kind))
323
 
 
324
 
            ball.addfile(item, fileobj)
325
 
        ball.close()
326
 
    exporters['tar'] = tar_exporter
327
 
 
328
 
    def tgz_exporter(tree, dest, root):
329
 
        tar_exporter(tree, dest, root, compression='gz')
330
 
    exporters['tgz'] = tgz_exporter
331
 
 
332
 
    def tbz_exporter(tree, dest, root):
333
 
        tar_exporter(tree, dest, root, compression='bz2')
334
 
    exporters['tbz2'] = tbz_exporter
335
 
 
336
 
 
337
 
def _find_file_size(fileobj):
338
 
    offset = fileobj.tell()
339
 
    try:
340
 
        fileobj.seek(0, 2)
341
 
        size = fileobj.tell()
342
 
    except TypeError:
343
 
        # gzip doesn't accept second argument to seek()
344
 
        fileobj.seek(0)
345
 
        size = 0
346
 
        while True:
347
 
            nread = len(fileobj.read())
348
 
            if nread == 0:
349
 
                break
350
 
            size += nread
351
 
    fileobj.seek(offset)
352
 
    return size