~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-07-27 14:19:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050727141923-9f4f14835da8a2db
- clean up code that loads modules to test, taking advantage of less broken
  testLoader in python 2.4

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
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)
68
66
 
69
67
    def _get_inventory(self):
70
68
        return self._inventory
 
69
    
 
70
    def get_file_by_path(self, path):
 
71
        return self.get_file(self._inventory.path2id(path))
71
72
 
72
73
    inventory = property(_get_inventory,
73
74
                         doc="Inventory of this Tree")
74
75
 
75
76
    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),
 
77
        fp = fingerprint_file(f)
 
78
        f.seek(0)
 
79
        
 
80
        if ie.text_size != None:
 
81
            if ie.text_size != fp['size']:
 
82
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
81
83
                        ["inventory expects %d bytes" % ie.text_size,
82
 
                         "file is actually %d bytes" % fs,
 
84
                         "file is actually %d bytes" % fp['size'],
83
85
                         "store is probably damaged/corrupt"])
84
86
 
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),
 
87
        if ie.text_sha1 != fp['sha1']:
 
88
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
89
89
                    ["inventory expects %s" % ie.text_sha1,
90
 
                     "file is actually %s" % f_hash,
 
90
                     "file is actually %s" % fp['sha1'],
91
91
                     "store is probably damaged/corrupt"])
92
92
 
93
93
 
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
 
        
 
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
 
293
110
 
294
111
class RevisionTree(Tree):
295
112
    """Tree viewing a previous revision.
296
113
 
297
114
    File text can be retrieved from the text store.
298
115
 
299
 
    :todo: Some kind of `__repr__` method, but a good one
 
116
    TODO: Some kind of `__repr__` method, but a good one
300
117
           probably means knowing the branch and revision number,
301
118
           or at least passing a description to the constructor.
302
119
    """
309
126
        ie = self._inventory[file_id]
310
127
        f = self._store[ie.text_id]
311
128
        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
129
        self._check_retrieved(ie, f)
316
130
        return f
317
131
 
332
146
 
333
147
 
334
148
class EmptyTree(Tree):
335
 
    def __init__(self):
336
 
        self._inventory = Inventory()
 
149
    def __init__(self, root_id):
 
150
        from bzrlib.inventory import Inventory
 
151
        self._inventory = Inventory(root_id)
337
152
 
338
153
    def has_filename(self, filename):
339
154
        return False
399
214
 
400
215
    
401
216
 
 
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