/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: Aaron Bentley
  • Date: 2006-05-17 16:15:13 UTC
  • mto: (1185.82.108 w-changeset)
  • mto: This revision was merged to the branch mainline in revision 1738.
  • Revision ID: abentley@panoramicfeedback.com-20060517161513-55a87bb608a1583c
Cleanups

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tree.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Tree classes, representing directory at point in time.
 
18
"""
 
19
 
 
20
import os
 
21
from cStringIO import StringIO
 
22
 
 
23
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
 
 
29
class Tree(object):
 
30
    """Abstract file tree.
 
31
 
 
32
    There are several subclasses:
 
33
    
 
34
    * `WorkingTree` exists as files on disk editable by the user.
 
35
 
 
36
    * `RevisionTree` is a tree as recorded at some point in the past.
 
37
 
 
38
    * `EmptyTree`
 
39
 
 
40
    Trees contain an `Inventory` object, and also know how to retrieve
 
41
    file texts mentioned in the inventory, either from a working
 
42
    directory or from a store.
 
43
 
 
44
    It is possible for trees to contain files that are not described
 
45
    in their inventory or vice versa; for this use `filenames()`.
 
46
 
 
47
    Trees can be compared, etc, regardless of whether they are working
 
48
    trees or versioned trees.
 
49
    """
 
50
    
 
51
    def has_filename(self, filename):
 
52
        """True if the tree has given filename."""
 
53
        raise NotImplementedError()
 
54
 
 
55
    def has_id(self, file_id):
 
56
        return self.inventory.has_id(file_id)
 
57
 
 
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)
 
67
 
 
68
    def id2path(self, file_id):
 
69
        return self.inventory.id2path(file_id)
 
70
 
 
71
    def kind(self, file_id):
 
72
        raise NotImplementedError("subclasses must implement kind")
 
73
 
 
74
    def _get_inventory(self):
 
75
        return self._inventory
 
76
    
 
77
    def get_file_by_path(self, path):
 
78
        return self.get_file(self._inventory.path2id(path))
 
79
 
 
80
    inventory = property(_get_inventory,
 
81
                         doc="Inventory of this Tree")
 
82
 
 
83
    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),
 
92
                        ["inventory expects %d bytes" % ie.text_size,
 
93
                         "file is actually %d bytes" % fp['size'],
 
94
                         "store is probably damaged/corrupt"])
 
95
 
 
96
        if ie.text_sha1 != fp['sha1']:
 
97
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
98
                    ["inventory expects %s" % ie.text_sha1,
 
99
                     "file is actually %s" % fp['sha1'],
 
100
                     "store is probably damaged/corrupt"])
 
101
 
 
102
 
 
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
        
 
126
class RevisionTree(Tree):
 
127
    """Tree viewing a previous revision.
 
128
 
 
129
    File text can be retrieved from the text store.
 
130
 
 
131
    TODO: Some kind of `__repr__` method, but a good one
 
132
           probably means knowing the branch and revision number,
 
133
           or at least passing a description to the constructor.
 
