~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-14 23:43:01 UTC
  • Revision ID: mbp@sourcefrog.net-20050414234300-57f6e8b8514287e4
- factor out locale.getpreferredencoding()
- fix problems with EMAIL not being defined

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 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
22
32
 
23
33
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 fingerprint_file
28
34
 
29
 
class Tree(object):
 
35
class Tree:
30
36
    """Abstract file tree.
31
37
 
32
38
    There are several subclasses:
55
61
    def has_id(self, file_id):
56
62
        return self.inventory.has_id(file_id)
57
63
 
58
 
    def has_or_had_id(self, file_id):
59
 
        if file_id == self.inventory.root.file_id:
60
 
            return True
61
 
        return self.inventory.has_id(file_id)
62
 
 
63
 
    __contains__ = has_id
64
 
 
65
 
    def __iter__(self):
66
 
        return iter(self.inventory)
 
64
    def id_set(self):
 
65
        """Return set of all ids in this tree."""
 
66
        return self.inventory.id_set()
67
67
 
68
68
    def id2path(self, file_id):
69
69
        return self.inventory.id2path(file_id)
70
70
 
71
 
    def kind(self, file_id):
72
 
        raise NotImplementedError("subclasses must implement kind")
73
 
 
74
71
    def _get_inventory(self):
75
72
        return self._inventory
76
 
    
77
 
    def get_file_by_path(self, path):
78
 
        return self.get_file(self._inventory.path2id(path))
79
73
 
80
74
    inventory = property(_get_inventory,
81
75
                         doc="Inventory of this Tree")
82
76
 
83
77
    def _check_retrieved(self, ie, f):
84
 
        if not __debug__:
85
 
            return  
86
78
        fp = fingerprint_file(f)
87
79
        f.seek(0)
88
80
        
89
81
        if ie.text_size != None:
90
82
            if ie.text_size != fp['size']:
91
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
83
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
92
84
                        ["inventory expects %d bytes" % ie.text_size,
93
85
                         "file is actually %d bytes" % fp['size'],
94
86
                         "store is probably damaged/corrupt"])
95
87
 
96
88
        if ie.text_sha1 != fp['sha1']:
97
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
89
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
98
90
                    ["inventory expects %s" % ie.text_sha1,
99
91
                     "file is actually %s" % fp['sha1'],
100
92
                     "store is probably damaged/corrupt"])
101
93
 
102
94
 
103
 
    def print_file(self, file_id):
104
 
        """Print file with id `file_id` to stdout."""
 
95
    def print_file(self, fileid):
 
96
        """Print file with id `fileid` to stdout."""
105
97
        import sys
106
 
        sys.stdout.write(self.get_file_text(file_id))
107
 
 
108
 
    def lock_read(self):
109
 
        pass
110
 
 
111
 
    def unlock(self):
112
 
        pass
113
 
 
114
 
    def filter_unversioned_files(self, paths):
115
 
        """Filter out paths that are not versioned.
116
 
 
117
 
        :return: set of paths.
118
 
        """
119
 
        # NB: we specifically *don't* call self.has_filename, because for
120
 
        # WorkingTrees that can indicate files that exist on disk but that 
121
 
        # are not versioned.
122
 
        pred = self.inventory.has_filename
123
 
        return set((p for p in paths if not pred(p)))
124
 
        
125
 
        
 
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
        
 
336
 
126
337
class RevisionTree(Tree):
127
338
    """Tree viewing a previous revision.
128
339
 
129
340
    File text can be retrieved from the text store.
130
341
 
131
 
    TODO: Some kind of `__repr__` method, but a good one
 
342
    :todo: Some kind of `__repr__` method, but a good one
132
343
           probably means knowing the branch and revision number,
133
344
           or at least passing a description to the constructor.
134
345
    """
135
346
    
136
 
    def __init__(self, branch, inv, revision_id):
137
 
        self._branch = branch
138
 
        self._weave_store = branch.weave_store
 
347
    def __init__(self, store, inv):
 
348
        self._store = store
139
349
        self._inventory = inv
140
 
        self._revision_id = revision_id
141
 
 
142
 
    def get_revision_id(self):
143
 
        """Return the revision id associated with this tree."""
144
 
        return self._revision_id
145
 
 
146
 
    def get_weave(self, file_id):
147
 
        return self._weave_store.get_weave(file_id,
148
 
                self._branch.get_transaction())
149
 
 
150
 
    def get_file_lines(self, file_id):
 
350
 
 
351
    def get_file(self, file_id):
151
352
        ie = self._inventory[file_id]
152
 
        weave = self.get_weave(file_id)
153
 
        return weave.get_lines(ie.revision)
154
 
 
155
 
    def get_file_text(self, file_id):
156
 
        return ''.join(self.get_file_lines(file_id))
157
 
 
158
 
    def get_file(self, file_id):
159
 
        return StringIO(self.get_file_text(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
160
357
 
161
358
    def get_file_size(self, file_id):
162
359
        return self._inventory[file_id].text_size
163
360
 
164
 
    def get_file_sha1(self, file_id, path=None):
165
 
        ie = self._inventory[file_id]
166
 
        if ie.kind == "file":
167
 
            return ie.text_sha1
168
 
        return None
169
 
 
170
 
    def is_executable(self, file_id, path=None):
171
 
        ie = self._inventory[file_id]
172
 
        if ie.kind != "file":
173
 
            return None 
174
 
        return self._inventory[file_id].executable
 
361
    def get_file_sha1(self, file_id):
 
362
        ie = self._inventory[file_id]
 
363
        return ie.text_sha1
175
364
 
176
365
    def has_filename(self, filename):
177
366
        return bool(self.inventory.path2id(filename))
179
368
    def list_files(self):
180
369
        # The only files returned by this are those from the version
181
370
        for path, entry in self.inventory.iter_entries():
182
 
            yield path, 'V', entry.kind, entry.file_id, entry
183
 
 
184
 
    def get_symlink_target(self, file_id):
185
 
        ie = self._inventory[file_id]
186
 
        return ie.symlink_target;
187
 
 
188
 
    def kind(self, file_id):
189
 
        return self._inventory[file_id].kind
190
 
 
191
 
    def lock_read(self):
192
 
        self._branch.lock_read()
193
 
 
194
 
    def unlock(self):
195
 
        self._branch.unlock()
 
371
            yield path, 'V', entry.kind, entry.file_id
196
372
 
197
373
 
198
374
class EmptyTree(Tree):
199
375
    def __init__(self):
200
376
        self._inventory = Inventory()
201
377
 
202
 
    def get_symlink_target(self, file_id):
203
 
        return None
204
 
 
205
378
    def has_filename(self, filename):
206
379
        return False
207
380
 
208
 
    def kind(self, file_id):
209
 
        assert self._inventory[file_id].kind == "root_directory"
210
 
        return "root_directory"
211
 
 
212
381
    def list_files(self):
213
 
        return iter([])
 
382
        if False:  # just to make it a generator
 
383
            yield None
214
384
    
215
 
    def __contains__(self, file_id):
216
 
        return file_id in self._inventory
217
 
 
218
 
    def get_file_sha1(self, file_id, path=None):
219
 
        assert self._inventory[file_id].kind == "root_directory"
220
 
        return None
221
385
 
222
386
 
223
387
######################################################################
284
448
        if old_name != new_name:
285
449
            yield (old_name, new_name)
286
450
            
287
 
 
288