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):
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,
87
"""Get a list of the conflicts in the tree.
89
Each conflict is an instance of bzrlib.conflicts.Conflict.
93
def get_parent_ids(self):
94
"""Get the parent ids for this tree.
96
:return: a list of parent ids. [] is returned to indicate
97
a tree with no parents.
98
:raises: BzrError if the parents are not known.
100
raise NotImplementedError(self.get_parent_ids)
102
def has_filename(self, filename):
103
"""True if the tree has given filename."""
104
raise NotImplementedError()
106
def has_id(self, file_id):
107
return self.inventory.has_id(file_id)
109
__contains__ = has_id
111
def has_or_had_id(self, file_id):
112
if file_id == self.inventory.root.file_id:
114
return self.inventory.has_id(file_id)
117
return iter(self.inventory)
119
def id2path(self, file_id):
120
return self.inventory.id2path(file_id)
122
def iter_entries_by_dir(self):
123
"""Walk the tree in 'by_dir' order.
125
This will yield each entry in the tree as a (path, entry) tuple. The
126
order that they are yielded is: the contents of a directory are
127
preceeded by the parent of a directory, and all the contents of a
128
directory are grouped together.
130
return self.inventory.iter_entries_by_dir()
132
def kind(self, file_id):
133
raise NotImplementedError("subclasses must implement kind")
135
def _get_inventory(self):
136
return self._inventory
138
def get_file_by_path(self, path):
139
return self.get_file(self._inventory.path2id(path))
141
inventory = property(_get_inventory,
142
doc="Inventory of this Tree")
144
def _check_retrieved(self, ie, f):
147
fp = fingerprint_file(f)
150
if ie.text_size is not None:
151
if ie.text_size != fp['size']:
152
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
153
["inventory expects %d bytes" % ie.text_size,
154
"file is actually %d bytes" % fp['size'],
155
"store is probably damaged/corrupt"])
157
if ie.text_sha1 != fp['sha1']:
158
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
159
["inventory expects %s" % ie.text_sha1,
160
"file is actually %s" % fp['sha1'],
161
"store is probably damaged/corrupt"])
164
def print_file(self, file_id):
165
"""Print file with id `file_id` to stdout."""
167
sys.stdout.write(self.get_file_text(file_id))
173
"""What files are present in this tree and unknown.
175
:return: an iterator over the unknown files.
182
def filter_unversioned_files(self, paths):
183
"""Filter out paths that are not versioned.
185
:return: set of paths.
187
# NB: we specifically *don't* call self.has_filename, because for
188
# WorkingTrees that can indicate files that exist on disk but that
190
pred = self.inventory.has_filename
191
return set((p for p in paths if not pred(p)))
195
from bzrlib.revisiontree import RevisionTree
198
class EmptyTree(Tree):
201
self._inventory = Inventory()
202
warn('EmptyTree is deprecated as of bzr 0.9 please use '
203
'repository.revision_tree instead.',
204
DeprecationWarning, stacklevel=2)
206
def get_parent_ids(self):
209
def get_symlink_target(self, file_id):
212
def has_filename(self, filename):
215
def kind(self, file_id):
216
assert self._inventory[file_id].kind == "directory"
219
def list_files(self):
222
def __contains__(self, file_id):
223
return (file_id in self._inventory)
225
def get_file_sha1(self, file_id, path=None):
229
######################################################################
232
# TODO: Merge these two functions into a single one that can operate
233
# on either a whole tree or a set of files.
235
# TODO: Return the diff in order by filename, not by category or in
236
# random order. Can probably be done by lock-stepping through the
237
# filenames from both trees.
240
def file_status(filename, old_tree, new_tree):
241
"""Return single-letter status, old and new names for a file.
243
The complexity here is in deciding how to represent renames;
244
many complex cases are possible.
246
old_inv = old_tree.inventory
247
new_inv = new_tree.inventory
248
new_id = new_inv.path2id(filename)
249
old_id = old_inv.path2id(filename)
251
if not new_id and not old_id:
252
# easy: doesn't exist in either; not versioned at all
253
if new_tree.is_ignored(filename):
254
return 'I', None, None
256
return '?', None, None
258
# There is now a file of this name, great.
261
# There is no longer a file of this name, but we can describe
262
# what happened to the file that used to have
263
# this name. There are two possibilities: either it was
264
# deleted entirely, or renamed.
266
if new_inv.has_id(old_id):
267
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
269
return 'D', old_inv.id2path(old_id), None
271
# if the file_id is new in this revision, it is added
272
if new_id and not old_inv.has_id(new_id):
275
# if there used to be a file of this name, but that ID has now
276
# disappeared, it is deleted
277
if old_id and not new_inv.has_id(old_id):
284
def find_renames(old_inv, new_inv):
285
for file_id in old_inv:
286
if file_id not in new_inv:
288
old_name = old_inv.id2path(file_id)
289
new_name = new_inv.id2path(file_id)
290
if old_name != new_name:
291
yield (old_name, new_name)
294
def find_ids_across_trees(filenames, trees, require_versioned=True):
295
"""Find the ids corresponding to specified filenames.
297
All matches in all trees will be used, and all children of matched
298
directories will be used.
300
:param filenames: The filenames to find file_ids for
301
:param trees: The trees to find file_ids within
302
:param require_versioned: if true, all specified filenames must occur in
304
:return: a set of file ids for the specified filenames and their children.
308
specified_ids = _find_filename_ids_across_trees(filenames, trees,
310
return _find_children_across_trees(specified_ids, trees)
313
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
314
"""Find the ids corresponding to specified filenames.
316
All matches in all trees will be used.
318
:param filenames: The filenames to find file_ids for
319
:param trees: The trees to find file_ids within
320
:param require_versioned: if true, all specified filenames must occur in
322
:return: a set of file ids for the specified filenames
325
interesting_ids = set()
326
for tree_path in filenames:
329
file_id = tree.inventory.path2id(tree_path)
330
if file_id is not None:
331
interesting_ids.add(file_id)
334
not_versioned.append(tree_path)
335
if len(not_versioned) > 0 and require_versioned:
336
raise errors.PathsNotVersionedError(not_versioned)
337
return interesting_ids
340
def _find_children_across_trees(specified_ids, trees):
341
"""Return a set including specified ids and their children
343
All matches in all trees will be used.
345
:param trees: The trees to find file_ids within
346
:return: a set containing all specified ids and their children
348
interesting_ids = set(specified_ids)
349
pending = interesting_ids
350
# now handle children of interesting ids
351
# we loop so that we handle all children of each id in both trees
352
while len(pending) > 0:
354
for file_id in pending:
356
if file_id not in tree:
358
entry = tree.inventory[file_id]
359
for child in getattr(entry, 'children', {}).itervalues():
360
if child.file_id not in interesting_ids:
361
new_pending.add(child.file_id)
362
interesting_ids.update(new_pending)
363
pending = new_pending
364
return interesting_ids
367
class InterTree(InterObject):
368
"""This class represents operations taking place between two Trees.
370
Its instances have methods like 'compare' and contain references to the
371
source and target trees these operations are to be carried out on.
373
clients of bzrlib should not need to use InterTree directly, rather they
374
should use the convenience methods on Tree such as 'Tree.compare()' which
375
will pass through to InterTree as appropriate.
381
def compare(self, want_unchanged=False, specific_files=None,
382
extra_trees=None, require_versioned=False):
383
"""Return the changes from source to target.
385
:return: A TreeDelta.
386
:param specific_files: An optional list of file paths to restrict the
387
comparison to. When mapping filenames to ids, all matches in all
388
trees (including optional extra_trees) are used, and all children of
389
matched directories are included.
390
:param want_unchanged: An optional boolean requesting the inclusion of
391
unchanged entries in the result.
392
:param extra_trees: An optional list of additional trees to use when
393
mapping the contents of specific_files (paths) to file_ids.
394
:param require_versioned: An optional boolean (defaults to False). When
395
supplied and True all the 'specific_files' must be versioned, or
396
a PathsNotVersionedError will be thrown.
398
# NB: show_status depends on being able to pass in non-versioned files and
399
# report them as unknown
400
trees = (self.source, self.target)
401
if extra_trees is not None:
402
trees = trees + tuple(extra_trees)
403
specific_file_ids = find_ids_across_trees(specific_files,
404
trees, require_versioned=require_versioned)
405
if specific_files and not specific_file_ids:
406
# All files are unversioned, so just return an empty delta
407
# _compare_trees would think we want a complete delta
408
return delta.TreeDelta()
409
return delta._compare_trees(self.source, self.target, want_unchanged,
added
removed
bzrlib/tree.py
