~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-06-10 07:13:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050610071333-23ae2f973a1eb0f5
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
from sets import Set
21
21
import os.path, os, fnmatch
22
22
 
23
 
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
 
23
from osutils import pumpfile, filesize, quotefn, sha_file, \
24
24
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
25
25
import errno
26
26
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
32
32
 
33
33
import bzrlib
34
34
 
35
 
class Tree:
 
35
class Tree(object):
36
36
    """Abstract file tree.
37
37
 
38
38
    There are several subclasses:
61
61
    def has_id(self, file_id):
62
62
        return self.inventory.has_id(file_id)
63
63
 
64
 
    def id_set(self):
65
 
        """Return set of all ids in this tree."""
66
 
        return self.inventory.id_set()
 
64
    __contains__ = has_id
 
65
 
 
66
    def __iter__(self):
 
67
        return iter(self.inventory)
67
68
 
68
69
    def id2path(self, file_id):
69
70
        return self.inventory.id2path(file_id)
104
105
        `dest` should not exist, and will be created holding the
105
106
        contents of this tree.
106
107
 
107
 
        :todo: To handle subdirectories we need to create the
 
108
        TODO: To handle subdirectories we need to create the
108
109
               directories first.
109
110
 
110
111
        :note: If the export fails, the destination directory will be
121
122
            elif kind == 'file':
122
123
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
123
124
            else:
124
 
                bailout("don't know how to export {%s} of kind %r" % (fid, kind))
 
125
                bailout("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
125
126
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
126
127
 
127
128
 
128
129
 
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
 
 
337
130
class RevisionTree(Tree):
338
131
    """Tree viewing a previous revision.
339
132
 
340
133
    File text can be retrieved from the text store.
341
134
 
342
 
    :todo: Some kind of `__repr__` method, but a good one
 
135
    TODO: Some kind of `__repr__` method, but a good one
343
136
           probably means knowing the branch and revision number,
344
137
           or at least passing a description to the constructor.
345
138
    """