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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
59
51
conflicts as _mod_conflicts,
68
60
revision as _mod_revision,
80
69
import bzrlib.branch
81
70
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
71
from bzrlib.workingtree_4 import (
86
78
from bzrlib import symbol_versioning
87
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
80
from bzrlib.lockable_files import LockableFiles
90
81
from bzrlib.lockdir import LockDir
91
82
import bzrlib.mutabletree
92
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
93
85
from bzrlib.osutils import (
103
93
supports_executable,
95
from bzrlib.filters import filtered_input_file
105
96
from bzrlib.trace import mutter, note
106
97
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
98
from bzrlib.revision import CURRENT_REVISION
109
99
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
120
106
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.
121
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
112
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()
144
115
class TreeEntry(object):
145
116
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
118
This needs further inspection, it may be better to have
148
119
InventoryEntries without ids - though that seems wrong. For now,
149
120
this is a parallel hierarchy to InventoryEntry, and needs to become
150
121
one of several things: decorates to that hierarchy, children of, or
290
285
self._control_files.break_lock()
291
286
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.
293
298
def requires_rich_root(self):
294
299
return self._format.requires_rich_root
296
301
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()
299
310
def _set_inventory(self, inv, dirty):
300
311
"""Set the internal cached inventory.
390
422
# at this point ?
392
424
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
394
426
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
427
# occurred. If the revision is present, its a problem, if its not
397
429
if self.branch.repository.has_revision(revision_id):
399
431
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
402
435
def _cleanup(self):
403
436
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)
443
438
def relpath(self, path):
444
439
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
441
The path may be absolute or relative. If its a relative path it is
447
442
interpreted relative to the python current working directory.
449
444
return osutils.relpath(self.basedir, path)
451
446
def has_filename(self, filename):
452
447
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id, path=None):
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
456
path = self.id2path(file_id)
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')
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
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
473
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
474
493
attribution will be correct).
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(),
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)]
502
532
def _get_ancestors(self, default_revision):
503
533
ancestors = set([default_revision])
540
570
def clone(self, to_bzrdir, revision_id=None):
541
571
"""Duplicate this working tree into to_bzr, including all state.
543
573
Specifically modified files are kept as modified, but
544
574
ignored and unknown files are discarded.
546
576
If you want to make a new line of development, see bzrdir.sprout()
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
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
551
581
and this one merged in.
553
583
# assumes the target bzr dir format is compatible.
554
result = self._format.initialize(to_bzrdir)
584
result = to_bzrdir.create_workingtree()
555
585
self.copy_content_into(result, revision_id)
729
767
kind = 'tree-reference'
730
768
return kind, None, None, None
731
769
elif kind == 'symlink':
732
return ('symlink', None, None, os.readlink(abspath))
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
734
773
return (kind, None, None, None)
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:]
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(
749
782
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
750
783
"""Common ghost checking functionality from set_parent_*.
761
794
def _set_merges_from_parent_ids(self, parent_ids):
762
795
merges = parent_ids[1:]
763
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
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
765
818
@needs_tree_write_lock
766
819
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
767
820
"""Set the parent ids to revision_ids.
769
822
See also set_parent_trees. This api will try to retrieve the tree data
770
823
for each element of revision_ids from the trees repository. If you have
771
824
tree data already available, it is more efficient to use
856
914
branch.last_revision().
858
916
from bzrlib.merge import Merger, Merge3Merger
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()
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()
899
950
def merge_modified(self):
900
951
"""Return a dictionary of files modified by a merge.
902
The list is initialized by WorkingTree.set_merge_modified, which is
953
The list is initialized by WorkingTree.set_merge_modified, which is
903
954
typically called after we make some automatic updates to the tree
904
955
because of a merge.
907
958
still in the working inventory and have that text hash.
910
hashfile = self._control_files.get('merge-hashes')
961
hashfile = self._transport.get('merge-hashes')
911
962
except errors.NoSuchFile:
915
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
916
970
raise errors.MergeModifiedFormatError()
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
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
929
983
@needs_write_lock
930
984
def mkdir(self, path, file_id=None):
980
1036
other_tree.unlock()
981
1037
other_tree.bzrdir.retire_bzrdir()
983
def _directory_is_tree_reference(self, relpath):
984
# as a special case, if a directory contains control files then
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
985
1052
# it's a tree reference, except that the root of the tree is not
986
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
987
1054
# TODO: We could ask all the control formats whether they
1009
1076
transport = transport.clone(name)
1010
1077
transport.ensure_base()
1011
1078
return transport
1013
1080
sub_path = self.id2path(file_id)
1014
1081
branch_transport = mkdirs(sub_path)
1015
1082
if format is None:
1016
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1083
format = self.bzrdir.cloning_metadir()
1017
1084
branch_transport.ensure_base()
1018
1085
branch_bzrdir = format.initialize_on_transport(branch_transport)
1020
1087
repo = branch_bzrdir.find_repository()
1021
1088
except errors.NoRepositoryPresent:
1022
1089
repo = branch_bzrdir.create_repository()
1023
assert repo.supports_rich_root()
1025
if not repo.supports_rich_root():
1026
raise errors.RootNotRich()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1027
1092
new_branch = branch_bzrdir.create_branch()
1028
1093
new_branch.pull(self.branch)
1029
1094
for parent_id in self.get_parent_ids():
1031
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1032
1097
if tree_transport.base != branch_transport.base:
1033
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1034
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1036
1102
tree_bzrdir = branch_bzrdir
1037
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1038
1104
wt.set_parent_ids(self.get_parent_ids())
1039
1105
my_inv = self.inventory
1040
child_inv = Inventory(root_id=None)
1106
child_inv = inventory.Inventory(root_id=None)
1041
1107
new_root = my_inv[file_id]
1042
1108
my_inv.remove_recursive_id(file_id)
1043
1109
new_root.parent_id = None
1061
1127
sio = StringIO()
1062
1128
self._serialize(self._inventory, sio)
1064
self._control_files.put('inventory', sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1065
1132
self._inventory_is_modified = False
1067
1134
def _kind(self, relpath):
1068
1135
return osutils.file_kind(self.abspath(relpath))
1070
def list_files(self, include_root=False):
1071
"""Recursively list all files as (path, class, kind, id, entry).
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
1073
1140
Lists, but does not descend into unversioned directories.
1075
1141
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1078
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
1080
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1081
1149
# with it. So callers should be careful to always read_lock the tree.
1096
1164
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1098
1166
# directory file_id, relative path, absolute path, reverse sorted children
1099
children = os.listdir(self.basedir)
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)
1100
1177
children.sort()
1101
# jam 20060527 The kernel sized tree seems equivalent whether we
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1102
1179
# use a deque and popleft to keep them sorted, or if we use a plain
1103
1180
# list and just reverse() them.
1104
1181
children = collections.deque(children)
1105
stack = [(inv.root.file_id, u'', self.basedir, children)]
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1107
1184
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1162
1239
except KeyError:
1163
1240
yield fp[1:], c, fk, None, TreeEntry()
1166
1243
if fk != 'directory':
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
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
1178
1256
# if we finished all children, pop it off the stack
1410
1493
from_tail = splitpath(from_rel)[-1]
1411
1494
from_id = inv.path2id(from_rel)
1412
1495
if from_id is None:
1413
raise errors.BzrRenameFailedError(from_rel,to_rel,
1414
errors.NotVersionedError(path=str(from_rel)))
1415
from_entry = inv[from_id]
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]
1416
1507
from_parent_id = from_entry.parent_id
1417
1508
to_dir, to_tail = os.path.split(to_rel)
1418
1509
to_dir_id = inv.path2id(to_dir)
1480
1571
:raises: NoSuchId if any fileid is not currently versioned.
1482
1573
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:
1483
1577
if self._inventory.has_id(file_id):
1484
1578
self._inventory.remove_recursive_id(file_id)
1486
raise errors.NoSuchId(self, file_id)
1487
1579
if len(file_ids):
1488
# in the future this should just set a dirty bit to wait for the
1580
# in the future this should just set a dirty bit to wait for the
1489
1581
# final unlock. However, until all methods of workingtree start
1490
# with the current in -memory inventory rather than triggering
1582
# with the current in -memory inventory rather than triggering
1491
1583
# a read, it is more complex - we need to teach read_inventory
1492
1584
# to know when to read, and when to not read first... and possibly
1493
1585
# to save first when the in memory one may be corrupted.
1494
1586
# so for now, we just only write it if it is indeed dirty.
1495
1587
# - RBC 20060907
1496
1588
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()
1504
1590
def _iter_conflicts(self):
1505
1591
conflicted = set()
1515
1601
@needs_write_lock
1516
1602
def pull(self, source, overwrite=False, stop_revision=None,
1517
change_reporter=None, possible_transports=None):
1518
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1603
change_reporter=None, possible_transports=None, local=False):
1519
1604
source.lock_read()
1521
pp = ProgressPhase("Pull phase", 2, top_pb)
1523
1606
old_revision_info = self.branch.last_revision_info()
1524
1607
basis_tree = self.basis_tree()
1525
1608
count = self.branch.pull(source, overwrite, stop_revision,
1526
possible_transports=possible_transports)
1609
possible_transports=possible_transports,
1527
1611
new_revision_info = self.branch.last_revision_info()
1528
1612
if new_revision_info != old_revision_info:
1530
1613
repository = self.branch.repository
1531
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1532
1614
basis_tree.lock_read()
1534
1616
new_basis_tree = self.branch.basis_tree()
1537
1619
new_basis_tree,
1539
1621
this_tree=self,
1541
1623
change_reporter=change_reporter)
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)
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)
1547
1629
basis_tree.unlock()
1548
1630
# TODO - dedup parents list with things merged by pull ?
1549
1631
# reuse the revisiontree we merged against to set the new
1551
1633
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1552
# we have to pull the merge trees out again, because
1553
# merge_inner has set the ids. - this corner is not yet
1634
# we have to pull the merge trees out again, because
1635
# merge_inner has set the ids. - this corner is not yet
1554
1636
# layered well enough to prevent double handling.
1555
1637
# XXX TODO: Fix the double handling: telling the tree about
1556
1638
# the already known parent data is wasteful.
1646
1734
r"""Check whether the filename matches an ignore pattern.
1648
1736
Patterns containing '/' or '\' need to match the whole path;
1649
others match against only the last component.
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.
1651
1741
If the file is ignored, returns the pattern which caused it to
1652
1742
be ignored, otherwise None. So this can simply be used as a
1653
1743
boolean if desired."""
1654
1744
if getattr(self, '_ignoreglobster', None) is None:
1655
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1656
1746
return self._ignoreglobster.match(filename)
1658
1748
def kind(self, file_id):
1659
1749
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
1661
1755
def _comparison_data(self, entry, path):
1662
1756
abspath = self.abspath(path)
1704
1798
raise errors.ObjectNotLocked(self)
1706
1800
def lock_read(self):
1707
"""See Branch.lock_read, and WorkingTree.unlock."""
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
1708
1808
if not self.is_locked():
1709
1809
self._reset_data()
1710
1810
self.branch.lock_read()
1712
return self._control_files.lock_read()
1812
self._control_files.lock_read()
1714
1815
self.branch.unlock()
1717
1818
def lock_tree_write(self):
1718
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: An object with an unlock method which will release the lock
1719
1824
if not self.is_locked():
1720
1825
self._reset_data()
1721
1826
self.branch.lock_read()
1723
return self._control_files.lock_write()
1828
self._control_files.lock_write()
1725
1831
self.branch.unlock()
1728
1834
def lock_write(self):
1729
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1835
"""See MutableTree.lock_write, and WorkingTree.unlock.
1837
:return: An object with an unlock method which will release the lock
1730
1840
if not self.is_locked():
1731
1841
self._reset_data()
1732
1842
self.branch.lock_write()
1734
return self._control_files.lock_write()
1844
self._control_files.lock_write()
1736
1847
self.branch.unlock()
1788
1903
# as commit already has that ready-to-use [while the format is the
1789
1904
# same, that is].
1791
# this double handles the inventory - unpack and repack -
1906
# this double handles the inventory - unpack and repack -
1792
1907
# but is easier to understand. We can/should put a conditional
1793
1908
# in here based on whether the inventory is in the latest format
1794
1909
# - perhaps we should repack all inventories on a repository
1796
1911
# the fast path is to copy the raw xml from the repository. If the
1797
# xml contains 'revision_id="', then we assume the right
1912
# xml contains 'revision_id="', then we assume the right
1798
1913
# revision_id is set. We must check for this full string, because a
1799
1914
# root node id can legitimately look like 'revision_id' but cannot
1800
1915
# contain a '"'.
1801
xml = self.branch.repository.get_inventory_xml(new_revision)
1916
xml = self.branch.repository._get_inventory_xml(new_revision)
1802
1917
firstline = xml.split('\n', 1)[0]
1803
if (not 'revision_id="' in firstline or
1918
if (not 'revision_id="' in firstline or
1804
1919
'format="7"' not in firstline):
1805
inv = self.branch.repository.deserialise_inventory(
1920
inv = self.branch.repository._serializer.read_inventory_from_string(
1807
1922
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1808
1923
self._write_basis_inventory(xml)
1809
1924
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1812
1927
def read_basis_inventory(self):
1813
1928
"""Read the cached basis inventory."""
1814
1929
path = self._basis_inventory_name()
1815
return self._control_files.get(path).read()
1930
return self._transport.get_bytes(path)
1817
1932
@needs_read_lock
1818
1933
def read_working_inventory(self):
1819
1934
"""Read the working inventory.
1821
1936
:raises errors.InventoryModified: read_working_inventory will fail
1822
1937
when the current in memory inventory has been modified.
1824
# conceptually this should be an implementation detail of the tree.
1939
# conceptually this should be an implementation detail of the tree.
1825
1940
# XXX: Deprecate this.
1826
1941
# ElementTree does its own conversion from UTF-8, so open in
1828
1943
if self._inventory_is_modified:
1829
1944
raise errors.InventoryModified(self)
1830
result = self._deserialize(self._control_files.get('inventory'))
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1831
1950
self._set_inventory(result, dirty=False)
1849
1968
new_files=set()
1850
1969
unknown_nested_files=set()
1971
to_file = sys.stdout
1852
1973
def recurse_directory_to_add_files(directory):
1853
1974
# Recurse directory and add all files
1854
1975
# so we can check if they have changed.
1855
1976
for parent_info, file_infos in\
1856
osutils.walkdirs(self.abspath(directory),
1858
for relpath, basename, kind, lstat, abspath in file_infos:
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1859
1979
# Is it versioned or ignored?
1860
1980
if self.path2id(relpath) or self.is_ignored(relpath):
1861
1981
# Add nested content for deletion.
1887
2006
has_changed_files = len(unknown_nested_files) > 0
1888
2007
if not has_changed_files:
1889
2008
for (file_id, path, content_change, versioned, parent_id, name,
1890
kind, executable) in self._iter_changes(self.basis_tree(),
2009
kind, executable) in self.iter_changes(self.basis_tree(),
1891
2010
include_unchanged=True, require_versioned=False,
1892
2011
want_unversioned=True, specific_files=files):
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):
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
1898
2020
has_changed_files = True
1960
2083
' as of bzr 0.91. Please use None (the default) instead.',
1961
2084
DeprecationWarning, stacklevel=2)
1962
2085
if old_tree is None:
1963
old_tree = self.basis_tree()
1964
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1966
if filenames is None:
1967
self.set_parent_ids(self.get_parent_ids()[:1])
2086
basis_tree = self.basis_tree()
2087
basis_tree.lock_read()
2088
old_tree = basis_tree
1970
resolve(self, filenames, ignore_misses=True)
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:
1971
2109
return conflicts
1973
2111
def revision_tree(self, revision_id):
2022
2159
@needs_tree_write_lock
2023
2160
def set_root_id(self, file_id):
2024
2161
"""Set the root id for this tree."""
2026
2163
if file_id is None:
2027
symbol_versioning.warn(symbol_versioning.zero_twelve
2028
% 'WorkingTree.set_root_id with fileid=None',
2033
file_id = osutils.safe_file_id(file_id)
2165
'WorkingTree.set_root_id with fileid=None')
2166
file_id = osutils.safe_file_id(file_id)
2034
2167
self._set_root_id(file_id)
2036
2169
def _set_root_id(self, file_id):
2037
2170
"""Set the root id for this tree, in a format specific manner.
2039
:param file_id: The file id to assign to the root. It must not be
2172
:param file_id: The file id to assign to the root. It must not be
2040
2173
present in the current inventory or an error will occur. It must
2041
2174
not be None, but rather a valid file id.
2062
2195
def unlock(self):
2063
2196
"""See Branch.unlock.
2065
2198
WorkingTree locking just uses the Branch locking facilities.
2066
2199
This is current because all working trees have an embedded branch
2067
2200
within them. IF in the future, we were to make branch data shareable
2068
between multiple working trees, i.e. via shared storage, then we
2201
between multiple working trees, i.e. via shared storage, then we
2069
2202
would probably want to lock both the local tree, and the branch.
2071
2204
raise NotImplementedError(self.unlock)
2073
def update(self, change_reporter=None, possible_transports=None):
2208
def update(self, change_reporter=None, possible_transports=None,
2209
revision=None, old_tip=_marker):
2074
2210
"""Update a working tree along its branch.
2076
2212
This will update the branch if its bound too, which means we have
2123
2266
# cant set that until we update the working trees last revision to be
2124
2267
# one from the new branch, because it will just get absorbed by the
2125
2268
# parent de-duplication logic.
2127
2270
# We MUST save it even if an error occurs, because otherwise the users
2128
2271
# local work is unreferenced and will appear to have been lost.
2132
2275
last_rev = self.get_parent_ids()[0]
2133
2276
except IndexError:
2134
2277
last_rev = _mod_revision.NULL_REVISION
2135
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2136
# merge tree state up to new branch tip.
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()
2137
2302
basis = self.basis_tree()
2138
2303
basis.lock_read()
2140
to_tree = self.branch.basis_tree()
2141
if basis.inventory.root is None:
2142
self.set_root_id(to_tree.inventory.root.file_id)
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)
2144
result += merge.merge_inner(
2149
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)
2152
2322
# TODO - dedup parents list with things merged by pull ?
2153
2323
# reuse the tree we've updated to to set the basis:
2154
parent_trees = [(self.branch.last_revision(), to_tree)]
2324
parent_trees = [(revision, to_tree)]
2155
2325
merges = self.get_parent_ids()[1:]
2156
2326
# Ideally we ask the tree for the trees here, that way the working
2157
# tree can decide whether to give us teh entire tree or give us a
2327
# tree can decide whether to give us the entire tree or give us a
2158
2328
# lazy initialised tree. dirstate for instance will have the trees
2159
2329
# in ram already, whereas a last-revision + basis-inventory tree
2160
2330
# will not, but also does not need them when setting parents.
2161
2331
for parent in merges:
2162
2332
parent_trees.append(
2163
2333
(parent, self.branch.repository.revision_tree(parent)))
2164
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
if not _mod_revision.is_null(old_tip):
2165
2335
parent_trees.append(
2166
2336
(old_tip, self.branch.repository.revision_tree(old_tip)))
2167
2337
self.set_parent_trees(parent_trees)
2168
2338
last_rev = parent_trees[0][0]
2170
# the working tree had the same last-revision as the master
2171
# branch did. We may still have pivot local work from the local
2172
# branch into old_tip:
2173
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2174
self.add_parent_tree_id(old_tip)
2175
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2176
and old_tip != last_rev):
2177
# our last revision was not the prior branch last revision
2178
# and we have converted that last revision to a pending merge.
2179
# base is somewhere between the branch tip now
2180
# and the now pending merge
2182
# Since we just modified the working tree and inventory, flush out
2183
# the current state, before we modify it again.
2184
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2185
# requires it only because TreeTransform directly munges the
2186
# inventory and calls tree._write_inventory(). Ultimately we
2187
# should be able to remove this extra flush.
2189
graph = self.branch.repository.get_graph()
2190
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2192
base_tree = self.branch.repository.revision_tree(base_rev_id)
2193
other_tree = self.branch.repository.revision_tree(old_tip)
2194
result += merge.merge_inner(
2199
change_reporter=change_reporter)
2202
2341
def _write_hashcache_if_dirty(self):
2203
2342
"""Write out the hashcache if it is dirty."""
2287
2426
current_inv = None
2288
2427
inv_finished = True
2289
2428
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)
2290
2435
if not disk_finished:
2291
2436
# strip out .bzr dirs
2292
if current_disk[0][1][top_strip_len:] == '':
2293
# osutils.walkdirs can be made nicer -
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 -
2294
2440
# yield the path-from-prefix rather than the pathjoined
2296
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2297
if current_disk[1][bzrdir_loc][0] == '.bzr':
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])):
2298
2447
# we dont yield the contents of, or, .bzr itself.
2299
del current_disk[1][bzrdir_loc]
2448
del cur_disk_dir_content[bzrdir_loc]
2300
2449
if inv_finished:
2301
2450
# everything is unknown
2304
2453
# everything is missing
2307
direction = cmp(current_inv[0][0], current_disk[0][0])
2456
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2308
2457
if direction > 0:
2309
2458
# disk is before inventory - unknown
2310
2459
dirblock = [(relpath, basename, kind, stat, None, None) for
2311
relpath, basename, kind, stat, top_path in current_disk[1]]
2312
yield (current_disk[0][0], None), dirblock
2460
relpath, basename, kind, stat, top_path in
2461
cur_disk_dir_content]
2462
yield (cur_disk_dir_relpath, None), dirblock
2314
2464
current_disk = disk_iterator.next()
2315
2465
except StopIteration:
2389
2540
# FIXME: stash the node in pending
2390
2541
entry = inv[top_id]
2391
for name, child in entry.sorted_children():
2392
dirblock.append((relroot + name, name, child.kind, None,
2393
child.file_id, child.kind
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
2395
2547
yield (currentdir[0], entry.file_id), dirblock
2396
2548
# push the user specified dirs from dirblock
2397
2549
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)
2445
2628
class WorkingTree2(WorkingTree):
2446
2629
"""This is the Format 2 working tree.
2448
This was the first weave based working tree.
2631
This was the first weave based working tree.
2449
2632
- uses os locks for locking.
2450
2633
- uses the branch last-revision.
2506
2697
def _last_revision(self):
2507
2698
"""See Mutable.last_revision."""
2509
return self._control_files.get('last-revision').read()
2700
return self._transport.get_bytes('last-revision')
2510
2701
except errors.NoSuchFile:
2511
2702
return _mod_revision.NULL_REVISION
2513
2704
def _change_last_revision(self, revision_id):
2514
2705
"""See WorkingTree._change_last_revision."""
2515
if revision_id is None or revision_id == NULL_REVISION:
2706
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2517
self._control_files._transport.delete('last-revision')
2708
self._transport.delete('last-revision')
2518
2709
except errors.NoSuchFile:
2522
self._control_files.put_bytes('last-revision', revision_id)
2713
self._transport.put_bytes('last-revision', revision_id,
2714
mode=self.bzrdir._get_file_mode())
2717
def _get_check_refs(self):
2718
"""Return the references needed to perform a check of this tree."""
2719
return [('trees', self.last_revision())]
2525
2721
@needs_tree_write_lock
2526
2722
def set_conflicts(self, conflicts):
2527
self._put_rio('conflicts', conflicts.to_stanzas(),
2723
self._put_rio('conflicts', conflicts.to_stanzas(),
2528
2724
CONFLICT_HEADER_1)
2530
2726
@needs_tree_write_lock
2678
2869
"""See WorkingTreeFormat.get_format_description()."""
2679
2870
return "Working tree format 2"
2681
def stub_initialize_remote(self, control_files):
2682
"""As a special workaround create critical control files for a remote working tree
2872
def _stub_initialize_on_transport(self, transport, file_mode):
2873
"""Workaround: create control files for a remote working tree.
2684
2875
This ensures that it can later be updated and dealt with locally,
2685
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2686
2877
no working tree. (See bug #43064).
2688
2879
sio = StringIO()
2880
inv = inventory.Inventory()
2690
2881
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2692
control_files.put('inventory', sio)
2694
control_files.put_bytes('pending-merges', '')
2697
def initialize(self, a_bzrdir, revision_id=None):
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):
2698
2888
"""See WorkingTreeFormat.initialize()."""
2699
2889
if not isinstance(a_bzrdir.transport, LocalTransport):
2700
2890
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2701
branch = a_bzrdir.open_branch()
2891
if from_branch is not None:
2892
branch = from_branch
2894
branch = a_bzrdir.open_branch()
2702
2895
if revision_id is None:
2703
2896
revision_id = _mod_revision.ensure_null(branch.last_revision())
2704
2897
branch.lock_write()
2781
2974
def _open_control_files(self, a_bzrdir):
2782
2975
transport = a_bzrdir.get_workingtree_transport(None)
2783
return LockableFiles(transport, self._lock_file_name,
2976
return LockableFiles(transport, self._lock_file_name,
2784
2977
self._lock_class)
2786
def initialize(self, a_bzrdir, revision_id=None):
2979
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
accelerator_tree=None, hardlink=False):
2787
2981
"""See WorkingTreeFormat.initialize().
2789
revision_id allows creating a working tree at a different
2790
revision than the branch is at.
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,
2792
2992
if not isinstance(a_bzrdir.transport, LocalTransport):
2793
2993
raise errors.NotLocalUrl(a_bzrdir.transport.base)