304
301
:param file_id: The file_id of the file.
305
302
:param path: The path of the file.
307
303
If both file_id and path are supplied, an implementation may use
310
306
return osutils.split_lines(self.get_file_text(file_id, path))
312
def get_file_verifier(self, file_id, path=None, stat_value=None):
313
"""Return a verifier for a file.
315
The default implementation returns a sha1.
317
:param file_id: The handle for this file.
318
:param path: The path that this file can be found at.
319
These must point to the same object.
320
:param stat_value: Optional stat value for the object
321
:return: Tuple with verifier name and verifier data
323
return ("SHA1", self.get_file_sha1(file_id, path=path,
324
stat_value=stat_value))
326
def get_file_sha1(self, file_id, path=None, stat_value=None):
327
"""Return the SHA1 file for a file.
329
:note: callers should use get_file_verifier instead
330
where possible, as the underlying repository implementation may
331
have quicker access to a non-sha1 verifier.
333
:param file_id: The handle for this file.
334
:param path: The path that this file can be found at.
335
These must point to the same object.
336
:param stat_value: Optional stat value for the object
338
raise NotImplementedError(self.get_file_sha1)
340
308
def get_file_mtime(self, file_id, path=None):
341
309
"""Return the modification time for a file.
393
352
cur_file = (self.get_file_text(file_id),)
394
353
yield identifier, cur_file
396
def get_symlink_target(self, file_id, path=None):
355
def get_symlink_target(self, file_id):
397
356
"""Get the target for a given file_id.
399
358
It is assumed that the caller already knows that file_id is referencing
401
360
:param file_id: Handle for the symlink entry.
402
:param path: The path of the file.
403
If both file_id and path are supplied, an implementation may use
405
361
:return: The path the symlink points to.
407
363
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))
409
425
def get_root_id(self):
410
426
"""Return the file_id for the root of this tree."""
411
427
raise NotImplementedError(self.get_root_id)
469
485
except errors.NoSuchRevisionInTree:
470
486
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()
472
497
def _get_file_revision(self, file_id, vf, tree_revision):
473
498
"""Ensure that file_id, tree_revision is in vf to plan the merge."""
475
500
if getattr(self, '_repository', None) is None:
476
501
last_revision = tree_revision
477
parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
502
parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
478
503
self._iter_parent_trees()]
479
504
vf.add_lines((file_id, last_revision), parent_keys,
480
self.get_file_lines(file_id))
505
self.get_file(file_id).readlines())
481
506
repo = self.branch.repository
482
507
base_vf = repo.texts
484
last_revision = self.get_file_revision(file_id)
509
last_revision = self._file_revision(self, file_id)
485
510
base_vf = self._repository.texts
486
511
if base_vf not in vf.fallback_versionedfiles:
487
512
vf.fallback_versionedfiles.append(base_vf)
488
513
return last_revision
515
inventory = property(_get_inventory,
516
doc="Inventory of this Tree")
490
518
def _check_retrieved(self, ie, f):
491
519
if not __debug__:
493
fp = osutils.fingerprint_file(f)
521
fp = fingerprint_file(f)
496
524
if ie.text_size is not None:
497
525
if ie.text_size != fp['size']:
498
raise errors.BzrError(
499
"mismatched size for file %r in %r" %
500
(ie.file_id, self._store),
526
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
501
527
["inventory expects %d bytes" % ie.text_size,
502
528
"file is actually %d bytes" % fp['size'],
503
529
"store is probably damaged/corrupt"])
505
531
if ie.text_sha1 != fp['sha1']:
506
raise errors.BzrError("wrong SHA-1 for file %r in %r" %
507
(ie.file_id, self._store),
532
raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
508
533
["inventory expects %s" % ie.text_sha1,
509
534
"file is actually %s" % fp['sha1'],
510
535
"store is probably damaged/corrupt"])
512
538
def path2id(self, path):
513
539
"""Return the id for path in this tree."""
514
raise NotImplementedError(self.path2id)
540
return self._inventory.path2id(path)
516
542
def paths2ids(self, paths, trees=[], require_versioned=True):
517
543
"""Return all the ids that can be reached by walking from paths.
680
class InventoryTree(Tree):
681
"""A tree that relies on an inventory for its metadata.
683
Trees contain an `Inventory` object, and also know how to retrieve
684
file texts mentioned in the inventory, either from a working
685
directory or from a store.
687
It is possible for trees to contain files that are not described
688
in their inventory or vice versa; for this use `filenames()`.
690
Subclasses should set the _inventory attribute, which is considered
691
private to external API users.
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.
694
def get_canonical_inventory_paths(self, paths):
695
"""Like get_canonical_inventory_path() but works on multiple items.
697
:param paths: A sequence of paths relative to the root of the tree.
698
:return: A list of paths, with each item the corresponding input path
699
adjusted to account for existing elements that match case
702
return list(self._yield_canonical_inventory_paths(paths))
704
def get_canonical_inventory_path(self, path):
705
"""Returns the first inventory item that case-insensitively matches path.
707
If a path matches exactly, it is returned. If no path matches exactly
708
but more than one path matches case-insensitively, it is implementation
709
defined which is returned.
711
If no path matches case-insensitively, the input path is returned, but
712
with as many path entries that do exist changed to their canonical
715
If you need to resolve many names from the same tree, you should
716
use get_canonical_inventory_paths() to avoid O(N) behaviour.
718
:param path: A paths relative to the root of the tree.
719
:return: The input path adjusted to account for existing elements
720
that match case insensitively.
722
return self._yield_canonical_inventory_paths([path]).next()
724
def _yield_canonical_inventory_paths(self, paths):
726
# First, if the path as specified exists exactly, just use it.
727
if self.path2id(path) is not None:
731
cur_id = self.get_root_id()
733
bit_iter = iter(path.split("/"))
737
for child in self.iter_children(cur_id):
739
# XXX: it seem like if the child is known to be in the
740
# tree, we shouldn't need to go from its id back to
741
# its path -- mbp 2010-02-11
743
# XXX: it seems like we could be more efficient
744
# by just directly looking up the original name and
745
# only then searching all children; also by not
746
# chopping paths so much. -- mbp 2010-02-11
747
child_base = os.path.basename(self.id2path(child))
748
if (child_base == elt):
749
# if we found an exact match, we can stop now; if
750
# we found an approximate match we need to keep
751
# searching because there might be an exact match
754
new_path = osutils.pathjoin(cur_path, child_base)
756
elif child_base.lower() == lelt:
758
new_path = osutils.pathjoin(cur_path, child_base)
759
except errors.NoSuchId:
760
# before a change is committed we can see this error...
765
# got to the end of this directory and no entries matched.
766
# Return what matched so far, plus the rest as specified.
767
cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
772
def _get_inventory(self):
773
return self._inventory
775
inventory = property(_get_inventory,
776
doc="Inventory of this Tree")
779
def path2id(self, path):
780
"""Return the id for path in this tree."""
781
return self._inventory.path2id(path)
783
def id2path(self, file_id):
784
"""Return the path for a file id.
788
return self.inventory.id2path(file_id)
790
def has_id(self, file_id):
791
return self.inventory.has_id(file_id)
793
def has_or_had_id(self, file_id):
794
return self.inventory.has_id(file_id)
796
def all_file_ids(self):
797
return set(self.inventory)
799
@deprecated_method(deprecated_in((2, 4, 0)))
801
return iter(self.inventory)
803
def filter_unversioned_files(self, paths):
804
"""Filter out paths that are versioned.
806
:return: set of paths.
808
# NB: we specifically *don't* call self.has_filename, because for
809
# WorkingTrees that can indicate files that exist on disk but that
811
pred = self.inventory.has_filename
812
return set((p for p in paths if not pred(p)))
815
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
816
"""Walk the tree in 'by_dir' order.
818
This will yield each entry in the tree as a (path, entry) tuple.
819
The order that they are yielded is:
821
See Tree.iter_entries_by_dir for details.
823
:param yield_parents: If True, yield the parents from the root leading
824
down to specific_file_ids that have been requested. This has no
825
impact if specific_file_ids is None.
827
return self.inventory.iter_entries_by_dir(
828
specific_file_ids=specific_file_ids, yield_parents=yield_parents)
830
def get_file_by_path(self, path):
831
return self.get_file(self._inventory.path2id(path), path)
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)
834
770
def find_ids_across_trees(filenames, trees, require_versioned=True):
1302
1232
changed_file_ids.add(result[0])
1306
def file_content_matches(self, source_file_id, target_file_id,
1307
source_path=None, target_path=None, source_stat=None, target_stat=None):
1308
"""Check if two files are the same in the source and target trees.
1310
This only checks that the contents of the files are the same,
1311
it does not touch anything else.
1313
:param source_file_id: File id of the file in the source tree
1314
:param target_file_id: File id of the file in the target tree
1315
:param source_path: Path of the file in the source tree
1316
:param target_path: Path of the file in the target tree
1317
:param source_stat: Optional stat value of the file in the source tree
1318
:param target_stat: Optional stat value of the file in the target tree
1319
:return: Boolean indicating whether the files have the same contents
1321
source_verifier_kind, source_verifier_data = self.source.get_file_verifier(
1322
source_file_id, source_path, source_stat)
1323
target_verifier_kind, target_verifier_data = self.target.get_file_verifier(
1324
target_file_id, target_path, target_stat)
1325
if source_verifier_kind == target_verifier_kind:
1326
return (source_verifier_data == target_verifier_data)
1327
# Fall back to SHA1 for now
1328
if source_verifier_kind != "SHA1":
1329
source_sha1 = self.source.get_file_sha1(source_file_id,
1330
source_path, source_stat)
1332
source_sha1 = source_verifier_data
1333
if target_verifier_kind != "SHA1":
1334
target_sha1 = self.target.get_file_sha1(target_file_id,
1335
target_path, target_stat)
1337
target_sha1 = target_verifier_data
1338
return (source_sha1 == target_sha1)
1340
InterTree.register_optimiser(InterTree)
1343
1236
class MultiWalker(object):
1344
1237
"""Walk multiple trees simultaneously, getting combined results."""
added
removed
bzrlib/tree.py
