51
59
conflicts as _mod_conflicts,
60
revision as _mod_revision,
69
77
import bzrlib.branch
70
78
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
83
from bzrlib import symbol_versioning
79
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lockable_files import LockableFiles
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
86
from bzrlib.lockable_files import LockableFiles, TransportLock
81
87
from bzrlib.lockdir import LockDir
82
88
import bzrlib.mutabletree
83
89
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
90
from bzrlib.osutils import (
93
100
supports_executable,
95
from bzrlib.filters import filtered_input_file
96
102
from bzrlib.trace import mutter, note
97
103
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
106
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
106
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
121
@deprecated_function(zero_thirteen)
122
def gen_file_id(name):
123
"""Return new file id for the basename 'name'.
125
Use bzrlib.generate_ids.gen_file_id() instead
127
return generate_ids.gen_file_id(name)
130
@deprecated_function(zero_thirteen)
132
"""Return a new tree-root file id.
134
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
136
return generate_ids.gen_root_id()
115
139
class TreeEntry(object):
116
140
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
142
This needs further inspection, it may be better to have
119
143
InventoryEntries without ids - though that seems wrong. For now,
120
144
this is a parallel hierarchy to InventoryEntry, and needs to become
121
145
one of several things: decorates to that hierarchy, children of, or
192
"""Construct a WorkingTree instance. This is not a public API.
211
"""Construct a WorkingTree for basedir.
194
:param branch: A branch to override probing for the branch.
213
If the branch is not supplied, it is opened automatically.
214
If the branch is supplied, it must be the branch for this basedir.
215
(branch.base is not cross checked, because for remote branches that
216
would be meaningless).
196
218
self._format = _format
197
219
self.bzrdir = _bzrdir
198
220
if not _internal:
199
raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
"WorkingTree.open() to obtain a WorkingTree.")
221
# not created via open etc.
222
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
223
"Please use bzrdir.open_workingtree or WorkingTree.open().",
226
wt = WorkingTree.open(basedir)
227
self._branch = wt.branch
228
self.basedir = wt.basedir
229
self._control_files = wt._control_files
230
self._hashcache = wt._hashcache
231
self._set_inventory(wt._inventory, dirty=False)
232
self._format = wt._format
233
self.bzrdir = wt.bzrdir
234
assert isinstance(basedir, basestring), \
235
"base directory %r is not a string" % basedir
201
236
basedir = safe_unicode(basedir)
202
237
mutter("opening working tree %r", basedir)
203
238
if deprecated_passed(branch):
240
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
241
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
242
" WorkingTree.open().",
204
246
self._branch = branch
206
248
self._branch = self.bzrdir.open_branch()
422
405
# at this point ?
424
407
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
408
except errors.RevisionNotPresent:
426
409
# the basis tree *may* be a ghost or a low level error may have
427
# occurred. If the revision is present, its a problem, if its not
410
# occured. If the revision is present, its a problem, if its not
429
412
if self.branch.repository.has_revision(revision_id):
431
414
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
415
return self.branch.repository.revision_tree(None)
418
@deprecated_method(zero_eight)
419
def create(branch, directory):
420
"""Create a workingtree for branch at directory.
422
If existing_directory already exists it must have a .bzr directory.
423
If it does not exist, it will be created.
425
This returns a new WorkingTree object for the new checkout.
427
TODO FIXME RBC 20060124 when we have checkout formats in place this
428
should accept an optional revisionid to checkout [and reject this if
429
checking out into the same dir as a pre-checkout-aware branch format.]
431
XXX: When BzrDir is present, these should be created through that
434
warnings.warn('delete WorkingTree.create', stacklevel=3)
435
transport = get_transport(directory)
436
if branch.bzrdir.root_transport.base == transport.base:
438
return branch.bzrdir.create_workingtree()
439
# different directory,
440
# create a branch reference
441
# and now a working tree.
442
raise NotImplementedError
445
@deprecated_method(zero_eight)
446
def create_standalone(directory):
447
"""Create a checkout and a branch and a repo at directory.
449
Directory must exist and be empty.
451
please use BzrDir.create_standalone_workingtree
453
return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
455
def relpath(self, path):
439
456
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
458
The path may be absolute or relative. If its a relative path it is
442
459
interpreted relative to the python current working directory.
444
461
return osutils.relpath(self.basedir, path)
446
463
def has_filename(self, filename):
447
464
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
466
def get_file(self, file_id):
467
file_id = osutils.safe_file_id(file_id)
468
return self.get_file_byname(self.id2path(file_id))
470
def get_file_text(self, file_id):
471
file_id = osutils.safe_file_id(file_id)
472
return self.get_file(file_id).read()
474
def get_file_byname(self, filename):
475
return file(self.abspath(filename), 'rb')
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
478
def annotate_iter(self, file_id):
486
479
"""See Tree.annotate_iter
488
481
This implementation will use the basis tree implementation if possible.
492
485
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
486
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
488
file_id = osutils.safe_file_id(file_id)
489
basis = self.basis_tree()
492
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
493
require_versioned=True).next()
494
changed_content, kind = changes[2], changes[6]
495
if not changed_content:
496
return basis.annotate_iter(file_id)
500
if kind[0] != 'file':
503
old_lines = list(basis.annotate_iter(file_id))
505
for tree in self.branch.repository.revision_trees(
506
self.get_parent_ids()[1:]):
507
if file_id not in tree:
509
old.append(list(tree.annotate_iter(file_id)))
510
return annotate.reannotate(old, self.get_file(file_id).readlines(),
539
515
def get_parent_ids(self):
540
516
"""See Tree.get_parent_ids.
542
518
This implementation reads the pending merges list and last_revision
543
519
value and uses that to decide what the parents list should be.
545
last_rev = _mod_revision.ensure_null(self._last_revision())
546
if _mod_revision.NULL_REVISION == last_rev:
521
last_rev = self._last_revision()
549
525
parents = [last_rev]
551
merges_bytes = self._transport.get_bytes('pending-merges')
527
merges_file = self._control_files.get('pending-merges')
552
528
except errors.NoSuchFile:
555
for l in osutils.split_lines(merges_bytes):
556
revision_id = l.rstrip('\n')
531
for l in merges_file.readlines():
532
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
533
parents.append(revision_id)
561
537
def get_root_id(self):
562
538
"""Return the id of this trees root"""
563
539
return self._inventory.root.file_id
565
541
def _get_store_filename(self, file_id):
566
542
## XXX: badly named; this is not in the store at all
543
file_id = osutils.safe_file_id(file_id)
567
544
return self.abspath(self.id2path(file_id))
570
def clone(self, to_bzrdir, revision_id=None):
547
def clone(self, to_bzrdir, revision_id=None, basis=None):
571
548
"""Duplicate this working tree into to_bzr, including all state.
573
550
Specifically modified files are kept as modified, but
574
551
ignored and unknown files are discarded.
576
553
If you want to make a new line of development, see bzrdir.sprout()
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
556
If not None, the cloned tree will have its last revision set to
557
revision, and and difference between the source trees last revision
581
558
and this one merged in.
561
If not None, a closer copy of a tree which may have some files in
562
common, and which file content should be preferentially copied from.
583
564
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
565
result = self._format.initialize(to_bzrdir)
585
566
self.copy_content_into(result, revision_id)
616
600
__contains__ = has_id
618
602
def get_file_size(self, file_id):
619
"""See Tree.get_file_size"""
620
# XXX: this returns the on-disk size; it should probably return the
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
603
file_id = osutils.safe_file_id(file_id)
604
return os.path.getsize(self.id2abspath(file_id))
631
607
def get_file_sha1(self, file_id, path=None, stat_value=None):
608
file_id = osutils.safe_file_id(file_id)
633
610
path = self._inventory.id2path(file_id)
634
611
return self._hashcache.get_sha1(path, stat_value)
636
613
def get_file_mtime(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
638
616
path = self.inventory.id2path(file_id)
639
617
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
619
if not supports_executable():
654
620
def is_executable(self, file_id, path=None):
621
file_id = osutils.safe_file_id(file_id)
655
622
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
624
def is_executable(self, file_id, path=None):
626
file_id = osutils.safe_file_id(file_id)
662
627
path = self.id2path(file_id)
663
628
mode = os.lstat(self.abspath(path)).st_mode
664
629
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
631
@needs_tree_write_lock
670
632
def _add(self, files, ids, kinds):
671
633
"""See MutableTree._add."""
672
634
# TODO: Re-adding a file that is removed in the working copy
673
635
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
636
# the read and write working inventory should not occur in this
675
637
# function - they should be part of lock_write and unlock.
638
inv = self.read_working_inventory()
677
639
for f, file_id, kind in zip(files, ids, kinds):
640
assert kind is not None
678
641
if file_id is None:
679
642
inv.add_path(f, kind=kind)
644
file_id = osutils.safe_file_id(file_id)
681
645
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
646
self._write_inventory(inv)
684
648
@needs_tree_write_lock
685
649
def _gather_kinds(self, files, kinds):
746
710
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
def path_content_summary(self, path, _lstat=os.lstat,
749
_mapper=osutils.file_kind_from_stat_mode):
750
"""See Tree.path_content_summary."""
751
abspath = self.abspath(path)
753
stat_result = _lstat(abspath)
755
if getattr(e, 'errno', None) == errno.ENOENT:
757
return ('missing', None, None, None)
758
# propagate other errors
760
kind = _mapper(stat_result.st_mode)
762
return self._file_content_summary(path, stat_result)
763
elif kind == 'directory':
764
# perhaps it looks like a plain directory, but it's really a
766
if self._directory_is_tree_reference(path):
767
kind = 'tree-reference'
768
return kind, None, None, None
769
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
773
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
return ('file', size, executable, self._sha_from_stat(
712
@deprecated_method(zero_eleven)
714
def pending_merges(self):
715
"""Return a list of pending merges.
717
These are revisions that have been merged into the working
718
directory but not yet committed.
720
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
721
instead - which is available on all tree objects.
723
return self.get_parent_ids()[1:]
782
725
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
726
"""Common ghost checking functionality from set_parent_*.
828
751
:param revision_ids: The revision_ids to set as the parent ids of this
829
752
working tree. Any of these may be ghosts.
754
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
755
self._check_parents_for_ghosts(revision_ids,
832
756
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
758
if len(revision_ids) > 0:
839
759
self.set_last_revision(revision_ids[0])
841
self.set_last_revision(_mod_revision.NULL_REVISION)
761
self.set_last_revision(None)
843
763
self._set_merges_from_parent_ids(revision_ids)
845
765
@needs_tree_write_lock
846
766
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
767
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
768
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
852
770
self._check_parents_for_ghosts(parent_ids,
853
771
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
773
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
774
leftmost_parent_id = None
859
775
leftmost_parent_tree = None
861
777
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
914
818
branch.last_revision().
916
820
from bzrlib.merge import Merger, Merge3Merger
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
821
pb = bzrlib.ui.ui_factory.nested_progress_bar()
823
merger = Merger(self.branch, this_tree=self, pb=pb)
824
merger.pp = ProgressPhase("Merge phase", 5, pb)
825
merger.pp.next_phase()
826
# check that there are no
828
merger.check_basis(check_clean=True, require_commits=False)
829
if to_revision is None:
830
to_revision = branch.last_revision()
832
to_revision = osutils.safe_revision_id(to_revision)
833
merger.other_rev_id = to_revision
834
if merger.other_rev_id is None:
835
raise error.NoCommits(branch)
836
self.branch.fetch(branch, last_revision=merger.other_rev_id)
837
merger.other_basis = merger.other_rev_id
838
merger.other_tree = self.branch.repository.revision_tree(
840
merger.other_branch = branch
841
merger.pp.next_phase()
932
842
merger.find_base()
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
843
if merger.base_rev_id == merger.other_rev_id:
844
raise errors.PointlessMerge
845
merger.backup_files = False
939
846
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
847
merger.set_interesting_files(None)
848
merger.show_base = False
849
merger.reprocess = False
850
conflicts = merger.do_merge()
950
857
def merge_modified(self):
951
858
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
860
The list is initialized by WorkingTree.set_merge_modified, which is
954
861
typically called after we make some automatic updates to the tree
955
862
because of a merge.
1036
939
other_tree.unlock()
1037
940
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
942
@needs_tree_write_lock
1066
943
def extract(self, file_id, format=None):
1067
944
"""Extract a subtree from this tree.
1069
946
A new branch will be created, relative to the path for this tree.
1072
948
def mkdirs(path):
1073
949
segments = osutils.splitpath(path)
1074
950
transport = self.branch.bzrdir.root_transport
1075
951
for name in segments:
1076
952
transport = transport.clone(name)
1077
transport.ensure_base()
955
except errors.FileExists:
1078
957
return transport
1080
959
sub_path = self.id2path(file_id)
1081
960
branch_transport = mkdirs(sub_path)
1082
961
if format is None:
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
962
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
964
branch_transport.mkdir('.')
965
except errors.FileExists:
1085
967
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
969
repo = branch_bzrdir.find_repository()
1088
970
except errors.NoRepositoryPresent:
1089
971
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
972
assert repo.supports_rich_root()
974
if not repo.supports_rich_root():
975
raise errors.RootNotRich()
1092
976
new_branch = branch_bzrdir.create_branch()
1093
977
new_branch.pull(self.branch)
1094
978
for parent_id in self.get_parent_ids():
1127
1009
sio = StringIO()
1128
1010
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1012
self._control_files.put('inventory', sio)
1132
1013
self._inventory_is_modified = False
1134
def _kind(self, relpath):
1135
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
1015
def list_files(self, include_root=False):
1016
"""Recursively list all files as (path, class, kind, id, entry).
1140
1018
Lists, but does not descend into unversioned directories.
1141
1020
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
1023
Skips the control directory.
1148
1025
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1026
# with it. So callers should be careful to always read_lock the tree.
1927
1768
def read_basis_inventory(self):
1928
1769
"""Read the cached basis inventory."""
1929
1770
path = self._basis_inventory_name()
1930
return self._transport.get_bytes(path)
1771
return self._control_files.get(path).read()
1932
1773
@needs_read_lock
1933
1774
def read_working_inventory(self):
1934
1775
"""Read the working inventory.
1936
1777
:raises errors.InventoryModified: read_working_inventory will fail
1937
1778
when the current in memory inventory has been modified.
1939
# conceptually this should be an implementation detail of the tree.
1780
# conceptually this should be an implementation detail of the tree.
1940
1781
# XXX: Deprecate this.
1941
1782
# ElementTree does its own conversion from UTF-8, so open in
1943
1784
if self._inventory_is_modified:
1944
1785
raise errors.InventoryModified(self)
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1786
result = self._deserialize(self._control_files.get('inventory'))
1950
1787
self._set_inventory(result, dirty=False)
1953
1790
@needs_tree_write_lock
1954
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1956
"""Remove nominated files from the working inventory.
1958
:files: File paths relative to the basedir.
1959
:keep_files: If true, the files will also be kept.
1960
:force: Delete files and directories, even if they are changed and
1961
even if the directories are not empty.
1791
def remove(self, files, verbose=False, to_file=None):
1792
"""Remove nominated files from the working inventory..
1794
This does not remove their text. This does not run on XXX on what? RBC
1796
TODO: Refuse to remove modified files unless --force is given?
1798
TODO: Do something useful with directories.
1800
TODO: Should this remove the text or not? Tough call; not
1801
removing may be useful and the user can just use use rm, and
1802
is the opposite of add. Removing it is consistent with most
1803
other tools. Maybe an option.
1805
## TODO: Normalize names
1806
## TODO: Remove nested loops; better scalability
1963
1807
if isinstance(files, basestring):
1964
1808
files = [files]
1969
unknown_nested_files=set()
1971
to_file = sys.stdout
1973
def recurse_directory_to_add_files(directory):
1974
# Recurse directory and add all files
1975
# so we can check if they have changed.
1976
for parent_info, file_infos in\
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1979
# Is it versioned or ignored?
1980
if self.path2id(relpath) or self.is_ignored(relpath):
1981
# Add nested content for deletion.
1982
new_files.add(relpath)
1984
# Files which are not versioned and not ignored
1985
# should be treated as unknown.
1986
unknown_nested_files.add((relpath, None, kind))
1988
for filename in files:
1989
# Get file name into canonical form.
1990
abspath = self.abspath(filename)
1991
filename = self.relpath(abspath)
1992
if len(filename) > 0:
1993
new_files.add(filename)
1994
recurse_directory_to_add_files(filename)
1996
files = list(new_files)
1999
return # nothing to do
2001
# Sort needed to first handle directory content before the directory
2002
files.sort(reverse=True)
2004
# Bail out if we are going to delete files we shouldn't
2005
if not keep_files and not force:
2006
has_changed_files = len(unknown_nested_files) > 0
2007
if not has_changed_files:
2008
for (file_id, path, content_change, versioned, parent_id, name,
2009
kind, executable) in self.iter_changes(self.basis_tree(),
2010
include_unchanged=True, require_versioned=False,
2011
want_unversioned=True, specific_files=files):
2012
if versioned == (False, False):
2013
# The record is unknown ...
2014
if not self.is_ignored(path[1]):
2015
# ... but not ignored
2016
has_changed_files = True
2018
elif content_change and (kind[1] is not None):
2019
# Versioned and changed, but not deleted
2020
has_changed_files = True
2023
if has_changed_files:
2024
# Make delta show ALL applicable changes in error message.
2025
tree_delta = self.changes_from(self.basis_tree(),
2026
require_versioned=False, want_unversioned=True,
2027
specific_files=files)
2028
for unknown_file in unknown_nested_files:
2029
if unknown_file not in tree_delta.unversioned:
2030
tree_delta.unversioned.extend((unknown_file,))
2031
raise errors.BzrRemoveChangedFilesError(tree_delta)
2033
# Build inv_delta and delete files where applicable,
2034
# do this before any modifications to inventory.
1810
inv = self.inventory
1812
# do this before any modifications
2035
1813
for f in files:
2036
fid = self.path2id(f)
1814
fid = inv.path2id(f)
2039
message = "%s is not versioned." % (f,)
1816
note("%s is not versioned."%f)
2042
# having removed it, it must be either ignored or unknown
1819
# having remove it, it must be either ignored or unknown
2043
1820
if self.is_ignored(f):
2044
1821
new_status = 'I'
2046
1823
new_status = '?'
2047
# XXX: Really should be a more abstract reporter interface
2048
kind_ch = osutils.kind_marker(self.kind(fid))
2049
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2051
inv_delta.append((f, None, fid, None))
2052
message = "removed %s" % (f,)
2055
abs_path = self.abspath(f)
2056
if osutils.lexists(abs_path):
2057
if (osutils.isdir(abs_path) and
2058
len(os.listdir(abs_path)) > 0):
2060
osutils.rmtree(abs_path)
2062
message = "%s is not an empty directory "\
2063
"and won't be deleted." % (f,)
2065
osutils.delete_any(abs_path)
2066
message = "deleted %s" % (f,)
2067
elif message is not None:
2068
# Only care if we haven't done anything yet.
2069
message = "%s does not exist." % (f,)
2071
# Print only one message (if any) per file.
2072
if message is not None:
2074
self.apply_inventory_delta(inv_delta)
1824
textui.show_status(new_status, inv[fid].kind, f,
1828
self._write_inventory(inv)
2076
1830
@needs_tree_write_lock
2077
def revert(self, filenames=None, old_tree=None, backups=True,
2078
pb=None, report_changes=False):
1831
def revert(self, filenames, old_tree=None, backups=True,
1832
pb=DummyProgress(), report_changes=False):
2079
1833
from bzrlib.conflicts import resolve
2082
symbol_versioning.warn('Using [] to revert all files is deprecated'
2083
' as of bzr 0.91. Please use None (the default) instead.',
2084
DeprecationWarning, stacklevel=2)
2085
1834
if old_tree is None:
2086
basis_tree = self.basis_tree()
2087
basis_tree.lock_read()
2088
old_tree = basis_tree
1835
old_tree = self.basis_tree()
1836
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1838
if not len(filenames):
1839
self.set_parent_ids(self.get_parent_ids()[:1])
2092
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2094
if filenames is None and len(self.get_parent_ids()) > 1:
2096
last_revision = self.last_revision()
2097
if last_revision != _mod_revision.NULL_REVISION:
2098
if basis_tree is None:
2099
basis_tree = self.basis_tree()
2100
basis_tree.lock_read()
2101
parent_trees.append((last_revision, basis_tree))
2102
self.set_parent_trees(parent_trees)
2105
resolve(self, filenames, ignore_misses=True, recursive=True)
2107
if basis_tree is not None:
1842
resolve(self, filenames, ignore_misses=True)
2109
1843
return conflicts
2111
1845
def revision_tree(self, revision_id):
2266
1995
# cant set that until we update the working trees last revision to be
2267
1996
# one from the new branch, because it will just get absorbed by the
2268
1997
# parent de-duplication logic.
2270
1999
# We MUST save it even if an error occurs, because otherwise the users
2271
2000
# local work is unreferenced and will appear to have been lost.
2275
2004
last_rev = self.get_parent_ids()[0]
2276
2005
except IndexError:
2277
last_rev = _mod_revision.NULL_REVISION
2278
if revision is None:
2279
revision = self.branch.last_revision()
2281
old_tip = old_tip or _mod_revision.NULL_REVISION
2283
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
# the branch we are bound to was updated
2285
# merge those changes in first
2286
base_tree = self.basis_tree()
2287
other_tree = self.branch.repository.revision_tree(old_tip)
2288
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
base_tree, this_tree=self,
2290
change_reporter=change_reporter)
2292
self.add_parent_tree((old_tip, other_tree))
2293
trace.note('Rerun update after fixing the conflicts.')
2296
if last_rev != _mod_revision.ensure_null(revision):
2297
# the working tree is up to date with the branch
2298
# we can merge the specified revision from master
2299
to_tree = self.branch.repository.revision_tree(revision)
2300
to_root_id = to_tree.get_root_id()
2007
if last_rev != self.branch.last_revision():
2008
# merge tree state up to new branch tip.
2302
2009
basis = self.basis_tree()
2303
2010
basis.lock_read()
2305
if (basis.inventory.root is None
2306
or basis.inventory.root.file_id != to_root_id):
2307
self.set_root_id(to_root_id)
2012
to_tree = self.branch.basis_tree()
2013
if basis.inventory.root is None:
2014
self.set_root_id(to_tree.inventory.root.file_id)
2016
result += merge.merge_inner(
2312
# determine the branch point
2313
graph = self.branch.repository.get_graph()
2314
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2316
base_tree = self.branch.repository.revision_tree(base_rev_id)
2318
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2320
change_reporter=change_reporter)
2321
self.set_last_revision(revision)
2322
2023
# TODO - dedup parents list with things merged by pull ?
2323
2024
# reuse the tree we've updated to to set the basis:
2324
parent_trees = [(revision, to_tree)]
2025
parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2026
merges = self.get_parent_ids()[1:]
2326
2027
# Ideally we ask the tree for the trees here, that way the working
2327
# tree can decide whether to give us the entire tree or give us a
2028
# tree can decide whether to give us teh entire tree or give us a
2328
2029
# lazy initialised tree. dirstate for instance will have the trees
2329
2030
# in ram already, whereas a last-revision + basis-inventory tree
2330
2031
# will not, but also does not need them when setting parents.
2331
2032
for parent in merges:
2332
2033
parent_trees.append(
2333
2034
(parent, self.branch.repository.revision_tree(parent)))
2334
if not _mod_revision.is_null(old_tip):
2035
if old_tip is not None:
2335
2036
parent_trees.append(
2336
2037
(old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2038
self.set_parent_trees(parent_trees)
2338
2039
last_rev = parent_trees[0][0]
2041
# the working tree had the same last-revision as the master
2042
# branch did. We may still have pivot local work from the local
2043
# branch into old_tip:
2044
if old_tip is not None:
2045
self.add_parent_tree_id(old_tip)
2046
if old_tip and old_tip != last_rev:
2047
# our last revision was not the prior branch last revision
2048
# and we have converted that last revision to a pending merge.
2049
# base is somewhere between the branch tip now
2050
# and the now pending merge
2052
# Since we just modified the working tree and inventory, flush out
2053
# the current state, before we modify it again.
2054
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2055
# requires it only because TreeTransform directly munges the
2056
# inventory and calls tree._write_inventory(). Ultimately we
2057
# should be able to remove this extra flush.
2059
from bzrlib.revision import common_ancestor
2061
base_rev_id = common_ancestor(self.branch.last_revision(),
2063
self.branch.repository)
2064
except errors.NoCommonAncestor:
2066
base_tree = self.branch.repository.revision_tree(base_rev_id)
2067
other_tree = self.branch.repository.revision_tree(old_tip)
2068
result += merge.merge_inner(
2341
2075
def _write_hashcache_if_dirty(self):
2342
2076
"""Write out the hashcache if it is dirty."""
2582
2289
self.set_conflicts(un_resolved)
2583
2290
return un_resolved, resolved
2586
def _check(self, references):
2587
"""Check the tree for consistency.
2589
:param references: A dict with keys matching the items returned by
2590
self._get_check_refs(), and values from looking those keys up in
2593
tree_basis = self.basis_tree()
2594
tree_basis.lock_read()
2596
repo_basis = references[('trees', self.last_revision())]
2597
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
raise errors.BzrCheckError(
2599
"Mismatched basis inventory content.")
2604
def _validate(self):
2605
"""Validate internal structures.
2607
This is meant mostly for the test suite. To give it a chance to detect
2608
corruption after actions have occurred. The default implementation is a
2611
:return: None. An exception should be raised if there is an error.
2615
def _get_rules_searcher(self, default_searcher):
2616
"""See Tree._get_rules_searcher."""
2617
if self._rules_searcher is None:
2618
self._rules_searcher = super(WorkingTree,
2619
self)._get_rules_searcher(default_searcher)
2620
return self._rules_searcher
2622
def get_shelf_manager(self):
2623
"""Return the ShelfManager for this WorkingTree."""
2624
from bzrlib.shelf import ShelfManager
2625
return ShelfManager(self, self._transport)
2628
2293
class WorkingTree2(WorkingTree):
2629
2294
"""This is the Format 2 working tree.
2631
This was the first weave based working tree.
2296
This was the first weave based working tree.
2632
2297
- uses os locks for locking.
2633
2298
- uses the branch last-revision.
2636
def __init__(self, *args, **kwargs):
2637
super(WorkingTree2, self).__init__(*args, **kwargs)
2638
# WorkingTree2 has more of a constraint that self._inventory must
2639
# exist. Because this is an older format, we don't mind the overhead
2640
# caused by the extra computation here.
2642
# Newer WorkingTree's should only have self._inventory set when they
2644
if self._inventory is None:
2645
self.read_working_inventory()
2647
def _get_check_refs(self):
2648
"""Return the references needed to perform a check of this tree."""
2649
return [('trees', self.last_revision())]
2651
2301
def lock_tree_write(self):
2652
2302
"""See WorkingTree.lock_tree_write().
2654
2304
In Format2 WorkingTrees we have a single lock for the branch and tree
2655
2305
so lock_tree_write() degrades to lock_write().
2657
:return: An object with an unlock method which will release the lock
2660
2307
self.branch.lock_write()
2662
self._control_files.lock_write()
2309
return self._control_files.lock_write()
2665
2311
self.branch.unlock()
2668
2314
def unlock(self):
2669
# do non-implementation specific cleanup
2672
2315
# we share control files:
2673
2316
if self._control_files._lock_count == 3:
2674
2317
# _inventory_is_modified is always False during a read lock.
2675
2318
if self._inventory_is_modified:
2677
2320
self._write_hashcache_if_dirty()
2679
2322
# reverse order of locking.
2681
2324
return self._control_files.unlock()
2856
2495
def unregister_format(klass, format):
2496
assert klass._formats[format.get_format_string()] is format
2857
2497
del klass._formats[format.get_format_string()]
2860
2501
class WorkingTreeFormat2(WorkingTreeFormat):
2861
"""The second working tree format.
2502
"""The second working tree format.
2863
2504
This format modified the hash cache from the format 1 hash cache.
2866
upgrade_recommended = True
2868
2507
def get_format_description(self):
2869
2508
"""See WorkingTreeFormat.get_format_description()."""
2870
2509
return "Working tree format 2"
2872
def _stub_initialize_on_transport(self, transport, file_mode):
2873
"""Workaround: create control files for a remote working tree.
2511
def stub_initialize_remote(self, control_files):
2512
"""As a special workaround create critical control files for a remote working tree
2875
2514
This ensures that it can later be updated and dealt with locally,
2876
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2515
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2877
2516
no working tree. (See bug #43064).
2879
2518
sio = StringIO()
2880
inv = inventory.Inventory()
2881
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2520
xml5.serializer_v5.write_inventory(inv, sio)
2883
transport.put_file('inventory', sio, file_mode)
2884
transport.put_bytes('pending-merges', '', file_mode)
2886
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2887
accelerator_tree=None, hardlink=False):
2522
control_files.put('inventory', sio)
2524
control_files.put_bytes('pending-merges', '')
2527
def initialize(self, a_bzrdir, revision_id=None):
2888
2528
"""See WorkingTreeFormat.initialize()."""
2889
2529
if not isinstance(a_bzrdir.transport, LocalTransport):
2890
2530
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2891
if from_branch is not None:
2892
branch = from_branch
2894
branch = a_bzrdir.open_branch()
2895
if revision_id is None:
2896
revision_id = _mod_revision.ensure_null(branch.last_revision())
2899
branch.generate_revision_history(revision_id)
2902
inv = inventory.Inventory()
2531
branch = a_bzrdir.open_branch()
2532
if revision_id is not None:
2533
revision_id = osutils.safe_revision_id(revision_id)
2536
revision_history = branch.revision_history()
2538
position = revision_history.index(revision_id)
2540
raise errors.NoSuchRevision(branch, revision_id)
2541
branch.set_revision_history(revision_history[:position + 1])
2544
revision = branch.last_revision()
2903
2546
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2906
2549
_internal=True,
2908
2551
_bzrdir=a_bzrdir)
2909
basis_tree = branch.repository.revision_tree(revision_id)
2552
basis_tree = branch.repository.revision_tree(revision)
2910
2553
if basis_tree.inventory.root is not None:
2911
wt.set_root_id(basis_tree.get_root_id())
2554
wt.set_root_id(basis_tree.inventory.root.file_id)
2912
2555
# set the parent list and cache the basis tree.
2913
if _mod_revision.is_null(revision_id):
2916
parent_trees = [(revision_id, basis_tree)]
2917
wt.set_parent_trees(parent_trees)
2556
wt.set_parent_trees([(revision, basis_tree)])
2918
2557
transform.build_tree(basis_tree, wt)
3070
2697
return self.get_format_string()
3073
__default_format = WorkingTreeFormat6()
2700
__default_format = WorkingTreeFormat4()
3074
2701
WorkingTreeFormat.register_format(__default_format)
3075
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
2702
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
2703
WorkingTreeFormat.set_default_format(__default_format)
3079
2704
# formats which have no format string are not discoverable
3080
2705
# and not independently creatable, so are not registered.
3081
2706
_legacy_formats = [WorkingTreeFormat2(),
2710
class WorkingTreeTestProviderAdapter(object):
2711
"""A tool to generate a suite testing multiple workingtree formats at once.
2713
This is done by copying the test once for each transport and injecting
2714
the transport_server, transport_readonly_server, and workingtree_format
2715
classes into each copy. Each copy is also given a new id() to make it
2719
def __init__(self, transport_server, transport_readonly_server, formats):
2720
self._transport_server = transport_server
2721
self._transport_readonly_server = transport_readonly_server
2722
self._formats = formats
2724
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2725
"""Clone test for adaption."""
2726
new_test = deepcopy(test)
2727
new_test.transport_server = self._transport_server
2728
new_test.transport_readonly_server = self._transport_readonly_server
2729
new_test.bzrdir_format = bzrdir_format
2730
new_test.workingtree_format = workingtree_format
2731
def make_new_test_id():
2732
new_id = "%s(%s)" % (test.id(), variation)
2733
return lambda: new_id
2734
new_test.id = make_new_test_id()
2737
def adapt(self, test):
2738
from bzrlib.tests import TestSuite
2739
result = TestSuite()
2740
for workingtree_format, bzrdir_format in self._formats:
2741
new_test = self._clone_test(
2744
workingtree_format, workingtree_format.__class__.__name__)
2745
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
