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,
70
from bzrlib.workingtree_4 import (
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
77
85
from bzrlib import symbol_versioning
78
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
79
from bzrlib.lock import LogicalLockResult
80
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
81
89
from bzrlib.lockdir import LockDir
82
90
import bzrlib.mutabletree
83
91
from bzrlib.mutabletree import needs_tree_write_lock
84
92
from bzrlib import osutils
85
93
from bzrlib.osutils import (
93
103
supports_executable,
95
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
106
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
120
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
288
276
self._control_files.break_lock()
289
277
self.branch.break_lock()
291
def _get_check_refs(self):
292
"""Return the references needed to perform a check of this tree.
294
The default implementation returns no refs, and is only suitable for
295
trees that have no local caching and can commit on ghosts at any time.
297
:seealso: bzrlib.check for details about check_refs.
301
279
def requires_rich_root(self):
302
280
return self._format.requires_rich_root
304
282
def supports_tree_reference(self):
307
def supports_content_filtering(self):
308
return self._format.supports_content_filtering()
310
def supports_views(self):
311
return self.views.supports_views()
313
285
def _set_inventory(self, inv, dirty):
314
286
"""Set the internal cached inventory.
425
395
# at this point ?
427
397
return self.branch.repository.revision_tree(revision_id)
428
except (errors.RevisionNotPresent, errors.NoSuchRevision):
398
except errors.RevisionNotPresent:
429
399
# the basis tree *may* be a ghost or a low level error may have
430
# occurred. If the revision is present, its a problem, if its not
400
# occured. If the revision is present, its a problem, if its not
432
402
if self.branch.repository.has_revision(revision_id):
434
404
# the basis tree is a ghost so return an empty tree.
435
return self.branch.repository.revision_tree(
436
_mod_revision.NULL_REVISION)
405
return self.branch.repository.revision_tree(None)
438
407
def _cleanup(self):
439
408
self._flush_ignore_list_cache()
441
410
def relpath(self, path):
442
411
"""Return the local path portion from a given path.
444
The path may be absolute or relative. If its a relative path it is
413
The path may be absolute or relative. If its a relative path it is
445
414
interpreted relative to the python current working directory.
447
416
return osutils.relpath(self.basedir, path)
449
418
def has_filename(self, filename):
450
419
return osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id, path=None, filtered=True):
453
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
455
def get_file_with_stat(self, file_id, path=None, filtered=True,
457
"""See Tree.get_file_with_stat."""
421
def get_file(self, file_id, path=None):
459
423
path = self.id2path(file_id)
460
file_obj = self.get_file_byname(path, filtered=False)
461
stat_value = _fstat(file_obj.fileno())
462
if filtered and self.supports_content_filtering():
463
filters = self._content_filter_stack(path)
464
file_obj = filtered_input_file(file_obj, filters)
465
return (file_obj, stat_value)
467
def get_file_text(self, file_id, path=None, filtered=True):
468
my_file = self.get_file(file_id, path=path, filtered=filtered)
470
return my_file.read()
474
def get_file_byname(self, filename, filtered=True):
475
path = self.abspath(filename)
477
if filtered and self.supports_content_filtering():
478
filters = self._content_filter_stack(filename)
479
return filtered_input_file(f, filters)
483
def get_file_lines(self, file_id, path=None, filtered=True):
484
"""See Tree.get_file_lines()"""
485
file = self.get_file(file_id, path, filtered=filtered)
487
return file.readlines()
424
return self.get_file_byname(path)
426
def get_file_text(self, file_id):
427
return self.get_file(file_id).read()
429
def get_file_byname(self, filename):
430
return file(self.abspath(filename), 'rb')
492
433
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
499
440
incorrectly attributed to CURRENT_REVISION (but after committing, the
500
441
attribution will be correct).
502
maybe_file_parent_keys = []
503
for parent_id in self.get_parent_ids():
505
parent_tree = self.revision_tree(parent_id)
506
except errors.NoSuchRevisionInTree:
507
parent_tree = self.branch.repository.revision_tree(parent_id)
508
parent_tree.lock_read()
510
if file_id not in parent_tree:
512
ie = parent_tree.inventory[file_id]
513
if ie.kind != 'file':
514
# Note: this is slightly unnecessary, because symlinks and
515
# directories have a "text" which is the empty text, and we
516
# know that won't mess up annotations. But it seems cleaner
518
parent_text_key = (file_id, ie.revision)
519
if parent_text_key not in maybe_file_parent_keys:
520
maybe_file_parent_keys.append(parent_text_key)
523
graph = _mod_graph.Graph(self.branch.repository.texts)
524
heads = graph.heads(maybe_file_parent_keys)
525
file_parent_keys = []
526
for key in maybe_file_parent_keys:
528
file_parent_keys.append(key)
530
# Now we have the parents of this content
531
annotator = self.branch.repository.texts.get_annotator()
532
text = self.get_file_text(file_id)
533
this_key =(file_id, default_revision)
534
annotator.add_special_text(this_key, file_parent_keys, text)
535
annotations = [(key[-1], line)
536
for key, line in annotator.annotate_flat(this_key)]
443
basis = self.basis_tree()
446
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
447
require_versioned=True).next()
448
changed_content, kind = changes[2], changes[6]
449
if not changed_content:
450
return basis.annotate_iter(file_id)
454
if kind[0] != 'file':
457
old_lines = list(basis.annotate_iter(file_id))
459
for tree in self.branch.repository.revision_trees(
460
self.get_parent_ids()[1:]):
461
if file_id not in tree:
463
old.append(list(tree.annotate_iter(file_id)))
464
return annotate.reannotate(old, self.get_file(file_id).readlines(),
539
469
def _get_ancestors(self, default_revision):
540
470
ancestors = set([default_revision])
577
507
def clone(self, to_bzrdir, revision_id=None):
578
508
"""Duplicate this working tree into to_bzr, including all state.
580
510
Specifically modified files are kept as modified, but
581
511
ignored and unknown files are discarded.
583
513
If you want to make a new line of development, see bzrdir.sprout()
586
If not None, the cloned tree will have its last revision set to
587
revision, and difference between the source trees last revision
516
If not None, the cloned tree will have its last revision set to
517
revision, and and difference between the source trees last revision
588
518
and this one merged in.
590
520
# assumes the target bzr dir format is compatible.
591
result = to_bzrdir.create_workingtree()
521
result = self._format.initialize(to_bzrdir)
592
522
self.copy_content_into(result, revision_id)
774
702
kind = 'tree-reference'
775
703
return kind, None, None, None
776
704
elif kind == 'symlink':
777
target = osutils.readlink(abspath)
778
return ('symlink', None, None, target)
705
return ('symlink', None, None, os.readlink(abspath))
780
707
return (kind, None, None, None)
782
def _file_content_summary(self, path, stat_result):
783
size = stat_result.st_size
784
executable = self._is_executable_from_path_and_stat(path, stat_result)
785
# try for a stat cache lookup
786
return ('file', size, executable, self._sha_from_stat(
789
709
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
790
710
"""Common ghost checking functionality from set_parent_*.
801
721
def _set_merges_from_parent_ids(self, parent_ids):
802
722
merges = parent_ids[1:]
803
self._transport.put_bytes('pending-merges', '\n'.join(merges),
804
mode=self.bzrdir._get_file_mode())
806
def _filter_parent_ids_by_ancestry(self, revision_ids):
807
"""Check that all merged revisions are proper 'heads'.
809
This will always return the first revision_id, and any merged revisions
812
if len(revision_ids) == 0:
814
graph = self.branch.repository.get_graph()
815
heads = graph.heads(revision_ids)
816
new_revision_ids = revision_ids[:1]
817
for revision_id in revision_ids[1:]:
818
if revision_id in heads and revision_id not in new_revision_ids:
819
new_revision_ids.append(revision_id)
820
if new_revision_ids != revision_ids:
821
trace.mutter('requested to set revision_ids = %s,'
822
' but filtered to %s', revision_ids, new_revision_ids)
823
return new_revision_ids
723
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
825
725
@needs_tree_write_lock
826
726
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
827
727
"""Set the parent ids to revision_ids.
829
729
See also set_parent_trees. This api will try to retrieve the tree data
830
730
for each element of revision_ids from the trees repository. If you have
831
731
tree data already available, it is more efficient to use
921
816
branch.last_revision().
923
818
from bzrlib.merge import Merger, Merge3Merger
924
merger = Merger(self.branch, this_tree=self)
925
# check that there are no local alterations
926
if not force and self.has_changes():
927
raise errors.UncommittedChanges(self)
928
if to_revision is None:
929
to_revision = _mod_revision.ensure_null(branch.last_revision())
930
merger.other_rev_id = to_revision
931
if _mod_revision.is_null(merger.other_rev_id):
932
raise errors.NoCommits(branch)
933
self.branch.fetch(branch, last_revision=merger.other_rev_id)
934
merger.other_basis = merger.other_rev_id
935
merger.other_tree = self.branch.repository.revision_tree(
937
merger.other_branch = branch
938
if from_revision is None:
941
merger.set_base_revision(from_revision, branch)
942
if merger.base_rev_id == merger.other_rev_id:
943
raise errors.PointlessMerge
944
merger.backup_files = False
945
if merge_type is None:
946
merger.merge_type = Merge3Merger
948
merger.merge_type = merge_type
949
merger.set_interesting_files(None)
950
merger.show_base = False
951
merger.reprocess = False
952
conflicts = merger.do_merge()
819
pb = bzrlib.ui.ui_factory.nested_progress_bar()
821
merger = Merger(self.branch, this_tree=self, pb=pb)
822
merger.pp = ProgressPhase("Merge phase", 5, pb)
823
merger.pp.next_phase()
824
# check that there are no
826
merger.check_basis(check_clean=True, require_commits=False)
827
if to_revision is None:
828
to_revision = _mod_revision.ensure_null(branch.last_revision())
829
merger.other_rev_id = to_revision
830
if _mod_revision.is_null(merger.other_rev_id):
831
raise errors.NoCommits(branch)
832
self.branch.fetch(branch, last_revision=merger.other_rev_id)
833
merger.other_basis = merger.other_rev_id
834
merger.other_tree = self.branch.repository.revision_tree(
836
merger.other_branch = branch
837
merger.pp.next_phase()
838
if from_revision is None:
841
merger.set_base_revision(from_revision, branch)
842
if merger.base_rev_id == merger.other_rev_id:
843
raise errors.PointlessMerge
844
merger.backup_files = False
845
if merge_type is None:
846
merger.merge_type = Merge3Merger
848
merger.merge_type = merge_type
849
merger.set_interesting_files(None)
850
merger.show_base = False
851
merger.reprocess = False
852
conflicts = merger.do_merge()
957
859
def merge_modified(self):
958
860
"""Return a dictionary of files modified by a merge.
960
The list is initialized by WorkingTree.set_merge_modified, which is
862
The list is initialized by WorkingTree.set_merge_modified, which is
961
863
typically called after we make some automatic updates to the tree
962
864
because of a merge.
965
867
still in the working inventory and have that text hash.
968
hashfile = self._transport.get('merge-hashes')
870
hashfile = self._control_files.get('merge-hashes')
969
871
except errors.NoSuchFile:
974
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
975
raise errors.MergeModifiedFormatError()
976
except StopIteration:
875
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
977
876
raise errors.MergeModifiedFormatError()
978
for s in RioReader(hashfile):
979
# RioReader reads in Unicode, so convert file_ids back to utf8
980
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
981
if file_id not in self.inventory:
983
text_hash = s.get("hash")
984
if text_hash == self.get_file_sha1(file_id):
985
merge_hashes[file_id] = text_hash
877
except StopIteration:
878
raise errors.MergeModifiedFormatError()
879
for s in RioReader(hashfile):
880
# RioReader reads in Unicode, so convert file_ids back to utf8
881
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
882
if file_id not in self.inventory:
884
text_hash = s.get("hash")
885
if text_hash == self.get_file_sha1(file_id):
886
merge_hashes[file_id] = text_hash
990
889
@needs_write_lock
991
890
def mkdir(self, path, file_id=None):
1103
1000
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1104
1001
if tree_transport.base != branch_transport.base:
1105
1002
tree_bzrdir = format.initialize_on_transport(tree_transport)
1106
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1107
target_branch=new_branch)
1003
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1109
1005
tree_bzrdir = branch_bzrdir
1110
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1006
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1111
1007
wt.set_parent_ids(self.get_parent_ids())
1112
1008
my_inv = self.inventory
1113
child_inv = inventory.Inventory(root_id=None)
1009
child_inv = Inventory(root_id=None)
1114
1010
new_root = my_inv[file_id]
1115
1011
my_inv.remove_recursive_id(file_id)
1116
1012
new_root.parent_id = None
1134
1030
sio = StringIO()
1135
1031
self._serialize(self._inventory, sio)
1137
self._transport.put_file('inventory', sio,
1138
mode=self.bzrdir._get_file_mode())
1033
self._control_files.put('inventory', sio)
1139
1034
self._inventory_is_modified = False
1141
1036
def _kind(self, relpath):
1142
1037
return osutils.file_kind(self.abspath(relpath))
1144
def list_files(self, include_root=False, from_dir=None, recursive=True):
1145
"""List all files as (path, class, kind, id, entry).
1039
def list_files(self, include_root=False):
1040
"""Recursively list all files as (path, class, kind, id, entry).
1147
1042
Lists, but does not descend into unversioned directories.
1148
1044
This does not include files that have been deleted in this
1149
tree. Skips the control directory.
1151
:param include_root: if True, return an entry for the root
1152
:param from_dir: start from this directory or None for the root
1153
:param recursive: whether to recurse into subdirectories or not
1047
Skips the control directory.
1155
1049
# list_files is an iterator, so @needs_read_lock doesn't work properly
1156
1050
# with it. So callers should be careful to always read_lock the tree.
1171
1065
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1173
1067
# directory file_id, relative path, absolute path, reverse sorted children
1174
if from_dir is not None:
1175
from_dir_id = inv.path2id(from_dir)
1176
if from_dir_id is None:
1177
# Directory not versioned
1179
from_dir_abspath = pathjoin(self.basedir, from_dir)
1181
from_dir_id = inv.root.file_id
1182
from_dir_abspath = self.basedir
1183
children = os.listdir(from_dir_abspath)
1068
children = os.listdir(self.basedir)
1184
1069
children.sort()
1185
# jam 20060527 The kernel sized tree seems equivalent whether we
1070
# jam 20060527 The kernel sized tree seems equivalent whether we
1186
1071
# use a deque and popleft to keep them sorted, or if we use a plain
1187
1072
# list and just reverse() them.
1188
1073
children = collections.deque(children)
1189
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1074
stack = [(inv.root.file_id, u'', self.basedir, children)]
1191
1076
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1246
1131
except KeyError:
1247
1132
yield fp[1:], c, fk, None, TreeEntry()
1250
1135
if fk != 'directory':
1253
# But do this child first if recursing down
1255
new_children = os.listdir(fap)
1257
new_children = collections.deque(new_children)
1258
stack.append((f_ie.file_id, fp, fap, new_children))
1259
# Break out of inner loop,
1260
# so that we start outer loop with child
1138
# But do this child first
1139
new_children = os.listdir(fap)
1141
new_children = collections.deque(new_children)
1142
stack.append((f_ie.file_id, fp, fap, new_children))
1143
# Break out of inner loop,
1144
# so that we start outer loop with child
1263
1147
# if we finished all children, pop it off the stack
1500
1383
from_tail = splitpath(from_rel)[-1]
1501
1384
from_id = inv.path2id(from_rel)
1502
1385
if from_id is None:
1503
# if file is missing in the inventory maybe it's in the basis_tree
1504
basis_tree = self.branch.basis_tree()
1505
from_id = basis_tree.path2id(from_rel)
1507
raise errors.BzrRenameFailedError(from_rel,to_rel,
1508
errors.NotVersionedError(path=str(from_rel)))
1509
# put entry back in the inventory so we can rename it
1510
from_entry = basis_tree.inventory[from_id].copy()
1513
from_entry = inv[from_id]
1386
raise errors.BzrRenameFailedError(from_rel,to_rel,
1387
errors.NotVersionedError(path=str(from_rel)))
1388
from_entry = inv[from_id]
1514
1389
from_parent_id = from_entry.parent_id
1515
1390
to_dir, to_tail = os.path.split(to_rel)
1516
1391
to_dir_id = inv.path2id(to_dir)
1578
1453
:raises: NoSuchId if any fileid is not currently versioned.
1580
1455
for file_id in file_ids:
1581
if file_id not in self._inventory:
1582
raise errors.NoSuchId(self, file_id)
1583
for file_id in file_ids:
1584
1456
if self._inventory.has_id(file_id):
1585
1457
self._inventory.remove_recursive_id(file_id)
1459
raise errors.NoSuchId(self, file_id)
1586
1460
if len(file_ids):
1587
# in the future this should just set a dirty bit to wait for the
1461
# in the future this should just set a dirty bit to wait for the
1588
1462
# final unlock. However, until all methods of workingtree start
1589
# with the current in -memory inventory rather than triggering
1463
# with the current in -memory inventory rather than triggering
1590
1464
# a read, it is more complex - we need to teach read_inventory
1591
1465
# to know when to read, and when to not read first... and possibly
1592
1466
# to save first when the in memory one may be corrupted.
1593
1467
# so for now, we just only write it if it is indeed dirty.
1594
1468
# - RBC 20060907
1595
1469
self._write_inventory(self._inventory)
1597
1471
def _iter_conflicts(self):
1598
1472
conflicted = set()
1599
1473
for info in self.list_files():
1608
1482
@needs_write_lock
1609
1483
def pull(self, source, overwrite=False, stop_revision=None,
1610
change_reporter=None, possible_transports=None, local=False):
1484
change_reporter=None, possible_transports=None):
1485
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1611
1486
source.lock_read()
1488
pp = ProgressPhase("Pull phase", 2, top_pb)
1613
1490
old_revision_info = self.branch.last_revision_info()
1614
1491
basis_tree = self.basis_tree()
1615
1492
count = self.branch.pull(source, overwrite, stop_revision,
1616
possible_transports=possible_transports,
1493
possible_transports=possible_transports)
1618
1494
new_revision_info = self.branch.last_revision_info()
1619
1495
if new_revision_info != old_revision_info:
1620
1497
repository = self.branch.repository
1498
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1621
1499
basis_tree.lock_read()
1623
1501
new_basis_tree = self.branch.basis_tree()
1626
1504
new_basis_tree,
1628
1506
this_tree=self,
1630
1508
change_reporter=change_reporter)
1631
basis_root_id = basis_tree.get_root_id()
1632
new_root_id = new_basis_tree.get_root_id()
1633
if basis_root_id != new_root_id:
1634
self.set_root_id(new_root_id)
1509
if (basis_tree.inventory.root is None and
1510
new_basis_tree.inventory.root is not None):
1511
self.set_root_id(new_basis_tree.get_root_id())
1636
1514
basis_tree.unlock()
1637
1515
# TODO - dedup parents list with things merged by pull ?
1638
1516
# reuse the revisiontree we merged against to set the new
1640
1518
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1641
# we have to pull the merge trees out again, because
1642
# merge_inner has set the ids. - this corner is not yet
1519
# we have to pull the merge trees out again, because
1520
# merge_inner has set the ids. - this corner is not yet
1643
1521
# layered well enough to prevent double handling.
1644
1522
# XXX TODO: Fix the double handling: telling the tree about
1645
1523
# the already known parent data is wasteful.
1805
1675
raise errors.ObjectNotLocked(self)
1807
1677
def lock_read(self):
1808
"""Lock the tree for reading.
1810
This also locks the branch, and can be unlocked via self.unlock().
1812
:return: A bzrlib.lock.LogicalLockResult.
1678
"""See Branch.lock_read, and WorkingTree.unlock."""
1814
1679
if not self.is_locked():
1815
1680
self._reset_data()
1816
1681
self.branch.lock_read()
1818
self._control_files.lock_read()
1819
return LogicalLockResult(self.unlock)
1683
return self._control_files.lock_read()
1821
1685
self.branch.unlock()
1824
1688
def lock_tree_write(self):
1825
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1827
:return: A bzrlib.lock.LogicalLockResult.
1689
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1829
1690
if not self.is_locked():
1830
1691
self._reset_data()
1831
1692
self.branch.lock_read()
1833
self._control_files.lock_write()
1834
return LogicalLockResult(self.unlock)
1694
return self._control_files.lock_write()
1836
1696
self.branch.unlock()
1839
1699
def lock_write(self):
1840
"""See MutableTree.lock_write, and WorkingTree.unlock.
1842
:return: A bzrlib.lock.LogicalLockResult.
1700
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1844
1701
if not self.is_locked():
1845
1702
self._reset_data()
1846
1703
self.branch.lock_write()
1848
self._control_files.lock_write()
1849
return LogicalLockResult(self.unlock)
1705
return self._control_files.lock_write()
1851
1707
self.branch.unlock()
1907
1758
# as commit already has that ready-to-use [while the format is the
1908
1759
# same, that is].
1910
# this double handles the inventory - unpack and repack -
1761
# this double handles the inventory - unpack and repack -
1911
1762
# but is easier to understand. We can/should put a conditional
1912
1763
# in here based on whether the inventory is in the latest format
1913
1764
# - perhaps we should repack all inventories on a repository
1915
1766
# the fast path is to copy the raw xml from the repository. If the
1916
# xml contains 'revision_id="', then we assume the right
1767
# xml contains 'revision_id="', then we assume the right
1917
1768
# revision_id is set. We must check for this full string, because a
1918
1769
# root node id can legitimately look like 'revision_id' but cannot
1919
1770
# contain a '"'.
1920
xml = self.branch.repository._get_inventory_xml(new_revision)
1771
xml = self.branch.repository.get_inventory_xml(new_revision)
1921
1772
firstline = xml.split('\n', 1)[0]
1922
if (not 'revision_id="' in firstline or
1773
if (not 'revision_id="' in firstline or
1923
1774
'format="7"' not in firstline):
1924
inv = self.branch.repository._serializer.read_inventory_from_string(
1775
inv = self.branch.repository.deserialise_inventory(
1926
1777
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1927
1778
self._write_basis_inventory(xml)
1928
1779
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1931
1782
def read_basis_inventory(self):
1932
1783
"""Read the cached basis inventory."""
1933
1784
path = self._basis_inventory_name()
1934
return self._transport.get_bytes(path)
1785
return self._control_files.get(path).read()
1936
1787
@needs_read_lock
1937
1788
def read_working_inventory(self):
1938
1789
"""Read the working inventory.
1940
1791
:raises errors.InventoryModified: read_working_inventory will fail
1941
1792
when the current in memory inventory has been modified.
1943
# conceptually this should be an implementation detail of the tree.
1794
# conceptually this should be an implementation detail of the tree.
1944
1795
# XXX: Deprecate this.
1945
1796
# ElementTree does its own conversion from UTF-8, so open in
1947
1798
if self._inventory_is_modified:
1948
1799
raise errors.InventoryModified(self)
1949
f = self._transport.get('inventory')
1951
result = self._deserialize(f)
1800
result = self._deserialize(self._control_files.get('inventory'))
1954
1801
self._set_inventory(result, dirty=False)
1972
1819
new_files=set()
1973
1820
unknown_nested_files=set()
1975
to_file = sys.stdout
1977
1822
def recurse_directory_to_add_files(directory):
1978
1823
# Recurse directory and add all files
1979
1824
# so we can check if they have changed.
1980
for parent_info, file_infos in self.walkdirs(directory):
1981
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1825
for parent_info, file_infos in\
1826
osutils.walkdirs(self.abspath(directory),
1828
for relpath, basename, kind, lstat, abspath in file_infos:
1982
1829
# Is it versioned or ignored?
1983
1830
if self.path2id(relpath) or self.is_ignored(relpath):
1984
1831
# Add nested content for deletion.
2200
2046
def unlock(self):
2201
2047
"""See Branch.unlock.
2203
2049
WorkingTree locking just uses the Branch locking facilities.
2204
2050
This is current because all working trees have an embedded branch
2205
2051
within them. IF in the future, we were to make branch data shareable
2206
between multiple working trees, i.e. via shared storage, then we
2052
between multiple working trees, i.e. via shared storage, then we
2207
2053
would probably want to lock both the local tree, and the branch.
2209
2055
raise NotImplementedError(self.unlock)
2213
def update(self, change_reporter=None, possible_transports=None,
2214
revision=None, old_tip=_marker):
2057
def update(self, change_reporter=None, possible_transports=None):
2215
2058
"""Update a working tree along its branch.
2217
2060
This will update the branch if its bound too, which means we have
2271
2107
# cant set that until we update the working trees last revision to be
2272
2108
# one from the new branch, because it will just get absorbed by the
2273
2109
# parent de-duplication logic.
2275
2111
# We MUST save it even if an error occurs, because otherwise the users
2276
2112
# local work is unreferenced and will appear to have been lost.
2280
2116
last_rev = self.get_parent_ids()[0]
2281
2117
except IndexError:
2282
2118
last_rev = _mod_revision.NULL_REVISION
2283
if revision is None:
2284
revision = self.branch.last_revision()
2286
old_tip = old_tip or _mod_revision.NULL_REVISION
2288
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2289
# the branch we are bound to was updated
2290
# merge those changes in first
2291
base_tree = self.basis_tree()
2292
other_tree = self.branch.repository.revision_tree(old_tip)
2293
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2294
base_tree, this_tree=self,
2295
change_reporter=change_reporter)
2297
self.add_parent_tree((old_tip, other_tree))
2298
trace.note('Rerun update after fixing the conflicts.')
2301
if last_rev != _mod_revision.ensure_null(revision):
2302
# the working tree is up to date with the branch
2303
# we can merge the specified revision from master
2304
to_tree = self.branch.repository.revision_tree(revision)
2305
to_root_id = to_tree.get_root_id()
2119
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2120
# merge tree state up to new branch tip.
2307
2121
basis = self.basis_tree()
2308
2122
basis.lock_read()
2310
if (basis.inventory.root is None
2311
or basis.inventory.root.file_id != to_root_id):
2312
self.set_root_id(to_root_id)
2124
to_tree = self.branch.basis_tree()
2125
if basis.inventory.root is None:
2126
self.set_root_id(to_tree.get_root_id())
2128
result += merge.merge_inner(
2133
change_reporter=change_reporter)
2317
# determine the branch point
2318
graph = self.branch.repository.get_graph()
2319
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2321
base_tree = self.branch.repository.revision_tree(base_rev_id)
2323
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2325
change_reporter=change_reporter)
2326
self.set_last_revision(revision)
2327
2136
# TODO - dedup parents list with things merged by pull ?
2328
2137
# reuse the tree we've updated to to set the basis:
2329
parent_trees = [(revision, to_tree)]
2138
parent_trees = [(self.branch.last_revision(), to_tree)]
2330
2139
merges = self.get_parent_ids()[1:]
2331
2140
# Ideally we ask the tree for the trees here, that way the working
2332
# tree can decide whether to give us the entire tree or give us a
2141
# tree can decide whether to give us teh entire tree or give us a
2333
2142
# lazy initialised tree. dirstate for instance will have the trees
2334
2143
# in ram already, whereas a last-revision + basis-inventory tree
2335
2144
# will not, but also does not need them when setting parents.
2336
2145
for parent in merges:
2337
2146
parent_trees.append(
2338
2147
(parent, self.branch.repository.revision_tree(parent)))
2339
if not _mod_revision.is_null(old_tip):
2148
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2340
2149
parent_trees.append(
2341
2150
(old_tip, self.branch.repository.revision_tree(old_tip)))
2342
2151
self.set_parent_trees(parent_trees)
2343
2152
last_rev = parent_trees[0][0]
2154
# the working tree had the same last-revision as the master
2155
# branch did. We may still have pivot local work from the local
2156
# branch into old_tip:
2157
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2158
self.add_parent_tree_id(old_tip)
2159
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2160
and old_tip != last_rev):
2161
# our last revision was not the prior branch last revision
2162
# and we have converted that last revision to a pending merge.
2163
# base is somewhere between the branch tip now
2164
# and the now pending merge
2166
# Since we just modified the working tree and inventory, flush out
2167
# the current state, before we modify it again.
2168
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2169
# requires it only because TreeTransform directly munges the
2170
# inventory and calls tree._write_inventory(). Ultimately we
2171
# should be able to remove this extra flush.
2173
graph = self.branch.repository.get_graph()
2174
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2176
base_tree = self.branch.repository.revision_tree(base_rev_id)
2177
other_tree = self.branch.repository.revision_tree(old_tip)
2178
result += merge.merge_inner(
2183
change_reporter=change_reporter)
2346
2186
def _write_hashcache_if_dirty(self):
2347
2187
"""Write out the hashcache if it is dirty."""
2545
2383
# FIXME: stash the node in pending
2546
2384
entry = inv[top_id]
2547
if entry.kind == 'directory':
2548
for name, child in entry.sorted_children():
2549
dirblock.append((relroot + name, name, child.kind, None,
2550
child.file_id, child.kind
2385
for name, child in entry.sorted_children():
2386
dirblock.append((relroot + name, name, child.kind, None,
2387
child.file_id, child.kind
2552
2389
yield (currentdir[0], entry.file_id), dirblock
2553
2390
# push the user specified dirs from dirblock
2554
2391
for dir in reversed(dirblock):
2620
def _get_rules_searcher(self, default_searcher):
2621
"""See Tree._get_rules_searcher."""
2622
if self._rules_searcher is None:
2623
self._rules_searcher = super(WorkingTree,
2624
self)._get_rules_searcher(default_searcher)
2625
return self._rules_searcher
2627
def get_shelf_manager(self):
2628
"""Return the ShelfManager for this WorkingTree."""
2629
from bzrlib.shelf import ShelfManager
2630
return ShelfManager(self, self._transport)
2633
2439
class WorkingTree2(WorkingTree):
2634
2440
"""This is the Format 2 working tree.
2636
This was the first weave based working tree.
2442
This was the first weave based working tree.
2637
2443
- uses os locks for locking.
2638
2444
- uses the branch last-revision.
2702
2500
def _last_revision(self):
2703
2501
"""See Mutable.last_revision."""
2705
return self._transport.get_bytes('last-revision')
2503
return self._control_files.get('last-revision').read()
2706
2504
except errors.NoSuchFile:
2707
2505
return _mod_revision.NULL_REVISION
2709
2507
def _change_last_revision(self, revision_id):
2710
2508
"""See WorkingTree._change_last_revision."""
2711
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2509
if revision_id is None or revision_id == NULL_REVISION:
2713
self._transport.delete('last-revision')
2511
self._control_files._transport.delete('last-revision')
2714
2512
except errors.NoSuchFile:
2718
self._transport.put_bytes('last-revision', revision_id,
2719
mode=self.bzrdir._get_file_mode())
2516
self._control_files.put_bytes('last-revision', revision_id)
2722
def _get_check_refs(self):
2723
"""Return the references needed to perform a check of this tree."""
2724
return [('trees', self.last_revision())]
2726
2519
@needs_tree_write_lock
2727
2520
def set_conflicts(self, conflicts):
2728
self._put_rio('conflicts', conflicts.to_stanzas(),
2521
self._put_rio('conflicts', conflicts.to_stanzas(),
2729
2522
CONFLICT_HEADER_1)
2731
2524
@needs_tree_write_lock
2874
2656
"""See WorkingTreeFormat.get_format_description()."""
2875
2657
return "Working tree format 2"
2877
def _stub_initialize_on_transport(self, transport, file_mode):
2878
"""Workaround: create control files for a remote working tree.
2659
def stub_initialize_remote(self, control_files):
2660
"""As a special workaround create critical control files for a remote working tree
2880
2662
This ensures that it can later be updated and dealt with locally,
2881
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2663
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2882
2664
no working tree. (See bug #43064).
2884
2666
sio = StringIO()
2885
inv = inventory.Inventory()
2886
2668
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2888
transport.put_file('inventory', sio, file_mode)
2889
transport.put_bytes('pending-merges', '', file_mode)
2670
control_files.put('inventory', sio)
2672
control_files.put_bytes('pending-merges', '')
2891
2675
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2892
2676
accelerator_tree=None, hardlink=False):