19
19
A WorkingTree represents the editable working copy of a branch.
20
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
new revision based on the workingtree and its inventory.
21
such as renaming or adding files.
25
23
At the moment every WorkingTree has its own branch. Remote
26
24
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
26
To get a WorkingTree, call controldir.open_workingtree() or
29
27
WorkingTree.open(dir).
30
from __future__ import absolute_import
33
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
39
from .lazy_import import lazy_import
38
40
lazy_import(globals(), """
39
41
from bisect import bisect_left
51
48
conflicts as _mod_conflicts,
51
filters as _mod_filters,
60
56
revision as _mod_revision,
70
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
from bzrlib import symbol_versioning
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
82
from bzrlib.lockdir import LockDir
83
import bzrlib.mutabletree
84
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
from bzrlib.osutils import (
96
from bzrlib.filters import filtered_input_file
97
from bzrlib.trace import mutter, note
98
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
100
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
107
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
CONFLICT_HEADER_1 = "BZR conflict list format 1"
68
from .decorators import needs_read_lock, needs_write_lock
69
from .i18n import gettext
70
from . import mutabletree
71
from .mutabletree import needs_tree_write_lock
75
from .trace import mutter, note
113
78
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
184
146
return views.DisabledViews(self)
186
148
def __init__(self, basedir='.',
187
branch=DEPRECATED_PARAMETER,
193
154
"""Construct a WorkingTree instance. This is not a public API.
195
156
:param branch: A branch to override probing for the branch.
197
158
self._format = _format
198
self.bzrdir = _bzrdir
159
self.controldir = _controldir
199
160
if not _internal:
200
raise errors.BzrError("Please use bzrdir.open_workingtree or "
161
raise errors.BzrError("Please use controldir.open_workingtree or "
201
162
"WorkingTree.open() to obtain a WorkingTree.")
202
basedir = safe_unicode(basedir)
163
basedir = osutils.safe_unicode(basedir)
203
164
mutter("opening working tree %r", basedir)
204
if deprecated_passed(branch):
165
if branch is not None:
205
166
self._branch = branch
207
self._branch = self.bzrdir.open_branch()
208
self.basedir = realpath(basedir)
209
# if branch is at our basedir and is a format 6 or less
210
if isinstance(self._format, WorkingTreeFormat2):
211
# share control object
212
self._control_files = self.branch.control_files
214
# assume all other formats have their own control files.
215
self._control_files = _control_files
216
self._transport = self._control_files._transport
217
# update the whole cache up front and write to disk if anything changed;
218
# in the future we might want to do this more selectively
219
# two possible ways offer themselves : in self._unlock, write the cache
220
# if needed, or, when the cache sees a change, append it to the hash
221
# cache file, and have the parser take the most recent entry for a
223
wt_trans = self.bzrdir.get_workingtree_transport(None)
224
cache_filename = wt_trans.local_abspath('stat-cache')
225
self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
self.bzrdir._get_file_mode(),
227
self._content_filter_stack_provider())
230
# is this scan needed ? it makes things kinda slow.
237
if _inventory is None:
238
# This will be acquired on lock_read() or lock_write()
239
self._inventory_is_modified = False
240
self._inventory = None
242
# the caller of __init__ has provided an inventory,
243
# we assume they know what they are doing - as its only
244
# the Format factory and creation methods that are
245
# permitted to do this.
246
self._set_inventory(_inventory, dirty=False)
247
self._detect_case_handling()
168
self._branch = self.controldir.open_branch()
169
self.basedir = osutils.realpath(basedir)
170
self._transport = _transport
248
171
self._rules_searcher = None
249
172
self.views = self._make_views()
252
175
def user_transport(self):
253
return self.bzrdir.user_transport
176
return self.controldir.user_transport
256
179
def control_transport(self):
257
180
return self._transport
259
def _detect_case_handling(self):
260
wt_trans = self.bzrdir.get_workingtree_transport(None)
262
wt_trans.stat("FoRMaT")
263
except errors.NoSuchFile:
264
self.case_sensitive = True
266
self.case_sensitive = False
268
self._setup_directory_is_tree_reference()
182
def is_control_filename(self, filename):
183
"""True if filename is the name of a control file in this tree.
185
:param filename: A filename within the tree. This is a relative path
186
from the root of this tree.
188
This is true IF and ONLY IF the filename is part of the meta data
189
that bzr controls in this tree. I.E. a random .bzr directory placed
190
on disk will not be a control file for this tree.
192
return self.controldir.is_control_filename(filename)
270
194
branch = property(
271
195
fget=lambda self: self._branch,
348
266
path = osutils.getcwd()
349
control, relpath = bzrdir.BzrDir.open_containing(path)
267
control, relpath = controldir.ControlDir.open_containing(path)
351
268
return control.open_workingtree(), relpath
271
def open_containing_paths(file_list, default_directory=None,
272
canonicalize=True, apply_view=True):
273
"""Open the WorkingTree that contains a set of paths.
275
Fail if the paths given are not all in a single tree.
277
This is used for the many command-line interfaces that take a list of
278
any number of files and that require they all be in the same tree.
280
if default_directory is None:
281
default_directory = u'.'
282
# recommended replacement for builtins.internal_tree_files
283
if file_list is None or len(file_list) == 0:
284
tree = WorkingTree.open_containing(default_directory)[0]
285
# XXX: doesn't really belong here, and seems to have the strange
286
# side effect of making it return a bunch of files, not the whole
287
# tree -- mbp 20100716
288
if tree.supports_views() and apply_view:
289
view_files = tree.views.lookup_view()
291
file_list = view_files
292
view_str = views.view_display_str(view_files)
293
note(gettext("Ignoring files outside view. View is %s") % view_str)
294
return tree, file_list
295
if default_directory == u'.':
298
seed = default_directory
299
file_list = [osutils.pathjoin(default_directory, f)
301
tree = WorkingTree.open_containing(seed)[0]
302
return tree, tree.safe_relpath_files(file_list, canonicalize,
303
apply_view=apply_view)
305
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
306
"""Convert file_list into a list of relpaths in tree.
308
:param self: A tree to operate on.
309
:param file_list: A list of user provided paths or None.
310
:param apply_view: if True and a view is set, apply it or check that
311
specified files are within it
312
:return: A list of relative paths.
313
:raises errors.PathNotChild: When a provided path is in a different self
316
if file_list is None:
318
if self.supports_views() and apply_view:
319
view_files = self.views.lookup_view()
323
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
324
# doesn't - fix that up here before we enter the loop.
326
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
329
for filename in file_list:
330
relpath = fixer(osutils.dereference_path(filename))
331
if view_files and not osutils.is_inside_any(view_files, relpath):
332
raise errors.FileOutsideView(filename, view_files)
333
new_list.append(relpath)
354
337
def open_downlevel(path=None):
355
338
"""Open an unsupported working tree.
357
Only intended for advanced situations like upgrading part of a bzrdir.
340
Only intended for advanced situations like upgrading part of a controldir.
359
342
return WorkingTree.open(path, _unsupported=True)
362
345
def find_trees(location):
363
346
def list_current(transport):
364
return [d for d in transport.list_dir('') if d != '.bzr']
365
def evaluate(bzrdir):
347
return [d for d in transport.list_dir('')
348
if not controldir.is_control_filename(d)]
349
def evaluate(controldir):
367
tree = bzrdir.open_workingtree()
351
tree = controldir.open_workingtree()
368
352
except errors.NoWorkingTree:
369
353
return True, None
371
355
return True, tree
372
transport = get_transport(location)
373
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
356
t = transport.get_transport(location)
357
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
374
358
list_current=list_current)
375
return [t for t in iterator if t is not None]
377
# should be deprecated - this is slow and in any case treating them as a
378
# container is (we now know) bad style -- mbp 20070302
379
## @deprecated_method(zero_fifteen)
381
"""Iterate through file_ids for this tree.
383
file_ids are in a WorkingTree if they are in the working inventory
384
and the working file exists.
386
inv = self._inventory
387
for path, ie in inv.iter_entries():
388
if osutils.lexists(self.abspath(path)):
391
def all_file_ids(self):
392
"""See Tree.iter_all_file_ids"""
393
return set(self.inventory)
359
return [tr for tr in iterator if tr is not None]
395
361
def __repr__(self):
396
362
return "<%s of %s>" % (self.__class__.__name__,
397
363
getattr(self, 'basedir', None))
399
365
def abspath(self, filename):
400
return pathjoin(self.basedir, filename)
366
return osutils.pathjoin(self.basedir, filename)
402
368
def basis_tree(self):
403
369
"""Return RevisionTree for the current last revision.
486
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
487
"""See Tree.annotate_iter
489
This implementation will use the basis tree implementation if possible.
490
Lines not in the basis are attributed to CURRENT_REVISION
492
If there are pending merges, lines added by those merges will be
493
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
533
def _get_ancestors(self, default_revision):
534
ancestors = set([default_revision])
535
for parent_id in self.get_parent_ids():
536
ancestors.update(self.branch.repository.get_ancestry(
537
parent_id, topo_sorted=False))
540
455
def get_parent_ids(self):
541
456
"""See Tree.get_parent_ids.
596
506
# TODO now merge from tree.last_revision to revision (to preserve
597
507
# user local changes)
598
merge.transform_tree(tree, self)
599
tree.set_parent_ids([revision_id])
509
other_tree = self.revision_tree(revision_id)
510
except errors.NoSuchRevision:
511
other_tree = self.branch.repository.revision_tree(revision_id)
513
merge.transform_tree(tree, other_tree)
514
if revision_id == _mod_revision.NULL_REVISION:
517
new_parents = [revision_id]
518
tree.set_parent_ids(new_parents)
601
520
def id2abspath(self, file_id):
602
521
return self.abspath(self.id2path(file_id))
604
def has_id(self, file_id):
605
# files that have been deleted are excluded
607
if not inv.has_id(file_id):
609
path = inv.id2path(file_id)
610
return osutils.lexists(self.abspath(path))
612
def has_or_had_id(self, file_id):
613
if file_id == self.inventory.root.file_id:
615
return self.inventory.has_id(file_id)
617
__contains__ = has_id
619
523
def get_file_size(self, file_id):
620
524
"""See Tree.get_file_size"""
621
525
# XXX: this returns the on-disk size; it should probably return the
624
528
return os.path.getsize(self.id2abspath(file_id))
626
530
if e.errno != errno.ENOENT:
632
def get_file_sha1(self, file_id, path=None, stat_value=None):
634
path = self._inventory.id2path(file_id)
635
return self._hashcache.get_sha1(path, stat_value)
637
def get_file_mtime(self, file_id, path=None):
639
path = self.inventory.id2path(file_id)
640
return os.lstat(self.abspath(path)).st_mtime
642
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
file_id = self.path2id(path)
645
# For unversioned files on win32, we just assume they are not
648
return self._inventory[file_id].executable
650
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
mode = stat_result.st_mode
652
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
654
if not supports_executable():
655
def is_executable(self, file_id, path=None):
656
return self._inventory[file_id].executable
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_basis
661
def is_executable(self, file_id, path=None):
663
path = self.id2path(file_id)
664
mode = os.lstat(self.abspath(path)).st_mode
665
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
667
_is_executable_from_path_and_stat = \
668
_is_executable_from_path_and_stat_from_stat
670
@needs_tree_write_lock
671
def _add(self, files, ids, kinds):
672
"""See MutableTree._add."""
673
# TODO: Re-adding a file that is removed in the working copy
674
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
676
# function - they should be part of lock_write and unlock.
678
for f, file_id, kind in zip(files, ids, kinds):
680
inv.add_path(f, kind=kind)
682
inv.add_path(f, kind=kind, file_id=file_id)
683
self._inventory_is_modified = True
685
535
@needs_tree_write_lock
686
536
def _gather_kinds(self, files, kinds):
687
537
"""See MutableTree._gather_kinds."""
688
538
for pos, f in enumerate(files):
689
539
if kinds[pos] is None:
690
fullpath = normpath(self.abspath(f))
540
fullpath = osutils.normpath(self.abspath(f))
692
kinds[pos] = file_kind(fullpath)
542
kinds[pos] = osutils.file_kind(fullpath)
694
544
if e.errno == errno.ENOENT:
695
545
raise errors.NoSuchFile(fullpath)
990
780
self.add(path, file_id, 'directory')
993
def get_symlink_target(self, file_id):
994
abspath = self.id2abspath(file_id)
783
def get_symlink_target(self, file_id, path=None):
785
abspath = self.abspath(path)
787
abspath = self.id2abspath(file_id)
995
788
target = osutils.readlink(abspath)
999
791
def subsume(self, other_tree):
1000
def add_children(inventory, entry):
1001
for child_entry in entry.children.values():
1002
inventory._byid[child_entry.file_id] = child_entry
1003
if child_entry.kind == 'directory':
1004
add_children(inventory, child_entry)
1005
if other_tree.get_root_id() == self.get_root_id():
1006
raise errors.BadSubsumeSource(self, other_tree,
1007
'Trees have the same root')
1009
other_tree_path = self.relpath(other_tree.basedir)
1010
except errors.PathNotChild:
1011
raise errors.BadSubsumeSource(self, other_tree,
1012
'Tree is not contained by the other')
1013
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1014
if new_root_parent is None:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Parent directory is not versioned.')
1017
# We need to ensure that the result of a fetch will have a
1018
# versionedfile for the other_tree root, and only fetching into
1019
# RepositoryKnit2 guarantees that.
1020
if not self.branch.repository.supports_rich_root():
1021
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1022
other_tree.lock_tree_write()
1024
new_parents = other_tree.get_parent_ids()
1025
other_root = other_tree.inventory.root
1026
other_root.parent_id = new_root_parent
1027
other_root.name = osutils.basename(other_tree_path)
1028
self.inventory.add(other_root)
1029
add_children(self.inventory, other_root)
1030
self._write_inventory(self.inventory)
1031
# normally we don't want to fetch whole repositories, but i think
1032
# here we really do want to consolidate the whole thing.
1033
for parent_id in other_tree.get_parent_ids():
1034
self.branch.fetch(other_tree.branch, parent_id)
1035
self.add_parent_tree_id(parent_id)
1038
other_tree.bzrdir.retire_bzrdir()
792
raise NotImplementedError(self.subsume)
1040
794
def _setup_directory_is_tree_reference(self):
1041
795
if self._branch.repository._format.supports_tree_reference:
1063
817
# checkout in a subdirectory. This can be avoided by not adding
1064
818
# it. mbp 20070306
1066
@needs_tree_write_lock
1067
820
def extract(self, file_id, format=None):
1068
821
"""Extract a subtree from this tree.
1070
823
A new branch will be created, relative to the path for this tree.
1074
segments = osutils.splitpath(path)
1075
transport = self.branch.bzrdir.root_transport
1076
for name in segments:
1077
transport = transport.clone(name)
1078
transport.ensure_base()
1081
sub_path = self.id2path(file_id)
1082
branch_transport = mkdirs(sub_path)
1084
format = self.bzrdir.cloning_metadir()
1085
branch_transport.ensure_base()
1086
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
repo = branch_bzrdir.find_repository()
1089
except errors.NoRepositoryPresent:
1090
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
1093
new_branch = branch_bzrdir.create_branch()
1094
new_branch.pull(self.branch)
1095
for parent_id in self.get_parent_ids():
1096
new_branch.fetch(self.branch, parent_id)
1097
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
if tree_transport.base != branch_transport.base:
1099
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1103
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1105
wt.set_parent_ids(self.get_parent_ids())
1106
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1108
new_root = my_inv[file_id]
1109
my_inv.remove_recursive_id(file_id)
1110
new_root.parent_id = None
1111
child_inv.add(new_root)
1112
self._write_inventory(my_inv)
1113
wt._write_inventory(child_inv)
1116
def _serialize(self, inventory, out_file):
1117
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1120
def _deserialize(selt, in_file):
1121
return xml5.serializer_v5.read_inventory(in_file)
825
raise NotImplementedError(self.extract)
1123
827
def flush(self):
1124
"""Write the in memory inventory to disk."""
1125
# TODO: Maybe this should only write on dirty ?
1126
if self._control_files._lock_mode != 'w':
1127
raise errors.NotWriteLocked(self)
1129
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1133
self._inventory_is_modified = False
828
"""Write the in memory meta data to disk."""
829
raise NotImplementedError(self.flush)
1135
831
def _kind(self, relpath):
1136
832
return osutils.file_kind(self.abspath(relpath))
1146
842
:param from_dir: start from this directory or None for the root
1147
843
:param recursive: whether to recurse into subdirectories or not
1149
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
# with it. So callers should be careful to always read_lock the tree.
1151
if not self.is_locked():
1152
raise errors.ObjectNotLocked(self)
1154
inv = self.inventory
1155
if from_dir is None and include_root is True:
1156
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
# Convert these into local objects to save lookup times
1158
pathjoin = osutils.pathjoin
1159
file_kind = self._kind
1161
# transport.base ends in a slash, we want the piece
1162
# between the last two slashes
1163
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1165
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
# use a deque and popleft to keep them sorted, or if we use a plain
1181
# list and just reverse() them.
1182
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1185
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1188
f = children.popleft()
1189
## TODO: If we find a subdirectory with its own .bzr
1190
## directory, then that is a separate tree and we
1191
## should exclude it.
1193
# the bzrdir for this tree
1194
if transport_base_dir == f:
1197
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1198
# and 'f' doesn't begin with one, we can do a string op, rather
1199
# than the checks of pathjoin(), all relative paths will have an extra slash
1201
fp = from_dir_relpath + '/' + f
1204
fap = from_dir_abspath + '/' + f
1206
f_ie = inv.get_child(from_dir_id, f)
1209
elif self.is_ignored(fp[1:]):
1212
# we may not have found this file, because of a unicode issue
1213
f_norm, can_access = osutils.normalized_filename(f)
1214
if f == f_norm or not can_access:
1215
# No change, so treat this file normally
1218
# this file can be accessed by a normalized path
1219
# check again if it is versioned
1220
# these lines are repeated here for performance
1222
fp = from_dir_relpath + '/' + f
1223
fap = from_dir_abspath + '/' + f
1224
f_ie = inv.get_child(from_dir_id, f)
1227
elif self.is_ignored(fp[1:]):
1234
# make a last minute entry
1236
yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
yield fp[1:], c, fk, None, fk_entries[fk]()
1241
yield fp[1:], c, fk, None, TreeEntry()
1244
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1257
# if we finished all children, pop it off the stack
1260
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
845
raise NotImplementedError(self.list_files)
847
def move(self, from_paths, to_dir=None, after=False):
1262
848
"""Rename files.
1264
to_dir must exist in the inventory.
850
to_dir must be known to the working tree.
1266
852
If to_dir exists and is a directory, the files are moved into
1267
853
it, keeping their old names.
1293
878
This returns a list of (from_path, to_path) pairs for each
1294
879
entry that is moved.
1299
# check for deprecated use of signature
1301
to_dir = kwargs.get('to_name', None)
1303
raise TypeError('You must supply a target directory')
1305
symbol_versioning.warn('The parameter to_name was deprecated'
1306
' in version 0.13. Use to_dir instead',
1309
# check destination directory
1310
if isinstance(from_paths, basestring):
1312
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
1314
if not isdir(to_abs):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotADirectory(to_abs))
1317
if not self.has_filename(to_dir):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotInWorkingDirectory(to_dir))
1320
to_dir_id = inv.path2id(to_dir)
1321
if to_dir_id is None:
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotVersionedError(path=str(to_dir)))
1325
to_dir_ie = inv[to_dir_id]
1326
if to_dir_ie.kind != 'directory':
1327
raise errors.BzrMoveFailedError('',to_dir,
1328
errors.NotADirectory(to_abs))
1330
# create rename entries and tuples
1331
for from_rel in from_paths:
1332
from_tail = splitpath(from_rel)[-1]
1333
from_id = inv.path2id(from_rel)
1335
raise errors.BzrMoveFailedError(from_rel,to_dir,
1336
errors.NotVersionedError(path=str(from_rel)))
1338
from_entry = inv[from_id]
1339
from_parent_id = from_entry.parent_id
1340
to_rel = pathjoin(to_dir, from_tail)
1341
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1343
from_tail=from_tail,
1344
from_parent_id=from_parent_id,
1345
to_rel=to_rel, to_tail=from_tail,
1346
to_parent_id=to_dir_id)
1347
rename_entries.append(rename_entry)
1348
rename_tuples.append((from_rel, to_rel))
1350
# determine which move mode to use. checks also for movability
1351
rename_entries = self._determine_mv_mode(rename_entries, after)
1353
original_modified = self._inventory_is_modified
1356
self._inventory_is_modified = True
1357
self._move(rename_entries)
1359
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
1362
self._write_inventory(inv)
1363
return rename_tuples
1365
def _determine_mv_mode(self, rename_entries, after=False):
1366
"""Determines for each from-to pair if both inventory and working tree
1367
or only the inventory has to be changed.
1369
Also does basic plausability tests.
1371
inv = self.inventory
1373
for rename_entry in rename_entries:
1374
# store to local variables for easier reference
1375
from_rel = rename_entry.from_rel
1376
from_id = rename_entry.from_id
1377
to_rel = rename_entry.to_rel
1378
to_id = inv.path2id(to_rel)
1379
only_change_inv = False
1381
# check the inventory for source and destination
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(from_rel)))
1385
if to_id is not None:
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.AlreadyVersionedError(path=str(to_rel)))
1389
# try to determine the mode for rename (only change inv or change
1390
# inv and file system)
1392
if not self.has_filename(to_rel):
1393
raise errors.BzrMoveFailedError(from_id,to_rel,
1394
errors.NoSuchFile(path=str(to_rel),
1395
extra="New file has not been created yet"))
1396
only_change_inv = True
1397
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1398
only_change_inv = True
1399
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
only_change_inv = False
1401
elif (not self.case_sensitive
1402
and from_rel.lower() == to_rel.lower()
1403
and self.has_filename(from_rel)):
1404
only_change_inv = False
1406
# something is wrong, so lets determine what exactly
1407
if not self.has_filename(from_rel) and \
1408
not self.has_filename(to_rel):
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.PathsDoNotExist(paths=(str(from_rel),
1413
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1414
rename_entry.only_change_inv = only_change_inv
1415
return rename_entries
1417
def _move(self, rename_entries):
1418
"""Moves a list of files.
1420
Depending on the value of the flag 'only_change_inv', the
1421
file will be moved on the file system or not.
1423
inv = self.inventory
1426
for entry in rename_entries:
1428
self._move_entry(entry)
1430
self._rollback_move(moved)
1434
def _rollback_move(self, moved):
1435
"""Try to rollback a previous move in case of an filesystem error."""
1436
inv = self.inventory
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1441
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
entry.from_tail, entry.from_parent_id,
1443
entry.only_change_inv))
1444
except errors.BzrMoveFailedError, e:
1445
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1446
" The working tree is in an inconsistent state."
1447
" Please consider doing a 'bzr revert'."
1448
" Error message is: %s" % e)
1450
def _move_entry(self, entry):
1451
inv = self.inventory
1452
from_rel_abs = self.abspath(entry.from_rel)
1453
to_rel_abs = self.abspath(entry.to_rel)
1454
if from_rel_abs == to_rel_abs:
1455
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1456
"Source and target are identical.")
1458
if not entry.only_change_inv:
1460
osutils.rename(from_rel_abs, to_rel_abs)
1462
raise errors.BzrMoveFailedError(entry.from_rel,
1464
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
881
raise NotImplementedError(self.move)
1466
883
@needs_tree_write_lock
1467
884
def rename_one(self, from_rel, to_rel, after=False):
1488
904
Everything else results in an error.
1490
inv = self.inventory
1493
# create rename entries and tuples
1494
from_tail = splitpath(from_rel)[-1]
1495
from_id = inv.path2id(from_rel)
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1508
from_parent_id = from_entry.parent_id
1509
to_dir, to_tail = os.path.split(to_rel)
1510
to_dir_id = inv.path2id(to_dir)
1511
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1513
from_tail=from_tail,
1514
from_parent_id=from_parent_id,
1515
to_rel=to_rel, to_tail=to_tail,
1516
to_parent_id=to_dir_id)
1517
rename_entries.append(rename_entry)
1519
# determine which move mode to use. checks also for movability
1520
rename_entries = self._determine_mv_mode(rename_entries, after)
1522
# check if the target changed directory and if the target directory is
1524
if to_dir_id is None:
1525
raise errors.BzrMoveFailedError(from_rel,to_rel,
1526
errors.NotVersionedError(path=str(to_dir)))
1528
# all checks done. now we can continue with our actual work
1529
mutter('rename_one:\n'
1534
' to_dir_id {%s}\n',
1535
from_id, from_rel, to_rel, to_dir, to_dir_id)
1537
self._move(rename_entries)
1538
self._write_inventory(inv)
1540
class _RenameEntry(object):
1541
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1542
to_rel, to_tail, to_parent_id, only_change_inv=False):
1543
self.from_rel = from_rel
1544
self.from_id = from_id
1545
self.from_tail = from_tail
1546
self.from_parent_id = from_parent_id
1547
self.to_rel = to_rel
1548
self.to_tail = to_tail
1549
self.to_parent_id = to_parent_id
1550
self.only_change_inv = only_change_inv
906
raise NotImplementedError(self.rename_one)
1552
908
@needs_read_lock
1553
909
def unknowns(self):
1792
1100
return _mod_revision.ensure_null(self.branch.last_revision())
1794
1102
def is_locked(self):
1795
return self._control_files.is_locked()
1797
def _must_be_locked(self):
1798
if not self.is_locked():
1799
raise errors.ObjectNotLocked(self)
1103
"""Check if this tree is locked."""
1104
raise NotImplementedError(self.is_locked)
1801
1106
def lock_read(self):
1802
1107
"""Lock the tree for reading.
1804
1109
This also locks the branch, and can be unlocked via self.unlock().
1806
:return: A bzrlib.lock.LogicalLockResult.
1111
:return: A breezy.lock.LogicalLockResult.
1808
if not self.is_locked():
1810
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1815
self.branch.unlock()
1113
raise NotImplementedError(self.lock_read)
1818
1115
def lock_tree_write(self):
1819
1116
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1118
:return: A breezy.lock.LogicalLockResult.
1823
if not self.is_locked():
1825
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1830
self.branch.unlock()
1120
raise NotImplementedError(self.lock_tree_write)
1833
1122
def lock_write(self):
1834
1123
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1125
:return: A breezy.lock.LogicalLockResult.
1838
if not self.is_locked():
1840
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1845
self.branch.unlock()
1127
raise NotImplementedError(self.lock_write)
1848
1129
def get_physical_lock_status(self):
1849
return self._control_files.get_physical_lock_status()
1851
def _basis_inventory_name(self):
1852
return 'basis-inventory-cache'
1854
def _reset_data(self):
1855
"""Reset transient data that cannot be revalidated."""
1856
self._inventory_is_modified = False
1857
f = self._transport.get('inventory')
1859
result = self._deserialize(f)
1862
self._set_inventory(result, dirty=False)
1864
@needs_tree_write_lock
1130
raise NotImplementedError(self.get_physical_lock_status)
1865
1132
def set_last_revision(self, new_revision):
1866
1133
"""Change the last revision in the working tree."""
1867
if self._change_last_revision(new_revision):
1868
self._cache_basis_inventory(new_revision)
1134
raise NotImplementedError(self.set_last_revision)
1870
1136
def _change_last_revision(self, new_revision):
1871
1137
"""Template method part of set_last_revision to perform the change.
1874
1140
when their last revision is set.
1876
1142
if _mod_revision.is_null(new_revision):
1877
self.branch.set_revision_history([])
1143
self.branch.set_last_revision_info(0, new_revision)
1145
_mod_revision.check_not_reserved_id(new_revision)
1880
1147
self.branch.generate_revision_history(new_revision)
1881
1148
except errors.NoSuchRevision:
1882
1149
# not present in the repo - dont try to set it deeper than the tip
1883
self.branch.set_revision_history([new_revision])
1150
self.branch._set_revision_history([new_revision])
1886
def _write_basis_inventory(self, xml):
1887
"""Write the basis inventory XML to the basis-inventory file"""
1888
path = self._basis_inventory_name()
1890
self._transport.put_file(path, sio,
1891
mode=self.bzrdir._get_file_mode())
1893
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
"""Create the text that will be saved in basis-inventory"""
1895
inventory.revision_id = revision_id
1896
return xml7.serializer_v7.write_inventory_to_string(inventory)
1898
def _cache_basis_inventory(self, new_revision):
1899
"""Cache new_revision as the basis inventory."""
1900
# TODO: this should allow the ready-to-use inventory to be passed in,
1901
# as commit already has that ready-to-use [while the format is the
1904
# this double handles the inventory - unpack and repack -
1905
# but is easier to understand. We can/should put a conditional
1906
# in here based on whether the inventory is in the latest format
1907
# - perhaps we should repack all inventories on a repository
1909
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1911
# revision_id is set. We must check for this full string, because a
1912
# root node id can legitimately look like 'revision_id' but cannot
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1915
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1917
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1920
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
self._write_basis_inventory(xml)
1922
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
def read_basis_inventory(self):
1926
"""Read the cached basis inventory."""
1927
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1931
def read_working_inventory(self):
1932
"""Read the working inventory.
1934
:raises errors.InventoryModified: read_working_inventory will fail
1935
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1938
# XXX: Deprecate this.
1939
# ElementTree does its own conversion from UTF-8, so open in
1941
if self._inventory_is_modified:
1942
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1948
self._set_inventory(result, dirty=False)
1951
1153
@needs_tree_write_lock
1952
1154
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1954
"""Remove nominated files from the working inventory.
1156
"""Remove nominated files from the working tree metadata.
1956
1158
:files: File paths relative to the basedir.
1957
1159
:keep_files: If true, the files will also be kept.
1958
1160
:force: Delete files and directories, even if they are changed and
1959
1161
even if the directories are not empty.
1961
if isinstance(files, basestring):
1163
if isinstance(files, (str, text_type)):
1962
1164
files = [files]
1168
all_files = set() # specified and nested files
1967
1169
unknown_nested_files=set()
1968
1170
if to_file is None:
1969
1171
to_file = sys.stdout
1173
files_to_backup = []
1971
1175
def recurse_directory_to_add_files(directory):
1972
1176
# Recurse directory and add all files
1973
1177
# so we can check if they have changed.
1974
1178
for parent_info, file_infos in self.walkdirs(directory):
1975
1179
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
1180
# Is it versioned or ignored?
1977
if self.path2id(relpath) or self.is_ignored(relpath):
1181
if self.path2id(relpath):
1978
1182
# Add nested content for deletion.
1979
new_files.add(relpath)
1183
all_files.add(relpath)
1981
# Files which are not versioned and not ignored
1185
# Files which are not versioned
1982
1186
# should be treated as unknown.
1983
unknown_nested_files.add((relpath, None, kind))
1187
files_to_backup.append(relpath)
1985
1189
for filename in files:
1986
1190
# Get file name into canonical form.
1987
1191
abspath = self.abspath(filename)
1988
1192
filename = self.relpath(abspath)
1989
1193
if len(filename) > 0:
1990
new_files.add(filename)
1194
all_files.add(filename)
1991
1195
recurse_directory_to_add_files(filename)
1993
files = list(new_files)
1197
files = list(all_files)
1995
1199
if len(files) == 0:
1996
1200
return # nothing to do
2001
1205
# Bail out if we are going to delete files we shouldn't
2002
1206
if not keep_files and not force:
2003
has_changed_files = len(unknown_nested_files) > 0
2004
if not has_changed_files:
2005
for (file_id, path, content_change, versioned, parent_id, name,
2006
kind, executable) in self.iter_changes(self.basis_tree(),
2007
include_unchanged=True, require_versioned=False,
2008
want_unversioned=True, specific_files=files):
2009
if versioned == (False, False):
2010
# The record is unknown ...
2011
if not self.is_ignored(path[1]):
2012
# ... but not ignored
2013
has_changed_files = True
2015
elif (content_change and (kind[1] is not None) and
2016
osutils.is_inside_any(files, path[1])):
2017
# Versioned and changed, but not deleted, and still
2018
# in one of the dirs to be deleted.
2019
has_changed_files = True
1207
for (file_id, path, content_change, versioned, parent_id, name,
1208
kind, executable) in self.iter_changes(self.basis_tree(),
1209
include_unchanged=True, require_versioned=False,
1210
want_unversioned=True, specific_files=files):
1211
if versioned[0] == False:
1212
# The record is unknown or newly added
1213
files_to_backup.append(path[1])
1214
elif (content_change and (kind[1] is not None) and
1215
osutils.is_inside_any(files, path[1])):
1216
# Versioned and changed, but not deleted, and still
1217
# in one of the dirs to be deleted.
1218
files_to_backup.append(path[1])
2022
if has_changed_files:
2023
# Make delta show ALL applicable changes in error message.
2024
tree_delta = self.changes_from(self.basis_tree(),
2025
require_versioned=False, want_unversioned=True,
2026
specific_files=files)
2027
for unknown_file in unknown_nested_files:
2028
if unknown_file not in tree_delta.unversioned:
2029
tree_delta.unversioned.extend((unknown_file,))
2030
raise errors.BzrRemoveChangedFilesError(tree_delta)
1220
def backup(file_to_backup):
1221
backup_name = self.controldir._available_backup_name(file_to_backup)
1222
osutils.rename(abs_path, self.abspath(backup_name))
1223
return "removed %s (but kept a copy: %s)" % (file_to_backup,
2032
1226
# Build inv_delta and delete files where applicable,
2033
# do this before any modifications to inventory.
1227
# do this before any modifications to meta data.
2034
1228
for f in files:
2035
1229
fid = self.path2id(f)
2107
1299
basis_tree.unlock()
2108
1300
return conflicts
1303
def store_uncommitted(self):
1304
"""Store uncommitted changes from the tree in the branch."""
1305
target_tree = self.basis_tree()
1306
shelf_creator = shelf.ShelfCreator(self, target_tree)
1308
if not shelf_creator.shelve_all():
1310
self.branch.store_uncommitted(shelf_creator)
1311
shelf_creator.transform()
1313
shelf_creator.finalize()
1314
note('Uncommitted changes stored in branch "%s".', self.branch.nick)
1317
def restore_uncommitted(self):
1318
"""Restore uncommitted changes from the branch into the tree."""
1319
unshelver = self.branch.get_unshelver(self)
1320
if unshelver is None:
1323
merger = unshelver.make_merger()
1324
merger.ignore_zero = True
1326
self.branch.store_uncommitted(None)
1328
unshelver.finalize()
2110
1330
def revision_tree(self, revision_id):
2111
1331
"""See Tree.revision_tree.
2113
1333
WorkingTree can supply revision_trees for the basis revision only
2114
1334
because there is only one cached inventory in the bzr directory.
2116
if revision_id == self.last_revision():
2118
xml = self.read_basis_inventory()
2119
except errors.NoSuchFile:
2123
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2124
# dont use the repository revision_tree api because we want
2125
# to supply the inventory.
2126
if inv.revision_id == revision_id:
2127
return revisiontree.RevisionTree(self.branch.repository,
2129
except errors.BadInventoryFormat:
2131
# raise if there was no inventory, or if we read the wrong inventory.
2132
raise errors.NoSuchRevisionInTree(self, revision_id)
2134
# XXX: This method should be deprecated in favour of taking in a proper
2135
# new Inventory object.
2136
@needs_tree_write_lock
2137
def set_inventory(self, new_inventory_list):
2138
from bzrlib.inventory import (Inventory,
2142
inv = Inventory(self.get_root_id())
2143
for path, file_id, parent, kind in new_inventory_list:
2144
name = os.path.basename(path)
2147
# fixme, there should be a factory function inv,add_??
2148
if kind == 'directory':
2149
inv.add(InventoryDirectory(file_id, name, parent))
2150
elif kind == 'file':
2151
inv.add(InventoryFile(file_id, name, parent))
2152
elif kind == 'symlink':
2153
inv.add(InventoryLink(file_id, name, parent))
2155
raise errors.BzrError("unknown kind %r" % kind)
2156
self._write_inventory(inv)
1336
raise NotImplementedError(self.revision_tree)
2158
1338
@needs_tree_write_lock
2159
1339
def set_root_id(self, file_id):
2337
1503
last_rev = parent_trees[0][0]
2338
1504
return nb_conflicts
2340
def _write_hashcache_if_dirty(self):
2341
"""Write out the hashcache if it is dirty."""
2342
if self._hashcache.needs_write:
2344
self._hashcache.write()
2346
if e.errno not in (errno.EPERM, errno.EACCES):
2348
# TODO: jam 20061219 Should this be a warning? A single line
2349
# warning might be sufficient to let the user know what
2351
mutter('Could not write hashcache for %s\nError: %s',
2352
self._hashcache.cache_file_name(), e)
2354
@needs_tree_write_lock
2355
def _write_inventory(self, inv):
2356
"""Write inventory as the current inventory."""
2357
self._set_inventory(inv, dirty=True)
2360
1506
def set_conflicts(self, arg):
2361
1507
raise errors.UnsupportedOperation(self.set_conflicts, self)
2363
1509
def add_conflicts(self, arg):
2364
1510
raise errors.UnsupportedOperation(self.add_conflicts, self)
2367
1512
def conflicts(self):
2368
conflicts = _mod_conflicts.ConflictList()
2369
for conflicted in self._iter_conflicts():
2372
if file_kind(self.abspath(conflicted)) != "file":
2374
except errors.NoSuchFile:
2377
for suffix in ('.THIS', '.OTHER'):
2379
kind = file_kind(self.abspath(conflicted+suffix))
2382
except errors.NoSuchFile:
2386
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2387
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2389
file_id=self.path2id(conflicted)))
1513
raise NotImplementedError(self.conflicts)
2392
1515
def walkdirs(self, prefix=""):
2393
1516
"""Walk the directories of this tree.
2502
1625
raise NotImplementedError('unreachable code')
2503
1626
yield current_inv[0], dirblock
2505
current_inv = inventory_iterator.next()
1628
current_inv = next(inventory_iterator)
2506
1629
except StopIteration:
2507
1630
inv_finished = True
2509
current_disk = disk_iterator.next()
1632
current_disk = next(disk_iterator)
2510
1633
except StopIteration:
2511
1634
disk_finished = True
2513
1636
def _walkdirs(self, prefix=""):
2514
1637
"""Walk the directories of this tree.
2516
:prefix: is used as the directrory to start with.
2517
returns a generator which yields items in the form:
2518
((curren_directory_path, fileid),
2519
[(file1_path, file1_name, file1_kind, None, file1_id,
1639
:param prefix: is used as the directrory to start with.
1640
:returns: a generator which yields items in the form::
1642
((curren_directory_path, fileid),
1643
[(file1_path, file1_name, file1_kind, None, file1_id,
2522
_directory = 'directory'
2523
# get the root in the inventory
2524
inv = self.inventory
2525
top_id = inv.path2id(prefix)
2529
pending = [(prefix, '', _directory, None, top_id, None)]
2532
currentdir = pending.pop()
2533
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2534
top_id = currentdir[4]
2536
relroot = currentdir[0] + '/'
2539
# FIXME: stash the node in pending
2541
if entry.kind == 'directory':
2542
for name, child in entry.sorted_children():
2543
dirblock.append((relroot + name, name, child.kind, None,
2544
child.file_id, child.kind
2546
yield (currentdir[0], entry.file_id), dirblock
2547
# push the user specified dirs from dirblock
2548
for dir in reversed(dirblock):
2549
if dir[2] == _directory:
1646
raise NotImplementedError(self._walkdirs)
2552
1648
@needs_tree_write_lock
2553
1649
def auto_resolve(self):
2621
1711
def get_shelf_manager(self):
2622
1712
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
1713
from .shelf import ShelfManager
2624
1714
return ShelfManager(self, self._transport)
2627
class WorkingTree2(WorkingTree):
2628
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
2631
- uses os locks for locking.
2632
- uses the branch last-revision.
2635
def __init__(self, *args, **kwargs):
2636
super(WorkingTree2, self).__init__(*args, **kwargs)
2637
# WorkingTree2 has more of a constraint that self._inventory must
2638
# exist. Because this is an older format, we don't mind the overhead
2639
# caused by the extra computation here.
2641
# Newer WorkingTree's should only have self._inventory set when they
2643
if self._inventory is None:
2644
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
2650
def lock_tree_write(self):
2651
"""See WorkingTree.lock_tree_write().
2653
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
2659
self.branch.lock_write()
2661
self._control_files.lock_write()
2664
self.branch.unlock()
2668
# do non-implementation specific cleanup
2671
# we share control files:
2672
if self._control_files._lock_count == 3:
2673
# _inventory_is_modified is always False during a read lock.
2674
if self._inventory_is_modified:
2676
self._write_hashcache_if_dirty()
2678
# reverse order of locking.
2680
return self._control_files.unlock()
2682
self.branch.unlock()
2685
class WorkingTree3(WorkingTree):
2686
"""This is the Format 3 working tree.
2688
This differs from the base WorkingTree by:
2689
- having its own file lock
2690
- having its own last-revision property.
2692
This is new in bzr 0.8
2696
def _last_revision(self):
2697
"""See Mutable.last_revision."""
2699
return self._transport.get_bytes('last-revision')
2700
except errors.NoSuchFile:
2701
return _mod_revision.NULL_REVISION
2703
def _change_last_revision(self, revision_id):
2704
"""See WorkingTree._change_last_revision."""
2705
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2707
self._transport.delete('last-revision')
2708
except errors.NoSuchFile:
2712
self._transport.put_bytes('last-revision', revision_id,
2713
mode=self.bzrdir._get_file_mode())
2716
def _get_check_refs(self):
2717
"""Return the references needed to perform a check of this tree."""
2718
return [('trees', self.last_revision())]
2720
@needs_tree_write_lock
2721
def set_conflicts(self, conflicts):
2722
self._put_rio('conflicts', conflicts.to_stanzas(),
2725
@needs_tree_write_lock
2726
def add_conflicts(self, new_conflicts):
2727
conflict_set = set(self.conflicts())
2728
conflict_set.update(set(list(new_conflicts)))
2729
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2730
key=_mod_conflicts.Conflict.sort_key)))
2733
def conflicts(self):
2735
confile = self._transport.get('conflicts')
2736
except errors.NoSuchFile:
2737
return _mod_conflicts.ConflictList()
2740
if confile.next() != CONFLICT_HEADER_1 + '\n':
2741
raise errors.ConflictFormatError()
2742
except StopIteration:
2743
raise errors.ConflictFormatError()
2744
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2749
# do non-implementation specific cleanup
2751
if self._control_files._lock_count == 1:
2752
# _inventory_is_modified is always False during a read lock.
2753
if self._inventory_is_modified:
2755
self._write_hashcache_if_dirty()
2756
# reverse order of locking.
2758
return self._control_files.unlock()
2760
self.branch.unlock()
2763
def get_conflicted_stem(path):
2764
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2765
if path.endswith(suffix):
2766
return path[:-len(suffix)]
2769
class WorkingTreeFormat(object):
1717
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
1718
"""Registry for working tree formats."""
1720
def __init__(self, other_registry=None):
1721
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1722
self._default_format = None
1723
self._default_format_key = None
1725
def get_default(self):
1726
"""Return the current default format."""
1727
if (self._default_format_key is not None and
1728
self._default_format is None):
1729
self._default_format = self.get(self._default_format_key)
1730
return self._default_format
1732
def set_default(self, format):
1733
"""Set the default format."""
1734
self._default_format = format
1735
self._default_format_key = None
1737
def set_default_key(self, format_string):
1738
"""Set the default format by its format string."""
1739
self._default_format_key = format_string
1740
self._default_format = None
1743
format_registry = WorkingTreeFormatRegistry()
1746
class WorkingTreeFormat(controldir.ControlComponentFormat):
2770
1747
"""An encapsulation of the initialization and open routines for a format.
2772
1749
Formats provide three things:
2784
1761
object will be created every time regardless.
2787
_default_format = None
2788
"""The default format used for new trees."""
2791
"""The known formats."""
2793
1764
requires_rich_root = False
2795
1766
upgrade_recommended = False
2798
def find_format(klass, a_bzrdir):
2799
"""Return the format for the working tree object in a_bzrdir."""
2801
transport = a_bzrdir.get_workingtree_transport(None)
2802
format_string = transport.get_bytes("format")
2803
return klass._formats[format_string]
2804
except errors.NoSuchFile:
2805
raise errors.NoWorkingTree(base=transport.base)
2807
raise errors.UnknownFormatError(format=format_string,
2808
kind="working tree")
1768
requires_normalized_unicode_filenames = False
1770
case_sensitive_filename = "FoRMaT"
1772
missing_parent_conflicts = False
1773
"""If this format supports missing parent conflicts."""
1775
supports_versioned_directories = None
1777
def initialize(self, controldir, revision_id=None, from_branch=None,
1778
accelerator_tree=None, hardlink=False):
1779
"""Initialize a new working tree in controldir.
1781
:param controldir: ControlDir to initialize the working tree in.
1782
:param revision_id: allows creating a working tree at a different
1783
revision than the branch is at.
1784
:param from_branch: Branch to checkout
1785
:param accelerator_tree: A tree which can be used for retrieving file
1786
contents more quickly than the revision tree, i.e. a workingtree.
1787
The revision tree will be used for cases where accelerator_tree's
1788
content is different.
1789
:param hardlink: If true, hard-link files from accelerator_tree,
1792
raise NotImplementedError(self.initialize)
2810
1794
def __eq__(self, other):
2811
1795
return self.__class__ is other.__class__
2843
1818
"""True if this format supports stored views."""
2847
def register_format(klass, format):
2848
klass._formats[format.get_format_string()] = format
2851
def set_default_format(klass, format):
2852
klass._default_format = format
2855
def unregister_format(klass, format):
2856
del klass._formats[format.get_format_string()]
2859
class WorkingTreeFormat2(WorkingTreeFormat):
2860
"""The second working tree format.
2862
This format modified the hash cache from the format 1 hash cache.
2865
upgrade_recommended = True
2867
def get_format_description(self):
2868
"""See WorkingTreeFormat.get_format_description()."""
2869
return "Working tree format 2"
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2874
This ensures that it can later be updated and dealt with locally,
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
no working tree. (See bug #43064).
2879
inv = inventory.Inventory()
2880
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
transport.put_file('inventory', sio, file_mode)
2883
transport.put_bytes('pending-merges', '', file_mode)
2885
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
accelerator_tree=None, hardlink=False):
2887
"""See WorkingTreeFormat.initialize()."""
2888
if not isinstance(a_bzrdir.transport, LocalTransport):
2889
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2890
if from_branch is not None:
2891
branch = from_branch
2893
branch = a_bzrdir.open_branch()
2894
if revision_id is None:
2895
revision_id = _mod_revision.ensure_null(branch.last_revision())
2898
branch.generate_revision_history(revision_id)
2901
inv = inventory.Inventory()
2902
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2908
basis_tree = branch.repository.revision_tree(revision_id)
2909
if basis_tree.inventory.root is not None:
2910
wt.set_root_id(basis_tree.get_root_id())
2911
# set the parent list and cache the basis tree.
2912
if _mod_revision.is_null(revision_id):
2915
parent_trees = [(revision_id, basis_tree)]
2916
wt.set_parent_trees(parent_trees)
2917
transform.build_tree(basis_tree, wt)
2921
super(WorkingTreeFormat2, self).__init__()
2922
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2924
def open(self, a_bzrdir, _found=False):
2925
"""Return the WorkingTree object for a_bzrdir
2927
_found is a private parameter, do not use it. It is used to indicate
2928
if format probing has already been done.
2931
# we are being called directly and must probe.
2932
raise NotImplementedError
2933
if not isinstance(a_bzrdir.transport, LocalTransport):
2934
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2935
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2941
class WorkingTreeFormat3(WorkingTreeFormat):
2942
"""The second working tree format updated to record a format marker.
2945
- exists within a metadir controlling .bzr
2946
- includes an explicit version marker for the workingtree control
2947
files, separate from the BzrDir format
2948
- modifies the hash cache format
2950
- uses a LockDir to guard access for writes.
2953
upgrade_recommended = True
2955
def get_format_string(self):
2956
"""See WorkingTreeFormat.get_format_string()."""
2957
return "Bazaar-NG Working Tree format 3"
2959
def get_format_description(self):
2960
"""See WorkingTreeFormat.get_format_description()."""
2961
return "Working tree format 3"
2963
_lock_file_name = 'lock'
2964
_lock_class = LockDir
2966
_tree_class = WorkingTree3
2968
def __get_matchingbzrdir(self):
2969
return bzrdir.BzrDirMetaFormat1()
2971
_matchingbzrdir = property(__get_matchingbzrdir)
2973
def _open_control_files(self, a_bzrdir):
2974
transport = a_bzrdir.get_workingtree_transport(None)
2975
return LockableFiles(transport, self._lock_file_name,
2978
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
accelerator_tree=None, hardlink=False):
2980
"""See WorkingTreeFormat.initialize().
2982
:param revision_id: if supplied, create a working tree at a different
2983
revision than the branch is at.
2984
:param accelerator_tree: A tree which can be used for retrieving file
2985
contents more quickly than the revision tree, i.e. a workingtree.
2986
The revision tree will be used for cases where accelerator_tree's
2987
content is different.
2988
:param hardlink: If true, hard-link files from accelerator_tree,
2991
if not isinstance(a_bzrdir.transport, LocalTransport):
2992
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2993
transport = a_bzrdir.get_workingtree_transport(self)
2994
control_files = self._open_control_files(a_bzrdir)
2995
control_files.create_lock()
2996
control_files.lock_write()
2997
transport.put_bytes('format', self.get_format_string(),
2998
mode=a_bzrdir._get_file_mode())
2999
if from_branch is not None:
3000
branch = from_branch
3002
branch = a_bzrdir.open_branch()
3003
if revision_id is None:
3004
revision_id = _mod_revision.ensure_null(branch.last_revision())
3005
# WorkingTree3 can handle an inventory which has a unique root id.
3006
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3007
# those trees. And because there isn't a format bump inbetween, we
3008
# are maintaining compatibility with older clients.
3009
# inv = Inventory(root_id=gen_root_id())
3010
inv = self._initial_inventory()
3011
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3017
_control_files=control_files)
3018
wt.lock_tree_write()
3020
basis_tree = branch.repository.revision_tree(revision_id)
3021
# only set an explicit root id if there is one to set.
3022
if basis_tree.inventory.root is not None:
3023
wt.set_root_id(basis_tree.get_root_id())
3024
if revision_id == _mod_revision.NULL_REVISION:
3025
wt.set_parent_trees([])
3027
wt.set_parent_trees([(revision_id, basis_tree)])
3028
transform.build_tree(basis_tree, wt)
3030
# Unlock in this order so that the unlock-triggers-flush in
3031
# WorkingTree is given a chance to fire.
3032
control_files.unlock()
3036
def _initial_inventory(self):
3037
return inventory.Inventory()
3040
super(WorkingTreeFormat3, self).__init__()
3042
def open(self, a_bzrdir, _found=False):
3043
"""Return the WorkingTree object for a_bzrdir
3045
_found is a private parameter, do not use it. It is used to indicate
3046
if format probing has already been done.
3049
# we are being called directly and must probe.
3050
raise NotImplementedError
3051
if not isinstance(a_bzrdir.transport, LocalTransport):
3052
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3053
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3056
def _open(self, a_bzrdir, control_files):
3057
"""Open the tree itself.
3059
:param a_bzrdir: the dir for the tree.
3060
:param control_files: the control files for the tree.
3062
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3066
_control_files=control_files)
3069
return self.get_format_string()
3072
__default_format = WorkingTreeFormat6()
3073
WorkingTreeFormat.register_format(__default_format)
3074
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
WorkingTreeFormat.set_default_format(__default_format)
3078
# formats which have no format string are not discoverable
3079
# and not independently creatable, so are not registered.
3080
_legacy_formats = [WorkingTreeFormat2(),
1821
def get_controldir_for_branch(self):
1822
"""Get the control directory format for creating branches.
1824
This is to support testing of working tree formats that can not exist
1825
in the same control directory as a branch.
1827
return self._matchingbzrdir
1830
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
1831
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1832
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
1833
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1834
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
1835
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1836
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
1837
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1838
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
