~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

[merge] mpe: Add 'co' and 'ann'

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
 
24
from bzrlib.errors import BzrError, BzrCheckError
 
25
from bzrlib.inventory import Inventory
 
26
from bzrlib.osutils import fingerprint_file
 
27
import bzrlib.revision
 
28
from bzrlib.trace import mutter, note
34
29
 
35
 
class Tree:
 
30
class Tree(object):
36
31
    """Abstract file tree.
37
32
 
38
33
    There are several subclasses:
54
49
    trees or versioned trees.
55
50
    """
56
51
    
 
52
    def conflicts(self):
 
53
        """Get a list of the conflicts in the tree.
 
54
 
 
55
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
56
        """
 
57
        return []
 
58
 
 
59
    def get_parent_ids(self):
 
60
        """Get the parent ids for this tree. 
 
61
 
 
62
        :return: a list of parent ids. [] is returned to indicate
 
63
        a tree with no parents.
 
64
        :raises: BzrError if the parents are not known.
 
65
        """
 
66
        raise NotImplementedError(self.get_parent_ids)
 
67
    
57
68
    def has_filename(self, filename):
58
69
        """True if the tree has given filename."""
59
70
        raise NotImplementedError()
61
72
    def has_id(self, file_id):
62
73
        return self.inventory.has_id(file_id)
63
74
 
64
 
    def id_set(self):
65
 
        """Return set of all ids in this tree."""
66
 
        return self.inventory.id_set()
 
75
    def has_or_had_id(self, file_id):
 
76
        if file_id == self.inventory.root.file_id:
 
77
            return True
 
78
        return self.inventory.has_id(file_id)
 
79
 
 
80
    __contains__ = has_id
 
81
 
 
82
    def __iter__(self):
 
83
        return iter(self.inventory)
67
84
 
68
85
    def id2path(self, file_id):
69
86
        return self.inventory.id2path(file_id)
70
87
 
 
88
    def kind(self, file_id):
 
89
        raise NotImplementedError("subclasses must implement kind")
 
90
 
71
91
    def _get_inventory(self):
72
92
        return self._inventory
 
93
    
 
94
    def get_file_by_path(self, path):
 
95
        return self.get_file(self._inventory.path2id(path))
73
96
 
74
97
    inventory = property(_get_inventory,
75
98
                         doc="Inventory of this Tree")
76
99
 
77
100
    def _check_retrieved(self, ie, f):
 
101
        if not __debug__:
 
102
            return  
78
103
        fp = fingerprint_file(f)
79
104
        f.seek(0)
80
105
        
81
106
        if ie.text_size != None:
82
107
            if ie.text_size != fp['size']:
83
 
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
108
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
84
109
                        ["inventory expects %d bytes" % ie.text_size,
85
110
                         "file is actually %d bytes" % fp['size'],
86
111
                         "store is probably damaged/corrupt"])
87
112
 
88
113
        if ie.text_sha1 != fp['sha1']:
89
 
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
114
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
90
115
                    ["inventory expects %s" % ie.text_sha1,
91
116
                     "file is actually %s" % fp['sha1'],
92
117
                     "store is probably damaged/corrupt"])
93
118
 
94
119
 
95
 
    def print_file(self, fileid):
96
 
        """Print file with id `fileid` to stdout."""
 
120
    def print_file(self, file_id):
 
121
        """Print file with id `file_id` to stdout."""
97
122
        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
 
 
 
123
        sys.stdout.write(self.get_file_text(file_id))
 
124
 
 
125
    def lock_read(self):
 
126
        pass
245
127
 
246
128
    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
 
        r"""Check whether the filename matches an ignore pattern.
308
 
 
309
 
        Patterns containing '/' or '\' need to match the whole path;
310
 
        others 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
317
 
        # globbing stuff from cvs/rsync.
318
 
 
319
 
        # XXX: fnmatch is actually not quite what we want: it's only
320
 
        # approximately the same as real Unix fnmatch, and doesn't
321
 
        # treat dotfiles correctly and allows * to match /.
322
 
        # Eventually it should be replaced with something more
323
 
        # accurate.
324
 
        
325
 
        for pat in self.get_ignore_list():
326
 
            if '/' in pat or '\\' in pat:
327
 
                
328
 
                # as a special case, you can put ./ at the start of a
329
 
                # pattern; this is good to match in the top-level
330
 
                # only;
331
 
                
332
 
                if (pat[:2] == './') or (pat[:2] == '.\\'):
333
 
                    newpat = pat[2:]
334
 
                else:
335
 
                    newpat = pat
336
 
                if fnmatch.fnmatchcase(filename, newpat):
337
 
                    return pat
338
 
            else:
339
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
340
 
                    return pat
341
 
        return None
342
 
        
343
 
 
344
 
        
345
 
        
346
 
 
 
129
        """What files are present in this tree and unknown.
 
130
        
 
131
        :return: an iterator over the unknown files.
 
132
        """
 
133
        return iter([])
 
134
 
 
135
    def unlock(self):
 
136
        pass
 
137
 
 
138
    def filter_unversioned_files(self, paths):
 
139
        """Filter out paths that are not versioned.
 
140
 
 
141
        :return: set of paths.
 
