~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-26 03:03:28 UTC
  • Revision ID: mbp@sourcefrog.net-20050326030328-350bb37fb45b5eb4
- update release notes

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
 
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)
71
73
                         doc="Inventory of this Tree")
72
74
 
73
75
    def _check_retrieved(self, ie, f):
74
 
        fp = fingerprint_file(f)
75
 
        f.seek(0)
76
 
        
77
 
        if ie.text_size != None:
78
 
            if ie.text_size != fp['size']:
79
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
76
        # TODO: Test this check by damaging the store?
 
77
        if ie.text_size is not None:
 
78
            fs = filesize(f)
 
79
            if fs != ie.text_size:
 
80
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
80
81
                        ["inventory expects %d bytes" % ie.text_size,
81
 
                         "file is actually %d bytes" % fp['size'],
 
82
                         "file is actually %d bytes" % fs,
82
83
                         "store is probably damaged/corrupt"])
83
84
 
84
 
        if ie.text_sha1 != fp['sha1']:
85
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
85
        f_hash = sha_file(f)
 
86
        f.seek(0)
 
87
        if ie.text_sha1 != f_hash:
 
88
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
86
89
                    ["inventory expects %s" % ie.text_sha1,
87
 
                     "file is actually %s" % fp['sha1'],
 
90
                     "file is actually %s" % f_hash,
88
91
                     "store is probably damaged/corrupt"])
89
92
 
90
93
 
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
 
 
 
94
    def export(self, dest):
 
95
        """Export this tree to a new directory.
 
96
 
 
97
        `dest` should not exist, and will be created holding the
 
98
        contents of this tree.
 
99
 
 
100
        :todo: To handle subdirectories we need to create the
 
101
               directories first.
 
102
 
 
103
        :note: If the export fails, the destination directory will be
 
104
               left in a half-assed state.
 
105
        """
 
106
        os.mkdir(dest)
 
107
        mutter('export version %r' % self)
 
108
        inv = self.inventory
 
109
        for dp, ie in inv.iter_entries():
 
110
            kind = ie.kind
 
111
            fullpath = appendpath(dest, dp)
 
112
            if kind == 'directory':
 
113
                os.mkdir(fullpath)
 
114
            elif kind == 'file':
 
115
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
 
116
            else:
 
117
                bailout("don't know how to export {%s} of kind %r", fid, kind)
 
118
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
119
 
 
120
 
 
121
 
 
122
class WorkingTree(Tree):
 
123
    """Working copy tree.
 
124
 
 
125
    The inventory is held in the `Branch` working-inventory, and the
 
126
    files are in a directory on disk.
 
127
 
 
128
    It is possible for a `WorkingTree` to have a filename which is
 
129
    not listed in the Inventory and vice versa.
 
130
    """
 
131
    def __init__(self, basedir, inv):
 
132
        self._inventory = inv
 
133
        self.basedir = basedir
 
134
        self.path2id = inv.path2id
 
135
 
 
136
    def __repr__(self):
 
137
        return "<%s of %s>" % (self.__class__.__name__,
 
138
                               self.basedir)
 
139
 
 
140
    def abspath(self, filename):
 
141
        return os.path.join(self.basedir, filename)
 
142
 
 
143
    def has_filename(self, filename):
 
144
        return os.path.exists(self.abspath(filename))
 
145
 
 
146
    def get_file(self, file_id):
 
147
        return self.get_file_byname(self.id2path(file_id))
 
148
 
 
149
    def get_file_byname(self, filename):
 
150
        return file(self.abspath(filename), 'rb')
 
151
 
 
152
    def _get_store_filename(self, file_id):
 
153
        return self.abspath(self.id2path(file_id))
 
154
 
 
155
    def has_id(self, file_id):
 
156
        # files that have been deleted are excluded
 
157
        if not self.inventory.has_id(file_id):
 
158
            return False
 
159
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
 
160
 
 
161
    def get_file_size(self, file_id):
 
162
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
163
 
 
164
    def get_file_sha1(self, file_id):
 
165
        f = self.get_file(file_id)
 
166
        return sha_file(f)
 
167
 
 
168
 
 
169
    def file_class(self, filename):
 
170
        if self.path2id(filename):
 
171
            return 'V'
 
172
        elif self.is_ignored(filename):
 
173
            return 'I'
 
174
        else:
 
175
            return '?'
 
176
 
 
177
 
 
178
    def file_kind(self, filename):
 
179
        if isfile(self.abspath(filename)):
 
180
            return 'file'
 
181
        elif isdir(self.abspath(filename)):
 
182
            return 'directory'
 
183
        else:
 
184
            return 'unknown'
 
185
 
 
186
 
 
187
    def list_files(self):
 
