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.
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.
23
25
At the moment every WorkingTree has its own branch. Remote
24
26
WorkingTrees aren't supported.
26
To get a WorkingTree, call controldir.open_workingtree() or
28
To get a WorkingTree, call bzrdir.open_workingtree() or
27
29
WorkingTree.open(dir).
30
from __future__ import absolute_import
33
from cStringIO import StringIO
38
from .lazy_import import lazy_import
37
from bzrlib.lazy_import import lazy_import
39
38
lazy_import(globals(), """
39
from bisect import bisect_left
45
51
conflicts as _mod_conflicts,
46
filters as _mod_filters,
48
60
revision as _mod_revision,
53
from breezy.bzr import (
70
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
61
from .controldir import (
63
ControlComponentFormatRegistry,
64
ControlComponentFormat,
71
from .i18n import gettext
72
from . import mutabletree
73
from .symbol_versioning import deprecated_method, deprecated_in
74
from .trace import mutter, note
77
class SettingFileIdUnsupported(errors.BzrError):
79
_fmt = "This format does not support setting file ids."
82
class ShelvingUnsupported(errors.BzrError):
84
_fmt = "This format does not support shelving changes."
87
class WorkingTree(mutabletree.MutableTree, ControlComponent):
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"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
116
class TreeEntry(object):
117
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
120
InventoryEntries without ids - though that seems wrong. For now,
121
this is a parallel hierarchy to InventoryEntry, and needs to become
122
one of several things: decorates to that hierarchy, children of, or
124
Another note is that these objects are currently only used when there is
125
no InventoryEntry available - i.e. for unversioned objects.
126
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
129
def __eq__(self, other):
130
# yes, this us ugly, TODO: best practice __eq__ style.
131
return (isinstance(other, TreeEntry)
132
and other.__class__ == self.__class__)
134
def kind_character(self):
138
class TreeDirectory(TreeEntry):
139
"""See TreeEntry. This is a directory in a working tree."""
141
def __eq__(self, other):
142
return (isinstance(other, TreeDirectory)
143
and other.__class__ == self.__class__)
145
def kind_character(self):
149
class TreeFile(TreeEntry):
150
"""See TreeEntry. This is a regular file in a working tree."""
152
def __eq__(self, other):
153
return (isinstance(other, TreeFile)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeLink(TreeEntry):
161
"""See TreeEntry. This is a symlink in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeLink)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
171
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
bzrdir.ControlComponent):
88
173
"""Working copy tree.
90
:ivar basedir: The root of the tree on disk. This is a unicode path object
91
(as opposed to a URL).
175
The inventory is held in the `Branch` working-inventory, and the
176
files are in a directory on disk.
178
It is possible for a `WorkingTree` to have a filename which is
179
not listed in the Inventory and vice versa.
94
182
# override this to set the strategy for storing views
96
184
return views.DisabledViews(self)
98
186
def __init__(self, basedir='.',
187
branch=DEPRECATED_PARAMETER,
104
193
"""Construct a WorkingTree instance. This is not a public API.
106
195
:param branch: A branch to override probing for the branch.
108
197
self._format = _format
109
self.controldir = _controldir
198
self.bzrdir = _bzrdir
110
199
if not _internal:
111
raise errors.BzrError("Please use controldir.open_workingtree or "
112
"WorkingTree.open() to obtain a WorkingTree.")
113
basedir = osutils.safe_unicode(basedir)
200
raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
"WorkingTree.open() to obtain a WorkingTree.")
202
basedir = safe_unicode(basedir)
114
203
mutter("opening working tree %r", basedir)
115
if branch is not None:
204
if deprecated_passed(branch):
116
205
self._branch = branch
118
self._branch = self.controldir.open_branch()
119
self.basedir = osutils.realpath(basedir)
120
self._transport = _transport
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()
121
248
self._rules_searcher = None
122
249
self.views = self._make_views()
125
252
def user_transport(self):
126
return self.controldir.user_transport
253
return self.bzrdir.user_transport
129
256
def control_transport(self):
130
257
return self._transport
132
def supports_symlinks(self):
133
return osutils.supports_symlinks(self.basedir)
135
def is_control_filename(self, filename):
136
"""True if filename is the name of a control file in this tree.
138
:param filename: A filename within the tree. This is a relative path
139
from the root of this tree.
141
This is true IF and ONLY IF the filename is part of the meta data
142
that bzr controls in this tree. I.E. a random .bzr directory placed
143
on disk will not be a control file for this tree.
145
return self.controldir.is_control_filename(filename)
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()
147
270
branch = property(
148
271
fget=lambda self: self._branch,
224
348
path = osutils.getcwd()
225
control, relpath = ControlDir.open_containing(path)
349
control, relpath = bzrdir.BzrDir.open_containing(path)
226
351
return control.open_workingtree(), relpath
229
def open_containing_paths(file_list, default_directory=None,
230
canonicalize=True, apply_view=True):
231
"""Open the WorkingTree that contains a set of paths.
233
Fail if the paths given are not all in a single tree.
235
This is used for the many command-line interfaces that take a list of
236
any number of files and that require they all be in the same tree.
238
if default_directory is None:
239
default_directory = u'.'
240
# recommended replacement for builtins.internal_tree_files
241
if file_list is None or len(file_list) == 0:
242
tree = WorkingTree.open_containing(default_directory)[0]
243
# XXX: doesn't really belong here, and seems to have the strange
244
# side effect of making it return a bunch of files, not the whole
245
# tree -- mbp 20100716
246
if tree.supports_views() and apply_view:
247
view_files = tree.views.lookup_view()
249
file_list = view_files
250
view_str = views.view_display_str(view_files)
251
note(gettext("Ignoring files outside view. View is %s") % view_str)
252
return tree, file_list
253
if default_directory == u'.':
256
seed = default_directory
257
file_list = [osutils.pathjoin(default_directory, f)
259
tree = WorkingTree.open_containing(seed)[0]
260
return tree, tree.safe_relpath_files(file_list, canonicalize,
261
apply_view=apply_view)
263
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
264
"""Convert file_list into a list of relpaths in tree.
266
:param self: A tree to operate on.
267
:param file_list: A list of user provided paths or None.
268
:param apply_view: if True and a view is set, apply it or check that
269
specified files are within it
270
:return: A list of relative paths.
271
:raises errors.PathNotChild: When a provided path is in a different self
274
if file_list is None:
276
if self.supports_views() and apply_view:
277
view_files = self.views.lookup_view()
281
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
282
# doesn't - fix that up here before we enter the loop.
285
return osutils.canonical_relpath(self.basedir, p)
288
for filename in file_list:
289
relpath = fixer(osutils.dereference_path(filename))
290
if view_files and not osutils.is_inside_any(view_files, relpath):
291
raise views.FileOutsideView(filename, view_files)
292
new_list.append(relpath)
296
354
def open_downlevel(path=None):
297
355
"""Open an unsupported working tree.
299
Only intended for advanced situations like upgrading part of a controldir.
357
Only intended for advanced situations like upgrading part of a bzrdir.
301
359
return WorkingTree.open(path, _unsupported=True)
362
def find_trees(location):
363
def list_current(transport):
364
return [d for d in transport.list_dir('') if d != '.bzr']
365
def evaluate(bzrdir):
367
tree = bzrdir.open_workingtree()
368
except errors.NoWorkingTree:
372
transport = get_transport(location)
373
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
374
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)
303
395
def __repr__(self):
304
396
return "<%s of %s>" % (self.__class__.__name__,
305
397
getattr(self, 'basedir', None))
307
399
def abspath(self, filename):
308
return osutils.pathjoin(self.basedir, filename)
400
return pathjoin(self.basedir, filename)
310
402
def basis_tree(self):
311
403
"""Return RevisionTree for the current last revision.
352
447
def has_filename(self, filename):
353
448
return osutils.lexists(self.abspath(filename))
355
def get_file(self, path, filtered=True):
356
return self.get_file_with_stat(path, filtered=filtered)[0]
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
358
def get_file_with_stat(self, path, filtered=True,
359
_fstat=osutils.fstat):
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
360
455
"""See Tree.get_file_with_stat."""
361
abspath = self.abspath(path)
363
file_obj = open(abspath, 'rb')
364
except EnvironmentError as e:
365
if e.errno == errno.ENOENT:
366
raise errors.NoSuchFile(path)
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
368
459
stat_value = _fstat(file_obj.fileno())
369
460
if filtered and self.supports_content_filtering():
370
461
filters = self._content_filter_stack(path)
372
file_obj, size = _mod_filters.filtered_input_file(
374
stat_value = _mod_filters.FilteredStat(
375
stat_value, st_size=size)
462
file_obj = filtered_input_file(file_obj, filters)
376
463
return (file_obj, stat_value)
378
def get_file_text(self, path, filtered=True):
379
with self.get_file(path, filtered=filtered) as my_file:
380
return my_file.read()
382
def get_file_lines(self, path, filtered=True):
465
def get_file_text(self, file_id, path=None, filtered=True):
466
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
383
478
"""See Tree.get_file_lines()"""
384
with self.get_file(path, filtered=filtered) as file:
479
file = self.get_file(file_id, path, filtered=filtered)
385
481
return file.readlines()
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))
387
540
def get_parent_ids(self):
388
541
"""See Tree.get_parent_ids.
403
556
for l in osutils.split_lines(merges_bytes):
404
revision_id = l.rstrip(b'\n')
557
revision_id = l.rstrip('\n')
405
558
parents.append(revision_id)
408
def clone(self, to_controldir, revision_id=None):
562
def get_root_id(self):
563
"""Return the id of this trees root"""
564
return self._inventory.root.file_id
566
def _get_store_filename(self, file_id):
567
## XXX: badly named; this is not in the store at all
568
return self.abspath(self.id2path(file_id))
571
def clone(self, to_bzrdir, revision_id=None):
409
572
"""Duplicate this working tree into to_bzr, including all state.
411
574
Specifically modified files are kept as modified, but
412
575
ignored and unknown files are discarded.
414
If you want to make a new line of development, see ControlDir.sprout()
577
If you want to make a new line of development, see bzrdir.sprout()
417
580
If not None, the cloned tree will have its last revision set to
418
581
revision, and difference between the source trees last revision
419
582
and this one merged in.
421
with self.lock_read():
422
# assumes the target bzr dir format is compatible.
423
result = to_controldir.create_workingtree()
424
self.copy_content_into(result, revision_id)
584
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
586
self.copy_content_into(result, revision_id)
427
590
def copy_content_into(self, tree, revision_id=None):
428
591
"""Copy the current content and user files of this tree into tree."""
429
with self.lock_read():
430
tree.set_root_id(self.path2id(''))
431
if revision_id is None:
432
merge.transform_tree(tree, self)
434
# TODO now merge from tree.last_revision to revision (to
435
# preserve user local changes)
437
other_tree = self.revision_tree(revision_id)
438
except errors.NoSuchRevision:
439
other_tree = self.branch.repository.revision_tree(
442
merge.transform_tree(tree, other_tree)
443
if revision_id == _mod_revision.NULL_REVISION:
446
new_parents = [revision_id]
447
tree.set_parent_ids(new_parents)
449
def get_file_size(self, path):
592
tree.set_root_id(self.get_root_id())
593
if revision_id is None:
594
merge.transform_tree(tree, self)
596
# TODO now merge from tree.last_revision to revision (to preserve
597
# user local changes)
598
merge.transform_tree(tree, self)
599
tree.set_parent_ids([revision_id])
601
def id2abspath(self, file_id):
602
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
def get_file_size(self, file_id):
450
620
"""See Tree.get_file_size"""
451
621
# XXX: this returns the on-disk size; it should probably return the
454
return os.path.getsize(self.abspath(path))
624
return os.path.getsize(self.id2abspath(file_id))
456
626
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
@needs_tree_write_lock
461
686
def _gather_kinds(self, files, kinds):
462
687
"""See MutableTree._gather_kinds."""
463
with self.lock_tree_write():
464
for pos, f in enumerate(files):
465
if kinds[pos] is None:
466
fullpath = osutils.normpath(self.abspath(f))
468
kinds[pos] = osutils.file_kind(fullpath)
470
if e.errno == errno.ENOENT:
471
raise errors.NoSuchFile(fullpath)
688
for pos, f in enumerate(files):
689
if kinds[pos] is None:
690
fullpath = normpath(self.abspath(f))
692
kinds[pos] = file_kind(fullpath)
694
if e.errno == errno.ENOENT:
695
raise errors.NoSuchFile(fullpath)
473
698
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
474
699
"""Add revision_id as a parent.
604
829
:param revision_ids: The revision_ids to set as the parent ids of this
605
830
working tree. Any of these may be ghosts.
607
with self.lock_tree_write():
608
self._check_parents_for_ghosts(revision_ids,
609
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
610
for revision_id in revision_ids:
611
_mod_revision.check_not_reserved_id(revision_id)
613
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
615
if len(revision_ids) > 0:
616
self.set_last_revision(revision_ids[0])
832
self._check_parents_for_ghosts(revision_ids,
833
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
for revision_id in revision_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
839
if len(revision_ids) > 0:
840
self.set_last_revision(revision_ids[0])
842
self.set_last_revision(_mod_revision.NULL_REVISION)
844
self._set_merges_from_parent_ids(revision_ids)
846
@needs_tree_write_lock
847
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
"""See MutableTree.set_parent_trees."""
849
parent_ids = [rev for (rev, tree) in parents_list]
850
for revision_id in parent_ids:
851
_mod_revision.check_not_reserved_id(revision_id)
853
self._check_parents_for_ghosts(parent_ids,
854
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
856
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
858
if len(parent_ids) == 0:
859
leftmost_parent_id = _mod_revision.NULL_REVISION
860
leftmost_parent_tree = None
862
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
864
if self._change_last_revision(leftmost_parent_id):
865
if leftmost_parent_tree is None:
866
# If we don't have a tree, fall back to reading the
867
# parent tree from the repository.
868
self._cache_basis_inventory(leftmost_parent_id)
618
self.set_last_revision(_mod_revision.NULL_REVISION)
620
self._set_merges_from_parent_ids(revision_ids)
870
inv = leftmost_parent_tree.inventory
871
xml = self._create_basis_xml_from_inventory(
872
leftmost_parent_id, inv)
873
self._write_basis_inventory(xml)
874
self._set_merges_from_parent_ids(parent_ids)
876
@needs_tree_write_lock
622
877
def set_pending_merges(self, rev_list):
623
with self.lock_tree_write():
624
parents = self.get_parent_ids()
625
leftmost = parents[:1]
626
new_parents = leftmost + rev_list
627
self.set_parent_ids(new_parents)
878
parents = self.get_parent_ids()
879
leftmost = parents[:1]
880
new_parents = leftmost + rev_list
881
self.set_parent_ids(new_parents)
883
@needs_tree_write_lock
629
884
def set_merge_modified(self, modified_hashes):
630
"""Set the merge modified hashes."""
631
raise NotImplementedError(self.set_merge_modified)
886
for file_id, hash in modified_hashes.iteritems():
887
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
888
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
633
890
def _sha_from_stat(self, path, stat_result):
634
891
"""Get a sha digest from the tree's stat cache.
692
956
because of a merge.
694
958
This returns a map of file_id->sha1, containing only files which are
695
still in the working tree and have that text hash.
959
still in the working inventory and have that text hash.
697
raise NotImplementedError(self.merge_modified)
962
hashfile = self._transport.get('merge-hashes')
963
except errors.NoSuchFile:
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
971
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
699
985
def mkdir(self, path, file_id=None):
700
986
"""See MutableTree.mkdir()."""
701
987
if file_id is None:
702
if self.supports_setting_file_ids():
703
file_id = generate_ids.gen_file_id(os.path.basename(path))
705
if not self.supports_setting_file_ids():
706
raise SettingFileIdUnsupported()
707
with self.lock_write():
708
os.mkdir(self.abspath(path))
709
self.add(path, file_id, 'directory')
988
file_id = generate_ids.gen_file_id(os.path.basename(path))
989
os.mkdir(self.abspath(path))
990
self.add(path, file_id, 'directory')
712
def get_symlink_target(self, path):
713
abspath = self.abspath(path)
993
def get_symlink_target(self, file_id):
994
abspath = self.id2abspath(file_id)
714
995
target = osutils.readlink(abspath)
717
999
def subsume(self, other_tree):
718
raise NotImplementedError(self.subsume)
720
def _directory_is_tree_reference(self, relpath):
721
raise NotImplementedError(self._directory_is_tree_reference)
723
def extract(self, path, format=None):
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()
1040
def _setup_directory_is_tree_reference(self):
1041
if self._branch.repository._format.supports_tree_reference:
1042
self._directory_is_tree_reference = \
1043
self._directory_may_be_tree_reference
1045
self._directory_is_tree_reference = \
1046
self._directory_is_never_tree_reference
1048
def _directory_is_never_tree_reference(self, relpath):
1051
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
1053
# it's a tree reference, except that the root of the tree is not
1054
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
# TODO: We could ask all the control formats whether they
1056
# recognize this directory, but at the moment there's no cheap api
1057
# to do that. Since we probably can only nest bzr checkouts and
1058
# they always use this name it's ok for now. -- mbp 20060306
1060
# FIXME: There is an unhandled case here of a subdirectory
1061
# containing .bzr but not a branch; that will probably blow up
1062
# when you try to commit it. It might happen if there is a
1063
# checkout in a subdirectory. This can be avoided by not adding
1066
@needs_tree_write_lock
1067
def extract(self, file_id, format=None):
724
1068
"""Extract a subtree from this tree.
726
1070
A new branch will be created, relative to the path for this tree.
728
raise NotImplementedError(self.extract)
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)
730
1123
def flush(self):
731
"""Write the in memory meta data to disk."""
732
raise NotImplementedError(self.flush)
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
734
def kind(self, relpath):
1135
def _kind(self, relpath):
735
1136
return osutils.file_kind(self.abspath(relpath))
737
def list_files(self, include_root=False, from_dir=None, recursive=True,
738
recurse_nested=False):
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
739
1139
"""List all files as (path, class, kind, id, entry).
741
1141
Lists, but does not descend into unversioned directories.
746
1146
:param from_dir: start from this directory or None for the root
747
1147
:param recursive: whether to recurse into subdirectories or not
749
raise NotImplementedError(self.list_files)
751
def move(self, from_paths, to_dir=None, after=False):
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):
752
1262
"""Rename files.
754
to_dir must be known to the working tree.
1264
to_dir must exist in the inventory.
756
1266
If to_dir exists and is a directory, the files are moved into
757
1267
it, keeping their old names.
782
1293
This returns a list of (from_path, to_path) pairs for each
783
1294
entry that is moved.
785
raise NotImplementedError(self.move)
787
def copy_one(self, from_rel, to_rel):
788
"""Copy a file in the tree to a new location.
790
This default implementation just copies the file, then
793
:param from_rel: From location (relative to tree root)
794
:param to_rel: Target location (relative to tree root)
796
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
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)
1466
@needs_tree_write_lock
1467
def rename_one(self, from_rel, to_rel, after=False):
1470
This can change the directory or the filename or both.
1472
rename_one has several 'modes' to work. First, it can rename a physical
1473
file and change the file_id. That is the normal mode. Second, it can
1474
only change the file_id without touching any physical file. This is
1475
the new mode introduced in version 0.15.
1477
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1478
versioned but present in the working tree.
1480
rename_one uses the second mode if 'after == False' and 'from_rel' is
1481
versioned but no longer in the working tree, and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the first mode if 'after == False' and 'from_rel' is
1485
versioned and present in the working tree, and 'to_rel' is not
1486
versioned and not present in the working tree.
1488
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
799
1553
def unknowns(self):
800
1554
"""Return all unknown files.
802
1556
These are files in the working directory that are not versioned or
803
1557
control files or ignored.
805
with self.lock_read():
806
# force the extras method to be fully executed before returning, to
807
# prevent race conditions with the lock
809
[subp for subp in self.extras() if not self.is_ignored(subp)])
811
def unversion(self, paths):
812
"""Remove the path in pahs from the current versioned set.
814
When a path is unversioned, all of its children are automatically
1559
# force the extras method to be fully executed before returning, to
1560
# prevent race conditions with the lock
1562
[subp for subp in self.extras() if not self.is_ignored(subp)])
1564
@needs_tree_write_lock
1565
def unversion(self, file_ids):
1566
"""Remove the file ids in file_ids from the current versioned set.
1568
When a file_id is unversioned, all of its children are automatically
817
:param paths: The paths to stop versioning.
818
:raises NoSuchFile: if any path is not currently versioned.
1571
:param file_ids: The file ids to stop versioning.
1572
:raises: NoSuchId if any fileid is not currently versioned.
820
raise NotImplementedError(self.unversion)
1574
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1578
if self._inventory.has_id(file_id):
1579
self._inventory.remove_recursive_id(file_id)
1581
# in the future this should just set a dirty bit to wait for the
1582
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1584
# a read, it is more complex - we need to teach read_inventory
1585
# to know when to read, and when to not read first... and possibly
1586
# to save first when the in memory one may be corrupted.
1587
# so for now, we just only write it if it is indeed dirty.
1589
self._write_inventory(self._inventory)
1591
def _iter_conflicts(self):
1593
for info in self.list_files():
1595
stem = get_conflicted_stem(path)
1598
if stem not in conflicted:
1599
conflicted.add(stem)
822
1603
def pull(self, source, overwrite=False, stop_revision=None,
823
change_reporter=None, possible_transports=None, local=False,
824
show_base=False, tag_selector=None):
825
with self.lock_write(), source.lock_read():
1604
change_reporter=None, possible_transports=None, local=False):
826
1607
old_revision_info = self.branch.last_revision_info()
827
1608
basis_tree = self.basis_tree()
828
1609
count = self.branch.pull(source, overwrite, stop_revision,
829
1610
possible_transports=possible_transports,
830
local=local, tag_selector=tag_selector)
831
1612
new_revision_info = self.branch.last_revision_info()
832
1613
if new_revision_info != old_revision_info:
833
1614
repository = self.branch.repository
834
if repository._format.fast_deltas:
835
parent_ids = self.get_parent_ids()
837
basis_id = parent_ids[0]
838
basis_tree = repository.revision_tree(basis_id)
839
with basis_tree.lock_read():
1615
basis_tree.lock_read()
840
1617
new_basis_tree = self.branch.basis_tree()
841
1618
merge.merge_inner(
846
change_reporter=change_reporter,
848
basis_root_id = basis_tree.path2id('')
849
new_root_id = new_basis_tree.path2id('')
850
if new_root_id is not None and basis_root_id != new_root_id:
1624
change_reporter=change_reporter)
1625
basis_root_id = basis_tree.get_root_id()
1626
new_root_id = new_basis_tree.get_root_id()
1627
if basis_root_id != new_root_id:
851
1628
self.set_root_id(new_root_id)
852
1631
# TODO - dedup parents list with things merged by pull ?
853
1632
# reuse the revisiontree we merged against to set the new
856
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
858
(self.branch.last_revision(), new_basis_tree))
1634
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
859
1635
# we have to pull the merge trees out again, because
860
1636
# merge_inner has set the ids. - this corner is not yet
861
1637
# layered well enough to prevent double handling.
978
1874
when their last revision is set.
980
1876
if _mod_revision.is_null(new_revision):
981
self.branch.set_last_revision_info(0, new_revision)
1877
self.branch.set_revision_history([])
983
_mod_revision.check_not_reserved_id(new_revision)
985
1880
self.branch.generate_revision_history(new_revision)
986
1881
except errors.NoSuchRevision:
987
1882
# not present in the repo - dont try to set it deeper than the tip
988
self.branch._set_revision_history([new_revision])
1883
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
@needs_tree_write_lock
991
1952
def remove(self, files, verbose=False, to_file=None, keep_files=True,
993
"""Remove nominated files from the working tree metadata.
1954
"""Remove nominated files from the working inventory.
995
1956
:files: File paths relative to the basedir.
996
1957
:keep_files: If true, the files will also be kept.
997
1958
:force: Delete files and directories, even if they are changed and
998
1959
even if the directories are not empty.
1000
raise NotImplementedError(self.remove)
1961
if isinstance(files, basestring):
1967
unknown_nested_files=set()
1969
to_file = sys.stdout
1971
def recurse_directory_to_add_files(directory):
1972
# Recurse directory and add all files
1973
# so we can check if they have changed.
1974
for parent_info, file_infos in self.walkdirs(directory):
1975
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
# Is it versioned or ignored?
1977
if self.path2id(relpath) or self.is_ignored(relpath):
1978
# Add nested content for deletion.
1979
new_files.add(relpath)
1981
# Files which are not versioned and not ignored
1982
# should be treated as unknown.
1983
unknown_nested_files.add((relpath, None, kind))
1985
for filename in files:
1986
# Get file name into canonical form.
1987
abspath = self.abspath(filename)
1988
filename = self.relpath(abspath)
1989
if len(filename) > 0:
1990
new_files.add(filename)
1991
recurse_directory_to_add_files(filename)
1993
files = list(new_files)
1996
return # nothing to do
1998
# Sort needed to first handle directory content before the directory
1999
files.sort(reverse=True)
2001
# Bail out if we are going to delete files we shouldn't
2002
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
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)
2032
# Build inv_delta and delete files where applicable,
2033
# do this before any modifications to inventory.
2035
fid = self.path2id(f)
2038
message = "%s is not versioned." % (f,)
2041
# having removed it, it must be either ignored or unknown
2042
if self.is_ignored(f):
2046
# XXX: Really should be a more abstract reporter interface
2047
kind_ch = osutils.kind_marker(self.kind(fid))
2048
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2050
inv_delta.append((f, None, fid, None))
2051
message = "removed %s" % (f,)
2054
abs_path = self.abspath(f)
2055
if osutils.lexists(abs_path):
2056
if (osutils.isdir(abs_path) and
2057
len(os.listdir(abs_path)) > 0):
2059
osutils.rmtree(abs_path)
2061
message = "%s is not an empty directory "\
2062
"and won't be deleted." % (f,)
2064
osutils.delete_any(abs_path)
2065
message = "deleted %s" % (f,)
2066
elif message is not None:
2067
# Only care if we haven't done anything yet.
2068
message = "%s does not exist." % (f,)
2070
# Print only one message (if any) per file.
2071
if message is not None:
2073
self.apply_inventory_delta(inv_delta)
2075
@needs_tree_write_lock
1002
2076
def revert(self, filenames=None, old_tree=None, backups=True,
1003
2077
pb=None, report_changes=False):
1004
from .conflicts import resolve
1005
with cleanup.ExitStack() as exit_stack:
1006
exit_stack.enter_context(self.lock_tree_write())
1007
if old_tree is None:
1008
basis_tree = self.basis_tree()
1009
exit_stack.enter_context(basis_tree.lock_read())
1010
old_tree = basis_tree
2078
from bzrlib.conflicts import resolve
2081
symbol_versioning.warn('Using [] to revert all files is deprecated'
2082
' as of bzr 0.91. Please use None (the default) instead.',
2083
DeprecationWarning, stacklevel=2)
2084
if old_tree is None:
2085
basis_tree = self.basis_tree()
2086
basis_tree.lock_read()
2087
old_tree = basis_tree
1013
2091
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1014
2092
report_changes)
1015
2093
if filenames is None and len(self.get_parent_ids()) > 1:
1018
2096
if last_revision != _mod_revision.NULL_REVISION:
1019
2097
if basis_tree is None:
1020
2098
basis_tree = self.basis_tree()
1021
exit_stack.enter_context(basis_tree.lock_read())
2099
basis_tree.lock_read()
1022
2100
parent_trees.append((last_revision, basis_tree))
1023
2101
self.set_parent_trees(parent_trees)
1026
2104
resolve(self, filenames, ignore_misses=True, recursive=True)
1029
def store_uncommitted(self):
1030
"""Store uncommitted changes from the tree in the branch."""
1031
raise NotImplementedError(self.store_uncommitted)
1033
def restore_uncommitted(self):
1034
"""Restore uncommitted changes from the branch into the tree."""
1035
raise NotImplementedError(self.restore_uncommitted)
2106
if basis_tree is not None:
1037
2110
def revision_tree(self, revision_id):
1038
2111
"""See Tree.revision_tree.
1040
For trees that can be obtained from the working tree, this
1041
will do so. For other trees, it will fall back to the repository.
2113
WorkingTree can supply revision_trees for the basis revision only
2114
because there is only one cached inventory in the bzr directory.
1043
raise NotImplementedError(self.revision_tree)
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)
2158
@needs_tree_write_lock
1045
2159
def set_root_id(self, file_id):
1046
2160
"""Set the root id for this tree."""
1047
if not self.supports_setting_file_ids():
1048
raise SettingFileIdUnsupported()
1049
with self.lock_tree_write():
1053
'WorkingTree.set_root_id with fileid=None')
1054
file_id = osutils.safe_file_id(file_id)
1055
self._set_root_id(file_id)
2164
'WorkingTree.set_root_id with fileid=None')
2165
file_id = osutils.safe_file_id(file_id)
2166
self._set_root_id(file_id)
1057
2168
def _set_root_id(self, file_id):
1058
2169
"""Set the root id for this tree, in a format specific manner.
1142
2269
# We MUST save it even if an error occurs, because otherwise the users
1143
2270
# local work is unreferenced and will appear to have been lost.
1145
with self.lock_tree_write():
1148
last_rev = self.get_parent_ids()[0]
1150
last_rev = _mod_revision.NULL_REVISION
1151
if revision is None:
1152
revision = self.branch.last_revision()
1154
old_tip = old_tip or _mod_revision.NULL_REVISION
1156
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1157
# the branch we are bound to was updated
1158
# merge those changes in first
1159
base_tree = self.basis_tree()
1160
other_tree = self.branch.repository.revision_tree(old_tip)
1161
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1162
base_tree, this_tree=self,
1163
change_reporter=change_reporter,
1164
show_base=show_base)
1166
self.add_parent_tree((old_tip, other_tree))
1167
note(gettext('Rerun update after fixing the conflicts.'))
1170
if last_rev != _mod_revision.ensure_null(revision):
1171
# the working tree is up to date with the branch
1172
# we can merge the specified revision from master
1173
to_tree = self.branch.repository.revision_tree(revision)
1174
to_root_id = to_tree.path2id('')
1176
basis = self.basis_tree()
1177
with basis.lock_read():
1178
if (basis.path2id('') is None or basis.path2id('') != to_root_id):
1179
self.set_root_id(to_root_id)
1182
# determine the branch point
1183
graph = self.branch.repository.get_graph()
1184
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1186
base_tree = self.branch.repository.revision_tree(base_rev_id)
1188
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1190
change_reporter=change_reporter,
1191
show_base=show_base)
1192
self.set_last_revision(revision)
1193
# TODO - dedup parents list with things merged by pull ?
1194
# reuse the tree we've updated to to set the basis:
1195
parent_trees = [(revision, to_tree)]
1196
merges = self.get_parent_ids()[1:]
1197
# Ideally we ask the tree for the trees here, that way the working
1198
# tree can decide whether to give us the entire tree or give us a
1199
# lazy initialised tree. dirstate for instance will have the trees
1200
# in ram already, whereas a last-revision + basis-inventory tree
1201
# will not, but also does not need them when setting parents.
1202
for parent in merges:
1203
parent_trees.append(
1204
(parent, self.branch.repository.revision_tree(parent)))
1205
if not _mod_revision.is_null(old_tip):
1206
parent_trees.append(
1207
(old_tip, self.branch.repository.revision_tree(old_tip)))
1208
self.set_parent_trees(parent_trees)
1209
last_rev = parent_trees[0][0]
2274
last_rev = self.get_parent_ids()[0]
2276
last_rev = _mod_revision.NULL_REVISION
2277
if revision is None:
2278
revision = self.branch.last_revision()
2280
old_tip = old_tip or _mod_revision.NULL_REVISION
2282
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
# the branch we are bound to was updated
2284
# merge those changes in first
2285
base_tree = self.basis_tree()
2286
other_tree = self.branch.repository.revision_tree(old_tip)
2287
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
base_tree, this_tree=self,
2289
change_reporter=change_reporter)
2291
self.add_parent_tree((old_tip, other_tree))
2292
trace.note('Rerun update after fixing the conflicts.')
2295
if last_rev != _mod_revision.ensure_null(revision):
2296
# the working tree is up to date with the branch
2297
# we can merge the specified revision from master
2298
to_tree = self.branch.repository.revision_tree(revision)
2299
to_root_id = to_tree.get_root_id()
2301
basis = self.basis_tree()
2304
if (basis.inventory.root is None
2305
or basis.inventory.root.file_id != to_root_id):
2306
self.set_root_id(to_root_id)
2311
# determine the branch point
2312
graph = self.branch.repository.get_graph()
2313
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
change_reporter=change_reporter)
2320
self.set_last_revision(revision)
2321
# TODO - dedup parents list with things merged by pull ?
2322
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
2324
merges = self.get_parent_ids()[1:]
2325
# Ideally we ask the tree for the trees here, that way the working
2326
# tree can decide whether to give us the entire tree or give us a
2327
# lazy initialised tree. dirstate for instance will have the trees
2328
# in ram already, whereas a last-revision + basis-inventory tree
2329
# will not, but also does not need them when setting parents.
2330
for parent in merges:
2331
parent_trees.append(
2332
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
2334
parent_trees.append(
2335
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
self.set_parent_trees(parent_trees)
2337
last_rev = parent_trees[0][0]
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)
1212
2360
def set_conflicts(self, arg):
1213
2361
raise errors.UnsupportedOperation(self.set_conflicts, self)
1232
2403
If the tree is not locked, it may cause an error to be raised,
1233
2404
depending on the tree implementation.
1235
raise NotImplementedError(self.walkdirs)
1237
@deprecated_method(deprecated_in((3, 0, 1)))
2406
disk_top = self.abspath(prefix)
2407
if disk_top.endswith('/'):
2408
disk_top = disk_top[:-1]
2409
top_strip_len = len(disk_top) + 1
2410
inventory_iterator = self._walkdirs(prefix)
2411
disk_iterator = osutils.walkdirs(disk_top, prefix)
2413
current_disk = disk_iterator.next()
2414
disk_finished = False
2416
if not (e.errno == errno.ENOENT or
2417
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2420
disk_finished = True
2422
current_inv = inventory_iterator.next()
2423
inv_finished = False
2424
except StopIteration:
2427
while not inv_finished or not disk_finished:
2429
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2430
cur_disk_dir_content) = current_disk
2432
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
cur_disk_dir_content) = ((None, None), None)
2434
if not disk_finished:
2435
# strip out .bzr dirs
2436
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2437
len(cur_disk_dir_content) > 0):
2438
# osutils.walkdirs can be made nicer -
2439
# yield the path-from-prefix rather than the pathjoined
2441
bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
if (bzrdir_loc < len(cur_disk_dir_content)
2444
and self.bzrdir.is_control_filename(
2445
cur_disk_dir_content[bzrdir_loc][0])):
2446
# we dont yield the contents of, or, .bzr itself.
2447
del cur_disk_dir_content[bzrdir_loc]
2449
# everything is unknown
2452
# everything is missing
2455
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2457
# disk is before inventory - unknown
2458
dirblock = [(relpath, basename, kind, stat, None, None) for
2459
relpath, basename, kind, stat, top_path in
2460
cur_disk_dir_content]
2461
yield (cur_disk_dir_relpath, None), dirblock
2463
current_disk = disk_iterator.next()
2464
except StopIteration:
2465
disk_finished = True
2467
# inventory is before disk - missing.
2468
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
for relpath, basename, dkind, stat, fileid, kind in
2471
yield (current_inv[0][0], current_inv[0][1]), dirblock
2473
current_inv = inventory_iterator.next()
2474
except StopIteration:
2477
# versioned present directory
2478
# merge the inventory and disk data together
2480
for relpath, subiterator in itertools.groupby(sorted(
2481
current_inv[1] + cur_disk_dir_content,
2482
key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
path_elements = list(subiterator)
2484
if len(path_elements) == 2:
2485
inv_row, disk_row = path_elements
2486
# versioned, present file
2487
dirblock.append((inv_row[0],
2488
inv_row[1], disk_row[2],
2489
disk_row[3], inv_row[4],
2491
elif len(path_elements[0]) == 5:
2493
dirblock.append((path_elements[0][0],
2494
path_elements[0][1], path_elements[0][2],
2495
path_elements[0][3], None, None))
2496
elif len(path_elements[0]) == 6:
2497
# versioned, absent file.
2498
dirblock.append((path_elements[0][0],
2499
path_elements[0][1], 'unknown', None,
2500
path_elements[0][4], path_elements[0][5]))
2502
raise NotImplementedError('unreachable code')
2503
yield current_inv[0], dirblock
2505
current_inv = inventory_iterator.next()
2506
except StopIteration:
2509
current_disk = disk_iterator.next()
2510
except StopIteration:
2511
disk_finished = True
2513
def _walkdirs(self, prefix=""):
2514
"""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,
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:
2552
@needs_tree_write_lock
1238
2553
def auto_resolve(self):
1239
2554
"""Automatically resolve text conflicts according to contents.
1273
def check_state(self):
1274
"""Check that the working state is/isn't valid."""
1275
raise NotImplementedError(self.check_state)
1277
def reset_state(self, revision_ids=None):
1278
"""Reset the state of the working tree.
1280
This does a hard-reset to a last-known-good state. This is a way to
1281
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1283
raise NotImplementedError(self.reset_state)
1285
2614
def _get_rules_searcher(self, default_searcher):
1286
2615
"""See Tree._get_rules_searcher."""
1287
2616
if self._rules_searcher is None:
1288
2617
self._rules_searcher = super(WorkingTree,
1289
self)._get_rules_searcher(default_searcher)
2618
self)._get_rules_searcher(default_searcher)
1290
2619
return self._rules_searcher
1292
2621
def get_shelf_manager(self):
1293
2622
"""Return the ShelfManager for this WorkingTree."""
1294
raise NotImplementedError(self.get_shelf_manager)
1296
def get_canonical_paths(self, paths):
1297
"""Like get_canonical_path() but works on multiple items.
1299
:param paths: A sequence of paths relative to the root of the tree.
1300
:return: A list of paths, with each item the corresponding input path
1301
adjusted to account for existing elements that match case
1304
with self.lock_read():
1308
def get_canonical_path(self, path):
1309
"""Returns the first item in the tree that matches a path.
1311
This is meant to allow case-insensitive path lookups on e.g.
1314
If a path matches exactly, it is returned. If no path matches exactly
1315
but more than one path matches according to the underlying file system,
1316
it is implementation defined which is returned.
1318
If no path matches according to the file system, the input path is
1319
returned, but with as many path entries that do exist changed to their
1322
If you need to resolve many names from the same tree, you should
1323
use get_canonical_paths() to avoid O(N) behaviour.
1325
:param path: A paths relative to the root of the tree.
1326
:return: The input path adjusted to account for existing elements
1327
that match case insensitively.
1329
with self.lock_read():
1330
return next(self.get_canonical_paths([path]))
1332
def reference_parent(self, path, branch=None, possible_transports=None):
1333
raise errors.UnsupportedOperation(self.reference_parent, self)
1335
def get_reference_info(self, path, branch=None):
1336
raise errors.UnsupportedOperation(self.get_reference_info, self)
1338
def set_reference_info(self, tree_path, branch_location):
1339
raise errors.UnsupportedOperation(self.set_reference_info, self)
1342
class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
1343
"""Registry for working tree formats."""
1345
def __init__(self, other_registry=None):
1346
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1347
self._default_format = None
1348
self._default_format_key = None
1350
def get_default(self):
1351
"""Return the current default format."""
1352
if (self._default_format_key is not None and
1353
self._default_format is None):
1354
self._default_format = self.get(self._default_format_key)
1355
return self._default_format
1357
def set_default(self, format):
1358
"""Set the default format."""
1359
self._default_format = format
1360
self._default_format_key = None
1362
def set_default_key(self, format_string):
1363
"""Set the default format by its format string."""
1364
self._default_format_key = format_string
1365
self._default_format = None
1368
format_registry = WorkingTreeFormatRegistry()
1371
class WorkingTreeFormat(ControlComponentFormat):
2623
from bzrlib.shelf import ShelfManager
2624
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):
1372
2770
"""An encapsulation of the initialization and open routines for a format.
1374
2772
Formats provide three things:
1459
2843
"""True if this format supports stored views."""
1462
def get_controldir_for_branch(self):
1463
"""Get the control directory format for creating branches.
1465
This is to support testing of working tree formats that can not exist
1466
in the same control directory as a branch.
1468
return self._matchingcontroldir
1471
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1472
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1473
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1474
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1475
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1476
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1477
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1478
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1479
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
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(),
added
removed
bzrlib/workingtree.py
