~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

- move 'conflict' and 'resolved' from shipped plugin to regular builtins

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
 
21
from cStringIO import StringIO
32
22
 
33
23
import bzrlib
34
 
 
35
 
class Tree:
 
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):
36
33
    """Abstract file tree.
37
34
 
38
35
    There are several subclasses:
61
58
    def has_id(self, file_id):
62
59
        return self.inventory.has_id(file_id)
63
60
 
64
 
    def id_set(self):
65
 
        """Return set of all ids in this tree."""
66
 
        return self.inventory.id_set()
 
61
    __contains__ = has_id
 
62
 
 
63
    def __iter__(self):
 
64
        return iter(self.inventory)
67
65
 
68
66
    def id2path(self, file_id):
69
67
        return self.inventory.id2path(file_id)
70
68
 
71
69
    def _get_inventory(self):
72
70
        return self._inventory
 
71
    
 
72
    def get_file_by_path(self, path):
 
73
        return self.get_file(self._inventory.path2id(path))
73
74
 
74
75
    inventory = property(_get_inventory,
75
76
                         doc="Inventory of this Tree")
76
77
 
77
78
    def _check_retrieved(self, ie, f):
 
79
        if not __debug__:
 
80
            return  
78
81
        fp = fingerprint_file(f)
79
82
        f.seek(0)
80
83
        
81
84
        if ie.text_size != None:
82
85
            if ie.text_size != fp['size']:
83
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
86
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
87
                        ["inventory expects %d bytes" % ie.text_size,
85
88
                         "file is actually %d bytes" % fp['size'],
86
89
                         "store is probably damaged/corrupt"])
87
90
 
88
91
        if ie.text_sha1 != fp['sha1']:
89
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
92
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
93
                    ["inventory expects %s" % ie.text_sha1,
91
94
                     "file is actually %s" % fp['sha1'],
92
95
                     "store is probably damaged/corrupt"])
93
96
 
94
97
 
95
 
    def print_file(self, fileid):
96
 
        """Print file with id `fileid` to stdout."""
 
98
    def print_file(self, file_id):
 
99
        """Print file with id `file_id` to stdout."""
97
100
        import sys
98
 
        pumpfile(self.get_file(fileid), sys.stdout)
99
 
        
100
 
        
101
 
    def export(self, dest):        
102
 
        """Export this tree to a new directory.
103
 
 
104
 
        `dest` should not exist, and will be created holding the
105
 
        contents of this tree.
106
 
 
107
 
        TODO: To handle subdirectories we need to create the
108
 
               directories first.
109
 
 
110
 
        :note: If the export fails, the destination directory will be
111
 
               left in a half-assed state.
112
 
        """
113
 
        os.mkdir(dest)
114
 
        mutter('export version %r' % self)
115
 
        inv = self.inventory
116
 
        for dp, ie in inv.iter_entries():
117
 
            kind = ie.kind
118
 
            fullpath = appendpath(dest, dp)
119
 
            if kind == 'directory':
120
 
                os.mkdir(fullpath)
121
 
            elif kind == 'file':
122
 
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
123
 
            else:
124
 
                bailout("don't know how to export {%s} of kind %r" % (fid, kind))
125
 
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
126
 
 
127
 
 
128
 
 
129
 
class WorkingTree(Tree):
130
 
    """Working copy tree.
131
 
 
132
 
    The inventory is held in the `Branch` working-inventory, and the
133
 
    files are in a directory on disk.
134
 
 
135
 
    It is possible for a `WorkingTree` to have a filename which is
136
 
    not listed in the Inventory and vice versa.
