/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-21 22:29:49 UTC
  • Revision ID: mbp@sourcefrog.net-20050321222949-232c2093a6eadd80
fixup doctest for new module structure

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
17
18
"""Tree classes, representing directory at point in time.
18
19
"""
19
20
 
20
 
import os
21
 
from cStringIO import StringIO
 
21
from sets import Set
 
22
import os.path, os, fnmatch
 
23
 
 
24
from inventory import Inventory
 
25
from trace import mutter, note
 
26
from osutils import pumpfile, compare_files, filesize, quotefn, sha_file, \
 
27
     joinpath, splitpath, appendpath, isdir, isfile, file_kind
 
28
from errors import bailout
 
29
import branch
 
30
from stat import S_ISREG, S_ISDIR, ST_MODE, ST_SIZE
22
31
 
23
32
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 appendpath, fingerprint_file
28
33
 
29
 
class Tree(object):
 
34
class Tree:
30
35
    """Abstract file tree.
31
36
 
32
37
    There are several subclasses:
55
60
    def has_id(self, file_id):
56
61
        return self.inventory.has_id(file_id)
57
62
 
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)
 
63
    def id_set(self):
 
64
        """Return set of all ids in this tree."""
 
65
        return self.inventory.id_set()
67
66
 
68
67
    def id2path(self, file_id):
69
68
        return self.inventory.id2path(file_id)
70
69
 
71
 
    def kind(self, file_id):
72
 
        raise NotImplementedError("subclasses must implement kind")
73
 
 
74
70
    def _get_inventory(self):
75
71
        return self._inventory
76
 
    
77
 
    def get_file_by_path(self, path):
78
 
        return self.get_file(self._inventory.path2id(path))
79
72
 
80
73
    inventory = property(_get_inventory,
81
74
                         doc="Inventory of this Tree")
82
75
 
83
76
    def _check_retrieved(self, ie, f):
84
 
        if not __debug__:
85
 
            return  
86
 
        fp = fingerprint_file(f)
87
 
        f.seek(0)
88
 
        
89
 
        if ie.text_size != None:
90
 
            if ie.text_size != fp['size']:
91
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
77
        # TODO: Test this check by damaging the store?
 
78
        if ie.text_size is not None:
 
79
            fs = filesize(f)
 
80
            if fs != ie.text_size:
 
81
                bailout("mismatched size for file %r in %r" % (ie.file_id, self._store),
92
82
                        ["inventory expects %d bytes" % ie.text_size,
93
 
                         "file is actually %d bytes" % fp['size'],
 
83
                         "file is actually %d bytes" % fs,
94
84
                         "store is probably damaged/corrupt"])
95
85
 
96
 
        if ie.text_sha1 != fp['sha1']:
97
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
86
        f_hash = sha_file(f)
 
87
        f.seek(0)
 
88
        if ie.text_sha1 != f_hash:
 
89
            bailout("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
98
90
                    ["inventory expects %s" % ie.text_sha1,
99
 
                     "file is actually %s" % fp['sha1'],
 
91
                     "file is actually %s" % f_hash,
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."""
105
 
        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
 
        
 
95
    def export(self, dest):
 
96
        """Export this tree to a new directory.
 
97
 
 
98
        `dest` should not exist, and will be created holding the
 
99
        contents of this tree.
 
100
 
 
101
        :todo: To handle subdirectories we need to create the
 
102
               directories first.
 
103
 
 
104
        :note: If the export fails, the destination directory will be
 
105
               left in a half-assed state.
 
106
        """
 
107
        os.mkdir(dest)
 
108
        mutter('export version %r' % self)
 
109
        inv = self.inventory
 
110
        for dp, ie in inv.iter_entries():
 
111
            kind = ie.kind
 
112
            fullpath = appendpath(dest, dp)
 
113
            if kind == 'directory':
 
114
                os.mkdir(fullpath)
 
115
            elif kind == 'file':
 
116
                pumpfile(self.get_file(ie.file_id), file(fullpath, 'wb'))
 
117
            else:
 
118
                bailout("don't know how to export {%s} of kind %r", fid, kind)
 
