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,
61
67
revision as _mod_revision,
71
from bzrlib.workingtree_4 import (
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
85
from bzrlib import symbol_versioning
79
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
82
89
from bzrlib.lockdir import LockDir
83
90
import bzrlib.mutabletree
84
91
from bzrlib.mutabletree import needs_tree_write_lock
85
92
from bzrlib import osutils
86
93
from bzrlib.osutils import (
94
103
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
107
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
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()
116
144
class TreeEntry(object):
117
145
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
147
This needs further inspection, it may be better to have
120
148
InventoryEntries without ids - though that seems wrong. For now,
121
149
this is a parallel hierarchy to InventoryEntry, and needs to become
122
150
one of several things: decorates to that hierarchy, children of, or
289
302
self._control_files.break_lock()
290
303
self.branch.break_lock()
292
def _get_check_refs(self):
293
"""Return the references needed to perform a check of this tree.
295
The default implementation returns no refs, and is only suitable for
296
trees that have no local caching and can commit on ghosts at any time.
298
:seealso: bzrlib.check for details about check_refs.
302
305
def requires_rich_root(self):
303
306
return self._format.requires_rich_root
305
308
def supports_tree_reference(self):
308
def supports_content_filtering(self):
309
return self._format.supports_content_filtering()
311
def supports_views(self):
312
return self.views.supports_views()
314
311
def _set_inventory(self, inv, dirty):
315
312
"""Set the internal cached inventory.
351
349
path = osutils.getcwd()
352
350
control, relpath = bzrdir.BzrDir.open_containing(path)
353
352
return control.open_workingtree(), relpath
356
def open_containing_paths(file_list, default_directory='.',
357
canonicalize=True, apply_view=True):
358
"""Open the WorkingTree that contains a set of paths.
360
Fail if the paths given are not all in a single tree.
362
This is used for the many command-line interfaces that take a list of
363
any number of files and that require they all be in the same tree.
365
# recommended replacement for builtins.internal_tree_files
366
if file_list is None or len(file_list) == 0:
367
tree = WorkingTree.open_containing(default_directory)[0]
368
# XXX: doesn't really belong here, and seems to have the strange
369
# side effect of making it return a bunch of files, not the whole
370
# tree -- mbp 20100716
371
if tree.supports_views() and apply_view:
372
view_files = tree.views.lookup_view()
374
file_list = view_files
375
view_str = views.view_display_str(view_files)
376
note("Ignoring files outside view. View is %s" % view_str)
377
return tree, file_list
378
tree = WorkingTree.open_containing(file_list[0])[0]
379
return tree, tree.safe_relpath_files(file_list, canonicalize,
380
apply_view=apply_view)
382
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
383
"""Convert file_list into a list of relpaths in tree.
385
:param self: A tree to operate on.
386
:param file_list: A list of user provided paths or None.
387
:param apply_view: if True and a view is set, apply it or check that
388
specified files are within it
389
:return: A list of relative paths.
390
:raises errors.PathNotChild: When a provided path is in a different self
393
if file_list is None:
395
if self.supports_views() and apply_view:
396
view_files = self.views.lookup_view()
400
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
401
# doesn't - fix that up here before we enter the loop.
403
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
406
for filename in file_list:
407
relpath = fixer(osutils.dereference_path(filename))
408
if view_files and not osutils.is_inside_any(view_files, relpath):
409
raise errors.FileOutsideView(filename, view_files)
410
new_list.append(relpath)
414
355
def open_downlevel(path=None):
415
356
"""Open an unsupported working tree.
483
422
# at this point ?
485
424
return self.branch.repository.revision_tree(revision_id)
486
except (errors.RevisionNotPresent, errors.NoSuchRevision):
425
except errors.RevisionNotPresent:
487
426
# the basis tree *may* be a ghost or a low level error may have
488
# 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
490
429
if self.branch.repository.has_revision(revision_id):
492
431
# the basis tree is a ghost so return an empty tree.
493
return self.branch.repository.revision_tree(
494
_mod_revision.NULL_REVISION)
432
return self.branch.repository.revision_tree(None)
496
434
def _cleanup(self):
497
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)
499
475
def relpath(self, path):
500
476
"""Return the local path portion from a given path.
502
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
503
479
interpreted relative to the python current working directory.
505
481
return osutils.relpath(self.basedir, path)
507
483
def has_filename(self, filename):
508
484
return osutils.lexists(self.abspath(filename))
510
def get_file(self, file_id, path=None, filtered=True):
511
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
513
def get_file_with_stat(self, file_id, path=None, filtered=True,
515
"""See Tree.get_file_with_stat."""
486
def get_file(self, file_id, path=None):
517
488
path = self.id2path(file_id)
518
file_obj = self.get_file_byname(path, filtered=False)
519
stat_value = _fstat(file_obj.fileno())
520
if filtered and self.supports_content_filtering():
521
filters = self._content_filter_stack(path)
522
file_obj = filtered_input_file(file_obj, filters)
523
return (file_obj, stat_value)
525
def get_file_text(self, file_id, path=None, filtered=True):
526
my_file = self.get_file(file_id, path=path, filtered=filtered)
528
return my_file.read()
532
def get_file_byname(self, filename, filtered=True):
533
path = self.abspath(filename)
535
if filtered and self.supports_content_filtering():
536
filters = self._content_filter_stack(filename)
537
return filtered_input_file(f, filters)
541
def get_file_lines(self, file_id, path=None, filtered=True):
542
"""See Tree.get_file_lines()"""
543
file = self.get_file(file_id, path, filtered=filtered)
545
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')
550
498
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
557
505
incorrectly attributed to CURRENT_REVISION (but after committing, the
558
506
attribution will be correct).
560
maybe_file_parent_keys = []
561
for parent_id in self.get_parent_ids():
563
parent_tree = self.revision_tree(parent_id)
564
except errors.NoSuchRevisionInTree:
565
parent_tree = self.branch.repository.revision_tree(parent_id)
566
parent_tree.lock_read()
568
if file_id not in parent_tree:
570
ie = parent_tree.inventory[file_id]
571
if ie.kind != 'file':
572
# Note: this is slightly unnecessary, because symlinks and
573
# directories have a "text" which is the empty text, and we
574
# know that won't mess up annotations. But it seems cleaner
576
parent_text_key = (file_id, ie.revision)
577
if parent_text_key not in maybe_file_parent_keys:
578
maybe_file_parent_keys.append(parent_text_key)
581
graph = _mod_graph.Graph(self.branch.repository.texts)
582
heads = graph.heads(maybe_file_parent_keys)
583
file_parent_keys = []
584
for key in maybe_file_parent_keys:
586
file_parent_keys.append(key)
588
# Now we have the parents of this content
589
annotator = self.branch.repository.texts.get_annotator()
590
text = self.get_file_text(file_id)
591
this_key =(file_id, default_revision)
592
annotator.add_special_text(this_key, file_parent_keys, text)
593
annotations = [(key[-1], line)
594
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(),
597
534
def _get_ancestors(self, default_revision):
598
535
ancestors = set([default_revision])
635
572
def clone(self, to_bzrdir, revision_id=None):
636
573
"""Duplicate this working tree into to_bzr, including all state.
638
575
Specifically modified files are kept as modified, but
639
576
ignored and unknown files are discarded.
641
578
If you want to make a new line of development, see bzrdir.sprout()
644
If not None, the cloned tree will have its last revision set to
645
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
646
583
and this one merged in.
648
585
# assumes the target bzr dir format is compatible.
649
result = to_bzrdir.create_workingtree()
586
result = self._format.initialize(to_bzrdir)
650
587
self.copy_content_into(result, revision_id)
832
761
kind = 'tree-reference'
833
762
return kind, None, None, None
834
763
elif kind == 'symlink':
835
target = osutils.readlink(abspath)
836
return ('symlink', None, None, target)
764
return ('symlink', None, None, os.readlink(abspath))
838
766
return (kind, None, None, None)
840
def _file_content_summary(self, path, stat_result):
841
size = stat_result.st_size
842
executable = self._is_executable_from_path_and_stat(path, stat_result)
843
# try for a stat cache lookup
844
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:]
847
781
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
848
782
"""Common ghost checking functionality from set_parent_*.
859
793
def _set_merges_from_parent_ids(self, parent_ids):
860
794
merges = parent_ids[1:]
861
self._transport.put_bytes('pending-merges', '\n'.join(merges),
862
mode=self.bzrdir._get_file_mode())
864
def _filter_parent_ids_by_ancestry(self, revision_ids):
865
"""Check that all merged revisions are proper 'heads'.
867
This will always return the first revision_id, and any merged revisions
870
if len(revision_ids) == 0:
872
graph = self.branch.repository.get_graph()
873
heads = graph.heads(revision_ids)
874
new_revision_ids = revision_ids[:1]
875
for revision_id in revision_ids[1:]:
876
if revision_id in heads and revision_id not in new_revision_ids:
877
new_revision_ids.append(revision_id)
878
if new_revision_ids != revision_ids:
879
trace.mutter('requested to set revision_ids = %s,'
880
' but filtered to %s', revision_ids, new_revision_ids)
881
return new_revision_ids
795
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
883
797
@needs_tree_write_lock
884
798
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
885
799
"""Set the parent ids to revision_ids.
887
801
See also set_parent_trees. This api will try to retrieve the tree data
888
802
for each element of revision_ids from the trees repository. If you have
889
803
tree data already available, it is more efficient to use
979
888
branch.last_revision().
981
890
from bzrlib.merge import Merger, Merge3Merger
982
merger = Merger(self.branch, this_tree=self)
983
# check that there are no local alterations
984
if not force and self.has_changes():
985
raise errors.UncommittedChanges(self)
986
if to_revision is None:
987
to_revision = _mod_revision.ensure_null(branch.last_revision())
988
merger.other_rev_id = to_revision
989
if _mod_revision.is_null(merger.other_rev_id):
990
raise errors.NoCommits(branch)
991
self.branch.fetch(branch, last_revision=merger.other_rev_id)
992
merger.other_basis = merger.other_rev_id
993
merger.other_tree = self.branch.repository.revision_tree(
995
merger.other_branch = branch
996
if from_revision is None:
999
merger.set_base_revision(from_revision, branch)
1000
if merger.base_rev_id == merger.other_rev_id:
1001
raise errors.PointlessMerge
1002
merger.backup_files = False
1003
if merge_type is None:
1004
merger.merge_type = Merge3Merger
1006
merger.merge_type = merge_type
1007
merger.set_interesting_files(None)
1008
merger.show_base = False
1009
merger.reprocess = False
1010
conflicts = merger.do_merge()
1011
merger.set_pending()
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()
1012
928
return conflicts
1014
930
@needs_read_lock
1015
931
def merge_modified(self):
1016
932
"""Return a dictionary of files modified by a merge.
1018
The list is initialized by WorkingTree.set_merge_modified, which is
934
The list is initialized by WorkingTree.set_merge_modified, which is
1019
935
typically called after we make some automatic updates to the tree
1020
936
because of a merge.
1023
939
still in the working inventory and have that text hash.
1026
hashfile = self._transport.get('merge-hashes')
942
hashfile = self._control_files.get('merge-hashes')
1027
943
except errors.NoSuchFile:
1032
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
1033
raise errors.MergeModifiedFormatError()
1034
except StopIteration:
947
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
1035
948
raise errors.MergeModifiedFormatError()
1036
for s in RioReader(hashfile):
1037
# RioReader reads in Unicode, so convert file_ids back to utf8
1038
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
1039
if file_id not in self.inventory:
1041
text_hash = s.get("hash")
1042
if text_hash == self.get_file_sha1(file_id):
1043
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
1048
961
@needs_write_lock
1049
962
def mkdir(self, path, file_id=None):
1161
1072
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1162
1073
if tree_transport.base != branch_transport.base:
1163
1074
tree_bzrdir = format.initialize_on_transport(tree_transport)
1164
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1165
target_branch=new_branch)
1075
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1167
1077
tree_bzrdir = branch_bzrdir
1168
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1078
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1169
1079
wt.set_parent_ids(self.get_parent_ids())
1170
1080
my_inv = self.inventory
1171
child_inv = inventory.Inventory(root_id=None)
1081
child_inv = Inventory(root_id=None)
1172
1082
new_root = my_inv[file_id]
1173
1083
my_inv.remove_recursive_id(file_id)
1174
1084
new_root.parent_id = None
1192
1102
sio = StringIO()
1193
1103
self._serialize(self._inventory, sio)
1195
self._transport.put_file('inventory', sio,
1196
mode=self.bzrdir._get_file_mode())
1105
self._control_files.put('inventory', sio)
1197
1106
self._inventory_is_modified = False
1199
1108
def _kind(self, relpath):
1200
1109
return osutils.file_kind(self.abspath(relpath))
1202
def list_files(self, include_root=False, from_dir=None, recursive=True):
1203
"""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).
1205
1114
Lists, but does not descend into unversioned directories.
1206
1116
This does not include files that have been deleted in this
1207
tree. Skips the control directory.
1209
:param include_root: if True, return an entry for the root
1210
:param from_dir: start from this directory or None for the root
1211
:param recursive: whether to recurse into subdirectories or not
1119
Skips the control directory.
1213
1121
# list_files is an iterator, so @needs_read_lock doesn't work properly
1214
1122
# with it. So callers should be careful to always read_lock the tree.
1229
1137
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1231
1139
# directory file_id, relative path, absolute path, reverse sorted children
1232
if from_dir is not None:
1233
from_dir_id = inv.path2id(from_dir)
1234
if from_dir_id is None:
1235
# Directory not versioned
1237
from_dir_abspath = pathjoin(self.basedir, from_dir)
1239
from_dir_id = inv.root.file_id
1240
from_dir_abspath = self.basedir
1241
children = os.listdir(from_dir_abspath)
1140
children = os.listdir(self.basedir)
1242
1141
children.sort()
1243
# jam 20060527 The kernel sized tree seems equivalent whether we
1142
# jam 20060527 The kernel sized tree seems equivalent whether we
1244
1143
# use a deque and popleft to keep them sorted, or if we use a plain
1245
1144
# list and just reverse() them.
1246
1145
children = collections.deque(children)
1247
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1146
stack = [(inv.root.file_id, u'', self.basedir, children)]
1249
1148
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1309
1203
except KeyError:
1310
1204
yield fp[1:], c, fk, None, TreeEntry()
1313
1207
if fk != 'directory':
1316
# But do this child first if recursing down
1318
new_children = os.listdir(fap)
1320
new_children = collections.deque(new_children)
1321
stack.append((f_ie.file_id, fp, fap, new_children))
1322
# Break out of inner loop,
1323
# 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
1326
1219
# if we finished all children, pop it off the stack
1329
1222
@needs_tree_write_lock
1330
def move(self, from_paths, to_dir=None, after=False):
1223
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1331
1224
"""Rename files.
1333
1226
to_dir must exist in the inventory.
1335
1228
If to_dir exists and is a directory, the files are moved into
1336
it, keeping their old names.
1229
it, keeping their old names.
1338
1231
Note that to_dir is only the last component of the new name;
1339
1232
this doesn't change the directory.
1556
1454
from_tail = splitpath(from_rel)[-1]
1557
1455
from_id = inv.path2id(from_rel)
1558
1456
if from_id is None:
1559
# if file is missing in the inventory maybe it's in the basis_tree
1560
basis_tree = self.branch.basis_tree()
1561
from_id = basis_tree.path2id(from_rel)
1563
raise errors.BzrRenameFailedError(from_rel,to_rel,
1564
errors.NotVersionedError(path=str(from_rel)))
1565
# put entry back in the inventory so we can rename it
1566
from_entry = basis_tree.inventory[from_id].copy()
1569
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]
1570
1460
from_parent_id = from_entry.parent_id
1571
1461
to_dir, to_tail = os.path.split(to_rel)
1572
1462
to_dir_id = inv.path2id(to_dir)
1634
1524
:raises: NoSuchId if any fileid is not currently versioned.
1636
1526
for file_id in file_ids:
1637
if file_id not in self._inventory:
1638
raise errors.NoSuchId(self, file_id)
1639
for file_id in file_ids:
1640
1527
if self._inventory.has_id(file_id):
1641
1528
self._inventory.remove_recursive_id(file_id)
1530
raise errors.NoSuchId(self, file_id)
1642
1531
if len(file_ids):
1643
# 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
1644
1533
# final unlock. However, until all methods of workingtree start
1645
# with the current in -memory inventory rather than triggering
1534
# with the current in -memory inventory rather than triggering
1646
1535
# a read, it is more complex - we need to teach read_inventory
1647
1536
# to know when to read, and when to not read first... and possibly
1648
1537
# to save first when the in memory one may be corrupted.
1649
1538
# so for now, we just only write it if it is indeed dirty.
1650
1539
# - RBC 20060907
1651
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()
1653
1548
def _iter_conflicts(self):
1654
1549
conflicted = set()
1664
1559
@needs_write_lock
1665
1560
def pull(self, source, overwrite=False, stop_revision=None,
1666
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()
1667
1563
source.lock_read()
1565
pp = ProgressPhase("Pull phase", 2, top_pb)
1669
1567
old_revision_info = self.branch.last_revision_info()
1670
1568
basis_tree = self.basis_tree()
1671
1569
count = self.branch.pull(source, overwrite, stop_revision,
1672
possible_transports=possible_transports,
1570
possible_transports=possible_transports)
1674
1571
new_revision_info = self.branch.last_revision_info()
1675
1572
if new_revision_info != old_revision_info:
1676
1574
repository = self.branch.repository
1575
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1677
1576
basis_tree.lock_read()
1679
1578
new_basis_tree = self.branch.basis_tree()
1682
1581
new_basis_tree,
1684
1583
this_tree=self,
1686
1585
change_reporter=change_reporter)
1687
basis_root_id = basis_tree.get_root_id()
1688
new_root_id = new_basis_tree.get_root_id()
1689
if basis_root_id != new_root_id:
1690
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())
1692
1591
basis_tree.unlock()
1693
1592
# TODO - dedup parents list with things merged by pull ?
1694
1593
# reuse the revisiontree we merged against to set the new
1696
1595
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1697
# we have to pull the merge trees out again, because
1698
# 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
1699
1598
# layered well enough to prevent double handling.
1700
1599
# XXX TODO: Fix the double handling: telling the tree about
1701
1600
# the already known parent data is wasteful.
1861
1752
raise errors.ObjectNotLocked(self)
1863
1754
def lock_read(self):
1864
"""Lock the tree for reading.
1866
This also locks the branch, and can be unlocked via self.unlock().
1868
:return: A bzrlib.lock.LogicalLockResult.
1755
"""See Branch.lock_read, and WorkingTree.unlock."""
1870
1756
if not self.is_locked():
1871
1757
self._reset_data()
1872
1758
self.branch.lock_read()
1874
self._control_files.lock_read()
1875
return LogicalLockResult(self.unlock)
1760
return self._control_files.lock_read()
1877
1762
self.branch.unlock()
1880
1765
def lock_tree_write(self):
1881
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1883
:return: A bzrlib.lock.LogicalLockResult.
1766
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1885
1767
if not self.is_locked():
1886
1768
self._reset_data()
1887
1769
self.branch.lock_read()
1889
self._control_files.lock_write()
1890
return LogicalLockResult(self.unlock)
1771
return self._control_files.lock_write()
1892
1773
self.branch.unlock()
1895
1776
def lock_write(self):
1896
"""See MutableTree.lock_write, and WorkingTree.unlock.
1898
:return: A bzrlib.lock.LogicalLockResult.
1777
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1900
1778
if not self.is_locked():
1901
1779
self._reset_data()
1902
1780
self.branch.lock_write()
1904
self._control_files.lock_write()
1905
return LogicalLockResult(self.unlock)
1782
return self._control_files.lock_write()
1907
1784
self.branch.unlock()
1963
1836
# as commit already has that ready-to-use [while the format is the
1964
1837
# same, that is].
1966
# this double handles the inventory - unpack and repack -
1839
# this double handles the inventory - unpack and repack -
1967
1840
# but is easier to understand. We can/should put a conditional
1968
1841
# in here based on whether the inventory is in the latest format
1969
1842
# - perhaps we should repack all inventories on a repository
1971
1844
# the fast path is to copy the raw xml from the repository. If the
1972
# xml contains 'revision_id="', then we assume the right
1845
# xml contains 'revision_id="', then we assume the right
1973
1846
# revision_id is set. We must check for this full string, because a
1974
1847
# root node id can legitimately look like 'revision_id' but cannot
1975
1848
# contain a '"'.
1976
xml = self.branch.repository._get_inventory_xml(new_revision)
1849
xml = self.branch.repository.get_inventory_xml(new_revision)
1977
1850
firstline = xml.split('\n', 1)[0]
1978
if (not 'revision_id="' in firstline or
1851
if (not 'revision_id="' in firstline or
1979
1852
'format="7"' not in firstline):
1980
inv = self.branch.repository._serializer.read_inventory_from_string(
1853
inv = self.branch.repository.deserialise_inventory(
1982
1855
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1983
1856
self._write_basis_inventory(xml)
1984
1857
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1987
1860
def read_basis_inventory(self):
1988
1861
"""Read the cached basis inventory."""
1989
1862
path = self._basis_inventory_name()
1990
return self._transport.get_bytes(path)
1863
return self._control_files.get(path).read()
1992
1865
@needs_read_lock
1993
1866
def read_working_inventory(self):
1994
1867
"""Read the working inventory.
1996
1869
:raises errors.InventoryModified: read_working_inventory will fail
1997
1870
when the current in memory inventory has been modified.
1999
# conceptually this should be an implementation detail of the tree.
1872
# conceptually this should be an implementation detail of the tree.
2000
1873
# XXX: Deprecate this.
2001
1874
# ElementTree does its own conversion from UTF-8, so open in
2003
1876
if self._inventory_is_modified:
2004
1877
raise errors.InventoryModified(self)
2005
f = self._transport.get('inventory')
2007
result = self._deserialize(f)
1878
result = self._deserialize(self._control_files.get('inventory'))
2010
1879
self._set_inventory(result, dirty=False)
2028
all_files = set() # specified and nested files
2029
1898
unknown_nested_files=set()
2031
to_file = sys.stdout
2033
files_to_backup = []
2035
1900
def recurse_directory_to_add_files(directory):
2036
1901
# Recurse directory and add all files
2037
1902
# so we can check if they have changed.
2038
for parent_info, file_infos in self.walkdirs(directory):
2039
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1903
for parent_info, file_infos in\
1904
osutils.walkdirs(self.abspath(directory),
1906
for relpath, basename, kind, lstat, abspath in file_infos:
2040
1907
# Is it versioned or ignored?
2041
if self.path2id(relpath):
1908
if self.path2id(relpath) or self.is_ignored(relpath):
2042
1909
# Add nested content for deletion.
2043
all_files.add(relpath)
1910
new_files.add(relpath)
2045
# Files which are not versioned
1912
# Files which are not versioned and not ignored
2046
1913
# should be treated as unknown.
2047
files_to_backup.append(relpath)
1914
unknown_nested_files.add((relpath, None, kind))
2049
1916
for filename in files:
2050
1917
# Get file name into canonical form.
2051
1918
abspath = self.abspath(filename)
2052
1919
filename = self.relpath(abspath)
2053
1920
if len(filename) > 0:
2054
all_files.add(filename)
2055
recurse_directory_to_add_files(filename)
1921
new_files.add(filename)
1922
if osutils.isdir(abspath):
1923
recurse_directory_to_add_files(filename)
2057
files = list(all_files)
1925
files = list(new_files)
2059
1927
if len(files) == 0:
2060
1928
return # nothing to do
2065
1933
# Bail out if we are going to delete files we shouldn't
2066
1934
if not keep_files and not force:
2067
for (file_id, path, content_change, versioned, parent_id, name,
2068
kind, executable) in self.iter_changes(self.basis_tree(),
2069
include_unchanged=True, require_versioned=False,
2070
want_unversioned=True, specific_files=files):
2071
if versioned[0] == False:
2072
# The record is unknown or newly added
2073
files_to_backup.append(path[1])
2074
elif (content_change and (kind[1] is not None) and
2075
osutils.is_inside_any(files, path[1])):
2076
# Versioned and changed, but not deleted, and still
2077
# in one of the dirs to be deleted.
2078
files_to_backup.append(path[1])
2080
def backup(file_to_backup):
2081
backup_name = self.bzrdir.generate_backup_name(file_to_backup)
2082
osutils.rename(abs_path, self.abspath(backup_name))
2083
return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
2085
# Build inv_delta and delete files where applicable,
1935
has_changed_files = len(unknown_nested_files) > 0
1936
if not has_changed_files:
1937
for (file_id, path, content_change, versioned, parent_id, name,
1938
kind, executable) in self.iter_changes(self.basis_tree(),
1939
include_unchanged=True, require_versioned=False,
1940
want_unversioned=True, specific_files=files):
1941
if versioned == (False, False):
1942
# The record is unknown ...
1943
if not self.is_ignored(path[1]):
1944
# ... but not ignored
1945
has_changed_files = True
1947
elif content_change and (kind[1] != None):
1948
# Versioned and changed, but not deleted
1949
has_changed_files = True
1952
if has_changed_files:
1953
# Make delta show ALL applicable changes in error message.
1954
tree_delta = self.changes_from(self.basis_tree(),
1955
require_versioned=False, want_unversioned=True,
1956
specific_files=files)
1957
for unknown_file in unknown_nested_files:
1958
if unknown_file not in tree_delta.unversioned:
1959
tree_delta.unversioned.extend((unknown_file,))
1960
raise errors.BzrRemoveChangedFilesError(tree_delta)
1962
# Build inv_delta and delete files where applicaple,
2086
1963
# do this before any modifications to inventory.
2087
1964
for f in files:
2088
1965
fid = self.path2id(f)
2214
2088
@needs_tree_write_lock
2215
2089
def set_root_id(self, file_id):
2216
2090
"""Set the root id for this tree."""
2218
2092
if file_id is None:
2220
'WorkingTree.set_root_id with fileid=None')
2221
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)
2222
2100
self._set_root_id(file_id)
2224
2102
def _set_root_id(self, file_id):
2225
2103
"""Set the root id for this tree, in a format specific manner.
2227
: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
2228
2106
present in the current inventory or an error will occur. It must
2229
2107
not be None, but rather a valid file id.
2250
2128
def unlock(self):
2251
2129
"""See Branch.unlock.
2253
2131
WorkingTree locking just uses the Branch locking facilities.
2254
2132
This is current because all working trees have an embedded branch
2255
2133
within them. IF in the future, we were to make branch data shareable
2256
between multiple working trees, i.e. via shared storage, then we
2134
between multiple working trees, i.e. via shared storage, then we
2257
2135
would probably want to lock both the local tree, and the branch.
2259
2137
raise NotImplementedError(self.unlock)
2263
def update(self, change_reporter=None, possible_transports=None,
2264
revision=None, old_tip=_marker):
2139
def update(self, change_reporter=None, possible_transports=None):
2265
2140
"""Update a working tree along its branch.
2267
2142
This will update the branch if its bound too, which means we have
2321
2189
# cant set that until we update the working trees last revision to be
2322
2190
# one from the new branch, because it will just get absorbed by the
2323
2191
# parent de-duplication logic.
2325
2193
# We MUST save it even if an error occurs, because otherwise the users
2326
2194
# local work is unreferenced and will appear to have been lost.
2330
2198
last_rev = self.get_parent_ids()[0]
2331
2199
except IndexError:
2332
2200
last_rev = _mod_revision.NULL_REVISION
2333
if revision is None:
2334
revision = self.branch.last_revision()
2336
old_tip = old_tip or _mod_revision.NULL_REVISION
2338
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2339
# the branch we are bound to was updated
2340
# merge those changes in first
2341
base_tree = self.basis_tree()
2342
other_tree = self.branch.repository.revision_tree(old_tip)
2343
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2344
base_tree, this_tree=self,
2345
change_reporter=change_reporter)
2347
self.add_parent_tree((old_tip, other_tree))
2348
trace.note('Rerun update after fixing the conflicts.')
2351
if last_rev != _mod_revision.ensure_null(revision):
2352
# the working tree is up to date with the branch
2353
# we can merge the specified revision from master
2354
to_tree = self.branch.repository.revision_tree(revision)
2355
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.
2357
2203
basis = self.basis_tree()
2358
2204
basis.lock_read()
2360
if (basis.inventory.root is None
2361
or basis.inventory.root.file_id != to_root_id):
2362
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)
2367
# determine the branch point
2368
graph = self.branch.repository.get_graph()
2369
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2371
base_tree = self.branch.repository.revision_tree(base_rev_id)
2373
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2375
change_reporter=change_reporter)
2376
self.set_last_revision(revision)
2377
2218
# TODO - dedup parents list with things merged by pull ?
2378
2219
# reuse the tree we've updated to to set the basis:
2379
parent_trees = [(revision, to_tree)]
2220
parent_trees = [(self.branch.last_revision(), to_tree)]
2380
2221
merges = self.get_parent_ids()[1:]
2381
2222
# Ideally we ask the tree for the trees here, that way the working
2382
# 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
2383
2224
# lazy initialised tree. dirstate for instance will have the trees
2384
2225
# in ram already, whereas a last-revision + basis-inventory tree
2385
2226
# will not, but also does not need them when setting parents.
2386
2227
for parent in merges:
2387
2228
parent_trees.append(
2388
2229
(parent, self.branch.repository.revision_tree(parent)))
2389
if not _mod_revision.is_null(old_tip):
2230
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2390
2231
parent_trees.append(
2391
2232
(old_tip, self.branch.repository.revision_tree(old_tip)))
2392
2233
self.set_parent_trees(parent_trees)
2393
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)
2396
2268
def _write_hashcache_if_dirty(self):
2397
2269
"""Write out the hashcache if it is dirty."""
2595
2465
# FIXME: stash the node in pending
2596
2466
entry = inv[top_id]
2597
if entry.kind == 'directory':
2598
for name, child in entry.sorted_children():
2599
dirblock.append((relroot + name, name, child.kind, None,
2600
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
2602
2471
yield (currentdir[0], entry.file_id), dirblock
2603
2472
# push the user specified dirs from dirblock
2604
2473
for dir in reversed(dirblock):
2670
def _get_rules_searcher(self, default_searcher):
2671
"""See Tree._get_rules_searcher."""
2672
if self._rules_searcher is None:
2673
self._rules_searcher = super(WorkingTree,
2674
self)._get_rules_searcher(default_searcher)
2675
return self._rules_searcher
2677
def get_shelf_manager(self):
2678
"""Return the ShelfManager for this WorkingTree."""
2679
from bzrlib.shelf import ShelfManager
2680
return ShelfManager(self, self._transport)
2683
2521
class WorkingTree2(WorkingTree):
2684
2522
"""This is the Format 2 working tree.
2686
This was the first weave based working tree.
2524
This was the first weave based working tree.
2687
2525
- uses os locks for locking.
2688
2526
- uses the branch last-revision.
2752
2582
def _last_revision(self):
2753
2583
"""See Mutable.last_revision."""
2755
return self._transport.get_bytes('last-revision')
2585
return self._control_files.get('last-revision').read()
2756
2586
except errors.NoSuchFile:
2757
2587
return _mod_revision.NULL_REVISION
2759
2589
def _change_last_revision(self, revision_id):
2760
2590
"""See WorkingTree._change_last_revision."""
2761
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2591
if revision_id is None or revision_id == NULL_REVISION:
2763
self._transport.delete('last-revision')
2593
self._control_files._transport.delete('last-revision')
2764
2594
except errors.NoSuchFile:
2768
self._transport.put_bytes('last-revision', revision_id,
2769
mode=self.bzrdir._get_file_mode())
2598
self._control_files.put_bytes('last-revision', revision_id)
2772
def _get_check_refs(self):
2773
"""Return the references needed to perform a check of this tree."""
2774
return [('trees', self.last_revision())]
2776
2601
@needs_tree_write_lock
2777
2602
def set_conflicts(self, conflicts):
2778
self._put_rio('conflicts', conflicts.to_stanzas(),
2603
self._put_rio('conflicts', conflicts.to_stanzas(),
2779
2604
CONFLICT_HEADER_1)
2781
2606
@needs_tree_write_lock
2924
2755
"""See WorkingTreeFormat.get_format_description()."""
2925
2756
return "Working tree format 2"
2927
def _stub_initialize_on_transport(self, transport, file_mode):
2928
"""Workaround: create control files for a remote working tree.
2758
def stub_initialize_remote(self, control_files):
2759
"""As a special workaround create critical control files for a remote working tree
2930
2761
This ensures that it can later be updated and dealt with locally,
2931
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2762
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2932
2763
no working tree. (See bug #43064).
2934
2765
sio = StringIO()
2935
inv = inventory.Inventory()
2936
2767
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2938
transport.put_file('inventory', sio, file_mode)
2939
transport.put_bytes('pending-merges', '', file_mode)
2769
control_files.put('inventory', sio)
2771
control_files.put_bytes('pending-merges', '')
2941
2774
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2942
2775
accelerator_tree=None, hardlink=False):
added
removed
bzrlib/workingtree.py
