180
199
down to specific_file_ids that have been requested. This has no
181
200
impact if specific_file_ids is None.
183
raise NotImplementedError(self.iter_entries_by_dir)
185
def list_files(self, include_root=False, from_dir=None, recursive=True):
186
"""List all files in this tree.
188
:param include_root: Whether to include the entry for the tree root
189
:param from_dir: Directory under which to list files
190
:param recursive: Whether to list files recursively
191
:return: iterator over tuples of (path, versioned, kind, file_id,
194
raise NotImplementedError(self.list_files)
202
return self.inventory.iter_entries_by_dir(
203
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
196
205
def iter_references(self):
197
206
if self.supports_tree_reference():
370
364
raise NotImplementedError(self.get_symlink_target)
366
def get_canonical_inventory_paths(self, paths):
367
"""Like get_canonical_inventory_path() but works on multiple items.
369
:param paths: A sequence of paths relative to the root of the tree.
370
:return: A list of paths, with each item the corresponding input path
371
adjusted to account for existing elements that match case
374
return list(self._yield_canonical_inventory_paths(paths))
376
def get_canonical_inventory_path(self, path):
377
"""Returns the first inventory item that case-insensitively matches path.
379
If a path matches exactly, it is returned. If no path matches exactly
380
but more than one path matches case-insensitively, it is implementation
381
defined which is returned.
383
If no path matches case-insensitively, the input path is returned, but
384
with as many path entries that do exist changed to their canonical
387
If you need to resolve many names from the same tree, you should
388
use get_canonical_inventory_paths() to avoid O(N) behaviour.
390
:param path: A paths relative to the root of the tree.
391
:return: The input path adjusted to account for existing elements
392
that match case insensitively.
394
return self._yield_canonical_inventory_paths([path]).next()
396
def _yield_canonical_inventory_paths(self, paths):
398
# First, if the path as specified exists exactly, just use it.
399
if self.path2id(path) is not None:
403
cur_id = self.get_root_id()
405
bit_iter = iter(path.split("/"))
409
for child in self.iter_children(cur_id):
411
# XXX: it seem like if the child is known to be in the
412
# tree, we shouldn't need to go from its id back to
413
# its path -- mbp 2010-02-11
415
# XXX: it seems like we could be more efficient
416
# by just directly looking up the original name and
417
# only then searching all children; also by not
418
# chopping paths so much. -- mbp 2010-02-11
419
child_base = os.path.basename(self.id2path(child))
420
if (child_base == elt):
421
# if we found an exact match, we can stop now; if
422
# we found an approximate match we need to keep
423
# searching because there might be an exact match
426
new_path = osutils.pathjoin(cur_path, child_base)
428
elif child_base.lower() == lelt:
430
new_path = osutils.pathjoin(cur_path, child_base)
432
# before a change is committed we can see this error...
437
# got to the end of this directory and no entries matched.
438
# Return what matched so far, plus the rest as specified.
439
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
373
444
def get_root_id(self):
374
445
"""Return the file_id for the root of this tree."""
433
504
except errors.NoSuchRevisionInTree:
434
505
yield self.repository.revision_tree(revision_id)
508
def _file_revision(revision_tree, file_id):
509
"""Determine the revision associated with a file in a given tree."""
510
revision_tree.lock_read()
512
return revision_tree.inventory[file_id].revision
514
revision_tree.unlock()
436
516
def _get_file_revision(self, file_id, vf, tree_revision):
437
517
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
439
519
if getattr(self, '_repository', None) is None:
440
520
last_revision = tree_revision
441
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
521
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
442
522
self._iter_parent_trees()]
443
523
vf.add_lines((file_id, last_revision), parent_keys,
444
self.get_file_lines(file_id))
524
self.get_file(file_id).readlines())
445
525
repo = self.branch.repository
446
526
base_vf = repo.texts
448
last_revision = self.get_file_revision(file_id)
528
last_revision = self._file_revision(self, file_id)
449
529
base_vf = self._repository.texts
450
530
if base_vf not in vf.fallback_versionedfiles:
451
531
vf.fallback_versionedfiles.append(base_vf)
452
532
return last_revision
534
inventory = property(_get_inventory,
535
doc="Inventory of this Tree")
454
537
def _check_retrieved(self, ie, f):
455
538
if not __debug__:
457
fp = osutils.fingerprint_file(f)
540
fp = fingerprint_file(f)
460
543
if ie.text_size is not None:
461
544
if ie.text_size != fp['size']:
462
raise errors.BzrError(
463
"mismatched size for file %r in %r" %
464
(ie.file_id, self._store),
545
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
465
546
["inventory expects %d bytes" % ie.text_size,
466
547
"file is actually %d bytes" % fp['size'],
467
548
"store is probably damaged/corrupt"])
469
550
if ie.text_sha1 != fp['sha1']:
470
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
471
(ie.file_id, self._store),
551
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
472
552
["inventory expects %s" % ie.text_sha1,
473
553
"file is actually %s" % fp['sha1'],
474
554
"store is probably damaged/corrupt"])
476
557
def path2id(self, path):
477
558
"""Return the id for path in this tree."""
478
raise NotImplementedError(self.path2id)
559
return self._inventory.path2id(path)
480
561
def paths2ids(self, paths, trees=[], require_versioned=True):
481
562
"""Return all the ids that can be reached by walking from paths.
644
class InventoryTree(Tree):
645
"""A tree that relies on an inventory for its metadata.
647
Trees contain an `Inventory` object, and also know how to retrieve
648
file texts mentioned in the inventory, either from a working
649
directory or from a store.
651
It is possible for trees to contain files that are not described
652
in their inventory or vice versa; for this use `filenames()`.
654
Subclasses should set the _inventory attribute, which is considered
655
private to external API users.
658
def get_canonical_inventory_paths(self, paths):
659
"""Like get_canonical_inventory_path() but works on multiple items.
661
:param paths: A sequence of paths relative to the root of the tree.
662
:return: A list of paths, with each item the corresponding input path
663
adjusted to account for existing elements that match case
666
return list(self._yield_canonical_inventory_paths(paths))
668
def get_canonical_inventory_path(self, path):
669
"""Returns the first inventory item that case-insensitively matches path.
671
If a path matches exactly, it is returned. If no path matches exactly
672
but more than one path matches case-insensitively, it is implementation
673
defined which is returned.
675
If no path matches case-insensitively, the input path is returned, but
676
with as many path entries that do exist changed to their canonical
679
If you need to resolve many names from the same tree, you should
680
use get_canonical_inventory_paths() to avoid O(N) behaviour.
682
:param path: A paths relative to the root of the tree.
683
:return: The input path adjusted to account for existing elements
684
that match case insensitively.
686
return self._yield_canonical_inventory_paths([path]).next()
688
def _yield_canonical_inventory_paths(self, paths):
690
# First, if the path as specified exists exactly, just use it.
691
if self.path2id(path) is not None:
695
cur_id = self.get_root_id()
697
bit_iter = iter(path.split("/"))
701
for child in self.iter_children(cur_id):
703
# XXX: it seem like if the child is known to be in the
704
# tree, we shouldn't need to go from its id back to
705
# its path -- mbp 2010-02-11
707
# XXX: it seems like we could be more efficient
708
# by just directly looking up the original name and
709
# only then searching all children; also by not
710
# chopping paths so much. -- mbp 2010-02-11
711
child_base = os.path.basename(self.id2path(child))
712
if (child_base == elt):
713
# if we found an exact match, we can stop now; if
714
# we found an approximate match we need to keep
715
# searching because there might be an exact match
718
new_path = osutils.pathjoin(cur_path, child_base)
720
elif child_base.lower() == lelt:
722
new_path = osutils.pathjoin(cur_path, child_base)
723
except errors.NoSuchId:
724
# before a change is committed we can see this error...
729
# got to the end of this directory and no entries matched.
730
# Return what matched so far, plus the rest as specified.
731
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
736
def _get_inventory(self):
737
return self._inventory
739
inventory = property(_get_inventory,
740
doc="Inventory of this Tree")
743
def path2id(self, path):
744
"""Return the id for path in this tree."""
745
return self._inventory.path2id(path)
747
def id2path(self, file_id):
748
"""Return the path for a file id.
752
return self.inventory.id2path(file_id)
754
def has_id(self, file_id):
755
return self.inventory.has_id(file_id)
757
def has_or_had_id(self, file_id):
758
return self.inventory.has_id(file_id)
761
return iter(self.inventory)
763
def filter_unversioned_files(self, paths):
764
"""Filter out paths that are versioned.
766
:return: set of paths.
768
# NB: we specifically *don't* call self.has_filename, because for
769
# WorkingTrees that can indicate files that exist on disk but that
771
pred = self.inventory.has_filename
772
return set((p for p in paths if not pred(p)))
775
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
776
"""Walk the tree in 'by_dir' order.
778
This will yield each entry in the tree as a (path, entry) tuple.
779
The order that they are yielded is:
781
See Tree.iter_entries_by_dir for details.
783
:param yield_parents: If True, yield the parents from the root leading
784
down to specific_file_ids that have been requested. This has no
785
impact if specific_file_ids is None.
787
return self.inventory.iter_entries_by_dir(
788
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
790
def get_file_by_path(self, path):
791
return self.get_file(self._inventory.path2id(path), path)
794
725
######################################################################