142
        """
 
143
        # NB: we specifically *don't* call self.has_filename, because for
 
144
        # WorkingTrees that can indicate files that exist on disk but that 
 
145
        # are not versioned.
 
146
        pred = self.inventory.has_filename
 
147
        return set((p for p in paths if not pred(p)))
 
148
        
 
149
        
347
150
class RevisionTree(Tree):
348
151
    """Tree viewing a previous revision.
349
152
 
354
157
           or at least passing a description to the constructor.
355
158
    """
356
159
    
357
 
    def __init__(self, store, inv):
358
 
        self._store = store
 
160
    def __init__(self, branch, inv, revision_id):
 
161
        # for compatability the 'branch' parameter has not been renamed to 
 
162
        # repository at this point. However, we should change RevisionTree's
 
163
        # construction to always be via Repository and not via direct 
 
164
        # construction - this will mean that we can change the constructor
 
165
        # with much less chance of breaking client code.
 
166
        self._repository = branch
 
167
        self._weave_store = branch.weave_store
359
168
        self._inventory = inv
 
169
        self._revision_id = revision_id
 
170
 
 
171
    def get_parent_ids(self):
 
172
        """See Tree.get_parent_ids.
 
173
 
 
174
        A RevisionTree's parents match the revision graph.
 
175
        """
 
176
        parent_ids = self._repository.get_revision(self._revision_id).parent_ids
 
177
        return parent_ids
 
178
        
 
179
    def get_revision_id(self):
 
180
        """Return the revision id associated with this tree."""
 
181
        return self._revision_id
 
182
 
 
183
    def get_weave(self, file_id):
 
184
        return self._weave_store.get_weave(file_id,
 
185
                self._repository.get_transaction())
 
186
 
 
187
    def get_file_lines(self, file_id):
 
188
        ie = self._inventory[file_id]
 
189
        weave = self.get_weave(file_id)
 
190
        return weave.get_lines(ie.revision)
 
191
 
 
192
    def get_file_text(self, file_id):
 
193
        return ''.join(self.get_file_lines(file_id))
360
194
 
361
195
    def get_file(self, file_id):
362
 
        ie = self._inventory[file_id]
363
 
        f = self._store[ie.text_id]
364
 
        mutter("  get fileid{%s} from %r" % (file_id, self))
365
 
        self._check_retrieved(ie, f)
366
 
        return f
 
196
        return StringIO(self.get_file_text(file_id))
367
197
 
368
198
    def get_file_size(self, file_id):
369
199
        return self._inventory[file_id].text_size
370
200
 
371
 
    def get_file_sha1(self, file_id):
372
 
        ie = self._inventory[file_id]
373
 
        return ie.text_sha1
 
201
    def get_file_sha1(self, file_id, path=None):
 
202
        ie = self._inventory[file_id]
 
203
        if ie.kind == "file":
 
204
            return ie.text_sha1
 
205
        return None
 
206
 
 
207
    def get_file_mtime(self, file_id, path=None):
 
208
        ie = self._inventory[file_id]
 
209
        revision = self._repository.get_revision(ie.revision)
 
210
        return revision.timestamp
 
211
 
 
212
    def is_executable(self, file_id, path=None):
 
213
        ie = self._inventory[file_id]
 
214
        if ie.kind != "file":
 
215
            return None 
 
216
        return self._inventory[file_id].executable
374
217
 
375
218
    def has_filename(self, filename):
376
219
        return bool(self.inventory.path2id(filename))
378
221
    def list_files(self):
379
222
        # The only files returned by this are those from the version
380
223
        for path, entry in self.inventory.iter_entries():
381
 
            yield path, 'V', entry.kind, entry.file_id
 
224
            yield path, 'V', entry.kind, entry.file_id, entry
 
225
 
 
226
    def get_symlink_target(self, file_id):
 
227
        ie = self._inventory[file_id]
 
228
        return ie.symlink_target;
 
229
 
 
230
    def kind(self, file_id):
 
231
        return self._inventory[file_id].kind
 
232
 
 
233
    def lock_read(self):
 
234
        self._repository.lock_read()
 
235
 
 
236
    def unlock(self):
 
237
        self._repository.unlock()
382
238
 
383
239
 
384
240
class EmptyTree(Tree):
 
241
 
385
242
    def __init__(self):
386
243
        self._inventory = Inventory()
387
244
 
 
245
    def get_parent_ids(self):
 
246
        """See Tree.get_parent_ids.
 
247
 
 
248
        An EmptyTree always has NULL_REVISION as the only parent.
 
249
        """
 
250
        return []
 
251
 
 
252
    def get_symlink_target(self, file_id):
 
253
        return None
 
254
 
388
255
    def has_filename(self, filename):
389
256
        return False
390
257
 
 
258
    def kind(self, file_id):
 
259
        assert self._inventory[file_id].kind == "root_directory"
 
260
        return "root_directory"
 
261
 
391
262
    def list_files(self):
392
 
        if False:  # just to make it a generator
393
 
            yield None
 
263
        return iter([])
394
264
    
 
265
    def __contains__(self, file_id):
 
266
        return file_id in self._inventory
 
267
 
 
268
    def get_file_sha1(self, file_id, path=None):
 
269
        assert self._inventory[file_id].kind == "root_directory"
 
270
        return None
395
271
 
396
272
 
397
273
######################################################################
458
334
        if old_name != new_name:
459
335
            yield (old_name, new_name)
460
336
            
 
337
 
 
338