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.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
81
89
from bzrlib.lockdir import LockDir
82
90
import bzrlib.mutabletree
83
91
from bzrlib.mutabletree import needs_tree_write_lock
84
92
from bzrlib import osutils
85
93
from bzrlib.osutils import (
93
103
supports_executable,
95
from bzrlib.filters import filtered_input_file
105
from bzrlib.filters import filtered_input, filters_for_path
96
106
from bzrlib.trace import mutter, note
97
107
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
108
from bzrlib.progress import DummyProgress, ProgressPhase
109
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
110
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
111
from bzrlib.symbol_versioning import (deprecated_passed,
114
DEPRECATED_PARAMETER,
106
121
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
122
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
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()
115
145
class TreeEntry(object):
116
146
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
148
This needs further inspection, it may be better to have
119
149
InventoryEntries without ids - though that seems wrong. For now,
120
150
this is a parallel hierarchy to InventoryEntry, and needs to become
121
151
one of several things: decorates to that hierarchy, children of, or
285
303
self._control_files.break_lock()
286
304
self.branch.break_lock()
288
def _get_check_refs(self):
289
"""Return the references needed to perform a check of this tree.
291
The default implementation returns no refs, and is only suitable for
292
trees that have no local caching and can commit on ghosts at any time.
294
:seealso: bzrlib.check for details about check_refs.
298
306
def requires_rich_root(self):
299
307
return self._format.requires_rich_root
301
309
def supports_tree_reference(self):
304
def supports_content_filtering(self):
305
return self._format.supports_content_filtering()
307
def supports_views(self):
308
return self.views.supports_views()
310
312
def _set_inventory(self, inv, dirty):
311
313
"""Set the internal cached inventory.
422
423
# at this point ?
424
425
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
except errors.RevisionNotPresent:
426
427
# the basis tree *may* be a ghost or a low level error may have
427
# 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
429
430
if self.branch.repository.has_revision(revision_id):
431
432
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
433
return self.branch.repository.revision_tree(None)
435
435
def _cleanup(self):
436
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)
438
476
def relpath(self, path):
439
477
"""Return the local path portion from a given path.
441
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
442
480
interpreted relative to the python current working directory.
444
482
return osutils.relpath(self.basedir, path)
446
484
def has_filename(self, filename):
447
485
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
487
def get_file(self, file_id, path=None):
456
489
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
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):
468
496
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
497
filters = filters_for_path(path)
498
return filtered_input(file(path, 'rb'), filters)
485
501
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
508
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
509
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
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(),
532
537
def _get_ancestors(self, default_revision):
533
538
ancestors = set([default_revision])
570
575
def clone(self, to_bzrdir, revision_id=None):
571
576
"""Duplicate this working tree into to_bzr, including all state.
573
578
Specifically modified files are kept as modified, but
574
579
ignored and unknown files are discarded.
576
581
If you want to make a new line of development, see bzrdir.sprout()
579
If not None, the cloned tree will have its last revision set to
580
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
581
586
and this one merged in.
583
588
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
589
result = self._format.initialize(to_bzrdir)
585
590
self.copy_content_into(result, revision_id)
767
764
kind = 'tree-reference'
768
765
return kind, None, None, None
769
766
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
767
return ('symlink', None, None, os.readlink(abspath))
773
769
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
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:]
782
784
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
785
"""Common ghost checking functionality from set_parent_*.
794
796
def _set_merges_from_parent_ids(self, parent_ids):
795
797
merges = parent_ids[1:]
796
self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
mode=self.bzrdir._get_file_mode())
799
def _filter_parent_ids_by_ancestry(self, revision_ids):
800
"""Check that all merged revisions are proper 'heads'.
802
This will always return the first revision_id, and any merged revisions
805
if len(revision_ids) == 0:
807
graph = self.branch.repository.get_graph()
808
heads = graph.heads(revision_ids)
809
new_revision_ids = revision_ids[:1]
810
for revision_id in revision_ids[1:]:
811
if revision_id in heads and revision_id not in new_revision_ids:
812
new_revision_ids.append(revision_id)
813
if new_revision_ids != revision_ids:
814
trace.mutter('requested to set revision_ids = %s,'
815
' but filtered to %s', revision_ids, new_revision_ids)
816
return new_revision_ids
798
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
800
@needs_tree_write_lock
819
801
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
802
"""Set the parent ids to revision_ids.
822
804
See also set_parent_trees. This api will try to retrieve the tree data
823
805
for each element of revision_ids from the trees repository. If you have
824
806
tree data already available, it is more efficient to use
914
891
branch.last_revision().
916
893
from bzrlib.merge import Merger, Merge3Merger
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
939
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
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()
950
934
def merge_modified(self):
951
935
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
937
The list is initialized by WorkingTree.set_merge_modified, which is
954
938
typically called after we make some automatic updates to the tree
955
939
because of a merge.
958
942
still in the working inventory and have that text hash.
961
hashfile = self._transport.get('merge-hashes')
945
hashfile = self._control_files.get('merge-hashes')
962
946
except errors.NoSuchFile:
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
950
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
951
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
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
983
964
@needs_write_lock
984
965
def mkdir(self, path, file_id=None):
1096
1075
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1076
if tree_transport.base != branch_transport.base:
1098
1077
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1078
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1080
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1081
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1082
wt.set_parent_ids(self.get_parent_ids())
1105
1083
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1084
child_inv = Inventory(root_id=None)
1107
1085
new_root = my_inv[file_id]
1108
1086
my_inv.remove_recursive_id(file_id)
1109
1087
new_root.parent_id = None
1127
1105
sio = StringIO()
1128
1106
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1108
self._control_files.put('inventory', sio)
1132
1109
self._inventory_is_modified = False
1134
1111
def _kind(self, relpath):
1135
1112
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""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).
1140
1117
Lists, but does not descend into unversioned directories.
1141
1119
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
1122
Skips the control directory.
1148
1124
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1125
# with it. So callers should be careful to always read_lock the tree.
1164
1140
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1142
# directory file_id, relative path, absolute path, reverse sorted children
1167
if from_dir is not None:
1168
from_dir_id = inv.path2id(from_dir)
1169
if from_dir_id is None:
1170
# Directory not versioned
1172
from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
from_dir_id = inv.root.file_id
1175
from_dir_abspath = self.basedir
1176
children = os.listdir(from_dir_abspath)
1143
children = os.listdir(self.basedir)
1177
1144
children.sort()
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1145
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
1146
# use a deque and popleft to keep them sorted, or if we use a plain
1180
1147
# list and just reverse() them.
1181
1148
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1149
stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1151
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1239
1206
except KeyError:
1240
1207
yield fp[1:], c, fk, None, TreeEntry()
1243
1210
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# 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
1256
1222
# if we finished all children, pop it off the stack
1493
1457
from_tail = splitpath(from_rel)[-1]
1494
1458
from_id = inv.path2id(from_rel)
1495
1459
if from_id is None:
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
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]
1507
1463
from_parent_id = from_entry.parent_id
1508
1464
to_dir, to_tail = os.path.split(to_rel)
1509
1465
to_dir_id = inv.path2id(to_dir)
1571
1527
:raises: NoSuchId if any fileid is not currently versioned.
1573
1529
for file_id in file_ids:
1574
if file_id not in self._inventory:
1575
raise errors.NoSuchId(self, file_id)
1576
for file_id in file_ids:
1577
1530
if self._inventory.has_id(file_id):
1578
1531
self._inventory.remove_recursive_id(file_id)
1533
raise errors.NoSuchId(self, file_id)
1579
1534
if len(file_ids):
1580
# 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
1581
1536
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1537
# with the current in -memory inventory rather than triggering
1583
1538
# a read, it is more complex - we need to teach read_inventory
1584
1539
# to know when to read, and when to not read first... and possibly
1585
1540
# to save first when the in memory one may be corrupted.
1586
1541
# so for now, we just only write it if it is indeed dirty.
1587
1542
# - RBC 20060907
1588
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()
1590
1551
def _iter_conflicts(self):
1591
1552
conflicted = set()
1601
1562
@needs_write_lock
1602
1563
def pull(self, source, overwrite=False, stop_revision=None,
1603
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()
1604
1566
source.lock_read()
1568
pp = ProgressPhase("Pull phase", 2, top_pb)
1606
1570
old_revision_info = self.branch.last_revision_info()
1607
1571
basis_tree = self.basis_tree()
1608
1572
count = self.branch.pull(source, overwrite, stop_revision,
1609
possible_transports=possible_transports,
1573
possible_transports=possible_transports)
1611
1574
new_revision_info = self.branch.last_revision_info()
1612
1575
if new_revision_info != old_revision_info:
1613
1577
repository = self.branch.repository
1578
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1579
basis_tree.lock_read()
1616
1581
new_basis_tree = self.branch.basis_tree()
1619
1584
new_basis_tree,
1621
1586
this_tree=self,
1623
1588
change_reporter=change_reporter)
1624
basis_root_id = basis_tree.get_root_id()
1625
new_root_id = new_basis_tree.get_root_id()
1626
if basis_root_id != new_root_id:
1627
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())
1629
1594
basis_tree.unlock()
1630
1595
# TODO - dedup parents list with things merged by pull ?
1631
1596
# reuse the revisiontree we merged against to set the new
1633
1598
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
# we have to pull the merge trees out again, because
1635
# 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
1636
1601
# layered well enough to prevent double handling.
1637
1602
# XXX TODO: Fix the double handling: telling the tree about
1638
1603
# the already known parent data is wasteful.
1886
1839
# as commit already has that ready-to-use [while the format is the
1887
1840
# same, that is].
1889
# this double handles the inventory - unpack and repack -
1842
# this double handles the inventory - unpack and repack -
1890
1843
# but is easier to understand. We can/should put a conditional
1891
1844
# in here based on whether the inventory is in the latest format
1892
1845
# - perhaps we should repack all inventories on a repository
1894
1847
# the fast path is to copy the raw xml from the repository. If the
1895
# xml contains 'revision_id="', then we assume the right
1848
# xml contains 'revision_id="', then we assume the right
1896
1849
# revision_id is set. We must check for this full string, because a
1897
1850
# root node id can legitimately look like 'revision_id' but cannot
1898
1851
# contain a '"'.
1899
xml = self.branch.repository._get_inventory_xml(new_revision)
1852
xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1853
firstline = xml.split('\n', 1)[0]
1901
if (not 'revision_id="' in firstline or
1854
if (not 'revision_id="' in firstline or
1902
1855
'format="7"' not in firstline):
1903
inv = self.branch.repository._serializer.read_inventory_from_string(
1856
inv = self.branch.repository.deserialise_inventory(
1905
1858
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1859
self._write_basis_inventory(xml)
1907
1860
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1863
def read_basis_inventory(self):
1911
1864
"""Read the cached basis inventory."""
1912
1865
path = self._basis_inventory_name()
1913
return self._transport.get_bytes(path)
1866
return self._control_files.get(path).read()
1915
1868
@needs_read_lock
1916
1869
def read_working_inventory(self):
1917
1870
"""Read the working inventory.
1919
1872
:raises errors.InventoryModified: read_working_inventory will fail
1920
1873
when the current in memory inventory has been modified.
1922
# conceptually this should be an implementation detail of the tree.
1875
# conceptually this should be an implementation detail of the tree.
1923
1876
# XXX: Deprecate this.
1924
1877
# ElementTree does its own conversion from UTF-8, so open in
1926
1879
if self._inventory_is_modified:
1927
1880
raise errors.InventoryModified(self)
1928
f = self._transport.get('inventory')
1930
result = self._deserialize(f)
1881
result = self._deserialize(self._control_files.get('inventory'))
1933
1882
self._set_inventory(result, dirty=False)
1951
1900
new_files=set()
1952
1901
unknown_nested_files=set()
1954
to_file = sys.stdout
1956
1903
def recurse_directory_to_add_files(directory):
1957
1904
# Recurse directory and add all files
1958
1905
# so we can check if they have changed.
1959
1906
for parent_info, file_infos in\
1960
self.walkdirs(directory):
1961
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1907
osutils.walkdirs(self.abspath(directory),
1909
for relpath, basename, kind, lstat, abspath in file_infos:
1962
1910
# Is it versioned or ignored?
1963
1911
if self.path2id(relpath) or self.is_ignored(relpath):
1964
1912
# Add nested content for deletion.
2142
2091
@needs_tree_write_lock
2143
2092
def set_root_id(self, file_id):
2144
2093
"""Set the root id for this tree."""
2146
2095
if file_id is None:
2148
'WorkingTree.set_root_id with fileid=None')
2149
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)
2150
2103
self._set_root_id(file_id)
2152
2105
def _set_root_id(self, file_id):
2153
2106
"""Set the root id for this tree, in a format specific manner.
2155
: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
2156
2109
present in the current inventory or an error will occur. It must
2157
2110
not be None, but rather a valid file id.
2178
2131
def unlock(self):
2179
2132
"""See Branch.unlock.
2181
2134
WorkingTree locking just uses the Branch locking facilities.
2182
2135
This is current because all working trees have an embedded branch
2183
2136
within them. IF in the future, we were to make branch data shareable
2184
between multiple working trees, i.e. via shared storage, then we
2137
between multiple working trees, i.e. via shared storage, then we
2185
2138
would probably want to lock both the local tree, and the branch.
2187
2140
raise NotImplementedError(self.unlock)
2191
def update(self, change_reporter=None, possible_transports=None,
2192
revision=None, old_tip=_marker):
2142
def update(self, change_reporter=None, possible_transports=None):
2193
2143
"""Update a working tree along its branch.
2195
2145
This will update the branch if its bound too, which means we have
2249
2192
# cant set that until we update the working trees last revision to be
2250
2193
# one from the new branch, because it will just get absorbed by the
2251
2194
# parent de-duplication logic.
2253
2196
# We MUST save it even if an error occurs, because otherwise the users
2254
2197
# local work is unreferenced and will appear to have been lost.
2258
2201
last_rev = self.get_parent_ids()[0]
2259
2202
except IndexError:
2260
2203
last_rev = _mod_revision.NULL_REVISION
2261
if revision is None:
2262
revision = self.branch.last_revision()
2264
old_tip = old_tip or _mod_revision.NULL_REVISION
2266
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
# the branch we are bound to was updated
2268
# merge those changes in first
2269
base_tree = self.basis_tree()
2270
other_tree = self.branch.repository.revision_tree(old_tip)
2271
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
base_tree, this_tree=self,
2273
change_reporter=change_reporter)
2275
self.add_parent_tree((old_tip, other_tree))
2276
trace.note('Rerun update after fixing the conflicts.')
2279
if last_rev != _mod_revision.ensure_null(revision):
2280
# the working tree is up to date with the branch
2281
# we can merge the specified revision from master
2282
to_tree = self.branch.repository.revision_tree(revision)
2283
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.
2285
2206
basis = self.basis_tree()
2286
2207
basis.lock_read()
2288
if (basis.inventory.root is None
2289
or basis.inventory.root.file_id != to_root_id):
2290
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)
2295
# determine the branch point
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2301
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
change_reporter=change_reporter)
2304
self.set_last_revision(revision)
2305
2221
# TODO - dedup parents list with things merged by pull ?
2306
2222
# reuse the tree we've updated to to set the basis:
2307
parent_trees = [(revision, to_tree)]
2223
parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2224
merges = self.get_parent_ids()[1:]
2309
2225
# Ideally we ask the tree for the trees here, that way the working
2310
# 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
2311
2227
# lazy initialised tree. dirstate for instance will have the trees
2312
2228
# in ram already, whereas a last-revision + basis-inventory tree
2313
2229
# will not, but also does not need them when setting parents.
2314
2230
for parent in merges:
2315
2231
parent_trees.append(
2316
2232
(parent, self.branch.repository.revision_tree(parent)))
2317
if not _mod_revision.is_null(old_tip):
2233
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2234
parent_trees.append(
2319
2235
(old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2236
self.set_parent_trees(parent_trees)
2321
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)
2324
2271
def _write_hashcache_if_dirty(self):
2325
2272
"""Write out the hashcache if it is dirty."""
2523
2468
# FIXME: stash the node in pending
2524
2469
entry = inv[top_id]
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
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
2530
2474
yield (currentdir[0], entry.file_id), dirblock
2531
2475
# push the user specified dirs from dirblock
2532
2476
for dir in reversed(dirblock):
2598
def _get_rules_searcher(self, default_searcher):
2599
"""See Tree._get_rules_searcher."""
2600
if self._rules_searcher is None:
2601
self._rules_searcher = super(WorkingTree,
2602
self)._get_rules_searcher(default_searcher)
2603
return self._rules_searcher
2605
def get_shelf_manager(self):
2606
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
2608
return ShelfManager(self, self._transport)
2611
2524
class WorkingTree2(WorkingTree):
2612
2525
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2527
This was the first weave based working tree.
2615
2528
- uses os locks for locking.
2616
2529
- uses the branch last-revision.
2676
2585
def _last_revision(self):
2677
2586
"""See Mutable.last_revision."""
2679
return self._transport.get_bytes('last-revision')
2588
return self._control_files.get('last-revision').read()
2680
2589
except errors.NoSuchFile:
2681
2590
return _mod_revision.NULL_REVISION
2683
2592
def _change_last_revision(self, revision_id):
2684
2593
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2594
if revision_id is None or revision_id == NULL_REVISION:
2687
self._transport.delete('last-revision')
2596
self._control_files._transport.delete('last-revision')
2688
2597
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2601
self._control_files.put_bytes('last-revision', revision_id)
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
2700
2604
@needs_tree_write_lock
2701
2605
def set_conflicts(self, conflicts):
2702
self._put_rio('conflicts', conflicts.to_stanzas(),
2606
self._put_rio('conflicts', conflicts.to_stanzas(),
2703
2607
CONFLICT_HEADER_1)
2705
2609
@needs_tree_write_lock
2848
2758
"""See WorkingTreeFormat.get_format_description()."""
2849
2759
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""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
2854
2764
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2765
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
2766
no working tree. (See bug #43064).
2858
2768
sio = StringIO()
2859
inv = inventory.Inventory()
2860
2770
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2772
control_files.put('inventory', sio)
2774
control_files.put_bytes('pending-merges', '')
2865
2777
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
2778
accelerator_tree=None, hardlink=False):
added
removed
bzrlib/workingtree.py
