13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
23
new revision based on the workingtree and its inventory.
25
25
At the moment every WorkingTree has its own branch. Remote
51
59
conflicts as _mod_conflicts,
60
67
revision as _mod_revision,
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
94
103
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
107
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
286
278
self._control_files.break_lock()
287
279
self.branch.break_lock()
289
def _get_check_refs(self):
290
"""Return the references needed to perform a check of this tree.
292
The default implementation returns no refs, and is only suitable for
293
trees that have no local caching and can commit on ghosts at any time.
295
:seealso: bzrlib.check for details about check_refs.
299
281
def requires_rich_root(self):
300
282
return self._format.requires_rich_root
302
284
def supports_tree_reference(self):
305
def supports_content_filtering(self):
306
return self._format.supports_content_filtering()
308
def supports_views(self):
309
return self.views.supports_views()
311
287
def _set_inventory(self, inv, dirty):
312
288
"""Set the internal cached inventory.
425
399
return self.branch.repository.revision_tree(revision_id)
426
400
except (errors.RevisionNotPresent, errors.NoSuchRevision):
427
401
# the basis tree *may* be a ghost or a low level error may have
428
# occurred. If the revision is present, its a problem, if its not
402
# occured. If the revision is present, its a problem, if its not
430
404
if self.branch.repository.has_revision(revision_id):
432
406
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
407
return self.branch.repository.revision_tree(None)
436
409
def _cleanup(self):
437
410
self._flush_ignore_list_cache()
439
412
def relpath(self, path):
440
413
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
415
The path may be absolute or relative. If its a relative path it is
443
416
interpreted relative to the python current working directory.
445
418
return osutils.relpath(self.basedir, path)
447
420
def has_filename(self, filename):
448
421
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
423
def get_file(self, file_id, path=None):
457
425
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
459
stat_value = _fstat(file_obj.fileno())
460
if filtered and self.supports_content_filtering():
461
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
463
return (file_obj, stat_value)
465
def get_file_text(self, file_id, path=None, filtered=True):
466
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
426
return self.get_file_byname(path)
428
def get_file_text(self, file_id):
429
return self.get_file(file_id).read()
431
def get_file_byname(self, filename):
432
return file(self.abspath(filename), 'rb')
486
435
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
442
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
443
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
445
basis = self.basis_tree()
448
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
449
require_versioned=True).next()
450
changed_content, kind = changes[2], changes[6]
451
if not changed_content:
452
return basis.annotate_iter(file_id)
456
if kind[0] != 'file':
459
old_lines = list(basis.annotate_iter(file_id))
461
for tree in self.branch.repository.revision_trees(
462
self.get_parent_ids()[1:]):
463
if file_id not in tree:
465
old.append(list(tree.annotate_iter(file_id)))
466
return annotate.reannotate(old, self.get_file(file_id).readlines(),
533
471
def _get_ancestors(self, default_revision):
534
472
ancestors = set([default_revision])
571
509
def clone(self, to_bzrdir, revision_id=None):
572
510
"""Duplicate this working tree into to_bzr, including all state.
574
512
Specifically modified files are kept as modified, but
575
513
ignored and unknown files are discarded.
577
515
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
518
If not None, the cloned tree will have its last revision set to
519
revision, and and difference between the source trees last revision
582
520
and this one merged in.
584
522
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
523
result = self._format.initialize(to_bzrdir)
586
524
self.copy_content_into(result, revision_id)
768
704
kind = 'tree-reference'
769
705
return kind, None, None, None
770
706
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
707
return ('symlink', None, None, os.readlink(abspath))
774
709
return (kind, None, None, None)
776
def _file_content_summary(self, path, stat_result):
777
size = stat_result.st_size
778
executable = self._is_executable_from_path_and_stat(path, stat_result)
779
# try for a stat cache lookup
780
return ('file', size, executable, self._sha_from_stat(
783
711
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
712
"""Common ghost checking functionality from set_parent_*.
915
843
branch.last_revision().
917
845
from bzrlib.merge import Merger, Merge3Merger
918
merger = Merger(self.branch, this_tree=self)
919
# check that there are no local alterations
920
if not force and self.has_changes():
921
raise errors.UncommittedChanges(self)
922
if to_revision is None:
923
to_revision = _mod_revision.ensure_null(branch.last_revision())
924
merger.other_rev_id = to_revision
925
if _mod_revision.is_null(merger.other_rev_id):
926
raise errors.NoCommits(branch)
927
self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
merger.other_basis = merger.other_rev_id
929
merger.other_tree = self.branch.repository.revision_tree(
931
merger.other_branch = branch
932
if from_revision is None:
935
merger.set_base_revision(from_revision, branch)
936
if merger.base_rev_id == merger.other_rev_id:
937
raise errors.PointlessMerge
938
merger.backup_files = False
939
if merge_type is None:
940
merger.merge_type = Merge3Merger
942
merger.merge_type = merge_type
943
merger.set_interesting_files(None)
944
merger.show_base = False
945
merger.reprocess = False
946
conflicts = merger.do_merge()
846
pb = bzrlib.ui.ui_factory.nested_progress_bar()
848
merger = Merger(self.branch, this_tree=self, pb=pb)
849
merger.pp = ProgressPhase("Merge phase", 5, pb)
850
merger.pp.next_phase()
851
# check that there are no
853
merger.check_basis(check_clean=True, require_commits=False)
854
if to_revision is None:
855
to_revision = _mod_revision.ensure_null(branch.last_revision())
856
merger.other_rev_id = to_revision
857
if _mod_revision.is_null(merger.other_rev_id):
858
raise errors.NoCommits(branch)
859
self.branch.fetch(branch, last_revision=merger.other_rev_id)
860
merger.other_basis = merger.other_rev_id
861
merger.other_tree = self.branch.repository.revision_tree(
863
merger.other_branch = branch
864
merger.pp.next_phase()
865
if from_revision is None:
868
merger.set_base_revision(from_revision, branch)
869
if merger.base_rev_id == merger.other_rev_id:
870
raise errors.PointlessMerge
871
merger.backup_files = False
872
if merge_type is None:
873
merger.merge_type = Merge3Merger
875
merger.merge_type = merge_type
876
merger.set_interesting_files(None)
877
merger.show_base = False
878
merger.reprocess = False
879
conflicts = merger.do_merge()
951
886
def merge_modified(self):
952
887
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
889
The list is initialized by WorkingTree.set_merge_modified, which is
955
890
typically called after we make some automatic updates to the tree
956
891
because of a merge.
962
897
hashfile = self._transport.get('merge-hashes')
963
898
except errors.NoSuchFile:
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
902
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
903
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
904
except StopIteration:
905
raise errors.MergeModifiedFormatError()
906
for s in RioReader(hashfile):
907
# RioReader reads in Unicode, so convert file_ids back to utf8
908
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
909
if file_id not in self.inventory:
911
text_hash = s.get("hash")
912
if text_hash == self.get_file_sha1(file_id):
913
merge_hashes[file_id] = text_hash
984
916
@needs_write_lock
985
917
def mkdir(self, path, file_id=None):
1097
1027
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1028
if tree_transport.base != branch_transport.base:
1099
1029
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1030
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
1032
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1033
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1034
wt.set_parent_ids(self.get_parent_ids())
1106
1035
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1036
child_inv = Inventory(root_id=None)
1108
1037
new_root = my_inv[file_id]
1109
1038
my_inv.remove_recursive_id(file_id)
1110
1039
new_root.parent_id = None
1129
1058
self._serialize(self._inventory, sio)
1131
1060
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1061
mode=self._control_files._file_mode)
1133
1062
self._inventory_is_modified = False
1135
1064
def _kind(self, relpath):
1136
1065
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
1067
def list_files(self, include_root=False):
1068
"""Recursively list all files as (path, class, kind, id, entry).
1141
1070
Lists, but does not descend into unversioned directories.
1142
1072
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
1075
Skips the control directory.
1149
1077
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1078
# with it. So callers should be careful to always read_lock the tree.
1165
1093
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
1095
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1096
children = os.listdir(self.basedir)
1178
1097
children.sort()
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1098
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
1099
# use a deque and popleft to keep them sorted, or if we use a plain
1181
1100
# list and just reverse() them.
1182
1101
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1102
stack = [(inv.root.file_id, u'', self.basedir, children)]
1185
1104
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1240
1159
except KeyError:
1241
1160
yield fp[1:], c, fk, None, TreeEntry()
1244
1163
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1166
# But do this child first
1167
new_children = os.listdir(fap)
1169
new_children = collections.deque(new_children)
1170
stack.append((f_ie.file_id, fp, fap, new_children))
1171
# Break out of inner loop,
1172
# so that we start outer loop with child
1257
1175
# if we finished all children, pop it off the stack
1494
1411
from_tail = splitpath(from_rel)[-1]
1495
1412
from_id = inv.path2id(from_rel)
1496
1413
if from_id is None:
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1414
raise errors.BzrRenameFailedError(from_rel,to_rel,
1415
errors.NotVersionedError(path=str(from_rel)))
1416
from_entry = inv[from_id]
1508
1417
from_parent_id = from_entry.parent_id
1509
1418
to_dir, to_tail = os.path.split(to_rel)
1510
1419
to_dir_id = inv.path2id(to_dir)
1572
1481
:raises: NoSuchId if any fileid is not currently versioned.
1574
1483
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1578
1484
if self._inventory.has_id(file_id):
1579
1485
self._inventory.remove_recursive_id(file_id)
1487
raise errors.NoSuchId(self, file_id)
1580
1488
if len(file_ids):
1581
# in the future this should just set a dirty bit to wait for the
1489
# in the future this should just set a dirty bit to wait for the
1582
1490
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1491
# with the current in -memory inventory rather than triggering
1584
1492
# a read, it is more complex - we need to teach read_inventory
1585
1493
# to know when to read, and when to not read first... and possibly
1586
1494
# to save first when the in memory one may be corrupted.
1587
1495
# so for now, we just only write it if it is indeed dirty.
1588
1496
# - RBC 20060907
1589
1497
self._write_inventory(self._inventory)
1591
1499
def _iter_conflicts(self):
1592
1500
conflicted = set()
1593
1501
for info in self.list_files():
1602
1510
@needs_write_lock
1603
1511
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1512
change_reporter=None, possible_transports=None):
1513
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1514
source.lock_read()
1516
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
1518
old_revision_info = self.branch.last_revision_info()
1608
1519
basis_tree = self.basis_tree()
1609
1520
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1521
possible_transports=possible_transports)
1612
1522
new_revision_info = self.branch.last_revision_info()
1613
1523
if new_revision_info != old_revision_info:
1614
1525
repository = self.branch.repository
1526
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1527
basis_tree.lock_read()
1617
1529
new_basis_tree = self.branch.basis_tree()
1620
1532
new_basis_tree,
1622
1534
this_tree=self,
1624
1536
change_reporter=change_reporter)
1625
basis_root_id = basis_tree.get_root_id()
1626
new_root_id = new_basis_tree.get_root_id()
1627
if basis_root_id != new_root_id:
1628
self.set_root_id(new_root_id)
1537
if (basis_tree.inventory.root is None and
1538
new_basis_tree.inventory.root is not None):
1539
self.set_root_id(new_basis_tree.get_root_id())
1630
1542
basis_tree.unlock()
1631
1543
# TODO - dedup parents list with things merged by pull ?
1632
1544
# reuse the revisiontree we merged against to set the new
1634
1546
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
# we have to pull the merge trees out again, because
1636
# merge_inner has set the ids. - this corner is not yet
1547
# we have to pull the merge trees out again, because
1548
# merge_inner has set the ids. - this corner is not yet
1637
1549
# layered well enough to prevent double handling.
1638
1550
# XXX TODO: Fix the double handling: telling the tree about
1639
1551
# the already known parent data is wasteful.
1799
1710
raise errors.ObjectNotLocked(self)
1801
1712
def lock_read(self):
1802
"""Lock the tree for reading.
1804
This also locks the branch, and can be unlocked via self.unlock().
1806
:return: A bzrlib.lock.LogicalLockResult.
1713
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1714
if not self.is_locked():
1809
1715
self._reset_data()
1810
1716
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1718
return self._control_files.lock_read()
1815
1720
self.branch.unlock()
1818
1723
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1724
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1725
if not self.is_locked():
1824
1726
self._reset_data()
1825
1727
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1729
return self._control_files.lock_write()
1830
1731
self.branch.unlock()
1833
1734
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1735
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1736
if not self.is_locked():
1839
1737
self._reset_data()
1840
1738
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1740
return self._control_files.lock_write()
1845
1742
self.branch.unlock()
1901
1794
# as commit already has that ready-to-use [while the format is the
1902
1795
# same, that is].
1904
# this double handles the inventory - unpack and repack -
1797
# this double handles the inventory - unpack and repack -
1905
1798
# but is easier to understand. We can/should put a conditional
1906
1799
# in here based on whether the inventory is in the latest format
1907
1800
# - perhaps we should repack all inventories on a repository
1909
1802
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1803
# xml contains 'revision_id="', then we assume the right
1911
1804
# revision_id is set. We must check for this full string, because a
1912
1805
# root node id can legitimately look like 'revision_id' but cannot
1913
1806
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1807
xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1808
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1809
if (not 'revision_id="' in firstline or
1917
1810
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1811
inv = self.branch.repository.deserialise_inventory(
1920
1813
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1814
self._write_basis_inventory(xml)
1922
1815
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1926
1819
"""Read the cached basis inventory."""
1927
1820
path = self._basis_inventory_name()
1928
1821
return self._transport.get_bytes(path)
1930
1823
@needs_read_lock
1931
1824
def read_working_inventory(self):
1932
1825
"""Read the working inventory.
1934
1827
:raises errors.InventoryModified: read_working_inventory will fail
1935
1828
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1830
# conceptually this should be an implementation detail of the tree.
1938
1831
# XXX: Deprecate this.
1939
1832
# ElementTree does its own conversion from UTF-8, so open in
1941
1834
if self._inventory_is_modified:
1942
1835
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1836
result = self._deserialize(self._transport.get('inventory'))
1948
1837
self._set_inventory(result, dirty=False)
2194
2080
def unlock(self):
2195
2081
"""See Branch.unlock.
2197
2083
WorkingTree locking just uses the Branch locking facilities.
2198
2084
This is current because all working trees have an embedded branch
2199
2085
within them. IF in the future, we were to make branch data shareable
2200
between multiple working trees, i.e. via shared storage, then we
2086
between multiple working trees, i.e. via shared storage, then we
2201
2087
would probably want to lock both the local tree, and the branch.
2203
2089
raise NotImplementedError(self.unlock)
2207
def update(self, change_reporter=None, possible_transports=None,
2208
revision=None, old_tip=_marker):
2091
def update(self, change_reporter=None, possible_transports=None):
2209
2092
"""Update a working tree along its branch.
2211
2094
This will update the branch if its bound too, which means we have
2265
2141
# cant set that until we update the working trees last revision to be
2266
2142
# one from the new branch, because it will just get absorbed by the
2267
2143
# parent de-duplication logic.
2269
2145
# We MUST save it even if an error occurs, because otherwise the users
2270
2146
# local work is unreferenced and will appear to have been lost.
2274
2150
last_rev = self.get_parent_ids()[0]
2275
2151
except IndexError:
2276
2152
last_rev = _mod_revision.NULL_REVISION
2277
if revision is None:
2278
revision = self.branch.last_revision()
2280
old_tip = old_tip or _mod_revision.NULL_REVISION
2282
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
# the branch we are bound to was updated
2284
# merge those changes in first
2285
base_tree = self.basis_tree()
2286
other_tree = self.branch.repository.revision_tree(old_tip)
2287
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
base_tree, this_tree=self,
2289
change_reporter=change_reporter)
2291
self.add_parent_tree((old_tip, other_tree))
2292
trace.note('Rerun update after fixing the conflicts.')
2295
if last_rev != _mod_revision.ensure_null(revision):
2296
# the working tree is up to date with the branch
2297
# we can merge the specified revision from master
2298
to_tree = self.branch.repository.revision_tree(revision)
2299
to_root_id = to_tree.get_root_id()
2153
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2154
# merge tree state up to new branch tip.
2301
2155
basis = self.basis_tree()
2302
2156
basis.lock_read()
2304
if (basis.inventory.root is None
2305
or basis.inventory.root.file_id != to_root_id):
2306
self.set_root_id(to_root_id)
2158
to_tree = self.branch.basis_tree()
2159
if basis.inventory.root is None:
2160
self.set_root_id(to_tree.get_root_id())
2162
result += merge.merge_inner(
2167
change_reporter=change_reporter)
2311
# determine the branch point
2312
graph = self.branch.repository.get_graph()
2313
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
change_reporter=change_reporter)
2320
self.set_last_revision(revision)
2321
2170
# TODO - dedup parents list with things merged by pull ?
2322
2171
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
2172
parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2173
merges = self.get_parent_ids()[1:]
2325
2174
# Ideally we ask the tree for the trees here, that way the working
2326
# tree can decide whether to give us the entire tree or give us a
2175
# tree can decide whether to give us teh entire tree or give us a
2327
2176
# lazy initialised tree. dirstate for instance will have the trees
2328
2177
# in ram already, whereas a last-revision + basis-inventory tree
2329
2178
# will not, but also does not need them when setting parents.
2330
2179
for parent in merges:
2331
2180
parent_trees.append(
2332
2181
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
2182
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2183
parent_trees.append(
2335
2184
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2185
self.set_parent_trees(parent_trees)
2337
2186
last_rev = parent_trees[0][0]
2188
# the working tree had the same last-revision as the master
2189
# branch did. We may still have pivot local work from the local
2190
# branch into old_tip:
2191
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2192
self.add_parent_tree_id(old_tip)
2193
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2194
and old_tip != last_rev):
2195
# our last revision was not the prior branch last revision
2196
# and we have converted that last revision to a pending merge.
2197
# base is somewhere between the branch tip now
2198
# and the now pending merge
2200
# Since we just modified the working tree and inventory, flush out
2201
# the current state, before we modify it again.
2202
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2203
# requires it only because TreeTransform directly munges the
2204
# inventory and calls tree._write_inventory(). Ultimately we
2205
# should be able to remove this extra flush.
2207
graph = self.branch.repository.get_graph()
2208
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2210
base_tree = self.branch.repository.revision_tree(base_rev_id)
2211
other_tree = self.branch.repository.revision_tree(old_tip)
2212
result += merge.merge_inner(
2217
change_reporter=change_reporter)
2340
2220
def _write_hashcache_if_dirty(self):
2341
2221
"""Write out the hashcache if it is dirty."""
2868
2714
"""See WorkingTreeFormat.get_format_description()."""
2869
2715
return "Working tree format 2"
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2717
def _stub_initialize_remote(self, branch):
2718
"""As a special workaround create critical control files for a remote working tree.
2874
2720
This ensures that it can later be updated and dealt with locally,
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2721
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
2722
no working tree. (See bug #43064).
2878
2724
sio = StringIO()
2879
inv = inventory.Inventory()
2880
2726
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
transport.put_file('inventory', sio, file_mode)
2883
transport.put_bytes('pending-merges', '', file_mode)
2728
branch._transport.put_file('inventory', sio,
2729
mode=branch.control_files._file_mode)
2730
branch._transport.put_bytes('pending-merges', '',
2731
mode=branch.control_files._file_mode)
2885
2734
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
2735
accelerator_tree=None, hardlink=False):