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
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
21
from errors import BzrCheckError
22
from trace import mutter
25
class WorkingTree(bzrlib.tree.Tree):
38
from bzrlib.lazy_import import lazy_import
39
lazy_import(globals(), """
40
from bisect import bisect_left
50
conflicts as _mod_conflicts,
53
filters as _mod_filters,
60
revision as _mod_revision,
72
# Explicitly import bzrlib.bzrdir so that the BzrProber
73
# is guaranteed to be registered.
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.i18n import gettext
81
from bzrlib.lock import LogicalLockResult
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
94
from bzrlib.trace import mutter, note
95
from bzrlib.revision import CURRENT_REVISION
96
from bzrlib.symbol_versioning import (
102
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
103
# TODO: Modifying the conflict objects or their type is currently nearly
104
# impossible as there is no clear relationship between the working tree format
105
# and the conflict list file format.
106
CONFLICT_HEADER_1 = "BZR conflict list format 1"
108
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
111
class TreeEntry(object):
112
"""An entry that implements the minimum interface used by commands.
114
This needs further inspection, it may be better to have
115
InventoryEntries without ids - though that seems wrong. For now,
116
this is a parallel hierarchy to InventoryEntry, and needs to become
117
one of several things: decorates to that hierarchy, children of, or
119
Another note is that these objects are currently only used when there is
120
no InventoryEntry available - i.e. for unversioned objects.
121
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
124
def __eq__(self, other):
125
# yes, this us ugly, TODO: best practice __eq__ style.
126
return (isinstance(other, TreeEntry)
127
and other.__class__ == self.__class__)
129
def kind_character(self):
133
class TreeDirectory(TreeEntry):
134
"""See TreeEntry. This is a directory in a working tree."""
136
def __eq__(self, other):
137
return (isinstance(other, TreeDirectory)
138
and other.__class__ == self.__class__)
140
def kind_character(self):
144
class TreeFile(TreeEntry):
145
"""See TreeEntry. This is a regular file in a working tree."""
147
def __eq__(self, other):
148
return (isinstance(other, TreeFile)
149
and other.__class__ == self.__class__)
151
def kind_character(self):
155
class TreeLink(TreeEntry):
156
"""See TreeEntry. This is a symlink in a working tree."""
158
def __eq__(self, other):
159
return (isinstance(other, TreeLink)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class WorkingTree(bzrlib.mutabletree.MutableTree,
167
controldir.ControlComponent):
26
168
"""Working copy tree.
170
:ivar basedir: The root of the tree on disk. This is a unicode path object
171
(as opposed to a URL).
174
# override this to set the strategy for storing views
175
def _make_views(self):
176
return views.DisabledViews(self)
178
def __init__(self, basedir='.',
179
branch=DEPRECATED_PARAMETER,
184
"""Construct a WorkingTree instance. This is not a public API.
186
:param branch: A branch to override probing for the branch.
188
self._format = _format
189
self.bzrdir = _bzrdir
191
raise errors.BzrError("Please use bzrdir.open_workingtree or "
192
"WorkingTree.open() to obtain a WorkingTree.")
193
basedir = safe_unicode(basedir)
194
mutter("opening working tree %r", basedir)
195
if deprecated_passed(branch):
196
self._branch = branch
198
self._branch = self.bzrdir.open_branch()
199
self.basedir = realpath(basedir)
200
self._transport = _transport
201
self._rules_searcher = None
202
self.views = self._make_views()
205
def user_transport(self):
206
return self.bzrdir.user_transport
209
def control_transport(self):
210
return self._transport
212
def is_control_filename(self, filename):
213
"""True if filename is the name of a control file in this tree.
215
:param filename: A filename within the tree. This is a relative path
216
from the root of this tree.
218
This is true IF and ONLY IF the filename is part of the meta data
219
that bzr controls in this tree. I.E. a random .bzr directory placed
220
on disk will not be a control file for this tree.
222
return self.bzrdir.is_control_filename(filename)
225
fget=lambda self: self._branch,
226
doc="""The branch this WorkingTree is connected to.
228
This cannot be set - it is reflective of the actual disk structure
229
the working tree has been constructed from.
232
def has_versioned_directories(self):
233
"""See `Tree.has_versioned_directories`."""
234
return self._format.supports_versioned_directories
236
def _supports_executable(self):
237
if sys.platform == 'win32':
239
# FIXME: Ideally this should check the file system
242
def break_lock(self):
243
"""Break a lock if one is present from another instance.
245
Uses the ui factory to ask for confirmation if the lock may be from
248
This will probe the repository for its lock as well.
250
raise NotImplementedError(self.break_lock)
252
def requires_rich_root(self):
253
return self._format.requires_rich_root
255
def supports_tree_reference(self):
258
def supports_content_filtering(self):
259
return self._format.supports_content_filtering()
261
def supports_views(self):
262
return self.views.supports_views()
265
def open(path=None, _unsupported=False):
266
"""Open an existing working tree at path.
270
path = osutils.getcwd()
271
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
272
return control.open_workingtree(unsupported=_unsupported)
275
def open_containing(path=None):
276
"""Open an existing working tree which has its root about path.
278
This probes for a working tree at path and searches upwards from there.
280
Basically we keep looking up until we find the control directory or
281
run into /. If there isn't one, raises NotBranchError.
282
TODO: give this a new exception.
283
If there is one, it is returned, along with the unused portion of path.
285
:return: The WorkingTree that contains 'path', and the rest of path
288
path = osutils.getcwd()
289
control, relpath = controldir.ControlDir.open_containing(path)
290
return control.open_workingtree(), relpath
293
def open_containing_paths(file_list, default_directory=None,
294
canonicalize=True, apply_view=True):
295
"""Open the WorkingTree that contains a set of paths.
297
Fail if the paths given are not all in a single tree.
299
This is used for the many command-line interfaces that take a list of
300
any number of files and that require they all be in the same tree.
302
if default_directory is None:
303
default_directory = u'.'
304
# recommended replacement for builtins.internal_tree_files
305
if file_list is None or len(file_list) == 0:
306
tree = WorkingTree.open_containing(default_directory)[0]
307
# XXX: doesn't really belong here, and seems to have the strange
308
# side effect of making it return a bunch of files, not the whole
309
# tree -- mbp 20100716
310
if tree.supports_views() and apply_view:
311
view_files = tree.views.lookup_view()
313
file_list = view_files
314
view_str = views.view_display_str(view_files)
315
note(gettext("Ignoring files outside view. View is %s") % view_str)
316
return tree, file_list
317
if default_directory == u'.':
320
seed = default_directory
321
file_list = [osutils.pathjoin(default_directory, f)
323
tree = WorkingTree.open_containing(seed)[0]
324
return tree, tree.safe_relpath_files(file_list, canonicalize,
325
apply_view=apply_view)
327
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
328
"""Convert file_list into a list of relpaths in tree.
330
:param self: A tree to operate on.
331
:param file_list: A list of user provided paths or None.
332
:param apply_view: if True and a view is set, apply it or check that
333
specified files are within it
334
:return: A list of relative paths.
335
:raises errors.PathNotChild: When a provided path is in a different self
338
if file_list is None:
340
if self.supports_views() and apply_view:
341
view_files = self.views.lookup_view()
345
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
346
# doesn't - fix that up here before we enter the loop.
348
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
351
for filename in file_list:
352
relpath = fixer(osutils.dereference_path(filename))
353
if view_files and not osutils.is_inside_any(view_files, relpath):
354
raise errors.FileOutsideView(filename, view_files)
355
new_list.append(relpath)
359
def open_downlevel(path=None):
360
"""Open an unsupported working tree.
362
Only intended for advanced situations like upgrading part of a bzrdir.
364
return WorkingTree.open(path, _unsupported=True)
367
def find_trees(location):
368
def list_current(transport):
369
return [d for d in transport.list_dir('') if d != '.bzr']
370
def evaluate(bzrdir):
372
tree = bzrdir.open_workingtree()
373
except errors.NoWorkingTree:
377
t = transport.get_transport(location)
378
iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
379
list_current=list_current)
380
return [tr for tr in iterator if tr is not None]
382
def all_file_ids(self):
383
"""See Tree.iter_all_file_ids"""
384
raise NotImplementedError(self.all_file_ids)
387
return "<%s of %s>" % (self.__class__.__name__,
388
getattr(self, 'basedir', None))
390
def abspath(self, filename):
391
return pathjoin(self.basedir, filename)
393
def basis_tree(self):
394
"""Return RevisionTree for the current last revision.
396
If the left most parent is a ghost then the returned tree will be an
397
empty tree - one obtained by calling
398
repository.revision_tree(NULL_REVISION).
401
revision_id = self.get_parent_ids()[0]
403
# no parents, return an empty revision tree.
404
# in the future this should return the tree for
405
# 'empty:' - the implicit root empty tree.
406
return self.branch.repository.revision_tree(
407
_mod_revision.NULL_REVISION)
409
return self.revision_tree(revision_id)
410
except errors.NoSuchRevision:
412
# No cached copy available, retrieve from the repository.
413
# FIXME? RBC 20060403 should we cache the inventory locally
416
return self.branch.repository.revision_tree(revision_id)
417
except (errors.RevisionNotPresent, errors.NoSuchRevision):
418
# the basis tree *may* be a ghost or a low level error may have
419
# occurred. If the revision is present, its a problem, if its not
421
if self.branch.repository.has_revision(revision_id):
423
# the basis tree is a ghost so return an empty tree.
424
return self.branch.repository.revision_tree(
425
_mod_revision.NULL_REVISION)
428
self._flush_ignore_list_cache()
430
def relpath(self, path):
431
"""Return the local path portion from a given path.
433
The path may be absolute or relative. If its a relative path it is
434
interpreted relative to the python current working directory.
436
return osutils.relpath(self.basedir, path)
438
def has_filename(self, filename):
439
return osutils.lexists(self.abspath(filename))
441
def get_file(self, file_id, path=None, filtered=True):
442
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
444
def get_file_with_stat(self, file_id, path=None, filtered=True,
445
_fstat=osutils.fstat):
446
"""See Tree.get_file_with_stat."""
448
path = self.id2path(file_id)
449
file_obj = self.get_file_byname(path, filtered=False)
450
stat_value = _fstat(file_obj.fileno())
451
if filtered and self.supports_content_filtering():
452
filters = self._content_filter_stack(path)
453
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
454
return (file_obj, stat_value)
456
def get_file_text(self, file_id, path=None, filtered=True):
457
my_file = self.get_file(file_id, path=path, filtered=filtered)
459
return my_file.read()
463
def get_file_byname(self, filename, filtered=True):
464
path = self.abspath(filename)
466
if filtered and self.supports_content_filtering():
467
filters = self._content_filter_stack(filename)
468
return _mod_filters.filtered_input_file(f, filters)
472
def get_file_lines(self, file_id, path=None, filtered=True):
473
"""See Tree.get_file_lines()"""
474
file = self.get_file(file_id, path, filtered=filtered)
476
return file.readlines()
480
def get_parent_ids(self):
481
"""See Tree.get_parent_ids.
483
This implementation reads the pending merges list and last_revision
484
value and uses that to decide what the parents list should be.
486
last_rev = _mod_revision.ensure_null(self._last_revision())
487
if _mod_revision.NULL_REVISION == last_rev:
492
merges_bytes = self._transport.get_bytes('pending-merges')
493
except errors.NoSuchFile:
496
for l in osutils.split_lines(merges_bytes):
497
revision_id = l.rstrip('\n')
498
parents.append(revision_id)
501
def get_root_id(self):
502
"""Return the id of this trees root"""
503
raise NotImplementedError(self.get_root_id)
506
def clone(self, to_controldir, revision_id=None):
507
"""Duplicate this working tree into to_bzr, including all state.
509
Specifically modified files are kept as modified, but
510
ignored and unknown files are discarded.
512
If you want to make a new line of development, see ControlDir.sprout()
515
If not None, the cloned tree will have its last revision set to
516
revision, and difference between the source trees last revision
517
and this one merged in.
519
# assumes the target bzr dir format is compatible.
520
result = to_controldir.create_workingtree()
521
self.copy_content_into(result, revision_id)
525
def copy_content_into(self, tree, revision_id=None):
526
"""Copy the current content and user files of this tree into tree."""
527
tree.set_root_id(self.get_root_id())
528
if revision_id is None:
529
merge.transform_tree(tree, self)
531
# TODO now merge from tree.last_revision to revision (to preserve
532
# user local changes)
533
merge.transform_tree(tree, self)
534
if revision_id == _mod_revision.NULL_REVISION:
537
new_parents = [revision_id]
538
tree.set_parent_ids(new_parents)
540
def id2abspath(self, file_id):
541
return self.abspath(self.id2path(file_id))
543
def _check_for_tree_references(self, iterator):
544
"""See if directories have become tree-references."""
545
blocked_parent_ids = set()
546
for path, ie in iterator:
547
if ie.parent_id in blocked_parent_ids:
548
# This entry was pruned because one of its parents became a
549
# TreeReference. If this is a directory, mark it as blocked.
550
if ie.kind == 'directory':
551
blocked_parent_ids.add(ie.file_id)
553
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
554
# This InventoryDirectory needs to be a TreeReference
555
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
556
blocked_parent_ids.add(ie.file_id)
559
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
560
"""See Tree.iter_entries_by_dir()"""
561
# The only trick here is that if we supports_tree_reference then we
562
# need to detect if a directory becomes a tree-reference.
563
iterator = super(WorkingTree, self).iter_entries_by_dir(
564
specific_file_ids=specific_file_ids,
565
yield_parents=yield_parents)
566
if not self.supports_tree_reference():
569
return self._check_for_tree_references(iterator)
571
def get_file_size(self, file_id):
572
"""See Tree.get_file_size"""
573
# XXX: this returns the on-disk size; it should probably return the
576
return os.path.getsize(self.id2abspath(file_id))
578
if e.errno != errno.ENOENT:
583
@needs_tree_write_lock
584
def _gather_kinds(self, files, kinds):
585
"""See MutableTree._gather_kinds."""
586
for pos, f in enumerate(files):
587
if kinds[pos] is None:
588
fullpath = normpath(self.abspath(f))
590
kinds[pos] = file_kind(fullpath)
592
if e.errno == errno.ENOENT:
593
raise errors.NoSuchFile(fullpath)
596
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
597
"""Add revision_id as a parent.
599
This is equivalent to retrieving the current list of parent ids
600
and setting the list to its value plus revision_id.
602
:param revision_id: The revision id to add to the parent list. It may
603
be a ghost revision as long as its not the first parent to be
604
added, or the allow_leftmost_as_ghost parameter is set True.
605
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
607
parents = self.get_parent_ids() + [revision_id]
608
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
609
or allow_leftmost_as_ghost)
611
@needs_tree_write_lock
612
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
613
"""Add revision_id, tree tuple as a parent.
615
This is equivalent to retrieving the current list of parent trees
616
and setting the list to its value plus parent_tuple. See also
617
add_parent_tree_id - if you only have a parent id available it will be
618
simpler to use that api. If you have the parent already available, using
619
this api is preferred.
621
:param parent_tuple: The (revision id, tree) to add to the parent list.
622
If the revision_id is a ghost, pass None for the tree.
623
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
625
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
626
if len(parent_ids) > 1:
627
# the leftmost may have already been a ghost, preserve that if it
629
allow_leftmost_as_ghost = True
630
self.set_parent_ids(parent_ids,
631
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
633
@needs_tree_write_lock
634
def add_pending_merge(self, *revision_ids):
635
# TODO: Perhaps should check at this point that the
636
# history of the revision is actually present?
637
parents = self.get_parent_ids()
639
for rev_id in revision_ids:
640
if rev_id in parents:
642
parents.append(rev_id)
645
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
647
def path_content_summary(self, path, _lstat=os.lstat,
648
_mapper=osutils.file_kind_from_stat_mode):
649
"""See Tree.path_content_summary."""
650
abspath = self.abspath(path)
652
stat_result = _lstat(abspath)
654
if getattr(e, 'errno', None) == errno.ENOENT:
656
return ('missing', None, None, None)
657
# propagate other errors
659
kind = _mapper(stat_result.st_mode)
661
return self._file_content_summary(path, stat_result)
662
elif kind == 'directory':
663
# perhaps it looks like a plain directory, but it's really a
665
if self._directory_is_tree_reference(path):
666
kind = 'tree-reference'
667
return kind, None, None, None
668
elif kind == 'symlink':
669
target = osutils.readlink(abspath)
670
return ('symlink', None, None, target)
672
return (kind, None, None, None)
674
def _file_content_summary(self, path, stat_result):
675
size = stat_result.st_size
676
executable = self._is_executable_from_path_and_stat(path, stat_result)
677
# try for a stat cache lookup
678
return ('file', size, executable, self._sha_from_stat(
681
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
682
"""Common ghost checking functionality from set_parent_*.
684
This checks that the left hand-parent exists if there are any
687
if len(revision_ids) > 0:
688
leftmost_id = revision_ids[0]
689
if (not allow_leftmost_as_ghost and not
690
self.branch.repository.has_revision(leftmost_id)):
691
raise errors.GhostRevisionUnusableHere(leftmost_id)
693
def _set_merges_from_parent_ids(self, parent_ids):
694
merges = parent_ids[1:]
695
self._transport.put_bytes('pending-merges', '\n'.join(merges),
696
mode=self.bzrdir._get_file_mode())
698
def _filter_parent_ids_by_ancestry(self, revision_ids):
699
"""Check that all merged revisions are proper 'heads'.
701
This will always return the first revision_id, and any merged revisions
704
if len(revision_ids) == 0:
706
graph = self.branch.repository.get_graph()
707
heads = graph.heads(revision_ids)
708
new_revision_ids = revision_ids[:1]
709
for revision_id in revision_ids[1:]:
710
if revision_id in heads and revision_id not in new_revision_ids:
711
new_revision_ids.append(revision_id)
712
if new_revision_ids != revision_ids:
713
mutter('requested to set revision_ids = %s,'
714
' but filtered to %s', revision_ids, new_revision_ids)
715
return new_revision_ids
717
@needs_tree_write_lock
718
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
719
"""Set the parent ids to revision_ids.
721
See also set_parent_trees. This api will try to retrieve the tree data
722
for each element of revision_ids from the trees repository. If you have
723
tree data already available, it is more efficient to use
724
set_parent_trees rather than set_parent_ids. set_parent_ids is however
725
an easier API to use.
727
:param revision_ids: The revision_ids to set as the parent ids of this
728
working tree. Any of these may be ghosts.
730
self._check_parents_for_ghosts(revision_ids,
731
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
732
for revision_id in revision_ids:
733
_mod_revision.check_not_reserved_id(revision_id)
735
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
737
if len(revision_ids) > 0:
738
self.set_last_revision(revision_ids[0])
740
self.set_last_revision(_mod_revision.NULL_REVISION)
742
self._set_merges_from_parent_ids(revision_ids)
744
@needs_tree_write_lock
745
def set_pending_merges(self, rev_list):
746
parents = self.get_parent_ids()
747
leftmost = parents[:1]
748
new_parents = leftmost + rev_list
749
self.set_parent_ids(new_parents)
751
@needs_tree_write_lock
752
def set_merge_modified(self, modified_hashes):
753
"""Set the merge modified hashes."""
754
raise NotImplementedError(self.set_merge_modified)
756
def _sha_from_stat(self, path, stat_result):
757
"""Get a sha digest from the tree's stat cache.
759
The default implementation assumes no stat cache is present.
761
:param path: The path.
762
:param stat_result: The stat result being looked up.
766
@needs_write_lock # because merge pulls data into the branch.
767
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
768
merge_type=None, force=False):
769
"""Merge from a branch into this working tree.
771
:param branch: The branch to merge from.
772
:param to_revision: If non-None, the merge will merge to to_revision,
773
but not beyond it. to_revision does not need to be in the history
774
of the branch when it is supplied. If None, to_revision defaults to
775
branch.last_revision().
777
from bzrlib.merge import Merger, Merge3Merger
778
merger = Merger(self.branch, this_tree=self)
779
# check that there are no local alterations
780
if not force and self.has_changes():
781
raise errors.UncommittedChanges(self)
782
if to_revision is None:
783
to_revision = _mod_revision.ensure_null(branch.last_revision())
784
merger.other_rev_id = to_revision
785
if _mod_revision.is_null(merger.other_rev_id):
786
raise errors.NoCommits(branch)
787
self.branch.fetch(branch, last_revision=merger.other_rev_id)
788
merger.other_basis = merger.other_rev_id
789
merger.other_tree = self.branch.repository.revision_tree(
791
merger.other_branch = branch
792
if from_revision is None:
795
merger.set_base_revision(from_revision, branch)
796
if merger.base_rev_id == merger.other_rev_id:
797
raise errors.PointlessMerge
798
merger.backup_files = False
799
if merge_type is None:
800
merger.merge_type = Merge3Merger
802
merger.merge_type = merge_type
803
merger.set_interesting_files(None)
804
merger.show_base = False
805
merger.reprocess = False
806
conflicts = merger.do_merge()
810
def merge_modified(self):
811
"""Return a dictionary of files modified by a merge.
813
The list is initialized by WorkingTree.set_merge_modified, which is
814
typically called after we make some automatic updates to the tree
817
This returns a map of file_id->sha1, containing only files which are
818
still in the working inventory and have that text hash.
820
raise NotImplementedError(self.merge_modified)
823
def mkdir(self, path, file_id=None):
824
"""See MutableTree.mkdir()."""
826
file_id = generate_ids.gen_file_id(os.path.basename(path))
827
os.mkdir(self.abspath(path))
828
self.add(path, file_id, 'directory')
831
def get_symlink_target(self, file_id, path=None):
833
abspath = self.abspath(path)
835
abspath = self.id2abspath(file_id)
836
target = osutils.readlink(abspath)
839
def subsume(self, other_tree):
840
raise NotImplementedError(self.subsume)
842
def _setup_directory_is_tree_reference(self):
843
if self._branch.repository._format.supports_tree_reference:
844
self._directory_is_tree_reference = \
845
self._directory_may_be_tree_reference
847
self._directory_is_tree_reference = \
848
self._directory_is_never_tree_reference
850
def _directory_is_never_tree_reference(self, relpath):
853
def _directory_may_be_tree_reference(self, relpath):
854
# as a special case, if a directory contains control files then
855
# it's a tree reference, except that the root of the tree is not
856
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
857
# TODO: We could ask all the control formats whether they
858
# recognize this directory, but at the moment there's no cheap api
859
# to do that. Since we probably can only nest bzr checkouts and
860
# they always use this name it's ok for now. -- mbp 20060306
862
# FIXME: There is an unhandled case here of a subdirectory
863
# containing .bzr but not a branch; that will probably blow up
864
# when you try to commit it. It might happen if there is a
865
# checkout in a subdirectory. This can be avoided by not adding
868
def extract(self, file_id, format=None):
869
"""Extract a subtree from this tree.
871
A new branch will be created, relative to the path for this tree.
873
raise NotImplementedError(self.extract)
876
"""Write the in memory meta data to disk."""
877
raise NotImplementedError(self.flush)
879
def _kind(self, relpath):
880
return osutils.file_kind(self.abspath(relpath))
882
def list_files(self, include_root=False, from_dir=None, recursive=True):
883
"""List all files as (path, class, kind, id, entry).
885
Lists, but does not descend into unversioned directories.
886
This does not include files that have been deleted in this
887
tree. Skips the control directory.
889
:param include_root: if True, return an entry for the root
890
:param from_dir: start from this directory or None for the root
891
:param recursive: whether to recurse into subdirectories or not
893
raise NotImplementedError(self.list_files)
895
def move(self, from_paths, to_dir=None, after=False):
898
to_dir must be known to the working tree.
900
If to_dir exists and is a directory, the files are moved into
901
it, keeping their old names.
903
Note that to_dir is only the last component of the new name;
904
this doesn't change the directory.
906
For each entry in from_paths the move mode will be determined
909
The first mode moves the file in the filesystem and updates the
910
working tree metadata. The second mode only updates the working tree
911
metadata without touching the file on the filesystem.
913
move uses the second mode if 'after == True' and the target is not
914
versioned but present in the working tree.
916
move uses the second mode if 'after == False' and the source is
917
versioned but no longer in the working tree, and the target is not
918
versioned but present in the working tree.
920
move uses the first mode if 'after == False' and the source is
921
versioned and present in the working tree, and the target is not
922
versioned and not present in the working tree.
924
Everything else results in an error.
926
This returns a list of (from_path, to_path) pairs for each
929
raise NotImplementedError(self.move)
931
@needs_tree_write_lock
932
def rename_one(self, from_rel, to_rel, after=False):
935
This can change the directory or the filename or both.
937
rename_one has several 'modes' to work. First, it can rename a physical
938
file and change the file_id. That is the normal mode. Second, it can
939
only change the file_id without touching any physical file.
941
rename_one uses the second mode if 'after == True' and 'to_rel' is
942
either not versioned or newly added, and present in the working tree.
944
rename_one uses the second mode if 'after == False' and 'from_rel' is
945
versioned but no longer in the working tree, and 'to_rel' is not
946
versioned but present in the working tree.
948
rename_one uses the first mode if 'after == False' and 'from_rel' is
949
versioned and present in the working tree, and 'to_rel' is not
950
versioned and not present in the working tree.
952
Everything else results in an error.
954
raise NotImplementedError(self.rename_one)
958
"""Return all unknown files.
960
These are files in the working directory that are not versioned or
961
control files or ignored.
963
# force the extras method to be fully executed before returning, to
964
# prevent race conditions with the lock
966
[subp for subp in self.extras() if not self.is_ignored(subp)])
968
def unversion(self, file_ids):
969
"""Remove the file ids in file_ids from the current versioned set.
971
When a file_id is unversioned, all of its children are automatically
974
:param file_ids: The file ids to stop versioning.
975
:raises: NoSuchId if any fileid is not currently versioned.
977
raise NotImplementedError(self.unversion)
980
def pull(self, source, overwrite=False, stop_revision=None,
981
change_reporter=None, possible_transports=None, local=False,
985
old_revision_info = self.branch.last_revision_info()
986
basis_tree = self.basis_tree()
987
count = self.branch.pull(source, overwrite, stop_revision,
988
possible_transports=possible_transports,
990
new_revision_info = self.branch.last_revision_info()
991
if new_revision_info != old_revision_info:
992
repository = self.branch.repository
993
if repository._format.fast_deltas:
994
parent_ids = self.get_parent_ids()
996
basis_id = parent_ids[0]
997
basis_tree = repository.revision_tree(basis_id)
998
basis_tree.lock_read()
1000
new_basis_tree = self.branch.basis_tree()
1007
change_reporter=change_reporter,
1008
show_base=show_base)
1009
basis_root_id = basis_tree.get_root_id()
1010
new_root_id = new_basis_tree.get_root_id()
1011
if new_root_id is not None and basis_root_id != new_root_id:
1012
self.set_root_id(new_root_id)
1015
# TODO - dedup parents list with things merged by pull ?
1016
# reuse the revisiontree we merged against to set the new
1019
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1020
parent_trees.append(
1021
(self.branch.last_revision(), new_basis_tree))
1022
# we have to pull the merge trees out again, because
1023
# merge_inner has set the ids. - this corner is not yet
1024
# layered well enough to prevent double handling.
1025
# XXX TODO: Fix the double handling: telling the tree about
1026
# the already known parent data is wasteful.
1027
merges = self.get_parent_ids()[1:]
1028
parent_trees.extend([
1029
(parent, repository.revision_tree(parent)) for
1031
self.set_parent_trees(parent_trees)
1037
def put_file_bytes_non_atomic(self, file_id, bytes):
1038
"""See MutableTree.put_file_bytes_non_atomic."""
1039
stream = file(self.id2abspath(file_id), 'wb')
1046
"""Yield all unversioned files in this WorkingTree.
1048
If there are any unversioned directories then only the directory is
1049
returned, not all its children. But if there are unversioned files
1050
under a versioned subdirectory, they are returned.
1052
Currently returned depth-first, sorted by name within directories.
1053
This is the same order used by 'osutils.walkdirs'.
1055
raise NotImplementedError(self.extras)
1057
def ignored_files(self):
1058
"""Yield list of PATH, IGNORE_PATTERN"""
1059
for subp in self.extras():
1060
pat = self.is_ignored(subp)
1064
def get_ignore_list(self):
1065
"""Return list of ignore patterns.
1067
Cached in the Tree object after the first call.
1069
ignoreset = getattr(self, '_ignoreset', None)
1070
if ignoreset is not None:
1073
ignore_globs = set()
1074
ignore_globs.update(ignores.get_runtime_ignores())
1075
ignore_globs.update(ignores.get_user_ignores())
1076
if self.has_filename(bzrlib.IGNORE_FILENAME):
1077
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1079
ignore_globs.update(ignores.parse_ignore_file(f))
1082
self._ignoreset = ignore_globs
1085
def _flush_ignore_list_cache(self):
1086
"""Resets the cached ignore list to force a cache rebuild."""
1087
self._ignoreset = None
1088
self._ignoreglobster = None
1090
def is_ignored(self, filename):
1091
r"""Check whether the filename matches an ignore pattern.
1093
Patterns containing '/' or '\' need to match the whole path;
1094
others match against only the last component. Patterns starting
1095
with '!' are ignore exceptions. Exceptions take precedence
1096
over regular patterns and cause the filename to not be ignored.
1098
If the file is ignored, returns the pattern which caused it to
1099
be ignored, otherwise None. So this can simply be used as a
1100
boolean if desired."""
1101
if getattr(self, '_ignoreglobster', None) is None:
1102
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1103
return self._ignoreglobster.match(filename)
1105
def kind(self, file_id):
1106
return file_kind(self.id2abspath(file_id))
1108
def stored_kind(self, file_id):
1109
"""See Tree.stored_kind"""
1110
raise NotImplementedError(self.stored_kind)
1112
def _comparison_data(self, entry, path):
1113
abspath = self.abspath(path)
1115
stat_value = os.lstat(abspath)
1117
if getattr(e, 'errno', None) == errno.ENOENT:
1124
mode = stat_value.st_mode
1125
kind = osutils.file_kind_from_stat_mode(mode)
1126
if not self._supports_executable():
1127
executable = entry is not None and entry.executable
1129
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1130
return kind, executable, stat_value
1132
def _file_size(self, entry, stat_value):
1133
return stat_value.st_size
1135
def last_revision(self):
1136
"""Return the last revision of the branch for this tree.
1138
This format tree does not support a separate marker for last-revision
1139
compared to the branch.
1141
See MutableTree.last_revision
1143
return self._last_revision()
1146
def _last_revision(self):
1147
"""helper for get_parent_ids."""
1148
return _mod_revision.ensure_null(self.branch.last_revision())
1150
def is_locked(self):
1151
"""Check if this tree is locked."""
1152
raise NotImplementedError(self.is_locked)
1154
def lock_read(self):
1155
"""Lock the tree for reading.
1157
This also locks the branch, and can be unlocked via self.unlock().
1159
:return: A bzrlib.lock.LogicalLockResult.
1161
raise NotImplementedError(self.lock_read)
1163
def lock_tree_write(self):
1164
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1166
:return: A bzrlib.lock.LogicalLockResult.
1168
raise NotImplementedError(self.lock_tree_write)
1170
def lock_write(self):
1171
"""See MutableTree.lock_write, and WorkingTree.unlock.
1173
:return: A bzrlib.lock.LogicalLockResult.
1175
raise NotImplementedError(self.lock_write)
1177
def get_physical_lock_status(self):
1178
raise NotImplementedError(self.get_physical_lock_status)
1180
def set_last_revision(self, new_revision):
1181
"""Change the last revision in the working tree."""
1182
raise NotImplementedError(self.set_last_revision)
1184
def _change_last_revision(self, new_revision):
1185
"""Template method part of set_last_revision to perform the change.
1187
This is used to allow WorkingTree3 instances to not affect branch
1188
when their last revision is set.
1190
if _mod_revision.is_null(new_revision):
1191
self.branch.set_last_revision_info(0, new_revision)
1193
_mod_revision.check_not_reserved_id(new_revision)
1195
self.branch.generate_revision_history(new_revision)
1196
except errors.NoSuchRevision:
1197
# not present in the repo - dont try to set it deeper than the tip
1198
self.branch._set_revision_history([new_revision])
1201
@needs_tree_write_lock
1202
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1204
"""Remove nominated files from the working tree metadata.
1206
:files: File paths relative to the basedir.
1207
:keep_files: If true, the files will also be kept.
1208
:force: Delete files and directories, even if they are changed and
1209
even if the directories are not empty.
1211
if isinstance(files, basestring):
1216
all_files = set() # specified and nested files
1217
unknown_nested_files=set()
1219
to_file = sys.stdout
1221
files_to_backup = []
1223
def recurse_directory_to_add_files(directory):
1224
# Recurse directory and add all files
1225
# so we can check if they have changed.
1226
for parent_info, file_infos in self.walkdirs(directory):
1227
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1228
# Is it versioned or ignored?
1229
if self.path2id(relpath):
1230
# Add nested content for deletion.
1231
all_files.add(relpath)
1233
# Files which are not versioned
1234
# should be treated as unknown.
1235
files_to_backup.append(relpath)
1237
for filename in files:
1238
# Get file name into canonical form.
1239
abspath = self.abspath(filename)
1240
filename = self.relpath(abspath)
1241
if len(filename) > 0:
1242
all_files.add(filename)
1243
recurse_directory_to_add_files(filename)
1245
files = list(all_files)
1248
return # nothing to do
1250
# Sort needed to first handle directory content before the directory
1251
files.sort(reverse=True)
1253
# Bail out if we are going to delete files we shouldn't
1254
if not keep_files and not force:
1255
for (file_id, path, content_change, versioned, parent_id, name,
1256
kind, executable) in self.iter_changes(self.basis_tree(),
1257
include_unchanged=True, require_versioned=False,
1258
want_unversioned=True, specific_files=files):
1259
if versioned[0] == False:
1260
# The record is unknown or newly added
1261
files_to_backup.append(path[1])
1262
elif (content_change and (kind[1] is not None) and
1263
osutils.is_inside_any(files, path[1])):
1264
# Versioned and changed, but not deleted, and still
1265
# in one of the dirs to be deleted.
1266
files_to_backup.append(path[1])
1268
def backup(file_to_backup):
1269
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1270
osutils.rename(abs_path, self.abspath(backup_name))
1271
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1274
# Build inv_delta and delete files where applicable,
1275
# do this before any modifications to meta data.
1277
fid = self.path2id(f)
1280
message = "%s is not versioned." % (f,)
1283
# having removed it, it must be either ignored or unknown
1284
if self.is_ignored(f):
1288
# XXX: Really should be a more abstract reporter interface
1289
kind_ch = osutils.kind_marker(self.kind(fid))
1290
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1292
inv_delta.append((f, None, fid, None))
1293
message = "removed %s" % (f,)
1296
abs_path = self.abspath(f)
1297
if osutils.lexists(abs_path):
1298
if (osutils.isdir(abs_path) and
1299
len(os.listdir(abs_path)) > 0):
1301
osutils.rmtree(abs_path)
1302
message = "deleted %s" % (f,)
1306
if f in files_to_backup:
1309
osutils.delete_any(abs_path)
1310
message = "deleted %s" % (f,)
1311
elif message is not None:
1312
# Only care if we haven't done anything yet.
1313
message = "%s does not exist." % (f,)
1315
# Print only one message (if any) per file.
1316
if message is not None:
1318
self.apply_inventory_delta(inv_delta)
1320
@needs_tree_write_lock
1321
def revert(self, filenames=None, old_tree=None, backups=True,
1322
pb=None, report_changes=False):
1323
from bzrlib.conflicts import resolve
1324
if old_tree is None:
1325
basis_tree = self.basis_tree()
1326
basis_tree.lock_read()
1327
old_tree = basis_tree
1331
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1333
if filenames is None and len(self.get_parent_ids()) > 1:
1335
last_revision = self.last_revision()
1336
if last_revision != _mod_revision.NULL_REVISION:
1337
if basis_tree is None:
1338
basis_tree = self.basis_tree()
1339
basis_tree.lock_read()
1340
parent_trees.append((last_revision, basis_tree))
1341
self.set_parent_trees(parent_trees)
1344
resolve(self, filenames, ignore_misses=True, recursive=True)
1346
if basis_tree is not None:
1350
def revision_tree(self, revision_id):
1351
"""See Tree.revision_tree.
1353
WorkingTree can supply revision_trees for the basis revision only
1354
because there is only one cached inventory in the bzr directory.
1356
raise NotImplementedError(self.revision_tree)
1358
@needs_tree_write_lock
1359
def set_root_id(self, file_id):
1360
"""Set the root id for this tree."""
1364
'WorkingTree.set_root_id with fileid=None')
1365
file_id = osutils.safe_file_id(file_id)
1366
self._set_root_id(file_id)
1368
def _set_root_id(self, file_id):
1369
"""Set the root id for this tree, in a format specific manner.
1371
:param file_id: The file id to assign to the root. It must not be
1372
present in the current inventory or an error will occur. It must
1373
not be None, but rather a valid file id.
1375
raise NotImplementedError(self._set_root_id)
1378
"""See Branch.unlock.
1380
WorkingTree locking just uses the Branch locking facilities.
1381
This is current because all working trees have an embedded branch
1382
within them. IF in the future, we were to make branch data shareable
1383
between multiple working trees, i.e. via shared storage, then we
1384
would probably want to lock both the local tree, and the branch.
1386
raise NotImplementedError(self.unlock)
1390
def update(self, change_reporter=None, possible_transports=None,
1391
revision=None, old_tip=_marker, show_base=False):
1392
"""Update a working tree along its branch.
1394
This will update the branch if its bound too, which means we have
1395
multiple trees involved:
1397
- The new basis tree of the master.
1398
- The old basis tree of the branch.
1399
- The old basis tree of the working tree.
1400
- The current working tree state.
1402
Pathologically, all three may be different, and non-ancestors of each
1403
other. Conceptually we want to:
1405
- Preserve the wt.basis->wt.state changes
1406
- Transform the wt.basis to the new master basis.
1407
- Apply a merge of the old branch basis to get any 'local' changes from
1409
- Restore the wt.basis->wt.state changes.
1411
There isn't a single operation at the moment to do that, so we:
1413
- Merge current state -> basis tree of the master w.r.t. the old tree
1415
- Do a 'normal' merge of the old branch basis if it is relevant.
1417
:param revision: The target revision to update to. Must be in the
1419
:param old_tip: If branch.update() has already been run, the value it
1420
returned (old tip of the branch or None). _marker is used
1423
if self.branch.get_bound_location() is not None:
1425
update_branch = (old_tip is self._marker)
1427
self.lock_tree_write()
1428
update_branch = False
1431
old_tip = self.branch.update(possible_transports)
1433
if old_tip is self._marker:
1435
return self._update_tree(old_tip, change_reporter, revision, show_base)
1439
@needs_tree_write_lock
1440
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1442
"""Update a tree to the master branch.
1444
:param old_tip: if supplied, the previous tip revision the branch,
1445
before it was changed to the master branch's tip.
1447
# here if old_tip is not None, it is the old tip of the branch before
1448
# it was updated from the master branch. This should become a pending
1449
# merge in the working tree to preserve the user existing work. we
1450
# cant set that until we update the working trees last revision to be
1451
# one from the new branch, because it will just get absorbed by the
1452
# parent de-duplication logic.
1454
# We MUST save it even if an error occurs, because otherwise the users
1455
# local work is unreferenced and will appear to have been lost.
1459
last_rev = self.get_parent_ids()[0]
1461
last_rev = _mod_revision.NULL_REVISION
1462
if revision is None:
1463
revision = self.branch.last_revision()
1465
old_tip = old_tip or _mod_revision.NULL_REVISION
1467
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1468
# the branch we are bound to was updated
1469
# merge those changes in first
1470
base_tree = self.basis_tree()
1471
other_tree = self.branch.repository.revision_tree(old_tip)
1472
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1473
base_tree, this_tree=self,
1474
change_reporter=change_reporter,
1475
show_base=show_base)
1477
self.add_parent_tree((old_tip, other_tree))
1478
note(gettext('Rerun update after fixing the conflicts.'))
1481
if last_rev != _mod_revision.ensure_null(revision):
1482
# the working tree is up to date with the branch
1483
# we can merge the specified revision from master
1484
to_tree = self.branch.repository.revision_tree(revision)
1485
to_root_id = to_tree.get_root_id()
1487
basis = self.basis_tree()
1490
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1491
self.set_root_id(to_root_id)
1496
# determine the branch point
1497
graph = self.branch.repository.get_graph()
1498
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1500
base_tree = self.branch.repository.revision_tree(base_rev_id)
1502
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1504
change_reporter=change_reporter,
1505
show_base=show_base)
1506
self.set_last_revision(revision)
1507
# TODO - dedup parents list with things merged by pull ?
1508
# reuse the tree we've updated to to set the basis:
1509
parent_trees = [(revision, to_tree)]
1510
merges = self.get_parent_ids()[1:]
1511
# Ideally we ask the tree for the trees here, that way the working
1512
# tree can decide whether to give us the entire tree or give us a
1513
# lazy initialised tree. dirstate for instance will have the trees
1514
# in ram already, whereas a last-revision + basis-inventory tree
1515
# will not, but also does not need them when setting parents.
1516
for parent in merges:
1517
parent_trees.append(
1518
(parent, self.branch.repository.revision_tree(parent)))
1519
if not _mod_revision.is_null(old_tip):
1520
parent_trees.append(
1521
(old_tip, self.branch.repository.revision_tree(old_tip)))
1522
self.set_parent_trees(parent_trees)
1523
last_rev = parent_trees[0][0]
1526
def set_conflicts(self, arg):
1527
raise errors.UnsupportedOperation(self.set_conflicts, self)
1529
def add_conflicts(self, arg):
1530
raise errors.UnsupportedOperation(self.add_conflicts, self)
1532
def conflicts(self):
1533
raise NotImplementedError(self.conflicts)
1535
def walkdirs(self, prefix=""):
1536
"""Walk the directories of this tree.
1538
returns a generator which yields items in the form:
1539
((curren_directory_path, fileid),
1540
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1543
This API returns a generator, which is only valid during the current
1544
tree transaction - within a single lock_read or lock_write duration.
1546
If the tree is not locked, it may cause an error to be raised,
1547
depending on the tree implementation.
1549
disk_top = self.abspath(prefix)
1550
if disk_top.endswith('/'):
1551
disk_top = disk_top[:-1]
1552
top_strip_len = len(disk_top) + 1
1553
inventory_iterator = self._walkdirs(prefix)
1554
disk_iterator = osutils.walkdirs(disk_top, prefix)
1556
current_disk = disk_iterator.next()
1557
disk_finished = False
1559
if not (e.errno == errno.ENOENT or
1560
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1563
disk_finished = True
1565
current_inv = inventory_iterator.next()
1566
inv_finished = False
1567
except StopIteration:
1570
while not inv_finished or not disk_finished:
1572
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1573
cur_disk_dir_content) = current_disk
1575
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1576
cur_disk_dir_content) = ((None, None), None)
1577
if not disk_finished:
1578
# strip out .bzr dirs
1579
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1580
len(cur_disk_dir_content) > 0):
1581
# osutils.walkdirs can be made nicer -
1582
# yield the path-from-prefix rather than the pathjoined
1584
bzrdir_loc = bisect_left(cur_disk_dir_content,
1586
if (bzrdir_loc < len(cur_disk_dir_content)
1587
and self.bzrdir.is_control_filename(
1588
cur_disk_dir_content[bzrdir_loc][0])):
1589
# we dont yield the contents of, or, .bzr itself.
1590
del cur_disk_dir_content[bzrdir_loc]
1592
# everything is unknown
1595
# everything is missing
1598
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1600
# disk is before inventory - unknown
1601
dirblock = [(relpath, basename, kind, stat, None, None) for
1602
relpath, basename, kind, stat, top_path in
1603
cur_disk_dir_content]
1604
yield (cur_disk_dir_relpath, None), dirblock
1606
current_disk = disk_iterator.next()
1607
except StopIteration:
1608
disk_finished = True
1610
# inventory is before disk - missing.
1611
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1612
for relpath, basename, dkind, stat, fileid, kind in
1614
yield (current_inv[0][0], current_inv[0][1]), dirblock
1616
current_inv = inventory_iterator.next()
1617
except StopIteration:
1620
# versioned present directory
1621
# merge the inventory and disk data together
1623
for relpath, subiterator in itertools.groupby(sorted(
1624
current_inv[1] + cur_disk_dir_content,
1625
key=operator.itemgetter(0)), operator.itemgetter(1)):
1626
path_elements = list(subiterator)
1627
if len(path_elements) == 2:
1628
inv_row, disk_row = path_elements
1629
# versioned, present file
1630
dirblock.append((inv_row[0],
1631
inv_row[1], disk_row[2],
1632
disk_row[3], inv_row[4],
1634
elif len(path_elements[0]) == 5:
1636
dirblock.append((path_elements[0][0],
1637
path_elements[0][1], path_elements[0][2],
1638
path_elements[0][3], None, None))
1639
elif len(path_elements[0]) == 6:
1640
# versioned, absent file.
1641
dirblock.append((path_elements[0][0],
1642
path_elements[0][1], 'unknown', None,
1643
path_elements[0][4], path_elements[0][5]))
1645
raise NotImplementedError('unreachable code')
1646
yield current_inv[0], dirblock
1648
current_inv = inventory_iterator.next()
1649
except StopIteration:
1652
current_disk = disk_iterator.next()
1653
except StopIteration:
1654
disk_finished = True
1656
def _walkdirs(self, prefix=""):
1657
"""Walk the directories of this tree.
1659
:param prefix: is used as the directrory to start with.
1660
:returns: a generator which yields items in the form::
1662
((curren_directory_path, fileid),
1663
[(file1_path, file1_name, file1_kind, None, file1_id,
1666
raise NotImplementedError(self._walkdirs)
1668
@needs_tree_write_lock
1669
def auto_resolve(self):
1670
"""Automatically resolve text conflicts according to contents.
1672
Only text conflicts are auto_resolvable. Files with no conflict markers
1673
are considered 'resolved', because bzr always puts conflict markers
1674
into files that have text conflicts. The corresponding .THIS .BASE and
1675
.OTHER files are deleted, as per 'resolve'.
1677
:return: a tuple of ConflictLists: (un_resolved, resolved).
1679
un_resolved = _mod_conflicts.ConflictList()
1680
resolved = _mod_conflicts.ConflictList()
1681
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1682
for conflict in self.conflicts():
1683
if (conflict.typestring != 'text conflict' or
1684
self.kind(conflict.file_id) != 'file'):
1685
un_resolved.append(conflict)
1687
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1689
for line in my_file:
1690
if conflict_re.search(line):
1691
un_resolved.append(conflict)
1694
resolved.append(conflict)
1697
resolved.remove_files(self)
1698
self.set_conflicts(un_resolved)
1699
return un_resolved, resolved
1701
def _validate(self):
1702
"""Validate internal structures.
1704
This is meant mostly for the test suite. To give it a chance to detect
1705
corruption after actions have occurred. The default implementation is a
1708
:return: None. An exception should be raised if there is an error.
1712
def check_state(self):
1713
"""Check that the working state is/isn't valid."""
1714
raise NotImplementedError(self.check_state)
1716
def reset_state(self, revision_ids=None):
1717
"""Reset the state of the working tree.
1719
This does a hard-reset to a last-known-good state. This is a way to
1720
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1722
raise NotImplementedError(self.reset_state)
1724
def _get_rules_searcher(self, default_searcher):
1725
"""See Tree._get_rules_searcher."""
1726
if self._rules_searcher is None:
1727
self._rules_searcher = super(WorkingTree,
1728
self)._get_rules_searcher(default_searcher)
1729
return self._rules_searcher
1731
def get_shelf_manager(self):
1732
"""Return the ShelfManager for this WorkingTree."""
1733
from bzrlib.shelf import ShelfManager
1734
return ShelfManager(self, self._transport)
1737
class InventoryWorkingTree(WorkingTree,
1738
bzrlib.mutabletree.MutableInventoryTree):
1739
"""Base class for working trees that are inventory-oriented.
28
1741
The inventory is held in the `Branch` working-inventory, and the
29
1742
files are in a directory on disk.
31
1744
It is possible for a `WorkingTree` to have a filename which is
32
1745
not listed in the Inventory and vice versa.
36
def __init__(self, basedir, inv):
1748
def __init__(self, basedir='.',
1749
branch=DEPRECATED_PARAMETER,
1751
_control_files=None,
1755
"""Construct a InventoryWorkingTree instance. This is not a public API.
1757
:param branch: A branch to override probing for the branch.
1759
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1760
branch=branch, _transport=_control_files._transport,
1761
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1763
self._control_files = _control_files
1764
self._detect_case_handling()
1766
if _inventory is None:
1767
# This will be acquired on lock_read() or lock_write()
1768
self._inventory_is_modified = False
1769
self._inventory = None
1771
# the caller of __init__ has provided an inventory,
1772
# we assume they know what they are doing - as its only
1773
# the Format factory and creation methods that are
1774
# permitted to do this.
1775
self._set_inventory(_inventory, dirty=False)
1777
def _set_inventory(self, inv, dirty):
1778
"""Set the internal cached inventory.
1780
:param inv: The inventory to set.
1781
:param dirty: A boolean indicating whether the inventory is the same
1782
logical inventory as whats on disk. If True the inventory is not
1783
the same and should be written to disk or data will be lost, if
1784
False then the inventory is the same as that on disk and any
1785
serialisation would be unneeded overhead.
37
1787
self._inventory = inv
38
self.basedir = basedir
39
self.path2id = inv.path2id
40
self._update_statcache()
1788
self._inventory_is_modified = dirty
1790
def _detect_case_handling(self):
1791
wt_trans = self.bzrdir.get_workingtree_transport(None)
1793
wt_trans.stat(self._format.case_sensitive_filename)
1794
except errors.NoSuchFile:
1795
self.case_sensitive = True
1797
self.case_sensitive = False
1799
self._setup_directory_is_tree_reference()
1801
def _serialize(self, inventory, out_file):
1802
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1805
def _deserialize(selt, in_file):
1806
return xml5.serializer_v5.read_inventory(in_file)
1808
def break_lock(self):
1809
"""Break a lock if one is present from another instance.
1811
Uses the ui factory to ask for confirmation if the lock may be from
1814
This will probe the repository for its lock as well.
1816
self._control_files.break_lock()
1817
self.branch.break_lock()
1819
def is_locked(self):
1820
return self._control_files.is_locked()
1822
def _must_be_locked(self):
1823
if not self.is_locked():
1824
raise errors.ObjectNotLocked(self)
1826
def lock_read(self):
1827
"""Lock the tree for reading.
1829
This also locks the branch, and can be unlocked via self.unlock().
1831
:return: A bzrlib.lock.LogicalLockResult.
1833
if not self.is_locked():
1835
self.branch.lock_read()
1837
self._control_files.lock_read()
1838
return LogicalLockResult(self.unlock)
1840
self.branch.unlock()
1843
def lock_tree_write(self):
1844
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1846
:return: A bzrlib.lock.LogicalLockResult.
1848
if not self.is_locked():
1850
self.branch.lock_read()
1852
self._control_files.lock_write()
1853
return LogicalLockResult(self.unlock)
1855
self.branch.unlock()
1858
def lock_write(self):
1859
"""See MutableTree.lock_write, and WorkingTree.unlock.
1861
:return: A bzrlib.lock.LogicalLockResult.
1863
if not self.is_locked():
1865
self.branch.lock_write()
1867
self._control_files.lock_write()
1868
return LogicalLockResult(self.unlock)
1870
self.branch.unlock()
1873
def get_physical_lock_status(self):
1874
return self._control_files.get_physical_lock_status()
1876
@needs_tree_write_lock
1877
def _write_inventory(self, inv):
1878
"""Write inventory as the current inventory."""
1879
self._set_inventory(inv, dirty=True)
1882
# XXX: This method should be deprecated in favour of taking in a proper
1883
# new Inventory object.
1884
@needs_tree_write_lock
1885
def set_inventory(self, new_inventory_list):
1886
from bzrlib.inventory import (Inventory,
1890
inv = Inventory(self.get_root_id())
1891
for path, file_id, parent, kind in new_inventory_list:
1892
name = os.path.basename(path)
1895
# fixme, there should be a factory function inv,add_??
1896
if kind == 'directory':
1897
inv.add(InventoryDirectory(file_id, name, parent))
1898
elif kind == 'file':
1899
inv.add(InventoryFile(file_id, name, parent))
1900
elif kind == 'symlink':
1901
inv.add(InventoryLink(file_id, name, parent))
1903
raise errors.BzrError("unknown kind %r" % kind)
1904
self._write_inventory(inv)
1906
def _write_basis_inventory(self, xml):
1907
"""Write the basis inventory XML to the basis-inventory file"""
1908
path = self._basis_inventory_name()
1910
self._transport.put_file(path, sio,
1911
mode=self.bzrdir._get_file_mode())
1913
def _reset_data(self):
1914
"""Reset transient data that cannot be revalidated."""
1915
self._inventory_is_modified = False
1916
f = self._transport.get('inventory')
1918
result = self._deserialize(f)
1921
self._set_inventory(result, dirty=False)
1923
def _set_root_id(self, file_id):
1924
"""Set the root id for this tree, in a format specific manner.
1926
:param file_id: The file id to assign to the root. It must not be
1927
present in the current inventory or an error will occur. It must
1928
not be None, but rather a valid file id.
1930
inv = self._inventory
1931
orig_root_id = inv.root.file_id
1932
# TODO: it might be nice to exit early if there was nothing
1933
# to do, saving us from trigger a sync on unlock.
1934
self._inventory_is_modified = True
1935
# we preserve the root inventory entry object, but
1936
# unlinkit from the byid index
1937
del inv._byid[inv.root.file_id]
1938
inv.root.file_id = file_id
1939
# and link it into the index with the new changed id.
1940
inv._byid[inv.root.file_id] = inv.root
1941
# and finally update all children to reference the new id.
1942
# XXX: this should be safe to just look at the root.children
1943
# list, not the WHOLE INVENTORY.
1946
if entry.parent_id == orig_root_id:
1947
entry.parent_id = inv.root.file_id
1949
def all_file_ids(self):
1950
"""See Tree.iter_all_file_ids"""
1951
return set(self.inventory)
1953
@needs_tree_write_lock
1954
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1955
"""See MutableTree.set_parent_trees."""
1956
parent_ids = [rev for (rev, tree) in parents_list]
1957
for revision_id in parent_ids:
1958
_mod_revision.check_not_reserved_id(revision_id)
1960
self._check_parents_for_ghosts(parent_ids,
1961
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1963
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1965
if len(parent_ids) == 0:
1966
leftmost_parent_id = _mod_revision.NULL_REVISION
1967
leftmost_parent_tree = None
1969
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1971
if self._change_last_revision(leftmost_parent_id):
1972
if leftmost_parent_tree is None:
1973
# If we don't have a tree, fall back to reading the
1974
# parent tree from the repository.
1975
self._cache_basis_inventory(leftmost_parent_id)
1977
inv = leftmost_parent_tree.inventory
1978
xml = self._create_basis_xml_from_inventory(
1979
leftmost_parent_id, inv)
1980
self._write_basis_inventory(xml)
1981
self._set_merges_from_parent_ids(parent_ids)
1983
def _cache_basis_inventory(self, new_revision):
1984
"""Cache new_revision as the basis inventory."""
1985
# TODO: this should allow the ready-to-use inventory to be passed in,
1986
# as commit already has that ready-to-use [while the format is the
1989
# this double handles the inventory - unpack and repack -
1990
# but is easier to understand. We can/should put a conditional
1991
# in here based on whether the inventory is in the latest format
1992
# - perhaps we should repack all inventories on a repository
1994
# the fast path is to copy the raw xml from the repository. If the
1995
# xml contains 'revision_id="', then we assume the right
1996
# revision_id is set. We must check for this full string, because a
1997
# root node id can legitimately look like 'revision_id' but cannot
1999
xml = self.branch.repository._get_inventory_xml(new_revision)
2000
firstline = xml.split('\n', 1)[0]
2001
if (not 'revision_id="' in firstline or
2002
'format="7"' not in firstline):
2003
inv = self.branch.repository._serializer.read_inventory_from_string(
2005
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2006
self._write_basis_inventory(xml)
2007
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2010
def _basis_inventory_name(self):
2011
return 'basis-inventory-cache'
2013
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2014
"""Create the text that will be saved in basis-inventory"""
2015
inventory.revision_id = revision_id
2016
return xml7.serializer_v7.write_inventory_to_string(inventory)
2018
@needs_tree_write_lock
2019
def set_conflicts(self, conflicts):
2020
self._put_rio('conflicts', conflicts.to_stanzas(),
2023
@needs_tree_write_lock
2024
def add_conflicts(self, new_conflicts):
2025
conflict_set = set(self.conflicts())
2026
conflict_set.update(set(list(new_conflicts)))
2027
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2028
key=_mod_conflicts.Conflict.sort_key)))
2031
def conflicts(self):
2033
confile = self._transport.get('conflicts')
2034
except errors.NoSuchFile:
2035
return _mod_conflicts.ConflictList()
2038
if confile.next() != CONFLICT_HEADER_1 + '\n':
2039
raise errors.ConflictFormatError()
2040
except StopIteration:
2041
raise errors.ConflictFormatError()
2042
reader = _mod_rio.RioReader(confile)
2043
return _mod_conflicts.ConflictList.from_stanzas(reader)
2047
def read_basis_inventory(self):
2048
"""Read the cached basis inventory."""
2049
path = self._basis_inventory_name()
2050
return self._transport.get_bytes(path)
2053
def read_working_inventory(self):
2054
"""Read the working inventory.
2056
:raises errors.InventoryModified: read_working_inventory will fail
2057
when the current in memory inventory has been modified.
2059
# conceptually this should be an implementation detail of the tree.
2060
# XXX: Deprecate this.
2061
# ElementTree does its own conversion from UTF-8, so open in
2063
if self._inventory_is_modified:
2064
raise errors.InventoryModified(self)
2065
f = self._transport.get('inventory')
2067
result = self._deserialize(f)
2070
self._set_inventory(result, dirty=False)
2074
def get_root_id(self):
2075
"""Return the id of this trees root"""
2076
return self._inventory.root.file_id
2078
def has_id(self, file_id):
2079
# files that have been deleted are excluded
2080
inv = self.inventory
2081
if not inv.has_id(file_id):
2083
path = inv.id2path(file_id)
2084
return osutils.lexists(self.abspath(path))
2086
def has_or_had_id(self, file_id):
2087
if file_id == self.inventory.root.file_id:
2089
return self.inventory.has_id(file_id)
2091
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
42
2092
def __iter__(self):
43
2093
"""Iterate through file_ids for this tree.
46
2096
and the working file exists.
48
2098
inv = self._inventory
49
for file_id in self._inventory:
50
# TODO: This is slightly redundant; we should be able to just
51
# check the statcache but it only includes regular files.
52
# only include files which still exist on disk
55
if ((file_id in self._statcache)
56
or (os.path.exists(self.abspath(inv.id2path(file_id))))):
62
return "<%s of %s>" % (self.__class__.__name__,
65
def abspath(self, filename):
66
return os.path.join(self.basedir, filename)
68
def has_filename(self, filename):
69
return os.path.exists(self.abspath(filename))
71
def get_file(self, file_id):
72
return self.get_file_byname(self.id2path(file_id))
74
def get_file_byname(self, filename):
75
return file(self.abspath(filename), 'rb')
77
def _get_store_filename(self, file_id):
78
## XXX: badly named; this isn't in the store at all
79
return self.abspath(self.id2path(file_id))
82
def has_id(self, file_id):
83
# files that have been deleted are excluded
84
if not self.inventory.has_id(file_id):
2099
for path, ie in inv.iter_entries():
2100
if osutils.lexists(self.abspath(path)):
2103
@needs_tree_write_lock
2104
def set_last_revision(self, new_revision):
2105
"""Change the last revision in the working tree."""
2106
if self._change_last_revision(new_revision):
2107
self._cache_basis_inventory(new_revision)
2109
def _get_check_refs(self):
2110
"""Return the references needed to perform a check of this tree.
2112
The default implementation returns no refs, and is only suitable for
2113
trees that have no local caching and can commit on ghosts at any time.
2115
:seealso: bzrlib.check for details about check_refs.
2120
def _check(self, references):
2121
"""Check the tree for consistency.
2123
:param references: A dict with keys matching the items returned by
2124
self._get_check_refs(), and values from looking those keys up in
2127
tree_basis = self.basis_tree()
2128
tree_basis.lock_read()
2130
repo_basis = references[('trees', self.last_revision())]
2131
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2132
raise errors.BzrCheckError(
2133
"Mismatched basis inventory content.")
2139
def check_state(self):
2140
"""Check that the working state is/isn't valid."""
2141
check_refs = self._get_check_refs()
2143
for ref in check_refs:
2146
refs[ref] = self.branch.repository.revision_tree(value)
2149
@needs_tree_write_lock
2150
def reset_state(self, revision_ids=None):
2151
"""Reset the state of the working tree.
2153
This does a hard-reset to a last-known-good state. This is a way to
2154
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2156
if revision_ids is None:
2157
revision_ids = self.get_parent_ids()
2158
if not revision_ids:
2159
rt = self.branch.repository.revision_tree(
2160
_mod_revision.NULL_REVISION)
2162
rt = self.branch.repository.revision_tree(revision_ids[0])
2163
self._write_inventory(rt.inventory)
2164
self.set_parent_ids(revision_ids)
2167
"""Write the in memory inventory to disk."""
2168
# TODO: Maybe this should only write on dirty ?
2169
if self._control_files._lock_mode != 'w':
2170
raise errors.NotWriteLocked(self)
2172
self._serialize(self._inventory, sio)
2174
self._transport.put_file('inventory', sio,
2175
mode=self.bzrdir._get_file_mode())
2176
self._inventory_is_modified = False
2178
def get_file_mtime(self, file_id, path=None):
2179
"""See Tree.get_file_mtime."""
2181
path = self.inventory.id2path(file_id)
2183
return os.lstat(self.abspath(path)).st_mtime
2185
if e.errno == errno.ENOENT:
2186
raise errors.FileTimestampUnavailable(path)
2189
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2190
file_id = self.path2id(path)
2192
# For unversioned files on win32, we just assume they are not
86
if file_id in self._statcache:
88
return os.path.exists(self.abspath(self.id2path(file_id)))
94
def _update_statcache(self):
96
if not self._statcache:
97
self._statcache = statcache.update_cache(self.basedir, self.inventory)
99
def get_file_size(self, file_id):
101
return os.stat(self._get_store_filename(file_id))[stat.ST_SIZE]
104
def get_file_sha1(self, file_id):
105
return self._statcache[file_id][statcache.SC_SHA1]
108
def file_class(self, filename):
109
if self.path2id(filename):
111
elif self.is_ignored(filename):
117
def list_files(self):
118
"""Recursively list all files as (path, class, kind, id).
2195
return self._inventory[file_id].executable
2197
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2198
mode = stat_result.st_mode
2199
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2201
def is_executable(self, file_id, path=None):
2202
if not self._supports_executable():
2203
return self._inventory[file_id].executable
2206
path = self.id2path(file_id)
2207
mode = os.lstat(self.abspath(path)).st_mode
2208
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2210
def _is_executable_from_path_and_stat(self, path, stat_result):
2211
if not self._supports_executable():
2212
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2214
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2216
@needs_tree_write_lock
2217
def _add(self, files, ids, kinds):
2218
"""See MutableTree._add."""
2219
# TODO: Re-adding a file that is removed in the working copy
2220
# should probably put it back with the previous ID.
2221
# the read and write working inventory should not occur in this
2222
# function - they should be part of lock_write and unlock.
2223
inv = self.inventory
2224
for f, file_id, kind in zip(files, ids, kinds):
2226
inv.add_path(f, kind=kind)
2228
inv.add_path(f, kind=kind, file_id=file_id)
2229
self._inventory_is_modified = True
2231
def revision_tree(self, revision_id):
2232
"""See WorkingTree.revision_id."""
2233
if revision_id == self.last_revision():
2235
xml = self.read_basis_inventory()
2236
except errors.NoSuchFile:
2240
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2241
# dont use the repository revision_tree api because we want
2242
# to supply the inventory.
2243
if inv.revision_id == revision_id:
2244
return revisiontree.InventoryRevisionTree(
2245
self.branch.repository, inv, revision_id)
2246
except errors.BadInventoryFormat:
2248
# raise if there was no inventory, or if we read the wrong inventory.
2249
raise errors.NoSuchRevisionInTree(self, revision_id)
2252
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2253
"""See Tree.annotate_iter
2255
This implementation will use the basis tree implementation if possible.
2256
Lines not in the basis are attributed to CURRENT_REVISION
2258
If there are pending merges, lines added by those merges will be
2259
incorrectly attributed to CURRENT_REVISION (but after committing, the
2260
attribution will be correct).
2262
maybe_file_parent_keys = []
2263
for parent_id in self.get_parent_ids():
2265
parent_tree = self.revision_tree(parent_id)
2266
except errors.NoSuchRevisionInTree:
2267
parent_tree = self.branch.repository.revision_tree(parent_id)
2268
parent_tree.lock_read()
2270
if not parent_tree.has_id(file_id):
2272
ie = parent_tree.inventory[file_id]
2273
if ie.kind != 'file':
2274
# Note: this is slightly unnecessary, because symlinks and
2275
# directories have a "text" which is the empty text, and we
2276
# know that won't mess up annotations. But it seems cleaner
2278
parent_text_key = (file_id, ie.revision)
2279
if parent_text_key not in maybe_file_parent_keys:
2280
maybe_file_parent_keys.append(parent_text_key)
2282
parent_tree.unlock()
2283
graph = _mod_graph.Graph(self.branch.repository.texts)
2284
heads = graph.heads(maybe_file_parent_keys)
2285
file_parent_keys = []
2286
for key in maybe_file_parent_keys:
2288
file_parent_keys.append(key)
2290
# Now we have the parents of this content
2291
annotator = self.branch.repository.texts.get_annotator()
2292
text = self.get_file_text(file_id)
2293
this_key =(file_id, default_revision)
2294
annotator.add_special_text(this_key, file_parent_keys, text)
2295
annotations = [(key[-1], line)
2296
for key, line in annotator.annotate_flat(this_key)]
2299
def _put_rio(self, filename, stanzas, header):
2300
self._must_be_locked()
2301
my_file = _mod_rio.rio_file(stanzas, header)
2302
self._transport.put_file(filename, my_file,
2303
mode=self.bzrdir._get_file_mode())
2305
@needs_tree_write_lock
2306
def set_merge_modified(self, modified_hashes):
2308
for file_id, hash in modified_hashes.iteritems():
2309
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2311
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2314
def merge_modified(self):
2315
"""Return a dictionary of files modified by a merge.
2317
The list is initialized by WorkingTree.set_merge_modified, which is
2318
typically called after we make some automatic updates to the tree
2321
This returns a map of file_id->sha1, containing only files which are
2322
still in the working inventory and have that text hash.
2325
hashfile = self._transport.get('merge-hashes')
2326
except errors.NoSuchFile:
2331
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2332
raise errors.MergeModifiedFormatError()
2333
except StopIteration:
2334
raise errors.MergeModifiedFormatError()
2335
for s in _mod_rio.RioReader(hashfile):
2336
# RioReader reads in Unicode, so convert file_ids back to utf8
2337
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2338
if not self.inventory.has_id(file_id):
2340
text_hash = s.get("hash")
2341
if text_hash == self.get_file_sha1(file_id):
2342
merge_hashes[file_id] = text_hash
2348
def subsume(self, other_tree):
2349
def add_children(inventory, entry):
2350
for child_entry in entry.children.values():
2351
inventory._byid[child_entry.file_id] = child_entry
2352
if child_entry.kind == 'directory':
2353
add_children(inventory, child_entry)
2354
if other_tree.get_root_id() == self.get_root_id():
2355
raise errors.BadSubsumeSource(self, other_tree,
2356
'Trees have the same root')
2358
other_tree_path = self.relpath(other_tree.basedir)
2359
except errors.PathNotChild:
2360
raise errors.BadSubsumeSource(self, other_tree,
2361
'Tree is not contained by the other')
2362
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2363
if new_root_parent is None:
2364
raise errors.BadSubsumeSource(self, other_tree,
2365
'Parent directory is not versioned.')
2366
# We need to ensure that the result of a fetch will have a
2367
# versionedfile for the other_tree root, and only fetching into
2368
# RepositoryKnit2 guarantees that.
2369
if not self.branch.repository.supports_rich_root():
2370
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2371
other_tree.lock_tree_write()
2373
new_parents = other_tree.get_parent_ids()
2374
other_root = other_tree.inventory.root
2375
other_root.parent_id = new_root_parent
2376
other_root.name = osutils.basename(other_tree_path)
2377
self.inventory.add(other_root)
2378
add_children(self.inventory, other_root)
2379
self._write_inventory(self.inventory)
2380
# normally we don't want to fetch whole repositories, but i think
2381
# here we really do want to consolidate the whole thing.
2382
for parent_id in other_tree.get_parent_ids():
2383
self.branch.fetch(other_tree.branch, parent_id)
2384
self.add_parent_tree_id(parent_id)
2387
other_tree.bzrdir.retire_bzrdir()
2389
@needs_tree_write_lock
2390
def extract(self, file_id, format=None):
2391
"""Extract a subtree from this tree.
2393
A new branch will be created, relative to the path for this tree.
2397
segments = osutils.splitpath(path)
2398
transport = self.branch.bzrdir.root_transport
2399
for name in segments:
2400
transport = transport.clone(name)
2401
transport.ensure_base()
2404
sub_path = self.id2path(file_id)
2405
branch_transport = mkdirs(sub_path)
2407
format = self.bzrdir.cloning_metadir()
2408
branch_transport.ensure_base()
2409
branch_bzrdir = format.initialize_on_transport(branch_transport)
2411
repo = branch_bzrdir.find_repository()
2412
except errors.NoRepositoryPresent:
2413
repo = branch_bzrdir.create_repository()
2414
if not repo.supports_rich_root():
2415
raise errors.RootNotRich()
2416
new_branch = branch_bzrdir.create_branch()
2417
new_branch.pull(self.branch)
2418
for parent_id in self.get_parent_ids():
2419
new_branch.fetch(self.branch, parent_id)
2420
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2421
if tree_transport.base != branch_transport.base:
2422
tree_bzrdir = format.initialize_on_transport(tree_transport)
2423
tree_bzrdir.set_branch_reference(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).
120
2441
Lists, but does not descend into unversioned directories.
122
2442
This does not include files that have been deleted in this
2443
tree. Skips the control directory.
125
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
127
from osutils import appendpath, file_kind
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)
130
2454
inv = self.inventory
132
def descend(from_dir_relpath, from_dir_id, dp):
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()
136
2489
## TODO: If we find a subdirectory with its own .bzr
137
2490
## directory, then that is a separate tree and we
138
2491
## should exclude it.
139
if bzrlib.BZRDIR == f:
2493
# the bzrdir for this tree
2494
if transport_base_dir == f:
143
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
146
fap = appendpath(dp, f)
148
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)
151
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:]):
156
2537
fk = file_kind(fap)
2539
# make a last minute entry
160
raise BzrCheckError("file %r entered as kind %r id %r, "
162
% (fap, f_ie.kind, f_ie.file_id, fk))
164
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()
166
2549
if fk != 'directory':
170
# don't descend unversioned directories
173
for ff in descend(fp, f_ie.file_id, fap):
176
for f in descend('', inv.root.file_id, self.basedir):
182
for subp in self.extras():
183
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
187
2897
def extras(self):
188
"""Yield all unknown files in this WorkingTree.
2898
"""Yield all unversioned files in this WorkingTree.
190
If there are any unknown directories then only the directory is
191
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
192
2902
under a versioned subdirectory, they are returned.
194
2904
Currently returned depth-first, sorted by name within directories.
2905
This is the same order used by 'osutils.walkdirs'.
196
2907
## TODO: Work from given directory downwards
197
from osutils import isdir, appendpath
199
2908
for path, dir_entry in self.inventory.directories():
200
mutter("search for unknowns in %r" % path)
2909
# mutter("search for unknowns in %r", path)
201
2910
dirabs = self.abspath(path)
202
2911
if not isdir(dirabs):
203
2912
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
