1
# Copyright (C) 2005 Canonical Ltd
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.
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.
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
17
"""Tree classes, representing directory at point in time.
21
from cStringIO import StringIO
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
30
"""Abstract file tree.
32
There are several subclasses:
34
* `WorkingTree` exists as files on disk editable by the user.
36
* `RevisionTree` is a tree as recorded at some point in the past.
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.
44
It is possible for trees to contain files that are not described
45
in their inventory or vice versa; for this use `filenames()`.
47
Trees can be compared, etc, regardless of whether they are working
48
trees or versioned trees.
51
def has_filename(self, filename):
52
"""True if the tree has given filename."""
53
raise NotImplementedError()
55
def has_id(self, file_id):
56
return self.inventory.has_id(file_id)
58
def has_or_had_id(self, file_id):
59
if file_id == self.inventory.root.file_id:
61
return self.inventory.has_id(file_id)
66
return iter(self.inventory)
68
def id2path(self, file_id):
69
return self.inventory.id2path(file_id)
71
def kind(self, file_id):
72
raise NotImplementedError("subclasses must implement kind")
74
def _get_inventory(self):
75
return self._inventory
77
def get_file_by_path(self, path):
78
return self.get_file(self._inventory.path2id(path))
80
inventory = property(_get_inventory,
81
doc="Inventory of this Tree")
83
def _check_retrieved(self, ie, f):
86
fp = fingerprint_file(f)
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"])
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"])
103
def print_file(self, file_id):
104
"""Print file with id `file_id` to stdout."""
106
sys.stdout.write(self.get_file_text(file_id))
115
class RevisionTree(Tree):
116
"""Tree viewing a previous revision.
118
File text can be retrieved from the text store.
120
TODO: Some kind of `__repr__` method, but a good one
121
probably means knowing the branch and revision number,
122
or at least passing a description to the constructor.
125
def __init__(self, branch, inv, revision_id):
126
self._branch = branch
127
self._weave_store = branch.weave_store
128
self._inventory = inv
129
self._revision_id = revision_id
131
def get_weave(self, file_id):
132
return self._weave_store.get_weave(file_id,
133
self._branch.get_transaction())
135
def get_weave_prelude(self, file_id):
136
return self._weave_store.get_weave_prelude(file_id,
137
self._branch.get_transaction())
139
def get_file_lines(self, file_id):
140
ie = self._inventory[file_id]
141
weave = self.get_weave(file_id)
142
return weave.get_lines(ie.revision)
144
def get_file_text(self, file_id):
145
return ''.join(self.get_file_lines(file_id))
147
def get_file(self, file_id):
148
return StringIO(self.get_file_text(file_id))
150
def get_file_size(self, file_id):
151
return self._inventory[file_id].text_size
153
def get_file_sha1(self, file_id):
154
ie = self._inventory[file_id]
155
if ie.kind == "file":
158
def is_executable(self, file_id):
159
ie = self._inventory[file_id]
160
if ie.kind != "file":
162
return self._inventory[file_id].executable
164
def has_filename(self, filename):
165
return bool(self.inventory.path2id(filename))
167
def list_files(self):
168
# The only files returned by this are those from the version
169
for path, entry in self.inventory.iter_entries():
170
yield path, 'V', entry.kind, entry.file_id, entry
172
def get_symlink_target(self, file_id):
173
ie = self._inventory[file_id]
174
return ie.symlink_target;
176
def kind(self, file_id):
177
return self._inventory[file_id].kind
180
self._branch.lock_read()
183
self._branch.unlock()
186
class EmptyTree(Tree):
188
self._inventory = Inventory()
190
def get_symlink_target(self, file_id):
193
def has_filename(self, filename):
196
def kind(self, file_id):
197
assert self._inventory[file_id].kind == "root_directory"
198
return "root_directory"
200
def list_files(self):
203
def __contains__(self, file_id):
204
return file_id in self._inventory
206
def get_file_sha1(self, file_id):
207
assert self._inventory[file_id].kind == "root_directory"
211
######################################################################
214
# TODO: Merge these two functions into a single one that can operate
215
# on either a whole tree or a set of files.
217
# TODO: Return the diff in order by filename, not by category or in
218
# random order. Can probably be done by lock-stepping through the
219
# filenames from both trees.
222
def file_status(filename, old_tree, new_tree):
223
"""Return single-letter status, old and new names for a file.
225
The complexity here is in deciding how to represent renames;
226
many complex cases are possible.
228
old_inv = old_tree.inventory
229
new_inv = new_tree.inventory
230
new_id = new_inv.path2id(filename)
231
old_id = old_inv.path2id(filename)
233
if not new_id and not old_id:
234
# easy: doesn't exist in either; not versioned at all
235
if new_tree.is_ignored(filename):
236
return 'I', None, None
238
return '?', None, None
240
# There is now a file of this name, great.
243
# There is no longer a file of this name, but we can describe
244
# what happened to the file that used to have
245
# this name. There are two possibilities: either it was
246
# deleted entirely, or renamed.
248
if new_inv.has_id(old_id):
249
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
251
return 'D', old_inv.id2path(old_id), None
253
# if the file_id is new in this revision, it is added
254
if new_id and not old_inv.has_id(new_id):
257
# if there used to be a file of this name, but that ID has now
258
# disappeared, it is deleted
259
if old_id and not new_inv.has_id(old_id):
266
def find_renames(old_inv, new_inv):
267
for file_id in old_inv:
268
if file_id not in new_inv:
270
old_name = old_inv.id2path(file_id)
271
new_name = new_inv.id2path(file_id)
272
if old_name != new_name:
273
yield (old_name, new_name)
added
removed
bzrlib/tree.py
