496
589
return os.path.getsize(self.id2abspath(file_id))
499
def get_file_sha1(self, file_id):
500
path = self._inventory.id2path(file_id)
501
return self._hashcache.get_sha1(path)
503
def is_executable(self, file_id):
504
if not supports_executable():
592
def get_file_sha1(self, file_id, path=None, stat_value=None):
594
path = self._inventory.id2path(file_id)
595
return self._hashcache.get_sha1(path, stat_value)
597
def get_file_mtime(self, file_id, path=None):
599
path = self.inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
603
file_id = self.path2id(path)
604
return self._inventory[file_id].executable
606
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
607
mode = stat_result.st_mode
608
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
610
if not supports_executable():
611
def is_executable(self, file_id, path=None):
505
612
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
614
_is_executable_from_path_and_stat = \
615
_is_executable_from_path_and_stat_from_basis
617
def is_executable(self, file_id, path=None):
619
path = self.id2path(file_id)
508
620
mode = os.lstat(self.abspath(path)).st_mode
509
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
512
def add(self, files, ids=None):
513
"""Make files versioned.
515
Note that the command line normally calls smart_add instead,
516
which can automatically recurse.
518
This adds the files to the inventory, so that they will be
519
recorded by the next commit.
522
List of paths to add, relative to the base of the tree.
525
If set, use these instead of automatically generated ids.
526
Must be the same length as the list of files, but may
527
contain None for ids that are to be autogenerated.
529
TODO: Perhaps have an option to add the ids even if the files do
532
TODO: Perhaps callback with the ids and paths as they're added.
621
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
623
_is_executable_from_path_and_stat = \
624
_is_executable_from_path_and_stat_from_stat
626
@needs_tree_write_lock
627
def _add(self, files, ids, kinds):
628
"""See MutableTree._add."""
534
629
# TODO: Re-adding a file that is removed in the working copy
535
630
# should probably put it back with the previous ID.
536
if isinstance(files, basestring):
537
assert(ids is None or isinstance(ids, basestring))
543
ids = [None] * len(files)
545
assert(len(ids) == len(files))
547
inv = self.read_working_inventory()
548
for f,file_id in zip(files, ids):
549
if self.is_control_filename(f):
550
raise BzrError("cannot add control file %s" % quotefn(f))
555
raise BzrError("cannot add top-level %r" % f)
557
fullpath = normpath(self.abspath(f))
560
kind = file_kind(fullpath)
562
if e.errno == errno.ENOENT:
563
raise NoSuchFile(fullpath)
564
# maybe something better?
565
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
567
if not InventoryEntry.versionable_kind(kind):
568
raise BzrError('cannot add: not a versionable file ('
569
'i.e. regular file, symlink or directory): %s' % quotefn(f))
631
# the read and write working inventory should not occur in this
632
# function - they should be part of lock_write and unlock.
634
for f, file_id, kind in zip(files, ids, kinds):
635
assert kind is not None
571
636
if file_id is None:
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
637
inv.add_path(f, kind=kind)
639
inv.add_path(f, kind=kind, file_id=file_id)
640
self._inventory_is_modified = True
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
self._write_inventory(inv)
642
@needs_tree_write_lock
643
def _gather_kinds(self, files, kinds):
644
"""See MutableTree._gather_kinds."""
645
for pos, f in enumerate(files):
646
if kinds[pos] is None:
647
fullpath = normpath(self.abspath(f))
649
kinds[pos] = file_kind(fullpath)
651
if e.errno == errno.ENOENT:
652
raise errors.NoSuchFile(fullpath)
578
654
@needs_write_lock
655
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
656
"""Add revision_id as a parent.
658
This is equivalent to retrieving the current list of parent ids
659
and setting the list to its value plus revision_id.
661
:param revision_id: The revision id to add to the parent list. It may
662
be a ghost revision as long as its not the first parent to be added,
663
or the allow_leftmost_as_ghost parameter is set True.
664
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
666
parents = self.get_parent_ids() + [revision_id]
667
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
668
or allow_leftmost_as_ghost)
670
@needs_tree_write_lock
671
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
672
"""Add revision_id, tree tuple as a parent.
674
This is equivalent to retrieving the current list of parent trees
675
and setting the list to its value plus parent_tuple. See also
676
add_parent_tree_id - if you only have a parent id available it will be
677
simpler to use that api. If you have the parent already available, using
678
this api is preferred.
680
:param parent_tuple: The (revision id, tree) to add to the parent list.
681
If the revision_id is a ghost, pass None for the tree.
682
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
684
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
685
if len(parent_ids) > 1:
686
# the leftmost may have already been a ghost, preserve that if it
688
allow_leftmost_as_ghost = True
689
self.set_parent_ids(parent_ids,
690
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
692
@needs_tree_write_lock
579
693
def add_pending_merge(self, *revision_ids):
580
694
# TODO: Perhaps should check at this point that the
581
695
# history of the revision is actually present?
582
p = self.pending_merges()
696
parents = self.get_parent_ids()
584
698
for rev_id in revision_ids:
699
if rev_id in parents:
701
parents.append(rev_id)
590
self.set_pending_merges(p)
704
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
706
def path_content_summary(self, path, _lstat=os.lstat,
707
_mapper=osutils.file_kind_from_stat_mode):
708
"""See Tree.path_content_summary."""
709
abspath = self.abspath(path)
711
stat_result = _lstat(abspath)
713
if getattr(e, 'errno', None) == errno.ENOENT:
715
return ('missing', None, None, None)
716
# propagate other errors
718
kind = _mapper(stat_result.st_mode)
720
size = stat_result.st_size
721
# try for a stat cache lookup
722
executable = self._is_executable_from_path_and_stat(path, stat_result)
723
return (kind, size, executable, self._sha_from_stat(
725
elif kind == 'directory':
726
# perhaps it looks like a plain directory, but it's really a
728
if self._directory_is_tree_reference(path):
729
kind = 'tree-reference'
730
return kind, None, None, None
731
elif kind == 'symlink':
732
return ('symlink', None, None, os.readlink(abspath))
734
return (kind, None, None, None)
736
@deprecated_method(zero_eleven)
593
738
def pending_merges(self):
594
739
"""Return a list of pending merges.
596
741
These are revisions that have been merged into the working
597
742
directory but not yet committed.
600
merges_file = self._control_files.get_utf8('pending-merges')
602
if e.errno != errno.ENOENT:
606
for l in merges_file.readlines():
607
p.append(l.rstrip('\n'))
744
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
745
instead - which is available on all tree objects.
747
return self.get_parent_ids()[1:]
749
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
750
"""Common ghost checking functionality from set_parent_*.
752
This checks that the left hand-parent exists if there are any
755
if len(revision_ids) > 0:
756
leftmost_id = revision_ids[0]
757
if (not allow_leftmost_as_ghost and not
758
self.branch.repository.has_revision(leftmost_id)):
759
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
def _set_merges_from_parent_ids(self, parent_ids):
762
merges = parent_ids[1:]
763
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
765
@needs_tree_write_lock
766
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
767
"""Set the parent ids to revision_ids.
769
See also set_parent_trees. This api will try to retrieve the tree data
770
for each element of revision_ids from the trees repository. If you have
771
tree data already available, it is more efficient to use
772
set_parent_trees rather than set_parent_ids. set_parent_ids is however
773
an easier API to use.
775
:param revision_ids: The revision_ids to set as the parent ids of this
776
working tree. Any of these may be ghosts.
778
self._check_parents_for_ghosts(revision_ids,
779
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
780
for revision_id in revision_ids:
781
_mod_revision.check_not_reserved_id(revision_id)
783
if len(revision_ids) > 0:
784
self.set_last_revision(revision_ids[0])
786
self.set_last_revision(_mod_revision.NULL_REVISION)
788
self._set_merges_from_parent_ids(revision_ids)
790
@needs_tree_write_lock
791
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
792
"""See MutableTree.set_parent_trees."""
793
parent_ids = [rev for (rev, tree) in parents_list]
794
for revision_id in parent_ids:
795
_mod_revision.check_not_reserved_id(revision_id)
797
self._check_parents_for_ghosts(parent_ids,
798
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
800
if len(parent_ids) == 0:
801
leftmost_parent_id = _mod_revision.NULL_REVISION
802
leftmost_parent_tree = None
804
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
806
if self._change_last_revision(leftmost_parent_id):
807
if leftmost_parent_tree is None:
808
# If we don't have a tree, fall back to reading the
809
# parent tree from the repository.
810
self._cache_basis_inventory(leftmost_parent_id)
812
inv = leftmost_parent_tree.inventory
813
xml = self._create_basis_xml_from_inventory(
814
leftmost_parent_id, inv)
815
self._write_basis_inventory(xml)
816
self._set_merges_from_parent_ids(parent_ids)
818
@needs_tree_write_lock
611
819
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
820
parents = self.get_parent_ids()
821
leftmost = parents[:1]
822
new_parents = leftmost + rev_list
823
self.set_parent_ids(new_parents)
825
@needs_tree_write_lock
615
826
def set_merge_modified(self, modified_hashes):
616
827
def iter_stanzas():
617
828
for file_id, hash in modified_hashes.iteritems():
618
yield Stanza(file_id=file_id, hash=hash)
829
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
619
830
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
832
def _sha_from_stat(self, path, stat_result):
833
"""Get a sha digest from the tree's stat cache.
835
The default implementation assumes no stat cache is present.
837
:param path: The path.
838
:param stat_result: The stat result being looked up.
622
842
def _put_rio(self, filename, stanzas, header):
843
self._must_be_locked()
623
844
my_file = rio_file(stanzas, header)
624
845
self._control_files.put(filename, my_file)
847
@needs_write_lock # because merge pulls data into the branch.
848
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
850
"""Merge from a branch into this working tree.
852
:param branch: The branch to merge from.
853
:param to_revision: If non-None, the merge will merge to to_revision,
854
but not beyond it. to_revision does not need to be in the history
855
of the branch when it is supplied. If None, to_revision defaults to
856
branch.last_revision().
858
from bzrlib.merge import Merger, Merge3Merger
859
pb = bzrlib.ui.ui_factory.nested_progress_bar()
861
merger = Merger(self.branch, this_tree=self, pb=pb)
862
merger.pp = ProgressPhase("Merge phase", 5, pb)
863
merger.pp.next_phase()
864
# check that there are no
866
merger.check_basis(check_clean=True, require_commits=False)
867
if to_revision is None:
868
to_revision = _mod_revision.ensure_null(branch.last_revision())
869
merger.other_rev_id = to_revision
870
if _mod_revision.is_null(merger.other_rev_id):
871
raise errors.NoCommits(branch)
872
self.branch.fetch(branch, last_revision=merger.other_rev_id)
873
merger.other_basis = merger.other_rev_id
874
merger.other_tree = self.branch.repository.revision_tree(
876
merger.other_branch = branch
877
merger.pp.next_phase()
878
if from_revision is None:
881
merger.set_base_revision(from_revision, branch)
882
if merger.base_rev_id == merger.other_rev_id:
883
raise errors.PointlessMerge
884
merger.backup_files = False
885
if merge_type is None:
886
merger.merge_type = Merge3Merger
888
merger.merge_type = merge_type
889
merger.set_interesting_files(None)
890
merger.show_base = False
891
merger.reprocess = False
892
conflicts = merger.do_merge()
627
899
def merge_modified(self):
900
"""Return a dictionary of files modified by a merge.
902
The list is initialized by WorkingTree.set_merge_modified, which is
903
typically called after we make some automatic updates to the tree
906
This returns a map of file_id->sha1, containing only files which are
907
still in the working inventory and have that text hash.
629
910
hashfile = self._control_files.get('merge-hashes')
911
except errors.NoSuchFile:
632
913
merge_hashes = {}
634
915
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
raise MergeModifiedFormatError()
916
raise errors.MergeModifiedFormatError()
636
917
except StopIteration:
637
raise MergeModifiedFormatError()
918
raise errors.MergeModifiedFormatError()
638
919
for s in RioReader(hashfile):
639
file_id = s.get("file_id")
920
# RioReader reads in Unicode, so convert file_ids back to utf8
921
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
640
922
if file_id not in self.inventory:
643
if hash == self.get_file_sha1(file_id):
644
merge_hashes[file_id] = hash
924
text_hash = s.get("hash")
925
if text_hash == self.get_file_sha1(file_id):
926
merge_hashes[file_id] = text_hash
645
927
return merge_hashes
930
def mkdir(self, path, file_id=None):
931
"""See MutableTree.mkdir()."""
933
file_id = generate_ids.gen_file_id(os.path.basename(path))
934
os.mkdir(self.abspath(path))
935
self.add(path, file_id, 'directory')
647
938
def get_symlink_target(self, file_id):
648
939
return os.readlink(self.id2abspath(file_id))
650
def file_class(self, filename):
651
if self.path2id(filename):
653
elif self.is_ignored(filename):
658
def list_files(self):
659
"""Recursively list all files as (path, class, kind, id).
942
def subsume(self, other_tree):
943
def add_children(inventory, entry):
944
for child_entry in entry.children.values():
945
inventory._byid[child_entry.file_id] = child_entry
946
if child_entry.kind == 'directory':
947
add_children(inventory, child_entry)
948
if other_tree.get_root_id() == self.get_root_id():
949
raise errors.BadSubsumeSource(self, other_tree,
950
'Trees have the same root')
952
other_tree_path = self.relpath(other_tree.basedir)
953
except errors.PathNotChild:
954
raise errors.BadSubsumeSource(self, other_tree,
955
'Tree is not contained by the other')
956
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
957
if new_root_parent is None:
958
raise errors.BadSubsumeSource(self, other_tree,
959
'Parent directory is not versioned.')
960
# We need to ensure that the result of a fetch will have a
961
# versionedfile for the other_tree root, and only fetching into
962
# RepositoryKnit2 guarantees that.
963
if not self.branch.repository.supports_rich_root():
964
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
965
other_tree.lock_tree_write()
967
new_parents = other_tree.get_parent_ids()
968
other_root = other_tree.inventory.root
969
other_root.parent_id = new_root_parent
970
other_root.name = osutils.basename(other_tree_path)
971
self.inventory.add(other_root)
972
add_children(self.inventory, other_root)
973
self._write_inventory(self.inventory)
974
# normally we don't want to fetch whole repositories, but i think
975
# here we really do want to consolidate the whole thing.
976
for parent_id in other_tree.get_parent_ids():
977
self.branch.fetch(other_tree.branch, parent_id)
978
self.add_parent_tree_id(parent_id)
981
other_tree.bzrdir.retire_bzrdir()
983
def _directory_is_tree_reference(self, relpath):
984
# as a special case, if a directory contains control files then
985
# it's a tree reference, except that the root of the tree is not
986
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
987
# TODO: We could ask all the control formats whether they
988
# recognize this directory, but at the moment there's no cheap api
989
# to do that. Since we probably can only nest bzr checkouts and
990
# they always use this name it's ok for now. -- mbp 20060306
992
# FIXME: There is an unhandled case here of a subdirectory
993
# containing .bzr but not a branch; that will probably blow up
994
# when you try to commit it. It might happen if there is a
995
# checkout in a subdirectory. This can be avoided by not adding
998
@needs_tree_write_lock
999
def extract(self, file_id, format=None):
1000
"""Extract a subtree from this tree.
1002
A new branch will be created, relative to the path for this tree.
1006
segments = osutils.splitpath(path)
1007
transport = self.branch.bzrdir.root_transport
1008
for name in segments:
1009
transport = transport.clone(name)
1010
transport.ensure_base()
1013
sub_path = self.id2path(file_id)
1014
branch_transport = mkdirs(sub_path)
1016
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1017
branch_transport.ensure_base()
1018
branch_bzrdir = format.initialize_on_transport(branch_transport)
1020
repo = branch_bzrdir.find_repository()
1021
except errors.NoRepositoryPresent:
1022
repo = branch_bzrdir.create_repository()
1023
assert repo.supports_rich_root()
1025
if not repo.supports_rich_root():
1026
raise errors.RootNotRich()
1027
new_branch = branch_bzrdir.create_branch()
1028
new_branch.pull(self.branch)
1029
for parent_id in self.get_parent_ids():
1030
new_branch.fetch(self.branch, parent_id)
1031
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1032
if tree_transport.base != branch_transport.base:
1033
tree_bzrdir = format.initialize_on_transport(tree_transport)
1034
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1036
tree_bzrdir = branch_bzrdir
1037
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1038
wt.set_parent_ids(self.get_parent_ids())
1039
my_inv = self.inventory
1040
child_inv = Inventory(root_id=None)
1041
new_root = my_inv[file_id]
1042
my_inv.remove_recursive_id(file_id)
1043
new_root.parent_id = None
1044
child_inv.add(new_root)
1045
self._write_inventory(my_inv)
1046
wt._write_inventory(child_inv)
1049
def _serialize(self, inventory, out_file):
1050
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1053
def _deserialize(selt, in_file):
1054
return xml5.serializer_v5.read_inventory(in_file)
1057
"""Write the in memory inventory to disk."""
1058
# TODO: Maybe this should only write on dirty ?
1059
if self._control_files._lock_mode != 'w':
1060
raise errors.NotWriteLocked(self)
1062
self._serialize(self._inventory, sio)
1064
self._control_files.put('inventory', sio)
1065
self._inventory_is_modified = False
1067
def _kind(self, relpath):
1068
return osutils.file_kind(self.abspath(relpath))
1070
def list_files(self, include_root=False):
1071
"""Recursively list all files as (path, class, kind, id, entry).
661
1073
Lists, but does not descend into unversioned directories.
666
1078
Skips the control directory.
668
inv = self._inventory
670
def descend(from_dir_relpath, from_dir_id, dp):
1080
# list_files is an iterator, so @needs_read_lock doesn't work properly
1081
# with it. So callers should be careful to always read_lock the tree.
1082
if not self.is_locked():
1083
raise errors.ObjectNotLocked(self)
1085
inv = self.inventory
1086
if include_root is True:
1087
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1088
# Convert these into local objects to save lookup times
1089
pathjoin = osutils.pathjoin
1090
file_kind = self._kind
1092
# transport.base ends in a slash, we want the piece
1093
# between the last two slashes
1094
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1096
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1098
# directory file_id, relative path, absolute path, reverse sorted children
1099
children = os.listdir(self.basedir)
1101
# jam 20060527 The kernel sized tree seems equivalent whether we
1102
# use a deque and popleft to keep them sorted, or if we use a plain
1103
# list and just reverse() them.
1104
children = collections.deque(children)
1105
stack = [(inv.root.file_id, u'', self.basedir, children)]
1107
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1110
f = children.popleft()
674
1111
## TODO: If we find a subdirectory with its own .bzr
675
1112
## directory, then that is a separate tree and we
676
1113
## should exclude it.
678
1115
# the bzrdir for this tree
679
if self.bzrdir.transport.base.endswith(f + '/'):
1116
if transport_base_dir == f:
683
fp = appendpath(from_dir_relpath, f)
1119
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1120
# and 'f' doesn't begin with one, we can do a string op, rather
1121
# than the checks of pathjoin(), all relative paths will have an extra slash
1123
fp = from_dir_relpath + '/' + f
686
fap = appendpath(dp, f)
1126
fap = from_dir_abspath + '/' + f
688
1128
f_ie = inv.get_child(from_dir_id, f)
691
elif self.is_ignored(fp):
1131
elif self.is_ignored(fp[1:]):
1134
# we may not have found this file, because of a unicode issue
1135
f_norm, can_access = osutils.normalized_filename(f)
1136
if f == f_norm or not can_access:
1137
# No change, so treat this file normally
1140
# this file can be accessed by a normalized path
1141
# check again if it is versioned
1142
# these lines are repeated here for performance
1144
fp = from_dir_relpath + '/' + f
1145
fap = from_dir_abspath + '/' + f
1146
f_ie = inv.get_child(from_dir_id, f)
1149
elif self.is_ignored(fp[1:]):
696
1154
fk = file_kind(fap)
700
raise BzrCheckError("file %r entered as kind %r id %r, "
702
% (fap, f_ie.kind, f_ie.file_id, fk))
704
1156
# make a last minute entry
1158
yield fp[1:], c, fk, f_ie.file_id, f_ie
708
if fk == 'directory':
709
entry = TreeDirectory()
712
elif fk == 'symlink':
1161
yield fp[1:], c, fk, None, fk_entries[fk]()
1163
yield fp[1:], c, fk, None, TreeEntry()
717
yield fp, c, fk, (f_ie and f_ie.file_id), entry
719
1166
if fk != 'directory':
723
# don't descend unversioned directories
726
for ff in descend(fp, f_ie.file_id, fap):
729
for f in descend(u'', inv.root.file_id, self.basedir):
733
def move(self, from_paths, to_name):
1169
# But do this child first
1170
new_children = os.listdir(fap)
1172
new_children = collections.deque(new_children)
1173
stack.append((f_ie.file_id, fp, fap, new_children))
1174
# Break out of inner loop,
1175
# so that we start outer loop with child
1178
# if we finished all children, pop it off the stack
1181
@needs_tree_write_lock
1182
def move(self, from_paths, to_dir=None, after=False, **kwargs):
734
1183
"""Rename files.
736
to_name must exist in the inventory.
1185
to_dir must exist in the inventory.
738
If to_name exists and is a directory, the files are moved into
1187
If to_dir exists and is a directory, the files are moved into
739
1188
it, keeping their old names.
741
Note that to_name is only the last component of the new name;
1190
Note that to_dir is only the last component of the new name;
742
1191
this doesn't change the directory.
1193
For each entry in from_paths the move mode will be determined
1196
The first mode moves the file in the filesystem and updates the
1197
inventory. The second mode only updates the inventory without
1198
touching the file on the filesystem. This is the new mode introduced
1201
move uses the second mode if 'after == True' and the target is not
1202
versioned but present in the working tree.
1204
move uses the second mode if 'after == False' and the source is
1205
versioned but no longer in the working tree, and the target is not
1206
versioned but present in the working tree.
1208
move uses the first mode if 'after == False' and the source is
1209
versioned and present in the working tree, and the target is not
1210
versioned and not present in the working tree.
1212
Everything else results in an error.
744
1214
This returns a list of (from_path, to_path) pairs for each
745
1215
entry that is moved.
748
## TODO: Option to move IDs only
1220
# check for deprecated use of signature
1222
to_dir = kwargs.get('to_name', None)
1224
raise TypeError('You must supply a target directory')
1226
symbol_versioning.warn('The parameter to_name was deprecated'
1227
' in version 0.13. Use to_dir instead',
1230
# check destination directory
749
1231
assert not isinstance(from_paths, basestring)
750
1232
inv = self.inventory
751
to_abs = self.abspath(to_name)
1233
to_abs = self.abspath(to_dir)
752
1234
if not isdir(to_abs):
753
raise BzrError("destination %r is not a directory" % to_abs)
754
if not self.has_filename(to_name):
755
raise BzrError("destination %r not in working directory" % to_abs)
756
to_dir_id = inv.path2id(to_name)
757
if to_dir_id == None and to_name != '':
758
raise BzrError("destination %r is not a versioned directory" % to_name)
1235
raise errors.BzrMoveFailedError('',to_dir,
1236
errors.NotADirectory(to_abs))
1237
if not self.has_filename(to_dir):
1238
raise errors.BzrMoveFailedError('',to_dir,
1239
errors.NotInWorkingDirectory(to_dir))
1240
to_dir_id = inv.path2id(to_dir)
1241
if to_dir_id is None:
1242
raise errors.BzrMoveFailedError('',to_dir,
1243
errors.NotVersionedError(path=str(to_dir)))
759
1245
to_dir_ie = inv[to_dir_id]
760
if to_dir_ie.kind not in ('directory', 'root_directory'):
761
raise BzrError("destination %r is not a directory" % to_abs)
763
to_idpath = inv.get_idpath(to_dir_id)
766
if not self.has_filename(f):
767
raise BzrError("%r does not exist in working tree" % f)
768
f_id = inv.path2id(f)
770
raise BzrError("%r is not versioned" % f)
771
name_tail = splitpath(f)[-1]
772
dest_path = appendpath(to_name, name_tail)
773
if self.has_filename(dest_path):
774
raise BzrError("destination %r already exists" % dest_path)
775
if f_id in to_idpath:
776
raise BzrError("can't move %r to a subdirectory of itself" % f)
778
# OK, so there's a race here, it's possible that someone will
779
# create a file in this interval and then the rename might be
780
# left half-done. But we should have caught most problems.
781
orig_inv = deepcopy(self.inventory)
1246
if to_dir_ie.kind != 'directory':
1247
raise errors.BzrMoveFailedError('',to_dir,
1248
errors.NotADirectory(to_abs))
1250
# create rename entries and tuples
1251
for from_rel in from_paths:
1252
from_tail = splitpath(from_rel)[-1]
1253
from_id = inv.path2id(from_rel)
1255
raise errors.BzrMoveFailedError(from_rel,to_dir,
1256
errors.NotVersionedError(path=str(from_rel)))
1258
from_entry = inv[from_id]
1259
from_parent_id = from_entry.parent_id
1260
to_rel = pathjoin(to_dir, from_tail)
1261
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1263
from_tail=from_tail,
1264
from_parent_id=from_parent_id,
1265
to_rel=to_rel, to_tail=from_tail,
1266
to_parent_id=to_dir_id)
1267
rename_entries.append(rename_entry)
1268
rename_tuples.append((from_rel, to_rel))
1270
# determine which move mode to use. checks also for movability
1271
rename_entries = self._determine_mv_mode(rename_entries, after)
1273
original_modified = self._inventory_is_modified
784
name_tail = splitpath(f)[-1]
785
dest_path = appendpath(to_name, name_tail)
786
result.append((f, dest_path))
787
inv.rename(inv.path2id(f), to_dir_id, name_tail)
789
rename(self.abspath(f), self.abspath(dest_path))
791
raise BzrError("failed to rename %r to %r: %s" %
792
(f, dest_path, e[1]),
793
["rename rolled back"])
1276
self._inventory_is_modified = True
1277
self._move(rename_entries)
795
1279
# restore the inventory on error
796
self._set_inventory(orig_inv)
1280
self._inventory_is_modified = original_modified
798
1282
self._write_inventory(inv)
802
def rename_one(self, from_rel, to_rel):
1283
return rename_tuples
1285
def _determine_mv_mode(self, rename_entries, after=False):
1286
"""Determines for each from-to pair if both inventory and working tree
1287
or only the inventory has to be changed.
1289
Also does basic plausability tests.
1291
inv = self.inventory
1293
for rename_entry in rename_entries:
1294
# store to local variables for easier reference
1295
from_rel = rename_entry.from_rel
1296
from_id = rename_entry.from_id
1297
to_rel = rename_entry.to_rel
1298
to_id = inv.path2id(to_rel)
1299
only_change_inv = False
1301
# check the inventory for source and destination
1303
raise errors.BzrMoveFailedError(from_rel,to_rel,
1304
errors.NotVersionedError(path=str(from_rel)))
1305
if to_id is not None:
1306
raise errors.BzrMoveFailedError(from_rel,to_rel,
1307
errors.AlreadyVersionedError(path=str(to_rel)))
1309
# try to determine the mode for rename (only change inv or change
1310
# inv and file system)
1312
if not self.has_filename(to_rel):
1313
raise errors.BzrMoveFailedError(from_id,to_rel,
1314
errors.NoSuchFile(path=str(to_rel),
1315
extra="New file has not been created yet"))
1316
only_change_inv = True
1317
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1318
only_change_inv = True
1319
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1320
only_change_inv = False
1322
# something is wrong, so lets determine what exactly
1323
if not self.has_filename(from_rel) and \
1324
not self.has_filename(to_rel):
1325
raise errors.BzrRenameFailedError(from_rel,to_rel,
1326
errors.PathsDoNotExist(paths=(str(from_rel),
1329
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1330
rename_entry.only_change_inv = only_change_inv
1331
return rename_entries
1333
def _move(self, rename_entries):
1334
"""Moves a list of files.
1336
Depending on the value of the flag 'only_change_inv', the
1337
file will be moved on the file system or not.
1339
inv = self.inventory
1342
for entry in rename_entries:
1344
self._move_entry(entry)
1346
self._rollback_move(moved)
1350
def _rollback_move(self, moved):
1351
"""Try to rollback a previous move in case of an filesystem error."""
1352
inv = self.inventory
1355
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1356
entry.to_tail, entry.to_parent_id, entry.from_rel,
1357
entry.from_tail, entry.from_parent_id,
1358
entry.only_change_inv))
1359
except errors.BzrMoveFailedError, e:
1360
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1361
" The working tree is in an inconsistent state."
1362
" Please consider doing a 'bzr revert'."
1363
" Error message is: %s" % e)
1365
def _move_entry(self, entry):
1366
inv = self.inventory
1367
from_rel_abs = self.abspath(entry.from_rel)
1368
to_rel_abs = self.abspath(entry.to_rel)
1369
if from_rel_abs == to_rel_abs:
1370
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1371
"Source and target are identical.")
1373
if not entry.only_change_inv:
1375
osutils.rename(from_rel_abs, to_rel_abs)
1377
raise errors.BzrMoveFailedError(entry.from_rel,
1379
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1381
@needs_tree_write_lock
1382
def rename_one(self, from_rel, to_rel, after=False):
803
1383
"""Rename one file.
805
1385
This can change the directory or the filename or both.
1387
rename_one has several 'modes' to work. First, it can rename a physical
1388
file and change the file_id. That is the normal mode. Second, it can
1389
only change the file_id without touching any physical file. This is
1390
the new mode introduced in version 0.15.
1392
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1393
versioned but present in the working tree.
1395
rename_one uses the second mode if 'after == False' and 'from_rel' is
1396
versioned but no longer in the working tree, and 'to_rel' is not
1397
versioned but present in the working tree.
1399
rename_one uses the first mode if 'after == False' and 'from_rel' is
1400
versioned and present in the working tree, and 'to_rel' is not
1401
versioned and not present in the working tree.
1403
Everything else results in an error.
807
1405
inv = self.inventory
808
if not self.has_filename(from_rel):
809
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
810
if self.has_filename(to_rel):
811
raise BzrError("can't rename: new working file %r already exists" % to_rel)
813
file_id = inv.path2id(from_rel)
815
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
818
from_parent = entry.parent_id
819
from_name = entry.name
821
if inv.path2id(to_rel):
822
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1408
# create rename entries and tuples
1409
from_tail = splitpath(from_rel)[-1]
1410
from_id = inv.path2id(from_rel)
1412
raise errors.BzrRenameFailedError(from_rel,to_rel,
1413
errors.NotVersionedError(path=str(from_rel)))
1414
from_entry = inv[from_id]
1415
from_parent_id = from_entry.parent_id
824
1416
to_dir, to_tail = os.path.split(to_rel)
825
1417
to_dir_id = inv.path2id(to_dir)
826
if to_dir_id == None and to_dir != '':
827
raise BzrError("can't determine destination directory id for %r" % to_dir)
829
mutter("rename_one:")
830
mutter(" file_id {%s}" % file_id)
831
mutter(" from_rel %r" % from_rel)
832
mutter(" to_rel %r" % to_rel)
833
mutter(" to_dir %r" % to_dir)
834
mutter(" to_dir_id {%s}" % to_dir_id)
836
inv.rename(file_id, to_dir_id, to_tail)
838
from_abs = self.abspath(from_rel)
839
to_abs = self.abspath(to_rel)
841
rename(from_abs, to_abs)
843
inv.rename(file_id, from_parent, from_name)
844
raise BzrError("failed to rename %r to %r: %s"
845
% (from_abs, to_abs, e[1]),
846
["rename rolled back"])
1418
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1420
from_tail=from_tail,
1421
from_parent_id=from_parent_id,
1422
to_rel=to_rel, to_tail=to_tail,
1423
to_parent_id=to_dir_id)
1424
rename_entries.append(rename_entry)
1426
# determine which move mode to use. checks also for movability
1427
rename_entries = self._determine_mv_mode(rename_entries, after)
1429
# check if the target changed directory and if the target directory is
1431
if to_dir_id is None:
1432
raise errors.BzrMoveFailedError(from_rel,to_rel,
1433
errors.NotVersionedError(path=str(to_dir)))
1435
# all checks done. now we can continue with our actual work
1436
mutter('rename_one:\n'
1441
' to_dir_id {%s}\n',
1442
from_id, from_rel, to_rel, to_dir, to_dir_id)
1444
self._move(rename_entries)
847
1445
self._write_inventory(inv)
1447
class _RenameEntry(object):
1448
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1449
to_rel, to_tail, to_parent_id, only_change_inv=False):
1450
self.from_rel = from_rel
1451
self.from_id = from_id
1452
self.from_tail = from_tail
1453
self.from_parent_id = from_parent_id
1454
self.to_rel = to_rel
1455
self.to_tail = to_tail
1456
self.to_parent_id = to_parent_id
1457
self.only_change_inv = only_change_inv
849
1459
@needs_read_lock
850
1460
def unknowns(self):
851
1461
"""Return all unknown files.
853
1463
These are files in the working directory that are not versioned or
854
1464
control files or ignored.
856
>>> from bzrlib.bzrdir import ScratchDir
857
>>> d = ScratchDir(files=['foo', 'foo~'])
858
>>> b = d.open_branch()
859
>>> tree = d.open_workingtree()
860
>>> map(str, tree.unknowns())
863
>>> list(b.unknowns())
865
>>> tree.remove('foo')
866
>>> list(b.unknowns())
869
for subp in self.extras():
870
if not self.is_ignored(subp):
1466
# force the extras method to be fully executed before returning, to
1467
# prevent race conditions with the lock
1469
[subp for subp in self.extras() if not self.is_ignored(subp)])
1471
@needs_tree_write_lock
1472
def unversion(self, file_ids):
1473
"""Remove the file ids in file_ids from the current versioned set.
1475
When a file_id is unversioned, all of its children are automatically
1478
:param file_ids: The file ids to stop versioning.
1479
:raises: NoSuchId if any fileid is not currently versioned.
1481
for file_id in file_ids:
1482
if self._inventory.has_id(file_id):
1483
self._inventory.remove_recursive_id(file_id)
1485
raise errors.NoSuchId(self, file_id)
1487
# in the future this should just set a dirty bit to wait for the
1488
# final unlock. However, until all methods of workingtree start
1489
# with the current in -memory inventory rather than triggering
1490
# a read, it is more complex - we need to teach read_inventory
1491
# to know when to read, and when to not read first... and possibly
1492
# to save first when the in memory one may be corrupted.
1493
# so for now, we just only write it if it is indeed dirty.
1495
self._write_inventory(self._inventory)
873
1497
@deprecated_method(zero_eight)
874
1498
def iter_conflicts(self):
875
1499
"""List all files in the tree that have text or content conflicts.
1056
1759
This is used to allow WorkingTree3 instances to not affect branch
1057
1760
when their last revision is set.
1059
if new_revision is None:
1762
if _mod_revision.is_null(new_revision):
1060
1763
self.branch.set_revision_history([])
1062
# current format is locked in with the branch
1063
revision_history = self.branch.revision_history()
1065
position = revision_history.index(new_revision)
1067
raise errors.NoSuchRevision(self.branch, new_revision)
1068
self.branch.set_revision_history(revision_history[:position + 1])
1766
self.branch.generate_revision_history(new_revision)
1767
except errors.NoSuchRevision:
1768
# not present in the repo - dont try to set it deeper than the tip
1769
self.branch.set_revision_history([new_revision])
1772
def _write_basis_inventory(self, xml):
1773
"""Write the basis inventory XML to the basis-inventory file"""
1774
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1775
path = self._basis_inventory_name()
1777
self._control_files.put(path, sio)
1779
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1780
"""Create the text that will be saved in basis-inventory"""
1781
inventory.revision_id = revision_id
1782
return xml7.serializer_v7.write_inventory_to_string(inventory)
1071
1784
def _cache_basis_inventory(self, new_revision):
1072
1785
"""Cache new_revision as the basis inventory."""
1786
# TODO: this should allow the ready-to-use inventory to be passed in,
1787
# as commit already has that ready-to-use [while the format is the
1074
1790
# this double handles the inventory - unpack and repack -
1075
1791
# but is easier to understand. We can/should put a conditional
1076
1792
# in here based on whether the inventory is in the latest format
1077
1793
# - perhaps we should repack all inventories on a repository
1079
inv = self.branch.repository.get_inventory(new_revision)
1080
inv.revision_id = new_revision
1081
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1083
path = self._basis_inventory_name()
1084
self._control_files.put_utf8(path, xml)
1085
except WeaveRevisionNotPresent:
1795
# the fast path is to copy the raw xml from the repository. If the
1796
# xml contains 'revision_id="', then we assume the right
1797
# revision_id is set. We must check for this full string, because a
1798
# root node id can legitimately look like 'revision_id' but cannot
1800
xml = self.branch.repository.get_inventory_xml(new_revision)
1801
firstline = xml.split('\n', 1)[0]
1802
if (not 'revision_id="' in firstline or
1803
'format="7"' not in firstline):
1804
inv = self.branch.repository.deserialise_inventory(
1806
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1807
self._write_basis_inventory(xml)
1808
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1088
1811
def read_basis_inventory(self):
1089
1812
"""Read the cached basis inventory."""
1090
1813
path = self._basis_inventory_name()
1091
return self._control_files.get_utf8(path).read()
1814
return self._control_files.get(path).read()
1093
1816
@needs_read_lock
1094
1817
def read_working_inventory(self):
1095
"""Read the working inventory."""
1818
"""Read the working inventory.
1820
:raises errors.InventoryModified: read_working_inventory will fail
1821
when the current in memory inventory has been modified.
1823
# conceptually this should be an implementation detail of the tree.
1824
# XXX: Deprecate this.
1096
1825
# ElementTree does its own conversion from UTF-8, so open in
1098
result = bzrlib.xml5.serializer_v5.read_inventory(
1099
self._control_files.get('inventory'))
1100
self._set_inventory(result)
1827
if self._inventory_is_modified:
1828
raise errors.InventoryModified(self)
1829
result = self._deserialize(self._control_files.get('inventory'))
1830
self._set_inventory(result, dirty=False)
1104
def remove(self, files, verbose=False):
1105
"""Remove nominated files from the working inventory..
1107
This does not remove their text. This does not run on XXX on what? RBC
1109
TODO: Refuse to remove modified files unless --force is given?
1111
TODO: Do something useful with directories.
1113
TODO: Should this remove the text or not? Tough call; not
1114
removing may be useful and the user can just use use rm, and
1115
is the opposite of add. Removing it is consistent with most
1116
other tools. Maybe an option.
1833
@needs_tree_write_lock
1834
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1836
"""Remove nominated files from the working inventory.
1838
:files: File paths relative to the basedir.
1839
:keep_files: If true, the files will also be kept.
1840
:force: Delete files and directories, even if they are changed and
1841
even if the directories are not empty.
1118
## TODO: Normalize names
1119
## TODO: Remove nested loops; better scalability
1120
1843
if isinstance(files, basestring):
1121
1844
files = [files]
1123
inv = self.inventory
1125
# do this before any modifications
1849
unknown_nested_files=set()
1851
def recurse_directory_to_add_files(directory):
1852
# Recurse directory and add all files
1853
# so we can check if they have changed.
1854
for parent_info, file_infos in\
1855
osutils.walkdirs(self.abspath(directory),
1857
for relpath, basename, kind, lstat, abspath in file_infos:
1858
# Is it versioned or ignored?
1859
if self.path2id(relpath) or self.is_ignored(relpath):
1860
# Add nested content for deletion.
1861
new_files.add(relpath)
1863
# Files which are not versioned and not ignored
1864
# should be treated as unknown.
1865
unknown_nested_files.add((relpath, None, kind))
1867
for filename in files:
1868
# Get file name into canonical form.
1869
abspath = self.abspath(filename)
1870
filename = self.relpath(abspath)
1871
if len(filename) > 0:
1872
new_files.add(filename)
1873
if osutils.isdir(abspath):
1874
recurse_directory_to_add_files(filename)
1876
files = list(new_files)
1879
return # nothing to do
1881
# Sort needed to first handle directory content before the directory
1882
files.sort(reverse=True)
1884
# Bail out if we are going to delete files we shouldn't
1885
if not keep_files and not force:
1886
has_changed_files = len(unknown_nested_files) > 0
1887
if not has_changed_files:
1888
for (file_id, path, content_change, versioned, parent_id, name,
1889
kind, executable) in self._iter_changes(self.basis_tree(),
1890
include_unchanged=True, require_versioned=False,
1891
want_unversioned=True, specific_files=files):
1892
# Check if it's an unknown (but not ignored) OR
1893
# changed (but not deleted) :
1894
if not self.is_ignored(path[1]) and (
1895
versioned == (False, False) or
1896
content_change and kind[1] != None):
1897
has_changed_files = True
1900
if has_changed_files:
1901
# Make delta show ALL applicable changes in error message.
1902
tree_delta = self.changes_from(self.basis_tree(),
1903
require_versioned=False, want_unversioned=True,
1904
specific_files=files)
1905
for unknown_file in unknown_nested_files:
1906
if unknown_file not in tree_delta.unversioned:
1907
tree_delta.unversioned.extend((unknown_file,))
1908
raise errors.BzrRemoveChangedFilesError(tree_delta)
1910
# Build inv_delta and delete files where applicaple,
1911
# do this before any modifications to inventory.
1126
1912
for f in files:
1127
fid = inv.path2id(f)
1913
fid = self.path2id(f)
1129
# TODO: Perhaps make this just a warning, and continue?
1130
# This tends to happen when
1131
raise NotVersionedError(path=f)
1132
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1134
# having remove it, it must be either ignored or unknown
1135
if self.is_ignored(f):
1139
show_status(new_status, inv[fid].kind, quotefn(f))
1142
self._write_inventory(inv)
1145
def revert(self, filenames, old_tree=None, backups=True,
1146
pb=DummyProgress()):
1147
from transform import revert
1148
from conflicts import resolve
1916
message = "%s is not versioned." % (f,)
1919
# having removed it, it must be either ignored or unknown
1920
if self.is_ignored(f):
1924
textui.show_status(new_status, self.kind(fid), f,
1927
inv_delta.append((f, None, fid, None))
1928
message = "removed %s" % (f,)
1931
abs_path = self.abspath(f)
1932
if osutils.lexists(abs_path):
1933
if (osutils.isdir(abs_path) and
1934
len(os.listdir(abs_path)) > 0):
1936
osutils.rmtree(abs_path)
1938
message = "%s is not an empty directory "\
1939
"and won't be deleted." % (f,)
1941
osutils.delete_any(abs_path)
1942
message = "deleted %s" % (f,)
1943
elif message is not None:
1944
# Only care if we haven't done anything yet.
1945
message = "%s does not exist." % (f,)
1947
# Print only one message (if any) per file.
1948
if message is not None:
1950
self.apply_inventory_delta(inv_delta)
1952
@needs_tree_write_lock
1953
def revert(self, filenames=None, old_tree=None, backups=True,
1954
pb=DummyProgress(), report_changes=False):
1955
from bzrlib.conflicts import resolve
1958
symbol_versioning.warn('Using [] to revert all files is deprecated'
1959
' as of bzr 0.91. Please use None (the default) instead.',
1960
DeprecationWarning, stacklevel=2)
1149
1961
if old_tree is None:
1150
old_tree = self.basis_tree()
1151
conflicts = revert(self, old_tree, filenames, backups, pb)
1152
if not len(filenames):
1153
self.set_pending_merges([])
1962
basis_tree = self.basis_tree()
1963
basis_tree.lock_read()
1964
old_tree = basis_tree
1156
resolve(self, filenames, ignore_misses=True)
1968
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1970
if filenames is None and len(self.get_parent_ids()) > 1:
1972
last_revision = self.last_revision()
1973
if last_revision != NULL_REVISION:
1974
if basis_tree is None:
1975
basis_tree = self.basis_tree()
1976
basis_tree.lock_read()
1977
parent_trees.append((last_revision, basis_tree))
1978
self.set_parent_trees(parent_trees)
1981
resolve(self, filenames, ignore_misses=True)
1983
if basis_tree is not None:
1157
1985
return conflicts
1987
def revision_tree(self, revision_id):
1988
"""See Tree.revision_tree.
1990
WorkingTree can supply revision_trees for the basis revision only
1991
because there is only one cached inventory in the bzr directory.
1993
if revision_id == self.last_revision():
1995
xml = self.read_basis_inventory()
1996
except errors.NoSuchFile:
2000
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2001
# dont use the repository revision_tree api because we want
2002
# to supply the inventory.
2003
if inv.revision_id == revision_id:
2004
return revisiontree.RevisionTree(self.branch.repository,
2006
except errors.BadInventoryFormat:
2008
# raise if there was no inventory, or if we read the wrong inventory.
2009
raise errors.NoSuchRevisionInTree(self, revision_id)
1159
2011
# XXX: This method should be deprecated in favour of taking in a proper
1160
2012
# new Inventory object.
2013
@needs_tree_write_lock
1162
2014
def set_inventory(self, new_inventory_list):
1163
2015
from bzrlib.inventory import (Inventory,
1164
2016
InventoryDirectory,
1204
2082
between multiple working trees, i.e. via shared storage, then we
1205
2083
would probably want to lock both the local tree, and the branch.
1207
# FIXME: We want to write out the hashcache only when the last lock on
1208
# this working copy is released. Peeking at the lock count is a bit
1209
# of a nasty hack; probably it's better to have a transaction object,
1210
# which can do some finalization when it's either successfully or
1211
# unsuccessfully completed. (Denys's original patch did that.)
1212
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
# wrongly. Hookinh into unllock on the control files object is fine though.
1215
# TODO: split this per format so there is no ugly if block
1216
if self._hashcache.needs_write and (
1217
# dedicated lock files
1218
self._control_files._lock_count==1 or
1220
(self._control_files is self.branch.control_files and
1221
self._control_files._lock_count==3)):
1222
self._hashcache.write()
1223
# reverse order of locking.
1224
result = self._control_files.unlock()
1226
self.branch.unlock()
2085
raise NotImplementedError(self.unlock)
2087
def update(self, change_reporter=None, possible_transports=None):
1232
2088
"""Update a working tree along its branch.
1234
This will update the branch if its bound too, which means we have multiple trees involved:
1235
The new basis tree of the master.
1236
The old basis tree of the branch.
1237
The old basis tree of the working tree.
1238
The current working tree state.
1239
pathologically all three may be different, and non ancestors of each other.
1240
Conceptually we want to:
1241
Preserve the wt.basis->wt.state changes
1242
Transform the wt.basis to the new master basis.
1243
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
Restore the wt.basis->wt.state changes.
2090
This will update the branch if its bound too, which means we have
2091
multiple trees involved:
2093
- The new basis tree of the master.
2094
- The old basis tree of the branch.
2095
- The old basis tree of the working tree.
2096
- The current working tree state.
2098
Pathologically, all three may be different, and non-ancestors of each
2099
other. Conceptually we want to:
2101
- Preserve the wt.basis->wt.state changes
2102
- Transform the wt.basis to the new master basis.
2103
- Apply a merge of the old branch basis to get any 'local' changes from
2105
- Restore the wt.basis->wt.state changes.
1246
2107
There isn't a single operation at the moment to do that, so we:
1247
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
Do a 'normal' merge of the old branch basis if it is relevant.
1250
old_tip = self.branch.update()
1251
if old_tip is not None:
1252
self.add_pending_merge(old_tip)
1253
self.branch.lock_read()
1256
if self.last_revision() != self.branch.last_revision():
1257
# merge tree state up to new branch tip.
1258
basis = self.basis_tree()
2108
- Merge current state -> basis tree of the master w.r.t. the old tree
2110
- Do a 'normal' merge of the old branch basis if it is relevant.
2112
if self.branch.get_master_branch(possible_transports) is not None:
2114
update_branch = True
2116
self.lock_tree_write()
2117
update_branch = False
2120
old_tip = self.branch.update(possible_transports)
2123
return self._update_tree(old_tip, change_reporter)
2127
@needs_tree_write_lock
2128
def _update_tree(self, old_tip=None, change_reporter=None):
2129
"""Update a tree to the master branch.
2131
:param old_tip: if supplied, the previous tip revision the branch,
2132
before it was changed to the master branch's tip.
2134
# here if old_tip is not None, it is the old tip of the branch before
2135
# it was updated from the master branch. This should become a pending
2136
# merge in the working tree to preserve the user existing work. we
2137
# cant set that until we update the working trees last revision to be
2138
# one from the new branch, because it will just get absorbed by the
2139
# parent de-duplication logic.
2141
# We MUST save it even if an error occurs, because otherwise the users
2142
# local work is unreferenced and will appear to have been lost.
2146
last_rev = self.get_parent_ids()[0]
2148
last_rev = _mod_revision.NULL_REVISION
2149
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2150
# merge tree state up to new branch tip.
2151
basis = self.basis_tree()
1259
2154
to_tree = self.branch.basis_tree()
1260
result += merge_inner(self.branch,
2155
if basis.inventory.root is None:
2156
self.set_root_id(to_tree.get_root_id())
2158
result += merge.merge_inner(
1264
self.set_last_revision(self.branch.last_revision())
1265
if old_tip and old_tip != self.last_revision():
1266
# our last revision was not the prior branch last reivison
1267
# and we have converted that last revision to a pending merge.
1268
# base is somewhere between the branch tip now
1269
# and the now pending merge
1270
from bzrlib.revision import common_ancestor
1272
base_rev_id = common_ancestor(self.branch.last_revision(),
1274
self.branch.repository)
1275
except errors.NoCommonAncestor:
1277
base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
other_tree = self.branch.repository.revision_tree(old_tip)
1279
result += merge_inner(self.branch,
1285
self.branch.unlock()
2163
change_reporter=change_reporter)
2166
# TODO - dedup parents list with things merged by pull ?
2167
# reuse the tree we've updated to to set the basis:
2168
parent_trees = [(self.branch.last_revision(), to_tree)]
2169
merges = self.get_parent_ids()[1:]
2170
# Ideally we ask the tree for the trees here, that way the working
2171
# tree can decide whether to give us teh entire tree or give us a
2172
# lazy initialised tree. dirstate for instance will have the trees
2173
# in ram already, whereas a last-revision + basis-inventory tree
2174
# will not, but also does not need them when setting parents.
2175
for parent in merges:
2176
parent_trees.append(
2177
(parent, self.branch.repository.revision_tree(parent)))
2178
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2179
parent_trees.append(
2180
(old_tip, self.branch.repository.revision_tree(old_tip)))
2181
self.set_parent_trees(parent_trees)
2182
last_rev = parent_trees[0][0]
2184
# the working tree had the same last-revision as the master
2185
# branch did. We may still have pivot local work from the local
2186
# branch into old_tip:
2187
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2188
self.add_parent_tree_id(old_tip)
2189
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2190
and old_tip != last_rev):
2191
# our last revision was not the prior branch last revision
2192
# and we have converted that last revision to a pending merge.
2193
# base is somewhere between the branch tip now
2194
# and the now pending merge
2196
# Since we just modified the working tree and inventory, flush out
2197
# the current state, before we modify it again.
2198
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2199
# requires it only because TreeTransform directly munges the
2200
# inventory and calls tree._write_inventory(). Ultimately we
2201
# should be able to remove this extra flush.
2203
graph = self.branch.repository.get_graph()
2204
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2206
base_tree = self.branch.repository.revision_tree(base_rev_id)
2207
other_tree = self.branch.repository.revision_tree(old_tip)
2208
result += merge.merge_inner(
2213
change_reporter=change_reporter)
2216
def _write_hashcache_if_dirty(self):
2217
"""Write out the hashcache if it is dirty."""
2218
if self._hashcache.needs_write:
2220
self._hashcache.write()
2222
if e.errno not in (errno.EPERM, errno.EACCES):
2224
# TODO: jam 20061219 Should this be a warning? A single line
2225
# warning might be sufficient to let the user know what
2227
mutter('Could not write hashcache for %s\nError: %s',
2228
self._hashcache.cache_file_name(), e)
2230
@needs_tree_write_lock
1288
2231
def _write_inventory(self, inv):
1289
2232
"""Write inventory as the current inventory."""
1291
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1293
self._control_files.put('inventory', sio)
1294
self._set_inventory(inv)
1295
mutter('wrote working inventory')
2233
self._set_inventory(inv, dirty=True)
1297
2236
def set_conflicts(self, arg):
1298
raise UnsupportedOperation(self.set_conflicts, self)
2237
raise errors.UnsupportedOperation(self.set_conflicts, self)
2239
def add_conflicts(self, arg):
2240
raise errors.UnsupportedOperation(self.add_conflicts, self)
1300
2242
@needs_read_lock
1301
2243
def conflicts(self):
1302
conflicts = ConflictList()
2244
conflicts = _mod_conflicts.ConflictList()
1303
2245
for conflicted in self._iter_conflicts():
1306
2248
if file_kind(self.abspath(conflicted)) != "file":
1309
if e.errno == errno.ENOENT:
2250
except errors.NoSuchFile:
1313
2252
if text is True:
1314
2253
for suffix in ('.THIS', '.OTHER'):
1316
2255
kind = file_kind(self.abspath(conflicted+suffix))
1318
if e.errno == errno.ENOENT:
2258
except errors.NoSuchFile:
1326
2262
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
conflicts.append(Conflict.factory(ctype, path=conflicted,
2263
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1328
2265
file_id=self.path2id(conflicted)))
1329
2266
return conflicts
2268
def walkdirs(self, prefix=""):
2269
"""Walk the directories of this tree.
2271
returns a generator which yields items in the form:
2272
((curren_directory_path, fileid),
2273
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2276
This API returns a generator, which is only valid during the current
2277
tree transaction - within a single lock_read or lock_write duration.
2279
If the tree is not locked, it may cause an error to be raised,
2280
depending on the tree implementation.
2282
disk_top = self.abspath(prefix)
2283
if disk_top.endswith('/'):
2284
disk_top = disk_top[:-1]
2285
top_strip_len = len(disk_top) + 1
2286
inventory_iterator = self._walkdirs(prefix)
2287
disk_iterator = osutils.walkdirs(disk_top, prefix)
2289
current_disk = disk_iterator.next()
2290
disk_finished = False
2292
if not (e.errno == errno.ENOENT or
2293
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2296
disk_finished = True
2298
current_inv = inventory_iterator.next()
2299
inv_finished = False
2300
except StopIteration:
2303
while not inv_finished or not disk_finished:
2305
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2306
cur_disk_dir_content) = current_disk
2308
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2309
cur_disk_dir_content) = ((None, None), None)
2310
if not disk_finished:
2311
# strip out .bzr dirs
2312
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2313
len(cur_disk_dir_content) > 0):
2314
# osutils.walkdirs can be made nicer -
2315
# yield the path-from-prefix rather than the pathjoined
2317
bzrdir_loc = bisect_left(cur_disk_dir_content,
2319
if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
2320
# we dont yield the contents of, or, .bzr itself.
2321
del cur_disk_dir_content[bzrdir_loc]
2323
# everything is unknown
2326
# everything is missing
2329
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2331
# disk is before inventory - unknown
2332
dirblock = [(relpath, basename, kind, stat, None, None) for
2333
relpath, basename, kind, stat, top_path in
2334
cur_disk_dir_content]
2335
yield (cur_disk_dir_relpath, None), dirblock
2337
current_disk = disk_iterator.next()
2338
except StopIteration:
2339
disk_finished = True
2341
# inventory is before disk - missing.
2342
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2343
for relpath, basename, dkind, stat, fileid, kind in
2345
yield (current_inv[0][0], current_inv[0][1]), dirblock
2347
current_inv = inventory_iterator.next()
2348
except StopIteration:
2351
# versioned present directory
2352
# merge the inventory and disk data together
2354
for relpath, subiterator in itertools.groupby(sorted(
2355
current_inv[1] + cur_disk_dir_content,
2356
key=operator.itemgetter(0)), operator.itemgetter(1)):
2357
path_elements = list(subiterator)
2358
if len(path_elements) == 2:
2359
inv_row, disk_row = path_elements
2360
# versioned, present file
2361
dirblock.append((inv_row[0],
2362
inv_row[1], disk_row[2],
2363
disk_row[3], inv_row[4],
2365
elif len(path_elements[0]) == 5:
2367
dirblock.append((path_elements[0][0],
2368
path_elements[0][1], path_elements[0][2],
2369
path_elements[0][3], None, None))
2370
elif len(path_elements[0]) == 6:
2371
# versioned, absent file.
2372
dirblock.append((path_elements[0][0],
2373
path_elements[0][1], 'unknown', None,
2374
path_elements[0][4], path_elements[0][5]))
2376
raise NotImplementedError('unreachable code')
2377
yield current_inv[0], dirblock
2379
current_inv = inventory_iterator.next()
2380
except StopIteration:
2383
current_disk = disk_iterator.next()
2384
except StopIteration:
2385
disk_finished = True
2387
def _walkdirs(self, prefix=""):
2388
"""Walk the directories of this tree.
2390
:prefix: is used as the directrory to start with.
2391
returns a generator which yields items in the form:
2392
((curren_directory_path, fileid),
2393
[(file1_path, file1_name, file1_kind, None, file1_id,
2396
_directory = 'directory'
2397
# get the root in the inventory
2398
inv = self.inventory
2399
top_id = inv.path2id(prefix)
2403
pending = [(prefix, '', _directory, None, top_id, None)]
2406
currentdir = pending.pop()
2407
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2408
top_id = currentdir[4]
2410
relroot = currentdir[0] + '/'
2413
# FIXME: stash the node in pending
2415
for name, child in entry.sorted_children():
2416
dirblock.append((relroot + name, name, child.kind, None,
2417
child.file_id, child.kind
2419
yield (currentdir[0], entry.file_id), dirblock
2420
# push the user specified dirs from dirblock
2421
for dir in reversed(dirblock):
2422
if dir[2] == _directory:
2425
@needs_tree_write_lock
2426
def auto_resolve(self):
2427
"""Automatically resolve text conflicts according to contents.
2429
Only text conflicts are auto_resolvable. Files with no conflict markers
2430
are considered 'resolved', because bzr always puts conflict markers
2431
into files that have text conflicts. The corresponding .THIS .BASE and
2432
.OTHER files are deleted, as per 'resolve'.
2433
:return: a tuple of ConflictLists: (un_resolved, resolved).
2435
un_resolved = _mod_conflicts.ConflictList()
2436
resolved = _mod_conflicts.ConflictList()
2437
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2438
for conflict in self.conflicts():
2439
if (conflict.typestring != 'text conflict' or
2440
self.kind(conflict.file_id) != 'file'):
2441
un_resolved.append(conflict)
2443
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2445
for line in my_file:
2446
if conflict_re.search(line):
2447
un_resolved.append(conflict)
2450
resolved.append(conflict)
2453
resolved.remove_files(self)
2454
self.set_conflicts(un_resolved)
2455
return un_resolved, resolved
2457
def _validate(self):
2458
"""Validate internal structures.
2460
This is meant mostly for the test suite. To give it a chance to detect
2461
corruption after actions have occurred. The default implementation is a
2464
:return: None. An exception should be raised if there is an error.
2469
class WorkingTree2(WorkingTree):
2470
"""This is the Format 2 working tree.
2472
This was the first weave based working tree.
2473
- uses os locks for locking.
2474
- uses the branch last-revision.
2477
def __init__(self, *args, **kwargs):
2478
super(WorkingTree2, self).__init__(*args, **kwargs)
2479
# WorkingTree2 has more of a constraint that self._inventory must
2480
# exist. Because this is an older format, we don't mind the overhead
2481
# caused by the extra computation here.
2483
# Newer WorkingTree's should only have self._inventory set when they
2485
if self._inventory is None:
2486
self.read_working_inventory()
2488
def lock_tree_write(self):
2489
"""See WorkingTree.lock_tree_write().
2491
In Format2 WorkingTrees we have a single lock for the branch and tree
2492
so lock_tree_write() degrades to lock_write().
2494
self.branch.lock_write()
2496
return self._control_files.lock_write()
2498
self.branch.unlock()
2502
# do non-implementation specific cleanup
2505
# we share control files:
2506
if self._control_files._lock_count == 3:
2507
# _inventory_is_modified is always False during a read lock.
2508
if self._inventory_is_modified:
2510
self._write_hashcache_if_dirty()
2512
# reverse order of locking.
2514
return self._control_files.unlock()
2516
self.branch.unlock()
1332
2519
class WorkingTree3(WorkingTree):
1333
2520
"""This is the Format 3 working tree.