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
68
revision as _mod_revision,
69
80
import bzrlib.branch
70
81
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
86
from bzrlib import symbol_versioning
79
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lockable_files import LockableFiles
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
81
90
from bzrlib.lockdir import LockDir
82
91
import bzrlib.mutabletree
83
92
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
93
from bzrlib.osutils import (
93
103
supports_executable,
95
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
106
120
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
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
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()
115
144
class TreeEntry(object):
116
145
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
147
This needs further inspection, it may be better to have
119
148
InventoryEntries without ids - though that seems wrong. For now,
120
149
this is a parallel hierarchy to InventoryEntry, and needs to become
121
150
one of several things: decorates to that hierarchy, children of, or
285
290
self._control_files.break_lock()
286
291
self.branch.break_lock()
288
def _get_check_refs(self):
289
"""Return the references needed to perform a check of this tree.
291
The default implementation returns no refs, and is only suitable for
292
trees that have no local caching and can commit on ghosts at any time.
294
:seealso: bzrlib.check for details about check_refs.
298
293
def requires_rich_root(self):
299
294
return self._format.requires_rich_root
301
296
def supports_tree_reference(self):
304
def supports_content_filtering(self):
305
return self._format.supports_content_filtering()
307
def supports_views(self):
308
return self.views.supports_views()
310
299
def _set_inventory(self, inv, dirty):
311
300
"""Set the internal cached inventory.
422
390
# at this point ?
424
392
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
393
except errors.RevisionNotPresent:
426
394
# 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
395
# occured. If the revision is present, its a problem, if its not
429
397
if self.branch.repository.has_revision(revision_id):
431
399
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
400
return self.branch.repository.revision_tree(None)
435
402
def _cleanup(self):
436
403
self._flush_ignore_list_cache()
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
443
def relpath(self, path):
439
444
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
446
The path may be absolute or relative. If its a relative path it is
442
447
interpreted relative to the python current working directory.
444
449
return osutils.relpath(self.basedir, path)
446
451
def has_filename(self, filename):
447
452
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."""
454
def get_file(self, file_id, path=None):
456
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()
457
return self.get_file_byname(path)
459
def get_file_text(self, file_id):
460
return self.get_file(file_id).read()
462
def get_file_byname(self, filename):
463
return file(self.abspath(filename), 'rb')
485
466
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
473
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
474
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)]
476
basis = self.basis_tree()
479
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
480
require_versioned=True).next()
481
changed_content, kind = changes[2], changes[6]
482
if not changed_content:
483
return basis.annotate_iter(file_id)
487
if kind[0] != 'file':
490
old_lines = list(basis.annotate_iter(file_id))
492
for tree in self.branch.repository.revision_trees(
493
self.get_parent_ids()[1:]):
494
if file_id not in tree:
496
old.append(list(tree.annotate_iter(file_id)))
497
return annotate.reannotate(old, self.get_file(file_id).readlines(),
532
502
def _get_ancestors(self, default_revision):
533
503
ancestors = set([default_revision])
570
540
def clone(self, to_bzrdir, revision_id=None):
571
541
"""Duplicate this working tree into to_bzr, including all state.
573
543
Specifically modified files are kept as modified, but
574
544
ignored and unknown files are discarded.
576
546
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
549
If not None, the cloned tree will have its last revision set to
550
revision, and and difference between the source trees last revision
581
551
and this one merged in.
583
553
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
554
result = self._format.initialize(to_bzrdir)
585
555
self.copy_content_into(result, revision_id)
767
729
kind = 'tree-reference'
768
730
return kind, None, None, None
769
731
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
732
return ('symlink', None, None, os.readlink(abspath))
773
734
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(
736
@deprecated_method(zero_eleven)
738
def pending_merges(self):
739
"""Return a list of pending merges.
741
These are revisions that have been merged into the working
742
directory but not yet committed.
744
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
745
instead - which is available on all tree objects.
747
return self.get_parent_ids()[1:]
782
749
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
750
"""Common ghost checking functionality from set_parent_*.
794
761
def _set_merges_from_parent_ids(self, parent_ids):
795
762
merges = parent_ids[1:]
796
self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
mode=self.bzrdir._get_file_mode())
799
def _filter_parent_ids_by_ancestry(self, revision_ids):
800
"""Check that all merged revisions are proper 'heads'.
802
This will always return the first revision_id, and any merged revisions
805
if len(revision_ids) == 0:
807
graph = self.branch.repository.get_graph()
808
heads = graph.heads(revision_ids)
809
new_revision_ids = revision_ids[:1]
810
for revision_id in revision_ids[1:]:
811
if revision_id in heads and revision_id not in new_revision_ids:
812
new_revision_ids.append(revision_id)
813
if new_revision_ids != revision_ids:
814
trace.mutter('requested to set revision_ids = %s,'
815
' but filtered to %s', revision_ids, new_revision_ids)
816
return new_revision_ids
763
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
765
@needs_tree_write_lock
819
766
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
767
"""Set the parent ids to revision_ids.
822
769
See also set_parent_trees. This api will try to retrieve the tree data
823
770
for each element of revision_ids from the trees repository. If you have
824
771
tree data already available, it is more efficient to use
914
856
branch.last_revision().
916
858
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:
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:
939
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()
859
pb = bzrlib.ui.ui_factory.nested_progress_bar()
861
merger = Merger(self.branch, this_tree=self, pb=pb)
862
merger.pp = ProgressPhase("Merge phase", 5, pb)
863
merger.pp.next_phase()
864
# check that there are no
866
merger.check_basis(check_clean=True, require_commits=False)
867
if to_revision is None:
868
to_revision = _mod_revision.ensure_null(branch.last_revision())
869
merger.other_rev_id = to_revision
870
if _mod_revision.is_null(merger.other_rev_id):
871
raise errors.NoCommits(branch)
872
self.branch.fetch(branch, last_revision=merger.other_rev_id)
873
merger.other_basis = merger.other_rev_id
874
merger.other_tree = self.branch.repository.revision_tree(
876
merger.other_branch = branch
877
merger.pp.next_phase()
878
if from_revision is None:
881
merger.set_base_revision(from_revision, branch)
882
if merger.base_rev_id == merger.other_rev_id:
883
raise errors.PointlessMerge
884
merger.backup_files = False
885
if merge_type is None:
886
merger.merge_type = Merge3Merger
888
merger.merge_type = merge_type
889
merger.set_interesting_files(None)
890
merger.show_base = False
891
merger.reprocess = False
892
conflicts = merger.do_merge()
950
899
def merge_modified(self):
951
900
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
902
The list is initialized by WorkingTree.set_merge_modified, which is
954
903
typically called after we make some automatic updates to the tree
955
904
because of a merge.
958
907
still in the working inventory and have that text hash.
961
hashfile = self._transport.get('merge-hashes')
910
hashfile = self._control_files.get('merge-hashes')
962
911
except errors.NoSuchFile:
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
915
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
916
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
merge_hashes[file_id] = text_hash
917
except StopIteration:
918
raise errors.MergeModifiedFormatError()
919
for s in RioReader(hashfile):
920
# RioReader reads in Unicode, so convert file_ids back to utf8
921
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
922
if file_id not in self.inventory:
924
text_hash = s.get("hash")
925
if text_hash == self.get_file_sha1(file_id):
926
merge_hashes[file_id] = text_hash
983
929
@needs_write_lock
984
930
def mkdir(self, path, file_id=None):
1036
980
other_tree.unlock()
1037
981
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
983
def _directory_is_tree_reference(self, relpath):
984
# as a special case, if a directory contains control files then
1052
985
# it's a tree reference, except that the root of the tree is not
1053
986
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
987
# TODO: We could ask all the control formats whether they
1076
1009
transport = transport.clone(name)
1077
1010
transport.ensure_base()
1078
1011
return transport
1080
1013
sub_path = self.id2path(file_id)
1081
1014
branch_transport = mkdirs(sub_path)
1082
1015
if format is None:
1083
format = self.bzrdir.cloning_metadir()
1016
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1084
1017
branch_transport.ensure_base()
1085
1018
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
1020
repo = branch_bzrdir.find_repository()
1088
1021
except errors.NoRepositoryPresent:
1089
1022
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1023
assert repo.supports_rich_root()
1025
if not repo.supports_rich_root():
1026
raise errors.RootNotRich()
1092
1027
new_branch = branch_bzrdir.create_branch()
1093
1028
new_branch.pull(self.branch)
1094
1029
for parent_id in self.get_parent_ids():
1096
1031
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1032
if tree_transport.base != branch_transport.base:
1098
1033
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1034
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1036
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1037
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1038
wt.set_parent_ids(self.get_parent_ids())
1105
1039
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1040
child_inv = Inventory(root_id=None)
1107
1041
new_root = my_inv[file_id]
1108
1042
my_inv.remove_recursive_id(file_id)
1109
1043
new_root.parent_id = None
1127
1061
sio = StringIO()
1128
1062
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1064
self._control_files.put('inventory', sio)
1132
1065
self._inventory_is_modified = False
1134
1067
def _kind(self, relpath):
1135
1068
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).
1070
def list_files(self, include_root=False):
1071
"""Recursively list all files as (path, class, kind, id, entry).
1140
1073
Lists, but does not descend into unversioned directories.
1141
1075
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
1078
Skips the control directory.
1148
1080
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1081
# with it. So callers should be careful to always read_lock the tree.
1164
1096
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1098
# directory file_id, relative path, absolute path, reverse sorted children
1167
if from_dir is not None:
1168
from_dir_id = inv.path2id(from_dir)
1169
if from_dir_id is None:
1170
# Directory not versioned
1172
from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
from_dir_id = inv.root.file_id
1175
from_dir_abspath = self.basedir
1176
children = os.listdir(from_dir_abspath)
1099
children = os.listdir(self.basedir)
1177
1100
children.sort()
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1101
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
1102
# use a deque and popleft to keep them sorted, or if we use a plain
1180
1103
# list and just reverse() them.
1181
1104
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1105
stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1107
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1239
1162
except KeyError:
1240
1163
yield fp[1:], c, fk, None, TreeEntry()
1243
1166
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
1169
# But do this child first
1170
new_children = os.listdir(fap)
1172
new_children = collections.deque(new_children)
1173
stack.append((f_ie.file_id, fp, fap, new_children))
1174
# Break out of inner loop,
1175
# so that we start outer loop with child
1256
1178
# if we finished all children, pop it off the stack
1493
1410
from_tail = splitpath(from_rel)[-1]
1494
1411
from_id = inv.path2id(from_rel)
1495
1412
if from_id is None:
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1413
raise errors.BzrRenameFailedError(from_rel,to_rel,
1414
errors.NotVersionedError(path=str(from_rel)))
1415
from_entry = inv[from_id]
1507
1416
from_parent_id = from_entry.parent_id
1508
1417
to_dir, to_tail = os.path.split(to_rel)
1509
1418
to_dir_id = inv.path2id(to_dir)
1571
1480
:raises: NoSuchId if any fileid is not currently versioned.
1573
1482
for file_id in file_ids:
1574
if file_id not in self._inventory:
1575
raise errors.NoSuchId(self, file_id)
1576
for file_id in file_ids:
1577
1483
if self._inventory.has_id(file_id):
1578
1484
self._inventory.remove_recursive_id(file_id)
1486
raise errors.NoSuchId(self, file_id)
1579
1487
if len(file_ids):
1580
# in the future this should just set a dirty bit to wait for the
1488
# in the future this should just set a dirty bit to wait for the
1581
1489
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1490
# with the current in -memory inventory rather than triggering
1583
1491
# a read, it is more complex - we need to teach read_inventory
1584
1492
# to know when to read, and when to not read first... and possibly
1585
1493
# to save first when the in memory one may be corrupted.
1586
1494
# so for now, we just only write it if it is indeed dirty.
1587
1495
# - RBC 20060907
1588
1496
self._write_inventory(self._inventory)
1498
@deprecated_method(zero_eight)
1499
def iter_conflicts(self):
1500
"""List all files in the tree that have text or content conflicts.
1501
DEPRECATED. Use conflicts instead."""
1502
return self._iter_conflicts()
1590
1504
def _iter_conflicts(self):
1591
1505
conflicted = set()
1601
1515
@needs_write_lock
1602
1516
def pull(self, source, overwrite=False, stop_revision=None,
1603
change_reporter=None, possible_transports=None, local=False):
1517
change_reporter=None, possible_transports=None):
1518
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1519
source.lock_read()
1521
pp = ProgressPhase("Pull phase", 2, top_pb)
1606
1523
old_revision_info = self.branch.last_revision_info()
1607
1524
basis_tree = self.basis_tree()
1608
1525
count = self.branch.pull(source, overwrite, stop_revision,
1609
possible_transports=possible_transports,
1526
possible_transports=possible_transports)
1611
1527
new_revision_info = self.branch.last_revision_info()
1612
1528
if new_revision_info != old_revision_info:
1613
1530
repository = self.branch.repository
1531
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1532
basis_tree.lock_read()
1616
1534
new_basis_tree = self.branch.basis_tree()
1619
1537
new_basis_tree,
1621
1539
this_tree=self,
1623
1541
change_reporter=change_reporter)
1624
basis_root_id = basis_tree.get_root_id()
1625
new_root_id = new_basis_tree.get_root_id()
1626
if basis_root_id != new_root_id:
1627
self.set_root_id(new_root_id)
1542
if (basis_tree.inventory.root is None and
1543
new_basis_tree.inventory.root is not None):
1544
self.set_root_id(new_basis_tree.inventory.root.file_id)
1629
1547
basis_tree.unlock()
1630
1548
# TODO - dedup parents list with things merged by pull ?
1631
1549
# reuse the revisiontree we merged against to set the new
1633
1551
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
# we have to pull the merge trees out again, because
1635
# merge_inner has set the ids. - this corner is not yet
1552
# we have to pull the merge trees out again, because
1553
# merge_inner has set the ids. - this corner is not yet
1636
1554
# layered well enough to prevent double handling.
1637
1555
# XXX TODO: Fix the double handling: telling the tree about
1638
1556
# the already known parent data is wasteful.
1734
1646
r"""Check whether the filename matches an ignore pattern.
1736
1648
Patterns containing '/' or '\' need to match the whole path;
1737
others match against only the last component. Patterns starting
1738
with '!' are ignore exceptions. Exceptions take precedence
1739
over regular patterns and cause the filename to not be ignored.
1649
others match against only the last component.
1741
1651
If the file is ignored, returns the pattern which caused it to
1742
1652
be ignored, otherwise None. So this can simply be used as a
1743
1653
boolean if desired."""
1744
1654
if getattr(self, '_ignoreglobster', None) is None:
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1655
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1656
return self._ignoreglobster.match(filename)
1748
1658
def kind(self, file_id):
1749
1659
return file_kind(self.id2abspath(file_id))
1751
def stored_kind(self, file_id):
1752
"""See Tree.stored_kind"""
1753
return self.inventory[file_id].kind
1755
1661
def _comparison_data(self, entry, path):
1756
1662
abspath = self.abspath(path)
1798
1704
raise errors.ObjectNotLocked(self)
1800
1706
def lock_read(self):
1801
"""Lock the tree for reading.
1803
This also locks the branch, and can be unlocked via self.unlock().
1805
:return: An object with an unlock method which will release the lock
1707
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1708
if not self.is_locked():
1809
1709
self._reset_data()
1810
1710
self.branch.lock_read()
1812
self._control_files.lock_read()
1712
return self._control_files.lock_read()
1815
1714
self.branch.unlock()
1818
1717
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: An object with an unlock method which will release the lock
1718
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1824
1719
if not self.is_locked():
1825
1720
self._reset_data()
1826
1721
self.branch.lock_read()
1828
self._control_files.lock_write()
1723
return self._control_files.lock_write()
1831
1725
self.branch.unlock()
1834
1728
def lock_write(self):
1835
"""See MutableTree.lock_write, and WorkingTree.unlock.
1837
:return: An object with an unlock method which will release the lock
1729
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1840
1730
if not self.is_locked():
1841
1731
self._reset_data()
1842
1732
self.branch.lock_write()
1844
self._control_files.lock_write()
1734
return self._control_files.lock_write()
1847
1736
self.branch.unlock()
1903
1788
# as commit already has that ready-to-use [while the format is the
1904
1789
# same, that is].
1906
# this double handles the inventory - unpack and repack -
1791
# this double handles the inventory - unpack and repack -
1907
1792
# but is easier to understand. We can/should put a conditional
1908
1793
# in here based on whether the inventory is in the latest format
1909
1794
# - perhaps we should repack all inventories on a repository
1911
1796
# the fast path is to copy the raw xml from the repository. If the
1912
# xml contains 'revision_id="', then we assume the right
1797
# xml contains 'revision_id="', then we assume the right
1913
1798
# revision_id is set. We must check for this full string, because a
1914
1799
# root node id can legitimately look like 'revision_id' but cannot
1915
1800
# contain a '"'.
1916
xml = self.branch.repository._get_inventory_xml(new_revision)
1801
xml = self.branch.repository.get_inventory_xml(new_revision)
1917
1802
firstline = xml.split('\n', 1)[0]
1918
if (not 'revision_id="' in firstline or
1803
if (not 'revision_id="' in firstline or
1919
1804
'format="7"' not in firstline):
1920
inv = self.branch.repository._serializer.read_inventory_from_string(
1805
inv = self.branch.repository.deserialise_inventory(
1922
1807
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
1808
self._write_basis_inventory(xml)
1924
1809
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1927
1812
def read_basis_inventory(self):
1928
1813
"""Read the cached basis inventory."""
1929
1814
path = self._basis_inventory_name()
1930
return self._transport.get_bytes(path)
1815
return self._control_files.get(path).read()
1932
1817
@needs_read_lock
1933
1818
def read_working_inventory(self):
1934
1819
"""Read the working inventory.
1936
1821
:raises errors.InventoryModified: read_working_inventory will fail
1937
1822
when the current in memory inventory has been modified.
1939
# conceptually this should be an implementation detail of the tree.
1824
# conceptually this should be an implementation detail of the tree.
1940
1825
# XXX: Deprecate this.
1941
1826
# ElementTree does its own conversion from UTF-8, so open in
1943
1828
if self._inventory_is_modified:
1944
1829
raise errors.InventoryModified(self)
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1830
result = self._deserialize(self._control_files.get('inventory'))
1950
1831
self._set_inventory(result, dirty=False)
1968
1849
new_files=set()
1969
1850
unknown_nested_files=set()
1971
to_file = sys.stdout
1973
1852
def recurse_directory_to_add_files(directory):
1974
1853
# Recurse directory and add all files
1975
1854
# so we can check if they have changed.
1976
1855
for parent_info, file_infos in\
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1856
osutils.walkdirs(self.abspath(directory),
1858
for relpath, basename, kind, lstat, abspath in file_infos:
1979
1859
# Is it versioned or ignored?
1980
1860
if self.path2id(relpath) or self.is_ignored(relpath):
1981
1861
# Add nested content for deletion.
2006
1887
has_changed_files = len(unknown_nested_files) > 0
2007
1888
if not has_changed_files:
2008
1889
for (file_id, path, content_change, versioned, parent_id, name,
2009
kind, executable) in self.iter_changes(self.basis_tree(),
1890
kind, executable) in self._iter_changes(self.basis_tree(),
2010
1891
include_unchanged=True, require_versioned=False,
2011
1892
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
1893
# Check if it's an unknown (but not ignored) OR
1894
# changed (but not deleted) :
1895
if not self.is_ignored(path[1]) and (
1896
versioned == (False, False) or
1897
content_change and kind[1] != None):
2020
1898
has_changed_files = True
2159
2037
@needs_tree_write_lock
2160
2038
def set_root_id(self, file_id):
2161
2039
"""Set the root id for this tree."""
2163
2041
if file_id is None:
2165
'WorkingTree.set_root_id with fileid=None')
2166
file_id = osutils.safe_file_id(file_id)
2042
symbol_versioning.warn(symbol_versioning.zero_twelve
2043
% 'WorkingTree.set_root_id with fileid=None',
2048
file_id = osutils.safe_file_id(file_id)
2167
2049
self._set_root_id(file_id)
2169
2051
def _set_root_id(self, file_id):
2170
2052
"""Set the root id for this tree, in a format specific manner.
2172
:param file_id: The file id to assign to the root. It must not be
2054
:param file_id: The file id to assign to the root. It must not be
2173
2055
present in the current inventory or an error will occur. It must
2174
2056
not be None, but rather a valid file id.
2195
2077
def unlock(self):
2196
2078
"""See Branch.unlock.
2198
2080
WorkingTree locking just uses the Branch locking facilities.
2199
2081
This is current because all working trees have an embedded branch
2200
2082
within them. IF in the future, we were to make branch data shareable
2201
between multiple working trees, i.e. via shared storage, then we
2083
between multiple working trees, i.e. via shared storage, then we
2202
2084
would probably want to lock both the local tree, and the branch.
2204
2086
raise NotImplementedError(self.unlock)
2208
def update(self, change_reporter=None, possible_transports=None,
2209
revision=None, old_tip=_marker):
2088
def update(self, change_reporter=None, possible_transports=None):
2210
2089
"""Update a working tree along its branch.
2212
2091
This will update the branch if its bound too, which means we have
2266
2138
# cant set that until we update the working trees last revision to be
2267
2139
# one from the new branch, because it will just get absorbed by the
2268
2140
# parent de-duplication logic.
2270
2142
# We MUST save it even if an error occurs, because otherwise the users
2271
2143
# local work is unreferenced and will appear to have been lost.
2275
2147
last_rev = self.get_parent_ids()[0]
2276
2148
except IndexError:
2277
2149
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()
2150
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2151
# merge tree state up to new branch tip.
2302
2152
basis = self.basis_tree()
2303
2153
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)
2155
to_tree = self.branch.basis_tree()
2156
if basis.inventory.root is None:
2157
self.set_root_id(to_tree.inventory.root.file_id)
2159
result += merge.merge_inner(
2164
change_reporter=change_reporter)
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
2167
# TODO - dedup parents list with things merged by pull ?
2323
2168
# reuse the tree we've updated to to set the basis:
2324
parent_trees = [(revision, to_tree)]
2169
parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2170
merges = self.get_parent_ids()[1:]
2326
2171
# 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
2172
# tree can decide whether to give us teh entire tree or give us a
2328
2173
# lazy initialised tree. dirstate for instance will have the trees
2329
2174
# in ram already, whereas a last-revision + basis-inventory tree
2330
2175
# will not, but also does not need them when setting parents.
2331
2176
for parent in merges:
2332
2177
parent_trees.append(
2333
2178
(parent, self.branch.repository.revision_tree(parent)))
2334
if not _mod_revision.is_null(old_tip):
2179
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2335
2180
parent_trees.append(
2336
2181
(old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2182
self.set_parent_trees(parent_trees)
2338
2183
last_rev = parent_trees[0][0]
2185
# the working tree had the same last-revision as the master
2186
# branch did. We may still have pivot local work from the local
2187
# branch into old_tip:
2188
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2189
self.add_parent_tree_id(old_tip)
2190
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2191
and old_tip != last_rev):
2192
# our last revision was not the prior branch last revision
2193
# and we have converted that last revision to a pending merge.
2194
# base is somewhere between the branch tip now
2195
# and the now pending merge
2197
# Since we just modified the working tree and inventory, flush out
2198
# the current state, before we modify it again.
2199
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2200
# requires it only because TreeTransform directly munges the
2201
# inventory and calls tree._write_inventory(). Ultimately we
2202
# should be able to remove this extra flush.
2204
graph = self.branch.repository.get_graph()
2205
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2207
base_tree = self.branch.repository.revision_tree(base_rev_id)
2208
other_tree = self.branch.repository.revision_tree(old_tip)
2209
result += merge.merge_inner(
2214
change_reporter=change_reporter)
2341
2217
def _write_hashcache_if_dirty(self):
2342
2218
"""Write out the hashcache if it is dirty."""
2426
2302
current_inv = None
2427
2303
inv_finished = True
2428
2304
while not inv_finished or not disk_finished:
2430
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2431
cur_disk_dir_content) = current_disk
2433
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
cur_disk_dir_content) = ((None, None), None)
2435
2305
if not disk_finished:
2436
2306
# strip out .bzr dirs
2437
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2438
len(cur_disk_dir_content) > 0):
2439
# osutils.walkdirs can be made nicer -
2307
if current_disk[0][1][top_strip_len:] == '':
2308
# osutils.walkdirs can be made nicer -
2440
2309
# yield the path-from-prefix rather than the pathjoined
2442
bzrdir_loc = bisect_left(cur_disk_dir_content,
2444
if (bzrdir_loc < len(cur_disk_dir_content)
2445
and self.bzrdir.is_control_filename(
2446
cur_disk_dir_content[bzrdir_loc][0])):
2311
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2312
if current_disk[1][bzrdir_loc][0] == '.bzr':
2447
2313
# we dont yield the contents of, or, .bzr itself.
2448
del cur_disk_dir_content[bzrdir_loc]
2314
del current_disk[1][bzrdir_loc]
2449
2315
if inv_finished:
2450
2316
# everything is unknown
2453
2319
# everything is missing
2456
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2322
direction = cmp(current_inv[0][0], current_disk[0][0])
2457
2323
if direction > 0:
2458
2324
# disk is before inventory - unknown
2459
2325
dirblock = [(relpath, basename, kind, stat, None, None) for
2460
relpath, basename, kind, stat, top_path in
2461
cur_disk_dir_content]
2462
yield (cur_disk_dir_relpath, None), dirblock
2326
relpath, basename, kind, stat, top_path in current_disk[1]]
2327
yield (current_disk[0][0], None), dirblock
2464
2329
current_disk = disk_iterator.next()
2465
2330
except StopIteration:
2540
2404
# FIXME: stash the node in pending
2541
2405
entry = inv[top_id]
2542
if entry.kind == 'directory':
2543
for name, child in entry.sorted_children():
2544
dirblock.append((relroot + name, name, child.kind, None,
2545
child.file_id, child.kind
2406
for name, child in entry.sorted_children():
2407
dirblock.append((relroot + name, name, child.kind, None,
2408
child.file_id, child.kind
2547
2410
yield (currentdir[0], entry.file_id), dirblock
2548
2411
# push the user specified dirs from dirblock
2549
2412
for dir in reversed(dirblock):
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
2460
class WorkingTree2(WorkingTree):
2629
2461
"""This is the Format 2 working tree.
2631
This was the first weave based working tree.
2463
This was the first weave based working tree.
2632
2464
- uses os locks for locking.
2633
2465
- uses the branch last-revision.
2697
2521
def _last_revision(self):
2698
2522
"""See Mutable.last_revision."""
2700
return self._transport.get_bytes('last-revision')
2524
return self._control_files.get('last-revision').read()
2701
2525
except errors.NoSuchFile:
2702
2526
return _mod_revision.NULL_REVISION
2704
2528
def _change_last_revision(self, revision_id):
2705
2529
"""See WorkingTree._change_last_revision."""
2706
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2530
if revision_id is None or revision_id == NULL_REVISION:
2708
self._transport.delete('last-revision')
2532
self._control_files._transport.delete('last-revision')
2709
2533
except errors.NoSuchFile:
2713
self._transport.put_bytes('last-revision', revision_id,
2714
mode=self.bzrdir._get_file_mode())
2537
self._control_files.put_bytes('last-revision', revision_id)
2717
def _get_check_refs(self):
2718
"""Return the references needed to perform a check of this tree."""
2719
return [('trees', self.last_revision())]
2721
2540
@needs_tree_write_lock
2722
2541
def set_conflicts(self, conflicts):
2723
self._put_rio('conflicts', conflicts.to_stanzas(),
2542
self._put_rio('conflicts', conflicts.to_stanzas(),
2724
2543
CONFLICT_HEADER_1)
2726
2545
@needs_tree_write_lock
2869
2693
"""See WorkingTreeFormat.get_format_description()."""
2870
2694
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.
2696
def stub_initialize_remote(self, control_files):
2697
"""As a special workaround create critical control files for a remote working tree
2875
2699
This ensures that it can later be updated and dealt with locally,
2876
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2700
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2877
2701
no working tree. (See bug #43064).
2879
2703
sio = StringIO()
2880
inv = inventory.Inventory()
2881
2705
xml5.serializer_v5.write_inventory(inv, sio, working=True)
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):
2707
control_files.put('inventory', sio)
2709
control_files.put_bytes('pending-merges', '')
2712
def initialize(self, a_bzrdir, revision_id=None):
2888
2713
"""See WorkingTreeFormat.initialize()."""
2889
2714
if not isinstance(a_bzrdir.transport, LocalTransport):
2890
2715
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2891
if from_branch is not None:
2892
branch = from_branch
2894
branch = a_bzrdir.open_branch()
2716
branch = a_bzrdir.open_branch()
2895
2717
if revision_id is None:
2896
2718
revision_id = _mod_revision.ensure_null(branch.last_revision())
2897
2719
branch.lock_write()
2974
2796
def _open_control_files(self, a_bzrdir):
2975
2797
transport = a_bzrdir.get_workingtree_transport(None)
2976
return LockableFiles(transport, self._lock_file_name,
2798
return LockableFiles(transport, self._lock_file_name,
2977
2799
self._lock_class)
2979
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
accelerator_tree=None, hardlink=False):
2801
def initialize(self, a_bzrdir, revision_id=None):
2981
2802
"""See WorkingTreeFormat.initialize().
2983
:param revision_id: if supplied, create a working tree at a different
2984
revision than the branch is at.
2985
:param accelerator_tree: A tree which can be used for retrieving file
2986
contents more quickly than the revision tree, i.e. a workingtree.
2987
The revision tree will be used for cases where accelerator_tree's
2988
content is different.
2989
:param hardlink: If true, hard-link files from accelerator_tree,
2804
revision_id allows creating a working tree at a different
2805
revision than the branch is at.
2992
2807
if not isinstance(a_bzrdir.transport, LocalTransport):
2993
2808
raise errors.NotLocalUrl(a_bzrdir.transport.base)
added
removed
bzrlib/workingtree.py
