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)
144
def iter_entries_by_dir(self, specific_file_ids=None):
145
"""Walk the tree in 'by_dir' order.
147
This will yield each entry in the tree as a (path, entry) tuple. The
148
order that they are yielded is: the contents of a directory are
149
preceeded by the parent of a directory, and all the contents of a
150
directory are grouped together.
152
return self.inventory.iter_entries_by_dir(
153
specific_file_ids=specific_file_ids)
155
def kind(self, file_id):
156
raise NotImplementedError("subclasses must implement kind")
158
def _comparison_data(self, entry, path):
159
"""Return a tuple of kind, executable, stat_value for a file.
161
entry may be None if there is no inventory entry for the file, but
162
path must always be supplied.
164
kind is None if there is no file present (even if an inventory id is
165
present). executable is False for non-file entries.
167
raise NotImplementedError(self._comparison_data)
169
def _file_size(entry, stat_value):
170
raise NotImplementedError(self._file_size)
172
def _get_inventory(self):
173
return self._inventory
175
def get_file(self, file_id):
176
"""Return a file object for the file file_id in the tree."""
177
raise NotImplementedError(self.get_file)
179
def get_file_by_path(self, path):
180
return self.get_file(self._inventory.path2id(path))
182
def annotate_iter(self, file_id):
183
"""Return an iterator of revision_id, line tuples
185
For working trees (and mutable trees in general), the special
186
revision_id 'current:' will be used for lines that are new in this
187
tree, e.g. uncommitted changes.
188
:param file_id: The file to produce an annotated version from
190
raise NotImplementedError(self.annotate_iter)
192
inventory = property(_get_inventory,
193
doc="Inventory of this Tree")
195
def _check_retrieved(self, ie, f):
198
fp = fingerprint_file(f)
201
if ie.text_size is not None:
202
if ie.text_size != fp['size']:
203
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
204
["inventory expects %d bytes" % ie.text_size,
205
"file is actually %d bytes" % fp['size'],
206
"store is probably damaged/corrupt"])
208
if ie.text_sha1 != fp['sha1']:
209
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
210
["inventory expects %s" % ie.text_sha1,
211
"file is actually %s" % fp['sha1'],
212
"store is probably damaged/corrupt"])
214
def path2id(self, path):
215
"""Return the id for path in this tree."""
216
return self._inventory.path2id(path)
218
def print_file(self, file_id):
219
"""Print file with id `file_id` to stdout."""
221
sys.stdout.write(self.get_file_text(file_id))
227
"""What files are present in this tree and unknown.
229
:return: an iterator over the unknown files.
236
def filter_unversioned_files(self, paths):
237
"""Filter out paths that are not versioned.
239
:return: set of paths.
241
# NB: we specifically *don't* call self.has_filename, because for
242
# WorkingTrees that can indicate files that exist on disk but that
244
pred = self.inventory.has_filename
245
return set((p for p in paths if not pred(p)))
248
class EmptyTree(Tree):
251
self._inventory = Inventory(root_id=None)
252
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
253
' use repository.revision_tree instead.',
254
DeprecationWarning, stacklevel=2)
256
def get_parent_ids(self):
259
def get_symlink_target(self, file_id):
262
def has_filename(self, filename):
265
def kind(self, file_id):
266
assert self._inventory[file_id].kind == "directory"
269
def list_files(self, include_root=False):
272
def __contains__(self, file_id):
273
return (file_id in self._inventory)
275
def get_file_sha1(self, file_id, path=None, stat_value=None):
279
######################################################################
282
# TODO: Merge these two functions into a single one that can operate
283
# on either a whole tree or a set of files.
285
# TODO: Return the diff in order by filename, not by category or in
286
# random order. Can probably be done by lock-stepping through the
287
# filenames from both trees.
290
def file_status(filename, old_tree, new_tree):
291
"""Return single-letter status, old and new names for a file.
293
The complexity here is in deciding how to represent renames;
294
many complex cases are possible.
296
old_inv = old_tree.inventory
297
new_inv = new_tree.inventory
298
new_id = new_inv.path2id(filename)
299
old_id = old_inv.path2id(filename)
301
if not new_id and not old_id:
302
# easy: doesn't exist in either; not versioned at all
303
if new_tree.is_ignored(filename):
304
return 'I', None, None
306
return '?', None, None
308
# There is now a file of this name, great.
311
# There is no longer a file of this name, but we can describe
312
# what happened to the file that used to have
313
# this name. There are two possibilities: either it was
314
# deleted entirely, or renamed.
316
if new_inv.has_id(old_id):
317
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
319
return 'D', old_inv.id2path(old_id), None
321
# if the file_id is new in this revision, it is added
322
if new_id and not old_inv.has_id(new_id):
325
# if there used to be a file of this name, but that ID has now
326
# disappeared, it is deleted
327
if old_id and not new_inv.has_id(old_id):
334
def find_renames(old_inv, new_inv):
335
for file_id in old_inv:
336
if file_id not in new_inv:
338
old_name = old_inv.id2path(file_id)
339
new_name = new_inv.id2path(file_id)
340
if old_name != new_name:
341
yield (old_name, new_name)
344
def find_ids_across_trees(filenames, trees, require_versioned=True):
345
"""Find the ids corresponding to specified filenames.
347
All matches in all trees will be used, and all children of matched
348
directories will be used.
350
:param filenames: The filenames to find file_ids for (if None, returns
352
:param trees: The trees to find file_ids within
353
:param require_versioned: if true, all specified filenames must occur in
355
:return: a set of file ids for the specified filenames and their children.
359
specified_ids = _find_filename_ids_across_trees(filenames, trees,
361
return _find_children_across_trees(specified_ids, trees)
364
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
365
"""Find the ids corresponding to specified filenames.
367
All matches in all trees will be used.
369
:param filenames: The filenames to find file_ids for
370
:param trees: The trees to find file_ids within
371
:param require_versioned: if true, all specified filenames must occur in
373
:return: a set of file ids for the specified filenames
376
interesting_ids = set()
377
for tree_path in filenames:
380
file_id = tree.inventory.path2id(tree_path)
381
if file_id is not None:
382
interesting_ids.add(file_id)
385
not_versioned.append(tree_path)
386
if len(not_versioned) > 0 and require_versioned:
387
raise errors.PathsNotVersionedError(not_versioned)
388
return interesting_ids
391
def _find_children_across_trees(specified_ids, trees):
392
"""Return a set including specified ids and their children
394
All matches in all trees will be used.
396
:param trees: The trees to find file_ids within
397
:return: a set containing all specified ids and their children
399
interesting_ids = set(specified_ids)
400
pending = interesting_ids
401
# now handle children of interesting ids
402
# we loop so that we handle all children of each id in both trees
403
while len(pending) > 0:
405
for file_id in pending:
407
if file_id not in tree:
409
entry = tree.inventory[file_id]
410
for child in getattr(entry, 'children', {}).itervalues():
411
if child.file_id not in interesting_ids:
412
new_pending.add(child.file_id)
413
interesting_ids.update(new_pending)
414
pending = new_pending
415
return interesting_ids
418
class InterTree(InterObject):
419
"""This class represents operations taking place between two Trees.
421
Its instances have methods like 'compare' and contain references to the
422
source and target trees these operations are to be carried out on.
424
clients of bzrlib should not need to use InterTree directly, rather they
425
should use the convenience methods on Tree such as 'Tree.compare()' which
426
will pass through to InterTree as appropriate.
432
def compare(self, want_unchanged=False, specific_files=None,
433
extra_trees=None, require_versioned=False, include_root=False):
434
"""Return the changes from source to target.
436
:return: A TreeDelta.
437
:param specific_files: An optional list of file paths to restrict the
438
comparison to. When mapping filenames to ids, all matches in all
439
trees (including optional extra_trees) are used, and all children of
440
matched directories are included.
441
:param want_unchanged: An optional boolean requesting the inclusion of
442
unchanged entries in the result.
443
:param extra_trees: An optional list of additional trees to use when
444
mapping the contents of specific_files (paths) to file_ids.
445
:param require_versioned: An optional boolean (defaults to False). When
446
supplied and True all the 'specific_files' must be versioned, or
447
a PathsNotVersionedError will be thrown.
449
# NB: show_status depends on being able to pass in non-versioned files and
450
# report them as unknown
451
trees = (self.source, self.target)
452
if extra_trees is not None:
453
trees = trees + tuple(extra_trees)
454
specific_file_ids = find_ids_across_trees(specific_files,
455
trees, require_versioned=require_versioned)
456
if specific_files and not specific_file_ids:
457
# All files are unversioned, so just return an empty delta
458
# _compare_trees would think we want a complete delta
459
return delta.TreeDelta()
460
return delta._compare_trees(self.source, self.target, want_unchanged,
461
specific_file_ids, include_root)
463
def _iter_changes(self, from_tree, to_tree, include_unchanged,
464
specific_file_ids, pb):
465
"""Generate an iterator of changes between trees.
468
(file_id, path, changed_content, versioned, parent, name, kind,
471
Path is relative to the to_tree. changed_content is True if the file's
472
content has changed. This includes changes to its kind, and to
475
versioned, parent, name, kind, executable are tuples of (from, to).
476
If a file is missing in a tree, its kind is None.
478
Iteration is done in parent-to-child order, relative to the to_tree.
481
from_entries_by_dir = list(from_tree.inventory.iter_entries_by_dir(
482
specific_file_ids=specific_file_ids))
483
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
484
to_entries_by_dir = list(to_tree.inventory.iter_entries_by_dir(
485
specific_file_ids=specific_file_ids))
486
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
488
for to_path, to_entry in to_entries_by_dir:
489
file_id = to_entry.file_id
490
to_paths[file_id] = to_path
492
changed_content = False
493
from_path, from_entry = from_data.get(file_id, (None, None))
494
from_versioned = (from_entry is not None)
495
if from_entry is not None:
496
from_versioned = True
497
from_name = from_entry.name
498
from_parent = from_entry.parent_id
499
from_kind, from_executable, from_stat = \
500
from_tree._comparison_data(from_entry, from_path)
503
from_versioned = False
507
from_executable = None
508
versioned = (from_versioned, True)
509
to_kind, to_executable, to_stat = \
510
to_tree._comparison_data(to_entry, to_path)
511
kind = (from_kind, to_kind)
512
if kind[0] != kind[1]:
513
changed_content = True
514
elif from_kind == 'file':
515
from_size = from_tree._file_size(from_entry, from_stat)
516
to_size = to_tree._file_size(to_entry, to_stat)
517
if from_size != to_size:
518
changed_content = True
519
elif (from_tree.get_file_sha1(file_id, from_path, from_stat) !=
520
to_tree.get_file_sha1(file_id, to_path, to_stat)):
521
changed_content = True
522
elif from_kind == 'symlink':
523
if (from_tree.get_symlink_target(file_id) !=
524
to_tree.get_symlink_target(file_id)):
525
changed_content = True
526
parent = (from_parent, to_entry.parent_id)
527
name = (from_name, to_entry.name)
528
executable = (from_executable, to_executable)
530
pb.update('comparing files', entry_count, num_entries)
531
if (changed_content is not False or versioned[0] != versioned[1]
532
or parent[0] != parent[1] or name[0] != name[1] or
533
executable[0] != executable[1] or include_unchanged):
534
yield (file_id, to_path, changed_content, versioned, parent,
535
name, kind, executable)
537
def get_to_path(from_entry):
538
if from_entry.parent_id is None:
541
if from_entry.parent_id not in to_paths:
542
get_to_path(from_tree.inventory[from_entry.parent_id])
543
to_path = osutils.pathjoin(to_paths[from_entry.parent_id],
545
to_paths[from_entry.file_id] = to_path
548
for path, from_entry in from_entries_by_dir:
549
file_id = from_entry.file_id
550
if file_id in to_paths:
552
to_path = get_to_path(from_entry)
555
pb.update('comparing files', entry_count, num_entries)
556
versioned = (True, False)
557
parent = (from_entry.parent_id, None)
558
name = (from_entry.name, None)
559
from_kind, from_executable, stat_value = \
560
from_tree._comparison_data(from_entry, path)
561
kind = (from_kind, None)
562
executable = (from_executable, None)
563
changed_content = True
564
# the parent's path is necessarily known at this point.
565
yield(file_id, to_path, changed_content, versioned, parent,
566
name, kind, executable)
569
# This was deprecated before 0.12, but did not have an official warning
570
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
571
def RevisionTree(*args, **kwargs):
572
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
574
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
577
from bzrlib.revisiontree import RevisionTree as _RevisionTree
578
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
