29
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
33
39
from cStringIO import StringIO
37
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
39
44
from bisect import bisect_left
46
from copy import deepcopy
48
55
from bzrlib import (
51
58
conflicts as _mod_conflicts,
60
revision as _mod_revision,
69
76
import bzrlib.branch
70
77
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
79
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
82
from bzrlib import symbol_versioning
79
83
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
85
from bzrlib.lockable_files import LockableFiles, TransportLock
82
86
from bzrlib.lockdir import LockDir
83
87
import bzrlib.mutabletree
84
88
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
89
from bzrlib.osutils import (
94
99
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
101
from bzrlib.trace import mutter, note
98
102
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
103
from bzrlib.progress import DummyProgress, ProgressPhase
104
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
105
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
106
from bzrlib.symbol_versioning import (deprecated_passed,
109
DEPRECATED_PARAMETER,
107
116
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
117
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
120
@deprecated_function(zero_thirteen)
121
def gen_file_id(name):
122
"""Return new file id for the basename 'name'.
124
Use bzrlib.generate_ids.gen_file_id() instead
126
return generate_ids.gen_file_id(name)
129
@deprecated_function(zero_thirteen)
131
"""Return a new tree-root file id.
133
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
135
return generate_ids.gen_root_id()
116
138
class TreeEntry(object):
117
139
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
141
This needs further inspection, it may be better to have
120
142
InventoryEntries without ids - though that seems wrong. For now,
121
143
this is a parallel hierarchy to InventoryEntry, and needs to become
122
144
one of several things: decorates to that hierarchy, children of, or
193
"""Construct a WorkingTree instance. This is not a public API.
210
"""Construct a WorkingTree for basedir.
195
:param branch: A branch to override probing for the branch.
212
If the branch is not supplied, it is opened automatically.
213
If the branch is supplied, it must be the branch for this basedir.
214
(branch.base is not cross checked, because for remote branches that
215
would be meaningless).
197
217
self._format = _format
198
218
self.bzrdir = _bzrdir
199
219
if not _internal:
200
raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
"WorkingTree.open() to obtain a WorkingTree.")
220
# not created via open etc.
221
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
"Please use bzrdir.open_workingtree or WorkingTree.open().",
225
wt = WorkingTree.open(basedir)
226
self._branch = wt.branch
227
self.basedir = wt.basedir
228
self._control_files = wt._control_files
229
self._hashcache = wt._hashcache
230
self._set_inventory(wt._inventory, dirty=False)
231
self._format = wt._format
232
self.bzrdir = wt.bzrdir
233
assert isinstance(basedir, basestring), \
234
"base directory %r is not a string" % basedir
202
235
basedir = safe_unicode(basedir)
203
236
mutter("opening working tree %r", basedir)
204
237
if deprecated_passed(branch):
239
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
240
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
241
" WorkingTree.open().",
205
245
self._branch = branch
207
247
self._branch = self.bzrdir.open_branch()
423
404
# at this point ?
425
406
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
407
except errors.RevisionNotPresent:
427
408
# the basis tree *may* be a ghost or a low level error may have
428
# occurred. If the revision is present, its a problem, if its not
409
# occured. If the revision is present, its a problem, if its not
430
411
if self.branch.repository.has_revision(revision_id):
432
413
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
437
self._flush_ignore_list_cache()
414
return self.branch.repository.revision_tree(None)
417
@deprecated_method(zero_eight)
418
def create(branch, directory):
419
"""Create a workingtree for branch at directory.
421
If existing_directory already exists it must have a .bzr directory.
422
If it does not exist, it will be created.
424
This returns a new WorkingTree object for the new checkout.
426
TODO FIXME RBC 20060124 when we have checkout formats in place this
427
should accept an optional revisionid to checkout [and reject this if
428
checking out into the same dir as a pre-checkout-aware branch format.]
430
XXX: When BzrDir is present, these should be created through that
433
warnings.warn('delete WorkingTree.create', stacklevel=3)
434
transport = get_transport(directory)
435
if branch.bzrdir.root_transport.base == transport.base:
437
return branch.bzrdir.create_workingtree()
438
# different directory,
439
# create a branch reference
440
# and now a working tree.
441
raise NotImplementedError
444
@deprecated_method(zero_eight)
445
def create_standalone(directory):
446
"""Create a checkout and a branch and a repo at directory.
448
Directory must exist and be empty.
450
please use BzrDir.create_standalone_workingtree
452
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
454
def relpath(self, path):
440
455
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
457
The path may be absolute or relative. If its a relative path it is
443
458
interpreted relative to the python current working directory.
445
460
return osutils.relpath(self.basedir, path)
447
462
def has_filename(self, filename):
448
463
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
459
stat_value = _fstat(file_obj.fileno())
460
if filtered and self.supports_content_filtering():
461
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
463
return (file_obj, stat_value)
465
def get_file_text(self, file_id, path=None, filtered=True):
466
my_file = self.get_file(file_id, path=path, filtered=filtered)
468
return my_file.read()
472
def get_file_byname(self, filename, filtered=True):
473
path = self.abspath(filename)
475
if filtered and self.supports_content_filtering():
476
filters = self._content_filter_stack(filename)
477
return filtered_input_file(f, filters)
481
def get_file_lines(self, file_id, path=None, filtered=True):
482
"""See Tree.get_file_lines()"""
483
file = self.get_file(file_id, path, filtered=filtered)
485
return file.readlines()
465
def get_file(self, file_id):
466
file_id = osutils.safe_file_id(file_id)
467
return self.get_file_byname(self.id2path(file_id))
469
def get_file_text(self, file_id):
470
file_id = osutils.safe_file_id(file_id)
471
return self.get_file(file_id).read()
473
def get_file_byname(self, filename):
474
return file(self.abspath(filename), 'rb')
490
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
477
def annotate_iter(self, file_id):
491
478
"""See Tree.annotate_iter
493
480
This implementation will use the basis tree implementation if possible.
497
484
incorrectly attributed to CURRENT_REVISION (but after committing, the
498
485
attribution will be correct).
500
maybe_file_parent_keys = []
501
for parent_id in self.get_parent_ids():
503
parent_tree = self.revision_tree(parent_id)
504
except errors.NoSuchRevisionInTree:
505
parent_tree = self.branch.repository.revision_tree(parent_id)
506
parent_tree.lock_read()
508
if file_id not in parent_tree:
510
ie = parent_tree.inventory[file_id]
511
if ie.kind != 'file':
512
# Note: this is slightly unnecessary, because symlinks and
513
# directories have a "text" which is the empty text, and we
514
# know that won't mess up annotations. But it seems cleaner
516
parent_text_key = (file_id, ie.revision)
517
if parent_text_key not in maybe_file_parent_keys:
518
maybe_file_parent_keys.append(parent_text_key)
521
graph = _mod_graph.Graph(self.branch.repository.texts)
522
heads = graph.heads(maybe_file_parent_keys)
523
file_parent_keys = []
524
for key in maybe_file_parent_keys:
526
file_parent_keys.append(key)
528
# Now we have the parents of this content
529
annotator = self.branch.repository.texts.get_annotator()
530
text = self.get_file_text(file_id)
531
this_key =(file_id, default_revision)
532
annotator.add_special_text(this_key, file_parent_keys, text)
533
annotations = [(key[-1], line)
534
for key, line in annotator.annotate_flat(this_key)]
537
def _get_ancestors(self, default_revision):
538
ancestors = set([default_revision])
539
for parent_id in self.get_parent_ids():
540
ancestors.update(self.branch.repository.get_ancestry(
541
parent_id, topo_sorted=False))
487
file_id = osutils.safe_file_id(file_id)
488
basis = self.basis_tree()
489
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
490
require_versioned=True).next()
491
changed_content, kind = changes[2], changes[6]
492
if not changed_content:
493
return basis.annotate_iter(file_id)
497
if kind[0] != 'file':
500
old_lines = list(basis.annotate_iter(file_id))
502
for tree in self.branch.repository.revision_trees(
503
self.get_parent_ids()[1:]):
504
if file_id not in tree:
506
old.append(list(tree.annotate_iter(file_id)))
507
return annotate.reannotate(old, self.get_file(file_id).readlines(),
544
510
def get_parent_ids(self):
545
511
"""See Tree.get_parent_ids.
547
513
This implementation reads the pending merges list and last_revision
548
514
value and uses that to decide what the parents list should be.
550
last_rev = _mod_revision.ensure_null(self._last_revision())
551
if _mod_revision.NULL_REVISION == last_rev:
516
last_rev = self._last_revision()
554
520
parents = [last_rev]
556
merges_bytes = self._transport.get_bytes('pending-merges')
522
merges_file = self._control_files.get('pending-merges')
557
523
except errors.NoSuchFile:
560
for l in osutils.split_lines(merges_bytes):
561
revision_id = l.rstrip('\n')
526
for l in merges_file.readlines():
527
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
562
528
parents.append(revision_id)
566
532
def get_root_id(self):
567
533
"""Return the id of this trees root"""
568
534
return self._inventory.root.file_id
570
536
def _get_store_filename(self, file_id):
571
537
## XXX: badly named; this is not in the store at all
538
file_id = osutils.safe_file_id(file_id)
572
539
return self.abspath(self.id2path(file_id))
575
def clone(self, to_bzrdir, revision_id=None):
542
def clone(self, to_bzrdir, revision_id=None, basis=None):
576
543
"""Duplicate this working tree into to_bzr, including all state.
578
545
Specifically modified files are kept as modified, but
579
546
ignored and unknown files are discarded.
581
548
If you want to make a new line of development, see bzrdir.sprout()
584
If not None, the cloned tree will have its last revision set to
585
revision, and difference between the source trees last revision
551
If not None, the cloned tree will have its last revision set to
552
revision, and and difference between the source trees last revision
586
553
and this one merged in.
556
If not None, a closer copy of a tree which may have some files in
557
common, and which file content should be preferentially copied from.
588
559
# assumes the target bzr dir format is compatible.
589
result = to_bzrdir.create_workingtree()
560
result = self._format.initialize(to_bzrdir)
590
561
self.copy_content_into(result, revision_id)
621
595
__contains__ = has_id
623
597
def get_file_size(self, file_id):
624
"""See Tree.get_file_size"""
625
# XXX: this returns the on-disk size; it should probably return the
628
return os.path.getsize(self.id2abspath(file_id))
630
if e.errno != errno.ENOENT:
598
file_id = osutils.safe_file_id(file_id)
599
return os.path.getsize(self.id2abspath(file_id))
636
602
def get_file_sha1(self, file_id, path=None, stat_value=None):
603
file_id = osutils.safe_file_id(file_id)
638
605
path = self._inventory.id2path(file_id)
639
606
return self._hashcache.get_sha1(path, stat_value)
641
608
def get_file_mtime(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
643
611
path = self.inventory.id2path(file_id)
644
612
return os.lstat(self.abspath(path)).st_mtime
646
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
647
file_id = self.path2id(path)
649
# For unversioned files on win32, we just assume they are not
652
return self._inventory[file_id].executable
654
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
655
mode = stat_result.st_mode
656
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
658
614
if not supports_executable():
659
615
def is_executable(self, file_id, path=None):
616
file_id = osutils.safe_file_id(file_id)
660
617
return self._inventory[file_id].executable
662
_is_executable_from_path_and_stat = \
663
_is_executable_from_path_and_stat_from_basis
665
619
def is_executable(self, file_id, path=None):
621
file_id = osutils.safe_file_id(file_id)
667
622
path = self.id2path(file_id)
668
623
mode = os.lstat(self.abspath(path)).st_mode
669
624
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
671
_is_executable_from_path_and_stat = \
672
_is_executable_from_path_and_stat_from_stat
674
626
@needs_tree_write_lock
675
627
def _add(self, files, ids, kinds):
676
628
"""See MutableTree._add."""
677
629
# TODO: Re-adding a file that is removed in the working copy
678
630
# should probably put it back with the previous ID.
679
# the read and write working inventory should not occur in this
631
# the read and write working inventory should not occur in this
680
632
# function - they should be part of lock_write and unlock.
633
inv = self.read_working_inventory()
682
634
for f, file_id, kind in zip(files, ids, kinds):
635
assert kind is not None
683
636
if file_id is None:
684
637
inv.add_path(f, kind=kind)
639
file_id = osutils.safe_file_id(file_id)
686
640
inv.add_path(f, kind=kind, file_id=file_id)
687
self._inventory_is_modified = True
641
self._write_inventory(inv)
689
643
@needs_tree_write_lock
690
644
def _gather_kinds(self, files, kinds):
751
705
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
753
def path_content_summary(self, path, _lstat=os.lstat,
754
_mapper=osutils.file_kind_from_stat_mode):
755
"""See Tree.path_content_summary."""
756
abspath = self.abspath(path)
758
stat_result = _lstat(abspath)
760
if getattr(e, 'errno', None) == errno.ENOENT:
762
return ('missing', None, None, None)
763
# propagate other errors
765
kind = _mapper(stat_result.st_mode)
767
return self._file_content_summary(path, stat_result)
768
elif kind == 'directory':
769
# perhaps it looks like a plain directory, but it's really a
771
if self._directory_is_tree_reference(path):
772
kind = 'tree-reference'
773
return kind, None, None, None
774
elif kind == 'symlink':
775
target = osutils.readlink(abspath)
776
return ('symlink', None, None, target)
778
return (kind, None, None, None)
780
def _file_content_summary(self, path, stat_result):
781
size = stat_result.st_size
782
executable = self._is_executable_from_path_and_stat(path, stat_result)
783
# try for a stat cache lookup
784
return ('file', size, executable, self._sha_from_stat(
707
@deprecated_method(zero_eleven)
709
def pending_merges(self):
710
"""Return a list of pending merges.
712
These are revisions that have been merged into the working
713
directory but not yet committed.
715
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
716
instead - which is available on all tree objects.
718
return self.get_parent_ids()[1:]
787
720
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
788
721
"""Common ghost checking functionality from set_parent_*.
833
746
:param revision_ids: The revision_ids to set as the parent ids of this
834
747
working tree. Any of these may be ghosts.
749
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
836
750
self._check_parents_for_ghosts(revision_ids,
837
751
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
838
for revision_id in revision_ids:
839
_mod_revision.check_not_reserved_id(revision_id)
841
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
843
753
if len(revision_ids) > 0:
844
754
self.set_last_revision(revision_ids[0])
846
self.set_last_revision(_mod_revision.NULL_REVISION)
756
self.set_last_revision(None)
848
758
self._set_merges_from_parent_ids(revision_ids)
850
760
@needs_tree_write_lock
851
761
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
852
762
"""See MutableTree.set_parent_trees."""
853
parent_ids = [rev for (rev, tree) in parents_list]
854
for revision_id in parent_ids:
855
_mod_revision.check_not_reserved_id(revision_id)
763
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
857
765
self._check_parents_for_ghosts(parent_ids,
858
766
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
860
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
862
768
if len(parent_ids) == 0:
863
leftmost_parent_id = _mod_revision.NULL_REVISION
769
leftmost_parent_id = None
864
770
leftmost_parent_tree = None
866
772
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
919
813
branch.last_revision().
921
815
from bzrlib.merge import Merger, Merge3Merger
922
merger = Merger(self.branch, this_tree=self)
923
# check that there are no local alterations
924
if not force and self.has_changes():
925
raise errors.UncommittedChanges(self)
926
if to_revision is None:
927
to_revision = _mod_revision.ensure_null(branch.last_revision())
928
merger.other_rev_id = to_revision
929
if _mod_revision.is_null(merger.other_rev_id):
930
raise errors.NoCommits(branch)
931
self.branch.fetch(branch, last_revision=merger.other_rev_id)
932
merger.other_basis = merger.other_rev_id
933
merger.other_tree = self.branch.repository.revision_tree(
935
merger.other_branch = branch
936
if from_revision is None:
816
pb = bzrlib.ui.ui_factory.nested_progress_bar()
818
merger = Merger(self.branch, this_tree=self, pb=pb)
819
merger.pp = ProgressPhase("Merge phase", 5, pb)
820
merger.pp.next_phase()
821
# check that there are no
823
merger.check_basis(check_clean=True, require_commits=False)
824
if to_revision is None:
825
to_revision = branch.last_revision()
827
to_revision = osutils.safe_revision_id(to_revision)
828
merger.other_rev_id = to_revision
829
if merger.other_rev_id is None:
830
raise error.NoCommits(branch)
831
self.branch.fetch(branch, last_revision=merger.other_rev_id)
832
merger.other_basis = merger.other_rev_id
833
merger.other_tree = self.branch.repository.revision_tree(
835
merger.other_branch = branch
836
merger.pp.next_phase()
937
837
merger.find_base()
939
merger.set_base_revision(from_revision, branch)
940
if merger.base_rev_id == merger.other_rev_id:
941
raise errors.PointlessMerge
942
merger.backup_files = False
943
if merge_type is None:
838
if merger.base_rev_id == merger.other_rev_id:
839
raise errors.PointlessMerge
840
merger.backup_files = False
944
841
merger.merge_type = Merge3Merger
946
merger.merge_type = merge_type
947
merger.set_interesting_files(None)
948
merger.show_base = False
949
merger.reprocess = False
950
conflicts = merger.do_merge()
842
merger.set_interesting_files(None)
843
merger.show_base = False
844
merger.reprocess = False
845
conflicts = merger.do_merge()
955
852
def merge_modified(self):
956
853
"""Return a dictionary of files modified by a merge.
958
The list is initialized by WorkingTree.set_merge_modified, which is
855
The list is initialized by WorkingTree.set_merge_modified, which is
959
856
typically called after we make some automatic updates to the tree
960
857
because of a merge.
1032
924
self.inventory.add(other_root)
1033
925
add_children(self.inventory, other_root)
1034
926
self._write_inventory(self.inventory)
1035
# normally we don't want to fetch whole repositories, but i think
1036
# here we really do want to consolidate the whole thing.
1037
927
for parent_id in other_tree.get_parent_ids():
1038
928
self.branch.fetch(other_tree.branch, parent_id)
1039
929
self.add_parent_tree_id(parent_id)
1041
931
other_tree.unlock()
1042
other_tree.bzrdir.retire_bzrdir()
1044
def _setup_directory_is_tree_reference(self):
1045
if self._branch.repository._format.supports_tree_reference:
1046
self._directory_is_tree_reference = \
1047
self._directory_may_be_tree_reference
1049
self._directory_is_tree_reference = \
1050
self._directory_is_never_tree_reference
1052
def _directory_is_never_tree_reference(self, relpath):
1055
def _directory_may_be_tree_reference(self, relpath):
1056
# as a special case, if a directory contains control files then
1057
# it's a tree reference, except that the root of the tree is not
1058
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1059
# TODO: We could ask all the control formats whether they
1060
# recognize this directory, but at the moment there's no cheap api
1061
# to do that. Since we probably can only nest bzr checkouts and
1062
# they always use this name it's ok for now. -- mbp 20060306
1064
# FIXME: There is an unhandled case here of a subdirectory
1065
# containing .bzr but not a branch; that will probably blow up
1066
# when you try to commit it. It might happen if there is a
1067
# checkout in a subdirectory. This can be avoided by not adding
932
other_tree.bzrdir.destroy_workingtree_metadata()
1070
934
@needs_tree_write_lock
1071
935
def extract(self, file_id, format=None):
1072
936
"""Extract a subtree from this tree.
1074
938
A new branch will be created, relative to the path for this tree.
1077
940
def mkdirs(path):
1078
941
segments = osutils.splitpath(path)
1079
942
transport = self.branch.bzrdir.root_transport
1080
943
for name in segments:
1081
944
transport = transport.clone(name)
1082
transport.ensure_base()
947
except errors.FileExists:
1083
949
return transport
1085
951
sub_path = self.id2path(file_id)
1086
952
branch_transport = mkdirs(sub_path)
1087
953
if format is None:
1088
format = self.bzrdir.cloning_metadir()
1089
branch_transport.ensure_base()
954
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
956
branch_transport.mkdir('.')
957
except errors.FileExists:
1090
959
branch_bzrdir = format.initialize_on_transport(branch_transport)
1092
961
repo = branch_bzrdir.find_repository()
1093
962
except errors.NoRepositoryPresent:
1094
963
repo = branch_bzrdir.create_repository()
1095
if not repo.supports_rich_root():
1096
raise errors.RootNotRich()
964
assert repo.supports_rich_root()
966
if not repo.supports_rich_root():
967
raise errors.RootNotRich()
1097
968
new_branch = branch_bzrdir.create_branch()
1098
969
new_branch.pull(self.branch)
1099
970
for parent_id in self.get_parent_ids():
1132
1001
sio = StringIO()
1133
1002
self._serialize(self._inventory, sio)
1135
self._transport.put_file('inventory', sio,
1136
mode=self.bzrdir._get_file_mode())
1004
self._control_files.put('inventory', sio)
1137
1005
self._inventory_is_modified = False
1139
def _kind(self, relpath):
1140
return osutils.file_kind(self.abspath(relpath))
1142
def list_files(self, include_root=False, from_dir=None, recursive=True):
1143
"""List all files as (path, class, kind, id, entry).
1007
def list_files(self, include_root=False):
1008
"""Recursively list all files as (path, class, kind, id, entry).
1145
1010
Lists, but does not descend into unversioned directories.
1146
1012
This does not include files that have been deleted in this
1147
tree. Skips the control directory.
1149
:param include_root: if True, return an entry for the root
1150
:param from_dir: start from this directory or None for the root
1151
:param recursive: whether to recurse into subdirectories or not
1015
Skips the control directory.
1153
1017
# list_files is an iterator, so @needs_read_lock doesn't work properly
1154
1018
# with it. So callers should be careful to always read_lock the tree.
1929
1748
def read_basis_inventory(self):
1930
1749
"""Read the cached basis inventory."""
1931
1750
path = self._basis_inventory_name()
1932
return self._transport.get_bytes(path)
1751
return self._control_files.get(path).read()
1934
1753
@needs_read_lock
1935
1754
def read_working_inventory(self):
1936
1755
"""Read the working inventory.
1938
1757
:raises errors.InventoryModified: read_working_inventory will fail
1939
1758
when the current in memory inventory has been modified.
1941
# conceptually this should be an implementation detail of the tree.
1760
# conceptually this should be an implementation detail of the tree.
1942
1761
# XXX: Deprecate this.
1943
1762
# ElementTree does its own conversion from UTF-8, so open in
1945
1764
if self._inventory_is_modified:
1946
1765
raise errors.InventoryModified(self)
1947
f = self._transport.get('inventory')
1949
result = self._deserialize(f)
1766
result = self._deserialize(self._control_files.get('inventory'))
1952
1767
self._set_inventory(result, dirty=False)
1955
1770
@needs_tree_write_lock
1956
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1958
"""Remove nominated files from the working inventory.
1960
:files: File paths relative to the basedir.
1961
:keep_files: If true, the files will also be kept.
1962
:force: Delete files and directories, even if they are changed and
1963
even if the directories are not empty.
1771
def remove(self, files, verbose=False, to_file=None):
1772
"""Remove nominated files from the working inventory..
1774
This does not remove their text. This does not run on XXX on what? RBC
1776
TODO: Refuse to remove modified files unless --force is given?
1778
TODO: Do something useful with directories.
1780
TODO: Should this remove the text or not? Tough call; not
1781
removing may be useful and the user can just use use rm, and
1782
is the opposite of add. Removing it is consistent with most
1783
other tools. Maybe an option.
1785
## TODO: Normalize names
1786
## TODO: Remove nested loops; better scalability
1965
1787
if isinstance(files, basestring):
1966
1788
files = [files]
1971
unknown_nested_files=set()
1973
to_file = sys.stdout
1975
def recurse_directory_to_add_files(directory):
1976
# Recurse directory and add all files
1977
# so we can check if they have changed.
1978
for parent_info, file_infos in self.walkdirs(directory):
1979
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1980
# Is it versioned or ignored?
1981
if self.path2id(relpath) or self.is_ignored(relpath):
1982
# Add nested content for deletion.
1983
new_files.add(relpath)
1985
# Files which are not versioned and not ignored
1986
# should be treated as unknown.
1987
unknown_nested_files.add((relpath, None, kind))
1989
for filename in files:
1990
# Get file name into canonical form.
1991
abspath = self.abspath(filename)
1992
filename = self.relpath(abspath)
1993
if len(filename) > 0:
1994
new_files.add(filename)
1995
recurse_directory_to_add_files(filename)
1997
files = list(new_files)
2000
return # nothing to do
2002
# Sort needed to first handle directory content before the directory
2003
files.sort(reverse=True)
2005
# Bail out if we are going to delete files we shouldn't
2006
if not keep_files and not force:
2007
has_changed_files = len(unknown_nested_files) > 0
2008
if not has_changed_files:
2009
for (file_id, path, content_change, versioned, parent_id, name,
2010
kind, executable) in self.iter_changes(self.basis_tree(),
2011
include_unchanged=True, require_versioned=False,
2012
want_unversioned=True, specific_files=files):
2013
if versioned == (False, False):
2014
# The record is unknown ...
2015
if not self.is_ignored(path[1]):
2016
# ... but not ignored
2017
has_changed_files = True
2019
elif (content_change and (kind[1] is not None) and
2020
osutils.is_inside_any(files, path[1])):
2021
# Versioned and changed, but not deleted, and still
2022
# in one of the dirs to be deleted.
2023
has_changed_files = True
2026
if has_changed_files:
2027
# Make delta show ALL applicable changes in error message.
2028
tree_delta = self.changes_from(self.basis_tree(),
2029
require_versioned=False, want_unversioned=True,
2030
specific_files=files)
2031
for unknown_file in unknown_nested_files:
2032
if unknown_file not in tree_delta.unversioned:
2033
tree_delta.unversioned.extend((unknown_file,))
2034
raise errors.BzrRemoveChangedFilesError(tree_delta)
2036
# Build inv_delta and delete files where applicable,
2037
# do this before any modifications to inventory.
1790
inv = self.inventory
1792
# do this before any modifications
2038
1793
for f in files:
2039
fid = self.path2id(f)
1794
fid = inv.path2id(f)
2042
message = "%s is not versioned." % (f,)
1796
note("%s is not versioned."%f)
2045
# having removed it, it must be either ignored or unknown
1799
# having remove it, it must be either ignored or unknown
2046
1800
if self.is_ignored(f):
2047
1801
new_status = 'I'
2049
1803
new_status = '?'
2050
# XXX: Really should be a more abstract reporter interface
2051
kind_ch = osutils.kind_marker(self.kind(fid))
2052
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2054
inv_delta.append((f, None, fid, None))
2055
message = "removed %s" % (f,)
2058
abs_path = self.abspath(f)
2059
if osutils.lexists(abs_path):
2060
if (osutils.isdir(abs_path) and
2061
len(os.listdir(abs_path)) > 0):
2063
osutils.rmtree(abs_path)
2065
message = "%s is not an empty directory "\
2066
"and won't be deleted." % (f,)
2068
osutils.delete_any(abs_path)
2069
message = "deleted %s" % (f,)
2070
elif message is not None:
2071
# Only care if we haven't done anything yet.
2072
message = "%s does not exist." % (f,)
2074
# Print only one message (if any) per file.
2075
if message is not None:
2077
self.apply_inventory_delta(inv_delta)
1804
textui.show_status(new_status, inv[fid].kind, f,
1808
self._write_inventory(inv)
2079
1810
@needs_tree_write_lock
2080
def revert(self, filenames=None, old_tree=None, backups=True,
2081
pb=None, report_changes=False):
1811
def revert(self, filenames, old_tree=None, backups=True,
1812
pb=DummyProgress(), report_changes=False):
2082
1813
from bzrlib.conflicts import resolve
2085
symbol_versioning.warn('Using [] to revert all files is deprecated'
2086
' as of bzr 0.91. Please use None (the default) instead.',
2087
DeprecationWarning, stacklevel=2)
2088
1814
if old_tree is None:
2089
basis_tree = self.basis_tree()
2090
basis_tree.lock_read()
2091
old_tree = basis_tree
1815
old_tree = self.basis_tree()
1816
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1818
if not len(filenames):
1819
self.set_parent_ids(self.get_parent_ids()[:1])
2095
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2097
if filenames is None and len(self.get_parent_ids()) > 1:
2099
last_revision = self.last_revision()
2100
if last_revision != _mod_revision.NULL_REVISION:
2101
if basis_tree is None:
2102
basis_tree = self.basis_tree()
2103
basis_tree.lock_read()
2104
parent_trees.append((last_revision, basis_tree))
2105
self.set_parent_trees(parent_trees)
2108
resolve(self, filenames, ignore_misses=True, recursive=True)
2110
if basis_tree is not None:
1822
resolve(self, filenames, ignore_misses=True)
2112
1823
return conflicts
2114
1825
def revision_tree(self, revision_id):
2269
1975
# cant set that until we update the working trees last revision to be
2270
1976
# one from the new branch, because it will just get absorbed by the
2271
1977
# parent de-duplication logic.
2273
1979
# We MUST save it even if an error occurs, because otherwise the users
2274
1980
# local work is unreferenced and will appear to have been lost.
2278
1984
last_rev = self.get_parent_ids()[0]
2279
1985
except IndexError:
2280
last_rev = _mod_revision.NULL_REVISION
2281
if revision is None:
2282
revision = self.branch.last_revision()
2284
old_tip = old_tip or _mod_revision.NULL_REVISION
2286
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2287
# the branch we are bound to was updated
2288
# merge those changes in first
2289
base_tree = self.basis_tree()
2290
other_tree = self.branch.repository.revision_tree(old_tip)
2291
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2292
base_tree, this_tree=self,
2293
change_reporter=change_reporter)
2295
self.add_parent_tree((old_tip, other_tree))
2296
trace.note('Rerun update after fixing the conflicts.')
2299
if last_rev != _mod_revision.ensure_null(revision):
2300
# the working tree is up to date with the branch
2301
# we can merge the specified revision from master
2302
to_tree = self.branch.repository.revision_tree(revision)
2303
to_root_id = to_tree.get_root_id()
1987
if last_rev != self.branch.last_revision():
1988
# merge tree state up to new branch tip.
2305
1989
basis = self.basis_tree()
2306
1990
basis.lock_read()
2308
if (basis.inventory.root is None
2309
or basis.inventory.root.file_id != to_root_id):
2310
self.set_root_id(to_root_id)
1992
to_tree = self.branch.basis_tree()
1993
if basis.inventory.root is None:
1994
self.set_root_id(to_tree.inventory.root.file_id)
1996
result += merge.merge_inner(
2315
# determine the branch point
2316
graph = self.branch.repository.get_graph()
2317
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2319
base_tree = self.branch.repository.revision_tree(base_rev_id)
2321
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2323
change_reporter=change_reporter)
2324
self.set_last_revision(revision)
2325
2003
# TODO - dedup parents list with things merged by pull ?
2326
2004
# reuse the tree we've updated to to set the basis:
2327
parent_trees = [(revision, to_tree)]
2005
parent_trees = [(self.branch.last_revision(), to_tree)]
2328
2006
merges = self.get_parent_ids()[1:]
2329
2007
# Ideally we ask the tree for the trees here, that way the working
2330
# tree can decide whether to give us the entire tree or give us a
2008
# tree can decide whether to give us teh entire tree or give us a
2331
2009
# lazy initialised tree. dirstate for instance will have the trees
2332
2010
# in ram already, whereas a last-revision + basis-inventory tree
2333
2011
# will not, but also does not need them when setting parents.
2334
2012
for parent in merges:
2335
2013
parent_trees.append(
2336
2014
(parent, self.branch.repository.revision_tree(parent)))
2337
if not _mod_revision.is_null(old_tip):
2015
if old_tip is not None:
2338
2016
parent_trees.append(
2339
2017
(old_tip, self.branch.repository.revision_tree(old_tip)))
2340
2018
self.set_parent_trees(parent_trees)
2341
2019
last_rev = parent_trees[0][0]
2021
# the working tree had the same last-revision as the master
2022
# branch did. We may still have pivot local work from the local
2023
# branch into old_tip:
2024
if old_tip is not None:
2025
self.add_parent_tree_id(old_tip)
2026
if old_tip and old_tip != last_rev:
2027
# our last revision was not the prior branch last revision
2028
# and we have converted that last revision to a pending merge.
2029
# base is somewhere between the branch tip now
2030
# and the now pending merge
2032
# Since we just modified the working tree and inventory, flush out
2033
# the current state, before we modify it again.
2034
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2035
# requires it only because TreeTransform directly munges the
2036
# inventory and calls tree._write_inventory(). Ultimately we
2037
# should be able to remove this extra flush.
2039
from bzrlib.revision import common_ancestor
2041
base_rev_id = common_ancestor(self.branch.last_revision(),
2043
self.branch.repository)
2044
except errors.NoCommonAncestor:
2046
base_tree = self.branch.repository.revision_tree(base_rev_id)
2047
other_tree = self.branch.repository.revision_tree(old_tip)
2048
result += merge.merge_inner(
2344
2055
def _write_hashcache_if_dirty(self):
2345
2056
"""Write out the hashcache if it is dirty."""
2543
2228
# FIXME: stash the node in pending
2544
2229
entry = inv[top_id]
2545
if entry.kind == 'directory':
2546
for name, child in entry.sorted_children():
2547
dirblock.append((relroot + name, name, child.kind, None,
2548
child.file_id, child.kind
2230
for name, child in entry.sorted_children():
2231
dirblock.append((relroot + name, name, child.kind, None,
2232
child.file_id, child.kind
2550
2234
yield (currentdir[0], entry.file_id), dirblock
2551
2235
# push the user specified dirs from dirblock
2552
2236
for dir in reversed(dirblock):
2553
2237
if dir[2] == _directory:
2554
2238
pending.append(dir)
2556
@needs_tree_write_lock
2557
def auto_resolve(self):
2558
"""Automatically resolve text conflicts according to contents.
2560
Only text conflicts are auto_resolvable. Files with no conflict markers
2561
are considered 'resolved', because bzr always puts conflict markers
2562
into files that have text conflicts. The corresponding .THIS .BASE and
2563
.OTHER files are deleted, as per 'resolve'.
2564
:return: a tuple of ConflictLists: (un_resolved, resolved).
2566
un_resolved = _mod_conflicts.ConflictList()
2567
resolved = _mod_conflicts.ConflictList()
2568
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2569
for conflict in self.conflicts():
2570
if (conflict.typestring != 'text conflict' or
2571
self.kind(conflict.file_id) != 'file'):
2572
un_resolved.append(conflict)
2574
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2576
for line in my_file:
2577
if conflict_re.search(line):
2578
un_resolved.append(conflict)
2581
resolved.append(conflict)
2584
resolved.remove_files(self)
2585
self.set_conflicts(un_resolved)
2586
return un_resolved, resolved
2589
def _check(self, references):
2590
"""Check the tree for consistency.
2592
:param references: A dict with keys matching the items returned by
2593
self._get_check_refs(), and values from looking those keys up in
2596
tree_basis = self.basis_tree()
2597
tree_basis.lock_read()
2599
repo_basis = references[('trees', self.last_revision())]
2600
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2601
raise errors.BzrCheckError(
2602
"Mismatched basis inventory content.")
2607
def _validate(self):
2608
"""Validate internal structures.
2610
This is meant mostly for the test suite. To give it a chance to detect
2611
corruption after actions have occurred. The default implementation is a
2614
:return: None. An exception should be raised if there is an error.
2618
def _get_rules_searcher(self, default_searcher):
2619
"""See Tree._get_rules_searcher."""
2620
if self._rules_searcher is None:
2621
self._rules_searcher = super(WorkingTree,
2622
self)._get_rules_searcher(default_searcher)
2623
return self._rules_searcher
2625
def get_shelf_manager(self):
2626
"""Return the ShelfManager for this WorkingTree."""
2627
from bzrlib.shelf import ShelfManager
2628
return ShelfManager(self, self._transport)
2631
2241
class WorkingTree2(WorkingTree):
2632
2242
"""This is the Format 2 working tree.
2634
This was the first weave based working tree.
2244
This was the first weave based working tree.
2635
2245
- uses os locks for locking.
2636
2246
- uses the branch last-revision.
2639
def __init__(self, *args, **kwargs):
2640
super(WorkingTree2, self).__init__(*args, **kwargs)
2641
# WorkingTree2 has more of a constraint that self._inventory must
2642
# exist. Because this is an older format, we don't mind the overhead
2643
# caused by the extra computation here.
2645
# Newer WorkingTree's should only have self._inventory set when they
2647
if self._inventory is None:
2648
self.read_working_inventory()
2650
def _get_check_refs(self):
2651
"""Return the references needed to perform a check of this tree."""
2652
return [('trees', self.last_revision())]
2654
2249
def lock_tree_write(self):
2655
2250
"""See WorkingTree.lock_tree_write().
2657
2252
In Format2 WorkingTrees we have a single lock for the branch and tree
2658
2253
so lock_tree_write() degrades to lock_write().
2660
:return: An object with an unlock method which will release the lock
2663
2255
self.branch.lock_write()
2665
self._control_files.lock_write()
2257
return self._control_files.lock_write()
2668
2259
self.branch.unlock()
2671
2262
def unlock(self):
2672
# do non-implementation specific cleanup
2675
2263
# we share control files:
2676
2264
if self._control_files._lock_count == 3:
2677
2265
# _inventory_is_modified is always False during a read lock.
2678
2266
if self._inventory_is_modified:
2680
2268
self._write_hashcache_if_dirty()
2682
2270
# reverse order of locking.
2684
2272
return self._control_files.unlock()
2859
2443
def unregister_format(klass, format):
2444
assert klass._formats[format.get_format_string()] is format
2860
2445
del klass._formats[format.get_format_string()]
2863
2449
class WorkingTreeFormat2(WorkingTreeFormat):
2864
"""The second working tree format.
2450
"""The second working tree format.
2866
2452
This format modified the hash cache from the format 1 hash cache.
2869
upgrade_recommended = True
2871
2455
def get_format_description(self):
2872
2456
"""See WorkingTreeFormat.get_format_description()."""
2873
2457
return "Working tree format 2"
2875
def _stub_initialize_on_transport(self, transport, file_mode):
2876
"""Workaround: create control files for a remote working tree.
2459
def stub_initialize_remote(self, control_files):
2460
"""As a special workaround create critical control files for a remote working tree
2878
2462
This ensures that it can later be updated and dealt with locally,
2879
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2463
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2880
2464
no working tree. (See bug #43064).
2882
2466
sio = StringIO()
2883
inv = inventory.Inventory()
2884
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2468
xml5.serializer_v5.write_inventory(inv, sio)
2886
transport.put_file('inventory', sio, file_mode)
2887
transport.put_bytes('pending-merges', '', file_mode)
2889
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
accelerator_tree=None, hardlink=False):
2470
control_files.put('inventory', sio)
2472
control_files.put_bytes('pending-merges', '')
2475
def initialize(self, a_bzrdir, revision_id=None):
2891
2476
"""See WorkingTreeFormat.initialize()."""
2892
2477
if not isinstance(a_bzrdir.transport, LocalTransport):
2893
2478
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2894
if from_branch is not None:
2895
branch = from_branch
2897
branch = a_bzrdir.open_branch()
2898
if revision_id is None:
2899
revision_id = _mod_revision.ensure_null(branch.last_revision())
2902
branch.generate_revision_history(revision_id)
2905
inv = inventory.Inventory()
2479
branch = a_bzrdir.open_branch()
2480
if revision_id is not None:
2481
revision_id = osutils.safe_revision_id(revision_id)
2484
revision_history = branch.revision_history()
2486
position = revision_history.index(revision_id)
2488
raise errors.NoSuchRevision(branch, revision_id)
2489
branch.set_revision_history(revision_history[:position + 1])
2492
revision = branch.last_revision()
2906
2494
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2909
2497
_internal=True,
2911
2499
_bzrdir=a_bzrdir)
2912
basis_tree = branch.repository.revision_tree(revision_id)
2500
basis_tree = branch.repository.revision_tree(revision)
2913
2501
if basis_tree.inventory.root is not None:
2914
wt.set_root_id(basis_tree.get_root_id())
2502
wt.set_root_id(basis_tree.inventory.root.file_id)
2915
2503
# set the parent list and cache the basis tree.
2916
if _mod_revision.is_null(revision_id):
2919
parent_trees = [(revision_id, basis_tree)]
2920
wt.set_parent_trees(parent_trees)
2504
wt.set_parent_trees([(revision, basis_tree)])
2921
2505
transform.build_tree(basis_tree, wt)
3073
2645
return self.get_format_string()
3076
__default_format = WorkingTreeFormat6()
2648
__default_format = WorkingTreeFormat4()
3077
2649
WorkingTreeFormat.register_format(__default_format)
3078
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3079
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3080
2650
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3081
2651
WorkingTreeFormat.set_default_format(__default_format)
3082
2652
# formats which have no format string are not discoverable
3083
2653
# and not independently creatable, so are not registered.
3084
2654
_legacy_formats = [WorkingTreeFormat2(),
2658
class WorkingTreeTestProviderAdapter(object):
2659
"""A tool to generate a suite testing multiple workingtree formats at once.
2661
This is done by copying the test once for each transport and injecting
2662
the transport_server, transport_readonly_server, and workingtree_format
2663
classes into each copy. Each copy is also given a new id() to make it
2667
def __init__(self, transport_server, transport_readonly_server, formats):
2668
self._transport_server = transport_server
2669
self._transport_readonly_server = transport_readonly_server
2670
self._formats = formats
2672
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2673
"""Clone test for adaption."""
2674
new_test = deepcopy(test)
2675
new_test.transport_server = self._transport_server
2676
new_test.transport_readonly_server = self._transport_readonly_server
2677
new_test.bzrdir_format = bzrdir_format
2678
new_test.workingtree_format = workingtree_format
2679
def make_new_test_id():
2680
new_id = "%s(%s)" % (test.id(), variation)
2681
return lambda: new_id
2682
new_test.id = make_new_test_id()
2685
def adapt(self, test):
2686
from bzrlib.tests import TestSuite
2687
result = TestSuite()
2688
for workingtree_format, bzrdir_format in self._formats:
2689
new_test = self._clone_test(
2692
workingtree_format, workingtree_format.__class__.__name__)
2693
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
