13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
23
new revision based on the workingtree and its inventory.
25
25
At the moment every WorkingTree has its own branch. Remote
51
59
conflicts as _mod_conflicts,
60
67
revision as _mod_revision,
69
79
import bzrlib.branch
70
80
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
94
103
supports_executable,
96
from bzrlib.filters import filtered_input_file
105
from bzrlib.filters import filtered_input, filters_for_path
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
121
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
122
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
124
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
127
@deprecated_function(zero_thirteen)
128
def gen_file_id(name):
129
"""Return new file id for the basename 'name'.
131
Use bzrlib.generate_ids.gen_file_id() instead
133
return generate_ids.gen_file_id(name)
136
@deprecated_function(zero_thirteen)
138
"""Return a new tree-root file id.
140
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
142
return generate_ids.gen_root_id()
116
145
class TreeEntry(object):
117
146
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
148
This needs further inspection, it may be better to have
120
149
InventoryEntries without ids - though that seems wrong. For now,
121
150
this is a parallel hierarchy to InventoryEntry, and needs to become
122
151
one of several things: decorates to that hierarchy, children of, or
286
303
self._control_files.break_lock()
287
304
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
306
def requires_rich_root(self):
300
307
return self._format.requires_rich_root
302
309
def supports_tree_reference(self):
305
def supports_content_filtering(self):
306
return self._format.supports_content_filtering()
308
def supports_views(self):
309
return self.views.supports_views()
311
312
def _set_inventory(self, inv, dirty):
312
313
"""Set the internal cached inventory.
423
423
# at this point ?
425
425
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
except errors.RevisionNotPresent:
427
427
# the basis tree *may* be a ghost or a low level error may have
428
# occurred. If the revision is present, its a problem, if its not
428
# occured. If the revision is present, its a problem, if its not
430
430
if self.branch.repository.has_revision(revision_id):
432
432
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
433
return self.branch.repository.revision_tree(None)
436
435
def _cleanup(self):
437
436
self._flush_ignore_list_cache()
439
@deprecated_method(zero_eight)
440
def create(branch, directory):
441
"""Create a workingtree for branch at directory.
443
If existing_directory already exists it must have a .bzr directory.
444
If it does not exist, it will be created.
446
This returns a new WorkingTree object for the new checkout.
448
TODO FIXME RBC 20060124 when we have checkout formats in place this
449
should accept an optional revisionid to checkout [and reject this if
450
checking out into the same dir as a pre-checkout-aware branch format.]
452
XXX: When BzrDir is present, these should be created through that
455
warnings.warn('delete WorkingTree.create', stacklevel=3)
456
transport = get_transport(directory)
457
if branch.bzrdir.root_transport.base == transport.base:
459
return branch.bzrdir.create_workingtree()
460
# different directory,
461
# create a branch reference
462
# and now a working tree.
463
raise NotImplementedError
466
@deprecated_method(zero_eight)
467
def create_standalone(directory):
468
"""Create a checkout and a branch and a repo at directory.
470
Directory must exist and be empty.
472
please use BzrDir.create_standalone_workingtree
474
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
476
def relpath(self, path):
440
477
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
479
The path may be absolute or relative. If its a relative path it is
443
480
interpreted relative to the python current working directory.
445
482
return osutils.relpath(self.basedir, path)
447
484
def has_filename(self, filename):
448
485
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
487
def get_file(self, file_id, path=None):
457
489
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):
490
return self.get_file_byname(path)
492
def get_file_text(self, file_id):
493
return self.get_file(file_id).read()
495
def get_file_byname(self, filename):
469
496
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
497
filters = filters_for_path(path)
498
return filtered_input(file(path, 'rb'), filters)
486
501
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
508
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
509
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)]
511
basis = self.basis_tree()
514
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
515
require_versioned=True).next()
516
changed_content, kind = changes[2], changes[6]
517
if not changed_content:
518
return basis.annotate_iter(file_id)
522
if kind[0] != 'file':
525
old_lines = list(basis.annotate_iter(file_id))
527
for tree in self.branch.repository.revision_trees(
528
self.get_parent_ids()[1:]):
529
if file_id not in tree:
531
old.append(list(tree.annotate_iter(file_id)))
532
return annotate.reannotate(old, self.get_file(file_id).readlines(),
533
537
def _get_ancestors(self, default_revision):
534
538
ancestors = set([default_revision])
571
575
def clone(self, to_bzrdir, revision_id=None):
572
576
"""Duplicate this working tree into to_bzr, including all state.
574
578
Specifically modified files are kept as modified, but
575
579
ignored and unknown files are discarded.
577
581
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
584
If not None, the cloned tree will have its last revision set to
585
revision, and and difference between the source trees last revision
582
586
and this one merged in.
584
588
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
589
result = self._format.initialize(to_bzrdir)
586
590
self.copy_content_into(result, revision_id)
768
764
kind = 'tree-reference'
769
765
return kind, None, None, None
770
766
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
767
return ('symlink', None, None, os.readlink(abspath))
774
769
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(
771
@deprecated_method(zero_eleven)
773
def pending_merges(self):
774
"""Return a list of pending merges.
776
These are revisions that have been merged into the working
777
directory but not yet committed.
779
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
780
instead - which is available on all tree objects.
782
return self.get_parent_ids()[1:]
783
784
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
785
"""Common ghost checking functionality from set_parent_*.
795
796
def _set_merges_from_parent_ids(self, parent_ids):
796
797
merges = parent_ids[1:]
797
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
800
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
"""Check that all merged revisions are proper 'heads'.
803
This will always return the first revision_id, and any merged revisions
806
if len(revision_ids) == 0:
808
graph = self.branch.repository.get_graph()
809
heads = graph.heads(revision_ids)
810
new_revision_ids = revision_ids[:1]
811
for revision_id in revision_ids[1:]:
812
if revision_id in heads and revision_id not in new_revision_ids:
813
new_revision_ids.append(revision_id)
814
if new_revision_ids != revision_ids:
815
trace.mutter('requested to set revision_ids = %s,'
816
' but filtered to %s', revision_ids, new_revision_ids)
817
return new_revision_ids
798
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
819
800
@needs_tree_write_lock
820
801
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
802
"""Set the parent ids to revision_ids.
823
804
See also set_parent_trees. This api will try to retrieve the tree data
824
805
for each element of revision_ids from the trees repository. If you have
825
806
tree data already available, it is more efficient to use
915
891
branch.last_revision().
917
893
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()
894
pb = bzrlib.ui.ui_factory.nested_progress_bar()
896
merger = Merger(self.branch, this_tree=self, pb=pb)
897
merger.pp = ProgressPhase("Merge phase", 5, pb)
898
merger.pp.next_phase()
899
# check that there are no
901
merger.check_basis(check_clean=True, require_commits=False)
902
if to_revision is None:
903
to_revision = _mod_revision.ensure_null(branch.last_revision())
904
merger.other_rev_id = to_revision
905
if _mod_revision.is_null(merger.other_rev_id):
906
raise errors.NoCommits(branch)
907
self.branch.fetch(branch, last_revision=merger.other_rev_id)
908
merger.other_basis = merger.other_rev_id
909
merger.other_tree = self.branch.repository.revision_tree(
911
merger.other_branch = branch
912
merger.pp.next_phase()
913
if from_revision is None:
916
merger.set_base_revision(from_revision, branch)
917
if merger.base_rev_id == merger.other_rev_id:
918
raise errors.PointlessMerge
919
merger.backup_files = False
920
if merge_type is None:
921
merger.merge_type = Merge3Merger
923
merger.merge_type = merge_type
924
merger.set_interesting_files(None)
925
merger.show_base = False
926
merger.reprocess = False
927
conflicts = merger.do_merge()
951
934
def merge_modified(self):
952
935
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
937
The list is initialized by WorkingTree.set_merge_modified, which is
955
938
typically called after we make some automatic updates to the tree
956
939
because of a merge.
959
942
still in the working inventory and have that text hash.
962
hashfile = self._transport.get('merge-hashes')
945
hashfile = self._control_files.get('merge-hashes')
963
946
except errors.NoSuchFile:
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
950
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
951
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
952
except StopIteration:
953
raise errors.MergeModifiedFormatError()
954
for s in RioReader(hashfile):
955
# RioReader reads in Unicode, so convert file_ids back to utf8
956
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
957
if file_id not in self.inventory:
959
text_hash = s.get("hash")
960
if text_hash == self.get_file_sha1(file_id):
961
merge_hashes[file_id] = text_hash
984
964
@needs_write_lock
985
965
def mkdir(self, path, file_id=None):
1097
1075
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1076
if tree_transport.base != branch_transport.base:
1099
1077
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1078
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
1080
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1081
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1082
wt.set_parent_ids(self.get_parent_ids())
1106
1083
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1084
child_inv = Inventory(root_id=None)
1108
1085
new_root = my_inv[file_id]
1109
1086
my_inv.remove_recursive_id(file_id)
1110
1087
new_root.parent_id = None
1128
1105
sio = StringIO()
1129
1106
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1108
self._control_files.put('inventory', sio)
1133
1109
self._inventory_is_modified = False
1135
1111
def _kind(self, relpath):
1136
1112
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).
1114
def list_files(self, include_root=False):
1115
"""Recursively list all files as (path, class, kind, id, entry).
1141
1117
Lists, but does not descend into unversioned directories.
1142
1119
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
1122
Skips the control directory.
1149
1124
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1125
# with it. So callers should be careful to always read_lock the tree.
1165
1140
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
1142
# 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)
1143
children = os.listdir(self.basedir)
1178
1144
children.sort()
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1145
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
1146
# use a deque and popleft to keep them sorted, or if we use a plain
1181
1147
# list and just reverse() them.
1182
1148
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1149
stack = [(inv.root.file_id, u'', self.basedir, children)]
1185
1151
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1240
1206
except KeyError:
1241
1207
yield fp[1:], c, fk, None, TreeEntry()
1244
1210
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
1213
# But do this child first
1214
new_children = os.listdir(fap)
1216
new_children = collections.deque(new_children)
1217
stack.append((f_ie.file_id, fp, fap, new_children))
1218
# Break out of inner loop,
1219
# so that we start outer loop with child
1257
1222
# if we finished all children, pop it off the stack
1494
1457
from_tail = splitpath(from_rel)[-1]
1495
1458
from_id = inv.path2id(from_rel)
1496
1459
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]
1460
raise errors.BzrRenameFailedError(from_rel,to_rel,
1461
errors.NotVersionedError(path=str(from_rel)))
1462
from_entry = inv[from_id]
1508
1463
from_parent_id = from_entry.parent_id
1509
1464
to_dir, to_tail = os.path.split(to_rel)
1510
1465
to_dir_id = inv.path2id(to_dir)
1572
1527
:raises: NoSuchId if any fileid is not currently versioned.
1574
1529
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
1530
if self._inventory.has_id(file_id):
1579
1531
self._inventory.remove_recursive_id(file_id)
1533
raise errors.NoSuchId(self, file_id)
1580
1534
if len(file_ids):
1581
# in the future this should just set a dirty bit to wait for the
1535
# in the future this should just set a dirty bit to wait for the
1582
1536
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1537
# with the current in -memory inventory rather than triggering
1584
1538
# a read, it is more complex - we need to teach read_inventory
1585
1539
# to know when to read, and when to not read first... and possibly
1586
1540
# to save first when the in memory one may be corrupted.
1587
1541
# so for now, we just only write it if it is indeed dirty.
1588
1542
# - RBC 20060907
1589
1543
self._write_inventory(self._inventory)
1545
@deprecated_method(zero_eight)
1546
def iter_conflicts(self):
1547
"""List all files in the tree that have text or content conflicts.
1548
DEPRECATED. Use conflicts instead."""
1549
return self._iter_conflicts()
1591
1551
def _iter_conflicts(self):
1592
1552
conflicted = set()
1602
1562
@needs_write_lock
1603
1563
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1564
change_reporter=None, possible_transports=None):
1565
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1566
source.lock_read()
1568
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
1570
old_revision_info = self.branch.last_revision_info()
1608
1571
basis_tree = self.basis_tree()
1609
1572
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1573
possible_transports=possible_transports)
1612
1574
new_revision_info = self.branch.last_revision_info()
1613
1575
if new_revision_info != old_revision_info:
1614
1577
repository = self.branch.repository
1578
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1579
basis_tree.lock_read()
1617
1581
new_basis_tree = self.branch.basis_tree()
1620
1584
new_basis_tree,
1622
1586
this_tree=self,
1624
1588
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)
1589
if (basis_tree.inventory.root is None and
1590
new_basis_tree.inventory.root is not None):
1591
self.set_root_id(new_basis_tree.get_root_id())
1630
1594
basis_tree.unlock()
1631
1595
# TODO - dedup parents list with things merged by pull ?
1632
1596
# reuse the revisiontree we merged against to set the new
1634
1598
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
1599
# we have to pull the merge trees out again, because
1600
# merge_inner has set the ids. - this corner is not yet
1637
1601
# layered well enough to prevent double handling.
1638
1602
# XXX TODO: Fix the double handling: telling the tree about
1639
1603
# the already known parent data is wasteful.
1799
1755
raise errors.ObjectNotLocked(self)
1801
1757
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.
1758
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1759
if not self.is_locked():
1809
1760
self._reset_data()
1810
1761
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1763
return self._control_files.lock_read()
1815
1765
self.branch.unlock()
1818
1768
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1769
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1770
if not self.is_locked():
1824
1771
self._reset_data()
1825
1772
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1774
return self._control_files.lock_write()
1830
1776
self.branch.unlock()
1833
1779
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1780
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1781
if not self.is_locked():
1839
1782
self._reset_data()
1840
1783
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1785
return self._control_files.lock_write()
1845
1787
self.branch.unlock()
1901
1839
# as commit already has that ready-to-use [while the format is the
1902
1840
# same, that is].
1904
# this double handles the inventory - unpack and repack -
1842
# this double handles the inventory - unpack and repack -
1905
1843
# but is easier to understand. We can/should put a conditional
1906
1844
# in here based on whether the inventory is in the latest format
1907
1845
# - perhaps we should repack all inventories on a repository
1909
1847
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1848
# xml contains 'revision_id="', then we assume the right
1911
1849
# revision_id is set. We must check for this full string, because a
1912
1850
# root node id can legitimately look like 'revision_id' but cannot
1913
1851
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1852
xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1853
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1854
if (not 'revision_id="' in firstline or
1917
1855
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1856
inv = self.branch.repository.deserialise_inventory(
1920
1858
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1859
self._write_basis_inventory(xml)
1922
1860
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1863
def read_basis_inventory(self):
1926
1864
"""Read the cached basis inventory."""
1927
1865
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1866
return self._control_files.get(path).read()
1930
1868
@needs_read_lock
1931
1869
def read_working_inventory(self):
1932
1870
"""Read the working inventory.
1934
1872
:raises errors.InventoryModified: read_working_inventory will fail
1935
1873
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1875
# conceptually this should be an implementation detail of the tree.
1938
1876
# XXX: Deprecate this.
1939
1877
# ElementTree does its own conversion from UTF-8, so open in
1941
1879
if self._inventory_is_modified:
1942
1880
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1881
result = self._deserialize(self._control_files.get('inventory'))
1948
1882
self._set_inventory(result, dirty=False)
1966
1900
new_files=set()
1967
1901
unknown_nested_files=set()
1969
to_file = sys.stdout
1971
1903
def recurse_directory_to_add_files(directory):
1972
1904
# Recurse directory and add all files
1973
1905
# so we can check if they have changed.
1974
for parent_info, file_infos in self.walkdirs(directory):
1975
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1906
for parent_info, file_infos in\
1907
osutils.walkdirs(self.abspath(directory),
1909
for relpath, basename, kind, lstat, abspath in file_infos:
1976
1910
# Is it versioned or ignored?
1977
1911
if self.path2id(relpath) or self.is_ignored(relpath):
1978
1912
# Add nested content for deletion.
2158
2091
@needs_tree_write_lock
2159
2092
def set_root_id(self, file_id):
2160
2093
"""Set the root id for this tree."""
2162
2095
if file_id is None:
2164
'WorkingTree.set_root_id with fileid=None')
2165
file_id = osutils.safe_file_id(file_id)
2096
symbol_versioning.warn(symbol_versioning.zero_twelve
2097
% 'WorkingTree.set_root_id with fileid=None',
2102
file_id = osutils.safe_file_id(file_id)
2166
2103
self._set_root_id(file_id)
2168
2105
def _set_root_id(self, file_id):
2169
2106
"""Set the root id for this tree, in a format specific manner.
2171
:param file_id: The file id to assign to the root. It must not be
2108
:param file_id: The file id to assign to the root. It must not be
2172
2109
present in the current inventory or an error will occur. It must
2173
2110
not be None, but rather a valid file id.
2194
2131
def unlock(self):
2195
2132
"""See Branch.unlock.
2197
2134
WorkingTree locking just uses the Branch locking facilities.
2198
2135
This is current because all working trees have an embedded branch
2199
2136
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
2137
between multiple working trees, i.e. via shared storage, then we
2201
2138
would probably want to lock both the local tree, and the branch.
2203
2140
raise NotImplementedError(self.unlock)
2207
def update(self, change_reporter=None, possible_transports=None,
2208
revision=None, old_tip=_marker):
2142
def update(self, change_reporter=None, possible_transports=None):
2209
2143
"""Update a working tree along its branch.
2211
2145
This will update the branch if its bound too, which means we have
2265
2192
# cant set that until we update the working trees last revision to be
2266
2193
# one from the new branch, because it will just get absorbed by the
2267
2194
# parent de-duplication logic.
2269
2196
# We MUST save it even if an error occurs, because otherwise the users
2270
2197
# local work is unreferenced and will appear to have been lost.
2274
2201
last_rev = self.get_parent_ids()[0]
2275
2202
except IndexError:
2276
2203
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()
2204
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2205
# merge tree state up to new branch tip.
2301
2206
basis = self.basis_tree()
2302
2207
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)
2209
to_tree = self.branch.basis_tree()
2210
if basis.inventory.root is None:
2211
self.set_root_id(to_tree.get_root_id())
2213
result += merge.merge_inner(
2218
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
2221
# TODO - dedup parents list with things merged by pull ?
2322
2222
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
2223
parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2224
merges = self.get_parent_ids()[1:]
2325
2225
# Ideally we ask the tree for the trees here, that way the working
2326
# tree can decide whether to give us the entire tree or give us a
2226
# tree can decide whether to give us teh entire tree or give us a
2327
2227
# lazy initialised tree. dirstate for instance will have the trees
2328
2228
# in ram already, whereas a last-revision + basis-inventory tree
2329
2229
# will not, but also does not need them when setting parents.
2330
2230
for parent in merges:
2331
2231
parent_trees.append(
2332
2232
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
2233
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2234
parent_trees.append(
2335
2235
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2236
self.set_parent_trees(parent_trees)
2337
2237
last_rev = parent_trees[0][0]
2239
# the working tree had the same last-revision as the master
2240
# branch did. We may still have pivot local work from the local
2241
# branch into old_tip:
2242
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2243
self.add_parent_tree_id(old_tip)
2244
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2245
and old_tip != last_rev):
2246
# our last revision was not the prior branch last revision
2247
# and we have converted that last revision to a pending merge.
2248
# base is somewhere between the branch tip now
2249
# and the now pending merge
2251
# Since we just modified the working tree and inventory, flush out
2252
# the current state, before we modify it again.
2253
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2254
# requires it only because TreeTransform directly munges the
2255
# inventory and calls tree._write_inventory(). Ultimately we
2256
# should be able to remove this extra flush.
2258
graph = self.branch.repository.get_graph()
2259
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2261
base_tree = self.branch.repository.revision_tree(base_rev_id)
2262
other_tree = self.branch.repository.revision_tree(old_tip)
2263
result += merge.merge_inner(
2268
change_reporter=change_reporter)
2340
2271
def _write_hashcache_if_dirty(self):
2341
2272
"""Write out the hashcache if it is dirty."""
2539
2468
# FIXME: stash the node in pending
2540
2469
entry = inv[top_id]
2541
if entry.kind == 'directory':
2542
for name, child in entry.sorted_children():
2543
dirblock.append((relroot + name, name, child.kind, None,
2544
child.file_id, child.kind
2470
for name, child in entry.sorted_children():
2471
dirblock.append((relroot + name, name, child.kind, None,
2472
child.file_id, child.kind
2546
2474
yield (currentdir[0], entry.file_id), dirblock
2547
2475
# push the user specified dirs from dirblock
2548
2476
for dir in reversed(dirblock):
2614
def _get_rules_searcher(self, default_searcher):
2615
"""See Tree._get_rules_searcher."""
2616
if self._rules_searcher is None:
2617
self._rules_searcher = super(WorkingTree,
2618
self)._get_rules_searcher(default_searcher)
2619
return self._rules_searcher
2621
def get_shelf_manager(self):
2622
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
2624
return ShelfManager(self, self._transport)
2627
2524
class WorkingTree2(WorkingTree):
2628
2525
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
2527
This was the first weave based working tree.
2631
2528
- uses os locks for locking.
2632
2529
- uses the branch last-revision.
2696
2585
def _last_revision(self):
2697
2586
"""See Mutable.last_revision."""
2699
return self._transport.get_bytes('last-revision')
2588
return self._control_files.get('last-revision').read()
2700
2589
except errors.NoSuchFile:
2701
2590
return _mod_revision.NULL_REVISION
2703
2592
def _change_last_revision(self, revision_id):
2704
2593
"""See WorkingTree._change_last_revision."""
2705
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2594
if revision_id is None or revision_id == NULL_REVISION:
2707
self._transport.delete('last-revision')
2596
self._control_files._transport.delete('last-revision')
2708
2597
except errors.NoSuchFile:
2712
self._transport.put_bytes('last-revision', revision_id,
2713
mode=self.bzrdir._get_file_mode())
2601
self._control_files.put_bytes('last-revision', revision_id)
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
2604
@needs_tree_write_lock
2721
2605
def set_conflicts(self, conflicts):
2722
self._put_rio('conflicts', conflicts.to_stanzas(),
2606
self._put_rio('conflicts', conflicts.to_stanzas(),
2723
2607
CONFLICT_HEADER_1)
2725
2609
@needs_tree_write_lock
2868
2758
"""See WorkingTreeFormat.get_format_description()."""
2869
2759
return "Working tree format 2"
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2761
def stub_initialize_remote(self, control_files):
2762
"""As a special workaround create critical control files for a remote working tree
2874
2764
This ensures that it can later be updated and dealt with locally,
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2765
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
2766
no working tree. (See bug #43064).
2878
2768
sio = StringIO()
2879
inv = inventory.Inventory()
2880
2770
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
transport.put_file('inventory', sio, file_mode)
2883
transport.put_bytes('pending-merges', '', file_mode)
2772
control_files.put('inventory', sio)
2774
control_files.put_bytes('pending-merges', '')
2885
2777
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
2778
accelerator_tree=None, hardlink=False):
added
removed
bzrlib/workingtree.py