134
    """
 
135
    
 
136
    def __init__(self, branch, inv, revision_id):
 
137
        self._branch = branch
 
138
        self._weave_store = branch.weave_store
 
139
        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):
 
151
        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))
 
160
 
 
161
    def get_file_size(self, file_id):
 
162
        return self._inventory[file_id].text_size
 
163
 
 
164
    def get_file_sha1(self, file_id):
 
165
        ie = self._inventory[file_id]
 
166
        if ie.kind == "file":
 
167
            return ie.text_sha1
 
168
 
 
169
    def is_executable(self, file_id):
 
170
        ie = self._inventory[file_id]
 
171
        if ie.kind != "file":
 
172
            return None 
 
173
        return self._inventory[file_id].executable
 
174
 
 
175
    def has_filename(self, filename):
 
176
        return bool(self.inventory.path2id(filename))
 
177
 
 
178
    def list_files(self):
 
179
        # The only files returned by this are those from the version
 
180
        for path, entry in self.inventory.iter_entries():
 
181
            yield path, 'V', entry.kind, entry.file_id, entry
 
182
 
 
183
    def get_symlink_target(self, file_id):
 
184
        ie = self._inventory[file_id]
 
185
        return ie.symlink_target;
 
186
 
 
187
    def kind(self, file_id):
 
188
        return self._inventory[file_id].kind
 
189
 
 
190
    def lock_read(self):
 
191
        self._branch.lock_read()
 
192
 
 
193
    def unlock(self):
 
194
        self._branch.unlock()
 
195
 
 
196
 
 
197
class EmptyTree(Tree):
 
198
    def __init__(self):
 
199
        self._inventory = Inventory()
 
200
 
 
201
    def get_symlink_target(self, file_id):
 
202
        return None
 
203
 
 
204
    def has_filename(self, filename):
 
205
        return False
 
206
 
 
207
    def kind(self, file_id):
 
208
        assert self._inventory[file_id].kind == "root_directory"
 
209
        return "root_directory"
 
210
 
 
211
    def list_files(self):
 
212
        return iter([])
 
213
    
 
214
    def __contains__(self, file_id):
 
215
        return file_id in self._inventory
 
216
 
 
217
    def get_file_sha1(self, file_id):
 
218
        assert self._inventory[file_id].kind == "root_directory"
 
219
        return None
 
220
 
 
221
 
 
222
######################################################################
 
223
# diff
 
224
 
 
225
# TODO: Merge these two functions into a single one that can operate
 
226
# on either a whole tree or a set of files.
 
227
 
 
228
# TODO: Return the diff in order by filename, not by category or in
 
229
# random order.  Can probably be done by lock-stepping through the
 
230
# filenames from both trees.
 
231
 
 
232
 
 
233
def file_status(filename, old_tree, new_tree):
 
234
    """Return single-letter status, old and new names for a file.
 
235
 
 
236
    The complexity here is in deciding how to represent renames;
 
237
    many complex cases are possible.
 
238
    """
 
239
    old_inv = old_tree.inventory
 
240
    new_inv = new_tree.inventory
 
241
    new_id = new_inv.path2id(filename)
 
242
    old_id = old_inv.path2id(filename)
 
243
 
 
244
    if not new_id and not old_id:
 
245
        # easy: doesn't exist in either; not versioned at all
 
246
        if new_tree.is_ignored(filename):
 
247
            return 'I', None, None
 
248
        else:
 
249
            return '?', None, None
 
250
    elif new_id:
 
251
        # There is now a file of this name, great.
 
252
        pass
 
253
    else:
 
254
        # There is no longer a file of this name, but we can describe
 
255
        # what happened to the file that used to have
 
256
        # this name.  There are two possibilities: either it was
 
257
        # deleted entirely, or renamed.
 
258
        assert old_id
 
259
        if new_inv.has_id(old_id):
 
260
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
261
        else:
 
262
            return 'D', old_inv.id2path(old_id), None
 
263
 
 
264
    # if the file_id is new in this revision, it is added
 
265
    if new_id and not old_inv.has_id(new_id):
 
266
        return 'A'
 
267
 
 
268
    # if there used to be a file of this name, but that ID has now
 
269
    # disappeared, it is deleted
 
270
    if old_id and not new_inv.has_id(old_id):
 
271
        return 'D'
 
272
 
 
273
    return 'wtf?'
 
274
 
 
275
    
 
276
 
 
277
def find_renames(old_inv, new_inv):
 
278
    for file_id in old_inv:
 
279
        if file_id not in new_inv:
 
280
            continue
 
281
        old_name = old_inv.id2path(file_id)
 
282
        new_name = new_inv.id2path(file_id)
 
283
        if old_name != new_name:
 
284
            yield (old_name, new_name)
 
285
            
 
286
 
 
287