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
22
from warnings import warn
25
from bzrlib.errors import BzrError, BzrCheckError
26
from bzrlib import errors
27
from bzrlib.inventory import Inventory
28
from bzrlib.osutils import fingerprint_file
29
import bzrlib.revision
30
from bzrlib.trace import mutter, note
34
"""Abstract file tree.
36
There are several subclasses:
38
* `WorkingTree` exists as files on disk editable by the user.
40
* `RevisionTree` is a tree as recorded at some point in the past.
42
Trees contain an `Inventory` object, and also know how to retrieve
43
file texts mentioned in the inventory, either from a working
44
directory or from a store.
46
It is possible for trees to contain files that are not described
47
in their inventory or vice versa; for this use `filenames()`.
49
Trees can be compared, etc, regardless of whether they are working
50
trees or versioned trees.
54
"""Get a list of the conflicts in the tree.
56
Each conflict is an instance of bzrlib.conflicts.Conflict.
60
def get_parent_ids(self):
61
"""Get the parent ids for this tree.
63
:return: a list of parent ids. [] is returned to indicate
64
a tree with no parents.
65
:raises: BzrError if the parents are not known.
67
raise NotImplementedError(self.get_parent_ids)
69
def has_filename(self, filename):
70
"""True if the tree has given filename."""
71
raise NotImplementedError()
73
def has_id(self, file_id):
74
return self.inventory.has_id(file_id)
76
def has_or_had_id(self, file_id):
77
if file_id == self.inventory.root.file_id:
79
return self.inventory.has_id(file_id)
84
return iter(self.inventory)
86
def id2path(self, file_id):
87
return self.inventory.id2path(file_id)
89
def kind(self, file_id):
90
raise NotImplementedError("subclasses must implement kind")
92
def _get_inventory(self):
93
return self._inventory
95
def get_file_by_path(self, path):
96
return self.get_file(self._inventory.path2id(path))
98
inventory = property(_get_inventory,
99
doc="Inventory of this Tree")
101
def _check_retrieved(self, ie, f):
104
fp = fingerprint_file(f)
107
if ie.text_size != None:
108
if ie.text_size != fp['size']:
109
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
110
["inventory expects %d bytes" % ie.text_size,
111
"file is actually %d bytes" % fp['size'],
112
"store is probably damaged/corrupt"])
114
if ie.text_sha1 != fp['sha1']:
115
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
116
["inventory expects %s" % ie.text_sha1,
117
"file is actually %s" % fp['sha1'],
118
"store is probably damaged/corrupt"])
121
def print_file(self, file_id):
122
"""Print file with id `file_id` to stdout."""
124
sys.stdout.write(self.get_file_text(file_id))
130
"""What files are present in this tree and unknown.
132
:return: an iterator over the unknown files.
139
def filter_unversioned_files(self, paths):
140
"""Filter out paths that are not versioned.
142
:return: set of paths.
144
# NB: we specifically *don't* call self.has_filename, because for
145
# WorkingTrees that can indicate files that exist on disk but that
147
pred = self.inventory.has_filename
148
return set((p for p in paths if not pred(p)))
152
from bzrlib.revisiontree import RevisionTree
155
class EmptyTree(Tree):
158
self._inventory = Inventory()
159
warn('EmptyTree is deprecated as of bzr 0.9 please use '
160
'repository.revision_tree instead.',
161
DeprecationWarning, stacklevel=2)
163
def get_parent_ids(self):
166
def get_symlink_target(self, file_id):
169
def has_filename(self, filename):
172
def kind(self, file_id):
173
assert self._inventory[file_id].kind == "root_directory"
174
return "root_directory"
176
def list_files(self):
179
def __contains__(self, file_id):
180
return file_id in self._inventory
182
def get_file_sha1(self, file_id, path=None):
183
assert self._inventory[file_id].kind == "root_directory"
187
######################################################################
190
# TODO: Merge these two functions into a single one that can operate
191
# on either a whole tree or a set of files.
193
# TODO: Return the diff in order by filename, not by category or in
194
# random order. Can probably be done by lock-stepping through the
195
# filenames from both trees.
198
def file_status(filename, old_tree, new_tree):
199
"""Return single-letter status, old and new names for a file.
201
The complexity here is in deciding how to represent renames;
202
many complex cases are possible.
204
old_inv = old_tree.inventory
205
new_inv = new_tree.inventory
206
new_id = new_inv.path2id(filename)
207
old_id = old_inv.path2id(filename)
209
if not new_id and not old_id:
210
# easy: doesn't exist in either; not versioned at all
211
if new_tree.is_ignored(filename):
212
return 'I', None, None
214
return '?', None, None
216
# There is now a file of this name, great.
219
# There is no longer a file of this name, but we can describe
220
# what happened to the file that used to have
221
# this name. There are two possibilities: either it was
222
# deleted entirely, or renamed.
224
if new_inv.has_id(old_id):
225
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
227
return 'D', old_inv.id2path(old_id), None
229
# if the file_id is new in this revision, it is added
230
if new_id and not old_inv.has_id(new_id):
233
# if there used to be a file of this name, but that ID has now
234
# disappeared, it is deleted
235
if old_id and not new_inv.has_id(old_id):
242
def find_renames(old_inv, new_inv):
243
for file_id in old_inv:
244
if file_id not in new_inv:
246
old_name = old_inv.id2path(file_id)
247
new_name = new_inv.id2path(file_id)
248
if old_name != new_name:
249
yield (old_name, new_name)
252
def find_ids_across_trees(filenames, trees, require_versioned=True):
253
"""Find the ids corresponding to specified filenames.
255
All matches in all trees will be used, and all children of matched
256
directories will be used.
258
:param filenames: The filenames to find file_ids for
259
:param trees: The trees to find file_ids within
260
:param require_versioned: if true, all specified filenames must occur in
262
:return: a set of file ids for the specified filenames and their children.
266
specified_ids = _find_filename_ids_across_trees(filenames, trees,
268
return _find_children_across_trees(specified_ids, trees)
271
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
272
"""Find the ids corresponding to specified filenames.
274
All matches in all trees will be used.
276
:param filenames: The filenames to find file_ids for
277
:param trees: The trees to find file_ids within
278
:param require_versioned: if true, all specified filenames must occur in
280
:return: a set of file ids for the specified filenames
283
interesting_ids = set()
284
for tree_path in filenames:
287
file_id = tree.inventory.path2id(tree_path)
288
if file_id is not None:
289
interesting_ids.add(file_id)
292
not_versioned.append(tree_path)
293
if len(not_versioned) > 0 and require_versioned:
294
raise errors.PathsNotVersionedError(not_versioned)
295
return interesting_ids
298
def _find_children_across_trees(specified_ids, trees):
299
"""Return a set including specified ids and their children
301
All matches in all trees will be used.
303
:param trees: The trees to find file_ids within
304
:return: a set containing all specified ids and their children
306
interesting_ids = set(specified_ids)
307
pending = interesting_ids
308
# now handle children of interesting ids
309
# we loop so that we handle all children of each id in both trees
310
while len(pending) > 0:
312
for file_id in pending:
314
if file_id not in tree:
316
entry = tree.inventory[file_id]
317
for child in getattr(entry, 'children', {}).itervalues():
318
if child.file_id not in interesting_ids:
319
new_pending.add(child.file_id)
320
interesting_ids.update(new_pending)
321
pending = new_pending
322
return interesting_ids
added
removed
bzrlib/tree.py
