1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 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., 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
19
# FIXME: I don't know if writing out the cache from the destructor is really a
20
# good idea, because destructors are considered poor taste in Python, and
21
# it's not predictable when it will be written out.
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,
73
# Explicitly import bzrlib.bzrdir so that the BzrProber
74
# is guaranteed to be registered.
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
81
from bzrlib.i18n import gettext
82
from bzrlib.lock import LogicalLockResult
83
import bzrlib.mutabletree
84
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
from bzrlib.osutils import (
95
from bzrlib.trace import mutter, note
96
from bzrlib.revision import CURRENT_REVISION
97
from bzrlib.symbol_versioning import (
103
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
104
# TODO: Modifying the conflict objects or their type is currently nearly
105
# impossible as there is no clear relationship between the working tree format
106
# and the conflict list file format.
107
CONFLICT_HEADER_1 = "BZR conflict list format 1"
109
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
112
class TreeEntry(object):
113
"""An entry that implements the minimum interface used by commands.
115
This needs further inspection, it may be better to have
116
InventoryEntries without ids - though that seems wrong. For now,
117
this is a parallel hierarchy to InventoryEntry, and needs to become
118
one of several things: decorates to that hierarchy, children of, or
120
Another note is that these objects are currently only used when there is
121
no InventoryEntry available - i.e. for unversioned objects.
122
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
125
def __eq__(self, other):
126
# yes, this us ugly, TODO: best practice __eq__ style.
127
return (isinstance(other, TreeEntry)
128
and other.__class__ == self.__class__)
130
def kind_character(self):
134
class TreeDirectory(TreeEntry):
135
"""See TreeEntry. This is a directory in a working tree."""
137
def __eq__(self, other):
138
return (isinstance(other, TreeDirectory)
139
and other.__class__ == self.__class__)
141
def kind_character(self):
145
class TreeFile(TreeEntry):
146
"""See TreeEntry. This is a regular file in a working tree."""
148
def __eq__(self, other):
149
return (isinstance(other, TreeFile)
150
and other.__class__ == self.__class__)
152
def kind_character(self):
156
class TreeLink(TreeEntry):
157
"""See TreeEntry. This is a symlink in a working tree."""
159
def __eq__(self, other):
160
return (isinstance(other, TreeLink)
161
and other.__class__ == self.__class__)
163
def kind_character(self):
167
class WorkingTree(bzrlib.mutabletree.MutableTree,
168
controldir.ControlComponent):
27
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
28
from bzrlib.errors import BzrCheckError
29
from bzrlib.trace import mutter
31
class WorkingTree(bzrlib.tree.Tree):
169
32
"""Working copy tree.
171
:ivar basedir: The root of the tree on disk. This is a unicode path object
172
(as opposed to a URL).
34
The inventory is held in the `Branch` working-inventory, and the
35
files are in a directory on disk.
37
It is possible for a `WorkingTree` to have a filename which is
38
not listed in the Inventory and vice versa.
175
# override this to set the strategy for storing views
176
def _make_views(self):
177
return views.DisabledViews(self)
179
def __init__(self, basedir='.',
180
branch=DEPRECATED_PARAMETER,
185
"""Construct a WorkingTree instance. This is not a public API.
187
:param branch: A branch to override probing for the branch.
189
self._format = _format
190
self.bzrdir = _bzrdir
192
raise errors.BzrError("Please use bzrdir.open_workingtree or "
193
"WorkingTree.open() to obtain a WorkingTree.")
194
basedir = safe_unicode(basedir)
195
mutter("opening working tree %r", basedir)
196
if deprecated_passed(branch):
197
self._branch = branch
199
self._branch = self.bzrdir.open_branch()
200
self.basedir = realpath(basedir)
201
self._transport = _transport
202
self._rules_searcher = None
203
self.views = self._make_views()
206
def user_transport(self):
207
return self.bzrdir.user_transport
210
def control_transport(self):
211
return self._transport
213
def is_control_filename(self, filename):
214
"""True if filename is the name of a control file in this tree.
216
:param filename: A filename within the tree. This is a relative path
217
from the root of this tree.
219
This is true IF and ONLY IF the filename is part of the meta data
220
that bzr controls in this tree. I.E. a random .bzr directory placed
221
on disk will not be a control file for this tree.
223
return self.bzrdir.is_control_filename(filename)
226
fget=lambda self: self._branch,
227
doc="""The branch this WorkingTree is connected to.
229
This cannot be set - it is reflective of the actual disk structure
230
the working tree has been constructed from.
233
def has_versioned_directories(self):
234
"""See `Tree.has_versioned_directories`."""
235
return self._format.supports_versioned_directories
237
def _supports_executable(self):
238
if sys.platform == 'win32':
240
# FIXME: Ideally this should check the file system
243
def break_lock(self):
244
"""Break a lock if one is present from another instance.
246
Uses the ui factory to ask for confirmation if the lock may be from
249
This will probe the repository for its lock as well.
251
raise NotImplementedError(self.break_lock)
253
def requires_rich_root(self):
254
return self._format.requires_rich_root
256
def supports_tree_reference(self):
259
def supports_content_filtering(self):
260
return self._format.supports_content_filtering()
262
def supports_views(self):
263
return self.views.supports_views()
265
def get_config_stack(self):
266
"""Retrieve the config stack for this tree.
268
:return: A ``bzrlib.config.Stack``
270
# For the moment, just provide the branch config stack.
271
return self.branch.get_config_stack()
274
def open(path=None, _unsupported=False):
275
"""Open an existing working tree at path.
279
path = osutils.getcwd()
280
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
281
return control.open_workingtree(unsupported=_unsupported)
284
def open_containing(path=None):
285
"""Open an existing working tree which has its root about path.
287
This probes for a working tree at path and searches upwards from there.
289
Basically we keep looking up until we find the control directory or
290
run into /. If there isn't one, raises NotBranchError.
291
TODO: give this a new exception.
292
If there is one, it is returned, along with the unused portion of path.
294
:return: The WorkingTree that contains 'path', and the rest of path
297
path = osutils.getcwd()
298
control, relpath = controldir.ControlDir.open_containing(path)
299
return control.open_workingtree(), relpath
302
def open_containing_paths(file_list, default_directory=None,
303
canonicalize=True, apply_view=True):
304
"""Open the WorkingTree that contains a set of paths.
306
Fail if the paths given are not all in a single tree.
308
This is used for the many command-line interfaces that take a list of
309
any number of files and that require they all be in the same tree.
311
if default_directory is None:
312
default_directory = u'.'
313
# recommended replacement for builtins.internal_tree_files
314
if file_list is None or len(file_list) == 0:
315
tree = WorkingTree.open_containing(default_directory)[0]
316
# XXX: doesn't really belong here, and seems to have the strange
317
# side effect of making it return a bunch of files, not the whole
318
# tree -- mbp 20100716
319
if tree.supports_views() and apply_view:
320
view_files = tree.views.lookup_view()
322
file_list = view_files
323
view_str = views.view_display_str(view_files)
324
note(gettext("Ignoring files outside view. View is %s") % view_str)
325
return tree, file_list
326
if default_directory == u'.':
329
seed = default_directory
330
file_list = [osutils.pathjoin(default_directory, f)
332
tree = WorkingTree.open_containing(seed)[0]
333
return tree, tree.safe_relpath_files(file_list, canonicalize,
334
apply_view=apply_view)
336
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
337
"""Convert file_list into a list of relpaths in tree.
339
:param self: A tree to operate on.
340
:param file_list: A list of user provided paths or None.
341
:param apply_view: if True and a view is set, apply it or check that
342
specified files are within it
343
:return: A list of relative paths.
344
:raises errors.PathNotChild: When a provided path is in a different self
347
if file_list is None:
349
if self.supports_views() and apply_view:
350
view_files = self.views.lookup_view()
354
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
355
# doesn't - fix that up here before we enter the loop.
357
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
360
for filename in file_list:
361
relpath = fixer(osutils.dereference_path(filename))
362
if view_files and not osutils.is_inside_any(view_files, relpath):
363
raise errors.FileOutsideView(filename, view_files)
364
new_list.append(relpath)
368
def open_downlevel(path=None):
369
"""Open an unsupported working tree.
371
Only intended for advanced situations like upgrading part of a bzrdir.
373
return WorkingTree.open(path, _unsupported=True)
376
def find_trees(location):
377
def list_current(transport):
378
return [d for d in transport.list_dir('') if d != '.bzr']
379
def evaluate(bzrdir):
381
tree = bzrdir.open_workingtree()
382
except errors.NoWorkingTree:
386
t = transport.get_transport(location)
387
iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
388
list_current=list_current)
389
return [tr for tr in iterator if tr is not None]
40
def __init__(self, basedir, inv):
41
from bzrlib.hashcache import HashCache
42
from bzrlib.trace import note, mutter
45
self.basedir = basedir
46
self.path2id = inv.path2id
48
# update the whole cache up front and write to disk if anything changed;
49
# in the future we might want to do this more selectively
50
hc = self._hashcache = HashCache(basedir)
60
if self._hashcache.needs_write:
61
self._hashcache.write()
65
"""Iterate through file_ids for this tree.
67
file_ids are in a WorkingTree if they are in the working inventory
68
and the working file exists.
71
for path, ie in inv.iter_entries():
72
if os.path.exists(self.abspath(path)):
391
76
def __repr__(self):
392
77
return "<%s of %s>" % (self.__class__.__name__,
393
78
getattr(self, 'basedir', None))
395
82
def abspath(self, filename):
396
return pathjoin(self.basedir, filename)
398
def basis_tree(self):
399
"""Return RevisionTree for the current last revision.
401
If the left most parent is a ghost then the returned tree will be an
402
empty tree - one obtained by calling
403
repository.revision_tree(NULL_REVISION).
406
revision_id = self.get_parent_ids()[0]
408
# no parents, return an empty revision tree.
409
# in the future this should return the tree for
410
# 'empty:' - the implicit root empty tree.
411
return self.branch.repository.revision_tree(
412
_mod_revision.NULL_REVISION)
414
return self.revision_tree(revision_id)
415
except errors.NoSuchRevision:
417
# No cached copy available, retrieve from the repository.
418
# FIXME? RBC 20060403 should we cache the inventory locally
421
return self.branch.repository.revision_tree(revision_id)
422
except (errors.RevisionNotPresent, errors.NoSuchRevision):
423
# the basis tree *may* be a ghost or a low level error may have
424
# occurred. If the revision is present, its a problem, if its not
426
if self.branch.repository.has_revision(revision_id):
428
# the basis tree is a ghost so return an empty tree.
429
return self.branch.repository.revision_tree(
430
_mod_revision.NULL_REVISION)
433
self._flush_ignore_list_cache()
435
def relpath(self, path):
436
"""Return the local path portion from a given path.
438
The path may be absolute or relative. If its a relative path it is
439
interpreted relative to the python current working directory.
441
return osutils.relpath(self.basedir, path)
83
return os.path.join(self.basedir, filename)
443
85
def has_filename(self, filename):
444
return osutils.lexists(self.abspath(filename))
446
def get_file(self, file_id, path=None, filtered=True):
447
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
449
def get_file_with_stat(self, file_id, path=None, filtered=True,
450
_fstat=osutils.fstat):
451
"""See Tree.get_file_with_stat."""
453
path = self.id2path(file_id)
454
file_obj = self.get_file_byname(path, filtered=False)
455
stat_value = _fstat(file_obj.fileno())
456
if filtered and self.supports_content_filtering():
457
filters = self._content_filter_stack(path)
458
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
459
return (file_obj, stat_value)
461
def get_file_text(self, file_id, path=None, filtered=True):
462
my_file = self.get_file(file_id, path=path, filtered=filtered)
464
return my_file.read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return _mod_filters.filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
485
def get_parent_ids(self):
486
"""See Tree.get_parent_ids.
488
This implementation reads the pending merges list and last_revision
489
value and uses that to decide what the parents list should be.
491
last_rev = _mod_revision.ensure_null(self._last_revision())
492
if _mod_revision.NULL_REVISION == last_rev:
497
merges_bytes = self._transport.get_bytes('pending-merges')
498
except errors.NoSuchFile:
501
for l in osutils.split_lines(merges_bytes):
502
revision_id = l.rstrip('\n')
503
parents.append(revision_id)
506
def get_root_id(self):
507
"""Return the id of this trees root"""
508
raise NotImplementedError(self.get_root_id)
511
def clone(self, to_controldir, revision_id=None):
512
"""Duplicate this working tree into to_bzr, including all state.
514
Specifically modified files are kept as modified, but
515
ignored and unknown files are discarded.
517
If you want to make a new line of development, see ControlDir.sprout()
520
If not None, the cloned tree will have its last revision set to
521
revision, and difference between the source trees last revision
522
and this one merged in.
524
# assumes the target bzr dir format is compatible.
525
result = to_controldir.create_workingtree()
526
self.copy_content_into(result, revision_id)
530
def copy_content_into(self, tree, revision_id=None):
531
"""Copy the current content and user files of this tree into tree."""
532
tree.set_root_id(self.get_root_id())
533
if revision_id is None:
534
merge.transform_tree(tree, self)
536
# TODO now merge from tree.last_revision to revision (to preserve
537
# user local changes)
539
other_tree = self.revision_tree(revision_id)
540
except errors.NoSuchRevision:
541
other_tree = self.branch.repository.revision_tree(revision_id)
543
merge.transform_tree(tree, other_tree)
544
if revision_id == _mod_revision.NULL_REVISION:
547
new_parents = [revision_id]
548
tree.set_parent_ids(new_parents)
550
def id2abspath(self, file_id):
86
return os.path.exists(self.abspath(filename))
88
def get_file(self, file_id):
89
return self.get_file_byname(self.id2path(file_id))
91
def get_file_byname(self, filename):
92
return file(self.abspath(filename), 'rb')
94
def _get_store_filename(self, file_id):
95
## XXX: badly named; this isn't in the store at all
551
96
return self.abspath(self.id2path(file_id))
553
def _check_for_tree_references(self, iterator):
554
"""See if directories have become tree-references."""
555
blocked_parent_ids = set()
556
for path, ie in iterator:
557
if ie.parent_id in blocked_parent_ids:
558
# This entry was pruned because one of its parents became a
559
# TreeReference. If this is a directory, mark it as blocked.
560
if ie.kind == 'directory':
561
blocked_parent_ids.add(ie.file_id)
563
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
564
# This InventoryDirectory needs to be a TreeReference
565
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
566
blocked_parent_ids.add(ie.file_id)
569
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
570
"""See Tree.iter_entries_by_dir()"""
571
# The only trick here is that if we supports_tree_reference then we
572
# need to detect if a directory becomes a tree-reference.
573
iterator = super(WorkingTree, self).iter_entries_by_dir(
574
specific_file_ids=specific_file_ids,
575
yield_parents=yield_parents)
576
if not self.supports_tree_reference():
579
return self._check_for_tree_references(iterator)
581
def get_file_size(self, file_id):
582
"""See Tree.get_file_size"""
583
# XXX: this returns the on-disk size; it should probably return the
586
return os.path.getsize(self.id2abspath(file_id))
588
if e.errno != errno.ENOENT:
593
@needs_tree_write_lock
594
def _gather_kinds(self, files, kinds):
595
"""See MutableTree._gather_kinds."""
596
for pos, f in enumerate(files):
597
if kinds[pos] is None:
598
fullpath = normpath(self.abspath(f))
600
kinds[pos] = file_kind(fullpath)
602
if e.errno == errno.ENOENT:
603
raise errors.NoSuchFile(fullpath)
606
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
607
"""Add revision_id as a parent.
609
This is equivalent to retrieving the current list of parent ids
610
and setting the list to its value plus revision_id.
612
:param revision_id: The revision id to add to the parent list. It may
613
be a ghost revision as long as its not the first parent to be
614
added, or the allow_leftmost_as_ghost parameter is set True.
615
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
617
parents = self.get_parent_ids() + [revision_id]
618
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
619
or allow_leftmost_as_ghost)
621
@needs_tree_write_lock
622
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
623
"""Add revision_id, tree tuple as a parent.
625
This is equivalent to retrieving the current list of parent trees
626
and setting the list to its value plus parent_tuple. See also
627
add_parent_tree_id - if you only have a parent id available it will be
628
simpler to use that api. If you have the parent already available, using
629
this api is preferred.
631
:param parent_tuple: The (revision id, tree) to add to the parent list.
632
If the revision_id is a ghost, pass None for the tree.
633
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
635
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
636
if len(parent_ids) > 1:
637
# the leftmost may have already been a ghost, preserve that if it
639
allow_leftmost_as_ghost = True
640
self.set_parent_ids(parent_ids,
641
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
643
@needs_tree_write_lock
644
def add_pending_merge(self, *revision_ids):
645
# TODO: Perhaps should check at this point that the
646
# history of the revision is actually present?
647
parents = self.get_parent_ids()
649
for rev_id in revision_ids:
650
if rev_id in parents:
652
parents.append(rev_id)
655
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
657
def path_content_summary(self, path, _lstat=os.lstat,
658
_mapper=osutils.file_kind_from_stat_mode):
659
"""See Tree.path_content_summary."""
660
abspath = self.abspath(path)
662
stat_result = _lstat(abspath)
664
if getattr(e, 'errno', None) == errno.ENOENT:
666
return ('missing', None, None, None)
667
# propagate other errors
669
kind = _mapper(stat_result.st_mode)
671
return self._file_content_summary(path, stat_result)
672
elif kind == 'directory':
673
# perhaps it looks like a plain directory, but it's really a
675
if self._directory_is_tree_reference(path):
676
kind = 'tree-reference'
677
return kind, None, None, None
678
elif kind == 'symlink':
679
target = osutils.readlink(abspath)
680
return ('symlink', None, None, target)
682
return (kind, None, None, None)
684
def _file_content_summary(self, path, stat_result):
685
size = stat_result.st_size
686
executable = self._is_executable_from_path_and_stat(path, stat_result)
687
# try for a stat cache lookup
688
return ('file', size, executable, self._sha_from_stat(
691
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
692
"""Common ghost checking functionality from set_parent_*.
694
This checks that the left hand-parent exists if there are any
697
if len(revision_ids) > 0:
698
leftmost_id = revision_ids[0]
699
if (not allow_leftmost_as_ghost and not
700
self.branch.repository.has_revision(leftmost_id)):
701
raise errors.GhostRevisionUnusableHere(leftmost_id)
703
def _set_merges_from_parent_ids(self, parent_ids):
704
merges = parent_ids[1:]
705
self._transport.put_bytes('pending-merges', '\n'.join(merges),
706
mode=self.bzrdir._get_file_mode())
708
def _filter_parent_ids_by_ancestry(self, revision_ids):
709
"""Check that all merged revisions are proper 'heads'.
711
This will always return the first revision_id, and any merged revisions
714
if len(revision_ids) == 0:
716
graph = self.branch.repository.get_graph()
717
heads = graph.heads(revision_ids)
718
new_revision_ids = revision_ids[:1]
719
for revision_id in revision_ids[1:]:
720
if revision_id in heads and revision_id not in new_revision_ids:
721
new_revision_ids.append(revision_id)
722
if new_revision_ids != revision_ids:
723
mutter('requested to set revision_ids = %s,'
724
' but filtered to %s', revision_ids, new_revision_ids)
725
return new_revision_ids
727
@needs_tree_write_lock
728
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
729
"""Set the parent ids to revision_ids.
731
See also set_parent_trees. This api will try to retrieve the tree data
732
for each element of revision_ids from the trees repository. If you have
733
tree data already available, it is more efficient to use
734
set_parent_trees rather than set_parent_ids. set_parent_ids is however
735
an easier API to use.
737
:param revision_ids: The revision_ids to set as the parent ids of this
738
working tree. Any of these may be ghosts.
740
self._check_parents_for_ghosts(revision_ids,
741
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
742
for revision_id in revision_ids:
743
_mod_revision.check_not_reserved_id(revision_id)
745
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
747
if len(revision_ids) > 0:
748
self.set_last_revision(revision_ids[0])
750
self.set_last_revision(_mod_revision.NULL_REVISION)
752
self._set_merges_from_parent_ids(revision_ids)
754
@needs_tree_write_lock
755
def set_pending_merges(self, rev_list):
756
parents = self.get_parent_ids()
757
leftmost = parents[:1]
758
new_parents = leftmost + rev_list
759
self.set_parent_ids(new_parents)
761
@needs_tree_write_lock
762
def set_merge_modified(self, modified_hashes):
763
"""Set the merge modified hashes."""
764
raise NotImplementedError(self.set_merge_modified)
766
def _sha_from_stat(self, path, stat_result):
767
"""Get a sha digest from the tree's stat cache.
769
The default implementation assumes no stat cache is present.
771
:param path: The path.
772
:param stat_result: The stat result being looked up.
776
@needs_write_lock # because merge pulls data into the branch.
777
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
778
merge_type=None, force=False):
779
"""Merge from a branch into this working tree.
781
:param branch: The branch to merge from.
782
:param to_revision: If non-None, the merge will merge to to_revision,
783
but not beyond it. to_revision does not need to be in the history
784
of the branch when it is supplied. If None, to_revision defaults to
785
branch.last_revision().
787
from bzrlib.merge import Merger, Merge3Merger
788
merger = Merger(self.branch, this_tree=self)
789
# check that there are no local alterations
790
if not force and self.has_changes():
791
raise errors.UncommittedChanges(self)
792
if to_revision is None:
793
to_revision = _mod_revision.ensure_null(branch.last_revision())
794
merger.other_rev_id = to_revision
795
if _mod_revision.is_null(merger.other_rev_id):
796
raise errors.NoCommits(branch)
797
self.branch.fetch(branch, last_revision=merger.other_rev_id)
798
merger.other_basis = merger.other_rev_id
799
merger.other_tree = self.branch.repository.revision_tree(
801
merger.other_branch = branch
802
if from_revision is None:
805
merger.set_base_revision(from_revision, branch)
806
if merger.base_rev_id == merger.other_rev_id:
807
raise errors.PointlessMerge
808
merger.backup_files = False
809
if merge_type is None:
810
merger.merge_type = Merge3Merger
812
merger.merge_type = merge_type
813
merger.set_interesting_files(None)
814
merger.show_base = False
815
merger.reprocess = False
816
conflicts = merger.do_merge()
820
def merge_modified(self):
821
"""Return a dictionary of files modified by a merge.
823
The list is initialized by WorkingTree.set_merge_modified, which is
824
typically called after we make some automatic updates to the tree
827
This returns a map of file_id->sha1, containing only files which are
828
still in the working inventory and have that text hash.
830
raise NotImplementedError(self.merge_modified)
833
def mkdir(self, path, file_id=None):
834
"""See MutableTree.mkdir()."""
836
file_id = generate_ids.gen_file_id(os.path.basename(path))
837
os.mkdir(self.abspath(path))
838
self.add(path, file_id, 'directory')
841
def get_symlink_target(self, file_id, path=None):
843
abspath = self.abspath(path)
845
abspath = self.id2abspath(file_id)
846
target = osutils.readlink(abspath)
849
def subsume(self, other_tree):
850
raise NotImplementedError(self.subsume)
852
def _setup_directory_is_tree_reference(self):
853
if self._branch.repository._format.supports_tree_reference:
854
self._directory_is_tree_reference = \
855
self._directory_may_be_tree_reference
857
self._directory_is_tree_reference = \
858
self._directory_is_never_tree_reference
860
def _directory_is_never_tree_reference(self, relpath):
863
def _directory_may_be_tree_reference(self, relpath):
864
# as a special case, if a directory contains control files then
865
# it's a tree reference, except that the root of the tree is not
866
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
867
# TODO: We could ask all the control formats whether they
868
# recognize this directory, but at the moment there's no cheap api
869
# to do that. Since we probably can only nest bzr checkouts and
870
# they always use this name it's ok for now. -- mbp 20060306
872
# FIXME: There is an unhandled case here of a subdirectory
873
# containing .bzr but not a branch; that will probably blow up
874
# when you try to commit it. It might happen if there is a
875
# checkout in a subdirectory. This can be avoided by not adding
878
def extract(self, file_id, format=None):
879
"""Extract a subtree from this tree.
881
A new branch will be created, relative to the path for this tree.
883
raise NotImplementedError(self.extract)
886
"""Write the in memory meta data to disk."""
887
raise NotImplementedError(self.flush)
889
def _kind(self, relpath):
890
return osutils.file_kind(self.abspath(relpath))
892
def list_files(self, include_root=False, from_dir=None, recursive=True):
893
"""List all files as (path, class, kind, id, entry).
895
Lists, but does not descend into unversioned directories.
896
This does not include files that have been deleted in this
897
tree. Skips the control directory.
899
:param include_root: if True, return an entry for the root
900
:param from_dir: start from this directory or None for the root
901
:param recursive: whether to recurse into subdirectories or not
903
raise NotImplementedError(self.list_files)
905
def move(self, from_paths, to_dir=None, after=False):
908
to_dir must be known to the working tree.
910
If to_dir exists and is a directory, the files are moved into
911
it, keeping their old names.
913
Note that to_dir is only the last component of the new name;
914
this doesn't change the directory.
916
For each entry in from_paths the move mode will be determined
919
The first mode moves the file in the filesystem and updates the
920
working tree metadata. The second mode only updates the working tree
921
metadata without touching the file on the filesystem.
923
move uses the second mode if 'after == True' and the target is not
924
versioned but present in the working tree.
926
move uses the second mode if 'after == False' and the source is
927
versioned but no longer in the working tree, and the target is not
928
versioned but present in the working tree.
930
move uses the first mode if 'after == False' and the source is
931
versioned and present in the working tree, and the target is not
932
versioned and not present in the working tree.
934
Everything else results in an error.
936
This returns a list of (from_path, to_path) pairs for each
939
raise NotImplementedError(self.move)
941
@needs_tree_write_lock
942
def rename_one(self, from_rel, to_rel, after=False):
945
This can change the directory or the filename or both.
947
rename_one has several 'modes' to work. First, it can rename a physical
948
file and change the file_id. That is the normal mode. Second, it can
949
only change the file_id without touching any physical file.
951
rename_one uses the second mode if 'after == True' and 'to_rel' is
952
either not versioned or newly added, and present in the working tree.
954
rename_one uses the second mode if 'after == False' and 'from_rel' is
955
versioned but no longer in the working tree, and 'to_rel' is not
956
versioned but present in the working tree.
958
rename_one uses the first mode if 'after == False' and 'from_rel' is
959
versioned and present in the working tree, and 'to_rel' is not
960
versioned and not present in the working tree.
962
Everything else results in an error.
964
raise NotImplementedError(self.rename_one)
968
"""Return all unknown files.
970
These are files in the working directory that are not versioned or
971
control files or ignored.
973
# force the extras method to be fully executed before returning, to
974
# prevent race conditions with the lock
976
[subp for subp in self.extras() if not self.is_ignored(subp)])
978
def unversion(self, file_ids):
979
"""Remove the file ids in file_ids from the current versioned set.
981
When a file_id is unversioned, all of its children are automatically
984
:param file_ids: The file ids to stop versioning.
985
:raises: NoSuchId if any fileid is not currently versioned.
987
raise NotImplementedError(self.unversion)
990
def pull(self, source, overwrite=False, stop_revision=None,
991
change_reporter=None, possible_transports=None, local=False,
995
old_revision_info = self.branch.last_revision_info()
996
basis_tree = self.basis_tree()
997
count = self.branch.pull(source, overwrite, stop_revision,
998
possible_transports=possible_transports,
1000
new_revision_info = self.branch.last_revision_info()
1001
if new_revision_info != old_revision_info:
1002
repository = self.branch.repository
1003
if repository._format.fast_deltas:
1004
parent_ids = self.get_parent_ids()
1006
basis_id = parent_ids[0]
1007
basis_tree = repository.revision_tree(basis_id)
1008
basis_tree.lock_read()
1010
new_basis_tree = self.branch.basis_tree()
1017
change_reporter=change_reporter,
1018
show_base=show_base)
1019
basis_root_id = basis_tree.get_root_id()
1020
new_root_id = new_basis_tree.get_root_id()
1021
if new_root_id is not None and basis_root_id != new_root_id:
1022
self.set_root_id(new_root_id)
1025
# TODO - dedup parents list with things merged by pull ?
1026
# reuse the revisiontree we merged against to set the new
1029
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1030
parent_trees.append(
1031
(self.branch.last_revision(), new_basis_tree))
1032
# we have to pull the merge trees out again, because
1033
# merge_inner has set the ids. - this corner is not yet
1034
# layered well enough to prevent double handling.
1035
# XXX TODO: Fix the double handling: telling the tree about
1036
# the already known parent data is wasteful.
1037
merges = self.get_parent_ids()[1:]
1038
parent_trees.extend([
1039
(parent, repository.revision_tree(parent)) for
1041
self.set_parent_trees(parent_trees)
1047
def put_file_bytes_non_atomic(self, file_id, bytes):
1048
"""See MutableTree.put_file_bytes_non_atomic."""
1049
stream = file(self.id2abspath(file_id), 'wb')
1056
"""Yield all unversioned files in this WorkingTree.
1058
If there are any unversioned directories then only the directory is
1059
returned, not all its children. But if there are unversioned files
1060
under a versioned subdirectory, they are returned.
1062
Currently returned depth-first, sorted by name within directories.
1063
This is the same order used by 'osutils.walkdirs'.
1065
raise NotImplementedError(self.extras)
1067
def ignored_files(self):
1068
"""Yield list of PATH, IGNORE_PATTERN"""
1069
for subp in self.extras():
1070
pat = self.is_ignored(subp)
1074
def get_ignore_list(self):
1075
"""Return list of ignore patterns.
1077
Cached in the Tree object after the first call.
1079
ignoreset = getattr(self, '_ignoreset', None)
1080
if ignoreset is not None:
1083
ignore_globs = set()
1084
ignore_globs.update(ignores.get_runtime_ignores())
1085
ignore_globs.update(ignores.get_user_ignores())
1086
if self.has_filename(bzrlib.IGNORE_FILENAME):
1087
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1089
ignore_globs.update(ignores.parse_ignore_file(f))
1092
self._ignoreset = ignore_globs
1095
def _flush_ignore_list_cache(self):
1096
"""Resets the cached ignore list to force a cache rebuild."""
1097
self._ignoreset = None
1098
self._ignoreglobster = None
1100
def is_ignored(self, filename):
1101
r"""Check whether the filename matches an ignore pattern.
1103
Patterns containing '/' or '\' need to match the whole path;
1104
others match against only the last component. Patterns starting
1105
with '!' are ignore exceptions. Exceptions take precedence
1106
over regular patterns and cause the filename to not be ignored.
1108
If the file is ignored, returns the pattern which caused it to
1109
be ignored, otherwise None. So this can simply be used as a
1110
boolean if desired."""
1111
if getattr(self, '_ignoreglobster', None) is None:
1112
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1113
return self._ignoreglobster.match(filename)
1115
def kind(self, file_id):
1116
return file_kind(self.id2abspath(file_id))
1118
def stored_kind(self, file_id):
1119
"""See Tree.stored_kind"""
1120
raise NotImplementedError(self.stored_kind)
1122
def _comparison_data(self, entry, path):
1123
abspath = self.abspath(path)
1125
stat_value = os.lstat(abspath)
1127
if getattr(e, 'errno', None) == errno.ENOENT:
1134
mode = stat_value.st_mode
1135
kind = osutils.file_kind_from_stat_mode(mode)
1136
if not self._supports_executable():
1137
executable = entry is not None and entry.executable
1139
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1140
return kind, executable, stat_value
1142
def _file_size(self, entry, stat_value):
1143
return stat_value.st_size
1145
def last_revision(self):
1146
"""Return the last revision of the branch for this tree.
1148
This format tree does not support a separate marker for last-revision
1149
compared to the branch.
1151
See MutableTree.last_revision
1153
return self._last_revision()
1156
def _last_revision(self):
1157
"""helper for get_parent_ids."""
1158
return _mod_revision.ensure_null(self.branch.last_revision())
1160
def is_locked(self):
1161
"""Check if this tree is locked."""
1162
raise NotImplementedError(self.is_locked)
1164
def lock_read(self):
1165
"""Lock the tree for reading.
1167
This also locks the branch, and can be unlocked via self.unlock().
1169
:return: A bzrlib.lock.LogicalLockResult.
1171
raise NotImplementedError(self.lock_read)
1173
def lock_tree_write(self):
1174
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1176
:return: A bzrlib.lock.LogicalLockResult.
1178
raise NotImplementedError(self.lock_tree_write)
1180
def lock_write(self):
1181
"""See MutableTree.lock_write, and WorkingTree.unlock.
1183
:return: A bzrlib.lock.LogicalLockResult.
1185
raise NotImplementedError(self.lock_write)
1187
def get_physical_lock_status(self):
1188
raise NotImplementedError(self.get_physical_lock_status)
1190
def set_last_revision(self, new_revision):
1191
"""Change the last revision in the working tree."""
1192
raise NotImplementedError(self.set_last_revision)
1194
def _change_last_revision(self, new_revision):
1195
"""Template method part of set_last_revision to perform the change.
1197
This is used to allow WorkingTree3 instances to not affect branch
1198
when their last revision is set.
1200
if _mod_revision.is_null(new_revision):
1201
self.branch.set_last_revision_info(0, new_revision)
1203
_mod_revision.check_not_reserved_id(new_revision)
1205
self.branch.generate_revision_history(new_revision)
1206
except errors.NoSuchRevision:
1207
# not present in the repo - dont try to set it deeper than the tip
1208
self.branch._set_revision_history([new_revision])
1211
@needs_tree_write_lock
1212
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1214
"""Remove nominated files from the working tree metadata.
1216
:files: File paths relative to the basedir.
1217
:keep_files: If true, the files will also be kept.
1218
:force: Delete files and directories, even if they are changed and
1219
even if the directories are not empty.
1221
if isinstance(files, basestring):
1226
all_files = set() # specified and nested files
1227
unknown_nested_files=set()
1229
to_file = sys.stdout
1231
files_to_backup = []
1233
def recurse_directory_to_add_files(directory):
1234
# Recurse directory and add all files
1235
# so we can check if they have changed.
1236
for parent_info, file_infos in self.walkdirs(directory):
1237
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1238
# Is it versioned or ignored?
1239
if self.path2id(relpath):
1240
# Add nested content for deletion.
1241
all_files.add(relpath)
1243
# Files which are not versioned
1244
# should be treated as unknown.
1245
files_to_backup.append(relpath)
1247
for filename in files:
1248
# Get file name into canonical form.
1249
abspath = self.abspath(filename)
1250
filename = self.relpath(abspath)
1251
if len(filename) > 0:
1252
all_files.add(filename)
1253
recurse_directory_to_add_files(filename)
1255
files = list(all_files)
1258
return # nothing to do
1260
# Sort needed to first handle directory content before the directory
1261
files.sort(reverse=True)
1263
# Bail out if we are going to delete files we shouldn't
1264
if not keep_files and not force:
1265
for (file_id, path, content_change, versioned, parent_id, name,
1266
kind, executable) in self.iter_changes(self.basis_tree(),
1267
include_unchanged=True, require_versioned=False,
1268
want_unversioned=True, specific_files=files):
1269
if versioned[0] == False:
1270
# The record is unknown or newly added
1271
files_to_backup.append(path[1])
1272
elif (content_change and (kind[1] is not None) and
1273
osutils.is_inside_any(files, path[1])):
1274
# Versioned and changed, but not deleted, and still
1275
# in one of the dirs to be deleted.
1276
files_to_backup.append(path[1])
1278
def backup(file_to_backup):
1279
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1280
osutils.rename(abs_path, self.abspath(backup_name))
1281
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1284
# Build inv_delta and delete files where applicable,
1285
# do this before any modifications to meta data.
1287
fid = self.path2id(f)
1290
message = "%s is not versioned." % (f,)
1293
# having removed it, it must be either ignored or unknown
1294
if self.is_ignored(f):
1298
# XXX: Really should be a more abstract reporter interface
1299
kind_ch = osutils.kind_marker(self.kind(fid))
1300
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1302
inv_delta.append((f, None, fid, None))
1303
message = "removed %s" % (f,)
1306
abs_path = self.abspath(f)
1307
if osutils.lexists(abs_path):
1308
if (osutils.isdir(abs_path) and
1309
len(os.listdir(abs_path)) > 0):
1311
osutils.rmtree(abs_path)
1312
message = "deleted %s" % (f,)
1316
if f in files_to_backup:
1319
osutils.delete_any(abs_path)
1320
message = "deleted %s" % (f,)
1321
elif message is not None:
1322
# Only care if we haven't done anything yet.
1323
message = "%s does not exist." % (f,)
1325
# Print only one message (if any) per file.
1326
if message is not None:
1328
self.apply_inventory_delta(inv_delta)
1330
@needs_tree_write_lock
1331
def revert(self, filenames=None, old_tree=None, backups=True,
1332
pb=None, report_changes=False):
1333
from bzrlib.conflicts import resolve
1334
if old_tree is None:
1335
basis_tree = self.basis_tree()
1336
basis_tree.lock_read()
1337
old_tree = basis_tree
1341
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1343
if filenames is None and len(self.get_parent_ids()) > 1:
1345
last_revision = self.last_revision()
1346
if last_revision != _mod_revision.NULL_REVISION:
1347
if basis_tree is None:
1348
basis_tree = self.basis_tree()
1349
basis_tree.lock_read()
1350
parent_trees.append((last_revision, basis_tree))
1351
self.set_parent_trees(parent_trees)
1354
resolve(self, filenames, ignore_misses=True, recursive=True)
1356
if basis_tree is not None:
1361
def store_uncommitted(self):
1362
"""Store uncommitted changes from the tree in the branch."""
1363
target_tree = self.basis_tree()
1364
shelf_creator = shelf.ShelfCreator(self, target_tree)
1366
if not shelf_creator.shelve_all():
1368
self.branch.store_uncommitted(shelf_creator)
1369
shelf_creator.transform()
1371
shelf_creator.finalize()
1372
note('Uncommitted changes stored in branch "%s".', self.branch.nick)
1375
def restore_uncommitted(self):
1376
"""Restore uncommitted changes from the branch into the tree."""
1377
unshelver = self.branch.get_unshelver(self)
1378
if unshelver is None:
1381
merger = unshelver.make_merger()
1382
merger.ignore_zero = True
1384
self.branch.store_uncommitted(None)
1386
unshelver.finalize()
1388
def revision_tree(self, revision_id):
1389
"""See Tree.revision_tree.
1391
WorkingTree can supply revision_trees for the basis revision only
1392
because there is only one cached inventory in the bzr directory.
1394
raise NotImplementedError(self.revision_tree)
1396
@needs_tree_write_lock
1397
def set_root_id(self, file_id):
1398
"""Set the root id for this tree."""
1402
'WorkingTree.set_root_id with fileid=None')
1403
file_id = osutils.safe_file_id(file_id)
1404
self._set_root_id(file_id)
1406
def _set_root_id(self, file_id):
1407
"""Set the root id for this tree, in a format specific manner.
1409
:param file_id: The file id to assign to the root. It must not be
1410
present in the current inventory or an error will occur. It must
1411
not be None, but rather a valid file id.
1413
raise NotImplementedError(self._set_root_id)
1416
"""See Branch.unlock.
1418
WorkingTree locking just uses the Branch locking facilities.
1419
This is current because all working trees have an embedded branch
1420
within them. IF in the future, we were to make branch data shareable
1421
between multiple working trees, i.e. via shared storage, then we
1422
would probably want to lock both the local tree, and the branch.
1424
raise NotImplementedError(self.unlock)
1428
def update(self, change_reporter=None, possible_transports=None,
1429
revision=None, old_tip=_marker, show_base=False):
1430
"""Update a working tree along its branch.
1432
This will update the branch if its bound too, which means we have
1433
multiple trees involved:
1435
- The new basis tree of the master.
1436
- The old basis tree of the branch.
1437
- The old basis tree of the working tree.
1438
- The current working tree state.
1440
Pathologically, all three may be different, and non-ancestors of each
1441
other. Conceptually we want to:
1443
- Preserve the wt.basis->wt.state changes
1444
- Transform the wt.basis to the new master basis.
1445
- Apply a merge of the old branch basis to get any 'local' changes from
1447
- Restore the wt.basis->wt.state changes.
1449
There isn't a single operation at the moment to do that, so we:
1451
- Merge current state -> basis tree of the master w.r.t. the old tree
1453
- Do a 'normal' merge of the old branch basis if it is relevant.
1455
:param revision: The target revision to update to. Must be in the
1457
:param old_tip: If branch.update() has already been run, the value it
1458
returned (old tip of the branch or None). _marker is used
1461
if self.branch.get_bound_location() is not None:
1463
update_branch = (old_tip is self._marker)
1465
self.lock_tree_write()
1466
update_branch = False
1469
old_tip = self.branch.update(possible_transports)
1471
if old_tip is self._marker:
1473
return self._update_tree(old_tip, change_reporter, revision, show_base)
1477
@needs_tree_write_lock
1478
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1480
"""Update a tree to the master branch.
1482
:param old_tip: if supplied, the previous tip revision the branch,
1483
before it was changed to the master branch's tip.
1485
# here if old_tip is not None, it is the old tip of the branch before
1486
# it was updated from the master branch. This should become a pending
1487
# merge in the working tree to preserve the user existing work. we
1488
# cant set that until we update the working trees last revision to be
1489
# one from the new branch, because it will just get absorbed by the
1490
# parent de-duplication logic.
1492
# We MUST save it even if an error occurs, because otherwise the users
1493
# local work is unreferenced and will appear to have been lost.
1497
last_rev = self.get_parent_ids()[0]
1499
last_rev = _mod_revision.NULL_REVISION
1500
if revision is None:
1501
revision = self.branch.last_revision()
1503
old_tip = old_tip or _mod_revision.NULL_REVISION
1505
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1506
# the branch we are bound to was updated
1507
# merge those changes in first
1508
base_tree = self.basis_tree()
1509
other_tree = self.branch.repository.revision_tree(old_tip)
1510
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1511
base_tree, this_tree=self,
1512
change_reporter=change_reporter,
1513
show_base=show_base)
1515
self.add_parent_tree((old_tip, other_tree))
1516
note(gettext('Rerun update after fixing the conflicts.'))
1519
if last_rev != _mod_revision.ensure_null(revision):
1520
# the working tree is up to date with the branch
1521
# we can merge the specified revision from master
1522
to_tree = self.branch.repository.revision_tree(revision)
1523
to_root_id = to_tree.get_root_id()
1525
basis = self.basis_tree()
1528
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1529
self.set_root_id(to_root_id)
1534
# determine the branch point
1535
graph = self.branch.repository.get_graph()
1536
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1538
base_tree = self.branch.repository.revision_tree(base_rev_id)
1540
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1542
change_reporter=change_reporter,
1543
show_base=show_base)
1544
self.set_last_revision(revision)
1545
# TODO - dedup parents list with things merged by pull ?
1546
# reuse the tree we've updated to to set the basis:
1547
parent_trees = [(revision, to_tree)]
1548
merges = self.get_parent_ids()[1:]
1549
# Ideally we ask the tree for the trees here, that way the working
1550
# tree can decide whether to give us the entire tree or give us a
1551
# lazy initialised tree. dirstate for instance will have the trees
1552
# in ram already, whereas a last-revision + basis-inventory tree
1553
# will not, but also does not need them when setting parents.
1554
for parent in merges:
1555
parent_trees.append(
1556
(parent, self.branch.repository.revision_tree(parent)))
1557
if not _mod_revision.is_null(old_tip):
1558
parent_trees.append(
1559
(old_tip, self.branch.repository.revision_tree(old_tip)))
1560
self.set_parent_trees(parent_trees)
1561
last_rev = parent_trees[0][0]
1564
def set_conflicts(self, arg):
1565
raise errors.UnsupportedOperation(self.set_conflicts, self)
1567
def add_conflicts(self, arg):
1568
raise errors.UnsupportedOperation(self.add_conflicts, self)
1570
def conflicts(self):
1571
raise NotImplementedError(self.conflicts)
1573
def walkdirs(self, prefix=""):
1574
"""Walk the directories of this tree.
1576
returns a generator which yields items in the form:
1577
((curren_directory_path, fileid),
1578
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1581
This API returns a generator, which is only valid during the current
1582
tree transaction - within a single lock_read or lock_write duration.
1584
If the tree is not locked, it may cause an error to be raised,
1585
depending on the tree implementation.
1587
disk_top = self.abspath(prefix)
1588
if disk_top.endswith('/'):
1589
disk_top = disk_top[:-1]
1590
top_strip_len = len(disk_top) + 1
1591
inventory_iterator = self._walkdirs(prefix)
1592
disk_iterator = osutils.walkdirs(disk_top, prefix)
1594
current_disk = disk_iterator.next()
1595
disk_finished = False
1597
if not (e.errno == errno.ENOENT or
1598
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1601
disk_finished = True
1603
current_inv = inventory_iterator.next()
1604
inv_finished = False
1605
except StopIteration:
1608
while not inv_finished or not disk_finished:
1610
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1611
cur_disk_dir_content) = current_disk
1613
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1614
cur_disk_dir_content) = ((None, None), None)
1615
if not disk_finished:
1616
# strip out .bzr dirs
1617
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1618
len(cur_disk_dir_content) > 0):
1619
# osutils.walkdirs can be made nicer -
1620
# yield the path-from-prefix rather than the pathjoined
1622
bzrdir_loc = bisect_left(cur_disk_dir_content,
1624
if (bzrdir_loc < len(cur_disk_dir_content)
1625
and self.bzrdir.is_control_filename(
1626
cur_disk_dir_content[bzrdir_loc][0])):
1627
# we dont yield the contents of, or, .bzr itself.
1628
del cur_disk_dir_content[bzrdir_loc]
1630
# everything is unknown
1633
# everything is missing
1636
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1638
# disk is before inventory - unknown
1639
dirblock = [(relpath, basename, kind, stat, None, None) for
1640
relpath, basename, kind, stat, top_path in
1641
cur_disk_dir_content]
1642
yield (cur_disk_dir_relpath, None), dirblock
1644
current_disk = disk_iterator.next()
1645
except StopIteration:
1646
disk_finished = True
1648
# inventory is before disk - missing.
1649
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1650
for relpath, basename, dkind, stat, fileid, kind in
1652
yield (current_inv[0][0], current_inv[0][1]), dirblock
1654
current_inv = inventory_iterator.next()
1655
except StopIteration:
1658
# versioned present directory
1659
# merge the inventory and disk data together
1661
for relpath, subiterator in itertools.groupby(sorted(
1662
current_inv[1] + cur_disk_dir_content,
1663
key=operator.itemgetter(0)), operator.itemgetter(1)):
1664
path_elements = list(subiterator)
1665
if len(path_elements) == 2:
1666
inv_row, disk_row = path_elements
1667
# versioned, present file
1668
dirblock.append((inv_row[0],
1669
inv_row[1], disk_row[2],
1670
disk_row[3], inv_row[4],
1672
elif len(path_elements[0]) == 5:
1674
dirblock.append((path_elements[0][0],
1675
path_elements[0][1], path_elements[0][2],
1676
path_elements[0][3], None, None))
1677
elif len(path_elements[0]) == 6:
1678
# versioned, absent file.
1679
dirblock.append((path_elements[0][0],
1680
path_elements[0][1], 'unknown', None,
1681
path_elements[0][4], path_elements[0][5]))
1683
raise NotImplementedError('unreachable code')
1684
yield current_inv[0], dirblock
1686
current_inv = inventory_iterator.next()
1687
except StopIteration:
1690
current_disk = disk_iterator.next()
1691
except StopIteration:
1692
disk_finished = True
1694
def _walkdirs(self, prefix=""):
1695
"""Walk the directories of this tree.
1697
:param prefix: is used as the directrory to start with.
1698
:returns: a generator which yields items in the form::
1700
((curren_directory_path, fileid),
1701
[(file1_path, file1_name, file1_kind, None, file1_id,
1704
raise NotImplementedError(self._walkdirs)
1706
@needs_tree_write_lock
1707
def auto_resolve(self):
1708
"""Automatically resolve text conflicts according to contents.
1710
Only text conflicts are auto_resolvable. Files with no conflict markers
1711
are considered 'resolved', because bzr always puts conflict markers
1712
into files that have text conflicts. The corresponding .THIS .BASE and
1713
.OTHER files are deleted, as per 'resolve'.
1715
:return: a tuple of ConflictLists: (un_resolved, resolved).
1717
un_resolved = _mod_conflicts.ConflictList()
1718
resolved = _mod_conflicts.ConflictList()
1719
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1720
for conflict in self.conflicts():
1721
if (conflict.typestring != 'text conflict' or
1722
self.kind(conflict.file_id) != 'file'):
1723
un_resolved.append(conflict)
1725
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1727
for line in my_file:
1728
if conflict_re.search(line):
1729
un_resolved.append(conflict)
1732
resolved.append(conflict)
1735
resolved.remove_files(self)
1736
self.set_conflicts(un_resolved)
1737
return un_resolved, resolved
1739
def _validate(self):
1740
"""Validate internal structures.
1742
This is meant mostly for the test suite. To give it a chance to detect
1743
corruption after actions have occurred. The default implementation is a
1746
:return: None. An exception should be raised if there is an error.
1750
def check_state(self):
1751
"""Check that the working state is/isn't valid."""
1752
raise NotImplementedError(self.check_state)
1754
def reset_state(self, revision_ids=None):
1755
"""Reset the state of the working tree.
1757
This does a hard-reset to a last-known-good state. This is a way to
1758
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1760
raise NotImplementedError(self.reset_state)
1762
def _get_rules_searcher(self, default_searcher):
1763
"""See Tree._get_rules_searcher."""
1764
if self._rules_searcher is None:
1765
self._rules_searcher = super(WorkingTree,
1766
self)._get_rules_searcher(default_searcher)
1767
return self._rules_searcher
1769
def get_shelf_manager(self):
1770
"""Return the ShelfManager for this WorkingTree."""
1771
from bzrlib.shelf import ShelfManager
1772
return ShelfManager(self, self._transport)
1775
class InventoryWorkingTree(WorkingTree,
1776
bzrlib.mutabletree.MutableInventoryTree):
1777
"""Base class for working trees that are inventory-oriented.
1779
The inventory is held in the `Branch` working-inventory, and the
1780
files are in a directory on disk.
1782
It is possible for a `WorkingTree` to have a filename which is
1783
not listed in the Inventory and vice versa.
1786
def __init__(self, basedir='.',
1787
branch=DEPRECATED_PARAMETER,
1789
_control_files=None,
1793
"""Construct a InventoryWorkingTree instance. This is not a public API.
1795
:param branch: A branch to override probing for the branch.
1797
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1798
branch=branch, _transport=_control_files._transport,
1799
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1801
self._control_files = _control_files
1802
self._detect_case_handling()
1804
if _inventory is None:
1805
# This will be acquired on lock_read() or lock_write()
1806
self._inventory_is_modified = False
1807
self._inventory = None
1809
# the caller of __init__ has provided an inventory,
1810
# we assume they know what they are doing - as its only
1811
# the Format factory and creation methods that are
1812
# permitted to do this.
1813
self._set_inventory(_inventory, dirty=False)
1815
def _set_inventory(self, inv, dirty):
1816
"""Set the internal cached inventory.
1818
:param inv: The inventory to set.
1819
:param dirty: A boolean indicating whether the inventory is the same
1820
logical inventory as whats on disk. If True the inventory is not
1821
the same and should be written to disk or data will be lost, if
1822
False then the inventory is the same as that on disk and any
1823
serialisation would be unneeded overhead.
1825
self._inventory = inv
1826
self._inventory_is_modified = dirty
1828
def _detect_case_handling(self):
1829
wt_trans = self.bzrdir.get_workingtree_transport(None)
1831
wt_trans.stat(self._format.case_sensitive_filename)
1832
except errors.NoSuchFile:
1833
self.case_sensitive = True
1835
self.case_sensitive = False
1837
self._setup_directory_is_tree_reference()
1839
def _serialize(self, inventory, out_file):
1840
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1843
def _deserialize(selt, in_file):
1844
return xml5.serializer_v5.read_inventory(in_file)
1846
def break_lock(self):
1847
"""Break a lock if one is present from another instance.
1849
Uses the ui factory to ask for confirmation if the lock may be from
1852
This will probe the repository for its lock as well.
1854
self._control_files.break_lock()
1855
self.branch.break_lock()
1857
def is_locked(self):
1858
return self._control_files.is_locked()
1860
def _must_be_locked(self):
1861
if not self.is_locked():
1862
raise errors.ObjectNotLocked(self)
1864
def lock_read(self):
1865
"""Lock the tree for reading.
1867
This also locks the branch, and can be unlocked via self.unlock().
1869
:return: A bzrlib.lock.LogicalLockResult.
1871
if not self.is_locked():
1873
self.branch.lock_read()
1875
self._control_files.lock_read()
1876
return LogicalLockResult(self.unlock)
1878
self.branch.unlock()
1881
def lock_tree_write(self):
1882
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1884
:return: A bzrlib.lock.LogicalLockResult.
1886
if not self.is_locked():
1888
self.branch.lock_read()
1890
self._control_files.lock_write()
1891
return LogicalLockResult(self.unlock)
1893
self.branch.unlock()
1896
def lock_write(self):
1897
"""See MutableTree.lock_write, and WorkingTree.unlock.
1899
:return: A bzrlib.lock.LogicalLockResult.
1901
if not self.is_locked():
1903
self.branch.lock_write()
1905
self._control_files.lock_write()
1906
return LogicalLockResult(self.unlock)
1908
self.branch.unlock()
1911
def get_physical_lock_status(self):
1912
return self._control_files.get_physical_lock_status()
1914
@needs_tree_write_lock
1915
def _write_inventory(self, inv):
1916
"""Write inventory as the current inventory."""
1917
self._set_inventory(inv, dirty=True)
1920
# XXX: This method should be deprecated in favour of taking in a proper
1921
# new Inventory object.
1922
@needs_tree_write_lock
1923
def set_inventory(self, new_inventory_list):
1924
from bzrlib.inventory import (Inventory,
1928
inv = Inventory(self.get_root_id())
1929
for path, file_id, parent, kind in new_inventory_list:
1930
name = os.path.basename(path)
1933
# fixme, there should be a factory function inv,add_??
1934
if kind == 'directory':
1935
inv.add(InventoryDirectory(file_id, name, parent))
1936
elif kind == 'file':
1937
inv.add(InventoryFile(file_id, name, parent))
1938
elif kind == 'symlink':
1939
inv.add(InventoryLink(file_id, name, parent))
1941
raise errors.BzrError("unknown kind %r" % kind)
1942
self._write_inventory(inv)
1944
def _write_basis_inventory(self, xml):
1945
"""Write the basis inventory XML to the basis-inventory file"""
1946
path = self._basis_inventory_name()
1948
self._transport.put_file(path, sio,
1949
mode=self.bzrdir._get_file_mode())
1951
def _reset_data(self):
1952
"""Reset transient data that cannot be revalidated."""
1953
self._inventory_is_modified = False
1954
f = self._transport.get('inventory')
1956
result = self._deserialize(f)
1959
self._set_inventory(result, dirty=False)
1961
def _set_root_id(self, file_id):
1962
"""Set the root id for this tree, in a format specific manner.
1964
:param file_id: The file id to assign to the root. It must not be
1965
present in the current inventory or an error will occur. It must
1966
not be None, but rather a valid file id.
1968
inv = self._inventory
1969
orig_root_id = inv.root.file_id
1970
# TODO: it might be nice to exit early if there was nothing
1971
# to do, saving us from trigger a sync on unlock.
1972
self._inventory_is_modified = True
1973
# we preserve the root inventory entry object, but
1974
# unlinkit from the byid index
1975
del inv._byid[inv.root.file_id]
1976
inv.root.file_id = file_id
1977
# and link it into the index with the new changed id.
1978
inv._byid[inv.root.file_id] = inv.root
1979
# and finally update all children to reference the new id.
1980
# XXX: this should be safe to just look at the root.children
1981
# list, not the WHOLE INVENTORY.
1984
if entry.parent_id == orig_root_id:
1985
entry.parent_id = inv.root.file_id
1987
@needs_tree_write_lock
1988
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1989
"""See MutableTree.set_parent_trees."""
1990
parent_ids = [rev for (rev, tree) in parents_list]
1991
for revision_id in parent_ids:
1992
_mod_revision.check_not_reserved_id(revision_id)
1994
self._check_parents_for_ghosts(parent_ids,
1995
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1997
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1999
if len(parent_ids) == 0:
2000
leftmost_parent_id = _mod_revision.NULL_REVISION
2001
leftmost_parent_tree = None
2003
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
2005
if self._change_last_revision(leftmost_parent_id):
2006
if leftmost_parent_tree is None:
2007
# If we don't have a tree, fall back to reading the
2008
# parent tree from the repository.
2009
self._cache_basis_inventory(leftmost_parent_id)
2011
inv = leftmost_parent_tree.root_inventory
2012
xml = self._create_basis_xml_from_inventory(
2013
leftmost_parent_id, inv)
2014
self._write_basis_inventory(xml)
2015
self._set_merges_from_parent_ids(parent_ids)
2017
def _cache_basis_inventory(self, new_revision):
2018
"""Cache new_revision as the basis inventory."""
2019
# TODO: this should allow the ready-to-use inventory to be passed in,
2020
# as commit already has that ready-to-use [while the format is the
2023
# this double handles the inventory - unpack and repack -
2024
# but is easier to understand. We can/should put a conditional
2025
# in here based on whether the inventory is in the latest format
2026
# - perhaps we should repack all inventories on a repository
2028
# the fast path is to copy the raw xml from the repository. If the
2029
# xml contains 'revision_id="', then we assume the right
2030
# revision_id is set. We must check for this full string, because a
2031
# root node id can legitimately look like 'revision_id' but cannot
2033
xml = self.branch.repository._get_inventory_xml(new_revision)
2034
firstline = xml.split('\n', 1)[0]
2035
if (not 'revision_id="' in firstline or
2036
'format="7"' not in firstline):
2037
inv = self.branch.repository._serializer.read_inventory_from_string(
2039
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2040
self._write_basis_inventory(xml)
2041
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2044
def _basis_inventory_name(self):
2045
return 'basis-inventory-cache'
2047
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2048
"""Create the text that will be saved in basis-inventory"""
2049
inventory.revision_id = revision_id
2050
return xml7.serializer_v7.write_inventory_to_string(inventory)
2052
@needs_tree_write_lock
2053
def set_conflicts(self, conflicts):
2054
self._put_rio('conflicts', conflicts.to_stanzas(),
2057
@needs_tree_write_lock
2058
def add_conflicts(self, new_conflicts):
2059
conflict_set = set(self.conflicts())
2060
conflict_set.update(set(list(new_conflicts)))
2061
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2062
key=_mod_conflicts.Conflict.sort_key)))
2065
def conflicts(self):
2067
confile = self._transport.get('conflicts')
2068
except errors.NoSuchFile:
2069
return _mod_conflicts.ConflictList()
2072
if confile.next() != CONFLICT_HEADER_1 + '\n':
2073
raise errors.ConflictFormatError()
2074
except StopIteration:
2075
raise errors.ConflictFormatError()
2076
reader = _mod_rio.RioReader(confile)
2077
return _mod_conflicts.ConflictList.from_stanzas(reader)
2081
def read_basis_inventory(self):
2082
"""Read the cached basis inventory."""
2083
path = self._basis_inventory_name()
2084
return self._transport.get_bytes(path)
2087
def read_working_inventory(self):
2088
"""Read the working inventory.
2090
:raises errors.InventoryModified: read_working_inventory will fail
2091
when the current in memory inventory has been modified.
2093
# conceptually this should be an implementation detail of the tree.
2094
# XXX: Deprecate this.
2095
# ElementTree does its own conversion from UTF-8, so open in
2097
if self._inventory_is_modified:
2098
raise errors.InventoryModified(self)
2099
f = self._transport.get('inventory')
2101
result = self._deserialize(f)
2104
self._set_inventory(result, dirty=False)
2108
def get_root_id(self):
2109
"""Return the id of this trees root"""
2110
return self._inventory.root.file_id
2112
99
def has_id(self, file_id):
2113
100
# files that have been deleted are excluded
2114
inv, inv_file_id = self._unpack_file_id(file_id)
2115
if not inv.has_id(inv_file_id):
2117
path = inv.id2path(inv_file_id)
2118
return osutils.lexists(self.abspath(path))
2120
def has_or_had_id(self, file_id):
2121
if file_id == self.get_root_id():
2123
inv, inv_file_id = self._unpack_file_id(file_id)
2124
return inv.has_id(inv_file_id)
2126
def all_file_ids(self):
2127
"""Iterate through file_ids for this tree.
2129
file_ids are in a WorkingTree if they are in the working inventory
2130
and the working file exists.
2133
for path, ie in self.iter_entries_by_dir():
2137
@needs_tree_write_lock
2138
def set_last_revision(self, new_revision):
2139
"""Change the last revision in the working tree."""
2140
if self._change_last_revision(new_revision):
2141
self._cache_basis_inventory(new_revision)
2143
def _get_check_refs(self):
2144
"""Return the references needed to perform a check of this tree.
2146
The default implementation returns no refs, and is only suitable for
2147
trees that have no local caching and can commit on ghosts at any time.
2149
:seealso: bzrlib.check for details about check_refs.
2154
def _check(self, references):
2155
"""Check the tree for consistency.
2157
:param references: A dict with keys matching the items returned by
2158
self._get_check_refs(), and values from looking those keys up in
2161
tree_basis = self.basis_tree()
2162
tree_basis.lock_read()
2164
repo_basis = references[('trees', self.last_revision())]
2165
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2166
raise errors.BzrCheckError(
2167
"Mismatched basis inventory content.")
2173
def check_state(self):
2174
"""Check that the working state is/isn't valid."""
2175
check_refs = self._get_check_refs()
2177
for ref in check_refs:
2180
refs[ref] = self.branch.repository.revision_tree(value)
2183
@needs_tree_write_lock
2184
def reset_state(self, revision_ids=None):
2185
"""Reset the state of the working tree.
2187
This does a hard-reset to a last-known-good state. This is a way to
2188
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2190
if revision_ids is None:
2191
revision_ids = self.get_parent_ids()
2192
if not revision_ids:
2193
rt = self.branch.repository.revision_tree(
2194
_mod_revision.NULL_REVISION)
2196
rt = self.branch.repository.revision_tree(revision_ids[0])
2197
self._write_inventory(rt.root_inventory)
2198
self.set_parent_ids(revision_ids)
2201
"""Write the in memory inventory to disk."""
2202
# TODO: Maybe this should only write on dirty ?
2203
if self._control_files._lock_mode != 'w':
2204
raise errors.NotWriteLocked(self)
2206
self._serialize(self._inventory, sio)
2208
self._transport.put_file('inventory', sio,
2209
mode=self.bzrdir._get_file_mode())
2210
self._inventory_is_modified = False
2212
def get_file_mtime(self, file_id, path=None):
2213
"""See Tree.get_file_mtime."""
2215
path = self.id2path(file_id)
2217
return os.lstat(self.abspath(path)).st_mtime
2219
if e.errno == errno.ENOENT:
2220
raise errors.FileTimestampUnavailable(path)
2223
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2224
inv, file_id = self._path2inv_file_id(path)
2226
# For unversioned files on win32, we just assume they are not
2229
return inv[file_id].executable
2231
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2232
mode = stat_result.st_mode
2233
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2235
def is_executable(self, file_id, path=None):
2236
if not self._supports_executable():
2237
inv, inv_file_id = self._unpack_file_id(file_id)
2238
return inv[inv_file_id].executable
2241
path = self.id2path(file_id)
2242
mode = os.lstat(self.abspath(path)).st_mode
2243
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2245
def _is_executable_from_path_and_stat(self, path, stat_result):
2246
if not self._supports_executable():
2247
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2249
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2251
@needs_tree_write_lock
2252
def _add(self, files, ids, kinds):
2253
"""See MutableTree._add."""
2254
# TODO: Re-adding a file that is removed in the working copy
2255
# should probably put it back with the previous ID.
2256
# the read and write working inventory should not occur in this
2257
# function - they should be part of lock_write and unlock.
2258
# FIXME: nested trees
2259
inv = self.root_inventory
2260
for f, file_id, kind in zip(files, ids, kinds):
2262
inv.add_path(f, kind=kind)
2264
inv.add_path(f, kind=kind, file_id=file_id)
2265
self._inventory_is_modified = True
2267
def revision_tree(self, revision_id):
2268
"""See WorkingTree.revision_id."""
2269
if revision_id == self.last_revision():
2271
xml = self.read_basis_inventory()
2272
except errors.NoSuchFile:
2276
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2277
# dont use the repository revision_tree api because we want
2278
# to supply the inventory.
2279
if inv.revision_id == revision_id:
2280
return revisiontree.InventoryRevisionTree(
2281
self.branch.repository, inv, revision_id)
2282
except errors.BadInventoryFormat:
2284
# raise if there was no inventory, or if we read the wrong inventory.
2285
raise errors.NoSuchRevisionInTree(self, revision_id)
2288
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2289
"""See Tree.annotate_iter
2291
This implementation will use the basis tree implementation if possible.
2292
Lines not in the basis are attributed to CURRENT_REVISION
2294
If there are pending merges, lines added by those merges will be
2295
incorrectly attributed to CURRENT_REVISION (but after committing, the
2296
attribution will be correct).
2298
maybe_file_parent_keys = []
2299
for parent_id in self.get_parent_ids():
2301
parent_tree = self.revision_tree(parent_id)
2302
except errors.NoSuchRevisionInTree:
2303
parent_tree = self.branch.repository.revision_tree(parent_id)
2304
parent_tree.lock_read()
2307
kind = parent_tree.kind(file_id)
2308
except errors.NoSuchId:
2311
# Note: this is slightly unnecessary, because symlinks and
2312
# directories have a "text" which is the empty text, and we
2313
# know that won't mess up annotations. But it seems cleaner
2316
file_id, parent_tree.get_file_revision(file_id))
2317
if parent_text_key not in maybe_file_parent_keys:
2318
maybe_file_parent_keys.append(parent_text_key)
2320
parent_tree.unlock()
2321
graph = _mod_graph.Graph(self.branch.repository.texts)
2322
heads = graph.heads(maybe_file_parent_keys)
2323
file_parent_keys = []
2324
for key in maybe_file_parent_keys:
2326
file_parent_keys.append(key)
2328
# Now we have the parents of this content
2329
annotator = self.branch.repository.texts.get_annotator()
2330
text = self.get_file_text(file_id)
2331
this_key =(file_id, default_revision)
2332
annotator.add_special_text(this_key, file_parent_keys, text)
2333
annotations = [(key[-1], line)
2334
for key, line in annotator.annotate_flat(this_key)]
2337
def _put_rio(self, filename, stanzas, header):
2338
self._must_be_locked()
2339
my_file = _mod_rio.rio_file(stanzas, header)
2340
self._transport.put_file(filename, my_file,
2341
mode=self.bzrdir._get_file_mode())
2343
@needs_tree_write_lock
2344
def set_merge_modified(self, modified_hashes):
2346
for file_id, hash in modified_hashes.iteritems():
2347
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2349
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2352
def merge_modified(self):
2353
"""Return a dictionary of files modified by a merge.
2355
The list is initialized by WorkingTree.set_merge_modified, which is
2356
typically called after we make some automatic updates to the tree
2359
This returns a map of file_id->sha1, containing only files which are
2360
still in the working inventory and have that text hash.
2363
hashfile = self._transport.get('merge-hashes')
2364
except errors.NoSuchFile:
2369
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2370
raise errors.MergeModifiedFormatError()
2371
except StopIteration:
2372
raise errors.MergeModifiedFormatError()
2373
for s in _mod_rio.RioReader(hashfile):
2374
# RioReader reads in Unicode, so convert file_ids back to utf8
2375
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2376
if not self.has_id(file_id):
2378
text_hash = s.get("hash")
2379
if text_hash == self.get_file_sha1(file_id):
2380
merge_hashes[file_id] = text_hash
2386
def subsume(self, other_tree):
2387
def add_children(inventory, entry):
2388
for child_entry in entry.children.values():
2389
inventory._byid[child_entry.file_id] = child_entry
2390
if child_entry.kind == 'directory':
2391
add_children(inventory, child_entry)
2392
if other_tree.get_root_id() == self.get_root_id():
2393
raise errors.BadSubsumeSource(self, other_tree,
2394
'Trees have the same root')
2396
other_tree_path = self.relpath(other_tree.basedir)
2397
except errors.PathNotChild:
2398
raise errors.BadSubsumeSource(self, other_tree,
2399
'Tree is not contained by the other')
2400
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2401
if new_root_parent is None:
2402
raise errors.BadSubsumeSource(self, other_tree,
2403
'Parent directory is not versioned.')
2404
# We need to ensure that the result of a fetch will have a
2405
# versionedfile for the other_tree root, and only fetching into
2406
# RepositoryKnit2 guarantees that.
2407
if not self.branch.repository.supports_rich_root():
2408
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2409
other_tree.lock_tree_write()
2411
new_parents = other_tree.get_parent_ids()
2412
other_root = other_tree.root_inventory.root
2413
other_root.parent_id = new_root_parent
2414
other_root.name = osutils.basename(other_tree_path)
2415
self.root_inventory.add(other_root)
2416
add_children(self.root_inventory, other_root)
2417
self._write_inventory(self.root_inventory)
2418
# normally we don't want to fetch whole repositories, but i think
2419
# here we really do want to consolidate the whole thing.
2420
for parent_id in other_tree.get_parent_ids():
2421
self.branch.fetch(other_tree.branch, parent_id)
2422
self.add_parent_tree_id(parent_id)
2425
other_tree.bzrdir.retire_bzrdir()
2427
@needs_tree_write_lock
2428
def extract(self, file_id, format=None):
2429
"""Extract a subtree from this tree.
2431
A new branch will be created, relative to the path for this tree.
2435
segments = osutils.splitpath(path)
2436
transport = self.branch.bzrdir.root_transport
2437
for name in segments:
2438
transport = transport.clone(name)
2439
transport.ensure_base()
2442
sub_path = self.id2path(file_id)
2443
branch_transport = mkdirs(sub_path)
2445
format = self.bzrdir.cloning_metadir()
2446
branch_transport.ensure_base()
2447
branch_bzrdir = format.initialize_on_transport(branch_transport)
2449
repo = branch_bzrdir.find_repository()
2450
except errors.NoRepositoryPresent:
2451
repo = branch_bzrdir.create_repository()
2452
if not repo.supports_rich_root():
2453
raise errors.RootNotRich()
2454
new_branch = branch_bzrdir.create_branch()
2455
new_branch.pull(self.branch)
2456
for parent_id in self.get_parent_ids():
2457
new_branch.fetch(self.branch, parent_id)
2458
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2459
if tree_transport.base != branch_transport.base:
2460
tree_bzrdir = format.initialize_on_transport(tree_transport)
2461
tree_bzrdir.set_branch_reference(new_branch)
2463
tree_bzrdir = branch_bzrdir
2464
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2465
wt.set_parent_ids(self.get_parent_ids())
2466
# FIXME: Support nested trees
2467
my_inv = self.root_inventory
2468
child_inv = inventory.Inventory(root_id=None)
2469
new_root = my_inv[file_id]
2470
my_inv.remove_recursive_id(file_id)
2471
new_root.parent_id = None
2472
child_inv.add(new_root)
2473
self._write_inventory(my_inv)
2474
wt._write_inventory(child_inv)
2477
def list_files(self, include_root=False, from_dir=None, recursive=True):
2478
"""List all files as (path, class, kind, id, entry).
101
inv = self._inventory
102
if not inv.has_id(file_id):
104
path = inv.id2path(file_id)
105
return os.path.exists(self.abspath(path))
108
__contains__ = has_id
111
def get_file_size(self, file_id):
112
# is this still called?
113
raise NotImplementedError()
116
def get_file_sha1(self, file_id):
117
path = self._inventory.id2path(file_id)
118
return self._hashcache.get_sha1(path)
121
def file_class(self, filename):
122
if self.path2id(filename):
124
elif self.is_ignored(filename):
130
def list_files(self):
131
"""Recursively list all files as (path, class, kind, id).
2480
133
Lists, but does not descend into unversioned directories.
2481
135
This does not include files that have been deleted in this
2482
tree. Skips the control directory.
2484
:param include_root: if True, return an entry for the root
2485
:param from_dir: start from this directory or None for the root
2486
:param recursive: whether to recurse into subdirectories or not
138
Skips the control directory.
2488
# list_files is an iterator, so @needs_read_lock doesn't work properly
2489
# with it. So callers should be careful to always read_lock the tree.
2490
if not self.is_locked():
2491
raise errors.ObjectNotLocked(self)
2493
if from_dir is None and include_root is True:
2494
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2495
# Convert these into local objects to save lookup times
2496
pathjoin = osutils.pathjoin
2497
file_kind = self._kind
2499
# transport.base ends in a slash, we want the piece
2500
# between the last two slashes
2501
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2503
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2505
# directory file_id, relative path, absolute path, reverse sorted children
2506
if from_dir is not None:
2507
inv, from_dir_id = self._path2inv_file_id(from_dir)
2508
if from_dir_id is None:
2509
# Directory not versioned
2511
from_dir_abspath = pathjoin(self.basedir, from_dir)
2513
inv = self.root_inventory
2514
from_dir_id = inv.root.file_id
2515
from_dir_abspath = self.basedir
2516
children = os.listdir(from_dir_abspath)
2518
# jam 20060527 The kernel sized tree seems equivalent whether we
2519
# use a deque and popleft to keep them sorted, or if we use a plain
2520
# list and just reverse() them.
2521
children = collections.deque(children)
2522
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2524
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2527
f = children.popleft()
140
inv = self._inventory
142
def descend(from_dir_relpath, from_dir_id, dp):
2528
146
## TODO: If we find a subdirectory with its own .bzr
2529
147
## directory, then that is a separate tree and we
2530
148
## should exclude it.
2532
# the bzrdir for this tree
2533
if transport_base_dir == f:
149
if bzrlib.BZRDIR == f:
2536
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2537
# and 'f' doesn't begin with one, we can do a string op, rather
2538
# than the checks of pathjoin(), all relative paths will have an extra slash
2540
fp = from_dir_relpath + '/' + f
153
fp = appendpath(from_dir_relpath, f)
2543
fap = from_dir_abspath + '/' + f
2545
dir_ie = inv[from_dir_id]
2546
if dir_ie.kind == 'directory':
2547
f_ie = dir_ie.children.get(f)
156
fap = appendpath(dp, f)
158
f_ie = inv.get_child(from_dir_id, f)
2552
elif self.is_ignored(fp[1:]):
161
elif self.is_ignored(fp):
2555
# we may not have found this file, because of a unicode
2556
# issue, or because the directory was actually a symlink.
2557
f_norm, can_access = osutils.normalized_filename(f)
2558
if f == f_norm or not can_access:
2559
# No change, so treat this file normally
2562
# this file can be accessed by a normalized path
2563
# check again if it is versioned
2564
# these lines are repeated here for performance
2566
fp = from_dir_relpath + '/' + f
2567
fap = from_dir_abspath + '/' + f
2568
f_ie = inv.get_child(from_dir_id, f)
2571
elif self.is_ignored(fp[1:]):
2576
166
fk = file_kind(fap)
2578
# make a last minute entry
2580
yield fp[1:], c, fk, f_ie.file_id, f_ie
2583
yield fp[1:], c, fk, None, fk_entries[fk]()
2585
yield fp[1:], c, fk, None, TreeEntry()
170
raise BzrCheckError("file %r entered as kind %r id %r, "
172
% (fap, f_ie.kind, f_ie.file_id, fk))
174
yield fp, c, fk, (f_ie and f_ie.file_id)
2588
176
if fk != 'directory':
2591
# But do this child first if recursing down
2593
new_children = os.listdir(fap)
2595
new_children = collections.deque(new_children)
2596
stack.append((f_ie.file_id, fp, fap, new_children))
2597
# Break out of inner loop,
2598
# so that we start outer loop with child
2601
# if we finished all children, pop it off the stack
2604
@needs_tree_write_lock
2605
def move(self, from_paths, to_dir=None, after=False):
2608
to_dir must exist in the inventory.
2610
If to_dir exists and is a directory, the files are moved into
2611
it, keeping their old names.
2613
Note that to_dir is only the last component of the new name;
2614
this doesn't change the directory.
2616
For each entry in from_paths the move mode will be determined
2619
The first mode moves the file in the filesystem and updates the
2620
inventory. The second mode only updates the inventory without
2621
touching the file on the filesystem.
2623
move uses the second mode if 'after == True' and the target is
2624
either not versioned or newly added, and present in the working tree.
2626
move uses the second mode if 'after == False' and the source is
2627
versioned but no longer in the working tree, and the target is not
2628
versioned but present in the working tree.
2630
move uses the first mode if 'after == False' and the source is
2631
versioned and present in the working tree, and the target is not
2632
versioned and not present in the working tree.
2634
Everything else results in an error.
2636
This returns a list of (from_path, to_path) pairs for each
2637
entry that is moved.
2642
invs_to_write = set()
2644
# check for deprecated use of signature
2646
raise TypeError('You must supply a target directory')
2647
# check destination directory
2648
if isinstance(from_paths, basestring):
2650
to_abs = self.abspath(to_dir)
2651
if not isdir(to_abs):
2652
raise errors.BzrMoveFailedError('',to_dir,
2653
errors.NotADirectory(to_abs))
2654
if not self.has_filename(to_dir):
2655
raise errors.BzrMoveFailedError('',to_dir,
2656
errors.NotInWorkingDirectory(to_dir))
2657
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2658
if to_dir_id is None:
2659
raise errors.BzrMoveFailedError('',to_dir,
2660
errors.NotVersionedError(path=to_dir))
2662
to_dir_ie = to_inv[to_dir_id]
2663
if to_dir_ie.kind != 'directory':
2664
raise errors.BzrMoveFailedError('',to_dir,
2665
errors.NotADirectory(to_abs))
2667
# create rename entries and tuples
2668
for from_rel in from_paths:
2669
from_tail = splitpath(from_rel)[-1]
2670
from_inv, from_id = self._path2inv_file_id(from_rel)
2672
raise errors.BzrMoveFailedError(from_rel,to_dir,
2673
errors.NotVersionedError(path=from_rel))
2675
from_entry = from_inv[from_id]
2676
from_parent_id = from_entry.parent_id
2677
to_rel = pathjoin(to_dir, from_tail)
2678
rename_entry = InventoryWorkingTree._RenameEntry(
2681
from_tail=from_tail,
2682
from_parent_id=from_parent_id,
2683
to_rel=to_rel, to_tail=from_tail,
2684
to_parent_id=to_dir_id)
2685
rename_entries.append(rename_entry)
2686
rename_tuples.append((from_rel, to_rel))
2688
# determine which move mode to use. checks also for movability
2689
rename_entries = self._determine_mv_mode(rename_entries, after)
2691
original_modified = self._inventory_is_modified
2694
self._inventory_is_modified = True
2695
self._move(rename_entries)
2697
# restore the inventory on error
2698
self._inventory_is_modified = original_modified
2700
#FIXME: Should potentially also write the from_invs
2701
self._write_inventory(to_inv)
2702
return rename_tuples
2704
@needs_tree_write_lock
2705
def rename_one(self, from_rel, to_rel, after=False):
2708
This can change the directory or the filename or both.
2710
rename_one has several 'modes' to work. First, it can rename a physical
2711
file and change the file_id. That is the normal mode. Second, it can
2712
only change the file_id without touching any physical file.
2714
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2715
versioned but present in the working tree.
2717
rename_one uses the second mode if 'after == False' and 'from_rel' is
2718
versioned but no longer in the working tree, and 'to_rel' is not
2719
versioned but present in the working tree.
2721
rename_one uses the first mode if 'after == False' and 'from_rel' is
2722
versioned and present in the working tree, and 'to_rel' is not
2723
versioned and not present in the working tree.
2725
Everything else results in an error.
2729
# create rename entries and tuples
2730
from_tail = splitpath(from_rel)[-1]
2731
from_inv, from_id = self._path2inv_file_id(from_rel)
2733
# if file is missing in the inventory maybe it's in the basis_tree
2734
basis_tree = self.branch.basis_tree()
2735
from_id = basis_tree.path2id(from_rel)
2737
raise errors.BzrRenameFailedError(from_rel,to_rel,
2738
errors.NotVersionedError(path=from_rel))
2739
# put entry back in the inventory so we can rename it
2740
from_entry = basis_tree.root_inventory[from_id].copy()
2741
from_inv.add(from_entry)
2743
from_inv, from_inv_id = self._unpack_file_id(from_id)
2744
from_entry = from_inv[from_inv_id]
2745
from_parent_id = from_entry.parent_id
2746
to_dir, to_tail = os.path.split(to_rel)
2747
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2748
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2750
from_tail=from_tail,
2751
from_parent_id=from_parent_id,
2752
to_rel=to_rel, to_tail=to_tail,
2753
to_parent_id=to_dir_id)
2754
rename_entries.append(rename_entry)
2756
# determine which move mode to use. checks also for movability
2757
rename_entries = self._determine_mv_mode(rename_entries, after)
2759
# check if the target changed directory and if the target directory is
2761
if to_dir_id is None:
2762
raise errors.BzrMoveFailedError(from_rel,to_rel,
2763
errors.NotVersionedError(path=to_dir))
2765
# all checks done. now we can continue with our actual work
2766
mutter('rename_one:\n'
2771
' to_dir_id {%s}\n',
2772
from_id, from_rel, to_rel, to_dir, to_dir_id)
2774
self._move(rename_entries)
2775
self._write_inventory(to_inv)
2777
class _RenameEntry(object):
2778
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2779
to_rel, to_tail, to_parent_id, only_change_inv=False,
2781
self.from_rel = from_rel
2782
self.from_id = from_id
2783
self.from_tail = from_tail
2784
self.from_parent_id = from_parent_id
2785
self.to_rel = to_rel
2786
self.to_tail = to_tail
2787
self.to_parent_id = to_parent_id
2788
self.change_id = change_id
2789
self.only_change_inv = only_change_inv
2791
def _determine_mv_mode(self, rename_entries, after=False):
2792
"""Determines for each from-to pair if both inventory and working tree
2793
or only the inventory has to be changed.
2795
Also does basic plausability tests.
2797
# FIXME: Handling of nested trees
2798
inv = self.root_inventory
2800
for rename_entry in rename_entries:
2801
# store to local variables for easier reference
2802
from_rel = rename_entry.from_rel
2803
from_id = rename_entry.from_id
2804
to_rel = rename_entry.to_rel
2805
to_id = inv.path2id(to_rel)
2806
only_change_inv = False
2809
# check the inventory for source and destination
2811
raise errors.BzrMoveFailedError(from_rel,to_rel,
2812
errors.NotVersionedError(path=from_rel))
2813
if to_id is not None:
2815
# allow it with --after but only if dest is newly added
2817
basis = self.basis_tree()
2820
if not basis.has_id(to_id):
2821
rename_entry.change_id = True
2826
raise errors.BzrMoveFailedError(from_rel,to_rel,
2827
errors.AlreadyVersionedError(path=to_rel))
2829
# try to determine the mode for rename (only change inv or change
2830
# inv and file system)
2832
if not self.has_filename(to_rel):
2833
raise errors.BzrMoveFailedError(from_id,to_rel,
2834
errors.NoSuchFile(path=to_rel,
2835
extra="New file has not been created yet"))
2836
only_change_inv = True
2837
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2838
only_change_inv = True
2839
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2840
only_change_inv = False
2841
elif (not self.case_sensitive
2842
and from_rel.lower() == to_rel.lower()
2843
and self.has_filename(from_rel)):
2844
only_change_inv = False
2846
# something is wrong, so lets determine what exactly
2847
if not self.has_filename(from_rel) and \
2848
not self.has_filename(to_rel):
2849
raise errors.BzrRenameFailedError(from_rel, to_rel,
2850
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2852
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2853
rename_entry.only_change_inv = only_change_inv
2854
return rename_entries
2856
def _move(self, rename_entries):
2857
"""Moves a list of files.
2859
Depending on the value of the flag 'only_change_inv', the
2860
file will be moved on the file system or not.
2864
for entry in rename_entries:
2866
self._move_entry(entry)
2868
self._rollback_move(moved)
2872
def _rollback_move(self, moved):
2873
"""Try to rollback a previous move in case of an filesystem error."""
2876
self._move_entry(WorkingTree._RenameEntry(
2877
entry.to_rel, entry.from_id,
2878
entry.to_tail, entry.to_parent_id, entry.from_rel,
2879
entry.from_tail, entry.from_parent_id,
2880
entry.only_change_inv))
2881
except errors.BzrMoveFailedError, e:
2882
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2883
" The working tree is in an inconsistent state."
2884
" Please consider doing a 'bzr revert'."
2885
" Error message is: %s" % e)
2887
def _move_entry(self, entry):
2888
inv = self.root_inventory
2889
from_rel_abs = self.abspath(entry.from_rel)
2890
to_rel_abs = self.abspath(entry.to_rel)
2891
if from_rel_abs == to_rel_abs:
2892
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2893
"Source and target are identical.")
2895
if not entry.only_change_inv:
2897
osutils.rename(from_rel_abs, to_rel_abs)
2899
raise errors.BzrMoveFailedError(entry.from_rel,
2902
to_id = inv.path2id(entry.to_rel)
2903
inv.remove_recursive_id(to_id)
2904
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2906
@needs_tree_write_lock
2907
def unversion(self, file_ids):
2908
"""Remove the file ids in file_ids from the current versioned set.
2910
When a file_id is unversioned, all of its children are automatically
2913
:param file_ids: The file ids to stop versioning.
2914
:raises: NoSuchId if any fileid is not currently versioned.
2916
for file_id in file_ids:
2917
if not self._inventory.has_id(file_id):
2918
raise errors.NoSuchId(self, file_id)
2919
for file_id in file_ids:
2920
if self._inventory.has_id(file_id):
2921
self._inventory.remove_recursive_id(file_id)
2923
# in the future this should just set a dirty bit to wait for the
2924
# final unlock. However, until all methods of workingtree start
2925
# with the current in -memory inventory rather than triggering
2926
# a read, it is more complex - we need to teach read_inventory
2927
# to know when to read, and when to not read first... and possibly
2928
# to save first when the in memory one may be corrupted.
2929
# so for now, we just only write it if it is indeed dirty.
2931
self._write_inventory(self._inventory)
2933
def stored_kind(self, file_id):
2934
"""See Tree.stored_kind"""
2935
inv, inv_file_id = self._unpack_file_id(file_id)
2936
return inv[inv_file_id].kind
180
# don't descend unversioned directories
183
for ff in descend(fp, f_ie.file_id, fap):
186
for f in descend('', inv.root.file_id, self.basedir):
192
for subp in self.extras():
193
if not self.is_ignored(subp):
2938
197
def extras(self):
2939
"""Yield all unversioned files in this WorkingTree.
198
"""Yield all unknown files in this WorkingTree.
2941
If there are any unversioned directories then only the directory is
2942
returned, not all its children. But if there are unversioned files
200
If there are any unknown directories then only the directory is
201
returned, not all its children. But if there are unknown files
2943
202
under a versioned subdirectory, they are returned.
2945
204
Currently returned depth-first, sorted by name within directories.
2946
This is the same order used by 'osutils.walkdirs'.
2948
206
## TODO: Work from given directory downwards
2949
for path, dir_entry in self.iter_entries_by_dir():
2950
if dir_entry.kind != 'directory':
2952
# mutter("search for unknowns in %r", path)
207
for path, dir_entry in self.inventory.directories():
208
mutter("search for unknowns in %r" % path)
2953
209
dirabs = self.abspath(path)
2954
210
if not isdir(dirabs):
2955
211
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
