68
380
inv = self._inventory
69
381
for path, ie in inv.iter_entries():
70
if os.path.exists(self.abspath(path)):
382
if osutils.lexists(self.abspath(path)):
385
def all_file_ids(self):
386
"""See Tree.iter_all_file_ids"""
387
return set(self.inventory)
74
389
def __repr__(self):
75
390
return "<%s of %s>" % (self.__class__.__name__,
76
391
getattr(self, 'basedir', None))
80
393
def abspath(self, filename):
81
return os.path.join(self.basedir, filename)
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision.
399
If the left most parent is a ghost then the returned tree will be an
400
empty tree - one obtained by calling
401
repository.revision_tree(NULL_REVISION).
404
revision_id = self.get_parent_ids()[0]
406
# no parents, return an empty revision tree.
407
# in the future this should return the tree for
408
# 'empty:' - the implicit root empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
412
return self.revision_tree(revision_id)
413
except errors.NoSuchRevision:
415
# No cached copy available, retrieve from the repository.
416
# FIXME? RBC 20060403 should we cache the inventory locally
419
return self.branch.repository.revision_tree(revision_id)
420
except (errors.RevisionNotPresent, errors.NoSuchRevision):
421
# the basis tree *may* be a ghost or a low level error may have
422
# occurred. If the revision is present, its a problem, if its not
424
if self.branch.repository.has_revision(revision_id):
426
# the basis tree is a ghost so return an empty tree.
427
return self.branch.repository.revision_tree(
428
_mod_revision.NULL_REVISION)
431
self._flush_ignore_list_cache()
433
def relpath(self, path):
434
"""Return the local path portion from a given path.
436
The path may be absolute or relative. If its a relative path it is
437
interpreted relative to the python current working directory.
439
return osutils.relpath(self.basedir, path)
83
441
def has_filename(self, filename):
84
return os.path.exists(self.abspath(filename))
86
def get_file(self, file_id):
87
return self.get_file_byname(self.id2path(file_id))
89
def get_file_byname(self, filename):
90
return file(self.abspath(filename), 'rb')
442
return osutils.lexists(self.abspath(filename))
444
def get_file(self, file_id, path=None, filtered=True):
445
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
447
def get_file_with_stat(self, file_id, path=None, filtered=True,
449
"""See MutableTree.get_file_with_stat."""
451
path = self.id2path(file_id)
452
file_obj = self.get_file_byname(path, filtered=False)
453
stat_value = _fstat(file_obj.fileno())
454
if self.supports_content_filtering() and filtered:
455
filters = self._content_filter_stack(path)
456
file_obj = filtered_input_file(file_obj, filters)
457
return (file_obj, stat_value)
459
def get_file_text(self, file_id, path=None, filtered=True):
460
return self.get_file(file_id, path=path, filtered=filtered).read()
462
def get_file_byname(self, filename, filtered=True):
463
path = self.abspath(filename)
465
if self.supports_content_filtering() and filtered:
466
filters = self._content_filter_stack(filename)
467
return filtered_input_file(f, filters)
471
def get_file_lines(self, file_id, path=None, filtered=True):
472
"""See Tree.get_file_lines()"""
473
file = self.get_file(file_id, path, filtered=filtered)
475
return file.readlines()
480
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
481
"""See Tree.annotate_iter
483
This implementation will use the basis tree implementation if possible.
484
Lines not in the basis are attributed to CURRENT_REVISION
486
If there are pending merges, lines added by those merges will be
487
incorrectly attributed to CURRENT_REVISION (but after committing, the
488
attribution will be correct).
490
basis = self.basis_tree()
493
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
494
require_versioned=True).next()
495
changed_content, kind = changes[2], changes[6]
496
if not changed_content:
497
return basis.annotate_iter(file_id)
501
if kind[0] != 'file':
504
old_lines = list(basis.annotate_iter(file_id))
506
for tree in self.branch.repository.revision_trees(
507
self.get_parent_ids()[1:]):
508
if file_id not in tree:
510
old.append(list(tree.annotate_iter(file_id)))
511
return annotate.reannotate(old, self.get_file(file_id).readlines(),
516
def _get_ancestors(self, default_revision):
517
ancestors = set([default_revision])
518
for parent_id in self.get_parent_ids():
519
ancestors.update(self.branch.repository.get_ancestry(
520
parent_id, topo_sorted=False))
523
def get_parent_ids(self):
524
"""See Tree.get_parent_ids.
526
This implementation reads the pending merges list and last_revision
527
value and uses that to decide what the parents list should be.
529
last_rev = _mod_revision.ensure_null(self._last_revision())
530
if _mod_revision.NULL_REVISION == last_rev:
535
merges_file = self._transport.get('pending-merges')
536
except errors.NoSuchFile:
539
for l in merges_file.readlines():
540
revision_id = l.rstrip('\n')
541
parents.append(revision_id)
545
def get_root_id(self):
546
"""Return the id of this trees root"""
547
return self._inventory.root.file_id
92
549
def _get_store_filename(self, file_id):
93
## XXX: badly named; this isn't in the store at all
94
return self.abspath(self.id2path(file_id))
550
## XXX: badly named; this is not in the store at all
551
return self.abspath(self.id2path(file_id))
554
def clone(self, to_bzrdir, revision_id=None):
555
"""Duplicate this working tree into to_bzr, including all state.
557
Specifically modified files are kept as modified, but
558
ignored and unknown files are discarded.
560
If you want to make a new line of development, see bzrdir.sprout()
563
If not None, the cloned tree will have its last revision set to
564
revision, and difference between the source trees last revision
565
and this one merged in.
567
# assumes the target bzr dir format is compatible.
568
result = to_bzrdir.create_workingtree()
569
self.copy_content_into(result, revision_id)
573
def copy_content_into(self, tree, revision_id=None):
574
"""Copy the current content and user files of this tree into tree."""
575
tree.set_root_id(self.get_root_id())
576
if revision_id is None:
577
merge.transform_tree(tree, self)
579
# TODO now merge from tree.last_revision to revision (to preserve
580
# user local changes)
581
merge.transform_tree(tree, self)
582
tree.set_parent_ids([revision_id])
584
def id2abspath(self, file_id):
585
return self.abspath(self.id2path(file_id))
97
587
def has_id(self, file_id):
98
588
# files that have been deleted are excluded
100
590
if not inv.has_id(file_id):
102
592
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
593
return osutils.lexists(self.abspath(path))
595
def has_or_had_id(self, file_id):
596
if file_id == self.inventory.root.file_id:
598
return self.inventory.has_id(file_id)
106
600
__contains__ = has_id
109
602
def get_file_size(self, file_id):
110
# is this still called?
111
raise NotImplementedError()
114
def get_file_sha1(self, file_id):
115
path = self._inventory.id2path(file_id)
116
return self._hashcache.get_sha1(path)
119
def file_class(self, filename):
120
if self.path2id(filename):
122
elif self.is_ignored(filename):
128
def list_files(self):
129
"""Recursively list all files as (path, class, kind, id).
603
"""See Tree.get_file_size"""
605
return os.path.getsize(self.id2abspath(file_id))
607
if e.errno != errno.ENOENT:
613
def get_file_sha1(self, file_id, path=None, stat_value=None):
615
path = self._inventory.id2path(file_id)
616
return self._hashcache.get_sha1(path, stat_value)
618
def get_file_mtime(self, file_id, path=None):
620
path = self.inventory.id2path(file_id)
621
return os.lstat(self.abspath(path)).st_mtime
623
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
624
file_id = self.path2id(path)
625
return self._inventory[file_id].executable
627
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
628
mode = stat_result.st_mode
629
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
631
if not supports_executable():
632
def is_executable(self, file_id, path=None):
633
return self._inventory[file_id].executable
635
_is_executable_from_path_and_stat = \
636
_is_executable_from_path_and_stat_from_basis
638
def is_executable(self, file_id, path=None):
640
path = self.id2path(file_id)
641
mode = os.lstat(self.abspath(path)).st_mode
642
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
644
_is_executable_from_path_and_stat = \
645
_is_executable_from_path_and_stat_from_stat
647
@needs_tree_write_lock
648
def _add(self, files, ids, kinds):
649
"""See MutableTree._add."""
650
# TODO: Re-adding a file that is removed in the working copy
651
# should probably put it back with the previous ID.
652
# the read and write working inventory should not occur in this
653
# function - they should be part of lock_write and unlock.
655
for f, file_id, kind in zip(files, ids, kinds):
657
inv.add_path(f, kind=kind)
659
inv.add_path(f, kind=kind, file_id=file_id)
660
self._inventory_is_modified = True
662
@needs_tree_write_lock
663
def _gather_kinds(self, files, kinds):
664
"""See MutableTree._gather_kinds."""
665
for pos, f in enumerate(files):
666
if kinds[pos] is None:
667
fullpath = normpath(self.abspath(f))
669
kinds[pos] = file_kind(fullpath)
671
if e.errno == errno.ENOENT:
672
raise errors.NoSuchFile(fullpath)
675
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
676
"""Add revision_id as a parent.
678
This is equivalent to retrieving the current list of parent ids
679
and setting the list to its value plus revision_id.
681
:param revision_id: The revision id to add to the parent list. It may
682
be a ghost revision as long as its not the first parent to be added,
683
or the allow_leftmost_as_ghost parameter is set True.
684
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
686
parents = self.get_parent_ids() + [revision_id]
687
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
688
or allow_leftmost_as_ghost)
690
@needs_tree_write_lock
691
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
692
"""Add revision_id, tree tuple as a parent.
694
This is equivalent to retrieving the current list of parent trees
695
and setting the list to its value plus parent_tuple. See also
696
add_parent_tree_id - if you only have a parent id available it will be
697
simpler to use that api. If you have the parent already available, using
698
this api is preferred.
700
:param parent_tuple: The (revision id, tree) to add to the parent list.
701
If the revision_id is a ghost, pass None for the tree.
702
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
704
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
705
if len(parent_ids) > 1:
706
# the leftmost may have already been a ghost, preserve that if it
708
allow_leftmost_as_ghost = True
709
self.set_parent_ids(parent_ids,
710
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
712
@needs_tree_write_lock
713
def add_pending_merge(self, *revision_ids):
714
# TODO: Perhaps should check at this point that the
715
# history of the revision is actually present?
716
parents = self.get_parent_ids()
718
for rev_id in revision_ids:
719
if rev_id in parents:
721
parents.append(rev_id)
724
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
726
def path_content_summary(self, path, _lstat=os.lstat,
727
_mapper=osutils.file_kind_from_stat_mode):
728
"""See Tree.path_content_summary."""
729
abspath = self.abspath(path)
731
stat_result = _lstat(abspath)
733
if getattr(e, 'errno', None) == errno.ENOENT:
735
return ('missing', None, None, None)
736
# propagate other errors
738
kind = _mapper(stat_result.st_mode)
740
size = stat_result.st_size
741
# try for a stat cache lookup
742
executable = self._is_executable_from_path_and_stat(path, stat_result)
743
return (kind, size, executable, self._sha_from_stat(
745
elif kind == 'directory':
746
# perhaps it looks like a plain directory, but it's really a
748
if self._directory_is_tree_reference(path):
749
kind = 'tree-reference'
750
return kind, None, None, None
751
elif kind == 'symlink':
752
return ('symlink', None, None,
753
os.readlink(abspath.encode(osutils._fs_enc)
754
).decode(osutils._fs_enc))
756
return (kind, None, None, None)
758
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
759
"""Common ghost checking functionality from set_parent_*.
761
This checks that the left hand-parent exists if there are any
764
if len(revision_ids) > 0:
765
leftmost_id = revision_ids[0]
766
if (not allow_leftmost_as_ghost and not
767
self.branch.repository.has_revision(leftmost_id)):
768
raise errors.GhostRevisionUnusableHere(leftmost_id)
770
def _set_merges_from_parent_ids(self, parent_ids):
771
merges = parent_ids[1:]
772
self._transport.put_bytes('pending-merges', '\n'.join(merges),
773
mode=self.bzrdir._get_file_mode())
775
def _filter_parent_ids_by_ancestry(self, revision_ids):
776
"""Check that all merged revisions are proper 'heads'.
778
This will always return the first revision_id, and any merged revisions
781
if len(revision_ids) == 0:
783
graph = self.branch.repository.get_graph()
784
heads = graph.heads(revision_ids)
785
new_revision_ids = revision_ids[:1]
786
for revision_id in revision_ids[1:]:
787
if revision_id in heads and revision_id not in new_revision_ids:
788
new_revision_ids.append(revision_id)
789
if new_revision_ids != revision_ids:
790
trace.mutter('requested to set revision_ids = %s,'
791
' but filtered to %s', revision_ids, new_revision_ids)
792
return new_revision_ids
794
@needs_tree_write_lock
795
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
796
"""Set the parent ids to revision_ids.
798
See also set_parent_trees. This api will try to retrieve the tree data
799
for each element of revision_ids from the trees repository. If you have
800
tree data already available, it is more efficient to use
801
set_parent_trees rather than set_parent_ids. set_parent_ids is however
802
an easier API to use.
804
:param revision_ids: The revision_ids to set as the parent ids of this
805
working tree. Any of these may be ghosts.
807
self._check_parents_for_ghosts(revision_ids,
808
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
809
for revision_id in revision_ids:
810
_mod_revision.check_not_reserved_id(revision_id)
812
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
814
if len(revision_ids) > 0:
815
self.set_last_revision(revision_ids[0])
817
self.set_last_revision(_mod_revision.NULL_REVISION)
819
self._set_merges_from_parent_ids(revision_ids)
821
@needs_tree_write_lock
822
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
823
"""See MutableTree.set_parent_trees."""
824
parent_ids = [rev for (rev, tree) in parents_list]
825
for revision_id in parent_ids:
826
_mod_revision.check_not_reserved_id(revision_id)
828
self._check_parents_for_ghosts(parent_ids,
829
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
831
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
833
if len(parent_ids) == 0:
834
leftmost_parent_id = _mod_revision.NULL_REVISION
835
leftmost_parent_tree = None
837
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
839
if self._change_last_revision(leftmost_parent_id):
840
if leftmost_parent_tree is None:
841
# If we don't have a tree, fall back to reading the
842
# parent tree from the repository.
843
self._cache_basis_inventory(leftmost_parent_id)
845
inv = leftmost_parent_tree.inventory
846
xml = self._create_basis_xml_from_inventory(
847
leftmost_parent_id, inv)
848
self._write_basis_inventory(xml)
849
self._set_merges_from_parent_ids(parent_ids)
851
@needs_tree_write_lock
852
def set_pending_merges(self, rev_list):
853
parents = self.get_parent_ids()
854
leftmost = parents[:1]
855
new_parents = leftmost + rev_list
856
self.set_parent_ids(new_parents)
858
@needs_tree_write_lock
859
def set_merge_modified(self, modified_hashes):
861
for file_id, hash in modified_hashes.iteritems():
862
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
863
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
865
def _sha_from_stat(self, path, stat_result):
866
"""Get a sha digest from the tree's stat cache.
868
The default implementation assumes no stat cache is present.
870
:param path: The path.
871
:param stat_result: The stat result being looked up.
875
def _put_rio(self, filename, stanzas, header):
876
self._must_be_locked()
877
my_file = rio_file(stanzas, header)
878
self._transport.put_file(filename, my_file,
879
mode=self.bzrdir._get_file_mode())
881
@needs_write_lock # because merge pulls data into the branch.
882
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
884
"""Merge from a branch into this working tree.
886
:param branch: The branch to merge from.
887
:param to_revision: If non-None, the merge will merge to to_revision,
888
but not beyond it. to_revision does not need to be in the history
889
of the branch when it is supplied. If None, to_revision defaults to
890
branch.last_revision().
892
from bzrlib.merge import Merger, Merge3Merger
893
pb = bzrlib.ui.ui_factory.nested_progress_bar()
895
merger = Merger(self.branch, this_tree=self, pb=pb)
896
merger.pp = ProgressPhase("Merge phase", 5, pb)
897
merger.pp.next_phase()
898
# check that there are no
900
merger.check_basis(check_clean=True, require_commits=False)
901
if to_revision is None:
902
to_revision = _mod_revision.ensure_null(branch.last_revision())
903
merger.other_rev_id = to_revision
904
if _mod_revision.is_null(merger.other_rev_id):
905
raise errors.NoCommits(branch)
906
self.branch.fetch(branch, last_revision=merger.other_rev_id)
907
merger.other_basis = merger.other_rev_id
908
merger.other_tree = self.branch.repository.revision_tree(
910
merger.other_branch = branch
911
merger.pp.next_phase()
912
if from_revision is None:
915
merger.set_base_revision(from_revision, branch)
916
if merger.base_rev_id == merger.other_rev_id:
917
raise errors.PointlessMerge
918
merger.backup_files = False
919
if merge_type is None:
920
merger.merge_type = Merge3Merger
922
merger.merge_type = merge_type
923
merger.set_interesting_files(None)
924
merger.show_base = False
925
merger.reprocess = False
926
conflicts = merger.do_merge()
933
def merge_modified(self):
934
"""Return a dictionary of files modified by a merge.
936
The list is initialized by WorkingTree.set_merge_modified, which is
937
typically called after we make some automatic updates to the tree
940
This returns a map of file_id->sha1, containing only files which are
941
still in the working inventory and have that text hash.
944
hashfile = self._transport.get('merge-hashes')
945
except errors.NoSuchFile:
950
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
951
raise errors.MergeModifiedFormatError()
952
except StopIteration:
953
raise errors.MergeModifiedFormatError()
954
for s in RioReader(hashfile):
955
# RioReader reads in Unicode, so convert file_ids back to utf8
956
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
957
if file_id not in self.inventory:
959
text_hash = s.get("hash")
960
if text_hash == self.get_file_sha1(file_id):
961
merge_hashes[file_id] = text_hash
967
def mkdir(self, path, file_id=None):
968
"""See MutableTree.mkdir()."""
970
file_id = generate_ids.gen_file_id(os.path.basename(path))
971
os.mkdir(self.abspath(path))
972
self.add(path, file_id, 'directory')
975
def get_symlink_target(self, file_id):
976
return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc)
977
).decode(osutils._fs_enc)
980
def subsume(self, other_tree):
981
def add_children(inventory, entry):
982
for child_entry in entry.children.values():
983
inventory._byid[child_entry.file_id] = child_entry
984
if child_entry.kind == 'directory':
985
add_children(inventory, child_entry)
986
if other_tree.get_root_id() == self.get_root_id():
987
raise errors.BadSubsumeSource(self, other_tree,
988
'Trees have the same root')
990
other_tree_path = self.relpath(other_tree.basedir)
991
except errors.PathNotChild:
992
raise errors.BadSubsumeSource(self, other_tree,
993
'Tree is not contained by the other')
994
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
995
if new_root_parent is None:
996
raise errors.BadSubsumeSource(self, other_tree,
997
'Parent directory is not versioned.')
998
# We need to ensure that the result of a fetch will have a
999
# versionedfile for the other_tree root, and only fetching into
1000
# RepositoryKnit2 guarantees that.
1001
if not self.branch.repository.supports_rich_root():
1002
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1003
other_tree.lock_tree_write()
1005
new_parents = other_tree.get_parent_ids()
1006
other_root = other_tree.inventory.root
1007
other_root.parent_id = new_root_parent
1008
other_root.name = osutils.basename(other_tree_path)
1009
self.inventory.add(other_root)
1010
add_children(self.inventory, other_root)
1011
self._write_inventory(self.inventory)
1012
# normally we don't want to fetch whole repositories, but i think
1013
# here we really do want to consolidate the whole thing.
1014
for parent_id in other_tree.get_parent_ids():
1015
self.branch.fetch(other_tree.branch, parent_id)
1016
self.add_parent_tree_id(parent_id)
1019
other_tree.bzrdir.retire_bzrdir()
1021
def _setup_directory_is_tree_reference(self):
1022
if self._branch.repository._format.supports_tree_reference:
1023
self._directory_is_tree_reference = \
1024
self._directory_may_be_tree_reference
1026
self._directory_is_tree_reference = \
1027
self._directory_is_never_tree_reference
1029
def _directory_is_never_tree_reference(self, relpath):
1032
def _directory_may_be_tree_reference(self, relpath):
1033
# as a special case, if a directory contains control files then
1034
# it's a tree reference, except that the root of the tree is not
1035
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1036
# TODO: We could ask all the control formats whether they
1037
# recognize this directory, but at the moment there's no cheap api
1038
# to do that. Since we probably can only nest bzr checkouts and
1039
# they always use this name it's ok for now. -- mbp 20060306
1041
# FIXME: There is an unhandled case here of a subdirectory
1042
# containing .bzr but not a branch; that will probably blow up
1043
# when you try to commit it. It might happen if there is a
1044
# checkout in a subdirectory. This can be avoided by not adding
1047
@needs_tree_write_lock
1048
def extract(self, file_id, format=None):
1049
"""Extract a subtree from this tree.
1051
A new branch will be created, relative to the path for this tree.
1055
segments = osutils.splitpath(path)
1056
transport = self.branch.bzrdir.root_transport
1057
for name in segments:
1058
transport = transport.clone(name)
1059
transport.ensure_base()
1062
sub_path = self.id2path(file_id)
1063
branch_transport = mkdirs(sub_path)
1065
format = self.bzrdir.cloning_metadir()
1066
branch_transport.ensure_base()
1067
branch_bzrdir = format.initialize_on_transport(branch_transport)
1069
repo = branch_bzrdir.find_repository()
1070
except errors.NoRepositoryPresent:
1071
repo = branch_bzrdir.create_repository()
1072
if not repo.supports_rich_root():
1073
raise errors.RootNotRich()
1074
new_branch = branch_bzrdir.create_branch()
1075
new_branch.pull(self.branch)
1076
for parent_id in self.get_parent_ids():
1077
new_branch.fetch(self.branch, parent_id)
1078
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1079
if tree_transport.base != branch_transport.base:
1080
tree_bzrdir = format.initialize_on_transport(tree_transport)
1081
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1083
tree_bzrdir = branch_bzrdir
1084
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1085
wt.set_parent_ids(self.get_parent_ids())
1086
my_inv = self.inventory
1087
child_inv = Inventory(root_id=None)
1088
new_root = my_inv[file_id]
1089
my_inv.remove_recursive_id(file_id)
1090
new_root.parent_id = None
1091
child_inv.add(new_root)
1092
self._write_inventory(my_inv)
1093
wt._write_inventory(child_inv)
1096
def _serialize(self, inventory, out_file):
1097
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1100
def _deserialize(selt, in_file):
1101
return xml5.serializer_v5.read_inventory(in_file)
1104
"""Write the in memory inventory to disk."""
1105
# TODO: Maybe this should only write on dirty ?
1106
if self._control_files._lock_mode != 'w':
1107
raise errors.NotWriteLocked(self)
1109
self._serialize(self._inventory, sio)
1111
self._transport.put_file('inventory', sio,
1112
mode=self.bzrdir._get_file_mode())
1113
self._inventory_is_modified = False
1115
def _kind(self, relpath):
1116
return osutils.file_kind(self.abspath(relpath))
1118
def list_files(self, include_root=False):
1119
"""Recursively list all files as (path, class, kind, id, entry).
131
1121
Lists, but does not descend into unversioned directories.
136
1126
Skips the control directory.
138
from osutils import appendpath, file_kind
141
inv = self._inventory
143
def descend(from_dir_relpath, from_dir_id, dp):
1128
# list_files is an iterator, so @needs_read_lock doesn't work properly
1129
# with it. So callers should be careful to always read_lock the tree.
1130
if not self.is_locked():
1131
raise errors.ObjectNotLocked(self)
1133
inv = self.inventory
1134
if include_root is True:
1135
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1136
# Convert these into local objects to save lookup times
1137
pathjoin = osutils.pathjoin
1138
file_kind = self._kind
1140
# transport.base ends in a slash, we want the piece
1141
# between the last two slashes
1142
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1144
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1146
# directory file_id, relative path, absolute path, reverse sorted children
1147
children = os.listdir(self.basedir)
1149
# jam 20060527 The kernel sized tree seems equivalent whether we
1150
# use a deque and popleft to keep them sorted, or if we use a plain
1151
# list and just reverse() them.
1152
children = collections.deque(children)
1153
stack = [(inv.root.file_id, u'', self.basedir, children)]
1155
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1158
f = children.popleft()
147
1159
## TODO: If we find a subdirectory with its own .bzr
148
1160
## directory, then that is a separate tree and we
149
1161
## should exclude it.
150
if bzrlib.BZRDIR == f:
1163
# the bzrdir for this tree
1164
if transport_base_dir == f:
154
fp = appendpath(from_dir_relpath, f)
1167
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1168
# and 'f' doesn't begin with one, we can do a string op, rather
1169
# than the checks of pathjoin(), all relative paths will have an extra slash
1171
fp = from_dir_relpath + '/' + f
157
fap = appendpath(dp, f)
1174
fap = from_dir_abspath + '/' + f
159
1176
f_ie = inv.get_child(from_dir_id, f)
162
elif self.is_ignored(fp):
1179
elif self.is_ignored(fp[1:]):
1182
# we may not have found this file, because of a unicode issue
1183
f_norm, can_access = osutils.normalized_filename(f)
1184
if f == f_norm or not can_access:
1185
# No change, so treat this file normally
1188
# this file can be accessed by a normalized path
1189
# check again if it is versioned
1190
# these lines are repeated here for performance
1192
fp = from_dir_relpath + '/' + f
1193
fap = from_dir_abspath + '/' + f
1194
f_ie = inv.get_child(from_dir_id, f)
1197
elif self.is_ignored(fp[1:]):
167
1202
fk = file_kind(fap)
1204
# make a last minute entry
171
raise BzrCheckError("file %r entered as kind %r id %r, "
173
% (fap, f_ie.kind, f_ie.file_id, fk))
175
yield fp, c, fk, (f_ie and f_ie.file_id)
1206
yield fp[1:], c, fk, f_ie.file_id, f_ie
1209
yield fp[1:], c, fk, None, fk_entries[fk]()
1211
yield fp[1:], c, fk, None, TreeEntry()
177
1214
if fk != 'directory':
181
# don't descend unversioned directories
184
for ff in descend(fp, f_ie.file_id, fap):
187
for f in descend('', inv.root.file_id, self.basedir):
1217
# But do this child first
1218
new_children = os.listdir(fap)
1220
new_children = collections.deque(new_children)
1221
stack.append((f_ie.file_id, fp, fap, new_children))
1222
# Break out of inner loop,
1223
# so that we start outer loop with child
1226
# if we finished all children, pop it off the stack
1229
@needs_tree_write_lock
1230
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1233
to_dir must exist in the inventory.
1235
If to_dir exists and is a directory, the files are moved into
1236
it, keeping their old names.
1238
Note that to_dir is only the last component of the new name;
1239
this doesn't change the directory.
1241
For each entry in from_paths the move mode will be determined
1244
The first mode moves the file in the filesystem and updates the
1245
inventory. The second mode only updates the inventory without
1246
touching the file on the filesystem. This is the new mode introduced
1249
move uses the second mode if 'after == True' and the target is not
1250
versioned but present in the working tree.
1252
move uses the second mode if 'after == False' and the source is
1253
versioned but no longer in the working tree, and the target is not
1254
versioned but present in the working tree.
1256
move uses the first mode if 'after == False' and the source is
1257
versioned and present in the working tree, and the target is not
1258
versioned and not present in the working tree.
1260
Everything else results in an error.
1262
This returns a list of (from_path, to_path) pairs for each
1263
entry that is moved.
1268
# check for deprecated use of signature
1270
to_dir = kwargs.get('to_name', None)
1272
raise TypeError('You must supply a target directory')
1274
symbol_versioning.warn('The parameter to_name was deprecated'
1275
' in version 0.13. Use to_dir instead',
1278
# check destination directory
1279
if isinstance(from_paths, basestring):
1281
inv = self.inventory
1282
to_abs = self.abspath(to_dir)
1283
if not isdir(to_abs):
1284
raise errors.BzrMoveFailedError('',to_dir,
1285
errors.NotADirectory(to_abs))
1286
if not self.has_filename(to_dir):
1287
raise errors.BzrMoveFailedError('',to_dir,
1288
errors.NotInWorkingDirectory(to_dir))
1289
to_dir_id = inv.path2id(to_dir)
1290
if to_dir_id is None:
1291
raise errors.BzrMoveFailedError('',to_dir,
1292
errors.NotVersionedError(path=str(to_dir)))
1294
to_dir_ie = inv[to_dir_id]
1295
if to_dir_ie.kind != 'directory':
1296
raise errors.BzrMoveFailedError('',to_dir,
1297
errors.NotADirectory(to_abs))
1299
# create rename entries and tuples
1300
for from_rel in from_paths:
1301
from_tail = splitpath(from_rel)[-1]
1302
from_id = inv.path2id(from_rel)
1304
raise errors.BzrMoveFailedError(from_rel,to_dir,
1305
errors.NotVersionedError(path=str(from_rel)))
1307
from_entry = inv[from_id]
1308
from_parent_id = from_entry.parent_id
1309
to_rel = pathjoin(to_dir, from_tail)
1310
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1312
from_tail=from_tail,
1313
from_parent_id=from_parent_id,
1314
to_rel=to_rel, to_tail=from_tail,
1315
to_parent_id=to_dir_id)
1316
rename_entries.append(rename_entry)
1317
rename_tuples.append((from_rel, to_rel))
1319
# determine which move mode to use. checks also for movability
1320
rename_entries = self._determine_mv_mode(rename_entries, after)
1322
original_modified = self._inventory_is_modified
1325
self._inventory_is_modified = True
1326
self._move(rename_entries)
1328
# restore the inventory on error
1329
self._inventory_is_modified = original_modified
1331
self._write_inventory(inv)
1332
return rename_tuples
1334
def _determine_mv_mode(self, rename_entries, after=False):
1335
"""Determines for each from-to pair if both inventory and working tree
1336
or only the inventory has to be changed.
1338
Also does basic plausability tests.
1340
inv = self.inventory
1342
for rename_entry in rename_entries:
1343
# store to local variables for easier reference
1344
from_rel = rename_entry.from_rel
1345
from_id = rename_entry.from_id
1346
to_rel = rename_entry.to_rel
1347
to_id = inv.path2id(to_rel)
1348
only_change_inv = False
1350
# check the inventory for source and destination
1352
raise errors.BzrMoveFailedError(from_rel,to_rel,
1353
errors.NotVersionedError(path=str(from_rel)))
1354
if to_id is not None:
1355
raise errors.BzrMoveFailedError(from_rel,to_rel,
1356
errors.AlreadyVersionedError(path=str(to_rel)))
1358
# try to determine the mode for rename (only change inv or change
1359
# inv and file system)
1361
if not self.has_filename(to_rel):
1362
raise errors.BzrMoveFailedError(from_id,to_rel,
1363
errors.NoSuchFile(path=str(to_rel),
1364
extra="New file has not been created yet"))
1365
only_change_inv = True
1366
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1367
only_change_inv = True
1368
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1369
only_change_inv = False
1370
elif (not self.case_sensitive
1371
and from_rel.lower() == to_rel.lower()
1372
and self.has_filename(from_rel)):
1373
only_change_inv = False
1375
# something is wrong, so lets determine what exactly
1376
if not self.has_filename(from_rel) and \
1377
not self.has_filename(to_rel):
1378
raise errors.BzrRenameFailedError(from_rel,to_rel,
1379
errors.PathsDoNotExist(paths=(str(from_rel),
1382
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1383
rename_entry.only_change_inv = only_change_inv
1384
return rename_entries
1386
def _move(self, rename_entries):
1387
"""Moves a list of files.
1389
Depending on the value of the flag 'only_change_inv', the
1390
file will be moved on the file system or not.
1392
inv = self.inventory
1395
for entry in rename_entries:
1397
self._move_entry(entry)
1399
self._rollback_move(moved)
1403
def _rollback_move(self, moved):
1404
"""Try to rollback a previous move in case of an filesystem error."""
1405
inv = self.inventory
1408
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1409
entry.to_tail, entry.to_parent_id, entry.from_rel,
1410
entry.from_tail, entry.from_parent_id,
1411
entry.only_change_inv))
1412
except errors.BzrMoveFailedError, e:
1413
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1414
" The working tree is in an inconsistent state."
1415
" Please consider doing a 'bzr revert'."
1416
" Error message is: %s" % e)
1418
def _move_entry(self, entry):
1419
inv = self.inventory
1420
from_rel_abs = self.abspath(entry.from_rel)
1421
to_rel_abs = self.abspath(entry.to_rel)
1422
if from_rel_abs == to_rel_abs:
1423
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1424
"Source and target are identical.")
1426
if not entry.only_change_inv:
1428
osutils.rename(from_rel_abs, to_rel_abs)
1430
raise errors.BzrMoveFailedError(entry.from_rel,
1432
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1434
@needs_tree_write_lock
1435
def rename_one(self, from_rel, to_rel, after=False):
1438
This can change the directory or the filename or both.
1440
rename_one has several 'modes' to work. First, it can rename a physical
1441
file and change the file_id. That is the normal mode. Second, it can
1442
only change the file_id without touching any physical file. This is
1443
the new mode introduced in version 0.15.
1445
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1446
versioned but present in the working tree.
1448
rename_one uses the second mode if 'after == False' and 'from_rel' is
1449
versioned but no longer in the working tree, and 'to_rel' is not
1450
versioned but present in the working tree.
1452
rename_one uses the first mode if 'after == False' and 'from_rel' is
1453
versioned and present in the working tree, and 'to_rel' is not
1454
versioned and not present in the working tree.
1456
Everything else results in an error.
1458
inv = self.inventory
1461
# create rename entries and tuples
1462
from_tail = splitpath(from_rel)[-1]
1463
from_id = inv.path2id(from_rel)
1465
raise errors.BzrRenameFailedError(from_rel,to_rel,
1466
errors.NotVersionedError(path=str(from_rel)))
1467
from_entry = inv[from_id]
1468
from_parent_id = from_entry.parent_id
1469
to_dir, to_tail = os.path.split(to_rel)
1470
to_dir_id = inv.path2id(to_dir)
1471
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1473
from_tail=from_tail,
1474
from_parent_id=from_parent_id,
1475
to_rel=to_rel, to_tail=to_tail,
1476
to_parent_id=to_dir_id)
1477
rename_entries.append(rename_entry)
1479
# determine which move mode to use. checks also for movability
1480
rename_entries = self._determine_mv_mode(rename_entries, after)
1482
# check if the target changed directory and if the target directory is
1484
if to_dir_id is None:
1485
raise errors.BzrMoveFailedError(from_rel,to_rel,
1486
errors.NotVersionedError(path=str(to_dir)))
1488
# all checks done. now we can continue with our actual work
1489
mutter('rename_one:\n'
1494
' to_dir_id {%s}\n',
1495
from_id, from_rel, to_rel, to_dir, to_dir_id)
1497
self._move(rename_entries)
1498
self._write_inventory(inv)
1500
class _RenameEntry(object):
1501
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1502
to_rel, to_tail, to_parent_id, only_change_inv=False):
1503
self.from_rel = from_rel
1504
self.from_id = from_id
1505
self.from_tail = from_tail
1506
self.from_parent_id = from_parent_id
1507
self.to_rel = to_rel
1508
self.to_tail = to_tail
1509
self.to_parent_id = to_parent_id
1510
self.only_change_inv = only_change_inv
192
1513
def unknowns(self):
193
for subp in self.extras():
194
if not self.is_ignored(subp):
1514
"""Return all unknown files.
1516
These are files in the working directory that are not versioned or
1517
control files or ignored.
1519
# force the extras method to be fully executed before returning, to
1520
# prevent race conditions with the lock
1522
[subp for subp in self.extras() if not self.is_ignored(subp)])
1524
@needs_tree_write_lock
1525
def unversion(self, file_ids):
1526
"""Remove the file ids in file_ids from the current versioned set.
1528
When a file_id is unversioned, all of its children are automatically
1531
:param file_ids: The file ids to stop versioning.
1532
:raises: NoSuchId if any fileid is not currently versioned.
1534
for file_id in file_ids:
1535
if file_id not in self._inventory:
1536
raise errors.NoSuchId(self, file_id)
1537
for file_id in file_ids:
1538
if self._inventory.has_id(file_id):
1539
self._inventory.remove_recursive_id(file_id)
1541
# in the future this should just set a dirty bit to wait for the
1542
# final unlock. However, until all methods of workingtree start
1543
# with the current in -memory inventory rather than triggering
1544
# a read, it is more complex - we need to teach read_inventory
1545
# to know when to read, and when to not read first... and possibly
1546
# to save first when the in memory one may be corrupted.
1547
# so for now, we just only write it if it is indeed dirty.
1549
self._write_inventory(self._inventory)
1551
def _iter_conflicts(self):
1553
for info in self.list_files():
1555
stem = get_conflicted_stem(path)
1558
if stem not in conflicted:
1559
conflicted.add(stem)
1563
def pull(self, source, overwrite=False, stop_revision=None,
1564
change_reporter=None, possible_transports=None):
1565
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1568
pp = ProgressPhase("Pull phase", 2, top_pb)
1570
old_revision_info = self.branch.last_revision_info()
1571
basis_tree = self.basis_tree()
1572
count = self.branch.pull(source, overwrite, stop_revision,
1573
possible_transports=possible_transports)
1574
new_revision_info = self.branch.last_revision_info()
1575
if new_revision_info != old_revision_info:
1577
repository = self.branch.repository
1578
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1579
basis_tree.lock_read()
1581
new_basis_tree = self.branch.basis_tree()
1588
change_reporter=change_reporter)
1589
if (basis_tree.inventory.root is None and
1590
new_basis_tree.inventory.root is not None):
1591
self.set_root_id(new_basis_tree.get_root_id())
1595
# TODO - dedup parents list with things merged by pull ?
1596
# reuse the revisiontree we merged against to set the new
1598
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1599
# we have to pull the merge trees out again, because
1600
# merge_inner has set the ids. - this corner is not yet
1601
# layered well enough to prevent double handling.
1602
# XXX TODO: Fix the double handling: telling the tree about
1603
# the already known parent data is wasteful.
1604
merges = self.get_parent_ids()[1:]
1605
parent_trees.extend([
1606
(parent, repository.revision_tree(parent)) for
1608
self.set_parent_trees(parent_trees)
1615
def put_file_bytes_non_atomic(self, file_id, bytes):
1616
"""See MutableTree.put_file_bytes_non_atomic."""
1617
stream = file(self.id2abspath(file_id), 'wb')
1622
# TODO: update the hashcache here ?
198
1624
def extras(self):
199
"""Yield all unknown files in this WorkingTree.
1625
"""Yield all unversioned files in this WorkingTree.
201
If there are any unknown directories then only the directory is
202
returned, not all its children. But if there are unknown files
1627
If there are any unversioned directories then only the directory is
1628
returned, not all its children. But if there are unversioned files
203
1629
under a versioned subdirectory, they are returned.
205
1631
Currently returned depth-first, sorted by name within directories.
1632
This is the same order used by 'osutils.walkdirs'.
207
1634
## TODO: Work from given directory downwards
208
from osutils import isdir, appendpath
210
1635
for path, dir_entry in self.inventory.directories():
211
mutter("search for unknowns in %r" % path)
1636
# mutter("search for unknowns in %r", path)
212
1637
dirabs = self.abspath(path)
213
1638
if not isdir(dirabs):
214
1639
# e.g. directory deleted
259
1705
If the file is ignored, returns the pattern which caused it to
260
1706
be ignored, otherwise None. So this can simply be used as a
261
1707
boolean if desired."""
263
# TODO: Use '**' to match directories, and other extended
264
# globbing stuff from cvs/rsync.
266
# XXX: fnmatch is actually not quite what we want: it's only
267
# approximately the same as real Unix fnmatch, and doesn't
268
# treat dotfiles correctly and allows * to match /.
269
# Eventually it should be replaced with something more
273
from osutils import splitpath
275
for pat in self.get_ignore_list():
276
if '/' in pat or '\\' in pat:
278
# as a special case, you can put ./ at the start of a
279
# pattern; this is good to match in the top-level
282
if (pat[:2] == './') or (pat[:2] == '.\\'):
1708
if getattr(self, '_ignoreglobster', None) is None:
1709
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1710
return self._ignoreglobster.match(filename)
1712
def kind(self, file_id):
1713
return file_kind(self.id2abspath(file_id))
1715
def stored_kind(self, file_id):
1716
"""See Tree.stored_kind"""
1717
return self.inventory[file_id].kind
1719
def _comparison_data(self, entry, path):
1720
abspath = self.abspath(path)
1722
stat_value = os.lstat(abspath)
1724
if getattr(e, 'errno', None) == errno.ENOENT:
1731
mode = stat_value.st_mode
1732
kind = osutils.file_kind_from_stat_mode(mode)
1733
if not supports_executable():
1734
executable = entry is not None and entry.executable
1736
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1737
return kind, executable, stat_value
1739
def _file_size(self, entry, stat_value):
1740
return stat_value.st_size
1742
def last_revision(self):
1743
"""Return the last revision of the branch for this tree.
1745
This format tree does not support a separate marker for last-revision
1746
compared to the branch.
1748
See MutableTree.last_revision
1750
return self._last_revision()
1753
def _last_revision(self):
1754
"""helper for get_parent_ids."""
1755
return _mod_revision.ensure_null(self.branch.last_revision())
1757
def is_locked(self):
1758
return self._control_files.is_locked()
1760
def _must_be_locked(self):
1761
if not self.is_locked():
1762
raise errors.ObjectNotLocked(self)
1764
def lock_read(self):
1765
"""See Branch.lock_read, and WorkingTree.unlock."""
1766
if not self.is_locked():
1768
self.branch.lock_read()
1770
return self._control_files.lock_read()
1772
self.branch.unlock()
1775
def lock_tree_write(self):
1776
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1777
if not self.is_locked():
1779
self.branch.lock_read()
1781
return self._control_files.lock_write()
1783
self.branch.unlock()
1786
def lock_write(self):
1787
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1788
if not self.is_locked():
1790
self.branch.lock_write()
1792
return self._control_files.lock_write()
1794
self.branch.unlock()
1797
def get_physical_lock_status(self):
1798
return self._control_files.get_physical_lock_status()
1800
def _basis_inventory_name(self):
1801
return 'basis-inventory-cache'
1803
def _reset_data(self):
1804
"""Reset transient data that cannot be revalidated."""
1805
self._inventory_is_modified = False
1806
result = self._deserialize(self._transport.get('inventory'))
1807
self._set_inventory(result, dirty=False)
1809
@needs_tree_write_lock
1810
def set_last_revision(self, new_revision):
1811
"""Change the last revision in the working tree."""
1812
if self._change_last_revision(new_revision):
1813
self._cache_basis_inventory(new_revision)
1815
def _change_last_revision(self, new_revision):
1816
"""Template method part of set_last_revision to perform the change.
1818
This is used to allow WorkingTree3 instances to not affect branch
1819
when their last revision is set.
1821
if _mod_revision.is_null(new_revision):
1822
self.branch.set_revision_history([])
1825
self.branch.generate_revision_history(new_revision)
1826
except errors.NoSuchRevision:
1827
# not present in the repo - dont try to set it deeper than the tip
1828
self.branch.set_revision_history([new_revision])
1831
def _write_basis_inventory(self, xml):
1832
"""Write the basis inventory XML to the basis-inventory file"""
1833
path = self._basis_inventory_name()
1835
self._transport.put_file(path, sio,
1836
mode=self.bzrdir._get_file_mode())
1838
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1839
"""Create the text that will be saved in basis-inventory"""
1840
inventory.revision_id = revision_id
1841
return xml7.serializer_v7.write_inventory_to_string(inventory)
1843
def _cache_basis_inventory(self, new_revision):
1844
"""Cache new_revision as the basis inventory."""
1845
# TODO: this should allow the ready-to-use inventory to be passed in,
1846
# as commit already has that ready-to-use [while the format is the
1849
# this double handles the inventory - unpack and repack -
1850
# but is easier to understand. We can/should put a conditional
1851
# in here based on whether the inventory is in the latest format
1852
# - perhaps we should repack all inventories on a repository
1854
# the fast path is to copy the raw xml from the repository. If the
1855
# xml contains 'revision_id="', then we assume the right
1856
# revision_id is set. We must check for this full string, because a
1857
# root node id can legitimately look like 'revision_id' but cannot
1859
xml = self.branch.repository.get_inventory_xml(new_revision)
1860
firstline = xml.split('\n', 1)[0]
1861
if (not 'revision_id="' in firstline or
1862
'format="7"' not in firstline):
1863
inv = self.branch.repository.deserialise_inventory(
1865
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1866
self._write_basis_inventory(xml)
1867
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1870
def read_basis_inventory(self):
1871
"""Read the cached basis inventory."""
1872
path = self._basis_inventory_name()
1873
return self._transport.get_bytes(path)
1876
def read_working_inventory(self):
1877
"""Read the working inventory.
1879
:raises errors.InventoryModified: read_working_inventory will fail
1880
when the current in memory inventory has been modified.
1882
# conceptually this should be an implementation detail of the tree.
1883
# XXX: Deprecate this.
1884
# ElementTree does its own conversion from UTF-8, so open in
1886
if self._inventory_is_modified:
1887
raise errors.InventoryModified(self)
1888
result = self._deserialize(self._transport.get('inventory'))
1889
self._set_inventory(result, dirty=False)
1892
@needs_tree_write_lock
1893
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1895
"""Remove nominated files from the working inventory.
1897
:files: File paths relative to the basedir.
1898
:keep_files: If true, the files will also be kept.
1899
:force: Delete files and directories, even if they are changed and
1900
even if the directories are not empty.
1902
if isinstance(files, basestring):
1908
unknown_nested_files=set()
1910
def recurse_directory_to_add_files(directory):
1911
# Recurse directory and add all files
1912
# so we can check if they have changed.
1913
for parent_info, file_infos in\
1914
self.walkdirs(directory):
1915
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1916
# Is it versioned or ignored?
1917
if self.path2id(relpath) or self.is_ignored(relpath):
1918
# Add nested content for deletion.
1919
new_files.add(relpath)
1921
# Files which are not versioned and not ignored
1922
# should be treated as unknown.
1923
unknown_nested_files.add((relpath, None, kind))
1925
for filename in files:
1926
# Get file name into canonical form.
1927
abspath = self.abspath(filename)
1928
filename = self.relpath(abspath)
1929
if len(filename) > 0:
1930
new_files.add(filename)
1931
recurse_directory_to_add_files(filename)
1933
files = list(new_files)
1936
return # nothing to do
1938
# Sort needed to first handle directory content before the directory
1939
files.sort(reverse=True)
1941
# Bail out if we are going to delete files we shouldn't
1942
if not keep_files and not force:
1943
has_changed_files = len(unknown_nested_files) > 0
1944
if not has_changed_files:
1945
for (file_id, path, content_change, versioned, parent_id, name,
1946
kind, executable) in self.iter_changes(self.basis_tree(),
1947
include_unchanged=True, require_versioned=False,
1948
want_unversioned=True, specific_files=files):
1949
if versioned == (False, False):
1950
# The record is unknown ...
1951
if not self.is_ignored(path[1]):
1952
# ... but not ignored
1953
has_changed_files = True
1955
elif content_change and (kind[1] is not None):
1956
# Versioned and changed, but not deleted
1957
has_changed_files = True
1960
if has_changed_files:
1961
# Make delta show ALL applicable changes in error message.
1962
tree_delta = self.changes_from(self.basis_tree(),
1963
require_versioned=False, want_unversioned=True,
1964
specific_files=files)
1965
for unknown_file in unknown_nested_files:
1966
if unknown_file not in tree_delta.unversioned:
1967
tree_delta.unversioned.extend((unknown_file,))
1968
raise errors.BzrRemoveChangedFilesError(tree_delta)
1970
# Build inv_delta and delete files where applicable,
1971
# do this before any modifications to inventory.
1973
fid = self.path2id(f)
1976
message = "%s is not versioned." % (f,)
1979
# having removed it, it must be either ignored or unknown
1980
if self.is_ignored(f):
1984
textui.show_status(new_status, self.kind(fid), f,
1987
inv_delta.append((f, None, fid, None))
1988
message = "removed %s" % (f,)
1991
abs_path = self.abspath(f)
1992
if osutils.lexists(abs_path):
1993
if (osutils.isdir(abs_path) and
1994
len(os.listdir(abs_path)) > 0):
1996
osutils.rmtree(abs_path)
1998
message = "%s is not an empty directory "\
1999
"and won't be deleted." % (f,)
2001
osutils.delete_any(abs_path)
2002
message = "deleted %s" % (f,)
2003
elif message is not None:
2004
# Only care if we haven't done anything yet.
2005
message = "%s does not exist." % (f,)
2007
# Print only one message (if any) per file.
2008
if message is not None:
2010
self.apply_inventory_delta(inv_delta)
2012
@needs_tree_write_lock
2013
def revert(self, filenames=None, old_tree=None, backups=True,
2014
pb=DummyProgress(), report_changes=False):
2015
from bzrlib.conflicts import resolve
2018
symbol_versioning.warn('Using [] to revert all files is deprecated'
2019
' as of bzr 0.91. Please use None (the default) instead.',
2020
DeprecationWarning, stacklevel=2)
2021
if old_tree is None:
2022
basis_tree = self.basis_tree()
2023
basis_tree.lock_read()
2024
old_tree = basis_tree
2028
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2030
if filenames is None and len(self.get_parent_ids()) > 1:
2032
last_revision = self.last_revision()
2033
if last_revision != NULL_REVISION:
2034
if basis_tree is None:
2035
basis_tree = self.basis_tree()
2036
basis_tree.lock_read()
2037
parent_trees.append((last_revision, basis_tree))
2038
self.set_parent_trees(parent_trees)
2041
resolve(self, filenames, ignore_misses=True, recursive=True)
2043
if basis_tree is not None:
2047
def revision_tree(self, revision_id):
2048
"""See Tree.revision_tree.
2050
WorkingTree can supply revision_trees for the basis revision only
2051
because there is only one cached inventory in the bzr directory.
2053
if revision_id == self.last_revision():
2055
xml = self.read_basis_inventory()
2056
except errors.NoSuchFile:
2060
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2061
# dont use the repository revision_tree api because we want
2062
# to supply the inventory.
2063
if inv.revision_id == revision_id:
2064
return revisiontree.RevisionTree(self.branch.repository,
2066
except errors.BadInventoryFormat:
2068
# raise if there was no inventory, or if we read the wrong inventory.
2069
raise errors.NoSuchRevisionInTree(self, revision_id)
2071
# XXX: This method should be deprecated in favour of taking in a proper
2072
# new Inventory object.
2073
@needs_tree_write_lock
2074
def set_inventory(self, new_inventory_list):
2075
from bzrlib.inventory import (Inventory,
2080
inv = Inventory(self.get_root_id())
2081
for path, file_id, parent, kind in new_inventory_list:
2082
name = os.path.basename(path)
2085
# fixme, there should be a factory function inv,add_??
2086
if kind == 'directory':
2087
inv.add(InventoryDirectory(file_id, name, parent))
2088
elif kind == 'file':
2089
inv.add(InventoryFile(file_id, name, parent))
2090
elif kind == 'symlink':
2091
inv.add(InventoryLink(file_id, name, parent))
2093
raise errors.BzrError("unknown kind %r" % kind)
2094
self._write_inventory(inv)
2096
@needs_tree_write_lock
2097
def set_root_id(self, file_id):
2098
"""Set the root id for this tree."""
2102
'WorkingTree.set_root_id with fileid=None')
2103
file_id = osutils.safe_file_id(file_id)
2104
self._set_root_id(file_id)
2106
def _set_root_id(self, file_id):
2107
"""Set the root id for this tree, in a format specific manner.
2109
:param file_id: The file id to assign to the root. It must not be
2110
present in the current inventory or an error will occur. It must
2111
not be None, but rather a valid file id.
2113
inv = self._inventory
2114
orig_root_id = inv.root.file_id
2115
# TODO: it might be nice to exit early if there was nothing
2116
# to do, saving us from trigger a sync on unlock.
2117
self._inventory_is_modified = True
2118
# we preserve the root inventory entry object, but
2119
# unlinkit from the byid index
2120
del inv._byid[inv.root.file_id]
2121
inv.root.file_id = file_id
2122
# and link it into the index with the new changed id.
2123
inv._byid[inv.root.file_id] = inv.root
2124
# and finally update all children to reference the new id.
2125
# XXX: this should be safe to just look at the root.children
2126
# list, not the WHOLE INVENTORY.
2129
if entry.parent_id == orig_root_id:
2130
entry.parent_id = inv.root.file_id
2133
"""See Branch.unlock.
2135
WorkingTree locking just uses the Branch locking facilities.
2136
This is current because all working trees have an embedded branch
2137
within them. IF in the future, we were to make branch data shareable
2138
between multiple working trees, i.e. via shared storage, then we
2139
would probably want to lock both the local tree, and the branch.
2141
raise NotImplementedError(self.unlock)
2143
def update(self, change_reporter=None, possible_transports=None):
2144
"""Update a working tree along its branch.
2146
This will update the branch if its bound too, which means we have
2147
multiple trees involved:
2149
- The new basis tree of the master.
2150
- The old basis tree of the branch.
2151
- The old basis tree of the working tree.
2152
- The current working tree state.
2154
Pathologically, all three may be different, and non-ancestors of each
2155
other. Conceptually we want to:
2157
- Preserve the wt.basis->wt.state changes
2158
- Transform the wt.basis to the new master basis.
2159
- Apply a merge of the old branch basis to get any 'local' changes from
2161
- Restore the wt.basis->wt.state changes.
2163
There isn't a single operation at the moment to do that, so we:
2164
- Merge current state -> basis tree of the master w.r.t. the old tree
2166
- Do a 'normal' merge of the old branch basis if it is relevant.
2168
if self.branch.get_bound_location() is not None:
2170
update_branch = True
2172
self.lock_tree_write()
2173
update_branch = False
2176
old_tip = self.branch.update(possible_transports)
2179
return self._update_tree(old_tip, change_reporter)
2183
@needs_tree_write_lock
2184
def _update_tree(self, old_tip=None, change_reporter=None):
2185
"""Update a tree to the master branch.
2187
:param old_tip: if supplied, the previous tip revision the branch,
2188
before it was changed to the master branch's tip.
2190
# here if old_tip is not None, it is the old tip of the branch before
2191
# it was updated from the master branch. This should become a pending
2192
# merge in the working tree to preserve the user existing work. we
2193
# cant set that until we update the working trees last revision to be
2194
# one from the new branch, because it will just get absorbed by the
2195
# parent de-duplication logic.
2197
# We MUST save it even if an error occurs, because otherwise the users
2198
# local work is unreferenced and will appear to have been lost.
2202
last_rev = self.get_parent_ids()[0]
2204
last_rev = _mod_revision.NULL_REVISION
2205
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2206
# merge tree state up to new branch tip.
2207
basis = self.basis_tree()
2210
to_tree = self.branch.basis_tree()
2211
if basis.inventory.root is None:
2212
self.set_root_id(to_tree.get_root_id())
2214
result += merge.merge_inner(
2219
change_reporter=change_reporter)
2222
# TODO - dedup parents list with things merged by pull ?
2223
# reuse the tree we've updated to to set the basis:
2224
parent_trees = [(self.branch.last_revision(), to_tree)]
2225
merges = self.get_parent_ids()[1:]
2226
# Ideally we ask the tree for the trees here, that way the working
2227
# tree can decide whether to give us the entire tree or give us a
2228
# lazy initialised tree. dirstate for instance will have the trees
2229
# in ram already, whereas a last-revision + basis-inventory tree
2230
# will not, but also does not need them when setting parents.
2231
for parent in merges:
2232
parent_trees.append(
2233
(parent, self.branch.repository.revision_tree(parent)))
2234
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2235
parent_trees.append(
2236
(old_tip, self.branch.repository.revision_tree(old_tip)))
2237
self.set_parent_trees(parent_trees)
2238
last_rev = parent_trees[0][0]
2240
# the working tree had the same last-revision as the master
2241
# branch did. We may still have pivot local work from the local
2242
# branch into old_tip:
2243
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2244
self.add_parent_tree_id(old_tip)
2245
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2246
and old_tip != last_rev):
2247
# our last revision was not the prior branch last revision
2248
# and we have converted that last revision to a pending merge.
2249
# base is somewhere between the branch tip now
2250
# and the now pending merge
2252
# Since we just modified the working tree and inventory, flush out
2253
# the current state, before we modify it again.
2254
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2255
# requires it only because TreeTransform directly munges the
2256
# inventory and calls tree._write_inventory(). Ultimately we
2257
# should be able to remove this extra flush.
2259
graph = self.branch.repository.get_graph()
2260
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2262
base_tree = self.branch.repository.revision_tree(base_rev_id)
2263
other_tree = self.branch.repository.revision_tree(old_tip)
2264
result += merge.merge_inner(
2269
change_reporter=change_reporter)
2272
def _write_hashcache_if_dirty(self):
2273
"""Write out the hashcache if it is dirty."""
2274
if self._hashcache.needs_write:
2276
self._hashcache.write()
2278
if e.errno not in (errno.EPERM, errno.EACCES):
2280
# TODO: jam 20061219 Should this be a warning? A single line
2281
# warning might be sufficient to let the user know what
2283
mutter('Could not write hashcache for %s\nError: %s',
2284
self._hashcache.cache_file_name(), e)
2286
@needs_tree_write_lock
2287
def _write_inventory(self, inv):
2288
"""Write inventory as the current inventory."""
2289
self._set_inventory(inv, dirty=True)
2292
def set_conflicts(self, arg):
2293
raise errors.UnsupportedOperation(self.set_conflicts, self)
2295
def add_conflicts(self, arg):
2296
raise errors.UnsupportedOperation(self.add_conflicts, self)
2299
def conflicts(self):
2300
conflicts = _mod_conflicts.ConflictList()
2301
for conflicted in self._iter_conflicts():
2304
if file_kind(self.abspath(conflicted)) != "file":
2306
except errors.NoSuchFile:
2309
for suffix in ('.THIS', '.OTHER'):
2311
kind = file_kind(self.abspath(conflicted+suffix))
2314
except errors.NoSuchFile:
2318
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2319
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2321
file_id=self.path2id(conflicted)))
2324
def walkdirs(self, prefix=""):
2325
"""Walk the directories of this tree.
2327
returns a generator which yields items in the form:
2328
((curren_directory_path, fileid),
2329
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2332
This API returns a generator, which is only valid during the current
2333
tree transaction - within a single lock_read or lock_write duration.
2335
If the tree is not locked, it may cause an error to be raised,
2336
depending on the tree implementation.
2338
disk_top = self.abspath(prefix)
2339
if disk_top.endswith('/'):
2340
disk_top = disk_top[:-1]
2341
top_strip_len = len(disk_top) + 1
2342
inventory_iterator = self._walkdirs(prefix)
2343
disk_iterator = osutils.walkdirs(disk_top, prefix)
2345
current_disk = disk_iterator.next()
2346
disk_finished = False
2348
if not (e.errno == errno.ENOENT or
2349
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2352
disk_finished = True
2354
current_inv = inventory_iterator.next()
2355
inv_finished = False
2356
except StopIteration:
2359
while not inv_finished or not disk_finished:
2361
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2362
cur_disk_dir_content) = current_disk
2364
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2365
cur_disk_dir_content) = ((None, None), None)
2366
if not disk_finished:
2367
# strip out .bzr dirs
2368
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2369
len(cur_disk_dir_content) > 0):
2370
# osutils.walkdirs can be made nicer -
2371
# yield the path-from-prefix rather than the pathjoined
2373
bzrdir_loc = bisect_left(cur_disk_dir_content,
2375
if (bzrdir_loc < len(cur_disk_dir_content)
2376
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2377
# we dont yield the contents of, or, .bzr itself.
2378
del cur_disk_dir_content[bzrdir_loc]
2380
# everything is unknown
2383
# everything is missing
2386
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2388
# disk is before inventory - unknown
2389
dirblock = [(relpath, basename, kind, stat, None, None) for
2390
relpath, basename, kind, stat, top_path in
2391
cur_disk_dir_content]
2392
yield (cur_disk_dir_relpath, None), dirblock
2394
current_disk = disk_iterator.next()
2395
except StopIteration:
2396
disk_finished = True
2398
# inventory is before disk - missing.
2399
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2400
for relpath, basename, dkind, stat, fileid, kind in
2402
yield (current_inv[0][0], current_inv[0][1]), dirblock
2404
current_inv = inventory_iterator.next()
2405
except StopIteration:
2408
# versioned present directory
2409
# merge the inventory and disk data together
2411
for relpath, subiterator in itertools.groupby(sorted(
2412
current_inv[1] + cur_disk_dir_content,
2413
key=operator.itemgetter(0)), operator.itemgetter(1)):
2414
path_elements = list(subiterator)
2415
if len(path_elements) == 2:
2416
inv_row, disk_row = path_elements
2417
# versioned, present file
2418
dirblock.append((inv_row[0],
2419
inv_row[1], disk_row[2],
2420
disk_row[3], inv_row[4],
2422
elif len(path_elements[0]) == 5:
2424
dirblock.append((path_elements[0][0],
2425
path_elements[0][1], path_elements[0][2],
2426
path_elements[0][3], None, None))
2427
elif len(path_elements[0]) == 6:
2428
# versioned, absent file.
2429
dirblock.append((path_elements[0][0],
2430
path_elements[0][1], 'unknown', None,
2431
path_elements[0][4], path_elements[0][5]))
2433
raise NotImplementedError('unreachable code')
2434
yield current_inv[0], dirblock
2436
current_inv = inventory_iterator.next()
2437
except StopIteration:
2440
current_disk = disk_iterator.next()
2441
except StopIteration:
2442
disk_finished = True
2444
def _walkdirs(self, prefix=""):
2445
"""Walk the directories of this tree.
2447
:prefix: is used as the directrory to start with.
2448
returns a generator which yields items in the form:
2449
((curren_directory_path, fileid),
2450
[(file1_path, file1_name, file1_kind, None, file1_id,
2453
_directory = 'directory'
2454
# get the root in the inventory
2455
inv = self.inventory
2456
top_id = inv.path2id(prefix)
2460
pending = [(prefix, '', _directory, None, top_id, None)]
2463
currentdir = pending.pop()
2464
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2465
top_id = currentdir[4]
2467
relroot = currentdir[0] + '/'
2470
# FIXME: stash the node in pending
2472
if entry.kind == 'directory':
2473
for name, child in entry.sorted_children():
2474
dirblock.append((relroot + name, name, child.kind, None,
2475
child.file_id, child.kind
2477
yield (currentdir[0], entry.file_id), dirblock
2478
# push the user specified dirs from dirblock
2479
for dir in reversed(dirblock):
2480
if dir[2] == _directory:
2483
@needs_tree_write_lock
2484
def auto_resolve(self):
2485
"""Automatically resolve text conflicts according to contents.
2487
Only text conflicts are auto_resolvable. Files with no conflict markers
2488
are considered 'resolved', because bzr always puts conflict markers
2489
into files that have text conflicts. The corresponding .THIS .BASE and
2490
.OTHER files are deleted, as per 'resolve'.
2491
:return: a tuple of ConflictLists: (un_resolved, resolved).
2493
un_resolved = _mod_conflicts.ConflictList()
2494
resolved = _mod_conflicts.ConflictList()
2495
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2496
for conflict in self.conflicts():
2497
if (conflict.typestring != 'text conflict' or
2498
self.kind(conflict.file_id) != 'file'):
2499
un_resolved.append(conflict)
2501
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2503
for line in my_file:
2504
if conflict_re.search(line):
2505
un_resolved.append(conflict)
286
if fnmatch.fnmatchcase(filename, newpat):
2508
resolved.append(conflict)
2511
resolved.remove_files(self)
2512
self.set_conflicts(un_resolved)
2513
return un_resolved, resolved
2517
tree_basis = self.basis_tree()
2518
tree_basis.lock_read()
2520
repo_basis = self.branch.repository.revision_tree(
2521
self.last_revision())
2522
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2523
raise errors.BzrCheckError(
2524
"Mismatched basis inventory content.")
2529
def _validate(self):
2530
"""Validate internal structures.
2532
This is meant mostly for the test suite. To give it a chance to detect
2533
corruption after actions have occurred. The default implementation is a
2536
:return: None. An exception should be raised if there is an error.
2541
def _get_rules_searcher(self, default_searcher):
2542
"""See Tree._get_rules_searcher."""
2543
if self._rules_searcher is None:
2544
self._rules_searcher = super(WorkingTree,
2545
self)._get_rules_searcher(default_searcher)
2546
return self._rules_searcher
2548
def get_shelf_manager(self):
2549
"""Return the ShelfManager for this WorkingTree."""
2550
from bzrlib.shelf import ShelfManager
2551
return ShelfManager(self, self._transport)
2554
class WorkingTree2(WorkingTree):
2555
"""This is the Format 2 working tree.
2557
This was the first weave based working tree.
2558
- uses os locks for locking.
2559
- uses the branch last-revision.
2562
def __init__(self, *args, **kwargs):
2563
super(WorkingTree2, self).__init__(*args, **kwargs)
2564
# WorkingTree2 has more of a constraint that self._inventory must
2565
# exist. Because this is an older format, we don't mind the overhead
2566
# caused by the extra computation here.
2568
# Newer WorkingTree's should only have self._inventory set when they
2570
if self._inventory is None:
2571
self.read_working_inventory()
2573
def lock_tree_write(self):
2574
"""See WorkingTree.lock_tree_write().
2576
In Format2 WorkingTrees we have a single lock for the branch and tree
2577
so lock_tree_write() degrades to lock_write().
2579
self.branch.lock_write()
2581
return self._control_files.lock_write()
2583
self.branch.unlock()
2587
# do non-implementation specific cleanup
2590
# we share control files:
2591
if self._control_files._lock_count == 3:
2592
# _inventory_is_modified is always False during a read lock.
2593
if self._inventory_is_modified:
2595
self._write_hashcache_if_dirty()
2597
# reverse order of locking.
2599
return self._control_files.unlock()
2601
self.branch.unlock()
2604
class WorkingTree3(WorkingTree):
2605
"""This is the Format 3 working tree.
2607
This differs from the base WorkingTree by:
2608
- having its own file lock
2609
- having its own last-revision property.
2611
This is new in bzr 0.8
2615
def _last_revision(self):
2616
"""See Mutable.last_revision."""
2618
return self._transport.get_bytes('last-revision')
2619
except errors.NoSuchFile:
2620
return _mod_revision.NULL_REVISION
2622
def _change_last_revision(self, revision_id):
2623
"""See WorkingTree._change_last_revision."""
2624
if revision_id is None or revision_id == NULL_REVISION:
2626
self._transport.delete('last-revision')
2627
except errors.NoSuchFile:
2631
self._transport.put_bytes('last-revision', revision_id,
2632
mode=self.bzrdir._get_file_mode())
2635
@needs_tree_write_lock
2636
def set_conflicts(self, conflicts):
2637
self._put_rio('conflicts', conflicts.to_stanzas(),
2640
@needs_tree_write_lock
2641
def add_conflicts(self, new_conflicts):
2642
conflict_set = set(self.conflicts())
2643
conflict_set.update(set(list(new_conflicts)))
2644
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2645
key=_mod_conflicts.Conflict.sort_key)))
2648
def conflicts(self):
2650
confile = self._transport.get('conflicts')
2651
except errors.NoSuchFile:
2652
return _mod_conflicts.ConflictList()
2655
if confile.next() != CONFLICT_HEADER_1 + '\n':
2656
raise errors.ConflictFormatError()
2657
except StopIteration:
2658
raise errors.ConflictFormatError()
2659
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2664
# do non-implementation specific cleanup
2666
if self._control_files._lock_count == 1:
2667
# _inventory_is_modified is always False during a read lock.
2668
if self._inventory_is_modified:
2670
self._write_hashcache_if_dirty()
2671
# reverse order of locking.
2673
return self._control_files.unlock()
2675
self.branch.unlock()
2678
def get_conflicted_stem(path):
2679
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2680
if path.endswith(suffix):
2681
return path[:-len(suffix)]
2684
class WorkingTreeFormat(object):
2685
"""An encapsulation of the initialization and open routines for a format.
2687
Formats provide three things:
2688
* An initialization routine,
2692
Formats are placed in an dict by their format string for reference
2693
during workingtree opening. Its not required that these be instances, they
2694
can be classes themselves with class methods - it simply depends on
2695
whether state is needed for a given format or not.
2697
Once a format is deprecated, just deprecate the initialize and open
2698
methods on the format class. Do not deprecate the object, as the
2699
object will be created every time regardless.
2702
_default_format = None
2703
"""The default format used for new trees."""
2706
"""The known formats."""
2708
requires_rich_root = False
2710
upgrade_recommended = False
2713
def find_format(klass, a_bzrdir):
2714
"""Return the format for the working tree object in a_bzrdir."""
2716
transport = a_bzrdir.get_workingtree_transport(None)
2717
format_string = transport.get("format").read()
2718
return klass._formats[format_string]
2719
except errors.NoSuchFile:
2720
raise errors.NoWorkingTree(base=transport.base)
2722
raise errors.UnknownFormatError(format=format_string,
2723
kind="working tree")
2725
def __eq__(self, other):
2726
return self.__class__ is other.__class__
2728
def __ne__(self, other):
2729
return not (self == other)
2732
def get_default_format(klass):
2733
"""Return the current default format."""
2734
return klass._default_format
2736
def get_format_string(self):
2737
"""Return the ASCII format string that identifies this format."""
2738
raise NotImplementedError(self.get_format_string)
2740
def get_format_description(self):
2741
"""Return the short description for this format."""
2742
raise NotImplementedError(self.get_format_description)
2744
def is_supported(self):
2745
"""Is this format supported?
2747
Supported formats can be initialized and opened.
2748
Unsupported formats may not support initialization or committing or
2749
some other features depending on the reason for not being supported.
2753
def supports_content_filtering(self):
2754
"""True if this format supports content filtering."""
2757
def supports_views(self):
2758
"""True if this format supports stored views."""
2762
def register_format(klass, format):
2763
klass._formats[format.get_format_string()] = format
2766
def set_default_format(klass, format):
2767
klass._default_format = format
2770
def unregister_format(klass, format):
2771
del klass._formats[format.get_format_string()]
2774
class WorkingTreeFormat2(WorkingTreeFormat):
2775
"""The second working tree format.
2777
This format modified the hash cache from the format 1 hash cache.
2780
upgrade_recommended = True
2782
def get_format_description(self):
2783
"""See WorkingTreeFormat.get_format_description()."""
2784
return "Working tree format 2"
2786
def _stub_initialize_on_transport(self, transport, file_mode):
2787
"""Workaround: create control files for a remote working tree.
2789
This ensures that it can later be updated and dealt with locally,
2790
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2791
no working tree. (See bug #43064).
2795
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2797
transport.put_file('inventory', sio, file_mode)
2798
transport.put_bytes('pending-merges', '', file_mode)
2800
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2801
accelerator_tree=None, hardlink=False):
2802
"""See WorkingTreeFormat.initialize()."""
2803
if not isinstance(a_bzrdir.transport, LocalTransport):
2804
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2805
if from_branch is not None:
2806
branch = from_branch
2808
branch = a_bzrdir.open_branch()
2809
if revision_id is None:
2810
revision_id = _mod_revision.ensure_null(branch.last_revision())
2813
branch.generate_revision_history(revision_id)
2817
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2823
basis_tree = branch.repository.revision_tree(revision_id)
2824
if basis_tree.inventory.root is not None:
2825
wt.set_root_id(basis_tree.get_root_id())
2826
# set the parent list and cache the basis tree.
2827
if _mod_revision.is_null(revision_id):
2830
parent_trees = [(revision_id, basis_tree)]
2831
wt.set_parent_trees(parent_trees)
2832
transform.build_tree(basis_tree, wt)
2836
super(WorkingTreeFormat2, self).__init__()
2837
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2839
def open(self, a_bzrdir, _found=False):
2840
"""Return the WorkingTree object for a_bzrdir
2842
_found is a private parameter, do not use it. It is used to indicate
2843
if format probing has already been done.
2846
# we are being called directly and must probe.
2847
raise NotImplementedError
2848
if not isinstance(a_bzrdir.transport, LocalTransport):
2849
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2850
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2856
class WorkingTreeFormat3(WorkingTreeFormat):
2857
"""The second working tree format updated to record a format marker.
2860
- exists within a metadir controlling .bzr
2861
- includes an explicit version marker for the workingtree control
2862
files, separate from the BzrDir format
2863
- modifies the hash cache format
2865
- uses a LockDir to guard access for writes.
2868
upgrade_recommended = True
2870
def get_format_string(self):
2871
"""See WorkingTreeFormat.get_format_string()."""
2872
return "Bazaar-NG Working Tree format 3"
2874
def get_format_description(self):
2875
"""See WorkingTreeFormat.get_format_description()."""
2876
return "Working tree format 3"
2878
_lock_file_name = 'lock'
2879
_lock_class = LockDir
2881
_tree_class = WorkingTree3
2883
def __get_matchingbzrdir(self):
2884
return bzrdir.BzrDirMetaFormat1()
2886
_matchingbzrdir = property(__get_matchingbzrdir)
2888
def _open_control_files(self, a_bzrdir):
2889
transport = a_bzrdir.get_workingtree_transport(None)
2890
return LockableFiles(transport, self._lock_file_name,
2893
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2894
accelerator_tree=None, hardlink=False):
2895
"""See WorkingTreeFormat.initialize().
2897
:param revision_id: if supplied, create a working tree at a different
2898
revision than the branch is at.
2899
:param accelerator_tree: A tree which can be used for retrieving file
2900
contents more quickly than the revision tree, i.e. a workingtree.
2901
The revision tree will be used for cases where accelerator_tree's
2902
content is different.
2903
:param hardlink: If true, hard-link files from accelerator_tree,
2906
if not isinstance(a_bzrdir.transport, LocalTransport):
2907
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2908
transport = a_bzrdir.get_workingtree_transport(self)
2909
control_files = self._open_control_files(a_bzrdir)
2910
control_files.create_lock()
2911
control_files.lock_write()
2912
transport.put_bytes('format', self.get_format_string(),
2913
mode=a_bzrdir._get_file_mode())
2914
if from_branch is not None:
2915
branch = from_branch
2917
branch = a_bzrdir.open_branch()
2918
if revision_id is None:
2919
revision_id = _mod_revision.ensure_null(branch.last_revision())
2920
# WorkingTree3 can handle an inventory which has a unique root id.
2921
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2922
# those trees. And because there isn't a format bump inbetween, we
2923
# are maintaining compatibility with older clients.
2924
# inv = Inventory(root_id=gen_root_id())
2925
inv = self._initial_inventory()
2926
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2932
_control_files=control_files)
2933
wt.lock_tree_write()
2935
basis_tree = branch.repository.revision_tree(revision_id)
2936
# only set an explicit root id if there is one to set.
2937
if basis_tree.inventory.root is not None:
2938
wt.set_root_id(basis_tree.get_root_id())
2939
if revision_id == NULL_REVISION:
2940
wt.set_parent_trees([])
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
b'\\ No newline at end of file'
2942
wt.set_parent_trees([(revision_id, basis_tree)])
2943
transform.build_tree(basis_tree, wt)
2945
# Unlock in this order so that the unlock-triggers-flush in
2946
# WorkingTree is given a chance to fire.
2947
control_files.unlock()
2951
def _initial_inventory(self):
2955
super(WorkingTreeFormat3, self).__init__()
2957
def open(self, a_bzrdir, _found=False):
2958
"""Return the WorkingTree object for a_bzrdir
2960
_found is a private parameter, do not use it. It is used to indicate
2961
if format probing has already been done.
2964
# we are being called directly and must probe.
2965
raise NotImplementedError
2966
if not isinstance(a_bzrdir.transport, LocalTransport):
2967
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2968
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2971
def _open(self, a_bzrdir, control_files):
2972
"""Open the tree itself.
2974
:param a_bzrdir: the dir for the tree.
2975
:param control_files: the control files for the tree.
2977
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2981
_control_files=control_files)
2984
return self.get_format_string()
2987
__default_format = WorkingTreeFormat4()
2988
WorkingTreeFormat.register_format(__default_format)
2989
WorkingTreeFormat.register_format(WorkingTreeFormat6())
2990
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2991
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2992
WorkingTreeFormat.set_default_format(__default_format)
2993
# formats which have no format string are not discoverable
2994
# and not independently creatable, so are not registered.
2995
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
