~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-09 04:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

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.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
29
33
 
30
 
class Tree(object):
 
34
class Tree:
31
35
    """Abstract file tree.
32
36
 
33
37
    There are several subclasses:
49
53
    trees or versioned trees.
50
54
    """
51
55
    
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
 
    
68
56
    def has_filename(self, filename):
69
57
        """True if the tree has given filename."""
70
58
        raise NotImplementedError()
72
60
    def has_id(self, file_id):
73
61
        return self.inventory.has_id(file_id)
74
62
 
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)
 
63
    def id_set(self):
 
64
        """Return set of all ids in this tree."""
 
65
        return self.inventory.id_set()
84
66
 
85
67
    def id2path(self, file_id):
86
68
        return self.inventory.id2path(file_id)
87
69
 
88
 
    def kind(self, file_id):
89
 
        raise NotImplementedError("subclasses must implement kind")
90
 
 
91
70
    def _get_inventory(self):
92
71
        return self._inventory
93
 
    
94
 
    def get_file_by_path(self, path):
95
 
        return self.get_file(self._inventory.path2id(path))
96
72
 
97
73
    inventory = property(_get_inventory,
98
74
                         doc="Inventory of this Tree")
99
75
 
100
76
    def _check_retrieved(self, ie, f):
101
 
        if not __debug__:
102
 
            return  
103
 
        fp = fingerprint_file(f)
104
 
        f.seek(0)
105
 
        
106
 
        if ie.text_size != None:
107
 
            if ie.text_size != fp['size']:
108
 
                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),
109
82
                        ["inventory expects %d bytes" % ie.text_size,
110
 
                         "file is actually %d bytes" % fp['size'],
 
83
                         "file is actually %d bytes" % fs,
111
84
                         "store is probably damaged/corrupt"])
112
85
 
113
 
        if ie.text_sha1 != fp['sha1']:
114
 
            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),
115
90
                    ["inventory expects %s" % ie.text_sha1,
116
 
                     "file is actually %s" % fp['sha1'],
 
91
                     "file is actually %s" % f_hash,
117
92
                     "store is probably damaged/corrupt"])
118
93
 
119
94
 
120
 
    def print_file(self, file_id):
121
 
        """Print file with id `file_id` to stdout."""
122
 
        import sys
123
 
        sys.stdout.write(self.get_file_text(file_id))
124
 
 
125
 
    def lock_read(self):
126
 
        pass
127
 
 
128
 
    def unknowns(self):
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
 
        
 
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 get_file_size(self, file_id):
 
157
        return os.stat(self._get_store_filename(file_id))[ST_SIZE]
 
158
 
 
159
    def get_file_sha1(self, file_id):
 
160
        f = self.get_file(file_id)
 
161
        return sha_file(f)
 
162
 
 
163
 
 
164
    def file_class(self, filename):
 
165
        if self.path2id(filename):
 
166
            return 'V'
 
167
        elif self.is_ignored(filename):
 
168
            return 'I'
 
169
        else:
 
170
            return '?'
 
171
 
 
172
 
 
173
    def file_kind(self, filename):
 
174
        if isfile(self._rel(filename)):
 
175
            return 'file'
 
176
        elif isdir(self._rel(filename)):
 
177
            return 'directory'
 
178
        else:
 
179
            return 'unknown'
 
180
 
 
181
 
 
182
    def list_files(self):
 
183
        """Recursively list all files as (path, class, kind, id).
 
184
 
 
185
        Lists, but does not descend into unversioned directories.
 
186
 
 
187
        This does not include files that have been deleted in this
 
188
        tree.
 
189
 
 
190
        Skips the control directory.
 
191
        """
 
192
        inv = self.inventory
 
193
 
 
194
        def descend(from_dir, from_dir_id, dp):
 
195
            ls = os.listdir(dp)
 
196
            ls.sort()
 
197
            for f in ls:
 
198
                if bzrlib.BZRDIR == f:
 
199
                    continue
 
200
 
 
201
                # path within tree
 
202
                fp = appendpath(from_dir, f)
 
203
 
 
204
                # absolute path
 
205
                fap = appendpath(dp, f)
 
206
                
 
207
                f_ie = inv.get_child(from_dir_id, f)
 
208
                if f_ie:
 
209
                    c = 'V'
 
210
                elif self.is_ignored(fp):
 
211
                    c = 'I'
 
212
                else:
 
213
                    c = '?'
 
214
 
 
215
                fk = file_kind(fap)
 
216
 
 
217
                if f_ie:
 
218
                    if f_ie.kind != fk:
 
219
                        bailout("file %r entered as kind %r id %r, now of kind %r"
 
220
                                % (fap, f_ie.kind, f_ie.file_id, fk))
 
221
 
 
222
                yield fp, c, fk, (f_ie and f_ie.file_id)
 
223
 
 
224
                if fk != 'directory':
 
225
                    continue
 