188
        """Recursively list all files as (path, class, kind, id).
 
189
 
 
190
        Lists, but does not descend into unversioned directories.
 
191
 
 
192
        This does not include files that have been deleted in this
 
193
        tree.
 
194
 
 
195
        Skips the control directory.
 
196
        """
 
197
        inv = self.inventory
 
198
 
 
199
        def descend(from_dir, from_dir_id, dp):
 
200
            ls = os.listdir(dp)
 
201
            ls.sort()
 
202
            for f in ls:
 
203
                if bzrlib.BZRDIR == f:
 
204
                    continue
 
205
 
 
206
                # path within tree
 
207
                fp = appendpath(from_dir, f)
 
208
 
 
209
                # absolute path
 
210
                fap = appendpath(dp, f)
 
211
                
 
212
                f_ie = inv.get_child(from_dir_id, f)
 
213
                if f_ie:
 
214
                    c = 'V'
 
215
                elif self.is_ignored(fp):
 
216
                    c = 'I'
 
217
                else:
 
218
                    c = '?'
 
219
 
 
220
                fk = file_kind(fap)
 
221
 
 
222
                if f_ie:
 
223
                    if f_ie.kind != fk:
 
224
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
225
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
226
 
 
227
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
228
 
 
229
                if fk != 'directory':
 
230
                    continue
 
231
 
 
232
                if c != 'V':
 
233
                    # don't descend unversioned directories
 
234
                    continue
 
235
                
 
236
                for ff in descend(fp, f_ie.file_id, fap):
 
237
                    yield ff
 
238
 
 
239
        for f in descend('', None, self.basedir):
 
240
            yield f
 
241
            
 
242
 
 
243
 
 
244
    def unknowns(self, path='', dir_id=None):
 
245
        """Yield names of unknown files in this WorkingTree.
 
246
 
 
247
        If there are any unknown directories then only the directory is
 
248
        returned, not all its children.  But if there are unknown files
 
249
        under a versioned subdirectory, they are returned.
 
250
 
 
251
        Currently returned depth-first, sorted by name within directories.
 
252
        """
 
253
        for fpath, fclass, fkind, fid in self.list_files():
 
254
            if fclass == '?':
 
255
                yield fpath
 
256
                
 
257
 
 
258
    def ignored_files(self):
 
259
        for fpath, fclass, fkind, fid in self.list_files():
 
260
            if fclass == 'I':
 
261
                yield fpath
 
262
 
 
263
 
 
264
    def get_ignore_list(self):
 
265
        """Return list of ignore patterns."""
 
266
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
267
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
268
            return [line.rstrip("\n\r") for line in f.readlines()]
 
269
        else:
 
270
            return bzrlib.DEFAULT_IGNORE
 
271
 
 
272
 
 
273
    def is_ignored(self, filename):
 
274
        """Check whether the filename matches an ignore pattern.
 
275
 
 
276
        Patterns containing '/' need to match the whole path; others
 
277
        match against only the last component."""
 
278
        ## TODO: Take them from a file, not hardcoded
 
279
        ## TODO: Use extended zsh-style globs maybe?
 
280
        ## TODO: Use '**' to match directories?
 
281
        for pat in self.get_ignore_list():
 
282
            if '/' in pat:
 
283
                if fnmatch.fnmatchcase(filename, pat):
 
284
                    return True
 
285
            else:
 
286
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
287
                    return True
 
288
        return False
 
289
        
 
290
 
 
291
        
 
292
        
107
293
 
108
294
class RevisionTree(Tree):
109
295
    """Tree viewing a previous revision.
110
296
 
111
297
    File text can be retrieved from the text store.
112
298
 
113
 
    TODO: Some kind of `__repr__` method, but a good one
 
299
    :todo: Some kind of `__repr__` method, but a good one
114
300
           probably means knowing the branch and revision number,
115
301
           or at least passing a description to the constructor.
116
302
    """
123
309
        ie = self._inventory[file_id]
124
310
        f = self._store[ie.text_id]
125
311
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
312
        fs = filesize(f)
 
313
        if ie.text_size is None:
 
314
            note("warning: no text size recorded on %r" % ie)
126
315
        self._check_retrieved(ie, f)
127
316
        return f
128
317
 
143
332
 
144
333
 
145
334
class EmptyTree(Tree):
146
 
    def __init__(self, root_id):
147
 
        from bzrlib.inventory import Inventory
148
 
        self._inventory = Inventory(root_id)
 
335
    def __init__(self):
 
336
        self._inventory = Inventory()
149
337
 
150
338
    def has_filename(self, filename):
151
339
        return False
211
399
 
212
400
    
213
401
 
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