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.lockable_files import LockableFiles
81
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
95
from bzrlib.filters import filtered_input_file
96
from bzrlib.trace import mutter, note
97
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
99
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
106
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
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
112
78
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
183
146
return views.DisabledViews(self)
185
148
def __init__(self, basedir='.',
186
branch=DEPRECATED_PARAMETER,
192
154
"""Construct a WorkingTree instance. This is not a public API.
194
156
:param branch: A branch to override probing for the branch.
196
158
self._format = _format
197
self.bzrdir = _bzrdir
159
self.controldir = _controldir
198
160
if not _internal:
199
raise errors.BzrError("Please use bzrdir.open_workingtree or "
161
raise errors.BzrError("Please use controldir.open_workingtree or "
200
162
"WorkingTree.open() to obtain a WorkingTree.")
201
basedir = safe_unicode(basedir)
163
basedir = osutils.safe_unicode(basedir)
202
164
mutter("opening working tree %r", basedir)
203
if deprecated_passed(branch):
165
if branch is not None:
204
166
self._branch = branch
206
self._branch = self.bzrdir.open_branch()
207
self.basedir = realpath(basedir)
208
# if branch is at our basedir and is a format 6 or less
209
if isinstance(self._format, WorkingTreeFormat2):
210
# share control object
211
self._control_files = self.branch.control_files
213
# assume all other formats have their own control files.
214
self._control_files = _control_files
215
self._transport = self._control_files._transport
216
# update the whole cache up front and write to disk if anything changed;
217
# in the future we might want to do this more selectively
218
# two possible ways offer themselves : in self._unlock, write the cache
219
# if needed, or, when the cache sees a change, append it to the hash
220
# cache file, and have the parser take the most recent entry for a
222
wt_trans = self.bzrdir.get_workingtree_transport(None)
223
cache_filename = wt_trans.local_abspath('stat-cache')
224
self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
self.bzrdir._get_file_mode(),
226
self._content_filter_stack_provider())
229
# is this scan needed ? it makes things kinda slow.
236
if _inventory is None:
237
# This will be acquired on lock_read() or lock_write()
238
self._inventory_is_modified = False
239
self._inventory = None
241
# the caller of __init__ has provided an inventory,
242
# we assume they know what they are doing - as its only
243
# the Format factory and creation methods that are
244
# permitted to do this.
245
self._set_inventory(_inventory, dirty=False)
246
self._detect_case_handling()
168
self._branch = self.controldir.open_branch()
169
self.basedir = osutils.realpath(basedir)
170
self._transport = _transport
247
171
self._rules_searcher = None
248
172
self.views = self._make_views()
251
175
def user_transport(self):
252
return self.bzrdir.user_transport
176
return self.controldir.user_transport
255
179
def control_transport(self):
256
180
return self._transport
258
def _detect_case_handling(self):
259
wt_trans = self.bzrdir.get_workingtree_transport(None)
261
wt_trans.stat("FoRMaT")
262
except errors.NoSuchFile:
263
self.case_sensitive = True
265
self.case_sensitive = False
267
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)
269
194
branch = property(
270
195
fget=lambda self: self._branch,
347
266
path = osutils.getcwd()
348
control, relpath = bzrdir.BzrDir.open_containing(path)
267
control, relpath = controldir.ControlDir.open_containing(path)
350
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)
353
337
def open_downlevel(path=None):
354
338
"""Open an unsupported working tree.
356
Only intended for advanced situations like upgrading part of a bzrdir.
340
Only intended for advanced situations like upgrading part of a controldir.
358
342
return WorkingTree.open(path, _unsupported=True)
361
345
def find_trees(location):
362
346
def list_current(transport):
363
return [d for d in transport.list_dir('') if d != '.bzr']
364
def evaluate(bzrdir):
347
return [d for d in transport.list_dir('')
348
if not controldir.is_control_filename(d)]
349
def evaluate(controldir):
366
tree = bzrdir.open_workingtree()
351
tree = controldir.open_workingtree()
367
352
except errors.NoWorkingTree:
368
353
return True, None
370
355
return True, tree
371
transport = get_transport(location)
372
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
356
t = transport.get_transport(location)
357
iterator = controldir.ControlDir.find_controldirs(t, evaluate=evaluate,
373
358
list_current=list_current)
374
return [t for t in iterator if t is not None]
376
# should be deprecated - this is slow and in any case treating them as a
377
# container is (we now know) bad style -- mbp 20070302
378
## @deprecated_method(zero_fifteen)
380
"""Iterate through file_ids for this tree.
382
file_ids are in a WorkingTree if they are in the working inventory
383
and the working file exists.
385
inv = self._inventory
386
for path, ie in inv.iter_entries():
387
if osutils.lexists(self.abspath(path)):
390
def all_file_ids(self):
391
"""See Tree.iter_all_file_ids"""
392
return set(self.inventory)
359
return [tr for tr in iterator if tr is not None]
394
361
def __repr__(self):
395
362
return "<%s of %s>" % (self.__class__.__name__,
396
363
getattr(self, 'basedir', None))
398
365
def abspath(self, filename):
399
return pathjoin(self.basedir, filename)
366
return osutils.pathjoin(self.basedir, filename)
401
368
def basis_tree(self):
402
369
"""Return RevisionTree for the current last revision.
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
"""See Tree.annotate_iter
488
This implementation will use the basis tree implementation if possible.
489
Lines not in the basis are attributed to CURRENT_REVISION
491
If there are pending merges, lines added by those merges will be
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
539
455
def get_parent_ids(self):
540
456
"""See Tree.get_parent_ids.
595
506
# TODO now merge from tree.last_revision to revision (to preserve
596
507
# user local changes)
597
merge.transform_tree(tree, self)
598
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)
600
520
def id2abspath(self, file_id):
601
521
return self.abspath(self.id2path(file_id))
603
def has_id(self, file_id):
604
# files that have been deleted are excluded
606
if not inv.has_id(file_id):
608
path = inv.id2path(file_id)
609
return osutils.lexists(self.abspath(path))
611
def has_or_had_id(self, file_id):
612
if file_id == self.inventory.root.file_id:
614
return self.inventory.has_id(file_id)
616
__contains__ = has_id
618
523
def get_file_size(self, file_id):
619
524
"""See Tree.get_file_size"""
620
525
# XXX: this returns the on-disk size; it should probably return the
623
528
return os.path.getsize(self.id2abspath(file_id))
625
530
if e.errno != errno.ENOENT:
631
def get_file_sha1(self, file_id, path=None, stat_value=None):
633
path = self._inventory.id2path(file_id)
634
return self._hashcache.get_sha1(path, stat_value)
636
def get_file_mtime(self, file_id, path=None):
638
path = self.inventory.id2path(file_id)
639
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
if not supports_executable():
654
def is_executable(self, file_id, path=None):
655
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
def is_executable(self, file_id, path=None):
662
path = self.id2path(file_id)
663
mode = os.lstat(self.abspath(path)).st_mode
664
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
@needs_tree_write_lock
670
def _add(self, files, ids, kinds):
671
"""See MutableTree._add."""
672
# TODO: Re-adding a file that is removed in the working copy
673
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
675
# function - they should be part of lock_write and unlock.
677
for f, file_id, kind in zip(files, ids, kinds):
679
inv.add_path(f, kind=kind)
681
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
684
535
@needs_tree_write_lock
685
536
def _gather_kinds(self, files, kinds):
686
537
"""See MutableTree._gather_kinds."""
687
538
for pos, f in enumerate(files):
688
539
if kinds[pos] is None:
689
fullpath = normpath(self.abspath(f))
540
fullpath = osutils.normpath(self.abspath(f))
691
kinds[pos] = file_kind(fullpath)
542
kinds[pos] = osutils.file_kind(fullpath)
693
544
if e.errno == errno.ENOENT:
694
545
raise errors.NoSuchFile(fullpath)
989
780
self.add(path, file_id, 'directory')
992
def get_symlink_target(self, file_id):
993
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)
994
788
target = osutils.readlink(abspath)
998
791
def subsume(self, other_tree):
999
def add_children(inventory, entry):
1000
for child_entry in entry.children.values():
1001
inventory._byid[child_entry.file_id] = child_entry
1002
if child_entry.kind == 'directory':
1003
add_children(inventory, child_entry)
1004
if other_tree.get_root_id() == self.get_root_id():
1005
raise errors.BadSubsumeSource(self, other_tree,
1006
'Trees have the same root')
1008
other_tree_path = self.relpath(other_tree.basedir)
1009
except errors.PathNotChild:
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Tree is not contained by the other')
1012
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
if new_root_parent is None:
1014
raise errors.BadSubsumeSource(self, other_tree,
1015
'Parent directory is not versioned.')
1016
# We need to ensure that the result of a fetch will have a
1017
# versionedfile for the other_tree root, and only fetching into
1018
# RepositoryKnit2 guarantees that.
1019
if not self.branch.repository.supports_rich_root():
1020
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
other_tree.lock_tree_write()
1023
new_parents = other_tree.get_parent_ids()
1024
other_root = other_tree.inventory.root
1025
other_root.parent_id = new_root_parent
1026
other_root.name = osutils.basename(other_tree_path)
1027
self.inventory.add(other_root)
1028
add_children(self.inventory, other_root)
1029
self._write_inventory(self.inventory)
1030
# normally we don't want to fetch whole repositories, but i think
1031
# here we really do want to consolidate the whole thing.
1032
for parent_id in other_tree.get_parent_ids():
1033
self.branch.fetch(other_tree.branch, parent_id)
1034
self.add_parent_tree_id(parent_id)
1037
other_tree.bzrdir.retire_bzrdir()
792
raise NotImplementedError(self.subsume)
1039
794
def _setup_directory_is_tree_reference(self):
1040
795
if self._branch.repository._format.supports_tree_reference:
1062
817
# checkout in a subdirectory. This can be avoided by not adding
1063
818
# it. mbp 20070306
1065
@needs_tree_write_lock
1066
820
def extract(self, file_id, format=None):
1067
821
"""Extract a subtree from this tree.
1069
823
A new branch will be created, relative to the path for this tree.
1073
segments = osutils.splitpath(path)
1074
transport = self.branch.bzrdir.root_transport
1075
for name in segments:
1076
transport = transport.clone(name)
1077
transport.ensure_base()
1080
sub_path = self.id2path(file_id)
1081
branch_transport = mkdirs(sub_path)
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
1085
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
repo = branch_bzrdir.find_repository()
1088
except errors.NoRepositoryPresent:
1089
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1092
new_branch = branch_bzrdir.create_branch()
1093
new_branch.pull(self.branch)
1094
for parent_id in self.get_parent_ids():
1095
new_branch.fetch(self.branch, parent_id)
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
if tree_transport.base != branch_transport.base:
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1102
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
wt.set_parent_ids(self.get_parent_ids())
1105
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1107
new_root = my_inv[file_id]
1108
my_inv.remove_recursive_id(file_id)
1109
new_root.parent_id = None
1110
child_inv.add(new_root)
1111
self._write_inventory(my_inv)
1112
wt._write_inventory(child_inv)
1115
def _serialize(self, inventory, out_file):
1116
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1119
def _deserialize(selt, in_file):
1120
return xml5.serializer_v5.read_inventory(in_file)
825
raise NotImplementedError(self.extract)
1122
827
def flush(self):
1123
"""Write the in memory inventory to disk."""
1124
# TODO: Maybe this should only write on dirty ?
1125
if self._control_files._lock_mode != 'w':
1126
raise errors.NotWriteLocked(self)
1128
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1132
self._inventory_is_modified = False
828
"""Write the in memory meta data to disk."""
829
raise NotImplementedError(self.flush)
1134
831
def _kind(self, relpath):
1135
832
return osutils.file_kind(self.abspath(relpath))
1145
842
:param from_dir: start from this directory or None for the root
1146
843
:param recursive: whether to recurse into subdirectories or not
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
# with it. So callers should be careful to always read_lock the tree.
1150
if not self.is_locked():
1151
raise errors.ObjectNotLocked(self)
1153
inv = self.inventory
1154
if from_dir is None and include_root is True:
1155
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
# Convert these into local objects to save lookup times
1157
pathjoin = osutils.pathjoin
1158
file_kind = self._kind
1160
# transport.base ends in a slash, we want the piece
1161
# between the last two slashes
1162
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1164
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
# directory file_id, relative path, absolute path, reverse sorted children
1167
if from_dir is not None:
1168
from_dir_id = inv.path2id(from_dir)
1169
if from_dir_id is None:
1170
# Directory not versioned
1172
from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
from_dir_id = inv.root.file_id
1175
from_dir_abspath = self.basedir
1176
children = os.listdir(from_dir_abspath)
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
# use a deque and popleft to keep them sorted, or if we use a plain
1180
# list and just reverse() them.
1181
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1184
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1187
f = children.popleft()
1188
## TODO: If we find a subdirectory with its own .bzr
1189
## directory, then that is a separate tree and we
1190
## should exclude it.
1192
# the bzrdir for this tree
1193
if transport_base_dir == f:
1196
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1197
# and 'f' doesn't begin with one, we can do a string op, rather
1198
# than the checks of pathjoin(), all relative paths will have an extra slash
1200
fp = from_dir_relpath + '/' + f
1203
fap = from_dir_abspath + '/' + f
1205
f_ie = inv.get_child(from_dir_id, f)
1208
elif self.is_ignored(fp[1:]):
1211
# we may not have found this file, because of a unicode issue
1212
f_norm, can_access = osutils.normalized_filename(f)
1213
if f == f_norm or not can_access:
1214
# No change, so treat this file normally
1217
# this file can be accessed by a normalized path
1218
# check again if it is versioned
1219
# these lines are repeated here for performance
1221
fp = from_dir_relpath + '/' + f
1222
fap = from_dir_abspath + '/' + f
1223
f_ie = inv.get_child(from_dir_id, f)
1226
elif self.is_ignored(fp[1:]):
1233
# make a last minute entry
1235
yield fp[1:], c, fk, f_ie.file_id, f_ie
1238
yield fp[1:], c, fk, None, fk_entries[fk]()
1240
yield fp[1:], c, fk, None, TreeEntry()
1243
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
1256
# if we finished all children, pop it off the stack
1259
@needs_tree_write_lock
1260
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):
1261
848
"""Rename files.
1263
to_dir must exist in the inventory.
850
to_dir must be known to the working tree.
1265
852
If to_dir exists and is a directory, the files are moved into
1266
853
it, keeping their old names.
1292
878
This returns a list of (from_path, to_path) pairs for each
1293
879
entry that is moved.
1298
# check for deprecated use of signature
1300
to_dir = kwargs.get('to_name', None)
1302
raise TypeError('You must supply a target directory')
1304
symbol_versioning.warn('The parameter to_name was deprecated'
1305
' in version 0.13. Use to_dir instead',
1308
# check destination directory
1309
if isinstance(from_paths, basestring):
1311
inv = self.inventory
1312
to_abs = self.abspath(to_dir)
1313
if not isdir(to_abs):
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotADirectory(to_abs))
1316
if not self.has_filename(to_dir):
1317
raise errors.BzrMoveFailedError('',to_dir,
1318
errors.NotInWorkingDirectory(to_dir))
1319
to_dir_id = inv.path2id(to_dir)
1320
if to_dir_id is None:
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotVersionedError(path=str(to_dir)))
1324
to_dir_ie = inv[to_dir_id]
1325
if to_dir_ie.kind != 'directory':
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotADirectory(to_abs))
1329
# create rename entries and tuples
1330
for from_rel in from_paths:
1331
from_tail = splitpath(from_rel)[-1]
1332
from_id = inv.path2id(from_rel)
1334
raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
errors.NotVersionedError(path=str(from_rel)))
1337
from_entry = inv[from_id]
1338
from_parent_id = from_entry.parent_id
1339
to_rel = pathjoin(to_dir, from_tail)
1340
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1342
from_tail=from_tail,
1343
from_parent_id=from_parent_id,
1344
to_rel=to_rel, to_tail=from_tail,
1345
to_parent_id=to_dir_id)
1346
rename_entries.append(rename_entry)
1347
rename_tuples.append((from_rel, to_rel))
1349
# determine which move mode to use. checks also for movability
1350
rename_entries = self._determine_mv_mode(rename_entries, after)
1352
original_modified = self._inventory_is_modified
1355
self._inventory_is_modified = True
1356
self._move(rename_entries)
1358
# restore the inventory on error
1359
self._inventory_is_modified = original_modified
1361
self._write_inventory(inv)
1362
return rename_tuples
1364
def _determine_mv_mode(self, rename_entries, after=False):
1365
"""Determines for each from-to pair if both inventory and working tree
1366
or only the inventory has to be changed.
1368
Also does basic plausability tests.
1370
inv = self.inventory
1372
for rename_entry in rename_entries:
1373
# store to local variables for easier reference
1374
from_rel = rename_entry.from_rel
1375
from_id = rename_entry.from_id
1376
to_rel = rename_entry.to_rel
1377
to_id = inv.path2id(to_rel)
1378
only_change_inv = False
1380
# check the inventory for source and destination
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.NotVersionedError(path=str(from_rel)))
1384
if to_id is not None:
1385
raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
errors.AlreadyVersionedError(path=str(to_rel)))
1388
# try to determine the mode for rename (only change inv or change
1389
# inv and file system)
1391
if not self.has_filename(to_rel):
1392
raise errors.BzrMoveFailedError(from_id,to_rel,
1393
errors.NoSuchFile(path=str(to_rel),
1394
extra="New file has not been created yet"))
1395
only_change_inv = True
1396
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
only_change_inv = True
1398
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
only_change_inv = False
1400
elif (not self.case_sensitive
1401
and from_rel.lower() == to_rel.lower()
1402
and self.has_filename(from_rel)):
1403
only_change_inv = False
1405
# something is wrong, so lets determine what exactly
1406
if not self.has_filename(from_rel) and \
1407
not self.has_filename(to_rel):
1408
raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
errors.PathsDoNotExist(paths=(str(from_rel),
1412
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
rename_entry.only_change_inv = only_change_inv
1414
return rename_entries
1416
def _move(self, rename_entries):
1417
"""Moves a list of files.
1419
Depending on the value of the flag 'only_change_inv', the
1420
file will be moved on the file system or not.
1422
inv = self.inventory
1425
for entry in rename_entries:
1427
self._move_entry(entry)
1429
self._rollback_move(moved)
1433
def _rollback_move(self, moved):
1434
"""Try to rollback a previous move in case of an filesystem error."""
1435
inv = self.inventory
1438
self._move_entry(WorkingTree._RenameEntry(
1439
entry.to_rel, entry.from_id,
1440
entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
entry.from_tail, entry.from_parent_id,
1442
entry.only_change_inv))
1443
except errors.BzrMoveFailedError, e:
1444
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
" The working tree is in an inconsistent state."
1446
" Please consider doing a 'bzr revert'."
1447
" Error message is: %s" % e)
1449
def _move_entry(self, entry):
1450
inv = self.inventory
1451
from_rel_abs = self.abspath(entry.from_rel)
1452
to_rel_abs = self.abspath(entry.to_rel)
1453
if from_rel_abs == to_rel_abs:
1454
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
"Source and target are identical.")
1457
if not entry.only_change_inv:
1459
osutils.rename(from_rel_abs, to_rel_abs)
1461
raise errors.BzrMoveFailedError(entry.from_rel,
1463
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
881
raise NotImplementedError(self.move)
1465
883
@needs_tree_write_lock
1466
884
def rename_one(self, from_rel, to_rel, after=False):
1487
904
Everything else results in an error.
1489
inv = self.inventory
1492
# create rename entries and tuples
1493
from_tail = splitpath(from_rel)[-1]
1494
from_id = inv.path2id(from_rel)
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1507
from_parent_id = from_entry.parent_id
1508
to_dir, to_tail = os.path.split(to_rel)
1509
to_dir_id = inv.path2id(to_dir)
1510
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1512
from_tail=from_tail,
1513
from_parent_id=from_parent_id,
1514
to_rel=to_rel, to_tail=to_tail,
1515
to_parent_id=to_dir_id)
1516
rename_entries.append(rename_entry)
1518
# determine which move mode to use. checks also for movability
1519
rename_entries = self._determine_mv_mode(rename_entries, after)
1521
# check if the target changed directory and if the target directory is
1523
if to_dir_id is None:
1524
raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
errors.NotVersionedError(path=str(to_dir)))
1527
# all checks done. now we can continue with our actual work
1528
mutter('rename_one:\n'
1533
' to_dir_id {%s}\n',
1534
from_id, from_rel, to_rel, to_dir, to_dir_id)
1536
self._move(rename_entries)
1537
self._write_inventory(inv)
1539
class _RenameEntry(object):
1540
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
self.from_rel = from_rel
1543
self.from_id = from_id
1544
self.from_tail = from_tail
1545
self.from_parent_id = from_parent_id
1546
self.to_rel = to_rel
1547
self.to_tail = to_tail
1548
self.to_parent_id = to_parent_id
1549
self.only_change_inv = only_change_inv
906
raise NotImplementedError(self.rename_one)
1551
908
@needs_read_lock
1552
909
def unknowns(self):
1791
1100
return _mod_revision.ensure_null(self.branch.last_revision())
1793
1102
def is_locked(self):
1794
return self._control_files.is_locked()
1796
def _must_be_locked(self):
1797
if not self.is_locked():
1798
raise errors.ObjectNotLocked(self)
1103
"""Check if this tree is locked."""
1104
raise NotImplementedError(self.is_locked)
1800
1106
def lock_read(self):
1801
"""See Branch.lock_read, and WorkingTree.unlock."""
1802
if not self.is_locked():
1804
self.branch.lock_read()
1806
return self._control_files.lock_read()
1808
self.branch.unlock()
1107
"""Lock the tree for reading.
1109
This also locks the branch, and can be unlocked via self.unlock().
1111
:return: A breezy.lock.LogicalLockResult.
1113
raise NotImplementedError(self.lock_read)
1811
1115
def lock_tree_write(self):
1812
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
if not self.is_locked():
1815
self.branch.lock_read()
1817
return self._control_files.lock_write()
1819
self.branch.unlock()
1116
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1118
:return: A breezy.lock.LogicalLockResult.
1120
raise NotImplementedError(self.lock_tree_write)
1822
1122
def lock_write(self):
1823
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1824
if not self.is_locked():
1826
self.branch.lock_write()
1828
return self._control_files.lock_write()
1830
self.branch.unlock()
1123
"""See MutableTree.lock_write, and WorkingTree.unlock.
1125
:return: A breezy.lock.LogicalLockResult.
1127
raise NotImplementedError(self.lock_write)
1833
1129
def get_physical_lock_status(self):
1834
return self._control_files.get_physical_lock_status()
1836
def _basis_inventory_name(self):
1837
return 'basis-inventory-cache'
1839
def _reset_data(self):
1840
"""Reset transient data that cannot be revalidated."""
1841
self._inventory_is_modified = False
1842
f = self._transport.get('inventory')
1844
result = self._deserialize(f)
1847
self._set_inventory(result, dirty=False)
1849
@needs_tree_write_lock
1130
raise NotImplementedError(self.get_physical_lock_status)
1850
1132
def set_last_revision(self, new_revision):
1851
1133
"""Change the last revision in the working tree."""
1852
if self._change_last_revision(new_revision):
1853
self._cache_basis_inventory(new_revision)
1134
raise NotImplementedError(self.set_last_revision)
1855
1136
def _change_last_revision(self, new_revision):
1856
1137
"""Template method part of set_last_revision to perform the change.
1859
1140
when their last revision is set.
1861
1142
if _mod_revision.is_null(new_revision):
1862
self.branch.set_revision_history([])
1143
self.branch.set_last_revision_info(0, new_revision)
1145
_mod_revision.check_not_reserved_id(new_revision)
1865
1147
self.branch.generate_revision_history(new_revision)
1866
1148
except errors.NoSuchRevision:
1867
1149
# not present in the repo - dont try to set it deeper than the tip
1868
self.branch.set_revision_history([new_revision])
1150
self.branch._set_revision_history([new_revision])
1871
def _write_basis_inventory(self, xml):
1872
"""Write the basis inventory XML to the basis-inventory file"""
1873
path = self._basis_inventory_name()
1875
self._transport.put_file(path, sio,
1876
mode=self.bzrdir._get_file_mode())
1878
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
"""Create the text that will be saved in basis-inventory"""
1880
inventory.revision_id = revision_id
1881
return xml7.serializer_v7.write_inventory_to_string(inventory)
1883
def _cache_basis_inventory(self, new_revision):
1884
"""Cache new_revision as the basis inventory."""
1885
# TODO: this should allow the ready-to-use inventory to be passed in,
1886
# as commit already has that ready-to-use [while the format is the
1889
# this double handles the inventory - unpack and repack -
1890
# but is easier to understand. We can/should put a conditional
1891
# in here based on whether the inventory is in the latest format
1892
# - perhaps we should repack all inventories on a repository
1894
# the fast path is to copy the raw xml from the repository. If the
1895
# xml contains 'revision_id="', then we assume the right
1896
# revision_id is set. We must check for this full string, because a
1897
# root node id can legitimately look like 'revision_id' but cannot
1899
xml = self.branch.repository._get_inventory_xml(new_revision)
1900
firstline = xml.split('\n', 1)[0]
1901
if (not 'revision_id="' in firstline or
1902
'format="7"' not in firstline):
1903
inv = self.branch.repository._serializer.read_inventory_from_string(
1905
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
self._write_basis_inventory(xml)
1907
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
def read_basis_inventory(self):
1911
"""Read the cached basis inventory."""
1912
path = self._basis_inventory_name()
1913
return self._transport.get_bytes(path)
1916
def read_working_inventory(self):
1917
"""Read the working inventory.
1919
:raises errors.InventoryModified: read_working_inventory will fail
1920
when the current in memory inventory has been modified.
1922
# conceptually this should be an implementation detail of the tree.
1923
# XXX: Deprecate this.
1924
# ElementTree does its own conversion from UTF-8, so open in
1926
if self._inventory_is_modified:
1927
raise errors.InventoryModified(self)
1928
f = self._transport.get('inventory')
1930
result = self._deserialize(f)
1933
self._set_inventory(result, dirty=False)
1936
1153
@needs_tree_write_lock
1937
1154
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1939
"""Remove nominated files from the working inventory.
1156
"""Remove nominated files from the working tree metadata.
1941
1158
:files: File paths relative to the basedir.
1942
1159
:keep_files: If true, the files will also be kept.
1943
1160
:force: Delete files and directories, even if they are changed and
1944
1161
even if the directories are not empty.
1946
if isinstance(files, basestring):
1163
if isinstance(files, (str, text_type)):
1947
1164
files = [files]
1168
all_files = set() # specified and nested files
1952
1169
unknown_nested_files=set()
1953
1170
if to_file is None:
1954
1171
to_file = sys.stdout
1173
files_to_backup = []
1956
1175
def recurse_directory_to_add_files(directory):
1957
1176
# Recurse directory and add all files
1958
1177
# so we can check if they have changed.
1959
for parent_info, file_infos in\
1960
self.walkdirs(directory):
1178
for parent_info, file_infos in self.walkdirs(directory):
1961
1179
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
1180
# Is it versioned or ignored?
1963
if self.path2id(relpath) or self.is_ignored(relpath):
1181
if self.path2id(relpath):
1964
1182
# Add nested content for deletion.
1965
new_files.add(relpath)
1183
all_files.add(relpath)
1967
# Files which are not versioned and not ignored
1185
# Files which are not versioned
1968
1186
# should be treated as unknown.
1969
unknown_nested_files.add((relpath, None, kind))
1187
files_to_backup.append(relpath)
1971
1189
for filename in files:
1972
1190
# Get file name into canonical form.
1973
1191
abspath = self.abspath(filename)
1974
1192
filename = self.relpath(abspath)
1975
1193
if len(filename) > 0:
1976
new_files.add(filename)
1194
all_files.add(filename)
1977
1195
recurse_directory_to_add_files(filename)
1979
files = list(new_files)
1197
files = list(all_files)
1981
1199
if len(files) == 0:
1982
1200
return # nothing to do
1987
1205
# Bail out if we are going to delete files we shouldn't
1988
1206
if not keep_files and not force:
1989
has_changed_files = len(unknown_nested_files) > 0
1990
if not has_changed_files:
1991
for (file_id, path, content_change, versioned, parent_id, name,
1992
kind, executable) in self.iter_changes(self.basis_tree(),
1993
include_unchanged=True, require_versioned=False,
1994
want_unversioned=True, specific_files=files):
1995
if versioned == (False, False):
1996
# The record is unknown ...
1997
if not self.is_ignored(path[1]):
1998
# ... but not ignored
1999
has_changed_files = True
2001
elif content_change and (kind[1] is not None):
2002
# Versioned and changed, but not deleted
2003
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])
2006
if has_changed_files:
2007
# Make delta show ALL applicable changes in error message.
2008
tree_delta = self.changes_from(self.basis_tree(),
2009
require_versioned=False, want_unversioned=True,
2010
specific_files=files)
2011
for unknown_file in unknown_nested_files:
2012
if unknown_file not in tree_delta.unversioned:
2013
tree_delta.unversioned.extend((unknown_file,))
2014
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,
2016
1226
# Build inv_delta and delete files where applicable,
2017
# do this before any modifications to inventory.
1227
# do this before any modifications to meta data.
2018
1228
for f in files:
2019
1229
fid = self.path2id(f)
2091
1299
basis_tree.unlock()
2092
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()
2094
1330
def revision_tree(self, revision_id):
2095
1331
"""See Tree.revision_tree.
2097
1333
WorkingTree can supply revision_trees for the basis revision only
2098
1334
because there is only one cached inventory in the bzr directory.
2100
if revision_id == self.last_revision():
2102
xml = self.read_basis_inventory()
2103
except errors.NoSuchFile:
2107
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2108
# dont use the repository revision_tree api because we want
2109
# to supply the inventory.
2110
if inv.revision_id == revision_id:
2111
return revisiontree.RevisionTree(self.branch.repository,
2113
except errors.BadInventoryFormat:
2115
# raise if there was no inventory, or if we read the wrong inventory.
2116
raise errors.NoSuchRevisionInTree(self, revision_id)
2118
# XXX: This method should be deprecated in favour of taking in a proper
2119
# new Inventory object.
2120
@needs_tree_write_lock
2121
def set_inventory(self, new_inventory_list):
2122
from bzrlib.inventory import (Inventory,
2126
inv = Inventory(self.get_root_id())
2127
for path, file_id, parent, kind in new_inventory_list:
2128
name = os.path.basename(path)
2131
# fixme, there should be a factory function inv,add_??
2132
if kind == 'directory':
2133
inv.add(InventoryDirectory(file_id, name, parent))
2134
elif kind == 'file':
2135
inv.add(InventoryFile(file_id, name, parent))
2136
elif kind == 'symlink':
2137
inv.add(InventoryLink(file_id, name, parent))
2139
raise errors.BzrError("unknown kind %r" % kind)
2140
self._write_inventory(inv)
1336
raise NotImplementedError(self.revision_tree)
2142
1338
@needs_tree_write_lock
2143
1339
def set_root_id(self, file_id):
2321
1503
last_rev = parent_trees[0][0]
2322
1504
return nb_conflicts
2324
def _write_hashcache_if_dirty(self):
2325
"""Write out the hashcache if it is dirty."""
2326
if self._hashcache.needs_write:
2328
self._hashcache.write()
2330
if e.errno not in (errno.EPERM, errno.EACCES):
2332
# TODO: jam 20061219 Should this be a warning? A single line
2333
# warning might be sufficient to let the user know what
2335
mutter('Could not write hashcache for %s\nError: %s',
2336
self._hashcache.cache_file_name(), e)
2338
@needs_tree_write_lock
2339
def _write_inventory(self, inv):
2340
"""Write inventory as the current inventory."""
2341
self._set_inventory(inv, dirty=True)
2344
1506
def set_conflicts(self, arg):
2345
1507
raise errors.UnsupportedOperation(self.set_conflicts, self)
2347
1509
def add_conflicts(self, arg):
2348
1510
raise errors.UnsupportedOperation(self.add_conflicts, self)
2351
1512
def conflicts(self):
2352
conflicts = _mod_conflicts.ConflictList()
2353
for conflicted in self._iter_conflicts():
2356
if file_kind(self.abspath(conflicted)) != "file":
2358
except errors.NoSuchFile:
2361
for suffix in ('.THIS', '.OTHER'):
2363
kind = file_kind(self.abspath(conflicted+suffix))
2366
except errors.NoSuchFile:
2370
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2371
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2373
file_id=self.path2id(conflicted)))
1513
raise NotImplementedError(self.conflicts)
2376
1515
def walkdirs(self, prefix=""):
2377
1516
"""Walk the directories of this tree.
2486
1625
raise NotImplementedError('unreachable code')
2487
1626
yield current_inv[0], dirblock
2489
current_inv = inventory_iterator.next()
1628
current_inv = next(inventory_iterator)
2490
1629
except StopIteration:
2491
1630
inv_finished = True
2493
current_disk = disk_iterator.next()
1632
current_disk = next(disk_iterator)
2494
1633
except StopIteration:
2495
1634
disk_finished = True
2497
1636
def _walkdirs(self, prefix=""):
2498
1637
"""Walk the directories of this tree.
2500
:prefix: is used as the directrory to start with.
2501
returns a generator which yields items in the form:
2502
((curren_directory_path, fileid),
2503
[(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,
2506
_directory = 'directory'
2507
# get the root in the inventory
2508
inv = self.inventory
2509
top_id = inv.path2id(prefix)
2513
pending = [(prefix, '', _directory, None, top_id, None)]
2516
currentdir = pending.pop()
2517
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
top_id = currentdir[4]
2520
relroot = currentdir[0] + '/'
2523
# FIXME: stash the node in pending
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
child.file_id, child.kind
2530
yield (currentdir[0], entry.file_id), dirblock
2531
# push the user specified dirs from dirblock
2532
for dir in reversed(dirblock):
2533
if dir[2] == _directory:
1646
raise NotImplementedError(self._walkdirs)
2536
1648
@needs_tree_write_lock
2537
1649
def auto_resolve(self):
2605
1711
def get_shelf_manager(self):
2606
1712
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
1713
from .shelf import ShelfManager
2608
1714
return ShelfManager(self, self._transport)
2611
class WorkingTree2(WorkingTree):
2612
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2615
- uses os locks for locking.
2616
- uses the branch last-revision.
2619
def __init__(self, *args, **kwargs):
2620
super(WorkingTree2, self).__init__(*args, **kwargs)
2621
# WorkingTree2 has more of a constraint that self._inventory must
2622
# exist. Because this is an older format, we don't mind the overhead
2623
# caused by the extra computation here.
2625
# Newer WorkingTree's should only have self._inventory set when they
2627
if self._inventory is None:
2628
self.read_working_inventory()
2630
def _get_check_refs(self):
2631
"""Return the references needed to perform a check of this tree."""
2632
return [('trees', self.last_revision())]
2634
def lock_tree_write(self):
2635
"""See WorkingTree.lock_tree_write().
2637
In Format2 WorkingTrees we have a single lock for the branch and tree
2638
so lock_tree_write() degrades to lock_write().
2640
self.branch.lock_write()
2642
return self._control_files.lock_write()
2644
self.branch.unlock()
2648
# do non-implementation specific cleanup
2651
# we share control files:
2652
if self._control_files._lock_count == 3:
2653
# _inventory_is_modified is always False during a read lock.
2654
if self._inventory_is_modified:
2656
self._write_hashcache_if_dirty()
2658
# reverse order of locking.
2660
return self._control_files.unlock()
2662
self.branch.unlock()
2665
class WorkingTree3(WorkingTree):
2666
"""This is the Format 3 working tree.
2668
This differs from the base WorkingTree by:
2669
- having its own file lock
2670
- having its own last-revision property.
2672
This is new in bzr 0.8
2676
def _last_revision(self):
2677
"""See Mutable.last_revision."""
2679
return self._transport.get_bytes('last-revision')
2680
except errors.NoSuchFile:
2681
return _mod_revision.NULL_REVISION
2683
def _change_last_revision(self, revision_id):
2684
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2687
self._transport.delete('last-revision')
2688
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
2700
@needs_tree_write_lock
2701
def set_conflicts(self, conflicts):
2702
self._put_rio('conflicts', conflicts.to_stanzas(),
2705
@needs_tree_write_lock
2706
def add_conflicts(self, new_conflicts):
2707
conflict_set = set(self.conflicts())
2708
conflict_set.update(set(list(new_conflicts)))
2709
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2710
key=_mod_conflicts.Conflict.sort_key)))
2713
def conflicts(self):
2715
confile = self._transport.get('conflicts')
2716
except errors.NoSuchFile:
2717
return _mod_conflicts.ConflictList()
2720
if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
raise errors.ConflictFormatError()
2722
except StopIteration:
2723
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2729
# do non-implementation specific cleanup
2731
if self._control_files._lock_count == 1:
2732
# _inventory_is_modified is always False during a read lock.
2733
if self._inventory_is_modified:
2735
self._write_hashcache_if_dirty()
2736
# reverse order of locking.
2738
return self._control_files.unlock()
2740
self.branch.unlock()
2743
def get_conflicted_stem(path):
2744
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
if path.endswith(suffix):
2746
return path[:-len(suffix)]
2749
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):
2750
1747
"""An encapsulation of the initialization and open routines for a format.
2752
1749
Formats provide three things:
2764
1761
object will be created every time regardless.
2767
_default_format = None
2768
"""The default format used for new trees."""
2771
"""The known formats."""
2773
1764
requires_rich_root = False
2775
1766
upgrade_recommended = False
2778
def find_format(klass, a_bzrdir):
2779
"""Return the format for the working tree object in a_bzrdir."""
2781
transport = a_bzrdir.get_workingtree_transport(None)
2782
format_string = transport.get_bytes("format")
2783
return klass._formats[format_string]
2784
except errors.NoSuchFile:
2785
raise errors.NoWorkingTree(base=transport.base)
2787
raise errors.UnknownFormatError(format=format_string,
2788
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)
2790
1794
def __eq__(self, other):
2791
1795
return self.__class__ is other.__class__
2823
1818
"""True if this format supports stored views."""
2827
def register_format(klass, format):
2828
klass._formats[format.get_format_string()] = format
2831
def set_default_format(klass, format):
2832
klass._default_format = format
2835
def unregister_format(klass, format):
2836
del klass._formats[format.get_format_string()]
2839
class WorkingTreeFormat2(WorkingTreeFormat):
2840
"""The second working tree format.
2842
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
2847
def get_format_description(self):
2848
"""See WorkingTreeFormat.get_format_description()."""
2849
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2854
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
no working tree. (See bug #43064).
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2867
"""See WorkingTreeFormat.initialize()."""
2868
if not isinstance(a_bzrdir.transport, LocalTransport):
2869
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
2882
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2888
basis_tree = branch.repository.revision_tree(revision_id)
2889
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2891
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
2897
transform.build_tree(basis_tree, wt)
2901
super(WorkingTreeFormat2, self).__init__()
2902
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2904
def open(self, a_bzrdir, _found=False):
2905
"""Return the WorkingTree object for a_bzrdir
2907
_found is a private parameter, do not use it. It is used to indicate
2908
if format probing has already been done.
2911
# we are being called directly and must probe.
2912
raise NotImplementedError
2913
if not isinstance(a_bzrdir.transport, LocalTransport):
2914
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2921
class WorkingTreeFormat3(WorkingTreeFormat):
2922
"""The second working tree format updated to record a format marker.
2925
- exists within a metadir controlling .bzr
2926
- includes an explicit version marker for the workingtree control
2927
files, separate from the BzrDir format
2928
- modifies the hash cache format
2930
- uses a LockDir to guard access for writes.
2933
upgrade_recommended = True
2935
def get_format_string(self):
2936
"""See WorkingTreeFormat.get_format_string()."""
2937
return "Bazaar-NG Working Tree format 3"
2939
def get_format_description(self):
2940
"""See WorkingTreeFormat.get_format_description()."""
2941
return "Working tree format 3"
2943
_lock_file_name = 'lock'
2944
_lock_class = LockDir
2946
_tree_class = WorkingTree3
2948
def __get_matchingbzrdir(self):
2949
return bzrdir.BzrDirMetaFormat1()
2951
_matchingbzrdir = property(__get_matchingbzrdir)
2953
def _open_control_files(self, a_bzrdir):
2954
transport = a_bzrdir.get_workingtree_transport(None)
2955
return LockableFiles(transport, self._lock_file_name,
2958
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
accelerator_tree=None, hardlink=False):
2960
"""See WorkingTreeFormat.initialize().
2962
:param revision_id: if supplied, create a working tree at a different
2963
revision than the branch is at.
2964
:param accelerator_tree: A tree which can be used for retrieving file
2965
contents more quickly than the revision tree, i.e. a workingtree.
2966
The revision tree will be used for cases where accelerator_tree's
2967
content is different.
2968
:param hardlink: If true, hard-link files from accelerator_tree,
2971
if not isinstance(a_bzrdir.transport, LocalTransport):
2972
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2973
transport = a_bzrdir.get_workingtree_transport(self)
2974
control_files = self._open_control_files(a_bzrdir)
2975
control_files.create_lock()
2976
control_files.lock_write()
2977
transport.put_bytes('format', self.get_format_string(),
2978
mode=a_bzrdir._get_file_mode())
2979
if from_branch is not None:
2980
branch = from_branch
2982
branch = a_bzrdir.open_branch()
2983
if revision_id is None:
2984
revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
# WorkingTree3 can handle an inventory which has a unique root id.
2986
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
# those trees. And because there isn't a format bump inbetween, we
2988
# are maintaining compatibility with older clients.
2989
# inv = Inventory(root_id=gen_root_id())
2990
inv = self._initial_inventory()
2991
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2997
_control_files=control_files)
2998
wt.lock_tree_write()
3000
basis_tree = branch.repository.revision_tree(revision_id)
3001
# only set an explicit root id if there is one to set.
3002
if basis_tree.inventory.root is not None:
3003
wt.set_root_id(basis_tree.get_root_id())
3004
if revision_id == _mod_revision.NULL_REVISION:
3005
wt.set_parent_trees([])
3007
wt.set_parent_trees([(revision_id, basis_tree)])
3008
transform.build_tree(basis_tree, wt)
3010
# Unlock in this order so that the unlock-triggers-flush in
3011
# WorkingTree is given a chance to fire.
3012
control_files.unlock()
3016
def _initial_inventory(self):
3017
return inventory.Inventory()
3020
super(WorkingTreeFormat3, self).__init__()
3022
def open(self, a_bzrdir, _found=False):
3023
"""Return the WorkingTree object for a_bzrdir
3025
_found is a private parameter, do not use it. It is used to indicate
3026
if format probing has already been done.
3029
# we are being called directly and must probe.
3030
raise NotImplementedError
3031
if not isinstance(a_bzrdir.transport, LocalTransport):
3032
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3036
def _open(self, a_bzrdir, control_files):
3037
"""Open the tree itself.
3039
:param a_bzrdir: the dir for the tree.
3040
:param control_files: the control files for the tree.
3042
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3046
_control_files=control_files)
3049
return self.get_format_string()
3052
__default_format = WorkingTreeFormat6()
3053
WorkingTreeFormat.register_format(__default_format)
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
WorkingTreeFormat.set_default_format(__default_format)
3058
# formats which have no format string are not discoverable
3059
# and not independently creatable, so are not registered.
3060
_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
