~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-23 06:25:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050323062555-5489339018d0c043
- import a subset of elementtree for easier installation

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
 
import os
21
 
from cStringIO import StringIO
 
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
22
30
 
23
31
import bzrlib
24
 
from bzrlib.trace import mutter, note
25
 
from bzrlib.errors import BzrError, BzrCheckError
26
 
from bzrlib.inventory import Inventory
27
 
from bzrlib.osutils import appendpath, fingerprint_file
28
 
 
29
 
 
30
 
exporters = {}
31
 
 
32
 
class Tree(object):
 
32
 
 
33
class Tree:
33
34
    """Abstract file tree.
34
35
 
35
36
    There are several subclasses:
58
59
    def has_id(self, file_id):
59
60
        return self.inventory.has_id(file_id)
60
61
 
61
 
    __contains__ = has_id
62
 
 
63
 
    def __iter__(self):
64
 
        return iter(self.inventory)
 
62
    def id_set(self):
 
63
        """Return set of all ids in this tree."""
 
64
        return self.inventory.id_set()
65
65
 
66
66
    def id2path(self, file_id):
67
67
        return self.inventory.id2path(file_id)
68
68
 
69
69
    def _get_inventory(self):
70
70
        return self._inventory
71
 
    
72
 
    def get_file_by_path(self, path):
73
 
        return self.get_file(self._inventory.path2id(path))
74
71
 
75
72
    inventory = property(_get_inventory,
76
73
                         doc="Inventory of this Tree")
77
74
 
78
75
    def _check_retrieved(self, ie, f):
79
 
        if not __debug__:
80
 
            return  
81
 
        fp = fingerprint_file(f)
82
 
        f.seek(0)
83
 
        
84
 
        if ie.text_size != None:
85
 
            if ie.text_size != fp['size']:
86
 
                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),
87
81
                        ["inventory expects %d bytes" % ie.text_size,
88
 
                         "file is actually %d bytes" % fp['size'],
 
82
                         "file is actually %d bytes" % fs,
89
83
                         "store is probably damaged/corrupt"])
90
84
 
91
 
        if ie.text_sha1 != fp['sha1']:
92
 
            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),
93
89
                    ["inventory expects %s" % ie.text_sha1,
94
 
                     "file is actually %s" % fp['sha1'],
 
90
                     "file is actually %s" % f_hash,
95
91
                     "store is probably damaged/corrupt"])
96
92
 
97
93
 
98
 
    def print_file(self, file_id):
99
 
        """Print file with id `file_id` to stdout."""
100
 
        import sys
101
 
        sys.stdout.write(self.get_file_text(file_id))
102
 
        
103
 
        
104
 
    def export(self, dest, format='dir', root=None):
105
 
        """Export this tree."""
106
 
        try:
107
 
            exporter = exporters[format]
108
 
        except KeyError:
109
 
            from bzrlib.errors import BzrCommandError
110
 
            raise BzrCommandError("export format %r not supported" % format)
111
 
        exporter(self, dest, root)
112
 
 
113
 
 
 
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
        
114
293
 
115
294
class RevisionTree(Tree):
116
295
    """Tree viewing a previous revision.
117
296
 
118
297
    File text can be retrieved from the text store.
119
298
 
120
 
    TODO: Some kind of `__repr__` method, but a good one
 
299
    :todo: Some kind of `__repr__` method, but a good one
121
300
           probably means knowing the branch and revision number,
122
301
           or at least passing a description to the constructor.
