~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-09-01 02:34:38 UTC
  • Revision ID: mbp@sourcefrog.net-20050901023437-bf791a0ef5edae8d
- old docs: clarify that this is not mainly descended from arch anymore

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
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")
74
76
 
75
77
    def _check_retrieved(self, ie, f):
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),
 
78
        fp = fingerprint_file(f)
 
79
        f.seek(0)
 
80
        
 
81
        if ie.text_size != None:
 
82
            if ie.text_size != fp['size']:
 
83
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
81
84
                        ["inventory expects %d bytes" % ie.text_size,
82
 
                         "file is actually %d bytes" % fs,
 
85
                         "file is actually %d bytes" % fp['size'],
83
86
                         "store is probably damaged/corrupt"])
84
87
 
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),
 
88
        if ie.text_sha1 != fp['sha1']:
 
89
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
89
90
                    ["inventory expects %s" % ie.text_sha1,
90
 
                     "file is actually %s" % f_hash,
 
91
                     "file is actually %s" % fp['sha1'],
91
92
                     "store is probably damaged/corrupt"])
92
93
 
93
94
 
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
 
        
 
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
 
293
111
 
294
112
class RevisionTree(Tree):
295
113
    """Tree viewing a previous revision.
296
114
 
297
115
    File text can be retrieved from the text store.
298
116
 
299
 
    :todo: Some kind of `__repr__` method, but a good one
 
117
    TODO: Some kind of `__repr__` method, but a good one
300
118
           probably means knowing the branch and revision number,
301
119
           or at least passing a description to the constructor.
302
120
    """
309
127
        ie = self._inventory[file_id]
310
128
        f = self._store[ie.text_id]
311
129
        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)
315
130
        self._check_retrieved(ie, f)
316
131
        return f
317
132
 
320
135
 
321
136
    def get_file_sha1(self, file_id):
322
137
        ie = self._inventory[file_id]
323
 
        return ie.text_sha1
 
138
        if ie.kind == "file":
 
139
            return ie.text_sha1
324
140
 
325
141
    def has_filename(self, filename):
326
142
        return bool(self.inventory.path2id(filename))
342
158
        if False:  # just to make it a generator
343
159
            yield None
344
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
 
345
169
 
346
170
 
347
171
######################################################################
399
223
 
400
224
    
401
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