137
 
    """
138
 
    def __init__(self, basedir, inv):
139
 
        self._inventory = inv
140
 
        self.basedir = basedir
141
 
        self.path2id = inv.path2id
142
 
 
143
 
    def __repr__(self):
144
 
        return "<%s of %s>" % (self.__class__.__name__,
145
 
                               self.basedir)
146
 
 
147
 
    def abspath(self, filename):
148
 
        return os.path.join(self.basedir, filename)
149
 
 
150
 
    def has_filename(self, filename):
151
 
        return os.path.exists(self.abspath(filename))
152
 
 
153
 
    def get_file(self, file_id):
154
 
        return self.get_file_byname(self.id2path(file_id))
155
 
 
156
 
    def get_file_byname(self, filename):
157
 
        return file(self.abspath(filename), 'rb')
158
 
 
159
 
    def _get_store_filename(self, file_id):
160
 
        ## XXX: badly named; this isn't in the store at all
161
 
        return self.abspath(self.id2path(file_id))
162
 
 
163
 
    def has_id(self, file_id):
164
 
        # files that have been deleted are excluded
165
 
        if not self.inventory.has_id(file_id):
166
 
            return False
167
 
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
168
 
 
169
 
    def get_file_size(self, file_id):
170
 
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
171
 
 
172
 
    def get_file_sha1(self, file_id):
173
 
        f = self.get_file(file_id)
174
 
        return sha_file(f)
175
 
 
176
 
 
177
 
    def file_class(self, filename):
178
 
        if self.path2id(filename):
179
 
            return 'V'
180
 
        elif self.is_ignored(filename):
181
 
            return 'I'
182
 
        else:
183
 
            return '?'
184
 
 
185
 
 
186
 
    def list_files(self):
187
 
        """Recursively list all files as (path, class, kind, id).
188
 
 
189
 
        Lists, but does not descend into unversioned directories.
190
 
 
191
 
        This does not include files that have been deleted in this
192
 
        tree.
193
 
 
194
 
        Skips the control directory.
195
 
        """
196
 
        inv = self.inventory
197
 
 
198
 
        def descend(from_dir_relpath, from_dir_id, dp):
199
 
            ls = os.listdir(dp)
200
 
            ls.sort()
201
 
            for f in ls:
202
 
                ## TODO: If we find a subdirectory with its own .bzr
203
 
                ## directory, then that is a separate tree and we
204
 
                ## should exclude it.
205
 
                if bzrlib.BZRDIR == f:
206
 
                    continue
207
 
 
208
 
                # path within tree
209
 
                fp = appendpath(from_dir_relpath, f)
210
 
 
211
 
                # absolute path
212
 
                fap = appendpath(dp, f)
213
 
                
214
 
                f_ie = inv.get_child(from_dir_id, f)
215
 
                if f_ie:
216
 
                    c = 'V'
217
 
                elif self.is_ignored(fp):
218
 
                    c = 'I'
219
 
                else:
220
 
                    c = '?'
221
 
 
222
 
                fk = file_kind(fap)
223
 
 
224
 
                if f_ie:
225
 
                    if f_ie.kind != fk:
226
 
                        bailout("file %r entered as kind %r id %r, now of kind %r"
227
 
                                % (fap, f_ie.kind, f_ie.file_id, fk))
228
 
 
229
 
                yield fp, c, fk, (f_ie and f_ie.file_id)
230
 
 
231
 
                if fk != 'directory':
232
 
                    continue
233
 
 
234
 
                if c != 'V':
235
 
                    # don't descend unversioned directories
236
 
                    continue
237
 
                
238
 
                for ff in descend(fp, f_ie.file_id, fap):
239
 
                    yield ff
240
 
 
241
 
        for f in descend('', inv.root.file_id, self.basedir):
242
 
            yield f
243
 
            
244
 
 
245
 
 
246
 
    def unknowns(self):
247
 
        for subp in self.extras():
248
 
            if not self.is_ignored(subp):
249
 
                yield subp
250
 
 
251
 
 
252
 
    def extras(self):
253
 
        """Yield all unknown files in this WorkingTree.
254
 
 
255
 
        If there are any unknown directories then only the directory is
256
 
        returned, not all its children.  But if there are unknown files
257
 
        under a versioned subdirectory, they are returned.
258
 
 
259
 
        Currently returned depth-first, sorted by name within directories.
260
 
        """
261
 
        ## TODO: Work from given directory downwards
262
 
        
263
 
        for path, dir_entry in self.inventory.directories():
264
 
            mutter("search for unknowns in %r" % path)
265
 
            dirabs = self.abspath(path)
266
 
            if not isdir(dirabs):
267
 
                # e.g. directory deleted
268
 
                continue
269
 
 
270
 
            fl = []
271
 
            for subf in os.listdir(dirabs):
272
 
                if (subf != '.bzr'
273
 
                    and (subf not in dir_entry.children)):
274
 
                    fl.append(subf)
275
 
            
276
 
            fl.sort()
277
 
            for subf in fl:
278
 
                subp = appendpath(path, subf)
279
 
                yield subp
280
 
 
281
 
 
282
 
    def ignored_files(self):
283
 
        """Yield list of PATH, IGNORE_PATTERN"""
284
 
        for subp in self.extras():
285
 
            pat = self.is_ignored(subp)
286
 
            if pat != None:
287
 
                yield subp, pat
288
 
 
289
 
 
290
 
    def get_ignore_list(self):
291
 
        """Return list of ignore patterns.
