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.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
31
"""Abstract file tree.
33
There are several subclasses:
35
* `WorkingTree` exists as files on disk editable by the user.
37
* `RevisionTree` is a tree as recorded at some point in the past.
41
Trees contain an `Inventory` object, and also know how to retrieve
42
file texts mentioned in the inventory, either from a working
43
directory or from a store.
45
It is possible for trees to contain files that are not described
46
in their inventory or vice versa; for this use `filenames()`.
48
Trees can be compared, etc, regardless of whether they are working
49
trees or versioned trees.
53
"""Get a list of the conflicts in the tree.
55
Each conflict is an instance of bzrlib.conflicts.Conflict.
59
def get_parent_ids(self):
60
"""Get the parent ids for this tree.
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.
66
raise NotImplementedError(self.get_parent_ids)
68
def has_filename(self, filename):
69
"""True if the tree has given filename."""
70
raise NotImplementedError()
72
def has_id(self, file_id):
73
return self.inventory.has_id(file_id)
75
def has_or_had_id(self, file_id):
76
if file_id == self.inventory.root.file_id:
78
return self.inventory.has_id(file_id)
83
return iter(self.inventory)
85
def id2path(self, file_id):
86
return self.inventory.id2path(file_id)
88
def kind(self, file_id):
89
raise NotImplementedError("subclasses must implement kind")
91
def _get_inventory(self):
92
return self._inventory
94
def get_file_by_path(self, path):
95
return self.get_file(self._inventory.path2id(path))
97
inventory = property(_get_inventory,
98
doc="Inventory of this Tree")
100
def _check_retrieved(self, ie, f):
103
fp = fingerprint_file(f)
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),
109
["inventory expects %d bytes" % ie.text_size,
110
"file is actually %d bytes" % fp['size'],
111
"store is probably damaged/corrupt"])
113
if ie.text_sha1 != fp['sha1']:
114
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
115
["inventory expects %s" % ie.text_sha1,
116
"file is actually %s" % fp['sha1'],
117
"store is probably damaged/corrupt"])
120
def print_file(self, file_id):
121
"""Print file with id `file_id` to stdout."""
123
sys.stdout.write(self.get_file_text(file_id))
129
"""What files are present in this tree and unknown.
131
:return: an iterator over the unknown files.
138
def filter_unversioned_files(self, paths):
139
"""Filter out paths that are not versioned.
141
:return: set of paths.
143
# NB: we specifically *don't* call self.has_filename, because for
144
# WorkingTrees that can indicate files that exist on disk but that
146
pred = self.inventory.has_filename
147
return set((p for p in paths if not pred(p)))
150
class RevisionTree(Tree):
151
"""Tree viewing a previous revision.
153
File text can be retrieved from the text store.
155
TODO: Some kind of `__repr__` method, but a good one
156
probably means knowing the branch and revision number,
157
or at least passing a description to the constructor.
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
168
self._inventory = inv
169
self._revision_id = revision_id
171
def get_parent_ids(self):
172
"""See Tree.get_parent_ids.
174
A RevisionTree's parents match the revision graph.
176
parent_ids = self._repository.get_revision(self._revision_id).parent_ids
179
def get_revision_id(self):
180
"""Return the revision id associated with this tree."""
181
return self._revision_id
183
def get_weave(self, file_id):
184
return self._weave_store.get_weave(file_id,
185
self._repository.get_transaction())
187
def get_file_lines(self, file_id):
188
ie = self._inventory[file_id]
189
weave = self.get_weave(file_id)
190
return weave.get_lines(ie.revision)
192
def get_file_text(self, file_id):
193
return ''.join(self.get_file_lines(file_id))
195
def get_file(self, file_id):
196
return StringIO(self.get_file_text(file_id))
198
def get_file_size(self, file_id):
199
return self._inventory[file_id].text_size
201
def get_file_sha1(self, file_id, path=None):
202
ie = self._inventory[file_id]
203
if ie.kind == "file":
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
212
def is_executable(self, file_id, path=None):
213
ie = self._inventory[file_id]
214
if ie.kind != "file":
216
return self._inventory[file_id].executable
218
def has_filename(self, filename):
219
return bool(self.inventory.path2id(filename))
221
def list_files(self):
222
# The only files returned by this are those from the version
223
for path, entry in self.inventory.iter_entries():
224
yield path, 'V', entry.kind, entry.file_id, entry
226
def get_symlink_target(self, file_id):
227
ie = self._inventory[file_id]
228
return ie.symlink_target;
230
def kind(self, file_id):
231
return self._inventory[file_id].kind
234
self._repository.lock_read()
237
self._repository.unlock()
240
class EmptyTree(Tree):
243
self._inventory = Inventory()
245
def get_parent_ids(self):
246
"""See Tree.get_parent_ids.
248
An EmptyTree always has NULL_REVISION as the only parent.
252
def get_symlink_target(self, file_id):
255
def has_filename(self, filename):
258
def kind(self, file_id):
259
assert self._inventory[file_id].kind == "root_directory"
260
return "root_directory"
262
def list_files(self):
265
def __contains__(self, file_id):
266
return file_id in self._inventory
268
def get_file_sha1(self, file_id, path=None):
269
assert self._inventory[file_id].kind == "root_directory"
273
######################################################################
276
# TODO: Merge these two functions into a single one that can operate
277
# on either a whole tree or a set of files.
279
# TODO: Return the diff in order by filename, not by category or in
280
# random order. Can probably be done by lock-stepping through the
281
# filenames from both trees.
284
def file_status(filename, old_tree, new_tree):
285
"""Return single-letter status, old and new names for a file.
287
The complexity here is in deciding how to represent renames;
288
many complex cases are possible.
290
old_inv = old_tree.inventory
291
new_inv = new_tree.inventory
292
new_id = new_inv.path2id(filename)
293
old_id = old_inv.path2id(filename)
295
if not new_id and not old_id:
296
# easy: doesn't exist in either; not versioned at all
297
if new_tree.is_ignored(filename):
298
return 'I', None, None
300
return '?', None, None
302
# There is now a file of this name, great.
305
# There is no longer a file of this name, but we can describe
306
# what happened to the file that used to have
307
# this name. There are two possibilities: either it was
308
# deleted entirely, or renamed.
310
if new_inv.has_id(old_id):
311
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
313
return 'D', old_inv.id2path(old_id), None
315
# if the file_id is new in this revision, it is added
316
if new_id and not old_inv.has_id(new_id):
319
# if there used to be a file of this name, but that ID has now
320
# disappeared, it is deleted
321
if old_id and not new_inv.has_id(old_id):
328
def find_renames(old_inv, new_inv):
329
for file_id in old_inv:
330
if file_id not in new_inv:
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)
added
removed
bzrlib/tree.py
