1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
33
from cStringIO import StringIO
21
from errors import BzrCheckError
22
from trace import mutter
25
class WorkingTree(bzrlib.tree.Tree):
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
50
conflicts as _mod_conflicts,
53
filters as _mod_filters,
60
revision as _mod_revision,
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.i18n import gettext
75
from bzrlib.lock import LogicalLockResult
76
import bzrlib.mutabletree
77
from bzrlib.mutabletree import needs_tree_write_lock
78
from bzrlib import osutils
79
from bzrlib.osutils import (
89
from bzrlib.trace import mutter, note
90
from bzrlib.revision import CURRENT_REVISION
91
from bzrlib.symbol_versioning import (
97
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
98
# TODO: Modifying the conflict objects or their type is currently nearly
99
# impossible as there is no clear relationship between the working tree format
100
# and the conflict list file format.
101
CONFLICT_HEADER_1 = "BZR conflict list format 1"
103
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
106
class TreeEntry(object):
107
"""An entry that implements the minimum interface used by commands.
109
This needs further inspection, it may be better to have
110
InventoryEntries without ids - though that seems wrong. For now,
111
this is a parallel hierarchy to InventoryEntry, and needs to become
112
one of several things: decorates to that hierarchy, children of, or
114
Another note is that these objects are currently only used when there is
115
no InventoryEntry available - i.e. for unversioned objects.
116
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
119
def __eq__(self, other):
120
# yes, this us ugly, TODO: best practice __eq__ style.
121
return (isinstance(other, TreeEntry)
122
and other.__class__ == self.__class__)
124
def kind_character(self):
128
class TreeDirectory(TreeEntry):
129
"""See TreeEntry. This is a directory in a working tree."""
131
def __eq__(self, other):
132
return (isinstance(other, TreeDirectory)
133
and other.__class__ == self.__class__)
135
def kind_character(self):
139
class TreeFile(TreeEntry):
140
"""See TreeEntry. This is a regular file in a working tree."""
142
def __eq__(self, other):
143
return (isinstance(other, TreeFile)
144
and other.__class__ == self.__class__)
146
def kind_character(self):
150
class TreeLink(TreeEntry):
151
"""See TreeEntry. This is a symlink in a working tree."""
153
def __eq__(self, other):
154
return (isinstance(other, TreeLink)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class WorkingTree(bzrlib.mutabletree.MutableTree,
162
controldir.ControlComponent):
26
163
"""Working copy tree.
165
:ivar basedir: The root of the tree on disk. This is a unicode path object
166
(as opposed to a URL).
169
# override this to set the strategy for storing views
170
def _make_views(self):
171
return views.DisabledViews(self)
173
def __init__(self, basedir='.',
174
branch=DEPRECATED_PARAMETER,
179
"""Construct a WorkingTree instance. This is not a public API.
181
:param branch: A branch to override probing for the branch.
183
self._format = _format
184
self.bzrdir = _bzrdir
186
raise errors.BzrError("Please use bzrdir.open_workingtree or "
187
"WorkingTree.open() to obtain a WorkingTree.")
188
basedir = safe_unicode(basedir)
189
mutter("opening working tree %r", basedir)
190
if deprecated_passed(branch):
191
self._branch = branch
193
self._branch = self.bzrdir.open_branch()
194
self.basedir = realpath(basedir)
195
self._transport = _transport
196
self._rules_searcher = None
197
self.views = self._make_views()
200
def user_transport(self):
201
return self.bzrdir.user_transport
204
def control_transport(self):
205
return self._transport
207
def is_control_filename(self, filename):
208
"""True if filename is the name of a control file in this tree.
210
:param filename: A filename within the tree. This is a relative path
211
from the root of this tree.
213
This is true IF and ONLY IF the filename is part of the meta data
214
that bzr controls in this tree. I.E. a random .bzr directory placed
215
on disk will not be a control file for this tree.
217
return self.bzrdir.is_control_filename(filename)
220
fget=lambda self: self._branch,
221
doc="""The branch this WorkingTree is connected to.
223
This cannot be set - it is reflective of the actual disk structure
224
the working tree has been constructed from.
227
def has_versioned_directories(self):
228
"""See `Tree.has_versioned_directories`."""
229
return self._format.supports_versioned_directories
231
def break_lock(self):
232
"""Break a lock if one is present from another instance.
234
Uses the ui factory to ask for confirmation if the lock may be from
237
This will probe the repository for its lock as well.
239
raise NotImplementedError(self.break_lock)
241
def requires_rich_root(self):
242
return self._format.requires_rich_root
244
def supports_tree_reference(self):
247
def supports_content_filtering(self):
248
return self._format.supports_content_filtering()
250
def supports_views(self):
251
return self.views.supports_views()
254
def open(path=None, _unsupported=False):
255
"""Open an existing working tree at path.
259
path = osutils.getcwd()
260
control = controldir.ControlDir.open(path, _unsupported)
261
return control.open_workingtree(_unsupported)
264
def open_containing(path=None):
265
"""Open an existing working tree which has its root about path.
267
This probes for a working tree at path and searches upwards from there.
269
Basically we keep looking up until we find the control directory or
270
run into /. If there isn't one, raises NotBranchError.
271
TODO: give this a new exception.
272
If there is one, it is returned, along with the unused portion of path.
274
:return: The WorkingTree that contains 'path', and the rest of path
277
path = osutils.getcwd()
278
control, relpath = controldir.ControlDir.open_containing(path)
279
return control.open_workingtree(), relpath
282
def open_containing_paths(file_list, default_directory=None,
283
canonicalize=True, apply_view=True):
284
"""Open the WorkingTree that contains a set of paths.
286
Fail if the paths given are not all in a single tree.
288
This is used for the many command-line interfaces that take a list of
289
any number of files and that require they all be in the same tree.
291
if default_directory is None:
292
default_directory = u'.'
293
# recommended replacement for builtins.internal_tree_files
294
if file_list is None or len(file_list) == 0:
295
tree = WorkingTree.open_containing(default_directory)[0]
296
# XXX: doesn't really belong here, and seems to have the strange
297
# side effect of making it return a bunch of files, not the whole
298
# tree -- mbp 20100716
299
if tree.supports_views() and apply_view:
300
view_files = tree.views.lookup_view()
302
file_list = view_files
303
view_str = views.view_display_str(view_files)
304
note(gettext("Ignoring files outside view. View is %s") % view_str)
305
return tree, file_list
306
if default_directory == u'.':
309
seed = default_directory
310
file_list = [osutils.pathjoin(default_directory, f)
312
tree = WorkingTree.open_containing(seed)[0]
313
return tree, tree.safe_relpath_files(file_list, canonicalize,
314
apply_view=apply_view)
316
def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
317
"""Convert file_list into a list of relpaths in tree.
319
:param self: A tree to operate on.
320
:param file_list: A list of user provided paths or None.
321
:param apply_view: if True and a view is set, apply it or check that
322
specified files are within it
323
:return: A list of relative paths.
324
:raises errors.PathNotChild: When a provided path is in a different self
327
if file_list is None:
329
if self.supports_views() and apply_view:
330
view_files = self.views.lookup_view()
334
# self.relpath exists as a "thunk" to osutils, but canonical_relpath
335
# doesn't - fix that up here before we enter the loop.
337
fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
340
for filename in file_list:
341
relpath = fixer(osutils.dereference_path(filename))
342
if view_files and not osutils.is_inside_any(view_files, relpath):
343
raise errors.FileOutsideView(filename, view_files)
344
new_list.append(relpath)
348
def open_downlevel(path=None):
349
"""Open an unsupported working tree.
351
Only intended for advanced situations like upgrading part of a bzrdir.
353
return WorkingTree.open(path, _unsupported=True)
356
def find_trees(location):
357
def list_current(transport):
358
return [d for d in transport.list_dir('') if d != '.bzr']
359
def evaluate(bzrdir):
361
tree = bzrdir.open_workingtree()
362
except errors.NoWorkingTree:
366
t = transport.get_transport(location)
367
iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
368
list_current=list_current)
369
return [tr for tr in iterator if tr is not None]
371
def all_file_ids(self):
372
"""See Tree.iter_all_file_ids"""
373
raise NotImplementedError(self.all_file_ids)
376
return "<%s of %s>" % (self.__class__.__name__,
377
getattr(self, 'basedir', None))
379
def abspath(self, filename):
380
return pathjoin(self.basedir, filename)
382
def basis_tree(self):
383
"""Return RevisionTree for the current last revision.
385
If the left most parent is a ghost then the returned tree will be an
386
empty tree - one obtained by calling
387
repository.revision_tree(NULL_REVISION).
390
revision_id = self.get_parent_ids()[0]
392
# no parents, return an empty revision tree.
393
# in the future this should return the tree for
394
# 'empty:' - the implicit root empty tree.
395
return self.branch.repository.revision_tree(
396
_mod_revision.NULL_REVISION)
398
return self.revision_tree(revision_id)
399
except errors.NoSuchRevision:
401
# No cached copy available, retrieve from the repository.
402
# FIXME? RBC 20060403 should we cache the inventory locally
405
return self.branch.repository.revision_tree(revision_id)
406
except (errors.RevisionNotPresent, errors.NoSuchRevision):
407
# the basis tree *may* be a ghost or a low level error may have
408
# occurred. If the revision is present, its a problem, if its not
410
if self.branch.repository.has_revision(revision_id):
412
# the basis tree is a ghost so return an empty tree.
413
return self.branch.repository.revision_tree(
414
_mod_revision.NULL_REVISION)
417
self._flush_ignore_list_cache()
419
def relpath(self, path):
420
"""Return the local path portion from a given path.
422
The path may be absolute or relative. If its a relative path it is
423
interpreted relative to the python current working directory.
425
return osutils.relpath(self.basedir, path)
427
def has_filename(self, filename):
428
return osutils.lexists(self.abspath(filename))
430
def get_file(self, file_id, path=None, filtered=True):
431
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
433
def get_file_with_stat(self, file_id, path=None, filtered=True,
434
_fstat=osutils.fstat):
435
"""See Tree.get_file_with_stat."""
437
path = self.id2path(file_id)
438
file_obj = self.get_file_byname(path, filtered=False)
439
stat_value = _fstat(file_obj.fileno())
440
if filtered and self.supports_content_filtering():
441
filters = self._content_filter_stack(path)
442
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
443
return (file_obj, stat_value)
445
def get_file_text(self, file_id, path=None, filtered=True):
446
my_file = self.get_file(file_id, path=path, filtered=filtered)
448
return my_file.read()
452
def get_file_byname(self, filename, filtered=True):
453
path = self.abspath(filename)
455
if filtered and self.supports_content_filtering():
456
filters = self._content_filter_stack(filename)
457
return _mod_filters.filtered_input_file(f, filters)
461
def get_file_lines(self, file_id, path=None, filtered=True):
462
"""See Tree.get_file_lines()"""
463
file = self.get_file(file_id, path, filtered=filtered)
465
return file.readlines()
469
def get_parent_ids(self):
470
"""See Tree.get_parent_ids.
472
This implementation reads the pending merges list and last_revision
473
value and uses that to decide what the parents list should be.
475
last_rev = _mod_revision.ensure_null(self._last_revision())
476
if _mod_revision.NULL_REVISION == last_rev:
481
merges_bytes = self._transport.get_bytes('pending-merges')
482
except errors.NoSuchFile:
485
for l in osutils.split_lines(merges_bytes):
486
revision_id = l.rstrip('\n')
487
parents.append(revision_id)
490
def get_root_id(self):
491
"""Return the id of this trees root"""
492
raise NotImplementedError(self.get_root_id)
495
def clone(self, to_controldir, revision_id=None):
496
"""Duplicate this working tree into to_bzr, including all state.
498
Specifically modified files are kept as modified, but
499
ignored and unknown files are discarded.
501
If you want to make a new line of development, see ControlDir.sprout()
504
If not None, the cloned tree will have its last revision set to
505
revision, and difference between the source trees last revision
506
and this one merged in.
508
# assumes the target bzr dir format is compatible.
509
result = to_controldir.create_workingtree()
510
self.copy_content_into(result, revision_id)
514
def copy_content_into(self, tree, revision_id=None):
515
"""Copy the current content and user files of this tree into tree."""
516
tree.set_root_id(self.get_root_id())
517
if revision_id is None:
518
merge.transform_tree(tree, self)
520
# TODO now merge from tree.last_revision to revision (to preserve
521
# user local changes)
522
merge.transform_tree(tree, self)
523
if revision_id == _mod_revision.NULL_REVISION:
526
new_parents = [revision_id]
527
tree.set_parent_ids(new_parents)
529
def id2abspath(self, file_id):
530
return self.abspath(self.id2path(file_id))
532
def _check_for_tree_references(self, iterator):
533
"""See if directories have become tree-references."""
534
blocked_parent_ids = set()
535
for path, ie in iterator:
536
if ie.parent_id in blocked_parent_ids:
537
# This entry was pruned because one of its parents became a
538
# TreeReference. If this is a directory, mark it as blocked.
539
if ie.kind == 'directory':
540
blocked_parent_ids.add(ie.file_id)
542
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
543
# This InventoryDirectory needs to be a TreeReference
544
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
545
blocked_parent_ids.add(ie.file_id)
548
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
549
"""See Tree.iter_entries_by_dir()"""
550
# The only trick here is that if we supports_tree_reference then we
551
# need to detect if a directory becomes a tree-reference.
552
iterator = super(WorkingTree, self).iter_entries_by_dir(
553
specific_file_ids=specific_file_ids,
554
yield_parents=yield_parents)
555
if not self.supports_tree_reference():
558
return self._check_for_tree_references(iterator)
560
def get_file_size(self, file_id):
561
"""See Tree.get_file_size"""
562
# XXX: this returns the on-disk size; it should probably return the
565
return os.path.getsize(self.id2abspath(file_id))
567
if e.errno != errno.ENOENT:
572
@needs_tree_write_lock
573
def _gather_kinds(self, files, kinds):
574
"""See MutableTree._gather_kinds."""
575
for pos, f in enumerate(files):
576
if kinds[pos] is None:
577
fullpath = normpath(self.abspath(f))
579
kinds[pos] = file_kind(fullpath)
581
if e.errno == errno.ENOENT:
582
raise errors.NoSuchFile(fullpath)
585
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
586
"""Add revision_id as a parent.
588
This is equivalent to retrieving the current list of parent ids
589
and setting the list to its value plus revision_id.
591
:param revision_id: The revision id to add to the parent list. It may
592
be a ghost revision as long as its not the first parent to be
593
added, or the allow_leftmost_as_ghost parameter is set True.
594
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
596
parents = self.get_parent_ids() + [revision_id]
597
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
598
or allow_leftmost_as_ghost)
600
@needs_tree_write_lock
601
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
602
"""Add revision_id, tree tuple as a parent.
604
This is equivalent to retrieving the current list of parent trees
605
and setting the list to its value plus parent_tuple. See also
606
add_parent_tree_id - if you only have a parent id available it will be
607
simpler to use that api. If you have the parent already available, using
608
this api is preferred.
610
:param parent_tuple: The (revision id, tree) to add to the parent list.
611
If the revision_id is a ghost, pass None for the tree.
612
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
614
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
615
if len(parent_ids) > 1:
616
# the leftmost may have already been a ghost, preserve that if it
618
allow_leftmost_as_ghost = True
619
self.set_parent_ids(parent_ids,
620
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
622
@needs_tree_write_lock
623
def add_pending_merge(self, *revision_ids):
624
# TODO: Perhaps should check at this point that the
625
# history of the revision is actually present?
626
parents = self.get_parent_ids()
628
for rev_id in revision_ids:
629
if rev_id in parents:
631
parents.append(rev_id)
634
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
636
def path_content_summary(self, path, _lstat=os.lstat,
637
_mapper=osutils.file_kind_from_stat_mode):
638
"""See Tree.path_content_summary."""
639
abspath = self.abspath(path)
641
stat_result = _lstat(abspath)
643
if getattr(e, 'errno', None) == errno.ENOENT:
645
return ('missing', None, None, None)
646
# propagate other errors
648
kind = _mapper(stat_result.st_mode)
650
return self._file_content_summary(path, stat_result)
651
elif kind == 'directory':
652
# perhaps it looks like a plain directory, but it's really a
654
if self._directory_is_tree_reference(path):
655
kind = 'tree-reference'
656
return kind, None, None, None
657
elif kind == 'symlink':
658
target = osutils.readlink(abspath)
659
return ('symlink', None, None, target)
661
return (kind, None, None, None)
663
def _file_content_summary(self, path, stat_result):
664
size = stat_result.st_size
665
executable = self._is_executable_from_path_and_stat(path, stat_result)
666
# try for a stat cache lookup
667
return ('file', size, executable, self._sha_from_stat(
670
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
671
"""Common ghost checking functionality from set_parent_*.
673
This checks that the left hand-parent exists if there are any
676
if len(revision_ids) > 0:
677
leftmost_id = revision_ids[0]
678
if (not allow_leftmost_as_ghost and not
679
self.branch.repository.has_revision(leftmost_id)):
680
raise errors.GhostRevisionUnusableHere(leftmost_id)
682
def _set_merges_from_parent_ids(self, parent_ids):
683
merges = parent_ids[1:]
684
self._transport.put_bytes('pending-merges', '\n'.join(merges),
685
mode=self.bzrdir._get_file_mode())
687
def _filter_parent_ids_by_ancestry(self, revision_ids):
688
"""Check that all merged revisions are proper 'heads'.
690
This will always return the first revision_id, and any merged revisions
693
if len(revision_ids) == 0:
695
graph = self.branch.repository.get_graph()
696
heads = graph.heads(revision_ids)
697
new_revision_ids = revision_ids[:1]
698
for revision_id in revision_ids[1:]:
699
if revision_id in heads and revision_id not in new_revision_ids:
700
new_revision_ids.append(revision_id)
701
if new_revision_ids != revision_ids:
702
mutter('requested to set revision_ids = %s,'
703
' but filtered to %s', revision_ids, new_revision_ids)
704
return new_revision_ids
706
@needs_tree_write_lock
707
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
708
"""Set the parent ids to revision_ids.
710
See also set_parent_trees. This api will try to retrieve the tree data
711
for each element of revision_ids from the trees repository. If you have
712
tree data already available, it is more efficient to use
713
set_parent_trees rather than set_parent_ids. set_parent_ids is however
714
an easier API to use.
716
:param revision_ids: The revision_ids to set as the parent ids of this
717
working tree. Any of these may be ghosts.
719
self._check_parents_for_ghosts(revision_ids,
720
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
721
for revision_id in revision_ids:
722
_mod_revision.check_not_reserved_id(revision_id)
724
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
726
if len(revision_ids) > 0:
727
self.set_last_revision(revision_ids[0])
729
self.set_last_revision(_mod_revision.NULL_REVISION)
731
self._set_merges_from_parent_ids(revision_ids)
733
@needs_tree_write_lock
734
def set_pending_merges(self, rev_list):
735
parents = self.get_parent_ids()
736
leftmost = parents[:1]
737
new_parents = leftmost + rev_list
738
self.set_parent_ids(new_parents)
740
@needs_tree_write_lock
741
def set_merge_modified(self, modified_hashes):
742
"""Set the merge modified hashes."""
743
raise NotImplementedError(self.set_merge_modified)
745
def _sha_from_stat(self, path, stat_result):
746
"""Get a sha digest from the tree's stat cache.
748
The default implementation assumes no stat cache is present.
750
:param path: The path.
751
:param stat_result: The stat result being looked up.
755
@needs_write_lock # because merge pulls data into the branch.
756
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
757
merge_type=None, force=False):
758
"""Merge from a branch into this working tree.
760
:param branch: The branch to merge from.
761
:param to_revision: If non-None, the merge will merge to to_revision,
762
but not beyond it. to_revision does not need to be in the history
763
of the branch when it is supplied. If None, to_revision defaults to
764
branch.last_revision().
766
from bzrlib.merge import Merger, Merge3Merger
767
merger = Merger(self.branch, this_tree=self)
768
# check that there are no local alterations
769
if not force and self.has_changes():
770
raise errors.UncommittedChanges(self)
771
if to_revision is None:
772
to_revision = _mod_revision.ensure_null(branch.last_revision())
773
merger.other_rev_id = to_revision
774
if _mod_revision.is_null(merger.other_rev_id):
775
raise errors.NoCommits(branch)
776
self.branch.fetch(branch, last_revision=merger.other_rev_id)
777
merger.other_basis = merger.other_rev_id
778
merger.other_tree = self.branch.repository.revision_tree(
780
merger.other_branch = branch
781
if from_revision is None:
784
merger.set_base_revision(from_revision, branch)
785
if merger.base_rev_id == merger.other_rev_id:
786
raise errors.PointlessMerge
787
merger.backup_files = False
788
if merge_type is None:
789
merger.merge_type = Merge3Merger
791
merger.merge_type = merge_type
792
merger.set_interesting_files(None)
793
merger.show_base = False
794
merger.reprocess = False
795
conflicts = merger.do_merge()
799
def merge_modified(self):
800
"""Return a dictionary of files modified by a merge.
802
The list is initialized by WorkingTree.set_merge_modified, which is
803
typically called after we make some automatic updates to the tree
806
This returns a map of file_id->sha1, containing only files which are
807
still in the working inventory and have that text hash.
809
raise NotImplementedError(self.merge_modified)
812
def mkdir(self, path, file_id=None):
813
"""See MutableTree.mkdir()."""
815
file_id = generate_ids.gen_file_id(os.path.basename(path))
816
os.mkdir(self.abspath(path))
817
self.add(path, file_id, 'directory')
820
def get_symlink_target(self, file_id, path=None):
822
abspath = self.abspath(path)
824
abspath = self.id2abspath(file_id)
825
target = osutils.readlink(abspath)
828
def subsume(self, other_tree):
829
raise NotImplementedError(self.subsume)
831
def _setup_directory_is_tree_reference(self):
832
if self._branch.repository._format.supports_tree_reference:
833
self._directory_is_tree_reference = \
834
self._directory_may_be_tree_reference
836
self._directory_is_tree_reference = \
837
self._directory_is_never_tree_reference
839
def _directory_is_never_tree_reference(self, relpath):
842
def _directory_may_be_tree_reference(self, relpath):
843
# as a special case, if a directory contains control files then
844
# it's a tree reference, except that the root of the tree is not
845
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
846
# TODO: We could ask all the control formats whether they
847
# recognize this directory, but at the moment there's no cheap api
848
# to do that. Since we probably can only nest bzr checkouts and
849
# they always use this name it's ok for now. -- mbp 20060306
851
# FIXME: There is an unhandled case here of a subdirectory
852
# containing .bzr but not a branch; that will probably blow up
853
# when you try to commit it. It might happen if there is a
854
# checkout in a subdirectory. This can be avoided by not adding
857
def extract(self, file_id, format=None):
858
"""Extract a subtree from this tree.
860
A new branch will be created, relative to the path for this tree.
862
raise NotImplementedError(self.extract)
865
"""Write the in memory meta data to disk."""
866
raise NotImplementedError(self.flush)
868
def _kind(self, relpath):
869
return osutils.file_kind(self.abspath(relpath))
871
def list_files(self, include_root=False, from_dir=None, recursive=True):
872
"""List all files as (path, class, kind, id, entry).
874
Lists, but does not descend into unversioned directories.
875
This does not include files that have been deleted in this
876
tree. Skips the control directory.
878
:param include_root: if True, return an entry for the root
879
:param from_dir: start from this directory or None for the root
880
:param recursive: whether to recurse into subdirectories or not
882
raise NotImplementedError(self.list_files)
884
def move(self, from_paths, to_dir=None, after=False):
887
to_dir must be known to the working tree.
889
If to_dir exists and is a directory, the files are moved into
890
it, keeping their old names.
892
Note that to_dir is only the last component of the new name;
893
this doesn't change the directory.
895
For each entry in from_paths the move mode will be determined
898
The first mode moves the file in the filesystem and updates the
899
working tree metadata. The second mode only updates the working tree
900
metadata without touching the file on the filesystem.
902
move uses the second mode if 'after == True' and the target is not
903
versioned but present in the working tree.
905
move uses the second mode if 'after == False' and the source is
906
versioned but no longer in the working tree, and the target is not
907
versioned but present in the working tree.
909
move uses the first mode if 'after == False' and the source is
910
versioned and present in the working tree, and the target is not
911
versioned and not present in the working tree.
913
Everything else results in an error.
915
This returns a list of (from_path, to_path) pairs for each
918
raise NotImplementedError(self.move)
920
@needs_tree_write_lock
921
def rename_one(self, from_rel, to_rel, after=False):
924
This can change the directory or the filename or both.
926
rename_one has several 'modes' to work. First, it can rename a physical
927
file and change the file_id. That is the normal mode. Second, it can
928
only change the file_id without touching any physical file.
930
rename_one uses the second mode if 'after == True' and 'to_rel' is
931
either not versioned or newly added, and present in the working tree.
933
rename_one uses the second mode if 'after == False' and 'from_rel' is
934
versioned but no longer in the working tree, and 'to_rel' is not
935
versioned but present in the working tree.
937
rename_one uses the first mode if 'after == False' and 'from_rel' is
938
versioned and present in the working tree, and 'to_rel' is not
939
versioned and not present in the working tree.
941
Everything else results in an error.
943
raise NotImplementedError(self.rename_one)
947
"""Return all unknown files.
949
These are files in the working directory that are not versioned or
950
control files or ignored.
952
# force the extras method to be fully executed before returning, to
953
# prevent race conditions with the lock
955
[subp for subp in self.extras() if not self.is_ignored(subp)])
957
def unversion(self, file_ids):
958
"""Remove the file ids in file_ids from the current versioned set.
960
When a file_id is unversioned, all of its children are automatically
963
:param file_ids: The file ids to stop versioning.
964
:raises: NoSuchId if any fileid is not currently versioned.
966
raise NotImplementedError(self.unversion)
969
def pull(self, source, overwrite=False, stop_revision=None,
970
change_reporter=None, possible_transports=None, local=False,
974
old_revision_info = self.branch.last_revision_info()
975
basis_tree = self.basis_tree()
976
count = self.branch.pull(source, overwrite, stop_revision,
977
possible_transports=possible_transports,
979
new_revision_info = self.branch.last_revision_info()
980
if new_revision_info != old_revision_info:
981
repository = self.branch.repository
982
if repository._format.fast_deltas:
983
parent_ids = self.get_parent_ids()
985
basis_id = parent_ids[0]
986
basis_tree = repository.revision_tree(basis_id)
987
basis_tree.lock_read()
989
new_basis_tree = self.branch.basis_tree()
996
change_reporter=change_reporter,
998
basis_root_id = basis_tree.get_root_id()
999
new_root_id = new_basis_tree.get_root_id()
1000
if new_root_id is not None and basis_root_id != new_root_id:
1001
self.set_root_id(new_root_id)
1004
# TODO - dedup parents list with things merged by pull ?
1005
# reuse the revisiontree we merged against to set the new
1008
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1009
parent_trees.append(
1010
(self.branch.last_revision(), new_basis_tree))
1011
# we have to pull the merge trees out again, because
1012
# merge_inner has set the ids. - this corner is not yet
1013
# layered well enough to prevent double handling.
1014
# XXX TODO: Fix the double handling: telling the tree about
1015
# the already known parent data is wasteful.
1016
merges = self.get_parent_ids()[1:]
1017
parent_trees.extend([
1018
(parent, repository.revision_tree(parent)) for
1020
self.set_parent_trees(parent_trees)
1026
def put_file_bytes_non_atomic(self, file_id, bytes):
1027
"""See MutableTree.put_file_bytes_non_atomic."""
1028
stream = file(self.id2abspath(file_id), 'wb')
1035
"""Yield all unversioned files in this WorkingTree.
1037
If there are any unversioned directories then only the directory is
1038
returned, not all its children. But if there are unversioned files
1039
under a versioned subdirectory, they are returned.
1041
Currently returned depth-first, sorted by name within directories.
1042
This is the same order used by 'osutils.walkdirs'.
1044
raise NotImplementedError(self.extras)
1046
def ignored_files(self):
1047
"""Yield list of PATH, IGNORE_PATTERN"""
1048
for subp in self.extras():
1049
pat = self.is_ignored(subp)
1053
def get_ignore_list(self):
1054
"""Return list of ignore patterns.
1056
Cached in the Tree object after the first call.
1058
ignoreset = getattr(self, '_ignoreset', None)
1059
if ignoreset is not None:
1062
ignore_globs = set()
1063
ignore_globs.update(ignores.get_runtime_ignores())
1064
ignore_globs.update(ignores.get_user_ignores())
1065
if self.has_filename(bzrlib.IGNORE_FILENAME):
1066
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1068
ignore_globs.update(ignores.parse_ignore_file(f))
1071
self._ignoreset = ignore_globs
1074
def _flush_ignore_list_cache(self):
1075
"""Resets the cached ignore list to force a cache rebuild."""
1076
self._ignoreset = None
1077
self._ignoreglobster = None
1079
def is_ignored(self, filename):
1080
r"""Check whether the filename matches an ignore pattern.
1082
Patterns containing '/' or '\' need to match the whole path;
1083
others match against only the last component. Patterns starting
1084
with '!' are ignore exceptions. Exceptions take precedence
1085
over regular patterns and cause the filename to not be ignored.
1087
If the file is ignored, returns the pattern which caused it to
1088
be ignored, otherwise None. So this can simply be used as a
1089
boolean if desired."""
1090
if getattr(self, '_ignoreglobster', None) is None:
1091
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1092
return self._ignoreglobster.match(filename)
1094
def kind(self, file_id):
1095
return file_kind(self.id2abspath(file_id))
1097
def stored_kind(self, file_id):
1098
"""See Tree.stored_kind"""
1099
raise NotImplementedError(self.stored_kind)
1101
def _comparison_data(self, entry, path):
1102
abspath = self.abspath(path)
1104
stat_value = os.lstat(abspath)
1106
if getattr(e, 'errno', None) == errno.ENOENT:
1113
mode = stat_value.st_mode
1114
kind = osutils.file_kind_from_stat_mode(mode)
1115
if not supports_executable():
1116
executable = entry is not None and entry.executable
1118
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1119
return kind, executable, stat_value
1121
def _file_size(self, entry, stat_value):
1122
return stat_value.st_size
1124
def last_revision(self):
1125
"""Return the last revision of the branch for this tree.
1127
This format tree does not support a separate marker for last-revision
1128
compared to the branch.
1130
See MutableTree.last_revision
1132
return self._last_revision()
1135
def _last_revision(self):
1136
"""helper for get_parent_ids."""
1137
return _mod_revision.ensure_null(self.branch.last_revision())
1139
def is_locked(self):
1140
"""Check if this tree is locked."""
1141
raise NotImplementedError(self.is_locked)
1143
def lock_read(self):
1144
"""Lock the tree for reading.
1146
This also locks the branch, and can be unlocked via self.unlock().
1148
:return: A bzrlib.lock.LogicalLockResult.
1150
raise NotImplementedError(self.lock_read)
1152
def lock_tree_write(self):
1153
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1155
:return: A bzrlib.lock.LogicalLockResult.
1157
raise NotImplementedError(self.lock_tree_write)
1159
def lock_write(self):
1160
"""See MutableTree.lock_write, and WorkingTree.unlock.
1162
:return: A bzrlib.lock.LogicalLockResult.
1164
raise NotImplementedError(self.lock_write)
1166
def get_physical_lock_status(self):
1167
raise NotImplementedError(self.get_physical_lock_status)
1169
def set_last_revision(self, new_revision):
1170
"""Change the last revision in the working tree."""
1171
raise NotImplementedError(self.set_last_revision)
1173
def _change_last_revision(self, new_revision):
1174
"""Template method part of set_last_revision to perform the change.
1176
This is used to allow WorkingTree3 instances to not affect branch
1177
when their last revision is set.
1179
if _mod_revision.is_null(new_revision):
1180
self.branch.set_last_revision_info(0, new_revision)
1182
_mod_revision.check_not_reserved_id(new_revision)
1184
self.branch.generate_revision_history(new_revision)
1185
except errors.NoSuchRevision:
1186
# not present in the repo - dont try to set it deeper than the tip
1187
self.branch._set_revision_history([new_revision])
1190
@needs_tree_write_lock
1191
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1193
"""Remove nominated files from the working tree metadata.
1195
:files: File paths relative to the basedir.
1196
:keep_files: If true, the files will also be kept.
1197
:force: Delete files and directories, even if they are changed and
1198
even if the directories are not empty.
1200
if isinstance(files, basestring):
1205
all_files = set() # specified and nested files
1206
unknown_nested_files=set()
1208
to_file = sys.stdout
1210
files_to_backup = []
1212
def recurse_directory_to_add_files(directory):
1213
# Recurse directory and add all files
1214
# so we can check if they have changed.
1215
for parent_info, file_infos in self.walkdirs(directory):
1216
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1217
# Is it versioned or ignored?
1218
if self.path2id(relpath):
1219
# Add nested content for deletion.
1220
all_files.add(relpath)
1222
# Files which are not versioned
1223
# should be treated as unknown.
1224
files_to_backup.append(relpath)
1226
for filename in files:
1227
# Get file name into canonical form.
1228
abspath = self.abspath(filename)
1229
filename = self.relpath(abspath)
1230
if len(filename) > 0:
1231
all_files.add(filename)
1232
recurse_directory_to_add_files(filename)
1234
files = list(all_files)
1237
return # nothing to do
1239
# Sort needed to first handle directory content before the directory
1240
files.sort(reverse=True)
1242
# Bail out if we are going to delete files we shouldn't
1243
if not keep_files and not force:
1244
for (file_id, path, content_change, versioned, parent_id, name,
1245
kind, executable) in self.iter_changes(self.basis_tree(),
1246
include_unchanged=True, require_versioned=False,
1247
want_unversioned=True, specific_files=files):
1248
if versioned[0] == False:
1249
# The record is unknown or newly added
1250
files_to_backup.append(path[1])
1251
elif (content_change and (kind[1] is not None) and
1252
osutils.is_inside_any(files, path[1])):
1253
# Versioned and changed, but not deleted, and still
1254
# in one of the dirs to be deleted.
1255
files_to_backup.append(path[1])
1257
def backup(file_to_backup):
1258
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1259
osutils.rename(abs_path, self.abspath(backup_name))
1260
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1263
# Build inv_delta and delete files where applicable,
1264
# do this before any modifications to meta data.
1266
fid = self.path2id(f)
1269
message = "%s is not versioned." % (f,)
1272
# having removed it, it must be either ignored or unknown
1273
if self.is_ignored(f):
1277
# XXX: Really should be a more abstract reporter interface
1278
kind_ch = osutils.kind_marker(self.kind(fid))
1279
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1281
inv_delta.append((f, None, fid, None))
1282
message = "removed %s" % (f,)
1285
abs_path = self.abspath(f)
1286
if osutils.lexists(abs_path):
1287
if (osutils.isdir(abs_path) and
1288
len(os.listdir(abs_path)) > 0):
1290
osutils.rmtree(abs_path)
1291
message = "deleted %s" % (f,)
1295
if f in files_to_backup:
1298
osutils.delete_any(abs_path)
1299
message = "deleted %s" % (f,)
1300
elif message is not None:
1301
# Only care if we haven't done anything yet.
1302
message = "%s does not exist." % (f,)
1304
# Print only one message (if any) per file.
1305
if message is not None:
1307
self.apply_inventory_delta(inv_delta)
1309
@needs_tree_write_lock
1310
def revert(self, filenames=None, old_tree=None, backups=True,
1311
pb=None, report_changes=False):
1312
from bzrlib.conflicts import resolve
1313
if old_tree is None:
1314
basis_tree = self.basis_tree()
1315
basis_tree.lock_read()
1316
old_tree = basis_tree
1320
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1322
if filenames is None and len(self.get_parent_ids()) > 1:
1324
last_revision = self.last_revision()
1325
if last_revision != _mod_revision.NULL_REVISION:
1326
if basis_tree is None:
1327
basis_tree = self.basis_tree()
1328
basis_tree.lock_read()
1329
parent_trees.append((last_revision, basis_tree))
1330
self.set_parent_trees(parent_trees)
1333
resolve(self, filenames, ignore_misses=True, recursive=True)
1335
if basis_tree is not None:
1339
def revision_tree(self, revision_id):
1340
"""See Tree.revision_tree.
1342
WorkingTree can supply revision_trees for the basis revision only
1343
because there is only one cached inventory in the bzr directory.
1345
raise NotImplementedError(self.revision_tree)
1347
@needs_tree_write_lock
1348
def set_root_id(self, file_id):
1349
"""Set the root id for this tree."""
1353
'WorkingTree.set_root_id with fileid=None')
1354
file_id = osutils.safe_file_id(file_id)
1355
self._set_root_id(file_id)
1357
def _set_root_id(self, file_id):
1358
"""Set the root id for this tree, in a format specific manner.
1360
:param file_id: The file id to assign to the root. It must not be
1361
present in the current inventory or an error will occur. It must
1362
not be None, but rather a valid file id.
1364
raise NotImplementedError(self._set_root_id)
1367
"""See Branch.unlock.
1369
WorkingTree locking just uses the Branch locking facilities.
1370
This is current because all working trees have an embedded branch
1371
within them. IF in the future, we were to make branch data shareable
1372
between multiple working trees, i.e. via shared storage, then we
1373
would probably want to lock both the local tree, and the branch.
1375
raise NotImplementedError(self.unlock)
1379
def update(self, change_reporter=None, possible_transports=None,
1380
revision=None, old_tip=_marker, show_base=False):
1381
"""Update a working tree along its branch.
1383
This will update the branch if its bound too, which means we have
1384
multiple trees involved:
1386
- The new basis tree of the master.
1387
- The old basis tree of the branch.
1388
- The old basis tree of the working tree.
1389
- The current working tree state.
1391
Pathologically, all three may be different, and non-ancestors of each
1392
other. Conceptually we want to:
1394
- Preserve the wt.basis->wt.state changes
1395
- Transform the wt.basis to the new master basis.
1396
- Apply a merge of the old branch basis to get any 'local' changes from
1398
- Restore the wt.basis->wt.state changes.
1400
There isn't a single operation at the moment to do that, so we:
1402
- Merge current state -> basis tree of the master w.r.t. the old tree
1404
- Do a 'normal' merge of the old branch basis if it is relevant.
1406
:param revision: The target revision to update to. Must be in the
1408
:param old_tip: If branch.update() has already been run, the value it
1409
returned (old tip of the branch or None). _marker is used
1412
if self.branch.get_bound_location() is not None:
1414
update_branch = (old_tip is self._marker)
1416
self.lock_tree_write()
1417
update_branch = False
1420
old_tip = self.branch.update(possible_transports)
1422
if old_tip is self._marker:
1424
return self._update_tree(old_tip, change_reporter, revision, show_base)
1428
@needs_tree_write_lock
1429
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1431
"""Update a tree to the master branch.
1433
:param old_tip: if supplied, the previous tip revision the branch,
1434
before it was changed to the master branch's tip.
1436
# here if old_tip is not None, it is the old tip of the branch before
1437
# it was updated from the master branch. This should become a pending
1438
# merge in the working tree to preserve the user existing work. we
1439
# cant set that until we update the working trees last revision to be
1440
# one from the new branch, because it will just get absorbed by the
1441
# parent de-duplication logic.
1443
# We MUST save it even if an error occurs, because otherwise the users
1444
# local work is unreferenced and will appear to have been lost.
1448
last_rev = self.get_parent_ids()[0]
1450
last_rev = _mod_revision.NULL_REVISION
1451
if revision is None:
1452
revision = self.branch.last_revision()
1454
old_tip = old_tip or _mod_revision.NULL_REVISION
1456
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1457
# the branch we are bound to was updated
1458
# merge those changes in first
1459
base_tree = self.basis_tree()
1460
other_tree = self.branch.repository.revision_tree(old_tip)
1461
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1462
base_tree, this_tree=self,
1463
change_reporter=change_reporter,
1464
show_base=show_base)
1466
self.add_parent_tree((old_tip, other_tree))
1467
note(gettext('Rerun update after fixing the conflicts.'))
1470
if last_rev != _mod_revision.ensure_null(revision):
1471
# the working tree is up to date with the branch
1472
# we can merge the specified revision from master
1473
to_tree = self.branch.repository.revision_tree(revision)
1474
to_root_id = to_tree.get_root_id()
1476
basis = self.basis_tree()
1479
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1480
self.set_root_id(to_root_id)
1485
# determine the branch point
1486
graph = self.branch.repository.get_graph()
1487
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1489
base_tree = self.branch.repository.revision_tree(base_rev_id)
1491
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1493
change_reporter=change_reporter,
1494
show_base=show_base)
1495
self.set_last_revision(revision)
1496
# TODO - dedup parents list with things merged by pull ?
1497
# reuse the tree we've updated to to set the basis:
1498
parent_trees = [(revision, to_tree)]
1499
merges = self.get_parent_ids()[1:]
1500
# Ideally we ask the tree for the trees here, that way the working
1501
# tree can decide whether to give us the entire tree or give us a
1502
# lazy initialised tree. dirstate for instance will have the trees
1503
# in ram already, whereas a last-revision + basis-inventory tree
1504
# will not, but also does not need them when setting parents.
1505
for parent in merges:
1506
parent_trees.append(
1507
(parent, self.branch.repository.revision_tree(parent)))
1508
if not _mod_revision.is_null(old_tip):
1509
parent_trees.append(
1510
(old_tip, self.branch.repository.revision_tree(old_tip)))
1511
self.set_parent_trees(parent_trees)
1512
last_rev = parent_trees[0][0]
1515
def set_conflicts(self, arg):
1516
raise errors.UnsupportedOperation(self.set_conflicts, self)
1518
def add_conflicts(self, arg):
1519
raise errors.UnsupportedOperation(self.add_conflicts, self)
1521
def conflicts(self):
1522
raise NotImplementedError(self.conflicts)
1524
def walkdirs(self, prefix=""):
1525
"""Walk the directories of this tree.
1527
returns a generator which yields items in the form:
1528
((curren_directory_path, fileid),
1529
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1532
This API returns a generator, which is only valid during the current
1533
tree transaction - within a single lock_read or lock_write duration.
1535
If the tree is not locked, it may cause an error to be raised,
1536
depending on the tree implementation.
1538
disk_top = self.abspath(prefix)
1539
if disk_top.endswith('/'):
1540
disk_top = disk_top[:-1]
1541
top_strip_len = len(disk_top) + 1
1542
inventory_iterator = self._walkdirs(prefix)
1543
disk_iterator = osutils.walkdirs(disk_top, prefix)
1545
current_disk = disk_iterator.next()
1546
disk_finished = False
1548
if not (e.errno == errno.ENOENT or
1549
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1552
disk_finished = True
1554
current_inv = inventory_iterator.next()
1555
inv_finished = False
1556
except StopIteration:
1559
while not inv_finished or not disk_finished:
1561
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1562
cur_disk_dir_content) = current_disk
1564
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1565
cur_disk_dir_content) = ((None, None), None)
1566
if not disk_finished:
1567
# strip out .bzr dirs
1568
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1569
len(cur_disk_dir_content) > 0):
1570
# osutils.walkdirs can be made nicer -
1571
# yield the path-from-prefix rather than the pathjoined
1573
bzrdir_loc = bisect_left(cur_disk_dir_content,
1575
if (bzrdir_loc < len(cur_disk_dir_content)
1576
and self.bzrdir.is_control_filename(
1577
cur_disk_dir_content[bzrdir_loc][0])):
1578
# we dont yield the contents of, or, .bzr itself.
1579
del cur_disk_dir_content[bzrdir_loc]
1581
# everything is unknown
1584
# everything is missing
1587
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1589
# disk is before inventory - unknown
1590
dirblock = [(relpath, basename, kind, stat, None, None) for
1591
relpath, basename, kind, stat, top_path in
1592
cur_disk_dir_content]
1593
yield (cur_disk_dir_relpath, None), dirblock
1595
current_disk = disk_iterator.next()
1596
except StopIteration:
1597
disk_finished = True
1599
# inventory is before disk - missing.
1600
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1601
for relpath, basename, dkind, stat, fileid, kind in
1603
yield (current_inv[0][0], current_inv[0][1]), dirblock
1605
current_inv = inventory_iterator.next()
1606
except StopIteration:
1609
# versioned present directory
1610
# merge the inventory and disk data together
1612
for relpath, subiterator in itertools.groupby(sorted(
1613
current_inv[1] + cur_disk_dir_content,
1614
key=operator.itemgetter(0)), operator.itemgetter(1)):
1615
path_elements = list(subiterator)
1616
if len(path_elements) == 2:
1617
inv_row, disk_row = path_elements
1618
# versioned, present file
1619
dirblock.append((inv_row[0],
1620
inv_row[1], disk_row[2],
1621
disk_row[3], inv_row[4],
1623
elif len(path_elements[0]) == 5:
1625
dirblock.append((path_elements[0][0],
1626
path_elements[0][1], path_elements[0][2],
1627
path_elements[0][3], None, None))
1628
elif len(path_elements[0]) == 6:
1629
# versioned, absent file.
1630
dirblock.append((path_elements[0][0],
1631
path_elements[0][1], 'unknown', None,
1632
path_elements[0][4], path_elements[0][5]))
1634
raise NotImplementedError('unreachable code')
1635
yield current_inv[0], dirblock
1637
current_inv = inventory_iterator.next()
1638
except StopIteration:
1641
current_disk = disk_iterator.next()
1642
except StopIteration:
1643
disk_finished = True
1645
def _walkdirs(self, prefix=""):
1646
"""Walk the directories of this tree.
1648
:param prefix: is used as the directrory to start with.
1649
:returns: a generator which yields items in the form::
1651
((curren_directory_path, fileid),
1652
[(file1_path, file1_name, file1_kind, None, file1_id,
1655
raise NotImplementedError(self._walkdirs)
1657
@needs_tree_write_lock
1658
def auto_resolve(self):
1659
"""Automatically resolve text conflicts according to contents.
1661
Only text conflicts are auto_resolvable. Files with no conflict markers
1662
are considered 'resolved', because bzr always puts conflict markers
1663
into files that have text conflicts. The corresponding .THIS .BASE and
1664
.OTHER files are deleted, as per 'resolve'.
1666
:return: a tuple of ConflictLists: (un_resolved, resolved).
1668
un_resolved = _mod_conflicts.ConflictList()
1669
resolved = _mod_conflicts.ConflictList()
1670
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1671
for conflict in self.conflicts():
1672
if (conflict.typestring != 'text conflict' or
1673
self.kind(conflict.file_id) != 'file'):
1674
un_resolved.append(conflict)
1676
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1678
for line in my_file:
1679
if conflict_re.search(line):
1680
un_resolved.append(conflict)
1683
resolved.append(conflict)
1686
resolved.remove_files(self)
1687
self.set_conflicts(un_resolved)
1688
return un_resolved, resolved
1690
def _validate(self):
1691
"""Validate internal structures.
1693
This is meant mostly for the test suite. To give it a chance to detect
1694
corruption after actions have occurred. The default implementation is a
1697
:return: None. An exception should be raised if there is an error.
1701
def check_state(self):
1702
"""Check that the working state is/isn't valid."""
1703
raise NotImplementedError(self.check_state)
1705
def reset_state(self, revision_ids=None):
1706
"""Reset the state of the working tree.
1708
This does a hard-reset to a last-known-good state. This is a way to
1709
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1711
raise NotImplementedError(self.reset_state)
1713
def _get_rules_searcher(self, default_searcher):
1714
"""See Tree._get_rules_searcher."""
1715
if self._rules_searcher is None:
1716
self._rules_searcher = super(WorkingTree,
1717
self)._get_rules_searcher(default_searcher)
1718
return self._rules_searcher
1720
def get_shelf_manager(self):
1721
"""Return the ShelfManager for this WorkingTree."""
1722
from bzrlib.shelf import ShelfManager
1723
return ShelfManager(self, self._transport)
1726
class InventoryWorkingTree(WorkingTree,
1727
bzrlib.mutabletree.MutableInventoryTree):
1728
"""Base class for working trees that are inventory-oriented.
28
1730
The inventory is held in the `Branch` working-inventory, and the
29
1731
files are in a directory on disk.
31
1733
It is possible for a `WorkingTree` to have a filename which is
32
1734
not listed in the Inventory and vice versa.
36
def __init__(self, basedir, inv):
1737
def __init__(self, basedir='.',
1738
branch=DEPRECATED_PARAMETER,
1740
_control_files=None,
1744
"""Construct a InventoryWorkingTree instance. This is not a public API.
1746
:param branch: A branch to override probing for the branch.
1748
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1749
branch=branch, _transport=_control_files._transport,
1750
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1752
self._control_files = _control_files
1753
self._detect_case_handling()
1755
if _inventory is None:
1756
# This will be acquired on lock_read() or lock_write()
1757
self._inventory_is_modified = False
1758
self._inventory = None
1760
# the caller of __init__ has provided an inventory,
1761
# we assume they know what they are doing - as its only
1762
# the Format factory and creation methods that are
1763
# permitted to do this.
1764
self._set_inventory(_inventory, dirty=False)
1766
def _set_inventory(self, inv, dirty):
1767
"""Set the internal cached inventory.
1769
:param inv: The inventory to set.
1770
:param dirty: A boolean indicating whether the inventory is the same
1771
logical inventory as whats on disk. If True the inventory is not
1772
the same and should be written to disk or data will be lost, if
1773
False then the inventory is the same as that on disk and any
1774
serialisation would be unneeded overhead.
37
1776
self._inventory = inv
38
self.basedir = basedir
39
self.path2id = inv.path2id
40
self._update_statcache()
1777
self._inventory_is_modified = dirty
1779
def _detect_case_handling(self):
1780
wt_trans = self.bzrdir.get_workingtree_transport(None)
1782
wt_trans.stat(self._format.case_sensitive_filename)
1783
except errors.NoSuchFile:
1784
self.case_sensitive = True
1786
self.case_sensitive = False
1788
self._setup_directory_is_tree_reference()
1790
def _serialize(self, inventory, out_file):
1791
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1794
def _deserialize(selt, in_file):
1795
return xml5.serializer_v5.read_inventory(in_file)
1797
def break_lock(self):
1798
"""Break a lock if one is present from another instance.
1800
Uses the ui factory to ask for confirmation if the lock may be from
1803
This will probe the repository for its lock as well.
1805
self._control_files.break_lock()
1806
self.branch.break_lock()
1808
def is_locked(self):
1809
return self._control_files.is_locked()
1811
def _must_be_locked(self):
1812
if not self.is_locked():
1813
raise errors.ObjectNotLocked(self)
1815
def lock_read(self):
1816
"""Lock the tree for reading.
1818
This also locks the branch, and can be unlocked via self.unlock().
1820
:return: A bzrlib.lock.LogicalLockResult.
1822
if not self.is_locked():
1824
self.branch.lock_read()
1826
self._control_files.lock_read()
1827
return LogicalLockResult(self.unlock)
1829
self.branch.unlock()
1832
def lock_tree_write(self):
1833
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1835
:return: A bzrlib.lock.LogicalLockResult.
1837
if not self.is_locked():
1839
self.branch.lock_read()
1841
self._control_files.lock_write()
1842
return LogicalLockResult(self.unlock)
1844
self.branch.unlock()
1847
def lock_write(self):
1848
"""See MutableTree.lock_write, and WorkingTree.unlock.
1850
:return: A bzrlib.lock.LogicalLockResult.
1852
if not self.is_locked():
1854
self.branch.lock_write()
1856
self._control_files.lock_write()
1857
return LogicalLockResult(self.unlock)
1859
self.branch.unlock()
1862
def get_physical_lock_status(self):
1863
return self._control_files.get_physical_lock_status()
1865
@needs_tree_write_lock
1866
def _write_inventory(self, inv):
1867
"""Write inventory as the current inventory."""
1868
self._set_inventory(inv, dirty=True)
1871
# XXX: This method should be deprecated in favour of taking in a proper
1872
# new Inventory object.
1873
@needs_tree_write_lock
1874
def set_inventory(self, new_inventory_list):
1875
from bzrlib.inventory import (Inventory,
1879
inv = Inventory(self.get_root_id())
1880
for path, file_id, parent, kind in new_inventory_list:
1881
name = os.path.basename(path)
1884
# fixme, there should be a factory function inv,add_??
1885
if kind == 'directory':
1886
inv.add(InventoryDirectory(file_id, name, parent))
1887
elif kind == 'file':
1888
inv.add(InventoryFile(file_id, name, parent))
1889
elif kind == 'symlink':
1890
inv.add(InventoryLink(file_id, name, parent))
1892
raise errors.BzrError("unknown kind %r" % kind)
1893
self._write_inventory(inv)
1895
def _write_basis_inventory(self, xml):
1896
"""Write the basis inventory XML to the basis-inventory file"""
1897
path = self._basis_inventory_name()
1899
self._transport.put_file(path, sio,
1900
mode=self.bzrdir._get_file_mode())
1902
def _reset_data(self):
1903
"""Reset transient data that cannot be revalidated."""
1904
self._inventory_is_modified = False
1905
f = self._transport.get('inventory')
1907
result = self._deserialize(f)
1910
self._set_inventory(result, dirty=False)
1912
def _set_root_id(self, file_id):
1913
"""Set the root id for this tree, in a format specific manner.
1915
:param file_id: The file id to assign to the root. It must not be
1916
present in the current inventory or an error will occur. It must
1917
not be None, but rather a valid file id.
1919
inv = self._inventory
1920
orig_root_id = inv.root.file_id
1921
# TODO: it might be nice to exit early if there was nothing
1922
# to do, saving us from trigger a sync on unlock.
1923
self._inventory_is_modified = True
1924
# we preserve the root inventory entry object, but
1925
# unlinkit from the byid index
1926
del inv._byid[inv.root.file_id]
1927
inv.root.file_id = file_id
1928
# and link it into the index with the new changed id.
1929
inv._byid[inv.root.file_id] = inv.root
1930
# and finally update all children to reference the new id.
1931
# XXX: this should be safe to just look at the root.children
1932
# list, not the WHOLE INVENTORY.
1935
if entry.parent_id == orig_root_id:
1936
entry.parent_id = inv.root.file_id
1938
def all_file_ids(self):
1939
"""See Tree.iter_all_file_ids"""
1940
return set(self.inventory)
1942
@needs_tree_write_lock
1943
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1944
"""See MutableTree.set_parent_trees."""
1945
parent_ids = [rev for (rev, tree) in parents_list]
1946
for revision_id in parent_ids:
1947
_mod_revision.check_not_reserved_id(revision_id)
1949
self._check_parents_for_ghosts(parent_ids,
1950
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1952
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1954
if len(parent_ids) == 0:
1955
leftmost_parent_id = _mod_revision.NULL_REVISION
1956
leftmost_parent_tree = None
1958
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1960
if self._change_last_revision(leftmost_parent_id):
1961
if leftmost_parent_tree is None:
1962
# If we don't have a tree, fall back to reading the
1963
# parent tree from the repository.
1964
self._cache_basis_inventory(leftmost_parent_id)
1966
inv = leftmost_parent_tree.inventory
1967
xml = self._create_basis_xml_from_inventory(
1968
leftmost_parent_id, inv)
1969
self._write_basis_inventory(xml)
1970
self._set_merges_from_parent_ids(parent_ids)
1972
def _cache_basis_inventory(self, new_revision):
1973
"""Cache new_revision as the basis inventory."""
1974
# TODO: this should allow the ready-to-use inventory to be passed in,
1975
# as commit already has that ready-to-use [while the format is the
1978
# this double handles the inventory - unpack and repack -
1979
# but is easier to understand. We can/should put a conditional
1980
# in here based on whether the inventory is in the latest format
1981
# - perhaps we should repack all inventories on a repository
1983
# the fast path is to copy the raw xml from the repository. If the
1984
# xml contains 'revision_id="', then we assume the right
1985
# revision_id is set. We must check for this full string, because a
1986
# root node id can legitimately look like 'revision_id' but cannot
1988
xml = self.branch.repository._get_inventory_xml(new_revision)
1989
firstline = xml.split('\n', 1)[0]
1990
if (not 'revision_id="' in firstline or
1991
'format="7"' not in firstline):
1992
inv = self.branch.repository._serializer.read_inventory_from_string(
1994
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1995
self._write_basis_inventory(xml)
1996
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1999
def _basis_inventory_name(self):
2000
return 'basis-inventory-cache'
2002
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2003
"""Create the text that will be saved in basis-inventory"""
2004
inventory.revision_id = revision_id
2005
return xml7.serializer_v7.write_inventory_to_string(inventory)
2007
@needs_tree_write_lock
2008
def set_conflicts(self, conflicts):
2009
self._put_rio('conflicts', conflicts.to_stanzas(),
2012
@needs_tree_write_lock
2013
def add_conflicts(self, new_conflicts):
2014
conflict_set = set(self.conflicts())
2015
conflict_set.update(set(list(new_conflicts)))
2016
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2017
key=_mod_conflicts.Conflict.sort_key)))
2020
def conflicts(self):
2022
confile = self._transport.get('conflicts')
2023
except errors.NoSuchFile:
2024
return _mod_conflicts.ConflictList()
2027
if confile.next() != CONFLICT_HEADER_1 + '\n':
2028
raise errors.ConflictFormatError()
2029
except StopIteration:
2030
raise errors.ConflictFormatError()
2031
reader = _mod_rio.RioReader(confile)
2032
return _mod_conflicts.ConflictList.from_stanzas(reader)
2036
def read_basis_inventory(self):
2037
"""Read the cached basis inventory."""
2038
path = self._basis_inventory_name()
2039
return self._transport.get_bytes(path)
2042
def read_working_inventory(self):
2043
"""Read the working inventory.
2045
:raises errors.InventoryModified: read_working_inventory will fail
2046
when the current in memory inventory has been modified.
2048
# conceptually this should be an implementation detail of the tree.
2049
# XXX: Deprecate this.
2050
# ElementTree does its own conversion from UTF-8, so open in
2052
if self._inventory_is_modified:
2053
raise errors.InventoryModified(self)
2054
f = self._transport.get('inventory')
2056
result = self._deserialize(f)
2059
self._set_inventory(result, dirty=False)
2063
def get_root_id(self):
2064
"""Return the id of this trees root"""
2065
return self._inventory.root.file_id
2067
def has_id(self, file_id):
2068
# files that have been deleted are excluded
2069
inv = self.inventory
2070
if not inv.has_id(file_id):
2072
path = inv.id2path(file_id)
2073
return osutils.lexists(self.abspath(path))
2075
def has_or_had_id(self, file_id):
2076
if file_id == self.inventory.root.file_id:
2078
return self.inventory.has_id(file_id)
2080
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
42
2081
def __iter__(self):
43
2082
"""Iterate through file_ids for this tree.
46
2085
and the working file exists.
48
2087
inv = self._inventory
49
for file_id in self._inventory:
50
# TODO: This is slightly redundant; we should be able to just
51
# check the statcache but it only includes regular files.
52
# only include files which still exist on disk
55
if ((file_id in self._statcache)
56
or (os.path.exists(self.abspath(inv.id2path(file_id))))):
62
return "<%s of %s>" % (self.__class__.__name__,
65
def abspath(self, filename):
66
return os.path.join(self.basedir, filename)
68
def has_filename(self, filename):
69
return os.path.exists(self.abspath(filename))
71
def get_file(self, file_id):
72
return self.get_file_byname(self.id2path(file_id))
74
def get_file_byname(self, filename):
75
return file(self.abspath(filename), 'rb')
77
def _get_store_filename(self, file_id):
78
## XXX: badly named; this isn't in the store at all
79
return self.abspath(self.id2path(file_id))
82
def has_id(self, file_id):
83
# files that have been deleted are excluded
84
if not self.inventory.has_id(file_id):
2088
for path, ie in inv.iter_entries():
2089
if osutils.lexists(self.abspath(path)):
2092
@needs_tree_write_lock
2093
def set_last_revision(self, new_revision):
2094
"""Change the last revision in the working tree."""
2095
if self._change_last_revision(new_revision):
2096
self._cache_basis_inventory(new_revision)
2098
def _get_check_refs(self):
2099
"""Return the references needed to perform a check of this tree.
2101
The default implementation returns no refs, and is only suitable for
2102
trees that have no local caching and can commit on ghosts at any time.
2104
:seealso: bzrlib.check for details about check_refs.
2109
def _check(self, references):
2110
"""Check the tree for consistency.
2112
:param references: A dict with keys matching the items returned by
2113
self._get_check_refs(), and values from looking those keys up in
2116
tree_basis = self.basis_tree()
2117
tree_basis.lock_read()
2119
repo_basis = references[('trees', self.last_revision())]
2120
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2121
raise errors.BzrCheckError(
2122
"Mismatched basis inventory content.")
2128
def check_state(self):
2129
"""Check that the working state is/isn't valid."""
2130
check_refs = self._get_check_refs()
2132
for ref in check_refs:
2135
refs[ref] = self.branch.repository.revision_tree(value)
2138
@needs_tree_write_lock
2139
def reset_state(self, revision_ids=None):
2140
"""Reset the state of the working tree.
2142
This does a hard-reset to a last-known-good state. This is a way to
2143
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2145
if revision_ids is None:
2146
revision_ids = self.get_parent_ids()
2147
if not revision_ids:
2148
rt = self.branch.repository.revision_tree(
2149
_mod_revision.NULL_REVISION)
2151
rt = self.branch.repository.revision_tree(revision_ids[0])
2152
self._write_inventory(rt.inventory)
2153
self.set_parent_ids(revision_ids)
2156
"""Write the in memory inventory to disk."""
2157
# TODO: Maybe this should only write on dirty ?
2158
if self._control_files._lock_mode != 'w':
2159
raise errors.NotWriteLocked(self)
2161
self._serialize(self._inventory, sio)
2163
self._transport.put_file('inventory', sio,
2164
mode=self.bzrdir._get_file_mode())
2165
self._inventory_is_modified = False
2167
def get_file_mtime(self, file_id, path=None):
2168
"""See Tree.get_file_mtime."""
2170
path = self.inventory.id2path(file_id)
2172
return os.lstat(self.abspath(path)).st_mtime
2174
if e.errno == errno.ENOENT:
2175
raise errors.FileTimestampUnavailable(path)
2178
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2179
file_id = self.path2id(path)
2181
# For unversioned files on win32, we just assume they are not
86
if file_id in self._statcache:
88
return os.path.exists(self.abspath(self.id2path(file_id)))
94
def _update_statcache(self):
96
if not self._statcache:
97
self._statcache = statcache.update_cache(self.basedir, self.inventory)
99
def get_file_size(self, file_id):
101
return os.stat(self._get_store_filename(file_id))[stat.ST_SIZE]
104
def get_file_sha1(self, file_id):
105
return self._statcache[file_id][statcache.SC_SHA1]
108
def file_class(self, filename):
109
if self.path2id(filename):
111
elif self.is_ignored(filename):
2184
return self._inventory[file_id].executable
2186
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2187
mode = stat_result.st_mode
2188
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2190
if not supports_executable():
2191
def is_executable(self, file_id, path=None):
2192
return self._inventory[file_id].executable
2194
_is_executable_from_path_and_stat = \
2195
_is_executable_from_path_and_stat_from_basis
2197
def is_executable(self, file_id, path=None):
2199
path = self.id2path(file_id)
2200
mode = os.lstat(self.abspath(path)).st_mode
2201
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2203
_is_executable_from_path_and_stat = \
2204
_is_executable_from_path_and_stat_from_stat
2206
@needs_tree_write_lock
2207
def _add(self, files, ids, kinds):
2208
"""See MutableTree._add."""
2209
# TODO: Re-adding a file that is removed in the working copy
2210
# should probably put it back with the previous ID.
2211
# the read and write working inventory should not occur in this
2212
# function - they should be part of lock_write and unlock.
2213
inv = self.inventory
2214
for f, file_id, kind in zip(files, ids, kinds):
2216
inv.add_path(f, kind=kind)
2218
inv.add_path(f, kind=kind, file_id=file_id)
2219
self._inventory_is_modified = True
2221
def revision_tree(self, revision_id):
2222
"""See WorkingTree.revision_id."""
2223
if revision_id == self.last_revision():
2225
xml = self.read_basis_inventory()
2226
except errors.NoSuchFile:
2230
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2231
# dont use the repository revision_tree api because we want
2232
# to supply the inventory.
2233
if inv.revision_id == revision_id:
2234
return revisiontree.InventoryRevisionTree(
2235
self.branch.repository, inv, revision_id)
2236
except errors.BadInventoryFormat:
2238
# raise if there was no inventory, or if we read the wrong inventory.
2239
raise errors.NoSuchRevisionInTree(self, revision_id)
2242
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2243
"""See Tree.annotate_iter
2245
This implementation will use the basis tree implementation if possible.
2246
Lines not in the basis are attributed to CURRENT_REVISION
2248
If there are pending merges, lines added by those merges will be
2249
incorrectly attributed to CURRENT_REVISION (but after committing, the
2250
attribution will be correct).
2252
maybe_file_parent_keys = []
2253
for parent_id in self.get_parent_ids():
2255
parent_tree = self.revision_tree(parent_id)
2256
except errors.NoSuchRevisionInTree:
2257
parent_tree = self.branch.repository.revision_tree(parent_id)
2258
parent_tree.lock_read()
2260
if not parent_tree.has_id(file_id):
2262
ie = parent_tree.inventory[file_id]
2263
if ie.kind != 'file':
2264
# Note: this is slightly unnecessary, because symlinks and
2265
# directories have a "text" which is the empty text, and we
2266
# know that won't mess up annotations. But it seems cleaner
2268
parent_text_key = (file_id, ie.revision)
2269
if parent_text_key not in maybe_file_parent_keys:
2270
maybe_file_parent_keys.append(parent_text_key)
2272
parent_tree.unlock()
2273
graph = _mod_graph.Graph(self.branch.repository.texts)
2274
heads = graph.heads(maybe_file_parent_keys)
2275
file_parent_keys = []
2276
for key in maybe_file_parent_keys:
2278
file_parent_keys.append(key)
2280
# Now we have the parents of this content
2281
annotator = self.branch.repository.texts.get_annotator()
2282
text = self.get_file_text(file_id)
2283
this_key =(file_id, default_revision)
2284
annotator.add_special_text(this_key, file_parent_keys, text)
2285
annotations = [(key[-1], line)
2286
for key, line in annotator.annotate_flat(this_key)]
2289
def _put_rio(self, filename, stanzas, header):
2290
self._must_be_locked()
2291
my_file = _mod_rio.rio_file(stanzas, header)
2292
self._transport.put_file(filename, my_file,
2293
mode=self.bzrdir._get_file_mode())
2295
@needs_tree_write_lock
2296
def set_merge_modified(self, modified_hashes):
2298
for file_id, hash in modified_hashes.iteritems():
2299
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2301
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2304
def merge_modified(self):
2305
"""Return a dictionary of files modified by a merge.
2307
The list is initialized by WorkingTree.set_merge_modified, which is
2308
typically called after we make some automatic updates to the tree
2311
This returns a map of file_id->sha1, containing only files which are
2312
still in the working inventory and have that text hash.
2315
hashfile = self._transport.get('merge-hashes')
2316
except errors.NoSuchFile:
2321
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2322
raise errors.MergeModifiedFormatError()
2323
except StopIteration:
2324
raise errors.MergeModifiedFormatError()
2325
for s in _mod_rio.RioReader(hashfile):
2326
# RioReader reads in Unicode, so convert file_ids back to utf8
2327
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2328
if not self.inventory.has_id(file_id):
2330
text_hash = s.get("hash")
2331
if text_hash == self.get_file_sha1(file_id):
2332
merge_hashes[file_id] = text_hash
2338
def subsume(self, other_tree):
2339
def add_children(inventory, entry):
2340
for child_entry in entry.children.values():
2341
inventory._byid[child_entry.file_id] = child_entry
2342
if child_entry.kind == 'directory':
2343
add_children(inventory, child_entry)
2344
if other_tree.get_root_id() == self.get_root_id():
2345
raise errors.BadSubsumeSource(self, other_tree,
2346
'Trees have the same root')
2348
other_tree_path = self.relpath(other_tree.basedir)
2349
except errors.PathNotChild:
2350
raise errors.BadSubsumeSource(self, other_tree,
2351
'Tree is not contained by the other')
2352
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2353
if new_root_parent is None:
2354
raise errors.BadSubsumeSource(self, other_tree,
2355
'Parent directory is not versioned.')
2356
# We need to ensure that the result of a fetch will have a
2357
# versionedfile for the other_tree root, and only fetching into
2358
# RepositoryKnit2 guarantees that.
2359
if not self.branch.repository.supports_rich_root():
2360
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2361
other_tree.lock_tree_write()
2363
new_parents = other_tree.get_parent_ids()
2364
other_root = other_tree.inventory.root
2365
other_root.parent_id = new_root_parent
2366
other_root.name = osutils.basename(other_tree_path)
2367
self.inventory.add(other_root)
2368
add_children(self.inventory, other_root)
2369
self._write_inventory(self.inventory)
2370
# normally we don't want to fetch whole repositories, but i think
2371
# here we really do want to consolidate the whole thing.
2372
for parent_id in other_tree.get_parent_ids():
2373
self.branch.fetch(other_tree.branch, parent_id)
2374
self.add_parent_tree_id(parent_id)
2377
other_tree.bzrdir.retire_bzrdir()
2379
@needs_tree_write_lock
2380
def extract(self, file_id, format=None):
2381
"""Extract a subtree from this tree.
2383
A new branch will be created, relative to the path for this tree.
2387
segments = osutils.splitpath(path)
2388
transport = self.branch.bzrdir.root_transport
2389
for name in segments:
2390
transport = transport.clone(name)
2391
transport.ensure_base()
2394
sub_path = self.id2path(file_id)
2395
branch_transport = mkdirs(sub_path)
2397
format = self.bzrdir.cloning_metadir()
2398
branch_transport.ensure_base()
2399
branch_bzrdir = format.initialize_on_transport(branch_transport)
2401
repo = branch_bzrdir.find_repository()
2402
except errors.NoRepositoryPresent:
2403
repo = branch_bzrdir.create_repository()
2404
if not repo.supports_rich_root():
2405
raise errors.RootNotRich()
2406
new_branch = branch_bzrdir.create_branch()
2407
new_branch.pull(self.branch)
2408
for parent_id in self.get_parent_ids():
2409
new_branch.fetch(self.branch, parent_id)
2410
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2411
if tree_transport.base != branch_transport.base:
2412
tree_bzrdir = format.initialize_on_transport(tree_transport)
2413
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2414
target_branch=new_branch)
117
def list_files(self):
118
"""Recursively list all files as (path, class, kind, id).
2416
tree_bzrdir = branch_bzrdir
2417
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2418
wt.set_parent_ids(self.get_parent_ids())
2419
my_inv = self.inventory
2420
child_inv = inventory.Inventory(root_id=None)
2421
new_root = my_inv[file_id]
2422
my_inv.remove_recursive_id(file_id)
2423
new_root.parent_id = None
2424
child_inv.add(new_root)
2425
self._write_inventory(my_inv)
2426
wt._write_inventory(child_inv)
2429
def list_files(self, include_root=False, from_dir=None, recursive=True):
2430
"""List all files as (path, class, kind, id, entry).
120
2432
Lists, but does not descend into unversioned directories.
122
2433
This does not include files that have been deleted in this
2434
tree. Skips the control directory.
125
Skips the control directory.
2436
:param include_root: if True, return an entry for the root
2437
:param from_dir: start from this directory or None for the root
2438
:param recursive: whether to recurse into subdirectories or not
127
from osutils import appendpath, file_kind
2440
# list_files is an iterator, so @needs_read_lock doesn't work properly
2441
# with it. So callers should be careful to always read_lock the tree.
2442
if not self.is_locked():
2443
raise errors.ObjectNotLocked(self)
130
2445
inv = self.inventory
132
def descend(from_dir_relpath, from_dir_id, dp):
2446
if from_dir is None and include_root is True:
2447
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2448
# Convert these into local objects to save lookup times
2449
pathjoin = osutils.pathjoin
2450
file_kind = self._kind
2452
# transport.base ends in a slash, we want the piece
2453
# between the last two slashes
2454
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2456
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2458
# directory file_id, relative path, absolute path, reverse sorted children
2459
if from_dir is not None:
2460
from_dir_id = inv.path2id(from_dir)
2461
if from_dir_id is None:
2462
# Directory not versioned
2464
from_dir_abspath = pathjoin(self.basedir, from_dir)
2466
from_dir_id = inv.root.file_id
2467
from_dir_abspath = self.basedir
2468
children = os.listdir(from_dir_abspath)
2470
# jam 20060527 The kernel sized tree seems equivalent whether we
2471
# use a deque and popleft to keep them sorted, or if we use a plain
2472
# list and just reverse() them.
2473
children = collections.deque(children)
2474
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2476
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2479
f = children.popleft()
136
2480
## TODO: If we find a subdirectory with its own .bzr
137
2481
## directory, then that is a separate tree and we
138
2482
## should exclude it.
139
if bzrlib.BZRDIR == f:
2484
# the bzrdir for this tree
2485
if transport_base_dir == f:
143
fp = appendpath(from_dir_relpath, f)
2488
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2489
# and 'f' doesn't begin with one, we can do a string op, rather
2490
# than the checks of pathjoin(), all relative paths will have an extra slash
2492
fp = from_dir_relpath + '/' + f
146
fap = appendpath(dp, f)
148
f_ie = inv.get_child(from_dir_id, f)
2495
fap = from_dir_abspath + '/' + f
2497
dir_ie = inv[from_dir_id]
2498
if dir_ie.kind == 'directory':
2499
f_ie = dir_ie.children.get(f)
151
elif self.is_ignored(fp):
2504
elif self.is_ignored(fp[1:]):
2507
# we may not have found this file, because of a unicode
2508
# issue, or because the directory was actually a symlink.
2509
f_norm, can_access = osutils.normalized_filename(f)
2510
if f == f_norm or not can_access:
2511
# No change, so treat this file normally
2514
# this file can be accessed by a normalized path
2515
# check again if it is versioned
2516
# these lines are repeated here for performance
2518
fp = from_dir_relpath + '/' + f
2519
fap = from_dir_abspath + '/' + f
2520
f_ie = inv.get_child(from_dir_id, f)
2523
elif self.is_ignored(fp[1:]):
156
2528
fk = file_kind(fap)
2530
# make a last minute entry
160
raise BzrCheckError("file %r entered as kind %r id %r, "
162
% (fap, f_ie.kind, f_ie.file_id, fk))
164
yield fp, c, fk, (f_ie and f_ie.file_id)
2532
yield fp[1:], c, fk, f_ie.file_id, f_ie
2535
yield fp[1:], c, fk, None, fk_entries[fk]()
2537
yield fp[1:], c, fk, None, TreeEntry()
166
2540
if fk != 'directory':
170
# don't descend unversioned directories
173
for ff in descend(fp, f_ie.file_id, fap):
176
for f in descend('', inv.root.file_id, self.basedir):
182
for subp in self.extras():
183
if not self.is_ignored(subp):
2543
# But do this child first if recursing down
2545
new_children = os.listdir(fap)
2547
new_children = collections.deque(new_children)
2548
stack.append((f_ie.file_id, fp, fap, new_children))
2549
# Break out of inner loop,
2550
# so that we start outer loop with child
2553
# if we finished all children, pop it off the stack
2556
@needs_tree_write_lock
2557
def move(self, from_paths, to_dir=None, after=False):
2560
to_dir must exist in the inventory.
2562
If to_dir exists and is a directory, the files are moved into
2563
it, keeping their old names.
2565
Note that to_dir is only the last component of the new name;
2566
this doesn't change the directory.
2568
For each entry in from_paths the move mode will be determined
2571
The first mode moves the file in the filesystem and updates the
2572
inventory. The second mode only updates the inventory without
2573
touching the file on the filesystem.
2575
move uses the second mode if 'after == True' and the target is
2576
either not versioned or newly added, and present in the working tree.
2578
move uses the second mode if 'after == False' and the source is
2579
versioned but no longer in the working tree, and the target is not
2580
versioned but present in the working tree.
2582
move uses the first mode if 'after == False' and the source is
2583
versioned and present in the working tree, and the target is not
2584
versioned and not present in the working tree.
2586
Everything else results in an error.
2588
This returns a list of (from_path, to_path) pairs for each
2589
entry that is moved.
2594
# check for deprecated use of signature
2596
raise TypeError('You must supply a target directory')
2597
# check destination directory
2598
if isinstance(from_paths, basestring):
2600
inv = self.inventory
2601
to_abs = self.abspath(to_dir)
2602
if not isdir(to_abs):
2603
raise errors.BzrMoveFailedError('',to_dir,
2604
errors.NotADirectory(to_abs))
2605
if not self.has_filename(to_dir):
2606
raise errors.BzrMoveFailedError('',to_dir,
2607
errors.NotInWorkingDirectory(to_dir))
2608
to_dir_id = inv.path2id(to_dir)
2609
if to_dir_id is None:
2610
raise errors.BzrMoveFailedError('',to_dir,
2611
errors.NotVersionedError(path=to_dir))
2613
to_dir_ie = inv[to_dir_id]
2614
if to_dir_ie.kind != 'directory':
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotADirectory(to_abs))
2618
# create rename entries and tuples
2619
for from_rel in from_paths:
2620
from_tail = splitpath(from_rel)[-1]
2621
from_id = inv.path2id(from_rel)
2623
raise errors.BzrMoveFailedError(from_rel,to_dir,
2624
errors.NotVersionedError(path=from_rel))
2626
from_entry = inv[from_id]
2627
from_parent_id = from_entry.parent_id
2628
to_rel = pathjoin(to_dir, from_tail)
2629
rename_entry = InventoryWorkingTree._RenameEntry(
2632
from_tail=from_tail,
2633
from_parent_id=from_parent_id,
2634
to_rel=to_rel, to_tail=from_tail,
2635
to_parent_id=to_dir_id)
2636
rename_entries.append(rename_entry)
2637
rename_tuples.append((from_rel, to_rel))
2639
# determine which move mode to use. checks also for movability
2640
rename_entries = self._determine_mv_mode(rename_entries, after)
2642
original_modified = self._inventory_is_modified
2645
self._inventory_is_modified = True
2646
self._move(rename_entries)
2648
# restore the inventory on error
2649
self._inventory_is_modified = original_modified
2651
self._write_inventory(inv)
2652
return rename_tuples
2654
@needs_tree_write_lock
2655
def rename_one(self, from_rel, to_rel, after=False):
2658
This can change the directory or the filename or both.
2660
rename_one has several 'modes' to work. First, it can rename a physical
2661
file and change the file_id. That is the normal mode. Second, it can
2662
only change the file_id without touching any physical file.
2664
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2665
versioned but present in the working tree.
2667
rename_one uses the second mode if 'after == False' and 'from_rel' is
2668
versioned but no longer in the working tree, and 'to_rel' is not
2669
versioned but present in the working tree.
2671
rename_one uses the first mode if 'after == False' and 'from_rel' is
2672
versioned and present in the working tree, and 'to_rel' is not
2673
versioned and not present in the working tree.
2675
Everything else results in an error.
2677
inv = self.inventory
2680
# create rename entries and tuples
2681
from_tail = splitpath(from_rel)[-1]
2682
from_id = inv.path2id(from_rel)
2684
# if file is missing in the inventory maybe it's in the basis_tree
2685
basis_tree = self.branch.basis_tree()
2686
from_id = basis_tree.path2id(from_rel)
2688
raise errors.BzrRenameFailedError(from_rel,to_rel,
2689
errors.NotVersionedError(path=from_rel))
2690
# put entry back in the inventory so we can rename it
2691
from_entry = basis_tree.inventory[from_id].copy()
2694
from_entry = inv[from_id]
2695
from_parent_id = from_entry.parent_id
2696
to_dir, to_tail = os.path.split(to_rel)
2697
to_dir_id = inv.path2id(to_dir)
2698
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2700
from_tail=from_tail,
2701
from_parent_id=from_parent_id,
2702
to_rel=to_rel, to_tail=to_tail,
2703
to_parent_id=to_dir_id)
2704
rename_entries.append(rename_entry)
2706
# determine which move mode to use. checks also for movability
2707
rename_entries = self._determine_mv_mode(rename_entries, after)
2709
# check if the target changed directory and if the target directory is
2711
if to_dir_id is None:
2712
raise errors.BzrMoveFailedError(from_rel,to_rel,
2713
errors.NotVersionedError(path=to_dir))
2715
# all checks done. now we can continue with our actual work
2716
mutter('rename_one:\n'
2721
' to_dir_id {%s}\n',
2722
from_id, from_rel, to_rel, to_dir, to_dir_id)
2724
self._move(rename_entries)
2725
self._write_inventory(inv)
2727
class _RenameEntry(object):
2728
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2729
to_rel, to_tail, to_parent_id, only_change_inv=False,
2731
self.from_rel = from_rel
2732
self.from_id = from_id
2733
self.from_tail = from_tail
2734
self.from_parent_id = from_parent_id
2735
self.to_rel = to_rel
2736
self.to_tail = to_tail
2737
self.to_parent_id = to_parent_id
2738
self.change_id = change_id
2739
self.only_change_inv = only_change_inv
2741
def _determine_mv_mode(self, rename_entries, after=False):
2742
"""Determines for each from-to pair if both inventory and working tree
2743
or only the inventory has to be changed.
2745
Also does basic plausability tests.
2747
inv = self.inventory
2749
for rename_entry in rename_entries:
2750
# store to local variables for easier reference
2751
from_rel = rename_entry.from_rel
2752
from_id = rename_entry.from_id
2753
to_rel = rename_entry.to_rel
2754
to_id = inv.path2id(to_rel)
2755
only_change_inv = False
2758
# check the inventory for source and destination
2760
raise errors.BzrMoveFailedError(from_rel,to_rel,
2761
errors.NotVersionedError(path=from_rel))
2762
if to_id is not None:
2764
# allow it with --after but only if dest is newly added
2766
basis = self.basis_tree()
2769
if not basis.has_id(to_id):
2770
rename_entry.change_id = True
2775
raise errors.BzrMoveFailedError(from_rel,to_rel,
2776
errors.AlreadyVersionedError(path=to_rel))
2778
# try to determine the mode for rename (only change inv or change
2779
# inv and file system)
2781
if not self.has_filename(to_rel):
2782
raise errors.BzrMoveFailedError(from_id,to_rel,
2783
errors.NoSuchFile(path=to_rel,
2784
extra="New file has not been created yet"))
2785
only_change_inv = True
2786
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2787
only_change_inv = True
2788
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2789
only_change_inv = False
2790
elif (not self.case_sensitive
2791
and from_rel.lower() == to_rel.lower()
2792
and self.has_filename(from_rel)):
2793
only_change_inv = False
2795
# something is wrong, so lets determine what exactly
2796
if not self.has_filename(from_rel) and \
2797
not self.has_filename(to_rel):
2798
raise errors.BzrRenameFailedError(from_rel,to_rel,
2799
errors.PathsDoNotExist(paths=(str(from_rel),
2802
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2803
rename_entry.only_change_inv = only_change_inv
2804
return rename_entries
2806
def _move(self, rename_entries):
2807
"""Moves a list of files.
2809
Depending on the value of the flag 'only_change_inv', the
2810
file will be moved on the file system or not.
2812
inv = self.inventory
2815
for entry in rename_entries:
2817
self._move_entry(entry)
2819
self._rollback_move(moved)
2823
def _rollback_move(self, moved):
2824
"""Try to rollback a previous move in case of an filesystem error."""
2825
inv = self.inventory
2828
self._move_entry(WorkingTree._RenameEntry(
2829
entry.to_rel, entry.from_id,
2830
entry.to_tail, entry.to_parent_id, entry.from_rel,
2831
entry.from_tail, entry.from_parent_id,
2832
entry.only_change_inv))
2833
except errors.BzrMoveFailedError, e:
2834
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2835
" The working tree is in an inconsistent state."
2836
" Please consider doing a 'bzr revert'."
2837
" Error message is: %s" % e)
2839
def _move_entry(self, entry):
2840
inv = self.inventory
2841
from_rel_abs = self.abspath(entry.from_rel)
2842
to_rel_abs = self.abspath(entry.to_rel)
2843
if from_rel_abs == to_rel_abs:
2844
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2845
"Source and target are identical.")
2847
if not entry.only_change_inv:
2849
osutils.rename(from_rel_abs, to_rel_abs)
2851
raise errors.BzrMoveFailedError(entry.from_rel,
2854
to_id = inv.path2id(entry.to_rel)
2855
inv.remove_recursive_id(to_id)
2856
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2858
@needs_tree_write_lock
2859
def unversion(self, file_ids):
2860
"""Remove the file ids in file_ids from the current versioned set.
2862
When a file_id is unversioned, all of its children are automatically
2865
:param file_ids: The file ids to stop versioning.
2866
:raises: NoSuchId if any fileid is not currently versioned.
2868
for file_id in file_ids:
2869
if not self._inventory.has_id(file_id):
2870
raise errors.NoSuchId(self, file_id)
2871
for file_id in file_ids:
2872
if self._inventory.has_id(file_id):
2873
self._inventory.remove_recursive_id(file_id)
2875
# in the future this should just set a dirty bit to wait for the
2876
# final unlock. However, until all methods of workingtree start
2877
# with the current in -memory inventory rather than triggering
2878
# a read, it is more complex - we need to teach read_inventory
2879
# to know when to read, and when to not read first... and possibly
2880
# to save first when the in memory one may be corrupted.
2881
# so for now, we just only write it if it is indeed dirty.
2883
self._write_inventory(self._inventory)
2885
def stored_kind(self, file_id):
2886
"""See Tree.stored_kind"""
2887
return self.inventory[file_id].kind
187
2889
def extras(self):
188
"""Yield all unknown files in this WorkingTree.
2890
"""Yield all unversioned files in this WorkingTree.
190
If there are any unknown directories then only the directory is
191
returned, not all its children. But if there are unknown files
2892
If there are any unversioned directories then only the directory is
2893
returned, not all its children. But if there are unversioned files
192
2894
under a versioned subdirectory, they are returned.
194
2896
Currently returned depth-first, sorted by name within directories.
2897
This is the same order used by 'osutils.walkdirs'.
196
2899
## TODO: Work from given directory downwards
197
from osutils import isdir, appendpath
199
2900
for path, dir_entry in self.inventory.directories():
200
mutter("search for unknowns in %r" % path)
2901
# mutter("search for unknowns in %r", path)
201
2902
dirabs = self.abspath(path)
202
2903
if not isdir(dirabs):
203
2904
# e.g. directory deleted
added
removed
bzrlib/workingtree.py
