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
29
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
33
39
from cStringIO import StringIO
51
59
conflicts as _mod_conflicts,
60
67
revision as _mod_revision,
69
80
import bzrlib.branch
70
81
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
83
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
78
86
from bzrlib import symbol_versioning
79
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
81
89
from bzrlib.lockable_files import LockableFiles
82
90
from bzrlib.lockdir import LockDir
83
91
import bzrlib.mutabletree
84
92
from bzrlib.mutabletree import needs_tree_write_lock
85
93
from bzrlib import osutils
86
94
from bzrlib.osutils import (
94
104
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
106
from bzrlib.trace import mutter, note
98
107
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
108
from bzrlib.progress import DummyProgress, ProgressPhase
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
110
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
111
from bzrlib.symbol_versioning import (deprecated_passed,
114
DEPRECATED_PARAMETER,
107
118
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
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
121
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
116
124
class TreeEntry(object):
117
125
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
127
This needs further inspection, it may be better to have
120
128
InventoryEntries without ids - though that seems wrong. For now,
121
129
this is a parallel hierarchy to InventoryEntry, and needs to become
122
130
one of several things: decorates to that hierarchy, children of, or
223
230
wt_trans = self.bzrdir.get_workingtree_transport(None)
224
231
cache_filename = wt_trans.local_abspath('stat-cache')
225
232
self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
self.bzrdir._get_file_mode(),
227
self._content_filter_stack_provider())
233
self.bzrdir._get_file_mode())
228
234
hc = self._hashcache
230
236
# is this scan needed ? it makes things kinda slow.
286
284
self._control_files.break_lock()
287
285
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
287
def requires_rich_root(self):
300
288
return self._format.requires_rich_root
447
435
def has_filename(self, filename):
448
436
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]
438
def get_file(self, file_id, path=None):
439
return self.get_file_with_stat(file_id, path)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
441
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
442
"""See MutableTree.get_file_with_stat."""
457
444
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):
445
file_obj = self.get_file_byname(path)
446
return (file_obj, _fstat(file_obj.fileno()))
448
def get_file_byname(self, filename):
449
return file(self.abspath(filename), 'rb')
451
def get_file_lines(self, file_id, path=None):
478
452
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
453
file = self.get_file(file_id, path)
481
455
return file.readlines()
493
467
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
468
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)]
470
basis = self.basis_tree()
473
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
474
require_versioned=True).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
533
496
def _get_ancestors(self, default_revision):
534
497
ancestors = set([default_revision])
571
534
def clone(self, to_bzrdir, revision_id=None):
572
535
"""Duplicate this working tree into to_bzr, including all state.
574
537
Specifically modified files are kept as modified, but
575
538
ignored and unknown files are discarded.
577
540
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
543
If not None, the cloned tree will have its last revision set to
581
544
revision, and difference between the source trees last revision
582
545
and this one merged in.
672
629
"""See MutableTree._add."""
673
630
# TODO: Re-adding a file that is removed in the working copy
674
631
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
632
# the read and write working inventory should not occur in this
676
633
# function - they should be part of lock_write and unlock.
677
634
inv = self.inventory
678
635
for f, file_id, kind in zip(files, ids, kinds):
761
718
kind = _mapper(stat_result.st_mode)
762
719
if kind == 'file':
763
return self._file_content_summary(path, stat_result)
720
size = stat_result.st_size
721
# try for a stat cache lookup
722
executable = self._is_executable_from_path_and_stat(path, stat_result)
723
return (kind, size, executable, self._sha_from_stat(
764
725
elif kind == 'directory':
765
726
# perhaps it looks like a plain directory, but it's really a
768
729
kind = 'tree-reference'
769
730
return kind, None, None, None
770
731
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
732
return ('symlink', None, None, os.readlink(abspath.encode(osutils._fs_enc)))
774
734
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
736
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
737
"""Common ghost checking functionality from set_parent_*.
795
748
def _set_merges_from_parent_ids(self, parent_ids):
796
749
merges = parent_ids[1:]
797
750
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
751
mode=self._control_files._file_mode)
800
753
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
754
"""Check that all merged revisions are proper 'heads'.
803
756
This will always return the first revision_id, and any merged revisions
806
759
if len(revision_ids) == 0:
807
760
return revision_ids
901
854
self._must_be_locked()
902
855
my_file = rio_file(stanzas, header)
903
856
self._transport.put_file(filename, my_file,
904
mode=self.bzrdir._get_file_mode())
857
mode=self._control_files._file_mode)
906
859
@needs_write_lock # because merge pulls data into the branch.
907
860
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
merge_type=None, force=False):
909
862
"""Merge from a branch into this working tree.
911
864
:param branch: The branch to merge from.
915
868
branch.last_revision().
917
870
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()
871
pb = bzrlib.ui.ui_factory.nested_progress_bar()
873
merger = Merger(self.branch, this_tree=self, pb=pb)
874
merger.pp = ProgressPhase("Merge phase", 5, pb)
875
merger.pp.next_phase()
876
# check that there are no
878
merger.check_basis(check_clean=True, require_commits=False)
879
if to_revision is None:
880
to_revision = _mod_revision.ensure_null(branch.last_revision())
881
merger.other_rev_id = to_revision
882
if _mod_revision.is_null(merger.other_rev_id):
883
raise errors.NoCommits(branch)
884
self.branch.fetch(branch, last_revision=merger.other_rev_id)
885
merger.other_basis = merger.other_rev_id
886
merger.other_tree = self.branch.repository.revision_tree(
888
merger.other_branch = branch
889
merger.pp.next_phase()
890
if from_revision is None:
893
merger.set_base_revision(from_revision, branch)
894
if merger.base_rev_id == merger.other_rev_id:
895
raise errors.PointlessMerge
896
merger.backup_files = False
897
if merge_type is None:
898
merger.merge_type = Merge3Merger
900
merger.merge_type = merge_type
901
merger.set_interesting_files(None)
902
merger.show_base = False
903
merger.reprocess = False
904
conflicts = merger.do_merge()
951
911
def merge_modified(self):
952
912
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
914
The list is initialized by WorkingTree.set_merge_modified, which is
955
915
typically called after we make some automatic updates to the tree
956
916
because of a merge.
1051
1009
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
1010
# as a special case, if a directory contains control files then
1053
1011
# it's a tree reference, except that the root of the tree is not
1054
1012
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
1013
# TODO: We could ask all the control formats whether they
1097
1055
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1056
if tree_transport.base != branch_transport.base:
1099
1057
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1058
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
1060
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1061
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1062
wt.set_parent_ids(self.get_parent_ids())
1106
1063
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1064
child_inv = Inventory(root_id=None)
1108
1065
new_root = my_inv[file_id]
1109
1066
my_inv.remove_recursive_id(file_id)
1110
1067
new_root.parent_id = None
1129
1086
self._serialize(self._inventory, sio)
1131
1088
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1089
mode=self._control_files._file_mode)
1133
1090
self._inventory_is_modified = False
1135
1092
def _kind(self, relpath):
1136
1093
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).
1095
def list_files(self, include_root=False):
1096
"""Recursively list all files as (path, class, kind, id, entry).
1141
1098
Lists, but does not descend into unversioned directories.
1142
1100
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
1103
Skips the control directory.
1149
1105
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1106
# with it. So callers should be careful to always read_lock the tree.
1165
1121
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
1123
# 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)
1124
children = os.listdir(self.basedir)
1178
1125
children.sort()
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1126
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
1127
# use a deque and popleft to keep them sorted, or if we use a plain
1181
1128
# list and just reverse() them.
1182
1129
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1130
stack = [(inv.root.file_id, u'', self.basedir, children)]
1185
1132
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1240
1187
except KeyError:
1241
1188
yield fp[1:], c, fk, None, TreeEntry()
1244
1191
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
1194
# But do this child first
1195
new_children = os.listdir(fap)
1197
new_children = collections.deque(new_children)
1198
stack.append((f_ie.file_id, fp, fap, new_children))
1199
# Break out of inner loop,
1200
# so that we start outer loop with child
1257
1203
# if we finished all children, pop it off the stack
1436
1382
inv = self.inventory
1437
1383
for entry in moved:
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1385
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1386
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1387
entry.from_tail, entry.from_parent_id,
1443
1388
entry.only_change_inv))
1494
1439
from_tail = splitpath(from_rel)[-1]
1495
1440
from_id = inv.path2id(from_rel)
1496
1441
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]
1442
raise errors.BzrRenameFailedError(from_rel,to_rel,
1443
errors.NotVersionedError(path=str(from_rel)))
1444
from_entry = inv[from_id]
1508
1445
from_parent_id = from_entry.parent_id
1509
1446
to_dir, to_tail = os.path.split(to_rel)
1510
1447
to_dir_id = inv.path2id(to_dir)
1572
1509
:raises: NoSuchId if any fileid is not currently versioned.
1574
1511
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
1512
if self._inventory.has_id(file_id):
1579
1513
self._inventory.remove_recursive_id(file_id)
1515
raise errors.NoSuchId(self, file_id)
1580
1516
if len(file_ids):
1581
# in the future this should just set a dirty bit to wait for the
1517
# in the future this should just set a dirty bit to wait for the
1582
1518
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1519
# with the current in -memory inventory rather than triggering
1584
1520
# a read, it is more complex - we need to teach read_inventory
1585
1521
# to know when to read, and when to not read first... and possibly
1586
1522
# to save first when the in memory one may be corrupted.
1587
1523
# so for now, we just only write it if it is indeed dirty.
1588
1524
# - RBC 20060907
1589
1525
self._write_inventory(self._inventory)
1591
1527
def _iter_conflicts(self):
1592
1528
conflicted = set()
1593
1529
for info in self.list_files():
1602
1538
@needs_write_lock
1603
1539
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1540
change_reporter=None, possible_transports=None):
1541
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1542
source.lock_read()
1544
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
1546
old_revision_info = self.branch.last_revision_info()
1608
1547
basis_tree = self.basis_tree()
1609
1548
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1549
possible_transports=possible_transports)
1612
1550
new_revision_info = self.branch.last_revision_info()
1613
1551
if new_revision_info != old_revision_info:
1614
1553
repository = self.branch.repository
1554
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1555
basis_tree.lock_read()
1617
1557
new_basis_tree = self.branch.basis_tree()
1620
1560
new_basis_tree,
1622
1562
this_tree=self,
1624
1564
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)
1565
if (basis_tree.inventory.root is None and
1566
new_basis_tree.inventory.root is not None):
1567
self.set_root_id(new_basis_tree.get_root_id())
1630
1570
basis_tree.unlock()
1631
1571
# TODO - dedup parents list with things merged by pull ?
1632
1572
# reuse the revisiontree we merged against to set the new
1634
1574
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
1575
# we have to pull the merge trees out again, because
1576
# merge_inner has set the ids. - this corner is not yet
1637
1577
# layered well enough to prevent double handling.
1638
1578
# XXX TODO: Fix the double handling: telling the tree about
1639
1579
# the already known parent data is wasteful.
1735
1676
r"""Check whether the filename matches an ignore pattern.
1737
1678
Patterns containing '/' or '\' need to match the whole path;
1738
others match against only the last component. Patterns starting
1739
with '!' are ignore exceptions. Exceptions take precedence
1740
over regular patterns and cause the filename to not be ignored.
1679
others match against only the last component.
1742
1681
If the file is ignored, returns the pattern which caused it to
1743
1682
be ignored, otherwise None. So this can simply be used as a
1744
1683
boolean if desired."""
1745
1684
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1685
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1686
return self._ignoreglobster.match(filename)
1749
1688
def kind(self, file_id):
1799
1738
raise errors.ObjectNotLocked(self)
1801
1740
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.
1741
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1742
if not self.is_locked():
1809
1743
self._reset_data()
1810
1744
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1746
return self._control_files.lock_read()
1815
1748
self.branch.unlock()
1818
1751
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1752
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1753
if not self.is_locked():
1824
1754
self._reset_data()
1825
1755
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1757
return self._control_files.lock_write()
1830
1759
self.branch.unlock()
1833
1762
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1763
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1764
if not self.is_locked():
1839
1765
self._reset_data()
1840
1766
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1768
return self._control_files.lock_write()
1845
1770
self.branch.unlock()
1901
1822
# as commit already has that ready-to-use [while the format is the
1902
1823
# same, that is].
1904
# this double handles the inventory - unpack and repack -
1825
# this double handles the inventory - unpack and repack -
1905
1826
# but is easier to understand. We can/should put a conditional
1906
1827
# in here based on whether the inventory is in the latest format
1907
1828
# - perhaps we should repack all inventories on a repository
1909
1830
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1831
# xml contains 'revision_id="', then we assume the right
1911
1832
# revision_id is set. We must check for this full string, because a
1912
1833
# root node id can legitimately look like 'revision_id' but cannot
1913
1834
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1835
xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1836
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1837
if (not 'revision_id="' in firstline or
1917
1838
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1839
inv = self.branch.repository.deserialise_inventory(
1920
1841
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1842
self._write_basis_inventory(xml)
1922
1843
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1926
1847
"""Read the cached basis inventory."""
1927
1848
path = self._basis_inventory_name()
1928
1849
return self._transport.get_bytes(path)
1930
1851
@needs_read_lock
1931
1852
def read_working_inventory(self):
1932
1853
"""Read the working inventory.
1934
1855
:raises errors.InventoryModified: read_working_inventory will fail
1935
1856
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1858
# conceptually this should be an implementation detail of the tree.
1938
1859
# XXX: Deprecate this.
1939
1860
# ElementTree does its own conversion from UTF-8, so open in
1941
1862
if self._inventory_is_modified:
1942
1863
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1864
result = self._deserialize(self._transport.get('inventory'))
1948
1865
self._set_inventory(result, dirty=False)
1966
1883
new_files=set()
1967
1884
unknown_nested_files=set()
1969
to_file = sys.stdout
1971
1886
def recurse_directory_to_add_files(directory):
1972
1887
# Recurse directory and add all files
1973
1888
# so we can check if they have changed.
1974
for parent_info, file_infos in self.walkdirs(directory):
1889
for parent_info, file_infos in\
1890
self.walkdirs(directory):
1975
1891
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
1892
# Is it versioned or ignored?
1977
1893
if self.path2id(relpath) or self.is_ignored(relpath):
2043
1957
new_status = 'I'
2045
1959
new_status = '?'
2046
# XXX: Really should be a more abstract reporter interface
2047
kind_ch = osutils.kind_marker(self.kind(fid))
2048
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1960
textui.show_status(new_status, self.kind(fid), f,
2049
1962
# Unversion file
2050
1963
inv_delta.append((f, None, fid, None))
2051
1964
message = "removed %s" % (f,)
2194
2108
def unlock(self):
2195
2109
"""See Branch.unlock.
2197
2111
WorkingTree locking just uses the Branch locking facilities.
2198
2112
This is current because all working trees have an embedded branch
2199
2113
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
2114
between multiple working trees, i.e. via shared storage, then we
2201
2115
would probably want to lock both the local tree, and the branch.
2203
2117
raise NotImplementedError(self.unlock)
2207
def update(self, change_reporter=None, possible_transports=None,
2208
revision=None, old_tip=_marker):
2119
def update(self, change_reporter=None, possible_transports=None):
2209
2120
"""Update a working tree along its branch.
2211
2122
This will update the branch if its bound too, which means we have
2229
2140
- Merge current state -> basis tree of the master w.r.t. the old tree
2231
2142
- Do a 'normal' merge of the old branch basis if it is relevant.
2233
:param revision: The target revision to update to. Must be in the
2235
:param old_tip: If branch.update() has already been run, the value it
2236
returned (old tip of the branch or None). _marker is used
2239
2144
if self.branch.get_bound_location() is not None:
2240
2145
self.lock_write()
2241
update_branch = (old_tip is self._marker)
2146
update_branch = True
2243
2148
self.lock_tree_write()
2244
2149
update_branch = False
2246
2151
if update_branch:
2247
2152
old_tip = self.branch.update(possible_transports)
2249
if old_tip is self._marker:
2251
return self._update_tree(old_tip, change_reporter, revision)
2155
return self._update_tree(old_tip, change_reporter)
2255
2159
@needs_tree_write_lock
2256
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2160
def _update_tree(self, old_tip=None, change_reporter=None):
2257
2161
"""Update a tree to the master branch.
2259
2163
:param old_tip: if supplied, the previous tip revision the branch,
2265
2169
# cant set that until we update the working trees last revision to be
2266
2170
# one from the new branch, because it will just get absorbed by the
2267
2171
# parent de-duplication logic.
2269
2173
# We MUST save it even if an error occurs, because otherwise the users
2270
2174
# local work is unreferenced and will appear to have been lost.
2274
2178
last_rev = self.get_parent_ids()[0]
2275
2179
except IndexError:
2276
2180
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()
2181
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2182
# merge tree state up to new branch tip.
2301
2183
basis = self.basis_tree()
2302
2184
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)
2186
to_tree = self.branch.basis_tree()
2187
if basis.inventory.root is None:
2188
self.set_root_id(to_tree.get_root_id())
2190
result += merge.merge_inner(
2195
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
2198
# TODO - dedup parents list with things merged by pull ?
2322
2199
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
2200
parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2201
merges = self.get_parent_ids()[1:]
2325
2202
# Ideally we ask the tree for the trees here, that way the working
2326
2203
# tree can decide whether to give us the entire tree or give us a
2330
2207
for parent in merges:
2331
2208
parent_trees.append(
2332
2209
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
2210
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2211
parent_trees.append(
2335
2212
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2213
self.set_parent_trees(parent_trees)
2337
2214
last_rev = parent_trees[0][0]
2216
# the working tree had the same last-revision as the master
2217
# branch did. We may still have pivot local work from the local
2218
# branch into old_tip:
2219
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2220
self.add_parent_tree_id(old_tip)
2221
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2222
and old_tip != last_rev):
2223
# our last revision was not the prior branch last revision
2224
# and we have converted that last revision to a pending merge.
2225
# base is somewhere between the branch tip now
2226
# and the now pending merge
2228
# Since we just modified the working tree and inventory, flush out
2229
# the current state, before we modify it again.
2230
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2231
# requires it only because TreeTransform directly munges the
2232
# inventory and calls tree._write_inventory(). Ultimately we
2233
# should be able to remove this extra flush.
2235
graph = self.branch.repository.get_graph()
2236
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2238
base_tree = self.branch.repository.revision_tree(base_rev_id)
2239
other_tree = self.branch.repository.revision_tree(old_tip)
2240
result += merge.merge_inner(
2245
change_reporter=change_reporter)
2340
2248
def _write_hashcache_if_dirty(self):
2341
2249
"""Write out the hashcache if it is dirty."""
2441
2349
bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
2350
('.bzr', '.bzr'))
2443
2351
if (bzrdir_loc < len(cur_disk_dir_content)
2444
and self.bzrdir.is_control_filename(
2445
cur_disk_dir_content[bzrdir_loc][0])):
2352
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2446
2353
# we dont yield the contents of, or, .bzr itself.
2447
2354
del cur_disk_dir_content[bzrdir_loc]
2448
2355
if inv_finished:
2582
2489
return un_resolved, resolved
2584
2491
@needs_read_lock
2585
def _check(self, references):
2586
"""Check the tree for consistency.
2588
:param references: A dict with keys matching the items returned by
2589
self._get_check_refs(), and values from looking those keys up in
2592
2493
tree_basis = self.basis_tree()
2593
2494
tree_basis.lock_read()
2595
repo_basis = references[('trees', self.last_revision())]
2496
repo_basis = self.branch.repository.revision_tree(
2497
self.last_revision())
2596
2498
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
2499
raise errors.BzrCheckError(
2598
2500
"Mismatched basis inventory content.")
2643
2546
if self._inventory is None:
2644
2547
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
2650
2549
def lock_tree_write(self):
2651
2550
"""See WorkingTree.lock_tree_write().
2653
2552
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
2553
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
2659
2555
self.branch.lock_write()
2661
self._control_files.lock_write()
2557
return self._control_files.lock_write()
2664
2559
self.branch.unlock()
2712
2607
self._transport.put_bytes('last-revision', revision_id,
2713
mode=self.bzrdir._get_file_mode())
2608
mode=self._control_files._file_mode)
2716
def _get_check_refs(self):
2717
"""Return the references needed to perform a check of this tree."""
2718
return [('trees', self.last_revision())]
2720
2611
@needs_tree_write_lock
2721
2612
def set_conflicts(self, conflicts):
2722
self._put_rio('conflicts', conflicts.to_stanzas(),
2613
self._put_rio('conflicts', conflicts.to_stanzas(),
2723
2614
CONFLICT_HEADER_1)
2725
2616
@needs_tree_write_lock
2774
2665
* a format string,
2775
2666
* an open routine.
2777
Formats are placed in an dict by their format string for reference
2668
Formats are placed in an dict by their format string for reference
2778
2669
during workingtree opening. Its not required that these be instances, they
2779
can be classes themselves with class methods - it simply depends on
2670
can be classes themselves with class methods - it simply depends on
2780
2671
whether state is needed for a given format or not.
2782
2673
Once a format is deprecated, just deprecate the initialize and open
2783
methods on the format class. Do not deprecate the object, as the
2674
methods on the format class. Do not deprecate the object, as the
2784
2675
object will be created every time regardless.
2973
2864
def _open_control_files(self, a_bzrdir):
2974
2865
transport = a_bzrdir.get_workingtree_transport(None)
2975
return LockableFiles(transport, self._lock_file_name,
2866
return LockableFiles(transport, self._lock_file_name,
2976
2867
self._lock_class)
2978
2869
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
2870
accelerator_tree=None, hardlink=False):
2980
2871
"""See WorkingTreeFormat.initialize().
2982
2873
:param revision_id: if supplied, create a working tree at a different
2983
2874
revision than the branch is at.
2984
2875
:param accelerator_tree: A tree which can be used for retrieving file
3069
2960
return self.get_format_string()
3072
__default_format = WorkingTreeFormat6()
2963
__default_format = WorkingTreeFormat4()
3073
2964
WorkingTreeFormat.register_format(__default_format)
3074
2965
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
2966
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2967
WorkingTreeFormat.set_default_format(__default_format)
3078
2968
# formats which have no format string are not discoverable
added
removed
bzrlib/workingtree.py