123
302
    """
124
303
    
125
 
    def __init__(self, weave_store, inv, revision_id):
126
 
        self._weave_store = weave_store
 
304
    def __init__(self, store, inv):
 
305
        self._store = store
127
306
        self._inventory = inv
128
 
        self._revision_id = revision_id
129
 
 
130
 
    def get_weave(self, file_id):
131
 
        return self._weave_store.get_weave(file_id)
132
 
 
133
 
 
134
 
    def get_file_lines(self, file_id):
 
307
 
 
308
    def get_file(self, file_id):
135
309
        ie = self._inventory[file_id]
136
 
        weave = self.get_weave(file_id)
137
 
        return weave.get(ie.revision)
138
 
        
139
 
 
140
 
    def get_file_text(self, file_id):
141
 
        return ''.join(self.get_file_lines(file_id))
142
 
 
143
 
 
144
 
    def get_file(self, file_id):
145
 
        return StringIO(self.get_file_text(file_id))
 
310
        f = self._store[ie.text_id]
 
311
        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
        self._check_retrieved(ie, f)
 
316
        return f
146
317
 
147
318
    def get_file_size(self, file_id):
148
319
        return self._inventory[file_id].text_size
149
320
 
150
321
    def get_file_sha1(self, file_id):
151
322
        ie = self._inventory[file_id]
152
 
        if ie.kind == "file":
153
 
            return ie.text_sha1
154
 
 
155
 
    def is_executable(self, file_id):
156
 
        return self._inventory[file_id].executable
 
323
        return ie.text_sha1
157
324
 
158
325
    def has_filename(self, filename):
159
326
        return bool(self.inventory.path2id(filename))
161
328
    def list_files(self):
162
329
        # The only files returned by this are those from the version
163
330
        for path, entry in self.inventory.iter_entries():
164
 
            yield path, 'V', entry.kind, entry.file_id, entry
165
 
 
166
 
    def get_symlink_target(self, file_id):
167
 
        ie = self._inventory[file_id]
168
 
        return ie.symlink_target;
 
331
            yield path, 'V', entry.kind, entry.file_id
169
332
 
170
333
 
171
334
class EmptyTree(Tree):
172
335
    def __init__(self):
173
336
        self._inventory = Inventory()
174
337
 
175
 
    def get_symlink_target(self, file_id):
176
 
        return None
177
 
 
178
338
    def has_filename(self, filename):
179
339
        return False
180
340
 
181
341
    def list_files(self):
182
 
        return iter([])
 
342
        if False:  # just to make it a generator
 
343
            yield None
183
344
    
184
 
    def __contains__(self, file_id):
185
 
        return file_id in self._inventory
186
 
 
187
 
    def get_file_sha1(self, file_id):
188
 
        assert self._inventory[file_id].kind == "root_directory"
189
 
        return None
190
345
 
191
346
 
192
347
######################################################################
244
399
 
245
400
    
246
401
 
247
 
def find_renames(old_inv, new_inv):
248
 
    for file_id in old_inv:
249
 
        if file_id not in new_inv:
250
 
            continue
251
 
        old_name = old_inv.id2path(file_id)
252
 
        new_name = new_inv.id2path(file_id)
253
 
        if old_name != new_name:
254
 
            yield (old_name, new_name)
255
 
            
256
 
 
257
 
 
258
 
######################################################################
259
 
# export
260
 
 
261
 
def dir_exporter(tree, dest, root):
262
 
    """Export this tree to a new directory.
263
 
 
264
 
    `dest` should not exist, and will be created holding the
265
 
    contents of this tree.
266
 
 
267
 
    TODO: To handle subdirectories we need to create the
268
 
           directories first.
269
 
 
270
 
    :note: If the export fails, the destination directory will be
271
 
           left in a half-assed state.
272
 
    """
273
 
    import os
274
 
    os.mkdir(dest)
275
 
    mutter('export version %r' % tree)
276
 
    inv = tree.inventory
277
 
    for dp, ie in inv.iter_entries():
278
 
        ie.put_on_disk(dest, dp, tree)
279
 
 
280
 
exporters['dir'] = dir_exporter
281
 
 
282
 
try:
283
 
    import tarfile
284
 
except ImportError:
285
 
    pass
286
 
else:
287
 
    def get_root_name(dest):
288
 
        """Get just the root name for a tarball.
289
 
 
290
 
        >>> get_root_name('mytar.tar')
291
 
        'mytar'
292
 
        >>> get_root_name('mytar.tar.bz2')
293
 
        'mytar'
294
 
        >>> get_root_name('tar.tar.tar.tgz')
295
 
        'tar.tar.tar'
296
 
        >>> get_root_name('bzr-0.0.5.tar.gz')
297
 
        'bzr-0.0.5'
298
 
        >>> get_root_name('a/long/path/mytar.tgz')
299
 
        'mytar'
300
 
        >>> get_root_name('../parent/../dir/other.tbz2')
301
 
        'other'
302
 
        """
303
 
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
304
 
        dest = os.path.basename(dest)
305
 
        for end in endings:
306
 
            if dest.endswith(end):
307
 
                return dest[:-len(end)]
308
 
 
309
 
    def tar_exporter(tree, dest, root, compression=None):
310
 
        """Export this tree to a new tar file.
311
 
 
312
 
        `dest` will be created holding the contents of this tree; if it
313
 
        already exists, it will be clobbered, like with "tar -c".
314
 
        """
315
 
        from time import time
316
 
        now = time()
317
 
        compression = str(compression or '')
318
 
        if root is None:
319
 
            root = get_root_name(dest)
320
 
        try:
321
 
            ball = tarfile.open(dest, 'w:' + compression)
322
 
        except tarfile.CompressionError, e:
323
 
            raise BzrError(str(e))
324
 
        mutter('export version %r' % tree)
325
 
        inv = tree.inventory
326
 
        for dp, ie in inv.iter_entries():
327
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
328
 
            item, fileobj = ie.get_tar_item(root, dp, now, tree)
329
 
            ball.addfile(item, fileobj)
330
 
        ball.close()
331
 
 
332
 
    exporters['tar'] = tar_exporter
333
 
 
334
 
    def tgz_exporter(tree, dest, root):
335
 
        tar_exporter(tree, dest, root, compression='gz')
336
 
    exporters['tgz'] = tgz_exporter
337
 
 
338
 
    def tbz_exporter(tree, dest, root):
339
 
        tar_exporter(tree, dest, root, compression='bz2')
340
 
    exporters['tbz2'] = tbz_exporter