13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files.
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.
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).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
37
from .lazy_import import lazy_import
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
43
59
conflicts as _mod_conflicts,
44
filters as _mod_filters,
46
revision as _mod_revision,
51
from breezy.bzr import (
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
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):
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib.osutils import (
104
from bzrlib.trace import mutter, note
105
from bzrlib.transport.local import LocalTransport
106
from bzrlib.progress import DummyProgress, ProgressPhase
107
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
108
from bzrlib.rio import RioReader, rio_file, Stanza
109
from bzrlib.symbol_versioning import (deprecated_passed,
112
DEPRECATED_PARAMETER,
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
@deprecated_function(zero_thirteen)
124
def gen_file_id(name):
125
"""Return new file id for the basename 'name'.
127
Use bzrlib.generate_ids.gen_file_id() instead
129
return generate_ids.gen_file_id(name)
132
@deprecated_function(zero_thirteen)
134
"""Return a new tree-root file id.
136
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
138
return generate_ids.gen_root_id()
141
class TreeEntry(object):
142
"""An entry that implements the minimum interface used by commands.
144
This needs further inspection, it may be better to have
145
InventoryEntries without ids - though that seems wrong. For now,
146
this is a parallel hierarchy to InventoryEntry, and needs to become
147
one of several things: decorates to that hierarchy, children of, or
149
Another note is that these objects are currently only used when there is
150
no InventoryEntry available - i.e. for unversioned objects.
151
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
154
def __eq__(self, other):
155
# yes, this us ugly, TODO: best practice __eq__ style.
156
return (isinstance(other, TreeEntry)
157
and other.__class__ == self.__class__)
159
def kind_character(self):
163
class TreeDirectory(TreeEntry):
164
"""See TreeEntry. This is a directory in a working tree."""
166
def __eq__(self, other):
167
return (isinstance(other, TreeDirectory)
168
and other.__class__ == self.__class__)
170
def kind_character(self):
174
class TreeFile(TreeEntry):
175
"""See TreeEntry. This is a regular file in a working tree."""
177
def __eq__(self, other):
178
return (isinstance(other, TreeFile)
179
and other.__class__ == self.__class__)
181
def kind_character(self):
185
class TreeLink(TreeEntry):
186
"""See TreeEntry. This is a symlink in a working tree."""
188
def __eq__(self, other):
189
return (isinstance(other, TreeLink)
190
and other.__class__ == self.__class__)
192
def kind_character(self):
196
class WorkingTree(bzrlib.mutabletree.MutableTree):
86
197
"""Working copy tree.
88
:ivar basedir: The root of the tree on disk. This is a unicode path object
89
(as opposed to a URL).
199
The inventory is held in the `Branch` working-inventory, and the
200
files are in a directory on disk.
202
It is possible for a `WorkingTree` to have a filename which is
203
not listed in the Inventory and vice versa.
92
# override this to set the strategy for storing views
93
def _make_views(self):
94
return views.DisabledViews(self)
96
206
def __init__(self, basedir='.',
207
branch=DEPRECATED_PARAMETER,
102
213
"""Construct a WorkingTree instance. This is not a public API.
104
215
:param branch: A branch to override probing for the branch.
106
217
self._format = _format
107
self.controldir = _controldir
218
self.bzrdir = _bzrdir
108
219
if not _internal:
109
raise errors.BzrError("Please use controldir.open_workingtree or "
110
"WorkingTree.open() to obtain a WorkingTree.")
111
basedir = osutils.safe_unicode(basedir)
220
raise errors.BzrError("Please use bzrdir.open_workingtree or "
221
"WorkingTree.open() to obtain a WorkingTree.")
222
assert isinstance(basedir, basestring), \
223
"base directory %r is not a string" % basedir
224
basedir = safe_unicode(basedir)
112
225
mutter("opening working tree %r", basedir)
113
if branch is not None:
226
if deprecated_passed(branch):
114
227
self._branch = branch
116
self._branch = self.controldir.open_branch()
117
self.basedir = osutils.realpath(basedir)
118
self._transport = _transport
119
self._rules_searcher = None
120
self.views = self._make_views()
123
def user_transport(self):
124
return self.controldir.user_transport
127
def control_transport(self):
128
return self._transport
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)
229
self._branch = self.bzrdir.open_branch()
230
self.basedir = realpath(basedir)
231
# if branch is at our basedir and is a format 6 or less
232
if isinstance(self._format, WorkingTreeFormat2):
233
# share control object
234
self._control_files = self.branch.control_files
236
# assume all other formats have their own control files.
237
assert isinstance(_control_files, LockableFiles), \
238
"_control_files must be a LockableFiles, not %r" \
240
self._control_files = _control_files
241
# update the whole cache up front and write to disk if anything changed;
242
# in the future we might want to do this more selectively
243
# two possible ways offer themselves : in self._unlock, write the cache
244
# if needed, or, when the cache sees a change, append it to the hash
245
# cache file, and have the parser take the most recent entry for a
247
wt_trans = self.bzrdir.get_workingtree_transport(None)
248
cache_filename = wt_trans.local_abspath('stat-cache')
249
self._hashcache = hashcache.HashCache(basedir, cache_filename,
250
self._control_files._file_mode)
253
# is this scan needed ? it makes things kinda slow.
260
if _inventory is None:
261
# This will be acquired on lock_read() or lock_write()
262
self._inventory_is_modified = False
263
self._inventory = None
265
# the caller of __init__ has provided an inventory,
266
# we assume they know what they are doing - as its only
267
# the Format factory and creation methods that are
268
# permitted to do this.
269
self._set_inventory(_inventory, dirty=False)
145
271
branch = property(
146
272
fget=lambda self: self._branch,
222
334
path = osutils.getcwd()
223
control, relpath = ControlDir.open_containing(path)
335
control, relpath = bzrdir.BzrDir.open_containing(path)
224
337
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)
294
340
def open_downlevel(path=None):
295
341
"""Open an unsupported working tree.
297
Only intended for advanced situations like upgrading part of a controldir.
343
Only intended for advanced situations like upgrading part of a bzrdir.
299
345
return WorkingTree.open(path, _unsupported=True)
347
# should be deprecated - this is slow and in any case treating them as a
348
# container is (we now know) bad style -- mbp 20070302
349
## @deprecated_method(zero_fifteen)
351
"""Iterate through file_ids for this tree.
353
file_ids are in a WorkingTree if they are in the working inventory
354
and the working file exists.
356
inv = self._inventory
357
for path, ie in inv.iter_entries():
358
if osutils.lexists(self.abspath(path)):
301
361
def __repr__(self):
302
362
return "<%s of %s>" % (self.__class__.__name__,
303
363
getattr(self, 'basedir', None))
305
365
def abspath(self, filename):
306
return osutils.pathjoin(self.basedir, filename)
366
return pathjoin(self.basedir, filename)
308
368
def basis_tree(self):
309
369
"""Return RevisionTree for the current last revision.
311
371
If the left most parent is a ghost then the returned tree will be an
312
empty tree - one obtained by calling
313
repository.revision_tree(NULL_REVISION).
372
empty tree - one obtained by calling repository.revision_tree(None).
316
375
revision_id = self.get_parent_ids()[0]
350
445
def has_filename(self, filename):
351
446
return osutils.lexists(self.abspath(filename))
353
def get_file(self, path, filtered=True):
354
return self.get_file_with_stat(path, filtered=filtered)[0]
356
def get_file_with_stat(self, path, filtered=True,
357
_fstat=osutils.fstat):
358
"""See Tree.get_file_with_stat."""
359
abspath = self.abspath(path)
448
def get_file(self, file_id):
449
file_id = osutils.safe_file_id(file_id)
450
return self.get_file_byname(self.id2path(file_id))
452
def get_file_text(self, file_id):
453
file_id = osutils.safe_file_id(file_id)
454
return self.get_file(file_id).read()
456
def get_file_byname(self, filename):
457
return file(self.abspath(filename), 'rb')
460
def annotate_iter(self, file_id):
461
"""See Tree.annotate_iter
463
This implementation will use the basis tree implementation if possible.
464
Lines not in the basis are attributed to CURRENT_REVISION
466
If there are pending merges, lines added by those merges will be
467
incorrectly attributed to CURRENT_REVISION (but after committing, the
468
attribution will be correct).
470
file_id = osutils.safe_file_id(file_id)
471
basis = self.basis_tree()
361
file_obj = open(abspath, 'rb')
362
except EnvironmentError as e:
363
if e.errno == errno.ENOENT:
364
raise errors.NoSuchFile(path)
366
stat_value = _fstat(file_obj.fileno())
367
if filtered and self.supports_content_filtering():
368
filters = self._content_filter_stack(path)
370
file_obj, size = _mod_filters.filtered_input_file(
372
stat_value = _mod_filters.FilteredStat(
373
stat_value, st_size=size)
374
return (file_obj, stat_value)
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):
381
"""See Tree.get_file_lines()"""
382
with self.get_file(path, filtered=filtered) as file:
383
return file.readlines()
474
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
475
require_versioned=True).next()
476
changed_content, kind = changes[2], changes[6]
477
if not changed_content:
478
return basis.annotate_iter(file_id)
482
if kind[0] != 'file':
485
old_lines = list(basis.annotate_iter(file_id))
487
for tree in self.branch.repository.revision_trees(
488
self.get_parent_ids()[1:]):
489
if file_id not in tree:
491
old.append(list(tree.annotate_iter(file_id)))
492
return annotate.reannotate(old, self.get_file(file_id).readlines(),
385
497
def get_parent_ids(self):
386
498
"""See Tree.get_parent_ids.
388
500
This implementation reads the pending merges list and last_revision
389
501
value and uses that to decide what the parents list should be.
391
last_rev = _mod_revision.ensure_null(self._last_revision())
392
if _mod_revision.NULL_REVISION == last_rev:
503
last_rev = self._last_revision()
395
507
parents = [last_rev]
397
merges_bytes = self._transport.get_bytes('pending-merges')
509
merges_file = self._control_files.get('pending-merges')
398
510
except errors.NoSuchFile:
401
for l in osutils.split_lines(merges_bytes):
402
revision_id = l.rstrip(b'\n')
513
for l in merges_file.readlines():
514
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
403
515
parents.append(revision_id)
406
def clone(self, to_controldir, revision_id=None):
519
def get_root_id(self):
520
"""Return the id of this trees root"""
521
return self._inventory.root.file_id
523
def _get_store_filename(self, file_id):
524
## XXX: badly named; this is not in the store at all
525
file_id = osutils.safe_file_id(file_id)
526
return self.abspath(self.id2path(file_id))
529
def clone(self, to_bzrdir, revision_id=None):
407
530
"""Duplicate this working tree into to_bzr, including all state.
409
532
Specifically modified files are kept as modified, but
410
533
ignored and unknown files are discarded.
412
If you want to make a new line of development, see ControlDir.sprout()
535
If you want to make a new line of development, see bzrdir.sprout()
415
If not None, the cloned tree will have its last revision set to
416
revision, and difference between the source trees last revision
538
If not None, the cloned tree will have its last revision set to
539
revision, and and difference between the source trees last revision
417
540
and this one merged in.
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)
542
# assumes the target bzr dir format is compatible.
543
result = self._format.initialize(to_bzrdir)
544
self.copy_content_into(result, revision_id)
425
548
def copy_content_into(self, tree, revision_id=None):
426
549
"""Copy the current content and user files of this tree into tree."""
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):
448
"""See Tree.get_file_size"""
449
# XXX: this returns the on-disk size; it should probably return the
452
return os.path.getsize(self.abspath(path))
454
if e.errno != errno.ENOENT:
550
tree.set_root_id(self.get_root_id())
551
if revision_id is None:
552
merge.transform_tree(tree, self)
554
# TODO now merge from tree.last_revision to revision (to preserve
555
# user local changes)
556
merge.transform_tree(tree, self)
557
tree.set_parent_ids([revision_id])
559
def id2abspath(self, file_id):
560
file_id = osutils.safe_file_id(file_id)
561
return self.abspath(self.id2path(file_id))
563
def has_id(self, file_id):
564
# files that have been deleted are excluded
565
file_id = osutils.safe_file_id(file_id)
567
if not inv.has_id(file_id):
569
path = inv.id2path(file_id)
570
return osutils.lexists(self.abspath(path))
572
def has_or_had_id(self, file_id):
573
file_id = osutils.safe_file_id(file_id)
574
if file_id == self.inventory.root.file_id:
576
return self.inventory.has_id(file_id)
578
__contains__ = has_id
580
def get_file_size(self, file_id):
581
file_id = osutils.safe_file_id(file_id)
582
return os.path.getsize(self.id2abspath(file_id))
585
def get_file_sha1(self, file_id, path=None, stat_value=None):
586
file_id = osutils.safe_file_id(file_id)
588
path = self._inventory.id2path(file_id)
589
return self._hashcache.get_sha1(path, stat_value)
591
def get_file_mtime(self, file_id, path=None):
592
file_id = osutils.safe_file_id(file_id)
594
path = self.inventory.id2path(file_id)
595
return os.lstat(self.abspath(path)).st_mtime
597
if not supports_executable():
598
def is_executable(self, file_id, path=None):
599
file_id = osutils.safe_file_id(file_id)
600
return self._inventory[file_id].executable
602
def is_executable(self, file_id, path=None):
604
file_id = osutils.safe_file_id(file_id)
605
path = self.id2path(file_id)
606
mode = os.lstat(self.abspath(path)).st_mode
607
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
609
@needs_tree_write_lock
610
def _add(self, files, ids, kinds):
611
"""See MutableTree._add."""
612
# TODO: Re-adding a file that is removed in the working copy
613
# should probably put it back with the previous ID.
614
# the read and write working inventory should not occur in this
615
# function - they should be part of lock_write and unlock.
616
inv = self.read_working_inventory()
617
for f, file_id, kind in zip(files, ids, kinds):
618
assert kind is not None
620
inv.add_path(f, kind=kind)
622
file_id = osutils.safe_file_id(file_id)
623
inv.add_path(f, kind=kind, file_id=file_id)
624
self._write_inventory(inv)
626
@needs_tree_write_lock
459
627
def _gather_kinds(self, files, kinds):
460
628
"""See MutableTree._gather_kinds."""
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)
629
for pos, f in enumerate(files):
630
if kinds[pos] is None:
631
fullpath = normpath(self.abspath(f))
633
kinds[pos] = file_kind(fullpath)
635
if e.errno == errno.ENOENT:
636
raise errors.NoSuchFile(fullpath)
471
639
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
472
640
"""Add revision_id as a parent.
497
665
If the revision_id is a ghost, pass None for the tree.
498
666
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
500
with self.lock_tree_write():
501
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
502
if len(parent_ids) > 1:
503
# the leftmost may have already been a ghost, preserve that if it
505
allow_leftmost_as_ghost = True
506
self.set_parent_ids(parent_ids,
507
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
668
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
669
if len(parent_ids) > 1:
670
# the leftmost may have already been a ghost, preserve that if it
672
allow_leftmost_as_ghost = True
673
self.set_parent_ids(parent_ids,
674
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
676
@needs_tree_write_lock
509
677
def add_pending_merge(self, *revision_ids):
510
with self.lock_tree_write():
511
# TODO: Perhaps should check at this point that the
512
# history of the revision is actually present?
513
parents = self.get_parent_ids()
515
for rev_id in revision_ids:
516
if rev_id in parents:
518
parents.append(rev_id)
521
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
523
def path_content_summary(self, path, _lstat=os.lstat,
524
_mapper=osutils.file_kind_from_stat_mode):
525
"""See Tree.path_content_summary."""
526
abspath = self.abspath(path)
528
stat_result = _lstat(abspath)
530
if getattr(e, 'errno', None) == errno.ENOENT:
532
return ('missing', None, None, None)
533
# propagate other errors
535
kind = _mapper(stat_result.st_mode)
537
return self._file_content_summary(path, stat_result)
538
elif kind == 'directory':
539
# perhaps it looks like a plain directory, but it's really a
541
if self._directory_is_tree_reference(path):
542
kind = 'tree-reference'
543
return kind, None, None, None
544
elif kind == 'symlink':
545
target = osutils.readlink(abspath)
546
return ('symlink', None, None, target)
548
return (kind, None, None, None)
550
def _file_content_summary(self, path, stat_result):
551
size = stat_result.st_size
552
executable = self._is_executable_from_path_and_stat(path, stat_result)
553
# try for a stat cache lookup
554
return ('file', size, executable, self._sha_from_stat(
678
# TODO: Perhaps should check at this point that the
679
# history of the revision is actually present?
680
parents = self.get_parent_ids()
682
for rev_id in revision_ids:
683
if rev_id in parents:
685
parents.append(rev_id)
688
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
690
@deprecated_method(zero_eleven)
692
def pending_merges(self):
693
"""Return a list of pending merges.
695
These are revisions that have been merged into the working
696
directory but not yet committed.
698
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
699
instead - which is available on all tree objects.
701
return self.get_parent_ids()[1:]
557
703
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
558
704
"""Common ghost checking functionality from set_parent_*.
602
729
:param revision_ids: The revision_ids to set as the parent ids of this
603
730
working tree. Any of these may be ghosts.
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])
732
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
733
self._check_parents_for_ghosts(revision_ids,
734
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
736
if len(revision_ids) > 0:
737
self.set_last_revision(revision_ids[0])
739
self.set_last_revision(None)
741
self._set_merges_from_parent_ids(revision_ids)
743
@needs_tree_write_lock
744
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
745
"""See MutableTree.set_parent_trees."""
746
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
748
self._check_parents_for_ghosts(parent_ids,
749
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
751
if len(parent_ids) == 0:
752
leftmost_parent_id = None
753
leftmost_parent_tree = None
755
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
757
if self._change_last_revision(leftmost_parent_id):
758
if leftmost_parent_tree is None:
759
# If we don't have a tree, fall back to reading the
760
# parent tree from the repository.
761
self._cache_basis_inventory(leftmost_parent_id)
616
self.set_last_revision(_mod_revision.NULL_REVISION)
618
self._set_merges_from_parent_ids(revision_ids)
763
inv = leftmost_parent_tree.inventory
764
xml = self._create_basis_xml_from_inventory(
765
leftmost_parent_id, inv)
766
self._write_basis_inventory(xml)
767
self._set_merges_from_parent_ids(parent_ids)
769
@needs_tree_write_lock
620
770
def set_pending_merges(self, rev_list):
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)
771
parents = self.get_parent_ids()
772
leftmost = parents[:1]
773
new_parents = leftmost + rev_list
774
self.set_parent_ids(new_parents)
776
@needs_tree_write_lock
627
777
def set_merge_modified(self, modified_hashes):
628
"""Set the merge modified hashes."""
629
raise NotImplementedError(self.set_merge_modified)
631
def _sha_from_stat(self, path, stat_result):
632
"""Get a sha digest from the tree's stat cache.
634
The default implementation assumes no stat cache is present.
636
:param path: The path.
637
:param stat_result: The stat result being looked up.
641
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
642
merge_type=None, force=False):
779
for file_id, hash in modified_hashes.iteritems():
780
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
781
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
783
def _put_rio(self, filename, stanzas, header):
784
self._must_be_locked()
785
my_file = rio_file(stanzas, header)
786
self._control_files.put(filename, my_file)
788
@needs_write_lock # because merge pulls data into the branch.
789
def merge_from_branch(self, branch, to_revision=None):
643
790
"""Merge from a branch into this working tree.
645
792
:param branch: The branch to merge from.
648
795
of the branch when it is supplied. If None, to_revision defaults to
649
796
branch.last_revision().
651
from .merge import Merger, Merge3Merger
652
with self.lock_write():
653
merger = Merger(self.branch, this_tree=self)
654
# check that there are no local alterations
655
if not force and self.has_changes():
656
raise errors.UncommittedChanges(self)
798
from bzrlib.merge import Merger, Merge3Merger
799
pb = bzrlib.ui.ui_factory.nested_progress_bar()
801
merger = Merger(self.branch, this_tree=self, pb=pb)
802
merger.pp = ProgressPhase("Merge phase", 5, pb)
803
merger.pp.next_phase()
804
# check that there are no
806
merger.check_basis(check_clean=True, require_commits=False)
657
807
if to_revision is None:
658
to_revision = _mod_revision.ensure_null(branch.last_revision())
808
to_revision = branch.last_revision()
810
to_revision = osutils.safe_revision_id(to_revision)
659
811
merger.other_rev_id = to_revision
660
if _mod_revision.is_null(merger.other_rev_id):
661
raise errors.NoCommits(branch)
662
self.branch.fetch(branch, stop_revision=merger.other_rev_id)
812
if merger.other_rev_id is None:
813
raise error.NoCommits(branch)
814
self.branch.fetch(branch, last_revision=merger.other_rev_id)
663
815
merger.other_basis = merger.other_rev_id
664
816
merger.other_tree = self.branch.repository.revision_tree(
665
817
merger.other_rev_id)
666
818
merger.other_branch = branch
667
if from_revision is None:
670
merger.set_base_revision(from_revision, branch)
819
merger.pp.next_phase()
671
821
if merger.base_rev_id == merger.other_rev_id:
672
822
raise errors.PointlessMerge
673
823
merger.backup_files = False
674
if merge_type is None:
675
merger.merge_type = Merge3Merger
677
merger.merge_type = merge_type
824
merger.merge_type = Merge3Merger
678
825
merger.set_interesting_files(None)
679
826
merger.show_base = False
680
827
merger.reprocess = False
681
828
conflicts = merger.do_merge()
682
829
merger.set_pending()
685
835
def merge_modified(self):
686
836
"""Return a dictionary of files modified by a merge.
688
The list is initialized by WorkingTree.set_merge_modified, which is
838
The list is initialized by WorkingTree.set_merge_modified, which is
689
839
typically called after we make some automatic updates to the tree
690
840
because of a merge.
692
842
This returns a map of file_id->sha1, containing only files which are
693
still in the working tree and have that text hash.
843
still in the working inventory and have that text hash.
695
raise NotImplementedError(self.merge_modified)
846
hashfile = self._control_files.get('merge-hashes')
847
except errors.NoSuchFile:
851
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
852
raise errors.MergeModifiedFormatError()
853
except StopIteration:
854
raise errors.MergeModifiedFormatError()
855
for s in RioReader(hashfile):
856
# RioReader reads in Unicode, so convert file_ids back to utf8
857
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
858
if file_id not in self.inventory:
860
text_hash = s.get("hash")
861
if text_hash == self.get_file_sha1(file_id):
862
merge_hashes[file_id] = text_hash
697
866
def mkdir(self, path, file_id=None):
698
867
"""See MutableTree.mkdir()."""
699
868
if file_id is None:
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)
869
file_id = generate_ids.gen_file_id(os.path.basename(path))
870
os.mkdir(self.abspath(path))
871
self.add(path, file_id, 'directory')
874
def get_symlink_target(self, file_id):
875
file_id = osutils.safe_file_id(file_id)
876
return os.readlink(self.id2abspath(file_id))
719
879
def subsume(self, other_tree):
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):
880
def add_children(inventory, entry):
881
for child_entry in entry.children.values():
882
inventory._byid[child_entry.file_id] = child_entry
883
if child_entry.kind == 'directory':
884
add_children(inventory, child_entry)
885
if other_tree.get_root_id() == self.get_root_id():
886
raise errors.BadSubsumeSource(self, other_tree,
887
'Trees have the same root')
889
other_tree_path = self.relpath(other_tree.basedir)
890
except errors.PathNotChild:
891
raise errors.BadSubsumeSource(self, other_tree,
892
'Tree is not contained by the other')
893
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
894
if new_root_parent is None:
895
raise errors.BadSubsumeSource(self, other_tree,
896
'Parent directory is not versioned.')
897
# We need to ensure that the result of a fetch will have a
898
# versionedfile for the other_tree root, and only fetching into
899
# RepositoryKnit2 guarantees that.
900
if not self.branch.repository.supports_rich_root():
901
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
902
other_tree.lock_tree_write()
904
new_parents = other_tree.get_parent_ids()
905
other_root = other_tree.inventory.root
906
other_root.parent_id = new_root_parent
907
other_root.name = osutils.basename(other_tree_path)
908
self.inventory.add(other_root)
909
add_children(self.inventory, other_root)
910
self._write_inventory(self.inventory)
911
# normally we don't want to fetch whole repositories, but i think
912
# here we really do want to consolidate the whole thing.
913
for parent_id in other_tree.get_parent_ids():
914
self.branch.fetch(other_tree.branch, parent_id)
915
self.add_parent_tree_id(parent_id)
918
other_tree.bzrdir.retire_bzrdir()
920
@needs_tree_write_lock
921
def extract(self, file_id, format=None):
726
922
"""Extract a subtree from this tree.
728
924
A new branch will be created, relative to the path for this tree.
730
raise NotImplementedError(self.extract)
928
segments = osutils.splitpath(path)
929
transport = self.branch.bzrdir.root_transport
930
for name in segments:
931
transport = transport.clone(name)
934
except errors.FileExists:
938
sub_path = self.id2path(file_id)
939
branch_transport = mkdirs(sub_path)
941
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
943
branch_transport.mkdir('.')
944
except errors.FileExists:
946
branch_bzrdir = format.initialize_on_transport(branch_transport)
948
repo = branch_bzrdir.find_repository()
949
except errors.NoRepositoryPresent:
950
repo = branch_bzrdir.create_repository()
951
assert repo.supports_rich_root()
953
if not repo.supports_rich_root():
954
raise errors.RootNotRich()
955
new_branch = branch_bzrdir.create_branch()
956
new_branch.pull(self.branch)
957
for parent_id in self.get_parent_ids():
958
new_branch.fetch(self.branch, parent_id)
959
tree_transport = self.bzrdir.root_transport.clone(sub_path)
960
if tree_transport.base != branch_transport.base:
961
tree_bzrdir = format.initialize_on_transport(tree_transport)
962
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
964
tree_bzrdir = branch_bzrdir
965
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
966
wt.set_parent_ids(self.get_parent_ids())
967
my_inv = self.inventory
968
child_inv = Inventory(root_id=None)
969
new_root = my_inv[file_id]
970
my_inv.remove_recursive_id(file_id)
971
new_root.parent_id = None
972
child_inv.add(new_root)
973
self._write_inventory(my_inv)
974
wt._write_inventory(child_inv)
977
def _serialize(self, inventory, out_file):
978
xml5.serializer_v5.write_inventory(self._inventory, out_file)
980
def _deserialize(selt, in_file):
981
return xml5.serializer_v5.read_inventory(in_file)
733
"""Write the in memory meta data to disk."""
734
raise NotImplementedError(self.flush)
984
"""Write the in memory inventory to disk."""
985
# TODO: Maybe this should only write on dirty ?
986
if self._control_files._lock_mode != 'w':
987
raise errors.NotWriteLocked(self)
989
self._serialize(self._inventory, sio)
991
self._control_files.put('inventory', sio)
992
self._inventory_is_modified = False
736
def kind(self, relpath):
994
def _kind(self, relpath):
737
995
return osutils.file_kind(self.abspath(relpath))
739
def list_files(self, include_root=False, from_dir=None, recursive=True,
740
recurse_nested=False):
741
"""List all files as (path, class, kind, id, entry).
997
def list_files(self, include_root=False):
998
"""Recursively list all files as (path, class, kind, id, entry).
743
1000
Lists, but does not descend into unversioned directories.
744
1002
This does not include files that have been deleted in this
745
tree. Skips the control directory.
747
:param include_root: if True, return an entry for the root
748
:param from_dir: start from this directory or None for the root
749
:param recursive: whether to recurse into subdirectories or not
1005
Skips the control directory.
751
raise NotImplementedError(self.list_files)
753
def move(self, from_paths, to_dir=None, after=False):
1007
# list_files is an iterator, so @needs_read_lock doesn't work properly
1008
# with it. So callers should be careful to always read_lock the tree.
1009
if not self.is_locked():
1010
raise errors.ObjectNotLocked(self)
1012
inv = self.inventory
1013
if include_root is True:
1014
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1015
# Convert these into local objects to save lookup times
1016
pathjoin = osutils.pathjoin
1017
file_kind = self._kind
1019
# transport.base ends in a slash, we want the piece
1020
# between the last two slashes
1021
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1023
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1025
# directory file_id, relative path, absolute path, reverse sorted children
1026
children = os.listdir(self.basedir)
1028
# jam 20060527 The kernel sized tree seems equivalent whether we
1029
# use a deque and popleft to keep them sorted, or if we use a plain
1030
# list and just reverse() them.
1031
children = collections.deque(children)
1032
stack = [(inv.root.file_id, u'', self.basedir, children)]
1034
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1037
f = children.popleft()
1038
## TODO: If we find a subdirectory with its own .bzr
1039
## directory, then that is a separate tree and we
1040
## should exclude it.
1042
# the bzrdir for this tree
1043
if transport_base_dir == f:
1046
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1047
# and 'f' doesn't begin with one, we can do a string op, rather
1048
# than the checks of pathjoin(), all relative paths will have an extra slash
1050
fp = from_dir_relpath + '/' + f
1053
fap = from_dir_abspath + '/' + f
1055
f_ie = inv.get_child(from_dir_id, f)
1058
elif self.is_ignored(fp[1:]):
1061
# we may not have found this file, because of a unicode issue
1062
f_norm, can_access = osutils.normalized_filename(f)
1063
if f == f_norm or not can_access:
1064
# No change, so treat this file normally
1067
# this file can be accessed by a normalized path
1068
# check again if it is versioned
1069
# these lines are repeated here for performance
1071
fp = from_dir_relpath + '/' + f
1072
fap = from_dir_abspath + '/' + f
1073
f_ie = inv.get_child(from_dir_id, f)
1076
elif self.is_ignored(fp[1:]):
1083
# make a last minute entry
1085
yield fp[1:], c, fk, f_ie.file_id, f_ie
1088
yield fp[1:], c, fk, None, fk_entries[fk]()
1090
yield fp[1:], c, fk, None, TreeEntry()
1093
if fk != 'directory':
1096
# But do this child first
1097
new_children = os.listdir(fap)
1099
new_children = collections.deque(new_children)
1100
stack.append((f_ie.file_id, fp, fap, new_children))
1101
# Break out of inner loop,
1102
# so that we start outer loop with child
1105
# if we finished all children, pop it off the stack
1108
@needs_tree_write_lock
1109
def move(self, from_paths, to_dir=None, after=False, **kwargs):
754
1110
"""Rename files.
756
to_dir must be known to the working tree.
1112
to_dir must exist in the inventory.
758
1114
If to_dir exists and is a directory, the files are moved into
759
it, keeping their old names.
1115
it, keeping their old names.
761
1117
Note that to_dir is only the last component of the new name;
762
1118
this doesn't change the directory.
784
1141
This returns a list of (from_path, to_path) pairs for each
785
1142
entry that is moved.
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))
1147
# check for deprecated use of signature
1149
to_dir = kwargs.get('to_name', None)
1151
raise TypeError('You must supply a target directory')
1153
symbol_versioning.warn('The parameter to_name was deprecated'
1154
' in version 0.13. Use to_dir instead',
1157
# check destination directory
1158
assert not isinstance(from_paths, basestring)
1159
inv = self.inventory
1160
to_abs = self.abspath(to_dir)
1161
if not isdir(to_abs):
1162
raise errors.BzrMoveFailedError('',to_dir,
1163
errors.NotADirectory(to_abs))
1164
if not self.has_filename(to_dir):
1165
raise errors.BzrMoveFailedError('',to_dir,
1166
errors.NotInWorkingDirectory(to_dir))
1167
to_dir_id = inv.path2id(to_dir)
1168
if to_dir_id is None:
1169
raise errors.BzrMoveFailedError('',to_dir,
1170
errors.NotVersionedError(path=str(to_dir)))
1172
to_dir_ie = inv[to_dir_id]
1173
if to_dir_ie.kind != 'directory':
1174
raise errors.BzrMoveFailedError('',to_dir,
1175
errors.NotADirectory(to_abs))
1177
# create rename entries and tuples
1178
for from_rel in from_paths:
1179
from_tail = splitpath(from_rel)[-1]
1180
from_id = inv.path2id(from_rel)
1182
raise errors.BzrMoveFailedError(from_rel,to_dir,
1183
errors.NotVersionedError(path=str(from_rel)))
1185
from_entry = inv[from_id]
1186
from_parent_id = from_entry.parent_id
1187
to_rel = pathjoin(to_dir, from_tail)
1188
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1190
from_tail=from_tail,
1191
from_parent_id=from_parent_id,
1192
to_rel=to_rel, to_tail=from_tail,
1193
to_parent_id=to_dir_id)
1194
rename_entries.append(rename_entry)
1195
rename_tuples.append((from_rel, to_rel))
1197
# determine which move mode to use. checks also for movability
1198
rename_entries = self._determine_mv_mode(rename_entries, after)
1200
original_modified = self._inventory_is_modified
1203
self._inventory_is_modified = True
1204
self._move(rename_entries)
1206
# restore the inventory on error
1207
self._inventory_is_modified = original_modified
1209
self._write_inventory(inv)
1210
return rename_tuples
1212
def _determine_mv_mode(self, rename_entries, after=False):
1213
"""Determines for each from-to pair if both inventory and working tree
1214
or only the inventory has to be changed.
1216
Also does basic plausability tests.
1218
inv = self.inventory
1220
for rename_entry in rename_entries:
1221
# store to local variables for easier reference
1222
from_rel = rename_entry.from_rel
1223
from_id = rename_entry.from_id
1224
to_rel = rename_entry.to_rel
1225
to_id = inv.path2id(to_rel)
1226
only_change_inv = False
1228
# check the inventory for source and destination
1230
raise errors.BzrMoveFailedError(from_rel,to_rel,
1231
errors.NotVersionedError(path=str(from_rel)))
1232
if to_id is not None:
1233
raise errors.BzrMoveFailedError(from_rel,to_rel,
1234
errors.AlreadyVersionedError(path=str(to_rel)))
1236
# try to determine the mode for rename (only change inv or change
1237
# inv and file system)
1239
if not self.has_filename(to_rel):
1240
raise errors.BzrMoveFailedError(from_id,to_rel,
1241
errors.NoSuchFile(path=str(to_rel),
1242
extra="New file has not been created yet"))
1243
only_change_inv = True
1244
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1245
only_change_inv = True
1246
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1247
only_change_inv = False
1249
# something is wrong, so lets determine what exactly
1250
if not self.has_filename(from_rel) and \
1251
not self.has_filename(to_rel):
1252
raise errors.BzrRenameFailedError(from_rel,to_rel,
1253
errors.PathsDoNotExist(paths=(str(from_rel),
1256
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1257
extra="(Use --after to update the Bazaar id)")
1258
rename_entry.only_change_inv = only_change_inv
1259
return rename_entries
1261
def _move(self, rename_entries):
1262
"""Moves a list of files.
1264
Depending on the value of the flag 'only_change_inv', the
1265
file will be moved on the file system or not.
1267
inv = self.inventory
1270
for entry in rename_entries:
1272
self._move_entry(entry)
1274
self._rollback_move(moved)
1278
def _rollback_move(self, moved):
1279
"""Try to rollback a previous move in case of an filesystem error."""
1280
inv = self.inventory
1283
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1284
entry.to_tail, entry.to_parent_id, entry.from_rel,
1285
entry.from_tail, entry.from_parent_id,
1286
entry.only_change_inv))
1287
except errors.BzrMoveFailedError, e:
1288
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1289
" The working tree is in an inconsistent state."
1290
" Please consider doing a 'bzr revert'."
1291
" Error message is: %s" % e)
1293
def _move_entry(self, entry):
1294
inv = self.inventory
1295
from_rel_abs = self.abspath(entry.from_rel)
1296
to_rel_abs = self.abspath(entry.to_rel)
1297
if from_rel_abs == to_rel_abs:
1298
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1299
"Source and target are identical.")
1301
if not entry.only_change_inv:
1303
osutils.rename(from_rel_abs, to_rel_abs)
1305
raise errors.BzrMoveFailedError(entry.from_rel,
1307
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1309
@needs_tree_write_lock
1310
def rename_one(self, from_rel, to_rel, after=False):
1313
This can change the directory or the filename or both.
1315
rename_one has several 'modes' to work. First, it can rename a physical
1316
file and change the file_id. That is the normal mode. Second, it can
1317
only change the file_id without touching any physical file. This is
1318
the new mode introduced in version 0.15.
1320
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1321
versioned but present in the working tree.
1323
rename_one uses the second mode if 'after == False' and 'from_rel' is
1324
versioned but no longer in the working tree, and 'to_rel' is not
1325
versioned but present in the working tree.
1327
rename_one uses the first mode if 'after == False' and 'from_rel' is
1328
versioned and present in the working tree, and 'to_rel' is not
1329
versioned and not present in the working tree.
1331
Everything else results in an error.
1333
inv = self.inventory
1336
# create rename entries and tuples
1337
from_tail = splitpath(from_rel)[-1]
1338
from_id = inv.path2id(from_rel)
1340
raise errors.BzrRenameFailedError(from_rel,to_rel,
1341
errors.NotVersionedError(path=str(from_rel)))
1342
from_entry = inv[from_id]
1343
from_parent_id = from_entry.parent_id
1344
to_dir, to_tail = os.path.split(to_rel)
1345
to_dir_id = inv.path2id(to_dir)
1346
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1348
from_tail=from_tail,
1349
from_parent_id=from_parent_id,
1350
to_rel=to_rel, to_tail=to_tail,
1351
to_parent_id=to_dir_id)
1352
rename_entries.append(rename_entry)
1354
# determine which move mode to use. checks also for movability
1355
rename_entries = self._determine_mv_mode(rename_entries, after)
1357
# check if the target changed directory and if the target directory is
1359
if to_dir_id is None:
1360
raise errors.BzrMoveFailedError(from_rel,to_rel,
1361
errors.NotVersionedError(path=str(to_dir)))
1363
# all checks done. now we can continue with our actual work
1364
mutter('rename_one:\n'
1369
' to_dir_id {%s}\n',
1370
from_id, from_rel, to_rel, to_dir, to_dir_id)
1372
self._move(rename_entries)
1373
self._write_inventory(inv)
1375
class _RenameEntry(object):
1376
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1377
to_rel, to_tail, to_parent_id, only_change_inv=False):
1378
self.from_rel = from_rel
1379
self.from_id = from_id
1380
self.from_tail = from_tail
1381
self.from_parent_id = from_parent_id
1382
self.to_rel = to_rel
1383
self.to_tail = to_tail
1384
self.to_parent_id = to_parent_id
1385
self.only_change_inv = only_change_inv
801
1388
def unknowns(self):
802
1389
"""Return all unknown files.
804
1391
These are files in the working directory that are not versioned or
805
1392
control files or ignored.
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
1394
# force the extras method to be fully executed before returning, to
1395
# prevent race conditions with the lock
1397
[subp for subp in self.extras() if not self.is_ignored(subp)])
1399
@needs_tree_write_lock
1400
def unversion(self, file_ids):
1401
"""Remove the file ids in file_ids from the current versioned set.
1403
When a file_id is unversioned, all of its children are automatically
819
:param paths: The paths to stop versioning.
820
:raises NoSuchFile: if any path is not currently versioned.
1406
:param file_ids: The file ids to stop versioning.
1407
:raises: NoSuchId if any fileid is not currently versioned.
822
raise NotImplementedError(self.unversion)
1409
for file_id in file_ids:
1410
file_id = osutils.safe_file_id(file_id)
1411
if self._inventory.has_id(file_id):
1412
self._inventory.remove_recursive_id(file_id)
1414
raise errors.NoSuchId(self, file_id)
1416
# in the future this should just set a dirty bit to wait for the
1417
# final unlock. However, until all methods of workingtree start
1418
# with the current in -memory inventory rather than triggering
1419
# a read, it is more complex - we need to teach read_inventory
1420
# to know when to read, and when to not read first... and possibly
1421
# to save first when the in memory one may be corrupted.
1422
# so for now, we just only write it if it is indeed dirty.
1424
self._write_inventory(self._inventory)
1426
@deprecated_method(zero_eight)
1427
def iter_conflicts(self):
1428
"""List all files in the tree that have text or content conflicts.
1429
DEPRECATED. Use conflicts instead."""
1430
return self._iter_conflicts()
1432
def _iter_conflicts(self):
1434
for info in self.list_files():
1436
stem = get_conflicted_stem(path)
1439
if stem not in conflicted:
1440
conflicted.add(stem)
824
1444
def pull(self, source, overwrite=False, stop_revision=None,
825
change_reporter=None, possible_transports=None, local=False,
826
show_base=False, tag_selector=None):
827
with self.lock_write(), source.lock_read():
1445
change_reporter=None):
1446
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1449
pp = ProgressPhase("Pull phase", 2, top_pb)
828
1451
old_revision_info = self.branch.last_revision_info()
829
1452
basis_tree = self.basis_tree()
830
count = self.branch.pull(source, overwrite, stop_revision,
831
possible_transports=possible_transports,
832
local=local, tag_selector=tag_selector)
1453
count = self.branch.pull(source, overwrite, stop_revision)
833
1454
new_revision_info = self.branch.last_revision_info()
834
1455
if new_revision_info != old_revision_info:
835
1457
repository = self.branch.repository
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():
1458
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1459
basis_tree.lock_read()
842
1461
new_basis_tree = self.branch.basis_tree()
843
1462
merge.merge_inner(
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:
853
self.set_root_id(new_root_id)
1468
change_reporter=change_reporter)
1469
if (basis_tree.inventory.root is None and
1470
new_basis_tree.inventory.root is not None):
1471
self.set_root_id(new_basis_tree.inventory.root.file_id)
854
1475
# TODO - dedup parents list with things merged by pull ?
855
1476
# reuse the revisiontree we merged against to set the new
858
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
860
(self.branch.last_revision(), new_basis_tree))
861
# we have to pull the merge trees out again, because
862
# merge_inner has set the ids. - this corner is not yet
1478
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1479
# we have to pull the merge trees out again, because
1480
# merge_inner has set the ids. - this corner is not yet
863
1481
# layered well enough to prevent double handling.
864
1482
# XXX TODO: Fix the double handling: telling the tree about
865
1483
# the already known parent data is wasteful.
866
1484
merges = self.get_parent_ids()[1:]
867
1485
parent_trees.extend([
868
1486
(parent, repository.revision_tree(parent)) for
870
1488
self.set_parent_trees(parent_trees)
873
def put_file_bytes_non_atomic(self, path, bytes):
1495
def put_file_bytes_non_atomic(self, file_id, bytes):
874
1496
"""See MutableTree.put_file_bytes_non_atomic."""
875
with self.lock_write(), open(self.abspath(path), 'wb') as stream:
1497
file_id = osutils.safe_file_id(file_id)
1498
stream = file(self.id2abspath(file_id), 'wb')
876
1500
stream.write(bytes)
1503
# TODO: update the hashcache here ?
878
1505
def extras(self):
879
1506
"""Yield all unversioned files in this WorkingTree.
881
If there are any unversioned directories and the file format
882
supports versioning directories, then only the directory is returned,
883
not all its children. But if there are unversioned files under a
884
versioned subdirectory, they are returned.
1508
If there are any unversioned directories then only the directory is
1509
returned, not all its children. But if there are unversioned files
1510
under a versioned subdirectory, they are returned.
886
1512
Currently returned depth-first, sorted by name within directories.
887
1513
This is the same order used by 'osutils.walkdirs'.
889
raise NotImplementedError(self.extras)
1515
## TODO: Work from given directory downwards
1516
for path, dir_entry in self.inventory.directories():
1517
# mutter("search for unknowns in %r", path)
1518
dirabs = self.abspath(path)
1519
if not isdir(dirabs):
1520
# e.g. directory deleted
1524
for subf in os.listdir(dirabs):
1527
if subf not in dir_entry.children:
1528
subf_norm, can_access = osutils.normalized_filename(subf)
1529
if subf_norm != subf and can_access:
1530
if subf_norm not in dir_entry.children:
1531
fl.append(subf_norm)
1537
subp = pathjoin(path, subf)
891
1540
def ignored_files(self):
892
1541
"""Yield list of PATH, IGNORE_PATTERN"""
935
1620
return self._last_revision()
937
1623
def _last_revision(self):
938
1624
"""helper for get_parent_ids."""
939
with self.lock_read():
940
return _mod_revision.ensure_null(self.branch.last_revision())
1625
return self.branch.last_revision()
942
1627
def is_locked(self):
943
"""Check if this tree is locked."""
944
raise NotImplementedError(self.is_locked)
1628
return self._control_files.is_locked()
1630
def _must_be_locked(self):
1631
if not self.is_locked():
1632
raise errors.ObjectNotLocked(self)
946
1634
def lock_read(self):
947
"""Lock the tree for reading.
949
This also locks the branch, and can be unlocked via self.unlock().
951
:return: A breezy.lock.LogicalLockResult.
953
raise NotImplementedError(self.lock_read)
1635
"""See Branch.lock_read, and WorkingTree.unlock."""
1636
if not self.is_locked():
1638
self.branch.lock_read()
1640
return self._control_files.lock_read()
1642
self.branch.unlock()
955
1645
def lock_tree_write(self):
956
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
958
:return: A breezy.lock.LogicalLockResult.
960
raise NotImplementedError(self.lock_tree_write)
1646
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1647
if not self.is_locked():
1649
self.branch.lock_read()
1651
return self._control_files.lock_write()
1653
self.branch.unlock()
962
1656
def lock_write(self):
963
"""See MutableTree.lock_write, and WorkingTree.unlock.
965
:return: A breezy.lock.LogicalLockResult.
967
raise NotImplementedError(self.lock_write)
1657
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1658
if not self.is_locked():
1660
self.branch.lock_write()
1662
return self._control_files.lock_write()
1664
self.branch.unlock()
969
1667
def get_physical_lock_status(self):
970
raise NotImplementedError(self.get_physical_lock_status)
1668
return self._control_files.get_physical_lock_status()
1670
def _basis_inventory_name(self):
1671
return 'basis-inventory-cache'
1673
def _reset_data(self):
1674
"""Reset transient data that cannot be revalidated."""
1675
self._inventory_is_modified = False
1676
result = self._deserialize(self._control_files.get('inventory'))
1677
self._set_inventory(result, dirty=False)
1679
@needs_tree_write_lock
972
1680
def set_last_revision(self, new_revision):
973
1681
"""Change the last revision in the working tree."""
974
raise NotImplementedError(self.set_last_revision)
1682
new_revision = osutils.safe_revision_id(new_revision)
1683
if self._change_last_revision(new_revision):
1684
self._cache_basis_inventory(new_revision)
976
1686
def _change_last_revision(self, new_revision):
977
1687
"""Template method part of set_last_revision to perform the change.
979
1689
This is used to allow WorkingTree3 instances to not affect branch
980
1690
when their last revision is set.
982
if _mod_revision.is_null(new_revision):
983
self.branch.set_last_revision_info(0, new_revision)
1692
if new_revision is None:
1693
self.branch.set_revision_history([])
985
_mod_revision.check_not_reserved_id(new_revision)
987
1696
self.branch.generate_revision_history(new_revision)
988
1697
except errors.NoSuchRevision:
989
1698
# not present in the repo - dont try to set it deeper than the tip
990
self.branch._set_revision_history([new_revision])
1699
self.branch.set_revision_history([new_revision])
993
def remove(self, files, verbose=False, to_file=None, keep_files=True,
995
"""Remove nominated files from the working tree metadata.
997
:files: File paths relative to the basedir.
998
:keep_files: If true, the files will also be kept.
999
:force: Delete files and directories, even if they are changed and
1000
even if the directories are not empty.
1002
raise NotImplementedError(self.remove)
1004
def revert(self, filenames=None, old_tree=None, backups=True,
1005
pb=None, report_changes=False):
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
1015
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1017
if filenames is None and len(self.get_parent_ids()) > 1:
1019
last_revision = self.last_revision()
1020
if last_revision != _mod_revision.NULL_REVISION:
1021
if basis_tree is None:
1022
basis_tree = self.basis_tree()
1023
exit_stack.enter_context(basis_tree.lock_read())
1024
parent_trees.append((last_revision, basis_tree))
1025
self.set_parent_trees(parent_trees)
1028
resolve(self, filenames, ignore_misses=True, recursive=True)
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)
1702
def _write_basis_inventory(self, xml):
1703
"""Write the basis inventory XML to the basis-inventory file"""
1704
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1705
path = self._basis_inventory_name()
1707
self._control_files.put(path, sio)
1709
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1710
"""Create the text that will be saved in basis-inventory"""
1711
# TODO: jam 20070209 This should be redundant, as the revision_id
1712
# as all callers should have already converted the revision_id to
1714
inventory.revision_id = osutils.safe_revision_id(revision_id)
1715
return xml7.serializer_v7.write_inventory_to_string(inventory)
1717
def _cache_basis_inventory(self, new_revision):
1718
"""Cache new_revision as the basis inventory."""
1719
# TODO: this should allow the ready-to-use inventory to be passed in,
1720
# as commit already has that ready-to-use [while the format is the
1723
# this double handles the inventory - unpack and repack -
1724
# but is easier to understand. We can/should put a conditional
1725
# in here based on whether the inventory is in the latest format
1726
# - perhaps we should repack all inventories on a repository
1728
# the fast path is to copy the raw xml from the repository. If the
1729
# xml contains 'revision_id="', then we assume the right
1730
# revision_id is set. We must check for this full string, because a
1731
# root node id can legitimately look like 'revision_id' but cannot
1733
xml = self.branch.repository.get_inventory_xml(new_revision)
1734
firstline = xml.split('\n', 1)[0]
1735
if (not 'revision_id="' in firstline or
1736
'format="7"' not in firstline):
1737
inv = self.branch.repository.deserialise_inventory(
1739
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1740
self._write_basis_inventory(xml)
1741
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1744
def read_basis_inventory(self):
1745
"""Read the cached basis inventory."""
1746
path = self._basis_inventory_name()
1747
return self._control_files.get(path).read()
1750
def read_working_inventory(self):
1751
"""Read the working inventory.
1753
:raises errors.InventoryModified: read_working_inventory will fail
1754
when the current in memory inventory has been modified.
1756
# conceptually this should be an implementation detail of the tree.
1757
# XXX: Deprecate this.
1758
# ElementTree does its own conversion from UTF-8, so open in
1760
if self._inventory_is_modified:
1761
raise errors.InventoryModified(self)
1762
result = self._deserialize(self._control_files.get('inventory'))
1763
self._set_inventory(result, dirty=False)
1766
@needs_tree_write_lock
1767
def remove(self, files, verbose=False, to_file=None):
1768
"""Remove nominated files from the working inventory..
1770
This does not remove their text. This does not run on XXX on what? RBC
1772
TODO: Refuse to remove modified files unless --force is given?
1774
TODO: Do something useful with directories.
1776
TODO: Should this remove the text or not? Tough call; not
1777
removing may be useful and the user can just use use rm, and
1778
is the opposite of add. Removing it is consistent with most
1779
other tools. Maybe an option.
1781
## TODO: Normalize names
1782
## TODO: Remove nested loops; better scalability
1783
if isinstance(files, basestring):
1786
inv = self.inventory
1788
# do this before any modifications
1790
fid = inv.path2id(f)
1792
note("%s is not versioned."%f)
1795
# having remove it, it must be either ignored or unknown
1796
if self.is_ignored(f):
1800
textui.show_status(new_status, inv[fid].kind, f,
1804
self._write_inventory(inv)
1806
@needs_tree_write_lock
1807
def revert(self, filenames, old_tree=None, backups=True,
1808
pb=DummyProgress(), report_changes=False):
1809
from bzrlib.conflicts import resolve
1810
if old_tree is None:
1811
old_tree = self.basis_tree()
1812
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1814
if not len(filenames):
1815
self.set_parent_ids(self.get_parent_ids()[:1])
1818
resolve(self, filenames, ignore_misses=True)
1039
1821
def revision_tree(self, revision_id):
1040
1822
"""See Tree.revision_tree.
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.
1824
WorkingTree can supply revision_trees for the basis revision only
1825
because there is only one cached inventory in the bzr directory.
1045
raise NotImplementedError(self.revision_tree)
1827
if revision_id == self.last_revision():
1829
xml = self.read_basis_inventory()
1830
except errors.NoSuchFile:
1834
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1835
# dont use the repository revision_tree api because we want
1836
# to supply the inventory.
1837
if inv.revision_id == revision_id:
1838
return revisiontree.RevisionTree(self.branch.repository,
1840
except errors.BadInventoryFormat:
1842
# raise if there was no inventory, or if we read the wrong inventory.
1843
raise errors.NoSuchRevisionInTree(self, revision_id)
1845
# XXX: This method should be deprecated in favour of taking in a proper
1846
# new Inventory object.
1847
@needs_tree_write_lock
1848
def set_inventory(self, new_inventory_list):
1849
from bzrlib.inventory import (Inventory,
1854
inv = Inventory(self.get_root_id())
1855
for path, file_id, parent, kind in new_inventory_list:
1856
name = os.path.basename(path)
1859
# fixme, there should be a factory function inv,add_??
1860
if kind == 'directory':
1861
inv.add(InventoryDirectory(file_id, name, parent))
1862
elif kind == 'file':
1863
inv.add(InventoryFile(file_id, name, parent))
1864
elif kind == 'symlink':
1865
inv.add(InventoryLink(file_id, name, parent))
1867
raise errors.BzrError("unknown kind %r" % kind)
1868
self._write_inventory(inv)
1870
@needs_tree_write_lock
1047
1871
def set_root_id(self, file_id):
1048
1872
"""Set the root id for this tree."""
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)
1875
symbol_versioning.warn(symbol_versioning.zero_twelve
1876
% 'WorkingTree.set_root_id with fileid=None',
1881
file_id = osutils.safe_file_id(file_id)
1882
self._set_root_id(file_id)
1058
1884
def _set_root_id(self, file_id):
1059
1885
"""Set the root id for this tree, in a format specific manner.
1061
:param file_id: The file id to assign to the root. It must not be
1887
:param file_id: The file id to assign to the root. It must not be
1062
1888
present in the current inventory or an error will occur. It must
1063
1889
not be None, but rather a valid file id.
1065
raise NotImplementedError(self._set_root_id)
1891
inv = self._inventory
1892
orig_root_id = inv.root.file_id
1893
# TODO: it might be nice to exit early if there was nothing
1894
# to do, saving us from trigger a sync on unlock.
1895
self._inventory_is_modified = True
1896
# we preserve the root inventory entry object, but
1897
# unlinkit from the byid index
1898
del inv._byid[inv.root.file_id]
1899
inv.root.file_id = file_id
1900
# and link it into the index with the new changed id.
1901
inv._byid[inv.root.file_id] = inv.root
1902
# and finally update all children to reference the new id.
1903
# XXX: this should be safe to just look at the root.children
1904
# list, not the WHOLE INVENTORY.
1907
if entry.parent_id == orig_root_id:
1908
entry.parent_id = inv.root.file_id
1067
1910
def unlock(self):
1068
1911
"""See Branch.unlock.
1070
1913
WorkingTree locking just uses the Branch locking facilities.
1071
1914
This is current because all working trees have an embedded branch
1072
1915
within them. IF in the future, we were to make branch data shareable
1073
between multiple working trees, i.e. via shared storage, then we
1916
between multiple working trees, i.e. via shared storage, then we
1074
1917
would probably want to lock both the local tree, and the branch.
1076
1919
raise NotImplementedError(self.unlock)
1080
def update(self, change_reporter=None, possible_transports=None,
1081
revision=None, old_tip=_marker, show_base=False):
1082
1922
"""Update a working tree along its branch.
1084
1924
This will update the branch if its bound too, which means we have
1139
1971
# cant set that until we update the working trees last revision to be
1140
1972
# one from the new branch, because it will just get absorbed by the
1141
1973
# parent de-duplication logic.
1143
1975
# We MUST save it even if an error occurs, because otherwise the users
1144
1976
# local work is unreferenced and will appear to have been lost.
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]
1980
last_rev = self.get_parent_ids()[0]
1983
if last_rev != self.branch.last_revision():
1984
# merge tree state up to new branch tip.
1985
basis = self.basis_tree()
1988
to_tree = self.branch.basis_tree()
1989
if basis.inventory.root is None:
1990
self.set_root_id(to_tree.inventory.root.file_id)
1992
result += merge.merge_inner(
1999
# TODO - dedup parents list with things merged by pull ?
2000
# reuse the tree we've updated to to set the basis:
2001
parent_trees = [(self.branch.last_revision(), to_tree)]
2002
merges = self.get_parent_ids()[1:]
2003
# Ideally we ask the tree for the trees here, that way the working
2004
# tree can decide whether to give us teh entire tree or give us a
2005
# lazy initialised tree. dirstate for instance will have the trees
2006
# in ram already, whereas a last-revision + basis-inventory tree
2007
# will not, but also does not need them when setting parents.
2008
for parent in merges:
2009
parent_trees.append(
2010
(parent, self.branch.repository.revision_tree(parent)))
2011
if old_tip is not None:
2012
parent_trees.append(
2013
(old_tip, self.branch.repository.revision_tree(old_tip)))
2014
self.set_parent_trees(parent_trees)
2015
last_rev = parent_trees[0][0]
2017
# the working tree had the same last-revision as the master
2018
# branch did. We may still have pivot local work from the local
2019
# branch into old_tip:
2020
if old_tip is not None:
2021
self.add_parent_tree_id(old_tip)
2022
if old_tip and old_tip != last_rev:
2023
# our last revision was not the prior branch last revision
2024
# and we have converted that last revision to a pending merge.
2025
# base is somewhere between the branch tip now
2026
# and the now pending merge
2028
# Since we just modified the working tree and inventory, flush out
2029
# the current state, before we modify it again.
2030
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2031
# requires it only because TreeTransform directly munges the
2032
# inventory and calls tree._write_inventory(). Ultimately we
2033
# should be able to remove this extra flush.
2035
from bzrlib.revision import common_ancestor
2037
base_rev_id = common_ancestor(self.branch.last_revision(),
2039
self.branch.repository)
2040
except errors.NoCommonAncestor:
2042
base_tree = self.branch.repository.revision_tree(base_rev_id)
2043
other_tree = self.branch.repository.revision_tree(old_tip)
2044
result += merge.merge_inner(
2051
def _write_hashcache_if_dirty(self):
2052
"""Write out the hashcache if it is dirty."""
2053
if self._hashcache.needs_write:
2055
self._hashcache.write()
2057
if e.errno not in (errno.EPERM, errno.EACCES):
2059
# TODO: jam 20061219 Should this be a warning? A single line
2060
# warning might be sufficient to let the user know what
2062
mutter('Could not write hashcache for %s\nError: %s',
2063
self._hashcache.cache_file_name(), e)
2065
@needs_tree_write_lock
2066
def _write_inventory(self, inv):
2067
"""Write inventory as the current inventory."""
2068
self._set_inventory(inv, dirty=True)
1213
2071
def set_conflicts(self, arg):
1214
2072
raise errors.UnsupportedOperation(self.set_conflicts, self)
1216
2074
def add_conflicts(self, arg):
1217
2075
raise errors.UnsupportedOperation(self.add_conflicts, self)
1219
2078
def conflicts(self):
1220
raise NotImplementedError(self.conflicts)
2079
conflicts = _mod_conflicts.ConflictList()
2080
for conflicted in self._iter_conflicts():
2083
if file_kind(self.abspath(conflicted)) != "file":
2085
except errors.NoSuchFile:
2088
for suffix in ('.THIS', '.OTHER'):
2090
kind = file_kind(self.abspath(conflicted+suffix))
2093
except errors.NoSuchFile:
2097
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2098
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2100
file_id=self.path2id(conflicted)))
1222
2103
def walkdirs(self, prefix=""):
1223
2104
"""Walk the directories of this tree.
1225
returns a generator which yields items in the form:
1226
(current_directory_path,
1227
[(file1_path, file1_name, file1_kind, (lstat),
1230
2106
This API returns a generator, which is only valid during the current
1231
2107
tree transaction - within a single lock_read or lock_write duration.
1233
If the tree is not locked, it may cause an error to be raised,
1234
depending on the tree implementation.
2109
If the tree is not locked, it may cause an error to be raised, depending
2110
on the tree implementation.
1236
raise NotImplementedError(self.walkdirs)
1238
@deprecated_method(deprecated_in((3, 0, 1)))
2112
disk_top = self.abspath(prefix)
2113
if disk_top.endswith('/'):
2114
disk_top = disk_top[:-1]
2115
top_strip_len = len(disk_top) + 1
2116
inventory_iterator = self._walkdirs(prefix)
2117
disk_iterator = osutils.walkdirs(disk_top, prefix)
2119
current_disk = disk_iterator.next()
2120
disk_finished = False
2122
if e.errno != errno.ENOENT:
2125
disk_finished = True
2127
current_inv = inventory_iterator.next()
2128
inv_finished = False
2129
except StopIteration:
2132
while not inv_finished or not disk_finished:
2133
if not disk_finished:
2134
# strip out .bzr dirs
2135
if current_disk[0][1][top_strip_len:] == '':
2136
# osutils.walkdirs can be made nicer -
2137
# yield the path-from-prefix rather than the pathjoined
2139
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2140
if current_disk[1][bzrdir_loc][0] == '.bzr':
2141
# we dont yield the contents of, or, .bzr itself.
2142
del current_disk[1][bzrdir_loc]
2144
# everything is unknown
2147
# everything is missing
2150
direction = cmp(current_inv[0][0], current_disk[0][0])
2152
# disk is before inventory - unknown
2153
dirblock = [(relpath, basename, kind, stat, None, None) for
2154
relpath, basename, kind, stat, top_path in current_disk[1]]
2155
yield (current_disk[0][0], None), dirblock
2157
current_disk = disk_iterator.next()
2158
except StopIteration:
2159
disk_finished = True
2161
# inventory is before disk - missing.
2162
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2163
for relpath, basename, dkind, stat, fileid, kind in
2165
yield (current_inv[0][0], current_inv[0][1]), dirblock
2167
current_inv = inventory_iterator.next()
2168
except StopIteration:
2171
# versioned present directory
2172
# merge the inventory and disk data together
2174
for relpath, subiterator in itertools.groupby(sorted(
2175
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2176
path_elements = list(subiterator)
2177
if len(path_elements) == 2:
2178
inv_row, disk_row = path_elements
2179
# versioned, present file
2180
dirblock.append((inv_row[0],
2181
inv_row[1], disk_row[2],
2182
disk_row[3], inv_row[4],
2184
elif len(path_elements[0]) == 5:
2186
dirblock.append((path_elements[0][0],
2187
path_elements[0][1], path_elements[0][2],
2188
path_elements[0][3], None, None))
2189
elif len(path_elements[0]) == 6:
2190
# versioned, absent file.
2191
dirblock.append((path_elements[0][0],
2192
path_elements[0][1], 'unknown', None,
2193
path_elements[0][4], path_elements[0][5]))
2195
raise NotImplementedError('unreachable code')
2196
yield current_inv[0], dirblock
2198
current_inv = inventory_iterator.next()
2199
except StopIteration:
2202
current_disk = disk_iterator.next()
2203
except StopIteration:
2204
disk_finished = True
2206
def _walkdirs(self, prefix=""):
2207
_directory = 'directory'
2208
# get the root in the inventory
2209
inv = self.inventory
2210
top_id = inv.path2id(prefix)
2214
pending = [(prefix, '', _directory, None, top_id, None)]
2217
currentdir = pending.pop()
2218
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2219
top_id = currentdir[4]
2221
relroot = currentdir[0] + '/'
2224
# FIXME: stash the node in pending
2226
for name, child in entry.sorted_children():
2227
dirblock.append((relroot + name, name, child.kind, None,
2228
child.file_id, child.kind
2230
yield (currentdir[0], entry.file_id), dirblock
2231
# push the user specified dirs from dirblock
2232
for dir in reversed(dirblock):
2233
if dir[2] == _directory:
2236
@needs_tree_write_lock
1239
2237
def auto_resolve(self):
1240
2238
"""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)
1286
def _get_rules_searcher(self, default_searcher):
1287
"""See Tree._get_rules_searcher."""
1288
if self._rules_searcher is None:
1289
self._rules_searcher = super(WorkingTree,
1290
self)._get_rules_searcher(default_searcher)
1291
return self._rules_searcher
1293
def get_shelf_manager(self):
1294
"""Return the ShelfManager for this WorkingTree."""
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):
2280
class WorkingTree2(WorkingTree):
2281
"""This is the Format 2 working tree.
2283
This was the first weave based working tree.
2284
- uses os locks for locking.
2285
- uses the branch last-revision.
2288
def __init__(self, *args, **kwargs):
2289
super(WorkingTree2, self).__init__(*args, **kwargs)
2290
# WorkingTree2 has more of a constraint that self._inventory must
2291
# exist. Because this is an older format, we don't mind the overhead
2292
# caused by the extra computation here.
2294
# Newer WorkingTree's should only have self._inventory set when they
2296
if self._inventory is None:
2297
self.read_working_inventory()
2299
def lock_tree_write(self):
2300
"""See WorkingTree.lock_tree_write().
2302
In Format2 WorkingTrees we have a single lock for the branch and tree
2303
so lock_tree_write() degrades to lock_write().
2305
self.branch.lock_write()
2307
return self._control_files.lock_write()
2309
self.branch.unlock()
2313
# we share control files:
2314
if self._control_files._lock_count == 3:
2315
# _inventory_is_modified is always False during a read lock.
2316
if self._inventory_is_modified:
2318
self._write_hashcache_if_dirty()
2320
# reverse order of locking.
2322
return self._control_files.unlock()
2324
self.branch.unlock()
2327
class WorkingTree3(WorkingTree):
2328
"""This is the Format 3 working tree.
2330
This differs from the base WorkingTree by:
2331
- having its own file lock
2332
- having its own last-revision property.
2334
This is new in bzr 0.8
2338
def _last_revision(self):
2339
"""See Mutable.last_revision."""
2341
return osutils.safe_revision_id(
2342
self._control_files.get('last-revision').read())
2343
except errors.NoSuchFile:
2346
def _change_last_revision(self, revision_id):
2347
"""See WorkingTree._change_last_revision."""
2348
if revision_id is None or revision_id == NULL_REVISION:
2350
self._control_files._transport.delete('last-revision')
2351
except errors.NoSuchFile:
2355
self._control_files.put_bytes('last-revision', revision_id)
2358
@needs_tree_write_lock
2359
def set_conflicts(self, conflicts):
2360
self._put_rio('conflicts', conflicts.to_stanzas(),
2363
@needs_tree_write_lock
2364
def add_conflicts(self, new_conflicts):
2365
conflict_set = set(self.conflicts())
2366
conflict_set.update(set(list(new_conflicts)))
2367
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2368
key=_mod_conflicts.Conflict.sort_key)))
2371
def conflicts(self):
2373
confile = self._control_files.get('conflicts')
2374
except errors.NoSuchFile:
2375
return _mod_conflicts.ConflictList()
2377
if confile.next() != CONFLICT_HEADER_1 + '\n':
2378
raise errors.ConflictFormatError()
2379
except StopIteration:
2380
raise errors.ConflictFormatError()
2381
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2384
if self._control_files._lock_count == 1:
2385
# _inventory_is_modified is always False during a read lock.
2386
if self._inventory_is_modified:
2388
self._write_hashcache_if_dirty()
2389
# reverse order of locking.
2391
return self._control_files.unlock()
2393
self.branch.unlock()
2396
def get_conflicted_stem(path):
2397
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2398
if path.endswith(suffix):
2399
return path[:-len(suffix)]
2402
@deprecated_function(zero_eight)
2403
def is_control_file(filename):
2404
"""See WorkingTree.is_control_filename(filename)."""
2405
## FIXME: better check
2406
filename = normpath(filename)
2407
while filename != '':
2408
head, tail = os.path.split(filename)
2409
## mutter('check %r for control file' % ((head, tail),))
2412
if filename == head:
2418
class WorkingTreeFormat(object):
1373
2419
"""An encapsulation of the initialization and open routines for a format.
1375
2421
Formats provide three things:
1447
2478
"""Is this format supported?
1449
2480
Supported formats can be initialized and opened.
1450
Unsupported formats may not support initialization or committing or
2481
Unsupported formats may not support initialization or committing or
1451
2482
some other features depending on the reason for not being supported.
1455
def supports_content_filtering(self):
1456
"""True if this format supports content filtering."""
1459
def supports_views(self):
1460
"""True if this format supports stored views."""
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")
2487
def register_format(klass, format):
2488
klass._formats[format.get_format_string()] = format
2491
def set_default_format(klass, format):
2492
klass._default_format = format
2495
def unregister_format(klass, format):
2496
assert klass._formats[format.get_format_string()] is format
2497
del klass._formats[format.get_format_string()]
2500
class WorkingTreeFormat2(WorkingTreeFormat):
2501
"""The second working tree format.
2503
This format modified the hash cache from the format 1 hash cache.
2506
upgrade_recommended = True
2508
def get_format_description(self):
2509
"""See WorkingTreeFormat.get_format_description()."""
2510
return "Working tree format 2"
2512
def stub_initialize_remote(self, control_files):
2513
"""As a special workaround create critical control files for a remote working tree
2515
This ensures that it can later be updated and dealt with locally,
2516
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2517
no working tree. (See bug #43064).
2521
xml5.serializer_v5.write_inventory(inv, sio)
2523
control_files.put('inventory', sio)
2525
control_files.put_bytes('pending-merges', '')
2528
def initialize(self, a_bzrdir, revision_id=None):
2529
"""See WorkingTreeFormat.initialize()."""
2530
if not isinstance(a_bzrdir.transport, LocalTransport):
2531
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2532
branch = a_bzrdir.open_branch()
2533
if revision_id is not None:
2534
revision_id = osutils.safe_revision_id(revision_id)
2537
revision_history = branch.revision_history()
2539
position = revision_history.index(revision_id)
2541
raise errors.NoSuchRevision(branch, revision_id)
2542
branch.set_revision_history(revision_history[:position + 1])
2545
revision = branch.last_revision()
2547
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2553
basis_tree = branch.repository.revision_tree(revision)
2554
if basis_tree.inventory.root is not None:
2555
wt.set_root_id(basis_tree.inventory.root.file_id)
2556
# set the parent list and cache the basis tree.
2557
wt.set_parent_trees([(revision, basis_tree)])
2558
transform.build_tree(basis_tree, wt)
2562
super(WorkingTreeFormat2, self).__init__()
2563
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2565
def open(self, a_bzrdir, _found=False):
2566
"""Return the WorkingTree object for a_bzrdir
2568
_found is a private parameter, do not use it. It is used to indicate
2569
if format probing has already been done.
2572
# we are being called directly and must probe.
2573
raise NotImplementedError
2574
if not isinstance(a_bzrdir.transport, LocalTransport):
2575
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2576
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2582
class WorkingTreeFormat3(WorkingTreeFormat):
2583
"""The second working tree format updated to record a format marker.
2586
- exists within a metadir controlling .bzr
2587
- includes an explicit version marker for the workingtree control
2588
files, separate from the BzrDir format
2589
- modifies the hash cache format
2591
- uses a LockDir to guard access for writes.
2594
upgrade_recommended = True
2596
def get_format_string(self):
2597
"""See WorkingTreeFormat.get_format_string()."""
2598
return "Bazaar-NG Working Tree format 3"
2600
def get_format_description(self):
2601
"""See WorkingTreeFormat.get_format_description()."""
2602
return "Working tree format 3"
2604
_lock_file_name = 'lock'
2605
_lock_class = LockDir
2607
_tree_class = WorkingTree3
2609
def __get_matchingbzrdir(self):
2610
return bzrdir.BzrDirMetaFormat1()
2612
_matchingbzrdir = property(__get_matchingbzrdir)
2614
def _open_control_files(self, a_bzrdir):
2615
transport = a_bzrdir.get_workingtree_transport(None)
2616
return LockableFiles(transport, self._lock_file_name,
2619
def initialize(self, a_bzrdir, revision_id=None):
2620
"""See WorkingTreeFormat.initialize().
2622
revision_id allows creating a working tree at a different
2623
revision than the branch is at.
2625
if not isinstance(a_bzrdir.transport, LocalTransport):
2626
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2627
transport = a_bzrdir.get_workingtree_transport(self)
2628
control_files = self._open_control_files(a_bzrdir)
2629
control_files.create_lock()
2630
control_files.lock_write()
2631
control_files.put_utf8('format', self.get_format_string())
2632
branch = a_bzrdir.open_branch()
2633
if revision_id is None:
2634
revision_id = branch.last_revision()
2636
revision_id = osutils.safe_revision_id(revision_id)
2637
# WorkingTree3 can handle an inventory which has a unique root id.
2638
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2639
# those trees. And because there isn't a format bump inbetween, we
2640
# are maintaining compatibility with older clients.
2641
# inv = Inventory(root_id=gen_root_id())
2642
inv = self._initial_inventory()
2643
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2649
_control_files=control_files)
2650
wt.lock_tree_write()
2652
basis_tree = branch.repository.revision_tree(revision_id)
2653
# only set an explicit root id if there is one to set.
2654
if basis_tree.inventory.root is not None:
2655
wt.set_root_id(basis_tree.inventory.root.file_id)
2656
if revision_id == NULL_REVISION:
2657
wt.set_parent_trees([])
2659
wt.set_parent_trees([(revision_id, basis_tree)])
2660
transform.build_tree(basis_tree, wt)
2662
# Unlock in this order so that the unlock-triggers-flush in
2663
# WorkingTree is given a chance to fire.
2664
control_files.unlock()
2668
def _initial_inventory(self):
2672
super(WorkingTreeFormat3, self).__init__()
2674
def open(self, a_bzrdir, _found=False):
2675
"""Return the WorkingTree object for a_bzrdir
2677
_found is a private parameter, do not use it. It is used to indicate
2678
if format probing has already been done.
2681
# we are being called directly and must probe.
2682
raise NotImplementedError
2683
if not isinstance(a_bzrdir.transport, LocalTransport):
2684
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2685
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2688
def _open(self, a_bzrdir, control_files):
2689
"""Open the tree itself.
2691
:param a_bzrdir: the dir for the tree.
2692
:param control_files: the control files for the tree.
2694
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2698
_control_files=control_files)
2701
return self.get_format_string()
2704
__default_format = WorkingTreeFormat4()
2705
WorkingTreeFormat.register_format(__default_format)
2706
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2707
WorkingTreeFormat.set_default_format(__default_format)
2708
# formats which have no format string are not discoverable
2709
# and not independently creatable, so are not registered.
2710
_legacy_formats = [WorkingTreeFormat2(),
2714
class WorkingTreeTestProviderAdapter(object):
2715
"""A tool to generate a suite testing multiple workingtree formats at once.
2717
This is done by copying the test once for each transport and injecting
2718
the transport_server, transport_readonly_server, and workingtree_format
2719
classes into each copy. Each copy is also given a new id() to make it
2723
def __init__(self, transport_server, transport_readonly_server, formats):
2724
self._transport_server = transport_server
2725
self._transport_readonly_server = transport_readonly_server
2726
self._formats = formats
2728
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2729
"""Clone test for adaption."""
2730
new_test = deepcopy(test)
2731
new_test.transport_server = self._transport_server
2732
new_test.transport_readonly_server = self._transport_readonly_server
2733
new_test.bzrdir_format = bzrdir_format
2734
new_test.workingtree_format = workingtree_format
2735
def make_new_test_id():
2736
new_id = "%s(%s)" % (test.id(), variation)
2737
return lambda: new_id
2738
new_test.id = make_new_test_id()
2741
def adapt(self, test):
2742
from bzrlib.tests import TestSuite
2743
result = TestSuite()
2744
for workingtree_format, bzrdir_format in self._formats:
2745
new_test = self._clone_test(
2748
workingtree_format, workingtree_format.__class__.__name__)
2749
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
