~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2005-06-06 11:49:47 UTC
  • Revision ID: mbp@sourcefrog.net-20050606114947-0ad5aa9f61ce6f59
todo

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, 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
 
23
28
from inventory import Inventory
24
29
from trace import mutter, note
25
 
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
26
 
     joinpath, splitpath, appendpath, isdir, isfile, file_kind, fingerprint_file
27
30
from errors import bailout
28
31
import branch
29
 
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
30
32
 
31
33
import bzrlib
32
34
 
33
 
class Tree:
 
35
class Tree(object):
34
36
    """Abstract file tree.
35
37
 
36
38
    There are several subclasses:
59
61
    def has_id(self, file_id):
60
62
        return self.inventory.has_id(file_id)
61
63
 
62
 
    def id_set(self):
63
 
        """Return set of all ids in this tree."""
64
 
        return self.inventory.id_set()
 
64
    __contains__ = has_id
 
65
 
 
66
    def __iter__(self):
 
67
        return iter(self.inventory)
65
68
 
66
69
    def id2path(self, file_id):
67
70
        return self.inventory.id2path(file_id)
76
79
        fp = fingerprint_file(f)
77
80
        f.seek(0)
78
81
        
79
 
        if ie.text_size is not None:
 
82
        if ie.text_size != None:
80
83
            if ie.text_size != fp['size']:
81
84
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
82
85
                        ["inventory expects %d bytes" % ie.text_size,
90
93
                     "store is probably damaged/corrupt"])
91
94
 
92
95
 
93
 
    def export(self, dest):
 
96
    def print_file(self, fileid):
 
97
        """Print file with id `fileid` to stdout."""
 
98
        import sys
 
99
        pumpfile(self.get_file(fileid), sys.stdout)
 
100
        
 
101
        
 
102
    def export(self, dest):        
94
103
        """Export this tree to a new directory.
95
104
 
96
105
        `dest` should not exist, and will be created holding the
97
106
        contents of this tree.
98
107
 
99
 
        :todo: To handle subdirectories we need to create the
 
108
        TODO: To handle subdirectories we need to create the
100
109
               directories first.
101
110
 
102
111
        :note: If the export fails, the destination directory will be
113
122
            elif kind == 'file':
114
123
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
115
124
            else:
116
 
                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))
117
126
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
118
127
 
119
128
 
120
129
 
121
 
class WorkingTree(Tree):
122
 
    """Working copy tree.
123
 
 
124
 
    The inventory is held in the `Branch` working-inventory, and the
125
 
    files are in a directory on disk.
126
 
 
127
 
    It is possible for a `WorkingTree` to have a filename which is
128
 
    not listed in the Inventory and vice versa.
129
 
    """
130
 
    def __init__(self, basedir, inv):
131
 
        self._inventory = inv
132
 
        self.basedir = basedir
133
 
        self.path2id = inv.path2id
134
 
 
135
 
    def __repr__(self):
136
 
        return "<%s of %s>" % (self.__class__.__name__,
137
 
                               self.basedir)
138
 
 
139
 
    def abspath(self, filename):
140
 
        return os.path.join(self.basedir, filename)
141
 
 
142
 
    def has_filename(self, filename):
143
 
        return os.path.exists(self.abspath(filename))
144
 
 
145
 
    def get_file(self, file_id):
146
 
        return self.get_file_byname(self.id2path(file_id))
147
 
 
148
 
    def get_file_byname(self, filename):
149
 
        return file(self.abspath(filename), 'rb')
150
 
 
151
 
    def _get_store_filename(self, file_id):
152
 
        return self.abspath(self.id2path(file_id))
153
 
 
154
 
    def has_id(self, file_id):
155
 
        # files that have been deleted are excluded
156
 
        if not self.inventory.has_id(file_id):
157
 
            return False
158
 
        return os.access(self.abspath(self.inventory.id2path(file_id)), os.F_OK)
159
 
 
160
 
    def get_file_size(self, file_id):
161
 
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
162
 
 
163
 
    def get_file_sha1(self, file_id):
164
 
        f = self.get_file(file_id)
165
 
        return sha_file(f)
166
 
 
167
 
 
168
 
    def file_class(self, filename):
169
 
        if self.path2id(filename):
170
 
            return 'V'
171
 
        elif self.is_ignored(filename):
172
 
            return 'I'
173
 
        else:
174
 
            return '?'
175
 
 
176
 
 
177
 
    def list_files(self):
178
 
        """Recursively list all files as (path, class, kind, id).
179
 
 
180
 
        Lists, but does not descend into unversioned directories.
181
 
 
182
 
        This does not include files that have been deleted in this
183
 
        tree.
184
 
 
185
 
        Skips the control directory.
186
 
        """
187
 
        inv = self.inventory
188
 
 
189
 
        def descend(from_dir, from_dir_id, dp):
190
 
            ls = os.listdir(dp)
191
 
            ls.sort()
192
 
            for f in ls:
193
 
                ## TODO: If we find a subdirectory with its own .bzr
194
 
                ## directory, then that is a separate tree and we
195
 
                ## should exclude it.
196
 
                if bzrlib.BZRDIR == f:
197
 
                    continue
198
 
 
199
 
                # path within tree
