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.lockable_files import LockableFiles
81
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
95
from bzrlib.filters import filtered_input_file
96
from bzrlib.trace import mutter, note
97
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
99
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
106
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
115
class TreeEntry(object):
116
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
119
InventoryEntries without ids - though that seems wrong. For now,
120
this is a parallel hierarchy to InventoryEntry, and needs to become
121
one of several things: decorates to that hierarchy, children of, or
123
Another note is that these objects are currently only used when there is
124
no InventoryEntry available - i.e. for unversioned objects.
125
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
128
def __eq__(self, other):
129
# yes, this us ugly, TODO: best practice __eq__ style.
130
return (isinstance(other, TreeEntry)
131
and other.__class__ == self.__class__)
133
def kind_character(self):
137
class TreeDirectory(TreeEntry):
138
"""See TreeEntry. This is a directory in a working tree."""
140
def __eq__(self, other):
141
return (isinstance(other, TreeDirectory)
142
and other.__class__ == self.__class__)
144
def kind_character(self):
148
class TreeFile(TreeEntry):
149
"""See TreeEntry. This is a regular file in a working tree."""
151
def __eq__(self, other):
152
return (isinstance(other, TreeFile)
153
and other.__class__ == self.__class__)
155
def kind_character(self):
159
class TreeLink(TreeEntry):
160
"""See TreeEntry. This is a symlink in a working tree."""
162
def __eq__(self, other):
163
return (isinstance(other, TreeLink)
164
and other.__class__ == self.__class__)
166
def kind_character(self):
170
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
bzrdir.ControlComponent):
88
172
"""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).
174
The inventory is held in the `Branch` working-inventory, and the
175
files are in a directory on disk.
177
It is possible for a `WorkingTree` to have a filename which is
178
not listed in the Inventory and vice versa.
94
181
# override this to set the strategy for storing views
96
183
return views.DisabledViews(self)
98
185
def __init__(self, basedir='.',
186
branch=DEPRECATED_PARAMETER,
104
192
"""Construct a WorkingTree instance. This is not a public API.
106
194
:param branch: A branch to override probing for the branch.
108
196
self._format = _format
109
self.controldir = _controldir
197
self.bzrdir = _bzrdir
110
198
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)
199
raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
"WorkingTree.open() to obtain a WorkingTree.")
201
basedir = safe_unicode(basedir)
114
202
mutter("opening working tree %r", basedir)
115
if branch is not None:
203
if deprecated_passed(branch):
116
204
self._branch = branch
118
self._branch = self.controldir.open_branch()
119
self.basedir = osutils.realpath(basedir)
120
self._transport = _transport
206
self._branch = self.bzrdir.open_branch()
207
self.basedir = realpath(basedir)
208
# if branch is at our basedir and is a format 6 or less
209
if isinstance(self._format, WorkingTreeFormat2):
210
# share control object
211
self._control_files = self.branch.control_files
213
# assume all other formats have their own control files.
214
self._control_files = _control_files
215
self._transport = self._control_files._transport
216
# update the whole cache up front and write to disk if anything changed;
217
# in the future we might want to do this more selectively
218
# two possible ways offer themselves : in self._unlock, write the cache
219
# if needed, or, when the cache sees a change, append it to the hash
220
# cache file, and have the parser take the most recent entry for a
222
wt_trans = self.bzrdir.get_workingtree_transport(None)
223
cache_filename = wt_trans.local_abspath('stat-cache')
224
self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
self.bzrdir._get_file_mode(),
226
self._content_filter_stack_provider())
229
# is this scan needed ? it makes things kinda slow.
236
if _inventory is None:
237
# This will be acquired on lock_read() or lock_write()
238
self._inventory_is_modified = False
239
self._inventory = None
241
# the caller of __init__ has provided an inventory,
242
# we assume they know what they are doing - as its only
243
# the Format factory and creation methods that are
244
# permitted to do this.
245
self._set_inventory(_inventory, dirty=False)
246
self._detect_case_handling()
121
247
self._rules_searcher = None
122
248
self.views = self._make_views()
125
251
def user_transport(self):
126
return self.controldir.user_transport
252
return self.bzrdir.user_transport
129
255
def control_transport(self):
130
256
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)
258
def _detect_case_handling(self):
259
wt_trans = self.bzrdir.get_workingtree_transport(None)
261
wt_trans.stat("FoRMaT")
262
except errors.NoSuchFile:
263
self.case_sensitive = True
265
self.case_sensitive = False
267
self._setup_directory_is_tree_reference()
147
269
branch = property(
148
270
fget=lambda self: self._branch,
224
347
path = osutils.getcwd()
225
control, relpath = ControlDir.open_containing(path)
348
control, relpath = bzrdir.BzrDir.open_containing(path)
226
350
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
353
def open_downlevel(path=None):
297
354
"""Open an unsupported working tree.
299
Only intended for advanced situations like upgrading part of a controldir.
356
Only intended for advanced situations like upgrading part of a bzrdir.
301
358
return WorkingTree.open(path, _unsupported=True)
361
def find_trees(location):
362
def list_current(transport):
363
return [d for d in transport.list_dir('') if d != '.bzr']
364
def evaluate(bzrdir):
366
tree = bzrdir.open_workingtree()
367
except errors.NoWorkingTree:
371
transport = get_transport(location)
372
iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
373
list_current=list_current)
374
return [t for t in iterator if t is not None]
376
# should be deprecated - this is slow and in any case treating them as a
377
# container is (we now know) bad style -- mbp 20070302
378
## @deprecated_method(zero_fifteen)
380
"""Iterate through file_ids for this tree.
382
file_ids are in a WorkingTree if they are in the working inventory
383
and the working file exists.
385
inv = self._inventory
386
for path, ie in inv.iter_entries():
387
if osutils.lexists(self.abspath(path)):
390
def all_file_ids(self):
391
"""See Tree.iter_all_file_ids"""
392
return set(self.inventory)
303
394
def __repr__(self):
304
395
return "<%s of %s>" % (self.__class__.__name__,
305
396
getattr(self, 'basedir', None))
307
398
def abspath(self, filename):
308
return osutils.pathjoin(self.basedir, filename)
399
return pathjoin(self.basedir, filename)
310
401
def basis_tree(self):
311
402
"""Return RevisionTree for the current last revision.
352
446
def has_filename(self, filename):
353
447
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]
449
def get_file(self, file_id, path=None, filtered=True):
450
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):
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
360
454
"""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)
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
368
458
stat_value = _fstat(file_obj.fileno())
369
459
if filtered and self.supports_content_filtering():
370
460
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)
461
file_obj = filtered_input_file(file_obj, filters)
376
462
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):
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
383
477
"""See Tree.get_file_lines()"""
384
with self.get_file(path, filtered=filtered) as file:
478
file = self.get_file(file_id, path, filtered=filtered)
385
480
return file.readlines()
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
"""See Tree.annotate_iter
488
This implementation will use the basis tree implementation if possible.
489
Lines not in the basis are attributed to CURRENT_REVISION
491
If there are pending merges, lines added by those merges will be
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
387
539
def get_parent_ids(self):
388
540
"""See Tree.get_parent_ids.
403
555
for l in osutils.split_lines(merges_bytes):
404
revision_id = l.rstrip(b'\n')
556
revision_id = l.rstrip('\n')
405
557
parents.append(revision_id)
408
def clone(self, to_controldir, revision_id=None):
561
def get_root_id(self):
562
"""Return the id of this trees root"""
563
return self._inventory.root.file_id
565
def _get_store_filename(self, file_id):
566
## XXX: badly named; this is not in the store at all
567
return self.abspath(self.id2path(file_id))
570
def clone(self, to_bzrdir, revision_id=None):
409
571
"""Duplicate this working tree into to_bzr, including all state.
411
573
Specifically modified files are kept as modified, but
412
574
ignored and unknown files are discarded.
414
If you want to make a new line of development, see ControlDir.sprout()
576
If you want to make a new line of development, see bzrdir.sprout()
417
579
If not None, the cloned tree will have its last revision set to
418
580
revision, and difference between the source trees last revision
419
581
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)
583
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
585
self.copy_content_into(result, revision_id)
427
589
def copy_content_into(self, tree, revision_id=None):
428
590
"""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):
591
tree.set_root_id(self.get_root_id())
592
if revision_id is None:
593
merge.transform_tree(tree, self)
595
# TODO now merge from tree.last_revision to revision (to preserve
596
# user local changes)
597
merge.transform_tree(tree, self)
598
tree.set_parent_ids([revision_id])
600
def id2abspath(self, file_id):
601
return self.abspath(self.id2path(file_id))
603
def has_id(self, file_id):
604
# files that have been deleted are excluded
606
if not inv.has_id(file_id):
608
path = inv.id2path(file_id)
609
return osutils.lexists(self.abspath(path))
611
def has_or_had_id(self, file_id):
612
if file_id == self.inventory.root.file_id:
614
return self.inventory.has_id(file_id)
616
__contains__ = has_id
618
def get_file_size(self, file_id):
450
619
"""See Tree.get_file_size"""
451
620
# XXX: this returns the on-disk size; it should probably return the
454
return os.path.getsize(self.abspath(path))
623
return os.path.getsize(self.id2abspath(file_id))
456
625
if e.errno != errno.ENOENT:
631
def get_file_sha1(self, file_id, path=None, stat_value=None):
633
path = self._inventory.id2path(file_id)
634
return self._hashcache.get_sha1(path, stat_value)
636
def get_file_mtime(self, file_id, path=None):
638
path = self.inventory.id2path(file_id)
639
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
if not supports_executable():
654
def is_executable(self, file_id, path=None):
655
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
def is_executable(self, file_id, path=None):
662
path = self.id2path(file_id)
663
mode = os.lstat(self.abspath(path)).st_mode
664
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
@needs_tree_write_lock
670
def _add(self, files, ids, kinds):
671
"""See MutableTree._add."""
672
# TODO: Re-adding a file that is removed in the working copy
673
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
675
# function - they should be part of lock_write and unlock.
677
for f, file_id, kind in zip(files, ids, kinds):
679
inv.add_path(f, kind=kind)
681
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
684
@needs_tree_write_lock
461
685
def _gather_kinds(self, files, kinds):
462
686
"""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)
687
for pos, f in enumerate(files):
688
if kinds[pos] is None:
689
fullpath = normpath(self.abspath(f))
691
kinds[pos] = file_kind(fullpath)
693
if e.errno == errno.ENOENT:
694
raise errors.NoSuchFile(fullpath)
473
697
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
474
698
"""Add revision_id as a parent.
604
828
:param revision_ids: The revision_ids to set as the parent ids of this
605
829
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])
831
self._check_parents_for_ghosts(revision_ids,
832
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
if len(revision_ids) > 0:
839
self.set_last_revision(revision_ids[0])
841
self.set_last_revision(_mod_revision.NULL_REVISION)
843
self._set_merges_from_parent_ids(revision_ids)
845
@needs_tree_write_lock
846
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
852
self._check_parents_for_ghosts(parent_ids,
853
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
859
leftmost_parent_tree = None
861
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
863
if self._change_last_revision(leftmost_parent_id):
864
if leftmost_parent_tree is None:
865
# If we don't have a tree, fall back to reading the
866
# parent tree from the repository.
867
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)
869
inv = leftmost_parent_tree.inventory
870
xml = self._create_basis_xml_from_inventory(
871
leftmost_parent_id, inv)
872
self._write_basis_inventory(xml)
873
self._set_merges_from_parent_ids(parent_ids)
875
@needs_tree_write_lock
622
876
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)
877
parents = self.get_parent_ids()
878
leftmost = parents[:1]
879
new_parents = leftmost + rev_list
880
self.set_parent_ids(new_parents)
882
@needs_tree_write_lock
629
883
def set_merge_modified(self, modified_hashes):
630
"""Set the merge modified hashes."""
631
raise NotImplementedError(self.set_merge_modified)
885
for file_id, hash in modified_hashes.iteritems():
886
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
633
889
def _sha_from_stat(self, path, stat_result):
634
890
"""Get a sha digest from the tree's stat cache.
692
955
because of a merge.
694
957
This returns a map of file_id->sha1, containing only files which are
695
still in the working tree and have that text hash.
958
still in the working inventory and have that text hash.
697
raise NotImplementedError(self.merge_modified)
961
hashfile = self._transport.get('merge-hashes')
962
except errors.NoSuchFile:
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
970
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
merge_hashes[file_id] = text_hash
699
984
def mkdir(self, path, file_id=None):
700
985
"""See MutableTree.mkdir()."""
701
986
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')
987
file_id = generate_ids.gen_file_id(os.path.basename(path))
988
os.mkdir(self.abspath(path))
989
self.add(path, file_id, 'directory')
712
def get_symlink_target(self, path):
713
abspath = self.abspath(path)
992
def get_symlink_target(self, file_id):
993
abspath = self.id2abspath(file_id)
714
994
target = osutils.readlink(abspath)
717
998
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):
999
def add_children(inventory, entry):
1000
for child_entry in entry.children.values():
1001
inventory._byid[child_entry.file_id] = child_entry
1002
if child_entry.kind == 'directory':
1003
add_children(inventory, child_entry)
1004
if other_tree.get_root_id() == self.get_root_id():
1005
raise errors.BadSubsumeSource(self, other_tree,
1006
'Trees have the same root')
1008
other_tree_path = self.relpath(other_tree.basedir)
1009
except errors.PathNotChild:
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Tree is not contained by the other')
1012
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
if new_root_parent is None:
1014
raise errors.BadSubsumeSource(self, other_tree,
1015
'Parent directory is not versioned.')
1016
# We need to ensure that the result of a fetch will have a
1017
# versionedfile for the other_tree root, and only fetching into
1018
# RepositoryKnit2 guarantees that.
1019
if not self.branch.repository.supports_rich_root():
1020
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
other_tree.lock_tree_write()
1023
new_parents = other_tree.get_parent_ids()
1024
other_root = other_tree.inventory.root
1025
other_root.parent_id = new_root_parent
1026
other_root.name = osutils.basename(other_tree_path)
1027
self.inventory.add(other_root)
1028
add_children(self.inventory, other_root)
1029
self._write_inventory(self.inventory)
1030
# normally we don't want to fetch whole repositories, but i think
1031
# here we really do want to consolidate the whole thing.
1032
for parent_id in other_tree.get_parent_ids():
1033
self.branch.fetch(other_tree.branch, parent_id)
1034
self.add_parent_tree_id(parent_id)
1037
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
@needs_tree_write_lock
1066
def extract(self, file_id, format=None):
724
1067
"""Extract a subtree from this tree.
726
1069
A new branch will be created, relative to the path for this tree.
728
raise NotImplementedError(self.extract)
1073
segments = osutils.splitpath(path)
1074
transport = self.branch.bzrdir.root_transport
1075
for name in segments:
1076
transport = transport.clone(name)
1077
transport.ensure_base()
1080
sub_path = self.id2path(file_id)
1081
branch_transport = mkdirs(sub_path)
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
1085
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
repo = branch_bzrdir.find_repository()
1088
except errors.NoRepositoryPresent:
1089
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1092
new_branch = branch_bzrdir.create_branch()
1093
new_branch.pull(self.branch)
1094
for parent_id in self.get_parent_ids():
1095
new_branch.fetch(self.branch, parent_id)
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
if tree_transport.base != branch_transport.base:
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1102
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
wt.set_parent_ids(self.get_parent_ids())
1105
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1107
new_root = my_inv[file_id]
1108
my_inv.remove_recursive_id(file_id)
1109
new_root.parent_id = None
1110
child_inv.add(new_root)
1111
self._write_inventory(my_inv)
1112
wt._write_inventory(child_inv)
1115
def _serialize(self, inventory, out_file):
1116
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1119
def _deserialize(selt, in_file):
1120
return xml5.serializer_v5.read_inventory(in_file)
730
1122
def flush(self):
731
"""Write the in memory meta data to disk."""
732
raise NotImplementedError(self.flush)
1123
"""Write the in memory inventory to disk."""
1124
# TODO: Maybe this should only write on dirty ?
1125
if self._control_files._lock_mode != 'w':
1126
raise errors.NotWriteLocked(self)
1128
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1132
self._inventory_is_modified = False
734
def kind(self, relpath):
1134
def _kind(self, relpath):
735
1135
return osutils.file_kind(self.abspath(relpath))
737
def list_files(self, include_root=False, from_dir=None, recursive=True,
738
recurse_nested=False):
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
739
1138
"""List all files as (path, class, kind, id, entry).
741
1140
Lists, but does not descend into unversioned directories.
746
1145
:param from_dir: start from this directory or None for the root
747
1146
: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):
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
# with it. So callers should be careful to always read_lock the tree.
1150
if not self.is_locked():
1151
raise errors.ObjectNotLocked(self)
1153
inv = self.inventory
1154
if from_dir is None and include_root is True:
1155
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
# Convert these into local objects to save lookup times
1157
pathjoin = osutils.pathjoin
1158
file_kind = self._kind
1160
# transport.base ends in a slash, we want the piece
1161
# between the last two slashes
1162
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1164
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
# directory file_id, relative path, absolute path, reverse sorted children
1167
if from_dir is not None:
1168
from_dir_id = inv.path2id(from_dir)
1169
if from_dir_id is None:
1170
# Directory not versioned
1172
from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
from_dir_id = inv.root.file_id
1175
from_dir_abspath = self.basedir
1176
children = os.listdir(from_dir_abspath)
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
# use a deque and popleft to keep them sorted, or if we use a plain
1180
# list and just reverse() them.
1181
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1184
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1187
f = children.popleft()
1188
## TODO: If we find a subdirectory with its own .bzr
1189
## directory, then that is a separate tree and we
1190
## should exclude it.
1192
# the bzrdir for this tree
1193
if transport_base_dir == f:
1196
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1197
# and 'f' doesn't begin with one, we can do a string op, rather
1198
# than the checks of pathjoin(), all relative paths will have an extra slash
1200
fp = from_dir_relpath + '/' + f
1203
fap = from_dir_abspath + '/' + f
1205
f_ie = inv.get_child(from_dir_id, f)
1208
elif self.is_ignored(fp[1:]):
1211
# we may not have found this file, because of a unicode issue
1212
f_norm, can_access = osutils.normalized_filename(f)
1213
if f == f_norm or not can_access:
1214
# No change, so treat this file normally
1217
# this file can be accessed by a normalized path
1218
# check again if it is versioned
1219
# these lines are repeated here for performance
1221
fp = from_dir_relpath + '/' + f
1222
fap = from_dir_abspath + '/' + f
1223
f_ie = inv.get_child(from_dir_id, f)
1226
elif self.is_ignored(fp[1:]):
1233
# make a last minute entry
1235
yield fp[1:], c, fk, f_ie.file_id, f_ie
1238
yield fp[1:], c, fk, None, fk_entries[fk]()
1240
yield fp[1:], c, fk, None, TreeEntry()
1243
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
1256
# if we finished all children, pop it off the stack
1259
@needs_tree_write_lock
1260
def move(self, from_paths, to_dir=None, after=False, **kwargs):
752
1261
"""Rename files.
754
to_dir must be known to the working tree.
1263
to_dir must exist in the inventory.
756
1265
If to_dir exists and is a directory, the files are moved into
757
1266
it, keeping their old names.
782
1292
This returns a list of (from_path, to_path) pairs for each
783
1293
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))
1298
# check for deprecated use of signature
1300
to_dir = kwargs.get('to_name', None)
1302
raise TypeError('You must supply a target directory')
1304
symbol_versioning.warn('The parameter to_name was deprecated'
1305
' in version 0.13. Use to_dir instead',
1308
# check destination directory
1309
if isinstance(from_paths, basestring):
1311
inv = self.inventory
1312
to_abs = self.abspath(to_dir)
1313
if not isdir(to_abs):
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotADirectory(to_abs))
1316
if not self.has_filename(to_dir):
1317
raise errors.BzrMoveFailedError('',to_dir,
1318
errors.NotInWorkingDirectory(to_dir))
1319
to_dir_id = inv.path2id(to_dir)
1320
if to_dir_id is None:
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotVersionedError(path=str(to_dir)))
1324
to_dir_ie = inv[to_dir_id]
1325
if to_dir_ie.kind != 'directory':
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotADirectory(to_abs))
1329
# create rename entries and tuples
1330
for from_rel in from_paths:
1331
from_tail = splitpath(from_rel)[-1]
1332
from_id = inv.path2id(from_rel)
1334
raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
errors.NotVersionedError(path=str(from_rel)))
1337
from_entry = inv[from_id]
1338
from_parent_id = from_entry.parent_id
1339
to_rel = pathjoin(to_dir, from_tail)
1340
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1342
from_tail=from_tail,
1343
from_parent_id=from_parent_id,
1344
to_rel=to_rel, to_tail=from_tail,
1345
to_parent_id=to_dir_id)
1346
rename_entries.append(rename_entry)
1347
rename_tuples.append((from_rel, to_rel))
1349
# determine which move mode to use. checks also for movability
1350
rename_entries = self._determine_mv_mode(rename_entries, after)
1352
original_modified = self._inventory_is_modified
1355
self._inventory_is_modified = True
1356
self._move(rename_entries)
1358
# restore the inventory on error
1359
self._inventory_is_modified = original_modified
1361
self._write_inventory(inv)
1362
return rename_tuples
1364
def _determine_mv_mode(self, rename_entries, after=False):
1365
"""Determines for each from-to pair if both inventory and working tree
1366
or only the inventory has to be changed.
1368
Also does basic plausability tests.
1370
inv = self.inventory
1372
for rename_entry in rename_entries:
1373
# store to local variables for easier reference
1374
from_rel = rename_entry.from_rel
1375
from_id = rename_entry.from_id
1376
to_rel = rename_entry.to_rel
1377
to_id = inv.path2id(to_rel)
1378
only_change_inv = False
1380
# check the inventory for source and destination
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.NotVersionedError(path=str(from_rel)))
1384
if to_id is not None:
1385
raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
errors.AlreadyVersionedError(path=str(to_rel)))
1388
# try to determine the mode for rename (only change inv or change
1389
# inv and file system)
1391
if not self.has_filename(to_rel):
1392
raise errors.BzrMoveFailedError(from_id,to_rel,
1393
errors.NoSuchFile(path=str(to_rel),
1394
extra="New file has not been created yet"))
1395
only_change_inv = True
1396
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
only_change_inv = True
1398
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
only_change_inv = False
1400
elif (not self.case_sensitive
1401
and from_rel.lower() == to_rel.lower()
1402
and self.has_filename(from_rel)):
1403
only_change_inv = False
1405
# something is wrong, so lets determine what exactly
1406
if not self.has_filename(from_rel) and \
1407
not self.has_filename(to_rel):
1408
raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
errors.PathsDoNotExist(paths=(str(from_rel),
1412
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
rename_entry.only_change_inv = only_change_inv
1414
return rename_entries
1416
def _move(self, rename_entries):
1417
"""Moves a list of files.
1419
Depending on the value of the flag 'only_change_inv', the
1420
file will be moved on the file system or not.
1422
inv = self.inventory
1425
for entry in rename_entries:
1427
self._move_entry(entry)
1429
self._rollback_move(moved)
1433
def _rollback_move(self, moved):
1434
"""Try to rollback a previous move in case of an filesystem error."""
1435
inv = self.inventory
1438
self._move_entry(WorkingTree._RenameEntry(
1439
entry.to_rel, entry.from_id,
1440
entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
entry.from_tail, entry.from_parent_id,
1442
entry.only_change_inv))
1443
except errors.BzrMoveFailedError, e:
1444
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
" The working tree is in an inconsistent state."
1446
" Please consider doing a 'bzr revert'."
1447
" Error message is: %s" % e)
1449
def _move_entry(self, entry):
1450
inv = self.inventory
1451
from_rel_abs = self.abspath(entry.from_rel)
1452
to_rel_abs = self.abspath(entry.to_rel)
1453
if from_rel_abs == to_rel_abs:
1454
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
"Source and target are identical.")
1457
if not entry.only_change_inv:
1459
osutils.rename(from_rel_abs, to_rel_abs)
1461
raise errors.BzrMoveFailedError(entry.from_rel,
1463
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1465
@needs_tree_write_lock
1466
def rename_one(self, from_rel, to_rel, after=False):
1469
This can change the directory or the filename or both.
1471
rename_one has several 'modes' to work. First, it can rename a physical
1472
file and change the file_id. That is the normal mode. Second, it can
1473
only change the file_id without touching any physical file. This is
1474
the new mode introduced in version 0.15.
1476
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
versioned but present in the working tree.
1479
rename_one uses the second mode if 'after == False' and 'from_rel' is
1480
versioned but no longer in the working tree, and 'to_rel' is not
1481
versioned but present in the working tree.
1483
rename_one uses the first mode if 'after == False' and 'from_rel' is
1484
versioned and present in the working tree, and 'to_rel' is not
1485
versioned and not present in the working tree.
1487
Everything else results in an error.
1489
inv = self.inventory
1492
# create rename entries and tuples
1493
from_tail = splitpath(from_rel)[-1]
1494
from_id = inv.path2id(from_rel)
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1507
from_parent_id = from_entry.parent_id
1508
to_dir, to_tail = os.path.split(to_rel)
1509
to_dir_id = inv.path2id(to_dir)
1510
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1512
from_tail=from_tail,
1513
from_parent_id=from_parent_id,
1514
to_rel=to_rel, to_tail=to_tail,
1515
to_parent_id=to_dir_id)
1516
rename_entries.append(rename_entry)
1518
# determine which move mode to use. checks also for movability
1519
rename_entries = self._determine_mv_mode(rename_entries, after)
1521
# check if the target changed directory and if the target directory is
1523
if to_dir_id is None:
1524
raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
errors.NotVersionedError(path=str(to_dir)))
1527
# all checks done. now we can continue with our actual work
1528
mutter('rename_one:\n'
1533
' to_dir_id {%s}\n',
1534
from_id, from_rel, to_rel, to_dir, to_dir_id)
1536
self._move(rename_entries)
1537
self._write_inventory(inv)
1539
class _RenameEntry(object):
1540
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
self.from_rel = from_rel
1543
self.from_id = from_id
1544
self.from_tail = from_tail
1545
self.from_parent_id = from_parent_id
1546
self.to_rel = to_rel
1547
self.to_tail = to_tail
1548
self.to_parent_id = to_parent_id
1549
self.only_change_inv = only_change_inv
799
1552
def unknowns(self):
800
1553
"""Return all unknown files.
802
1555
These are files in the working directory that are not versioned or
803
1556
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
1558
# force the extras method to be fully executed before returning, to
1559
# prevent race conditions with the lock
1561
[subp for subp in self.extras() if not self.is_ignored(subp)])
1563
@needs_tree_write_lock
1564
def unversion(self, file_ids):
1565
"""Remove the file ids in file_ids from the current versioned set.
1567
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.
1570
:param file_ids: The file ids to stop versioning.
1571
:raises: NoSuchId if any fileid is not currently versioned.
820
raise NotImplementedError(self.unversion)
1573
for file_id in file_ids:
1574
if file_id not in self._inventory:
1575
raise errors.NoSuchId(self, file_id)
1576
for file_id in file_ids:
1577
if self._inventory.has_id(file_id):
1578
self._inventory.remove_recursive_id(file_id)
1580
# in the future this should just set a dirty bit to wait for the
1581
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1583
# a read, it is more complex - we need to teach read_inventory
1584
# to know when to read, and when to not read first... and possibly
1585
# to save first when the in memory one may be corrupted.
1586
# so for now, we just only write it if it is indeed dirty.
1588
self._write_inventory(self._inventory)
1590
def _iter_conflicts(self):
1592
for info in self.list_files():
1594
stem = get_conflicted_stem(path)
1597
if stem not in conflicted:
1598
conflicted.add(stem)
822
1602
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():
1603
change_reporter=None, possible_transports=None, local=False):
826
1606
old_revision_info = self.branch.last_revision_info()
827
1607
basis_tree = self.basis_tree()
828
1608
count = self.branch.pull(source, overwrite, stop_revision,
829
1609
possible_transports=possible_transports,
830
local=local, tag_selector=tag_selector)
831
1611
new_revision_info = self.branch.last_revision_info()
832
1612
if new_revision_info != old_revision_info:
833
1613
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():
1614
basis_tree.lock_read()
840
1616
new_basis_tree = self.branch.basis_tree()
841
1617
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:
1623
change_reporter=change_reporter)
1624
basis_root_id = basis_tree.get_root_id()
1625
new_root_id = new_basis_tree.get_root_id()
1626
if basis_root_id != new_root_id:
851
1627
self.set_root_id(new_root_id)
852
1630
# TODO - dedup parents list with things merged by pull ?
853
1631
# 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))
1633
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
859
1634
# we have to pull the merge trees out again, because
860
1635
# merge_inner has set the ids. - this corner is not yet
861
1636
# layered well enough to prevent double handling.
978
1876
when their last revision is set.
980
1878
if _mod_revision.is_null(new_revision):
981
self.branch.set_last_revision_info(0, new_revision)
1879
self.branch.set_revision_history([])
983
_mod_revision.check_not_reserved_id(new_revision)
985
1882
self.branch.generate_revision_history(new_revision)
986
1883
except errors.NoSuchRevision:
987
1884
# not present in the repo - dont try to set it deeper than the tip
988
self.branch._set_revision_history([new_revision])
1885
self.branch.set_revision_history([new_revision])
1888
def _write_basis_inventory(self, xml):
1889
"""Write the basis inventory XML to the basis-inventory file"""
1890
path = self._basis_inventory_name()
1892
self._transport.put_file(path, sio,
1893
mode=self.bzrdir._get_file_mode())
1895
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1896
"""Create the text that will be saved in basis-inventory"""
1897
inventory.revision_id = revision_id
1898
return xml7.serializer_v7.write_inventory_to_string(inventory)
1900
def _cache_basis_inventory(self, new_revision):
1901
"""Cache new_revision as the basis inventory."""
1902
# TODO: this should allow the ready-to-use inventory to be passed in,
1903
# as commit already has that ready-to-use [while the format is the
1906
# this double handles the inventory - unpack and repack -
1907
# but is easier to understand. We can/should put a conditional
1908
# in here based on whether the inventory is in the latest format
1909
# - perhaps we should repack all inventories on a repository
1911
# the fast path is to copy the raw xml from the repository. If the
1912
# xml contains 'revision_id="', then we assume the right
1913
# revision_id is set. We must check for this full string, because a
1914
# root node id can legitimately look like 'revision_id' but cannot
1916
xml = self.branch.repository._get_inventory_xml(new_revision)
1917
firstline = xml.split('\n', 1)[0]
1918
if (not 'revision_id="' in firstline or
1919
'format="7"' not in firstline):
1920
inv = self.branch.repository._serializer.read_inventory_from_string(
1922
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
self._write_basis_inventory(xml)
1924
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1927
def read_basis_inventory(self):
1928
"""Read the cached basis inventory."""
1929
path = self._basis_inventory_name()
1930
return self._transport.get_bytes(path)
1933
def read_working_inventory(self):
1934
"""Read the working inventory.
1936
:raises errors.InventoryModified: read_working_inventory will fail
1937
when the current in memory inventory has been modified.
1939
# conceptually this should be an implementation detail of the tree.
1940
# XXX: Deprecate this.
1941
# ElementTree does its own conversion from UTF-8, so open in
1943
if self._inventory_is_modified:
1944
raise errors.InventoryModified(self)
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1950
self._set_inventory(result, dirty=False)
1953
@needs_tree_write_lock
991
1954
def remove(self, files, verbose=False, to_file=None, keep_files=True,
993
"""Remove nominated files from the working tree metadata.
1956
"""Remove nominated files from the working inventory.
995
1958
:files: File paths relative to the basedir.
996
1959
:keep_files: If true, the files will also be kept.
997
1960
:force: Delete files and directories, even if they are changed and
998
1961
even if the directories are not empty.
1000
raise NotImplementedError(self.remove)
1963
if isinstance(files, basestring):
1969
unknown_nested_files=set()
1971
to_file = sys.stdout
1973
def recurse_directory_to_add_files(directory):
1974
# Recurse directory and add all files
1975
# so we can check if they have changed.
1976
for parent_info, file_infos in\
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1979
# Is it versioned or ignored?
1980
if self.path2id(relpath) or self.is_ignored(relpath):
1981
# Add nested content for deletion.
1982
new_files.add(relpath)
1984
# Files which are not versioned and not ignored
1985
# should be treated as unknown.
1986
unknown_nested_files.add((relpath, None, kind))
1988
for filename in files:
1989
# Get file name into canonical form.
1990
abspath = self.abspath(filename)
1991
filename = self.relpath(abspath)
1992
if len(filename) > 0:
1993
new_files.add(filename)
1994
recurse_directory_to_add_files(filename)
1996
files = list(new_files)
1999
return # nothing to do
2001
# Sort needed to first handle directory content before the directory
2002
files.sort(reverse=True)
2004
# Bail out if we are going to delete files we shouldn't
2005
if not keep_files and not force:
2006
has_changed_files = len(unknown_nested_files) > 0
2007
if not has_changed_files:
2008
for (file_id, path, content_change, versioned, parent_id, name,
2009
kind, executable) in self.iter_changes(self.basis_tree(),
2010
include_unchanged=True, require_versioned=False,
2011
want_unversioned=True, specific_files=files):
2012
if versioned == (False, False):
2013
# The record is unknown ...
2014
if not self.is_ignored(path[1]):
2015
# ... but not ignored
2016
has_changed_files = True
2018
elif content_change and (kind[1] is not None):
2019
# Versioned and changed, but not deleted
2020
has_changed_files = True
2023
if has_changed_files:
2024
# Make delta show ALL applicable changes in error message.
2025
tree_delta = self.changes_from(self.basis_tree(),
2026
require_versioned=False, want_unversioned=True,
2027
specific_files=files)
2028
for unknown_file in unknown_nested_files:
2029
if unknown_file not in tree_delta.unversioned:
2030
tree_delta.unversioned.extend((unknown_file,))
2031
raise errors.BzrRemoveChangedFilesError(tree_delta)
2033
# Build inv_delta and delete files where applicable,
2034
# do this before any modifications to inventory.
2036
fid = self.path2id(f)
2039
message = "%s is not versioned." % (f,)
2042
# having removed it, it must be either ignored or unknown
2043
if self.is_ignored(f):
2047
# XXX: Really should be a more abstract reporter interface
2048
kind_ch = osutils.kind_marker(self.kind(fid))
2049
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2051
inv_delta.append((f, None, fid, None))
2052
message = "removed %s" % (f,)
2055
abs_path = self.abspath(f)
2056
if osutils.lexists(abs_path):
2057
if (osutils.isdir(abs_path) and
2058
len(os.listdir(abs_path)) > 0):
2060
osutils.rmtree(abs_path)
2062
message = "%s is not an empty directory "\
2063
"and won't be deleted." % (f,)
2065
osutils.delete_any(abs_path)
2066
message = "deleted %s" % (f,)
2067
elif message is not None:
2068
# Only care if we haven't done anything yet.
2069
message = "%s does not exist." % (f,)
2071
# Print only one message (if any) per file.
2072
if message is not None:
2074
self.apply_inventory_delta(inv_delta)
2076
@needs_tree_write_lock
1002
2077
def revert(self, filenames=None, old_tree=None, backups=True,
1003
2078
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
2079
from bzrlib.conflicts import resolve
2082
symbol_versioning.warn('Using [] to revert all files is deprecated'
2083
' as of bzr 0.91. Please use None (the default) instead.',
2084
DeprecationWarning, stacklevel=2)
2085
if old_tree is None:
2086
basis_tree = self.basis_tree()
2087
basis_tree.lock_read()
2088
old_tree = basis_tree
1013
2092
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1014
2093
report_changes)
1015
2094
if filenames is None and len(self.get_parent_ids()) > 1:
1018
2097
if last_revision != _mod_revision.NULL_REVISION:
1019
2098
if basis_tree is None:
1020
2099
basis_tree = self.basis_tree()
1021
exit_stack.enter_context(basis_tree.lock_read())
2100
basis_tree.lock_read()
1022
2101
parent_trees.append((last_revision, basis_tree))
1023
2102
self.set_parent_trees(parent_trees)
1026
2105
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)
2107
if basis_tree is not None:
1037
2111
def revision_tree(self, revision_id):
1038
2112
"""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.
2114
WorkingTree can supply revision_trees for the basis revision only
2115
because there is only one cached inventory in the bzr directory.
1043
raise NotImplementedError(self.revision_tree)
2117
if revision_id == self.last_revision():
2119
xml = self.read_basis_inventory()
2120
except errors.NoSuchFile:
2124
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2125
# dont use the repository revision_tree api because we want
2126
# to supply the inventory.
2127
if inv.revision_id == revision_id:
2128
return revisiontree.RevisionTree(self.branch.repository,
2130
except errors.BadInventoryFormat:
2132
# raise if there was no inventory, or if we read the wrong inventory.
2133
raise errors.NoSuchRevisionInTree(self, revision_id)
2135
# XXX: This method should be deprecated in favour of taking in a proper
2136
# new Inventory object.
2137
@needs_tree_write_lock
2138
def set_inventory(self, new_inventory_list):
2139
from bzrlib.inventory import (Inventory,
2143
inv = Inventory(self.get_root_id())
2144
for path, file_id, parent, kind in new_inventory_list:
2145
name = os.path.basename(path)
2148
# fixme, there should be a factory function inv,add_??
2149
if kind == 'directory':
2150
inv.add(InventoryDirectory(file_id, name, parent))
2151
elif kind == 'file':
2152
inv.add(InventoryFile(file_id, name, parent))
2153
elif kind == 'symlink':
2154
inv.add(InventoryLink(file_id, name, parent))
2156
raise errors.BzrError("unknown kind %r" % kind)
2157
self._write_inventory(inv)
2159
@needs_tree_write_lock
1045
2160
def set_root_id(self, file_id):
1046
2161
"""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)
2165
'WorkingTree.set_root_id with fileid=None')
2166
file_id = osutils.safe_file_id(file_id)
2167
self._set_root_id(file_id)
1057
2169
def _set_root_id(self, file_id):
1058
2170
"""Set the root id for this tree, in a format specific manner.
1142
2270
# We MUST save it even if an error occurs, because otherwise the users
1143
2271
# 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]
2275
last_rev = self.get_parent_ids()[0]
2277
last_rev = _mod_revision.NULL_REVISION
2278
if revision is None:
2279
revision = self.branch.last_revision()
2281
old_tip = old_tip or _mod_revision.NULL_REVISION
2283
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
# the branch we are bound to was updated
2285
# merge those changes in first
2286
base_tree = self.basis_tree()
2287
other_tree = self.branch.repository.revision_tree(old_tip)
2288
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
base_tree, this_tree=self,
2290
change_reporter=change_reporter)
2292
self.add_parent_tree((old_tip, other_tree))
2293
trace.note('Rerun update after fixing the conflicts.')
2296
if last_rev != _mod_revision.ensure_null(revision):
2297
# the working tree is up to date with the branch
2298
# we can merge the specified revision from master
2299
to_tree = self.branch.repository.revision_tree(revision)
2300
to_root_id = to_tree.get_root_id()
2302
basis = self.basis_tree()
2305
if (basis.inventory.root is None
2306
or basis.inventory.root.file_id != to_root_id):
2307
self.set_root_id(to_root_id)
2312
# determine the branch point
2313
graph = self.branch.repository.get_graph()
2314
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2316
base_tree = self.branch.repository.revision_tree(base_rev_id)
2318
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2320
change_reporter=change_reporter)
2321
self.set_last_revision(revision)
2322
# TODO - dedup parents list with things merged by pull ?
2323
# reuse the tree we've updated to to set the basis:
2324
parent_trees = [(revision, to_tree)]
2325
merges = self.get_parent_ids()[1:]
2326
# Ideally we ask the tree for the trees here, that way the working
2327
# tree can decide whether to give us the entire tree or give us a
2328
# lazy initialised tree. dirstate for instance will have the trees
2329
# in ram already, whereas a last-revision + basis-inventory tree
2330
# will not, but also does not need them when setting parents.
2331
for parent in merges:
2332
parent_trees.append(
2333
(parent, self.branch.repository.revision_tree(parent)))
2334
if not _mod_revision.is_null(old_tip):
2335
parent_trees.append(
2336
(old_tip, self.branch.repository.revision_tree(old_tip)))
2337
self.set_parent_trees(parent_trees)
2338
last_rev = parent_trees[0][0]
2341
def _write_hashcache_if_dirty(self):
2342
"""Write out the hashcache if it is dirty."""
2343
if self._hashcache.needs_write:
2345
self._hashcache.write()
2347
if e.errno not in (errno.EPERM, errno.EACCES):
2349
# TODO: jam 20061219 Should this be a warning? A single line
2350
# warning might be sufficient to let the user know what
2352
mutter('Could not write hashcache for %s\nError: %s',
2353
self._hashcache.cache_file_name(), e)
2355
@needs_tree_write_lock
2356
def _write_inventory(self, inv):
2357
"""Write inventory as the current inventory."""
2358
self._set_inventory(inv, dirty=True)
1212
2361
def set_conflicts(self, arg):
1213
2362
raise errors.UnsupportedOperation(self.set_conflicts, self)
1232
2404
If the tree is not locked, it may cause an error to be raised,
1233
2405
depending on the tree implementation.
1235
raise NotImplementedError(self.walkdirs)
1237
@deprecated_method(deprecated_in((3, 0, 1)))
2407
disk_top = self.abspath(prefix)
2408
if disk_top.endswith('/'):
2409
disk_top = disk_top[:-1]
2410
top_strip_len = len(disk_top) + 1
2411
inventory_iterator = self._walkdirs(prefix)
2412
disk_iterator = osutils.walkdirs(disk_top, prefix)
2414
current_disk = disk_iterator.next()
2415
disk_finished = False
2417
if not (e.errno == errno.ENOENT or
2418
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2421
disk_finished = True
2423
current_inv = inventory_iterator.next()
2424
inv_finished = False
2425
except StopIteration:
2428
while not inv_finished or not disk_finished:
2430
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2431
cur_disk_dir_content) = current_disk
2433
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
cur_disk_dir_content) = ((None, None), None)
2435
if not disk_finished:
2436
# strip out .bzr dirs
2437
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2438
len(cur_disk_dir_content) > 0):
2439
# osutils.walkdirs can be made nicer -
2440
# yield the path-from-prefix rather than the pathjoined
2442
bzrdir_loc = bisect_left(cur_disk_dir_content,
2444
if (bzrdir_loc < len(cur_disk_dir_content)
2445
and self.bzrdir.is_control_filename(
2446
cur_disk_dir_content[bzrdir_loc][0])):
2447
# we dont yield the contents of, or, .bzr itself.
2448
del cur_disk_dir_content[bzrdir_loc]
2450
# everything is unknown
2453
# everything is missing
2456
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2458
# disk is before inventory - unknown
2459
dirblock = [(relpath, basename, kind, stat, None, None) for
2460
relpath, basename, kind, stat, top_path in
2461
cur_disk_dir_content]
2462
yield (cur_disk_dir_relpath, None), dirblock
2464
current_disk = disk_iterator.next()
2465
except StopIteration:
2466
disk_finished = True
2468
# inventory is before disk - missing.
2469
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2470
for relpath, basename, dkind, stat, fileid, kind in
2472
yield (current_inv[0][0], current_inv[0][1]), dirblock
2474
current_inv = inventory_iterator.next()
2475
except StopIteration:
2478
# versioned present directory
2479
# merge the inventory and disk data together
2481
for relpath, subiterator in itertools.groupby(sorted(
2482
current_inv[1] + cur_disk_dir_content,
2483
key=operator.itemgetter(0)), operator.itemgetter(1)):
2484
path_elements = list(subiterator)
2485
if len(path_elements) == 2:
2486
inv_row, disk_row = path_elements
2487
# versioned, present file
2488
dirblock.append((inv_row[0],
2489
inv_row[1], disk_row[2],
2490
disk_row[3], inv_row[4],
2492
elif len(path_elements[0]) == 5:
2494
dirblock.append((path_elements[0][0],
2495
path_elements[0][1], path_elements[0][2],
2496
path_elements[0][3], None, None))
2497
elif len(path_elements[0]) == 6:
2498
# versioned, absent file.
2499
dirblock.append((path_elements[0][0],
2500
path_elements[0][1], 'unknown', None,
2501
path_elements[0][4], path_elements[0][5]))
2503
raise NotImplementedError('unreachable code')
2504
yield current_inv[0], dirblock
2506
current_inv = inventory_iterator.next()
2507
except StopIteration:
2510
current_disk = disk_iterator.next()
2511
except StopIteration:
2512
disk_finished = True
2514
def _walkdirs(self, prefix=""):
2515
"""Walk the directories of this tree.
2517
:prefix: is used as the directrory to start with.
2518
returns a generator which yields items in the form:
2519
((curren_directory_path, fileid),
2520
[(file1_path, file1_name, file1_kind, None, file1_id,
2523
_directory = 'directory'
2524
# get the root in the inventory
2525
inv = self.inventory
2526
top_id = inv.path2id(prefix)
2530
pending = [(prefix, '', _directory, None, top_id, None)]
2533
currentdir = pending.pop()
2534
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2535
top_id = currentdir[4]
2537
relroot = currentdir[0] + '/'
2540
# FIXME: stash the node in pending
2542
if entry.kind == 'directory':
2543
for name, child in entry.sorted_children():
2544
dirblock.append((relroot + name, name, child.kind, None,
2545
child.file_id, child.kind
2547
yield (currentdir[0], entry.file_id), dirblock
2548
# push the user specified dirs from dirblock
2549
for dir in reversed(dirblock):
2550
if dir[2] == _directory:
2553
@needs_tree_write_lock
1238
2554
def auto_resolve(self):
1239
2555
"""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
2615
def _get_rules_searcher(self, default_searcher):
1286
2616
"""See Tree._get_rules_searcher."""
1287
2617
if self._rules_searcher is None:
1288
2618
self._rules_searcher = super(WorkingTree,
1289
self)._get_rules_searcher(default_searcher)
2619
self)._get_rules_searcher(default_searcher)
1290
2620
return self._rules_searcher
1292
2622
def get_shelf_manager(self):
1293
2623
"""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):
2624
from bzrlib.shelf import ShelfManager
2625
return ShelfManager(self, self._transport)
2628
class WorkingTree2(WorkingTree):
2629
"""This is the Format 2 working tree.
2631
This was the first weave based working tree.
2632
- uses os locks for locking.
2633
- uses the branch last-revision.
2636
def __init__(self, *args, **kwargs):
2637
super(WorkingTree2, self).__init__(*args, **kwargs)
2638
# WorkingTree2 has more of a constraint that self._inventory must
2639
# exist. Because this is an older format, we don't mind the overhead
2640
# caused by the extra computation here.
2642
# Newer WorkingTree's should only have self._inventory set when they
2644
if self._inventory is None:
2645
self.read_working_inventory()
2647
def _get_check_refs(self):
2648
"""Return the references needed to perform a check of this tree."""
2649
return [('trees', self.last_revision())]
2651
def lock_tree_write(self):
2652
"""See WorkingTree.lock_tree_write().
2654
In Format2 WorkingTrees we have a single lock for the branch and tree
2655
so lock_tree_write() degrades to lock_write().
2657
:return: An object with an unlock method which will release the lock
2660
self.branch.lock_write()
2662
self._control_files.lock_write()
2665
self.branch.unlock()
2669
# do non-implementation specific cleanup
2672
# we share control files:
2673
if self._control_files._lock_count == 3:
2674
# _inventory_is_modified is always False during a read lock.
2675
if self._inventory_is_modified:
2677
self._write_hashcache_if_dirty()
2679
# reverse order of locking.
2681
return self._control_files.unlock()
2683
self.branch.unlock()
2686
class WorkingTree3(WorkingTree):
2687
"""This is the Format 3 working tree.
2689
This differs from the base WorkingTree by:
2690
- having its own file lock
2691
- having its own last-revision property.
2693
This is new in bzr 0.8
2697
def _last_revision(self):
2698
"""See Mutable.last_revision."""
2700
return self._transport.get_bytes('last-revision')
2701
except errors.NoSuchFile:
2702
return _mod_revision.NULL_REVISION
2704
def _change_last_revision(self, revision_id):
2705
"""See WorkingTree._change_last_revision."""
2706
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2708
self._transport.delete('last-revision')
2709
except errors.NoSuchFile:
2713
self._transport.put_bytes('last-revision', revision_id,
2714
mode=self.bzrdir._get_file_mode())
2717
def _get_check_refs(self):
2718
"""Return the references needed to perform a check of this tree."""
2719
return [('trees', self.last_revision())]
2721
@needs_tree_write_lock
2722
def set_conflicts(self, conflicts):
2723
self._put_rio('conflicts', conflicts.to_stanzas(),
2726
@needs_tree_write_lock
2727
def add_conflicts(self, new_conflicts):
2728
conflict_set = set(self.conflicts())
2729
conflict_set.update(set(list(new_conflicts)))
2730
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2731
key=_mod_conflicts.Conflict.sort_key)))
2734
def conflicts(self):
2736
confile = self._transport.get('conflicts')
2737
except errors.NoSuchFile:
2738
return _mod_conflicts.ConflictList()
2741
if confile.next() != CONFLICT_HEADER_1 + '\n':
2742
raise errors.ConflictFormatError()
2743
except StopIteration:
2744
raise errors.ConflictFormatError()
2745
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2750
# do non-implementation specific cleanup
2752
if self._control_files._lock_count == 1:
2753
# _inventory_is_modified is always False during a read lock.
2754
if self._inventory_is_modified:
2756
self._write_hashcache_if_dirty()
2757
# reverse order of locking.
2759
return self._control_files.unlock()
2761
self.branch.unlock()
2764
def get_conflicted_stem(path):
2765
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2766
if path.endswith(suffix):
2767
return path[:-len(suffix)]
2770
class WorkingTreeFormat(object):
1372
2771
"""An encapsulation of the initialization and open routines for a format.
1374
2773
Formats provide three things:
1459
2844
"""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")
2848
def register_format(klass, format):
2849
klass._formats[format.get_format_string()] = format
2852
def set_default_format(klass, format):
2853
klass._default_format = format
2856
def unregister_format(klass, format):
2857
del klass._formats[format.get_format_string()]
2860
class WorkingTreeFormat2(WorkingTreeFormat):
2861
"""The second working tree format.
2863
This format modified the hash cache from the format 1 hash cache.
2866
upgrade_recommended = True
2868
def get_format_description(self):
2869
"""See WorkingTreeFormat.get_format_description()."""
2870
return "Working tree format 2"
2872
def _stub_initialize_on_transport(self, transport, file_mode):
2873
"""Workaround: create control files for a remote working tree.
2875
This ensures that it can later be updated and dealt with locally,
2876
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2877
no working tree. (See bug #43064).
2880
inv = inventory.Inventory()
2881
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2883
transport.put_file('inventory', sio, file_mode)
2884
transport.put_bytes('pending-merges', '', file_mode)
2886
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2887
accelerator_tree=None, hardlink=False):
2888
"""See WorkingTreeFormat.initialize()."""
2889
if not isinstance(a_bzrdir.transport, LocalTransport):
2890
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2891
if from_branch is not None:
2892
branch = from_branch
2894
branch = a_bzrdir.open_branch()
2895
if revision_id is None:
2896
revision_id = _mod_revision.ensure_null(branch.last_revision())
2899
branch.generate_revision_history(revision_id)
2902
inv = inventory.Inventory()
2903
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2909
basis_tree = branch.repository.revision_tree(revision_id)
2910
if basis_tree.inventory.root is not None:
2911
wt.set_root_id(basis_tree.get_root_id())
2912
# set the parent list and cache the basis tree.
2913
if _mod_revision.is_null(revision_id):
2916
parent_trees = [(revision_id, basis_tree)]
2917
wt.set_parent_trees(parent_trees)
2918
transform.build_tree(basis_tree, wt)
2922
super(WorkingTreeFormat2, self).__init__()
2923
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2925
def open(self, a_bzrdir, _found=False):
2926
"""Return the WorkingTree object for a_bzrdir
2928
_found is a private parameter, do not use it. It is used to indicate
2929
if format probing has already been done.
2932
# we are being called directly and must probe.
2933
raise NotImplementedError
2934
if not isinstance(a_bzrdir.transport, LocalTransport):
2935
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2936
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2942
class WorkingTreeFormat3(WorkingTreeFormat):
2943
"""The second working tree format updated to record a format marker.
2946
- exists within a metadir controlling .bzr
2947
- includes an explicit version marker for the workingtree control
2948
files, separate from the BzrDir format
2949
- modifies the hash cache format
2951
- uses a LockDir to guard access for writes.
2954
upgrade_recommended = True
2956
def get_format_string(self):
2957
"""See WorkingTreeFormat.get_format_string()."""
2958
return "Bazaar-NG Working Tree format 3"
2960
def get_format_description(self):
2961
"""See WorkingTreeFormat.get_format_description()."""
2962
return "Working tree format 3"
2964
_lock_file_name = 'lock'
2965
_lock_class = LockDir
2967
_tree_class = WorkingTree3
2969
def __get_matchingbzrdir(self):
2970
return bzrdir.BzrDirMetaFormat1()
2972
_matchingbzrdir = property(__get_matchingbzrdir)
2974
def _open_control_files(self, a_bzrdir):
2975
transport = a_bzrdir.get_workingtree_transport(None)
2976
return LockableFiles(transport, self._lock_file_name,
2979
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
accelerator_tree=None, hardlink=False):
2981
"""See WorkingTreeFormat.initialize().
2983
:param revision_id: if supplied, create a working tree at a different
2984
revision than the branch is at.
2985
:param accelerator_tree: A tree which can be used for retrieving file
2986
contents more quickly than the revision tree, i.e. a workingtree.
2987
The revision tree will be used for cases where accelerator_tree's
2988
content is different.
2989
:param hardlink: If true, hard-link files from accelerator_tree,
2992
if not isinstance(a_bzrdir.transport, LocalTransport):
2993
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2994
transport = a_bzrdir.get_workingtree_transport(self)
2995
control_files = self._open_control_files(a_bzrdir)
2996
control_files.create_lock()
2997
control_files.lock_write()
2998
transport.put_bytes('format', self.get_format_string(),
2999
mode=a_bzrdir._get_file_mode())
3000
if from_branch is not None:
3001
branch = from_branch
3003
branch = a_bzrdir.open_branch()
3004
if revision_id is None:
3005
revision_id = _mod_revision.ensure_null(branch.last_revision())
3006
# WorkingTree3 can handle an inventory which has a unique root id.
3007
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3008
# those trees. And because there isn't a format bump inbetween, we
3009
# are maintaining compatibility with older clients.
3010
# inv = Inventory(root_id=gen_root_id())
3011
inv = self._initial_inventory()
3012
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3018
_control_files=control_files)
3019
wt.lock_tree_write()
3021
basis_tree = branch.repository.revision_tree(revision_id)
3022
# only set an explicit root id if there is one to set.
3023
if basis_tree.inventory.root is not None:
3024
wt.set_root_id(basis_tree.get_root_id())
3025
if revision_id == _mod_revision.NULL_REVISION:
3026
wt.set_parent_trees([])
3028
wt.set_parent_trees([(revision_id, basis_tree)])
3029
transform.build_tree(basis_tree, wt)
3031
# Unlock in this order so that the unlock-triggers-flush in
3032
# WorkingTree is given a chance to fire.
3033
control_files.unlock()
3037
def _initial_inventory(self):
3038
return inventory.Inventory()
3041
super(WorkingTreeFormat3, self).__init__()
3043
def open(self, a_bzrdir, _found=False):
3044
"""Return the WorkingTree object for a_bzrdir
3046
_found is a private parameter, do not use it. It is used to indicate
3047
if format probing has already been done.
3050
# we are being called directly and must probe.
3051
raise NotImplementedError
3052
if not isinstance(a_bzrdir.transport, LocalTransport):
3053
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3054
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3057
def _open(self, a_bzrdir, control_files):
3058
"""Open the tree itself.
3060
:param a_bzrdir: the dir for the tree.
3061
:param control_files: the control files for the tree.
3063
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3067
_control_files=control_files)
3070
return self.get_format_string()
3073
__default_format = WorkingTreeFormat6()
3074
WorkingTreeFormat.register_format(__default_format)
3075
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
WorkingTreeFormat.set_default_format(__default_format)
3079
# formats which have no format string are not discoverable
3080
# and not independently creatable, so are not registered.
3081
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
