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,
67
60
revision as _mod_revision,
79
69
import bzrlib.branch
80
70
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
71
from bzrlib.workingtree_4 import (
85
78
from bzrlib import symbol_versioning
86
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
80
from bzrlib.lockable_files import LockableFiles
89
81
from bzrlib.lockdir import LockDir
90
82
import bzrlib.mutabletree
91
83
from bzrlib.mutabletree import needs_tree_write_lock
92
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
302
285
self._control_files.break_lock()
303
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.
305
298
def requires_rich_root(self):
306
299
return self._format.requires_rich_root
308
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()
311
310
def _set_inventory(self, inv, dirty):
312
311
"""Set the internal cached inventory.
422
422
# at this point ?
424
424
return self.branch.repository.revision_tree(revision_id)
425
except errors.RevisionNotPresent:
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
426
# the basis tree *may* be a ghost or a low level error may have
427
# 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
429
429
if self.branch.repository.has_revision(revision_id):
431
431
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(None)
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
434
435
def _cleanup(self):
435
436
self._flush_ignore_list_cache()
438
@deprecated_method(zero_eight)
439
def create(branch, directory):
440
"""Create a workingtree for branch at directory.
442
If existing_directory already exists it must have a .bzr directory.
443
If it does not exist, it will be created.
445
This returns a new WorkingTree object for the new checkout.
447
TODO FIXME RBC 20060124 when we have checkout formats in place this
448
should accept an optional revisionid to checkout [and reject this if
449
checking out into the same dir as a pre-checkout-aware branch format.]
451
XXX: When BzrDir is present, these should be created through that
454
warnings.warn('delete WorkingTree.create', stacklevel=3)
455
transport = get_transport(directory)
456
if branch.bzrdir.root_transport.base == transport.base:
458
return branch.bzrdir.create_workingtree()
459
# different directory,
460
# create a branch reference
461
# and now a working tree.
462
raise NotImplementedError
465
@deprecated_method(zero_eight)
466
def create_standalone(directory):
467
"""Create a checkout and a branch and a repo at directory.
469
Directory must exist and be empty.
471
please use BzrDir.create_standalone_workingtree
473
return bzrdir.BzrDir.create_standalone_workingtree(directory)
475
438
def relpath(self, path):
476
439
"""Return the local path portion from a given path.
478
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
479
442
interpreted relative to the python current working directory.
481
444
return osutils.relpath(self.basedir, path)
483
446
def has_filename(self, filename):
484
447
return osutils.lexists(self.abspath(filename))
486
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."""
488
456
path = self.id2path(file_id)
489
return self.get_file_byname(path)
491
def get_file_text(self, file_id):
492
return self.get_file(file_id).read()
494
def get_file_byname(self, filename):
495
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()
498
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
505
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
506
493
attribution will be correct).
508
basis = self.basis_tree()
511
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
512
require_versioned=True).next()
513
changed_content, kind = changes[2], changes[6]
514
if not changed_content:
515
return basis.annotate_iter(file_id)
519
if kind[0] != 'file':
522
old_lines = list(basis.annotate_iter(file_id))
524
for tree in self.branch.repository.revision_trees(
525
self.get_parent_ids()[1:]):
526
if file_id not in tree:
528
old.append(list(tree.annotate_iter(file_id)))
529
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)]
534
532
def _get_ancestors(self, default_revision):
535
533
ancestors = set([default_revision])
572
570
def clone(self, to_bzrdir, revision_id=None):
573
571
"""Duplicate this working tree into to_bzr, including all state.
575
573
Specifically modified files are kept as modified, but
576
574
ignored and unknown files are discarded.
578
576
If you want to make a new line of development, see bzrdir.sprout()
581
If not None, the cloned tree will have its last revision set to
582
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
583
581
and this one merged in.
585
583
# assumes the target bzr dir format is compatible.
586
result = self._format.initialize(to_bzrdir)
584
result = to_bzrdir.create_workingtree()
587
585
self.copy_content_into(result, revision_id)
761
767
kind = 'tree-reference'
762
768
return kind, None, None, None
763
769
elif kind == 'symlink':
764
return ('symlink', None, None, os.readlink(abspath))
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
766
773
return (kind, None, None, None)
768
@deprecated_method(zero_eleven)
770
def pending_merges(self):
771
"""Return a list of pending merges.
773
These are revisions that have been merged into the working
774
directory but not yet committed.
776
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
777
instead - which is available on all tree objects.
779
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(
781
782
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
782
783
"""Common ghost checking functionality from set_parent_*.
793
794
def _set_merges_from_parent_ids(self, parent_ids):
794
795
merges = parent_ids[1:]
795
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
797
818
@needs_tree_write_lock
798
819
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
799
820
"""Set the parent ids to revision_ids.
801
822
See also set_parent_trees. This api will try to retrieve the tree data
802
823
for each element of revision_ids from the trees repository. If you have
803
824
tree data already available, it is more efficient to use
888
914
branch.last_revision().
890
916
from bzrlib.merge import Merger, Merge3Merger
891
pb = bzrlib.ui.ui_factory.nested_progress_bar()
893
merger = Merger(self.branch, this_tree=self, pb=pb)
894
merger.pp = ProgressPhase("Merge phase", 5, pb)
895
merger.pp.next_phase()
896
# check that there are no
898
merger.check_basis(check_clean=True, require_commits=False)
899
if to_revision is None:
900
to_revision = _mod_revision.ensure_null(branch.last_revision())
901
merger.other_rev_id = to_revision
902
if _mod_revision.is_null(merger.other_rev_id):
903
raise errors.NoCommits(branch)
904
self.branch.fetch(branch, last_revision=merger.other_rev_id)
905
merger.other_basis = merger.other_rev_id
906
merger.other_tree = self.branch.repository.revision_tree(
908
merger.other_branch = branch
909
merger.pp.next_phase()
910
if from_revision is None:
913
merger.set_base_revision(from_revision, branch)
914
if merger.base_rev_id == merger.other_rev_id:
915
raise errors.PointlessMerge
916
merger.backup_files = False
917
if merge_type is None:
918
merger.merge_type = Merge3Merger
920
merger.merge_type = merge_type
921
merger.set_interesting_files(None)
922
merger.show_base = False
923
merger.reprocess = False
924
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()
931
950
def merge_modified(self):
932
951
"""Return a dictionary of files modified by a merge.
934
The list is initialized by WorkingTree.set_merge_modified, which is
953
The list is initialized by WorkingTree.set_merge_modified, which is
935
954
typically called after we make some automatic updates to the tree
936
955
because of a merge.
939
958
still in the working inventory and have that text hash.
942
hashfile = self._control_files.get('merge-hashes')
961
hashfile = self._transport.get('merge-hashes')
943
962
except errors.NoSuchFile:
947
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
948
970
raise errors.MergeModifiedFormatError()
949
except StopIteration:
950
raise errors.MergeModifiedFormatError()
951
for s in RioReader(hashfile):
952
# RioReader reads in Unicode, so convert file_ids back to utf8
953
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
954
if file_id not in self.inventory:
956
text_hash = s.get("hash")
957
if text_hash == self.get_file_sha1(file_id):
958
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
961
983
@needs_write_lock
962
984
def mkdir(self, path, file_id=None):
1072
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1073
1097
if tree_transport.base != branch_transport.base:
1074
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1075
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1077
1102
tree_bzrdir = branch_bzrdir
1078
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1079
1104
wt.set_parent_ids(self.get_parent_ids())
1080
1105
my_inv = self.inventory
1081
child_inv = Inventory(root_id=None)
1106
child_inv = inventory.Inventory(root_id=None)
1082
1107
new_root = my_inv[file_id]
1083
1108
my_inv.remove_recursive_id(file_id)
1084
1109
new_root.parent_id = None
1102
1127
sio = StringIO()
1103
1128
self._serialize(self._inventory, sio)
1105
self._control_files.put('inventory', sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1106
1132
self._inventory_is_modified = False
1108
1134
def _kind(self, relpath):
1109
1135
return osutils.file_kind(self.abspath(relpath))
1111
def list_files(self, include_root=False):
1112
"""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).
1114
1140
Lists, but does not descend into unversioned directories.
1116
1141
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1119
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
1121
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1122
1149
# with it. So callers should be careful to always read_lock the tree.
1137
1164
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1139
1166
# directory file_id, relative path, absolute path, reverse sorted children
1140
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)
1141
1177
children.sort()
1142
# jam 20060527 The kernel sized tree seems equivalent whether we
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1143
1179
# use a deque and popleft to keep them sorted, or if we use a plain
1144
1180
# list and just reverse() them.
1145
1181
children = collections.deque(children)
1146
stack = [(inv.root.file_id, u'', self.basedir, children)]
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1148
1184
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1203
1239
except KeyError:
1204
1240
yield fp[1:], c, fk, None, TreeEntry()
1207
1243
if fk != 'directory':
1210
# But do this child first
1211
new_children = os.listdir(fap)
1213
new_children = collections.deque(new_children)
1214
stack.append((f_ie.file_id, fp, fap, new_children))
1215
# Break out of inner loop,
1216
# 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
1219
1256
# if we finished all children, pop it off the stack
1454
1493
from_tail = splitpath(from_rel)[-1]
1455
1494
from_id = inv.path2id(from_rel)
1456
1495
if from_id is None:
1457
raise errors.BzrRenameFailedError(from_rel,to_rel,
1458
errors.NotVersionedError(path=str(from_rel)))
1459
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]
1460
1507
from_parent_id = from_entry.parent_id
1461
1508
to_dir, to_tail = os.path.split(to_rel)
1462
1509
to_dir_id = inv.path2id(to_dir)
1524
1571
:raises: NoSuchId if any fileid is not currently versioned.
1526
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:
1527
1577
if self._inventory.has_id(file_id):
1528
1578
self._inventory.remove_recursive_id(file_id)
1530
raise errors.NoSuchId(self, file_id)
1531
1579
if len(file_ids):
1532
# 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
1533
1581
# final unlock. However, until all methods of workingtree start
1534
# with the current in -memory inventory rather than triggering
1582
# with the current in -memory inventory rather than triggering
1535
1583
# a read, it is more complex - we need to teach read_inventory
1536
1584
# to know when to read, and when to not read first... and possibly
1537
1585
# to save first when the in memory one may be corrupted.
1538
1586
# so for now, we just only write it if it is indeed dirty.
1539
1587
# - RBC 20060907
1540
1588
self._write_inventory(self._inventory)
1542
@deprecated_method(zero_eight)
1543
def iter_conflicts(self):
1544
"""List all files in the tree that have text or content conflicts.
1545
DEPRECATED. Use conflicts instead."""
1546
return self._iter_conflicts()
1548
1590
def _iter_conflicts(self):
1549
1591
conflicted = set()
1559
1601
@needs_write_lock
1560
1602
def pull(self, source, overwrite=False, stop_revision=None,
1561
change_reporter=None, possible_transports=None):
1562
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1603
change_reporter=None, possible_transports=None, local=False):
1563
1604
source.lock_read()
1565
pp = ProgressPhase("Pull phase", 2, top_pb)
1567
1606
old_revision_info = self.branch.last_revision_info()
1568
1607
basis_tree = self.basis_tree()
1569
1608
count = self.branch.pull(source, overwrite, stop_revision,
1570
possible_transports=possible_transports)
1609
possible_transports=possible_transports,
1571
1611
new_revision_info = self.branch.last_revision_info()
1572
1612
if new_revision_info != old_revision_info:
1574
1613
repository = self.branch.repository
1575
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1576
1614
basis_tree.lock_read()
1578
1616
new_basis_tree = self.branch.basis_tree()
1581
1619
new_basis_tree,
1583
1621
this_tree=self,
1585
1623
change_reporter=change_reporter)
1586
if (basis_tree.inventory.root is None and
1587
new_basis_tree.inventory.root is not None):
1588
self.set_root_id(new_basis_tree.get_root_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)
1591
1629
basis_tree.unlock()
1592
1630
# TODO - dedup parents list with things merged by pull ?
1593
1631
# reuse the revisiontree we merged against to set the new
1595
1633
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1596
# we have to pull the merge trees out again, because
1597
# 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
1598
1636
# layered well enough to prevent double handling.
1599
1637
# XXX TODO: Fix the double handling: telling the tree about
1600
1638
# the already known parent data is wasteful.
1836
1886
# as commit already has that ready-to-use [while the format is the
1837
1887
# same, that is].
1839
# this double handles the inventory - unpack and repack -
1889
# this double handles the inventory - unpack and repack -
1840
1890
# but is easier to understand. We can/should put a conditional
1841
1891
# in here based on whether the inventory is in the latest format
1842
1892
# - perhaps we should repack all inventories on a repository
1844
1894
# the fast path is to copy the raw xml from the repository. If the
1845
# xml contains 'revision_id="', then we assume the right
1895
# xml contains 'revision_id="', then we assume the right
1846
1896
# revision_id is set. We must check for this full string, because a
1847
1897
# root node id can legitimately look like 'revision_id' but cannot
1848
1898
# contain a '"'.
1849
xml = self.branch.repository.get_inventory_xml(new_revision)
1899
xml = self.branch.repository._get_inventory_xml(new_revision)
1850
1900
firstline = xml.split('\n', 1)[0]
1851
if (not 'revision_id="' in firstline or
1901
if (not 'revision_id="' in firstline or
1852
1902
'format="7"' not in firstline):
1853
inv = self.branch.repository.deserialise_inventory(
1903
inv = self.branch.repository._serializer.read_inventory_from_string(
1855
1905
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1856
1906
self._write_basis_inventory(xml)
1857
1907
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1860
1910
def read_basis_inventory(self):
1861
1911
"""Read the cached basis inventory."""
1862
1912
path = self._basis_inventory_name()
1863
return self._control_files.get(path).read()
1913
return self._transport.get_bytes(path)
1865
1915
@needs_read_lock
1866
1916
def read_working_inventory(self):
1867
1917
"""Read the working inventory.
1869
1919
:raises errors.InventoryModified: read_working_inventory will fail
1870
1920
when the current in memory inventory has been modified.
1872
# conceptually this should be an implementation detail of the tree.
1922
# conceptually this should be an implementation detail of the tree.
1873
1923
# XXX: Deprecate this.
1874
1924
# ElementTree does its own conversion from UTF-8, so open in
1876
1926
if self._inventory_is_modified:
1877
1927
raise errors.InventoryModified(self)
1878
result = self._deserialize(self._control_files.get('inventory'))
1928
f = self._transport.get('inventory')
1930
result = self._deserialize(f)
1879
1933
self._set_inventory(result, dirty=False)
1897
1951
new_files=set()
1898
1952
unknown_nested_files=set()
1954
to_file = sys.stdout
1900
1956
def recurse_directory_to_add_files(directory):
1901
1957
# Recurse directory and add all files
1902
1958
# so we can check if they have changed.
1903
1959
for parent_info, file_infos in\
1904
osutils.walkdirs(self.abspath(directory),
1906
for relpath, basename, kind, lstat, abspath in file_infos:
1960
self.walkdirs(directory):
1961
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1907
1962
# Is it versioned or ignored?
1908
1963
if self.path2id(relpath) or self.is_ignored(relpath):
1909
1964
# Add nested content for deletion.
2088
2142
@needs_tree_write_lock
2089
2143
def set_root_id(self, file_id):
2090
2144
"""Set the root id for this tree."""
2092
2146
if file_id is None:
2093
symbol_versioning.warn(symbol_versioning.zero_twelve
2094
% 'WorkingTree.set_root_id with fileid=None',
2099
file_id = osutils.safe_file_id(file_id)
2148
'WorkingTree.set_root_id with fileid=None')
2149
file_id = osutils.safe_file_id(file_id)
2100
2150
self._set_root_id(file_id)
2102
2152
def _set_root_id(self, file_id):
2103
2153
"""Set the root id for this tree, in a format specific manner.
2105
:param file_id: The file id to assign to the root. It must not be
2155
:param file_id: The file id to assign to the root. It must not be
2106
2156
present in the current inventory or an error will occur. It must
2107
2157
not be None, but rather a valid file id.
2128
2178
def unlock(self):
2129
2179
"""See Branch.unlock.
2131
2181
WorkingTree locking just uses the Branch locking facilities.
2132
2182
This is current because all working trees have an embedded branch
2133
2183
within them. IF in the future, we were to make branch data shareable
2134
between multiple working trees, i.e. via shared storage, then we
2184
between multiple working trees, i.e. via shared storage, then we
2135
2185
would probably want to lock both the local tree, and the branch.
2137
2187
raise NotImplementedError(self.unlock)
2139
def update(self, change_reporter=None, possible_transports=None):
2191
def update(self, change_reporter=None, possible_transports=None,
2192
revision=None, old_tip=_marker):
2140
2193
"""Update a working tree along its branch.
2142
2195
This will update the branch if its bound too, which means we have
2189
2249
# cant set that until we update the working trees last revision to be
2190
2250
# one from the new branch, because it will just get absorbed by the
2191
2251
# parent de-duplication logic.
2193
2253
# We MUST save it even if an error occurs, because otherwise the users
2194
2254
# local work is unreferenced and will appear to have been lost.
2198
2258
last_rev = self.get_parent_ids()[0]
2199
2259
except IndexError:
2200
2260
last_rev = _mod_revision.NULL_REVISION
2201
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2202
# merge tree state up to new branch tip.
2261
if revision is None:
2262
revision = self.branch.last_revision()
2264
old_tip = old_tip or _mod_revision.NULL_REVISION
2266
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
# the branch we are bound to was updated
2268
# merge those changes in first
2269
base_tree = self.basis_tree()
2270
other_tree = self.branch.repository.revision_tree(old_tip)
2271
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
base_tree, this_tree=self,
2273
change_reporter=change_reporter)
2275
self.add_parent_tree((old_tip, other_tree))
2276
trace.note('Rerun update after fixing the conflicts.')
2279
if last_rev != _mod_revision.ensure_null(revision):
2280
# the working tree is up to date with the branch
2281
# we can merge the specified revision from master
2282
to_tree = self.branch.repository.revision_tree(revision)
2283
to_root_id = to_tree.get_root_id()
2203
2285
basis = self.basis_tree()
2204
2286
basis.lock_read()
2206
to_tree = self.branch.basis_tree()
2207
if basis.inventory.root is None:
2208
self.set_root_id(to_tree.get_root_id())
2288
if (basis.inventory.root is None
2289
or basis.inventory.root.file_id != to_root_id):
2290
self.set_root_id(to_root_id)
2210
result += merge.merge_inner(
2215
change_reporter=change_reporter)
2295
# determine the branch point
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2301
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
change_reporter=change_reporter)
2304
self.set_last_revision(revision)
2218
2305
# TODO - dedup parents list with things merged by pull ?
2219
2306
# reuse the tree we've updated to to set the basis:
2220
parent_trees = [(self.branch.last_revision(), to_tree)]
2307
parent_trees = [(revision, to_tree)]
2221
2308
merges = self.get_parent_ids()[1:]
2222
2309
# Ideally we ask the tree for the trees here, that way the working
2223
# tree can decide whether to give us teh entire tree or give us a
2310
# tree can decide whether to give us the entire tree or give us a
2224
2311
# lazy initialised tree. dirstate for instance will have the trees
2225
2312
# in ram already, whereas a last-revision + basis-inventory tree
2226
2313
# will not, but also does not need them when setting parents.
2227
2314
for parent in merges:
2228
2315
parent_trees.append(
2229
2316
(parent, self.branch.repository.revision_tree(parent)))
2230
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2317
if not _mod_revision.is_null(old_tip):
2231
2318
parent_trees.append(
2232
2319
(old_tip, self.branch.repository.revision_tree(old_tip)))
2233
2320
self.set_parent_trees(parent_trees)
2234
2321
last_rev = parent_trees[0][0]
2236
# the working tree had the same last-revision as the master
2237
# branch did. We may still have pivot local work from the local
2238
# branch into old_tip:
2239
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2240
self.add_parent_tree_id(old_tip)
2241
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2242
and old_tip != last_rev):
2243
# our last revision was not the prior branch last revision
2244
# and we have converted that last revision to a pending merge.
2245
# base is somewhere between the branch tip now
2246
# and the now pending merge
2248
# Since we just modified the working tree and inventory, flush out
2249
# the current state, before we modify it again.
2250
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2251
# requires it only because TreeTransform directly munges the
2252
# inventory and calls tree._write_inventory(). Ultimately we
2253
# should be able to remove this extra flush.
2255
graph = self.branch.repository.get_graph()
2256
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2258
base_tree = self.branch.repository.revision_tree(base_rev_id)
2259
other_tree = self.branch.repository.revision_tree(old_tip)
2260
result += merge.merge_inner(
2265
change_reporter=change_reporter)
2268
2324
def _write_hashcache_if_dirty(self):
2269
2325
"""Write out the hashcache if it is dirty."""
2465
2523
# FIXME: stash the node in pending
2466
2524
entry = inv[top_id]
2467
for name, child in entry.sorted_children():
2468
dirblock.append((relroot + name, name, child.kind, None,
2469
child.file_id, child.kind
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
child.file_id, child.kind
2471
2530
yield (currentdir[0], entry.file_id), dirblock
2472
2531
# push the user specified dirs from dirblock
2473
2532
for dir in reversed(dirblock):
2598
def _get_rules_searcher(self, default_searcher):
2599
"""See Tree._get_rules_searcher."""
2600
if self._rules_searcher is None:
2601
self._rules_searcher = super(WorkingTree,
2602
self)._get_rules_searcher(default_searcher)
2603
return self._rules_searcher
2605
def get_shelf_manager(self):
2606
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
2608
return ShelfManager(self, self._transport)
2521
2611
class WorkingTree2(WorkingTree):
2522
2612
"""This is the Format 2 working tree.
2524
This was the first weave based working tree.
2614
This was the first weave based working tree.
2525
2615
- uses os locks for locking.
2526
2616
- uses the branch last-revision.
2582
2676
def _last_revision(self):
2583
2677
"""See Mutable.last_revision."""
2585
return self._control_files.get('last-revision').read()
2679
return self._transport.get_bytes('last-revision')
2586
2680
except errors.NoSuchFile:
2587
2681
return _mod_revision.NULL_REVISION
2589
2683
def _change_last_revision(self, revision_id):
2590
2684
"""See WorkingTree._change_last_revision."""
2591
if revision_id is None or revision_id == NULL_REVISION:
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2593
self._control_files._transport.delete('last-revision')
2687
self._transport.delete('last-revision')
2594
2688
except errors.NoSuchFile:
2598
self._control_files.put_bytes('last-revision', revision_id)
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
2601
2700
@needs_tree_write_lock
2602
2701
def set_conflicts(self, conflicts):
2603
self._put_rio('conflicts', conflicts.to_stanzas(),
2702
self._put_rio('conflicts', conflicts.to_stanzas(),
2604
2703
CONFLICT_HEADER_1)
2606
2705
@needs_tree_write_lock
2755
2848
"""See WorkingTreeFormat.get_format_description()."""
2756
2849
return "Working tree format 2"
2758
def stub_initialize_remote(self, control_files):
2759
"""As a special workaround create critical control files for a remote working tree
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2761
2854
This ensures that it can later be updated and dealt with locally,
2762
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2763
2856
no working tree. (See bug #43064).
2765
2858
sio = StringIO()
2859
inv = inventory.Inventory()
2767
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2769
control_files.put('inventory', sio)
2771
control_files.put_bytes('pending-merges', '')
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2774
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2775
2866
accelerator_tree=None, hardlink=False):
added
removed
bzrlib/workingtree.py
