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 import delta
26
from bzrlib.decorators import needs_read_lock
27
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib import errors
29
from bzrlib.inventory import Inventory
30
from bzrlib.inter import InterObject
31
from bzrlib.osutils import fingerprint_file
32
import bzrlib.revision
33
from bzrlib.trace import mutter, note
37
"""Abstract file tree.
39
There are several subclasses:
41
* `WorkingTree` exists as files on disk editable by the user.
43
* `RevisionTree` is a tree as recorded at some point in the past.
45
Trees contain an `Inventory` object, and also know how to retrieve
46
file texts mentioned in the inventory, either from a working
47
directory or from a store.
49
It is possible for trees to contain files that are not described
50
in their inventory or vice versa; for this use `filenames()`.
52
Trees can be compared, etc, regardless of whether they are working
53
trees or versioned trees.
56
def changes_from(self, other, want_unchanged=False, specific_files=None,
57
extra_trees=None, require_versioned=False, include_root=False):
58
"""Return a TreeDelta of the changes from other to this tree.
60
:param other: A tree to compare with.
61
:param specific_files: An optional list of file paths to restrict the
62
comparison to. When mapping filenames to ids, all matches in all
63
trees (including optional extra_trees) are used, and all children of
64
matched directories are included.
65
:param want_unchanged: An optional boolean requesting the inclusion of
66
unchanged entries in the result.
67
:param extra_trees: An optional list of additional trees to use when
68
mapping the contents of specific_files (paths) to file_ids.
69
:param require_versioned: An optional boolean (defaults to False). When
70
supplied and True all the 'specific_files' must be versioned, or
71
a PathsNotVersionedError will be thrown.
73
The comparison will be performed by an InterTree object looked up on
76
# Martin observes that Tree.changes_from returns a TreeDelta and this
77
# may confuse people, because the class name of the returned object is
78
# a synonym of the object referenced in the method name.
79
return InterTree.get(other, self).compare(
80
want_unchanged=want_unchanged,
81
specific_files=specific_files,
82
extra_trees=extra_trees,
83
require_versioned=require_versioned,
84
include_root=include_root
88
"""Get a list of the conflicts in the tree.
90
Each conflict is an instance of bzrlib.conflicts.Conflict.
94
def get_parent_ids(self):
95
"""Get the parent ids for this tree.
97
:return: a list of parent ids. [] is returned to indicate
98
a tree with no parents.
99
:raises: BzrError if the parents are not known.
101
raise NotImplementedError(self.get_parent_ids)
103
def has_filename(self, filename):
104
"""True if the tree has given filename."""
105
raise NotImplementedError()
107
def has_id(self, file_id):
108
return self.inventory.has_id(file_id)
110
__contains__ = has_id
112
def has_or_had_id(self, file_id):
113
if file_id == self.inventory.root.file_id:
115
return self.inventory.has_id(file_id)
118
return iter(self.inventory)
120
def id2path(self, file_id):
121
return self.inventory.id2path(file_id)
123
def iter_entries_by_dir(self):
124
"""Walk the tree in 'by_dir' order.
126
This will yield each entry in the tree as a (path, entry) tuple. The
127
order that they are yielded is: the contents of a directory are
128
preceeded by the parent of a directory, and all the contents of a
129
directory are grouped together.
131
return self.inventory.iter_entries_by_dir()
133
def kind(self, file_id):
134
raise NotImplementedError("subclasses must implement kind")
136
def _get_inventory(self):
137
return self._inventory
139
def get_file_by_path(self, path):
140
return self.get_file(self._inventory.path2id(path))
142
inventory = property(_get_inventory,
143
doc="Inventory of this Tree")
145
def _check_retrieved(self, ie, f):
148
fp = fingerprint_file(f)
151
if ie.text_size != None:
152
if ie.text_size != fp['size']:
153
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
154
["inventory expects %d bytes" % ie.text_size,
155
"file is actually %d bytes" % fp['size'],
156
"store is probably damaged/corrupt"])
158
if ie.text_sha1 != fp['sha1']:
159
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
160
["inventory expects %s" % ie.text_sha1,
161
"file is actually %s" % fp['sha1'],
162
"store is probably damaged/corrupt"])
165
def print_file(self, file_id):
166
"""Print file with id `file_id` to stdout."""
168
sys.stdout.write(self.get_file_text(file_id))
174
"""What files are present in this tree and unknown.
176
:return: an iterator over the unknown files.
183
def filter_unversioned_files(self, paths):
184
"""Filter out paths that are not versioned.
186
:return: set of paths.
188
# NB: we specifically *don't* call self.has_filename, because for
189
# WorkingTrees that can indicate files that exist on disk but that
191
pred = self.inventory.has_filename
192
return set((p for p in paths if not pred(p)))
196
from bzrlib.revisiontree import RevisionTree
199
class EmptyTree(Tree):
202
self._inventory = Inventory(root_id=None)
203
warn('EmptyTree is deprecated as of bzr 0.9 please use '
204
'repository.revision_tree instead.',
205
DeprecationWarning, stacklevel=2)
207
def get_parent_ids(self):
210
def get_symlink_target(self, file_id):
213
def has_filename(self, filename):
216
def list_files(self, include_root=True):
219
def __contains__(self, file_id):
220
return file_id in self._inventory
222
def get_file_sha1(self, file_id, path=None):
226
######################################################################
229
# TODO: Merge these two functions into a single one that can operate
230
# on either a whole tree or a set of files.
232
# TODO: Return the diff in order by filename, not by category or in
233
# random order. Can probably be done by lock-stepping through the
234
# filenames from both trees.
237
def file_status(filename, old_tree, new_tree):
238
"""Return single-letter status, old and new names for a file.
240
The complexity here is in deciding how to represent renames;
241
many complex cases are possible.
243
old_inv = old_tree.inventory
244
new_inv = new_tree.inventory
245
new_id = new_inv.path2id(filename)
246
old_id = old_inv.path2id(filename)
248
if not new_id and not old_id:
249
# easy: doesn't exist in either; not versioned at all
250
if new_tree.is_ignored(filename):
251
return 'I', None, None
253
return '?', None, None
255
# There is now a file of this name, great.
258
# There is no longer a file of this name, but we can describe
259
# what happened to the file that used to have
260
# this name. There are two possibilities: either it was
261
# deleted entirely, or renamed.
263
if new_inv.has_id(old_id):
264
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
266
return 'D', old_inv.id2path(old_id), None
268
# if the file_id is new in this revision, it is added
269
if new_id and not old_inv.has_id(new_id):
272
# if there used to be a file of this name, but that ID has now
273
# disappeared, it is deleted
274
if old_id and not new_inv.has_id(old_id):
281
def find_renames(old_inv, new_inv):
282
for file_id in old_inv:
283
if file_id not in new_inv:
285
old_name = old_inv.id2path(file_id)
286
new_name = new_inv.id2path(file_id)
287
if old_name != new_name:
288
yield (old_name, new_name)
291
def find_ids_across_trees(filenames, trees, require_versioned=True):
292
"""Find the ids corresponding to specified filenames.
294
All matches in all trees will be used, and all children of matched
295
directories will be used.
297
:param filenames: The filenames to find file_ids for
298
:param trees: The trees to find file_ids within
299
:param require_versioned: if true, all specified filenames must occur in
301
:return: a set of file ids for the specified filenames and their children.
305
specified_ids = _find_filename_ids_across_trees(filenames, trees,
307
return _find_children_across_trees(specified_ids, trees)
310
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
311
"""Find the ids corresponding to specified filenames.
313
All matches in all trees will be used.
315
:param filenames: The filenames to find file_ids for
316
:param trees: The trees to find file_ids within
317
:param require_versioned: if true, all specified filenames must occur in
319
:return: a set of file ids for the specified filenames
322
interesting_ids = set()
323
for tree_path in filenames:
326
file_id = tree.inventory.path2id(tree_path)
327
if file_id is not None:
328
interesting_ids.add(file_id)
331
not_versioned.append(tree_path)
332
if len(not_versioned) > 0 and require_versioned:
333
raise errors.PathsNotVersionedError(not_versioned)
334
return interesting_ids
337
def _find_children_across_trees(specified_ids, trees):
338
"""Return a set including specified ids and their children
340
All matches in all trees will be used.
342
:param trees: The trees to find file_ids within
343
:return: a set containing all specified ids and their children
345
interesting_ids = set(specified_ids)
346
pending = interesting_ids
347
# now handle children of interesting ids
348
# we loop so that we handle all children of each id in both trees
349
while len(pending) > 0:
351
for file_id in pending:
353
if file_id not in tree:
355
entry = tree.inventory[file_id]
356
for child in getattr(entry, 'children', {}).itervalues():
357
if child.file_id not in interesting_ids:
358
new_pending.add(child.file_id)
359
interesting_ids.update(new_pending)
360
pending = new_pending
361
return interesting_ids
364
class InterTree(InterObject):
365
"""This class represents operations taking place between two Trees.
367
Its instances have methods like 'compare' and contain references to the
368
source and target trees these operations are to be carried out on.
370
clients of bzrlib should not need to use InterTree directly, rather they
371
should use the convenience methods on Tree such as 'Tree.compare()' which
372
will pass through to InterTree as appropriate.
378
def compare(self, want_unchanged=False, specific_files=None,
379
extra_trees=None, require_versioned=False, include_root=False):
380
"""Return the changes from source to target.
382
:return: A TreeDelta.
383
:param specific_files: An optional list of file paths to restrict the
384
comparison to. When mapping filenames to ids, all matches in all
385
trees (including optional extra_trees) are used, and all children of
386
matched directories are included.
387
:param want_unchanged: An optional boolean requesting the inclusion of
388
unchanged entries in the result.
389
:param extra_trees: An optional list of additional trees to use when
390
mapping the contents of specific_files (paths) to file_ids.
391
:param require_versioned: An optional boolean (defaults to False). When
392
supplied and True all the 'specific_files' must be versioned, or
393
a PathsNotVersionedError will be thrown.
395
# NB: show_status depends on being able to pass in non-versioned files and
396
# report them as unknown
397
trees = (self.source, self.target)
398
if extra_trees is not None:
399
trees = trees + tuple(extra_trees)
400
specific_file_ids = find_ids_across_trees(specific_files,
401
trees, require_versioned=require_versioned)
402
if specific_files and not specific_file_ids:
403
# All files are unversioned, so just return an empty delta
404
# _compare_trees would think we want a complete delta
405
return delta.TreeDelta()
406
return delta._compare_trees(self.source, self.target, want_unchanged,
407
specific_file_ids, include_root=include_root)
added
removed
bzrlib/tree.py
