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
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
106
120
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
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
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()
115
144
class TreeEntry(object):
116
145
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
147
This needs further inspection, it may be better to have
119
148
InventoryEntries without ids - though that seems wrong. For now,
120
149
this is a parallel hierarchy to InventoryEntry, and needs to become
121
150
one of several things: decorates to that hierarchy, children of, or
285
302
self._control_files.break_lock()
286
303
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
305
def requires_rich_root(self):
299
306
return self._format.requires_rich_root
301
308
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
311
def _set_inventory(self, inv, dirty):
311
312
"""Set the internal cached inventory.
422
418
# at this point ?
424
420
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
421
except errors.RevisionNotPresent:
426
422
# 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
423
# occured. If the revision is present, its a problem, if its not
429
425
if self.branch.repository.has_revision(revision_id):
431
427
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
428
return self.branch.repository.revision_tree(None)
435
430
def _cleanup(self):
436
431
self._flush_ignore_list_cache()
434
@deprecated_method(zero_eight)
435
def create(branch, directory):
436
"""Create a workingtree for branch at directory.
438
If existing_directory already exists it must have a .bzr directory.
439
If it does not exist, it will be created.
441
This returns a new WorkingTree object for the new checkout.
443
TODO FIXME RBC 20060124 when we have checkout formats in place this
444
should accept an optional revisionid to checkout [and reject this if
445
checking out into the same dir as a pre-checkout-aware branch format.]
447
XXX: When BzrDir is present, these should be created through that
450
warnings.warn('delete WorkingTree.create', stacklevel=3)
451
transport = get_transport(directory)
452
if branch.bzrdir.root_transport.base == transport.base:
454
return branch.bzrdir.create_workingtree()
455
# different directory,
456
# create a branch reference
457
# and now a working tree.
458
raise NotImplementedError
461
@deprecated_method(zero_eight)
462
def create_standalone(directory):
463
"""Create a checkout and a branch and a repo at directory.
465
Directory must exist and be empty.
467
please use BzrDir.create_standalone_workingtree
469
return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
471
def relpath(self, path):
439
472
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
474
The path may be absolute or relative. If its a relative path it is
442
475
interpreted relative to the python current working directory.
444
477
return osutils.relpath(self.basedir, path)
446
479
def has_filename(self, filename):
447
480
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."""
482
def get_file(self, file_id, path=None):
456
484
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):
468
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()
485
return self.get_file_byname(path)
487
def get_file_text(self, file_id):
488
return self.get_file(file_id).read()
490
def get_file_byname(self, filename):
491
return file(self.abspath(filename), 'rb')
485
494
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
501
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
502
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)]
504
basis = self.basis_tree()
507
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
508
require_versioned=True).next()
509
changed_content, kind = changes[2], changes[6]
510
if not changed_content:
511
return basis.annotate_iter(file_id)
515
if kind[0] != 'file':
518
old_lines = list(basis.annotate_iter(file_id))
520
for tree in self.branch.repository.revision_trees(
521
self.get_parent_ids()[1:]):
522
if file_id not in tree:
524
old.append(list(tree.annotate_iter(file_id)))
525
return annotate.reannotate(old, self.get_file(file_id).readlines(),
532
530
def _get_ancestors(self, default_revision):
533
531
ancestors = set([default_revision])
570
568
def clone(self, to_bzrdir, revision_id=None):
571
569
"""Duplicate this working tree into to_bzr, including all state.
573
571
Specifically modified files are kept as modified, but
574
572
ignored and unknown files are discarded.
576
574
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
577
If not None, the cloned tree will have its last revision set to
578
revision, and and difference between the source trees last revision
581
579
and this one merged in.
583
581
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
582
result = self._format.initialize(to_bzrdir)
585
583
self.copy_content_into(result, revision_id)
767
757
kind = 'tree-reference'
768
758
return kind, None, None, None
769
759
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
760
return ('symlink', None, None, os.readlink(abspath))
773
762
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(
764
@deprecated_method(zero_eleven)
766
def pending_merges(self):
767
"""Return a list of pending merges.
769
These are revisions that have been merged into the working
770
directory but not yet committed.
772
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
773
instead - which is available on all tree objects.
775
return self.get_parent_ids()[1:]
782
777
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
778
"""Common ghost checking functionality from set_parent_*.
794
789
def _set_merges_from_parent_ids(self, parent_ids):
795
790
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
791
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
793
@needs_tree_write_lock
819
794
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
795
"""Set the parent ids to revision_ids.
822
797
See also set_parent_trees. This api will try to retrieve the tree data
823
798
for each element of revision_ids from the trees repository. If you have
824
799
tree data already available, it is more efficient to use
914
884
branch.last_revision().
916
886
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()
887
pb = bzrlib.ui.ui_factory.nested_progress_bar()
889
merger = Merger(self.branch, this_tree=self, pb=pb)
890
merger.pp = ProgressPhase("Merge phase", 5, pb)
891
merger.pp.next_phase()
892
# check that there are no
894
merger.check_basis(check_clean=True, require_commits=False)
895
if to_revision is None:
896
to_revision = _mod_revision.ensure_null(branch.last_revision())
897
merger.other_rev_id = to_revision
898
if _mod_revision.is_null(merger.other_rev_id):
899
raise errors.NoCommits(branch)
900
self.branch.fetch(branch, last_revision=merger.other_rev_id)
901
merger.other_basis = merger.other_rev_id
902
merger.other_tree = self.branch.repository.revision_tree(
904
merger.other_branch = branch
905
merger.pp.next_phase()
906
if from_revision is None:
909
merger.set_base_revision(from_revision, branch)
910
if merger.base_rev_id == merger.other_rev_id:
911
raise errors.PointlessMerge
912
merger.backup_files = False
913
if merge_type is None:
914
merger.merge_type = Merge3Merger
916
merger.merge_type = merge_type
917
merger.set_interesting_files(None)
918
merger.show_base = False
919
merger.reprocess = False
920
conflicts = merger.do_merge()
950
927
def merge_modified(self):
951
928
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
930
The list is initialized by WorkingTree.set_merge_modified, which is
954
931
typically called after we make some automatic updates to the tree
955
932
because of a merge.
958
935
still in the working inventory and have that text hash.
961
hashfile = self._transport.get('merge-hashes')
938
hashfile = self._control_files.get('merge-hashes')
962
939
except errors.NoSuchFile:
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
943
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
944
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
945
except StopIteration:
946
raise errors.MergeModifiedFormatError()
947
for s in RioReader(hashfile):
948
# RioReader reads in Unicode, so convert file_ids back to utf8
949
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
950
if file_id not in self.inventory:
952
text_hash = s.get("hash")
953
if text_hash == self.get_file_sha1(file_id):
954
merge_hashes[file_id] = text_hash
983
957
@needs_write_lock
984
958
def mkdir(self, path, file_id=None):
1096
1068
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1069
if tree_transport.base != branch_transport.base:
1098
1070
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1071
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1073
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1074
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1075
wt.set_parent_ids(self.get_parent_ids())
1105
1076
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1077
child_inv = Inventory(root_id=None)
1107
1078
new_root = my_inv[file_id]
1108
1079
my_inv.remove_recursive_id(file_id)
1109
1080
new_root.parent_id = None
1127
1098
sio = StringIO()
1128
1099
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1101
self._control_files.put('inventory', sio)
1132
1102
self._inventory_is_modified = False
1134
1104
def _kind(self, relpath):
1135
1105
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).
1107
def list_files(self, include_root=False):
1108
"""Recursively list all files as (path, class, kind, id, entry).
1140
1110
Lists, but does not descend into unversioned directories.
1141
1112
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
1115
Skips the control directory.
1148
1117
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1118
# with it. So callers should be careful to always read_lock the tree.
1164
1133
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1135
# 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)
1136
children = os.listdir(self.basedir)
1177
1137
children.sort()
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1138
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
1139
# use a deque and popleft to keep them sorted, or if we use a plain
1180
1140
# list and just reverse() them.
1181
1141
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1142
stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1144
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1239
1199
except KeyError:
1240
1200
yield fp[1:], c, fk, None, TreeEntry()
1243
1203
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
1206
# But do this child first
1207
new_children = os.listdir(fap)
1209
new_children = collections.deque(new_children)
1210
stack.append((f_ie.file_id, fp, fap, new_children))
1211
# Break out of inner loop,
1212
# so that we start outer loop with child
1256
1215
# if we finished all children, pop it off the stack
1493
1450
from_tail = splitpath(from_rel)[-1]
1494
1451
from_id = inv.path2id(from_rel)
1495
1452
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]
1453
raise errors.BzrRenameFailedError(from_rel,to_rel,
1454
errors.NotVersionedError(path=str(from_rel)))
1455
from_entry = inv[from_id]
1507
1456
from_parent_id = from_entry.parent_id
1508
1457
to_dir, to_tail = os.path.split(to_rel)
1509
1458
to_dir_id = inv.path2id(to_dir)
1571
1520
:raises: NoSuchId if any fileid is not currently versioned.
1573
1522
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
1523
if self._inventory.has_id(file_id):
1578
1524
self._inventory.remove_recursive_id(file_id)
1526
raise errors.NoSuchId(self, file_id)
1579
1527
if len(file_ids):
1580
# in the future this should just set a dirty bit to wait for the
1528
# in the future this should just set a dirty bit to wait for the
1581
1529
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1530
# with the current in -memory inventory rather than triggering
1583
1531
# a read, it is more complex - we need to teach read_inventory
1584
1532
# to know when to read, and when to not read first... and possibly
1585
1533
# to save first when the in memory one may be corrupted.
1586
1534
# so for now, we just only write it if it is indeed dirty.
1587
1535
# - RBC 20060907
1588
1536
self._write_inventory(self._inventory)
1538
@deprecated_method(zero_eight)
1539
def iter_conflicts(self):
1540
"""List all files in the tree that have text or content conflicts.
1541
DEPRECATED. Use conflicts instead."""
1542
return self._iter_conflicts()
1590
1544
def _iter_conflicts(self):
1591
1545
conflicted = set()
1601
1555
@needs_write_lock
1602
1556
def pull(self, source, overwrite=False, stop_revision=None,
1603
change_reporter=None, possible_transports=None, local=False):
1557
change_reporter=None, possible_transports=None):
1558
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1559
source.lock_read()
1561
pp = ProgressPhase("Pull phase", 2, top_pb)
1606
1563
old_revision_info = self.branch.last_revision_info()
1607
1564
basis_tree = self.basis_tree()
1608
1565
count = self.branch.pull(source, overwrite, stop_revision,
1609
possible_transports=possible_transports,
1566
possible_transports=possible_transports)
1611
1567
new_revision_info = self.branch.last_revision_info()
1612
1568
if new_revision_info != old_revision_info:
1613
1570
repository = self.branch.repository
1571
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1572
basis_tree.lock_read()
1616
1574
new_basis_tree = self.branch.basis_tree()
1619
1577
new_basis_tree,
1621
1579
this_tree=self,
1623
1581
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)
1582
if (basis_tree.inventory.root is None and
1583
new_basis_tree.inventory.root is not None):
1584
self.set_root_id(new_basis_tree.get_root_id())
1629
1587
basis_tree.unlock()
1630
1588
# TODO - dedup parents list with things merged by pull ?
1631
1589
# reuse the revisiontree we merged against to set the new
1633
1591
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
1592
# we have to pull the merge trees out again, because
1593
# merge_inner has set the ids. - this corner is not yet
1636
1594
# layered well enough to prevent double handling.
1637
1595
# XXX TODO: Fix the double handling: telling the tree about
1638
1596
# the already known parent data is wasteful.
1734
1686
r"""Check whether the filename matches an ignore pattern.
1736
1688
Patterns containing '/' or '\' need to match the whole path;
1737
others match against only the last component. Patterns starting
1738
with '!' are ignore exceptions. Exceptions take precedence
1739
over regular patterns and cause the filename to not be ignored.
1689
others match against only the last component.
1741
1691
If the file is ignored, returns the pattern which caused it to
1742
1692
be ignored, otherwise None. So this can simply be used as a
1743
1693
boolean if desired."""
1744
1694
if getattr(self, '_ignoreglobster', None) is None:
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1695
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1696
return self._ignoreglobster.match(filename)
1748
1698
def kind(self, file_id):
1749
1699
return file_kind(self.id2abspath(file_id))
1751
def stored_kind(self, file_id):
1752
"""See Tree.stored_kind"""
1753
return self.inventory[file_id].kind
1755
1701
def _comparison_data(self, entry, path):
1756
1702
abspath = self.abspath(path)
1798
1744
raise errors.ObjectNotLocked(self)
1800
1746
def lock_read(self):
1801
"""Lock the tree for reading.
1803
This also locks the branch, and can be unlocked via self.unlock().
1805
:return: An object with an unlock method which will release the lock
1747
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1748
if not self.is_locked():
1809
1749
self._reset_data()
1810
1750
self.branch.lock_read()
1812
self._control_files.lock_read()
1752
return self._control_files.lock_read()
1815
1754
self.branch.unlock()
1818
1757
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: An object with an unlock method which will release the lock
1758
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1824
1759
if not self.is_locked():
1825
1760
self._reset_data()
1826
1761
self.branch.lock_read()
1828
self._control_files.lock_write()
1763
return self._control_files.lock_write()
1831
1765
self.branch.unlock()
1834
1768
def lock_write(self):
1835
"""See MutableTree.lock_write, and WorkingTree.unlock.
1837
:return: An object with an unlock method which will release the lock
1769
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1840
1770
if not self.is_locked():
1841
1771
self._reset_data()
1842
1772
self.branch.lock_write()
1844
self._control_files.lock_write()
1774
return self._control_files.lock_write()
1847
1776
self.branch.unlock()
1903
1828
# as commit already has that ready-to-use [while the format is the
1904
1829
# same, that is].
1906
# this double handles the inventory - unpack and repack -
1831
# this double handles the inventory - unpack and repack -
1907
1832
# but is easier to understand. We can/should put a conditional
1908
1833
# in here based on whether the inventory is in the latest format
1909
1834
# - perhaps we should repack all inventories on a repository
1911
1836
# the fast path is to copy the raw xml from the repository. If the
1912
# xml contains 'revision_id="', then we assume the right
1837
# xml contains 'revision_id="', then we assume the right
1913
1838
# revision_id is set. We must check for this full string, because a
1914
1839
# root node id can legitimately look like 'revision_id' but cannot
1915
1840
# contain a '"'.
1916
xml = self.branch.repository._get_inventory_xml(new_revision)
1841
xml = self.branch.repository.get_inventory_xml(new_revision)
1917
1842
firstline = xml.split('\n', 1)[0]
1918
if (not 'revision_id="' in firstline or
1843
if (not 'revision_id="' in firstline or
1919
1844
'format="7"' not in firstline):
1920
inv = self.branch.repository._serializer.read_inventory_from_string(
1845
inv = self.branch.repository.deserialise_inventory(
1922
1847
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
1848
self._write_basis_inventory(xml)
1924
1849
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1927
1852
def read_basis_inventory(self):
1928
1853
"""Read the cached basis inventory."""
1929
1854
path = self._basis_inventory_name()
1930
return self._transport.get_bytes(path)
1855
return self._control_files.get(path).read()
1932
1857
@needs_read_lock
1933
1858
def read_working_inventory(self):
1934
1859
"""Read the working inventory.
1936
1861
:raises errors.InventoryModified: read_working_inventory will fail
1937
1862
when the current in memory inventory has been modified.
1939
# conceptually this should be an implementation detail of the tree.
1864
# conceptually this should be an implementation detail of the tree.
1940
1865
# XXX: Deprecate this.
1941
1866
# ElementTree does its own conversion from UTF-8, so open in
1943
1868
if self._inventory_is_modified:
1944
1869
raise errors.InventoryModified(self)
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1870
result = self._deserialize(self._control_files.get('inventory'))
1950
1871
self._set_inventory(result, dirty=False)
1968
1889
new_files=set()
1969
1890
unknown_nested_files=set()
1971
to_file = sys.stdout
1973
1892
def recurse_directory_to_add_files(directory):
1974
1893
# Recurse directory and add all files
1975
1894
# so we can check if they have changed.
1976
1895
for parent_info, file_infos in\
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1896
osutils.walkdirs(self.abspath(directory),
1898
for relpath, basename, kind, lstat, abspath in file_infos:
1979
1899
# Is it versioned or ignored?
1980
1900
if self.path2id(relpath) or self.is_ignored(relpath):
1981
1901
# Add nested content for deletion.
2159
2080
@needs_tree_write_lock
2160
2081
def set_root_id(self, file_id):
2161
2082
"""Set the root id for this tree."""
2163
2084
if file_id is None:
2165
'WorkingTree.set_root_id with fileid=None')
2166
file_id = osutils.safe_file_id(file_id)
2085
symbol_versioning.warn(symbol_versioning.zero_twelve
2086
% 'WorkingTree.set_root_id with fileid=None',
2091
file_id = osutils.safe_file_id(file_id)
2167
2092
self._set_root_id(file_id)
2169
2094
def _set_root_id(self, file_id):
2170
2095
"""Set the root id for this tree, in a format specific manner.
2172
:param file_id: The file id to assign to the root. It must not be
2097
:param file_id: The file id to assign to the root. It must not be
2173
2098
present in the current inventory or an error will occur. It must
2174
2099
not be None, but rather a valid file id.
2195
2120
def unlock(self):
2196
2121
"""See Branch.unlock.
2198
2123
WorkingTree locking just uses the Branch locking facilities.
2199
2124
This is current because all working trees have an embedded branch
2200
2125
within them. IF in the future, we were to make branch data shareable
2201
between multiple working trees, i.e. via shared storage, then we
2126
between multiple working trees, i.e. via shared storage, then we
2202
2127
would probably want to lock both the local tree, and the branch.
2204
2129
raise NotImplementedError(self.unlock)
2208
def update(self, change_reporter=None, possible_transports=None,
2209
revision=None, old_tip=_marker):
2131
def update(self, change_reporter=None, possible_transports=None):
2210
2132
"""Update a working tree along its branch.
2212
2134
This will update the branch if its bound too, which means we have
2266
2181
# cant set that until we update the working trees last revision to be
2267
2182
# one from the new branch, because it will just get absorbed by the
2268
2183
# parent de-duplication logic.
2270
2185
# We MUST save it even if an error occurs, because otherwise the users
2271
2186
# local work is unreferenced and will appear to have been lost.
2275
2190
last_rev = self.get_parent_ids()[0]
2276
2191
except IndexError:
2277
2192
last_rev = _mod_revision.NULL_REVISION
2278
if revision is None:
2279
revision = self.branch.last_revision()
2281
old_tip = old_tip or _mod_revision.NULL_REVISION
2283
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
# the branch we are bound to was updated
2285
# merge those changes in first
2286
base_tree = self.basis_tree()
2287
other_tree = self.branch.repository.revision_tree(old_tip)
2288
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
base_tree, this_tree=self,
2290
change_reporter=change_reporter)
2292
self.add_parent_tree((old_tip, other_tree))
2293
trace.note('Rerun update after fixing the conflicts.')
2296
if last_rev != _mod_revision.ensure_null(revision):
2297
# the working tree is up to date with the branch
2298
# we can merge the specified revision from master
2299
to_tree = self.branch.repository.revision_tree(revision)
2300
to_root_id = to_tree.get_root_id()
2193
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2194
# merge tree state up to new branch tip.
2302
2195
basis = self.basis_tree()
2303
2196
basis.lock_read()
2305
if (basis.inventory.root is None
2306
or basis.inventory.root.file_id != to_root_id):
2307
self.set_root_id(to_root_id)
2198
to_tree = self.branch.basis_tree()
2199
if basis.inventory.root is None:
2200
self.set_root_id(to_tree.get_root_id())
2202
result += merge.merge_inner(
2207
change_reporter=change_reporter)
2312
# determine the branch point
2313
graph = self.branch.repository.get_graph()
2314
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2316
base_tree = self.branch.repository.revision_tree(base_rev_id)
2318
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2320
change_reporter=change_reporter)
2321
self.set_last_revision(revision)
2322
2210
# TODO - dedup parents list with things merged by pull ?
2323
2211
# reuse the tree we've updated to to set the basis:
2324
parent_trees = [(revision, to_tree)]
2212
parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2213
merges = self.get_parent_ids()[1:]
2326
2214
# Ideally we ask the tree for the trees here, that way the working
2327
# tree can decide whether to give us the entire tree or give us a
2215
# tree can decide whether to give us teh entire tree or give us a
2328
2216
# lazy initialised tree. dirstate for instance will have the trees
2329
2217
# in ram already, whereas a last-revision + basis-inventory tree
2330
2218
# will not, but also does not need them when setting parents.
2331
2219
for parent in merges:
2332
2220
parent_trees.append(
2333
2221
(parent, self.branch.repository.revision_tree(parent)))
2334
if not _mod_revision.is_null(old_tip):
2222
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2335
2223
parent_trees.append(
2336
2224
(old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2225
self.set_parent_trees(parent_trees)
2338
2226
last_rev = parent_trees[0][0]
2228
# the working tree had the same last-revision as the master
2229
# branch did. We may still have pivot local work from the local
2230
# branch into old_tip:
2231
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2232
self.add_parent_tree_id(old_tip)
2233
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2234
and old_tip != last_rev):
2235
# our last revision was not the prior branch last revision
2236
# and we have converted that last revision to a pending merge.
2237
# base is somewhere between the branch tip now
2238
# and the now pending merge
2240
# Since we just modified the working tree and inventory, flush out
2241
# the current state, before we modify it again.
2242
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2243
# requires it only because TreeTransform directly munges the
2244
# inventory and calls tree._write_inventory(). Ultimately we
2245
# should be able to remove this extra flush.
2247
graph = self.branch.repository.get_graph()
2248
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2250
base_tree = self.branch.repository.revision_tree(base_rev_id)
2251
other_tree = self.branch.repository.revision_tree(old_tip)
2252
result += merge.merge_inner(
2257
change_reporter=change_reporter)
2341
2260
def _write_hashcache_if_dirty(self):
2342
2261
"""Write out the hashcache if it is dirty."""
2540
2457
# FIXME: stash the node in pending
2541
2458
entry = inv[top_id]
2542
if entry.kind == 'directory':
2543
for name, child in entry.sorted_children():
2544
dirblock.append((relroot + name, name, child.kind, None,
2545
child.file_id, child.kind
2459
for name, child in entry.sorted_children():
2460
dirblock.append((relroot + name, name, child.kind, None,
2461
child.file_id, child.kind
2547
2463
yield (currentdir[0], entry.file_id), dirblock
2548
2464
# push the user specified dirs from dirblock
2549
2465
for dir in reversed(dirblock):
2615
def _get_rules_searcher(self, default_searcher):
2616
"""See Tree._get_rules_searcher."""
2617
if self._rules_searcher is None:
2618
self._rules_searcher = super(WorkingTree,
2619
self)._get_rules_searcher(default_searcher)
2620
return self._rules_searcher
2622
def get_shelf_manager(self):
2623
"""Return the ShelfManager for this WorkingTree."""
2624
from bzrlib.shelf import ShelfManager
2625
return ShelfManager(self, self._transport)
2628
2513
class WorkingTree2(WorkingTree):
2629
2514
"""This is the Format 2 working tree.
2631
This was the first weave based working tree.
2516
This was the first weave based working tree.
2632
2517
- uses os locks for locking.
2633
2518
- uses the branch last-revision.
2697
2574
def _last_revision(self):
2698
2575
"""See Mutable.last_revision."""
2700
return self._transport.get_bytes('last-revision')
2577
return self._control_files.get('last-revision').read()
2701
2578
except errors.NoSuchFile:
2702
2579
return _mod_revision.NULL_REVISION
2704
2581
def _change_last_revision(self, revision_id):
2705
2582
"""See WorkingTree._change_last_revision."""
2706
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2583
if revision_id is None or revision_id == NULL_REVISION:
2708
self._transport.delete('last-revision')
2585
self._control_files._transport.delete('last-revision')
2709
2586
except errors.NoSuchFile:
2713
self._transport.put_bytes('last-revision', revision_id,
2714
mode=self.bzrdir._get_file_mode())
2590
self._control_files.put_bytes('last-revision', revision_id)
2717
def _get_check_refs(self):
2718
"""Return the references needed to perform a check of this tree."""
2719
return [('trees', self.last_revision())]
2721
2593
@needs_tree_write_lock
2722
2594
def set_conflicts(self, conflicts):
2723
self._put_rio('conflicts', conflicts.to_stanzas(),
2595
self._put_rio('conflicts', conflicts.to_stanzas(),
2724
2596
CONFLICT_HEADER_1)
2726
2598
@needs_tree_write_lock
2869
2746
"""See WorkingTreeFormat.get_format_description()."""
2870
2747
return "Working tree format 2"
2872
def _stub_initialize_on_transport(self, transport, file_mode):
2873
"""Workaround: create control files for a remote working tree.
2749
def stub_initialize_remote(self, control_files):
2750
"""As a special workaround create critical control files for a remote working tree
2875
2752
This ensures that it can later be updated and dealt with locally,
2876
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2753
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2877
2754
no working tree. (See bug #43064).
2879
2756
sio = StringIO()
2880
inv = inventory.Inventory()
2881
2758
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2883
transport.put_file('inventory', sio, file_mode)
2884
transport.put_bytes('pending-merges', '', file_mode)
2760
control_files.put('inventory', sio)
2762
control_files.put_bytes('pending-merges', '')
2886
2765
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2887
accelerator_tree=None, hardlink=False):
2766
accelerator_tree=None):
2888
2767
"""See WorkingTreeFormat.initialize()."""
2889
2768
if not isinstance(a_bzrdir.transport, LocalTransport):
2890
2769
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2853
def _open_control_files(self, a_bzrdir):
2975
2854
transport = a_bzrdir.get_workingtree_transport(None)
2976
return LockableFiles(transport, self._lock_file_name,
2855
return LockableFiles(transport, self._lock_file_name,
2977
2856
self._lock_class)
2979
2858
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
accelerator_tree=None, hardlink=False):
2859
accelerator_tree=None):
2981
2860
"""See WorkingTreeFormat.initialize().
2983
2862
:param revision_id: if supplied, create a working tree at a different
2984
2863
revision than the branch is at.
2985
2864
:param accelerator_tree: A tree which can be used for retrieving file
2986
2865
contents more quickly than the revision tree, i.e. a workingtree.
2987
2866
The revision tree will be used for cases where accelerator_tree's
2988
2867
content is different.
2989
:param hardlink: If true, hard-link files from accelerator_tree,
2992
2869
if not isinstance(a_bzrdir.transport, LocalTransport):
2993
2870
raise errors.NotLocalUrl(a_bzrdir.transport.base)
added
removed
bzrlib/workingtree.py