292
 
 
293
 
        Cached in the Tree object after the first call.
294
 
        """
295
 
        if hasattr(self, '_ignorelist'):
296
 
            return self._ignorelist
297
 
 
298
 
        l = bzrlib.DEFAULT_IGNORE[:]
299
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
300
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
301
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
302
 
        self._ignorelist = l
303
 
        return l
304
 
 
305
 
 
306
 
    def is_ignored(self, filename):
307
 
        """Check whether the filename matches an ignore pattern.
308
 
 
309
 
        Patterns containing '/' need to match the whole path; others
310
 
        match against only the last component.
311
 
 
312
 
        If the file is ignored, returns the pattern which caused it to
313
 
        be ignored, otherwise None.  So this can simply be used as a
314
 
        boolean if desired."""
315
 
 
316
 
        ## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
317
 
        
318
 
        for pat in self.get_ignore_list():
319
 
            if '/' in pat:
320
 
                # as a special case, you can put ./ at the start of a pattern;
321
 
                # this is good to match in the top-level only;
322
 
                if pat[:2] == './':
323
 
                    newpat = pat[2:]
324
 
                else:
325
 
                    newpat = pat
326
 
                if fnmatch.fnmatchcase(filename, newpat):
327
 
                    return pat
328
 
            else:
329
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
330
 
                    return pat
331
 
        return None
332
 
        
333
 
 
334
 
        
335
 
        
 
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
 
336
114
 
337
115
class RevisionTree(Tree):
338
116
    """Tree viewing a previous revision.
344
122
           or at least passing a description to the constructor.
345
123
    """
346
124
    
347
 
    def __init__(self, store, inv):
348
 
        self._store = store
 
125
    def __init__(self, weave_store, inv, revision_id):
 
126
        self._weave_store = weave_store
349
127
        self._inventory = inv
 
128
        self._revision_id = revision_id
 
129
 
 
130
    def get_weave(self, file_id):
 
131
        # FIXME: RevisionTree should be given a branch
 
132
        # not a store, or the store should know the branch.
 
133
        import bzrlib.transactions as transactions
 
134
        return self._weave_store.get_weave(file_id,
 
135
            transactions.PassThroughTransaction())
 
136
 
 
137
 
 
138
    def get_file_lines(self, file_id):
 
139
        ie = self._inventory[file_id]
 
140
        weave = self.get_weave(file_id)
 
141
        return weave.get(ie.revision)
 
142
        
 
143
 
 
144
    def get_file_text(self, file_id):
 
145
        return ''.join(self.get_file_lines(file_id))
 
146
 
350
147
 
351
148
    def get_file(self, file_id):
352
 
        ie = self._inventory[file_id]
353
 
        f = self._store[ie.text_id]
354
 
        mutter("  get fileid{%s} from %r" % (file_id, self))
355
 
        self._check_retrieved(ie, f)
356
 
        return f
 
149
        return StringIO(self.get_file_text(file_id))
357
150
 
358
151
    def get_file_size(self, file_id):
359
152
        return self._inventory[file_id].text_size
360
153
 
361
154
    def get_file_sha1(self, file_id):
362
155
        ie = self._inventory[file_id]
363
 
        return ie.text_sha1
 
156
        if ie.kind == "file":
 
157
            return ie.text_sha1
 
158
 
 
159
    def is_executable(self, file_id):
 
160
        return self._inventory[file_id].executable
364
161
 
365
162
    def has_filename(self, filename):
366
163
        return bool(self.inventory.path2id(filename))
368
165
    def list_files(self):
369
166
        # The only files returned by this are those from the version
370
167
        for path, entry in self.inventory.iter_entries():
371
 
            yield path, 'V', entry.kind, entry.file_id
 
168
            yield path, 'V', entry.kind, entry.file_id, entry
 
169
 
 
170
    def get_symlink_target(self, file_id):
 
171
        ie = self._inventory[file_id]
 
172
        return ie.symlink_target;
372
173
 
373
174
 
374
175
class EmptyTree(Tree):
375
176
    def __init__(self):
376
177
        self._inventory = Inventory()
377
178
 
 
179
    def get_symlink_target(self, file_id):
 
180
        return None
 
181
 
378
182
    def has_filename(self, filename):
379
183
        return False
380
184
 
381
185
    def list_files(self):
382
 
        if False:  # just to make it a generator
383
 
            yield None
 
186
        return iter([])
384
187
    
 
188
    def __contains__(self, file_id):
 
189
        return file_id in self._inventory
 
190
 
 
191
    def get_file_sha1(self, file_id):
 
192
        assert self._inventory[file_id].kind == "root_directory"
 
193
        return None
385
194
 
386
195
 
387
196
######################################################################
448
257
        if old_name != new_name:
449
258
            yield (old_name, new_name)
450
259
            
 
260
 
 
261
 
 
262
######################################################################
 
263
# export
 
264
 
 
265
def dir_exporter(tree, dest, root):
 
266
    """Export this tree to a new directory.
 
