1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""WorkingTree object and friends.
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. 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.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
33
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
51
conflicts as _mod_conflicts,
60
revision as _mod_revision,
70
from bzrlib.workingtree_4 import (
77
from bzrlib import symbol_versioning
78
from bzrlib.decorators import needs_read_lock, needs_write_lock
79
from bzrlib.lock import LogicalLockResult
80
from bzrlib.lockable_files import LockableFiles
81
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
95
from bzrlib.filters import filtered_input_file
96
from bzrlib.trace import mutter, note
97
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
99
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
106
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
115
class TreeEntry(object):
116
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
119
InventoryEntries without ids - though that seems wrong. For now,
120
this is a parallel hierarchy to InventoryEntry, and needs to become
121
one of several things: decorates to that hierarchy, children of, or
123
Another note is that these objects are currently only used when there is
124
no InventoryEntry available - i.e. for unversioned objects.
125
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
128
def __eq__(self, other):
129
# yes, this us ugly, TODO: best practice __eq__ style.
130
return (isinstance(other, TreeEntry)
131
and other.__class__ == self.__class__)
133
def kind_character(self):
137
class TreeDirectory(TreeEntry):
138
"""See TreeEntry. This is a directory in a working tree."""
140
def __eq__(self, other):
141
return (isinstance(other, TreeDirectory)
142
and other.__class__ == self.__class__)
144
def kind_character(self):
148
class TreeFile(TreeEntry):
149
"""See TreeEntry. This is a regular file in a working tree."""
151
def __eq__(self, other):
152
return (isinstance(other, TreeFile)
153
and other.__class__ == self.__class__)
155
def kind_character(self):
159
class TreeLink(TreeEntry):
160
"""See TreeEntry. This is a symlink in a working tree."""
162
def __eq__(self, other):
163
return (isinstance(other, TreeLink)
164
and other.__class__ == self.__class__)
166
def kind_character(self):
170
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
bzrdir.ControlComponent):
172
"""Working copy tree.
174
The inventory is held in the `Branch` working-inventory, and the
175
files are in a directory on disk.
177
It is possible for a `WorkingTree` to have a filename which is
178
not listed in the Inventory and vice versa.
180
:ivar basedir: The root of the tree on disk. This is a unicode path object
181
(as opposed to a URL).
184
# override this to set the strategy for storing views
185
def _make_views(self):
186
return views.DisabledViews(self)
188
def __init__(self, basedir='.',
189
branch=DEPRECATED_PARAMETER,
195
"""Construct a WorkingTree instance. This is not a public API.
197
:param branch: A branch to override probing for the branch.
199
self._format = _format
200
self.bzrdir = _bzrdir
202
raise errors.BzrError("Please use bzrdir.open_workingtree or "
203
"WorkingTree.open() to obtain a WorkingTree.")
204
basedir = safe_unicode(basedir)
205
mutter("opening working tree %r", basedir)
206
if deprecated_passed(branch):
207
self._branch = branch
209
self._branch = self.bzrdir.open_branch()
210
self.basedir = realpath(basedir)
211
# if branch is at our basedir and is a format 6 or less
212
if isinstance(self._format, WorkingTreeFormat2):
213
# share control object
214
self._control_files = self.branch.control_files
216
# assume all other formats have their own control files.
217
self._control_files = _control_files
218
self._transport = self._control_files._transport
219
# update the whole cache up front and write to disk if anything changed;
220
# in the future we might want to do this more selectively
221
# two possible ways offer themselves : in self._unlock, write the cache
222
# if needed, or, when the cache sees a change, append it to the hash
223
# cache file, and have the parser take the most recent entry for a
225
wt_trans = self.bzrdir.get_workingtree_transport(None)
226
cache_filename = wt_trans.local_abspath('stat-cache')
227
self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
self.bzrdir._get_file_mode(),
229
self._content_filter_stack_provider())
232
# is this scan needed ? it makes things kinda slow.
239
if _inventory is None:
240
# This will be acquired on lock_read() or lock_write()
241
self._inventory_is_modified = False
242
self._inventory = None
244
# the caller of __init__ has provided an inventory,
245
# we assume they know what they are doing - as its only
246
# the Format factory and creation methods that are
247
# permitted to do this.
248
self._set_inventory(_inventory, dirty=False)
249
self._detect_case_handling()
250
self._rules_searcher = None
251
self.views = self._make_views()
254
def user_transport(self):
255
return self.bzrdir.user_transport
258
def control_transport(self):
259
return self._transport
261
def _detect_case_handling(self):
262
wt_trans = self.bzrdir.get_workingtree_transport(None)
264
wt_trans.stat("FoRMaT")
265
except errors.NoSuchFile:
266
self.case_sensitive = True
268
self.case_sensitive = False
270
self._setup_directory_is_tree_reference()
273
fget=lambda self: self._branch,
274
doc="""The branch this WorkingTree is connected to.
276
This cannot be set - it is reflective of the actual disk structure
277
the working tree has been constructed from.
280
def break_lock(self):
281
"""Break a lock if one is present from another instance.
283
Uses the ui factory to ask for confirmation if the lock may be from
286
This will probe the repository for its lock as well.
288
self._control_files.break_lock()
289
self.branch.break_lock()
291
def _get_check_refs(self):
292
"""Return the references needed to perform a check of this tree.
294
The default implementation returns no refs, and is only suitable for
295
trees that have no local caching and can commit on ghosts at any time.
297
:seealso: bzrlib.check for details about check_refs.
301
def requires_rich_root(self):
302
return self._format.requires_rich_root
304
def supports_tree_reference(self):
307
def supports_content_filtering(self):
308
return self._format.supports_content_filtering()
310
def supports_views(self):
311
return self.views.supports_views()
313
def _set_inventory(self, inv, dirty):
314
"""Set the internal cached inventory.
316
:param inv: The inventory to set.
317
:param dirty: A boolean indicating whether the inventory is the same
318
logical inventory as whats on disk. If True the inventory is not
319
the same and should be written to disk or data will be lost, if
320
False then the inventory is the same as that on disk and any
321
serialisation would be unneeded overhead.
323
self._inventory = inv
324
self._inventory_is_modified = dirty
327
def open(path=None, _unsupported=False):
328
"""Open an existing working tree at path.
332
path = osutils.getcwd()
333
control = bzrdir.BzrDir.open(path, _unsupported)
334
return control.open_workingtree(_unsupported)
337
def open_containing(path=None):
338
"""Open an existing working tree which has its root about path.
340
This probes for a working tree at path and searches upwards from there.
342
Basically we keep looking up until we find the control directory or
343
run into /. If there isn't one, raises NotBranchError.
344
TODO: give this a new exception.
345
If there is one, it is returned, along with the unused portion of path.
347
:return: The WorkingTree that contains 'path', and the rest of path
350
path = osutils.getcwd()
351
control, relpath = bzrdir.BzrDir.open_containing(path)
352
return control.open_workingtree(), relpath
355
def open_containing_paths(file_list, default_directory='.',
356
canonicalize=True, apply_view=True):
357
"""Open the WorkingTree that contains a set of paths.
359
Fail if the paths given are not all in a single tree.
361
This is used for the many command-line interfaces that take a list of
362
any number of files and that require they all be in the same tree.
364
# recommended replacement for builtins.internal_tree_files
365
if file_list is None or len(file_list) == 0:
366
tree = WorkingTree.open_containing(default_directory)[0]
367
# XXX: doesn't really belong here, and seems to have the strange
368
# side effect of making it return a bunch of files, not the whole
369
# tree -- mbp 20100716
370
if tree.supports_views() and apply_view:
371
view_files = tree.views.lookup_view()
373
file_list = view_files
374
view_str = views.view_display_str(view_files)
375
note("Ignoring files outside view. View is %s" % view_str)
376
return tree, file_list
377
tree = WorkingTree.open_containing(file_list[0])[0]
378
return tree, tree.safe_relpath_files(file_list, canonicalize,
379
apply_view=apply_view)
381
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
382
"""Convert file_list into a list of relpaths in tree.
384
:param self: A tree to operate on.
385
:param file_list: A list of user provided paths or None.
386
:param apply_view: if True and a view is set, apply it or check that
387
specified files are within it
388
:return: A list of relative paths.
389
:raises errors.PathNotChild: When a provided path is in a different self
392
if file_list is None:
394
if self.supports_views() and apply_view:
395
view_files = self.views.lookup_view()
399
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
400
# doesn't - fix that up here before we enter the loop.
402
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
405
for filename in file_list:
406
relpath = fixer(osutils.dereference_path(filename))
407
if view_files and not osutils.is_inside_any(view_files, relpath):
408
raise errors.FileOutsideView(filename, view_files)
409
new_list.append(relpath)
413
def open_downlevel(path=None):
414
"""Open an unsupported working tree.
416
Only intended for advanced situations like upgrading part of a bzrdir.
418
return WorkingTree.open(path, _unsupported=True)
421
def find_trees(location):
422
def list_current(transport):
423
return [d for d in transport.list_dir('') if d != '.bzr']
424
def evaluate(bzrdir):
426
tree = bzrdir.open_workingtree()
427
except errors.NoWorkingTree:
431
t = transport.get_transport(location)
432
iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
433
list_current=list_current)
434
return [tr for tr in iterator if tr is not None]
436
# should be deprecated - this is slow and in any case treating them as a
437
# container is (we now know) bad style -- mbp 20070302
438
## @deprecated_method(zero_fifteen)
440
"""Iterate through file_ids for this tree.
442
file_ids are in a WorkingTree if they are in the working inventory
443
and the working file exists.
445
inv = self._inventory
446
for path, ie in inv.iter_entries():
447
if osutils.lexists(self.abspath(path)):
450
def all_file_ids(self):
451
"""See Tree.iter_all_file_ids"""
452
return set(self.inventory)
455
return "<%s of %s>" % (self.__class__.__name__,
456
getattr(self, 'basedir', None))
458
def abspath(self, filename):
459
return pathjoin(self.basedir, filename)
461
def basis_tree(self):
462
"""Return RevisionTree for the current last revision.
464
If the left most parent is a ghost then the returned tree will be an
465
empty tree - one obtained by calling
466
repository.revision_tree(NULL_REVISION).
469
revision_id = self.get_parent_ids()[0]
471
# no parents, return an empty revision tree.
472
# in the future this should return the tree for
473
# 'empty:' - the implicit root empty tree.
474
return self.branch.repository.revision_tree(
475
_mod_revision.NULL_REVISION)
477
return self.revision_tree(revision_id)
478
except errors.NoSuchRevision:
480
# No cached copy available, retrieve from the repository.
481
# FIXME? RBC 20060403 should we cache the inventory locally
484
return self.branch.repository.revision_tree(revision_id)
485
except (errors.RevisionNotPresent, errors.NoSuchRevision):
486
# the basis tree *may* be a ghost or a low level error may have
487
# occurred. If the revision is present, its a problem, if its not
489
if self.branch.repository.has_revision(revision_id):
491
# the basis tree is a ghost so return an empty tree.
492
return self.branch.repository.revision_tree(
493
_mod_revision.NULL_REVISION)
496
self._flush_ignore_list_cache()
498
def relpath(self, path):
499
"""Return the local path portion from a given path.
501
The path may be absolute or relative. If its a relative path it is
502
interpreted relative to the python current working directory.
504
return osutils.relpath(self.basedir, path)
506
def has_filename(self, filename):
507
return osutils.lexists(self.abspath(filename))
509
def get_file(self, file_id, path=None, filtered=True):
510
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
512
def get_file_with_stat(self, file_id, path=None, filtered=True,
514
"""See Tree.get_file_with_stat."""
516
path = self.id2path(file_id)
517
file_obj = self.get_file_byname(path, filtered=False)
518
stat_value = _fstat(file_obj.fileno())
519
if filtered and self.supports_content_filtering():
520
filters = self._content_filter_stack(path)
521
file_obj = filtered_input_file(file_obj, filters)
522
return (file_obj, stat_value)
524
def get_file_text(self, file_id, path=None, filtered=True):
525
my_file = self.get_file(file_id, path=path, filtered=filtered)
527
return my_file.read()
531
def get_file_byname(self, filename, filtered=True):
532
path = self.abspath(filename)
534
if filtered and self.supports_content_filtering():
535
filters = self._content_filter_stack(filename)
536
return filtered_input_file(f, filters)
540
def get_file_lines(self, file_id, path=None, filtered=True):
541
"""See Tree.get_file_lines()"""
542
file = self.get_file(file_id, path, filtered=filtered)
544
return file.readlines()
549
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
550
"""See Tree.annotate_iter
552
This implementation will use the basis tree implementation if possible.
553
Lines not in the basis are attributed to CURRENT_REVISION
555
If there are pending merges, lines added by those merges will be
556
incorrectly attributed to CURRENT_REVISION (but after committing, the
557
attribution will be correct).
559
maybe_file_parent_keys = []
560
for parent_id in self.get_parent_ids():
562
parent_tree = self.revision_tree(parent_id)
563
except errors.NoSuchRevisionInTree:
564
parent_tree = self.branch.repository.revision_tree(parent_id)
565
parent_tree.lock_read()
567
if file_id not in parent_tree:
569
ie = parent_tree.inventory[file_id]
570
if ie.kind != 'file':
571
# Note: this is slightly unnecessary, because symlinks and
572
# directories have a "text" which is the empty text, and we
573
# know that won't mess up annotations. But it seems cleaner
575
parent_text_key = (file_id, ie.revision)
576
if parent_text_key not in maybe_file_parent_keys:
577
maybe_file_parent_keys.append(parent_text_key)
580
graph = _mod_graph.Graph(self.branch.repository.texts)
581
heads = graph.heads(maybe_file_parent_keys)
582
file_parent_keys = []
583
for key in maybe_file_parent_keys:
585
file_parent_keys.append(key)
587
# Now we have the parents of this content
588
annotator = self.branch.repository.texts.get_annotator()
589
text = self.get_file_text(file_id)
590
this_key =(file_id, default_revision)
591
annotator.add_special_text(this_key, file_parent_keys, text)
592
annotations = [(key[-1], line)
593
for key, line in annotator.annotate_flat(this_key)]
596
def _get_ancestors(self, default_revision):
597
ancestors = set([default_revision])
598
for parent_id in self.get_parent_ids():
599
ancestors.update(self.branch.repository.get_ancestry(
600
parent_id, topo_sorted=False))
603
def get_parent_ids(self):
604
"""See Tree.get_parent_ids.
606
This implementation reads the pending merges list and last_revision
607
value and uses that to decide what the parents list should be.
609
last_rev = _mod_revision.ensure_null(self._last_revision())
610
if _mod_revision.NULL_REVISION == last_rev:
615
merges_bytes = self._transport.get_bytes('pending-merges')
616
except errors.NoSuchFile:
619
for l in osutils.split_lines(merges_bytes):
620
revision_id = l.rstrip('\n')
621
parents.append(revision_id)
625
def get_root_id(self):
626
"""Return the id of this trees root"""
627
return self._inventory.root.file_id
629
def _get_store_filename(self, file_id):
630
## XXX: badly named; this is not in the store at all
631
return self.abspath(self.id2path(file_id))
634
def clone(self, to_bzrdir, revision_id=None):
635
"""Duplicate this working tree into to_bzr, including all state.
637
Specifically modified files are kept as modified, but
638
ignored and unknown files are discarded.
640
If you want to make a new line of development, see bzrdir.sprout()
643
If not None, the cloned tree will have its last revision set to
644
revision, and difference between the source trees last revision
645
and this one merged in.
647
# assumes the target bzr dir format is compatible.
648
result = to_bzrdir.create_workingtree()
649
self.copy_content_into(result, revision_id)
653
def copy_content_into(self, tree, revision_id=None):
654
"""Copy the current content and user files of this tree into tree."""
655
tree.set_root_id(self.get_root_id())
656
if revision_id is None:
657
merge.transform_tree(tree, self)
659
# TODO now merge from tree.last_revision to revision (to preserve
660
# user local changes)
661
merge.transform_tree(tree, self)
662
tree.set_parent_ids([revision_id])
664
def id2abspath(self, file_id):
665
return self.abspath(self.id2path(file_id))
667
def has_id(self, file_id):
668
# files that have been deleted are excluded
670
if not inv.has_id(file_id):
672
path = inv.id2path(file_id)
673
return osutils.lexists(self.abspath(path))
675
def has_or_had_id(self, file_id):
676
if file_id == self.inventory.root.file_id:
678
return self.inventory.has_id(file_id)
680
__contains__ = has_id
682
def get_file_size(self, file_id):
683
"""See Tree.get_file_size"""
684
# XXX: this returns the on-disk size; it should probably return the
687
return os.path.getsize(self.id2abspath(file_id))
689
if e.errno != errno.ENOENT:
695
def get_file_sha1(self, file_id, path=None, stat_value=None):
697
path = self._inventory.id2path(file_id)
698
return self._hashcache.get_sha1(path, stat_value)
700
def get_file_mtime(self, file_id, path=None):
702
path = self.inventory.id2path(file_id)
703
return os.lstat(self.abspath(path)).st_mtime
705
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
706
file_id = self.path2id(path)
708
# For unversioned files on win32, we just assume they are not
711
return self._inventory[file_id].executable
713
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
714
mode = stat_result.st_mode
715
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
717
if not supports_executable():
718
def is_executable(self, file_id, path=None):
719
return self._inventory[file_id].executable
721
_is_executable_from_path_and_stat = \
722
_is_executable_from_path_and_stat_from_basis
724
def is_executable(self, file_id, path=None):
726
path = self.id2path(file_id)
727
mode = os.lstat(self.abspath(path)).st_mode
728
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
730
_is_executable_from_path_and_stat = \
731
_is_executable_from_path_and_stat_from_stat
733
@needs_tree_write_lock
734
def _add(self, files, ids, kinds):
735
"""See MutableTree._add."""
736
# TODO: Re-adding a file that is removed in the working copy
737
# should probably put it back with the previous ID.
738
# the read and write working inventory should not occur in this
739
# function - they should be part of lock_write and unlock.
741
for f, file_id, kind in zip(files, ids, kinds):
743
inv.add_path(f, kind=kind)
745
inv.add_path(f, kind=kind, file_id=file_id)
746
self._inventory_is_modified = True
748
@needs_tree_write_lock
749
def _gather_kinds(self, files, kinds):
750
"""See MutableTree._gather_kinds."""
751
for pos, f in enumerate(files):
752
if kinds[pos] is None:
753
fullpath = normpath(self.abspath(f))
755
kinds[pos] = file_kind(fullpath)
757
if e.errno == errno.ENOENT:
758
raise errors.NoSuchFile(fullpath)
761
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
762
"""Add revision_id as a parent.
764
This is equivalent to retrieving the current list of parent ids
765
and setting the list to its value plus revision_id.
767
:param revision_id: The revision id to add to the parent list. It may
768
be a ghost revision as long as its not the first parent to be added,
769
or the allow_leftmost_as_ghost parameter is set True.
770
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
772
parents = self.get_parent_ids() + [revision_id]
773
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
774
or allow_leftmost_as_ghost)
776
@needs_tree_write_lock
777
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
778
"""Add revision_id, tree tuple as a parent.
780
This is equivalent to retrieving the current list of parent trees
781
and setting the list to its value plus parent_tuple. See also
782
add_parent_tree_id - if you only have a parent id available it will be
783
simpler to use that api. If you have the parent already available, using
784
this api is preferred.
786
:param parent_tuple: The (revision id, tree) to add to the parent list.
787
If the revision_id is a ghost, pass None for the tree.
788
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
790
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
791
if len(parent_ids) > 1:
792
# the leftmost may have already been a ghost, preserve that if it
794
allow_leftmost_as_ghost = True
795
self.set_parent_ids(parent_ids,
796
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
798
@needs_tree_write_lock
799
def add_pending_merge(self, *revision_ids):
800
# TODO: Perhaps should check at this point that the
801
# history of the revision is actually present?
802
parents = self.get_parent_ids()
804
for rev_id in revision_ids:
805
if rev_id in parents:
807
parents.append(rev_id)
810
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
812
def path_content_summary(self, path, _lstat=os.lstat,
813
_mapper=osutils.file_kind_from_stat_mode):
814
"""See Tree.path_content_summary."""
815
abspath = self.abspath(path)
817
stat_result = _lstat(abspath)
819
if getattr(e, 'errno', None) == errno.ENOENT:
821
return ('missing', None, None, None)
822
# propagate other errors
824
kind = _mapper(stat_result.st_mode)
826
return self._file_content_summary(path, stat_result)
827
elif kind == 'directory':
828
# perhaps it looks like a plain directory, but it's really a
830
if self._directory_is_tree_reference(path):
831
kind = 'tree-reference'
832
return kind, None, None, None
833
elif kind == 'symlink':
834
target = osutils.readlink(abspath)
835
return ('symlink', None, None, target)
837
return (kind, None, None, None)
839
def _file_content_summary(self, path, stat_result):
840
size = stat_result.st_size
841
executable = self._is_executable_from_path_and_stat(path, stat_result)
842
# try for a stat cache lookup
843
return ('file', size, executable, self._sha_from_stat(
846
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
847
"""Common ghost checking functionality from set_parent_*.
849
This checks that the left hand-parent exists if there are any
852
if len(revision_ids) > 0:
853
leftmost_id = revision_ids[0]
854
if (not allow_leftmost_as_ghost and not
855
self.branch.repository.has_revision(leftmost_id)):
856
raise errors.GhostRevisionUnusableHere(leftmost_id)
858
def _set_merges_from_parent_ids(self, parent_ids):
859
merges = parent_ids[1:]
860
self._transport.put_bytes('pending-merges', '\n'.join(merges),
861
mode=self.bzrdir._get_file_mode())
863
def _filter_parent_ids_by_ancestry(self, revision_ids):
864
"""Check that all merged revisions are proper 'heads'.
866
This will always return the first revision_id, and any merged revisions
869
if len(revision_ids) == 0:
871
graph = self.branch.repository.get_graph()
872
heads = graph.heads(revision_ids)
873
new_revision_ids = revision_ids[:1]
874
for revision_id in revision_ids[1:]:
875
if revision_id in heads and revision_id not in new_revision_ids:
876
new_revision_ids.append(revision_id)
877
if new_revision_ids != revision_ids:
878
trace.mutter('requested to set revision_ids = %s,'
879
' but filtered to %s', revision_ids, new_revision_ids)
880
return new_revision_ids
882
@needs_tree_write_lock
883
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
884
"""Set the parent ids to revision_ids.
886
See also set_parent_trees. This api will try to retrieve the tree data
887
for each element of revision_ids from the trees repository. If you have
888
tree data already available, it is more efficient to use
889
set_parent_trees rather than set_parent_ids. set_parent_ids is however
890
an easier API to use.
892
:param revision_ids: The revision_ids to set as the parent ids of this
893
working tree. Any of these may be ghosts.
895
self._check_parents_for_ghosts(revision_ids,
896
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
897
for revision_id in revision_ids:
898
_mod_revision.check_not_reserved_id(revision_id)
900
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
902
if len(revision_ids) > 0:
903
self.set_last_revision(revision_ids[0])
905
self.set_last_revision(_mod_revision.NULL_REVISION)
907
self._set_merges_from_parent_ids(revision_ids)
909
@needs_tree_write_lock
910
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
911
"""See MutableTree.set_parent_trees."""
912
parent_ids = [rev for (rev, tree) in parents_list]
913
for revision_id in parent_ids:
914
_mod_revision.check_not_reserved_id(revision_id)
916
self._check_parents_for_ghosts(parent_ids,
917
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
919
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
921
if len(parent_ids) == 0:
922
leftmost_parent_id = _mod_revision.NULL_REVISION
923
leftmost_parent_tree = None
925
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
927
if self._change_last_revision(leftmost_parent_id):
928
if leftmost_parent_tree is None:
929
# If we don't have a tree, fall back to reading the
930
# parent tree from the repository.
931
self._cache_basis_inventory(leftmost_parent_id)
933
inv = leftmost_parent_tree.inventory
934
xml = self._create_basis_xml_from_inventory(
935
leftmost_parent_id, inv)
936
self._write_basis_inventory(xml)
937
self._set_merges_from_parent_ids(parent_ids)
939
@needs_tree_write_lock
940
def set_pending_merges(self, rev_list):
941
parents = self.get_parent_ids()
942
leftmost = parents[:1]
943
new_parents = leftmost + rev_list
944
self.set_parent_ids(new_parents)
946
@needs_tree_write_lock
947
def set_merge_modified(self, modified_hashes):
949
for file_id, hash in modified_hashes.iteritems():
950
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
951
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
953
def _sha_from_stat(self, path, stat_result):
954
"""Get a sha digest from the tree's stat cache.
956
The default implementation assumes no stat cache is present.
958
:param path: The path.
959
:param stat_result: The stat result being looked up.
963
def _put_rio(self, filename, stanzas, header):
964
self._must_be_locked()
965
my_file = rio_file(stanzas, header)
966
self._transport.put_file(filename, my_file,
967
mode=self.bzrdir._get_file_mode())
969
@needs_write_lock # because merge pulls data into the branch.
970
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
971
merge_type=None, force=False):
972
"""Merge from a branch into this working tree.
974
:param branch: The branch to merge from.
975
:param to_revision: If non-None, the merge will merge to to_revision,
976
but not beyond it. to_revision does not need to be in the history
977
of the branch when it is supplied. If None, to_revision defaults to
978
branch.last_revision().
980
from bzrlib.merge import Merger, Merge3Merger
981
merger = Merger(self.branch, this_tree=self)
982
# check that there are no local alterations
983
if not force and self.has_changes():
984
raise errors.UncommittedChanges(self)
985
if to_revision is None:
986
to_revision = _mod_revision.ensure_null(branch.last_revision())
987
merger.other_rev_id = to_revision
988
if _mod_revision.is_null(merger.other_rev_id):
989
raise errors.NoCommits(branch)
990
self.branch.fetch(branch, last_revision=merger.other_rev_id)
991
merger.other_basis = merger.other_rev_id
992
merger.other_tree = self.branch.repository.revision_tree(
994
merger.other_branch = branch
995
if from_revision is None:
998
merger.set_base_revision(from_revision, branch)
999
if merger.base_rev_id == merger.other_rev_id:
1000
raise errors.PointlessMerge
1001
merger.backup_files = False
1002
if merge_type is None:
1003
merger.merge_type = Merge3Merger
1005
merger.merge_type = merge_type
1006
merger.set_interesting_files(None)
1007
merger.show_base = False
1008
merger.reprocess = False
1009
conflicts = merger.do_merge()
1010
merger.set_pending()
1014
def merge_modified(self):
1015
"""Return a dictionary of files modified by a merge.
1017
The list is initialized by WorkingTree.set_merge_modified, which is
1018
typically called after we make some automatic updates to the tree
1021
This returns a map of file_id->sha1, containing only files which are
1022
still in the working inventory and have that text hash.
1025
hashfile = self._transport.get('merge-hashes')
1026
except errors.NoSuchFile:
1031
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
1032
raise errors.MergeModifiedFormatError()
1033
except StopIteration:
1034
raise errors.MergeModifiedFormatError()
1035
for s in RioReader(hashfile):
1036
# RioReader reads in Unicode, so convert file_ids back to utf8
1037
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
1038
if file_id not in self.inventory:
1040
text_hash = s.get("hash")
1041
if text_hash == self.get_file_sha1(file_id):
1042
merge_hashes[file_id] = text_hash
1048
def mkdir(self, path, file_id=None):
1049
"""See MutableTree.mkdir()."""
1051
file_id = generate_ids.gen_file_id(os.path.basename(path))
1052
os.mkdir(self.abspath(path))
1053
self.add(path, file_id, 'directory')
1056
def get_symlink_target(self, file_id):
1057
abspath = self.id2abspath(file_id)
1058
target = osutils.readlink(abspath)
1062
def subsume(self, other_tree):
1063
def add_children(inventory, entry):
1064
for child_entry in entry.children.values():
1065
inventory._byid[child_entry.file_id] = child_entry
1066
if child_entry.kind == 'directory':
1067
add_children(inventory, child_entry)
1068
if other_tree.get_root_id() == self.get_root_id():
1069
raise errors.BadSubsumeSource(self, other_tree,
1070
'Trees have the same root')
1072
other_tree_path = self.relpath(other_tree.basedir)
1073
except errors.PathNotChild:
1074
raise errors.BadSubsumeSource(self, other_tree,
1075
'Tree is not contained by the other')
1076
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1077
if new_root_parent is None:
1078
raise errors.BadSubsumeSource(self, other_tree,
1079
'Parent directory is not versioned.')
1080
# We need to ensure that the result of a fetch will have a
1081
# versionedfile for the other_tree root, and only fetching into
1082
# RepositoryKnit2 guarantees that.
1083
if not self.branch.repository.supports_rich_root():
1084
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1085
other_tree.lock_tree_write()
1087
new_parents = other_tree.get_parent_ids()
1088
other_root = other_tree.inventory.root
1089
other_root.parent_id = new_root_parent
1090
other_root.name = osutils.basename(other_tree_path)
1091
self.inventory.add(other_root)
1092
add_children(self.inventory, other_root)
1093
self._write_inventory(self.inventory)
1094
# normally we don't want to fetch whole repositories, but i think
1095
# here we really do want to consolidate the whole thing.
1096
for parent_id in other_tree.get_parent_ids():
1097
self.branch.fetch(other_tree.branch, parent_id)
1098
self.add_parent_tree_id(parent_id)
1101
other_tree.bzrdir.retire_bzrdir()
1103
def _setup_directory_is_tree_reference(self):
1104
if self._branch.repository._format.supports_tree_reference:
1105
self._directory_is_tree_reference = \
1106
self._directory_may_be_tree_reference
1108
self._directory_is_tree_reference = \
1109
self._directory_is_never_tree_reference
1111
def _directory_is_never_tree_reference(self, relpath):
1114
def _directory_may_be_tree_reference(self, relpath):
1115
# as a special case, if a directory contains control files then
1116
# it's a tree reference, except that the root of the tree is not
1117
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1118
# TODO: We could ask all the control formats whether they
1119
# recognize this directory, but at the moment there's no cheap api
1120
# to do that. Since we probably can only nest bzr checkouts and
1121
# they always use this name it's ok for now. -- mbp 20060306
1123
# FIXME: There is an unhandled case here of a subdirectory
1124
# containing .bzr but not a branch; that will probably blow up
1125
# when you try to commit it. It might happen if there is a
1126
# checkout in a subdirectory. This can be avoided by not adding
1129
@needs_tree_write_lock
1130
def extract(self, file_id, format=None):
1131
"""Extract a subtree from this tree.
1133
A new branch will be created, relative to the path for this tree.
1137
segments = osutils.splitpath(path)
1138
transport = self.branch.bzrdir.root_transport
1139
for name in segments:
1140
transport = transport.clone(name)
1141
transport.ensure_base()
1144
sub_path = self.id2path(file_id)
1145
branch_transport = mkdirs(sub_path)
1147
format = self.bzrdir.cloning_metadir()
1148
branch_transport.ensure_base()
1149
branch_bzrdir = format.initialize_on_transport(branch_transport)
1151
repo = branch_bzrdir.find_repository()
1152
except errors.NoRepositoryPresent:
1153
repo = branch_bzrdir.create_repository()
1154
if not repo.supports_rich_root():
1155
raise errors.RootNotRich()
1156
new_branch = branch_bzrdir.create_branch()
1157
new_branch.pull(self.branch)
1158
for parent_id in self.get_parent_ids():
1159
new_branch.fetch(self.branch, parent_id)
1160
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1161
if tree_transport.base != branch_transport.base:
1162
tree_bzrdir = format.initialize_on_transport(tree_transport)
1163
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1164
target_branch=new_branch)
1166
tree_bzrdir = branch_bzrdir
1167
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1168
wt.set_parent_ids(self.get_parent_ids())
1169
my_inv = self.inventory
1170
child_inv = inventory.Inventory(root_id=None)
1171
new_root = my_inv[file_id]
1172
my_inv.remove_recursive_id(file_id)
1173
new_root.parent_id = None
1174
child_inv.add(new_root)
1175
self._write_inventory(my_inv)
1176
wt._write_inventory(child_inv)
1179
def _serialize(self, inventory, out_file):
1180
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1183
def _deserialize(selt, in_file):
1184
return xml5.serializer_v5.read_inventory(in_file)
1187
"""Write the in memory inventory to disk."""
1188
# TODO: Maybe this should only write on dirty ?
1189
if self._control_files._lock_mode != 'w':
1190
raise errors.NotWriteLocked(self)
1192
self._serialize(self._inventory, sio)
1194
self._transport.put_file('inventory', sio,
1195
mode=self.bzrdir._get_file_mode())
1196
self._inventory_is_modified = False
1198
def _kind(self, relpath):
1199
return osutils.file_kind(self.abspath(relpath))
1201
def list_files(self, include_root=False, from_dir=None, recursive=True):
1202
"""List all files as (path, class, kind, id, entry).
1204
Lists, but does not descend into unversioned directories.
1205
This does not include files that have been deleted in this
1206
tree. Skips the control directory.
1208
:param include_root: if True, return an entry for the root
1209
:param from_dir: start from this directory or None for the root
1210
:param recursive: whether to recurse into subdirectories or not
1212
# list_files is an iterator, so @needs_read_lock doesn't work properly
1213
# with it. So callers should be careful to always read_lock the tree.
1214
if not self.is_locked():
1215
raise errors.ObjectNotLocked(self)
1217
inv = self.inventory
1218
if from_dir is None and include_root is True:
1219
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1220
# Convert these into local objects to save lookup times
1221
pathjoin = osutils.pathjoin
1222
file_kind = self._kind
1224
# transport.base ends in a slash, we want the piece
1225
# between the last two slashes
1226
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1228
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1230
# directory file_id, relative path, absolute path, reverse sorted children
1231
if from_dir is not None:
1232
from_dir_id = inv.path2id(from_dir)
1233
if from_dir_id is None:
1234
# Directory not versioned
1236
from_dir_abspath = pathjoin(self.basedir, from_dir)
1238
from_dir_id = inv.root.file_id
1239
from_dir_abspath = self.basedir
1240
children = os.listdir(from_dir_abspath)
1242
# jam 20060527 The kernel sized tree seems equivalent whether we
1243
# use a deque and popleft to keep them sorted, or if we use a plain
1244
# list and just reverse() them.
1245
children = collections.deque(children)
1246
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1248
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1251
f = children.popleft()
1252
## TODO: If we find a subdirectory with its own .bzr
1253
## directory, then that is a separate tree and we
1254
## should exclude it.
1256
# the bzrdir for this tree
1257
if transport_base_dir == f:
1260
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1261
# and 'f' doesn't begin with one, we can do a string op, rather
1262
# than the checks of pathjoin(), all relative paths will have an extra slash
1264
fp = from_dir_relpath + '/' + f
1267
fap = from_dir_abspath + '/' + f
1269
f_ie = inv.get_child(from_dir_id, f)
1272
elif self.is_ignored(fp[1:]):
1275
# we may not have found this file, because of a unicode issue
1276
f_norm, can_access = osutils.normalized_filename(f)
1277
if f == f_norm or not can_access:
1278
# No change, so treat this file normally
1281
# this file can be accessed by a normalized path
1282
# check again if it is versioned
1283
# these lines are repeated here for performance
1285
fp = from_dir_relpath + '/' + f
1286
fap = from_dir_abspath + '/' + f
1287
f_ie = inv.get_child(from_dir_id, f)
1290
elif self.is_ignored(fp[1:]):
1297
# make a last minute entry
1299
yield fp[1:], c, fk, f_ie.file_id, f_ie
1302
yield fp[1:], c, fk, None, fk_entries[fk]()
1304
yield fp[1:], c, fk, None, TreeEntry()
1307
if fk != 'directory':
1310
# But do this child first if recursing down
1312
new_children = os.listdir(fap)
1314
new_children = collections.deque(new_children)
1315
stack.append((f_ie.file_id, fp, fap, new_children))
1316
# Break out of inner loop,
1317
# so that we start outer loop with child
1320
# if we finished all children, pop it off the stack
1323
@needs_tree_write_lock
1324
def move(self, from_paths, to_dir=None, after=False):
1327
to_dir must exist in the inventory.
1329
If to_dir exists and is a directory, the files are moved into
1330
it, keeping their old names.
1332
Note that to_dir is only the last component of the new name;
1333
this doesn't change the directory.
1335
For each entry in from_paths the move mode will be determined
1338
The first mode moves the file in the filesystem and updates the
1339
inventory. The second mode only updates the inventory without
1340
touching the file on the filesystem. This is the new mode introduced
1343
move uses the second mode if 'after == True' and the target is not
1344
versioned but present in the working tree.
1346
move uses the second mode if 'after == False' and the source is
1347
versioned but no longer in the working tree, and the target is not
1348
versioned but present in the working tree.
1350
move uses the first mode if 'after == False' and the source is
1351
versioned and present in the working tree, and the target is not
1352
versioned and not present in the working tree.
1354
Everything else results in an error.
1356
This returns a list of (from_path, to_path) pairs for each
1357
entry that is moved.
1362
# check for deprecated use of signature
1364
raise TypeError('You must supply a target directory')
1365
# check destination directory
1366
if isinstance(from_paths, basestring):
1368
inv = self.inventory
1369
to_abs = self.abspath(to_dir)
1370
if not isdir(to_abs):
1371
raise errors.BzrMoveFailedError('',to_dir,
1372
errors.NotADirectory(to_abs))
1373
if not self.has_filename(to_dir):
1374
raise errors.BzrMoveFailedError('',to_dir,
1375
errors.NotInWorkingDirectory(to_dir))
1376
to_dir_id = inv.path2id(to_dir)
1377
if to_dir_id is None:
1378
raise errors.BzrMoveFailedError('',to_dir,
1379
errors.NotVersionedError(path=str(to_dir)))
1381
to_dir_ie = inv[to_dir_id]
1382
if to_dir_ie.kind != 'directory':
1383
raise errors.BzrMoveFailedError('',to_dir,
1384
errors.NotADirectory(to_abs))
1386
# create rename entries and tuples
1387
for from_rel in from_paths:
1388
from_tail = splitpath(from_rel)[-1]
1389
from_id = inv.path2id(from_rel)
1391
raise errors.BzrMoveFailedError(from_rel,to_dir,
1392
errors.NotVersionedError(path=str(from_rel)))
1394
from_entry = inv[from_id]
1395
from_parent_id = from_entry.parent_id
1396
to_rel = pathjoin(to_dir, from_tail)
1397
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1399
from_tail=from_tail,
1400
from_parent_id=from_parent_id,
1401
to_rel=to_rel, to_tail=from_tail,
1402
to_parent_id=to_dir_id)
1403
rename_entries.append(rename_entry)
1404
rename_tuples.append((from_rel, to_rel))
1406
# determine which move mode to use. checks also for movability
1407
rename_entries = self._determine_mv_mode(rename_entries, after)
1409
original_modified = self._inventory_is_modified
1412
self._inventory_is_modified = True
1413
self._move(rename_entries)
1415
# restore the inventory on error
1416
self._inventory_is_modified = original_modified
1418
self._write_inventory(inv)
1419
return rename_tuples
1421
def _determine_mv_mode(self, rename_entries, after=False):
1422
"""Determines for each from-to pair if both inventory and working tree
1423
or only the inventory has to be changed.
1425
Also does basic plausability tests.
1427
inv = self.inventory
1429
for rename_entry in rename_entries:
1430
# store to local variables for easier reference
1431
from_rel = rename_entry.from_rel
1432
from_id = rename_entry.from_id
1433
to_rel = rename_entry.to_rel
1434
to_id = inv.path2id(to_rel)
1435
only_change_inv = False
1437
# check the inventory for source and destination
1439
raise errors.BzrMoveFailedError(from_rel,to_rel,
1440
errors.NotVersionedError(path=str(from_rel)))
1441
if to_id is not None:
1442
raise errors.BzrMoveFailedError(from_rel,to_rel,
1443
errors.AlreadyVersionedError(path=str(to_rel)))
1445
# try to determine the mode for rename (only change inv or change
1446
# inv and file system)
1448
if not self.has_filename(to_rel):
1449
raise errors.BzrMoveFailedError(from_id,to_rel,
1450
errors.NoSuchFile(path=str(to_rel),
1451
extra="New file has not been created yet"))
1452
only_change_inv = True
1453
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1454
only_change_inv = True
1455
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1456
only_change_inv = False
1457
elif (not self.case_sensitive
1458
and from_rel.lower() == to_rel.lower()
1459
and self.has_filename(from_rel)):
1460
only_change_inv = False
1462
# something is wrong, so lets determine what exactly
1463
if not self.has_filename(from_rel) and \
1464
not self.has_filename(to_rel):
1465
raise errors.BzrRenameFailedError(from_rel,to_rel,
1466
errors.PathsDoNotExist(paths=(str(from_rel),
1469
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1470
rename_entry.only_change_inv = only_change_inv
1471
return rename_entries
1473
def _move(self, rename_entries):
1474
"""Moves a list of files.
1476
Depending on the value of the flag 'only_change_inv', the
1477
file will be moved on the file system or not.
1479
inv = self.inventory
1482
for entry in rename_entries:
1484
self._move_entry(entry)
1486
self._rollback_move(moved)
1490
def _rollback_move(self, moved):
1491
"""Try to rollback a previous move in case of an filesystem error."""
1492
inv = self.inventory
1495
self._move_entry(WorkingTree._RenameEntry(
1496
entry.to_rel, entry.from_id,
1497
entry.to_tail, entry.to_parent_id, entry.from_rel,
1498
entry.from_tail, entry.from_parent_id,
1499
entry.only_change_inv))
1500
except errors.BzrMoveFailedError, e:
1501
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1502
" The working tree is in an inconsistent state."
1503
" Please consider doing a 'bzr revert'."
1504
" Error message is: %s" % e)
1506
def _move_entry(self, entry):
1507
inv = self.inventory
1508
from_rel_abs = self.abspath(entry.from_rel)
1509
to_rel_abs = self.abspath(entry.to_rel)
1510
if from_rel_abs == to_rel_abs:
1511
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1512
"Source and target are identical.")
1514
if not entry.only_change_inv:
1516
osutils.rename(from_rel_abs, to_rel_abs)
1518
raise errors.BzrMoveFailedError(entry.from_rel,
1520
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1522
@needs_tree_write_lock
1523
def rename_one(self, from_rel, to_rel, after=False):
1526
This can change the directory or the filename or both.
1528
rename_one has several 'modes' to work. First, it can rename a physical
1529
file and change the file_id. That is the normal mode. Second, it can
1530
only change the file_id without touching any physical file. This is
1531
the new mode introduced in version 0.15.
1533
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1534
versioned but present in the working tree.
1536
rename_one uses the second mode if 'after == False' and 'from_rel' is
1537
versioned but no longer in the working tree, and 'to_rel' is not
1538
versioned but present in the working tree.
1540
rename_one uses the first mode if 'after == False' and 'from_rel' is
1541
versioned and present in the working tree, and 'to_rel' is not
1542
versioned and not present in the working tree.
1544
Everything else results in an error.
1546
inv = self.inventory
1549
# create rename entries and tuples
1550
from_tail = splitpath(from_rel)[-1]
1551
from_id = inv.path2id(from_rel)
1553
# if file is missing in the inventory maybe it's in the basis_tree
1554
basis_tree = self.branch.basis_tree()
1555
from_id = basis_tree.path2id(from_rel)
1557
raise errors.BzrRenameFailedError(from_rel,to_rel,
1558
errors.NotVersionedError(path=str(from_rel)))
1559
# put entry back in the inventory so we can rename it
1560
from_entry = basis_tree.inventory[from_id].copy()
1563
from_entry = inv[from_id]
1564
from_parent_id = from_entry.parent_id
1565
to_dir, to_tail = os.path.split(to_rel)
1566
to_dir_id = inv.path2id(to_dir)
1567
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1569
from_tail=from_tail,
1570
from_parent_id=from_parent_id,
1571
to_rel=to_rel, to_tail=to_tail,
1572
to_parent_id=to_dir_id)
1573
rename_entries.append(rename_entry)
1575
# determine which move mode to use. checks also for movability
1576
rename_entries = self._determine_mv_mode(rename_entries, after)
1578
# check if the target changed directory and if the target directory is
1580
if to_dir_id is None:
1581
raise errors.BzrMoveFailedError(from_rel,to_rel,
1582
errors.NotVersionedError(path=str(to_dir)))
1584
# all checks done. now we can continue with our actual work
1585
mutter('rename_one:\n'
1590
' to_dir_id {%s}\n',
1591
from_id, from_rel, to_rel, to_dir, to_dir_id)
1593
self._move(rename_entries)
1594
self._write_inventory(inv)
1596
class _RenameEntry(object):
1597
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1598
to_rel, to_tail, to_parent_id, only_change_inv=False):
1599
self.from_rel = from_rel
1600
self.from_id = from_id
1601
self.from_tail = from_tail
1602
self.from_parent_id = from_parent_id
1603
self.to_rel = to_rel
1604
self.to_tail = to_tail
1605
self.to_parent_id = to_parent_id
1606
self.only_change_inv = only_change_inv
1610
"""Return all unknown files.
1612
These are files in the working directory that are not versioned or
1613
control files or ignored.
1615
# force the extras method to be fully executed before returning, to
1616
# prevent race conditions with the lock
1618
[subp for subp in self.extras() if not self.is_ignored(subp)])
1620
@needs_tree_write_lock
1621
def unversion(self, file_ids):
1622
"""Remove the file ids in file_ids from the current versioned set.
1624
When a file_id is unversioned, all of its children are automatically
1627
:param file_ids: The file ids to stop versioning.
1628
:raises: NoSuchId if any fileid is not currently versioned.
1630
for file_id in file_ids:
1631
if file_id not in self._inventory:
1632
raise errors.NoSuchId(self, file_id)
1633
for file_id in file_ids:
1634
if self._inventory.has_id(file_id):
1635
self._inventory.remove_recursive_id(file_id)
1637
# in the future this should just set a dirty bit to wait for the
1638
# final unlock. However, until all methods of workingtree start
1639
# with the current in -memory inventory rather than triggering
1640
# a read, it is more complex - we need to teach read_inventory
1641
# to know when to read, and when to not read first... and possibly
1642
# to save first when the in memory one may be corrupted.
1643
# so for now, we just only write it if it is indeed dirty.
1645
self._write_inventory(self._inventory)
1647
def _iter_conflicts(self):
1649
for info in self.list_files():
1651
stem = get_conflicted_stem(path)
1654
if stem not in conflicted:
1655
conflicted.add(stem)
1659
def pull(self, source, overwrite=False, stop_revision=None,
1660
change_reporter=None, possible_transports=None, local=False):
1663
old_revision_info = self.branch.last_revision_info()
1664
basis_tree = self.basis_tree()
1665
count = self.branch.pull(source, overwrite, stop_revision,
1666
possible_transports=possible_transports,
1668
new_revision_info = self.branch.last_revision_info()
1669
if new_revision_info != old_revision_info:
1670
repository = self.branch.repository
1671
basis_tree.lock_read()
1673
new_basis_tree = self.branch.basis_tree()
1680
change_reporter=change_reporter)
1681
basis_root_id = basis_tree.get_root_id()
1682
new_root_id = new_basis_tree.get_root_id()
1683
if basis_root_id != new_root_id:
1684
self.set_root_id(new_root_id)
1687
# TODO - dedup parents list with things merged by pull ?
1688
# reuse the revisiontree we merged against to set the new
1690
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1691
# we have to pull the merge trees out again, because
1692
# merge_inner has set the ids. - this corner is not yet
1693
# layered well enough to prevent double handling.
1694
# XXX TODO: Fix the double handling: telling the tree about
1695
# the already known parent data is wasteful.
1696
merges = self.get_parent_ids()[1:]
1697
parent_trees.extend([
1698
(parent, repository.revision_tree(parent)) for
1700
self.set_parent_trees(parent_trees)
1706
def put_file_bytes_non_atomic(self, file_id, bytes):
1707
"""See MutableTree.put_file_bytes_non_atomic."""
1708
stream = file(self.id2abspath(file_id), 'wb')
1713
# TODO: update the hashcache here ?
1716
"""Yield all unversioned files in this WorkingTree.
1718
If there are any unversioned directories then only the directory is
1719
returned, not all its children. But if there are unversioned files
1720
under a versioned subdirectory, they are returned.
1722
Currently returned depth-first, sorted by name within directories.
1723
This is the same order used by 'osutils.walkdirs'.
1725
## TODO: Work from given directory downwards
1726
for path, dir_entry in self.inventory.directories():
1727
# mutter("search for unknowns in %r", path)
1728
dirabs = self.abspath(path)
1729
if not isdir(dirabs):
1730
# e.g. directory deleted
1734
for subf in os.listdir(dirabs):
1735
if self.bzrdir.is_control_filename(subf):
1737
if subf not in dir_entry.children:
1740
can_access) = osutils.normalized_filename(subf)
1741
except UnicodeDecodeError:
1742
path_os_enc = path.encode(osutils._fs_enc)
1743
relpath = path_os_enc + '/' + subf
1744
raise errors.BadFilenameEncoding(relpath,
1746
if subf_norm != subf and can_access:
1747
if subf_norm not in dir_entry.children:
1748
fl.append(subf_norm)
1754
subp = pathjoin(path, subf)
1757
def ignored_files(self):
1758
"""Yield list of PATH, IGNORE_PATTERN"""
1759
for subp in self.extras():
1760
pat = self.is_ignored(subp)
1764
def get_ignore_list(self):
1765
"""Return list of ignore patterns.
1767
Cached in the Tree object after the first call.
1769
ignoreset = getattr(self, '_ignoreset', None)
1770
if ignoreset is not None:
1773
ignore_globs = set()
1774
ignore_globs.update(ignores.get_runtime_ignores())
1775
ignore_globs.update(ignores.get_user_ignores())
1776
if self.has_filename(bzrlib.IGNORE_FILENAME):
1777
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1779
ignore_globs.update(ignores.parse_ignore_file(f))
1782
self._ignoreset = ignore_globs
1785
def _flush_ignore_list_cache(self):
1786
"""Resets the cached ignore list to force a cache rebuild."""
1787
self._ignoreset = None
1788
self._ignoreglobster = None
1790
def is_ignored(self, filename):
1791
r"""Check whether the filename matches an ignore pattern.
1793
Patterns containing '/' or '\' need to match the whole path;
1794
others match against only the last component. Patterns starting
1795
with '!' are ignore exceptions. Exceptions take precedence
1796
over regular patterns and cause the filename to not be ignored.
1798
If the file is ignored, returns the pattern which caused it to
1799
be ignored, otherwise None. So this can simply be used as a
1800
boolean if desired."""
1801
if getattr(self, '_ignoreglobster', None) is None:
1802
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1803
return self._ignoreglobster.match(filename)
1805
def kind(self, file_id):
1806
return file_kind(self.id2abspath(file_id))
1808
def stored_kind(self, file_id):
1809
"""See Tree.stored_kind"""
1810
return self.inventory[file_id].kind
1812
def _comparison_data(self, entry, path):
1813
abspath = self.abspath(path)
1815
stat_value = os.lstat(abspath)
1817
if getattr(e, 'errno', None) == errno.ENOENT:
1824
mode = stat_value.st_mode
1825
kind = osutils.file_kind_from_stat_mode(mode)
1826
if not supports_executable():
1827
executable = entry is not None and entry.executable
1829
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1830
return kind, executable, stat_value
1832
def _file_size(self, entry, stat_value):
1833
return stat_value.st_size
1835
def last_revision(self):
1836
"""Return the last revision of the branch for this tree.
1838
This format tree does not support a separate marker for last-revision
1839
compared to the branch.
1841
See MutableTree.last_revision
1843
return self._last_revision()
1846
def _last_revision(self):
1847
"""helper for get_parent_ids."""
1848
return _mod_revision.ensure_null(self.branch.last_revision())
1850
def is_locked(self):
1851
return self._control_files.is_locked()
1853
def _must_be_locked(self):
1854
if not self.is_locked():
1855
raise errors.ObjectNotLocked(self)
1857
def lock_read(self):
1858
"""Lock the tree for reading.
1860
This also locks the branch, and can be unlocked via self.unlock().
1862
:return: A bzrlib.lock.LogicalLockResult.
1864
if not self.is_locked():
1866
self.branch.lock_read()
1868
self._control_files.lock_read()
1869
return LogicalLockResult(self.unlock)
1871
self.branch.unlock()
1874
def lock_tree_write(self):
1875
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1877
:return: A bzrlib.lock.LogicalLockResult.
1879
if not self.is_locked():
1881
self.branch.lock_read()
1883
self._control_files.lock_write()
1884
return LogicalLockResult(self.unlock)
1886
self.branch.unlock()
1889
def lock_write(self):
1890
"""See MutableTree.lock_write, and WorkingTree.unlock.
1892
:return: A bzrlib.lock.LogicalLockResult.
1894
if not self.is_locked():
1896
self.branch.lock_write()
1898
self._control_files.lock_write()
1899
return LogicalLockResult(self.unlock)
1901
self.branch.unlock()
1904
def get_physical_lock_status(self):
1905
return self._control_files.get_physical_lock_status()
1907
def _basis_inventory_name(self):
1908
return 'basis-inventory-cache'
1910
def _reset_data(self):
1911
"""Reset transient data that cannot be revalidated."""
1912
self._inventory_is_modified = False
1913
f = self._transport.get('inventory')
1915
result = self._deserialize(f)
1918
self._set_inventory(result, dirty=False)
1920
@needs_tree_write_lock
1921
def set_last_revision(self, new_revision):
1922
"""Change the last revision in the working tree."""
1923
if self._change_last_revision(new_revision):
1924
self._cache_basis_inventory(new_revision)
1926
def _change_last_revision(self, new_revision):
1927
"""Template method part of set_last_revision to perform the change.
1929
This is used to allow WorkingTree3 instances to not affect branch
1930
when their last revision is set.
1932
if _mod_revision.is_null(new_revision):
1933
self.branch.set_revision_history([])
1936
self.branch.generate_revision_history(new_revision)
1937
except errors.NoSuchRevision:
1938
# not present in the repo - dont try to set it deeper than the tip
1939
self.branch.set_revision_history([new_revision])
1942
def _write_basis_inventory(self, xml):
1943
"""Write the basis inventory XML to the basis-inventory file"""
1944
path = self._basis_inventory_name()
1946
self._transport.put_file(path, sio,
1947
mode=self.bzrdir._get_file_mode())
1949
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1950
"""Create the text that will be saved in basis-inventory"""
1951
inventory.revision_id = revision_id
1952
return xml7.serializer_v7.write_inventory_to_string(inventory)
1954
def _cache_basis_inventory(self, new_revision):
1955
"""Cache new_revision as the basis inventory."""
1956
# TODO: this should allow the ready-to-use inventory to be passed in,
1957
# as commit already has that ready-to-use [while the format is the
1960
# this double handles the inventory - unpack and repack -
1961
# but is easier to understand. We can/should put a conditional
1962
# in here based on whether the inventory is in the latest format
1963
# - perhaps we should repack all inventories on a repository
1965
# the fast path is to copy the raw xml from the repository. If the
1966
# xml contains 'revision_id="', then we assume the right
1967
# revision_id is set. We must check for this full string, because a
1968
# root node id can legitimately look like 'revision_id' but cannot
1970
xml = self.branch.repository._get_inventory_xml(new_revision)
1971
firstline = xml.split('\n', 1)[0]
1972
if (not 'revision_id="' in firstline or
1973
'format="7"' not in firstline):
1974
inv = self.branch.repository._serializer.read_inventory_from_string(
1976
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1977
self._write_basis_inventory(xml)
1978
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1981
def read_basis_inventory(self):
1982
"""Read the cached basis inventory."""
1983
path = self._basis_inventory_name()
1984
return self._transport.get_bytes(path)
1987
def read_working_inventory(self):
1988
"""Read the working inventory.
1990
:raises errors.InventoryModified: read_working_inventory will fail
1991
when the current in memory inventory has been modified.
1993
# conceptually this should be an implementation detail of the tree.
1994
# XXX: Deprecate this.
1995
# ElementTree does its own conversion from UTF-8, so open in
1997
if self._inventory_is_modified:
1998
raise errors.InventoryModified(self)
1999
f = self._transport.get('inventory')
2001
result = self._deserialize(f)
2004
self._set_inventory(result, dirty=False)
2007
@needs_tree_write_lock
2008
def remove(self, files, verbose=False, to_file=None, keep_files=True,
2010
"""Remove nominated files from the working inventory.
2012
:files: File paths relative to the basedir.
2013
:keep_files: If true, the files will also be kept.
2014
:force: Delete files and directories, even if they are changed and
2015
even if the directories are not empty.
2017
if isinstance(files, basestring):
2023
unknown_nested_files=set()
2025
to_file = sys.stdout
2027
def recurse_directory_to_add_files(directory):
2028
# Recurse directory and add all files
2029
# so we can check if they have changed.
2030
for parent_info, file_infos in self.walkdirs(directory):
2031
for relpath, basename, kind, lstat, fileid, kind in file_infos:
2032
# Is it versioned or ignored?
2033
if self.path2id(relpath) or self.is_ignored(relpath):
2034
# Add nested content for deletion.
2035
new_files.add(relpath)
2037
# Files which are not versioned and not ignored
2038
# should be treated as unknown.
2039
unknown_nested_files.add((relpath, None, kind))
2041
for filename in files:
2042
# Get file name into canonical form.
2043
abspath = self.abspath(filename)
2044
filename = self.relpath(abspath)
2045
if len(filename) > 0:
2046
new_files.add(filename)
2047
recurse_directory_to_add_files(filename)
2049
files = list(new_files)
2052
return # nothing to do
2054
# Sort needed to first handle directory content before the directory
2055
files.sort(reverse=True)
2057
# Bail out if we are going to delete files we shouldn't
2058
if not keep_files and not force:
2059
has_changed_files = len(unknown_nested_files) > 0
2060
if not has_changed_files:
2061
for (file_id, path, content_change, versioned, parent_id, name,
2062
kind, executable) in self.iter_changes(self.basis_tree(),
2063
include_unchanged=True, require_versioned=False,
2064
want_unversioned=True, specific_files=files):
2065
if versioned == (False, False):
2066
# The record is unknown ...
2067
if not self.is_ignored(path[1]):
2068
# ... but not ignored
2069
has_changed_files = True
2071
elif (content_change and (kind[1] is not None) and
2072
osutils.is_inside_any(files, path[1])):
2073
# Versioned and changed, but not deleted, and still
2074
# in one of the dirs to be deleted.
2075
has_changed_files = True
2078
if has_changed_files:
2079
# Make delta show ALL applicable changes in error message.
2080
tree_delta = self.changes_from(self.basis_tree(),
2081
require_versioned=False, want_unversioned=True,
2082
specific_files=files)
2083
for unknown_file in unknown_nested_files:
2084
if unknown_file not in tree_delta.unversioned:
2085
tree_delta.unversioned.extend((unknown_file,))
2086
raise errors.BzrRemoveChangedFilesError(tree_delta)
2088
# Build inv_delta and delete files where applicable,
2089
# do this before any modifications to inventory.
2091
fid = self.path2id(f)
2094
message = "%s is not versioned." % (f,)
2097
# having removed it, it must be either ignored or unknown
2098
if self.is_ignored(f):
2102
# XXX: Really should be a more abstract reporter interface
2103
kind_ch = osutils.kind_marker(self.kind(fid))
2104
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2106
inv_delta.append((f, None, fid, None))
2107
message = "removed %s" % (f,)
2110
abs_path = self.abspath(f)
2111
if osutils.lexists(abs_path):
2112
if (osutils.isdir(abs_path) and
2113
len(os.listdir(abs_path)) > 0):
2115
osutils.rmtree(abs_path)
2117
message = "%s is not an empty directory "\
2118
"and won't be deleted." % (f,)
2120
osutils.delete_any(abs_path)
2121
message = "deleted %s" % (f,)
2122
elif message is not None:
2123
# Only care if we haven't done anything yet.
2124
message = "%s does not exist." % (f,)
2126
# Print only one message (if any) per file.
2127
if message is not None:
2129
self.apply_inventory_delta(inv_delta)
2131
@needs_tree_write_lock
2132
def revert(self, filenames=None, old_tree=None, backups=True,
2133
pb=None, report_changes=False):
2134
from bzrlib.conflicts import resolve
2137
symbol_versioning.warn('Using [] to revert all files is deprecated'
2138
' as of bzr 0.91. Please use None (the default) instead.',
2139
DeprecationWarning, stacklevel=2)
2140
if old_tree is None:
2141
basis_tree = self.basis_tree()
2142
basis_tree.lock_read()
2143
old_tree = basis_tree
2147
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2149
if filenames is None and len(self.get_parent_ids()) > 1:
2151
last_revision = self.last_revision()
2152
if last_revision != _mod_revision.NULL_REVISION:
2153
if basis_tree is None:
2154
basis_tree = self.basis_tree()
2155
basis_tree.lock_read()
2156
parent_trees.append((last_revision, basis_tree))
2157
self.set_parent_trees(parent_trees)
2160
resolve(self, filenames, ignore_misses=True, recursive=True)
2162
if basis_tree is not None:
2166
def revision_tree(self, revision_id):
2167
"""See Tree.revision_tree.
2169
WorkingTree can supply revision_trees for the basis revision only
2170
because there is only one cached inventory in the bzr directory.
2172
if revision_id == self.last_revision():
2174
xml = self.read_basis_inventory()
2175
except errors.NoSuchFile:
2179
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2180
# dont use the repository revision_tree api because we want
2181
# to supply the inventory.
2182
if inv.revision_id == revision_id:
2183
return revisiontree.RevisionTree(self.branch.repository,
2185
except errors.BadInventoryFormat:
2187
# raise if there was no inventory, or if we read the wrong inventory.
2188
raise errors.NoSuchRevisionInTree(self, revision_id)
2190
# XXX: This method should be deprecated in favour of taking in a proper
2191
# new Inventory object.
2192
@needs_tree_write_lock
2193
def set_inventory(self, new_inventory_list):
2194
from bzrlib.inventory import (Inventory,
2198
inv = Inventory(self.get_root_id())
2199
for path, file_id, parent, kind in new_inventory_list:
2200
name = os.path.basename(path)
2203
# fixme, there should be a factory function inv,add_??
2204
if kind == 'directory':
2205
inv.add(InventoryDirectory(file_id, name, parent))
2206
elif kind == 'file':
2207
inv.add(InventoryFile(file_id, name, parent))
2208
elif kind == 'symlink':
2209
inv.add(InventoryLink(file_id, name, parent))
2211
raise errors.BzrError("unknown kind %r" % kind)
2212
self._write_inventory(inv)
2214
@needs_tree_write_lock
2215
def set_root_id(self, file_id):
2216
"""Set the root id for this tree."""
2220
'WorkingTree.set_root_id with fileid=None')
2221
file_id = osutils.safe_file_id(file_id)
2222
self._set_root_id(file_id)
2224
def _set_root_id(self, file_id):
2225
"""Set the root id for this tree, in a format specific manner.
2227
:param file_id: The file id to assign to the root. It must not be
2228
present in the current inventory or an error will occur. It must
2229
not be None, but rather a valid file id.
2231
inv = self._inventory
2232
orig_root_id = inv.root.file_id
2233
# TODO: it might be nice to exit early if there was nothing
2234
# to do, saving us from trigger a sync on unlock.
2235
self._inventory_is_modified = True
2236
# we preserve the root inventory entry object, but
2237
# unlinkit from the byid index
2238
del inv._byid[inv.root.file_id]
2239
inv.root.file_id = file_id
2240
# and link it into the index with the new changed id.
2241
inv._byid[inv.root.file_id] = inv.root
2242
# and finally update all children to reference the new id.
2243
# XXX: this should be safe to just look at the root.children
2244
# list, not the WHOLE INVENTORY.
2247
if entry.parent_id == orig_root_id:
2248
entry.parent_id = inv.root.file_id
2251
"""See Branch.unlock.
2253
WorkingTree locking just uses the Branch locking facilities.
2254
This is current because all working trees have an embedded branch
2255
within them. IF in the future, we were to make branch data shareable
2256
between multiple working trees, i.e. via shared storage, then we
2257
would probably want to lock both the local tree, and the branch.
2259
raise NotImplementedError(self.unlock)
2263
def update(self, change_reporter=None, possible_transports=None,
2264
revision=None, old_tip=_marker):
2265
"""Update a working tree along its branch.
2267
This will update the branch if its bound too, which means we have
2268
multiple trees involved:
2270
- The new basis tree of the master.
2271
- The old basis tree of the branch.
2272
- The old basis tree of the working tree.
2273
- The current working tree state.
2275
Pathologically, all three may be different, and non-ancestors of each
2276
other. Conceptually we want to:
2278
- Preserve the wt.basis->wt.state changes
2279
- Transform the wt.basis to the new master basis.
2280
- Apply a merge of the old branch basis to get any 'local' changes from
2282
- Restore the wt.basis->wt.state changes.
2284
There isn't a single operation at the moment to do that, so we:
2285
- Merge current state -> basis tree of the master w.r.t. the old tree
2287
- Do a 'normal' merge of the old branch basis if it is relevant.
2289
:param revision: The target revision to update to. Must be in the
2291
:param old_tip: If branch.update() has already been run, the value it
2292
returned (old tip of the branch or None). _marker is used
2295
if self.branch.get_bound_location() is not None:
2297
update_branch = (old_tip is self._marker)
2299
self.lock_tree_write()
2300
update_branch = False
2303
old_tip = self.branch.update(possible_transports)
2305
if old_tip is self._marker:
2307
return self._update_tree(old_tip, change_reporter, revision)
2311
@needs_tree_write_lock
2312
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2313
"""Update a tree to the master branch.
2315
:param old_tip: if supplied, the previous tip revision the branch,
2316
before it was changed to the master branch's tip.
2318
# here if old_tip is not None, it is the old tip of the branch before
2319
# it was updated from the master branch. This should become a pending
2320
# merge in the working tree to preserve the user existing work. we
2321
# cant set that until we update the working trees last revision to be
2322
# one from the new branch, because it will just get absorbed by the
2323
# parent de-duplication logic.
2325
# We MUST save it even if an error occurs, because otherwise the users
2326
# local work is unreferenced and will appear to have been lost.
2330
last_rev = self.get_parent_ids()[0]
2332
last_rev = _mod_revision.NULL_REVISION
2333
if revision is None:
2334
revision = self.branch.last_revision()
2336
old_tip = old_tip or _mod_revision.NULL_REVISION
2338
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2339
# the branch we are bound to was updated
2340
# merge those changes in first
2341
base_tree = self.basis_tree()
2342
other_tree = self.branch.repository.revision_tree(old_tip)
2343
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2344
base_tree, this_tree=self,
2345
change_reporter=change_reporter)
2347
self.add_parent_tree((old_tip, other_tree))
2348
trace.note('Rerun update after fixing the conflicts.')
2351
if last_rev != _mod_revision.ensure_null(revision):
2352
# the working tree is up to date with the branch
2353
# we can merge the specified revision from master
2354
to_tree = self.branch.repository.revision_tree(revision)
2355
to_root_id = to_tree.get_root_id()
2357
basis = self.basis_tree()
2360
if (basis.inventory.root is None
2361
or basis.inventory.root.file_id != to_root_id):
2362
self.set_root_id(to_root_id)
2367
# determine the branch point
2368
graph = self.branch.repository.get_graph()
2369
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2371
base_tree = self.branch.repository.revision_tree(base_rev_id)
2373
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2375
change_reporter=change_reporter)
2376
self.set_last_revision(revision)
2377
# TODO - dedup parents list with things merged by pull ?
2378
# reuse the tree we've updated to to set the basis:
2379
parent_trees = [(revision, to_tree)]
2380
merges = self.get_parent_ids()[1:]
2381
# Ideally we ask the tree for the trees here, that way the working
2382
# tree can decide whether to give us the entire tree or give us a
2383
# lazy initialised tree. dirstate for instance will have the trees
2384
# in ram already, whereas a last-revision + basis-inventory tree
2385
# will not, but also does not need them when setting parents.
2386
for parent in merges:
2387
parent_trees.append(
2388
(parent, self.branch.repository.revision_tree(parent)))
2389
if not _mod_revision.is_null(old_tip):
2390
parent_trees.append(
2391
(old_tip, self.branch.repository.revision_tree(old_tip)))
2392
self.set_parent_trees(parent_trees)
2393
last_rev = parent_trees[0][0]
2396
def _write_hashcache_if_dirty(self):
2397
"""Write out the hashcache if it is dirty."""
2398
if self._hashcache.needs_write:
2400
self._hashcache.write()
2402
if e.errno not in (errno.EPERM, errno.EACCES):
2404
# TODO: jam 20061219 Should this be a warning? A single line
2405
# warning might be sufficient to let the user know what
2407
mutter('Could not write hashcache for %s\nError: %s',
2408
self._hashcache.cache_file_name(), e)
2410
@needs_tree_write_lock
2411
def _write_inventory(self, inv):
2412
"""Write inventory as the current inventory."""
2413
self._set_inventory(inv, dirty=True)
2416
def set_conflicts(self, arg):
2417
raise errors.UnsupportedOperation(self.set_conflicts, self)
2419
def add_conflicts(self, arg):
2420
raise errors.UnsupportedOperation(self.add_conflicts, self)
2423
def conflicts(self):
2424
conflicts = _mod_conflicts.ConflictList()
2425
for conflicted in self._iter_conflicts():
2428
if file_kind(self.abspath(conflicted)) != "file":
2430
except errors.NoSuchFile:
2433
for suffix in ('.THIS', '.OTHER'):
2435
kind = file_kind(self.abspath(conflicted+suffix))
2438
except errors.NoSuchFile:
2442
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2443
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2445
file_id=self.path2id(conflicted)))
2448
def walkdirs(self, prefix=""):
2449
"""Walk the directories of this tree.
2451
returns a generator which yields items in the form:
2452
((curren_directory_path, fileid),
2453
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2456
This API returns a generator, which is only valid during the current
2457
tree transaction - within a single lock_read or lock_write duration.
2459
If the tree is not locked, it may cause an error to be raised,
2460
depending on the tree implementation.
2462
disk_top = self.abspath(prefix)
2463
if disk_top.endswith('/'):
2464
disk_top = disk_top[:-1]
2465
top_strip_len = len(disk_top) + 1
2466
inventory_iterator = self._walkdirs(prefix)
2467
disk_iterator = osutils.walkdirs(disk_top, prefix)
2469
current_disk = disk_iterator.next()
2470
disk_finished = False
2472
if not (e.errno == errno.ENOENT or
2473
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2476
disk_finished = True
2478
current_inv = inventory_iterator.next()
2479
inv_finished = False
2480
except StopIteration:
2483
while not inv_finished or not disk_finished:
2485
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2486
cur_disk_dir_content) = current_disk
2488
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2489
cur_disk_dir_content) = ((None, None), None)
2490
if not disk_finished:
2491
# strip out .bzr dirs
2492
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2493
len(cur_disk_dir_content) > 0):
2494
# osutils.walkdirs can be made nicer -
2495
# yield the path-from-prefix rather than the pathjoined
2497
bzrdir_loc = bisect_left(cur_disk_dir_content,
2499
if (bzrdir_loc < len(cur_disk_dir_content)
2500
and self.bzrdir.is_control_filename(
2501
cur_disk_dir_content[bzrdir_loc][0])):
2502
# we dont yield the contents of, or, .bzr itself.
2503
del cur_disk_dir_content[bzrdir_loc]
2505
# everything is unknown
2508
# everything is missing
2511
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2513
# disk is before inventory - unknown
2514
dirblock = [(relpath, basename, kind, stat, None, None) for
2515
relpath, basename, kind, stat, top_path in
2516
cur_disk_dir_content]
2517
yield (cur_disk_dir_relpath, None), dirblock
2519
current_disk = disk_iterator.next()
2520
except StopIteration:
2521
disk_finished = True
2523
# inventory is before disk - missing.
2524
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2525
for relpath, basename, dkind, stat, fileid, kind in
2527
yield (current_inv[0][0], current_inv[0][1]), dirblock
2529
current_inv = inventory_iterator.next()
2530
except StopIteration:
2533
# versioned present directory
2534
# merge the inventory and disk data together
2536
for relpath, subiterator in itertools.groupby(sorted(
2537
current_inv[1] + cur_disk_dir_content,
2538
key=operator.itemgetter(0)), operator.itemgetter(1)):
2539
path_elements = list(subiterator)
2540
if len(path_elements) == 2:
2541
inv_row, disk_row = path_elements
2542
# versioned, present file
2543
dirblock.append((inv_row[0],
2544
inv_row[1], disk_row[2],
2545
disk_row[3], inv_row[4],
2547
elif len(path_elements[0]) == 5:
2549
dirblock.append((path_elements[0][0],
2550
path_elements[0][1], path_elements[0][2],
2551
path_elements[0][3], None, None))
2552
elif len(path_elements[0]) == 6:
2553
# versioned, absent file.
2554
dirblock.append((path_elements[0][0],
2555
path_elements[0][1], 'unknown', None,
2556
path_elements[0][4], path_elements[0][5]))
2558
raise NotImplementedError('unreachable code')
2559
yield current_inv[0], dirblock
2561
current_inv = inventory_iterator.next()
2562
except StopIteration:
2565
current_disk = disk_iterator.next()
2566
except StopIteration:
2567
disk_finished = True
2569
def _walkdirs(self, prefix=""):
2570
"""Walk the directories of this tree.
2572
:prefix: is used as the directrory to start with.
2573
returns a generator which yields items in the form:
2574
((curren_directory_path, fileid),
2575
[(file1_path, file1_name, file1_kind, None, file1_id,
2578
_directory = 'directory'
2579
# get the root in the inventory
2580
inv = self.inventory
2581
top_id = inv.path2id(prefix)
2585
pending = [(prefix, '', _directory, None, top_id, None)]
2588
currentdir = pending.pop()
2589
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2590
top_id = currentdir[4]
2592
relroot = currentdir[0] + '/'
2595
# FIXME: stash the node in pending
2597
if entry.kind == 'directory':
2598
for name, child in entry.sorted_children():
2599
dirblock.append((relroot + name, name, child.kind, None,
2600
child.file_id, child.kind
2602
yield (currentdir[0], entry.file_id), dirblock
2603
# push the user specified dirs from dirblock
2604
for dir in reversed(dirblock):
2605
if dir[2] == _directory:
2608
@needs_tree_write_lock
2609
def auto_resolve(self):
2610
"""Automatically resolve text conflicts according to contents.
2612
Only text conflicts are auto_resolvable. Files with no conflict markers
2613
are considered 'resolved', because bzr always puts conflict markers
2614
into files that have text conflicts. The corresponding .THIS .BASE and
2615
.OTHER files are deleted, as per 'resolve'.
2616
:return: a tuple of ConflictLists: (un_resolved, resolved).
2618
un_resolved = _mod_conflicts.ConflictList()
2619
resolved = _mod_conflicts.ConflictList()
2620
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2621
for conflict in self.conflicts():
2622
if (conflict.typestring != 'text conflict' or
2623
self.kind(conflict.file_id) != 'file'):
2624
un_resolved.append(conflict)
2626
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2628
for line in my_file:
2629
if conflict_re.search(line):
2630
un_resolved.append(conflict)
2633
resolved.append(conflict)
2636
resolved.remove_files(self)
2637
self.set_conflicts(un_resolved)
2638
return un_resolved, resolved
2641
def _check(self, references):
2642
"""Check the tree for consistency.
2644
:param references: A dict with keys matching the items returned by
2645
self._get_check_refs(), and values from looking those keys up in
2648
tree_basis = self.basis_tree()
2649
tree_basis.lock_read()
2651
repo_basis = references[('trees', self.last_revision())]
2652
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2653
raise errors.BzrCheckError(
2654
"Mismatched basis inventory content.")
2659
def _validate(self):
2660
"""Validate internal structures.
2662
This is meant mostly for the test suite. To give it a chance to detect
2663
corruption after actions have occurred. The default implementation is a
2666
:return: None. An exception should be raised if there is an error.
2670
def _get_rules_searcher(self, default_searcher):
2671
"""See Tree._get_rules_searcher."""
2672
if self._rules_searcher is None:
2673
self._rules_searcher = super(WorkingTree,
2674
self)._get_rules_searcher(default_searcher)
2675
return self._rules_searcher
2677
def get_shelf_manager(self):
2678
"""Return the ShelfManager for this WorkingTree."""
2679
from bzrlib.shelf import ShelfManager
2680
return ShelfManager(self, self._transport)
2683
class WorkingTree2(WorkingTree):
2684
"""This is the Format 2 working tree.
2686
This was the first weave based working tree.
2687
- uses os locks for locking.
2688
- uses the branch last-revision.
2691
def __init__(self, *args, **kwargs):
2692
super(WorkingTree2, self).__init__(*args, **kwargs)
2693
# WorkingTree2 has more of a constraint that self._inventory must
2694
# exist. Because this is an older format, we don't mind the overhead
2695
# caused by the extra computation here.
2697
# Newer WorkingTree's should only have self._inventory set when they
2699
if self._inventory is None:
2700
self.read_working_inventory()
2702
def _get_check_refs(self):
2703
"""Return the references needed to perform a check of this tree."""
2704
return [('trees', self.last_revision())]
2706
def lock_tree_write(self):
2707
"""See WorkingTree.lock_tree_write().
2709
In Format2 WorkingTrees we have a single lock for the branch and tree
2710
so lock_tree_write() degrades to lock_write().
2712
:return: An object with an unlock method which will release the lock
2715
self.branch.lock_write()
2717
self._control_files.lock_write()
2720
self.branch.unlock()
2724
# do non-implementation specific cleanup
2727
# we share control files:
2728
if self._control_files._lock_count == 3:
2729
# _inventory_is_modified is always False during a read lock.
2730
if self._inventory_is_modified:
2732
self._write_hashcache_if_dirty()
2734
# reverse order of locking.
2736
return self._control_files.unlock()
2738
self.branch.unlock()
2741
class WorkingTree3(WorkingTree):
2742
"""This is the Format 3 working tree.
2744
This differs from the base WorkingTree by:
2745
- having its own file lock
2746
- having its own last-revision property.
2748
This is new in bzr 0.8
2752
def _last_revision(self):
2753
"""See Mutable.last_revision."""
2755
return self._transport.get_bytes('last-revision')
2756
except errors.NoSuchFile:
2757
return _mod_revision.NULL_REVISION
2759
def _change_last_revision(self, revision_id):
2760
"""See WorkingTree._change_last_revision."""
2761
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2763
self._transport.delete('last-revision')
2764
except errors.NoSuchFile:
2768
self._transport.put_bytes('last-revision', revision_id,
2769
mode=self.bzrdir._get_file_mode())
2772
def _get_check_refs(self):
2773
"""Return the references needed to perform a check of this tree."""
2774
return [('trees', self.last_revision())]
2776
@needs_tree_write_lock
2777
def set_conflicts(self, conflicts):
2778
self._put_rio('conflicts', conflicts.to_stanzas(),
2781
@needs_tree_write_lock
2782
def add_conflicts(self, new_conflicts):
2783
conflict_set = set(self.conflicts())
2784
conflict_set.update(set(list(new_conflicts)))
2785
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2786
key=_mod_conflicts.Conflict.sort_key)))
2789
def conflicts(self):
2791
confile = self._transport.get('conflicts')
2792
except errors.NoSuchFile:
2793
return _mod_conflicts.ConflictList()
2796
if confile.next() != CONFLICT_HEADER_1 + '\n':
2797
raise errors.ConflictFormatError()
2798
except StopIteration:
2799
raise errors.ConflictFormatError()
2800
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2805
# do non-implementation specific cleanup
2807
if self._control_files._lock_count == 1:
2808
# _inventory_is_modified is always False during a read lock.
2809
if self._inventory_is_modified:
2811
self._write_hashcache_if_dirty()
2812
# reverse order of locking.
2814
return self._control_files.unlock()
2816
self.branch.unlock()
2819
def get_conflicted_stem(path):
2820
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2821
if path.endswith(suffix):
2822
return path[:-len(suffix)]
2825
class WorkingTreeFormat(object):
2826
"""An encapsulation of the initialization and open routines for a format.
2828
Formats provide three things:
2829
* An initialization routine,
2833
Formats are placed in an dict by their format string for reference
2834
during workingtree opening. Its not required that these be instances, they
2835
can be classes themselves with class methods - it simply depends on
2836
whether state is needed for a given format or not.
2838
Once a format is deprecated, just deprecate the initialize and open
2839
methods on the format class. Do not deprecate the object, as the
2840
object will be created every time regardless.
2843
_default_format = None
2844
"""The default format used for new trees."""
2847
"""The known formats."""
2849
requires_rich_root = False
2851
upgrade_recommended = False
2854
def find_format(klass, a_bzrdir):
2855
"""Return the format for the working tree object in a_bzrdir."""
2857
transport = a_bzrdir.get_workingtree_transport(None)
2858
format_string = transport.get_bytes("format")
2859
return klass._formats[format_string]
2860
except errors.NoSuchFile:
2861
raise errors.NoWorkingTree(base=transport.base)
2863
raise errors.UnknownFormatError(format=format_string,
2864
kind="working tree")
2866
def __eq__(self, other):
2867
return self.__class__ is other.__class__
2869
def __ne__(self, other):
2870
return not (self == other)
2873
def get_default_format(klass):
2874
"""Return the current default format."""
2875
return klass._default_format
2877
def get_format_string(self):
2878
"""Return the ASCII format string that identifies this format."""
2879
raise NotImplementedError(self.get_format_string)
2881
def get_format_description(self):
2882
"""Return the short description for this format."""
2883
raise NotImplementedError(self.get_format_description)
2885
def is_supported(self):
2886
"""Is this format supported?
2888
Supported formats can be initialized and opened.
2889
Unsupported formats may not support initialization or committing or
2890
some other features depending on the reason for not being supported.
2894
def supports_content_filtering(self):
2895
"""True if this format supports content filtering."""
2898
def supports_views(self):
2899
"""True if this format supports stored views."""
2903
def register_format(klass, format):
2904
klass._formats[format.get_format_string()] = format
2907
def set_default_format(klass, format):
2908
klass._default_format = format
2911
def unregister_format(klass, format):
2912
del klass._formats[format.get_format_string()]
2915
class WorkingTreeFormat2(WorkingTreeFormat):
2916
"""The second working tree format.
2918
This format modified the hash cache from the format 1 hash cache.
2921
upgrade_recommended = True
2923
def get_format_description(self):
2924
"""See WorkingTreeFormat.get_format_description()."""
2925
return "Working tree format 2"
2927
def _stub_initialize_on_transport(self, transport, file_mode):
2928
"""Workaround: create control files for a remote working tree.
2930
This ensures that it can later be updated and dealt with locally,
2931
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2932
no working tree. (See bug #43064).
2935
inv = inventory.Inventory()
2936
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2938
transport.put_file('inventory', sio, file_mode)
2939
transport.put_bytes('pending-merges', '', file_mode)
2941
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2942
accelerator_tree=None, hardlink=False):
2943
"""See WorkingTreeFormat.initialize()."""
2944
if not isinstance(a_bzrdir.transport, LocalTransport):
2945
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2946
if from_branch is not None:
2947
branch = from_branch
2949
branch = a_bzrdir.open_branch()
2950
if revision_id is None:
2951
revision_id = _mod_revision.ensure_null(branch.last_revision())
2954
branch.generate_revision_history(revision_id)
2957
inv = inventory.Inventory()
2958
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2964
basis_tree = branch.repository.revision_tree(revision_id)
2965
if basis_tree.inventory.root is not None:
2966
wt.set_root_id(basis_tree.get_root_id())
2967
# set the parent list and cache the basis tree.
2968
if _mod_revision.is_null(revision_id):
2971
parent_trees = [(revision_id, basis_tree)]
2972
wt.set_parent_trees(parent_trees)
2973
transform.build_tree(basis_tree, wt)
2977
super(WorkingTreeFormat2, self).__init__()
2978
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2980
def open(self, a_bzrdir, _found=False):
2981
"""Return the WorkingTree object for a_bzrdir
2983
_found is a private parameter, do not use it. It is used to indicate
2984
if format probing has already been done.
2987
# we are being called directly and must probe.
2988
raise NotImplementedError
2989
if not isinstance(a_bzrdir.transport, LocalTransport):
2990
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2997
class WorkingTreeFormat3(WorkingTreeFormat):
2998
"""The second working tree format updated to record a format marker.
3001
- exists within a metadir controlling .bzr
3002
- includes an explicit version marker for the workingtree control
3003
files, separate from the BzrDir format
3004
- modifies the hash cache format
3006
- uses a LockDir to guard access for writes.
3009
upgrade_recommended = True
3011
def get_format_string(self):
3012
"""See WorkingTreeFormat.get_format_string()."""
3013
return "Bazaar-NG Working Tree format 3"
3015
def get_format_description(self):
3016
"""See WorkingTreeFormat.get_format_description()."""
3017
return "Working tree format 3"
3019
_lock_file_name = 'lock'
3020
_lock_class = LockDir
3022
_tree_class = WorkingTree3
3024
def __get_matchingbzrdir(self):
3025
return bzrdir.BzrDirMetaFormat1()
3027
_matchingbzrdir = property(__get_matchingbzrdir)
3029
def _open_control_files(self, a_bzrdir):
3030
transport = a_bzrdir.get_workingtree_transport(None)
3031
return LockableFiles(transport, self._lock_file_name,
3034
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3035
accelerator_tree=None, hardlink=False):
3036
"""See WorkingTreeFormat.initialize().
3038
:param revision_id: if supplied, create a working tree at a different
3039
revision than the branch is at.
3040
:param accelerator_tree: A tree which can be used for retrieving file
3041
contents more quickly than the revision tree, i.e. a workingtree.
3042
The revision tree will be used for cases where accelerator_tree's
3043
content is different.
3044
:param hardlink: If true, hard-link files from accelerator_tree,
3047
if not isinstance(a_bzrdir.transport, LocalTransport):
3048
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3049
transport = a_bzrdir.get_workingtree_transport(self)
3050
control_files = self._open_control_files(a_bzrdir)
3051
control_files.create_lock()
3052
control_files.lock_write()
3053
transport.put_bytes('format', self.get_format_string(),
3054
mode=a_bzrdir._get_file_mode())
3055
if from_branch is not None:
3056
branch = from_branch
3058
branch = a_bzrdir.open_branch()
3059
if revision_id is None:
3060
revision_id = _mod_revision.ensure_null(branch.last_revision())
3061
# WorkingTree3 can handle an inventory which has a unique root id.
3062
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3063
# those trees. And because there isn't a format bump inbetween, we
3064
# are maintaining compatibility with older clients.
3065
# inv = Inventory(root_id=gen_root_id())
3066
inv = self._initial_inventory()
3067
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3073
_control_files=control_files)
3074
wt.lock_tree_write()
3076
basis_tree = branch.repository.revision_tree(revision_id)
3077
# only set an explicit root id if there is one to set.
3078
if basis_tree.inventory.root is not None:
3079
wt.set_root_id(basis_tree.get_root_id())
3080
if revision_id == _mod_revision.NULL_REVISION:
3081
wt.set_parent_trees([])
3083
wt.set_parent_trees([(revision_id, basis_tree)])
3084
transform.build_tree(basis_tree, wt)
3086
# Unlock in this order so that the unlock-triggers-flush in
3087
# WorkingTree is given a chance to fire.
3088
control_files.unlock()
3092
def _initial_inventory(self):
3093
return inventory.Inventory()
3096
super(WorkingTreeFormat3, self).__init__()
3098
def open(self, a_bzrdir, _found=False):
3099
"""Return the WorkingTree object for a_bzrdir
3101
_found is a private parameter, do not use it. It is used to indicate
3102
if format probing has already been done.
3105
# we are being called directly and must probe.
3106
raise NotImplementedError
3107
if not isinstance(a_bzrdir.transport, LocalTransport):
3108
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3109
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3112
def _open(self, a_bzrdir, control_files):
3113
"""Open the tree itself.
3115
:param a_bzrdir: the dir for the tree.
3116
:param control_files: the control files for the tree.
3118
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3122
_control_files=control_files)
3125
return self.get_format_string()
3128
__default_format = WorkingTreeFormat6()
3129
WorkingTreeFormat.register_format(__default_format)
3130
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3131
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3132
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3133
WorkingTreeFormat.set_default_format(__default_format)
3134
# formats which have no format string are not discoverable
3135
# and not independently creatable, so are not registered.
3136
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
