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).
33
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
37
from .lazy_import import lazy_import
38
38
lazy_import(globals(), """
39
from bisect import bisect_left
51
43
conflicts as _mod_conflicts,
44
filters as _mod_filters,
60
46
revision as _mod_revision,
70
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
51
from breezy.bzr import (
78
from bzrlib import symbol_versioning
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
82
from bzrlib.lockdir import LockDir
83
import bzrlib.mutabletree
84
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
from bzrlib.osutils import (
96
from bzrlib.filters import filtered_input_file
97
from bzrlib.trace import mutter, note
98
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
100
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
107
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
CONFLICT_HEADER_1 = "BZR conflict list format 1"
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):
59
from .controldir import (
61
ControlComponentFormatRegistry,
62
ControlComponentFormat,
69
from .i18n import gettext
70
from . import mutabletree
71
from .symbol_versioning import deprecated_method, deprecated_in
72
from .trace import mutter, note
75
class SettingFileIdUnsupported(errors.BzrError):
77
_fmt = "This format does not support setting file ids."
80
class ShelvingUnsupported(errors.BzrError):
82
_fmt = "This format does not support shelving changes."
85
class WorkingTree(mutabletree.MutableTree, ControlComponent):
173
86
"""Working copy tree.
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.
88
:ivar basedir: The root of the tree on disk. This is a unicode path object
89
(as opposed to a URL).
182
92
# override this to set the strategy for storing views
184
94
return views.DisabledViews(self)
186
96
def __init__(self, basedir='.',
187
branch=DEPRECATED_PARAMETER,
193
102
"""Construct a WorkingTree instance. This is not a public API.
195
104
:param branch: A branch to override probing for the branch.
197
106
self._format = _format
198
self.bzrdir = _bzrdir
107
self.controldir = _controldir
199
108
if not _internal:
200
raise errors.BzrError("Please use bzrdir.open_workingtree or "
201
"WorkingTree.open() to obtain a WorkingTree.")
202
basedir = safe_unicode(basedir)
109
raise errors.BzrError("Please use controldir.open_workingtree or "
110
"WorkingTree.open() to obtain a WorkingTree.")
111
basedir = osutils.safe_unicode(basedir)
203
112
mutter("opening working tree %r", basedir)
204
if deprecated_passed(branch):
113
if branch is not None:
205
114
self._branch = branch
207
self._branch = self.bzrdir.open_branch()
208
self.basedir = realpath(basedir)
209
# if branch is at our basedir and is a format 6 or less
210
if isinstance(self._format, WorkingTreeFormat2):
211
# share control object
212
self._control_files = self.branch.control_files
214
# assume all other formats have their own control files.
215
self._control_files = _control_files
216
self._transport = self._control_files._transport
217
# update the whole cache up front and write to disk if anything changed;
218
# in the future we might want to do this more selectively
219
# two possible ways offer themselves : in self._unlock, write the cache
220
# if needed, or, when the cache sees a change, append it to the hash
221
# cache file, and have the parser take the most recent entry for a
223
wt_trans = self.bzrdir.get_workingtree_transport(None)
224
cache_filename = wt_trans.local_abspath('stat-cache')
225
self._hashcache = hashcache.HashCache(basedir, cache_filename,
226
self.bzrdir._get_file_mode(),
227
self._content_filter_stack_provider())
230
# is this scan needed ? it makes things kinda slow.
237
if _inventory is None:
238
# This will be acquired on lock_read() or lock_write()
239
self._inventory_is_modified = False
240
self._inventory = None
242
# the caller of __init__ has provided an inventory,
243
# we assume they know what they are doing - as its only
244
# the Format factory and creation methods that are
245
# permitted to do this.
246
self._set_inventory(_inventory, dirty=False)
247
self._detect_case_handling()
116
self._branch = self.controldir.open_branch()
117
self.basedir = osutils.realpath(basedir)
118
self._transport = _transport
248
119
self._rules_searcher = None
249
120
self.views = self._make_views()
252
123
def user_transport(self):
253
return self.bzrdir.user_transport
124
return self.controldir.user_transport
256
127
def control_transport(self):
257
128
return self._transport
259
def _detect_case_handling(self):
260
wt_trans = self.bzrdir.get_workingtree_transport(None)
262
wt_trans.stat("FoRMaT")
263
except errors.NoSuchFile:
264
self.case_sensitive = True
266
self.case_sensitive = False
268
self._setup_directory_is_tree_reference()
130
def supports_symlinks(self):
131
return osutils.supports_symlinks(self.basedir)
133
def is_control_filename(self, filename):
134
"""True if filename is the name of a control file in this tree.
136
:param filename: A filename within the tree. This is a relative path
137
from the root of this tree.
139
This is true IF and ONLY IF the filename is part of the meta data
140
that bzr controls in this tree. I.E. a random .bzr directory placed
141
on disk will not be a control file for this tree.
143
return self.controldir.is_control_filename(filename)
270
145
branch = property(
271
146
fget=lambda self: self._branch,
348
222
path = osutils.getcwd()
349
control, relpath = bzrdir.BzrDir.open_containing(path)
223
control, relpath = ControlDir.open_containing(path)
351
224
return control.open_workingtree(), relpath
227
def open_containing_paths(file_list, default_directory=None,
228
canonicalize=True, apply_view=True):
229
"""Open the WorkingTree that contains a set of paths.
231
Fail if the paths given are not all in a single tree.
233
This is used for the many command-line interfaces that take a list of
234
any number of files and that require they all be in the same tree.
236
if default_directory is None:
237
default_directory = u'.'
238
# recommended replacement for builtins.internal_tree_files
239
if file_list is None or len(file_list) == 0:
240
tree = WorkingTree.open_containing(default_directory)[0]
241
# XXX: doesn't really belong here, and seems to have the strange
242
# side effect of making it return a bunch of files, not the whole
243
# tree -- mbp 20100716
244
if tree.supports_views() and apply_view:
245
view_files = tree.views.lookup_view()
247
file_list = view_files
248
view_str = views.view_display_str(view_files)
249
note(gettext("Ignoring files outside view. View is %s") % view_str)
250
return tree, file_list
251
if default_directory == u'.':
254
seed = default_directory
255
file_list = [osutils.pathjoin(default_directory, f)
257
tree = WorkingTree.open_containing(seed)[0]
258
return tree, tree.safe_relpath_files(file_list, canonicalize,
259
apply_view=apply_view)
261
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
262
"""Convert file_list into a list of relpaths in tree.
264
:param self: A tree to operate on.
265
:param file_list: A list of user provided paths or None.
266
:param apply_view: if True and a view is set, apply it or check that
267
specified files are within it
268
:return: A list of relative paths.
269
:raises errors.PathNotChild: When a provided path is in a different self
272
if file_list is None:
274
if self.supports_views() and apply_view:
275
view_files = self.views.lookup_view()
279
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
280
# doesn't - fix that up here before we enter the loop.
283
return osutils.canonical_relpath(self.basedir, p)
286
for filename in file_list:
287
relpath = fixer(osutils.dereference_path(filename))
288
if view_files and not osutils.is_inside_any(view_files, relpath):
289
raise views.FileOutsideView(filename, view_files)
290
new_list.append(relpath)
354
294
def open_downlevel(path=None):
355
295
"""Open an unsupported working tree.
357
Only intended for advanced situations like upgrading part of a bzrdir.
297
Only intended for advanced situations like upgrading part of a controldir.
359
299
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)
395
301
def __repr__(self):
396
302
return "<%s of %s>" % (self.__class__.__name__,
397
303
getattr(self, 'basedir', None))
399
305
def abspath(self, filename):
400
return pathjoin(self.basedir, filename)
306
return osutils.pathjoin(self.basedir, filename)
402
308
def basis_tree(self):
403
309
"""Return RevisionTree for the current last revision.
447
350
def has_filename(self, filename):
448
351
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
353
def get_file(self, path, filtered=True):
354
return self.get_file_with_stat(path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
356
def get_file_with_stat(self, path, filtered=True,
357
_fstat=osutils.fstat):
455
358
"""See Tree.get_file_with_stat."""
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
359
abspath = self.abspath(path)
361
file_obj = open(abspath, 'rb')
362
except EnvironmentError as e:
363
if e.errno == errno.ENOENT:
364
raise errors.NoSuchFile(path)
459
366
stat_value = _fstat(file_obj.fileno())
460
367
if filtered and self.supports_content_filtering():
461
368
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
370
file_obj, size = _mod_filters.filtered_input_file(
372
stat_value = _mod_filters.FilteredStat(
373
stat_value, st_size=size)
463
374
return (file_obj, stat_value)
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):
376
def get_file_text(self, path, filtered=True):
377
with self.get_file(path, filtered=filtered) as my_file:
378
return my_file.read()
380
def get_file_lines(self, path, filtered=True):
478
381
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
382
with self.get_file(path, filtered=filtered) as file:
481
383
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))
540
385
def get_parent_ids(self):
541
386
"""See Tree.get_parent_ids.
556
401
for l in osutils.split_lines(merges_bytes):
557
revision_id = l.rstrip('\n')
402
revision_id = l.rstrip(b'\n')
558
403
parents.append(revision_id)
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):
406
def clone(self, to_controldir, revision_id=None):
572
407
"""Duplicate this working tree into to_bzr, including all state.
574
409
Specifically modified files are kept as modified, but
575
410
ignored and unknown files are discarded.
577
If you want to make a new line of development, see bzrdir.sprout()
412
If you want to make a new line of development, see ControlDir.sprout()
580
415
If not None, the cloned tree will have its last revision set to
581
416
revision, and difference between the source trees last revision
582
417
and this one merged in.
584
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
586
self.copy_content_into(result, revision_id)
419
with self.lock_read():
420
# assumes the target bzr dir format is compatible.
421
result = to_controldir.create_workingtree()
422
self.copy_content_into(result, revision_id)
590
425
def copy_content_into(self, tree, revision_id=None):
591
426
"""Copy the current content and user files of this tree into tree."""
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):
427
with self.lock_read():
428
tree.set_root_id(self.path2id(''))
429
if revision_id is None:
430
merge.transform_tree(tree, self)
432
# TODO now merge from tree.last_revision to revision (to
433
# preserve user local changes)
435
other_tree = self.revision_tree(revision_id)
436
except errors.NoSuchRevision:
437
other_tree = self.branch.repository.revision_tree(
440
merge.transform_tree(tree, other_tree)
441
if revision_id == _mod_revision.NULL_REVISION:
444
new_parents = [revision_id]
445
tree.set_parent_ids(new_parents)
447
def get_file_size(self, path):
620
448
"""See Tree.get_file_size"""
621
449
# XXX: this returns the on-disk size; it should probably return the
624
return os.path.getsize(self.id2abspath(file_id))
452
return os.path.getsize(self.abspath(path))
626
454
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
686
459
def _gather_kinds(self, files, kinds):
687
460
"""See MutableTree._gather_kinds."""
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)
461
with self.lock_tree_write():
462
for pos, f in enumerate(files):
463
if kinds[pos] is None:
464
fullpath = osutils.normpath(self.abspath(f))
466
kinds[pos] = osutils.file_kind(fullpath)
468
if e.errno == errno.ENOENT:
469
raise errors.NoSuchFile(fullpath)
698
471
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
699
472
"""Add revision_id as a parent.
829
602
:param revision_ids: The revision_ids to set as the parent ids of this
830
603
working tree. Any of these may be ghosts.
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)
605
with self.lock_tree_write():
606
self._check_parents_for_ghosts(revision_ids,
607
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
608
for revision_id in revision_ids:
609
_mod_revision.check_not_reserved_id(revision_id)
611
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
613
if len(revision_ids) > 0:
614
self.set_last_revision(revision_ids[0])
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
616
self.set_last_revision(_mod_revision.NULL_REVISION)
618
self._set_merges_from_parent_ids(revision_ids)
877
620
def set_pending_merges(self, rev_list):
878
parents = self.get_parent_ids()
879
leftmost = parents[:1]
880
new_parents = leftmost + rev_list
881
self.set_parent_ids(new_parents)
621
with self.lock_tree_write():
622
parents = self.get_parent_ids()
623
leftmost = parents[:1]
624
new_parents = leftmost + rev_list
625
self.set_parent_ids(new_parents)
883
@needs_tree_write_lock
884
627
def set_merge_modified(self, modified_hashes):
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)
628
"""Set the merge modified hashes."""
629
raise NotImplementedError(self.set_merge_modified)
890
631
def _sha_from_stat(self, path, stat_result):
891
632
"""Get a sha digest from the tree's stat cache.
956
690
because of a merge.
958
692
This returns a map of file_id->sha1, containing only files which are
959
still in the working inventory and have that text hash.
693
still in the working tree and have that text hash.
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
695
raise NotImplementedError(self.merge_modified)
985
697
def mkdir(self, path, file_id=None):
986
698
"""See MutableTree.mkdir()."""
987
699
if file_id is None:
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')
993
def get_symlink_target(self, file_id):
994
abspath = self.id2abspath(file_id)
995
target = osutils.readlink(abspath)
700
if self.supports_setting_file_ids():
701
file_id = generate_ids.gen_file_id(os.path.basename(path))
703
if not self.supports_setting_file_ids():
704
raise SettingFileIdUnsupported()
705
with self.lock_write():
706
os.mkdir(self.abspath(path))
707
self.add(path, file_id, 'directory')
710
def get_symlink_target(self, path):
711
abspath = self.abspath(path)
713
return osutils.readlink(abspath)
715
if getattr(e, 'errno', None) == errno.ENOENT:
716
raise errors.NoSuchFile(path)
999
719
def subsume(self, other_tree):
1000
def add_children(inventory, entry):
1001
for child_entry in entry.children.values():
1002
inventory._byid[child_entry.file_id] = child_entry
1003
if child_entry.kind == 'directory':
1004
add_children(inventory, child_entry)
1005
if other_tree.get_root_id() == self.get_root_id():
1006
raise errors.BadSubsumeSource(self, other_tree,
1007
'Trees have the same root')
1009
other_tree_path = self.relpath(other_tree.basedir)
1010
except errors.PathNotChild:
1011
raise errors.BadSubsumeSource(self, other_tree,
1012
'Tree is not contained by the other')
1013
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1014
if new_root_parent is None:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Parent directory is not versioned.')
1017
# We need to ensure that the result of a fetch will have a
1018
# versionedfile for the other_tree root, and only fetching into
1019
# RepositoryKnit2 guarantees that.
1020
if not self.branch.repository.supports_rich_root():
1021
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1022
other_tree.lock_tree_write()
1024
new_parents = other_tree.get_parent_ids()
1025
other_root = other_tree.inventory.root
1026
other_root.parent_id = new_root_parent
1027
other_root.name = osutils.basename(other_tree_path)
1028
self.inventory.add(other_root)
1029
add_children(self.inventory, other_root)
1030
self._write_inventory(self.inventory)
1031
# normally we don't want to fetch whole repositories, but i think
1032
# here we really do want to consolidate the whole thing.
1033
for parent_id in other_tree.get_parent_ids():
1034
self.branch.fetch(other_tree.branch, parent_id)
1035
self.add_parent_tree_id(parent_id)
1038
other_tree.bzrdir.retire_bzrdir()
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):
720
raise NotImplementedError(self.subsume)
722
def _directory_is_tree_reference(self, relpath):
723
raise NotImplementedError(self._directory_is_tree_reference)
725
def extract(self, path, format=None):
1068
726
"""Extract a subtree from this tree.
1070
728
A new branch will be created, relative to the path for this tree.
1074
segments = osutils.splitpath(path)
1075
transport = self.branch.bzrdir.root_transport
1076
for name in segments:
1077
transport = transport.clone(name)
1078
transport.ensure_base()
1081
sub_path = self.id2path(file_id)
1082
branch_transport = mkdirs(sub_path)
1084
format = self.bzrdir.cloning_metadir()
1085
branch_transport.ensure_base()
1086
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
repo = branch_bzrdir.find_repository()
1089
except errors.NoRepositoryPresent:
1090
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
1093
new_branch = branch_bzrdir.create_branch()
1094
new_branch.pull(self.branch)
1095
for parent_id in self.get_parent_ids():
1096
new_branch.fetch(self.branch, parent_id)
1097
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
if tree_transport.base != branch_transport.base:
1099
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1103
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1105
wt.set_parent_ids(self.get_parent_ids())
1106
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1108
new_root = my_inv[file_id]
1109
my_inv.remove_recursive_id(file_id)
1110
new_root.parent_id = None
1111
child_inv.add(new_root)
1112
self._write_inventory(my_inv)
1113
wt._write_inventory(child_inv)
1116
def _serialize(self, inventory, out_file):
1117
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1120
def _deserialize(selt, in_file):
1121
return xml5.serializer_v5.read_inventory(in_file)
730
raise NotImplementedError(self.extract)
1123
732
def flush(self):
1124
"""Write the in memory inventory to disk."""
1125
# TODO: Maybe this should only write on dirty ?
1126
if self._control_files._lock_mode != 'w':
1127
raise errors.NotWriteLocked(self)
1129
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1133
self._inventory_is_modified = False
733
"""Write the in memory meta data to disk."""
734
raise NotImplementedError(self.flush)
1135
def _kind(self, relpath):
736
def kind(self, relpath):
1136
737
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
739
def list_files(self, include_root=False, from_dir=None, recursive=True,
740
recurse_nested=False):
1139
741
"""List all files as (path, class, kind, id, entry).
1141
743
Lists, but does not descend into unversioned directories.
1146
748
:param from_dir: start from this directory or None for the root
1147
749
:param recursive: whether to recurse into subdirectories or not
1149
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
# with it. So callers should be careful to always read_lock the tree.
1151
if not self.is_locked():
1152
raise errors.ObjectNotLocked(self)
1154
inv = self.inventory
1155
if from_dir is None and include_root is True:
1156
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
# Convert these into local objects to save lookup times
1158
pathjoin = osutils.pathjoin
1159
file_kind = self._kind
1161
# transport.base ends in a slash, we want the piece
1162
# between the last two slashes
1163
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1165
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
# use a deque and popleft to keep them sorted, or if we use a plain
1181
# list and just reverse() them.
1182
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1185
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1188
f = children.popleft()
1189
## TODO: If we find a subdirectory with its own .bzr
1190
## directory, then that is a separate tree and we
1191
## should exclude it.
1193
# the bzrdir for this tree
1194
if transport_base_dir == f:
1197
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1198
# and 'f' doesn't begin with one, we can do a string op, rather
1199
# than the checks of pathjoin(), all relative paths will have an extra slash
1201
fp = from_dir_relpath + '/' + f
1204
fap = from_dir_abspath + '/' + f
1206
f_ie = inv.get_child(from_dir_id, f)
1209
elif self.is_ignored(fp[1:]):
1212
# we may not have found this file, because of a unicode issue
1213
f_norm, can_access = osutils.normalized_filename(f)
1214
if f == f_norm or not can_access:
1215
# No change, so treat this file normally
1218
# this file can be accessed by a normalized path
1219
# check again if it is versioned
1220
# these lines are repeated here for performance
1222
fp = from_dir_relpath + '/' + f
1223
fap = from_dir_abspath + '/' + f
1224
f_ie = inv.get_child(from_dir_id, f)
1227
elif self.is_ignored(fp[1:]):
1234
# make a last minute entry
1236
yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
yield fp[1:], c, fk, None, fk_entries[fk]()
1241
yield fp[1:], c, fk, None, TreeEntry()
1244
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1257
# if we finished all children, pop it off the stack
1260
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
751
raise NotImplementedError(self.list_files)
753
def move(self, from_paths, to_dir=None, after=False):
1262
754
"""Rename files.
1264
to_dir must exist in the inventory.
756
to_dir must be known to the working tree.
1266
758
If to_dir exists and is a directory, the files are moved into
1267
759
it, keeping their old names.
1293
784
This returns a list of (from_path, to_path) pairs for each
1294
785
entry that is moved.
1299
# check for deprecated use of signature
1301
to_dir = kwargs.get('to_name', None)
1303
raise TypeError('You must supply a target directory')
1305
symbol_versioning.warn('The parameter to_name was deprecated'
1306
' in version 0.13. Use to_dir instead',
1309
# check destination directory
1310
if isinstance(from_paths, basestring):
1312
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
1314
if not isdir(to_abs):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotADirectory(to_abs))
1317
if not self.has_filename(to_dir):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotInWorkingDirectory(to_dir))
1320
to_dir_id = inv.path2id(to_dir)
1321
if to_dir_id is None:
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotVersionedError(path=str(to_dir)))
1325
to_dir_ie = inv[to_dir_id]
1326
if to_dir_ie.kind != 'directory':
1327
raise errors.BzrMoveFailedError('',to_dir,
1328
errors.NotADirectory(to_abs))
1330
# create rename entries and tuples
1331
for from_rel in from_paths:
1332
from_tail = splitpath(from_rel)[-1]
1333
from_id = inv.path2id(from_rel)
1335
raise errors.BzrMoveFailedError(from_rel,to_dir,
1336
errors.NotVersionedError(path=str(from_rel)))
1338
from_entry = inv[from_id]
1339
from_parent_id = from_entry.parent_id
1340
to_rel = pathjoin(to_dir, from_tail)
1341
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1343
from_tail=from_tail,
1344
from_parent_id=from_parent_id,
1345
to_rel=to_rel, to_tail=from_tail,
1346
to_parent_id=to_dir_id)
1347
rename_entries.append(rename_entry)
1348
rename_tuples.append((from_rel, to_rel))
1350
# determine which move mode to use. checks also for movability
1351
rename_entries = self._determine_mv_mode(rename_entries, after)
1353
original_modified = self._inventory_is_modified
1356
self._inventory_is_modified = True
1357
self._move(rename_entries)
1359
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
1362
self._write_inventory(inv)
1363
return rename_tuples
1365
def _determine_mv_mode(self, rename_entries, after=False):
1366
"""Determines for each from-to pair if both inventory and working tree
1367
or only the inventory has to be changed.
1369
Also does basic plausability tests.
1371
inv = self.inventory
1373
for rename_entry in rename_entries:
1374
# store to local variables for easier reference
1375
from_rel = rename_entry.from_rel
1376
from_id = rename_entry.from_id
1377
to_rel = rename_entry.to_rel
1378
to_id = inv.path2id(to_rel)
1379
only_change_inv = False
1381
# check the inventory for source and destination
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(from_rel)))
1385
if to_id is not None:
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.AlreadyVersionedError(path=str(to_rel)))
1389
# try to determine the mode for rename (only change inv or change
1390
# inv and file system)
1392
if not self.has_filename(to_rel):
1393
raise errors.BzrMoveFailedError(from_id,to_rel,
1394
errors.NoSuchFile(path=str(to_rel),
1395
extra="New file has not been created yet"))
1396
only_change_inv = True
1397
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1398
only_change_inv = True
1399
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
only_change_inv = False
1401
elif (not self.case_sensitive
1402
and from_rel.lower() == to_rel.lower()
1403
and self.has_filename(from_rel)):
1404
only_change_inv = False
1406
# something is wrong, so lets determine what exactly
1407
if not self.has_filename(from_rel) and \
1408
not self.has_filename(to_rel):
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.PathsDoNotExist(paths=(str(from_rel),
1413
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1414
rename_entry.only_change_inv = only_change_inv
1415
return rename_entries
1417
def _move(self, rename_entries):
1418
"""Moves a list of files.
1420
Depending on the value of the flag 'only_change_inv', the
1421
file will be moved on the file system or not.
1423
inv = self.inventory
1426
for entry in rename_entries:
1428
self._move_entry(entry)
1430
self._rollback_move(moved)
1434
def _rollback_move(self, moved):
1435
"""Try to rollback a previous move in case of an filesystem error."""
1436
inv = self.inventory
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1441
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
entry.from_tail, entry.from_parent_id,
1443
entry.only_change_inv))
1444
except errors.BzrMoveFailedError, e:
1445
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1446
" The working tree is in an inconsistent state."
1447
" Please consider doing a 'bzr revert'."
1448
" Error message is: %s" % e)
1450
def _move_entry(self, entry):
1451
inv = self.inventory
1452
from_rel_abs = self.abspath(entry.from_rel)
1453
to_rel_abs = self.abspath(entry.to_rel)
1454
if from_rel_abs == to_rel_abs:
1455
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1456
"Source and target are identical.")
1458
if not entry.only_change_inv:
1460
osutils.rename(from_rel_abs, to_rel_abs)
1462
raise errors.BzrMoveFailedError(entry.from_rel,
1464
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
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
787
raise NotImplementedError(self.move)
789
def copy_one(self, from_rel, to_rel):
790
"""Copy a file in the tree to a new location.
792
This default implementation just copies the file, then
795
:param from_rel: From location (relative to tree root)
796
:param to_rel: Target location (relative to tree root)
798
shutil.copyfile(self.abspath(from_rel), self.abspath(to_rel))
1553
801
def unknowns(self):
1554
802
"""Return all unknown files.
1556
804
These are files in the working directory that are not versioned or
1557
805
control files or ignored.
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
807
with self.lock_read():
808
# force the extras method to be fully executed before returning, to
809
# prevent race conditions with the lock
811
[subp for subp in self.extras() if not self.is_ignored(subp)])
813
def unversion(self, paths):
814
"""Remove the path in pahs from the current versioned set.
816
When a path is unversioned, all of its children are automatically
1571
:param file_ids: The file ids to stop versioning.
1572
:raises: NoSuchId if any fileid is not currently versioned.
819
:param paths: The paths to stop versioning.
820
:raises NoSuchFile: if any path is not currently versioned.
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
raise NotImplementedError(self.unversion)
1603
824
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
825
change_reporter=None, possible_transports=None, local=False,
826
show_base=False, tag_selector=None):
827
with self.lock_write(), source.lock_read():
1607
828
old_revision_info = self.branch.last_revision_info()
1608
829
basis_tree = self.basis_tree()
1609
830
count = self.branch.pull(source, overwrite, stop_revision,
1610
831
possible_transports=possible_transports,
832
local=local, tag_selector=tag_selector)
1612
833
new_revision_info = self.branch.last_revision_info()
1613
834
if new_revision_info != old_revision_info:
1614
835
repository = self.branch.repository
1615
basis_tree.lock_read()
836
if repository._format.fast_deltas:
837
parent_ids = self.get_parent_ids()
839
basis_id = parent_ids[0]
840
basis_tree = repository.revision_tree(basis_id)
841
with basis_tree.lock_read():
1617
842
new_basis_tree = self.branch.basis_tree()
1618
843
merge.merge_inner(
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:
848
change_reporter=change_reporter,
850
basis_root_id = basis_tree.path2id('')
851
new_root_id = new_basis_tree.path2id('')
852
if new_root_id is not None and basis_root_id != new_root_id:
1628
853
self.set_root_id(new_root_id)
1631
854
# TODO - dedup parents list with things merged by pull ?
1632
855
# reuse the revisiontree we merged against to set the new
1634
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
858
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
860
(self.branch.last_revision(), new_basis_tree))
1635
861
# we have to pull the merge trees out again, because
1636
862
# merge_inner has set the ids. - this corner is not yet
1637
863
# layered well enough to prevent double handling.
1874
980
when their last revision is set.
1876
982
if _mod_revision.is_null(new_revision):
1877
self.branch.set_revision_history([])
983
self.branch.set_last_revision_info(0, new_revision)
985
_mod_revision.check_not_reserved_id(new_revision)
1880
987
self.branch.generate_revision_history(new_revision)
1881
988
except errors.NoSuchRevision:
1882
989
# not present in the repo - dont try to set it deeper than the tip
1883
self.branch.set_revision_history([new_revision])
990
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
1952
993
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1954
"""Remove nominated files from the working inventory.
995
"""Remove nominated files from the working tree metadata.
1956
997
:files: File paths relative to the basedir.
1957
998
:keep_files: If true, the files will also be kept.
1958
999
:force: Delete files and directories, even if they are changed and
1959
1000
even if the directories are not empty.
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\
1975
self.walkdirs(directory):
1976
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1977
# Is it versioned or ignored?
1978
if self.path2id(relpath) or self.is_ignored(relpath):
1979
# Add nested content for deletion.
1980
new_files.add(relpath)
1982
# Files which are not versioned and not ignored
1983
# should be treated as unknown.
1984
unknown_nested_files.add((relpath, None, kind))
1986
for filename in files:
1987
# Get file name into canonical form.
1988
abspath = self.abspath(filename)
1989
filename = self.relpath(abspath)
1990
if len(filename) > 0:
1991
new_files.add(filename)
1992
recurse_directory_to_add_files(filename)
1994
files = list(new_files)
1997
return # nothing to do
1999
# Sort needed to first handle directory content before the directory
2000
files.sort(reverse=True)
2002
# Bail out if we are going to delete files we shouldn't
2003
if not keep_files and not force:
2004
has_changed_files = len(unknown_nested_files) > 0
2005
if not has_changed_files:
2006
for (file_id, path, content_change, versioned, parent_id, name,
2007
kind, executable) in self.iter_changes(self.basis_tree(),
2008
include_unchanged=True, require_versioned=False,
2009
want_unversioned=True, specific_files=files):
2010
if versioned == (False, False):
2011
# The record is unknown ...
2012
if not self.is_ignored(path[1]):
2013
# ... but not ignored
2014
has_changed_files = True
2016
elif content_change and (kind[1] is not None):
2017
# Versioned and changed, but not deleted
2018
has_changed_files = True
2021
if has_changed_files:
2022
# Make delta show ALL applicable changes in error message.
2023
tree_delta = self.changes_from(self.basis_tree(),
2024
require_versioned=False, want_unversioned=True,
2025
specific_files=files)
2026
for unknown_file in unknown_nested_files:
2027
if unknown_file not in tree_delta.unversioned:
2028
tree_delta.unversioned.extend((unknown_file,))
2029
raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
# Build inv_delta and delete files where applicable,
2032
# do this before any modifications to inventory.
2034
fid = self.path2id(f)
2037
message = "%s is not versioned." % (f,)
2040
# having removed it, it must be either ignored or unknown
2041
if self.is_ignored(f):
2045
# XXX: Really should be a more abstract reporter interface
2046
kind_ch = osutils.kind_marker(self.kind(fid))
2047
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2049
inv_delta.append((f, None, fid, None))
2050
message = "removed %s" % (f,)
2053
abs_path = self.abspath(f)
2054
if osutils.lexists(abs_path):
2055
if (osutils.isdir(abs_path) and
2056
len(os.listdir(abs_path)) > 0):
2058
osutils.rmtree(abs_path)
2060
message = "%s is not an empty directory "\
2061
"and won't be deleted." % (f,)
2063
osutils.delete_any(abs_path)
2064
message = "deleted %s" % (f,)
2065
elif message is not None:
2066
# Only care if we haven't done anything yet.
2067
message = "%s does not exist." % (f,)
2069
# Print only one message (if any) per file.
2070
if message is not None:
2072
self.apply_inventory_delta(inv_delta)
2074
@needs_tree_write_lock
1002
raise NotImplementedError(self.remove)
2075
1004
def revert(self, filenames=None, old_tree=None, backups=True,
2076
1005
pb=None, report_changes=False):
2077
from bzrlib.conflicts import resolve
2080
symbol_versioning.warn('Using [] to revert all files is deprecated'
2081
' as of bzr 0.91. Please use None (the default) instead.',
2082
DeprecationWarning, stacklevel=2)
2083
if old_tree is None:
2084
basis_tree = self.basis_tree()
2085
basis_tree.lock_read()
2086
old_tree = basis_tree
1006
from .conflicts import resolve
1007
with contextlib.ExitStack() as exit_stack:
1008
exit_stack.enter_context(self.lock_tree_write())
1009
if old_tree is None:
1010
basis_tree = self.basis_tree()
1011
exit_stack.enter_context(basis_tree.lock_read())
1012
old_tree = basis_tree
2090
1015
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2091
1016
report_changes)
2092
1017
if filenames is None and len(self.get_parent_ids()) > 1:
2095
1020
if last_revision != _mod_revision.NULL_REVISION:
2096
1021
if basis_tree is None:
2097
1022
basis_tree = self.basis_tree()
2098
basis_tree.lock_read()
1023
exit_stack.enter_context(basis_tree.lock_read())
2099
1024
parent_trees.append((last_revision, basis_tree))
2100
1025
self.set_parent_trees(parent_trees)
2103
1028
resolve(self, filenames, ignore_misses=True, recursive=True)
2105
if basis_tree is not None:
1031
def store_uncommitted(self):
1032
"""Store uncommitted changes from the tree in the branch."""
1033
raise NotImplementedError(self.store_uncommitted)
1035
def restore_uncommitted(self):
1036
"""Restore uncommitted changes from the branch into the tree."""
1037
raise NotImplementedError(self.restore_uncommitted)
2109
1039
def revision_tree(self, revision_id):
2110
1040
"""See Tree.revision_tree.
2112
WorkingTree can supply revision_trees for the basis revision only
2113
because there is only one cached inventory in the bzr directory.
1042
For trees that can be obtained from the working tree, this
1043
will do so. For other trees, it will fall back to the repository.
2115
if revision_id == self.last_revision():
2117
xml = self.read_basis_inventory()
2118
except errors.NoSuchFile:
2122
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2123
# dont use the repository revision_tree api because we want
2124
# to supply the inventory.
2125
if inv.revision_id == revision_id:
2126
return revisiontree.RevisionTree(self.branch.repository,
2128
except errors.BadInventoryFormat:
2130
# raise if there was no inventory, or if we read the wrong inventory.
2131
raise errors.NoSuchRevisionInTree(self, revision_id)
2133
# XXX: This method should be deprecated in favour of taking in a proper
2134
# new Inventory object.
2135
@needs_tree_write_lock
2136
def set_inventory(self, new_inventory_list):
2137
from bzrlib.inventory import (Inventory,
2141
inv = Inventory(self.get_root_id())
2142
for path, file_id, parent, kind in new_inventory_list:
2143
name = os.path.basename(path)
2146
# fixme, there should be a factory function inv,add_??
2147
if kind == 'directory':
2148
inv.add(InventoryDirectory(file_id, name, parent))
2149
elif kind == 'file':
2150
inv.add(InventoryFile(file_id, name, parent))
2151
elif kind == 'symlink':
2152
inv.add(InventoryLink(file_id, name, parent))
2154
raise errors.BzrError("unknown kind %r" % kind)
2155
self._write_inventory(inv)
2157
@needs_tree_write_lock
1045
raise NotImplementedError(self.revision_tree)
2158
1047
def set_root_id(self, file_id):
2159
1048
"""Set the root id for this tree."""
2163
'WorkingTree.set_root_id with fileid=None')
2164
file_id = osutils.safe_file_id(file_id)
2165
self._set_root_id(file_id)
1049
if not self.supports_setting_file_ids():
1050
raise SettingFileIdUnsupported()
1051
with self.lock_tree_write():
1055
'WorkingTree.set_root_id with fileid=None')
1056
self._set_root_id(file_id)
2167
1058
def _set_root_id(self, file_id):
2168
1059
"""Set the root id for this tree, in a format specific manner.
2268
1143
# We MUST save it even if an error occurs, because otherwise the users
2269
1144
# local work is unreferenced and will appear to have been lost.
2273
last_rev = self.get_parent_ids()[0]
2275
last_rev = _mod_revision.NULL_REVISION
2276
if revision is None:
2277
revision = self.branch.last_revision()
2279
old_tip = old_tip or _mod_revision.NULL_REVISION
2281
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
# the branch we are bound to was updated
2283
# merge those changes in first
2284
base_tree = self.basis_tree()
2285
other_tree = self.branch.repository.revision_tree(old_tip)
2286
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
base_tree, this_tree=self,
2288
change_reporter=change_reporter)
2290
self.add_parent_tree((old_tip, other_tree))
2291
trace.note('Rerun update after fixing the conflicts.')
2294
if last_rev != _mod_revision.ensure_null(revision):
2295
# the working tree is up to date with the branch
2296
# we can merge the specified revision from master
2297
to_tree = self.branch.repository.revision_tree(revision)
2298
to_root_id = to_tree.get_root_id()
2300
basis = self.basis_tree()
2303
if (basis.inventory.root is None
2304
or basis.inventory.root.file_id != to_root_id):
2305
self.set_root_id(to_root_id)
2310
# determine the branch point
2311
graph = self.branch.repository.get_graph()
2312
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
change_reporter=change_reporter)
2319
self.set_last_revision(revision)
2320
# TODO - dedup parents list with things merged by pull ?
2321
# reuse the tree we've updated to to set the basis:
2322
parent_trees = [(revision, to_tree)]
2323
merges = self.get_parent_ids()[1:]
2324
# Ideally we ask the tree for the trees here, that way the working
2325
# tree can decide whether to give us the entire tree or give us a
2326
# lazy initialised tree. dirstate for instance will have the trees
2327
# in ram already, whereas a last-revision + basis-inventory tree
2328
# will not, but also does not need them when setting parents.
2329
for parent in merges:
2330
parent_trees.append(
2331
(parent, self.branch.repository.revision_tree(parent)))
2332
if not _mod_revision.is_null(old_tip):
2333
parent_trees.append(
2334
(old_tip, self.branch.repository.revision_tree(old_tip)))
2335
self.set_parent_trees(parent_trees)
2336
last_rev = parent_trees[0][0]
2339
def _write_hashcache_if_dirty(self):
2340
"""Write out the hashcache if it is dirty."""
2341
if self._hashcache.needs_write:
2343
self._hashcache.write()
2345
if e.errno not in (errno.EPERM, errno.EACCES):
2347
# TODO: jam 20061219 Should this be a warning? A single line
2348
# warning might be sufficient to let the user know what
2350
mutter('Could not write hashcache for %s\nError: %s',
2351
self._hashcache.cache_file_name(), e)
2353
@needs_tree_write_lock
2354
def _write_inventory(self, inv):
2355
"""Write inventory as the current inventory."""
2356
self._set_inventory(inv, dirty=True)
1146
with self.lock_tree_write():
1149
last_rev = self.get_parent_ids()[0]
1151
last_rev = _mod_revision.NULL_REVISION
1152
if revision is None:
1153
revision = self.branch.last_revision()
1155
old_tip = old_tip or _mod_revision.NULL_REVISION
1157
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1158
# the branch we are bound to was updated
1159
# merge those changes in first
1160
base_tree = self.basis_tree()
1161
other_tree = self.branch.repository.revision_tree(old_tip)
1162
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1163
base_tree, this_tree=self,
1164
change_reporter=change_reporter,
1165
show_base=show_base)
1167
self.add_parent_tree((old_tip, other_tree))
1168
note(gettext('Rerun update after fixing the conflicts.'))
1171
if last_rev != _mod_revision.ensure_null(revision):
1172
# the working tree is up to date with the branch
1173
# we can merge the specified revision from master
1174
to_tree = self.branch.repository.revision_tree(revision)
1175
to_root_id = to_tree.path2id('')
1177
basis = self.basis_tree()
1178
with basis.lock_read():
1179
if (basis.path2id('') is None or basis.path2id('') != to_root_id):
1180
self.set_root_id(to_root_id)
1183
# determine the branch point
1184
graph = self.branch.repository.get_graph()
1185
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1187
base_tree = self.branch.repository.revision_tree(base_rev_id)
1189
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1191
change_reporter=change_reporter,
1192
show_base=show_base)
1193
self.set_last_revision(revision)
1194
# TODO - dedup parents list with things merged by pull ?
1195
# reuse the tree we've updated to to set the basis:
1196
parent_trees = [(revision, to_tree)]
1197
merges = self.get_parent_ids()[1:]
1198
# Ideally we ask the tree for the trees here, that way the working
1199
# tree can decide whether to give us the entire tree or give us a
1200
# lazy initialised tree. dirstate for instance will have the trees
1201
# in ram already, whereas a last-revision + basis-inventory tree
1202
# will not, but also does not need them when setting parents.
1203
for parent in merges:
1204
parent_trees.append(
1205
(parent, self.branch.repository.revision_tree(parent)))
1206
if not _mod_revision.is_null(old_tip):
1207
parent_trees.append(
1208
(old_tip, self.branch.repository.revision_tree(old_tip)))
1209
self.set_parent_trees(parent_trees)
1210
last_rev = parent_trees[0][0]
2359
1213
def set_conflicts(self, arg):
2360
1214
raise errors.UnsupportedOperation(self.set_conflicts, self)
2402
1233
If the tree is not locked, it may cause an error to be raised,
2403
1234
depending on the tree implementation.
2405
disk_top = self.abspath(prefix)
2406
if disk_top.endswith('/'):
2407
disk_top = disk_top[:-1]
2408
top_strip_len = len(disk_top) + 1
2409
inventory_iterator = self._walkdirs(prefix)
2410
disk_iterator = osutils.walkdirs(disk_top, prefix)
2412
current_disk = disk_iterator.next()
2413
disk_finished = False
2415
if not (e.errno == errno.ENOENT or
2416
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2419
disk_finished = True
2421
current_inv = inventory_iterator.next()
2422
inv_finished = False
2423
except StopIteration:
2426
while not inv_finished or not disk_finished:
2428
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2429
cur_disk_dir_content) = current_disk
2431
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2432
cur_disk_dir_content) = ((None, None), None)
2433
if not disk_finished:
2434
# strip out .bzr dirs
2435
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2436
len(cur_disk_dir_content) > 0):
2437
# osutils.walkdirs can be made nicer -
2438
# yield the path-from-prefix rather than the pathjoined
2440
bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
if (bzrdir_loc < len(cur_disk_dir_content)
2443
and self.bzrdir.is_control_filename(
2444
cur_disk_dir_content[bzrdir_loc][0])):
2445
# we dont yield the contents of, or, .bzr itself.
2446
del cur_disk_dir_content[bzrdir_loc]
2448
# everything is unknown
2451
# everything is missing
2454
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2456
# disk is before inventory - unknown
2457
dirblock = [(relpath, basename, kind, stat, None, None) for
2458
relpath, basename, kind, stat, top_path in
2459
cur_disk_dir_content]
2460
yield (cur_disk_dir_relpath, None), dirblock
2462
current_disk = disk_iterator.next()
2463
except StopIteration:
2464
disk_finished = True
2466
# inventory is before disk - missing.
2467
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2468
for relpath, basename, dkind, stat, fileid, kind in
2470
yield (current_inv[0][0], current_inv[0][1]), dirblock
2472
current_inv = inventory_iterator.next()
2473
except StopIteration:
2476
# versioned present directory
2477
# merge the inventory and disk data together
2479
for relpath, subiterator in itertools.groupby(sorted(
2480
current_inv[1] + cur_disk_dir_content,
2481
key=operator.itemgetter(0)), operator.itemgetter(1)):
2482
path_elements = list(subiterator)
2483
if len(path_elements) == 2:
2484
inv_row, disk_row = path_elements
2485
# versioned, present file
2486
dirblock.append((inv_row[0],
2487
inv_row[1], disk_row[2],
2488
disk_row[3], inv_row[4],
2490
elif len(path_elements[0]) == 5:
2492
dirblock.append((path_elements[0][0],
2493
path_elements[0][1], path_elements[0][2],
2494
path_elements[0][3], None, None))
2495
elif len(path_elements[0]) == 6:
2496
# versioned, absent file.
2497
dirblock.append((path_elements[0][0],
2498
path_elements[0][1], 'unknown', None,
2499
path_elements[0][4], path_elements[0][5]))
2501
raise NotImplementedError('unreachable code')
2502
yield current_inv[0], dirblock
2504
current_inv = inventory_iterator.next()
2505
except StopIteration:
2508
current_disk = disk_iterator.next()
2509
except StopIteration:
2510
disk_finished = True
2512
def _walkdirs(self, prefix=""):
2513
"""Walk the directories of this tree.
2515
:prefix: is used as the directrory to start with.
2516
returns a generator which yields items in the form:
2517
((curren_directory_path, fileid),
2518
[(file1_path, file1_name, file1_kind, None, file1_id,
2521
_directory = 'directory'
2522
# get the root in the inventory
2523
inv = self.inventory
2524
top_id = inv.path2id(prefix)
2528
pending = [(prefix, '', _directory, None, top_id, None)]
2531
currentdir = pending.pop()
2532
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2533
top_id = currentdir[4]
2535
relroot = currentdir[0] + '/'
2538
# FIXME: stash the node in pending
2540
if entry.kind == 'directory':
2541
for name, child in entry.sorted_children():
2542
dirblock.append((relroot + name, name, child.kind, None,
2543
child.file_id, child.kind
2545
yield (currentdir[0], entry.file_id), dirblock
2546
# push the user specified dirs from dirblock
2547
for dir in reversed(dirblock):
2548
if dir[2] == _directory:
2551
@needs_tree_write_lock
1236
raise NotImplementedError(self.walkdirs)
1238
@deprecated_method(deprecated_in((3, 0, 1)))
2552
1239
def auto_resolve(self):
2553
1240
"""Automatically resolve text conflicts according to contents.
1274
def check_state(self):
1275
"""Check that the working state is/isn't valid."""
1276
raise NotImplementedError(self.check_state)
1278
def reset_state(self, revision_ids=None):
1279
"""Reset the state of the working tree.
1281
This does a hard-reset to a last-known-good state. This is a way to
1282
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1284
raise NotImplementedError(self.reset_state)
2613
1286
def _get_rules_searcher(self, default_searcher):
2614
1287
"""See Tree._get_rules_searcher."""
2615
1288
if self._rules_searcher is None:
2616
1289
self._rules_searcher = super(WorkingTree,
2617
self)._get_rules_searcher(default_searcher)
1290
self)._get_rules_searcher(default_searcher)
2618
1291
return self._rules_searcher
2620
1293
def get_shelf_manager(self):
2621
1294
"""Return the ShelfManager for this WorkingTree."""
2622
from bzrlib.shelf import ShelfManager
2623
return ShelfManager(self, self._transport)
2626
class WorkingTree2(WorkingTree):
2627
"""This is the Format 2 working tree.
2629
This was the first weave based working tree.
2630
- uses os locks for locking.
2631
- uses the branch last-revision.
2634
def __init__(self, *args, **kwargs):
2635
super(WorkingTree2, self).__init__(*args, **kwargs)
2636
# WorkingTree2 has more of a constraint that self._inventory must
2637
# exist. Because this is an older format, we don't mind the overhead
2638
# caused by the extra computation here.
2640
# Newer WorkingTree's should only have self._inventory set when they
2642
if self._inventory is None:
2643
self.read_working_inventory()
2645
def _get_check_refs(self):
2646
"""Return the references needed to perform a check of this tree."""
2647
return [('trees', self.last_revision())]
2649
def lock_tree_write(self):
2650
"""See WorkingTree.lock_tree_write().
2652
In Format2 WorkingTrees we have a single lock for the branch and tree
2653
so lock_tree_write() degrades to lock_write().
2655
:return: An object with an unlock method which will release the lock
2658
self.branch.lock_write()
2660
self._control_files.lock_write()
2663
self.branch.unlock()
2667
# do non-implementation specific cleanup
2670
# we share control files:
2671
if self._control_files._lock_count == 3:
2672
# _inventory_is_modified is always False during a read lock.
2673
if self._inventory_is_modified:
2675
self._write_hashcache_if_dirty()
2677
# reverse order of locking.
2679
return self._control_files.unlock()
2681
self.branch.unlock()
2684
class WorkingTree3(WorkingTree):
2685
"""This is the Format 3 working tree.
2687
This differs from the base WorkingTree by:
2688
- having its own file lock
2689
- having its own last-revision property.
2691
This is new in bzr 0.8
2695
def _last_revision(self):
2696
"""See Mutable.last_revision."""
2698
return self._transport.get_bytes('last-revision')
2699
except errors.NoSuchFile:
2700
return _mod_revision.NULL_REVISION
2702
def _change_last_revision(self, revision_id):
2703
"""See WorkingTree._change_last_revision."""
2704
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2706
self._transport.delete('last-revision')
2707
except errors.NoSuchFile:
2711
self._transport.put_bytes('last-revision', revision_id,
2712
mode=self.bzrdir._get_file_mode())
2715
def _get_check_refs(self):
2716
"""Return the references needed to perform a check of this tree."""
2717
return [('trees', self.last_revision())]
2719
@needs_tree_write_lock
2720
def set_conflicts(self, conflicts):
2721
self._put_rio('conflicts', conflicts.to_stanzas(),
2724
@needs_tree_write_lock
2725
def add_conflicts(self, new_conflicts):
2726
conflict_set = set(self.conflicts())
2727
conflict_set.update(set(list(new_conflicts)))
2728
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2729
key=_mod_conflicts.Conflict.sort_key)))
2732
def conflicts(self):
2734
confile = self._transport.get('conflicts')
2735
except errors.NoSuchFile:
2736
return _mod_conflicts.ConflictList()
2739
if confile.next() != CONFLICT_HEADER_1 + '\n':
2740
raise errors.ConflictFormatError()
2741
except StopIteration:
2742
raise errors.ConflictFormatError()
2743
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2748
# do non-implementation specific cleanup
2750
if self._control_files._lock_count == 1:
2751
# _inventory_is_modified is always False during a read lock.
2752
if self._inventory_is_modified:
2754
self._write_hashcache_if_dirty()
2755
# reverse order of locking.
2757
return self._control_files.unlock()
2759
self.branch.unlock()
2762
def get_conflicted_stem(path):
2763
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2764
if path.endswith(suffix):
2765
return path[:-len(suffix)]
2768
class WorkingTreeFormat(object):
1295
raise NotImplementedError(self.get_shelf_manager)
1297
def get_canonical_paths(self, paths):
1298
"""Like get_canonical_path() but works on multiple items.
1300
:param paths: A sequence of paths relative to the root of the tree.
1301
:return: A list of paths, with each item the corresponding input path
1302
adjusted to account for existing elements that match case
1305
with self.lock_read():
1309
def get_canonical_path(self, path):
1310
"""Returns the first item in the tree that matches a path.
1312
This is meant to allow case-insensitive path lookups on e.g.
1315
If a path matches exactly, it is returned. If no path matches exactly
1316
but more than one path matches according to the underlying file system,
1317
it is implementation defined which is returned.
1319
If no path matches according to the file system, the input path is
1320
returned, but with as many path entries that do exist changed to their
1323
If you need to resolve many names from the same tree, you should
1324
use get_canonical_paths() to avoid O(N) behaviour.
1326
:param path: A paths relative to the root of the tree.
1327
:return: The input path adjusted to account for existing elements
1328
that match case insensitively.
1330
with self.lock_read():
1331
return next(self.get_canonical_paths([path]))
1333
def reference_parent(self, path, branch=None, possible_transports=None):
1334
raise errors.UnsupportedOperation(self.reference_parent, self)
1336
def get_reference_info(self, path, branch=None):
1337
raise errors.UnsupportedOperation(self.get_reference_info, self)
1339
def set_reference_info(self, tree_path, branch_location):
1340
raise errors.UnsupportedOperation(self.set_reference_info, self)
1343
class WorkingTreeFormatRegistry(ControlComponentFormatRegistry):
1344
"""Registry for working tree formats."""
1346
def __init__(self, other_registry=None):
1347
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
1348
self._default_format = None
1349
self._default_format_key = None
1351
def get_default(self):
1352
"""Return the current default format."""
1353
if (self._default_format_key is not None and
1354
self._default_format is None):
1355
self._default_format = self.get(self._default_format_key)
1356
return self._default_format
1358
def set_default(self, format):
1359
"""Set the default format."""
1360
self._default_format = format
1361
self._default_format_key = None
1363
def set_default_key(self, format_string):
1364
"""Set the default format by its format string."""
1365
self._default_format_key = format_string
1366
self._default_format = None
1369
format_registry = WorkingTreeFormatRegistry()
1372
class WorkingTreeFormat(ControlComponentFormat):
2769
1373
"""An encapsulation of the initialization and open routines for a format.
2771
1375
Formats provide three things:
2842
1460
"""True if this format supports stored views."""
2846
def register_format(klass, format):
2847
klass._formats[format.get_format_string()] = format
2850
def set_default_format(klass, format):
2851
klass._default_format = format
2854
def unregister_format(klass, format):
2855
del klass._formats[format.get_format_string()]
2858
class WorkingTreeFormat2(WorkingTreeFormat):
2859
"""The second working tree format.
2861
This format modified the hash cache from the format 1 hash cache.
2864
upgrade_recommended = True
2866
def get_format_description(self):
2867
"""See WorkingTreeFormat.get_format_description()."""
2868
return "Working tree format 2"
2870
def _stub_initialize_on_transport(self, transport, file_mode):
2871
"""Workaround: create control files for a remote working tree.
2873
This ensures that it can later be updated and dealt with locally,
2874
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2875
no working tree. (See bug #43064).
2878
inv = inventory.Inventory()
2879
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
transport.put_file('inventory', sio, file_mode)
2882
transport.put_bytes('pending-merges', '', file_mode)
2884
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2885
accelerator_tree=None, hardlink=False):
2886
"""See WorkingTreeFormat.initialize()."""
2887
if not isinstance(a_bzrdir.transport, LocalTransport):
2888
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2889
if from_branch is not None:
2890
branch = from_branch
2892
branch = a_bzrdir.open_branch()
2893
if revision_id is None:
2894
revision_id = _mod_revision.ensure_null(branch.last_revision())
2897
branch.generate_revision_history(revision_id)
2900
inv = inventory.Inventory()
2901
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2907
basis_tree = branch.repository.revision_tree(revision_id)
2908
if basis_tree.inventory.root is not None:
2909
wt.set_root_id(basis_tree.get_root_id())
2910
# set the parent list and cache the basis tree.
2911
if _mod_revision.is_null(revision_id):
2914
parent_trees = [(revision_id, basis_tree)]
2915
wt.set_parent_trees(parent_trees)
2916
transform.build_tree(basis_tree, wt)
2920
super(WorkingTreeFormat2, self).__init__()
2921
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2923
def open(self, a_bzrdir, _found=False):
2924
"""Return the WorkingTree object for a_bzrdir
2926
_found is a private parameter, do not use it. It is used to indicate
2927
if format probing has already been done.
2930
# we are being called directly and must probe.
2931
raise NotImplementedError
2932
if not isinstance(a_bzrdir.transport, LocalTransport):
2933
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2934
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2940
class WorkingTreeFormat3(WorkingTreeFormat):
2941
"""The second working tree format updated to record a format marker.
2944
- exists within a metadir controlling .bzr
2945
- includes an explicit version marker for the workingtree control
2946
files, separate from the BzrDir format
2947
- modifies the hash cache format
2949
- uses a LockDir to guard access for writes.
2952
upgrade_recommended = True
2954
def get_format_string(self):
2955
"""See WorkingTreeFormat.get_format_string()."""
2956
return "Bazaar-NG Working Tree format 3"
2958
def get_format_description(self):
2959
"""See WorkingTreeFormat.get_format_description()."""
2960
return "Working tree format 3"
2962
_lock_file_name = 'lock'
2963
_lock_class = LockDir
2965
_tree_class = WorkingTree3
2967
def __get_matchingbzrdir(self):
2968
return bzrdir.BzrDirMetaFormat1()
2970
_matchingbzrdir = property(__get_matchingbzrdir)
2972
def _open_control_files(self, a_bzrdir):
2973
transport = a_bzrdir.get_workingtree_transport(None)
2974
return LockableFiles(transport, self._lock_file_name,
2977
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2978
accelerator_tree=None, hardlink=False):
2979
"""See WorkingTreeFormat.initialize().
2981
:param revision_id: if supplied, create a working tree at a different
2982
revision than the branch is at.
2983
:param accelerator_tree: A tree which can be used for retrieving file
2984
contents more quickly than the revision tree, i.e. a workingtree.
2985
The revision tree will be used for cases where accelerator_tree's
2986
content is different.
2987
:param hardlink: If true, hard-link files from accelerator_tree,
2990
if not isinstance(a_bzrdir.transport, LocalTransport):
2991
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2992
transport = a_bzrdir.get_workingtree_transport(self)
2993
control_files = self._open_control_files(a_bzrdir)
2994
control_files.create_lock()
2995
control_files.lock_write()
2996
transport.put_bytes('format', self.get_format_string(),
2997
mode=a_bzrdir._get_file_mode())
2998
if from_branch is not None:
2999
branch = from_branch
3001
branch = a_bzrdir.open_branch()
3002
if revision_id is None:
3003
revision_id = _mod_revision.ensure_null(branch.last_revision())
3004
# WorkingTree3 can handle an inventory which has a unique root id.
3005
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3006
# those trees. And because there isn't a format bump inbetween, we
3007
# are maintaining compatibility with older clients.
3008
# inv = Inventory(root_id=gen_root_id())
3009
inv = self._initial_inventory()
3010
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3016
_control_files=control_files)
3017
wt.lock_tree_write()
3019
basis_tree = branch.repository.revision_tree(revision_id)
3020
# only set an explicit root id if there is one to set.
3021
if basis_tree.inventory.root is not None:
3022
wt.set_root_id(basis_tree.get_root_id())
3023
if revision_id == _mod_revision.NULL_REVISION:
3024
wt.set_parent_trees([])
3026
wt.set_parent_trees([(revision_id, basis_tree)])
3027
transform.build_tree(basis_tree, wt)
3029
# Unlock in this order so that the unlock-triggers-flush in
3030
# WorkingTree is given a chance to fire.
3031
control_files.unlock()
3035
def _initial_inventory(self):
3036
return inventory.Inventory()
3039
super(WorkingTreeFormat3, self).__init__()
3041
def open(self, a_bzrdir, _found=False):
3042
"""Return the WorkingTree object for a_bzrdir
3044
_found is a private parameter, do not use it. It is used to indicate
3045
if format probing has already been done.
3048
# we are being called directly and must probe.
3049
raise NotImplementedError
3050
if not isinstance(a_bzrdir.transport, LocalTransport):
3051
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3052
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3055
def _open(self, a_bzrdir, control_files):
3056
"""Open the tree itself.
3058
:param a_bzrdir: the dir for the tree.
3059
:param control_files: the control files for the tree.
3061
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3065
_control_files=control_files)
3068
return self.get_format_string()
3071
__default_format = WorkingTreeFormat6()
3072
WorkingTreeFormat.register_format(__default_format)
3073
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3074
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3076
WorkingTreeFormat.set_default_format(__default_format)
3077
# formats which have no format string are not discoverable
3078
# and not independently creatable, so are not registered.
3079
_legacy_formats = [WorkingTreeFormat2(),
1463
def get_controldir_for_branch(self):
1464
"""Get the control directory format for creating branches.
1466
This is to support testing of working tree formats that can not exist
1467
in the same control directory as a branch.
1469
return self._matchingcontroldir
1472
format_registry.register_lazy(b"Bazaar Working Tree Format 4 (bzr 0.15)\n",
1473
"breezy.bzr.workingtree_4", "WorkingTreeFormat4")
1474
format_registry.register_lazy(b"Bazaar Working Tree Format 5 (bzr 1.11)\n",
1475
"breezy.bzr.workingtree_4", "WorkingTreeFormat5")
1476
format_registry.register_lazy(b"Bazaar Working Tree Format 6 (bzr 1.14)\n",
1477
"breezy.bzr.workingtree_4", "WorkingTreeFormat6")
1478
format_registry.register_lazy(b"Bazaar-NG Working Tree format 3",
1479
"breezy.bzr.workingtree_3", "WorkingTreeFormat3")
1480
format_registry.set_default_key(b"Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
breezy/workingtree.py