119
            mutter("  export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
 
120
 
 
121
 
 
122
 
 
123
class WorkingTree(Tree):
 
124
    """Working copy tree.
 
125
 
 
126
    The inventory is held in the `Branch` working-inventory, and the
 
127
    files are in a directory on disk.
 
128
 
 
129
    It is possible for a `WorkingTree` to have a filename which is
 
130
    not listed in the Inventory and vice versa.
 
131
    """
 
132
    def __init__(self, basedir, inv):
 
133
        self._inventory = inv
 
134
        self.basedir = basedir
 
135
        self.path2id = inv.path2id
 
136
 
 
137
    def __repr__(self):
 
138
        return "<%s of %s>" % (self.__class__.__name__,
 
139
                               self.basedir)
 
140
 
 
141
    def _rel(self, filename):
 
142
        return os.path.join(self.basedir, filename)
 
143
 
 
144
    def has_filename(self, filename):
 
145
        return os.path.exists(self._rel(filename))
 
146
 
 
147
    def get_file(self, file_id):
 
148
        return self.get_file_byname(self.id2path(file_id))
 
149
 
 
150
    def get_file_byname(self, filename):
 
151
        return file(self._rel(filename), 'rb')
 
152
 
 
153
    def _get_store_filename(self, file_id):
 
154
        return self._rel(self.id2path(file_id))
 
155
 
 
156
    def has_id(self, file_id):
 
157
        # files that have been deleted are excluded
 
158
        if not self.inventory.has_id(file_id):
 
159
            return False
 
160
        return os.access(self._rel(self.inventory.id2path(file_id)), os.F_OK)
 
161
 
 
162
    def get_file_size(self, file_id):
 
163
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
164
 
 
165
    def get_file_sha1(self, file_id):
 
166
        f = self.get_file(file_id)
 
167
        return sha_file(f)
 
168
 
 
169
 
 
170
    def file_class(self, filename):
 
171
        if self.path2id(filename):
 
172
            return 'V'
 
173
        elif self.is_ignored(filename):
 
174
            return 'I'
 
175
        else:
 
176
            return '?'
 
177
 
 
178
 
 
179
    def file_kind(self, filename):
 
180
        if isfile(self._rel(filename)):
 
181
            return 'file'
 
182
        elif isdir(self._rel(filename)):
 
183
            return 'directory'
 
184
        else:
 
185
            return 'unknown'
 
186
 
 
187
 
 
188
    def list_files(self):
 
189
        """Recursively list all files as (path, class, kind, id).
 
190
 
 
191
        Lists, but does not descend into unversioned directories.
 
192
 
 
193
        This does not include files that have been deleted in this
 
194
        tree.
 
195
 
 
196
        Skips the control directory.
 
197
        """
 
198
        inv = self.inventory
 
199
 
 
200
        def descend(from_dir, from_dir_id, dp):
 
201
            ls = os.listdir(dp)
 
202
            ls.sort()
 
203
            for f in ls:
 
204
                if bzrlib.BZRDIR == f:
 
205
                    continue
 
206
 
 
207
                # path within tree
 
208
                fp = appendpath(from_dir, f)
 
209
 
 
210
                # absolute path
 
211
                fap = appendpath(dp, f)
 
212
                
 
213
                f_ie = inv.get_child(from_dir_id, f)
 
214
                if f_ie:
 
215
                    c = 'V'
 
216
                elif self.is_ignored(fp):
 
217
                    c = 'I'
 
218
                else:
 
219
                    c = '?'
 
220
 
 
221
                fk = file_kind(fap)
 
222
 
 
223
                if f_ie:
 
224
                    if f_ie.kind != fk:
 
225
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
226
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
227
 
 
228
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
229
 
 
230
                if fk != 'directory':
 
231
                    continue
 
232
 
 
233
                if c != 'V':
 
234
                    # don't descend unversioned directories
 
235
                    continue
 
236
                
 
237
                for ff in descend(fp, f_ie.file_id, fap):
 
238
                    yield ff
 
239
 
 
240
        for f in descend('', None, self.basedir):
 
241
            yield f
 
242
            
 
243
 
 
244
 
 
245
    def unknowns(self, path='', dir_id=None):
 
246
        """Yield names of unknown files in this WorkingTree.
 
247
 
 
248
        If there are any unknown directories then only the directory is
 
249
        returned, not all its children.  But if there are unknown files
 
250
        under a versioned subdirectory, they are returned.
 
251
 
 
252
        Currently returned depth-first, sorted by name within directories.
 
253
        """
 
254
        for fpath, fclass, fkind, fid in self.list_files():
 
255
            if fclass == '?':
 
256
                yield fpath
 
257
                
 
258
 
 
259
    def ignored_files(self):
 
260
        for fpath, fclass, fkind, fid in self.list_files():
 
261
            if fclass == 'I':
 
262
                yield fpath
 
263
 
 
264
 
 
265
    def get_ignore_list(self):
 
266
        """Return list of ignore patterns."""
 
267
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
268
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
269
            return [line.rstrip("\n\r") for line in f.readlines()]
 
270
        else:
 
271
            return bzrlib.DEFAULT_IGNORE
 
272
 
 
273
 
 
274
    def is_ignored(self, filename):
 
275
        """Check whether the filename matches an ignore pattern.
 
276
 
 
277
        Patterns containing '/' need to match the whole path; others
 
278
        match against only the last component."""
 
279
        ## TODO: Take them from a file, not hardcoded
 
280
        ## TODO: Use extended zsh-style globs maybe?
 
281
        ## TODO: Use '**' to match directories?
 
282
        for pat in self.get_ignore_list():
 
283
            if '/' in pat:
 
284
                if fnmatch.fnmatchcase(filename, pat):
 
285
                    return True
 
286
            else:
 
287
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
288
                    return True
 
289
        return False
 
290
        
 
291
 
 
292
        
 
293
        
 
294
 
126
295
class RevisionTree(Tree):
127
296
    """Tree viewing a previous revision.
128
297
 
129
298
    File text can be retrieved from the text store.
130
299
 
131
 
    TODO: Some kind of `__repr__` method, but a good one
 
300
    :todo: Some kind of `__repr__` method, but a good one
132
301
           probably means knowing the branch and revision number,
133
302
           or at least passing a description to the constructor.
134
303
    """
135
304
    
136
 
    def __init__(self, branch, inv, revision_id):
137
 
        self._branch = branch
138
 
        self._weave_store = branch.weave_store
 
305
    def __init__(self, store, inv):
 
306
        self._store = store
139
307
        self._inventory = inv
140
 
        self._revision_id = revision_id
141
 
 
142
 
    def get_weave(self, file_id):
143
 
        return self._weave_store.get_weave(file_id,
144
 
                self._branch.get_transaction())
145
 
 
146
 
    def get_file_lines(self, file_id):
 
308
 
 
309
    def get_file(self, file_id):
147
310
        ie = self._inventory[file_id]
148
 
        weave = self.get_weave(file_id)
149
 
        return weave.get_lines(ie.revision)
150
 
 
151
 
    def get_file_text(self, file_id):
152
 
        return ''.join(self.get_file_lines(file_id))
153
 
 
154
 
    def get_file(self, file_id):
155
 
        return StringIO(self.get_file_text(file_id))
 
311
        f = self._store[ie.text_id]
 
312
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
313
        fs = filesize(f)
 
314
        if ie.text_size is None:
 
315
            note("warning: no text size recorded on %r" % ie)
 
316
        self._check_retrieved(ie, f)
 
317
        return f
156
318
 
157
319
    def get_file_size(self, file_id):
158
320
        return self._inventory[file_id].text_size
159
321
 
160
322
    def get_file_sha1(self, file_id):
161
323
        ie = self._inventory[file_id]
162
 
        if ie.kind == "file":
163
 
            return ie.text_sha1
164
 
 
165
 
    def is_executable(self, file_id):
166
 
        ie = self._inventory[file_id]
167
 
        if ie.kind != "file":
168
 
            return None 
169
 
        return self._inventory[file_id].executable
 
324
        return ie.text_sha1
170
325
 
171
326
    def has_filename(self, filename):
172
327
        return bool(self.inventory.path2id(filename))
174
329
    def list_files(self):
175
330
        # The only files returned by this are those from the version
176
331
        for path, entry in self.inventory.iter_entries():
177
 
            yield path, 'V', entry.kind, entry.file_id, entry
178
 
 
179
 
    def get_symlink_target(self, file_id):
180
 
        ie = self._inventory[file_id]
181
 
        return ie.symlink_target;
182
 
 
183
 
    def kind(self, file_id):
184
 
        return self._inventory[file_id].kind
185
 
 
186
 
    def lock_read(self):
187
 
        self._branch.lock_read()
188
 
 
189
 
    def unlock(self):
190
 
        self._branch.unlock()
 
332
            yield path, 'V', entry.kind, entry.file_id
191
333
 
192
334
 
193
335
class EmptyTree(Tree):
194
336
    def __init__(self):
195
337
        self._inventory = Inventory()
196
338
 
197
 
    def get_symlink_target(self, file_id):
198
 
        return None
199
 
 
200
339
    def has_filename(self, filename):
201
340
        return False
202
341
 
203
 
    def kind(self, file_id):
204
 
        assert self._inventory[file_id].kind == "root_directory"
205
 
        return "root_directory"
206
 
 
207
342
    def list_files(self):
208
 
        return iter([])
 
343
        if False:  # just to make it a generator
 
344
            yield None
209
345
    
210
 
    def __contains__(self, file_id):
211
 
        return file_id in self._inventory
212
 
 
213
 
    def get_file_sha1(self, file_id):
214
 
        assert self._inventory[file_id].kind == "root_directory"
215
 
        return None
216
346
 
217
347
 
218
348
######################################################################
270
400
 
271
401
    
272
402
 
273
 
def find_renames(old_inv, new_inv):
274
 
    for file_id in old_inv:
275
 
        if file_id not in new_inv:
276
 
            continue
277
 
        old_name = old_inv.id2path(file_id)
278
 
        new_name = new_inv.id2path(file_id)
279
 
        if old_name != new_name:
280
 
            yield (old_name, new_name)
281
 
            
282
 
 
283