352
366
cur_file = (self.get_file_text(file_id),)
353
367
yield identifier, cur_file
355
def get_symlink_target(self, file_id):
369
def get_symlink_target(self, file_id, path=None):
356
370
"""Get the target for a given file_id.
358
372
It is assumed that the caller already knows that file_id is referencing
360
374
:param file_id: Handle for the symlink entry.
375
:param path: The path of the file.
376
If both file_id and path are supplied, an implementation may use
361
378
:return: The path the symlink points to.
363
380
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("/"))
408
for child in self.iter_children(cur_id):
410
# XXX: it seem like if the child is known to be in the
411
# tree, we shouldn't need to go from its id back to
412
# its path -- mbp 2010-02-11
414
# XXX: it seems like we could be more efficient
415
# by just directly looking up the original name and
416
# only then searching all children; also by not
417
# chopping paths so much. -- mbp 2010-02-11
418
child_base = os.path.basename(self.id2path(child))
419
if (child_base == elt):
420
# if we found an exact match, we can stop now; if
421
# we found an approximate match we need to keep
422
# searching because there might be an exact match
425
new_path = osutils.pathjoin(cur_path, child_base)
427
elif child_base.lower() == lelt:
429
new_path = osutils.pathjoin(cur_path, child_base)
431
# before a change is committed we can see this error...
436
# got to the end of this directory and no entries matched.
437
# Return what matched so far, plus the rest as specified.
438
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
443
382
def get_root_id(self):
444
383
"""Return the file_id for the root of this tree."""
445
384
raise NotImplementedError(self.get_root_id)
503
442
except errors.NoSuchRevisionInTree:
504
443
yield self.repository.revision_tree(revision_id)
507
def _file_revision(revision_tree, file_id):
508
"""Determine the revision associated with a file in a given tree."""
509
revision_tree.lock_read()
511
return revision_tree.inventory[file_id].revision
513
revision_tree.unlock()
515
445
def _get_file_revision(self, file_id, vf, tree_revision):
516
446
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
518
448
if getattr(self, '_repository', None) is None:
519
449
last_revision = tree_revision
520
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
450
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
451
self._iter_parent_trees()]
522
452
vf.add_lines((file_id, last_revision), parent_keys,
523
self.get_file(file_id).readlines())
453
self.get_file_lines(file_id))
524
454
repo = self.branch.repository
525
455
base_vf = repo.texts
527
last_revision = self._file_revision(self, file_id)
457
last_revision = self.get_file_revision(file_id)
528
458
base_vf = self._repository.texts
529
459
if base_vf not in vf.fallback_versionedfiles:
530
460
vf.fallback_versionedfiles.append(base_vf)
531
461
return last_revision
533
inventory = property(_get_inventory,
534
doc="Inventory of this Tree")
536
463
def _check_retrieved(self, ie, f):
537
464
if not __debug__:
539
fp = fingerprint_file(f)
466
fp = osutils.fingerprint_file(f)
542
469
if ie.text_size is not None:
543
470
if ie.text_size != fp['size']:
544
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
471
raise errors.BzrError(
472
"mismatched size for file %r in %r" %
473
(ie.file_id, self._store),
545
474
["inventory expects %d bytes" % ie.text_size,
546
475
"file is actually %d bytes" % fp['size'],
547
476
"store is probably damaged/corrupt"])
549
478
if ie.text_sha1 != fp['sha1']:
550
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
479
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
480
(ie.file_id, self._store),
551
481
["inventory expects %s" % ie.text_sha1,
552
482
"file is actually %s" % fp['sha1'],
553
483
"store is probably damaged/corrupt"])
556
485
def path2id(self, path):
557
486
"""Return the id for path in this tree."""
558
return self._inventory.path2id(path)
487
raise NotImplementedError(self.path2id)
560
489
def paths2ids(self, paths, trees=[], require_versioned=True):
561
490
"""Return all the ids that can be reached by walking from paths.
724
######################################################################
727
# TODO: Merge these two functions into a single one that can operate
728
# on either a whole tree or a set of files.
730
# TODO: Return the diff in order by filename, not by category or in
731
# random order. Can probably be done by lock-stepping through the
732
# filenames from both trees.
735
def file_status(filename, old_tree, new_tree):
736
"""Return single-letter status, old and new names for a file.
738
The complexity here is in deciding how to represent renames;
739
many complex cases are possible.
653
class InventoryTree(Tree):
654
"""A tree that relies on an inventory for its metadata.
656
Trees contain an `Inventory` object, and also know how to retrieve
657
file texts mentioned in the inventory, either from a working
658
directory or from a store.
660
It is possible for trees to contain files that are not described
661
in their inventory or vice versa; for this use `filenames()`.
663
Subclasses should set the _inventory attribute, which is considered
664
private to external API users.
741
old_inv = old_tree.inventory
742
new_inv = new_tree.inventory
743
new_id = new_inv.path2id(filename)
744
old_id = old_inv.path2id(filename)
746
if not new_id and not old_id:
747
# easy: doesn't exist in either; not versioned at all
748
if new_tree.is_ignored(filename):
749
return 'I', None, None
751
return '?', None, None
753
# There is now a file of this name, great.
756
# There is no longer a file of this name, but we can describe
757
# what happened to the file that used to have
758
# this name. There are two possibilities: either it was
759
# deleted entirely, or renamed.
760
if new_inv.has_id(old_id):
761
return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
763
return 'D', old_inv.id2path(old_id), None
765
# if the file_id is new in this revision, it is added
766
if new_id and not old_inv.has_id(new_id):
769
# if there used to be a file of this name, but that ID has now
770
# disappeared, it is deleted
771
if old_id and not new_inv.has_id(old_id):
777
@deprecated_function(deprecated_in((1, 9, 0)))
778
def find_renames(old_inv, new_inv):
779
for file_id in old_inv:
780
if file_id not in new_inv:
782
old_name = old_inv.id2path(file_id)
783
new_name = new_inv.id2path(file_id)
784
if old_name != new_name:
785
yield (old_name, new_name)
667
def get_canonical_inventory_paths(self, paths):
668
"""Like get_canonical_inventory_path() but works on multiple items.
670
:param paths: A sequence of paths relative to the root of the tree.
671
:return: A list of paths, with each item the corresponding input path
672
adjusted to account for existing elements that match case
675
return list(self._yield_canonical_inventory_paths(paths))
677
def get_canonical_inventory_path(self, path):
678
"""Returns the first inventory item that case-insensitively matches path.
680
If a path matches exactly, it is returned. If no path matches exactly
681
but more than one path matches case-insensitively, it is implementation
682
defined which is returned.
684
If no path matches case-insensitively, the input path is returned, but
685
with as many path entries that do exist changed to their canonical
688
If you need to resolve many names from the same tree, you should
689
use get_canonical_inventory_paths() to avoid O(N) behaviour.
691
:param path: A paths relative to the root of the tree.
692
:return: The input path adjusted to account for existing elements
693
that match case insensitively.
695
return self._yield_canonical_inventory_paths([path]).next()
697
def _yield_canonical_inventory_paths(self, paths):
699
# First, if the path as specified exists exactly, just use it.
700
if self.path2id(path) is not None:
704
cur_id = self.get_root_id()
706
bit_iter = iter(path.split("/"))
710
for child in self.iter_children(cur_id):
712
# XXX: it seem like if the child is known to be in the
713
# tree, we shouldn't need to go from its id back to
714
# its path -- mbp 2010-02-11
716
# XXX: it seems like we could be more efficient
717
# by just directly looking up the original name and
718
# only then searching all children; also by not
719
# chopping paths so much. -- mbp 2010-02-11
720
child_base = os.path.basename(self.id2path(child))
721
if (child_base == elt):
722
# if we found an exact match, we can stop now; if
723
# we found an approximate match we need to keep
724
# searching because there might be an exact match
727
new_path = osutils.pathjoin(cur_path, child_base)
729
elif child_base.lower() == lelt:
731
new_path = osutils.pathjoin(cur_path, child_base)
732
except errors.NoSuchId:
733
# before a change is committed we can see this error...
738
# got to the end of this directory and no entries matched.
739
# Return what matched so far, plus the rest as specified.
740
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
745
def _get_inventory(self):
746
return self._inventory
748
inventory = property(_get_inventory,
749
doc="Inventory of this Tree")
752
def path2id(self, path):
753
"""Return the id for path in this tree."""
754
return self._inventory.path2id(path)
756
def id2path(self, file_id):
757
"""Return the path for a file id.
761
return self.inventory.id2path(file_id)
763
def has_id(self, file_id):
764
return self.inventory.has_id(file_id)
766
def has_or_had_id(self, file_id):
767
return self.inventory.has_id(file_id)
769
def all_file_ids(self):
770
return set(self.inventory)
772
@deprecated_method(deprecated_in((2, 4, 0)))
774
return iter(self.inventory)
776
def filter_unversioned_files(self, paths):
777
"""Filter out paths that are versioned.
779
:return: set of paths.
781
# NB: we specifically *don't* call self.has_filename, because for
782
# WorkingTrees that can indicate files that exist on disk but that
784
pred = self.inventory.has_filename
785
return set((p for p in paths if not pred(p)))
788
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
789
"""Walk the tree in 'by_dir' order.
791
This will yield each entry in the tree as a (path, entry) tuple.
792
The order that they are yielded is:
794
See Tree.iter_entries_by_dir for details.
796
:param yield_parents: If True, yield the parents from the root leading
797
down to specific_file_ids that have been requested. This has no
798
impact if specific_file_ids is None.
800
return self.inventory.iter_entries_by_dir(
801
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
803
def get_file_by_path(self, path):
804
return self.get_file(self._inventory.path2id(path), path)
788
807
def find_ids_across_trees(filenames, trees, require_versioned=True):