~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-05 08:24:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050405082451-408ebb0fd108440f
start adding quotes

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
22
 
 
23
 
from bzrlib.trace import mutter, note
24
 
from bzrlib.errors import BzrError
 
20
from sets import Set
 
21
import os.path, os, fnmatch
 
22
 
 
23
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
 
24
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
 
25
import errno
 
26
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
 
27
 
 
28
from inventory import Inventory
 
29
from trace import mutter, note
 
30
from errors import bailout
 
31
import branch
25
32
 
26
33
import bzrlib
27
34
 
28
 
exporters = {}
29
 
 
30
 
class Tree(object):
 
35
class Tree:
31
36
    """Abstract file tree.
32
37
 
33
38
    There are several subclasses:
56
61
    def has_id(self, file_id):
57
62
        return self.inventory.has_id(file_id)
58
63
 
59
 
    __contains__ = has_id
60
 
 
61
 
    def __iter__(self):
62
 
        return iter(self.inventory)
 
64
    def id_set(self):
 
65
        """Return set of all ids in this tree."""
 
66
        return self.inventory.id_set()
63
67
 
64
68
    def id2path(self, file_id):
65
69
        return self.inventory.id2path(file_id)
74
78
        fp = fingerprint_file(f)
75
79
        f.seek(0)
76
80
        
77
 
        if ie.text_size != None:
 
81
        if ie.text_size is not None:
78
82
            if ie.text_size != fp['size']:
79
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
83
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
80
84
                        ["inventory expects %d bytes" % ie.text_size,
81
85
                         "file is actually %d bytes" % fp['size'],
82
86
                         "store is probably damaged/corrupt"])
83
87
 
84
88
        if ie.text_sha1 != fp['sha1']:
85
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
89
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
86
90
                    ["inventory expects %s" % ie.text_sha1,
87
91
                     "file is actually %s" % fp['sha1'],
88
92
                     "store is probably damaged/corrupt"])
89
93
 
90
94
 
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
 
 
 
95
    def export(self, dest):
 
96
        """Export this tree to a new directory.
 
97
 
 
98
        `dest` should not exist, and will be created holding the
 
99
        contents of this tree.
 
100
 
 
101
        :todo: To handle subdirectories we need to create the
 
102
               directories first.
 
103
 
 
104
        :note: If the export fails, the destination directory will be
 
105
               left in a half-assed state.
 
106
        """
 
107
        os.mkdir(dest)
 
108
        mutter('export version %r' % self)
 
109
        inv = self.inventory
 
110
        for dp, ie in inv.iter_entries():
 
111
            kind = ie.kind
 
112
            fullpath = appendpath(dest, dp)
 
113
            if kind == 'directory':
 
114
                os.mkdir(fullpath)
 
115
            elif kind == 'file':
 
116
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
 
117
            else:
 
118
                bailout("don't know how to export {%s} of kind %r", fid, kind)
 
119
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
120
 
 
121
 
 
122
 
 
123
class WorkingTree(Tree):
 
124
    """Working copy tree.
 
125
 
 
126
    The inventory is held in the `Branch` working-inventory, and the
 
127
    files are in a directory on disk.
 
128
 
 
129
    It is possible for a `WorkingTree` to have a filename which is
 
130
    not listed in the Inventory and vice versa.
 
131
    """
 
132
    def __init__(self, basedir, inv):
 
133
        self._inventory = inv
 
134
        self.basedir = basedir
 
135
        self.path2id = inv.path2id
 
136
 
 
137
    def __repr__(self):
 
138
        return "<%s of %s>" % (self.__class__.__name__,
 
139
                               self.basedir)
 
140
 
 
141
    def abspath(self, filename):
 
142
        return os.path.join(self.basedir, filename)
 
143
 
 
144
    def has_filename(self, filename):
 
145
        return os.path.exists(self.abspath(filename))
 
146
 
 
147
    def get_file(self, file_id):
 
148
        return self.get_file_byname(self.id2path(file_id))
 
149
 
 
150
    def get_file_byname(self, filename):
 
151
        return file(self.abspath(filename), 'rb')
 
152
 
 
153
    def _get_store_filename(self, file_id):
 
154
        return self.abspath(self.id2path(file_id))
 
155
 
 
156
    def has_id(self, file_id):
 
157
        # files that have been deleted are excluded
 
158
        if not self.inventory.has_id(file_id):
 
159
            return False
 
160
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
 
161
 
 
162
    def get_file_size(self, file_id):
 
163
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
164
 
 
165
    def get_file_sha1(self, file_id):
 
166
        f = self.get_file(file_id)
 
167
        return sha_file(f)
 
168
 
 
169
 
 
170
    def file_class(self, filename):
 
171
        if self.path2id(filename):
 
172
            return 'V'
 
173
        elif self.is_ignored(filename):
 
174
            return 'I'
 
175
        else:
 
176
            return '?'
 
177
 
 
178
 
 
179
    def list_files(self):
 
180
        """Recursively list all files as (path, class, kind, id).
 
181
 
 
182
        Lists, but does not descend into unversioned directories.
 
183
 
 
184
        This does not include files that have been deleted in this
 
185
        tree.
 
186
 
 
187
        Skips the control directory.
 
