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
57
59
conflicts as _mod_conflicts,
66
67
revision as _mod_revision,
75
79
import bzrlib.branch
76
80
from bzrlib.transport import get_transport
77
from bzrlib.workingtree_4 import (
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
84
85
from bzrlib import symbol_versioning
85
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
86
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
87
89
from bzrlib.lockdir import LockDir
88
90
import bzrlib.mutabletree
89
91
from bzrlib.mutabletree import needs_tree_write_lock
90
92
from bzrlib import osutils
91
93
from bzrlib.osutils import (
99
103
supports_executable,
101
from bzrlib.filters import filtered_input_file
102
105
from bzrlib.trace import mutter, note
103
106
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import ProgressPhase
105
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
106
109
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (
109
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
113
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
114
# TODO: Modifying the conflict objects or their type is currently nearly
115
# impossible as there is no clear relationship between the working tree format
116
# and the conflict list file format.
117
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
119
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
122
144
class TreeEntry(object):
123
145
"""An entry that implements the minimum interface used by commands.
125
This needs further inspection, it may be better to have
147
This needs further inspection, it may be better to have
126
148
InventoryEntries without ids - though that seems wrong. For now,
127
149
this is a parallel hierarchy to InventoryEntry, and needs to become
128
150
one of several things: decorates to that hierarchy, children of, or
283
302
self._control_files.break_lock()
284
303
self.branch.break_lock()
286
def _get_check_refs(self):
287
"""Return the references needed to perform a check of this tree.
289
The default implementation returns no refs, and is only suitable for
290
trees that have no local caching and can commit on ghosts at any time.
292
:seealso: bzrlib.check for details about check_refs.
296
305
def requires_rich_root(self):
297
306
return self._format.requires_rich_root
299
308
def supports_tree_reference(self):
302
def supports_content_filtering(self):
303
return self._format.supports_content_filtering()
305
def supports_views(self):
306
return self.views.supports_views()
308
311
def _set_inventory(self, inv, dirty):
309
312
"""Set the internal cached inventory.
420
422
# at this point ?
422
424
return self.branch.repository.revision_tree(revision_id)
423
except (errors.RevisionNotPresent, errors.NoSuchRevision):
425
except errors.RevisionNotPresent:
424
426
# the basis tree *may* be a ghost or a low level error may have
425
# occurred. If the revision is present, its a problem, if its not
427
# occured. If the revision is present, its a problem, if its not
427
429
if self.branch.repository.has_revision(revision_id):
429
431
# the basis tree is a ghost so return an empty tree.
430
return self.branch.repository.revision_tree(
431
_mod_revision.NULL_REVISION)
432
return self.branch.repository.revision_tree(None)
433
434
def _cleanup(self):
434
435
self._flush_ignore_list_cache()
438
@deprecated_method(zero_eight)
439
def create(branch, directory):
440
"""Create a workingtree for branch at directory.
442
If existing_directory already exists it must have a .bzr directory.
443
If it does not exist, it will be created.
445
This returns a new WorkingTree object for the new checkout.
447
TODO FIXME RBC 20060124 when we have checkout formats in place this
448
should accept an optional revisionid to checkout [and reject this if
449
checking out into the same dir as a pre-checkout-aware branch format.]
451
XXX: When BzrDir is present, these should be created through that
454
warnings.warn('delete WorkingTree.create', stacklevel=3)
455
transport = get_transport(directory)
456
if branch.bzrdir.root_transport.base == transport.base:
458
return branch.bzrdir.create_workingtree()
459
# different directory,
460
# create a branch reference
461
# and now a working tree.
462
raise NotImplementedError
465
@deprecated_method(zero_eight)
466
def create_standalone(directory):
467
"""Create a checkout and a branch and a repo at directory.
469
Directory must exist and be empty.
471
please use BzrDir.create_standalone_workingtree
473
return bzrdir.BzrDir.create_standalone_workingtree(directory)
436
475
def relpath(self, path):
437
476
"""Return the local path portion from a given path.
439
The path may be absolute or relative. If its a relative path it is
478
The path may be absolute or relative. If its a relative path it is
440
479
interpreted relative to the python current working directory.
442
481
return osutils.relpath(self.basedir, path)
444
483
def has_filename(self, filename):
445
484
return osutils.lexists(self.abspath(filename))
447
def get_file(self, file_id, path=None, filtered=True):
448
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
450
def get_file_with_stat(self, file_id, path=None, filtered=True,
452
"""See Tree.get_file_with_stat."""
486
def get_file(self, file_id, path=None):
454
488
path = self.id2path(file_id)
455
file_obj = self.get_file_byname(path, filtered=False)
456
stat_value = _fstat(file_obj.fileno())
457
if filtered and self.supports_content_filtering():
458
filters = self._content_filter_stack(path)
459
file_obj = filtered_input_file(file_obj, filters)
460
return (file_obj, stat_value)
462
def get_file_text(self, file_id, path=None, filtered=True):
463
return self.get_file(file_id, path=path, filtered=filtered).read()
465
def get_file_byname(self, filename, filtered=True):
466
path = self.abspath(filename)
468
if filtered and self.supports_content_filtering():
469
filters = self._content_filter_stack(filename)
470
return filtered_input_file(f, filters)
474
def get_file_lines(self, file_id, path=None, filtered=True):
475
"""See Tree.get_file_lines()"""
476
file = self.get_file(file_id, path, filtered=filtered)
478
return file.readlines()
489
return self.get_file_byname(path)
491
def get_file_text(self, file_id):
492
return self.get_file(file_id).read()
494
def get_file_byname(self, filename):
495
return file(self.abspath(filename), 'rb')
483
498
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
490
505
incorrectly attributed to CURRENT_REVISION (but after committing, the
491
506
attribution will be correct).
493
maybe_file_parent_keys = []
494
for parent_id in self.get_parent_ids():
496
parent_tree = self.revision_tree(parent_id)
497
except errors.NoSuchRevisionInTree:
498
parent_tree = self.branch.repository.revision_tree(parent_id)
499
parent_tree.lock_read()
501
if file_id not in parent_tree:
503
ie = parent_tree.inventory[file_id]
504
if ie.kind != 'file':
505
# Note: this is slightly unnecessary, because symlinks and
506
# directories have a "text" which is the empty text, and we
507
# know that won't mess up annotations. But it seems cleaner
509
parent_text_key = (file_id, ie.revision)
510
if parent_text_key not in maybe_file_parent_keys:
511
maybe_file_parent_keys.append(parent_text_key)
514
graph = _mod_graph.Graph(self.branch.repository.texts)
515
heads = graph.heads(maybe_file_parent_keys)
516
file_parent_keys = []
517
for key in maybe_file_parent_keys:
519
file_parent_keys.append(key)
521
# Now we have the parents of this content
522
annotator = self.branch.repository.texts.get_annotator()
523
text = self.get_file(file_id).read()
524
this_key =(file_id, default_revision)
525
annotator.add_special_text(this_key, file_parent_keys, text)
526
annotations = [(key[-1], line)
527
for key, line in annotator.annotate_flat(this_key)]
508
basis = self.basis_tree()
511
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
512
require_versioned=True).next()
513
changed_content, kind = changes[2], changes[6]
514
if not changed_content:
515
return basis.annotate_iter(file_id)
519
if kind[0] != 'file':
522
old_lines = list(basis.annotate_iter(file_id))
524
for tree in self.branch.repository.revision_trees(
525
self.get_parent_ids()[1:]):
526
if file_id not in tree:
528
old.append(list(tree.annotate_iter(file_id)))
529
return annotate.reannotate(old, self.get_file(file_id).readlines(),
530
534
def _get_ancestors(self, default_revision):
531
535
ancestors = set([default_revision])
568
572
def clone(self, to_bzrdir, revision_id=None):
569
573
"""Duplicate this working tree into to_bzr, including all state.
571
575
Specifically modified files are kept as modified, but
572
576
ignored and unknown files are discarded.
574
578
If you want to make a new line of development, see bzrdir.sprout()
577
If not None, the cloned tree will have its last revision set to
578
revision, and difference between the source trees last revision
581
If not None, the cloned tree will have its last revision set to
582
revision, and and difference between the source trees last revision
579
583
and this one merged in.
581
585
# assumes the target bzr dir format is compatible.
582
result = to_bzrdir.create_workingtree()
586
result = self._format.initialize(to_bzrdir)
583
587
self.copy_content_into(result, revision_id)
765
761
kind = 'tree-reference'
766
762
return kind, None, None, None
767
763
elif kind == 'symlink':
768
target = osutils.readlink(abspath)
769
return ('symlink', None, None, target)
764
return ('symlink', None, None, os.readlink(abspath))
771
766
return (kind, None, None, None)
773
def _file_content_summary(self, path, stat_result):
774
size = stat_result.st_size
775
executable = self._is_executable_from_path_and_stat(path, stat_result)
776
# try for a stat cache lookup
777
return ('file', size, executable, self._sha_from_stat(
768
@deprecated_method(zero_eleven)
770
def pending_merges(self):
771
"""Return a list of pending merges.
773
These are revisions that have been merged into the working
774
directory but not yet committed.
776
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
777
instead - which is available on all tree objects.
779
return self.get_parent_ids()[1:]
780
781
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
781
782
"""Common ghost checking functionality from set_parent_*.
792
793
def _set_merges_from_parent_ids(self, parent_ids):
793
794
merges = parent_ids[1:]
794
self._transport.put_bytes('pending-merges', '\n'.join(merges),
795
mode=self.bzrdir._get_file_mode())
797
def _filter_parent_ids_by_ancestry(self, revision_ids):
798
"""Check that all merged revisions are proper 'heads'.
800
This will always return the first revision_id, and any merged revisions
803
if len(revision_ids) == 0:
805
graph = self.branch.repository.get_graph()
806
heads = graph.heads(revision_ids)
807
new_revision_ids = revision_ids[:1]
808
for revision_id in revision_ids[1:]:
809
if revision_id in heads and revision_id not in new_revision_ids:
810
new_revision_ids.append(revision_id)
811
if new_revision_ids != revision_ids:
812
trace.mutter('requested to set revision_ids = %s,'
813
' but filtered to %s', revision_ids, new_revision_ids)
814
return new_revision_ids
795
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
816
797
@needs_tree_write_lock
817
798
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
818
799
"""Set the parent ids to revision_ids.
820
801
See also set_parent_trees. This api will try to retrieve the tree data
821
802
for each element of revision_ids from the trees repository. If you have
822
803
tree data already available, it is more efficient to use
912
888
branch.last_revision().
914
890
from bzrlib.merge import Merger, Merge3Merger
915
merger = Merger(self.branch, this_tree=self)
916
# check that there are no local alterations
917
if not force and self.has_changes():
918
raise errors.UncommittedChanges(self)
919
if to_revision is None:
920
to_revision = _mod_revision.ensure_null(branch.last_revision())
921
merger.other_rev_id = to_revision
922
if _mod_revision.is_null(merger.other_rev_id):
923
raise errors.NoCommits(branch)
924
self.branch.fetch(branch, last_revision=merger.other_rev_id)
925
merger.other_basis = merger.other_rev_id
926
merger.other_tree = self.branch.repository.revision_tree(
928
merger.other_branch = branch
929
if from_revision is None:
932
merger.set_base_revision(from_revision, branch)
933
if merger.base_rev_id == merger.other_rev_id:
934
raise errors.PointlessMerge
935
merger.backup_files = False
936
if merge_type is None:
937
merger.merge_type = Merge3Merger
939
merger.merge_type = merge_type
940
merger.set_interesting_files(None)
941
merger.show_base = False
942
merger.reprocess = False
943
conflicts = merger.do_merge()
891
pb = bzrlib.ui.ui_factory.nested_progress_bar()
893
merger = Merger(self.branch, this_tree=self, pb=pb)
894
merger.pp = ProgressPhase("Merge phase", 5, pb)
895
merger.pp.next_phase()
896
# check that there are no
898
merger.check_basis(check_clean=True, require_commits=False)
899
if to_revision is None:
900
to_revision = _mod_revision.ensure_null(branch.last_revision())
901
merger.other_rev_id = to_revision
902
if _mod_revision.is_null(merger.other_rev_id):
903
raise errors.NoCommits(branch)
904
self.branch.fetch(branch, last_revision=merger.other_rev_id)
905
merger.other_basis = merger.other_rev_id
906
merger.other_tree = self.branch.repository.revision_tree(
908
merger.other_branch = branch
909
merger.pp.next_phase()
910
if from_revision is None:
913
merger.set_base_revision(from_revision, branch)
914
if merger.base_rev_id == merger.other_rev_id:
915
raise errors.PointlessMerge
916
merger.backup_files = False
917
if merge_type is None:
918
merger.merge_type = Merge3Merger
920
merger.merge_type = merge_type
921
merger.set_interesting_files(None)
922
merger.show_base = False
923
merger.reprocess = False
924
conflicts = merger.do_merge()
948
931
def merge_modified(self):
949
932
"""Return a dictionary of files modified by a merge.
951
The list is initialized by WorkingTree.set_merge_modified, which is
934
The list is initialized by WorkingTree.set_merge_modified, which is
952
935
typically called after we make some automatic updates to the tree
953
936
because of a merge.
956
939
still in the working inventory and have that text hash.
959
hashfile = self._transport.get('merge-hashes')
942
hashfile = self._control_files.get('merge-hashes')
960
943
except errors.NoSuchFile:
965
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
966
raise errors.MergeModifiedFormatError()
967
except StopIteration:
947
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
948
raise errors.MergeModifiedFormatError()
969
for s in RioReader(hashfile):
970
# RioReader reads in Unicode, so convert file_ids back to utf8
971
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
972
if file_id not in self.inventory:
974
text_hash = s.get("hash")
975
if text_hash == self.get_file_sha1(file_id):
976
merge_hashes[file_id] = text_hash
949
except StopIteration:
950
raise errors.MergeModifiedFormatError()
951
for s in RioReader(hashfile):
952
# RioReader reads in Unicode, so convert file_ids back to utf8
953
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
954
if file_id not in self.inventory:
956
text_hash = s.get("hash")
957
if text_hash == self.get_file_sha1(file_id):
958
merge_hashes[file_id] = text_hash
981
961
@needs_write_lock
982
962
def mkdir(self, path, file_id=None):
1124
1102
sio = StringIO()
1125
1103
self._serialize(self._inventory, sio)
1127
self._transport.put_file('inventory', sio,
1128
mode=self.bzrdir._get_file_mode())
1105
self._control_files.put('inventory', sio)
1129
1106
self._inventory_is_modified = False
1131
1108
def _kind(self, relpath):
1132
1109
return osutils.file_kind(self.abspath(relpath))
1134
def list_files(self, include_root=False, from_dir=None, recursive=True):
1135
"""List all files as (path, class, kind, id, entry).
1111
def list_files(self, include_root=False):
1112
"""Recursively list all files as (path, class, kind, id, entry).
1137
1114
Lists, but does not descend into unversioned directories.
1138
1116
This does not include files that have been deleted in this
1139
tree. Skips the control directory.
1141
:param include_root: if True, do not return an entry for the root
1142
:param from_dir: start from this directory or None for the root
1143
:param recursive: whether to recurse into subdirectories or not
1119
Skips the control directory.
1145
1121
# list_files is an iterator, so @needs_read_lock doesn't work properly
1146
1122
# with it. So callers should be careful to always read_lock the tree.
1161
1137
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1163
1139
# directory file_id, relative path, absolute path, reverse sorted children
1164
if from_dir is not None:
1165
from_dir_id = inv.path2id(from_dir)
1166
if from_dir_id is None:
1167
# Directory not versioned
1169
from_dir_abspath = pathjoin(self.basedir, from_dir)
1171
from_dir_id = inv.root.file_id
1172
from_dir_abspath = self.basedir
1173
children = os.listdir(from_dir_abspath)
1140
children = os.listdir(self.basedir)
1174
1141
children.sort()
1175
# jam 20060527 The kernel sized tree seems equivalent whether we
1142
# jam 20060527 The kernel sized tree seems equivalent whether we
1176
1143
# use a deque and popleft to keep them sorted, or if we use a plain
1177
1144
# list and just reverse() them.
1178
1145
children = collections.deque(children)
1179
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1146
stack = [(inv.root.file_id, u'', self.basedir, children)]
1181
1148
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1236
1203
except KeyError:
1237
1204
yield fp[1:], c, fk, None, TreeEntry()
1240
1207
if fk != 'directory':
1243
# But do this child first if recursing down
1245
new_children = os.listdir(fap)
1247
new_children = collections.deque(new_children)
1248
stack.append((f_ie.file_id, fp, fap, new_children))
1249
# Break out of inner loop,
1250
# so that we start outer loop with child
1210
# But do this child first
1211
new_children = os.listdir(fap)
1213
new_children = collections.deque(new_children)
1214
stack.append((f_ie.file_id, fp, fap, new_children))
1215
# Break out of inner loop,
1216
# so that we start outer loop with child
1253
1219
# if we finished all children, pop it off the stack
1490
1454
from_tail = splitpath(from_rel)[-1]
1491
1455
from_id = inv.path2id(from_rel)
1492
1456
if from_id is None:
1493
# if file is missing in the inventory maybe it's in the basis_tree
1494
basis_tree = self.branch.basis_tree()
1495
from_id = basis_tree.path2id(from_rel)
1497
raise errors.BzrRenameFailedError(from_rel,to_rel,
1498
errors.NotVersionedError(path=str(from_rel)))
1499
# put entry back in the inventory so we can rename it
1500
from_entry = basis_tree.inventory[from_id].copy()
1503
from_entry = inv[from_id]
1457
raise errors.BzrRenameFailedError(from_rel,to_rel,
1458
errors.NotVersionedError(path=str(from_rel)))
1459
from_entry = inv[from_id]
1504
1460
from_parent_id = from_entry.parent_id
1505
1461
to_dir, to_tail = os.path.split(to_rel)
1506
1462
to_dir_id = inv.path2id(to_dir)
1568
1524
:raises: NoSuchId if any fileid is not currently versioned.
1570
1526
for file_id in file_ids:
1571
if file_id not in self._inventory:
1572
raise errors.NoSuchId(self, file_id)
1573
for file_id in file_ids:
1574
1527
if self._inventory.has_id(file_id):
1575
1528
self._inventory.remove_recursive_id(file_id)
1530
raise errors.NoSuchId(self, file_id)
1576
1531
if len(file_ids):
1577
# in the future this should just set a dirty bit to wait for the
1532
# in the future this should just set a dirty bit to wait for the
1578
1533
# final unlock. However, until all methods of workingtree start
1579
# with the current in -memory inventory rather than triggering
1534
# with the current in -memory inventory rather than triggering
1580
1535
# a read, it is more complex - we need to teach read_inventory
1581
1536
# to know when to read, and when to not read first... and possibly
1582
1537
# to save first when the in memory one may be corrupted.
1583
1538
# so for now, we just only write it if it is indeed dirty.
1584
1539
# - RBC 20060907
1585
1540
self._write_inventory(self._inventory)
1542
@deprecated_method(zero_eight)
1543
def iter_conflicts(self):
1544
"""List all files in the tree that have text or content conflicts.
1545
DEPRECATED. Use conflicts instead."""
1546
return self._iter_conflicts()
1587
1548
def _iter_conflicts(self):
1588
1549
conflicted = set()
1598
1559
@needs_write_lock
1599
1560
def pull(self, source, overwrite=False, stop_revision=None,
1600
change_reporter=None, possible_transports=None, local=False):
1561
change_reporter=None, possible_transports=None):
1562
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1601
1563
source.lock_read()
1565
pp = ProgressPhase("Pull phase", 2, top_pb)
1603
1567
old_revision_info = self.branch.last_revision_info()
1604
1568
basis_tree = self.basis_tree()
1605
1569
count = self.branch.pull(source, overwrite, stop_revision,
1606
possible_transports=possible_transports,
1570
possible_transports=possible_transports)
1608
1571
new_revision_info = self.branch.last_revision_info()
1609
1572
if new_revision_info != old_revision_info:
1610
1574
repository = self.branch.repository
1575
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1611
1576
basis_tree.lock_read()
1613
1578
new_basis_tree = self.branch.basis_tree()
1616
1581
new_basis_tree,
1618
1583
this_tree=self,
1620
1585
change_reporter=change_reporter)
1621
basis_root_id = basis_tree.get_root_id()
1622
new_root_id = new_basis_tree.get_root_id()
1623
if basis_root_id != new_root_id:
1624
self.set_root_id(new_root_id)
1586
if (basis_tree.inventory.root is None and
1587
new_basis_tree.inventory.root is not None):
1588
self.set_root_id(new_basis_tree.get_root_id())
1626
1591
basis_tree.unlock()
1627
1592
# TODO - dedup parents list with things merged by pull ?
1628
1593
# reuse the revisiontree we merged against to set the new
1630
1595
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1631
# we have to pull the merge trees out again, because
1632
# merge_inner has set the ids. - this corner is not yet
1596
# we have to pull the merge trees out again, because
1597
# merge_inner has set the ids. - this corner is not yet
1633
1598
# layered well enough to prevent double handling.
1634
1599
# XXX TODO: Fix the double handling: telling the tree about
1635
1600
# the already known parent data is wasteful.
1883
1836
# as commit already has that ready-to-use [while the format is the
1884
1837
# same, that is].
1886
# this double handles the inventory - unpack and repack -
1839
# this double handles the inventory - unpack and repack -
1887
1840
# but is easier to understand. We can/should put a conditional
1888
1841
# in here based on whether the inventory is in the latest format
1889
1842
# - perhaps we should repack all inventories on a repository
1891
1844
# the fast path is to copy the raw xml from the repository. If the
1892
# xml contains 'revision_id="', then we assume the right
1845
# xml contains 'revision_id="', then we assume the right
1893
1846
# revision_id is set. We must check for this full string, because a
1894
1847
# root node id can legitimately look like 'revision_id' but cannot
1895
1848
# contain a '"'.
1896
xml = self.branch.repository._get_inventory_xml(new_revision)
1849
xml = self.branch.repository.get_inventory_xml(new_revision)
1897
1850
firstline = xml.split('\n', 1)[0]
1898
if (not 'revision_id="' in firstline or
1851
if (not 'revision_id="' in firstline or
1899
1852
'format="7"' not in firstline):
1900
inv = self.branch.repository._serializer.read_inventory_from_string(
1853
inv = self.branch.repository.deserialise_inventory(
1902
1855
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1903
1856
self._write_basis_inventory(xml)
1904
1857
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1907
1860
def read_basis_inventory(self):
1908
1861
"""Read the cached basis inventory."""
1909
1862
path = self._basis_inventory_name()
1910
return self._transport.get_bytes(path)
1863
return self._control_files.get(path).read()
1912
1865
@needs_read_lock
1913
1866
def read_working_inventory(self):
1914
1867
"""Read the working inventory.
1916
1869
:raises errors.InventoryModified: read_working_inventory will fail
1917
1870
when the current in memory inventory has been modified.
1919
# conceptually this should be an implementation detail of the tree.
1872
# conceptually this should be an implementation detail of the tree.
1920
1873
# XXX: Deprecate this.
1921
1874
# ElementTree does its own conversion from UTF-8, so open in
1923
1876
if self._inventory_is_modified:
1924
1877
raise errors.InventoryModified(self)
1925
f = self._transport.get('inventory')
1927
result = self._deserialize(f)
1878
result = self._deserialize(self._control_files.get('inventory'))
1930
1879
self._set_inventory(result, dirty=False)
1948
1897
new_files=set()
1949
1898
unknown_nested_files=set()
1951
to_file = sys.stdout
1953
1900
def recurse_directory_to_add_files(directory):
1954
1901
# Recurse directory and add all files
1955
1902
# so we can check if they have changed.
1956
1903
for parent_info, file_infos in\
1957
self.walkdirs(directory):
1958
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1904
osutils.walkdirs(self.abspath(directory),
1906
for relpath, basename, kind, lstat, abspath in file_infos:
1959
1907
# Is it versioned or ignored?
1960
1908
if self.path2id(relpath) or self.is_ignored(relpath):
1961
1909
# Add nested content for deletion.
2139
2088
@needs_tree_write_lock
2140
2089
def set_root_id(self, file_id):
2141
2090
"""Set the root id for this tree."""
2143
2092
if file_id is None:
2145
'WorkingTree.set_root_id with fileid=None')
2146
file_id = osutils.safe_file_id(file_id)
2093
symbol_versioning.warn(symbol_versioning.zero_twelve
2094
% 'WorkingTree.set_root_id with fileid=None',
2099
file_id = osutils.safe_file_id(file_id)
2147
2100
self._set_root_id(file_id)
2149
2102
def _set_root_id(self, file_id):
2150
2103
"""Set the root id for this tree, in a format specific manner.
2152
:param file_id: The file id to assign to the root. It must not be
2105
:param file_id: The file id to assign to the root. It must not be
2153
2106
present in the current inventory or an error will occur. It must
2154
2107
not be None, but rather a valid file id.
2175
2128
def unlock(self):
2176
2129
"""See Branch.unlock.
2178
2131
WorkingTree locking just uses the Branch locking facilities.
2179
2132
This is current because all working trees have an embedded branch
2180
2133
within them. IF in the future, we were to make branch data shareable
2181
between multiple working trees, i.e. via shared storage, then we
2134
between multiple working trees, i.e. via shared storage, then we
2182
2135
would probably want to lock both the local tree, and the branch.
2184
2137
raise NotImplementedError(self.unlock)
2188
def update(self, change_reporter=None, possible_transports=None,
2189
revision=None, old_tip=_marker):
2139
def update(self, change_reporter=None, possible_transports=None):
2190
2140
"""Update a working tree along its branch.
2192
2142
This will update the branch if its bound too, which means we have
2246
2189
# cant set that until we update the working trees last revision to be
2247
2190
# one from the new branch, because it will just get absorbed by the
2248
2191
# parent de-duplication logic.
2250
2193
# We MUST save it even if an error occurs, because otherwise the users
2251
2194
# local work is unreferenced and will appear to have been lost.
2255
2198
last_rev = self.get_parent_ids()[0]
2256
2199
except IndexError:
2257
2200
last_rev = _mod_revision.NULL_REVISION
2258
if revision is None:
2259
revision = self.branch.last_revision()
2261
if revision not in self.branch.revision_history():
2262
raise errors.NoSuchRevision(self.branch, 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()
2201
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2202
# merge tree state up to new branch tip.
2285
2203
basis = self.basis_tree()
2286
2204
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)
2206
to_tree = self.branch.basis_tree()
2207
if basis.inventory.root is None:
2208
self.set_root_id(to_tree.get_root_id())
2210
result += merge.merge_inner(
2215
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
2218
# TODO - dedup parents list with things merged by pull ?
2306
2219
# reuse the tree we've updated to to set the basis:
2307
parent_trees = [(revision, to_tree)]
2220
parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2221
merges = self.get_parent_ids()[1:]
2309
2222
# 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
2223
# tree can decide whether to give us teh entire tree or give us a
2311
2224
# lazy initialised tree. dirstate for instance will have the trees
2312
2225
# in ram already, whereas a last-revision + basis-inventory tree
2313
2226
# will not, but also does not need them when setting parents.
2314
2227
for parent in merges:
2315
2228
parent_trees.append(
2316
2229
(parent, self.branch.repository.revision_tree(parent)))
2317
if not _mod_revision.is_null(old_tip):
2230
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2231
parent_trees.append(
2319
2232
(old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2233
self.set_parent_trees(parent_trees)
2321
2234
last_rev = parent_trees[0][0]
2236
# the working tree had the same last-revision as the master
2237
# branch did. We may still have pivot local work from the local
2238
# branch into old_tip:
2239
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2240
self.add_parent_tree_id(old_tip)
2241
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2242
and old_tip != last_rev):
2243
# our last revision was not the prior branch last revision
2244
# and we have converted that last revision to a pending merge.
2245
# base is somewhere between the branch tip now
2246
# and the now pending merge
2248
# Since we just modified the working tree and inventory, flush out
2249
# the current state, before we modify it again.
2250
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2251
# requires it only because TreeTransform directly munges the
2252
# inventory and calls tree._write_inventory(). Ultimately we
2253
# should be able to remove this extra flush.
2255
graph = self.branch.repository.get_graph()
2256
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2258
base_tree = self.branch.repository.revision_tree(base_rev_id)
2259
other_tree = self.branch.repository.revision_tree(old_tip)
2260
result += merge.merge_inner(
2265
change_reporter=change_reporter)
2324
2268
def _write_hashcache_if_dirty(self):
2325
2269
"""Write out the hashcache if it is dirty."""
2523
2465
# FIXME: stash the node in pending
2524
2466
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
2467
for name, child in entry.sorted_children():
2468
dirblock.append((relroot + name, name, child.kind, None,
2469
child.file_id, child.kind
2530
2471
yield (currentdir[0], entry.file_id), dirblock
2531
2472
# push the user specified dirs from dirblock
2532
2473
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
2521
class WorkingTree2(WorkingTree):
2612
2522
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2524
This was the first weave based working tree.
2615
2525
- uses os locks for locking.
2616
2526
- uses the branch last-revision.
2676
2582
def _last_revision(self):
2677
2583
"""See Mutable.last_revision."""
2679
return self._transport.get_bytes('last-revision')
2585
return self._control_files.get('last-revision').read()
2680
2586
except errors.NoSuchFile:
2681
2587
return _mod_revision.NULL_REVISION
2683
2589
def _change_last_revision(self, revision_id):
2684
2590
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2591
if revision_id is None or revision_id == NULL_REVISION:
2687
self._transport.delete('last-revision')
2593
self._control_files._transport.delete('last-revision')
2688
2594
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2598
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
2601
@needs_tree_write_lock
2701
2602
def set_conflicts(self, conflicts):
2702
self._put_rio('conflicts', conflicts.to_stanzas(),
2603
self._put_rio('conflicts', conflicts.to_stanzas(),
2703
2604
CONFLICT_HEADER_1)
2705
2606
@needs_tree_write_lock
2848
2754
"""See WorkingTreeFormat.get_format_description()."""
2849
2755
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.
2757
def stub_initialize_remote(self, control_files):
2758
"""As a special workaround create critical control files for a remote working tree
2854
2760
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2761
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
2762
no working tree. (See bug #43064).
2858
2764
sio = StringIO()
2859
inv = inventory.Inventory()
2860
2766
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)
2768
control_files.put('inventory', sio)
2770
control_files.put_bytes('pending-merges', '')
2865
2773
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
2774
accelerator_tree=None, hardlink=False):
added
removed
bzrlib/workingtree.py
