/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-08-04 22:04:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050804220440-99562df8151d1ac5
- add pending merge from aaron

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 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
 
20
import os
32
21
 
33
22
import bzrlib
34
 
 
35
 
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):
36
32
    """Abstract file tree.
37
33
 
38
34
    There are several subclasses:
61
57
    def has_id(self, file_id):
62
58
        return self.inventory.has_id(file_id)
63
59
 
64
 
    def id_set(self):
65
 
        """Return set of all ids in this tree."""
66
 
        return self.inventory.id_set()
 
60
    __contains__ = has_id
 
61
 
 
62
    def __iter__(self):
 
63
        return iter(self.inventory)
67
64
 
68
65
    def id2path(self, file_id):
69
66
        return self.inventory.id2path(file_id)
70
67
 
71
68
    def _get_inventory(self):
72
69
        return self._inventory
 
70
    
 
71
    def get_file_by_path(self, path):
 
72
        return self.get_file(self._inventory.path2id(path))
73
73
 
74
74
    inventory = property(_get_inventory,
75
75
                         doc="Inventory of this Tree")
78
78
        fp = fingerprint_file(f)
79
79
        f.seek(0)
80
80
        
81
 
        if ie.text_size is not None:
 
81
        if ie.text_size != None:
82
82
            if ie.text_size != fp['size']:
83
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
83
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
84
                        ["inventory expects %d bytes" % ie.text_size,
85
85
                         "file is actually %d bytes" % fp['size'],
86
86
                         "store is probably damaged/corrupt"])
87
87
 
88
88
        if ie.text_sha1 != fp['sha1']:
89
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
89
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
90
                    ["inventory expects %s" % ie.text_sha1,
91
91
                     "file is actually %s" % fp['sha1'],
92
92
                     "store is probably damaged/corrupt"])
93
93
 
94
94
 
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
 
        
 
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
 
329
111
 
330
112
class RevisionTree(Tree):
331
113
    """Tree viewing a previous revision.
332
114
 
333
115
    File text can be retrieved from the text store.
334
116
 
335
 
    :todo: Some kind of `__repr__` method, but a good one
 
117
    TODO: Some kind of `__repr__` method, but a good one
336
118
           probably means knowing the branch and revision number,
337
119
           or at least passing a description to the constructor.
338
120
    """
441
223
        if old_name != new_name:
442
224
            yield (old_name, new_name)
443
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