226
 
 
227
                if c != 'V':
 
228
                    # don't descend unversioned directories
 
229
                    continue
 
230
                
 
231
                for ff in descend(fp, f_ie.file_id, fap):
 
232
                    yield ff
 
233
 
 
234
        for f in descend('', None, self.basedir):
 
235
            yield f
 
236
            
 
237
 
 
238
 
 
239
    def unknowns(self, path='', dir_id=None):
 
240
        """Yield names of unknown files in this WorkingTree.
 
241
 
 
242
        If there are any unknown directories then only the directory is
 
243
        returned, not all its children.  But if there are unknown files
 
244
        under a versioned subdirectory, they are returned.
 
245
 
 
246
        Currently returned depth-first, sorted by name within directories.
 
247
        """
 
248
        for fpath, fclass, fkind, fid in self.list_files():
 
249
            if fclass == '?':
 
250
                yield fpath
 
251
                
 
252
 
 
253
    def ignored_files(self):
 
254
        for fpath, fclass, fkind, fid in self.list_files():
 
255
            if fclass == 'I':
 
256
                yield fpath
 
257
 
 
258
 
 
259
    def get_ignore_list(self):
 
260
        """Return list of ignore patterns."""
 
261
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
262
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
263
            return [line.rstrip("\n\r") for line in f.readlines()]
 
264
        else:
 
265
            return bzrlib.DEFAULT_IGNORE
 
266
 
 
267
 
 
268
    def is_ignored(self, filename):
 
269
        """Check whether the filename matches an ignore pattern.
 
270
 
 
271
        Patterns containing '/' need to match the whole path; others
 
272
        match against only the last component."""
 
273
        ## TODO: Take them from a file, not hardcoded
 
274
        ## TODO: Use extended zsh-style globs maybe?
 
275
        ## TODO: Use '**' to match directories?
 
276
        for pat in self.get_ignore_list():
 
277
            if '/' in pat:
 
278
                if fnmatch.fnmatchcase(filename, pat):
 
279
                    return True
 
280
            else:
 
281
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
282
                    return True
 
283
        return False
 
284
        
 
285
 
 
286
        
 
287
        
 
288
 
150
289
class RevisionTree(Tree):
151
290
    """Tree viewing a previous revision.
152
291
 
153
292
    File text can be retrieved from the text store.
154
293
 
155
 
    TODO: Some kind of `__repr__` method, but a good one
 
294
    :todo: Some kind of `__repr__` method, but a good one
156
295
           probably means knowing the branch and revision number,
157
296
           or at least passing a description to the constructor.
158
297
    """
159
298
    
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
 
299
    def __init__(self, store, inv):
 
300
        self._store = store
168
301
        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):
 
302
 
 
303
    def get_file(self, file_id):
188
304
        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))
194
 
 
195
 
    def get_file(self, file_id):
196
 
        return StringIO(self.get_file_text(file_id))
 
305
        f = self._store[ie.text_id]
 
306
        mutter("  get fileid{%s} from %r" % (file_id, self))
 
307
        fs = filesize(f)
 
308
        if ie.text_size is None:
 
309
            note("warning: no text size recorded on %r" % ie)
 
310
        self._check_retrieved(ie, f)
 
311
        return f
197
312
 
198
313
    def get_file_size(self, file_id):
199
314
        return self._inventory[file_id].text_size
200
315
 
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
 
316
    def get_file_sha1(self, file_id):
 
317
        ie = self._inventory[file_id]
 
318
        return ie.text_sha1
217
319
 
218
320
    def has_filename(self, filename):
219
321
        return bool(self.inventory.path2id(filename))
221
323
    def list_files(self):
222
324
        # The only files returned by this are those from the version
223
325
        for path, entry in self.inventory.iter_entries():
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()
 
326
            yield path, 'V', entry.kind, entry.file_id
238
327
 
239
328
 
240
329
class EmptyTree(Tree):
241
 
 
242
330
    def __init__(self):
243
331
        self._inventory = Inventory()
244
332
 
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
 
 
255
333
    def has_filename(self, filename):
256
334
        return False
257
335
 
258
 
    def kind(self, file_id):
259
 
        assert self._inventory[file_id].kind == "root_directory"
260
 
        return "root_directory"
261
 
 
262
336
    def list_files(self):
263
 
        return iter([])
 
337
        if False:  # just to make it a generator
 
338
            yield None
264
339
    
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
271
340
 
272
341
 
273
342
######################################################################
325
394
 
326
395
    
327
396
 
328
 
def find_renames(old_inv, new_inv):
329
 
    for file_id in old_inv:
330
 
        if file_id not in new_inv:
331
 
            continue
332
 
        old_name = old_inv.id2path(file_id)
333
 
        new_name = new_inv.id2path(file_id)
334
 
        if old_name != new_name:
335
 
            yield (old_name, new_name)
336
 
            
337
 
 
338