39
36
# At the moment they may alias the inventory and have old copies of it in
40
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
42
45
from copy import deepcopy
43
from cStringIO import StringIO
50
from bzrlib.atomicfile import AtomicFile
51
from bzrlib.branch import (Branch,
53
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
54
import bzrlib.bzrdir as bzrdir
54
conflicts as _mod_conflicts,
69
from bzrlib.transport import get_transport
73
from bzrlib import symbol_versioning
55
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
import bzrlib.errors as errors
57
from bzrlib.errors import (BzrCheckError,
61
WeaveRevisionNotPresent,
65
MergeModifiedFormatError,
68
from bzrlib.inventory import InventoryEntry, Inventory
75
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
69
76
from bzrlib.lockable_files import LockableFiles, TransportLock
70
77
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
78
import bzrlib.mutabletree
79
from bzrlib.mutabletree import needs_tree_write_lock
72
80
from bzrlib.osutils import (
92
from bzrlib.trace import mutter, note
93
from bzrlib.transport.local import LocalTransport
90
95
from bzrlib.progress import DummyProgress, ProgressPhase
91
from bzrlib.revision import NULL_REVISION
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
97
import bzrlib.revisiontree
92
98
from bzrlib.rio import RioReader, rio_file, Stanza
93
from bzrlib.symbol_versioning import *
94
from bzrlib.textui import show_status
96
from bzrlib.transform import build_tree
97
from bzrlib.trace import mutter, note
98
from bzrlib.transport import get_transport
99
from bzrlib.transport.local import LocalTransport
99
from bzrlib.symbol_versioning import (deprecated_passed,
102
DEPRECATED_PARAMETER,
109
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
@deprecated_function(zero_thirteen)
104
114
def gen_file_id(name):
105
"""Return new file id.
107
This should probably generate proper UUIDs, but for the moment we
108
cope with just randomness because running uuidgen every time is
111
from binascii import hexlify
112
from time import time
115
idx = name.rfind('/')
117
name = name[idx+1 : ]
118
idx = name.rfind('\\')
120
name = name[idx+1 : ]
122
# make it not a hidden file
123
name = name.lstrip('.')
125
# remove any wierd characters; we don't escape them but rather
127
name = re.sub(r'[^\w.]', '', name)
129
s = hexlify(rand_bytes(8))
130
return '-'.join((name, compact_date(time()), s))
115
"""Return new file id for the basename 'name'.
117
Use bzrlib.generate_ids.gen_file_id() instead
119
return generate_ids.gen_file_id(name)
122
@deprecated_function(zero_thirteen)
133
123
def gen_root_id():
134
"""Return a new tree-root file id."""
135
return gen_file_id('TREE_ROOT')
124
"""Return a new tree-root file id.
126
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
128
return generate_ids.gen_root_id()
138
131
class TreeEntry(object):
139
"""An entry that implements the minium interface used by commands.
132
"""An entry that implements the minimum interface used by commands.
141
134
This needs further inspection, it may be better to have
142
135
InventoryEntries without ids - though that seems wrong. For now,
496
577
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():
580
def get_file_sha1(self, file_id, path=None, stat_value=None):
582
path = self._inventory.id2path(file_id)
583
return self._hashcache.get_sha1(path, stat_value)
585
def get_file_mtime(self, file_id, path=None):
587
path = self._inventory.id2path(file_id)
588
return os.lstat(self.abspath(path)).st_mtime
590
if not supports_executable():
591
def is_executable(self, file_id, path=None):
505
592
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
594
def is_executable(self, file_id, path=None):
596
path = self._inventory.id2path(file_id)
508
597
mode = os.lstat(self.abspath(path)).st_mode
509
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
598
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
511
600
@needs_write_lock
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.
601
def _add(self, files, ids, kinds):
602
"""See MutableTree._add."""
534
603
# TODO: Re-adding a file that is removed in the working copy
535
604
# 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))
605
# the read and write working inventory should not occur in this
606
# function - they should be part of lock_write and unlock.
547
607
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))
608
for f, file_id, kind in zip(files, ids, kinds):
609
assert kind is not None
571
610
if file_id is None:
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
611
inv.add_path(f, kind=kind)
613
inv.add_path(f, kind=kind, file_id=file_id)
576
614
self._write_inventory(inv)
616
@needs_tree_write_lock
617
def _gather_kinds(self, files, kinds):
618
"""See MutableTree._gather_kinds."""
619
for pos, f in enumerate(files):
620
if kinds[pos] is None:
621
fullpath = normpath(self.abspath(f))
623
kinds[pos] = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise errors.NoSuchFile(fullpath)
578
628
@needs_write_lock
629
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
630
"""Add revision_id as a parent.
632
This is equivalent to retrieving the current list of parent ids
633
and setting the list to its value plus revision_id.
635
:param revision_id: The revision id to add to the parent list. It may
636
be a ghost revision as long as its not the first parent to be added,
637
or the allow_leftmost_as_ghost parameter is set True.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parents = self.get_parent_ids() + [revision_id]
641
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
642
or allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
646
"""Add revision_id, tree tuple as a parent.
648
This is equivalent to retrieving the current list of parent trees
649
and setting the list to its value plus parent_tuple. See also
650
add_parent_tree_id - if you only have a parent id available it will be
651
simpler to use that api. If you have the parent already available, using
652
this api is preferred.
654
:param parent_tuple: The (revision id, tree) to add to the parent list.
655
If the revision_id is a ghost, pass None for the tree.
656
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
659
if len(parent_ids) > 1:
660
# the leftmost may have already been a ghost, preserve that if it
662
allow_leftmost_as_ghost = True
663
self.set_parent_ids(parent_ids,
664
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
@needs_tree_write_lock
579
667
def add_pending_merge(self, *revision_ids):
580
668
# TODO: Perhaps should check at this point that the
581
669
# history of the revision is actually present?
582
p = self.pending_merges()
670
parents = self.get_parent_ids()
584
672
for rev_id in revision_ids:
673
if rev_id in parents:
675
parents.append(rev_id)
590
self.set_pending_merges(p)
678
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
@deprecated_method(zero_eleven)
593
682
def pending_merges(self):
594
683
"""Return a list of pending merges.
596
685
These are revisions that have been merged into the working
597
686
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'))
688
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
689
instead - which is available on all tree objects.
691
return self.get_parent_ids()[1:]
693
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
694
"""Common ghost checking functionality from set_parent_*.
696
This checks that the left hand-parent exists if there are any
699
if len(revision_ids) > 0:
700
leftmost_id = revision_ids[0]
701
if (not allow_leftmost_as_ghost and not
702
self.branch.repository.has_revision(leftmost_id)):
703
raise errors.GhostRevisionUnusableHere(leftmost_id)
705
def _set_merges_from_parent_ids(self, parent_ids):
706
merges = parent_ids[1:]
707
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
709
@needs_tree_write_lock
710
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
711
"""Set the parent ids to revision_ids.
713
See also set_parent_trees. This api will try to retrieve the tree data
714
for each element of revision_ids from the trees repository. If you have
715
tree data already available, it is more efficient to use
716
set_parent_trees rather than set_parent_ids. set_parent_ids is however
717
an easier API to use.
719
:param revision_ids: The revision_ids to set as the parent ids of this
720
working tree. Any of these may be ghosts.
722
self._check_parents_for_ghosts(revision_ids,
723
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
725
if len(revision_ids) > 0:
726
self.set_last_revision(revision_ids[0])
728
self.set_last_revision(None)
730
self._set_merges_from_parent_ids(revision_ids)
732
@needs_tree_write_lock
733
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
734
"""See MutableTree.set_parent_trees."""
735
parent_ids = [rev for (rev, tree) in parents_list]
737
self._check_parents_for_ghosts(parent_ids,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
if len(parent_ids) == 0:
741
leftmost_parent_id = None
742
leftmost_parent_tree = None
744
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
746
if self._change_last_revision(leftmost_parent_id):
747
if leftmost_parent_tree is None:
748
# If we don't have a tree, fall back to reading the
749
# parent tree from the repository.
750
self._cache_basis_inventory(leftmost_parent_id)
752
inv = leftmost_parent_tree.inventory
753
xml = self._create_basis_xml_from_inventory(
754
leftmost_parent_id, inv)
755
self._write_basis_inventory(xml)
756
self._set_merges_from_parent_ids(parent_ids)
758
@needs_tree_write_lock
611
759
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
760
parents = self.get_parent_ids()
761
leftmost = parents[:1]
762
new_parents = leftmost + rev_list
763
self.set_parent_ids(new_parents)
765
@needs_tree_write_lock
615
766
def set_merge_modified(self, modified_hashes):
616
767
def iter_stanzas():
617
768
for file_id, hash in modified_hashes.iteritems():
618
769
yield Stanza(file_id=file_id, hash=hash)
619
770
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
772
@needs_tree_write_lock
622
773
def _put_rio(self, filename, stanzas, header):
623
774
my_file = rio_file(stanzas, header)
624
775
self._control_files.put(filename, my_file)
777
@needs_write_lock # because merge pulls data into the branch.
778
def merge_from_branch(self, branch, to_revision=None):
779
"""Merge from a branch into this working tree.
781
:param branch: The branch to merge from.
782
:param to_revision: If non-None, the merge will merge to to_revision,
783
but not beyond it. to_revision does not need to be in the history
784
of the branch when it is supplied. If None, to_revision defaults to
785
branch.last_revision().
787
from bzrlib.merge import Merger, Merge3Merger
788
pb = bzrlib.ui.ui_factory.nested_progress_bar()
790
merger = Merger(self.branch, this_tree=self, pb=pb)
791
merger.pp = ProgressPhase("Merge phase", 5, pb)
792
merger.pp.next_phase()
793
# check that there are no
795
merger.check_basis(check_clean=True, require_commits=False)
796
if to_revision is None:
797
to_revision = branch.last_revision()
798
merger.other_rev_id = to_revision
799
if merger.other_rev_id is None:
800
raise error.NoCommits(branch)
801
self.branch.fetch(branch, last_revision=merger.other_rev_id)
802
merger.other_basis = merger.other_rev_id
803
merger.other_tree = self.branch.repository.revision_tree(
805
merger.pp.next_phase()
807
if merger.base_rev_id == merger.other_rev_id:
808
raise errors.PointlessMerge
809
merger.backup_files = False
810
merger.merge_type = Merge3Merger
811
merger.set_interesting_files(None)
812
merger.show_base = False
813
merger.reprocess = False
814
conflicts = merger.do_merge()
627
821
def merge_modified(self):
629
823
hashfile = self._control_files.get('merge-hashes')
824
except errors.NoSuchFile:
632
826
merge_hashes = {}
634
828
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
raise MergeModifiedFormatError()
829
raise errors.MergeModifiedFormatError()
636
830
except StopIteration:
637
raise MergeModifiedFormatError()
831
raise errors.MergeModifiedFormatError()
638
832
for s in RioReader(hashfile):
639
833
file_id = s.get("file_id")
640
834
if file_id not in self.inventory:
666
880
Skips the control directory.
668
882
inv = self._inventory
670
def descend(from_dir_relpath, from_dir_id, dp):
883
if include_root is True:
884
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
885
# Convert these into local objects to save lookup times
886
pathjoin = osutils.pathjoin
887
file_kind = osutils.file_kind
889
# transport.base ends in a slash, we want the piece
890
# between the last two slashes
891
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
893
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
895
# directory file_id, relative path, absolute path, reverse sorted children
896
children = os.listdir(self.basedir)
898
# jam 20060527 The kernel sized tree seems equivalent whether we
899
# use a deque and popleft to keep them sorted, or if we use a plain
900
# list and just reverse() them.
901
children = collections.deque(children)
902
stack = [(inv.root.file_id, u'', self.basedir, children)]
904
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
907
f = children.popleft()
674
908
## TODO: If we find a subdirectory with its own .bzr
675
909
## directory, then that is a separate tree and we
676
910
## should exclude it.
678
912
# the bzrdir for this tree
679
if self.bzrdir.transport.base.endswith(f + '/'):
913
if transport_base_dir == f:
683
fp = appendpath(from_dir_relpath, f)
916
# we know that from_dir_relpath and from_dir_abspath never end in a slash
917
# and 'f' doesn't begin with one, we can do a string op, rather
918
# than the checks of pathjoin(), all relative paths will have an extra slash
920
fp = from_dir_relpath + '/' + f
686
fap = appendpath(dp, f)
923
fap = from_dir_abspath + '/' + f
688
925
f_ie = inv.get_child(from_dir_id, f)
691
elif self.is_ignored(fp):
928
elif self.is_ignored(fp[1:]):
931
# we may not have found this file, because of a unicode issue
932
f_norm, can_access = osutils.normalized_filename(f)
933
if f == f_norm or not can_access:
934
# No change, so treat this file normally
937
# this file can be accessed by a normalized path
938
# check again if it is versioned
939
# these lines are repeated here for performance
941
fp = from_dir_relpath + '/' + f
942
fap = from_dir_abspath + '/' + f
943
f_ie = inv.get_child(from_dir_id, f)
946
elif self.is_ignored(fp[1:]):
696
951
fk = file_kind(fap)
699
954
if f_ie.kind != fk:
700
raise BzrCheckError("file %r entered as kind %r id %r, "
702
% (fap, f_ie.kind, f_ie.file_id, fk))
955
raise errors.BzrCheckError(
956
"file %r entered as kind %r id %r, now of kind %r"
957
% (fap, f_ie.kind, f_ie.file_id, fk))
704
959
# make a last minute entry
961
yield fp[1:], c, fk, f_ie.file_id, f_ie
708
if fk == 'directory':
709
entry = TreeDirectory()
712
elif fk == 'symlink':
964
yield fp[1:], c, fk, None, fk_entries[fk]()
966
yield fp[1:], c, fk, None, TreeEntry()
717
yield fp, c, fk, (f_ie and f_ie.file_id), entry
719
969
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):
972
# But do this child first
973
new_children = os.listdir(fap)
975
new_children = collections.deque(new_children)
976
stack.append((f_ie.file_id, fp, fap, new_children))
977
# Break out of inner loop,
978
# so that we start outer loop with child
981
# if we finished all children, pop it off the stack
984
@needs_tree_write_lock
985
def move(self, from_paths, to_dir=None, after=False, **kwargs):
736
to_name must exist in the inventory.
988
to_dir must exist in the inventory.
738
If to_name exists and is a directory, the files are moved into
990
If to_dir exists and is a directory, the files are moved into
739
991
it, keeping their old names.
741
Note that to_name is only the last component of the new name;
993
Note that to_dir is only the last component of the new name;
742
994
this doesn't change the directory.
996
For each entry in from_paths the move mode will be determined
999
The first mode moves the file in the filesystem and updates the
1000
inventory. The second mode only updates the inventory without
1001
touching the file on the filesystem. This is the new mode introduced
1004
move uses the second mode if 'after == True' and the target is not
1005
versioned but present in the working tree.
1007
move uses the second mode if 'after == False' and the source is
1008
versioned but no longer in the working tree, and the target is not
1009
versioned but present in the working tree.
1011
move uses the first mode if 'after == False' and the source is
1012
versioned and present in the working tree, and the target is not
1013
versioned and not present in the working tree.
1015
Everything else results in an error.
744
1017
This returns a list of (from_path, to_path) pairs for each
745
1018
entry that is moved.
748
## TODO: Option to move IDs only
1023
# check for deprecated use of signature
1025
to_dir = kwargs.get('to_name', None)
1027
raise TypeError('You must supply a target directory')
1029
symbol_versioning.warn('The parameter to_name was deprecated'
1030
' in version 0.13. Use to_dir instead',
1033
# check destination directory
749
1034
assert not isinstance(from_paths, basestring)
750
1035
inv = self.inventory
751
to_abs = self.abspath(to_name)
1036
to_abs = self.abspath(to_dir)
752
1037
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)
1038
raise errors.BzrMoveFailedError('',to_dir,
1039
errors.NotADirectory(to_abs))
1040
if not self.has_filename(to_dir):
1041
raise errors.BzrMoveFailedError('',to_dir,
1042
errors.NotInWorkingDirectory(to_dir))
1043
to_dir_id = inv.path2id(to_dir)
1044
if to_dir_id is None:
1045
raise errors.BzrMoveFailedError('',to_dir,
1046
errors.NotVersionedError(path=str(to_dir)))
759
1048
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)
1049
if to_dir_ie.kind != 'directory':
1050
raise errors.BzrMoveFailedError('',to_dir,
1051
errors.NotADirectory(to_abs))
1053
# create rename entries and tuples
1054
for from_rel in from_paths:
1055
from_tail = splitpath(from_rel)[-1]
1056
from_id = inv.path2id(from_rel)
1058
raise errors.BzrMoveFailedError(from_rel,to_dir,
1059
errors.NotVersionedError(path=str(from_rel)))
1061
from_entry = inv[from_id]
1062
from_parent_id = from_entry.parent_id
1063
to_rel = pathjoin(to_dir, from_tail)
1064
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1066
from_tail=from_tail,
1067
from_parent_id=from_parent_id,
1068
to_rel=to_rel, to_tail=from_tail,
1069
to_parent_id=to_dir_id)
1070
rename_entries.append(rename_entry)
1071
rename_tuples.append((from_rel, to_rel))
1073
# determine which move mode to use. checks also for movability
1074
rename_entries = self._determine_mv_mode(rename_entries, after)
1076
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"])
1079
self._inventory_is_modified = True
1080
self._move(rename_entries)
795
1082
# restore the inventory on error
796
self._set_inventory(orig_inv)
1083
self._inventory_is_modified = original_modified
798
1085
self._write_inventory(inv)
802
def rename_one(self, from_rel, to_rel):
1086
return rename_tuples
1088
def _determine_mv_mode(self, rename_entries, after=False):
1089
"""Determines for each from-to pair if both inventory and working tree
1090
or only the inventory has to be changed.
1092
Also does basic plausability tests.
1094
inv = self.inventory
1096
for rename_entry in rename_entries:
1097
# store to local variables for easier reference
1098
from_rel = rename_entry.from_rel
1099
from_id = rename_entry.from_id
1100
to_rel = rename_entry.to_rel
1101
to_id = inv.path2id(to_rel)
1102
only_change_inv = False
1104
# check the inventory for source and destination
1106
raise errors.BzrMoveFailedError(from_rel,to_rel,
1107
errors.NotVersionedError(path=str(from_rel)))
1108
if to_id is not None:
1109
raise errors.BzrMoveFailedError(from_rel,to_rel,
1110
errors.AlreadyVersionedError(path=str(to_rel)))
1112
# try to determine the mode for rename (only change inv or change
1113
# inv and file system)
1115
if not self.has_filename(to_rel):
1116
raise errors.BzrMoveFailedError(from_id,to_rel,
1117
errors.NoSuchFile(path=str(to_rel),
1118
extra="New file has not been created yet"))
1119
only_change_inv = True
1120
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1121
only_change_inv = True
1122
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1123
only_change_inv = False
1125
# something is wrong, so lets determine what exactly
1126
if not self.has_filename(from_rel) and \
1127
not self.has_filename(to_rel):
1128
raise errors.BzrRenameFailedError(from_rel,to_rel,
1129
errors.PathsDoNotExist(paths=(str(from_rel),
1132
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1133
extra="(Use --after to update the Bazaar id)")
1134
rename_entry.only_change_inv = only_change_inv
1135
return rename_entries
1137
def _move(self, rename_entries):
1138
"""Moves a list of files.
1140
Depending on the value of the flag 'only_change_inv', the
1141
file will be moved on the file system or not.
1143
inv = self.inventory
1146
for entry in rename_entries:
1148
self._move_entry(entry)
1150
self._rollback_move(moved)
1154
def _rollback_move(self, moved):
1155
"""Try to rollback a previous move in case of an filesystem error."""
1156
inv = self.inventory
1159
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1160
entry.to_tail, entry.to_parent_id, entry.from_rel,
1161
entry.from_tail, entry.from_parent_id,
1162
entry.only_change_inv))
1163
except errors.BzrMoveFailedError, e:
1164
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1165
" The working tree is in an inconsistent state."
1166
" Please consider doing a 'bzr revert'."
1167
" Error message is: %s" % e)
1169
def _move_entry(self, entry):
1170
inv = self.inventory
1171
from_rel_abs = self.abspath(entry.from_rel)
1172
to_rel_abs = self.abspath(entry.to_rel)
1173
if from_rel_abs == to_rel_abs:
1174
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1175
"Source and target are identical.")
1177
if not entry.only_change_inv:
1179
osutils.rename(from_rel_abs, to_rel_abs)
1181
raise errors.BzrMoveFailedError(entry.from_rel,
1183
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1185
@needs_tree_write_lock
1186
def rename_one(self, from_rel, to_rel, after=False):
803
1187
"""Rename one file.
805
1189
This can change the directory or the filename or both.
1191
rename_one has several 'modes' to work. First, it can rename a physical
1192
file and change the file_id. That is the normal mode. Second, it can
1193
only change the file_id without touching any physical file. This is
1194
the new mode introduced in version 0.15.
1196
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1197
versioned but present in the working tree.
1199
rename_one uses the second mode if 'after == False' and 'from_rel' is
1200
versioned but no longer in the working tree, and 'to_rel' is not
1201
versioned but present in the working tree.
1203
rename_one uses the first mode if 'after == False' and 'from_rel' is
1204
versioned and present in the working tree, and 'to_rel' is not
1205
versioned and not present in the working tree.
1207
Everything else results in an error.
807
1209
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)
1212
# create rename entries and tuples
1213
from_tail = splitpath(from_rel)[-1]
1214
from_id = inv.path2id(from_rel)
1216
raise errors.BzrRenameFailedError(from_rel,to_rel,
1217
errors.NotVersionedError(path=str(from_rel)))
1218
from_entry = inv[from_id]
1219
from_parent_id = from_entry.parent_id
824
1220
to_dir, to_tail = os.path.split(to_rel)
825
1221
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"])
1222
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1224
from_tail=from_tail,
1225
from_parent_id=from_parent_id,
1226
to_rel=to_rel, to_tail=to_tail,
1227
to_parent_id=to_dir_id)
1228
rename_entries.append(rename_entry)
1230
# determine which move mode to use. checks also for movability
1231
rename_entries = self._determine_mv_mode(rename_entries, after)
1233
# check if the target changed directory and if the target directory is
1235
if to_dir_id is None:
1236
raise errors.BzrMoveFailedError(from_rel,to_rel,
1237
errors.NotVersionedError(path=str(to_dir)))
1239
# all checks done. now we can continue with our actual work
1240
mutter('rename_one:\n'
1245
' to_dir_id {%s}\n',
1246
from_id, from_rel, to_rel, to_dir, to_dir_id)
1248
self._move(rename_entries)
847
1249
self._write_inventory(inv)
1251
class _RenameEntry(object):
1252
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1253
to_rel, to_tail, to_parent_id, only_change_inv=False):
1254
self.from_rel = from_rel
1255
self.from_id = from_id
1256
self.from_tail = from_tail
1257
self.from_parent_id = from_parent_id
1258
self.to_rel = to_rel
1259
self.to_tail = to_tail
1260
self.to_parent_id = to_parent_id
1261
self.only_change_inv = only_change_inv
849
1263
@needs_read_lock
850
1264
def unknowns(self):
851
1265
"""Return all unknown files.
853
1267
These are files in the working directory that are not versioned or
854
1268
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
1270
for subp in self.extras():
870
1271
if not self.is_ignored(subp):
1274
@needs_tree_write_lock
1275
def unversion(self, file_ids):
1276
"""Remove the file ids in file_ids from the current versioned set.
1278
When a file_id is unversioned, all of its children are automatically
1281
:param file_ids: The file ids to stop versioning.
1282
:raises: NoSuchId if any fileid is not currently versioned.
1284
for file_id in file_ids:
1285
if self._inventory.has_id(file_id):
1286
self._inventory.remove_recursive_id(file_id)
1288
raise errors.NoSuchId(self, file_id)
1290
# in the future this should just set a dirty bit to wait for the
1291
# final unlock. However, until all methods of workingtree start
1292
# with the current in -memory inventory rather than triggering
1293
# a read, it is more complex - we need to teach read_inventory
1294
# to know when to read, and when to not read first... and possibly
1295
# to save first when the in memory one may be corrupted.
1296
# so for now, we just only write it if it is indeed dirty.
1298
self._write_inventory(self._inventory)
873
1300
@deprecated_method(zero_eight)
874
1301
def iter_conflicts(self):
875
1302
"""List all files in the tree that have text or content conflicts.
1059
1546
if new_revision is None:
1060
1547
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])
1550
self.branch.generate_revision_history(new_revision)
1551
except errors.NoSuchRevision:
1552
# not present in the repo - dont try to set it deeper than the tip
1553
self.branch.set_revision_history([new_revision])
1556
def _write_basis_inventory(self, xml):
1557
"""Write the basis inventory XML to the basis-inventory file"""
1558
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1559
path = self._basis_inventory_name()
1561
self._control_files.put(path, sio)
1563
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1564
"""Create the text that will be saved in basis-inventory"""
1565
inventory.revision_id = revision_id
1566
return xml6.serializer_v6.write_inventory_to_string(inventory)
1071
1568
def _cache_basis_inventory(self, new_revision):
1072
1569
"""Cache new_revision as the basis inventory."""
1570
# TODO: this should allow the ready-to-use inventory to be passed in,
1571
# as commit already has that ready-to-use [while the format is the
1074
1574
# this double handles the inventory - unpack and repack -
1075
1575
# but is easier to understand. We can/should put a conditional
1076
1576
# in here based on whether the inventory is in the latest format
1077
1577
# - 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:
1579
# the fast path is to copy the raw xml from the repository. If the
1580
# xml contains 'revision_id="', then we assume the right
1581
# revision_id is set. We must check for this full string, because a
1582
# root node id can legitimately look like 'revision_id' but cannot
1584
xml = self.branch.repository.get_inventory_xml(new_revision)
1585
firstline = xml.split('\n', 1)[0]
1586
if (not 'revision_id="' in firstline or
1587
'format="6"' not in firstline):
1588
inv = self.branch.repository.deserialise_inventory(
1590
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1591
self._write_basis_inventory(xml)
1592
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1088
1595
def read_basis_inventory(self):
1089
1596
"""Read the cached basis inventory."""
1090
1597
path = self._basis_inventory_name()
1091
return self._control_files.get_utf8(path).read()
1598
return self._control_files.get(path).read()
1093
1600
@needs_read_lock
1094
1601
def read_working_inventory(self):
1095
"""Read the working inventory."""
1602
"""Read the working inventory.
1604
:raises errors.InventoryModified: read_working_inventory will fail
1605
when the current in memory inventory has been modified.
1607
# conceptually this should be an implementation detail of the tree.
1608
# XXX: Deprecate this.
1096
1609
# ElementTree does its own conversion from UTF-8, so open in
1098
result = bzrlib.xml5.serializer_v5.read_inventory(
1611
if self._inventory_is_modified:
1612
raise errors.InventoryModified(self)
1613
result = xml5.serializer_v5.read_inventory(
1099
1614
self._control_files.get('inventory'))
1100
self._set_inventory(result)
1615
self._set_inventory(result, dirty=False)
1104
def remove(self, files, verbose=False):
1618
@needs_tree_write_lock
1619
def remove(self, files, verbose=False, to_file=None):
1105
1620
"""Remove nominated files from the working inventory..
1107
1622
This does not remove their text. This does not run on XXX on what? RBC
1204
1733
between multiple working trees, i.e. via shared storage, then we
1205
1734
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()
1736
raise NotImplementedError(self.unlock)
1231
1738
def update(self):
1232
1739
"""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.
1741
This will update the branch if its bound too, which means we have
1742
multiple trees involved:
1744
- The new basis tree of the master.
1745
- The old basis tree of the branch.
1746
- The old basis tree of the working tree.
1747
- The current working tree state.
1749
Pathologically, all three may be different, and non-ancestors of each
1750
other. Conceptually we want to:
1752
- Preserve the wt.basis->wt.state changes
1753
- Transform the wt.basis to the new master basis.
1754
- Apply a merge of the old branch basis to get any 'local' changes from
1756
- Restore the wt.basis->wt.state changes.
1246
1758
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.
1759
- Merge current state -> basis tree of the master w.r.t. the old tree
1761
- 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()
1763
if self.branch.get_master_branch() is not None:
1765
update_branch = True
1767
self.lock_tree_write()
1768
update_branch = False
1256
if self.last_revision() != self.branch.last_revision():
1257
# merge tree state up to new branch tip.
1258
basis = self.basis_tree()
1259
to_tree = self.branch.basis_tree()
1260
result += merge_inner(self.branch,
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,
1771
old_tip = self.branch.update()
1774
return self._update_tree(old_tip)
1285
self.branch.unlock()
1778
@needs_tree_write_lock
1779
def _update_tree(self, old_tip=None):
1780
"""Update a tree to the master branch.
1782
:param old_tip: if supplied, the previous tip revision the branch,
1783
before it was changed to the master branch's tip.
1785
# here if old_tip is not None, it is the old tip of the branch before
1786
# it was updated from the master branch. This should become a pending
1787
# merge in the working tree to preserve the user existing work. we
1788
# cant set that until we update the working trees last revision to be
1789
# one from the new branch, because it will just get absorbed by the
1790
# parent de-duplication logic.
1792
# We MUST save it even if an error occurs, because otherwise the users
1793
# local work is unreferenced and will appear to have been lost.
1797
last_rev = self.get_parent_ids()[0]
1800
if last_rev != self.branch.last_revision():
1801
# merge tree state up to new branch tip.
1802
basis = self.basis_tree()
1803
to_tree = self.branch.basis_tree()
1804
if basis.inventory.root is None:
1805
self.set_root_id(to_tree.inventory.root.file_id)
1806
result += merge.merge_inner(
1811
# TODO - dedup parents list with things merged by pull ?
1812
# reuse the tree we've updated to to set the basis:
1813
parent_trees = [(self.branch.last_revision(), to_tree)]
1814
merges = self.get_parent_ids()[1:]
1815
# Ideally we ask the tree for the trees here, that way the working
1816
# tree can decide whether to give us teh entire tree or give us a
1817
# lazy initialised tree. dirstate for instance will have the trees
1818
# in ram already, whereas a last-revision + basis-inventory tree
1819
# will not, but also does not need them when setting parents.
1820
for parent in merges:
1821
parent_trees.append(
1822
(parent, self.branch.repository.revision_tree(parent)))
1823
if old_tip is not None:
1824
parent_trees.append(
1825
(old_tip, self.branch.repository.revision_tree(old_tip)))
1826
self.set_parent_trees(parent_trees)
1827
last_rev = parent_trees[0][0]
1829
# the working tree had the same last-revision as the master
1830
# branch did. We may still have pivot local work from the local
1831
# branch into old_tip:
1832
if old_tip is not None:
1833
self.add_parent_tree_id(old_tip)
1834
if old_tip and old_tip != last_rev:
1835
# our last revision was not the prior branch last revision
1836
# and we have converted that last revision to a pending merge.
1837
# base is somewhere between the branch tip now
1838
# and the now pending merge
1839
from bzrlib.revision import common_ancestor
1841
base_rev_id = common_ancestor(self.branch.last_revision(),
1843
self.branch.repository)
1844
except errors.NoCommonAncestor:
1846
base_tree = self.branch.repository.revision_tree(base_rev_id)
1847
other_tree = self.branch.repository.revision_tree(old_tip)
1848
result += merge.merge_inner(
1855
def _write_hashcache_if_dirty(self):
1856
"""Write out the hashcache if it is dirty."""
1857
if self._hashcache.needs_write:
1859
self._hashcache.write()
1861
if e.errno not in (errno.EPERM, errno.EACCES):
1863
# TODO: jam 20061219 Should this be a warning? A single line
1864
# warning might be sufficient to let the user know what
1866
mutter('Could not write hashcache for %s\nError: %s',
1867
self._hashcache.cache_file_name(), e)
1869
@needs_tree_write_lock
1288
1870
def _write_inventory(self, inv):
1289
1871
"""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')
1872
self._set_inventory(inv, dirty=True)
1297
1875
def set_conflicts(self, arg):
1298
raise UnsupportedOperation(self.set_conflicts, self)
1876
raise errors.UnsupportedOperation(self.set_conflicts, self)
1878
def add_conflicts(self, arg):
1879
raise errors.UnsupportedOperation(self.add_conflicts, self)
1300
1881
@needs_read_lock
1301
1882
def conflicts(self):
1302
conflicts = ConflictList()
1883
conflicts = _mod_conflicts.ConflictList()
1303
1884
for conflicted in self._iter_conflicts():
1306
1887
if file_kind(self.abspath(conflicted)) != "file":
1309
if e.errno == errno.ENOENT:
1889
except errors.NoSuchFile:
1313
1891
if text is True:
1314
1892
for suffix in ('.THIS', '.OTHER'):
1316
1894
kind = file_kind(self.abspath(conflicted+suffix))
1318
if e.errno == errno.ENOENT:
1897
except errors.NoSuchFile:
1326
1901
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
conflicts.append(Conflict.factory(ctype, path=conflicted,
1902
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1328
1904
file_id=self.path2id(conflicted)))
1329
1905
return conflicts
1908
class WorkingTree2(WorkingTree):
1909
"""This is the Format 2 working tree.
1911
This was the first weave based working tree.
1912
- uses os locks for locking.
1913
- uses the branch last-revision.
1916
def lock_tree_write(self):
1917
"""See WorkingTree.lock_tree_write().
1919
In Format2 WorkingTrees we have a single lock for the branch and tree
1920
so lock_tree_write() degrades to lock_write().
1922
self.branch.lock_write()
1924
return self._control_files.lock_write()
1926
self.branch.unlock()
1930
# we share control files:
1931
if self._control_files._lock_count == 3:
1932
# _inventory_is_modified is always False during a read lock.
1933
if self._inventory_is_modified:
1935
self._write_hashcache_if_dirty()
1937
# reverse order of locking.
1939
return self._control_files.unlock()
1941
self.branch.unlock()
1332
1944
class WorkingTree3(WorkingTree):
1333
1945
"""This is the Format 3 working tree.