13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
23
new revision based on the workingtree and its inventory.
25
25
At the moment every WorkingTree has its own branch. Remote
51
59
conflicts as _mod_conflicts,
60
67
revision as _mod_revision,
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
94
103
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
107
120
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
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
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)
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()
116
144
class TreeEntry(object):
117
145
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
147
This needs further inspection, it may be better to have
120
148
InventoryEntries without ids - though that seems wrong. For now,
121
149
this is a parallel hierarchy to InventoryEntry, and needs to become
122
150
one of several things: decorates to that hierarchy, children of, or
286
300
self._control_files.break_lock()
287
301
self.branch.break_lock()
289
def _get_check_refs(self):
290
"""Return the references needed to perform a check of this tree.
292
The default implementation returns no refs, and is only suitable for
293
trees that have no local caching and can commit on ghosts at any time.
295
:seealso: bzrlib.check for details about check_refs.
299
303
def requires_rich_root(self):
300
304
return self._format.requires_rich_root
302
306
def supports_tree_reference(self):
305
def supports_content_filtering(self):
306
return self._format.supports_content_filtering()
308
def supports_views(self):
309
return self.views.supports_views()
311
309
def _set_inventory(self, inv, dirty):
312
310
"""Set the internal cached inventory.
423
400
# at this point ?
425
402
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
403
except errors.RevisionNotPresent:
427
404
# 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
405
# occured. If the revision is present, its a problem, if its not
430
407
if self.branch.repository.has_revision(revision_id):
432
409
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
410
return self.branch.repository.revision_tree(None)
436
412
def _cleanup(self):
437
413
self._flush_ignore_list_cache()
416
@deprecated_method(zero_eight)
417
def create(branch, directory):
418
"""Create a workingtree for branch at directory.
420
If existing_directory already exists it must have a .bzr directory.
421
If it does not exist, it will be created.
423
This returns a new WorkingTree object for the new checkout.
425
TODO FIXME RBC 20060124 when we have checkout formats in place this
426
should accept an optional revisionid to checkout [and reject this if
427
checking out into the same dir as a pre-checkout-aware branch format.]
429
XXX: When BzrDir is present, these should be created through that
432
warnings.warn('delete WorkingTree.create', stacklevel=3)
433
transport = get_transport(directory)
434
if branch.bzrdir.root_transport.base == transport.base:
436
return branch.bzrdir.create_workingtree()
437
# different directory,
438
# create a branch reference
439
# and now a working tree.
440
raise NotImplementedError
443
@deprecated_method(zero_eight)
444
def create_standalone(directory):
445
"""Create a checkout and a branch and a repo at directory.
447
Directory must exist and be empty.
449
please use BzrDir.create_standalone_workingtree
451
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
453
def relpath(self, path):
440
454
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
456
The path may be absolute or relative. If its a relative path it is
443
457
interpreted relative to the python current working directory.
445
459
return osutils.relpath(self.basedir, path)
447
461
def has_filename(self, filename):
448
462
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."""
464
def get_file(self, file_id, path=None):
457
466
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
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
467
return self.get_file_byname(path)
469
def get_file_text(self, file_id):
470
return self.get_file(file_id).read()
472
def get_file_byname(self, filename):
473
return file(self.abspath(filename), 'rb')
486
476
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
483
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
484
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
486
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(),
533
512
def _get_ancestors(self, default_revision):
534
513
ancestors = set([default_revision])
571
550
def clone(self, to_bzrdir, revision_id=None):
572
551
"""Duplicate this working tree into to_bzr, including all state.
574
553
Specifically modified files are kept as modified, but
575
554
ignored and unknown files are discarded.
577
556
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
559
If not None, the cloned tree will have its last revision set to
560
revision, and and difference between the source trees last revision
582
561
and this one merged in.
584
563
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
564
result = self._format.initialize(to_bzrdir)
586
565
self.copy_content_into(result, revision_id)
768
739
kind = 'tree-reference'
769
740
return kind, None, None, None
770
741
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
742
return ('symlink', None, None, os.readlink(abspath))
774
744
return (kind, None, None, None)
776
def _file_content_summary(self, path, stat_result):
777
size = stat_result.st_size
778
executable = self._is_executable_from_path_and_stat(path, stat_result)
779
# try for a stat cache lookup
780
return ('file', size, executable, self._sha_from_stat(
746
@deprecated_method(zero_eleven)
748
def pending_merges(self):
749
"""Return a list of pending merges.
751
These are revisions that have been merged into the working
752
directory but not yet committed.
754
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
755
instead - which is available on all tree objects.
757
return self.get_parent_ids()[1:]
783
759
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
760
"""Common ghost checking functionality from set_parent_*.
795
771
def _set_merges_from_parent_ids(self, parent_ids):
796
772
merges = parent_ids[1:]
797
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
800
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
"""Check that all merged revisions are proper 'heads'.
803
This will always return the first revision_id, and any merged revisions
806
if len(revision_ids) == 0:
808
graph = self.branch.repository.get_graph()
809
heads = graph.heads(revision_ids)
810
new_revision_ids = revision_ids[:1]
811
for revision_id in revision_ids[1:]:
812
if revision_id in heads and revision_id not in new_revision_ids:
813
new_revision_ids.append(revision_id)
814
if new_revision_ids != revision_ids:
815
trace.mutter('requested to set revision_ids = %s,'
816
' but filtered to %s', revision_ids, new_revision_ids)
817
return new_revision_ids
773
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
819
775
@needs_tree_write_lock
820
776
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
777
"""Set the parent ids to revision_ids.
823
779
See also set_parent_trees. This api will try to retrieve the tree data
824
780
for each element of revision_ids from the trees repository. If you have
825
781
tree data already available, it is more efficient to use
915
866
branch.last_revision().
917
868
from bzrlib.merge import Merger, Merge3Merger
918
merger = Merger(self.branch, this_tree=self)
919
# check that there are no local alterations
920
if not force and self.has_changes():
921
raise errors.UncommittedChanges(self)
922
if to_revision is None:
923
to_revision = _mod_revision.ensure_null(branch.last_revision())
924
merger.other_rev_id = to_revision
925
if _mod_revision.is_null(merger.other_rev_id):
926
raise errors.NoCommits(branch)
927
self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
merger.other_basis = merger.other_rev_id
929
merger.other_tree = self.branch.repository.revision_tree(
931
merger.other_branch = branch
932
if from_revision is None:
935
merger.set_base_revision(from_revision, branch)
936
if merger.base_rev_id == merger.other_rev_id:
937
raise errors.PointlessMerge
938
merger.backup_files = False
939
if merge_type is None:
940
merger.merge_type = Merge3Merger
942
merger.merge_type = merge_type
943
merger.set_interesting_files(None)
944
merger.show_base = False
945
merger.reprocess = False
946
conflicts = merger.do_merge()
869
pb = bzrlib.ui.ui_factory.nested_progress_bar()
871
merger = Merger(self.branch, this_tree=self, pb=pb)
872
merger.pp = ProgressPhase("Merge phase", 5, pb)
873
merger.pp.next_phase()
874
# check that there are no
876
merger.check_basis(check_clean=True, require_commits=False)
877
if to_revision is None:
878
to_revision = _mod_revision.ensure_null(branch.last_revision())
879
merger.other_rev_id = to_revision
880
if _mod_revision.is_null(merger.other_rev_id):
881
raise errors.NoCommits(branch)
882
self.branch.fetch(branch, last_revision=merger.other_rev_id)
883
merger.other_basis = merger.other_rev_id
884
merger.other_tree = self.branch.repository.revision_tree(
886
merger.other_branch = branch
887
merger.pp.next_phase()
888
if from_revision is None:
891
merger.set_base_revision(from_revision, branch)
892
if merger.base_rev_id == merger.other_rev_id:
893
raise errors.PointlessMerge
894
merger.backup_files = False
895
if merge_type is None:
896
merger.merge_type = Merge3Merger
898
merger.merge_type = merge_type
899
merger.set_interesting_files(None)
900
merger.show_base = False
901
merger.reprocess = False
902
conflicts = merger.do_merge()
951
909
def merge_modified(self):
952
910
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
912
The list is initialized by WorkingTree.set_merge_modified, which is
955
913
typically called after we make some automatic updates to the tree
956
914
because of a merge.
959
917
still in the working inventory and have that text hash.
962
hashfile = self._transport.get('merge-hashes')
920
hashfile = self._control_files.get('merge-hashes')
963
921
except errors.NoSuchFile:
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
925
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
926
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
927
except StopIteration:
928
raise errors.MergeModifiedFormatError()
929
for s in RioReader(hashfile):
930
# RioReader reads in Unicode, so convert file_ids back to utf8
931
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
932
if file_id not in self.inventory:
934
text_hash = s.get("hash")
935
if text_hash == self.get_file_sha1(file_id):
936
merge_hashes[file_id] = text_hash
984
939
@needs_write_lock
985
940
def mkdir(self, path, file_id=None):
1037
990
other_tree.unlock()
1038
991
other_tree.bzrdir.retire_bzrdir()
1040
def _setup_directory_is_tree_reference(self):
1041
if self._branch.repository._format.supports_tree_reference:
1042
self._directory_is_tree_reference = \
1043
self._directory_may_be_tree_reference
1045
self._directory_is_tree_reference = \
1046
self._directory_is_never_tree_reference
1048
def _directory_is_never_tree_reference(self, relpath):
1051
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
993
def _directory_is_tree_reference(self, relpath):
994
# as a special case, if a directory contains control files then
1053
995
# it's a tree reference, except that the root of the tree is not
1054
996
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
997
# TODO: We could ask all the control formats whether they
1077
1019
transport = transport.clone(name)
1078
1020
transport.ensure_base()
1079
1021
return transport
1081
1023
sub_path = self.id2path(file_id)
1082
1024
branch_transport = mkdirs(sub_path)
1083
1025
if format is None:
1084
format = self.bzrdir.cloning_metadir()
1026
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1085
1027
branch_transport.ensure_base()
1086
1028
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
1030
repo = branch_bzrdir.find_repository()
1089
1031
except errors.NoRepositoryPresent:
1090
1032
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
1033
assert repo.supports_rich_root()
1035
if not repo.supports_rich_root():
1036
raise errors.RootNotRich()
1093
1037
new_branch = branch_bzrdir.create_branch()
1094
1038
new_branch.pull(self.branch)
1095
1039
for parent_id in self.get_parent_ids():
1097
1041
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1042
if tree_transport.base != branch_transport.base:
1099
1043
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1044
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
1046
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1047
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1048
wt.set_parent_ids(self.get_parent_ids())
1106
1049
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1050
child_inv = Inventory(root_id=None)
1108
1051
new_root = my_inv[file_id]
1109
1052
my_inv.remove_recursive_id(file_id)
1110
1053
new_root.parent_id = None
1128
1071
sio = StringIO()
1129
1072
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1074
self._control_files.put('inventory', sio)
1133
1075
self._inventory_is_modified = False
1135
1077
def _kind(self, relpath):
1136
1078
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
1080
def list_files(self, include_root=False):
1081
"""Recursively list all files as (path, class, kind, id, entry).
1141
1083
Lists, but does not descend into unversioned directories.
1142
1085
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
1088
Skips the control directory.
1149
1090
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1091
# with it. So callers should be careful to always read_lock the tree.
1165
1106
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
1108
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1109
children = os.listdir(self.basedir)
1178
1110
children.sort()
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1111
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
1112
# use a deque and popleft to keep them sorted, or if we use a plain
1181
1113
# list and just reverse() them.
1182
1114
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1115
stack = [(inv.root.file_id, u'', self.basedir, children)]
1185
1117
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1240
1172
except KeyError:
1241
1173
yield fp[1:], c, fk, None, TreeEntry()
1244
1176
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1179
# But do this child first
1180
new_children = os.listdir(fap)
1182
new_children = collections.deque(new_children)
1183
stack.append((f_ie.file_id, fp, fap, new_children))
1184
# Break out of inner loop,
1185
# so that we start outer loop with child
1257
1188
# if we finished all children, pop it off the stack
1494
1423
from_tail = splitpath(from_rel)[-1]
1495
1424
from_id = inv.path2id(from_rel)
1496
1425
if from_id is None:
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1426
raise errors.BzrRenameFailedError(from_rel,to_rel,
1427
errors.NotVersionedError(path=str(from_rel)))
1428
from_entry = inv[from_id]
1508
1429
from_parent_id = from_entry.parent_id
1509
1430
to_dir, to_tail = os.path.split(to_rel)
1510
1431
to_dir_id = inv.path2id(to_dir)
1572
1493
:raises: NoSuchId if any fileid is not currently versioned.
1574
1495
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1578
1496
if self._inventory.has_id(file_id):
1579
1497
self._inventory.remove_recursive_id(file_id)
1499
raise errors.NoSuchId(self, file_id)
1580
1500
if len(file_ids):
1581
# in the future this should just set a dirty bit to wait for the
1501
# in the future this should just set a dirty bit to wait for the
1582
1502
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1503
# with the current in -memory inventory rather than triggering
1584
1504
# a read, it is more complex - we need to teach read_inventory
1585
1505
# to know when to read, and when to not read first... and possibly
1586
1506
# to save first when the in memory one may be corrupted.
1587
1507
# so for now, we just only write it if it is indeed dirty.
1588
1508
# - RBC 20060907
1589
1509
self._write_inventory(self._inventory)
1511
@deprecated_method(zero_eight)
1512
def iter_conflicts(self):
1513
"""List all files in the tree that have text or content conflicts.
1514
DEPRECATED. Use conflicts instead."""
1515
return self._iter_conflicts()
1591
1517
def _iter_conflicts(self):
1592
1518
conflicted = set()
1602
1528
@needs_write_lock
1603
1529
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1530
change_reporter=None, possible_transports=None):
1531
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1532
source.lock_read()
1534
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
1536
old_revision_info = self.branch.last_revision_info()
1608
1537
basis_tree = self.basis_tree()
1609
1538
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1539
possible_transports=possible_transports)
1612
1540
new_revision_info = self.branch.last_revision_info()
1613
1541
if new_revision_info != old_revision_info:
1614
1543
repository = self.branch.repository
1544
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1545
basis_tree.lock_read()
1617
1547
new_basis_tree = self.branch.basis_tree()
1620
1550
new_basis_tree,
1622
1552
this_tree=self,
1624
1554
change_reporter=change_reporter)
1625
basis_root_id = basis_tree.get_root_id()
1626
new_root_id = new_basis_tree.get_root_id()
1627
if basis_root_id != new_root_id:
1628
self.set_root_id(new_root_id)
1555
if (basis_tree.inventory.root is None and
1556
new_basis_tree.inventory.root is not None):
1557
self.set_root_id(new_basis_tree.get_root_id())
1630
1560
basis_tree.unlock()
1631
1561
# TODO - dedup parents list with things merged by pull ?
1632
1562
# reuse the revisiontree we merged against to set the new
1634
1564
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
# we have to pull the merge trees out again, because
1636
# merge_inner has set the ids. - this corner is not yet
1565
# we have to pull the merge trees out again, because
1566
# merge_inner has set the ids. - this corner is not yet
1637
1567
# layered well enough to prevent double handling.
1638
1568
# XXX TODO: Fix the double handling: telling the tree about
1639
1569
# the already known parent data is wasteful.
1735
1659
r"""Check whether the filename matches an ignore pattern.
1737
1661
Patterns containing '/' or '\' need to match the whole path;
1738
others match against only the last component. Patterns starting
1739
with '!' are ignore exceptions. Exceptions take precedence
1740
over regular patterns and cause the filename to not be ignored.
1662
others match against only the last component.
1742
1664
If the file is ignored, returns the pattern which caused it to
1743
1665
be ignored, otherwise None. So this can simply be used as a
1744
1666
boolean if desired."""
1745
1667
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1668
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1669
return self._ignoreglobster.match(filename)
1749
1671
def kind(self, file_id):
1750
1672
return file_kind(self.id2abspath(file_id))
1752
def stored_kind(self, file_id):
1753
"""See Tree.stored_kind"""
1754
return self.inventory[file_id].kind
1756
1674
def _comparison_data(self, entry, path):
1757
1675
abspath = self.abspath(path)
1799
1717
raise errors.ObjectNotLocked(self)
1801
1719
def lock_read(self):
1802
"""Lock the tree for reading.
1804
This also locks the branch, and can be unlocked via self.unlock().
1806
:return: A bzrlib.lock.LogicalLockResult.
1720
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1721
if not self.is_locked():
1809
1722
self._reset_data()
1810
1723
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1725
return self._control_files.lock_read()
1815
1727
self.branch.unlock()
1818
1730
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1731
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1732
if not self.is_locked():
1824
1733
self._reset_data()
1825
1734
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1736
return self._control_files.lock_write()
1830
1738
self.branch.unlock()
1833
1741
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1742
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1743
if not self.is_locked():
1839
1744
self._reset_data()
1840
1745
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1747
return self._control_files.lock_write()
1845
1749
self.branch.unlock()
1901
1801
# as commit already has that ready-to-use [while the format is the
1902
1802
# same, that is].
1904
# this double handles the inventory - unpack and repack -
1804
# this double handles the inventory - unpack and repack -
1905
1805
# but is easier to understand. We can/should put a conditional
1906
1806
# in here based on whether the inventory is in the latest format
1907
1807
# - perhaps we should repack all inventories on a repository
1909
1809
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1810
# xml contains 'revision_id="', then we assume the right
1911
1811
# revision_id is set. We must check for this full string, because a
1912
1812
# root node id can legitimately look like 'revision_id' but cannot
1913
1813
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1814
xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1815
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1816
if (not 'revision_id="' in firstline or
1917
1817
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1818
inv = self.branch.repository.deserialise_inventory(
1920
1820
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1821
self._write_basis_inventory(xml)
1922
1822
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1825
def read_basis_inventory(self):
1926
1826
"""Read the cached basis inventory."""
1927
1827
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1828
return self._control_files.get(path).read()
1930
1830
@needs_read_lock
1931
1831
def read_working_inventory(self):
1932
1832
"""Read the working inventory.
1934
1834
:raises errors.InventoryModified: read_working_inventory will fail
1935
1835
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1837
# conceptually this should be an implementation detail of the tree.
1938
1838
# XXX: Deprecate this.
1939
1839
# ElementTree does its own conversion from UTF-8, so open in
1941
1841
if self._inventory_is_modified:
1942
1842
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1843
result = self._deserialize(self._control_files.get('inventory'))
1948
1844
self._set_inventory(result, dirty=False)
1966
1862
new_files=set()
1967
1863
unknown_nested_files=set()
1969
to_file = sys.stdout
1971
1865
def recurse_directory_to_add_files(directory):
1972
1866
# Recurse directory and add all files
1973
1867
# so we can check if they have changed.
1974
1868
for parent_info, file_infos in\
1975
self.walkdirs(directory):
1976
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1869
osutils.walkdirs(self.abspath(directory),
1871
for relpath, basename, kind, lstat, abspath in file_infos:
1977
1872
# Is it versioned or ignored?
1978
1873
if self.path2id(relpath) or self.is_ignored(relpath):
1979
1874
# Add nested content for deletion.
2157
2053
@needs_tree_write_lock
2158
2054
def set_root_id(self, file_id):
2159
2055
"""Set the root id for this tree."""
2161
2057
if file_id is None:
2163
'WorkingTree.set_root_id with fileid=None')
2164
file_id = osutils.safe_file_id(file_id)
2058
symbol_versioning.warn(symbol_versioning.zero_twelve
2059
% 'WorkingTree.set_root_id with fileid=None',
2064
file_id = osutils.safe_file_id(file_id)
2165
2065
self._set_root_id(file_id)
2167
2067
def _set_root_id(self, file_id):
2168
2068
"""Set the root id for this tree, in a format specific manner.
2170
:param file_id: The file id to assign to the root. It must not be
2070
:param file_id: The file id to assign to the root. It must not be
2171
2071
present in the current inventory or an error will occur. It must
2172
2072
not be None, but rather a valid file id.
2193
2093
def unlock(self):
2194
2094
"""See Branch.unlock.
2196
2096
WorkingTree locking just uses the Branch locking facilities.
2197
2097
This is current because all working trees have an embedded branch
2198
2098
within them. IF in the future, we were to make branch data shareable
2199
between multiple working trees, i.e. via shared storage, then we
2099
between multiple working trees, i.e. via shared storage, then we
2200
2100
would probably want to lock both the local tree, and the branch.
2202
2102
raise NotImplementedError(self.unlock)
2206
def update(self, change_reporter=None, possible_transports=None,
2207
revision=None, old_tip=_marker):
2104
def update(self, change_reporter=None, possible_transports=None):
2208
2105
"""Update a working tree along its branch.
2210
2107
This will update the branch if its bound too, which means we have
2264
2154
# cant set that until we update the working trees last revision to be
2265
2155
# one from the new branch, because it will just get absorbed by the
2266
2156
# parent de-duplication logic.
2268
2158
# We MUST save it even if an error occurs, because otherwise the users
2269
2159
# local work is unreferenced and will appear to have been lost.
2273
2163
last_rev = self.get_parent_ids()[0]
2274
2164
except IndexError:
2275
2165
last_rev = _mod_revision.NULL_REVISION
2276
if revision is None:
2277
revision = self.branch.last_revision()
2279
old_tip = old_tip or _mod_revision.NULL_REVISION
2281
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
# the branch we are bound to was updated
2283
# merge those changes in first
2284
base_tree = self.basis_tree()
2285
other_tree = self.branch.repository.revision_tree(old_tip)
2286
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
base_tree, this_tree=self,
2288
change_reporter=change_reporter)
2290
self.add_parent_tree((old_tip, other_tree))
2291
trace.note('Rerun update after fixing the conflicts.')
2294
if last_rev != _mod_revision.ensure_null(revision):
2295
# the working tree is up to date with the branch
2296
# we can merge the specified revision from master
2297
to_tree = self.branch.repository.revision_tree(revision)
2298
to_root_id = to_tree.get_root_id()
2166
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2167
# merge tree state up to new branch tip.
2300
2168
basis = self.basis_tree()
2301
2169
basis.lock_read()
2303
if (basis.inventory.root is None
2304
or basis.inventory.root.file_id != to_root_id):
2305
self.set_root_id(to_root_id)
2171
to_tree = self.branch.basis_tree()
2172
if basis.inventory.root is None:
2173
self.set_root_id(to_tree.get_root_id())
2175
result += merge.merge_inner(
2180
change_reporter=change_reporter)
2310
# determine the branch point
2311
graph = self.branch.repository.get_graph()
2312
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
change_reporter=change_reporter)
2319
self.set_last_revision(revision)
2320
2183
# TODO - dedup parents list with things merged by pull ?
2321
2184
# reuse the tree we've updated to to set the basis:
2322
parent_trees = [(revision, to_tree)]
2185
parent_trees = [(self.branch.last_revision(), to_tree)]
2323
2186
merges = self.get_parent_ids()[1:]
2324
2187
# Ideally we ask the tree for the trees here, that way the working
2325
# tree can decide whether to give us the entire tree or give us a
2188
# tree can decide whether to give us teh entire tree or give us a
2326
2189
# lazy initialised tree. dirstate for instance will have the trees
2327
2190
# in ram already, whereas a last-revision + basis-inventory tree
2328
2191
# will not, but also does not need them when setting parents.
2329
2192
for parent in merges:
2330
2193
parent_trees.append(
2331
2194
(parent, self.branch.repository.revision_tree(parent)))
2332
if not _mod_revision.is_null(old_tip):
2195
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2333
2196
parent_trees.append(
2334
2197
(old_tip, self.branch.repository.revision_tree(old_tip)))
2335
2198
self.set_parent_trees(parent_trees)
2336
2199
last_rev = parent_trees[0][0]
2201
# the working tree had the same last-revision as the master
2202
# branch did. We may still have pivot local work from the local
2203
# branch into old_tip:
2204
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2205
self.add_parent_tree_id(old_tip)
2206
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2207
and old_tip != last_rev):
2208
# our last revision was not the prior branch last revision
2209
# and we have converted that last revision to a pending merge.
2210
# base is somewhere between the branch tip now
2211
# and the now pending merge
2213
# Since we just modified the working tree and inventory, flush out
2214
# the current state, before we modify it again.
2215
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2216
# requires it only because TreeTransform directly munges the
2217
# inventory and calls tree._write_inventory(). Ultimately we
2218
# should be able to remove this extra flush.
2220
graph = self.branch.repository.get_graph()
2221
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2223
base_tree = self.branch.repository.revision_tree(base_rev_id)
2224
other_tree = self.branch.repository.revision_tree(old_tip)
2225
result += merge.merge_inner(
2230
change_reporter=change_reporter)
2339
2233
def _write_hashcache_if_dirty(self):
2340
2234
"""Write out the hashcache if it is dirty."""
2538
2430
# FIXME: stash the node in pending
2539
2431
entry = inv[top_id]
2540
if entry.kind == 'directory':
2541
for name, child in entry.sorted_children():
2542
dirblock.append((relroot + name, name, child.kind, None,
2543
child.file_id, child.kind
2432
for name, child in entry.sorted_children():
2433
dirblock.append((relroot + name, name, child.kind, None,
2434
child.file_id, child.kind
2545
2436
yield (currentdir[0], entry.file_id), dirblock
2546
2437
# push the user specified dirs from dirblock
2547
2438
for dir in reversed(dirblock):
2613
def _get_rules_searcher(self, default_searcher):
2614
"""See Tree._get_rules_searcher."""
2615
if self._rules_searcher is None:
2616
self._rules_searcher = super(WorkingTree,
2617
self)._get_rules_searcher(default_searcher)
2618
return self._rules_searcher
2620
def get_shelf_manager(self):
2621
"""Return the ShelfManager for this WorkingTree."""
2622
from bzrlib.shelf import ShelfManager
2623
return ShelfManager(self, self._transport)
2626
2486
class WorkingTree2(WorkingTree):
2627
2487
"""This is the Format 2 working tree.
2629
This was the first weave based working tree.
2489
This was the first weave based working tree.
2630
2490
- uses os locks for locking.
2631
2491
- uses the branch last-revision.
2695
2547
def _last_revision(self):
2696
2548
"""See Mutable.last_revision."""
2698
return self._transport.get_bytes('last-revision')
2550
return self._control_files.get('last-revision').read()
2699
2551
except errors.NoSuchFile:
2700
2552
return _mod_revision.NULL_REVISION
2702
2554
def _change_last_revision(self, revision_id):
2703
2555
"""See WorkingTree._change_last_revision."""
2704
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2556
if revision_id is None or revision_id == NULL_REVISION:
2706
self._transport.delete('last-revision')
2558
self._control_files._transport.delete('last-revision')
2707
2559
except errors.NoSuchFile:
2711
self._transport.put_bytes('last-revision', revision_id,
2712
mode=self.bzrdir._get_file_mode())
2563
self._control_files.put_bytes('last-revision', revision_id)
2715
def _get_check_refs(self):
2716
"""Return the references needed to perform a check of this tree."""
2717
return [('trees', self.last_revision())]
2719
2566
@needs_tree_write_lock
2720
2567
def set_conflicts(self, conflicts):
2721
self._put_rio('conflicts', conflicts.to_stanzas(),
2568
self._put_rio('conflicts', conflicts.to_stanzas(),
2722
2569
CONFLICT_HEADER_1)
2724
2571
@needs_tree_write_lock
2867
2719
"""See WorkingTreeFormat.get_format_description()."""
2868
2720
return "Working tree format 2"
2870
def _stub_initialize_on_transport(self, transport, file_mode):
2871
"""Workaround: create control files for a remote working tree.
2722
def stub_initialize_remote(self, control_files):
2723
"""As a special workaround create critical control files for a remote working tree
2873
2725
This ensures that it can later be updated and dealt with locally,
2874
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2726
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2875
2727
no working tree. (See bug #43064).
2877
2729
sio = StringIO()
2878
inv = inventory.Inventory()
2879
2731
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
transport.put_file('inventory', sio, file_mode)
2882
transport.put_bytes('pending-merges', '', file_mode)
2884
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2885
accelerator_tree=None, hardlink=False):
2733
control_files.put('inventory', sio)
2735
control_files.put_bytes('pending-merges', '')
2738
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2886
2739
"""See WorkingTreeFormat.initialize()."""
2887
2740
if not isinstance(a_bzrdir.transport, LocalTransport):
2888
2741
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2972
2825
def _open_control_files(self, a_bzrdir):
2973
2826
transport = a_bzrdir.get_workingtree_transport(None)
2974
return LockableFiles(transport, self._lock_file_name,
2827
return LockableFiles(transport, self._lock_file_name,
2975
2828
self._lock_class)
2977
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2978
accelerator_tree=None, hardlink=False):
2830
def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
2979
2831
"""See WorkingTreeFormat.initialize().
2981
:param revision_id: if supplied, create a working tree at a different
2982
revision than the branch is at.
2983
:param accelerator_tree: A tree which can be used for retrieving file
2984
contents more quickly than the revision tree, i.e. a workingtree.
2985
The revision tree will be used for cases where accelerator_tree's
2986
content is different.
2987
:param hardlink: If true, hard-link files from accelerator_tree,
2833
revision_id allows creating a working tree at a different
2834
revision than the branch is at.
2990
2836
if not isinstance(a_bzrdir.transport, LocalTransport):
2991
2837
raise errors.NotLocalUrl(a_bzrdir.transport.base)
added
removed
bzrlib/workingtree.py
