1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
19
# FIXME: I don't know if writing out the cache from the destructor is really a
20
# good idea, because destructors are considered poor taste in Python, and
21
# it's not predictable when it will be written out.
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
26
from errors import BzrCheckError
27
from trace import mutter
29
class WorkingTree(bzrlib.tree.Tree):
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
50
conflicts as _mod_conflicts,
53
filters as _mod_filters,
60
revision as _mod_revision,
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.i18n import gettext
75
from bzrlib.lock import LogicalLockResult
76
import bzrlib.mutabletree
77
from bzrlib.mutabletree import needs_tree_write_lock
78
from bzrlib import osutils
79
from bzrlib.osutils import (
89
from bzrlib.trace import mutter, note
90
from bzrlib.revision import CURRENT_REVISION
91
from bzrlib.symbol_versioning import (
97
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
98
# TODO: Modifying the conflict objects or their type is currently nearly
99
# impossible as there is no clear relationship between the working tree format
100
# and the conflict list file format.
101
CONFLICT_HEADER_1 = "BZR conflict list format 1"
103
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
106
class TreeEntry(object):
107
"""An entry that implements the minimum interface used by commands.
109
This needs further inspection, it may be better to have
110
InventoryEntries without ids - though that seems wrong. For now,
111
this is a parallel hierarchy to InventoryEntry, and needs to become
112
one of several things: decorates to that hierarchy, children of, or
114
Another note is that these objects are currently only used when there is
115
no InventoryEntry available - i.e. for unversioned objects.
116
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
119
def __eq__(self, other):
120
# yes, this us ugly, TODO: best practice __eq__ style.
121
return (isinstance(other, TreeEntry)
122
and other.__class__ == self.__class__)
124
def kind_character(self):
128
class TreeDirectory(TreeEntry):
129
"""See TreeEntry. This is a directory in a working tree."""
131
def __eq__(self, other):
132
return (isinstance(other, TreeDirectory)
133
and other.__class__ == self.__class__)
135
def kind_character(self):
139
class TreeFile(TreeEntry):
140
"""See TreeEntry. This is a regular file in a working tree."""
142
def __eq__(self, other):
143
return (isinstance(other, TreeFile)
144
and other.__class__ == self.__class__)
146
def kind_character(self):
150
class TreeLink(TreeEntry):
151
"""See TreeEntry. This is a symlink in a working tree."""
153
def __eq__(self, other):
154
return (isinstance(other, TreeLink)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class WorkingTree(bzrlib.mutabletree.MutableTree,
162
controldir.ControlComponent):
30
163
"""Working copy tree.
165
:ivar basedir: The root of the tree on disk. This is a unicode path object
166
(as opposed to a URL).
169
# override this to set the strategy for storing views
170
def _make_views(self):
171
return views.DisabledViews(self)
173
def __init__(self, basedir='.',
174
branch=DEPRECATED_PARAMETER,
179
"""Construct a WorkingTree instance. This is not a public API.
181
:param branch: A branch to override probing for the branch.
183
self._format = _format
184
self.bzrdir = _bzrdir
186
raise errors.BzrError("Please use bzrdir.open_workingtree or "
187
"WorkingTree.open() to obtain a WorkingTree.")
188
basedir = safe_unicode(basedir)
189
mutter("opening working tree %r", basedir)
190
if deprecated_passed(branch):
191
self._branch = branch
193
self._branch = self.bzrdir.open_branch()
194
self.basedir = realpath(basedir)
195
self._control_files = _control_files
196
self._transport = self._control_files._transport
197
self._rules_searcher = None
198
self.views = self._make_views()
201
def user_transport(self):
202
return self.bzrdir.user_transport
205
def control_transport(self):
206
return self._transport
208
def is_control_filename(self, filename):
209
"""True if filename is the name of a control file in this tree.
211
:param filename: A filename within the tree. This is a relative path
212
from the root of this tree.
214
This is true IF and ONLY IF the filename is part of the meta data
215
that bzr controls in this tree. I.E. a random .bzr directory placed
216
on disk will not be a control file for this tree.
218
return self.bzrdir.is_control_filename(filename)
221
fget=lambda self: self._branch,
222
doc="""The branch this WorkingTree is connected to.
224
This cannot be set - it is reflective of the actual disk structure
225
the working tree has been constructed from.
228
def has_versioned_directories(self):
229
"""See `Tree.has_versioned_directories`."""
230
return self._format.supports_versioned_directories
232
def break_lock(self):
233
"""Break a lock if one is present from another instance.
235
Uses the ui factory to ask for confirmation if the lock may be from
238
This will probe the repository for its lock as well.
240
self._control_files.break_lock()
241
self.branch.break_lock()
243
def requires_rich_root(self):
244
return self._format.requires_rich_root
246
def supports_tree_reference(self):
249
def supports_content_filtering(self):
250
return self._format.supports_content_filtering()
252
def supports_views(self):
253
return self.views.supports_views()
256
def open(path=None, _unsupported=False):
257
"""Open an existing working tree at path.
261
path = osutils.getcwd()
262
control = controldir.ControlDir.open(path, _unsupported)
263
return control.open_workingtree(_unsupported)
266
def open_containing(path=None):
267
"""Open an existing working tree which has its root about path.
269
This probes for a working tree at path and searches upwards from there.
271
Basically we keep looking up until we find the control directory or
272
run into /. If there isn't one, raises NotBranchError.
273
TODO: give this a new exception.
274
If there is one, it is returned, along with the unused portion of path.
276
:return: The WorkingTree that contains 'path', and the rest of path
279
path = osutils.getcwd()
280
control, relpath = controldir.ControlDir.open_containing(path)
281
return control.open_workingtree(), relpath
284
def open_containing_paths(file_list, default_directory=None,
285
canonicalize=True, apply_view=True):
286
"""Open the WorkingTree that contains a set of paths.
288
Fail if the paths given are not all in a single tree.
290
This is used for the many command-line interfaces that take a list of
291
any number of files and that require they all be in the same tree.
293
if default_directory is None:
294
default_directory = u'.'
295
# recommended replacement for builtins.internal_tree_files
296
if file_list is None or len(file_list) == 0:
297
tree = WorkingTree.open_containing(default_directory)[0]
298
# XXX: doesn't really belong here, and seems to have the strange
299
# side effect of making it return a bunch of files, not the whole
300
# tree -- mbp 20100716
301
if tree.supports_views() and apply_view:
302
view_files = tree.views.lookup_view()
304
file_list = view_files
305
view_str = views.view_display_str(view_files)
306
note(gettext("Ignoring files outside view. View is %s") % view_str)
307
return tree, file_list
308
if default_directory == u'.':
311
seed = default_directory
312
file_list = [osutils.pathjoin(default_directory, f)
314
tree = WorkingTree.open_containing(seed)[0]
315
return tree, tree.safe_relpath_files(file_list, canonicalize,
316
apply_view=apply_view)
318
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
319
"""Convert file_list into a list of relpaths in tree.
321
:param self: A tree to operate on.
322
:param file_list: A list of user provided paths or None.
323
:param apply_view: if True and a view is set, apply it or check that
324
specified files are within it
325
:return: A list of relative paths.
326
:raises errors.PathNotChild: When a provided path is in a different self
329
if file_list is None:
331
if self.supports_views() and apply_view:
332
view_files = self.views.lookup_view()
336
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
337
# doesn't - fix that up here before we enter the loop.
339
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
342
for filename in file_list:
343
relpath = fixer(osutils.dereference_path(filename))
344
if view_files and not osutils.is_inside_any(view_files, relpath):
345
raise errors.FileOutsideView(filename, view_files)
346
new_list.append(relpath)
350
def open_downlevel(path=None):
351
"""Open an unsupported working tree.
353
Only intended for advanced situations like upgrading part of a bzrdir.
355
return WorkingTree.open(path, _unsupported=True)
358
def find_trees(location):
359
def list_current(transport):
360
return [d for d in transport.list_dir('') if d != '.bzr']
361
def evaluate(bzrdir):
363
tree = bzrdir.open_workingtree()
364
except errors.NoWorkingTree:
368
t = transport.get_transport(location)
369
iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
370
list_current=list_current)
371
return [tr for tr in iterator if tr is not None]
373
def all_file_ids(self):
374
"""See Tree.iter_all_file_ids"""
375
raise NotImplementedError(self.all_file_ids)
378
return "<%s of %s>" % (self.__class__.__name__,
379
getattr(self, 'basedir', None))
381
def abspath(self, filename):
382
return pathjoin(self.basedir, filename)
384
def basis_tree(self):
385
"""Return RevisionTree for the current last revision.
387
If the left most parent is a ghost then the returned tree will be an
388
empty tree - one obtained by calling
389
repository.revision_tree(NULL_REVISION).
392
revision_id = self.get_parent_ids()[0]
394
# no parents, return an empty revision tree.
395
# in the future this should return the tree for
396
# 'empty:' - the implicit root empty tree.
397
return self.branch.repository.revision_tree(
398
_mod_revision.NULL_REVISION)
400
return self.revision_tree(revision_id)
401
except errors.NoSuchRevision:
403
# No cached copy available, retrieve from the repository.
404
# FIXME? RBC 20060403 should we cache the inventory locally
407
return self.branch.repository.revision_tree(revision_id)
408
except (errors.RevisionNotPresent, errors.NoSuchRevision):
409
# the basis tree *may* be a ghost or a low level error may have
410
# occurred. If the revision is present, its a problem, if its not
412
if self.branch.repository.has_revision(revision_id):
414
# the basis tree is a ghost so return an empty tree.
415
return self.branch.repository.revision_tree(
416
_mod_revision.NULL_REVISION)
419
self._flush_ignore_list_cache()
421
def relpath(self, path):
422
"""Return the local path portion from a given path.
424
The path may be absolute or relative. If its a relative path it is
425
interpreted relative to the python current working directory.
427
return osutils.relpath(self.basedir, path)
429
def has_filename(self, filename):
430
return osutils.lexists(self.abspath(filename))
432
def get_file(self, file_id, path=None, filtered=True):
433
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
435
def get_file_with_stat(self, file_id, path=None, filtered=True,
436
_fstat=osutils.fstat):
437
"""See Tree.get_file_with_stat."""
439
path = self.id2path(file_id)
440
file_obj = self.get_file_byname(path, filtered=False)
441
stat_value = _fstat(file_obj.fileno())
442
if filtered and self.supports_content_filtering():
443
filters = self._content_filter_stack(path)
444
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
445
return (file_obj, stat_value)
447
def get_file_text(self, file_id, path=None, filtered=True):
448
my_file = self.get_file(file_id, path=path, filtered=filtered)
450
return my_file.read()
454
def get_file_byname(self, filename, filtered=True):
455
path = self.abspath(filename)
457
if filtered and self.supports_content_filtering():
458
filters = self._content_filter_stack(filename)
459
return _mod_filters.filtered_input_file(f, filters)
463
def get_file_lines(self, file_id, path=None, filtered=True):
464
"""See Tree.get_file_lines()"""
465
file = self.get_file(file_id, path, filtered=filtered)
467
return file.readlines()
471
def get_parent_ids(self):
472
"""See Tree.get_parent_ids.
474
This implementation reads the pending merges list and last_revision
475
value and uses that to decide what the parents list should be.
477
last_rev = _mod_revision.ensure_null(self._last_revision())
478
if _mod_revision.NULL_REVISION == last_rev:
483
merges_bytes = self._transport.get_bytes('pending-merges')
484
except errors.NoSuchFile:
487
for l in osutils.split_lines(merges_bytes):
488
revision_id = l.rstrip('\n')
489
parents.append(revision_id)
492
def get_root_id(self):
493
"""Return the id of this trees root"""
494
raise NotImplementedError(self.get_root_id)
497
def clone(self, to_controldir, revision_id=None):
498
"""Duplicate this working tree into to_bzr, including all state.
500
Specifically modified files are kept as modified, but
501
ignored and unknown files are discarded.
503
If you want to make a new line of development, see ControlDir.sprout()
506
If not None, the cloned tree will have its last revision set to
507
revision, and difference between the source trees last revision
508
and this one merged in.
510
# assumes the target bzr dir format is compatible.
511
result = to_controldir.create_workingtree()
512
self.copy_content_into(result, revision_id)
516
def copy_content_into(self, tree, revision_id=None):
517
"""Copy the current content and user files of this tree into tree."""
518
tree.set_root_id(self.get_root_id())
519
if revision_id is None:
520
merge.transform_tree(tree, self)
522
# TODO now merge from tree.last_revision to revision (to preserve
523
# user local changes)
524
merge.transform_tree(tree, self)
525
if revision_id == _mod_revision.NULL_REVISION:
528
new_parents = [revision_id]
529
tree.set_parent_ids(new_parents)
531
def id2abspath(self, file_id):
532
return self.abspath(self.id2path(file_id))
534
def _check_for_tree_references(self, iterator):
535
"""See if directories have become tree-references."""
536
blocked_parent_ids = set()
537
for path, ie in iterator:
538
if ie.parent_id in blocked_parent_ids:
539
# This entry was pruned because one of its parents became a
540
# TreeReference. If this is a directory, mark it as blocked.
541
if ie.kind == 'directory':
542
blocked_parent_ids.add(ie.file_id)
544
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
545
# This InventoryDirectory needs to be a TreeReference
546
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
547
blocked_parent_ids.add(ie.file_id)
550
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
551
"""See Tree.iter_entries_by_dir()"""
552
# The only trick here is that if we supports_tree_reference then we
553
# need to detect if a directory becomes a tree-reference.
554
iterator = super(WorkingTree, self).iter_entries_by_dir(
555
specific_file_ids=specific_file_ids,
556
yield_parents=yield_parents)
557
if not self.supports_tree_reference():
560
return self._check_for_tree_references(iterator)
562
def get_file_size(self, file_id):
563
"""See Tree.get_file_size"""
564
# XXX: this returns the on-disk size; it should probably return the
567
return os.path.getsize(self.id2abspath(file_id))
569
if e.errno != errno.ENOENT:
574
@needs_tree_write_lock
575
def _gather_kinds(self, files, kinds):
576
"""See MutableTree._gather_kinds."""
577
for pos, f in enumerate(files):
578
if kinds[pos] is None:
579
fullpath = normpath(self.abspath(f))
581
kinds[pos] = file_kind(fullpath)
583
if e.errno == errno.ENOENT:
584
raise errors.NoSuchFile(fullpath)
587
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
588
"""Add revision_id as a parent.
590
This is equivalent to retrieving the current list of parent ids
591
and setting the list to its value plus revision_id.
593
:param revision_id: The revision id to add to the parent list. It may
594
be a ghost revision as long as its not the first parent to be
595
added, or the allow_leftmost_as_ghost parameter is set True.
596
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
598
parents = self.get_parent_ids() + [revision_id]
599
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
600
or allow_leftmost_as_ghost)
602
@needs_tree_write_lock
603
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
604
"""Add revision_id, tree tuple as a parent.
606
This is equivalent to retrieving the current list of parent trees
607
and setting the list to its value plus parent_tuple. See also
608
add_parent_tree_id - if you only have a parent id available it will be
609
simpler to use that api. If you have the parent already available, using
610
this api is preferred.
612
:param parent_tuple: The (revision id, tree) to add to the parent list.
613
If the revision_id is a ghost, pass None for the tree.
614
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
616
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
617
if len(parent_ids) > 1:
618
# the leftmost may have already been a ghost, preserve that if it
620
allow_leftmost_as_ghost = True
621
self.set_parent_ids(parent_ids,
622
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
624
@needs_tree_write_lock
625
def add_pending_merge(self, *revision_ids):
626
# TODO: Perhaps should check at this point that the
627
# history of the revision is actually present?
628
parents = self.get_parent_ids()
630
for rev_id in revision_ids:
631
if rev_id in parents:
633
parents.append(rev_id)
636
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
638
def path_content_summary(self, path, _lstat=os.lstat,
639
_mapper=osutils.file_kind_from_stat_mode):
640
"""See Tree.path_content_summary."""
641
abspath = self.abspath(path)
643
stat_result = _lstat(abspath)
645
if getattr(e, 'errno', None) == errno.ENOENT:
647
return ('missing', None, None, None)
648
# propagate other errors
650
kind = _mapper(stat_result.st_mode)
652
return self._file_content_summary(path, stat_result)
653
elif kind == 'directory':
654
# perhaps it looks like a plain directory, but it's really a
656
if self._directory_is_tree_reference(path):
657
kind = 'tree-reference'
658
return kind, None, None, None
659
elif kind == 'symlink':
660
target = osutils.readlink(abspath)
661
return ('symlink', None, None, target)
663
return (kind, None, None, None)
665
def _file_content_summary(self, path, stat_result):
666
size = stat_result.st_size
667
executable = self._is_executable_from_path_and_stat(path, stat_result)
668
# try for a stat cache lookup
669
return ('file', size, executable, self._sha_from_stat(
672
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
673
"""Common ghost checking functionality from set_parent_*.
675
This checks that the left hand-parent exists if there are any
678
if len(revision_ids) > 0:
679
leftmost_id = revision_ids[0]
680
if (not allow_leftmost_as_ghost and not
681
self.branch.repository.has_revision(leftmost_id)):
682
raise errors.GhostRevisionUnusableHere(leftmost_id)
684
def _set_merges_from_parent_ids(self, parent_ids):
685
merges = parent_ids[1:]
686
self._transport.put_bytes('pending-merges', '\n'.join(merges),
687
mode=self.bzrdir._get_file_mode())
689
def _filter_parent_ids_by_ancestry(self, revision_ids):
690
"""Check that all merged revisions are proper 'heads'.
692
This will always return the first revision_id, and any merged revisions
695
if len(revision_ids) == 0:
697
graph = self.branch.repository.get_graph()
698
heads = graph.heads(revision_ids)
699
new_revision_ids = revision_ids[:1]
700
for revision_id in revision_ids[1:]:
701
if revision_id in heads and revision_id not in new_revision_ids:
702
new_revision_ids.append(revision_id)
703
if new_revision_ids != revision_ids:
704
mutter('requested to set revision_ids = %s,'
705
' but filtered to %s', revision_ids, new_revision_ids)
706
return new_revision_ids
708
@needs_tree_write_lock
709
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
710
"""Set the parent ids to revision_ids.
712
See also set_parent_trees. This api will try to retrieve the tree data
713
for each element of revision_ids from the trees repository. If you have
714
tree data already available, it is more efficient to use
715
set_parent_trees rather than set_parent_ids. set_parent_ids is however
716
an easier API to use.
718
:param revision_ids: The revision_ids to set as the parent ids of this
719
working tree. Any of these may be ghosts.
721
self._check_parents_for_ghosts(revision_ids,
722
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
723
for revision_id in revision_ids:
724
_mod_revision.check_not_reserved_id(revision_id)
726
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
728
if len(revision_ids) > 0:
729
self.set_last_revision(revision_ids[0])
731
self.set_last_revision(_mod_revision.NULL_REVISION)
733
self._set_merges_from_parent_ids(revision_ids)
735
@needs_tree_write_lock
736
def set_pending_merges(self, rev_list):
737
parents = self.get_parent_ids()
738
leftmost = parents[:1]
739
new_parents = leftmost + rev_list
740
self.set_parent_ids(new_parents)
742
@needs_tree_write_lock
743
def set_merge_modified(self, modified_hashes):
745
for file_id, hash in modified_hashes.iteritems():
746
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
748
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
750
def _sha_from_stat(self, path, stat_result):
751
"""Get a sha digest from the tree's stat cache.
753
The default implementation assumes no stat cache is present.
755
:param path: The path.
756
:param stat_result: The stat result being looked up.
760
def _put_rio(self, filename, stanzas, header):
761
self._must_be_locked()
762
my_file = _mod_rio.rio_file(stanzas, header)
763
self._transport.put_file(filename, my_file,
764
mode=self.bzrdir._get_file_mode())
766
@needs_write_lock # because merge pulls data into the branch.
767
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
768
merge_type=None, force=False):
769
"""Merge from a branch into this working tree.
771
:param branch: The branch to merge from.
772
:param to_revision: If non-None, the merge will merge to to_revision,
773
but not beyond it. to_revision does not need to be in the history
774
of the branch when it is supplied. If None, to_revision defaults to
775
branch.last_revision().
777
from bzrlib.merge import Merger, Merge3Merger
778
merger = Merger(self.branch, this_tree=self)
779
# check that there are no local alterations
780
if not force and self.has_changes():
781
raise errors.UncommittedChanges(self)
782
if to_revision is None:
783
to_revision = _mod_revision.ensure_null(branch.last_revision())
784
merger.other_rev_id = to_revision
785
if _mod_revision.is_null(merger.other_rev_id):
786
raise errors.NoCommits(branch)
787
self.branch.fetch(branch, last_revision=merger.other_rev_id)
788
merger.other_basis = merger.other_rev_id
789
merger.other_tree = self.branch.repository.revision_tree(
791
merger.other_branch = branch
792
if from_revision is None:
795
merger.set_base_revision(from_revision, branch)
796
if merger.base_rev_id == merger.other_rev_id:
797
raise errors.PointlessMerge
798
merger.backup_files = False
799
if merge_type is None:
800
merger.merge_type = Merge3Merger
802
merger.merge_type = merge_type
803
merger.set_interesting_files(None)
804
merger.show_base = False
805
merger.reprocess = False
806
conflicts = merger.do_merge()
810
def merge_modified(self):
811
"""Return a dictionary of files modified by a merge.
813
The list is initialized by WorkingTree.set_merge_modified, which is
814
typically called after we make some automatic updates to the tree
817
This returns a map of file_id->sha1, containing only files which are
818
still in the working inventory and have that text hash.
820
raise NotImplementedError(self.merge_modified)
823
def mkdir(self, path, file_id=None):
824
"""See MutableTree.mkdir()."""
826
file_id = generate_ids.gen_file_id(os.path.basename(path))
827
os.mkdir(self.abspath(path))
828
self.add(path, file_id, 'directory')
831
def get_symlink_target(self, file_id, path=None):
833
abspath = self.abspath(path)
835
abspath = self.id2abspath(file_id)
836
target = osutils.readlink(abspath)
839
def subsume(self, other_tree):
840
raise NotImplementedError(self.subsume)
842
def _setup_directory_is_tree_reference(self):
843
if self._branch.repository._format.supports_tree_reference:
844
self._directory_is_tree_reference = \
845
self._directory_may_be_tree_reference
847
self._directory_is_tree_reference = \
848
self._directory_is_never_tree_reference
850
def _directory_is_never_tree_reference(self, relpath):
853
def _directory_may_be_tree_reference(self, relpath):
854
# as a special case, if a directory contains control files then
855
# it's a tree reference, except that the root of the tree is not
856
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
857
# TODO: We could ask all the control formats whether they
858
# recognize this directory, but at the moment there's no cheap api
859
# to do that. Since we probably can only nest bzr checkouts and
860
# they always use this name it's ok for now. -- mbp 20060306
862
# FIXME: There is an unhandled case here of a subdirectory
863
# containing .bzr but not a branch; that will probably blow up
864
# when you try to commit it. It might happen if there is a
865
# checkout in a subdirectory. This can be avoided by not adding
868
def extract(self, file_id, format=None):
869
"""Extract a subtree from this tree.
871
A new branch will be created, relative to the path for this tree.
873
raise NotImplementedError(self.extract)
876
"""Write the in memory meta data to disk."""
877
raise NotImplementedError(self.flush)
879
def _kind(self, relpath):
880
return osutils.file_kind(self.abspath(relpath))
882
def list_files(self, include_root=False, from_dir=None, recursive=True):
883
"""List all files as (path, class, kind, id, entry).
885
Lists, but does not descend into unversioned directories.
886
This does not include files that have been deleted in this
887
tree. Skips the control directory.
889
:param include_root: if True, return an entry for the root
890
:param from_dir: start from this directory or None for the root
891
:param recursive: whether to recurse into subdirectories or not
893
raise NotImplementedError(self.list_files)
895
def move(self, from_paths, to_dir=None, after=False):
898
to_dir must be known to the working tree.
900
If to_dir exists and is a directory, the files are moved into
901
it, keeping their old names.
903
Note that to_dir is only the last component of the new name;
904
this doesn't change the directory.
906
For each entry in from_paths the move mode will be determined
909
The first mode moves the file in the filesystem and updates the
910
working tree metadata. The second mode only updates the working tree
911
metadata without touching the file on the filesystem.
913
move uses the second mode if 'after == True' and the target is not
914
versioned but present in the working tree.
916
move uses the second mode if 'after == False' and the source is
917
versioned but no longer in the working tree, and the target is not
918
versioned but present in the working tree.
920
move uses the first mode if 'after == False' and the source is
921
versioned and present in the working tree, and the target is not
922
versioned and not present in the working tree.
924
Everything else results in an error.
926
This returns a list of (from_path, to_path) pairs for each
929
raise NotImplementedError(self.move)
931
@needs_tree_write_lock
932
def rename_one(self, from_rel, to_rel, after=False):
935
This can change the directory or the filename or both.
937
rename_one has several 'modes' to work. First, it can rename a physical
938
file and change the file_id. That is the normal mode. Second, it can
939
only change the file_id without touching any physical file.
941
rename_one uses the second mode if 'after == True' and 'to_rel' is
942
either not versioned or newly added, and present in the working tree.
944
rename_one uses the second mode if 'after == False' and 'from_rel' is
945
versioned but no longer in the working tree, and 'to_rel' is not
946
versioned but present in the working tree.
948
rename_one uses the first mode if 'after == False' and 'from_rel' is
949
versioned and present in the working tree, and 'to_rel' is not
950
versioned and not present in the working tree.
952
Everything else results in an error.
954
raise NotImplementedError(self.rename_one)
958
"""Return all unknown files.
960
These are files in the working directory that are not versioned or
961
control files or ignored.
963
# force the extras method to be fully executed before returning, to
964
# prevent race conditions with the lock
966
[subp for subp in self.extras() if not self.is_ignored(subp)])
968
def unversion(self, file_ids):
969
"""Remove the file ids in file_ids from the current versioned set.
971
When a file_id is unversioned, all of its children are automatically
974
:param file_ids: The file ids to stop versioning.
975
:raises: NoSuchId if any fileid is not currently versioned.
977
raise NotImplementedError(self.unversion)
980
def pull(self, source, overwrite=False, stop_revision=None,
981
change_reporter=None, possible_transports=None, local=False,
985
old_revision_info = self.branch.last_revision_info()
986
basis_tree = self.basis_tree()
987
count = self.branch.pull(source, overwrite, stop_revision,
988
possible_transports=possible_transports,
990
new_revision_info = self.branch.last_revision_info()
991
if new_revision_info != old_revision_info:
992
repository = self.branch.repository
993
if repository._format.fast_deltas:
994
parent_ids = self.get_parent_ids()
996
basis_id = parent_ids[0]
997
basis_tree = repository.revision_tree(basis_id)
998
basis_tree.lock_read()
1000
new_basis_tree = self.branch.basis_tree()
1007
change_reporter=change_reporter,
1008
show_base=show_base)
1009
basis_root_id = basis_tree.get_root_id()
1010
new_root_id = new_basis_tree.get_root_id()
1011
if new_root_id is not None and basis_root_id != new_root_id:
1012
self.set_root_id(new_root_id)
1015
# TODO - dedup parents list with things merged by pull ?
1016
# reuse the revisiontree we merged against to set the new
1019
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1020
parent_trees.append(
1021
(self.branch.last_revision(), new_basis_tree))
1022
# we have to pull the merge trees out again, because
1023
# merge_inner has set the ids. - this corner is not yet
1024
# layered well enough to prevent double handling.
1025
# XXX TODO: Fix the double handling: telling the tree about
1026
# the already known parent data is wasteful.
1027
merges = self.get_parent_ids()[1:]
1028
parent_trees.extend([
1029
(parent, repository.revision_tree(parent)) for
1031
self.set_parent_trees(parent_trees)
1037
def put_file_bytes_non_atomic(self, file_id, bytes):
1038
"""See MutableTree.put_file_bytes_non_atomic."""
1039
stream = file(self.id2abspath(file_id), 'wb')
1046
"""Yield all unversioned files in this WorkingTree.
1048
If there are any unversioned directories then only the directory is
1049
returned, not all its children. But if there are unversioned files
1050
under a versioned subdirectory, they are returned.
1052
Currently returned depth-first, sorted by name within directories.
1053
This is the same order used by 'osutils.walkdirs'.
1055
raise NotImplementedError(self.extras)
1057
def ignored_files(self):
1058
"""Yield list of PATH, IGNORE_PATTERN"""
1059
for subp in self.extras():
1060
pat = self.is_ignored(subp)
1064
def get_ignore_list(self):
1065
"""Return list of ignore patterns.
1067
Cached in the Tree object after the first call.
1069
ignoreset = getattr(self, '_ignoreset', None)
1070
if ignoreset is not None:
1073
ignore_globs = set()
1074
ignore_globs.update(ignores.get_runtime_ignores())
1075
ignore_globs.update(ignores.get_user_ignores())
1076
if self.has_filename(bzrlib.IGNORE_FILENAME):
1077
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1079
ignore_globs.update(ignores.parse_ignore_file(f))
1082
self._ignoreset = ignore_globs
1085
def _flush_ignore_list_cache(self):
1086
"""Resets the cached ignore list to force a cache rebuild."""
1087
self._ignoreset = None
1088
self._ignoreglobster = None
1090
def is_ignored(self, filename):
1091
r"""Check whether the filename matches an ignore pattern.
1093
Patterns containing '/' or '\' need to match the whole path;
1094
others match against only the last component. Patterns starting
1095
with '!' are ignore exceptions. Exceptions take precedence
1096
over regular patterns and cause the filename to not be ignored.
1098
If the file is ignored, returns the pattern which caused it to
1099
be ignored, otherwise None. So this can simply be used as a
1100
boolean if desired."""
1101
if getattr(self, '_ignoreglobster', None) is None:
1102
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1103
return self._ignoreglobster.match(filename)
1105
def kind(self, file_id):
1106
return file_kind(self.id2abspath(file_id))
1108
def stored_kind(self, file_id):
1109
"""See Tree.stored_kind"""
1110
raise NotImplementedError(self.stored_kind)
1112
def _comparison_data(self, entry, path):
1113
abspath = self.abspath(path)
1115
stat_value = os.lstat(abspath)
1117
if getattr(e, 'errno', None) == errno.ENOENT:
1124
mode = stat_value.st_mode
1125
kind = osutils.file_kind_from_stat_mode(mode)
1126
if not supports_executable():
1127
executable = entry is not None and entry.executable
1129
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1130
return kind, executable, stat_value
1132
def _file_size(self, entry, stat_value):
1133
return stat_value.st_size
1135
def last_revision(self):
1136
"""Return the last revision of the branch for this tree.
1138
This format tree does not support a separate marker for last-revision
1139
compared to the branch.
1141
See MutableTree.last_revision
1143
return self._last_revision()
1146
def _last_revision(self):
1147
"""helper for get_parent_ids."""
1148
return _mod_revision.ensure_null(self.branch.last_revision())
1150
def is_locked(self):
1151
return self._control_files.is_locked()
1153
def _must_be_locked(self):
1154
if not self.is_locked():
1155
raise errors.ObjectNotLocked(self)
1157
def lock_read(self):
1158
"""Lock the tree for reading.
1160
This also locks the branch, and can be unlocked via self.unlock().
1162
:return: A bzrlib.lock.LogicalLockResult.
1164
if not self.is_locked():
1166
self.branch.lock_read()
1168
self._control_files.lock_read()
1169
return LogicalLockResult(self.unlock)
1171
self.branch.unlock()
1174
def lock_tree_write(self):
1175
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1177
:return: A bzrlib.lock.LogicalLockResult.
1179
if not self.is_locked():
1181
self.branch.lock_read()
1183
self._control_files.lock_write()
1184
return LogicalLockResult(self.unlock)
1186
self.branch.unlock()
1189
def lock_write(self):
1190
"""See MutableTree.lock_write, and WorkingTree.unlock.
1192
:return: A bzrlib.lock.LogicalLockResult.
1194
if not self.is_locked():
1196
self.branch.lock_write()
1198
self._control_files.lock_write()
1199
return LogicalLockResult(self.unlock)
1201
self.branch.unlock()
1204
def get_physical_lock_status(self):
1205
return self._control_files.get_physical_lock_status()
1207
def _reset_data(self):
1208
"""Reset transient data that cannot be revalidated."""
1209
raise NotImplementedError(self._reset_data)
1211
def set_last_revision(self, new_revision):
1212
"""Change the last revision in the working tree."""
1213
raise NotImplementedError(self.set_last_revision)
1215
def _change_last_revision(self, new_revision):
1216
"""Template method part of set_last_revision to perform the change.
1218
This is used to allow WorkingTree3 instances to not affect branch
1219
when their last revision is set.
1221
if _mod_revision.is_null(new_revision):
1222
self.branch.set_last_revision_info(0, new_revision)
1224
_mod_revision.check_not_reserved_id(new_revision)
1226
self.branch.generate_revision_history(new_revision)
1227
except errors.NoSuchRevision:
1228
# not present in the repo - dont try to set it deeper than the tip
1229
self.branch._set_revision_history([new_revision])
1232
@needs_tree_write_lock
1233
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1235
"""Remove nominated files from the working tree metadata.
1237
:files: File paths relative to the basedir.
1238
:keep_files: If true, the files will also be kept.
1239
:force: Delete files and directories, even if they are changed and
1240
even if the directories are not empty.
1242
if isinstance(files, basestring):
1247
all_files = set() # specified and nested files
1248
unknown_nested_files=set()
1250
to_file = sys.stdout
1252
files_to_backup = []
1254
def recurse_directory_to_add_files(directory):
1255
# Recurse directory and add all files
1256
# so we can check if they have changed.
1257
for parent_info, file_infos in self.walkdirs(directory):
1258
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1259
# Is it versioned or ignored?
1260
if self.path2id(relpath):
1261
# Add nested content for deletion.
1262
all_files.add(relpath)
1264
# Files which are not versioned
1265
# should be treated as unknown.
1266
files_to_backup.append(relpath)
1268
for filename in files:
1269
# Get file name into canonical form.
1270
abspath = self.abspath(filename)
1271
filename = self.relpath(abspath)
1272
if len(filename) > 0:
1273
all_files.add(filename)
1274
recurse_directory_to_add_files(filename)
1276
files = list(all_files)
1279
return # nothing to do
1281
# Sort needed to first handle directory content before the directory
1282
files.sort(reverse=True)
1284
# Bail out if we are going to delete files we shouldn't
1285
if not keep_files and not force:
1286
for (file_id, path, content_change, versioned, parent_id, name,
1287
kind, executable) in self.iter_changes(self.basis_tree(),
1288
include_unchanged=True, require_versioned=False,
1289
want_unversioned=True, specific_files=files):
1290
if versioned[0] == False:
1291
# The record is unknown or newly added
1292
files_to_backup.append(path[1])
1293
elif (content_change and (kind[1] is not None) and
1294
osutils.is_inside_any(files, path[1])):
1295
# Versioned and changed, but not deleted, and still
1296
# in one of the dirs to be deleted.
1297
files_to_backup.append(path[1])
1299
def backup(file_to_backup):
1300
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1301
osutils.rename(abs_path, self.abspath(backup_name))
1302
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1305
# Build inv_delta and delete files where applicable,
1306
# do this before any modifications to meta data.
1308
fid = self.path2id(f)
1311
message = "%s is not versioned." % (f,)
1314
# having removed it, it must be either ignored or unknown
1315
if self.is_ignored(f):
1319
# XXX: Really should be a more abstract reporter interface
1320
kind_ch = osutils.kind_marker(self.kind(fid))
1321
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1323
inv_delta.append((f, None, fid, None))
1324
message = "removed %s" % (f,)
1327
abs_path = self.abspath(f)
1328
if osutils.lexists(abs_path):
1329
if (osutils.isdir(abs_path) and
1330
len(os.listdir(abs_path)) > 0):
1332
osutils.rmtree(abs_path)
1333
message = "deleted %s" % (f,)
1337
if f in files_to_backup:
1340
osutils.delete_any(abs_path)
1341
message = "deleted %s" % (f,)
1342
elif message is not None:
1343
# Only care if we haven't done anything yet.
1344
message = "%s does not exist." % (f,)
1346
# Print only one message (if any) per file.
1347
if message is not None:
1349
self.apply_inventory_delta(inv_delta)
1351
@needs_tree_write_lock
1352
def revert(self, filenames=None, old_tree=None, backups=True,
1353
pb=None, report_changes=False):
1354
from bzrlib.conflicts import resolve
1355
if old_tree is None:
1356
basis_tree = self.basis_tree()
1357
basis_tree.lock_read()
1358
old_tree = basis_tree
1362
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1364
if filenames is None and len(self.get_parent_ids()) > 1:
1366
last_revision = self.last_revision()
1367
if last_revision != _mod_revision.NULL_REVISION:
1368
if basis_tree is None:
1369
basis_tree = self.basis_tree()
1370
basis_tree.lock_read()
1371
parent_trees.append((last_revision, basis_tree))
1372
self.set_parent_trees(parent_trees)
1375
resolve(self, filenames, ignore_misses=True, recursive=True)
1377
if basis_tree is not None:
1381
def revision_tree(self, revision_id):
1382
"""See Tree.revision_tree.
1384
WorkingTree can supply revision_trees for the basis revision only
1385
because there is only one cached inventory in the bzr directory.
1387
raise NotImplementedError(self.revision_tree)
1389
@needs_tree_write_lock
1390
def set_root_id(self, file_id):
1391
"""Set the root id for this tree."""
1395
'WorkingTree.set_root_id with fileid=None')
1396
file_id = osutils.safe_file_id(file_id)
1397
self._set_root_id(file_id)
1399
def _set_root_id(self, file_id):
1400
"""Set the root id for this tree, in a format specific manner.
1402
:param file_id: The file id to assign to the root. It must not be
1403
present in the current inventory or an error will occur. It must
1404
not be None, but rather a valid file id.
1406
raise NotImplementedError(self._set_root_id)
1409
"""See Branch.unlock.
1411
WorkingTree locking just uses the Branch locking facilities.
1412
This is current because all working trees have an embedded branch
1413
within them. IF in the future, we were to make branch data shareable
1414
between multiple working trees, i.e. via shared storage, then we
1415
would probably want to lock both the local tree, and the branch.
1417
raise NotImplementedError(self.unlock)
1421
def update(self, change_reporter=None, possible_transports=None,
1422
revision=None, old_tip=_marker, show_base=False):
1423
"""Update a working tree along its branch.
1425
This will update the branch if its bound too, which means we have
1426
multiple trees involved:
1428
- The new basis tree of the master.
1429
- The old basis tree of the branch.
1430
- The old basis tree of the working tree.
1431
- The current working tree state.
1433
Pathologically, all three may be different, and non-ancestors of each
1434
other. Conceptually we want to:
1436
- Preserve the wt.basis->wt.state changes
1437
- Transform the wt.basis to the new master basis.
1438
- Apply a merge of the old branch basis to get any 'local' changes from
1440
- Restore the wt.basis->wt.state changes.
1442
There isn't a single operation at the moment to do that, so we:
1444
- Merge current state -> basis tree of the master w.r.t. the old tree
1446
- Do a 'normal' merge of the old branch basis if it is relevant.
1448
:param revision: The target revision to update to. Must be in the
1450
:param old_tip: If branch.update() has already been run, the value it
1451
returned (old tip of the branch or None). _marker is used
1454
if self.branch.get_bound_location() is not None:
1456
update_branch = (old_tip is self._marker)
1458
self.lock_tree_write()
1459
update_branch = False
1462
old_tip = self.branch.update(possible_transports)
1464
if old_tip is self._marker:
1466
return self._update_tree(old_tip, change_reporter, revision, show_base)
1470
@needs_tree_write_lock
1471
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1473
"""Update a tree to the master branch.
1475
:param old_tip: if supplied, the previous tip revision the branch,
1476
before it was changed to the master branch's tip.
1478
# here if old_tip is not None, it is the old tip of the branch before
1479
# it was updated from the master branch. This should become a pending
1480
# merge in the working tree to preserve the user existing work. we
1481
# cant set that until we update the working trees last revision to be
1482
# one from the new branch, because it will just get absorbed by the
1483
# parent de-duplication logic.
1485
# We MUST save it even if an error occurs, because otherwise the users
1486
# local work is unreferenced and will appear to have been lost.
1490
last_rev = self.get_parent_ids()[0]
1492
last_rev = _mod_revision.NULL_REVISION
1493
if revision is None:
1494
revision = self.branch.last_revision()
1496
old_tip = old_tip or _mod_revision.NULL_REVISION
1498
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1499
# the branch we are bound to was updated
1500
# merge those changes in first
1501
base_tree = self.basis_tree()
1502
other_tree = self.branch.repository.revision_tree(old_tip)
1503
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1504
base_tree, this_tree=self,
1505
change_reporter=change_reporter,
1506
show_base=show_base)
1508
self.add_parent_tree((old_tip, other_tree))
1509
note(gettext('Rerun update after fixing the conflicts.'))
1512
if last_rev != _mod_revision.ensure_null(revision):
1513
# the working tree is up to date with the branch
1514
# we can merge the specified revision from master
1515
to_tree = self.branch.repository.revision_tree(revision)
1516
to_root_id = to_tree.get_root_id()
1518
basis = self.basis_tree()
1521
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1522
self.set_root_id(to_root_id)
1527
# determine the branch point
1528
graph = self.branch.repository.get_graph()
1529
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1531
base_tree = self.branch.repository.revision_tree(base_rev_id)
1533
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1535
change_reporter=change_reporter,
1536
show_base=show_base)
1537
self.set_last_revision(revision)
1538
# TODO - dedup parents list with things merged by pull ?
1539
# reuse the tree we've updated to to set the basis:
1540
parent_trees = [(revision, to_tree)]
1541
merges = self.get_parent_ids()[1:]
1542
# Ideally we ask the tree for the trees here, that way the working
1543
# tree can decide whether to give us the entire tree or give us a
1544
# lazy initialised tree. dirstate for instance will have the trees
1545
# in ram already, whereas a last-revision + basis-inventory tree
1546
# will not, but also does not need them when setting parents.
1547
for parent in merges:
1548
parent_trees.append(
1549
(parent, self.branch.repository.revision_tree(parent)))
1550
if not _mod_revision.is_null(old_tip):
1551
parent_trees.append(
1552
(old_tip, self.branch.repository.revision_tree(old_tip)))
1553
self.set_parent_trees(parent_trees)
1554
last_rev = parent_trees[0][0]
1557
def set_conflicts(self, arg):
1558
raise errors.UnsupportedOperation(self.set_conflicts, self)
1560
def add_conflicts(self, arg):
1561
raise errors.UnsupportedOperation(self.add_conflicts, self)
1563
def conflicts(self):
1564
raise NotImplementedError(self.conflicts)
1566
def walkdirs(self, prefix=""):
1567
"""Walk the directories of this tree.
1569
returns a generator which yields items in the form:
1570
((curren_directory_path, fileid),
1571
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1574
This API returns a generator, which is only valid during the current
1575
tree transaction - within a single lock_read or lock_write duration.
1577
If the tree is not locked, it may cause an error to be raised,
1578
depending on the tree implementation.
1580
disk_top = self.abspath(prefix)
1581
if disk_top.endswith('/'):
1582
disk_top = disk_top[:-1]
1583
top_strip_len = len(disk_top) + 1
1584
inventory_iterator = self._walkdirs(prefix)
1585
disk_iterator = osutils.walkdirs(disk_top, prefix)
1587
current_disk = disk_iterator.next()
1588
disk_finished = False
1590
if not (e.errno == errno.ENOENT or
1591
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1594
disk_finished = True
1596
current_inv = inventory_iterator.next()
1597
inv_finished = False
1598
except StopIteration:
1601
while not inv_finished or not disk_finished:
1603
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1604
cur_disk_dir_content) = current_disk
1606
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1607
cur_disk_dir_content) = ((None, None), None)
1608
if not disk_finished:
1609
# strip out .bzr dirs
1610
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1611
len(cur_disk_dir_content) > 0):
1612
# osutils.walkdirs can be made nicer -
1613
# yield the path-from-prefix rather than the pathjoined
1615
bzrdir_loc = bisect_left(cur_disk_dir_content,
1617
if (bzrdir_loc < len(cur_disk_dir_content)
1618
and self.bzrdir.is_control_filename(
1619
cur_disk_dir_content[bzrdir_loc][0])):
1620
# we dont yield the contents of, or, .bzr itself.
1621
del cur_disk_dir_content[bzrdir_loc]
1623
# everything is unknown
1626
# everything is missing
1629
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1631
# disk is before inventory - unknown
1632
dirblock = [(relpath, basename, kind, stat, None, None) for
1633
relpath, basename, kind, stat, top_path in
1634
cur_disk_dir_content]
1635
yield (cur_disk_dir_relpath, None), dirblock
1637
current_disk = disk_iterator.next()
1638
except StopIteration:
1639
disk_finished = True
1641
# inventory is before disk - missing.
1642
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1643
for relpath, basename, dkind, stat, fileid, kind in
1645
yield (current_inv[0][0], current_inv[0][1]), dirblock
1647
current_inv = inventory_iterator.next()
1648
except StopIteration:
1651
# versioned present directory
1652
# merge the inventory and disk data together
1654
for relpath, subiterator in itertools.groupby(sorted(
1655
current_inv[1] + cur_disk_dir_content,
1656
key=operator.itemgetter(0)), operator.itemgetter(1)):
1657
path_elements = list(subiterator)
1658
if len(path_elements) == 2:
1659
inv_row, disk_row = path_elements
1660
# versioned, present file
1661
dirblock.append((inv_row[0],
1662
inv_row[1], disk_row[2],
1663
disk_row[3], inv_row[4],
1665
elif len(path_elements[0]) == 5:
1667
dirblock.append((path_elements[0][0],
1668
path_elements[0][1], path_elements[0][2],
1669
path_elements[0][3], None, None))
1670
elif len(path_elements[0]) == 6:
1671
# versioned, absent file.
1672
dirblock.append((path_elements[0][0],
1673
path_elements[0][1], 'unknown', None,
1674
path_elements[0][4], path_elements[0][5]))
1676
raise NotImplementedError('unreachable code')
1677
yield current_inv[0], dirblock
1679
current_inv = inventory_iterator.next()
1680
except StopIteration:
1683
current_disk = disk_iterator.next()
1684
except StopIteration:
1685
disk_finished = True
1687
def _walkdirs(self, prefix=""):
1688
"""Walk the directories of this tree.
1690
:param prefix: is used as the directrory to start with.
1691
:returns: a generator which yields items in the form::
1693
((curren_directory_path, fileid),
1694
[(file1_path, file1_name, file1_kind, None, file1_id,
1697
raise NotImplementedError(self._walkdirs)
1699
@needs_tree_write_lock
1700
def auto_resolve(self):
1701
"""Automatically resolve text conflicts according to contents.
1703
Only text conflicts are auto_resolvable. Files with no conflict markers
1704
are considered 'resolved', because bzr always puts conflict markers
1705
into files that have text conflicts. The corresponding .THIS .BASE and
1706
.OTHER files are deleted, as per 'resolve'.
1708
:return: a tuple of ConflictLists: (un_resolved, resolved).
1710
un_resolved = _mod_conflicts.ConflictList()
1711
resolved = _mod_conflicts.ConflictList()
1712
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1713
for conflict in self.conflicts():
1714
if (conflict.typestring != 'text conflict' or
1715
self.kind(conflict.file_id) != 'file'):
1716
un_resolved.append(conflict)
1718
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1720
for line in my_file:
1721
if conflict_re.search(line):
1722
un_resolved.append(conflict)
1725
resolved.append(conflict)
1728
resolved.remove_files(self)
1729
self.set_conflicts(un_resolved)
1730
return un_resolved, resolved
1732
def _validate(self):
1733
"""Validate internal structures.
1735
This is meant mostly for the test suite. To give it a chance to detect
1736
corruption after actions have occurred. The default implementation is a
1739
:return: None. An exception should be raised if there is an error.
1743
def check_state(self):
1744
"""Check that the working state is/isn't valid."""
1745
raise NotImplementedError(self.check_state)
1747
def reset_state(self, revision_ids=None):
1748
"""Reset the state of the working tree.
1750
This does a hard-reset to a last-known-good state. This is a way to
1751
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1753
raise NotImplementedError(self.reset_state)
1755
def _get_rules_searcher(self, default_searcher):
1756
"""See Tree._get_rules_searcher."""
1757
if self._rules_searcher is None:
1758
self._rules_searcher = super(WorkingTree,
1759
self)._get_rules_searcher(default_searcher)
1760
return self._rules_searcher
1762
def get_shelf_manager(self):
1763
"""Return the ShelfManager for this WorkingTree."""
1764
from bzrlib.shelf import ShelfManager
1765
return ShelfManager(self, self._transport)
1768
class InventoryWorkingTree(WorkingTree,
1769
bzrlib.mutabletree.MutableInventoryTree):
1770
"""Base class for working trees that are inventory-oriented.
32
1772
The inventory is held in the `Branch` working-inventory, and the
33
1773
files are in a directory on disk.
35
1775
It is possible for a `WorkingTree` to have a filename which is
36
1776
not listed in the Inventory and vice versa.
38
def __init__(self, basedir, inv):
39
from bzrlib.hashcache import HashCache
40
from bzrlib.trace import note, mutter
1779
def __init__(self, basedir='.',
1780
branch=DEPRECATED_PARAMETER,
1782
_control_files=None,
1786
"""Construct a InventoryWorkingTree instance. This is not a public API.
1788
:param branch: A branch to override probing for the branch.
1790
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1791
branch=branch, _control_files=_control_files, _internal=_internal,
1792
_format=_format, _bzrdir=_bzrdir)
1794
self._detect_case_handling()
1796
if _inventory is None:
1797
# This will be acquired on lock_read() or lock_write()
1798
self._inventory_is_modified = False
1799
self._inventory = None
1801
# the caller of __init__ has provided an inventory,
1802
# we assume they know what they are doing - as its only
1803
# the Format factory and creation methods that are
1804
# permitted to do this.
1805
self._set_inventory(_inventory, dirty=False)
1807
def _set_inventory(self, inv, dirty):
1808
"""Set the internal cached inventory.
1810
:param inv: The inventory to set.
1811
:param dirty: A boolean indicating whether the inventory is the same
1812
logical inventory as whats on disk. If True the inventory is not
1813
the same and should be written to disk or data will be lost, if
1814
False then the inventory is the same as that on disk and any
1815
serialisation would be unneeded overhead.
42
1817
self._inventory = inv
43
self.basedir = basedir
44
self.path2id = inv.path2id
46
# update the whole cache up front and write to disk if anything changed;
47
# in the future we might want to do this more selectively
48
hc = self._hashcache = HashCache(basedir)
58
if self._hashcache.needs_write:
59
self._hashcache.write()
1818
self._inventory_is_modified = dirty
1820
def _detect_case_handling(self):
1821
wt_trans = self.bzrdir.get_workingtree_transport(None)
1823
wt_trans.stat(self._format.case_sensitive_filename)
1824
except errors.NoSuchFile:
1825
self.case_sensitive = True
1827
self.case_sensitive = False
1829
self._setup_directory_is_tree_reference()
1831
def _serialize(self, inventory, out_file):
1832
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1835
def _deserialize(selt, in_file):
1836
return xml5.serializer_v5.read_inventory(in_file)
1838
@needs_tree_write_lock
1839
def _write_inventory(self, inv):
1840
"""Write inventory as the current inventory."""
1841
self._set_inventory(inv, dirty=True)
1844
# XXX: This method should be deprecated in favour of taking in a proper
1845
# new Inventory object.
1846
@needs_tree_write_lock
1847
def set_inventory(self, new_inventory_list):
1848
from bzrlib.inventory import (Inventory,
1852
inv = Inventory(self.get_root_id())
1853
for path, file_id, parent, kind in new_inventory_list:
1854
name = os.path.basename(path)
1857
# fixme, there should be a factory function inv,add_??
1858
if kind == 'directory':
1859
inv.add(InventoryDirectory(file_id, name, parent))
1860
elif kind == 'file':
1861
inv.add(InventoryFile(file_id, name, parent))
1862
elif kind == 'symlink':
1863
inv.add(InventoryLink(file_id, name, parent))
1865
raise errors.BzrError("unknown kind %r" % kind)
1866
self._write_inventory(inv)
1868
def _write_basis_inventory(self, xml):
1869
"""Write the basis inventory XML to the basis-inventory file"""
1870
path = self._basis_inventory_name()
1872
self._transport.put_file(path, sio,
1873
mode=self.bzrdir._get_file_mode())
1875
def _reset_data(self):
1876
"""Reset transient data that cannot be revalidated."""
1877
self._inventory_is_modified = False
1878
f = self._transport.get('inventory')
1880
result = self._deserialize(f)
1883
self._set_inventory(result, dirty=False)
1885
def _set_root_id(self, file_id):
1886
"""Set the root id for this tree, in a format specific manner.
1888
:param file_id: The file id to assign to the root. It must not be
1889
present in the current inventory or an error will occur. It must
1890
not be None, but rather a valid file id.
1892
inv = self._inventory
1893
orig_root_id = inv.root.file_id
1894
# TODO: it might be nice to exit early if there was nothing
1895
# to do, saving us from trigger a sync on unlock.
1896
self._inventory_is_modified = True
1897
# we preserve the root inventory entry object, but
1898
# unlinkit from the byid index
1899
del inv._byid[inv.root.file_id]
1900
inv.root.file_id = file_id
1901
# and link it into the index with the new changed id.
1902
inv._byid[inv.root.file_id] = inv.root
1903
# and finally update all children to reference the new id.
1904
# XXX: this should be safe to just look at the root.children
1905
# list, not the WHOLE INVENTORY.
1908
if entry.parent_id == orig_root_id:
1909
entry.parent_id = inv.root.file_id
1911
def all_file_ids(self):
1912
"""See Tree.iter_all_file_ids"""
1913
return set(self.inventory)
1915
@needs_tree_write_lock
1916
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1917
"""See MutableTree.set_parent_trees."""
1918
parent_ids = [rev for (rev, tree) in parents_list]
1919
for revision_id in parent_ids:
1920
_mod_revision.check_not_reserved_id(revision_id)
1922
self._check_parents_for_ghosts(parent_ids,
1923
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1925
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1927
if len(parent_ids) == 0:
1928
leftmost_parent_id = _mod_revision.NULL_REVISION
1929
leftmost_parent_tree = None
1931
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1933
if self._change_last_revision(leftmost_parent_id):
1934
if leftmost_parent_tree is None:
1935
# If we don't have a tree, fall back to reading the
1936
# parent tree from the repository.
1937
self._cache_basis_inventory(leftmost_parent_id)
1939
inv = leftmost_parent_tree.inventory
1940
xml = self._create_basis_xml_from_inventory(
1941
leftmost_parent_id, inv)
1942
self._write_basis_inventory(xml)
1943
self._set_merges_from_parent_ids(parent_ids)
1945
def _cache_basis_inventory(self, new_revision):
1946
"""Cache new_revision as the basis inventory."""
1947
# TODO: this should allow the ready-to-use inventory to be passed in,
1948
# as commit already has that ready-to-use [while the format is the
1951
# this double handles the inventory - unpack and repack -
1952
# but is easier to understand. We can/should put a conditional
1953
# in here based on whether the inventory is in the latest format
1954
# - perhaps we should repack all inventories on a repository
1956
# the fast path is to copy the raw xml from the repository. If the
1957
# xml contains 'revision_id="', then we assume the right
1958
# revision_id is set. We must check for this full string, because a
1959
# root node id can legitimately look like 'revision_id' but cannot
1961
xml = self.branch.repository._get_inventory_xml(new_revision)
1962
firstline = xml.split('\n', 1)[0]
1963
if (not 'revision_id="' in firstline or
1964
'format="7"' not in firstline):
1965
inv = self.branch.repository._serializer.read_inventory_from_string(
1967
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1968
self._write_basis_inventory(xml)
1969
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1972
def _basis_inventory_name(self):
1973
return 'basis-inventory-cache'
1975
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1976
"""Create the text that will be saved in basis-inventory"""
1977
inventory.revision_id = revision_id
1978
return xml7.serializer_v7.write_inventory_to_string(inventory)
1980
@needs_tree_write_lock
1981
def set_conflicts(self, conflicts):
1982
self._put_rio('conflicts', conflicts.to_stanzas(),
1985
@needs_tree_write_lock
1986
def add_conflicts(self, new_conflicts):
1987
conflict_set = set(self.conflicts())
1988
conflict_set.update(set(list(new_conflicts)))
1989
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1990
key=_mod_conflicts.Conflict.sort_key)))
1993
def conflicts(self):
1995
confile = self._transport.get('conflicts')
1996
except errors.NoSuchFile:
1997
return _mod_conflicts.ConflictList()
2000
if confile.next() != CONFLICT_HEADER_1 + '\n':
2001
raise errors.ConflictFormatError()
2002
except StopIteration:
2003
raise errors.ConflictFormatError()
2004
reader = _mod_rio.RioReader(confile)
2005
return _mod_conflicts.ConflictList.from_stanzas(reader)
2009
def read_basis_inventory(self):
2010
"""Read the cached basis inventory."""
2011
path = self._basis_inventory_name()
2012
return self._transport.get_bytes(path)
2015
def read_working_inventory(self):
2016
"""Read the working inventory.
2018
:raises errors.InventoryModified: read_working_inventory will fail
2019
when the current in memory inventory has been modified.
2021
# conceptually this should be an implementation detail of the tree.
2022
# XXX: Deprecate this.
2023
# ElementTree does its own conversion from UTF-8, so open in
2025
if self._inventory_is_modified:
2026
raise errors.InventoryModified(self)
2027
f = self._transport.get('inventory')
2029
result = self._deserialize(f)
2032
self._set_inventory(result, dirty=False)
2036
def get_root_id(self):
2037
"""Return the id of this trees root"""
2038
return self._inventory.root.file_id
2040
def has_id(self, file_id):
2041
# files that have been deleted are excluded
2042
inv = self.inventory
2043
if not inv.has_id(file_id):
2045
path = inv.id2path(file_id)
2046
return osutils.lexists(self.abspath(path))
2048
def has_or_had_id(self, file_id):
2049
if file_id == self.inventory.root.file_id:
2051
return self.inventory.has_id(file_id)
2053
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
62
2054
def __iter__(self):
63
2055
"""Iterate through file_ids for this tree.
68
2060
inv = self._inventory
69
2061
for path, ie in inv.iter_entries():
70
if os.path.exists(self.abspath(path)):
2062
if osutils.lexists(self.abspath(path)):
75
return "<%s of %s>" % (self.__class__.__name__,
76
getattr(self, 'basedir', None))
80
def abspath(self, filename):
81
return os.path.join(self.basedir, filename)
83
def has_filename(self, filename):
84
return os.path.exists(self.abspath(filename))
86
def get_file(self, file_id):
87
return self.get_file_byname(self.id2path(file_id))
89
def get_file_byname(self, filename):
90
return file(self.abspath(filename), 'rb')
92
def _get_store_filename(self, file_id):
93
## XXX: badly named; this isn't in the store at all
94
return self.abspath(self.id2path(file_id))
97
def has_id(self, file_id):
98
# files that have been deleted are excluded
100
if not inv.has_id(file_id):
2065
@needs_tree_write_lock
2066
def set_last_revision(self, new_revision):
2067
"""Change the last revision in the working tree."""
2068
if self._change_last_revision(new_revision):
2069
self._cache_basis_inventory(new_revision)
2071
def _get_check_refs(self):
2072
"""Return the references needed to perform a check of this tree.
2074
The default implementation returns no refs, and is only suitable for
2075
trees that have no local caching and can commit on ghosts at any time.
2077
:seealso: bzrlib.check for details about check_refs.
2082
def _check(self, references):
2083
"""Check the tree for consistency.
2085
:param references: A dict with keys matching the items returned by
2086
self._get_check_refs(), and values from looking those keys up in
2089
tree_basis = self.basis_tree()
2090
tree_basis.lock_read()
2092
repo_basis = references[('trees', self.last_revision())]
2093
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2094
raise errors.BzrCheckError(
2095
"Mismatched basis inventory content.")
2101
def check_state(self):
2102
"""Check that the working state is/isn't valid."""
2103
check_refs = self._get_check_refs()
2105
for ref in check_refs:
2108
refs[ref] = self.branch.repository.revision_tree(value)
2111
@needs_tree_write_lock
2112
def reset_state(self, revision_ids=None):
2113
"""Reset the state of the working tree.
2115
This does a hard-reset to a last-known-good state. This is a way to
2116
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2118
if revision_ids is None:
2119
revision_ids = self.get_parent_ids()
2120
if not revision_ids:
2121
rt = self.branch.repository.revision_tree(
2122
_mod_revision.NULL_REVISION)
2124
rt = self.branch.repository.revision_tree(revision_ids[0])
2125
self._write_inventory(rt.inventory)
2126
self.set_parent_ids(revision_ids)
2129
"""Write the in memory inventory to disk."""
2130
# TODO: Maybe this should only write on dirty ?
2131
if self._control_files._lock_mode != 'w':
2132
raise errors.NotWriteLocked(self)
2134
self._serialize(self._inventory, sio)
2136
self._transport.put_file('inventory', sio,
2137
mode=self.bzrdir._get_file_mode())
2138
self._inventory_is_modified = False
2140
def get_file_mtime(self, file_id, path=None):
2141
"""See Tree.get_file_mtime."""
2143
path = self.inventory.id2path(file_id)
2145
return os.lstat(self.abspath(path)).st_mtime
2147
if e.errno == errno.ENOENT:
2148
raise errors.FileTimestampUnavailable(path)
2151
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2152
file_id = self.path2id(path)
2154
# For unversioned files on win32, we just assume they are not
102
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
106
__contains__ = has_id
109
def get_file_size(self, file_id):
110
# is this still called?
111
raise NotImplementedError()
114
def get_file_sha1(self, file_id):
115
path = self._inventory.id2path(file_id)
116
return self._hashcache.get_sha1(path)
119
def file_class(self, filename):
120
if self.path2id(filename):
122
elif self.is_ignored(filename):
2157
return self._inventory[file_id].executable
2159
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2160
mode = stat_result.st_mode
2161
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2163
if not supports_executable():
2164
def is_executable(self, file_id, path=None):
2165
return self._inventory[file_id].executable
2167
_is_executable_from_path_and_stat = \
2168
_is_executable_from_path_and_stat_from_basis
2170
def is_executable(self, file_id, path=None):
2172
path = self.id2path(file_id)
2173
mode = os.lstat(self.abspath(path)).st_mode
2174
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2176
_is_executable_from_path_and_stat = \
2177
_is_executable_from_path_and_stat_from_stat
2179
@needs_tree_write_lock
2180
def _add(self, files, ids, kinds):
2181
"""See MutableTree._add."""
2182
# TODO: Re-adding a file that is removed in the working copy
2183
# should probably put it back with the previous ID.
2184
# the read and write working inventory should not occur in this
2185
# function - they should be part of lock_write and unlock.
2186
inv = self.inventory
2187
for f, file_id, kind in zip(files, ids, kinds):
2189
inv.add_path(f, kind=kind)
2191
inv.add_path(f, kind=kind, file_id=file_id)
2192
self._inventory_is_modified = True
2194
def revision_tree(self, revision_id):
2195
"""See WorkingTree.revision_id."""
2196
if revision_id == self.last_revision():
2198
xml = self.read_basis_inventory()
2199
except errors.NoSuchFile:
2203
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2204
# dont use the repository revision_tree api because we want
2205
# to supply the inventory.
2206
if inv.revision_id == revision_id:
2207
return revisiontree.InventoryRevisionTree(
2208
self.branch.repository, inv, revision_id)
2209
except errors.BadInventoryFormat:
2211
# raise if there was no inventory, or if we read the wrong inventory.
2212
raise errors.NoSuchRevisionInTree(self, revision_id)
2215
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2216
"""See Tree.annotate_iter
2218
This implementation will use the basis tree implementation if possible.
2219
Lines not in the basis are attributed to CURRENT_REVISION
2221
If there are pending merges, lines added by those merges will be
2222
incorrectly attributed to CURRENT_REVISION (but after committing, the
2223
attribution will be correct).
2225
maybe_file_parent_keys = []
2226
for parent_id in self.get_parent_ids():
2228
parent_tree = self.revision_tree(parent_id)
2229
except errors.NoSuchRevisionInTree:
2230
parent_tree = self.branch.repository.revision_tree(parent_id)
2231
parent_tree.lock_read()
2233
if not parent_tree.has_id(file_id):
2235
ie = parent_tree.inventory[file_id]
2236
if ie.kind != 'file':
2237
# Note: this is slightly unnecessary, because symlinks and
2238
# directories have a "text" which is the empty text, and we
2239
# know that won't mess up annotations. But it seems cleaner
2241
parent_text_key = (file_id, ie.revision)
2242
if parent_text_key not in maybe_file_parent_keys:
2243
maybe_file_parent_keys.append(parent_text_key)
2245
parent_tree.unlock()
2246
graph = _mod_graph.Graph(self.branch.repository.texts)
2247
heads = graph.heads(maybe_file_parent_keys)
2248
file_parent_keys = []
2249
for key in maybe_file_parent_keys:
2251
file_parent_keys.append(key)
2253
# Now we have the parents of this content
2254
annotator = self.branch.repository.texts.get_annotator()
2255
text = self.get_file_text(file_id)
2256
this_key =(file_id, default_revision)
2257
annotator.add_special_text(this_key, file_parent_keys, text)
2258
annotations = [(key[-1], line)
2259
for key, line in annotator.annotate_flat(this_key)]
2263
def merge_modified(self):
2264
"""Return a dictionary of files modified by a merge.
2266
The list is initialized by WorkingTree.set_merge_modified, which is
2267
typically called after we make some automatic updates to the tree
2270
This returns a map of file_id->sha1, containing only files which are
2271
still in the working inventory and have that text hash.
2274
hashfile = self._transport.get('merge-hashes')
2275
except errors.NoSuchFile:
2280
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2281
raise errors.MergeModifiedFormatError()
2282
except StopIteration:
2283
raise errors.MergeModifiedFormatError()
2284
for s in _mod_rio.RioReader(hashfile):
2285
# RioReader reads in Unicode, so convert file_ids back to utf8
2286
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2287
if not self.inventory.has_id(file_id):
2289
text_hash = s.get("hash")
2290
if text_hash == self.get_file_sha1(file_id):
2291
merge_hashes[file_id] = text_hash
2297
def subsume(self, other_tree):
2298
def add_children(inventory, entry):
2299
for child_entry in entry.children.values():
2300
inventory._byid[child_entry.file_id] = child_entry
2301
if child_entry.kind == 'directory':
2302
add_children(inventory, child_entry)
2303
if other_tree.get_root_id() == self.get_root_id():
2304
raise errors.BadSubsumeSource(self, other_tree,
2305
'Trees have the same root')
2307
other_tree_path = self.relpath(other_tree.basedir)
2308
except errors.PathNotChild:
2309
raise errors.BadSubsumeSource(self, other_tree,
2310
'Tree is not contained by the other')
2311
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2312
if new_root_parent is None:
2313
raise errors.BadSubsumeSource(self, other_tree,
2314
'Parent directory is not versioned.')
2315
# We need to ensure that the result of a fetch will have a
2316
# versionedfile for the other_tree root, and only fetching into
2317
# RepositoryKnit2 guarantees that.
2318
if not self.branch.repository.supports_rich_root():
2319
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2320
other_tree.lock_tree_write()
2322
new_parents = other_tree.get_parent_ids()
2323
other_root = other_tree.inventory.root
2324
other_root.parent_id = new_root_parent
2325
other_root.name = osutils.basename(other_tree_path)
2326
self.inventory.add(other_root)
2327
add_children(self.inventory, other_root)
2328
self._write_inventory(self.inventory)
2329
# normally we don't want to fetch whole repositories, but i think
2330
# here we really do want to consolidate the whole thing.
2331
for parent_id in other_tree.get_parent_ids():
2332
self.branch.fetch(other_tree.branch, parent_id)
2333
self.add_parent_tree_id(parent_id)
2336
other_tree.bzrdir.retire_bzrdir()
2338
@needs_tree_write_lock
2339
def extract(self, file_id, format=None):
2340
"""Extract a subtree from this tree.
2342
A new branch will be created, relative to the path for this tree.
2346
segments = osutils.splitpath(path)
2347
transport = self.branch.bzrdir.root_transport
2348
for name in segments:
2349
transport = transport.clone(name)
2350
transport.ensure_base()
2353
sub_path = self.id2path(file_id)
2354
branch_transport = mkdirs(sub_path)
2356
format = self.bzrdir.cloning_metadir()
2357
branch_transport.ensure_base()
2358
branch_bzrdir = format.initialize_on_transport(branch_transport)
2360
repo = branch_bzrdir.find_repository()
2361
except errors.NoRepositoryPresent:
2362
repo = branch_bzrdir.create_repository()
2363
if not repo.supports_rich_root():
2364
raise errors.RootNotRich()
2365
new_branch = branch_bzrdir.create_branch()
2366
new_branch.pull(self.branch)
2367
for parent_id in self.get_parent_ids():
2368
new_branch.fetch(self.branch, parent_id)
2369
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2370
if tree_transport.base != branch_transport.base:
2371
tree_bzrdir = format.initialize_on_transport(tree_transport)
2372
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2373
target_branch=new_branch)
128
def list_files(self):
129
"""Recursively list all files as (path, class, kind, id).
2375
tree_bzrdir = branch_bzrdir
2376
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2377
wt.set_parent_ids(self.get_parent_ids())
2378
my_inv = self.inventory
2379
child_inv = inventory.Inventory(root_id=None)
2380
new_root = my_inv[file_id]
2381
my_inv.remove_recursive_id(file_id)
2382
new_root.parent_id = None
2383
child_inv.add(new_root)
2384
self._write_inventory(my_inv)
2385
wt._write_inventory(child_inv)
2388
def list_files(self, include_root=False, from_dir=None, recursive=True):
2389
"""List all files as (path, class, kind, id, entry).
131
2391
Lists, but does not descend into unversioned directories.
133
2392
This does not include files that have been deleted in this
2393
tree. Skips the control directory.
136
Skips the control directory.
2395
:param include_root: if True, return an entry for the root
2396
:param from_dir: start from this directory or None for the root
2397
:param recursive: whether to recurse into subdirectories or not
138
from osutils import appendpath, file_kind
141
inv = self._inventory
143
def descend(from_dir_relpath, from_dir_id, dp):
2399
# list_files is an iterator, so @needs_read_lock doesn't work properly
2400
# with it. So callers should be careful to always read_lock the tree.
2401
if not self.is_locked():
2402
raise errors.ObjectNotLocked(self)
2404
inv = self.inventory
2405
if from_dir is None and include_root is True:
2406
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2407
# Convert these into local objects to save lookup times
2408
pathjoin = osutils.pathjoin
2409
file_kind = self._kind
2411
# transport.base ends in a slash, we want the piece
2412
# between the last two slashes
2413
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2415
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2417
# directory file_id, relative path, absolute path, reverse sorted children
2418
if from_dir is not None:
2419
from_dir_id = inv.path2id(from_dir)
2420
if from_dir_id is None:
2421
# Directory not versioned
2423
from_dir_abspath = pathjoin(self.basedir, from_dir)
2425
from_dir_id = inv.root.file_id
2426
from_dir_abspath = self.basedir
2427
children = os.listdir(from_dir_abspath)
2429
# jam 20060527 The kernel sized tree seems equivalent whether we
2430
# use a deque and popleft to keep them sorted, or if we use a plain
2431
# list and just reverse() them.
2432
children = collections.deque(children)
2433
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2435
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2438
f = children.popleft()
147
2439
## TODO: If we find a subdirectory with its own .bzr
148
2440
## directory, then that is a separate tree and we
149
2441
## should exclude it.
150
if bzrlib.BZRDIR == f:
2443
# the bzrdir for this tree
2444
if transport_base_dir == f:
154
fp = appendpath(from_dir_relpath, f)
2447
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2448
# and 'f' doesn't begin with one, we can do a string op, rather
2449
# than the checks of pathjoin(), all relative paths will have an extra slash
2451
fp = from_dir_relpath + '/' + f
157
fap = appendpath(dp, f)
159
f_ie = inv.get_child(from_dir_id, f)
2454
fap = from_dir_abspath + '/' + f
2456
dir_ie = inv[from_dir_id]
2457
if dir_ie.kind == 'directory':
2458
f_ie = dir_ie.children.get(f)
162
elif self.is_ignored(fp):
2463
elif self.is_ignored(fp[1:]):
2466
# we may not have found this file, because of a unicode
2467
# issue, or because the directory was actually a symlink.
2468
f_norm, can_access = osutils.normalized_filename(f)
2469
if f == f_norm or not can_access:
2470
# No change, so treat this file normally
2473
# this file can be accessed by a normalized path
2474
# check again if it is versioned
2475
# these lines are repeated here for performance
2477
fp = from_dir_relpath + '/' + f
2478
fap = from_dir_abspath + '/' + f
2479
f_ie = inv.get_child(from_dir_id, f)
2482
elif self.is_ignored(fp[1:]):
167
2487
fk = file_kind(fap)
2489
# make a last minute entry
171
raise BzrCheckError("file %r entered as kind %r id %r, "
173
% (fap, f_ie.kind, f_ie.file_id, fk))
175
yield fp, c, fk, (f_ie and f_ie.file_id)
2491
yield fp[1:], c, fk, f_ie.file_id, f_ie
2494
yield fp[1:], c, fk, None, fk_entries[fk]()
2496
yield fp[1:], c, fk, None, TreeEntry()
177
2499
if fk != 'directory':
181
# don't descend unversioned directories
184
for ff in descend(fp, f_ie.file_id, fap):
187
for f in descend('', inv.root.file_id, self.basedir):
193
for subp in self.extras():
194
if not self.is_ignored(subp):
2502
# But do this child first if recursing down
2504
new_children = os.listdir(fap)
2506
new_children = collections.deque(new_children)
2507
stack.append((f_ie.file_id, fp, fap, new_children))
2508
# Break out of inner loop,
2509
# so that we start outer loop with child
2512
# if we finished all children, pop it off the stack
2515
@needs_tree_write_lock
2516
def move(self, from_paths, to_dir=None, after=False):
2519
to_dir must exist in the inventory.
2521
If to_dir exists and is a directory, the files are moved into
2522
it, keeping their old names.
2524
Note that to_dir is only the last component of the new name;
2525
this doesn't change the directory.
2527
For each entry in from_paths the move mode will be determined
2530
The first mode moves the file in the filesystem and updates the
2531
inventory. The second mode only updates the inventory without
2532
touching the file on the filesystem.
2534
move uses the second mode if 'after == True' and the target is
2535
either not versioned or newly added, and present in the working tree.
2537
move uses the second mode if 'after == False' and the source is
2538
versioned but no longer in the working tree, and the target is not
2539
versioned but present in the working tree.
2541
move uses the first mode if 'after == False' and the source is
2542
versioned and present in the working tree, and the target is not
2543
versioned and not present in the working tree.
2545
Everything else results in an error.
2547
This returns a list of (from_path, to_path) pairs for each
2548
entry that is moved.
2553
# check for deprecated use of signature
2555
raise TypeError('You must supply a target directory')
2556
# check destination directory
2557
if isinstance(from_paths, basestring):
2559
inv = self.inventory
2560
to_abs = self.abspath(to_dir)
2561
if not isdir(to_abs):
2562
raise errors.BzrMoveFailedError('',to_dir,
2563
errors.NotADirectory(to_abs))
2564
if not self.has_filename(to_dir):
2565
raise errors.BzrMoveFailedError('',to_dir,
2566
errors.NotInWorkingDirectory(to_dir))
2567
to_dir_id = inv.path2id(to_dir)
2568
if to_dir_id is None:
2569
raise errors.BzrMoveFailedError('',to_dir,
2570
errors.NotVersionedError(path=to_dir))
2572
to_dir_ie = inv[to_dir_id]
2573
if to_dir_ie.kind != 'directory':
2574
raise errors.BzrMoveFailedError('',to_dir,
2575
errors.NotADirectory(to_abs))
2577
# create rename entries and tuples
2578
for from_rel in from_paths:
2579
from_tail = splitpath(from_rel)[-1]
2580
from_id = inv.path2id(from_rel)
2582
raise errors.BzrMoveFailedError(from_rel,to_dir,
2583
errors.NotVersionedError(path=from_rel))
2585
from_entry = inv[from_id]
2586
from_parent_id = from_entry.parent_id
2587
to_rel = pathjoin(to_dir, from_tail)
2588
rename_entry = InventoryWorkingTree._RenameEntry(
2591
from_tail=from_tail,
2592
from_parent_id=from_parent_id,
2593
to_rel=to_rel, to_tail=from_tail,
2594
to_parent_id=to_dir_id)
2595
rename_entries.append(rename_entry)
2596
rename_tuples.append((from_rel, to_rel))
2598
# determine which move mode to use. checks also for movability
2599
rename_entries = self._determine_mv_mode(rename_entries, after)
2601
original_modified = self._inventory_is_modified
2604
self._inventory_is_modified = True
2605
self._move(rename_entries)
2607
# restore the inventory on error
2608
self._inventory_is_modified = original_modified
2610
self._write_inventory(inv)
2611
return rename_tuples
2613
@needs_tree_write_lock
2614
def rename_one(self, from_rel, to_rel, after=False):
2617
This can change the directory or the filename or both.
2619
rename_one has several 'modes' to work. First, it can rename a physical
2620
file and change the file_id. That is the normal mode. Second, it can
2621
only change the file_id without touching any physical file.
2623
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2624
versioned but present in the working tree.
2626
rename_one uses the second mode if 'after == False' and 'from_rel' is
2627
versioned but no longer in the working tree, and 'to_rel' is not
2628
versioned but present in the working tree.
2630
rename_one uses the first mode if 'after == False' and 'from_rel' is
2631
versioned and present in the working tree, and 'to_rel' is not
2632
versioned and not present in the working tree.
2634
Everything else results in an error.
2636
inv = self.inventory
2639
# create rename entries and tuples
2640
from_tail = splitpath(from_rel)[-1]
2641
from_id = inv.path2id(from_rel)
2643
# if file is missing in the inventory maybe it's in the basis_tree
2644
basis_tree = self.branch.basis_tree()
2645
from_id = basis_tree.path2id(from_rel)
2647
raise errors.BzrRenameFailedError(from_rel,to_rel,
2648
errors.NotVersionedError(path=from_rel))
2649
# put entry back in the inventory so we can rename it
2650
from_entry = basis_tree.inventory[from_id].copy()
2653
from_entry = inv[from_id]
2654
from_parent_id = from_entry.parent_id
2655
to_dir, to_tail = os.path.split(to_rel)
2656
to_dir_id = inv.path2id(to_dir)
2657
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2659
from_tail=from_tail,
2660
from_parent_id=from_parent_id,
2661
to_rel=to_rel, to_tail=to_tail,
2662
to_parent_id=to_dir_id)
2663
rename_entries.append(rename_entry)
2665
# determine which move mode to use. checks also for movability
2666
rename_entries = self._determine_mv_mode(rename_entries, after)
2668
# check if the target changed directory and if the target directory is
2670
if to_dir_id is None:
2671
raise errors.BzrMoveFailedError(from_rel,to_rel,
2672
errors.NotVersionedError(path=to_dir))
2674
# all checks done. now we can continue with our actual work
2675
mutter('rename_one:\n'
2680
' to_dir_id {%s}\n',
2681
from_id, from_rel, to_rel, to_dir, to_dir_id)
2683
self._move(rename_entries)
2684
self._write_inventory(inv)
2686
class _RenameEntry(object):
2687
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2688
to_rel, to_tail, to_parent_id, only_change_inv=False,
2690
self.from_rel = from_rel
2691
self.from_id = from_id
2692
self.from_tail = from_tail
2693
self.from_parent_id = from_parent_id
2694
self.to_rel = to_rel
2695
self.to_tail = to_tail
2696
self.to_parent_id = to_parent_id
2697
self.change_id = change_id
2698
self.only_change_inv = only_change_inv
2700
def _determine_mv_mode(self, rename_entries, after=False):
2701
"""Determines for each from-to pair if both inventory and working tree
2702
or only the inventory has to be changed.
2704
Also does basic plausability tests.
2706
inv = self.inventory
2708
for rename_entry in rename_entries:
2709
# store to local variables for easier reference
2710
from_rel = rename_entry.from_rel
2711
from_id = rename_entry.from_id
2712
to_rel = rename_entry.to_rel
2713
to_id = inv.path2id(to_rel)
2714
only_change_inv = False
2717
# check the inventory for source and destination
2719
raise errors.BzrMoveFailedError(from_rel,to_rel,
2720
errors.NotVersionedError(path=from_rel))
2721
if to_id is not None:
2723
# allow it with --after but only if dest is newly added
2725
basis = self.basis_tree()
2728
if not basis.has_id(to_id):
2729
rename_entry.change_id = True
2734
raise errors.BzrMoveFailedError(from_rel,to_rel,
2735
errors.AlreadyVersionedError(path=to_rel))
2737
# try to determine the mode for rename (only change inv or change
2738
# inv and file system)
2740
if not self.has_filename(to_rel):
2741
raise errors.BzrMoveFailedError(from_id,to_rel,
2742
errors.NoSuchFile(path=to_rel,
2743
extra="New file has not been created yet"))
2744
only_change_inv = True
2745
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2746
only_change_inv = True
2747
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2748
only_change_inv = False
2749
elif (not self.case_sensitive
2750
and from_rel.lower() == to_rel.lower()
2751
and self.has_filename(from_rel)):
2752
only_change_inv = False
2754
# something is wrong, so lets determine what exactly
2755
if not self.has_filename(from_rel) and \
2756
not self.has_filename(to_rel):
2757
raise errors.BzrRenameFailedError(from_rel,to_rel,
2758
errors.PathsDoNotExist(paths=(str(from_rel),
2761
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2762
rename_entry.only_change_inv = only_change_inv
2763
return rename_entries
2765
def _move(self, rename_entries):
2766
"""Moves a list of files.
2768
Depending on the value of the flag 'only_change_inv', the
2769
file will be moved on the file system or not.
2771
inv = self.inventory
2774
for entry in rename_entries:
2776
self._move_entry(entry)
2778
self._rollback_move(moved)
2782
def _rollback_move(self, moved):
2783
"""Try to rollback a previous move in case of an filesystem error."""
2784
inv = self.inventory
2787
self._move_entry(WorkingTree._RenameEntry(
2788
entry.to_rel, entry.from_id,
2789
entry.to_tail, entry.to_parent_id, entry.from_rel,
2790
entry.from_tail, entry.from_parent_id,
2791
entry.only_change_inv))
2792
except errors.BzrMoveFailedError, e:
2793
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2794
" The working tree is in an inconsistent state."
2795
" Please consider doing a 'bzr revert'."
2796
" Error message is: %s" % e)
2798
def _move_entry(self, entry):
2799
inv = self.inventory
2800
from_rel_abs = self.abspath(entry.from_rel)
2801
to_rel_abs = self.abspath(entry.to_rel)
2802
if from_rel_abs == to_rel_abs:
2803
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2804
"Source and target are identical.")
2806
if not entry.only_change_inv:
2808
osutils.rename(from_rel_abs, to_rel_abs)
2810
raise errors.BzrMoveFailedError(entry.from_rel,
2813
to_id = inv.path2id(entry.to_rel)
2814
inv.remove_recursive_id(to_id)
2815
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2817
@needs_tree_write_lock
2818
def unversion(self, file_ids):
2819
"""Remove the file ids in file_ids from the current versioned set.
2821
When a file_id is unversioned, all of its children are automatically
2824
:param file_ids: The file ids to stop versioning.
2825
:raises: NoSuchId if any fileid is not currently versioned.
2827
for file_id in file_ids:
2828
if not self._inventory.has_id(file_id):
2829
raise errors.NoSuchId(self, file_id)
2830
for file_id in file_ids:
2831
if self._inventory.has_id(file_id):
2832
self._inventory.remove_recursive_id(file_id)
2834
# in the future this should just set a dirty bit to wait for the
2835
# final unlock. However, until all methods of workingtree start
2836
# with the current in -memory inventory rather than triggering
2837
# a read, it is more complex - we need to teach read_inventory
2838
# to know when to read, and when to not read first... and possibly
2839
# to save first when the in memory one may be corrupted.
2840
# so for now, we just only write it if it is indeed dirty.
2842
self._write_inventory(self._inventory)
2844
def stored_kind(self, file_id):
2845
"""See Tree.stored_kind"""
2846
return self.inventory[file_id].kind
198
2848
def extras(self):
199
"""Yield all unknown files in this WorkingTree.
2849
"""Yield all unversioned files in this WorkingTree.
201
If there are any unknown directories then only the directory is
202
returned, not all its children. But if there are unknown files
2851
If there are any unversioned directories then only the directory is
2852
returned, not all its children. But if there are unversioned files
203
2853
under a versioned subdirectory, they are returned.
205
2855
Currently returned depth-first, sorted by name within directories.
2856
This is the same order used by 'osutils.walkdirs'.
207
2858
## TODO: Work from given directory downwards
208
from osutils import isdir, appendpath
210
2859
for path, dir_entry in self.inventory.directories():
211
mutter("search for unknowns in %r" % path)
2860
# mutter("search for unknowns in %r", path)
212
2861
dirabs = self.abspath(path)
213
2862
if not isdir(dirabs):
214
2863
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