200
 
                fp = appendpath(from_dir, f)
201
 
 
202
 
                # absolute path
203
 
                fap = appendpath(dp, f)
204
 
                
205
 
                f_ie = inv.get_child(from_dir_id, f)
206
 
                if f_ie:
207
 
                    c = 'V'
208
 
                elif self.is_ignored(fp):
209
 
                    c = 'I'
210
 
                else:
211
 
                    c = '?'
212
 
 
213
 
                fk = file_kind(fap)
214
 
 
215
 
                if f_ie:
216
 
                    if f_ie.kind != fk:
217
 
                        bailout("file %r entered as kind %r id %r, now of kind %r"
218
 
                                % (fap, f_ie.kind, f_ie.file_id, fk))
219
 
 
220
 
                yield fp, c, fk, (f_ie and f_ie.file_id)
221
 
 
222
 
                if fk != 'directory':
223
 
                    continue
224
 
 
225
 
                if c != 'V':
226
 
                    # don't descend unversioned directories
227
 
                    continue
228
 
                
229
 
                for ff in descend(fp, f_ie.file_id, fap):
230
 
                    yield ff
231
 
 
232
 
        for f in descend('', None, self.basedir):
233
 
            yield f
234
 
            
235
 
 
236
 
 
237
 
    def unknowns(self):
238
 
        for subp in self.extras():
239
 
            if not self.is_ignored(subp):
240
 
                yield subp
241
 
 
242
 
 
243
 
    def extras(self):
244
 
        """Yield all unknown files in this WorkingTree.
245
 
 
246
 
        If there are any unknown directories then only the directory is
247
 
        returned, not all its children.  But if there are unknown files
248
 
        under a versioned subdirectory, they are returned.
249
 
 
250
 
        Currently returned depth-first, sorted by name within directories.
251
 
        """
252
 
        ## TODO: Work from given directory downwards
253
 
        
254
 
        for path, dir_entry in self.inventory.directories():
255
 
            mutter("search for unknowns in %r" % path)
256
 
            dirabs = self.abspath(path)
257
 
            if not isdir(dirabs):
258
 
                # e.g. directory deleted
259
 
                continue
260
 
 
261
 
            fl = []
262
 
            for subf in os.listdir(dirabs):
263
 
                if (subf != '.bzr'
264
 
                    and (subf not in dir_entry.children)):
265
 
                    fl.append(subf)
266
 
            
267
 
            fl.sort()
268
 
            for subf in fl:
269
 
                subp = appendpath(path, subf)
270
 
                yield subp
271
 
                
272
 
 
273
 
    def ignored_files(self):
274
 
        """Yield list of PATH, IGNORE_PATTERN"""
275
 
        for subp in self.extras():
276
 
            pat = self.is_ignored(subp)
277
 
            if pat != None:
278
 
                yield subp, pat
279
 
 
280
 
 
281
 
    def get_ignore_list(self):
282
 
        """Return list of ignore patterns.
283
 
 
284
 
        Cached in the Tree object after the first call.
285
 
        """
286
 
        if hasattr(self, '_ignorelist'):
287
 
            return self._ignorelist
288
 
 
289
 
        l = bzrlib.DEFAULT_IGNORE[:]
290
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
291
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
292
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
293
 
        self._ignorelist = l
294
 
        return l
295
 
 
296
 
 
297
 
    def is_ignored(self, filename):
298
 
        """Check whether the filename matches an ignore pattern.
299
 
 
300
 
        Patterns containing '/' need to match the whole path; others
301
 
        match against only the last component.
302
 
 
303
 
        If the file is ignored, returns the pattern which caused it to
304
 
        be ignored, otherwise None.  So this can simply be used as a
305
 
        boolean if desired."""
306
 
 
307
 
        ## TODO: Use '**' to match directories, and other extended globbing stuff from cvs/rsync.
308
 
        
309
 
        for pat in self.get_ignore_list():
310
 
            if '/' in pat:
311
 
                # as a special case, you can put ./ at the start of a pattern;
312
 
                # this is good to match in the top-level only;
313
 
                if pat[:2] == './':
314
 
                    newpat = pat[2:]
315
 
                else:
316
 
                    newpat = pat
317
 
                if fnmatch.fnmatchcase(filename, newpat):
318
 
                    return pat
319
 
            else:
320
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
321
 
                    return pat
322
 
        return None
323
 
        
324
 
 
325
 
        
326
 
        
327
 
 
328
130
class RevisionTree(Tree):
329
131
    """Tree viewing a previous revision.
330
132
 
331
133
    File text can be retrieved from the text store.
332
134
 
333
 
    :todo: Some kind of `__repr__` method, but a good one
 
135
    TODO: Some kind of `__repr__` method, but a good one
334
136
           probably means knowing the branch and revision number,
335
137
           or at least passing a description to the constructor.
336
138
    """
430
232
 
431
233
    
432
234
 
 
235
def find_renames(old_inv, new_inv):
 
236
    for file_id in old_inv:
 
237
        if file_id not in new_inv:
 
238
            continue
 
239
        old_name = old_inv.id2path(file_id)
 
240
        new_name = new_inv.id2path(file_id)
 
241
        if old_name != new_name:
 
242
            yield (old_name, new_name)
 
243