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
78
90
from bzrlib import symbol_versioning
79
91
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
92
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
81
93
from bzrlib.lockable_files import LockableFiles
82
94
from bzrlib.lockdir import LockDir
83
95
import bzrlib.mutabletree
84
96
from bzrlib.mutabletree import needs_tree_write_lock
85
97
from bzrlib import osutils
86
98
from bzrlib.osutils import (
96
110
from bzrlib.filters import filtered_input_file
97
111
from bzrlib.trace import mutter, note
98
112
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
113
from bzrlib.progress import DummyProgress, ProgressPhase
114
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
115
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
116
from bzrlib.symbol_versioning import (deprecated_passed,
119
DEPRECATED_PARAMETER,
107
123
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
124
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
126
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
286
290
self._control_files.break_lock()
287
291
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
293
def requires_rich_root(self):
300
294
return self._format.requires_rich_root
493
487
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
488
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)]
490
basis = self.basis_tree()
493
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
494
require_versioned=True).next()
495
changed_content, kind = changes[2], changes[6]
496
if not changed_content:
497
return basis.annotate_iter(file_id)
501
if kind[0] != 'file':
504
old_lines = list(basis.annotate_iter(file_id))
506
for tree in self.branch.repository.revision_trees(
507
self.get_parent_ids()[1:]):
508
if file_id not in tree:
510
old.append(list(tree.annotate_iter(file_id)))
511
return annotate.reannotate(old, self.get_file(file_id).readlines(),
533
516
def _get_ancestors(self, default_revision):
534
517
ancestors = set([default_revision])
642
623
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
624
file_id = self.path2id(path)
645
# For unversioned files on win32, we just assume they are not
648
625
return self._inventory[file_id].executable
650
627
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
761
738
kind = _mapper(stat_result.st_mode)
762
739
if kind == 'file':
763
return self._file_content_summary(path, stat_result)
740
size = stat_result.st_size
741
# try for a stat cache lookup
742
executable = self._is_executable_from_path_and_stat(path, stat_result)
743
return (kind, size, executable, self._sha_from_stat(
764
745
elif kind == 'directory':
765
746
# perhaps it looks like a plain directory, but it's really a
774
755
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
757
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
758
"""Common ghost checking functionality from set_parent_*.
906
880
@needs_write_lock # because merge pulls data into the branch.
907
881
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
merge_type=None, force=False):
909
883
"""Merge from a branch into this working tree.
911
885
:param branch: The branch to merge from.
915
889
branch.last_revision().
917
891
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()
892
pb = bzrlib.ui.ui_factory.nested_progress_bar()
894
merger = Merger(self.branch, this_tree=self, pb=pb)
895
merger.pp = ProgressPhase("Merge phase", 5, pb)
896
merger.pp.next_phase()
897
# check that there are no
899
merger.check_basis(check_clean=True, require_commits=False)
900
if to_revision is None:
901
to_revision = _mod_revision.ensure_null(branch.last_revision())
902
merger.other_rev_id = to_revision
903
if _mod_revision.is_null(merger.other_rev_id):
904
raise errors.NoCommits(branch)
905
self.branch.fetch(branch, last_revision=merger.other_rev_id)
906
merger.other_basis = merger.other_rev_id
907
merger.other_tree = self.branch.repository.revision_tree(
909
merger.other_branch = branch
910
merger.pp.next_phase()
911
if from_revision is None:
914
merger.set_base_revision(from_revision, branch)
915
if merger.base_rev_id == merger.other_rev_id:
916
raise errors.PointlessMerge
917
merger.backup_files = False
918
if merge_type is None:
919
merger.merge_type = Merge3Merger
921
merger.merge_type = merge_type
922
merger.set_interesting_files(None)
923
merger.show_base = False
924
merger.reprocess = False
925
conflicts = merger.do_merge()
1097
1078
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1079
if tree_transport.base != branch_transport.base:
1099
1080
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1081
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
1083
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1084
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1085
wt.set_parent_ids(self.get_parent_ids())
1106
1086
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1087
child_inv = Inventory(root_id=None)
1108
1088
new_root = my_inv[file_id]
1109
1089
my_inv.remove_recursive_id(file_id)
1110
1090
new_root.parent_id = None
1142
1122
This does not include files that have been deleted in this
1143
1123
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1125
:param include_root: if True, do not return an entry for the root
1146
1126
:param from_dir: start from this directory or None for the root
1147
1127
:param recursive: whether to recurse into subdirectories or not
1436
1416
inv = self.inventory
1437
1417
for entry in moved:
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1419
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1420
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1421
entry.from_tail, entry.from_parent_id,
1443
1422
entry.only_change_inv))
1494
1473
from_tail = splitpath(from_rel)[-1]
1495
1474
from_id = inv.path2id(from_rel)
1496
1475
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]
1476
raise errors.BzrRenameFailedError(from_rel,to_rel,
1477
errors.NotVersionedError(path=str(from_rel)))
1478
from_entry = inv[from_id]
1508
1479
from_parent_id = from_entry.parent_id
1509
1480
to_dir, to_tail = os.path.split(to_rel)
1510
1481
to_dir_id = inv.path2id(to_dir)
1602
1573
@needs_write_lock
1603
1574
def pull(self, source, overwrite=False, stop_revision=None,
1604
1575
change_reporter=None, possible_transports=None, local=False):
1576
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1577
source.lock_read()
1579
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
1581
old_revision_info = self.branch.last_revision_info()
1608
1582
basis_tree = self.basis_tree()
1609
1583
count = self.branch.pull(source, overwrite, stop_revision,
1620
1596
new_basis_tree,
1622
1598
this_tree=self,
1624
1600
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)
1601
if (basis_tree.inventory.root is None and
1602
new_basis_tree.inventory.root is not None):
1603
self.set_root_id(new_basis_tree.get_root_id())
1630
1606
basis_tree.unlock()
1631
1607
# TODO - dedup parents list with things merged by pull ?
1632
1608
# reuse the revisiontree we merged against to set the new
1735
1712
r"""Check whether the filename matches an ignore pattern.
1737
1714
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.
1715
others match against only the last component.
1742
1717
If the file is ignored, returns the pattern which caused it to
1743
1718
be ignored, otherwise None. So this can simply be used as a
1744
1719
boolean if desired."""
1745
1720
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1721
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1722
return self._ignoreglobster.match(filename)
1749
1724
def kind(self, file_id):
1799
1774
raise errors.ObjectNotLocked(self)
1801
1776
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.
1777
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1778
if not self.is_locked():
1809
1779
self._reset_data()
1810
1780
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1782
return self._control_files.lock_read()
1815
1784
self.branch.unlock()
1818
1787
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1788
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1789
if not self.is_locked():
1824
1790
self._reset_data()
1825
1791
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1793
return self._control_files.lock_write()
1830
1795
self.branch.unlock()
1833
1798
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1799
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1800
if not self.is_locked():
1839
1801
self._reset_data()
1840
1802
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1804
return self._control_files.lock_write()
1845
1806
self.branch.unlock()
1911
1868
# revision_id is set. We must check for this full string, because a
1912
1869
# root node id can legitimately look like 'revision_id' but cannot
1913
1870
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1871
xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1872
firstline = xml.split('\n', 1)[0]
1916
1873
if (not 'revision_id="' in firstline or
1917
1874
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1875
inv = self.branch.repository.deserialise_inventory(
1920
1877
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1878
self._write_basis_inventory(xml)
1922
1879
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2042
1993
new_status = 'I'
2044
1995
new_status = '?'
2045
# XXX: Really should be a more abstract reporter interface
2046
kind_ch = osutils.kind_marker(self.kind(fid))
2047
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1996
textui.show_status(new_status, self.kind(fid), f,
2048
1998
# Unversion file
2049
1999
inv_delta.append((f, None, fid, None))
2050
2000
message = "removed %s" % (f,)
2202
2153
raise NotImplementedError(self.unlock)
2206
def update(self, change_reporter=None, possible_transports=None,
2207
revision=None, old_tip=_marker):
2155
def update(self, change_reporter=None, possible_transports=None):
2208
2156
"""Update a working tree along its branch.
2210
2158
This will update the branch if its bound too, which means we have
2228
2176
- Merge current state -> basis tree of the master w.r.t. the old tree
2230
2178
- Do a 'normal' merge of the old branch basis if it is relevant.
2232
:param revision: The target revision to update to. Must be in the
2234
:param old_tip: If branch.update() has already been run, the value it
2235
returned (old tip of the branch or None). _marker is used
2238
2180
if self.branch.get_bound_location() is not None:
2239
2181
self.lock_write()
2240
update_branch = (old_tip is self._marker)
2182
update_branch = True
2242
2184
self.lock_tree_write()
2243
2185
update_branch = False
2245
2187
if update_branch:
2246
2188
old_tip = self.branch.update(possible_transports)
2248
if old_tip is self._marker:
2250
return self._update_tree(old_tip, change_reporter, revision)
2191
return self._update_tree(old_tip, change_reporter)
2254
2195
@needs_tree_write_lock
2255
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2196
def _update_tree(self, old_tip=None, change_reporter=None):
2256
2197
"""Update a tree to the master branch.
2258
2199
:param old_tip: if supplied, the previous tip revision the branch,
2268
2209
# We MUST save it even if an error occurs, because otherwise the users
2269
2210
# local work is unreferenced and will appear to have been lost.
2273
2214
last_rev = self.get_parent_ids()[0]
2274
2215
except IndexError:
2275
2216
last_rev = _mod_revision.NULL_REVISION
2276
if revision is None:
2277
revision = self.branch.last_revision()
2279
old_tip = old_tip or _mod_revision.NULL_REVISION
2281
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
# the branch we are bound to was updated
2283
# merge those changes in first
2284
base_tree = self.basis_tree()
2285
other_tree = self.branch.repository.revision_tree(old_tip)
2286
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
base_tree, this_tree=self,
2288
change_reporter=change_reporter)
2290
self.add_parent_tree((old_tip, other_tree))
2291
trace.note('Rerun update after fixing the conflicts.')
2294
if last_rev != _mod_revision.ensure_null(revision):
2295
# the working tree is up to date with the branch
2296
# we can merge the specified revision from master
2297
to_tree = self.branch.repository.revision_tree(revision)
2298
to_root_id = to_tree.get_root_id()
2217
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2218
# merge tree state up to new branch tip.
2300
2219
basis = self.basis_tree()
2301
2220
basis.lock_read()
2303
if (basis.inventory.root is None
2304
or basis.inventory.root.file_id != to_root_id):
2305
self.set_root_id(to_root_id)
2222
to_tree = self.branch.basis_tree()
2223
if basis.inventory.root is None:
2224
self.set_root_id(to_tree.get_root_id())
2226
result += merge.merge_inner(
2231
change_reporter=change_reporter)
2310
# determine the branch point
2311
graph = self.branch.repository.get_graph()
2312
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
change_reporter=change_reporter)
2319
self.set_last_revision(revision)
2320
2234
# TODO - dedup parents list with things merged by pull ?
2321
2235
# reuse the tree we've updated to to set the basis:
2322
parent_trees = [(revision, to_tree)]
2236
parent_trees = [(self.branch.last_revision(), to_tree)]
2323
2237
merges = self.get_parent_ids()[1:]
2324
2238
# Ideally we ask the tree for the trees here, that way the working
2325
2239
# tree can decide whether to give us the entire tree or give us a
2329
2243
for parent in merges:
2330
2244
parent_trees.append(
2331
2245
(parent, self.branch.repository.revision_tree(parent)))
2332
if not _mod_revision.is_null(old_tip):
2246
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2333
2247
parent_trees.append(
2334
2248
(old_tip, self.branch.repository.revision_tree(old_tip)))
2335
2249
self.set_parent_trees(parent_trees)
2336
2250
last_rev = parent_trees[0][0]
2252
# the working tree had the same last-revision as the master
2253
# branch did. We may still have pivot local work from the local
2254
# branch into old_tip:
2255
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2256
self.add_parent_tree_id(old_tip)
2257
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2258
and old_tip != last_rev):
2259
# our last revision was not the prior branch last revision
2260
# and we have converted that last revision to a pending merge.
2261
# base is somewhere between the branch tip now
2262
# and the now pending merge
2264
# Since we just modified the working tree and inventory, flush out
2265
# the current state, before we modify it again.
2266
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2267
# requires it only because TreeTransform directly munges the
2268
# inventory and calls tree._write_inventory(). Ultimately we
2269
# should be able to remove this extra flush.
2271
graph = self.branch.repository.get_graph()
2272
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2274
base_tree = self.branch.repository.revision_tree(base_rev_id)
2275
other_tree = self.branch.repository.revision_tree(old_tip)
2276
result += merge.merge_inner(
2281
change_reporter=change_reporter)
2339
2284
def _write_hashcache_if_dirty(self):
2340
2285
"""Write out the hashcache if it is dirty."""
2581
2526
return un_resolved, resolved
2583
2528
@needs_read_lock
2584
def _check(self, references):
2585
"""Check the tree for consistency.
2587
:param references: A dict with keys matching the items returned by
2588
self._get_check_refs(), and values from looking those keys up in
2591
2530
tree_basis = self.basis_tree()
2592
2531
tree_basis.lock_read()
2594
repo_basis = references[('trees', self.last_revision())]
2533
repo_basis = self.branch.repository.revision_tree(
2534
self.last_revision())
2595
2535
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2596
2536
raise errors.BzrCheckError(
2597
2537
"Mismatched basis inventory content.")
2642
2583
if self._inventory is None:
2643
2584
self.read_working_inventory()
2645
def _get_check_refs(self):
2646
"""Return the references needed to perform a check of this tree."""
2647
return [('trees', self.last_revision())]
2649
2586
def lock_tree_write(self):
2650
2587
"""See WorkingTree.lock_tree_write().
2652
2589
In Format2 WorkingTrees we have a single lock for the branch and tree
2653
2590
so lock_tree_write() degrades to lock_write().
2655
:return: An object with an unlock method which will release the lock
2658
2592
self.branch.lock_write()
2660
self._control_files.lock_write()
2594
return self._control_files.lock_write()
2663
2596
self.branch.unlock()
2712
2645
mode=self.bzrdir._get_file_mode())
2715
def _get_check_refs(self):
2716
"""Return the references needed to perform a check of this tree."""
2717
return [('trees', self.last_revision())]
2719
2648
@needs_tree_write_lock
2720
2649
def set_conflicts(self, conflicts):
2721
2650
self._put_rio('conflicts', conflicts.to_stanzas(),
2798
2727
"""Return the format for the working tree object in a_bzrdir."""
2800
2729
transport = a_bzrdir.get_workingtree_transport(None)
2801
format_string = transport.get_bytes("format")
2730
format_string = transport.get("format").read()
2802
2731
return klass._formats[format_string]
2803
2732
except errors.NoSuchFile:
2804
2733
raise errors.NoWorkingTree(base=transport.base)
3068
2997
return self.get_format_string()
3071
__default_format = WorkingTreeFormat6()
3000
__default_format = WorkingTreeFormat4()
3072
3001
WorkingTreeFormat.register_format(__default_format)
3002
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3073
3003
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3074
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3075
3004
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3076
3005
WorkingTreeFormat.set_default_format(__default_format)
3077
3006
# formats which have no format string are not discoverable