267
 
 
268
    `dest` should not exist, and will be created holding the
 
269
    contents of this tree.
 
270
 
 
271
    TODO: To handle subdirectories we need to create the
 
272
           directories first.
 
273
 
 
274
    :note: If the export fails, the destination directory will be
 
275
           left in a half-assed state.
 
276
    """
 
277
    import os
 
278
    os.mkdir(dest)
 
279
    mutter('export version %r' % tree)
 
280
    inv = tree.inventory
 
281
    for dp, ie in inv.iter_entries():
 
282
        ie.put_on_disk(dest, dp, tree)
 
283
 
 
284
exporters['dir'] = dir_exporter
 
285
 
 
286
try:
 
287
    import tarfile
 
288
except ImportError:
 
289
    pass
 
290
else:
 
291
    def get_root_name(dest):
 
292
        """Get just the root name for a tarball.
 
293
 
 
294
        >>> get_root_name('mytar.tar')
 
295
        'mytar'
 
296
        >>> get_root_name('mytar.tar.bz2')
 
297
        'mytar'
 
298
        >>> get_root_name('tar.tar.tar.tgz')
 
299
        'tar.tar.tar'
 
300
        >>> get_root_name('bzr-0.0.5.tar.gz')
 
301
        'bzr-0.0.5'
 
302
        >>> get_root_name('a/long/path/mytar.tgz')
 
303
        'mytar'
 
304
        >>> get_root_name('../parent/../dir/other.tbz2')
 
305
        'other'
 
306
        """
 
307
        endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
 
308
        dest = os.path.basename(dest)
 
309
        for end in endings:
 
310
            if dest.endswith(end):
 
311
                return dest[:-len(end)]
 
312
 
 
313
    def tar_exporter(tree, dest, root, compression=None):
 
314
        """Export this tree to a new tar file.
 
315
 
 
316
        `dest` will be created holding the contents of this tree; if it
 
317
        already exists, it will be clobbered, like with "tar -c".
 
318
        """
 
319
        from time import time
 
320
        now = time()
 
321
        compression = str(compression or '')
 
322
        if root is None:
 
323
            root = get_root_name(dest)
 
324
        try:
 
325
            ball = tarfile.open(dest, 'w:' + compression)
 
326
        except tarfile.CompressionError, e:
 
327
            raise BzrError(str(e))
 
328
        mutter('export version %r' % tree)
 
329
        inv = tree.inventory
 
330
        for dp, ie in inv.iter_entries():
 
331
            mutter("  export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
 
332
            item, fileobj = ie.get_tar_item(root, dp, now, tree)
 
333
            ball.addfile(item, fileobj)
 
334
        ball.close()
 
335
 
 
336
    exporters['tar'] = tar_exporter
 
337
 
 
338
    def tgz_exporter(tree, dest, root):
 
339
        tar_exporter(tree, dest, root, compression='gz')
 
340
    exporters['tgz'] = tgz_exporter
 
341
 
 
342
    def tbz_exporter(tree, dest, root):
 
343
        tar_exporter(tree, dest, root, compression='bz2')
 
344
    exporters['tbz2'] = tbz_exporter