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
29
from bzrlib.decorators import needs_read_lock
30
from bzrlib.errors import BzrError, BzrCheckError
31
from bzrlib import errors
32
from bzrlib.inventory import Inventory
33
from bzrlib.inter import InterObject
34
from bzrlib.osutils import fingerprint_file
35
import bzrlib.revision
36
from bzrlib.trace import mutter, note
40
"""Abstract file tree.
42
There are several subclasses:
44
* `WorkingTree` exists as files on disk editable by the user.
46
* `RevisionTree` is a tree as recorded at some point in the past.
48
Trees contain an `Inventory` object, and also know how to retrieve
49
file texts mentioned in the inventory, either from a working
50
directory or from a store.
52
It is possible for trees to contain files that are not described
53
in their inventory or vice versa; for this use `filenames()`.
55
Trees can be compared, etc, regardless of whether they are working
56
trees or versioned trees.
59
def changes_from(self, other, want_unchanged=False, specific_files=None,
60
extra_trees=None, require_versioned=False, include_root=False):
61
"""Return a TreeDelta of the changes from other to this tree.
63
:param other: A tree to compare with.
64
:param specific_files: An optional list of file paths to restrict the
65
comparison to. When mapping filenames to ids, all matches in all
66
trees (including optional extra_trees) are used, and all children of
67
matched directories are included.
68
:param want_unchanged: An optional boolean requesting the inclusion of
69
unchanged entries in the result.
70
:param extra_trees: An optional list of additional trees to use when
71
mapping the contents of specific_files (paths) to file_ids.
72
:param require_versioned: An optional boolean (defaults to False). When
73
supplied and True all the 'specific_files' must be versioned, or
74
a PathsNotVersionedError will be thrown.
76
The comparison will be performed by an InterTree object looked up on
79
# Martin observes that Tree.changes_from returns a TreeDelta and this
80
# may confuse people, because the class name of the returned object is
81
# a synonym of the object referenced in the method name.
82
return InterTree.get(other, self).compare(
83
want_unchanged=want_unchanged,
84
specific_files=specific_files,
85
extra_trees=extra_trees,
86
require_versioned=require_versioned,
87
include_root=include_root
90
def _iter_changes(self, from_tree, include_unchanged=False,
91
specific_file_ids=None, pb=None):
92
intertree = InterTree.get(from_tree, self)
93
return intertree._iter_changes(from_tree, self, include_unchanged,
94
specific_file_ids, pb)
97
"""Get a list of the conflicts in the tree.
99
Each conflict is an instance of bzrlib.conflicts.Conflict.
103
def get_parent_ids(self):
104
"""Get the parent ids for this tree.
106
:return: a list of parent ids. [] is returned to indicate
107
a tree with no parents.
108
:raises: BzrError if the parents are not known.
110
raise NotImplementedError(self.get_parent_ids)
112
def has_filename(self, filename):
113
"""True if the tree has given filename."""
114
raise NotImplementedError()
116
def has_id(self, file_id):
117
return self.inventory.has_id(file_id)
119
__contains__ = has_id
121
def has_or_had_id(self, file_id):
122
if file_id == self.inventory.root.file_id:
124
return self.inventory.has_id(file_id)
127
return iter(self.inventory)
129
def id2path(self, file_id):
130
return self.inventory.id2path(file_id)
132
def is_control_filename(self, filename):
133
"""True if filename is the name of a control file in this tree.
135
:param filename: A filename within the tree. This is a relative path
136
from the root of this tree.
138
This is true IF and ONLY IF the filename is part of the meta data
139
that bzr controls in this tree. I.E. a random .bzr directory placed
140
on disk will not be a control file for this tree.
142
return self.bzrdir.is_control_filename(filename)
145
def iter_entries_by_dir(self, specific_file_ids=None):
146
"""Walk the tree in 'by_dir' order.
148
This will yield each entry in the tree as a (path, entry) tuple. The
149
order that they are yielded is: the contents of a directory are
150
preceeded by the parent of a directory, and all the contents of a
151
directory are grouped together.
153
return self.inventory.iter_entries_by_dir(
154
specific_file_ids=specific_file_ids)
156
def kind(self, file_id):
157
raise NotImplementedError("subclasses must implement kind")
159
def _comparison_data(self, entry, path):
160
"""Return a tuple of kind, executable, stat_value for a file.
162
entry may be None if there is no inventory entry for the file, but
163
path must always be supplied.
165
kind is None if there is no file present (even if an inventory id is
166
present). executable is False for non-file entries.
168
raise NotImplementedError(self._comparison_data)
170
def _file_size(self, entry, stat_value):
171
raise NotImplementedError(self._file_size)
173
def _get_inventory(self):
174
return self._inventory
176
def get_file(self, file_id):
177
"""Return a file object for the file file_id in the tree."""
178
raise NotImplementedError(self.get_file)
180
def get_file_by_path(self, path):
181
return self.get_file(self._inventory.path2id(path))
183
def annotate_iter(self, file_id):
184
"""Return an iterator of revision_id, line tuples
186
For working trees (and mutable trees in general), the special
187
revision_id 'current:' will be used for lines that are new in this
188
tree, e.g. uncommitted changes.
189
:param file_id: The file to produce an annotated version from
191
raise NotImplementedError(self.annotate_iter)
193
inventory = property(_get_inventory,
194
doc="Inventory of this Tree")
196
def _check_retrieved(self, ie, f):
199
fp = fingerprint_file(f)
202
if ie.text_size is not None:
203
if ie.text_size != fp['size']:
204
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
205
["inventory expects %d bytes" % ie.text_size,
206
"file is actually %d bytes" % fp['size'],
207
"store is probably damaged/corrupt"])
209
if ie.text_sha1 != fp['sha1']:
210
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
211
["inventory expects %s" % ie.text_sha1,
212
"file is actually %s" % fp['sha1'],
213
"store is probably damaged/corrupt"])
215
def path2id(self, path):
216
"""Return the id for path in this tree."""
217
return self._inventory.path2id(path)
219
def paths2ids(self, paths, trees=[], require_versioned=True):
220
"""Return all the ids that can be reached by walking from paths.
222
Each path is looked up in each this tree and any extras provided in
223
trees, and this is repeated recursively: the children in an extra tree
224
of a directory that has been renamed under a provided path in this tree
225
are all returned, even if none exist until a provided path in this
226
tree, and vice versa.
228
:param paths: An iterable of paths to start converting to ids from.
229
Alternatively, if paths is None, no ids should be calculated and None
230
will be returned. This is offered to make calling the api unconditional
231
for code that *might* take a list of files.
232
:param trees: Additional trees to consider.
233
:param require_versioned: If False, do not raise NotVersionedError if
234
an element of paths is not versioned in this tree and all of trees.
236
return find_ids_across_trees(paths, [self] + trees, require_versioned)
238
def print_file(self, file_id):
239
"""Print file with id `file_id` to stdout."""
241
sys.stdout.write(self.get_file_text(file_id))
246
def revision_tree(self, revision_id):
247
"""Obtain a revision tree for the revision revision_id.
249
The intention of this method is to allow access to possibly cached
250
tree data. Implementors of this method should raise NoSuchRevision if
251
the tree is not locally available, even if they could obtain the
252
tree via a repository or some other means. Callers are responsible
253
for finding the ultimate source for a revision tree.
255
:param revision_id: The revision_id of the requested tree.
257
:raises: NoSuchRevision if the tree cannot be obtained.
259
raise errors.NoSuchRevisionInTree(self, revision_id)
262
"""What files are present in this tree and unknown.
264
:return: an iterator over the unknown files.
271
def filter_unversioned_files(self, paths):
272
"""Filter out paths that are not versioned.
274
:return: set of paths.
276
# NB: we specifically *don't* call self.has_filename, because for
277
# WorkingTrees that can indicate files that exist on disk but that
279
pred = self.inventory.has_filename
280
return set((p for p in paths if not pred(p)))
282
def walkdirs(self, prefix=""):
283
"""Walk the contents of this tree from path down.
285
This yields all the data about the contents of a directory at a time.
286
After each directory has been yielded, if the caller has mutated the
287
list to exclude some directories, they are then not descended into.
289
The data yielded is of the form:
290
((directory-relpath, directory-path-from-root, directory-fileid),
291
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
292
versioned_kind), ...]),
293
- directory-relpath is the containing dirs relpath from prefix
294
- directory-path-from-root is the containing dirs path from /
295
- directory-fileid is the id of the directory if it is versioned.
296
- relpath is the relative path within the subtree being walked.
297
- basename is the basename
298
- kind is the kind of the file now. If unknonwn then the file is not
299
present within the tree - but it may be recorded as versioned. See
301
- lstat is the stat data *if* the file was statted.
302
- path_from_tree_root is the path from the root of the tree.
303
- file_id is the file_id is the entry is versioned.
304
- versioned_kind is the kind of the file as last recorded in the
305
versioning system. If 'unknown' the file is not versioned.
306
One of 'kind' and 'versioned_kind' must not be 'unknown'.
308
:param prefix: Start walking from prefix within the tree rather than
309
at the root. This allows one to walk a subtree but get paths that are
310
relative to a tree rooted higher up.
311
:return: an iterator over the directory data.
313
raise NotImplementedError(self.walkdirs)
316
class EmptyTree(Tree):
319
self._inventory = Inventory(root_id=None)
320
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
321
' use repository.revision_tree instead.',
322
DeprecationWarning, stacklevel=2)
324
def get_parent_ids(self):
327
def get_symlink_target(self, file_id):
330
def has_filename(self, filename):
333
def kind(self, file_id):
334
assert self._inventory[file_id].kind == "directory"
337
def list_files(self, include_root=False):
340
def __contains__(self, file_id):
341
return (file_id in self._inventory)
343
def get_file_sha1(self, file_id, path=None, stat_value=None):
347
######################################################################
350
# TODO: Merge these two functions into a single one that can operate
351
# on either a whole tree or a set of files.
353
# TODO: Return the diff in order by filename, not by category or in
354
# random order. Can probably be done by lock-stepping through the
355
# filenames from both trees.
358
def file_status(filename, old_tree, new_tree):
359
"""Return single-letter status, old and new names for a file.
361
The complexity here is in deciding how to represent renames;
362
many complex cases are possible.
364
old_inv = old_tree.inventory
365
new_inv = new_tree.inventory
366
new_id = new_inv.path2id(filename)
367
old_id = old_inv.path2id(filename)
369
if not new_id and not old_id:
370
# easy: doesn't exist in either; not versioned at all
371
if new_tree.is_ignored(filename):
372
return 'I', None, None
374
return '?', None, None
376
# There is now a file of this name, great.
379
# There is no longer a file of this name, but we can describe
380
# what happened to the file that used to have
381
# this name. There are two possibilities: either it was
382
# deleted entirely, or renamed.
384
if new_inv.has_id(old_id):
385
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
387
return 'D', old_inv.id2path(old_id), None
389
# if the file_id is new in this revision, it is added
390
if new_id and not old_inv.has_id(new_id):
393
# if there used to be a file of this name, but that ID has now
394
# disappeared, it is deleted
395
if old_id and not new_inv.has_id(old_id):
402
def find_renames(old_inv, new_inv):
403
for file_id in old_inv:
404
if file_id not in new_inv:
406
old_name = old_inv.id2path(file_id)
407
new_name = new_inv.id2path(file_id)
408
if old_name != new_name:
409
yield (old_name, new_name)
412
def find_ids_across_trees(filenames, trees, require_versioned=True):
413
"""Find the ids corresponding to specified filenames.
415
All matches in all trees will be used, and all children of matched
416
directories will be used.
418
:param filenames: The filenames to find file_ids for (if None, returns
420
:param trees: The trees to find file_ids within
421
:param require_versioned: if true, all specified filenames must occur in
423
:return: a set of file ids for the specified filenames and their children.
427
specified_path_ids = _find_ids_across_trees(filenames, trees,
429
return _find_children_across_trees(specified_path_ids, trees)
430
# specified_ids = [id for path, id in _find_path_ids_across_trees(filenames, trees, require_versioned)]
431
# return _find_children_across_trees(specified_ids, trees)
433
def find_path_ids_across_trees(filenames, trees, require_versioned=True):
434
"""Find the paths and ids corresponding to specified filenames.
436
All matches in all trees will be used, and all children of matched
437
directories will be included
439
:param filenames: The filenames to find file_ids for
440
:param trees: The trees to find file_ids within
441
:param require_versioned: if true, all specified filenames must occur in
443
:return: a set of (path, file ids) for the specified filenames and their
444
children. The returned path is the path of the id in the first tree
445
that contains it. This matters when files have been moved
449
# This function needs to know the ids for filenames in all trees, then
450
# search for those same files and children in all the other trees.
451
# it is complicated by the same path in two trees being able to have
452
# different ids, which might both be present in both trees.
453
# consider two trees, which have had 'mv foo bar' and 'mv baz foo' done
454
# in this case, a diff of 'foo' should should changes to both the current
455
# 'bar' and the current 'foo' which was baz. Its arguable that if
456
# the situation is 'mv parent/foo bar' and 'mv baz parent/foo', that
457
# we should return the current bar and the current parent/foo' - at the
458
# moment we do, but we loop around all ids and all trees: I*T checks.
460
# Updating this algorithm to be fast in the common case:
461
# nothing has moved, all files have the same id in parent, child and there
462
# are only two trees (or one is working tree and the others are parents).
463
# walk the dirstate. as we find each path, gather the paths of that
464
# id in all trees. add a mapping from the id to the path in those trees.
465
# now lookup children by id, again in all trees; for these trees that
466
# nothing has moved in, the id->path mapping will allow us to find the
467
# parent trivially. To answer 'has anything been moved' in one of the
468
# dirstate parent trees though, we will need to stare harder at it.
470
# Now, given a path index, that is trivial for any one tree, and given
471
# that we can ask for additional data from a dirstate tree, its a single
472
# pass, though it will require scanning the entire tree to find paths
473
# that were at the current location.
474
# ideal results?: There are three things: tree, path, id. Pathologically
475
# we can have completely disjoint ids for each tree; but we cannot have
476
# disjoin paths for each tree, except if we scan each tree for the
477
# different ids from other trees.
479
specified_path_ids = _find_ids_across_trees(filenames, trees,
481
return _find_path_id_children_across_trees(specified_path_ids, trees)
484
def _find_ids_across_trees(filenames, trees, require_versioned):
485
"""Find the ids corresponding to specified filenames.
487
All matches in all trees will be used, but subdirectories are not scanned.
489
:param filenames: The filenames to find file_ids for
490
:param trees: The trees to find file_ids within
491
:param require_versioned: if true, all specified filenames must occur in
493
:return: a set of (path, file ids) for the specified filenames
496
interesting_ids = set()
497
for tree_path in filenames:
500
file_id = tree.path2id(tree_path)
501
if file_id is not None:
502
interesting_ids.add(file_id)
505
not_versioned.append(tree_path)
506
if len(not_versioned) > 0 and require_versioned:
507
raise errors.PathsNotVersionedError(not_versioned)
508
return interesting_ids
511
def _find_children_across_trees(specified_ids, trees):
512
"""Return a set including specified ids and their children
514
All matches in all trees will be used.
516
:param trees: The trees to find file_ids within
517
:return: a set containing all specified ids and their children
519
interesting_ids = set(specified_ids)
520
pending = interesting_ids
521
# now handle children of interesting ids
522
# we loop so that we handle all children of each id in both trees
523
while len(pending) > 0:
525
for file_id in pending:
527
if not tree.has_id(file_id):
529
entry = tree.inventory[file_id]
530
for child in getattr(entry, 'children', {}).itervalues():
531
if child.file_id not in interesting_ids:
532
new_pending.add(child.file_id)
533
interesting_ids.update(new_pending)
534
pending = new_pending
535
return interesting_ids
538
class InterTree(InterObject):
539
"""This class represents operations taking place between two Trees.
541
Its instances have methods like 'compare' and contain references to the
542
source and target trees these operations are to be carried out on.
544
clients of bzrlib should not need to use InterTree directly, rather they
545
should use the convenience methods on Tree such as 'Tree.compare()' which
546
will pass through to InterTree as appropriate.
552
def compare(self, want_unchanged=False, specific_files=None,
553
extra_trees=None, require_versioned=False, include_root=False):
554
"""Return the changes from source to target.
556
:return: A TreeDelta.
557
:param specific_files: An optional list of file paths to restrict the
558
comparison to. When mapping filenames to ids, all matches in all
559
trees (including optional extra_trees) are used, and all children of
560
matched directories are included.
561
:param want_unchanged: An optional boolean requesting the inclusion of
562
unchanged entries in the result.
563
:param extra_trees: An optional list of additional trees to use when
564
mapping the contents of specific_files (paths) to file_ids.
565
:param require_versioned: An optional boolean (defaults to False). When
566
supplied and True all the 'specific_files' must be versioned, or
567
a PathsNotVersionedError will be thrown.
569
# NB: show_status depends on being able to pass in non-versioned files
570
# and report them as unknown
571
trees = (self.source, self.target)
572
if extra_trees is not None:
573
trees = trees + tuple(extra_trees)
574
# target is usually the newer tree:
575
specific_file_ids = self.target.paths2ids(specific_files, [self.source],
576
require_versioned=require_versioned)
577
if specific_files and not specific_file_ids:
578
# All files are unversioned, so just return an empty delta
579
# _compare_trees would think we want a complete delta
580
return delta.TreeDelta()
581
return delta._compare_trees(self.source, self.target, want_unchanged,
582
specific_file_ids, include_root)
584
def _iter_changes(self, from_tree, to_tree, include_unchanged,
585
specific_file_ids, pb):
586
"""Generate an iterator of changes between trees.
589
(file_id, path, changed_content, versioned, parent, name, kind,
592
Path is relative to the to_tree. changed_content is True if the file's
593
content has changed. This includes changes to its kind, and to
596
versioned, parent, name, kind, executable are tuples of (from, to).
597
If a file is missing in a tree, its kind is None.
599
Iteration is done in parent-to-child order, relative to the to_tree.
602
from_entries_by_dir = list(from_tree.inventory.iter_entries_by_dir(
603
specific_file_ids=specific_file_ids))
604
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
605
to_entries_by_dir = list(to_tree.inventory.iter_entries_by_dir(
606
specific_file_ids=specific_file_ids))
607
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
609
for to_path, to_entry in to_entries_by_dir:
610
file_id = to_entry.file_id
611
to_paths[file_id] = to_path
613
changed_content = False
614
from_path, from_entry = from_data.get(file_id, (None, None))
615
from_versioned = (from_entry is not None)
616
if from_entry is not None:
617
from_versioned = True
618
from_name = from_entry.name
619
from_parent = from_entry.parent_id
620
from_kind, from_executable, from_stat = \
621
from_tree._comparison_data(from_entry, from_path)
624
from_versioned = False
628
from_executable = None
629
versioned = (from_versioned, True)
630
to_kind, to_executable, to_stat = \
631
to_tree._comparison_data(to_entry, to_path)
632
kind = (from_kind, to_kind)
633
if kind[0] != kind[1]:
634
changed_content = True
635
elif from_kind == 'file':
636
from_size = from_tree._file_size(from_entry, from_stat)
637
to_size = to_tree._file_size(to_entry, to_stat)
638
if from_size != to_size:
639
changed_content = True
640
elif (from_tree.get_file_sha1(file_id, from_path, from_stat) !=
641
to_tree.get_file_sha1(file_id, to_path, to_stat)):
642
changed_content = True
643
elif from_kind == 'symlink':
644
if (from_tree.get_symlink_target(file_id) !=
645
to_tree.get_symlink_target(file_id)):
646
changed_content = True
647
parent = (from_parent, to_entry.parent_id)
648
name = (from_name, to_entry.name)
649
executable = (from_executable, to_executable)
651
pb.update('comparing files', entry_count, num_entries)
652
if (changed_content is not False or versioned[0] != versioned[1]
653
or parent[0] != parent[1] or name[0] != name[1] or
654
executable[0] != executable[1] or include_unchanged):
655
yield (file_id, to_path, changed_content, versioned, parent,
656
name, kind, executable)
658
def get_to_path(from_entry):
659
if from_entry.parent_id is None:
662
if from_entry.parent_id not in to_paths:
663
get_to_path(from_tree.inventory[from_entry.parent_id])
664
to_path = osutils.pathjoin(to_paths[from_entry.parent_id],
666
to_paths[from_entry.file_id] = to_path
669
for path, from_entry in from_entries_by_dir:
670
file_id = from_entry.file_id
671
if file_id in to_paths:
673
to_path = get_to_path(from_entry)
676
pb.update('comparing files', entry_count, num_entries)
677
versioned = (True, False)
678
parent = (from_entry.parent_id, None)
679
name = (from_entry.name, None)
680
from_kind, from_executable, stat_value = \
681
from_tree._comparison_data(from_entry, path)
682
kind = (from_kind, None)
683
executable = (from_executable, None)
684
changed_content = True
685
# the parent's path is necessarily known at this point.
686
yield(file_id, to_path, changed_content, versioned, parent,
687
name, kind, executable)
690
# This was deprecated before 0.12, but did not have an official warning
691
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
692
def RevisionTree(*args, **kwargs):
693
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
695
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
698
from bzrlib.revisiontree import RevisionTree as _RevisionTree
699
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