188
        """
 
189
        inv = self.inventory
 
190
 
 
191
        def descend(from_dir, from_dir_id, dp):
 
192
            ls = os.listdir(dp)
 
193
            ls.sort()
 
194
            for f in ls:
 
195
                ## TODO: If we find a subdirectory with its own .bzr
 
196
                ## directory, then that is a separate tree and we
 
197
                ## should exclude it.
 
198
                if bzrlib.BZRDIR == f:
 
199
                    continue
 
200
 
 
201
                # path within tree
 
202
                fp = appendpath(from_dir, f)
 
203
 
 
204
                # absolute path
 
205
                fap = appendpath(dp, f)
 
206
                
 
207
                f_ie = inv.get_child(from_dir_id, f)
 
208
                if f_ie:
 
209
                    c = 'V'
 
210
                elif self.is_ignored(fp):
 
211
                    c = 'I'
 
212
                else:
 
213
                    c = '?'
 
214
 
 
215
                fk = file_kind(fap)
 
216
 
 
217
                if f_ie:
 
218
                    if f_ie.kind != fk:
 
219
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
220
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
221
 
 
222
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
223
 
 
224
                if fk != 'directory':
 
225
                    continue
 
226
 
 
227
                if c != 'V':
 
228
                    # don't descend unversioned directories
 
229
                    continue
 
230
                
 
231
                for ff in descend(fp, f_ie.file_id, fap):
 
232
                    yield ff
 
233
 
 
234
        for f in descend('', None, self.basedir):
 
235
            yield f
 
236
            
 
237
 
 
238
 
 
239
    def unknowns(self):
 
240
        for subp in self.extras():
 
241
            if not self.is_ignored(subp):
 
242
                yield subp
 
243
 
 
244
 
 
245
    def extras(self):
 
246
        """Yield all unknown files in this WorkingTree.
 
247
 
 
248
        If there are any unknown directories then only the directory is
 
249
        returned, not all its children.  But if there are unknown files
 
250
        under a versioned subdirectory, they are returned.
 
251
 
 
252
        Currently returned depth-first, sorted by name within directories.
 
253
        """
 
254
        ## TODO: Work from given directory downwards
 
255
        
 
256
        for path, dir_entry in self.inventory.directories():
 
257
            mutter("search for unknowns in %r" % path)
 
258
            dirabs = self.abspath(path)
 
259
            if not isdir(dirabs):
 
260
                # e.g. directory deleted
 
261
                continue
 
262
 
 
263
            fl = []
 
264
            for subf in os.listdir(dirabs):
 
265
                if (subf != '.bzr'
 
266
                    and (subf not in dir_entry.children)):
 
267
                    fl.append(subf)
 
268
            
 
269
            fl.sort()
 
270
            for subf in fl:
 
271
                subp = appendpath(path, subf)
 
272
                yield subp
 
273
 
 
274
 
 
275
    def ignored_files(self):
 
276
        """Yield list of PATH, IGNORE_PATTERN"""
 
277
        for subp in self.extras():
 
278
            pat = self.is_ignored(subp)
 
279
            if pat != None:
 
280
                yield subp, pat
 
281
 
 
282
 
 
283
    def get_ignore_list(self):
 
284
        """Return list of ignore patterns.
 
285
 
 
286
        Cached in the Tree object after the first call.
 
287
        """
 
288
        if hasattr(self, '_ignorelist'):
 
289
            return self._ignorelist
 
290
 
 
291
        l = bzrlib.DEFAULT_IGNORE[:]
 
292
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
293
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
294
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
295
        self._ignorelist = l
 
296
        return l
 
297
 
 
298
 
 
299
    def is_ignored(self, filename):
 
300
        """Check whether the filename matches an ignore pattern.
 
301
 
 
302
        Patterns containing '/' need to match the whole path; others
 
303
        match against only the last component.
 
304
 
 
305
        If the file is ignored, returns the pattern which caused it to
 
306
        be ignored, otherwise None.  So this can simply be used as a
 
307
        boolean if desired."""
 
308
 
 
309
        ## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
 
310
        
 
311
        for pat in self.get_ignore_list():
 
312
            if '/' in pat:
 
313
                # as a special case, you can put ./ at the start of a pattern;
 
314
                # this is good to match in the top-level only;
 
315
                if pat[:2] == './':
 
316
                    newpat = pat[2:]
 
317
                else:
 
318
                    newpat = pat
 
319
                if fnmatch.fnmatchcase(filename, newpat):
 
320
                    return pat
 
321
            else:
 
322
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
323
                    return pat
 
324
        return None
 
325
        
 
326
 
 
327
        
 
328
        
107
329
 
108
330
class RevisionTree(Tree):
109
331
    """Tree viewing a previous revision.
110
332
 
111
333
    File text can be retrieved from the text store.
112
334
 
113
 
    TODO: Some kind of `__repr__` method, but a good one
 
335
    :todo: Some kind of `__repr__` method, but a good one
114
336
           probably means knowing the branch and revision number,
115
337
           or at least passing a description to the constructor.
116
338
    """
143
365
 
144
366
 
145
367
class EmptyTree(Tree):
146
 
    def __init__(self, root_id):
147
 
        from bzrlib.inventory import Inventory
148
 
        self._inventory = Inventory(root_id)
 
368
    def __init__(self):
 
369
        self._inventory = Inventory()
149
370
 
150
371
    def has_filename(self, filename):
151
372
        return False
220
441
        if old_name != new_name:
221
442
            yield (old_name, new_name)
222
443
            
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