~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-28 02:24:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050328022418-9d37f56361aa18e9
doc: more on ignore patterns

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
 
20
from sets import Set
 
21
import os.path, os, fnmatch
21
22
 
22
 
from bzrlib.trace import mutter, note
23
 
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
24
30
 
25
31
import bzrlib
26
32
 
27
 
exporters = {}
28
 
 
29
 
class Tree(object):
 
33
class Tree:
30
34
    """Abstract file tree.
31
35
 
32
36
    There are several subclasses:
55
59
    def has_id(self, file_id):
56
60
        return self.inventory.has_id(file_id)
57
61
 
58
 
    __contains__ = has_id
59
 
 
60
 
    def __iter__(self):
61
 
        return iter(self.inventory)
 
62
    def id_set(self):
 
63
        """Return set of all ids in this tree."""
 
64
        return self.inventory.id_set()
62
65
 
63
66
    def id2path(self, file_id):
64
67
        return self.inventory.id2path(file_id)
70
73
                         doc="Inventory of this Tree")
71
74
 
72
75
    def _check_retrieved(self, ie, f):
73
 
        fp = fingerprint_file(f)
74
 
        f.seek(0)
75
 
        
76
 
        if ie.text_size != None:
77
 
            if ie.text_size != fp['size']:
78
 
                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),
79
81
                        ["inventory expects %d bytes" % ie.text_size,
80
 
                         "file is actually %d bytes" % fp['size'],
 
82
                         "file is actually %d bytes" % fs,
81
83
                         "store is probably damaged/corrupt"])
82
84
 
83
 
        if ie.text_sha1 != fp['sha1']:
84
 
            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),
85
89
                    ["inventory expects %s" % ie.text_sha1,
86
 
                     "file is actually %s" % fp['sha1'],
 
90
                     "file is actually %s" % f_hash,
87
91
                     "store is probably damaged/corrupt"])
88
92
 
89
93
 
90
 
    def print_file(self, fileid):
91
 
        """Print file with id `fileid` to stdout."""
92
 
        import sys
93
 
        pumpfile(self.get_file(fileid), sys.stdout)
94
 
        
95
 
        
96
 
    def export(self, dest, format='dir'):
97
 
        """Export this tree."""
98
 
        try:
99
 
            exporter = exporters[format]
100
 
        except KeyError:
101
 
            raise BzrCommandError("export format %r not supported" % format)
102
 
        exporter(self, dest)
103
 
 
104
 
 
 
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
 
 
267
        Cached in the Tree object after the first call.
 
268
        """
 
269
        if hasattr(self, '_ignorelist'):
 
270
            return self._ignorelist
 
271
 
 
272
        l = bzrlib.DEFAULT_IGNORE[:]
 
273
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
274
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
275
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
276
        self._ignorelist = l
 
277
        return l
 
278
 
 
279
 
 
280
    def is_ignored(self, filename):
 
281
        """Check whether the filename matches an ignore pattern.
 
282
 
 
283
        Patterns containing '/' need to match the whole path; others
 
284
        match against only the last component."""
 
285
        ## TODO: Use extended zsh-style globs maybe?
 
286
        ## TODO: Use '**' to match directories?
 
287
        for pat in self.get_ignore_list():
 
288
            if '/' in pat:
 
289
                if fnmatch.fnmatchcase(filename, pat):
 
290
                    return True
 
291
            else:
 
292
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
293
                    return True
 
294
        return False
 
295
        
 
296
 
 
297
        
 
298
        
105
299
 
106
300
class RevisionTree(Tree):
107
301
    """Tree viewing a previous revision.
108
302
 
109
303
    File text can be retrieved from the text store.
110
304
 
111
 
    TODO: Some kind of `__repr__` method, but a good one
 
305
    :todo: Some kind of `__repr__` method, but a good one
112
306
           probably means knowing the branch and revision number,
113
307
           or at least passing a description to the constructor.
114
308
    """
121
315
        ie = self._inventory[file_id]
122
316
        f = self._store[ie.text_id]
123
317
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
318
        fs = filesize(f)
 
319
        if ie.text_size is None:
 
320
            note("warning: no text size recorded on %r" % ie)
124
321
        self._check_retrieved(ie, f)
125
322
        return f
126
323
 
142
339
 
143
340
class EmptyTree(Tree):
144
341
    def __init__(self):
