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,
72
# Explicitly import bzrlib.bzrdir so that the BzrProber
73
# is guaranteed to be registered.
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.i18n import gettext
81
from bzrlib.lock import LogicalLockResult
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
from bzrlib.osutils import (
94
from bzrlib.trace import mutter, note
95
from bzrlib.revision import CURRENT_REVISION
96
from bzrlib.symbol_versioning import (
102
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
103
# TODO: Modifying the conflict objects or their type is currently nearly
104
# impossible as there is no clear relationship between the working tree format
105
# and the conflict list file format.
106
CONFLICT_HEADER_1 = "BZR conflict list format 1"
108
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
111
class TreeEntry(object):
112
"""An entry that implements the minimum interface used by commands.
114
This needs further inspection, it may be better to have
115
InventoryEntries without ids - though that seems wrong. For now,
116
this is a parallel hierarchy to InventoryEntry, and needs to become
117
one of several things: decorates to that hierarchy, children of, or
119
Another note is that these objects are currently only used when there is
120
no InventoryEntry available - i.e. for unversioned objects.
121
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
124
def __eq__(self, other):
125
# yes, this us ugly, TODO: best practice __eq__ style.
126
return (isinstance(other, TreeEntry)
127
and other.__class__ == self.__class__)
129
def kind_character(self):
133
class TreeDirectory(TreeEntry):
134
"""See TreeEntry. This is a directory in a working tree."""
136
def __eq__(self, other):
137
return (isinstance(other, TreeDirectory)
138
and other.__class__ == self.__class__)
140
def kind_character(self):
144
class TreeFile(TreeEntry):
145
"""See TreeEntry. This is a regular file in a working tree."""
147
def __eq__(self, other):
148
return (isinstance(other, TreeFile)
149
and other.__class__ == self.__class__)
151
def kind_character(self):
155
class TreeLink(TreeEntry):
156
"""See TreeEntry. This is a symlink in a working tree."""
158
def __eq__(self, other):
159
return (isinstance(other, TreeLink)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class WorkingTree(bzrlib.mutabletree.MutableTree,
167
controldir.ControlComponent):
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):
168
32
"""Working copy tree.
170
:ivar basedir: The root of the tree on disk. This is a unicode path object
171
(as opposed to a URL).
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.
174
# override this to set the strategy for storing views
175
def _make_views(self):
176
return views.DisabledViews(self)
178
def __init__(self, basedir='.',
179
branch=DEPRECATED_PARAMETER,
184
"""Construct a WorkingTree instance. This is not a public API.
186
:param branch: A branch to override probing for the branch.
188
self._format = _format
189
self.bzrdir = _bzrdir
191
raise errors.BzrError("Please use bzrdir.open_workingtree or "
192
"WorkingTree.open() to obtain a WorkingTree.")
193
basedir = safe_unicode(basedir)
194
mutter("opening working tree %r", basedir)
195
if deprecated_passed(branch):
196
self._branch = branch
198
self._branch = self.bzrdir.open_branch()
199
self.basedir = realpath(basedir)
200
self._transport = _transport
201
self._rules_searcher = None
202
self.views = self._make_views()
205
def user_transport(self):
206
return self.bzrdir.user_transport
209
def control_transport(self):
210
return self._transport
212
def is_control_filename(self, filename):
213
"""True if filename is the name of a control file in this tree.
215
:param filename: A filename within the tree. This is a relative path
216
from the root of this tree.
218
This is true IF and ONLY IF the filename is part of the meta data
219
that bzr controls in this tree. I.E. a random .bzr directory placed
220
on disk will not be a control file for this tree.
222
return self.bzrdir.is_control_filename(filename)
225
fget=lambda self: self._branch,
226
doc="""The branch this WorkingTree is connected to.
228
This cannot be set - it is reflective of the actual disk structure
229
the working tree has been constructed from.
232
def has_versioned_directories(self):
233
"""See `Tree.has_versioned_directories`."""
234
return self._format.supports_versioned_directories
236
def _supports_executable(self):
237
if sys.platform == 'win32':
239
# FIXME: Ideally this should check the file system
242
def break_lock(self):
243
"""Break a lock if one is present from another instance.
245
Uses the ui factory to ask for confirmation if the lock may be from
248
This will probe the repository for its lock as well.
250
raise NotImplementedError(self.break_lock)
252
def requires_rich_root(self):
253
return self._format.requires_rich_root
255
def supports_tree_reference(self):
258
def supports_content_filtering(self):
259
return self._format.supports_content_filtering()
261
def supports_views(self):
262
return self.views.supports_views()
264
def get_config_stack(self):
265
"""Retrieve the config stack for this tree.
267
:return: A ``bzrlib.config.Stack``
269
# For the moment, just provide the branch config stack.
270
return self.branch.get_config_stack()
273
def open(path=None, _unsupported=False):
274
"""Open an existing working tree at path.
278
path = osutils.getcwd()
279
control = controldir.ControlDir.open(path, _unsupported=_unsupported)
280
return control.open_workingtree(unsupported=_unsupported)
283
def open_containing(path=None):
284
"""Open an existing working tree which has its root about path.
286
This probes for a working tree at path and searches upwards from there.
288
Basically we keep looking up until we find the control directory or
289
run into /. If there isn't one, raises NotBranchError.
290
TODO: give this a new exception.
291
If there is one, it is returned, along with the unused portion of path.
293
:return: The WorkingTree that contains 'path', and the rest of path
296
path = osutils.getcwd()
297
control, relpath = controldir.ControlDir.open_containing(path)
298
return control.open_workingtree(), relpath
301
def open_containing_paths(file_list, default_directory=None,
302
canonicalize=True, apply_view=True):
303
"""Open the WorkingTree that contains a set of paths.
305
Fail if the paths given are not all in a single tree.
307
This is used for the many command-line interfaces that take a list of
308
any number of files and that require they all be in the same tree.
310
if default_directory is None:
311
default_directory = u'.'
312
# recommended replacement for builtins.internal_tree_files
313
if file_list is None or len(file_list) == 0:
314
tree = WorkingTree.open_containing(default_directory)[0]
315
# XXX: doesn't really belong here, and seems to have the strange
316
# side effect of making it return a bunch of files, not the whole
317
# tree -- mbp 20100716
318
if tree.supports_views() and apply_view:
319
view_files = tree.views.lookup_view()
321
file_list = view_files
322
view_str = views.view_display_str(view_files)
323
note(gettext("Ignoring files outside view. View is %s") % view_str)
324
return tree, file_list
325
if default_directory == u'.':
328
seed = default_directory
329
file_list = [osutils.pathjoin(default_directory, f)
331
tree = WorkingTree.open_containing(seed)[0]
332
return tree, tree.safe_relpath_files(file_list, canonicalize,
333
apply_view=apply_view)
335
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
336
"""Convert file_list into a list of relpaths in tree.
338
:param self: A tree to operate on.
339
:param file_list: A list of user provided paths or None.
340
:param apply_view: if True and a view is set, apply it or check that
341
specified files are within it
342
:return: A list of relative paths.
343
:raises errors.PathNotChild: When a provided path is in a different self
346
if file_list is None:
348
if self.supports_views() and apply_view:
349
view_files = self.views.lookup_view()
353
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
354
# doesn't - fix that up here before we enter the loop.
356
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
359
for filename in file_list:
360
relpath = fixer(osutils.dereference_path(filename))
361
if view_files and not osutils.is_inside_any(view_files, relpath):
362
raise errors.FileOutsideView(filename, view_files)
363
new_list.append(relpath)
367
def open_downlevel(path=None):
368
"""Open an unsupported working tree.
370
Only intended for advanced situations like upgrading part of a bzrdir.
372
return WorkingTree.open(path, _unsupported=True)
375
def find_trees(location):
376
def list_current(transport):
377
return [d for d in transport.list_dir('') if d != '.bzr']
378
def evaluate(bzrdir):
380
tree = bzrdir.open_workingtree()
381
except errors.NoWorkingTree:
385
t = transport.get_transport(location)
386
iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
387
list_current=list_current)
388
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)):
390
76
def __repr__(self):
391
77
return "<%s of %s>" % (self.__class__.__name__,
392
78
getattr(self, 'basedir', None))
394
82
def abspath(self, filename):
395
return pathjoin(self.basedir, filename)
397
def basis_tree(self):
398
"""Return RevisionTree for the current last revision.
400
If the left most parent is a ghost then the returned tree will be an
401
empty tree - one obtained by calling
402
repository.revision_tree(NULL_REVISION).
405
revision_id = self.get_parent_ids()[0]
407
# no parents, return an empty revision tree.
408
# in the future this should return the tree for
409
# 'empty:' - the implicit root empty tree.
410
return self.branch.repository.revision_tree(
411
_mod_revision.NULL_REVISION)
413
return self.revision_tree(revision_id)
414
except errors.NoSuchRevision:
416
# No cached copy available, retrieve from the repository.
417
# FIXME? RBC 20060403 should we cache the inventory locally
420
return self.branch.repository.revision_tree(revision_id)
421
except (errors.RevisionNotPresent, errors.NoSuchRevision):
422
# the basis tree *may* be a ghost or a low level error may have
423
# occurred. If the revision is present, its a problem, if its not
425
if self.branch.repository.has_revision(revision_id):
427
# the basis tree is a ghost so return an empty tree.
428
return self.branch.repository.revision_tree(
429
_mod_revision.NULL_REVISION)
432
self._flush_ignore_list_cache()
434
def relpath(self, path):
435
"""Return the local path portion from a given path.
437
The path may be absolute or relative. If its a relative path it is
438
interpreted relative to the python current working directory.
440
return osutils.relpath(self.basedir, path)
83
return os.path.join(self.basedir, filename)
442
85
def has_filename(self, filename):
443
return osutils.lexists(self.abspath(filename))
445
def get_file(self, file_id, path=None, filtered=True):
446
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
448
def get_file_with_stat(self, file_id, path=None, filtered=True,
449
_fstat=osutils.fstat):
450
"""See Tree.get_file_with_stat."""
452
path = self.id2path(file_id)
453
file_obj = self.get_file_byname(path, filtered=False)
454
stat_value = _fstat(file_obj.fileno())
455
if filtered and self.supports_content_filtering():
456
filters = self._content_filter_stack(path)
457
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
458
return (file_obj, stat_value)
460
def get_file_text(self, file_id, path=None, filtered=True):
461
my_file = self.get_file(file_id, path=path, filtered=filtered)
463
return my_file.read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return _mod_filters.filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
484
def get_parent_ids(self):
485
"""See Tree.get_parent_ids.
487
This implementation reads the pending merges list and last_revision
488
value and uses that to decide what the parents list should be.
490
last_rev = _mod_revision.ensure_null(self._last_revision())
491
if _mod_revision.NULL_REVISION == last_rev:
496
merges_bytes = self._transport.get_bytes('pending-merges')
497
except errors.NoSuchFile:
500
for l in osutils.split_lines(merges_bytes):
501
revision_id = l.rstrip('\n')
502
parents.append(revision_id)
505
def get_root_id(self):
506
"""Return the id of this trees root"""
507
raise NotImplementedError(self.get_root_id)
510
def clone(self, to_controldir, revision_id=None):
511
"""Duplicate this working tree into to_bzr, including all state.
513
Specifically modified files are kept as modified, but
514
ignored and unknown files are discarded.
516
If you want to make a new line of development, see ControlDir.sprout()
519
If not None, the cloned tree will have its last revision set to
520
revision, and difference between the source trees last revision
521
and this one merged in.
523
# assumes the target bzr dir format is compatible.
524
result = to_controldir.create_workingtree()
525
self.copy_content_into(result, revision_id)
529
def copy_content_into(self, tree, revision_id=None):
530
"""Copy the current content and user files of this tree into tree."""
531
tree.set_root_id(self.get_root_id())
532
if revision_id is None:
533
merge.transform_tree(tree, self)
535
# TODO now merge from tree.last_revision to revision (to preserve
536
# user local changes)
537
merge.transform_tree(tree, self)
538
if revision_id == _mod_revision.NULL_REVISION:
541
new_parents = [revision_id]
542
tree.set_parent_ids(new_parents)
544
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
545
96
return self.abspath(self.id2path(file_id))
547
def _check_for_tree_references(self, iterator):
548
"""See if directories have become tree-references."""
549
blocked_parent_ids = set()
550
for path, ie in iterator:
551
if ie.parent_id in blocked_parent_ids:
552
# This entry was pruned because one of its parents became a
553
# TreeReference. If this is a directory, mark it as blocked.
554
if ie.kind == 'directory':
555
blocked_parent_ids.add(ie.file_id)
557
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
558
# This InventoryDirectory needs to be a TreeReference
559
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
560
blocked_parent_ids.add(ie.file_id)
563
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
564
"""See Tree.iter_entries_by_dir()"""
565
# The only trick here is that if we supports_tree_reference then we
566
# need to detect if a directory becomes a tree-reference.
567
iterator = super(WorkingTree, self).iter_entries_by_dir(
568
specific_file_ids=specific_file_ids,
569
yield_parents=yield_parents)
570
if not self.supports_tree_reference():
573
return self._check_for_tree_references(iterator)
575
def get_file_size(self, file_id):
576
"""See Tree.get_file_size"""
577
# XXX: this returns the on-disk size; it should probably return the
580
return os.path.getsize(self.id2abspath(file_id))
582
if e.errno != errno.ENOENT:
587
@needs_tree_write_lock
588
def _gather_kinds(self, files, kinds):
589
"""See MutableTree._gather_kinds."""
590
for pos, f in enumerate(files):
591
if kinds[pos] is None:
592
fullpath = normpath(self.abspath(f))
594
kinds[pos] = file_kind(fullpath)
596
if e.errno == errno.ENOENT:
597
raise errors.NoSuchFile(fullpath)
600
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
601
"""Add revision_id as a parent.
603
This is equivalent to retrieving the current list of parent ids
604
and setting the list to its value plus revision_id.
606
:param revision_id: The revision id to add to the parent list. It may
607
be a ghost revision as long as its not the first parent to be
608
added, or the allow_leftmost_as_ghost parameter is set True.
609
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
611
parents = self.get_parent_ids() + [revision_id]
612
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
613
or allow_leftmost_as_ghost)
615
@needs_tree_write_lock
616
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
617
"""Add revision_id, tree tuple as a parent.
619
This is equivalent to retrieving the current list of parent trees
620
and setting the list to its value plus parent_tuple. See also
621
add_parent_tree_id - if you only have a parent id available it will be
622
simpler to use that api. If you have the parent already available, using
623
this api is preferred.
625
:param parent_tuple: The (revision id, tree) to add to the parent list.
626
If the revision_id is a ghost, pass None for the tree.
627
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
629
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
630
if len(parent_ids) > 1:
631
# the leftmost may have already been a ghost, preserve that if it
633
allow_leftmost_as_ghost = True
634
self.set_parent_ids(parent_ids,
635
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
637
@needs_tree_write_lock
638
def add_pending_merge(self, *revision_ids):
639
# TODO: Perhaps should check at this point that the
640
# history of the revision is actually present?
641
parents = self.get_parent_ids()
643
for rev_id in revision_ids:
644
if rev_id in parents:
646
parents.append(rev_id)
649
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
651
def path_content_summary(self, path, _lstat=os.lstat,
652
_mapper=osutils.file_kind_from_stat_mode):
653
"""See Tree.path_content_summary."""
654
abspath = self.abspath(path)
656
stat_result = _lstat(abspath)
658
if getattr(e, 'errno', None) == errno.ENOENT:
660
return ('missing', None, None, None)
661
# propagate other errors
663
kind = _mapper(stat_result.st_mode)
665
return self._file_content_summary(path, stat_result)
666
elif kind == 'directory':
667
# perhaps it looks like a plain directory, but it's really a
669
if self._directory_is_tree_reference(path):
670
kind = 'tree-reference'
671
return kind, None, None, None
672
elif kind == 'symlink':
673
target = osutils.readlink(abspath)
674
return ('symlink', None, None, target)
676
return (kind, None, None, None)
678
def _file_content_summary(self, path, stat_result):
679
size = stat_result.st_size
680
executable = self._is_executable_from_path_and_stat(path, stat_result)
681
# try for a stat cache lookup
682
return ('file', size, executable, self._sha_from_stat(
685
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
686
"""Common ghost checking functionality from set_parent_*.
688
This checks that the left hand-parent exists if there are any
691
if len(revision_ids) > 0:
692
leftmost_id = revision_ids[0]
693
if (not allow_leftmost_as_ghost and not
694
self.branch.repository.has_revision(leftmost_id)):
695
raise errors.GhostRevisionUnusableHere(leftmost_id)
697
def _set_merges_from_parent_ids(self, parent_ids):
698
merges = parent_ids[1:]
699
self._transport.put_bytes('pending-merges', '\n'.join(merges),
700
mode=self.bzrdir._get_file_mode())
702
def _filter_parent_ids_by_ancestry(self, revision_ids):
703
"""Check that all merged revisions are proper 'heads'.
705
This will always return the first revision_id, and any merged revisions
708
if len(revision_ids) == 0:
710
graph = self.branch.repository.get_graph()
711
heads = graph.heads(revision_ids)
712
new_revision_ids = revision_ids[:1]
713
for revision_id in revision_ids[1:]:
714
if revision_id in heads and revision_id not in new_revision_ids:
715
new_revision_ids.append(revision_id)
716
if new_revision_ids != revision_ids:
717
mutter('requested to set revision_ids = %s,'
718
' but filtered to %s', revision_ids, new_revision_ids)
719
return new_revision_ids
721
@needs_tree_write_lock
722
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
723
"""Set the parent ids to revision_ids.
725
See also set_parent_trees. This api will try to retrieve the tree data
726
for each element of revision_ids from the trees repository. If you have
727
tree data already available, it is more efficient to use
728
set_parent_trees rather than set_parent_ids. set_parent_ids is however
729
an easier API to use.
731
:param revision_ids: The revision_ids to set as the parent ids of this
732
working tree. Any of these may be ghosts.
734
self._check_parents_for_ghosts(revision_ids,
735
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
736
for revision_id in revision_ids:
737
_mod_revision.check_not_reserved_id(revision_id)
739
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
741
if len(revision_ids) > 0:
742
self.set_last_revision(revision_ids[0])
744
self.set_last_revision(_mod_revision.NULL_REVISION)
746
self._set_merges_from_parent_ids(revision_ids)
748
@needs_tree_write_lock
749
def set_pending_merges(self, rev_list):
750
parents = self.get_parent_ids()
751
leftmost = parents[:1]
752
new_parents = leftmost + rev_list
753
self.set_parent_ids(new_parents)
755
@needs_tree_write_lock
756
def set_merge_modified(self, modified_hashes):
757
"""Set the merge modified hashes."""
758
raise NotImplementedError(self.set_merge_modified)
760
def _sha_from_stat(self, path, stat_result):
761
"""Get a sha digest from the tree's stat cache.
763
The default implementation assumes no stat cache is present.
765
:param path: The path.
766
:param stat_result: The stat result being looked up.
770
@needs_write_lock # because merge pulls data into the branch.
771
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
772
merge_type=None, force=False):
773
"""Merge from a branch into this working tree.
775
:param branch: The branch to merge from.
776
:param to_revision: If non-None, the merge will merge to to_revision,
777
but not beyond it. to_revision does not need to be in the history
778
of the branch when it is supplied. If None, to_revision defaults to
779
branch.last_revision().
781
from bzrlib.merge import Merger, Merge3Merger
782
merger = Merger(self.branch, this_tree=self)
783
# check that there are no local alterations
784
if not force and self.has_changes():
785
raise errors.UncommittedChanges(self)
786
if to_revision is None:
787
to_revision = _mod_revision.ensure_null(branch.last_revision())
788
merger.other_rev_id = to_revision
789
if _mod_revision.is_null(merger.other_rev_id):
790
raise errors.NoCommits(branch)
791
self.branch.fetch(branch, last_revision=merger.other_rev_id)
792
merger.other_basis = merger.other_rev_id
793
merger.other_tree = self.branch.repository.revision_tree(
795
merger.other_branch = branch
796
if from_revision is None:
799
merger.set_base_revision(from_revision, branch)
800
if merger.base_rev_id == merger.other_rev_id:
801
raise errors.PointlessMerge
802
merger.backup_files = False
803
if merge_type is None:
804
merger.merge_type = Merge3Merger
806
merger.merge_type = merge_type
807
merger.set_interesting_files(None)
808
merger.show_base = False
809
merger.reprocess = False
810
conflicts = merger.do_merge()
814
def merge_modified(self):
815
"""Return a dictionary of files modified by a merge.
817
The list is initialized by WorkingTree.set_merge_modified, which is
818
typically called after we make some automatic updates to the tree
821
This returns a map of file_id->sha1, containing only files which are
822
still in the working inventory and have that text hash.
824
raise NotImplementedError(self.merge_modified)
827
def mkdir(self, path, file_id=None):
828
"""See MutableTree.mkdir()."""
830
file_id = generate_ids.gen_file_id(os.path.basename(path))
831
os.mkdir(self.abspath(path))
832
self.add(path, file_id, 'directory')
835
def get_symlink_target(self, file_id, path=None):
837
abspath = self.abspath(path)
839
abspath = self.id2abspath(file_id)
840
target = osutils.readlink(abspath)
843
def subsume(self, other_tree):
844
raise NotImplementedError(self.subsume)
846
def _setup_directory_is_tree_reference(self):
847
if self._branch.repository._format.supports_tree_reference:
848
self._directory_is_tree_reference = \
849
self._directory_may_be_tree_reference
851
self._directory_is_tree_reference = \
852
self._directory_is_never_tree_reference
854
def _directory_is_never_tree_reference(self, relpath):
857
def _directory_may_be_tree_reference(self, relpath):
858
# as a special case, if a directory contains control files then
859
# it's a tree reference, except that the root of the tree is not
860
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
861
# TODO: We could ask all the control formats whether they
862
# recognize this directory, but at the moment there's no cheap api
863
# to do that. Since we probably can only nest bzr checkouts and
864
# they always use this name it's ok for now. -- mbp 20060306
866
# FIXME: There is an unhandled case here of a subdirectory
867
# containing .bzr but not a branch; that will probably blow up
868
# when you try to commit it. It might happen if there is a
869
# checkout in a subdirectory. This can be avoided by not adding
872
def extract(self, file_id, format=None):
873
"""Extract a subtree from this tree.
875
A new branch will be created, relative to the path for this tree.
877
raise NotImplementedError(self.extract)
880
"""Write the in memory meta data to disk."""
881
raise NotImplementedError(self.flush)
883
def _kind(self, relpath):
884
return osutils.file_kind(self.abspath(relpath))
886
def list_files(self, include_root=False, from_dir=None, recursive=True):
887
"""List all files as (path, class, kind, id, entry).
889
Lists, but does not descend into unversioned directories.
890
This does not include files that have been deleted in this
891
tree. Skips the control directory.
893
:param include_root: if True, return an entry for the root
894
:param from_dir: start from this directory or None for the root
895
:param recursive: whether to recurse into subdirectories or not
897
raise NotImplementedError(self.list_files)
899
def move(self, from_paths, to_dir=None, after=False):
902
to_dir must be known to the working tree.
904
If to_dir exists and is a directory, the files are moved into
905
it, keeping their old names.
907
Note that to_dir is only the last component of the new name;
908
this doesn't change the directory.
910
For each entry in from_paths the move mode will be determined
913
The first mode moves the file in the filesystem and updates the
914
working tree metadata. The second mode only updates the working tree
915
metadata without touching the file on the filesystem.
917
move uses the second mode if 'after == True' and the target is not
918
versioned but present in the working tree.
920
move uses the second mode if 'after == False' and the source is
921
versioned but no longer in the working tree, and the target is not
922
versioned but present in the working tree.
924
move uses the first mode if 'after == False' and the source is
925
versioned and present in the working tree, and the target is not
926
versioned and not present in the working tree.
928
Everything else results in an error.
930
This returns a list of (from_path, to_path) pairs for each
933
raise NotImplementedError(self.move)
935
@needs_tree_write_lock
936
def rename_one(self, from_rel, to_rel, after=False):
939
This can change the directory or the filename or both.
941
rename_one has several 'modes' to work. First, it can rename a physical
942
file and change the file_id. That is the normal mode. Second, it can
943
only change the file_id without touching any physical file.
945
rename_one uses the second mode if 'after == True' and 'to_rel' is
946
either not versioned or newly added, and present in the working tree.
948
rename_one uses the second mode if 'after == False' and 'from_rel' is
949
versioned but no longer in the working tree, and 'to_rel' is not
950
versioned but present in the working tree.
952
rename_one uses the first mode if 'after == False' and 'from_rel' is
953
versioned and present in the working tree, and 'to_rel' is not
954
versioned and not present in the working tree.
956
Everything else results in an error.
958
raise NotImplementedError(self.rename_one)
962
"""Return all unknown files.
964
These are files in the working directory that are not versioned or
965
control files or ignored.
967
# force the extras method to be fully executed before returning, to
968
# prevent race conditions with the lock
970
[subp for subp in self.extras() if not self.is_ignored(subp)])
972
def unversion(self, file_ids):
973
"""Remove the file ids in file_ids from the current versioned set.
975
When a file_id is unversioned, all of its children are automatically
978
:param file_ids: The file ids to stop versioning.
979
:raises: NoSuchId if any fileid is not currently versioned.
981
raise NotImplementedError(self.unversion)
984
def pull(self, source, overwrite=False, stop_revision=None,
985
change_reporter=None, possible_transports=None, local=False,
989
old_revision_info = self.branch.last_revision_info()
990
basis_tree = self.basis_tree()
991
count = self.branch.pull(source, overwrite, stop_revision,
992
possible_transports=possible_transports,
994
new_revision_info = self.branch.last_revision_info()
995
if new_revision_info != old_revision_info:
996
repository = self.branch.repository
997
if repository._format.fast_deltas:
998
parent_ids = self.get_parent_ids()
1000
basis_id = parent_ids[0]
1001
basis_tree = repository.revision_tree(basis_id)
1002
basis_tree.lock_read()
1004
new_basis_tree = self.branch.basis_tree()
1011
change_reporter=change_reporter,
1012
show_base=show_base)
1013
basis_root_id = basis_tree.get_root_id()
1014
new_root_id = new_basis_tree.get_root_id()
1015
if new_root_id is not None and basis_root_id != new_root_id:
1016
self.set_root_id(new_root_id)
1019
# TODO - dedup parents list with things merged by pull ?
1020
# reuse the revisiontree we merged against to set the new
1023
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1024
parent_trees.append(
1025
(self.branch.last_revision(), new_basis_tree))
1026
# we have to pull the merge trees out again, because
1027
# merge_inner has set the ids. - this corner is not yet
1028
# layered well enough to prevent double handling.
1029
# XXX TODO: Fix the double handling: telling the tree about
1030
# the already known parent data is wasteful.
1031
merges = self.get_parent_ids()[1:]
1032
parent_trees.extend([
1033
(parent, repository.revision_tree(parent)) for
1035
self.set_parent_trees(parent_trees)
1041
def put_file_bytes_non_atomic(self, file_id, bytes):
1042
"""See MutableTree.put_file_bytes_non_atomic."""
1043
stream = file(self.id2abspath(file_id), 'wb')
1050
"""Yield all unversioned files in this WorkingTree.
1052
If there are any unversioned directories then only the directory is
1053
returned, not all its children. But if there are unversioned files
1054
under a versioned subdirectory, they are returned.
1056
Currently returned depth-first, sorted by name within directories.
1057
This is the same order used by 'osutils.walkdirs'.
1059
raise NotImplementedError(self.extras)
1061
def ignored_files(self):
1062
"""Yield list of PATH, IGNORE_PATTERN"""
1063
for subp in self.extras():
1064
pat = self.is_ignored(subp)
1068
def get_ignore_list(self):
1069
"""Return list of ignore patterns.
1071
Cached in the Tree object after the first call.
1073
ignoreset = getattr(self, '_ignoreset', None)
1074
if ignoreset is not None:
1077
ignore_globs = set()
1078
ignore_globs.update(ignores.get_runtime_ignores())
1079
ignore_globs.update(ignores.get_user_ignores())
1080
if self.has_filename(bzrlib.IGNORE_FILENAME):
1081
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1083
ignore_globs.update(ignores.parse_ignore_file(f))
1086
self._ignoreset = ignore_globs
1089
def _flush_ignore_list_cache(self):
1090
"""Resets the cached ignore list to force a cache rebuild."""
1091
self._ignoreset = None
1092
self._ignoreglobster = None
1094
def is_ignored(self, filename):
1095
r"""Check whether the filename matches an ignore pattern.
1097
Patterns containing '/' or '\' need to match the whole path;
1098
others match against only the last component. Patterns starting
1099
with '!' are ignore exceptions. Exceptions take precedence
1100
over regular patterns and cause the filename to not be ignored.
1102
If the file is ignored, returns the pattern which caused it to
1103
be ignored, otherwise None. So this can simply be used as a
1104
boolean if desired."""
1105
if getattr(self, '_ignoreglobster', None) is None:
1106
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1107
return self._ignoreglobster.match(filename)
1109
def kind(self, file_id):
1110
return file_kind(self.id2abspath(file_id))
1112
def stored_kind(self, file_id):
1113
"""See Tree.stored_kind"""
1114
raise NotImplementedError(self.stored_kind)
1116
def _comparison_data(self, entry, path):
1117
abspath = self.abspath(path)
1119
stat_value = os.lstat(abspath)
1121
if getattr(e, 'errno', None) == errno.ENOENT:
1128
mode = stat_value.st_mode
1129
kind = osutils.file_kind_from_stat_mode(mode)
1130
if not self._supports_executable():
1131
executable = entry is not None and entry.executable
1133
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1134
return kind, executable, stat_value
1136
def _file_size(self, entry, stat_value):
1137
return stat_value.st_size
1139
def last_revision(self):
1140
"""Return the last revision of the branch for this tree.
1142
This format tree does not support a separate marker for last-revision
1143
compared to the branch.
1145
See MutableTree.last_revision
1147
return self._last_revision()
1150
def _last_revision(self):
1151
"""helper for get_parent_ids."""
1152
return _mod_revision.ensure_null(self.branch.last_revision())
1154
def is_locked(self):
1155
"""Check if this tree is locked."""
1156
raise NotImplementedError(self.is_locked)
1158
def lock_read(self):
1159
"""Lock the tree for reading.
1161
This also locks the branch, and can be unlocked via self.unlock().
1163
:return: A bzrlib.lock.LogicalLockResult.
1165
raise NotImplementedError(self.lock_read)
1167
def lock_tree_write(self):
1168
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1170
:return: A bzrlib.lock.LogicalLockResult.
1172
raise NotImplementedError(self.lock_tree_write)
1174
def lock_write(self):
1175
"""See MutableTree.lock_write, and WorkingTree.unlock.
1177
:return: A bzrlib.lock.LogicalLockResult.
1179
raise NotImplementedError(self.lock_write)
1181
def get_physical_lock_status(self):
1182
raise NotImplementedError(self.get_physical_lock_status)
1184
def set_last_revision(self, new_revision):
1185
"""Change the last revision in the working tree."""
1186
raise NotImplementedError(self.set_last_revision)
1188
def _change_last_revision(self, new_revision):
1189
"""Template method part of set_last_revision to perform the change.
1191
This is used to allow WorkingTree3 instances to not affect branch
1192
when their last revision is set.
1194
if _mod_revision.is_null(new_revision):
1195
self.branch.set_last_revision_info(0, new_revision)
1197
_mod_revision.check_not_reserved_id(new_revision)
1199
self.branch.generate_revision_history(new_revision)
1200
except errors.NoSuchRevision:
1201
# not present in the repo - dont try to set it deeper than the tip
1202
self.branch._set_revision_history([new_revision])
1205
@needs_tree_write_lock
1206
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1208
"""Remove nominated files from the working tree metadata.
1210
:files: File paths relative to the basedir.
1211
:keep_files: If true, the files will also be kept.
1212
:force: Delete files and directories, even if they are changed and
1213
even if the directories are not empty.
1215
if isinstance(files, basestring):
1220
all_files = set() # specified and nested files
1221
unknown_nested_files=set()
1223
to_file = sys.stdout
1225
files_to_backup = []
1227
def recurse_directory_to_add_files(directory):
1228
# Recurse directory and add all files
1229
# so we can check if they have changed.
1230
for parent_info, file_infos in self.walkdirs(directory):
1231
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1232
# Is it versioned or ignored?
1233
if self.path2id(relpath):
1234
# Add nested content for deletion.
1235
all_files.add(relpath)
1237
# Files which are not versioned
1238
# should be treated as unknown.
1239
files_to_backup.append(relpath)
1241
for filename in files:
1242
# Get file name into canonical form.
1243
abspath = self.abspath(filename)
1244
filename = self.relpath(abspath)
1245
if len(filename) > 0:
1246
all_files.add(filename)
1247
recurse_directory_to_add_files(filename)
1249
files = list(all_files)
1252
return # nothing to do
1254
# Sort needed to first handle directory content before the directory
1255
files.sort(reverse=True)
1257
# Bail out if we are going to delete files we shouldn't
1258
if not keep_files and not force:
1259
for (file_id, path, content_change, versioned, parent_id, name,
1260
kind, executable) in self.iter_changes(self.basis_tree(),
1261
include_unchanged=True, require_versioned=False,
1262
want_unversioned=True, specific_files=files):
1263
if versioned[0] == False:
1264
# The record is unknown or newly added
1265
files_to_backup.append(path[1])
1266
elif (content_change and (kind[1] is not None) and
1267
osutils.is_inside_any(files, path[1])):
1268
# Versioned and changed, but not deleted, and still
1269
# in one of the dirs to be deleted.
1270
files_to_backup.append(path[1])
1272
def backup(file_to_backup):
1273
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1274
osutils.rename(abs_path, self.abspath(backup_name))
1275
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1278
# Build inv_delta and delete files where applicable,
1279
# do this before any modifications to meta data.
1281
fid = self.path2id(f)
1284
message = "%s is not versioned." % (f,)
1287
# having removed it, it must be either ignored or unknown
1288
if self.is_ignored(f):
1292
# XXX: Really should be a more abstract reporter interface
1293
kind_ch = osutils.kind_marker(self.kind(fid))
1294
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1296
inv_delta.append((f, None, fid, None))
1297
message = "removed %s" % (f,)
1300
abs_path = self.abspath(f)
1301
if osutils.lexists(abs_path):
1302
if (osutils.isdir(abs_path) and
1303
len(os.listdir(abs_path)) > 0):
1305
osutils.rmtree(abs_path)
1306
message = "deleted %s" % (f,)
1310
if f in files_to_backup:
1313
osutils.delete_any(abs_path)
1314
message = "deleted %s" % (f,)
1315
elif message is not None:
1316
# Only care if we haven't done anything yet.
1317
message = "%s does not exist." % (f,)
1319
# Print only one message (if any) per file.
1320
if message is not None:
1322
self.apply_inventory_delta(inv_delta)
1324
@needs_tree_write_lock
1325
def revert(self, filenames=None, old_tree=None, backups=True,
1326
pb=None, report_changes=False):
1327
from bzrlib.conflicts import resolve
1328
if old_tree is None:
1329
basis_tree = self.basis_tree()
1330
basis_tree.lock_read()
1331
old_tree = basis_tree
1335
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1337
if filenames is None and len(self.get_parent_ids()) > 1:
1339
last_revision = self.last_revision()
1340
if last_revision != _mod_revision.NULL_REVISION:
1341
if basis_tree is None:
1342
basis_tree = self.basis_tree()
1343
basis_tree.lock_read()
1344
parent_trees.append((last_revision, basis_tree))
1345
self.set_parent_trees(parent_trees)
1348
resolve(self, filenames, ignore_misses=True, recursive=True)
1350
if basis_tree is not None:
1354
def revision_tree(self, revision_id):
1355
"""See Tree.revision_tree.
1357
WorkingTree can supply revision_trees for the basis revision only
1358
because there is only one cached inventory in the bzr directory.
1360
raise NotImplementedError(self.revision_tree)
1362
@needs_tree_write_lock
1363
def set_root_id(self, file_id):
1364
"""Set the root id for this tree."""
1368
'WorkingTree.set_root_id with fileid=None')
1369
file_id = osutils.safe_file_id(file_id)
1370
self._set_root_id(file_id)
1372
def _set_root_id(self, file_id):
1373
"""Set the root id for this tree, in a format specific manner.
1375
:param file_id: The file id to assign to the root. It must not be
1376
present in the current inventory or an error will occur. It must
1377
not be None, but rather a valid file id.
1379
raise NotImplementedError(self._set_root_id)
1382
"""See Branch.unlock.
1384
WorkingTree locking just uses the Branch locking facilities.
1385
This is current because all working trees have an embedded branch
1386
within them. IF in the future, we were to make branch data shareable
1387
between multiple working trees, i.e. via shared storage, then we
1388
would probably want to lock both the local tree, and the branch.
1390
raise NotImplementedError(self.unlock)
1394
def update(self, change_reporter=None, possible_transports=None,
1395
revision=None, old_tip=_marker, show_base=False):
1396
"""Update a working tree along its branch.
1398
This will update the branch if its bound too, which means we have
1399
multiple trees involved:
1401
- The new basis tree of the master.
1402
- The old basis tree of the branch.
1403
- The old basis tree of the working tree.
1404
- The current working tree state.
1406
Pathologically, all three may be different, and non-ancestors of each
1407
other. Conceptually we want to:
1409
- Preserve the wt.basis->wt.state changes
1410
- Transform the wt.basis to the new master basis.
1411
- Apply a merge of the old branch basis to get any 'local' changes from
1413
- Restore the wt.basis->wt.state changes.
1415
There isn't a single operation at the moment to do that, so we:
1417
- Merge current state -> basis tree of the master w.r.t. the old tree
1419
- Do a 'normal' merge of the old branch basis if it is relevant.
1421
:param revision: The target revision to update to. Must be in the
1423
:param old_tip: If branch.update() has already been run, the value it
1424
returned (old tip of the branch or None). _marker is used
1427
if self.branch.get_bound_location() is not None:
1429
update_branch = (old_tip is self._marker)
1431
self.lock_tree_write()
1432
update_branch = False
1435
old_tip = self.branch.update(possible_transports)
1437
if old_tip is self._marker:
1439
return self._update_tree(old_tip, change_reporter, revision, show_base)
1443
@needs_tree_write_lock
1444
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1446
"""Update a tree to the master branch.
1448
:param old_tip: if supplied, the previous tip revision the branch,
1449
before it was changed to the master branch's tip.
1451
# here if old_tip is not None, it is the old tip of the branch before
1452
# it was updated from the master branch. This should become a pending
1453
# merge in the working tree to preserve the user existing work. we
1454
# cant set that until we update the working trees last revision to be
1455
# one from the new branch, because it will just get absorbed by the
1456
# parent de-duplication logic.
1458
# We MUST save it even if an error occurs, because otherwise the users
1459
# local work is unreferenced and will appear to have been lost.
1463
last_rev = self.get_parent_ids()[0]
1465
last_rev = _mod_revision.NULL_REVISION
1466
if revision is None:
1467
revision = self.branch.last_revision()
1469
old_tip = old_tip or _mod_revision.NULL_REVISION
1471
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1472
# the branch we are bound to was updated
1473
# merge those changes in first
1474
base_tree = self.basis_tree()
1475
other_tree = self.branch.repository.revision_tree(old_tip)
1476
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1477
base_tree, this_tree=self,
1478
change_reporter=change_reporter,
1479
show_base=show_base)
1481
self.add_parent_tree((old_tip, other_tree))
1482
note(gettext('Rerun update after fixing the conflicts.'))
1485
if last_rev != _mod_revision.ensure_null(revision):
1486
# the working tree is up to date with the branch
1487
# we can merge the specified revision from master
1488
to_tree = self.branch.repository.revision_tree(revision)
1489
to_root_id = to_tree.get_root_id()
1491
basis = self.basis_tree()
1494
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1495
self.set_root_id(to_root_id)
1500
# determine the branch point
1501
graph = self.branch.repository.get_graph()
1502
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1504
base_tree = self.branch.repository.revision_tree(base_rev_id)
1506
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1508
change_reporter=change_reporter,
1509
show_base=show_base)
1510
self.set_last_revision(revision)
1511
# TODO - dedup parents list with things merged by pull ?
1512
# reuse the tree we've updated to to set the basis:
1513
parent_trees = [(revision, to_tree)]
1514
merges = self.get_parent_ids()[1:]
1515
# Ideally we ask the tree for the trees here, that way the working
1516
# tree can decide whether to give us the entire tree or give us a
1517
# lazy initialised tree. dirstate for instance will have the trees
1518
# in ram already, whereas a last-revision + basis-inventory tree
1519
# will not, but also does not need them when setting parents.
1520
for parent in merges:
1521
parent_trees.append(
1522
(parent, self.branch.repository.revision_tree(parent)))
1523
if not _mod_revision.is_null(old_tip):
1524
parent_trees.append(
1525
(old_tip, self.branch.repository.revision_tree(old_tip)))
1526
self.set_parent_trees(parent_trees)
1527
last_rev = parent_trees[0][0]
1530
def set_conflicts(self, arg):
1531
raise errors.UnsupportedOperation(self.set_conflicts, self)
1533
def add_conflicts(self, arg):
1534
raise errors.UnsupportedOperation(self.add_conflicts, self)
1536
def conflicts(self):
1537
raise NotImplementedError(self.conflicts)
1539
def walkdirs(self, prefix=""):
1540
"""Walk the directories of this tree.
1542
returns a generator which yields items in the form:
1543
((curren_directory_path, fileid),
1544
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1547
This API returns a generator, which is only valid during the current
1548
tree transaction - within a single lock_read or lock_write duration.
1550
If the tree is not locked, it may cause an error to be raised,
1551
depending on the tree implementation.
1553
disk_top = self.abspath(prefix)
1554
if disk_top.endswith('/'):
1555
disk_top = disk_top[:-1]
1556
top_strip_len = len(disk_top) + 1
1557
inventory_iterator = self._walkdirs(prefix)
1558
disk_iterator = osutils.walkdirs(disk_top, prefix)
1560
current_disk = disk_iterator.next()
1561
disk_finished = False
1563
if not (e.errno == errno.ENOENT or
1564
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1567
disk_finished = True
1569
current_inv = inventory_iterator.next()
1570
inv_finished = False
1571
except StopIteration:
1574
while not inv_finished or not disk_finished:
1576
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1577
cur_disk_dir_content) = current_disk
1579
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1580
cur_disk_dir_content) = ((None, None), None)
1581
if not disk_finished:
1582
# strip out .bzr dirs
1583
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1584
len(cur_disk_dir_content) > 0):
1585
# osutils.walkdirs can be made nicer -
1586
# yield the path-from-prefix rather than the pathjoined
1588
bzrdir_loc = bisect_left(cur_disk_dir_content,
1590
if (bzrdir_loc < len(cur_disk_dir_content)
1591
and self.bzrdir.is_control_filename(
1592
cur_disk_dir_content[bzrdir_loc][0])):
1593
# we dont yield the contents of, or, .bzr itself.
1594
del cur_disk_dir_content[bzrdir_loc]
1596
# everything is unknown
1599
# everything is missing
1602
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1604
# disk is before inventory - unknown
1605
dirblock = [(relpath, basename, kind, stat, None, None) for
1606
relpath, basename, kind, stat, top_path in
1607
cur_disk_dir_content]
1608
yield (cur_disk_dir_relpath, None), dirblock
1610
current_disk = disk_iterator.next()
1611
except StopIteration:
1612
disk_finished = True
1614
# inventory is before disk - missing.
1615
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1616
for relpath, basename, dkind, stat, fileid, kind in
1618
yield (current_inv[0][0], current_inv[0][1]), dirblock
1620
current_inv = inventory_iterator.next()
1621
except StopIteration:
1624
# versioned present directory
1625
# merge the inventory and disk data together
1627
for relpath, subiterator in itertools.groupby(sorted(
1628
current_inv[1] + cur_disk_dir_content,
1629
key=operator.itemgetter(0)), operator.itemgetter(1)):
1630
path_elements = list(subiterator)
1631
if len(path_elements) == 2:
1632
inv_row, disk_row = path_elements
1633
# versioned, present file
1634
dirblock.append((inv_row[0],
1635
inv_row[1], disk_row[2],
1636
disk_row[3], inv_row[4],
1638
elif len(path_elements[0]) == 5:
1640
dirblock.append((path_elements[0][0],
1641
path_elements[0][1], path_elements[0][2],
1642
path_elements[0][3], None, None))
1643
elif len(path_elements[0]) == 6:
1644
# versioned, absent file.
1645
dirblock.append((path_elements[0][0],
1646
path_elements[0][1], 'unknown', None,
1647
path_elements[0][4], path_elements[0][5]))
1649
raise NotImplementedError('unreachable code')
1650
yield current_inv[0], dirblock
1652
current_inv = inventory_iterator.next()
1653
except StopIteration:
1656
current_disk = disk_iterator.next()
1657
except StopIteration:
1658
disk_finished = True
1660
def _walkdirs(self, prefix=""):
1661
"""Walk the directories of this tree.
1663
:param prefix: is used as the directrory to start with.
1664
:returns: a generator which yields items in the form::
1666
((curren_directory_path, fileid),
1667
[(file1_path, file1_name, file1_kind, None, file1_id,
1670
raise NotImplementedError(self._walkdirs)
1672
@needs_tree_write_lock
1673
def auto_resolve(self):
1674
"""Automatically resolve text conflicts according to contents.
1676
Only text conflicts are auto_resolvable. Files with no conflict markers
1677
are considered 'resolved', because bzr always puts conflict markers
1678
into files that have text conflicts. The corresponding .THIS .BASE and
1679
.OTHER files are deleted, as per 'resolve'.
1681
:return: a tuple of ConflictLists: (un_resolved, resolved).
1683
un_resolved = _mod_conflicts.ConflictList()
1684
resolved = _mod_conflicts.ConflictList()
1685
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1686
for conflict in self.conflicts():
1687
if (conflict.typestring != 'text conflict' or
1688
self.kind(conflict.file_id) != 'file'):
1689
un_resolved.append(conflict)
1691
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1693
for line in my_file:
1694
if conflict_re.search(line):
1695
un_resolved.append(conflict)
1698
resolved.append(conflict)
1701
resolved.remove_files(self)
1702
self.set_conflicts(un_resolved)
1703
return un_resolved, resolved
1705
def _validate(self):
1706
"""Validate internal structures.
1708
This is meant mostly for the test suite. To give it a chance to detect
1709
corruption after actions have occurred. The default implementation is a
1712
:return: None. An exception should be raised if there is an error.
1716
def check_state(self):
1717
"""Check that the working state is/isn't valid."""
1718
raise NotImplementedError(self.check_state)
1720
def reset_state(self, revision_ids=None):
1721
"""Reset the state of the working tree.
1723
This does a hard-reset to a last-known-good state. This is a way to
1724
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1726
raise NotImplementedError(self.reset_state)
1728
def _get_rules_searcher(self, default_searcher):
1729
"""See Tree._get_rules_searcher."""
1730
if self._rules_searcher is None:
1731
self._rules_searcher = super(WorkingTree,
1732
self)._get_rules_searcher(default_searcher)
1733
return self._rules_searcher
1735
def get_shelf_manager(self):
1736
"""Return the ShelfManager for this WorkingTree."""
1737
from bzrlib.shelf import ShelfManager
1738
return ShelfManager(self, self._transport)
1741
class InventoryWorkingTree(WorkingTree,
1742
bzrlib.mutabletree.MutableInventoryTree):
1743
"""Base class for working trees that are inventory-oriented.
1745
The inventory is held in the `Branch` working-inventory, and the
1746
files are in a directory on disk.
1748
It is possible for a `WorkingTree` to have a filename which is
1749
not listed in the Inventory and vice versa.
1752
def __init__(self, basedir='.',
1753
branch=DEPRECATED_PARAMETER,
1755
_control_files=None,
1759
"""Construct a InventoryWorkingTree instance. This is not a public API.
1761
:param branch: A branch to override probing for the branch.
1763
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1764
branch=branch, _transport=_control_files._transport,
1765
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1767
self._control_files = _control_files
1768
self._detect_case_handling()
1770
if _inventory is None:
1771
# This will be acquired on lock_read() or lock_write()
1772
self._inventory_is_modified = False
1773
self._inventory = None
1775
# the caller of __init__ has provided an inventory,
1776
# we assume they know what they are doing - as its only
1777
# the Format factory and creation methods that are
1778
# permitted to do this.
1779
self._set_inventory(_inventory, dirty=False)
1781
def _set_inventory(self, inv, dirty):
1782
"""Set the internal cached inventory.
1784
:param inv: The inventory to set.
1785
:param dirty: A boolean indicating whether the inventory is the same
1786
logical inventory as whats on disk. If True the inventory is not
1787
the same and should be written to disk or data will be lost, if
1788
False then the inventory is the same as that on disk and any
1789
serialisation would be unneeded overhead.
1791
self._inventory = inv
1792
self._inventory_is_modified = dirty
1794
def _detect_case_handling(self):
1795
wt_trans = self.bzrdir.get_workingtree_transport(None)
1797
wt_trans.stat(self._format.case_sensitive_filename)
1798
except errors.NoSuchFile:
1799
self.case_sensitive = True
1801
self.case_sensitive = False
1803
self._setup_directory_is_tree_reference()
1805
def _serialize(self, inventory, out_file):
1806
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1809
def _deserialize(selt, in_file):
1810
return xml5.serializer_v5.read_inventory(in_file)
1812
def break_lock(self):
1813
"""Break a lock if one is present from another instance.
1815
Uses the ui factory to ask for confirmation if the lock may be from
1818
This will probe the repository for its lock as well.
1820
self._control_files.break_lock()
1821
self.branch.break_lock()
1823
def is_locked(self):
1824
return self._control_files.is_locked()
1826
def _must_be_locked(self):
1827
if not self.is_locked():
1828
raise errors.ObjectNotLocked(self)
1830
def lock_read(self):
1831
"""Lock the tree for reading.
1833
This also locks the branch, and can be unlocked via self.unlock().
1835
:return: A bzrlib.lock.LogicalLockResult.
1837
if not self.is_locked():
1839
self.branch.lock_read()
1841
self._control_files.lock_read()
1842
return LogicalLockResult(self.unlock)
1844
self.branch.unlock()
1847
def lock_tree_write(self):
1848
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1850
:return: A bzrlib.lock.LogicalLockResult.
1852
if not self.is_locked():
1854
self.branch.lock_read()
1856
self._control_files.lock_write()
1857
return LogicalLockResult(self.unlock)
1859
self.branch.unlock()
1862
def lock_write(self):
1863
"""See MutableTree.lock_write, and WorkingTree.unlock.
1865
:return: A bzrlib.lock.LogicalLockResult.
1867
if not self.is_locked():
1869
self.branch.lock_write()
1871
self._control_files.lock_write()
1872
return LogicalLockResult(self.unlock)
1874
self.branch.unlock()
1877
def get_physical_lock_status(self):
1878
return self._control_files.get_physical_lock_status()
1880
@needs_tree_write_lock
1881
def _write_inventory(self, inv):
1882
"""Write inventory as the current inventory."""
1883
self._set_inventory(inv, dirty=True)
1886
# XXX: This method should be deprecated in favour of taking in a proper
1887
# new Inventory object.
1888
@needs_tree_write_lock
1889
def set_inventory(self, new_inventory_list):
1890
from bzrlib.inventory import (Inventory,
1894
inv = Inventory(self.get_root_id())
1895
for path, file_id, parent, kind in new_inventory_list:
1896
name = os.path.basename(path)
1899
# fixme, there should be a factory function inv,add_??
1900
if kind == 'directory':
1901
inv.add(InventoryDirectory(file_id, name, parent))
1902
elif kind == 'file':
1903
inv.add(InventoryFile(file_id, name, parent))
1904
elif kind == 'symlink':
1905
inv.add(InventoryLink(file_id, name, parent))
1907
raise errors.BzrError("unknown kind %r" % kind)
1908
self._write_inventory(inv)
1910
def _write_basis_inventory(self, xml):
1911
"""Write the basis inventory XML to the basis-inventory file"""
1912
path = self._basis_inventory_name()
1914
self._transport.put_file(path, sio,
1915
mode=self.bzrdir._get_file_mode())
1917
def _reset_data(self):
1918
"""Reset transient data that cannot be revalidated."""
1919
self._inventory_is_modified = False
1920
f = self._transport.get('inventory')
1922
result = self._deserialize(f)
1925
self._set_inventory(result, dirty=False)
1927
def _set_root_id(self, file_id):
1928
"""Set the root id for this tree, in a format specific manner.
1930
:param file_id: The file id to assign to the root. It must not be
1931
present in the current inventory or an error will occur. It must
1932
not be None, but rather a valid file id.
1934
inv = self._inventory
1935
orig_root_id = inv.root.file_id
1936
# TODO: it might be nice to exit early if there was nothing
1937
# to do, saving us from trigger a sync on unlock.
1938
self._inventory_is_modified = True
1939
# we preserve the root inventory entry object, but
1940
# unlinkit from the byid index
1941
del inv._byid[inv.root.file_id]
1942
inv.root.file_id = file_id
1943
# and link it into the index with the new changed id.
1944
inv._byid[inv.root.file_id] = inv.root
1945
# and finally update all children to reference the new id.
1946
# XXX: this should be safe to just look at the root.children
1947
# list, not the WHOLE INVENTORY.
1950
if entry.parent_id == orig_root_id:
1951
entry.parent_id = inv.root.file_id
1953
@needs_tree_write_lock
1954
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1955
"""See MutableTree.set_parent_trees."""
1956
parent_ids = [rev for (rev, tree) in parents_list]
1957
for revision_id in parent_ids:
1958
_mod_revision.check_not_reserved_id(revision_id)
1960
self._check_parents_for_ghosts(parent_ids,
1961
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1963
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1965
if len(parent_ids) == 0:
1966
leftmost_parent_id = _mod_revision.NULL_REVISION
1967
leftmost_parent_tree = None
1969
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1971
if self._change_last_revision(leftmost_parent_id):
1972
if leftmost_parent_tree is None:
1973
# If we don't have a tree, fall back to reading the
1974
# parent tree from the repository.
1975
self._cache_basis_inventory(leftmost_parent_id)
1977
inv = leftmost_parent_tree.root_inventory
1978
xml = self._create_basis_xml_from_inventory(
1979
leftmost_parent_id, inv)
1980
self._write_basis_inventory(xml)
1981
self._set_merges_from_parent_ids(parent_ids)
1983
def _cache_basis_inventory(self, new_revision):
1984
"""Cache new_revision as the basis inventory."""
1985
# TODO: this should allow the ready-to-use inventory to be passed in,
1986
# as commit already has that ready-to-use [while the format is the
1989
# this double handles the inventory - unpack and repack -
1990
# but is easier to understand. We can/should put a conditional
1991
# in here based on whether the inventory is in the latest format
1992
# - perhaps we should repack all inventories on a repository
1994
# the fast path is to copy the raw xml from the repository. If the
1995
# xml contains 'revision_id="', then we assume the right
1996
# revision_id is set. We must check for this full string, because a
1997
# root node id can legitimately look like 'revision_id' but cannot
1999
xml = self.branch.repository._get_inventory_xml(new_revision)
2000
firstline = xml.split('\n', 1)[0]
2001
if (not 'revision_id="' in firstline or
2002
'format="7"' not in firstline):
2003
inv = self.branch.repository._serializer.read_inventory_from_string(
2005
xml = self._create_basis_xml_from_inventory(new_revision, inv)
2006
self._write_basis_inventory(xml)
2007
except (errors.NoSuchRevision, errors.RevisionNotPresent):
2010
def _basis_inventory_name(self):
2011
return 'basis-inventory-cache'
2013
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2014
"""Create the text that will be saved in basis-inventory"""
2015
inventory.revision_id = revision_id
2016
return xml7.serializer_v7.write_inventory_to_string(inventory)
2018
@needs_tree_write_lock
2019
def set_conflicts(self, conflicts):
2020
self._put_rio('conflicts', conflicts.to_stanzas(),
2023
@needs_tree_write_lock
2024
def add_conflicts(self, new_conflicts):
2025
conflict_set = set(self.conflicts())
2026
conflict_set.update(set(list(new_conflicts)))
2027
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2028
key=_mod_conflicts.Conflict.sort_key)))
2031
def conflicts(self):
2033
confile = self._transport.get('conflicts')
2034
except errors.NoSuchFile:
2035
return _mod_conflicts.ConflictList()
2038
if confile.next() != CONFLICT_HEADER_1 + '\n':
2039
raise errors.ConflictFormatError()
2040
except StopIteration:
2041
raise errors.ConflictFormatError()
2042
reader = _mod_rio.RioReader(confile)
2043
return _mod_conflicts.ConflictList.from_stanzas(reader)
2047
def read_basis_inventory(self):
2048
"""Read the cached basis inventory."""
2049
path = self._basis_inventory_name()
2050
return self._transport.get_bytes(path)
2053
def read_working_inventory(self):
2054
"""Read the working inventory.
2056
:raises errors.InventoryModified: read_working_inventory will fail
2057
when the current in memory inventory has been modified.
2059
# conceptually this should be an implementation detail of the tree.
2060
# XXX: Deprecate this.
2061
# ElementTree does its own conversion from UTF-8, so open in
2063
if self._inventory_is_modified:
2064
raise errors.InventoryModified(self)
2065
f = self._transport.get('inventory')
2067
result = self._deserialize(f)
2070
self._set_inventory(result, dirty=False)
2074
def get_root_id(self):
2075
"""Return the id of this trees root"""
2076
return self._inventory.root.file_id
2078
99
def has_id(self, file_id):
2079
100
# files that have been deleted are excluded
2080
inv, inv_file_id = self._unpack_file_id(file_id)
2081
if not inv.has_id(inv_file_id):
2083
path = inv.id2path(inv_file_id)
2084
return osutils.lexists(self.abspath(path))
2086
def has_or_had_id(self, file_id):
2087
if file_id == self.get_root_id():
2089
inv, inv_file_id = self._unpack_file_id(file_id)
2090
return inv.has_id(inv_file_id)
2092
def all_file_ids(self):
2093
"""Iterate through file_ids for this tree.
2095
file_ids are in a WorkingTree if they are in the working inventory
2096
and the working file exists.
2099
for path, ie in self.iter_entries_by_dir():
2103
@needs_tree_write_lock
2104
def set_last_revision(self, new_revision):
2105
"""Change the last revision in the working tree."""
2106
if self._change_last_revision(new_revision):
2107
self._cache_basis_inventory(new_revision)
2109
def _get_check_refs(self):
2110
"""Return the references needed to perform a check of this tree.
2112
The default implementation returns no refs, and is only suitable for
2113
trees that have no local caching and can commit on ghosts at any time.
2115
:seealso: bzrlib.check for details about check_refs.
2120
def _check(self, references):
2121
"""Check the tree for consistency.
2123
:param references: A dict with keys matching the items returned by
2124
self._get_check_refs(), and values from looking those keys up in
2127
tree_basis = self.basis_tree()
2128
tree_basis.lock_read()
2130
repo_basis = references[('trees', self.last_revision())]
2131
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2132
raise errors.BzrCheckError(
2133
"Mismatched basis inventory content.")
2139
def check_state(self):
2140
"""Check that the working state is/isn't valid."""
2141
check_refs = self._get_check_refs()
2143
for ref in check_refs:
2146
refs[ref] = self.branch.repository.revision_tree(value)
2149
@needs_tree_write_lock
2150
def reset_state(self, revision_ids=None):
2151
"""Reset the state of the working tree.
2153
This does a hard-reset to a last-known-good state. This is a way to
2154
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2156
if revision_ids is None:
2157
revision_ids = self.get_parent_ids()
2158
if not revision_ids:
2159
rt = self.branch.repository.revision_tree(
2160
_mod_revision.NULL_REVISION)
2162
rt = self.branch.repository.revision_tree(revision_ids[0])
2163
self._write_inventory(rt.root_inventory)
2164
self.set_parent_ids(revision_ids)
2167
"""Write the in memory inventory to disk."""
2168
# TODO: Maybe this should only write on dirty ?
2169
if self._control_files._lock_mode != 'w':
2170
raise errors.NotWriteLocked(self)
2172
self._serialize(self._inventory, sio)
2174
self._transport.put_file('inventory', sio,
2175
mode=self.bzrdir._get_file_mode())
2176
self._inventory_is_modified = False
2178
def get_file_mtime(self, file_id, path=None):
2179
"""See Tree.get_file_mtime."""
2181
path = self.id2path(file_id)
2183
return os.lstat(self.abspath(path)).st_mtime
2185
if e.errno == errno.ENOENT:
2186
raise errors.FileTimestampUnavailable(path)
2189
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2190
inv, file_id = self._path2inv_file_id(path)
2192
# For unversioned files on win32, we just assume they are not
2195
return inv[file_id].executable
2197
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2198
mode = stat_result.st_mode
2199
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2201
def is_executable(self, file_id, path=None):
2202
if not self._supports_executable():
2203
inv, inv_file_id = self._unpack_file_id(file_id)
2204
return inv[inv_file_id].executable
2207
path = self.id2path(file_id)
2208
mode = os.lstat(self.abspath(path)).st_mode
2209
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2211
def _is_executable_from_path_and_stat(self, path, stat_result):
2212
if not self._supports_executable():
2213
return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
2215
return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
2217
@needs_tree_write_lock
2218
def _add(self, files, ids, kinds):
2219
"""See MutableTree._add."""
2220
# TODO: Re-adding a file that is removed in the working copy
2221
# should probably put it back with the previous ID.
2222
# the read and write working inventory should not occur in this
2223
# function - they should be part of lock_write and unlock.
2224
# FIXME: nested trees
2225
inv = self.root_inventory
2226
for f, file_id, kind in zip(files, ids, kinds):
2228
inv.add_path(f, kind=kind)
2230
inv.add_path(f, kind=kind, file_id=file_id)
2231
self._inventory_is_modified = True
2233
def revision_tree(self, revision_id):
2234
"""See WorkingTree.revision_id."""
2235
if revision_id == self.last_revision():
2237
xml = self.read_basis_inventory()
2238
except errors.NoSuchFile:
2242
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2243
# dont use the repository revision_tree api because we want
2244
# to supply the inventory.
2245
if inv.revision_id == revision_id:
2246
return revisiontree.InventoryRevisionTree(
2247
self.branch.repository, inv, revision_id)
2248
except errors.BadInventoryFormat:
2250
# raise if there was no inventory, or if we read the wrong inventory.
2251
raise errors.NoSuchRevisionInTree(self, revision_id)
2254
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2255
"""See Tree.annotate_iter
2257
This implementation will use the basis tree implementation if possible.
2258
Lines not in the basis are attributed to CURRENT_REVISION
2260
If there are pending merges, lines added by those merges will be
2261
incorrectly attributed to CURRENT_REVISION (but after committing, the
2262
attribution will be correct).
2264
maybe_file_parent_keys = []
2265
for parent_id in self.get_parent_ids():
2267
parent_tree = self.revision_tree(parent_id)
2268
except errors.NoSuchRevisionInTree:
2269
parent_tree = self.branch.repository.revision_tree(parent_id)
2270
parent_tree.lock_read()
2273
kind = parent_tree.kind(file_id)
2274
except errors.NoSuchId:
2277
# Note: this is slightly unnecessary, because symlinks and
2278
# directories have a "text" which is the empty text, and we
2279
# know that won't mess up annotations. But it seems cleaner
2282
file_id, parent_tree.get_file_revision(file_id))
2283
if parent_text_key not in maybe_file_parent_keys:
2284
maybe_file_parent_keys.append(parent_text_key)
2286
parent_tree.unlock()
2287
graph = _mod_graph.Graph(self.branch.repository.texts)
2288
heads = graph.heads(maybe_file_parent_keys)
2289
file_parent_keys = []
2290
for key in maybe_file_parent_keys:
2292
file_parent_keys.append(key)
2294
# Now we have the parents of this content
2295
annotator = self.branch.repository.texts.get_annotator()
2296
text = self.get_file_text(file_id)
2297
this_key =(file_id, default_revision)
2298
annotator.add_special_text(this_key, file_parent_keys, text)
2299
annotations = [(key[-1], line)
2300
for key, line in annotator.annotate_flat(this_key)]
2303
def _put_rio(self, filename, stanzas, header):
2304
self._must_be_locked()
2305
my_file = _mod_rio.rio_file(stanzas, header)
2306
self._transport.put_file(filename, my_file,
2307
mode=self.bzrdir._get_file_mode())
2309
@needs_tree_write_lock
2310
def set_merge_modified(self, modified_hashes):
2312
for file_id, hash in modified_hashes.iteritems():
2313
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2315
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2318
def merge_modified(self):
2319
"""Return a dictionary of files modified by a merge.
2321
The list is initialized by WorkingTree.set_merge_modified, which is
2322
typically called after we make some automatic updates to the tree
2325
This returns a map of file_id->sha1, containing only files which are
2326
still in the working inventory and have that text hash.
2329
hashfile = self._transport.get('merge-hashes')
2330
except errors.NoSuchFile:
2335
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2336
raise errors.MergeModifiedFormatError()
2337
except StopIteration:
2338
raise errors.MergeModifiedFormatError()
2339
for s in _mod_rio.RioReader(hashfile):
2340
# RioReader reads in Unicode, so convert file_ids back to utf8
2341
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2342
if not self.has_id(file_id):
2344
text_hash = s.get("hash")
2345
if text_hash == self.get_file_sha1(file_id):
2346
merge_hashes[file_id] = text_hash
2352
def subsume(self, other_tree):
2353
def add_children(inventory, entry):
2354
for child_entry in entry.children.values():
2355
inventory._byid[child_entry.file_id] = child_entry
2356
if child_entry.kind == 'directory':
2357
add_children(inventory, child_entry)
2358
if other_tree.get_root_id() == self.get_root_id():
2359
raise errors.BadSubsumeSource(self, other_tree,
2360
'Trees have the same root')
2362
other_tree_path = self.relpath(other_tree.basedir)
2363
except errors.PathNotChild:
2364
raise errors.BadSubsumeSource(self, other_tree,
2365
'Tree is not contained by the other')
2366
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2367
if new_root_parent is None:
2368
raise errors.BadSubsumeSource(self, other_tree,
2369
'Parent directory is not versioned.')
2370
# We need to ensure that the result of a fetch will have a
2371
# versionedfile for the other_tree root, and only fetching into
2372
# RepositoryKnit2 guarantees that.
2373
if not self.branch.repository.supports_rich_root():
2374
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2375
other_tree.lock_tree_write()
2377
new_parents = other_tree.get_parent_ids()
2378
other_root = other_tree.root_inventory.root
2379
other_root.parent_id = new_root_parent
2380
other_root.name = osutils.basename(other_tree_path)
2381
self.root_inventory.add(other_root)
2382
add_children(self.root_inventory, other_root)
2383
self._write_inventory(self.root_inventory)
2384
# normally we don't want to fetch whole repositories, but i think
2385
# here we really do want to consolidate the whole thing.
2386
for parent_id in other_tree.get_parent_ids():
2387
self.branch.fetch(other_tree.branch, parent_id)
2388
self.add_parent_tree_id(parent_id)
2391
other_tree.bzrdir.retire_bzrdir()
2393
@needs_tree_write_lock
2394
def extract(self, file_id, format=None):
2395
"""Extract a subtree from this tree.
2397
A new branch will be created, relative to the path for this tree.
2401
segments = osutils.splitpath(path)
2402
transport = self.branch.bzrdir.root_transport
2403
for name in segments:
2404
transport = transport.clone(name)
2405
transport.ensure_base()
2408
sub_path = self.id2path(file_id)
2409
branch_transport = mkdirs(sub_path)
2411
format = self.bzrdir.cloning_metadir()
2412
branch_transport.ensure_base()
2413
branch_bzrdir = format.initialize_on_transport(branch_transport)
2415
repo = branch_bzrdir.find_repository()
2416
except errors.NoRepositoryPresent:
2417
repo = branch_bzrdir.create_repository()
2418
if not repo.supports_rich_root():
2419
raise errors.RootNotRich()
2420
new_branch = branch_bzrdir.create_branch()
2421
new_branch.pull(self.branch)
2422
for parent_id in self.get_parent_ids():
2423
new_branch.fetch(self.branch, parent_id)
2424
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2425
if tree_transport.base != branch_transport.base:
2426
tree_bzrdir = format.initialize_on_transport(tree_transport)
2427
tree_bzrdir.set_branch_reference(new_branch)
2429
tree_bzrdir = branch_bzrdir
2430
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2431
wt.set_parent_ids(self.get_parent_ids())
2432
# FIXME: Support nested trees
2433
my_inv = self.root_inventory
2434
child_inv = inventory.Inventory(root_id=None)
2435
new_root = my_inv[file_id]
2436
my_inv.remove_recursive_id(file_id)
2437
new_root.parent_id = None
2438
child_inv.add(new_root)
2439
self._write_inventory(my_inv)
2440
wt._write_inventory(child_inv)
2443
def list_files(self, include_root=False, from_dir=None, recursive=True):
2444
"""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).
2446
133
Lists, but does not descend into unversioned directories.
2447
135
This does not include files that have been deleted in this
2448
tree. Skips the control directory.
2450
:param include_root: if True, return an entry for the root
2451
:param from_dir: start from this directory or None for the root
2452
:param recursive: whether to recurse into subdirectories or not
138
Skips the control directory.
2454
# list_files is an iterator, so @needs_read_lock doesn't work properly
2455
# with it. So callers should be careful to always read_lock the tree.
2456
if not self.is_locked():
2457
raise errors.ObjectNotLocked(self)
2459
if from_dir is None and include_root is True:
2460
yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
2461
# Convert these into local objects to save lookup times
2462
pathjoin = osutils.pathjoin
2463
file_kind = self._kind
2465
# transport.base ends in a slash, we want the piece
2466
# between the last two slashes
2467
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2469
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2471
# directory file_id, relative path, absolute path, reverse sorted children
2472
if from_dir is not None:
2473
inv, from_dir_id = self._path2inv_file_id(from_dir)
2474
if from_dir_id is None:
2475
# Directory not versioned
2477
from_dir_abspath = pathjoin(self.basedir, from_dir)
2479
inv = self.root_inventory
2480
from_dir_id = inv.root.file_id
2481
from_dir_abspath = self.basedir
2482
children = os.listdir(from_dir_abspath)
2484
# jam 20060527 The kernel sized tree seems equivalent whether we
2485
# use a deque and popleft to keep them sorted, or if we use a plain
2486
# list and just reverse() them.
2487
children = collections.deque(children)
2488
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2490
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2493
f = children.popleft()
140
inv = self._inventory
142
def descend(from_dir_relpath, from_dir_id, dp):
2494
146
## TODO: If we find a subdirectory with its own .bzr
2495
147
## directory, then that is a separate tree and we
2496
148
## should exclude it.
2498
# the bzrdir for this tree
2499
if transport_base_dir == f:
149
if bzrlib.BZRDIR == f:
2502
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2503
# and 'f' doesn't begin with one, we can do a string op, rather
2504
# than the checks of pathjoin(), all relative paths will have an extra slash
2506
fp = from_dir_relpath + '/' + f
153
fp = appendpath(from_dir_relpath, f)
2509
fap = from_dir_abspath + '/' + f
2511
dir_ie = inv[from_dir_id]
2512
if dir_ie.kind == 'directory':
2513
f_ie = dir_ie.children.get(f)
156
fap = appendpath(dp, f)
158
f_ie = inv.get_child(from_dir_id, f)
2518
elif self.is_ignored(fp[1:]):
161
elif self.is_ignored(fp):
2521
# we may not have found this file, because of a unicode
2522
# issue, or because the directory was actually a symlink.
2523
f_norm, can_access = osutils.normalized_filename(f)
2524
if f == f_norm or not can_access:
2525
# No change, so treat this file normally
2528
# this file can be accessed by a normalized path
2529
# check again if it is versioned
2530
# these lines are repeated here for performance
2532
fp = from_dir_relpath + '/' + f
2533
fap = from_dir_abspath + '/' + f
2534
f_ie = inv.get_child(from_dir_id, f)
2537
elif self.is_ignored(fp[1:]):
2542
166
fk = file_kind(fap)
2544
# make a last minute entry
2546
yield fp[1:], c, fk, f_ie.file_id, f_ie
2549
yield fp[1:], c, fk, None, fk_entries[fk]()
2551
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)
2554
176
if fk != 'directory':
2557
# But do this child first if recursing down
2559
new_children = os.listdir(fap)
2561
new_children = collections.deque(new_children)
2562
stack.append((f_ie.file_id, fp, fap, new_children))
2563
# Break out of inner loop,
2564
# so that we start outer loop with child
2567
# if we finished all children, pop it off the stack
2570
@needs_tree_write_lock
2571
def move(self, from_paths, to_dir=None, after=False):
2574
to_dir must exist in the inventory.
2576
If to_dir exists and is a directory, the files are moved into
2577
it, keeping their old names.
2579
Note that to_dir is only the last component of the new name;
2580
this doesn't change the directory.
2582
For each entry in from_paths the move mode will be determined
2585
The first mode moves the file in the filesystem and updates the
2586
inventory. The second mode only updates the inventory without
2587
touching the file on the filesystem.
2589
move uses the second mode if 'after == True' and the target is
2590
either not versioned or newly added, and present in the working tree.
2592
move uses the second mode if 'after == False' and the source is
2593
versioned but no longer in the working tree, and the target is not
2594
versioned but present in the working tree.
2596
move uses the first mode if 'after == False' and the source is
2597
versioned and present in the working tree, and the target is not
2598
versioned and not present in the working tree.
2600
Everything else results in an error.
2602
This returns a list of (from_path, to_path) pairs for each
2603
entry that is moved.
2608
invs_to_write = set()
2610
# check for deprecated use of signature
2612
raise TypeError('You must supply a target directory')
2613
# check destination directory
2614
if isinstance(from_paths, basestring):
2616
to_abs = self.abspath(to_dir)
2617
if not isdir(to_abs):
2618
raise errors.BzrMoveFailedError('',to_dir,
2619
errors.NotADirectory(to_abs))
2620
if not self.has_filename(to_dir):
2621
raise errors.BzrMoveFailedError('',to_dir,
2622
errors.NotInWorkingDirectory(to_dir))
2623
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2624
if to_dir_id is None:
2625
raise errors.BzrMoveFailedError('',to_dir,
2626
errors.NotVersionedError(path=to_dir))
2628
to_dir_ie = to_inv[to_dir_id]
2629
if to_dir_ie.kind != 'directory':
2630
raise errors.BzrMoveFailedError('',to_dir,
2631
errors.NotADirectory(to_abs))
2633
# create rename entries and tuples
2634
for from_rel in from_paths:
2635
from_tail = splitpath(from_rel)[-1]
2636
from_inv, from_id = self._path2inv_file_id(from_rel)
2638
raise errors.BzrMoveFailedError(from_rel,to_dir,
2639
errors.NotVersionedError(path=from_rel))
2641
from_entry = from_inv[from_id]
2642
from_parent_id = from_entry.parent_id
2643
to_rel = pathjoin(to_dir, from_tail)
2644
rename_entry = InventoryWorkingTree._RenameEntry(
2647
from_tail=from_tail,
2648
from_parent_id=from_parent_id,
2649
to_rel=to_rel, to_tail=from_tail,
2650
to_parent_id=to_dir_id)
2651
rename_entries.append(rename_entry)
2652
rename_tuples.append((from_rel, to_rel))
2654
# determine which move mode to use. checks also for movability
2655
rename_entries = self._determine_mv_mode(rename_entries, after)
2657
original_modified = self._inventory_is_modified
2660
self._inventory_is_modified = True
2661
self._move(rename_entries)
2663
# restore the inventory on error
2664
self._inventory_is_modified = original_modified
2666
#FIXME: Should potentially also write the from_invs
2667
self._write_inventory(to_inv)
2668
return rename_tuples
2670
@needs_tree_write_lock
2671
def rename_one(self, from_rel, to_rel, after=False):
2674
This can change the directory or the filename or both.
2676
rename_one has several 'modes' to work. First, it can rename a physical
2677
file and change the file_id. That is the normal mode. Second, it can
2678
only change the file_id without touching any physical file.
2680
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2681
versioned but present in the working tree.
2683
rename_one uses the second mode if 'after == False' and 'from_rel' is
2684
versioned but no longer in the working tree, and 'to_rel' is not
2685
versioned but present in the working tree.
2687
rename_one uses the first mode if 'after == False' and 'from_rel' is
2688
versioned and present in the working tree, and 'to_rel' is not
2689
versioned and not present in the working tree.
2691
Everything else results in an error.
2695
# create rename entries and tuples
2696
from_tail = splitpath(from_rel)[-1]
2697
from_inv, from_id = self._path2inv_file_id(from_rel)
2699
# if file is missing in the inventory maybe it's in the basis_tree
2700
basis_tree = self.branch.basis_tree()
2701
from_id = basis_tree.path2id(from_rel)
2703
raise errors.BzrRenameFailedError(from_rel,to_rel,
2704
errors.NotVersionedError(path=from_rel))
2705
# put entry back in the inventory so we can rename it
2706
from_entry = basis_tree.root_inventory[from_id].copy()
2707
from_inv.add(from_entry)
2709
from_inv, from_inv_id = self._unpack_file_id(from_id)
2710
from_entry = from_inv[from_inv_id]
2711
from_parent_id = from_entry.parent_id
2712
to_dir, to_tail = os.path.split(to_rel)
2713
to_inv, to_dir_id = self._path2inv_file_id(to_dir)
2714
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2716
from_tail=from_tail,
2717
from_parent_id=from_parent_id,
2718
to_rel=to_rel, to_tail=to_tail,
2719
to_parent_id=to_dir_id)
2720
rename_entries.append(rename_entry)
2722
# determine which move mode to use. checks also for movability
2723
rename_entries = self._determine_mv_mode(rename_entries, after)
2725
# check if the target changed directory and if the target directory is
2727
if to_dir_id is None:
2728
raise errors.BzrMoveFailedError(from_rel,to_rel,
2729
errors.NotVersionedError(path=to_dir))
2731
# all checks done. now we can continue with our actual work
2732
mutter('rename_one:\n'
2737
' to_dir_id {%s}\n',
2738
from_id, from_rel, to_rel, to_dir, to_dir_id)
2740
self._move(rename_entries)
2741
self._write_inventory(to_inv)
2743
class _RenameEntry(object):
2744
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2745
to_rel, to_tail, to_parent_id, only_change_inv=False,
2747
self.from_rel = from_rel
2748
self.from_id = from_id
2749
self.from_tail = from_tail
2750
self.from_parent_id = from_parent_id
2751
self.to_rel = to_rel
2752
self.to_tail = to_tail
2753
self.to_parent_id = to_parent_id
2754
self.change_id = change_id
2755
self.only_change_inv = only_change_inv
2757
def _determine_mv_mode(self, rename_entries, after=False):
2758
"""Determines for each from-to pair if both inventory and working tree
2759
or only the inventory has to be changed.
2761
Also does basic plausability tests.
2763
# FIXME: Handling of nested trees
2764
inv = self.root_inventory
2766
for rename_entry in rename_entries:
2767
# store to local variables for easier reference
2768
from_rel = rename_entry.from_rel
2769
from_id = rename_entry.from_id
2770
to_rel = rename_entry.to_rel
2771
to_id = inv.path2id(to_rel)
2772
only_change_inv = False
2775
# check the inventory for source and destination
2777
raise errors.BzrMoveFailedError(from_rel,to_rel,
2778
errors.NotVersionedError(path=from_rel))
2779
if to_id is not None:
2781
# allow it with --after but only if dest is newly added
2783
basis = self.basis_tree()
2786
if not basis.has_id(to_id):
2787
rename_entry.change_id = True
2792
raise errors.BzrMoveFailedError(from_rel,to_rel,
2793
errors.AlreadyVersionedError(path=to_rel))
2795
# try to determine the mode for rename (only change inv or change
2796
# inv and file system)
2798
if not self.has_filename(to_rel):
2799
raise errors.BzrMoveFailedError(from_id,to_rel,
2800
errors.NoSuchFile(path=to_rel,
2801
extra="New file has not been created yet"))
2802
only_change_inv = True
2803
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2804
only_change_inv = True
2805
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2806
only_change_inv = False
2807
elif (not self.case_sensitive
2808
and from_rel.lower() == to_rel.lower()
2809
and self.has_filename(from_rel)):
2810
only_change_inv = False
2812
# something is wrong, so lets determine what exactly
2813
if not self.has_filename(from_rel) and \
2814
not self.has_filename(to_rel):
2815
raise errors.BzrRenameFailedError(from_rel, to_rel,
2816
errors.PathsDoNotExist(paths=(from_rel, to_rel)))
2818
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2819
rename_entry.only_change_inv = only_change_inv
2820
return rename_entries
2822
def _move(self, rename_entries):
2823
"""Moves a list of files.
2825
Depending on the value of the flag 'only_change_inv', the
2826
file will be moved on the file system or not.
2830
for entry in rename_entries:
2832
self._move_entry(entry)
2834
self._rollback_move(moved)
2838
def _rollback_move(self, moved):
2839
"""Try to rollback a previous move in case of an filesystem error."""
2842
self._move_entry(WorkingTree._RenameEntry(
2843
entry.to_rel, entry.from_id,
2844
entry.to_tail, entry.to_parent_id, entry.from_rel,
2845
entry.from_tail, entry.from_parent_id,
2846
entry.only_change_inv))
2847
except errors.BzrMoveFailedError, e:
2848
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2849
" The working tree is in an inconsistent state."
2850
" Please consider doing a 'bzr revert'."
2851
" Error message is: %s" % e)
2853
def _move_entry(self, entry):
2854
inv = self.root_inventory
2855
from_rel_abs = self.abspath(entry.from_rel)
2856
to_rel_abs = self.abspath(entry.to_rel)
2857
if from_rel_abs == to_rel_abs:
2858
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2859
"Source and target are identical.")
2861
if not entry.only_change_inv:
2863
osutils.rename(from_rel_abs, to_rel_abs)
2865
raise errors.BzrMoveFailedError(entry.from_rel,
2868
to_id = inv.path2id(entry.to_rel)
2869
inv.remove_recursive_id(to_id)
2870
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2872
@needs_tree_write_lock
2873
def unversion(self, file_ids):
2874
"""Remove the file ids in file_ids from the current versioned set.
2876
When a file_id is unversioned, all of its children are automatically
2879
:param file_ids: The file ids to stop versioning.
2880
:raises: NoSuchId if any fileid is not currently versioned.
2882
for file_id in file_ids:
2883
if not self._inventory.has_id(file_id):
2884
raise errors.NoSuchId(self, file_id)
2885
for file_id in file_ids:
2886
if self._inventory.has_id(file_id):
2887
self._inventory.remove_recursive_id(file_id)
2889
# in the future this should just set a dirty bit to wait for the
2890
# final unlock. However, until all methods of workingtree start
2891
# with the current in -memory inventory rather than triggering
2892
# a read, it is more complex - we need to teach read_inventory
2893
# to know when to read, and when to not read first... and possibly
2894
# to save first when the in memory one may be corrupted.
2895
# so for now, we just only write it if it is indeed dirty.
2897
self._write_inventory(self._inventory)
2899
def stored_kind(self, file_id):
2900
"""See Tree.stored_kind"""
2901
inv, inv_file_id = self._unpack_file_id(file_id)
2902
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):
2904
197
def extras(self):
2905
"""Yield all unversioned files in this WorkingTree.
198
"""Yield all unknown files in this WorkingTree.
2907
If there are any unversioned directories then only the directory is
2908
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
2909
202
under a versioned subdirectory, they are returned.
2911
204
Currently returned depth-first, sorted by name within directories.
2912
This is the same order used by 'osutils.walkdirs'.
2914
206
## TODO: Work from given directory downwards
2915
for path, dir_entry in self.iter_entries_by_dir():
2916
if dir_entry.kind != 'directory':
2918
# mutter("search for unknowns in %r", path)
207
for path, dir_entry in self.inventory.directories():
208
mutter("search for unknowns in %r" % path)
2919
209
dirabs = self.abspath(path)
2920
210
if not isdir(dirabs):
2921
211
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
