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).
32
from __future__ import absolute_import
34
from cStringIO import StringIO
27
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
28
from bzrlib.errors import BzrCheckError
29
from bzrlib.trace import mutter
31
class WorkingTree(bzrlib.tree.Tree):
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
40
from bisect import bisect_left
51
conflicts as _mod_conflicts,
54
filters as _mod_filters,
61
revision as _mod_revision,
73
# Explicitly import bzrlib.bzrdir so that the BzrProber
74
# is guaranteed to be registered.
77
from bzrlib import symbol_versioning
78
from bzrlib.decorators import needs_read_lock, needs_write_lock
79
from bzrlib.i18n import gettext
80
from bzrlib.lock import LogicalLockResult
81
import bzrlib.mutabletree
82
from bzrlib.mutabletree import needs_tree_write_lock
83
from bzrlib import osutils
84
from bzrlib.osutils import (
93
from bzrlib.trace import mutter, note
94
from bzrlib.revision import CURRENT_REVISION
95
from bzrlib.symbol_versioning import (
101
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
102
# TODO: Modifying the conflict objects or their type is currently nearly
103
# impossible as there is no clear relationship between the working tree format
104
# and the conflict list file format.
105
CONFLICT_HEADER_1 = "BZR conflict list format 1"
107
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
110
class TreeEntry(object):
111
"""An entry that implements the minimum interface used by commands.
113
This needs further inspection, it may be better to have
114
InventoryEntries without ids - though that seems wrong. For now,
115
this is a parallel hierarchy to InventoryEntry, and needs to become
116
one of several things: decorates to that hierarchy, children of, or
118
Another note is that these objects are currently only used when there is
119
no InventoryEntry available - i.e. for unversioned objects.
120
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
123
def __eq__(self, other):
124
# yes, this us ugly, TODO: best practice __eq__ style.
125
return (isinstance(other, TreeEntry)
126
and other.__class__ == self.__class__)
128
def kind_character(self):
132
class TreeDirectory(TreeEntry):
133
"""See TreeEntry. This is a directory in a working tree."""
135
def __eq__(self, other):
136
return (isinstance(other, TreeDirectory)
137
and other.__class__ == self.__class__)
139
def kind_character(self):
143
class TreeFile(TreeEntry):
144
"""See TreeEntry. This is a regular file in a working tree."""
146
def __eq__(self, other):
147
return (isinstance(other, TreeFile)
148
and other.__class__ == self.__class__)
150
def kind_character(self):
154
class TreeLink(TreeEntry):
155
"""See TreeEntry. This is a symlink in a working tree."""
157
def __eq__(self, other):
158
return (isinstance(other, TreeLink)
159
and other.__class__ == self.__class__)
161
def kind_character(self):
165
class WorkingTree(bzrlib.mutabletree.MutableTree,
166
controldir.ControlComponent):
32
167
"""Working copy tree.
169
:ivar basedir: The root of the tree on disk. This is a unicode path object
170
(as opposed to a URL).
173
# override this to set the strategy for storing views
174
def _make_views(self):
175
return views.DisabledViews(self)
177
def __init__(self, basedir='.',
178
branch=DEPRECATED_PARAMETER,
183
"""Construct a WorkingTree instance. This is not a public API.
185
:param branch: A branch to override probing for the branch.
187
self._format = _format
188
self.bzrdir = _bzrdir
190
raise errors.BzrError("Please use bzrdir.open_workingtree or "
191
"WorkingTree.open() to obtain a WorkingTree.")
192
basedir = safe_unicode(basedir)
193
mutter("opening working tree %r", basedir)
194
if deprecated_passed(branch):
195
self._branch = branch
197
self._branch = self.bzrdir.open_branch()
198
self.basedir = realpath(basedir)
199
self._transport = _transport
200
self._rules_searcher = None
201
self.views = self._make_views()
204
def user_transport(self):
205
return self.bzrdir.user_transport
208
def control_transport(self):
209
return self._transport
211
def is_control_filename(self, filename):
212
"""True if filename is the name of a control file in this tree.
214
:param filename: A filename within the tree. This is a relative path
215
from the root of this tree.
217
This is true IF and ONLY IF the filename is part of the meta data
218
that bzr controls in this tree. I.E. a random .bzr directory placed
219
on disk will not be a control file for this tree.
221
return self.bzrdir.is_control_filename(filename)
224
fget=lambda self: self._branch,
225
doc="""The branch this WorkingTree is connected to.
227
This cannot be set - it is reflective of the actual disk structure
228
the working tree has been constructed from.
231
def has_versioned_directories(self):
232
"""See `Tree.has_versioned_directories`."""
233
return self._format.supports_versioned_directories
235
def _supports_executable(self):
236
if sys.platform == 'win32':
238
# FIXME: Ideally this should check the file system
241
def break_lock(self):
242
"""Break a lock if one is present from another instance.
244
Uses the ui factory to ask for confirmation if the lock may be from
247
This will probe the repository for its lock as well.
249
raise NotImplementedError(self.break_lock)
251
def requires_rich_root(self):
252
return self._format.requires_rich_root
254
def supports_tree_reference(self):
257
def supports_content_filtering(self):
258
return self._format.supports_content_filtering()
260
def supports_views(self):
261
return self.views.supports_views()
264
def open(path=None, _unsupported=False):
265
"""Open an existing working tree at path.
269
path = osutils.getcwd()
270
control = controldir.ControlDir.open(path, _unsupported)
271
return control.open_workingtree(_unsupported)
274
def open_containing(path=None):
275
"""Open an existing working tree which has its root about path.
277
This probes for a working tree at path and searches upwards from there.
279
Basically we keep looking up until we find the control directory or
280
run into /. If there isn't one, raises NotBranchError.
281
TODO: give this a new exception.
282
If there is one, it is returned, along with the unused portion of path.
284
:return: The WorkingTree that contains 'path', and the rest of path
287
path = osutils.getcwd()
288
control, relpath = controldir.ControlDir.open_containing(path)
289
return control.open_workingtree(), relpath
292
def open_containing_paths(file_list, default_directory=None,
293
canonicalize=True, apply_view=True):
294
"""Open the WorkingTree that contains a set of paths.
296
Fail if the paths given are not all in a single tree.
298
This is used for the many command-line interfaces that take a list of
299
any number of files and that require they all be in the same tree.
301
if default_directory is None:
302
default_directory = u'.'
303
# recommended replacement for builtins.internal_tree_files
304
if file_list is None or len(file_list) == 0:
305
tree = WorkingTree.open_containing(default_directory)[0]
306
# XXX: doesn't really belong here, and seems to have the strange
307
# side effect of making it return a bunch of files, not the whole
308
# tree -- mbp 20100716
309
if tree.supports_views() and apply_view:
310
view_files = tree.views.lookup_view()
312
file_list = view_files
313
view_str = views.view_display_str(view_files)
314
note(gettext("Ignoring files outside view. View is %s") % view_str)
315
return tree, file_list
316
if default_directory == u'.':
319
seed = default_directory
320
file_list = [osutils.pathjoin(default_directory, f)
322
tree = WorkingTree.open_containing(seed)[0]
323
return tree, tree.safe_relpath_files(file_list, canonicalize,
324
apply_view=apply_view)
326
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
327
"""Convert file_list into a list of relpaths in tree.
329
:param self: A tree to operate on.
330
:param file_list: A list of user provided paths or None.
331
:param apply_view: if True and a view is set, apply it or check that
332
specified files are within it
333
:return: A list of relative paths.
334
:raises errors.PathNotChild: When a provided path is in a different self
337
if file_list is None:
339
if self.supports_views() and apply_view:
340
view_files = self.views.lookup_view()
344
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
345
# doesn't - fix that up here before we enter the loop.
347
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
350
for filename in file_list:
351
relpath = fixer(osutils.dereference_path(filename))
352
if view_files and not osutils.is_inside_any(view_files, relpath):
353
raise errors.FileOutsideView(filename, view_files)
354
new_list.append(relpath)
358
def open_downlevel(path=None):
359
"""Open an unsupported working tree.
361
Only intended for advanced situations like upgrading part of a bzrdir.
363
return WorkingTree.open(path, _unsupported=True)
366
def find_trees(location):
367
def list_current(transport):
368
return [d for d in transport.list_dir('') if d != '.bzr']
369
def evaluate(bzrdir):
371
tree = bzrdir.open_workingtree()
372
except errors.NoWorkingTree:
376
t = transport.get_transport(location)
377
iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
378
list_current=list_current)
379
return [tr for tr in iterator if tr is not None]
381
def all_file_ids(self):
382
"""See Tree.iter_all_file_ids"""
383
raise NotImplementedError(self.all_file_ids)
386
return "<%s of %s>" % (self.__class__.__name__,
387
getattr(self, 'basedir', None))
389
def abspath(self, filename):
390
return pathjoin(self.basedir, filename)
392
def basis_tree(self):
393
"""Return RevisionTree for the current last revision.
395
If the left most parent is a ghost then the returned tree will be an
396
empty tree - one obtained by calling
397
repository.revision_tree(NULL_REVISION).
400
revision_id = self.get_parent_ids()[0]
402
# no parents, return an empty revision tree.
403
# in the future this should return the tree for
404
# 'empty:' - the implicit root empty tree.
405
return self.branch.repository.revision_tree(
406
_mod_revision.NULL_REVISION)
408
return self.revision_tree(revision_id)
409
except errors.NoSuchRevision:
411
# No cached copy available, retrieve from the repository.
412
# FIXME? RBC 20060403 should we cache the inventory locally
415
return self.branch.repository.revision_tree(revision_id)
416
except (errors.RevisionNotPresent, errors.NoSuchRevision):
417
# the basis tree *may* be a ghost or a low level error may have
418
# occurred. If the revision is present, its a problem, if its not
420
if self.branch.repository.has_revision(revision_id):
422
# the basis tree is a ghost so return an empty tree.
423
return self.branch.repository.revision_tree(
424
_mod_revision.NULL_REVISION)
427
self._flush_ignore_list_cache()
429
def relpath(self, path):
430
"""Return the local path portion from a given path.
432
The path may be absolute or relative. If its a relative path it is
433
interpreted relative to the python current working directory.
435
return osutils.relpath(self.basedir, path)
437
def has_filename(self, filename):
438
return osutils.lexists(self.abspath(filename))
440
def get_file(self, file_id, path=None, filtered=True):
441
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
443
def get_file_with_stat(self, file_id, path=None, filtered=True,
444
_fstat=osutils.fstat):
445
"""See Tree.get_file_with_stat."""
447
path = self.id2path(file_id)
448
file_obj = self.get_file_byname(path, filtered=False)
449
stat_value = _fstat(file_obj.fileno())
450
if filtered and self.supports_content_filtering():
451
filters = self._content_filter_stack(path)
452
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
453
return (file_obj, stat_value)
455
def get_file_text(self, file_id, path=None, filtered=True):
456
my_file = self.get_file(file_id, path=path, filtered=filtered)
458
return my_file.read()
462
def get_file_byname(self, filename, filtered=True):
463
path = self.abspath(filename)
465
if filtered and self.supports_content_filtering():
466
filters = self._content_filter_stack(filename)
467
return _mod_filters.filtered_input_file(f, filters)
471
def get_file_lines(self, file_id, path=None, filtered=True):
472
"""See Tree.get_file_lines()"""
473
file = self.get_file(file_id, path, filtered=filtered)
475
return file.readlines()
479
def get_parent_ids(self):
480
"""See Tree.get_parent_ids.
482
This implementation reads the pending merges list and last_revision
483
value and uses that to decide what the parents list should be.
485
last_rev = _mod_revision.ensure_null(self._last_revision())
486
if _mod_revision.NULL_REVISION == last_rev:
491
merges_bytes = self._transport.get_bytes('pending-merges')
492
except errors.NoSuchFile:
495
for l in osutils.split_lines(merges_bytes):
496
revision_id = l.rstrip('\n')
497
parents.append(revision_id)
500
def get_root_id(self):
501
"""Return the id of this trees root"""
502
raise NotImplementedError(self.get_root_id)
505
def clone(self, to_controldir, revision_id=None):
506
"""Duplicate this working tree into to_bzr, including all state.
508
Specifically modified files are kept as modified, but
509
ignored and unknown files are discarded.
511
If you want to make a new line of development, see ControlDir.sprout()
514
If not None, the cloned tree will have its last revision set to
515
revision, and difference between the source trees last revision
516
and this one merged in.
518
# assumes the target bzr dir format is compatible.
519
result = to_controldir.create_workingtree()
520
self.copy_content_into(result, revision_id)
524
def copy_content_into(self, tree, revision_id=None):
525
"""Copy the current content and user files of this tree into tree."""
526
tree.set_root_id(self.get_root_id())
527
if revision_id is None:
528
merge.transform_tree(tree, self)
530
# TODO now merge from tree.last_revision to revision (to preserve
531
# user local changes)
532
merge.transform_tree(tree, self)
533
if revision_id == _mod_revision.NULL_REVISION:
536
new_parents = [revision_id]
537
tree.set_parent_ids(new_parents)
539
def id2abspath(self, file_id):
540
return self.abspath(self.id2path(file_id))
542
def _check_for_tree_references(self, iterator):
543
"""See if directories have become tree-references."""
544
blocked_parent_ids = set()
545
for path, ie in iterator:
546
if ie.parent_id in blocked_parent_ids:
547
# This entry was pruned because one of its parents became a
548
# TreeReference. If this is a directory, mark it as blocked.
549
if ie.kind == 'directory':
550
blocked_parent_ids.add(ie.file_id)
552
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
553
# This InventoryDirectory needs to be a TreeReference
554
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
555
blocked_parent_ids.add(ie.file_id)
558
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
559
"""See Tree.iter_entries_by_dir()"""
560
# The only trick here is that if we supports_tree_reference then we
561
# need to detect if a directory becomes a tree-reference.
562
iterator = super(WorkingTree, self).iter_entries_by_dir(
563
specific_file_ids=specific_file_ids,
564
yield_parents=yield_parents)
565
if not self.supports_tree_reference():
568
return self._check_for_tree_references(iterator)
570
def get_file_size(self, file_id):
571
"""See Tree.get_file_size"""
572
# XXX: this returns the on-disk size; it should probably return the
575
return os.path.getsize(self.id2abspath(file_id))
577
if e.errno != errno.ENOENT:
582
@needs_tree_write_lock
583
def _gather_kinds(self, files, kinds):
584
"""See MutableTree._gather_kinds."""
585
for pos, f in enumerate(files):
586
if kinds[pos] is None:
587
fullpath = normpath(self.abspath(f))
589
kinds[pos] = file_kind(fullpath)
591
if e.errno == errno.ENOENT:
592
raise errors.NoSuchFile(fullpath)
595
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
596
"""Add revision_id as a parent.
598
This is equivalent to retrieving the current list of parent ids
599
and setting the list to its value plus revision_id.
601
:param revision_id: The revision id to add to the parent list. It may
602
be a ghost revision as long as its not the first parent to be
603
added, or the allow_leftmost_as_ghost parameter is set True.
604
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
606
parents = self.get_parent_ids() + [revision_id]
607
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
608
or allow_leftmost_as_ghost)
610
@needs_tree_write_lock
611
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
612
"""Add revision_id, tree tuple as a parent.
614
This is equivalent to retrieving the current list of parent trees
615
and setting the list to its value plus parent_tuple. See also
616
add_parent_tree_id - if you only have a parent id available it will be
617
simpler to use that api. If you have the parent already available, using
618
this api is preferred.
620
:param parent_tuple: The (revision id, tree) to add to the parent list.
621
If the revision_id is a ghost, pass None for the tree.
622
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
624
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
625
if len(parent_ids) > 1:
626
# the leftmost may have already been a ghost, preserve that if it
628
allow_leftmost_as_ghost = True
629
self.set_parent_ids(parent_ids,
630
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
632
@needs_tree_write_lock
633
def add_pending_merge(self, *revision_ids):
634
# TODO: Perhaps should check at this point that the
635
# history of the revision is actually present?
636
parents = self.get_parent_ids()
638
for rev_id in revision_ids:
639
if rev_id in parents:
641
parents.append(rev_id)
644
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
646
def path_content_summary(self, path, _lstat=os.lstat,
647
_mapper=osutils.file_kind_from_stat_mode):
648
"""See Tree.path_content_summary."""
649
abspath = self.abspath(path)
651
stat_result = _lstat(abspath)
653
if getattr(e, 'errno', None) == errno.ENOENT:
655
return ('missing', None, None, None)
656
# propagate other errors
658
kind = _mapper(stat_result.st_mode)
660
return self._file_content_summary(path, stat_result)
661
elif kind == 'directory':
662
# perhaps it looks like a plain directory, but it's really a
664
if self._directory_is_tree_reference(path):
665
kind = 'tree-reference'
666
return kind, None, None, None
667
elif kind == 'symlink':
668
target = osutils.readlink(abspath)
669
return ('symlink', None, None, target)
671
return (kind, None, None, None)
673
def _file_content_summary(self, path, stat_result):
674
size = stat_result.st_size
675
executable = self._is_executable_from_path_and_stat(path, stat_result)
676
# try for a stat cache lookup
677
return ('file', size, executable, self._sha_from_stat(
680
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
681
"""Common ghost checking functionality from set_parent_*.
683
This checks that the left hand-parent exists if there are any
686
if len(revision_ids) > 0:
687
leftmost_id = revision_ids[0]
688
if (not allow_leftmost_as_ghost and not
689
self.branch.repository.has_revision(leftmost_id)):
690
raise errors.GhostRevisionUnusableHere(leftmost_id)
692
def _set_merges_from_parent_ids(self, parent_ids):
693
merges = parent_ids[1:]
694
self._transport.put_bytes('pending-merges', '\n'.join(merges),
695
mode=self.bzrdir._get_file_mode())
697
def _filter_parent_ids_by_ancestry(self, revision_ids):
698
"""Check that all merged revisions are proper 'heads'.
700
This will always return the first revision_id, and any merged revisions
703
if len(revision_ids) == 0:
705
graph = self.branch.repository.get_graph()
706
heads = graph.heads(revision_ids)
707
new_revision_ids = revision_ids[:1]
708
for revision_id in revision_ids[1:]:
709
if revision_id in heads and revision_id not in new_revision_ids:
710
new_revision_ids.append(revision_id)
711
if new_revision_ids != revision_ids:
712
mutter('requested to set revision_ids = %s,'
713
' but filtered to %s', revision_ids, new_revision_ids)
714
return new_revision_ids
716
@needs_tree_write_lock
717
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
718
"""Set the parent ids to revision_ids.
720
See also set_parent_trees. This api will try to retrieve the tree data
721
for each element of revision_ids from the trees repository. If you have
722
tree data already available, it is more efficient to use
723
set_parent_trees rather than set_parent_ids. set_parent_ids is however
724
an easier API to use.
726
:param revision_ids: The revision_ids to set as the parent ids of this
727
working tree. Any of these may be ghosts.
729
self._check_parents_for_ghosts(revision_ids,
730
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
731
for revision_id in revision_ids:
732
_mod_revision.check_not_reserved_id(revision_id)
734
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
736
if len(revision_ids) > 0:
737
self.set_last_revision(revision_ids[0])
739
self.set_last_revision(_mod_revision.NULL_REVISION)
741
self._set_merges_from_parent_ids(revision_ids)
743
@needs_tree_write_lock
744
def set_pending_merges(self, rev_list):
745
parents = self.get_parent_ids()
746
leftmost = parents[:1]
747
new_parents = leftmost + rev_list
748
self.set_parent_ids(new_parents)
750
@needs_tree_write_lock
751
def set_merge_modified(self, modified_hashes):
752
"""Set the merge modified hashes."""
753
raise NotImplementedError(self.set_merge_modified)
755
def _sha_from_stat(self, path, stat_result):
756
"""Get a sha digest from the tree's stat cache.
758
The default implementation assumes no stat cache is present.
760
:param path: The path.
761
:param stat_result: The stat result being looked up.
765
@needs_write_lock # because merge pulls data into the branch.
766
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
767
merge_type=None, force=False):
768
"""Merge from a branch into this working tree.
770
:param branch: The branch to merge from.
771
:param to_revision: If non-None, the merge will merge to to_revision,
772
but not beyond it. to_revision does not need to be in the history
773
of the branch when it is supplied. If None, to_revision defaults to
774
branch.last_revision().
776
from bzrlib.merge import Merger, Merge3Merger
777
merger = Merger(self.branch, this_tree=self)
778
# check that there are no local alterations
779
if not force and self.has_changes():
780
raise errors.UncommittedChanges(self)
781
if to_revision is None:
782
to_revision = _mod_revision.ensure_null(branch.last_revision())
783
merger.other_rev_id = to_revision
784
if _mod_revision.is_null(merger.other_rev_id):
785
raise errors.NoCommits(branch)
786
self.branch.fetch(branch, last_revision=merger.other_rev_id)
787
merger.other_basis = merger.other_rev_id
788
merger.other_tree = self.branch.repository.revision_tree(
790
merger.other_branch = branch
791
if from_revision is None:
794
merger.set_base_revision(from_revision, branch)
795
if merger.base_rev_id == merger.other_rev_id:
796
raise errors.PointlessMerge
797
merger.backup_files = False
798
if merge_type is None:
799
merger.merge_type = Merge3Merger
801
merger.merge_type = merge_type
802
merger.set_interesting_files(None)
803
merger.show_base = False
804
merger.reprocess = False
805
conflicts = merger.do_merge()
809
def merge_modified(self):
810
"""Return a dictionary of files modified by a merge.
812
The list is initialized by WorkingTree.set_merge_modified, which is
813
typically called after we make some automatic updates to the tree
816
This returns a map of file_id->sha1, containing only files which are
817
still in the working inventory and have that text hash.
819
raise NotImplementedError(self.merge_modified)
822
def mkdir(self, path, file_id=None):
823
"""See MutableTree.mkdir()."""
825
file_id = generate_ids.gen_file_id(os.path.basename(path))
826
os.mkdir(self.abspath(path))
827
self.add(path, file_id, 'directory')
830
def get_symlink_target(self, file_id, path=None):
832
abspath = self.abspath(path)
834
abspath = self.id2abspath(file_id)
835
target = osutils.readlink(abspath)
838
def subsume(self, other_tree):
839
raise NotImplementedError(self.subsume)
841
def _setup_directory_is_tree_reference(self):
842
if self._branch.repository._format.supports_tree_reference:
843
self._directory_is_tree_reference = \
844
self._directory_may_be_tree_reference
846
self._directory_is_tree_reference = \
847
self._directory_is_never_tree_reference
849
def _directory_is_never_tree_reference(self, relpath):
852
def _directory_may_be_tree_reference(self, relpath):
853
# as a special case, if a directory contains control files then
854
# it's a tree reference, except that the root of the tree is not
855
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
856
# TODO: We could ask all the control formats whether they
857
# recognize this directory, but at the moment there's no cheap api
858
# to do that. Since we probably can only nest bzr checkouts and
859
# they always use this name it's ok for now. -- mbp 20060306
861
# FIXME: There is an unhandled case here of a subdirectory
862
# containing .bzr but not a branch; that will probably blow up
863
# when you try to commit it. It might happen if there is a
864
# checkout in a subdirectory. This can be avoided by not adding
867
def extract(self, file_id, format=None):
868
"""Extract a subtree from this tree.
870
A new branch will be created, relative to the path for this tree.
872
raise NotImplementedError(self.extract)
875
"""Write the in memory meta data to disk."""
876
raise NotImplementedError(self.flush)
878
def _kind(self, relpath):
879
return osutils.file_kind(self.abspath(relpath))
881
def list_files(self, include_root=False, from_dir=None, recursive=True):
882
"""List all files as (path, class, kind, id, entry).
884
Lists, but does not descend into unversioned directories.
885
This does not include files that have been deleted in this
886
tree. Skips the control directory.
888
:param include_root: if True, return an entry for the root
889
:param from_dir: start from this directory or None for the root
890
:param recursive: whether to recurse into subdirectories or not
892
raise NotImplementedError(self.list_files)
894
def move(self, from_paths, to_dir=None, after=False):
897
to_dir must be known to the working tree.
899
If to_dir exists and is a directory, the files are moved into
900
it, keeping their old names.
902
Note that to_dir is only the last component of the new name;
903
this doesn't change the directory.
905
For each entry in from_paths the move mode will be determined
908
The first mode moves the file in the filesystem and updates the
909
working tree metadata. The second mode only updates the working tree
910
metadata without touching the file on the filesystem.
912
move uses the second mode if 'after == True' and the target is not
913
versioned but present in the working tree.
915
move uses the second mode if 'after == False' and the source is
916
versioned but no longer in the working tree, and the target is not
917
versioned but present in the working tree.
919
move uses the first mode if 'after == False' and the source is
920
versioned and present in the working tree, and the target is not
921
versioned and not present in the working tree.
923
Everything else results in an error.
925
This returns a list of (from_path, to_path) pairs for each
928
raise NotImplementedError(self.move)
930
@needs_tree_write_lock
931
def rename_one(self, from_rel, to_rel, after=False):
934
This can change the directory or the filename or both.
936
rename_one has several 'modes' to work. First, it can rename a physical
937
file and change the file_id. That is the normal mode. Second, it can
938
only change the file_id without touching any physical file.
940
rename_one uses the second mode if 'after == True' and 'to_rel' is
941
either not versioned or newly added, and present in the working tree.
943
rename_one uses the second mode if 'after == False' and 'from_rel' is
944
versioned but no longer in the working tree, and 'to_rel' is not
945
versioned but present in the working tree.
947
rename_one uses the first mode if 'after == False' and 'from_rel' is
948
versioned and present in the working tree, and 'to_rel' is not
949
versioned and not present in the working tree.
951
Everything else results in an error.
953
raise NotImplementedError(self.rename_one)
957
"""Return all unknown files.
959
These are files in the working directory that are not versioned or
960
control files or ignored.
962
# force the extras method to be fully executed before returning, to
963
# prevent race conditions with the lock
965
[subp for subp in self.extras() if not self.is_ignored(subp)])
967
def unversion(self, file_ids):
968
"""Remove the file ids in file_ids from the current versioned set.
970
When a file_id is unversioned, all of its children are automatically
973
:param file_ids: The file ids to stop versioning.
974
:raises: NoSuchId if any fileid is not currently versioned.
976
raise NotImplementedError(self.unversion)
979
def pull(self, source, overwrite=False, stop_revision=None,
980
change_reporter=None, possible_transports=None, local=False,
984
old_revision_info = self.branch.last_revision_info()
985
basis_tree = self.basis_tree()
986
count = self.branch.pull(source, overwrite, stop_revision,
987
possible_transports=possible_transports,
989
new_revision_info = self.branch.last_revision_info()
990
if new_revision_info != old_revision_info:
991
repository = self.branch.repository
992
if repository._format.fast_deltas:
993
parent_ids = self.get_parent_ids()
995
basis_id = parent_ids[0]
996
basis_tree = repository.revision_tree(basis_id)
997
basis_tree.lock_read()
999
new_basis_tree = self.branch.basis_tree()
1006
change_reporter=change_reporter,
1007
show_base=show_base)
1008
basis_root_id = basis_tree.get_root_id()
1009
new_root_id = new_basis_tree.get_root_id()
1010
if new_root_id is not None and basis_root_id != new_root_id:
1011
self.set_root_id(new_root_id)
1014
# TODO - dedup parents list with things merged by pull ?
1015
# reuse the revisiontree we merged against to set the new
1018
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1019
parent_trees.append(
1020
(self.branch.last_revision(), new_basis_tree))
1021
# we have to pull the merge trees out again, because
1022
# merge_inner has set the ids. - this corner is not yet
1023
# layered well enough to prevent double handling.
1024
# XXX TODO: Fix the double handling: telling the tree about
1025
# the already known parent data is wasteful.
1026
merges = self.get_parent_ids()[1:]
1027
parent_trees.extend([
1028
(parent, repository.revision_tree(parent)) for
1030
self.set_parent_trees(parent_trees)
1036
def put_file_bytes_non_atomic(self, file_id, bytes):
1037
"""See MutableTree.put_file_bytes_non_atomic."""
1038
stream = file(self.id2abspath(file_id), 'wb')
1045
"""Yield all unversioned files in this WorkingTree.
1047
If there are any unversioned directories then only the directory is
1048
returned, not all its children. But if there are unversioned files
1049
under a versioned subdirectory, they are returned.
1051
Currently returned depth-first, sorted by name within directories.
1052
This is the same order used by 'osutils.walkdirs'.
1054
raise NotImplementedError(self.extras)
1056
def ignored_files(self):
1057
"""Yield list of PATH, IGNORE_PATTERN"""
1058
for subp in self.extras():
1059
pat = self.is_ignored(subp)
1063
def get_ignore_list(self):
1064
"""Return list of ignore patterns.
1066
Cached in the Tree object after the first call.
1068
ignoreset = getattr(self, '_ignoreset', None)
1069
if ignoreset is not None:
1072
ignore_globs = set()
1073
ignore_globs.update(ignores.get_runtime_ignores())
1074
ignore_globs.update(ignores.get_user_ignores())
1075
if self.has_filename(bzrlib.IGNORE_FILENAME):
1076
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1078
ignore_globs.update(ignores.parse_ignore_file(f))
1081
self._ignoreset = ignore_globs
1084
def _flush_ignore_list_cache(self):
1085
"""Resets the cached ignore list to force a cache rebuild."""
1086
self._ignoreset = None
1087
self._ignoreglobster = None
1089
def is_ignored(self, filename):
1090
r"""Check whether the filename matches an ignore pattern.
1092
Patterns containing '/' or '\' need to match the whole path;
1093
others match against only the last component. Patterns starting
1094
with '!' are ignore exceptions. Exceptions take precedence
1095
over regular patterns and cause the filename to not be ignored.
1097
If the file is ignored, returns the pattern which caused it to
1098
be ignored, otherwise None. So this can simply be used as a
1099
boolean if desired."""
1100
if getattr(self, '_ignoreglobster', None) is None:
1101
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1102
return self._ignoreglobster.match(filename)
1104
def kind(self, file_id):
1105
return file_kind(self.id2abspath(file_id))
1107
def stored_kind(self, file_id):
1108
"""See Tree.stored_kind"""
1109
raise NotImplementedError(self.stored_kind)
1111
def _comparison_data(self, entry, path):
1112
abspath = self.abspath(path)
1114
stat_value = os.lstat(abspath)
1116
if getattr(e, 'errno', None) == errno.ENOENT:
1123
mode = stat_value.st_mode
1124
kind = osutils.file_kind_from_stat_mode(mode)
1125
if not self._supports_executable():
1126
executable = entry is not None and entry.executable
1128
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1129
return kind, executable, stat_value
1131
def _file_size(self, entry, stat_value):
1132
return stat_value.st_size
1134
def last_revision(self):
1135
"""Return the last revision of the branch for this tree.
1137
This format tree does not support a separate marker for last-revision
1138
compared to the branch.
1140
See MutableTree.last_revision
1142
return self._last_revision()
1145
def _last_revision(self):
1146
"""helper for get_parent_ids."""
1147
return _mod_revision.ensure_null(self.branch.last_revision())
1149
def is_locked(self):
1150
"""Check if this tree is locked."""
1151
raise NotImplementedError(self.is_locked)
1153
def lock_read(self):
1154
"""Lock the tree for reading.
1156
This also locks the branch, and can be unlocked via self.unlock().
1158
:return: A bzrlib.lock.LogicalLockResult.
1160
raise NotImplementedError(self.lock_read)
1162
def lock_tree_write(self):
1163
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1165
:return: A bzrlib.lock.LogicalLockResult.
1167
raise NotImplementedError(self.lock_tree_write)
1169
def lock_write(self):
1170
"""See MutableTree.lock_write, and WorkingTree.unlock.
1172
:return: A bzrlib.lock.LogicalLockResult.
1174
raise NotImplementedError(self.lock_write)
1176
def get_physical_lock_status(self):
1177
raise NotImplementedError(self.get_physical_lock_status)
1179
def set_last_revision(self, new_revision):
1180
"""Change the last revision in the working tree."""
1181
raise NotImplementedError(self.set_last_revision)
1183
def _change_last_revision(self, new_revision):
1184
"""Template method part of set_last_revision to perform the change.
1186
This is used to allow WorkingTree3 instances to not affect branch
1187
when their last revision is set.
1189
if _mod_revision.is_null(new_revision):
1190
self.branch.set_last_revision_info(0, new_revision)
1192
_mod_revision.check_not_reserved_id(new_revision)
1194
self.branch.generate_revision_history(new_revision)
1195
except errors.NoSuchRevision:
1196
# not present in the repo - dont try to set it deeper than the tip
1197
self.branch._set_revision_history([new_revision])
1200
@needs_tree_write_lock
1201
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1203
"""Remove nominated files from the working tree metadata.
1205
:files: File paths relative to the basedir.
1206
:keep_files: If true, the files will also be kept.
1207
:force: Delete files and directories, even if they are changed and
1208
even if the directories are not empty.
1210
if isinstance(files, basestring):
1215
all_files = set() # specified and nested files
1216
unknown_nested_files=set()
1218
to_file = sys.stdout
1220
files_to_backup = []
1222
def recurse_directory_to_add_files(directory):
1223
# Recurse directory and add all files
1224
# so we can check if they have changed.
1225
for parent_info, file_infos in self.walkdirs(directory):
1226
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1227
# Is it versioned or ignored?
1228
if self.path2id(relpath):
1229
# Add nested content for deletion.
1230
all_files.add(relpath)
1232
# Files which are not versioned
1233
# should be treated as unknown.
1234
files_to_backup.append(relpath)
1236
for filename in files:
1237
# Get file name into canonical form.
1238
abspath = self.abspath(filename)
1239
filename = self.relpath(abspath)
1240
if len(filename) > 0:
1241
all_files.add(filename)
1242
recurse_directory_to_add_files(filename)
1244
files = list(all_files)
1247
return # nothing to do
1249
# Sort needed to first handle directory content before the directory
1250
files.sort(reverse=True)
1252
# Bail out if we are going to delete files we shouldn't
1253
if not keep_files and not force:
1254
for (file_id, path, content_change, versioned, parent_id, name,
1255
kind, executable) in self.iter_changes(self.basis_tree(),
1256
include_unchanged=True, require_versioned=False,
1257
want_unversioned=True, specific_files=files):
1258
if versioned[0] == False:
1259
# The record is unknown or newly added
1260
files_to_backup.append(path[1])
1261
elif (content_change and (kind[1] is not None) and
1262
osutils.is_inside_any(files, path[1])):
1263
# Versioned and changed, but not deleted, and still
1264
# in one of the dirs to be deleted.
1265
files_to_backup.append(path[1])
1267
def backup(file_to_backup):
1268
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1269
osutils.rename(abs_path, self.abspath(backup_name))
1270
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1273
# Build inv_delta and delete files where applicable,
1274
# do this before any modifications to meta data.
1276
fid = self.path2id(f)
1279
message = "%s is not versioned." % (f,)
1282
# having removed it, it must be either ignored or unknown
1283
if self.is_ignored(f):
1287
# XXX: Really should be a more abstract reporter interface
1288
kind_ch = osutils.kind_marker(self.kind(fid))
1289
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1291
inv_delta.append((f, None, fid, None))
1292
message = "removed %s" % (f,)
1295
abs_path = self.abspath(f)
1296
if osutils.lexists(abs_path):
1297
if (osutils.isdir(abs_path) and
1298
len(os.listdir(abs_path)) > 0):
1300
osutils.rmtree(abs_path)
1301
message = "deleted %s" % (f,)
1305
if f in files_to_backup:
1308
osutils.delete_any(abs_path)
1309
message = "deleted %s" % (f,)
1310
elif message is not None:
1311
# Only care if we haven't done anything yet.
1312
message = "%s does not exist." % (f,)
1314
# Print only one message (if any) per file.
1315
if message is not None:
1317
self.apply_inventory_delta(inv_delta)
1319
@needs_tree_write_lock
1320
def revert(self, filenames=None, old_tree=None, backups=True,
1321
pb=None, report_changes=False):
1322
from bzrlib.conflicts import resolve
1323
if old_tree is None:
1324
basis_tree = self.basis_tree()
1325
basis_tree.lock_read()
1326
old_tree = basis_tree
1330
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1332
if filenames is None and len(self.get_parent_ids()) > 1:
1334
last_revision = self.last_revision()
1335
if last_revision != _mod_revision.NULL_REVISION:
1336
if basis_tree is None:
1337
basis_tree = self.basis_tree()
1338
basis_tree.lock_read()
1339
parent_trees.append((last_revision, basis_tree))
1340
self.set_parent_trees(parent_trees)
1343
resolve(self, filenames, ignore_misses=True, recursive=True)
1345
if basis_tree is not None:
1349
def revision_tree(self, revision_id):
1350
"""See Tree.revision_tree.
1352
WorkingTree can supply revision_trees for the basis revision only
1353
because there is only one cached inventory in the bzr directory.
1355
raise NotImplementedError(self.revision_tree)
1357
@needs_tree_write_lock
1358
def set_root_id(self, file_id):
1359
"""Set the root id for this tree."""
1363
'WorkingTree.set_root_id with fileid=None')
1364
file_id = osutils.safe_file_id(file_id)
1365
self._set_root_id(file_id)
1367
def _set_root_id(self, file_id):
1368
"""Set the root id for this tree, in a format specific manner.
1370
:param file_id: The file id to assign to the root. It must not be
1371
present in the current inventory or an error will occur. It must
1372
not be None, but rather a valid file id.
1374
raise NotImplementedError(self._set_root_id)
1377
"""See Branch.unlock.
1379
WorkingTree locking just uses the Branch locking facilities.
1380
This is current because all working trees have an embedded branch
1381
within them. IF in the future, we were to make branch data shareable
1382
between multiple working trees, i.e. via shared storage, then we
1383
would probably want to lock both the local tree, and the branch.
1385
raise NotImplementedError(self.unlock)
1389
def update(self, change_reporter=None, possible_transports=None,
1390
revision=None, old_tip=_marker, show_base=False):
1391
"""Update a working tree along its branch.
1393
This will update the branch if its bound too, which means we have
1394
multiple trees involved:
1396
- The new basis tree of the master.
1397
- The old basis tree of the branch.
1398
- The old basis tree of the working tree.
1399
- The current working tree state.
1401
Pathologically, all three may be different, and non-ancestors of each
1402
other. Conceptually we want to:
1404
- Preserve the wt.basis->wt.state changes
1405
- Transform the wt.basis to the new master basis.
1406
- Apply a merge of the old branch basis to get any 'local' changes from
1408
- Restore the wt.basis->wt.state changes.
1410
There isn't a single operation at the moment to do that, so we:
1412
- Merge current state -> basis tree of the master w.r.t. the old tree
1414
- Do a 'normal' merge of the old branch basis if it is relevant.
1416
:param revision: The target revision to update to. Must be in the
1418
:param old_tip: If branch.update() has already been run, the value it
1419
returned (old tip of the branch or None). _marker is used
1422
if self.branch.get_bound_location() is not None:
1424
update_branch = (old_tip is self._marker)
1426
self.lock_tree_write()
1427
update_branch = False
1430
old_tip = self.branch.update(possible_transports)
1432
if old_tip is self._marker:
1434
return self._update_tree(old_tip, change_reporter, revision, show_base)
1438
@needs_tree_write_lock
1439
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1441
"""Update a tree to the master branch.
1443
:param old_tip: if supplied, the previous tip revision the branch,
1444
before it was changed to the master branch's tip.
1446
# here if old_tip is not None, it is the old tip of the branch before
1447
# it was updated from the master branch. This should become a pending
1448
# merge in the working tree to preserve the user existing work. we
1449
# cant set that until we update the working trees last revision to be
1450
# one from the new branch, because it will just get absorbed by the
1451
# parent de-duplication logic.
1453
# We MUST save it even if an error occurs, because otherwise the users
1454
# local work is unreferenced and will appear to have been lost.
1458
last_rev = self.get_parent_ids()[0]
1460
last_rev = _mod_revision.NULL_REVISION
1461
if revision is None:
1462
revision = self.branch.last_revision()
1464
old_tip = old_tip or _mod_revision.NULL_REVISION
1466
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1467
# the branch we are bound to was updated
1468
# merge those changes in first
1469
base_tree = self.basis_tree()
1470
other_tree = self.branch.repository.revision_tree(old_tip)
1471
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1472
base_tree, this_tree=self,
1473
change_reporter=change_reporter,
1474
show_base=show_base)
1476
self.add_parent_tree((old_tip, other_tree))
1477
note(gettext('Rerun update after fixing the conflicts.'))
1480
if last_rev != _mod_revision.ensure_null(revision):
1481
# the working tree is up to date with the branch
1482
# we can merge the specified revision from master
1483
to_tree = self.branch.repository.revision_tree(revision)
1484
to_root_id = to_tree.get_root_id()
1486
basis = self.basis_tree()
1489
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1490
self.set_root_id(to_root_id)
1495
# determine the branch point
1496
graph = self.branch.repository.get_graph()
1497
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1499
base_tree = self.branch.repository.revision_tree(base_rev_id)
1501
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1503
change_reporter=change_reporter,
1504
show_base=show_base)
1505
self.set_last_revision(revision)
1506
# TODO - dedup parents list with things merged by pull ?
1507
# reuse the tree we've updated to to set the basis:
1508
parent_trees = [(revision, to_tree)]
1509
merges = self.get_parent_ids()[1:]
1510
# Ideally we ask the tree for the trees here, that way the working
1511
# tree can decide whether to give us the entire tree or give us a
1512
# lazy initialised tree. dirstate for instance will have the trees
1513
# in ram already, whereas a last-revision + basis-inventory tree
1514
# will not, but also does not need them when setting parents.
1515
for parent in merges:
1516
parent_trees.append(
1517
(parent, self.branch.repository.revision_tree(parent)))
1518
if not _mod_revision.is_null(old_tip):
1519
parent_trees.append(
1520
(old_tip, self.branch.repository.revision_tree(old_tip)))
1521
self.set_parent_trees(parent_trees)
1522
last_rev = parent_trees[0][0]
1525
def set_conflicts(self, arg):
1526
raise errors.UnsupportedOperation(self.set_conflicts, self)
1528
def add_conflicts(self, arg):
1529
raise errors.UnsupportedOperation(self.add_conflicts, self)
1531
def conflicts(self):
1532
raise NotImplementedError(self.conflicts)
1534
def walkdirs(self, prefix=""):
1535
"""Walk the directories of this tree.
1537
returns a generator which yields items in the form:
1538
((curren_directory_path, fileid),
1539
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1542
This API returns a generator, which is only valid during the current
1543
tree transaction - within a single lock_read or lock_write duration.
1545
If the tree is not locked, it may cause an error to be raised,
1546
depending on the tree implementation.
1548
disk_top = self.abspath(prefix)
1549
if disk_top.endswith('/'):
1550
disk_top = disk_top[:-1]
1551
top_strip_len = len(disk_top) + 1
1552
inventory_iterator = self._walkdirs(prefix)
1553
disk_iterator = osutils.walkdirs(disk_top, prefix)
1555
current_disk = disk_iterator.next()
1556
disk_finished = False
1558
if not (e.errno == errno.ENOENT or
1559
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1562
disk_finished = True
1564
current_inv = inventory_iterator.next()
1565
inv_finished = False
1566
except StopIteration:
1569
while not inv_finished or not disk_finished:
1571
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1572
cur_disk_dir_content) = current_disk
1574
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1575
cur_disk_dir_content) = ((None, None), None)
1576
if not disk_finished:
1577
# strip out .bzr dirs
1578
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1579
len(cur_disk_dir_content) > 0):
1580
# osutils.walkdirs can be made nicer -
1581
# yield the path-from-prefix rather than the pathjoined
1583
bzrdir_loc = bisect_left(cur_disk_dir_content,
1585
if (bzrdir_loc < len(cur_disk_dir_content)
1586
and self.bzrdir.is_control_filename(
1587
cur_disk_dir_content[bzrdir_loc][0])):
1588
# we dont yield the contents of, or, .bzr itself.
1589
del cur_disk_dir_content[bzrdir_loc]
1591
# everything is unknown
1594
# everything is missing
1597
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1599
# disk is before inventory - unknown
1600
dirblock = [(relpath, basename, kind, stat, None, None) for
1601
relpath, basename, kind, stat, top_path in
1602
cur_disk_dir_content]
1603
yield (cur_disk_dir_relpath, None), dirblock
1605
current_disk = disk_iterator.next()
1606
except StopIteration:
1607
disk_finished = True
1609
# inventory is before disk - missing.
1610
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1611
for relpath, basename, dkind, stat, fileid, kind in
1613
yield (current_inv[0][0], current_inv[0][1]), dirblock
1615
current_inv = inventory_iterator.next()
1616
except StopIteration:
1619
# versioned present directory
1620
# merge the inventory and disk data together
1622
for relpath, subiterator in itertools.groupby(sorted(
1623
current_inv[1] + cur_disk_dir_content,
1624
key=operator.itemgetter(0)), operator.itemgetter(1)):
1625
path_elements = list(subiterator)
1626
if len(path_elements) == 2:
1627
inv_row, disk_row = path_elements
1628
# versioned, present file
1629
dirblock.append((inv_row[0],
1630
inv_row[1], disk_row[2],
1631
disk_row[3], inv_row[4],
1633
elif len(path_elements[0]) == 5:
1635
dirblock.append((path_elements[0][0],
1636
path_elements[0][1], path_elements[0][2],
1637
path_elements[0][3], None, None))
1638
elif len(path_elements[0]) == 6:
1639
# versioned, absent file.
1640
dirblock.append((path_elements[0][0],
1641
path_elements[0][1], 'unknown', None,
1642
path_elements[0][4], path_elements[0][5]))
1644
raise NotImplementedError('unreachable code')
1645
yield current_inv[0], dirblock
1647
current_inv = inventory_iterator.next()
1648
except StopIteration:
1651
current_disk = disk_iterator.next()
1652
except StopIteration:
1653
disk_finished = True
1655
def _walkdirs(self, prefix=""):
1656
"""Walk the directories of this tree.
1658
:param prefix: is used as the directrory to start with.
1659
:returns: a generator which yields items in the form::
1661
((curren_directory_path, fileid),
1662
[(file1_path, file1_name, file1_kind, None, file1_id,
1665
raise NotImplementedError(self._walkdirs)
1667
@needs_tree_write_lock
1668
def auto_resolve(self):
1669
"""Automatically resolve text conflicts according to contents.
1671
Only text conflicts are auto_resolvable. Files with no conflict markers
1672
are considered 'resolved', because bzr always puts conflict markers
1673
into files that have text conflicts. The corresponding .THIS .BASE and
1674
.OTHER files are deleted, as per 'resolve'.
1676
:return: a tuple of ConflictLists: (un_resolved, resolved).
1678
un_resolved = _mod_conflicts.ConflictList()
1679
resolved = _mod_conflicts.ConflictList()
1680
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1681
for conflict in self.conflicts():
1682
if (conflict.typestring != 'text conflict' or
1683
self.kind(conflict.file_id) != 'file'):
1684
un_resolved.append(conflict)
1686
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1688
for line in my_file:
1689
if conflict_re.search(line):
1690
un_resolved.append(conflict)
1693
resolved.append(conflict)
1696
resolved.remove_files(self)
1697
self.set_conflicts(un_resolved)
1698
return un_resolved, resolved
1700
def _validate(self):
1701
"""Validate internal structures.
1703
This is meant mostly for the test suite. To give it a chance to detect
1704
corruption after actions have occurred. The default implementation is a
1707
:return: None. An exception should be raised if there is an error.
1711
def check_state(self):
1712
"""Check that the working state is/isn't valid."""
1713
raise NotImplementedError(self.check_state)
1715
def reset_state(self, revision_ids=None):
1716
"""Reset the state of the working tree.
1718
This does a hard-reset to a last-known-good state. This is a way to
1719
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1721
raise NotImplementedError(self.reset_state)
1723
def _get_rules_searcher(self, default_searcher):
1724
"""See Tree._get_rules_searcher."""
1725
if self._rules_searcher is None:
1726
self._rules_searcher = super(WorkingTree,
1727
self)._get_rules_searcher(default_searcher)
1728
return self._rules_searcher
1730
def get_shelf_manager(self):
1731
"""Return the ShelfManager for this WorkingTree."""
1732
from bzrlib.shelf import ShelfManager
1733
return ShelfManager(self, self._transport)
1736
class InventoryWorkingTree(WorkingTree,
1737
bzrlib.mutabletree.MutableInventoryTree):
1738
"""Base class for working trees that are inventory-oriented.
34
1740
The inventory is held in the `Branch` working-inventory, and the
35
1741
files are in a directory on disk.
37
1743
It is possible for a `WorkingTree` to have a filename which is
38
1744
not listed in the Inventory and vice versa.
40
def __init__(self, basedir, inv):
41
from bzrlib.hashcache import HashCache
42
from bzrlib.trace import note, mutter
1747
def __init__(self, basedir='.',
1748
branch=DEPRECATED_PARAMETER,
1750
_control_files=None,
1754
"""Construct a InventoryWorkingTree instance. This is not a public API.
1756
:param branch: A branch to override probing for the branch.
1758
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1759
branch=branch, _transport=_control_files._transport,
1760
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1762
self._control_files = _control_files
1763
self._detect_case_handling()
1765
if _inventory is None:
1766
# This will be acquired on lock_read() or lock_write()
1767
self._inventory_is_modified = False
1768
self._inventory = None
1770
# the caller of __init__ has provided an inventory,
1771
# we assume they know what they are doing - as its only
1772
# the Format factory and creation methods that are
1773
# permitted to do this.
1774
self._set_inventory(_inventory, dirty=False)
1776
def _set_inventory(self, inv, dirty):
1777
"""Set the internal cached inventory.
1779
:param inv: The inventory to set.
1780
:param dirty: A boolean indicating whether the inventory is the same
1781
logical inventory as whats on disk. If True the inventory is not
1782
the same and should be written to disk or data will be lost, if
1783
False then the inventory is the same as that on disk and any
1784
serialisation would be unneeded overhead.
44
1786
self._inventory = inv
45
self.basedir = basedir
46
self.path2id = inv.path2id
48
# update the whole cache up front and write to disk if anything changed;
49
# in the future we might want to do this more selectively
50
hc = self._hashcache = HashCache(basedir)
60
if self._hashcache.needs_write:
61
self._hashcache.write()
1787
self._inventory_is_modified = dirty
1789
def _detect_case_handling(self):
1790
wt_trans = self.bzrdir.get_workingtree_transport(None)
1792
wt_trans.stat(self._format.case_sensitive_filename)
1793
except errors.NoSuchFile:
1794
self.case_sensitive = True
1796
self.case_sensitive = False
1798
self._setup_directory_is_tree_reference()
1800
def _serialize(self, inventory, out_file):
1801
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1804
def _deserialize(selt, in_file):
1805
return xml5.serializer_v5.read_inventory(in_file)
1807
def break_lock(self):
1808
"""Break a lock if one is present from another instance.
1810
Uses the ui factory to ask for confirmation if the lock may be from
1813
This will probe the repository for its lock as well.
1815
self._control_files.break_lock()
1816
self.branch.break_lock()
1818
def is_locked(self):
1819
return self._control_files.is_locked()
1821
def _must_be_locked(self):
1822
if not self.is_locked():
1823
raise errors.ObjectNotLocked(self)
1825
def lock_read(self):
1826
"""Lock the tree for reading.
1828
This also locks the branch, and can be unlocked via self.unlock().
1830
:return: A bzrlib.lock.LogicalLockResult.
1832
if not self.is_locked():
1834
self.branch.lock_read()
1836
self._control_files.lock_read()
1837
return LogicalLockResult(self.unlock)
1839
self.branch.unlock()
1842
def lock_tree_write(self):
1843
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1845
:return: A bzrlib.lock.LogicalLockResult.
1847
if not self.is_locked():
1849
self.branch.lock_read()
1851
self._control_files.lock_write()
1852
return LogicalLockResult(self.unlock)
1854
self.branch.unlock()
1857
def lock_write(self):
1858
"""See MutableTree.lock_write, and WorkingTree.unlock.
1860
:return: A bzrlib.lock.LogicalLockResult.
1862
if not self.is_locked():
1864
self.branch.lock_write()
1866
self._control_files.lock_write()
1867
return LogicalLockResult(self.unlock)
1869
self.branch.unlock()
1872
def get_physical_lock_status(self):
1873
return self._control_files.get_physical_lock_status()
1875
@needs_tree_write_lock
1876
def _write_inventory(self, inv):
1877
"""Write inventory as the current inventory."""
1878
self._set_inventory(inv, dirty=True)
1881
# XXX: This method should be deprecated in favour of taking in a proper
1882
# new Inventory object.
1883
@needs_tree_write_lock
1884
def set_inventory(self, new_inventory_list):
1885
from bzrlib.inventory import (Inventory,
1889
inv = Inventory(self.get_root_id())
1890
for path, file_id, parent, kind in new_inventory_list:
1891
name = os.path.basename(path)
1894
# fixme, there should be a factory function inv,add_??
1895
if kind == 'directory':
1896
inv.add(InventoryDirectory(file_id, name, parent))
1897
elif kind == 'file':
1898
inv.add(InventoryFile(file_id, name, parent))
1899
elif kind == 'symlink':
1900
inv.add(InventoryLink(file_id, name, parent))
1902
raise errors.BzrError("unknown kind %r" % kind)
1903
self._write_inventory(inv)
1905
def _write_basis_inventory(self, xml):
1906
"""Write the basis inventory XML to the basis-inventory file"""
1907
path = self._basis_inventory_name()
1909
self._transport.put_file(path, sio,
1910
mode=self.bzrdir._get_file_mode())
1912
def _reset_data(self):
1913
"""Reset transient data that cannot be revalidated."""
1914
self._inventory_is_modified = False
1915
f = self._transport.get('inventory')
1917
result = self._deserialize(f)
1920
self._set_inventory(result, dirty=False)
1922
def _set_root_id(self, file_id):
1923
"""Set the root id for this tree, in a format specific manner.
1925
:param file_id: The file id to assign to the root. It must not be
1926
present in the current inventory or an error will occur. It must
1927
not be None, but rather a valid file id.
1929
inv = self._inventory
1930
orig_root_id = inv.root.file_id
1931
# TODO: it might be nice to exit early if there was nothing
1932
# to do, saving us from trigger a sync on unlock.
1933
self._inventory_is_modified = True
1934
# we preserve the root inventory entry object, but
1935
# unlinkit from the byid index
1936
del inv._byid[inv.root.file_id]
1937
inv.root.file_id = file_id
1938
# and link it into the index with the new changed id.
1939
inv._byid[inv.root.file_id] = inv.root
1940
# and finally update all children to reference the new id.
1941
# XXX: this should be safe to just look at the root.children
1942
# list, not the WHOLE INVENTORY.
1945
if entry.parent_id == orig_root_id:
1946
entry.parent_id = inv.root.file_id
1948
def all_file_ids(self):
1949
"""See Tree.iter_all_file_ids"""
1950
return set(self.inventory)
1952
@needs_tree_write_lock
1953
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1954
"""See MutableTree.set_parent_trees."""
1955
parent_ids = [rev for (rev, tree) in parents_list]
1956
for revision_id in parent_ids:
1957
_mod_revision.check_not_reserved_id(revision_id)
1959
self._check_parents_for_ghosts(parent_ids,
1960
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1962
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1964
if len(parent_ids) == 0:
1965
leftmost_parent_id = _mod_revision.NULL_REVISION
1966
leftmost_parent_tree = None
1968
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1970
if self._change_last_revision(leftmost_parent_id):
1971
if leftmost_parent_tree is None:
1972
# If we don't have a tree, fall back to reading the
1973
# parent tree from the repository.
1974
self._cache_basis_inventory(leftmost_parent_id)
1976
inv = leftmost_parent_tree.inventory
1977
xml = self._create_basis_xml_from_inventory(
1978
leftmost_parent_id, inv)
1979
self._write_basis_inventory(xml)
1980
self._set_merges_from_parent_ids(parent_ids)
1982
def _cache_basis_inventory(self, new_revision):
1983
"""Cache new_revision as the basis inventory."""
1984
# TODO: this should allow the ready-to-use inventory to be passed in,
1985
# as commit already has that ready-to-use [while the format is the
1988
# this double handles the inventory - unpack and repack -
1989
# but is easier to understand. We can/should put a conditional
1990
# in here based on whether the inventory is in the latest format
1991
# - perhaps we should repack all inventories on a repository
1993
# the fast path is to copy the raw xml from the repository. If the
1994
# xml contains 'revision_id="', then we assume the right
1995
# revision_id is set. We must check for this full string, because a
1996
# root node id can legitimately look like 'revision_id' but cannot
1998
xml = self.branch.repository._get_inventory_xml(new_revision)
1999
firstline = xml.split('\n', 1)[0]
2000
if (not 'revision_id="' in firstline or
2001
'format="7"' not in firstline):
2002
inv = self.branch.repository._serializer.read_inventory_from_string(
2004
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2005
self._write_basis_inventory(xml)
2006
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2009
def _basis_inventory_name(self):
2010
return 'basis-inventory-cache'
2012
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2013
"""Create the text that will be saved in basis-inventory"""
2014
inventory.revision_id = revision_id
2015
return xml7.serializer_v7.write_inventory_to_string(inventory)
2017
@needs_tree_write_lock
2018
def set_conflicts(self, conflicts):
2019
self._put_rio('conflicts', conflicts.to_stanzas(),
2022
@needs_tree_write_lock
2023
def add_conflicts(self, new_conflicts):
2024
conflict_set = set(self.conflicts())
2025
conflict_set.update(set(list(new_conflicts)))
2026
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2027
key=_mod_conflicts.Conflict.sort_key)))
2030
def conflicts(self):
2032
confile = self._transport.get('conflicts')
2033
except errors.NoSuchFile:
2034
return _mod_conflicts.ConflictList()
2037
if confile.next() != CONFLICT_HEADER_1 + '\n':
2038
raise errors.ConflictFormatError()
2039
except StopIteration:
2040
raise errors.ConflictFormatError()
2041
reader = _mod_rio.RioReader(confile)
2042
return _mod_conflicts.ConflictList.from_stanzas(reader)
2046
def read_basis_inventory(self):
2047
"""Read the cached basis inventory."""
2048
path = self._basis_inventory_name()
2049
return self._transport.get_bytes(path)
2052
def read_working_inventory(self):
2053
"""Read the working inventory.
2055
:raises errors.InventoryModified: read_working_inventory will fail
2056
when the current in memory inventory has been modified.
2058
# conceptually this should be an implementation detail of the tree.
2059
# XXX: Deprecate this.
2060
# ElementTree does its own conversion from UTF-8, so open in
2062
if self._inventory_is_modified:
2063
raise errors.InventoryModified(self)
2064
f = self._transport.get('inventory')
2066
result = self._deserialize(f)
2069
self._set_inventory(result, dirty=False)
2073
def get_root_id(self):
2074
"""Return the id of this trees root"""
2075
return self._inventory.root.file_id
2077
def has_id(self, file_id):
2078
# files that have been deleted are excluded
2079
inv = self.inventory
2080
if not inv.has_id(file_id):
2082
path = inv.id2path(file_id)
2083
return osutils.lexists(self.abspath(path))
2085
def has_or_had_id(self, file_id):
2086
if file_id == self.inventory.root.file_id:
2088
return self.inventory.has_id(file_id)
2090
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
64
2091
def __iter__(self):
65
2092
"""Iterate through file_ids for this tree.
70
2097
inv = self._inventory
71
2098
for path, ie in inv.iter_entries():
72
if os.path.exists(self.abspath(path)):
2099
if osutils.lexists(self.abspath(path)):
77
return "<%s of %s>" % (self.__class__.__name__,
78
getattr(self, 'basedir', None))
82
def abspath(self, filename):
83
return os.path.join(self.basedir, filename)
85
def has_filename(self, filename):
86
return os.path.exists(self.abspath(filename))
88
def get_file(self, file_id):
89
return self.get_file_byname(self.id2path(file_id))
91
def get_file_byname(self, filename):
92
return file(self.abspath(filename), 'rb')
94
def _get_store_filename(self, file_id):
95
## XXX: badly named; this isn't in the store at all
96
return self.abspath(self.id2path(file_id))
99
def has_id(self, file_id):
100
# files that have been deleted are excluded
101
inv = self._inventory
102
if not inv.has_id(file_id):
2102
@needs_tree_write_lock
2103
def set_last_revision(self, new_revision):
2104
"""Change the last revision in the working tree."""
2105
if self._change_last_revision(new_revision):
2106
self._cache_basis_inventory(new_revision)
2108
def _get_check_refs(self):
2109
"""Return the references needed to perform a check of this tree.
2111
The default implementation returns no refs, and is only suitable for
2112
trees that have no local caching and can commit on ghosts at any time.
2114
:seealso: bzrlib.check for details about check_refs.
2119
def _check(self, references):
2120
"""Check the tree for consistency.
2122
:param references: A dict with keys matching the items returned by
2123
self._get_check_refs(), and values from looking those keys up in
2126
tree_basis = self.basis_tree()
2127
tree_basis.lock_read()
2129
repo_basis = references[('trees', self.last_revision())]
2130
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2131
raise errors.BzrCheckError(
2132
"Mismatched basis inventory content.")
2138
def check_state(self):
2139
"""Check that the working state is/isn't valid."""
2140
check_refs = self._get_check_refs()
2142
for ref in check_refs:
2145
refs[ref] = self.branch.repository.revision_tree(value)
2148
@needs_tree_write_lock
2149
def reset_state(self, revision_ids=None):
2150
"""Reset the state of the working tree.
2152
This does a hard-reset to a last-known-good state. This is a way to
2153
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2155
if revision_ids is None:
2156
revision_ids = self.get_parent_ids()
2157
if not revision_ids:
2158
rt = self.branch.repository.revision_tree(
2159
_mod_revision.NULL_REVISION)
2161
rt = self.branch.repository.revision_tree(revision_ids[0])
2162
self._write_inventory(rt.inventory)
2163
self.set_parent_ids(revision_ids)
2166
"""Write the in memory inventory to disk."""
2167
# TODO: Maybe this should only write on dirty ?
2168
if self._control_files._lock_mode != 'w':
2169
raise errors.NotWriteLocked(self)
2171
self._serialize(self._inventory, sio)
2173
self._transport.put_file('inventory', sio,
2174
mode=self.bzrdir._get_file_mode())
2175
self._inventory_is_modified = False
2177
def get_file_mtime(self, file_id, path=None):
2178
"""See Tree.get_file_mtime."""
2180
path = self.inventory.id2path(file_id)
2182
return os.lstat(self.abspath(path)).st_mtime
2184
if e.errno == errno.ENOENT:
2185
raise errors.FileTimestampUnavailable(path)
2188
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2189
file_id = self.path2id(path)
2191
# For unversioned files on win32, we just assume they are not
104
path = inv.id2path(file_id)
105
return os.path.exists(self.abspath(path))
108
__contains__ = has_id
111
def get_file_size(self, file_id):
112
# is this still called?
113
raise NotImplementedError()
116
def get_file_sha1(self, file_id):
117
path = self._inventory.id2path(file_id)
118
return self._hashcache.get_sha1(path)
121
def file_class(self, filename):
122
if self.path2id(filename):
124
elif self.is_ignored(filename):
130
def list_files(self):
131
"""Recursively list all files as (path, class, kind, id).
2194
return self._inventory[file_id].executable
2196
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2197
mode = stat_result.st_mode
2198
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2200
def is_executable(self, file_id, path=None):
2201
if not self._supports_executable():
2202
return self._inventory[file_id].executable
2205
path = self.id2path(file_id)
2206
mode = os.lstat(self.abspath(path)).st_mode
2207
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2209
def _is_executable_from_path_and_stat(self, path, stat_result):
2210
if not self._supports_executable():
2211
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2213
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2215
@needs_tree_write_lock
2216
def _add(self, files, ids, kinds):
2217
"""See MutableTree._add."""
2218
# TODO: Re-adding a file that is removed in the working copy
2219
# should probably put it back with the previous ID.
2220
# the read and write working inventory should not occur in this
2221
# function - they should be part of lock_write and unlock.
2222
inv = self.inventory
2223
for f, file_id, kind in zip(files, ids, kinds):
2225
inv.add_path(f, kind=kind)
2227
inv.add_path(f, kind=kind, file_id=file_id)
2228
self._inventory_is_modified = True
2230
def revision_tree(self, revision_id):
2231
"""See WorkingTree.revision_id."""
2232
if revision_id == self.last_revision():
2234
xml = self.read_basis_inventory()
2235
except errors.NoSuchFile:
2239
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2240
# dont use the repository revision_tree api because we want
2241
# to supply the inventory.
2242
if inv.revision_id == revision_id:
2243
return revisiontree.InventoryRevisionTree(
2244
self.branch.repository, inv, revision_id)
2245
except errors.BadInventoryFormat:
2247
# raise if there was no inventory, or if we read the wrong inventory.
2248
raise errors.NoSuchRevisionInTree(self, revision_id)
2251
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2252
"""See Tree.annotate_iter
2254
This implementation will use the basis tree implementation if possible.
2255
Lines not in the basis are attributed to CURRENT_REVISION
2257
If there are pending merges, lines added by those merges will be
2258
incorrectly attributed to CURRENT_REVISION (but after committing, the
2259
attribution will be correct).
2261
maybe_file_parent_keys = []
2262
for parent_id in self.get_parent_ids():
2264
parent_tree = self.revision_tree(parent_id)
2265
except errors.NoSuchRevisionInTree:
2266
parent_tree = self.branch.repository.revision_tree(parent_id)
2267
parent_tree.lock_read()
2269
if not parent_tree.has_id(file_id):
2271
ie = parent_tree.inventory[file_id]
2272
if ie.kind != 'file':
2273
# Note: this is slightly unnecessary, because symlinks and
2274
# directories have a "text" which is the empty text, and we
2275
# know that won't mess up annotations. But it seems cleaner
2277
parent_text_key = (file_id, ie.revision)
2278
if parent_text_key not in maybe_file_parent_keys:
2279
maybe_file_parent_keys.append(parent_text_key)
2281
parent_tree.unlock()
2282
graph = _mod_graph.Graph(self.branch.repository.texts)
2283
heads = graph.heads(maybe_file_parent_keys)
2284
file_parent_keys = []
2285
for key in maybe_file_parent_keys:
2287
file_parent_keys.append(key)
2289
# Now we have the parents of this content
2290
annotator = self.branch.repository.texts.get_annotator()
2291
text = self.get_file_text(file_id)
2292
this_key =(file_id, default_revision)
2293
annotator.add_special_text(this_key, file_parent_keys, text)
2294
annotations = [(key[-1], line)
2295
for key, line in annotator.annotate_flat(this_key)]
2298
def _put_rio(self, filename, stanzas, header):
2299
self._must_be_locked()
2300
my_file = _mod_rio.rio_file(stanzas, header)
2301
self._transport.put_file(filename, my_file,
2302
mode=self.bzrdir._get_file_mode())
2304
@needs_tree_write_lock
2305
def set_merge_modified(self, modified_hashes):
2307
for file_id, hash in modified_hashes.iteritems():
2308
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2310
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2313
def merge_modified(self):
2314
"""Return a dictionary of files modified by a merge.
2316
The list is initialized by WorkingTree.set_merge_modified, which is
2317
typically called after we make some automatic updates to the tree
2320
This returns a map of file_id->sha1, containing only files which are
2321
still in the working inventory and have that text hash.
2324
hashfile = self._transport.get('merge-hashes')
2325
except errors.NoSuchFile:
2330
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2331
raise errors.MergeModifiedFormatError()
2332
except StopIteration:
2333
raise errors.MergeModifiedFormatError()
2334
for s in _mod_rio.RioReader(hashfile):
2335
# RioReader reads in Unicode, so convert file_ids back to utf8
2336
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2337
if not self.inventory.has_id(file_id):
2339
text_hash = s.get("hash")
2340
if text_hash == self.get_file_sha1(file_id):
2341
merge_hashes[file_id] = text_hash
2347
def subsume(self, other_tree):
2348
def add_children(inventory, entry):
2349
for child_entry in entry.children.values():
2350
inventory._byid[child_entry.file_id] = child_entry
2351
if child_entry.kind == 'directory':
2352
add_children(inventory, child_entry)
2353
if other_tree.get_root_id() == self.get_root_id():
2354
raise errors.BadSubsumeSource(self, other_tree,
2355
'Trees have the same root')
2357
other_tree_path = self.relpath(other_tree.basedir)
2358
except errors.PathNotChild:
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Tree is not contained by the other')
2361
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2362
if new_root_parent is None:
2363
raise errors.BadSubsumeSource(self, other_tree,
2364
'Parent directory is not versioned.')
2365
# We need to ensure that the result of a fetch will have a
2366
# versionedfile for the other_tree root, and only fetching into
2367
# RepositoryKnit2 guarantees that.
2368
if not self.branch.repository.supports_rich_root():
2369
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2370
other_tree.lock_tree_write()
2372
new_parents = other_tree.get_parent_ids()
2373
other_root = other_tree.inventory.root
2374
other_root.parent_id = new_root_parent
2375
other_root.name = osutils.basename(other_tree_path)
2376
self.inventory.add(other_root)
2377
add_children(self.inventory, other_root)
2378
self._write_inventory(self.inventory)
2379
# normally we don't want to fetch whole repositories, but i think
2380
# here we really do want to consolidate the whole thing.
2381
for parent_id in other_tree.get_parent_ids():
2382
self.branch.fetch(other_tree.branch, parent_id)
2383
self.add_parent_tree_id(parent_id)
2386
other_tree.bzrdir.retire_bzrdir()
2388
@needs_tree_write_lock
2389
def extract(self, file_id, format=None):
2390
"""Extract a subtree from this tree.
2392
A new branch will be created, relative to the path for this tree.
2396
segments = osutils.splitpath(path)
2397
transport = self.branch.bzrdir.root_transport
2398
for name in segments:
2399
transport = transport.clone(name)
2400
transport.ensure_base()
2403
sub_path = self.id2path(file_id)
2404
branch_transport = mkdirs(sub_path)
2406
format = self.bzrdir.cloning_metadir()
2407
branch_transport.ensure_base()
2408
branch_bzrdir = format.initialize_on_transport(branch_transport)
2410
repo = branch_bzrdir.find_repository()
2411
except errors.NoRepositoryPresent:
2412
repo = branch_bzrdir.create_repository()
2413
if not repo.supports_rich_root():
2414
raise errors.RootNotRich()
2415
new_branch = branch_bzrdir.create_branch()
2416
new_branch.pull(self.branch)
2417
for parent_id in self.get_parent_ids():
2418
new_branch.fetch(self.branch, parent_id)
2419
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2420
if tree_transport.base != branch_transport.base:
2421
tree_bzrdir = format.initialize_on_transport(tree_transport)
2422
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2423
target_branch=new_branch)
2425
tree_bzrdir = branch_bzrdir
2426
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2427
wt.set_parent_ids(self.get_parent_ids())
2428
my_inv = self.inventory
2429
child_inv = inventory.Inventory(root_id=None)
2430
new_root = my_inv[file_id]
2431
my_inv.remove_recursive_id(file_id)
2432
new_root.parent_id = None
2433
child_inv.add(new_root)
2434
self._write_inventory(my_inv)
2435
wt._write_inventory(child_inv)
2438
def list_files(self, include_root=False, from_dir=None, recursive=True):
2439
"""List all files as (path, class, kind, id, entry).
133
2441
Lists, but does not descend into unversioned directories.
135
2442
This does not include files that have been deleted in this
2443
tree. Skips the control directory.
138
Skips the control directory.
2445
:param include_root: if True, return an entry for the root
2446
:param from_dir: start from this directory or None for the root
2447
:param recursive: whether to recurse into subdirectories or not
140
inv = self._inventory
142
def descend(from_dir_relpath, from_dir_id, dp):
2449
# list_files is an iterator, so @needs_read_lock doesn't work properly
2450
# with it. So callers should be careful to always read_lock the tree.
2451
if not self.is_locked():
2452
raise errors.ObjectNotLocked(self)
2454
inv = self.inventory
2455
if from_dir is None and include_root is True:
2456
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2457
# Convert these into local objects to save lookup times
2458
pathjoin = osutils.pathjoin
2459
file_kind = self._kind
2461
# transport.base ends in a slash, we want the piece
2462
# between the last two slashes
2463
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2465
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2467
# directory file_id, relative path, absolute path, reverse sorted children
2468
if from_dir is not None:
2469
from_dir_id = inv.path2id(from_dir)
2470
if from_dir_id is None:
2471
# Directory not versioned
2473
from_dir_abspath = pathjoin(self.basedir, from_dir)
2475
from_dir_id = inv.root.file_id
2476
from_dir_abspath = self.basedir
2477
children = os.listdir(from_dir_abspath)
2479
# jam 20060527 The kernel sized tree seems equivalent whether we
2480
# use a deque and popleft to keep them sorted, or if we use a plain
2481
# list and just reverse() them.
2482
children = collections.deque(children)
2483
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2485
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2488
f = children.popleft()
146
2489
## TODO: If we find a subdirectory with its own .bzr
147
2490
## directory, then that is a separate tree and we
148
2491
## should exclude it.
149
if bzrlib.BZRDIR == f:
2493
# the bzrdir for this tree
2494
if transport_base_dir == f:
153
fp = appendpath(from_dir_relpath, f)
2497
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2498
# and 'f' doesn't begin with one, we can do a string op, rather
2499
# than the checks of pathjoin(), all relative paths will have an extra slash
2501
fp = from_dir_relpath + '/' + f
156
fap = appendpath(dp, f)
158
f_ie = inv.get_child(from_dir_id, f)
2504
fap = from_dir_abspath + '/' + f
2506
dir_ie = inv[from_dir_id]
2507
if dir_ie.kind == 'directory':
2508
f_ie = dir_ie.children.get(f)
161
elif self.is_ignored(fp):
2513
elif self.is_ignored(fp[1:]):
2516
# we may not have found this file, because of a unicode
2517
# issue, or because the directory was actually a symlink.
2518
f_norm, can_access = osutils.normalized_filename(f)
2519
if f == f_norm or not can_access:
2520
# No change, so treat this file normally
2523
# this file can be accessed by a normalized path
2524
# check again if it is versioned
2525
# these lines are repeated here for performance
2527
fp = from_dir_relpath + '/' + f
2528
fap = from_dir_abspath + '/' + f
2529
f_ie = inv.get_child(from_dir_id, f)
2532
elif self.is_ignored(fp[1:]):
166
2537
fk = file_kind(fap)
2539
# make a last minute entry
170
raise BzrCheckError("file %r entered as kind %r id %r, "
172
% (fap, f_ie.kind, f_ie.file_id, fk))
174
yield fp, c, fk, (f_ie and f_ie.file_id)
2541
yield fp[1:], c, fk, f_ie.file_id, f_ie
2544
yield fp[1:], c, fk, None, fk_entries[fk]()
2546
yield fp[1:], c, fk, None, TreeEntry()
176
2549
if fk != 'directory':
180
# don't descend unversioned directories
183
for ff in descend(fp, f_ie.file_id, fap):
186
for f in descend('', inv.root.file_id, self.basedir):
192
for subp in self.extras():
193
if not self.is_ignored(subp):
2552
# But do this child first if recursing down
2554
new_children = os.listdir(fap)
2556
new_children = collections.deque(new_children)
2557
stack.append((f_ie.file_id, fp, fap, new_children))
2558
# Break out of inner loop,
2559
# so that we start outer loop with child
2562
# if we finished all children, pop it off the stack
2565
@needs_tree_write_lock
2566
def move(self, from_paths, to_dir=None, after=False):
2569
to_dir must exist in the inventory.
2571
If to_dir exists and is a directory, the files are moved into
2572
it, keeping their old names.
2574
Note that to_dir is only the last component of the new name;
2575
this doesn't change the directory.
2577
For each entry in from_paths the move mode will be determined
2580
The first mode moves the file in the filesystem and updates the
2581
inventory. The second mode only updates the inventory without
2582
touching the file on the filesystem.
2584
move uses the second mode if 'after == True' and the target is
2585
either not versioned or newly added, and present in the working tree.
2587
move uses the second mode if 'after == False' and the source is
2588
versioned but no longer in the working tree, and the target is not
2589
versioned but present in the working tree.
2591
move uses the first mode if 'after == False' and the source is
2592
versioned and present in the working tree, and the target is not
2593
versioned and not present in the working tree.
2595
Everything else results in an error.
2597
This returns a list of (from_path, to_path) pairs for each
2598
entry that is moved.
2603
# check for deprecated use of signature
2605
raise TypeError('You must supply a target directory')
2606
# check destination directory
2607
if isinstance(from_paths, basestring):
2609
inv = self.inventory
2610
to_abs = self.abspath(to_dir)
2611
if not isdir(to_abs):
2612
raise errors.BzrMoveFailedError('',to_dir,
2613
errors.NotADirectory(to_abs))
2614
if not self.has_filename(to_dir):
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotInWorkingDirectory(to_dir))
2617
to_dir_id = inv.path2id(to_dir)
2618
if to_dir_id is None:
2619
raise errors.BzrMoveFailedError('',to_dir,
2620
errors.NotVersionedError(path=to_dir))
2622
to_dir_ie = inv[to_dir_id]
2623
if to_dir_ie.kind != 'directory':
2624
raise errors.BzrMoveFailedError('',to_dir,
2625
errors.NotADirectory(to_abs))
2627
# create rename entries and tuples
2628
for from_rel in from_paths:
2629
from_tail = splitpath(from_rel)[-1]
2630
from_id = inv.path2id(from_rel)
2632
raise errors.BzrMoveFailedError(from_rel,to_dir,
2633
errors.NotVersionedError(path=from_rel))
2635
from_entry = inv[from_id]
2636
from_parent_id = from_entry.parent_id
2637
to_rel = pathjoin(to_dir, from_tail)
2638
rename_entry = InventoryWorkingTree._RenameEntry(
2641
from_tail=from_tail,
2642
from_parent_id=from_parent_id,
2643
to_rel=to_rel, to_tail=from_tail,
2644
to_parent_id=to_dir_id)
2645
rename_entries.append(rename_entry)
2646
rename_tuples.append((from_rel, to_rel))
2648
# determine which move mode to use. checks also for movability
2649
rename_entries = self._determine_mv_mode(rename_entries, after)
2651
original_modified = self._inventory_is_modified
2654
self._inventory_is_modified = True
2655
self._move(rename_entries)
2657
# restore the inventory on error
2658
self._inventory_is_modified = original_modified
2660
self._write_inventory(inv)
2661
return rename_tuples
2663
@needs_tree_write_lock
2664
def rename_one(self, from_rel, to_rel, after=False):
2667
This can change the directory or the filename or both.
2669
rename_one has several 'modes' to work. First, it can rename a physical
2670
file and change the file_id. That is the normal mode. Second, it can
2671
only change the file_id without touching any physical file.
2673
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2674
versioned but present in the working tree.
2676
rename_one uses the second mode if 'after == False' and 'from_rel' is
2677
versioned but no longer in the working tree, and 'to_rel' is not
2678
versioned but present in the working tree.
2680
rename_one uses the first mode if 'after == False' and 'from_rel' is
2681
versioned and present in the working tree, and 'to_rel' is not
2682
versioned and not present in the working tree.
2684
Everything else results in an error.
2686
inv = self.inventory
2689
# create rename entries and tuples
2690
from_tail = splitpath(from_rel)[-1]
2691
from_id = inv.path2id(from_rel)
2693
# if file is missing in the inventory maybe it's in the basis_tree
2694
basis_tree = self.branch.basis_tree()
2695
from_id = basis_tree.path2id(from_rel)
2697
raise errors.BzrRenameFailedError(from_rel,to_rel,
2698
errors.NotVersionedError(path=from_rel))
2699
# put entry back in the inventory so we can rename it
2700
from_entry = basis_tree.inventory[from_id].copy()
2703
from_entry = inv[from_id]
2704
from_parent_id = from_entry.parent_id
2705
to_dir, to_tail = os.path.split(to_rel)
2706
to_dir_id = inv.path2id(to_dir)
2707
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2709
from_tail=from_tail,
2710
from_parent_id=from_parent_id,
2711
to_rel=to_rel, to_tail=to_tail,
2712
to_parent_id=to_dir_id)
2713
rename_entries.append(rename_entry)
2715
# determine which move mode to use. checks also for movability
2716
rename_entries = self._determine_mv_mode(rename_entries, after)
2718
# check if the target changed directory and if the target directory is
2720
if to_dir_id is None:
2721
raise errors.BzrMoveFailedError(from_rel,to_rel,
2722
errors.NotVersionedError(path=to_dir))
2724
# all checks done. now we can continue with our actual work
2725
mutter('rename_one:\n'
2730
' to_dir_id {%s}\n',
2731
from_id, from_rel, to_rel, to_dir, to_dir_id)
2733
self._move(rename_entries)
2734
self._write_inventory(inv)
2736
class _RenameEntry(object):
2737
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2738
to_rel, to_tail, to_parent_id, only_change_inv=False,
2740
self.from_rel = from_rel
2741
self.from_id = from_id
2742
self.from_tail = from_tail
2743
self.from_parent_id = from_parent_id
2744
self.to_rel = to_rel
2745
self.to_tail = to_tail
2746
self.to_parent_id = to_parent_id
2747
self.change_id = change_id
2748
self.only_change_inv = only_change_inv
2750
def _determine_mv_mode(self, rename_entries, after=False):
2751
"""Determines for each from-to pair if both inventory and working tree
2752
or only the inventory has to be changed.
2754
Also does basic plausability tests.
2756
inv = self.inventory
2758
for rename_entry in rename_entries:
2759
# store to local variables for easier reference
2760
from_rel = rename_entry.from_rel
2761
from_id = rename_entry.from_id
2762
to_rel = rename_entry.to_rel
2763
to_id = inv.path2id(to_rel)
2764
only_change_inv = False
2767
# check the inventory for source and destination
2769
raise errors.BzrMoveFailedError(from_rel,to_rel,
2770
errors.NotVersionedError(path=from_rel))
2771
if to_id is not None:
2773
# allow it with --after but only if dest is newly added
2775
basis = self.basis_tree()
2778
if not basis.has_id(to_id):
2779
rename_entry.change_id = True
2784
raise errors.BzrMoveFailedError(from_rel,to_rel,
2785
errors.AlreadyVersionedError(path=to_rel))
2787
# try to determine the mode for rename (only change inv or change
2788
# inv and file system)
2790
if not self.has_filename(to_rel):
2791
raise errors.BzrMoveFailedError(from_id,to_rel,
2792
errors.NoSuchFile(path=to_rel,
2793
extra="New file has not been created yet"))
2794
only_change_inv = True
2795
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2796
only_change_inv = True
2797
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2798
only_change_inv = False
2799
elif (not self.case_sensitive
2800
and from_rel.lower() == to_rel.lower()
2801
and self.has_filename(from_rel)):
2802
only_change_inv = False
2804
# something is wrong, so lets determine what exactly
2805
if not self.has_filename(from_rel) and \
2806
not self.has_filename(to_rel):
2807
raise errors.BzrRenameFailedError(from_rel, to_rel,
2808
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2810
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2811
rename_entry.only_change_inv = only_change_inv
2812
return rename_entries
2814
def _move(self, rename_entries):
2815
"""Moves a list of files.
2817
Depending on the value of the flag 'only_change_inv', the
2818
file will be moved on the file system or not.
2820
inv = self.inventory
2823
for entry in rename_entries:
2825
self._move_entry(entry)
2827
self._rollback_move(moved)
2831
def _rollback_move(self, moved):
2832
"""Try to rollback a previous move in case of an filesystem error."""
2833
inv = self.inventory
2836
self._move_entry(WorkingTree._RenameEntry(
2837
entry.to_rel, entry.from_id,
2838
entry.to_tail, entry.to_parent_id, entry.from_rel,
2839
entry.from_tail, entry.from_parent_id,
2840
entry.only_change_inv))
2841
except errors.BzrMoveFailedError, e:
2842
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2843
" The working tree is in an inconsistent state."
2844
" Please consider doing a 'bzr revert'."
2845
" Error message is: %s" % e)
2847
def _move_entry(self, entry):
2848
inv = self.inventory
2849
from_rel_abs = self.abspath(entry.from_rel)
2850
to_rel_abs = self.abspath(entry.to_rel)
2851
if from_rel_abs == to_rel_abs:
2852
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2853
"Source and target are identical.")
2855
if not entry.only_change_inv:
2857
osutils.rename(from_rel_abs, to_rel_abs)
2859
raise errors.BzrMoveFailedError(entry.from_rel,
2862
to_id = inv.path2id(entry.to_rel)
2863
inv.remove_recursive_id(to_id)
2864
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2866
@needs_tree_write_lock
2867
def unversion(self, file_ids):
2868
"""Remove the file ids in file_ids from the current versioned set.
2870
When a file_id is unversioned, all of its children are automatically
2873
:param file_ids: The file ids to stop versioning.
2874
:raises: NoSuchId if any fileid is not currently versioned.
2876
for file_id in file_ids:
2877
if not self._inventory.has_id(file_id):
2878
raise errors.NoSuchId(self, file_id)
2879
for file_id in file_ids:
2880
if self._inventory.has_id(file_id):
2881
self._inventory.remove_recursive_id(file_id)
2883
# in the future this should just set a dirty bit to wait for the
2884
# final unlock. However, until all methods of workingtree start
2885
# with the current in -memory inventory rather than triggering
2886
# a read, it is more complex - we need to teach read_inventory
2887
# to know when to read, and when to not read first... and possibly
2888
# to save first when the in memory one may be corrupted.
2889
# so for now, we just only write it if it is indeed dirty.
2891
self._write_inventory(self._inventory)
2893
def stored_kind(self, file_id):
2894
"""See Tree.stored_kind"""
2895
return self.inventory[file_id].kind
197
2897
def extras(self):
198
"""Yield all unknown files in this WorkingTree.
2898
"""Yield all unversioned files in this WorkingTree.
200
If there are any unknown directories then only the directory is
201
returned, not all its children. But if there are unknown files
2900
If there are any unversioned directories then only the directory is
2901
returned, not all its children. But if there are unversioned files
202
2902
under a versioned subdirectory, they are returned.
204
2904
Currently returned depth-first, sorted by name within directories.
2905
This is the same order used by 'osutils.walkdirs'.
206
2907
## TODO: Work from given directory downwards
207
2908
for path, dir_entry in self.inventory.directories():
208
mutter("search for unknowns in %r" % path)
2909
# mutter("search for unknowns in %r", path)
209
2910
dirabs = self.abspath(path)
210
2911
if not isdir(dirabs):
211
2912
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
