352
402
cur_file = (self.get_file_text(file_id),)
353
403
yield identifier, cur_file
355
def get_symlink_target(self, file_id):
405
def get_symlink_target(self, file_id, path=None):
356
406
"""Get the target for a given file_id.
358
408
It is assumed that the caller already knows that file_id is referencing
360
410
:param file_id: Handle for the symlink entry.
411
:param path: The path of the file.
412
If both file_id and path are supplied, an implementation may use
361
414
:return: The path the symlink points to.
363
416
raise NotImplementedError(self.get_symlink_target)
365
def get_canonical_inventory_paths(self, paths):
366
"""Like get_canonical_inventory_path() but works on multiple items.
368
:param paths: A sequence of paths relative to the root of the tree.
369
:return: A list of paths, with each item the corresponding input path
370
adjusted to account for existing elements that match case
373
return list(self._yield_canonical_inventory_paths(paths))
375
def get_canonical_inventory_path(self, path):
376
"""Returns the first inventory item that case-insensitively matches path.
378
If a path matches exactly, it is returned. If no path matches exactly
379
but more than one path matches case-insensitively, it is implementation
380
defined which is returned.
382
If no path matches case-insensitively, the input path is returned, but
383
with as many path entries that do exist changed to their canonical
386
If you need to resolve many names from the same tree, you should
387
use get_canonical_inventory_paths() to avoid O(N) behaviour.
389
:param path: A paths relative to the root of the tree.
390
:return: The input path adjusted to account for existing elements
391
that match case insensitively.
393
return self._yield_canonical_inventory_paths([path]).next()
395
def _yield_canonical_inventory_paths(self, paths):
397
# First, if the path as specified exists exactly, just use it.
398
if self.path2id(path) is not None:
402
cur_id = self.get_root_id()
404
bit_iter = iter(path.split("/"))
407
for child in self.iter_children(cur_id):
409
child_base = os.path.basename(self.id2path(child))
410
if child_base.lower() == lelt:
412
cur_path = osutils.pathjoin(cur_path, child_base)
415
# before a change is committed we can see this error...
418
# got to the end of this directory and no entries matched.
419
# Return what matched so far, plus the rest as specified.
420
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
425
418
def get_root_id(self):
426
419
"""Return the file_id for the root of this tree."""
427
420
raise NotImplementedError(self.get_root_id)
485
478
except errors.NoSuchRevisionInTree:
486
479
yield self.repository.revision_tree(revision_id)
489
def _file_revision(revision_tree, file_id):
490
"""Determine the revision associated with a file in a given tree."""
491
revision_tree.lock_read()
493
return revision_tree.inventory[file_id].revision
495
revision_tree.unlock()
497
481
def _get_file_revision(self, file_id, vf, tree_revision):
498
482
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
500
484
if getattr(self, '_repository', None) is None:
501
485
last_revision = tree_revision
502
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
486
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
503
487
self._iter_parent_trees()]
504
488
vf.add_lines((file_id, last_revision), parent_keys,
505
self.get_file(file_id).readlines())
489
self.get_file_lines(file_id))
506
490
repo = self.branch.repository
507
491
base_vf = repo.texts
509
last_revision = self._file_revision(self, file_id)
493
last_revision = self.get_file_revision(file_id)
510
494
base_vf = self._repository.texts
511
495
if base_vf not in vf.fallback_versionedfiles:
512
496
vf.fallback_versionedfiles.append(base_vf)
513
497
return last_revision
515
inventory = property(_get_inventory,
516
doc="Inventory of this Tree")
518
499
def _check_retrieved(self, ie, f):
519
500
if not __debug__:
521
fp = fingerprint_file(f)
502
fp = osutils.fingerprint_file(f)
524
505
if ie.text_size is not None:
525
506
if ie.text_size != fp['size']:
526
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
507
raise errors.BzrError(
508
"mismatched size for file %r in %r" %
509
(ie.file_id, self._store),
527
510
["inventory expects %d bytes" % ie.text_size,
528
511
"file is actually %d bytes" % fp['size'],
529
512
"store is probably damaged/corrupt"])
531
514
if ie.text_sha1 != fp['sha1']:
532
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
515
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
516
(ie.file_id, self._store),
533
517
["inventory expects %s" % ie.text_sha1,
534
518
"file is actually %s" % fp['sha1'],
535
519
"store is probably damaged/corrupt"])
538
521
def path2id(self, path):
539
522
"""Return the id for path in this tree."""
540
return self._inventory.path2id(path)
523
raise NotImplementedError(self.path2id)
542
525
def paths2ids(self, paths, trees=[], require_versioned=True):
543
526
"""Return all the ids that can be reached by walking from paths.
706
######################################################################
709
# TODO: Merge these two functions into a single one that can operate
710
# on either a whole tree or a set of files.
712
# TODO: Return the diff in order by filename, not by category or in
713
# random order. Can probably be done by lock-stepping through the
714
# filenames from both trees.
717
def file_status(filename, old_tree, new_tree):
718
"""Return single-letter status, old and new names for a file.
720
The complexity here is in deciding how to represent renames;
721
many complex cases are possible.
692
class InventoryTree(Tree):
693
"""A tree that relies on an inventory for its metadata.
695
Trees contain an `Inventory` object, and also know how to retrieve
696
file texts mentioned in the inventory, either from a working
697
directory or from a store.
699
It is possible for trees to contain files that are not described
700
in their inventory or vice versa; for this use `filenames()`.
702
Subclasses should set the _inventory attribute, which is considered
703
private to external API users.
723
old_inv = old_tree.inventory
724
new_inv = new_tree.inventory
725
new_id = new_inv.path2id(filename)
726
old_id = old_inv.path2id(filename)
728
if not new_id and not old_id:
729
# easy: doesn't exist in either; not versioned at all
730
if new_tree.is_ignored(filename):
731
return 'I', None, None
733
return '?', None, None
735
# There is now a file of this name, great.
738
# There is no longer a file of this name, but we can describe
739
# what happened to the file that used to have
740
# this name. There are two possibilities: either it was
741
# deleted entirely, or renamed.
742
if new_inv.has_id(old_id):
743
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
745
return 'D', old_inv.id2path(old_id), None
747
# if the file_id is new in this revision, it is added
748
if new_id and not old_inv.has_id(new_id):
751
# if there used to be a file of this name, but that ID has now
752
# disappeared, it is deleted
753
if old_id and not new_inv.has_id(old_id):
759
@deprecated_function(deprecated_in((1, 9, 0)))
760
def find_renames(old_inv, new_inv):
761
for file_id in old_inv:
762
if file_id not in new_inv:
764
old_name = old_inv.id2path(file_id)
765
new_name = new_inv.id2path(file_id)
766
if old_name != new_name:
767
yield (old_name, new_name)
706
def get_canonical_inventory_paths(self, paths):
707
"""Like get_canonical_inventory_path() but works on multiple items.
709
:param paths: A sequence of paths relative to the root of the tree.
710
:return: A list of paths, with each item the corresponding input path
711
adjusted to account for existing elements that match case
714
return list(self._yield_canonical_inventory_paths(paths))
716
def get_canonical_inventory_path(self, path):
717
"""Returns the first inventory item that case-insensitively matches path.
719
If a path matches exactly, it is returned. If no path matches exactly
720
but more than one path matches case-insensitively, it is implementation
721
defined which is returned.
723
If no path matches case-insensitively, the input path is returned, but
724
with as many path entries that do exist changed to their canonical
727
If you need to resolve many names from the same tree, you should
728
use get_canonical_inventory_paths() to avoid O(N) behaviour.
730
:param path: A paths relative to the root of the tree.
731
:return: The input path adjusted to account for existing elements
732
that match case insensitively.
734
return self._yield_canonical_inventory_paths([path]).next()
736
def _yield_canonical_inventory_paths(self, paths):
738
# First, if the path as specified exists exactly, just use it.
739
if self.path2id(path) is not None:
743
cur_id = self.get_root_id()
745
bit_iter = iter(path.split("/"))
749
for child in self.iter_children(cur_id):
751
# XXX: it seem like if the child is known to be in the
752
# tree, we shouldn't need to go from its id back to
753
# its path -- mbp 2010-02-11
755
# XXX: it seems like we could be more efficient
756
# by just directly looking up the original name and
757
# only then searching all children; also by not
758
# chopping paths so much. -- mbp 2010-02-11
759
child_base = os.path.basename(self.id2path(child))
760
if (child_base == elt):
761
# if we found an exact match, we can stop now; if
762
# we found an approximate match we need to keep
763
# searching because there might be an exact match
766
new_path = osutils.pathjoin(cur_path, child_base)
768
elif child_base.lower() == lelt:
770
new_path = osutils.pathjoin(cur_path, child_base)
771
except errors.NoSuchId:
772
# before a change is committed we can see this error...
777
# got to the end of this directory and no entries matched.
778
# Return what matched so far, plus the rest as specified.
779
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
784
@deprecated_method(deprecated_in((2, 5, 0)))
785
def _get_inventory(self):
786
return self._inventory
788
inventory = property(_get_inventory,
789
doc="Inventory of this Tree")
791
def _get_root_inventory(self):
792
return self._inventory
794
root_inventory = property(_get_root_inventory,
795
doc="Root inventory of this tree")
797
def _unpack_file_id(self, file_id):
798
"""Find the inventory and inventory file id for a tree file id.
800
:param file_id: The tree file id, as bytestring or tuple
801
:return: Inventory and inventory file id
803
if isinstance(file_id, tuple):
804
if len(file_id) != 1:
805
raise ValueError("nested trees not yet supported: %r" % file_id)
807
return self.root_inventory, file_id
810
def path2id(self, path):
811
"""Return the id for path in this tree."""
812
return self._path2inv_file_id(path)[1]
814
def _path2inv_file_id(self, path):
815
"""Lookup a inventory and inventory file id by path.
817
:param path: Path to look up
818
:return: tuple with inventory and inventory file id
820
# FIXME: Support nested trees
821
return self.root_inventory, self.root_inventory.path2id(path)
823
def id2path(self, file_id):
824
"""Return the path for a file id.
828
inventory, file_id = self._unpack_file_id(file_id)
829
return inventory.id2path(file_id)
831
def has_id(self, file_id):
832
inventory, file_id = self._unpack_file_id(file_id)
833
return inventory.has_id(file_id)
835
def has_or_had_id(self, file_id):
836
inventory, file_id = self._unpack_file_id(file_id)
837
return inventory.has_id(file_id)
839
def all_file_ids(self):
841
[entry.file_id for path, entry in self.iter_entries_by_dir()])
843
@deprecated_method(deprecated_in((2, 4, 0)))
845
return iter(self.all_file_ids())
847
def filter_unversioned_files(self, paths):
848
"""Filter out paths that are versioned.
850
:return: set of paths.
852
# NB: we specifically *don't* call self.has_filename, because for
853
# WorkingTrees that can indicate files that exist on disk but that
855
return set((p for p in paths if self.path2id(p) is None))
858
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
859
"""Walk the tree in 'by_dir' order.
861
This will yield each entry in the tree as a (path, entry) tuple.
862
The order that they are yielded is:
864
See Tree.iter_entries_by_dir for details.
866
:param yield_parents: If True, yield the parents from the root leading
867
down to specific_file_ids that have been requested. This has no
868
impact if specific_file_ids is None.
870
if specific_file_ids is None:
871
inventory_file_ids = None
873
inventory_file_ids = []
874
for tree_file_id in specific_file_ids:
875
inventory, inv_file_id = self._unpack_file_id(tree_file_id)
876
if not inventory is self.root_inventory: # for now
877
raise AssertionError("%r != %r" % (
878
inventory, self.root_inventory))
879
inventory_file_ids.append(inv_file_id)
880
# FIXME: Handle nested trees
881
return self.root_inventory.iter_entries_by_dir(
882
specific_file_ids=inventory_file_ids, yield_parents=yield_parents)
885
def iter_child_entries(self, file_id, path=None):
886
inv, inv_file_id = self._unpack_file_id(file_id)
887
return inv[inv_file_id].children.itervalues()
889
@deprecated_method(deprecated_in((2, 5, 0)))
890
def get_file_by_path(self, path):
891
return self.get_file(self.path2id(path), path)
893
def iter_children(self, file_id, path=None):
894
"""See Tree.iter_children."""
895
entry = self.iter_entries_by_dir([file_id]).next()[1]
896
for child in getattr(entry, 'children', {}).itervalues():
770
900
def find_ids_across_trees(filenames, trees, require_versioned=True):
1227
1359
if old_entry is None:
1228
1360
# Reusing a discarded change.
1229
1361
old_entry = self._get_entry(self.source, file_id)
1230
for child in old_entry.children.values():
1231
precise_file_ids.add(child.file_id)
1362
precise_file_ids.update(
1363
self.source.iter_children(file_id))
1232
1364
changed_file_ids.add(result[0])
1368
def file_content_matches(self, source_file_id, target_file_id,
1369
source_path=None, target_path=None, source_stat=None, target_stat=None):
1370
"""Check if two files are the same in the source and target trees.
1372
This only checks that the contents of the files are the same,
1373
it does not touch anything else.
1375
:param source_file_id: File id of the file in the source tree
1376
:param target_file_id: File id of the file in the target tree
1377
:param source_path: Path of the file in the source tree
1378
:param target_path: Path of the file in the target tree
1379
:param source_stat: Optional stat value of the file in the source tree
1380
:param target_stat: Optional stat value of the file in the target tree
1381
:return: Boolean indicating whether the files have the same contents
1383
source_verifier_kind, source_verifier_data = self.source.get_file_verifier(
1384
source_file_id, source_path, source_stat)
1385
target_verifier_kind, target_verifier_data = self.target.get_file_verifier(
1386
target_file_id, target_path, target_stat)
1387
if source_verifier_kind == target_verifier_kind:
1388
return (source_verifier_data == target_verifier_data)
1389
# Fall back to SHA1 for now
1390
if source_verifier_kind != "SHA1":
1391
source_sha1 = self.source.get_file_sha1(source_file_id,
1392
source_path, source_stat)
1394
source_sha1 = source_verifier_data
1395
if target_verifier_kind != "SHA1":
1396
target_sha1 = self.target.get_file_sha1(target_file_id,
1397
target_path, target_stat)
1399
target_sha1 = target_verifier_data
1400
return (source_sha1 == target_sha1)
1402
InterTree.register_optimiser(InterTree)
1236
1405
class MultiWalker(object):
1237
1406
"""Walk multiple trees simultaneously, getting combined results."""