145
 
        from bzrlib.inventory import Inventory
146
342
        self._inventory = Inventory()
147
343
 
148
344
    def has_filename(self, filename):
209
405
 
210
406
    
211
407
 
212
 
def find_renames(old_inv, new_inv):
213
 
    for file_id in old_inv:
214
 
        if file_id not in new_inv:
215
 
            continue
216
 
        old_name = old_inv.id2path(file_id)
217
 
        new_name = new_inv.id2path(file_id)
218
 
        if old_name != new_name:
219
 
            yield (old_name, new_name)
220
 
            
221
 
 
222
 
 
223
 
######################################################################
224
 
# export
225
 
 
226
 
def dir_exporter(tree, dest):
227
 
    """Export this tree to a new directory.
228
 
 
229
 
    `dest` should not exist, and will be created holding the
230
 
    contents of this tree.
231
 
 
232
 
    TODO: To handle subdirectories we need to create the
233
 
           directories first.
234
 
 
235
 
    :note: If the export fails, the destination directory will be
236
 
           left in a half-assed state.
237
 
    """
238
 
    import os
239
 
    os.mkdir(dest)
240
 
    mutter('export version %r' % tree)
241
 
    inv = tree.inventory
242
 
    for dp, ie in inv.iter_entries():
243
 
        kind = ie.kind
244
 
        fullpath = appendpath(dest, dp)
245
 
        if kind == 'directory':
246
 
            os.mkdir(fullpath)
247
 
        elif kind == 'file':
248
 
            pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
249
 
        else:
250
 
            raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
251
 
        mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
252
 
exporters['dir'] = dir_exporter
253
 
 
254
 
try:
255
 
    import tarfile
256
 
except ImportError:
257
 
    pass
258
 
else:
259
 
    def tar_exporter(tree, dest, compression=None):
260
 
        """Export this tree to a new tar file.
261
 
 
262
 
        `dest` will be created holding the contents of this tree; if it
263
 
        already exists, it will be clobbered, like with "tar -c".
264
 
        """
265
 
        from time import time
266
 
        now = time()
267
 
        compression = str(compression or '')
268
 
        try:
269
 
            ball = tarfile.open(dest, 'w:' + compression)
270
 
        except tarfile.CompressionError, e:
271
 
            raise BzrError(str(e))
272
 
        mutter('export version %r' % tree)
273
 
        inv = tree.inventory
274
 
        for dp, ie in inv.iter_entries():
275
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
276
 
            item = tarfile.TarInfo(dp)
277
 
            # TODO: would be cool to actually set it to the timestamp of the
278
 
            # revision it was last changed
279
 
            item.mtime = now
280
 
            if ie.kind == 'directory':
281
 
                item.type = tarfile.DIRTYPE
282
 
                fileobj = None
283
 
                item.name += '/'
284
 
                item.size = 0
285
 
                item.mode = 0755
286
 
            elif ie.kind == 'file':
287
 
                item.type = tarfile.REGTYPE
288
 
                fileobj = tree.get_file(ie.file_id)
289
 
                item.size = _find_file_size(fileobj)
290
 
                item.mode = 0644
291
 
            else:
292
 
                raise BzrError("don't know how to export {%s} of kind %r" %
293
 
                        (ie.file_id, ie.kind))
294
 
 
295
 
            ball.addfile(item, fileobj)
296
 
        ball.close()
297
 
    exporters['tar'] = tar_exporter
298
 
 
299
 
    def tgz_exporter(tree, dest):
300
 
        tar_exporter(tree, dest, compression='gz')
301
 
    exporters['tgz'] = tgz_exporter
302
 
 
303
 
    def tbz_exporter(tree, dest):
304
 
        tar_exporter(tree, dest, compression='bz2')
305
 
    exporters['tbz2'] = tbz_exporter
306
 
 
307
 
 
308
 
def _find_file_size(fileobj):
309
 
    offset = fileobj.tell()
310
 
    try:
311
 
        fileobj.seek(0, 2)
312
 
        size = fileobj.tell()
313
 
    except TypeError:
314
 
        # gzip doesn't accept second argument to seek()
315
 
        fileobj.seek(0)
316
 
        size = 0
317
 
        while True:
318
 
            nread = len(fileobj.read())
319
 
            if nread == 0:
320
 
                break
321
 
            size += nread
322
 
    fileobj.seek(offset)
323
 
    return size