39
36
# At the moment they may alias the inventory and have old copies of it in
40
37
# memory. (Now done? -- mbp 20060309)
42
from copy import deepcopy
43
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
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
59
conflicts as _mod_conflicts,
68
revision as _mod_revision,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
86
from bzrlib import symbol_versioning
55
87
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
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
69
89
from bzrlib.lockable_files import LockableFiles, TransportLock
70
90
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
72
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
90
107
from bzrlib.progress import DummyProgress, ProgressPhase
91
from bzrlib.revision import NULL_REVISION
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
92
109
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
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
104
127
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))
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
133
136
def gen_root_id():
134
"""Return a new tree-root file id."""
135
return gen_file_id('TREE_ROOT')
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
138
144
class TreeEntry(object):
139
"""An entry that implements the minium interface used by commands.
145
"""An entry that implements the minimum interface used by commands.
141
147
This needs further inspection, it may be better to have
142
148
InventoryEntries without ids - though that seems wrong. For now,
405
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
407
def relpath(self, abs):
408
"""Return the local path portion from a given absolute path."""
409
return relpath(self.basedir, abs)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
411
451
def has_filename(self, filename):
412
return bzrlib.osutils.lexists(self.abspath(filename))
414
def get_file(self, file_id):
415
return self.get_file_byname(self.id2path(file_id))
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None):
456
file_id = osutils.safe_file_id(file_id)
457
path = self.id2path(file_id)
458
return self.get_file_byname(path)
460
def get_file_text(self, file_id):
461
file_id = osutils.safe_file_id(file_id)
462
return self.get_file(file_id).read()
417
464
def get_file_byname(self, filename):
418
465
return file(self.abspath(filename), 'rb')
468
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
469
"""See Tree.annotate_iter
471
This implementation will use the basis tree implementation if possible.
472
Lines not in the basis are attributed to CURRENT_REVISION
474
If there are pending merges, lines added by those merges will be
475
incorrectly attributed to CURRENT_REVISION (but after committing, the
476
attribution will be correct).
478
file_id = osutils.safe_file_id(file_id)
479
basis = self.basis_tree()
482
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
483
require_versioned=True).next()
484
changed_content, kind = changes[2], changes[6]
485
if not changed_content:
486
return basis.annotate_iter(file_id)
490
if kind[0] != 'file':
493
old_lines = list(basis.annotate_iter(file_id))
495
for tree in self.branch.repository.revision_trees(
496
self.get_parent_ids()[1:]):
497
if file_id not in tree:
499
old.append(list(tree.annotate_iter(file_id)))
500
return annotate.reannotate(old, self.get_file(file_id).readlines(),
505
def _get_ancestors(self, default_revision):
506
ancestors = set([default_revision])
507
for parent_id in self.get_parent_ids():
508
ancestors.update(self.branch.repository.get_ancestry(
509
parent_id, topo_sorted=False))
512
def get_parent_ids(self):
513
"""See Tree.get_parent_ids.
515
This implementation reads the pending merges list and last_revision
516
value and uses that to decide what the parents list should be.
518
last_rev = _mod_revision.ensure_null(self._last_revision())
519
if _mod_revision.NULL_REVISION == last_rev:
524
merges_file = self._control_files.get('pending-merges')
525
except errors.NoSuchFile:
528
for l in merges_file.readlines():
529
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
530
parents.append(revision_id)
420
534
def get_root_id(self):
421
535
"""Return the id of this trees root"""
422
inv = self.read_working_inventory()
423
return inv.root.file_id
536
return self._inventory.root.file_id
425
538
def _get_store_filename(self, file_id):
426
539
## XXX: badly named; this is not in the store at all
540
file_id = osutils.safe_file_id(file_id)
427
541
return self.abspath(self.id2path(file_id))
430
def clone(self, to_bzrdir, revision_id=None, basis=None):
544
def clone(self, to_bzrdir, revision_id=None):
431
545
"""Duplicate this working tree into to_bzr, including all state.
433
547
Specifically modified files are kept as modified, but
493
593
__contains__ = has_id
495
595
def get_file_size(self, file_id):
596
file_id = osutils.safe_file_id(file_id)
496
597
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():
600
def get_file_sha1(self, file_id, path=None, stat_value=None):
601
file_id = osutils.safe_file_id(file_id)
603
path = self._inventory.id2path(file_id)
604
return self._hashcache.get_sha1(path, stat_value)
606
def get_file_mtime(self, file_id, path=None):
607
file_id = osutils.safe_file_id(file_id)
609
path = self.inventory.id2path(file_id)
610
return os.lstat(self.abspath(path)).st_mtime
612
if not supports_executable():
613
def is_executable(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
505
615
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
617
def is_executable(self, file_id, path=None):
619
file_id = osutils.safe_file_id(file_id)
620
path = self.id2path(file_id)
508
621
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.
622
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
@needs_tree_write_lock
625
def _add(self, files, ids, kinds):
626
"""See MutableTree._add."""
534
627
# TODO: Re-adding a file that is removed in the working copy
535
628
# 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))
629
# the read and write working inventory should not occur in this
630
# function - they should be part of lock_write and unlock.
632
for f, file_id, kind in zip(files, ids, kinds):
633
assert kind is not None
571
634
if file_id is None:
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
635
inv.add_path(f, kind=kind)
637
file_id = osutils.safe_file_id(file_id)
638
inv.add_path(f, kind=kind, file_id=file_id)
639
self._inventory_is_modified = True
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
self._write_inventory(inv)
641
@needs_tree_write_lock
642
def _gather_kinds(self, files, kinds):
643
"""See MutableTree._gather_kinds."""
644
for pos, f in enumerate(files):
645
if kinds[pos] is None:
646
fullpath = normpath(self.abspath(f))
648
kinds[pos] = file_kind(fullpath)
650
if e.errno == errno.ENOENT:
651
raise errors.NoSuchFile(fullpath)
578
653
@needs_write_lock
654
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
655
"""Add revision_id as a parent.
657
This is equivalent to retrieving the current list of parent ids
658
and setting the list to its value plus revision_id.
660
:param revision_id: The revision id to add to the parent list. It may
661
be a ghost revision as long as its not the first parent to be added,
662
or the allow_leftmost_as_ghost parameter is set True.
663
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
665
parents = self.get_parent_ids() + [revision_id]
666
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
667
or allow_leftmost_as_ghost)
669
@needs_tree_write_lock
670
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
671
"""Add revision_id, tree tuple as a parent.
673
This is equivalent to retrieving the current list of parent trees
674
and setting the list to its value plus parent_tuple. See also
675
add_parent_tree_id - if you only have a parent id available it will be
676
simpler to use that api. If you have the parent already available, using
677
this api is preferred.
679
:param parent_tuple: The (revision id, tree) to add to the parent list.
680
If the revision_id is a ghost, pass None for the tree.
681
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
683
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
684
if len(parent_ids) > 1:
685
# the leftmost may have already been a ghost, preserve that if it
687
allow_leftmost_as_ghost = True
688
self.set_parent_ids(parent_ids,
689
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
691
@needs_tree_write_lock
579
692
def add_pending_merge(self, *revision_ids):
580
693
# TODO: Perhaps should check at this point that the
581
694
# history of the revision is actually present?
582
p = self.pending_merges()
695
parents = self.get_parent_ids()
584
697
for rev_id in revision_ids:
698
if rev_id in parents:
700
parents.append(rev_id)
590
self.set_pending_merges(p)
703
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
705
@deprecated_method(zero_eleven)
593
707
def pending_merges(self):
594
708
"""Return a list of pending merges.
596
710
These are revisions that have been merged into the working
597
711
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'))
713
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
714
instead - which is available on all tree objects.
716
return self.get_parent_ids()[1:]
718
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
719
"""Common ghost checking functionality from set_parent_*.
721
This checks that the left hand-parent exists if there are any
724
if len(revision_ids) > 0:
725
leftmost_id = revision_ids[0]
726
if (not allow_leftmost_as_ghost and not
727
self.branch.repository.has_revision(leftmost_id)):
728
raise errors.GhostRevisionUnusableHere(leftmost_id)
730
def _set_merges_from_parent_ids(self, parent_ids):
731
merges = parent_ids[1:]
732
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
734
@needs_tree_write_lock
735
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
736
"""Set the parent ids to revision_ids.
738
See also set_parent_trees. This api will try to retrieve the tree data
739
for each element of revision_ids from the trees repository. If you have
740
tree data already available, it is more efficient to use
741
set_parent_trees rather than set_parent_ids. set_parent_ids is however
742
an easier API to use.
744
:param revision_ids: The revision_ids to set as the parent ids of this
745
working tree. Any of these may be ghosts.
747
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
748
self._check_parents_for_ghosts(revision_ids,
749
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
750
for revision_id in revision_ids:
751
_mod_revision.check_not_reserved_id(revision_id)
753
if len(revision_ids) > 0:
754
self.set_last_revision(revision_ids[0])
756
self.set_last_revision(_mod_revision.NULL_REVISION)
758
self._set_merges_from_parent_ids(revision_ids)
760
@needs_tree_write_lock
761
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
762
"""See MutableTree.set_parent_trees."""
763
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
764
for revision_id in parent_ids:
765
_mod_revision.check_not_reserved_id(revision_id)
767
self._check_parents_for_ghosts(parent_ids,
768
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
770
if len(parent_ids) == 0:
771
leftmost_parent_id = _mod_revision.NULL_REVISION
772
leftmost_parent_tree = None
774
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
776
if self._change_last_revision(leftmost_parent_id):
777
if leftmost_parent_tree is None:
778
# If we don't have a tree, fall back to reading the
779
# parent tree from the repository.
780
self._cache_basis_inventory(leftmost_parent_id)
782
inv = leftmost_parent_tree.inventory
783
xml = self._create_basis_xml_from_inventory(
784
leftmost_parent_id, inv)
785
self._write_basis_inventory(xml)
786
self._set_merges_from_parent_ids(parent_ids)
788
@needs_tree_write_lock
611
789
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
790
parents = self.get_parent_ids()
791
leftmost = parents[:1]
792
new_parents = leftmost + rev_list
793
self.set_parent_ids(new_parents)
795
@needs_tree_write_lock
615
796
def set_merge_modified(self, modified_hashes):
616
797
def iter_stanzas():
617
798
for file_id, hash in modified_hashes.iteritems():
618
yield Stanza(file_id=file_id, hash=hash)
799
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
619
800
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
622
802
def _put_rio(self, filename, stanzas, header):
803
self._must_be_locked()
623
804
my_file = rio_file(stanzas, header)
624
805
self._control_files.put(filename, my_file)
807
@needs_write_lock # because merge pulls data into the branch.
808
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
810
"""Merge from a branch into this working tree.
812
:param branch: The branch to merge from.
813
:param to_revision: If non-None, the merge will merge to to_revision,
814
but not beyond it. to_revision does not need to be in the history
815
of the branch when it is supplied. If None, to_revision defaults to
816
branch.last_revision().
818
from bzrlib.merge import Merger, Merge3Merger
819
pb = bzrlib.ui.ui_factory.nested_progress_bar()
821
merger = Merger(self.branch, this_tree=self, pb=pb)
822
merger.pp = ProgressPhase("Merge phase", 5, pb)
823
merger.pp.next_phase()
824
# check that there are no
826
merger.check_basis(check_clean=True, require_commits=False)
827
if to_revision is None:
828
to_revision = _mod_revision.ensure_null(branch.last_revision())
830
to_revision = osutils.safe_revision_id(to_revision)
831
merger.other_rev_id = to_revision
832
if _mod_revision.is_null(merger.other_rev_id):
833
raise errors.NoCommits(branch)
834
self.branch.fetch(branch, last_revision=merger.other_rev_id)
835
merger.other_basis = merger.other_rev_id
836
merger.other_tree = self.branch.repository.revision_tree(
838
merger.other_branch = branch
839
merger.pp.next_phase()
840
if from_revision is None:
843
merger.set_base_revision(from_revision, branch)
844
if merger.base_rev_id == merger.other_rev_id:
845
raise errors.PointlessMerge
846
merger.backup_files = False
847
if merge_type is None:
848
merger.merge_type = Merge3Merger
850
merger.merge_type = merge_type
851
merger.set_interesting_files(None)
852
merger.show_base = False
853
merger.reprocess = False
854
conflicts = merger.do_merge()
627
861
def merge_modified(self):
862
"""Return a dictionary of files modified by a merge.
864
The list is initialized by WorkingTree.set_merge_modified, which is
865
typically called after we make some automatic updates to the tree
868
This returns a map of file_id->sha1, containing only files which are
869
still in the working inventory and have that text hash.
629
872
hashfile = self._control_files.get('merge-hashes')
873
except errors.NoSuchFile:
632
875
merge_hashes = {}
634
877
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
raise MergeModifiedFormatError()
878
raise errors.MergeModifiedFormatError()
636
879
except StopIteration:
637
raise MergeModifiedFormatError()
880
raise errors.MergeModifiedFormatError()
638
881
for s in RioReader(hashfile):
639
file_id = s.get("file_id")
882
# RioReader reads in Unicode, so convert file_ids back to utf8
883
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
640
884
if file_id not in self.inventory:
643
if hash == self.get_file_sha1(file_id):
644
merge_hashes[file_id] = hash
886
text_hash = s.get("hash")
887
if text_hash == self.get_file_sha1(file_id):
888
merge_hashes[file_id] = text_hash
645
889
return merge_hashes
892
def mkdir(self, path, file_id=None):
893
"""See MutableTree.mkdir()."""
895
file_id = generate_ids.gen_file_id(os.path.basename(path))
896
os.mkdir(self.abspath(path))
897
self.add(path, file_id, 'directory')
647
900
def get_symlink_target(self, file_id):
901
file_id = osutils.safe_file_id(file_id)
648
902
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).
905
def subsume(self, other_tree):
906
def add_children(inventory, entry):
907
for child_entry in entry.children.values():
908
inventory._byid[child_entry.file_id] = child_entry
909
if child_entry.kind == 'directory':
910
add_children(inventory, child_entry)
911
if other_tree.get_root_id() == self.get_root_id():
912
raise errors.BadSubsumeSource(self, other_tree,
913
'Trees have the same root')
915
other_tree_path = self.relpath(other_tree.basedir)
916
except errors.PathNotChild:
917
raise errors.BadSubsumeSource(self, other_tree,
918
'Tree is not contained by the other')
919
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
920
if new_root_parent is None:
921
raise errors.BadSubsumeSource(self, other_tree,
922
'Parent directory is not versioned.')
923
# We need to ensure that the result of a fetch will have a
924
# versionedfile for the other_tree root, and only fetching into
925
# RepositoryKnit2 guarantees that.
926
if not self.branch.repository.supports_rich_root():
927
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
928
other_tree.lock_tree_write()
930
new_parents = other_tree.get_parent_ids()
931
other_root = other_tree.inventory.root
932
other_root.parent_id = new_root_parent
933
other_root.name = osutils.basename(other_tree_path)
934
self.inventory.add(other_root)
935
add_children(self.inventory, other_root)
936
self._write_inventory(self.inventory)
937
# normally we don't want to fetch whole repositories, but i think
938
# here we really do want to consolidate the whole thing.
939
for parent_id in other_tree.get_parent_ids():
940
self.branch.fetch(other_tree.branch, parent_id)
941
self.add_parent_tree_id(parent_id)
944
other_tree.bzrdir.retire_bzrdir()
946
@needs_tree_write_lock
947
def extract(self, file_id, format=None):
948
"""Extract a subtree from this tree.
950
A new branch will be created, relative to the path for this tree.
954
segments = osutils.splitpath(path)
955
transport = self.branch.bzrdir.root_transport
956
for name in segments:
957
transport = transport.clone(name)
958
transport.ensure_base()
961
sub_path = self.id2path(file_id)
962
branch_transport = mkdirs(sub_path)
964
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
965
branch_transport.ensure_base()
966
branch_bzrdir = format.initialize_on_transport(branch_transport)
968
repo = branch_bzrdir.find_repository()
969
except errors.NoRepositoryPresent:
970
repo = branch_bzrdir.create_repository()
971
assert repo.supports_rich_root()
973
if not repo.supports_rich_root():
974
raise errors.RootNotRich()
975
new_branch = branch_bzrdir.create_branch()
976
new_branch.pull(self.branch)
977
for parent_id in self.get_parent_ids():
978
new_branch.fetch(self.branch, parent_id)
979
tree_transport = self.bzrdir.root_transport.clone(sub_path)
980
if tree_transport.base != branch_transport.base:
981
tree_bzrdir = format.initialize_on_transport(tree_transport)
982
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
984
tree_bzrdir = branch_bzrdir
985
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
986
wt.set_parent_ids(self.get_parent_ids())
987
my_inv = self.inventory
988
child_inv = Inventory(root_id=None)
989
new_root = my_inv[file_id]
990
my_inv.remove_recursive_id(file_id)
991
new_root.parent_id = None
992
child_inv.add(new_root)
993
self._write_inventory(my_inv)
994
wt._write_inventory(child_inv)
997
def _serialize(self, inventory, out_file):
998
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1001
def _deserialize(selt, in_file):
1002
return xml5.serializer_v5.read_inventory(in_file)
1005
"""Write the in memory inventory to disk."""
1006
# TODO: Maybe this should only write on dirty ?
1007
if self._control_files._lock_mode != 'w':
1008
raise errors.NotWriteLocked(self)
1010
self._serialize(self._inventory, sio)
1012
self._control_files.put('inventory', sio)
1013
self._inventory_is_modified = False
1015
def _kind(self, relpath):
1016
return osutils.file_kind(self.abspath(relpath))
1018
def list_files(self, include_root=False):
1019
"""Recursively list all files as (path, class, kind, id, entry).
661
1021
Lists, but does not descend into unversioned directories.
666
1026
Skips the control directory.
668
inv = self._inventory
670
def descend(from_dir_relpath, from_dir_id, dp):
1028
# list_files is an iterator, so @needs_read_lock doesn't work properly
1029
# with it. So callers should be careful to always read_lock the tree.
1030
if not self.is_locked():
1031
raise errors.ObjectNotLocked(self)
1033
inv = self.inventory
1034
if include_root is True:
1035
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1036
# Convert these into local objects to save lookup times
1037
pathjoin = osutils.pathjoin
1038
file_kind = self._kind
1040
# transport.base ends in a slash, we want the piece
1041
# between the last two slashes
1042
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1044
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1046
# directory file_id, relative path, absolute path, reverse sorted children
1047
children = os.listdir(self.basedir)
1049
# jam 20060527 The kernel sized tree seems equivalent whether we
1050
# use a deque and popleft to keep them sorted, or if we use a plain
1051
# list and just reverse() them.
1052
children = collections.deque(children)
1053
stack = [(inv.root.file_id, u'', self.basedir, children)]
1055
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1058
f = children.popleft()
674
1059
## TODO: If we find a subdirectory with its own .bzr
675
1060
## directory, then that is a separate tree and we
676
1061
## should exclude it.
678
1063
# the bzrdir for this tree
679
if self.bzrdir.transport.base.endswith(f + '/'):
1064
if transport_base_dir == f:
683
fp = appendpath(from_dir_relpath, f)
1067
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1068
# and 'f' doesn't begin with one, we can do a string op, rather
1069
# than the checks of pathjoin(), all relative paths will have an extra slash
1071
fp = from_dir_relpath + '/' + f
686
fap = appendpath(dp, f)
1074
fap = from_dir_abspath + '/' + f
688
1076
f_ie = inv.get_child(from_dir_id, f)
691
elif self.is_ignored(fp):
1079
elif self.is_ignored(fp[1:]):
1082
# we may not have found this file, because of a unicode issue
1083
f_norm, can_access = osutils.normalized_filename(f)
1084
if f == f_norm or not can_access:
1085
# No change, so treat this file normally
1088
# this file can be accessed by a normalized path
1089
# check again if it is versioned
1090
# these lines are repeated here for performance
1092
fp = from_dir_relpath + '/' + f
1093
fap = from_dir_abspath + '/' + f
1094
f_ie = inv.get_child(from_dir_id, f)
1097
elif self.is_ignored(fp[1:]):
696
1102
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
1104
# make a last minute entry
1106
yield fp[1:], c, fk, f_ie.file_id, f_ie
708
if fk == 'directory':
709
entry = TreeDirectory()
712
elif fk == 'symlink':
1109
yield fp[1:], c, fk, None, fk_entries[fk]()
1111
yield fp[1:], c, fk, None, TreeEntry()
717
yield fp, c, fk, (f_ie and f_ie.file_id), entry
719
1114
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):
1117
# But do this child first
1118
new_children = os.listdir(fap)
1120
new_children = collections.deque(new_children)
1121
stack.append((f_ie.file_id, fp, fap, new_children))
1122
# Break out of inner loop,
1123
# so that we start outer loop with child
1126
# if we finished all children, pop it off the stack
1129
@needs_tree_write_lock
1130
def move(self, from_paths, to_dir=None, after=False, **kwargs):
734
1131
"""Rename files.
736
to_name must exist in the inventory.
1133
to_dir must exist in the inventory.
738
If to_name exists and is a directory, the files are moved into
1135
If to_dir exists and is a directory, the files are moved into
739
1136
it, keeping their old names.
741
Note that to_name is only the last component of the new name;
1138
Note that to_dir is only the last component of the new name;
742
1139
this doesn't change the directory.
1141
For each entry in from_paths the move mode will be determined
1144
The first mode moves the file in the filesystem and updates the
1145
inventory. The second mode only updates the inventory without
1146
touching the file on the filesystem. This is the new mode introduced
1149
move uses the second mode if 'after == True' and the target is not
1150
versioned but present in the working tree.
1152
move uses the second mode if 'after == False' and the source is
1153
versioned but no longer in the working tree, and the target is not
1154
versioned but present in the working tree.
1156
move uses the first mode if 'after == False' and the source is
1157
versioned and present in the working tree, and the target is not
1158
versioned and not present in the working tree.
1160
Everything else results in an error.
744
1162
This returns a list of (from_path, to_path) pairs for each
745
1163
entry that is moved.
748
## TODO: Option to move IDs only
1168
# check for deprecated use of signature
1170
to_dir = kwargs.get('to_name', None)
1172
raise TypeError('You must supply a target directory')
1174
symbol_versioning.warn('The parameter to_name was deprecated'
1175
' in version 0.13. Use to_dir instead',
1178
# check destination directory
749
1179
assert not isinstance(from_paths, basestring)
750
1180
inv = self.inventory
751
to_abs = self.abspath(to_name)
1181
to_abs = self.abspath(to_dir)
752
1182
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)
1183
raise errors.BzrMoveFailedError('',to_dir,
1184
errors.NotADirectory(to_abs))
1185
if not self.has_filename(to_dir):
1186
raise errors.BzrMoveFailedError('',to_dir,
1187
errors.NotInWorkingDirectory(to_dir))
1188
to_dir_id = inv.path2id(to_dir)
1189
if to_dir_id is None:
1190
raise errors.BzrMoveFailedError('',to_dir,
1191
errors.NotVersionedError(path=str(to_dir)))
759
1193
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)
1194
if to_dir_ie.kind != 'directory':
1195
raise errors.BzrMoveFailedError('',to_dir,
1196
errors.NotADirectory(to_abs))
1198
# create rename entries and tuples
1199
for from_rel in from_paths:
1200
from_tail = splitpath(from_rel)[-1]
1201
from_id = inv.path2id(from_rel)
1203
raise errors.BzrMoveFailedError(from_rel,to_dir,
1204
errors.NotVersionedError(path=str(from_rel)))
1206
from_entry = inv[from_id]
1207
from_parent_id = from_entry.parent_id
1208
to_rel = pathjoin(to_dir, from_tail)
1209
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1211
from_tail=from_tail,
1212
from_parent_id=from_parent_id,
1213
to_rel=to_rel, to_tail=from_tail,
1214
to_parent_id=to_dir_id)
1215
rename_entries.append(rename_entry)
1216
rename_tuples.append((from_rel, to_rel))
1218
# determine which move mode to use. checks also for movability
1219
rename_entries = self._determine_mv_mode(rename_entries, after)
1221
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"])
1224
self._inventory_is_modified = True
1225
self._move(rename_entries)
795
1227
# restore the inventory on error
796
self._set_inventory(orig_inv)
1228
self._inventory_is_modified = original_modified
798
1230
self._write_inventory(inv)
802
def rename_one(self, from_rel, to_rel):
1231
return rename_tuples
1233
def _determine_mv_mode(self, rename_entries, after=False):
1234
"""Determines for each from-to pair if both inventory and working tree
1235
or only the inventory has to be changed.
1237
Also does basic plausability tests.
1239
inv = self.inventory
1241
for rename_entry in rename_entries:
1242
# store to local variables for easier reference
1243
from_rel = rename_entry.from_rel
1244
from_id = rename_entry.from_id
1245
to_rel = rename_entry.to_rel
1246
to_id = inv.path2id(to_rel)
1247
only_change_inv = False
1249
# check the inventory for source and destination
1251
raise errors.BzrMoveFailedError(from_rel,to_rel,
1252
errors.NotVersionedError(path=str(from_rel)))
1253
if to_id is not None:
1254
raise errors.BzrMoveFailedError(from_rel,to_rel,
1255
errors.AlreadyVersionedError(path=str(to_rel)))
1257
# try to determine the mode for rename (only change inv or change
1258
# inv and file system)
1260
if not self.has_filename(to_rel):
1261
raise errors.BzrMoveFailedError(from_id,to_rel,
1262
errors.NoSuchFile(path=str(to_rel),
1263
extra="New file has not been created yet"))
1264
only_change_inv = True
1265
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1266
only_change_inv = True
1267
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1268
only_change_inv = False
1270
# something is wrong, so lets determine what exactly
1271
if not self.has_filename(from_rel) and \
1272
not self.has_filename(to_rel):
1273
raise errors.BzrRenameFailedError(from_rel,to_rel,
1274
errors.PathsDoNotExist(paths=(str(from_rel),
1277
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1278
extra="(Use --after to update the Bazaar id)")
1279
rename_entry.only_change_inv = only_change_inv
1280
return rename_entries
1282
def _move(self, rename_entries):
1283
"""Moves a list of files.
1285
Depending on the value of the flag 'only_change_inv', the
1286
file will be moved on the file system or not.
1288
inv = self.inventory
1291
for entry in rename_entries:
1293
self._move_entry(entry)
1295
self._rollback_move(moved)
1299
def _rollback_move(self, moved):
1300
"""Try to rollback a previous move in case of an filesystem error."""
1301
inv = self.inventory
1304
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1305
entry.to_tail, entry.to_parent_id, entry.from_rel,
1306
entry.from_tail, entry.from_parent_id,
1307
entry.only_change_inv))
1308
except errors.BzrMoveFailedError, e:
1309
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1310
" The working tree is in an inconsistent state."
1311
" Please consider doing a 'bzr revert'."
1312
" Error message is: %s" % e)
1314
def _move_entry(self, entry):
1315
inv = self.inventory
1316
from_rel_abs = self.abspath(entry.from_rel)
1317
to_rel_abs = self.abspath(entry.to_rel)
1318
if from_rel_abs == to_rel_abs:
1319
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1320
"Source and target are identical.")
1322
if not entry.only_change_inv:
1324
osutils.rename(from_rel_abs, to_rel_abs)
1326
raise errors.BzrMoveFailedError(entry.from_rel,
1328
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1330
@needs_tree_write_lock
1331
def rename_one(self, from_rel, to_rel, after=False):
803
1332
"""Rename one file.
805
1334
This can change the directory or the filename or both.
1336
rename_one has several 'modes' to work. First, it can rename a physical
1337
file and change the file_id. That is the normal mode. Second, it can
1338
only change the file_id without touching any physical file. This is
1339
the new mode introduced in version 0.15.
1341
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1342
versioned but present in the working tree.
1344
rename_one uses the second mode if 'after == False' and 'from_rel' is
1345
versioned but no longer in the working tree, and 'to_rel' is not
1346
versioned but present in the working tree.
1348
rename_one uses the first mode if 'after == False' and 'from_rel' is
1349
versioned and present in the working tree, and 'to_rel' is not
1350
versioned and not present in the working tree.
1352
Everything else results in an error.
807
1354
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)
1357
# create rename entries and tuples
1358
from_tail = splitpath(from_rel)[-1]
1359
from_id = inv.path2id(from_rel)
1361
raise errors.BzrRenameFailedError(from_rel,to_rel,
1362
errors.NotVersionedError(path=str(from_rel)))
1363
from_entry = inv[from_id]
1364
from_parent_id = from_entry.parent_id
824
1365
to_dir, to_tail = os.path.split(to_rel)
825
1366
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"])
1367
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1369
from_tail=from_tail,
1370
from_parent_id=from_parent_id,
1371
to_rel=to_rel, to_tail=to_tail,
1372
to_parent_id=to_dir_id)
1373
rename_entries.append(rename_entry)
1375
# determine which move mode to use. checks also for movability
1376
rename_entries = self._determine_mv_mode(rename_entries, after)
1378
# check if the target changed directory and if the target directory is
1380
if to_dir_id is None:
1381
raise errors.BzrMoveFailedError(from_rel,to_rel,
1382
errors.NotVersionedError(path=str(to_dir)))
1384
# all checks done. now we can continue with our actual work
1385
mutter('rename_one:\n'
1390
' to_dir_id {%s}\n',
1391
from_id, from_rel, to_rel, to_dir, to_dir_id)
1393
self._move(rename_entries)
847
1394
self._write_inventory(inv)
1396
class _RenameEntry(object):
1397
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1398
to_rel, to_tail, to_parent_id, only_change_inv=False):
1399
self.from_rel = from_rel
1400
self.from_id = from_id
1401
self.from_tail = from_tail
1402
self.from_parent_id = from_parent_id
1403
self.to_rel = to_rel
1404
self.to_tail = to_tail
1405
self.to_parent_id = to_parent_id
1406
self.only_change_inv = only_change_inv
849
1408
@needs_read_lock
850
1409
def unknowns(self):
851
1410
"""Return all unknown files.
853
1412
These are files in the working directory that are not versioned or
854
1413
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):
1415
# force the extras method to be fully executed before returning, to
1416
# prevent race conditions with the lock
1418
[subp for subp in self.extras() if not self.is_ignored(subp)])
1420
@needs_tree_write_lock
1421
def unversion(self, file_ids):
1422
"""Remove the file ids in file_ids from the current versioned set.
1424
When a file_id is unversioned, all of its children are automatically
1427
:param file_ids: The file ids to stop versioning.
1428
:raises: NoSuchId if any fileid is not currently versioned.
1430
for file_id in file_ids:
1431
file_id = osutils.safe_file_id(file_id)
1432
if self._inventory.has_id(file_id):
1433
self._inventory.remove_recursive_id(file_id)
1435
raise errors.NoSuchId(self, file_id)
1437
# in the future this should just set a dirty bit to wait for the
1438
# final unlock. However, until all methods of workingtree start
1439
# with the current in -memory inventory rather than triggering
1440
# a read, it is more complex - we need to teach read_inventory
1441
# to know when to read, and when to not read first... and possibly
1442
# to save first when the in memory one may be corrupted.
1443
# so for now, we just only write it if it is indeed dirty.
1445
self._write_inventory(self._inventory)
873
1447
@deprecated_method(zero_eight)
874
1448
def iter_conflicts(self):
875
1449
"""List all files in the tree that have text or content conflicts.
1056
1710
This is used to allow WorkingTree3 instances to not affect branch
1057
1711
when their last revision is set.
1059
if new_revision is None:
1713
if _mod_revision.is_null(new_revision):
1060
1714
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])
1717
self.branch.generate_revision_history(new_revision)
1718
except errors.NoSuchRevision:
1719
# not present in the repo - dont try to set it deeper than the tip
1720
self.branch.set_revision_history([new_revision])
1723
def _write_basis_inventory(self, xml):
1724
"""Write the basis inventory XML to the basis-inventory file"""
1725
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1726
path = self._basis_inventory_name()
1728
self._control_files.put(path, sio)
1730
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1731
"""Create the text that will be saved in basis-inventory"""
1732
# TODO: jam 20070209 This should be redundant, as the revision_id
1733
# as all callers should have already converted the revision_id to
1735
inventory.revision_id = osutils.safe_revision_id(revision_id)
1736
return xml7.serializer_v7.write_inventory_to_string(inventory)
1071
1738
def _cache_basis_inventory(self, new_revision):
1072
1739
"""Cache new_revision as the basis inventory."""
1740
# TODO: this should allow the ready-to-use inventory to be passed in,
1741
# as commit already has that ready-to-use [while the format is the
1074
1744
# this double handles the inventory - unpack and repack -
1075
1745
# but is easier to understand. We can/should put a conditional
1076
1746
# in here based on whether the inventory is in the latest format
1077
1747
# - 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:
1749
# the fast path is to copy the raw xml from the repository. If the
1750
# xml contains 'revision_id="', then we assume the right
1751
# revision_id is set. We must check for this full string, because a
1752
# root node id can legitimately look like 'revision_id' but cannot
1754
xml = self.branch.repository.get_inventory_xml(new_revision)
1755
firstline = xml.split('\n', 1)[0]
1756
if (not 'revision_id="' in firstline or
1757
'format="7"' not in firstline):
1758
inv = self.branch.repository.deserialise_inventory(
1760
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1761
self._write_basis_inventory(xml)
1762
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1088
1765
def read_basis_inventory(self):
1089
1766
"""Read the cached basis inventory."""
1090
1767
path = self._basis_inventory_name()
1091
return self._control_files.get_utf8(path).read()
1768
return self._control_files.get(path).read()
1093
1770
@needs_read_lock
1094
1771
def read_working_inventory(self):
1095
"""Read the working inventory."""
1772
"""Read the working inventory.
1774
:raises errors.InventoryModified: read_working_inventory will fail
1775
when the current in memory inventory has been modified.
1777
# conceptually this should be an implementation detail of the tree.
1778
# XXX: Deprecate this.
1096
1779
# 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)
1781
if self._inventory_is_modified:
1782
raise errors.InventoryModified(self)
1783
result = self._deserialize(self._control_files.get('inventory'))
1784
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.
1787
@needs_tree_write_lock
1788
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1790
"""Remove nominated files from the working inventory.
1792
:files: File paths relative to the basedir.
1793
:keep_files: If true, the files will also be kept.
1794
:force: Delete files and directories, even if they are changed and
1795
even if the directories are not empty.
1118
## TODO: Normalize names
1119
## TODO: Remove nested loops; better scalability
1120
1797
if isinstance(files, basestring):
1121
1798
files = [files]
1123
inv = self.inventory
1125
# do this before any modifications
1803
unknown_nested_files=set()
1805
def recurse_directory_to_add_files(directory):
1806
# Recurse directory and add all files
1807
# so we can check if they have changed.
1808
for parent_info, file_infos in\
1809
osutils.walkdirs(self.abspath(directory),
1811
for relpath, basename, kind, lstat, abspath in file_infos:
1812
# Is it versioned or ignored?
1813
if self.path2id(relpath) or self.is_ignored(relpath):
1814
# Add nested content for deletion.
1815
new_files.add(relpath)
1817
# Files which are not versioned and not ignored
1818
# should be treated as unknown.
1819
unknown_nested_files.add((relpath, None, kind))
1821
for filename in files:
1822
# Get file name into canonical form.
1823
abspath = self.abspath(filename)
1824
filename = self.relpath(abspath)
1825
if len(filename) > 0:
1826
new_files.add(filename)
1827
if osutils.isdir(abspath):
1828
recurse_directory_to_add_files(filename)
1830
files = list(new_files)
1833
return # nothing to do
1835
# Sort needed to first handle directory content before the directory
1836
files.sort(reverse=True)
1838
# Bail out if we are going to delete files we shouldn't
1839
if not keep_files and not force:
1840
has_changed_files = len(unknown_nested_files) > 0
1841
if not has_changed_files:
1842
for (file_id, path, content_change, versioned, parent_id, name,
1843
kind, executable) in self._iter_changes(self.basis_tree(),
1844
include_unchanged=True, require_versioned=False,
1845
want_unversioned=True, specific_files=files):
1846
# Check if it's an unknown (but not ignored) OR
1847
# changed (but not deleted) :
1848
if not self.is_ignored(path[1]) and (
1849
versioned == (False, False) or
1850
content_change and kind[1] != None):
1851
has_changed_files = True
1854
if has_changed_files:
1855
# Make delta show ALL applicable changes in error message.
1856
tree_delta = self.changes_from(self.basis_tree(),
1857
require_versioned=False, want_unversioned=True,
1858
specific_files=files)
1859
for unknown_file in unknown_nested_files:
1860
if unknown_file not in tree_delta.unversioned:
1861
tree_delta.unversioned.extend((unknown_file,))
1862
raise errors.BzrRemoveChangedFilesError(tree_delta)
1864
# Build inv_delta and delete files where applicaple,
1865
# do this before any modifications to inventory.
1126
1866
for f in files:
1127
fid = inv.path2id(f)
1867
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
1870
message = "%s is not versioned." % (f,)
1873
# having removed it, it must be either ignored or unknown
1874
if self.is_ignored(f):
1878
textui.show_status(new_status, self.kind(fid), f,
1881
inv_delta.append((f, None, fid, None))
1882
message = "removed %s" % (f,)
1885
abs_path = self.abspath(f)
1886
if osutils.lexists(abs_path):
1887
if (osutils.isdir(abs_path) and
1888
len(os.listdir(abs_path)) > 0):
1890
osutils.rmtree(abs_path)
1892
message = "%s is not an empty directory "\
1893
"and won't be deleted." % (f,)
1895
osutils.delete_any(abs_path)
1896
message = "deleted %s" % (f,)
1897
elif message is not None:
1898
# Only care if we haven't done anything yet.
1899
message = "%s does not exist." % (f,)
1901
# Print only one message (if any) per file.
1902
if message is not None:
1904
self.apply_inventory_delta(inv_delta)
1906
@needs_tree_write_lock
1907
def revert(self, filenames=None, old_tree=None, backups=True,
1908
pb=DummyProgress(), report_changes=False):
1909
from bzrlib.conflicts import resolve
1912
symbol_versioning.warn('Using [] to revert all files is deprecated'
1913
' as of bzr 0.91. Please use None (the default) instead.',
1914
DeprecationWarning, stacklevel=2)
1149
1915
if old_tree is None:
1150
1916
old_tree = self.basis_tree()
1151
conflicts = revert(self, old_tree, filenames, backups, pb)
1152
if not len(filenames):
1153
self.set_pending_merges([])
1917
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1919
if filenames is None:
1920
self.set_parent_ids(self.get_parent_ids()[:1])
1156
1923
resolve(self, filenames, ignore_misses=True)
1157
1924
return conflicts
1926
def revision_tree(self, revision_id):
1927
"""See Tree.revision_tree.
1929
WorkingTree can supply revision_trees for the basis revision only
1930
because there is only one cached inventory in the bzr directory.
1932
if revision_id == self.last_revision():
1934
xml = self.read_basis_inventory()
1935
except errors.NoSuchFile:
1939
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1940
# dont use the repository revision_tree api because we want
1941
# to supply the inventory.
1942
if inv.revision_id == revision_id:
1943
return revisiontree.RevisionTree(self.branch.repository,
1945
except errors.BadInventoryFormat:
1947
# raise if there was no inventory, or if we read the wrong inventory.
1948
raise errors.NoSuchRevisionInTree(self, revision_id)
1159
1950
# XXX: This method should be deprecated in favour of taking in a proper
1160
1951
# new Inventory object.
1952
@needs_tree_write_lock
1162
1953
def set_inventory(self, new_inventory_list):
1163
1954
from bzrlib.inventory import (Inventory,
1164
1955
InventoryDirectory,
1204
2021
between multiple working trees, i.e. via shared storage, then we
1205
2022
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()
2024
raise NotImplementedError(self.unlock)
2026
def update(self, change_reporter=None, possible_transports=None):
1232
2027
"""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.
2029
This will update the branch if its bound too, which means we have
2030
multiple trees involved:
2032
- The new basis tree of the master.
2033
- The old basis tree of the branch.
2034
- The old basis tree of the working tree.
2035
- The current working tree state.
2037
Pathologically, all three may be different, and non-ancestors of each
2038
other. Conceptually we want to:
2040
- Preserve the wt.basis->wt.state changes
2041
- Transform the wt.basis to the new master basis.
2042
- Apply a merge of the old branch basis to get any 'local' changes from
2044
- Restore the wt.basis->wt.state changes.
1246
2046
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()
2047
- Merge current state -> basis tree of the master w.r.t. the old tree
2049
- Do a 'normal' merge of the old branch basis if it is relevant.
2051
if self.branch.get_master_branch(possible_transports) is not None:
2053
update_branch = True
2055
self.lock_tree_write()
2056
update_branch = False
2059
old_tip = self.branch.update(possible_transports)
2062
return self._update_tree(old_tip, change_reporter)
2066
@needs_tree_write_lock
2067
def _update_tree(self, old_tip=None, change_reporter=None):
2068
"""Update a tree to the master branch.
2070
:param old_tip: if supplied, the previous tip revision the branch,
2071
before it was changed to the master branch's tip.
2073
# here if old_tip is not None, it is the old tip of the branch before
2074
# it was updated from the master branch. This should become a pending
2075
# merge in the working tree to preserve the user existing work. we
2076
# cant set that until we update the working trees last revision to be
2077
# one from the new branch, because it will just get absorbed by the
2078
# parent de-duplication logic.
2080
# We MUST save it even if an error occurs, because otherwise the users
2081
# local work is unreferenced and will appear to have been lost.
2085
last_rev = self.get_parent_ids()[0]
2087
last_rev = _mod_revision.NULL_REVISION
2088
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2089
# merge tree state up to new branch tip.
2090
basis = self.basis_tree()
1259
2093
to_tree = self.branch.basis_tree()
1260
result += merge_inner(self.branch,
2094
if basis.inventory.root is None:
2095
self.set_root_id(to_tree.inventory.root.file_id)
2097
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()
2102
change_reporter=change_reporter)
2105
# TODO - dedup parents list with things merged by pull ?
2106
# reuse the tree we've updated to to set the basis:
2107
parent_trees = [(self.branch.last_revision(), to_tree)]
2108
merges = self.get_parent_ids()[1:]
2109
# Ideally we ask the tree for the trees here, that way the working
2110
# tree can decide whether to give us teh entire tree or give us a
2111
# lazy initialised tree. dirstate for instance will have the trees
2112
# in ram already, whereas a last-revision + basis-inventory tree
2113
# will not, but also does not need them when setting parents.
2114
for parent in merges:
2115
parent_trees.append(
2116
(parent, self.branch.repository.revision_tree(parent)))
2117
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2118
parent_trees.append(
2119
(old_tip, self.branch.repository.revision_tree(old_tip)))
2120
self.set_parent_trees(parent_trees)
2121
last_rev = parent_trees[0][0]
2123
# the working tree had the same last-revision as the master
2124
# branch did. We may still have pivot local work from the local
2125
# branch into old_tip:
2126
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2127
self.add_parent_tree_id(old_tip)
2128
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2129
and old_tip != last_rev):
2130
# our last revision was not the prior branch last revision
2131
# and we have converted that last revision to a pending merge.
2132
# base is somewhere between the branch tip now
2133
# and the now pending merge
2135
# Since we just modified the working tree and inventory, flush out
2136
# the current state, before we modify it again.
2137
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2138
# requires it only because TreeTransform directly munges the
2139
# inventory and calls tree._write_inventory(). Ultimately we
2140
# should be able to remove this extra flush.
2142
graph = self.branch.repository.get_graph()
2143
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2145
base_tree = self.branch.repository.revision_tree(base_rev_id)
2146
other_tree = self.branch.repository.revision_tree(old_tip)
2147
result += merge.merge_inner(
2152
change_reporter=change_reporter)
2155
def _write_hashcache_if_dirty(self):
2156
"""Write out the hashcache if it is dirty."""
2157
if self._hashcache.needs_write:
2159
self._hashcache.write()
2161
if e.errno not in (errno.EPERM, errno.EACCES):
2163
# TODO: jam 20061219 Should this be a warning? A single line
2164
# warning might be sufficient to let the user know what
2166
mutter('Could not write hashcache for %s\nError: %s',
2167
self._hashcache.cache_file_name(), e)
2169
@needs_tree_write_lock
1288
2170
def _write_inventory(self, inv):
1289
2171
"""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')
2172
self._set_inventory(inv, dirty=True)
1297
2175
def set_conflicts(self, arg):
1298
raise UnsupportedOperation(self.set_conflicts, self)
2176
raise errors.UnsupportedOperation(self.set_conflicts, self)
2178
def add_conflicts(self, arg):
2179
raise errors.UnsupportedOperation(self.add_conflicts, self)
1300
2181
@needs_read_lock
1301
2182
def conflicts(self):
1302
conflicts = ConflictList()
2183
conflicts = _mod_conflicts.ConflictList()
1303
2184
for conflicted in self._iter_conflicts():
1306
2187
if file_kind(self.abspath(conflicted)) != "file":
1309
if e.errno == errno.ENOENT:
2189
except errors.NoSuchFile:
1313
2191
if text is True:
1314
2192
for suffix in ('.THIS', '.OTHER'):
1316
2194
kind = file_kind(self.abspath(conflicted+suffix))
1318
if e.errno == errno.ENOENT:
2197
except errors.NoSuchFile:
1326
2201
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
conflicts.append(Conflict.factory(ctype, path=conflicted,
2202
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1328
2204
file_id=self.path2id(conflicted)))
1329
2205
return conflicts
2207
def walkdirs(self, prefix=""):
2208
"""Walk the directories of this tree.
2210
returns a generator which yields items in the form:
2211
((curren_directory_path, fileid),
2212
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2215
This API returns a generator, which is only valid during the current
2216
tree transaction - within a single lock_read or lock_write duration.
2218
If the tree is not locked, it may cause an error to be raised,
2219
depending on the tree implementation.
2221
disk_top = self.abspath(prefix)
2222
if disk_top.endswith('/'):
2223
disk_top = disk_top[:-1]
2224
top_strip_len = len(disk_top) + 1
2225
inventory_iterator = self._walkdirs(prefix)
2226
disk_iterator = osutils.walkdirs(disk_top, prefix)
2228
current_disk = disk_iterator.next()
2229
disk_finished = False
2231
if not (e.errno == errno.ENOENT or
2232
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2235
disk_finished = True
2237
current_inv = inventory_iterator.next()
2238
inv_finished = False
2239
except StopIteration:
2242
while not inv_finished or not disk_finished:
2243
if not disk_finished:
2244
# strip out .bzr dirs
2245
if current_disk[0][1][top_strip_len:] == '':
2246
# osutils.walkdirs can be made nicer -
2247
# yield the path-from-prefix rather than the pathjoined
2249
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2250
if current_disk[1][bzrdir_loc][0] == '.bzr':
2251
# we dont yield the contents of, or, .bzr itself.
2252
del current_disk[1][bzrdir_loc]
2254
# everything is unknown
2257
# everything is missing
2260
direction = cmp(current_inv[0][0], current_disk[0][0])
2262
# disk is before inventory - unknown
2263
dirblock = [(relpath, basename, kind, stat, None, None) for
2264
relpath, basename, kind, stat, top_path in current_disk[1]]
2265
yield (current_disk[0][0], None), dirblock
2267
current_disk = disk_iterator.next()
2268
except StopIteration:
2269
disk_finished = True
2271
# inventory is before disk - missing.
2272
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2273
for relpath, basename, dkind, stat, fileid, kind in
2275
yield (current_inv[0][0], current_inv[0][1]), dirblock
2277
current_inv = inventory_iterator.next()
2278
except StopIteration:
2281
# versioned present directory
2282
# merge the inventory and disk data together
2284
for relpath, subiterator in itertools.groupby(sorted(
2285
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2286
path_elements = list(subiterator)
2287
if len(path_elements) == 2:
2288
inv_row, disk_row = path_elements
2289
# versioned, present file
2290
dirblock.append((inv_row[0],
2291
inv_row[1], disk_row[2],
2292
disk_row[3], inv_row[4],
2294
elif len(path_elements[0]) == 5:
2296
dirblock.append((path_elements[0][0],
2297
path_elements[0][1], path_elements[0][2],
2298
path_elements[0][3], None, None))
2299
elif len(path_elements[0]) == 6:
2300
# versioned, absent file.
2301
dirblock.append((path_elements[0][0],
2302
path_elements[0][1], 'unknown', None,
2303
path_elements[0][4], path_elements[0][5]))
2305
raise NotImplementedError('unreachable code')
2306
yield current_inv[0], dirblock
2308
current_inv = inventory_iterator.next()
2309
except StopIteration:
2312
current_disk = disk_iterator.next()
2313
except StopIteration:
2314
disk_finished = True
2316
def _walkdirs(self, prefix=""):
2317
"""Walk the directories of this tree.
2319
:prefix: is used as the directrory to start with.
2320
returns a generator which yields items in the form:
2321
((curren_directory_path, fileid),
2322
[(file1_path, file1_name, file1_kind, None, file1_id,
2325
_directory = 'directory'
2326
# get the root in the inventory
2327
inv = self.inventory
2328
top_id = inv.path2id(prefix)
2332
pending = [(prefix, '', _directory, None, top_id, None)]
2335
currentdir = pending.pop()
2336
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2337
top_id = currentdir[4]
2339
relroot = currentdir[0] + '/'
2342
# FIXME: stash the node in pending
2344
for name, child in entry.sorted_children():
2345
dirblock.append((relroot + name, name, child.kind, None,
2346
child.file_id, child.kind
2348
yield (currentdir[0], entry.file_id), dirblock
2349
# push the user specified dirs from dirblock
2350
for dir in reversed(dirblock):
2351
if dir[2] == _directory:
2354
@needs_tree_write_lock
2355
def auto_resolve(self):
2356
"""Automatically resolve text conflicts according to contents.
2358
Only text conflicts are auto_resolvable. Files with no conflict markers
2359
are considered 'resolved', because bzr always puts conflict markers
2360
into files that have text conflicts. The corresponding .THIS .BASE and
2361
.OTHER files are deleted, as per 'resolve'.
2362
:return: a tuple of ConflictLists: (un_resolved, resolved).
2364
un_resolved = _mod_conflicts.ConflictList()
2365
resolved = _mod_conflicts.ConflictList()
2366
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2367
for conflict in self.conflicts():
2368
if (conflict.typestring != 'text conflict' or
2369
self.kind(conflict.file_id) != 'file'):
2370
un_resolved.append(conflict)
2372
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2374
for line in my_file:
2375
if conflict_re.search(line):
2376
un_resolved.append(conflict)
2379
resolved.append(conflict)
2382
resolved.remove_files(self)
2383
self.set_conflicts(un_resolved)
2384
return un_resolved, resolved
2386
def _validate(self):
2387
"""Validate internal structures.
2389
This is meant mostly for the test suite. To give it a chance to detect
2390
corruption after actions have occurred. The default implementation is a
2393
:return: None. An exception should be raised if there is an error.
2398
class WorkingTree2(WorkingTree):
2399
"""This is the Format 2 working tree.
2401
This was the first weave based working tree.
2402
- uses os locks for locking.
2403
- uses the branch last-revision.
2406
def __init__(self, *args, **kwargs):
2407
super(WorkingTree2, self).__init__(*args, **kwargs)
2408
# WorkingTree2 has more of a constraint that self._inventory must
2409
# exist. Because this is an older format, we don't mind the overhead
2410
# caused by the extra computation here.
2412
# Newer WorkingTree's should only have self._inventory set when they
2414
if self._inventory is None:
2415
self.read_working_inventory()
2417
def lock_tree_write(self):
2418
"""See WorkingTree.lock_tree_write().
2420
In Format2 WorkingTrees we have a single lock for the branch and tree
2421
so lock_tree_write() degrades to lock_write().
2423
self.branch.lock_write()
2425
return self._control_files.lock_write()
2427
self.branch.unlock()
2431
# do non-implementation specific cleanup
2434
# we share control files:
2435
if self._control_files._lock_count == 3:
2436
# _inventory_is_modified is always False during a read lock.
2437
if self._inventory_is_modified:
2439
self._write_hashcache_if_dirty()
2441
# reverse order of locking.
2443
return self._control_files.unlock()
2445
self.branch.unlock()
1332
2448
class WorkingTree3(WorkingTree):
1333
2449
"""This is the Format 3 working tree.