29
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
33
39
from cStringIO import StringIO
37
43
from bzrlib.lazy_import import lazy_import
38
44
lazy_import(globals(), """
39
from bisect import bisect_left
46
from copy import deepcopy
48
54
from bzrlib import (
51
56
conflicts as _mod_conflicts,
60
revision as _mod_revision,
69
66
import bzrlib.branch
70
67
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
from bzrlib import symbol_versioning
79
71
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
72
from bzrlib.errors import (BzrCheckError,
75
WeaveRevisionNotPresent,
79
MergeModifiedFormatError,
82
from bzrlib.inventory import InventoryEntry, Inventory
83
from bzrlib.lockable_files import LockableFiles, TransportLock
82
84
from bzrlib.lockdir import LockDir
83
import bzrlib.mutabletree
84
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
85
from bzrlib.osutils import (
94
95
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
97
from bzrlib.trace import mutter, note
98
98
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
100
from bzrlib.progress import DummyProgress, ProgressPhase
101
from bzrlib.revision import NULL_REVISION
100
102
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
103
from bzrlib.symbol_versioning import (deprecated_passed,
106
DEPRECATED_PARAMETER,
107
112
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
113
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
115
# the regex removes any weird characters; we don't escape them
116
# but rather just pull them out
117
_gen_file_id_re = re.compile(r'[^\w.]')
118
_gen_id_suffix = None
122
def _next_id_suffix():
123
"""Create a new file id suffix that is reasonably unique.
125
On the first call we combine the current time with 64 bits of randomness
126
to give a highly probably globally unique number. Then each call in the same
127
process adds 1 to a serial number we append to that unique value.
129
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
130
# than having to move the id randomness out of the inner loop like this.
131
# XXX TODO: for the global randomness this uses we should add the thread-id
132
# before the serial #.
133
global _gen_id_suffix, _gen_id_serial
134
if _gen_id_suffix is None:
135
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
137
return _gen_id_suffix + str(_gen_id_serial)
140
def gen_file_id(name):
141
"""Return new file id for the basename 'name'.
143
The uniqueness is supplied from _next_id_suffix.
145
# The real randomness is in the _next_id_suffix, the
146
# rest of the identifier is just to be nice.
148
# 1) Remove non-ascii word characters to keep the ids portable
149
# 2) squash to lowercase, so the file id doesn't have to
150
# be escaped (case insensitive filesystems would bork for ids
151
# that only differred in case without escaping).
152
# 3) truncate the filename to 20 chars. Long filenames also bork on some
154
# 4) Removing starting '.' characters to prevent the file ids from
155
# being considered hidden.
156
ascii_word_only = _gen_file_id_re.sub('', name.lower())
157
short_no_dots = ascii_word_only.lstrip('.')[:20]
158
return short_no_dots + _next_id_suffix()
162
"""Return a new tree-root file id."""
163
return gen_file_id('TREE_ROOT')
116
166
class TreeEntry(object):
117
167
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
169
This needs further inspection, it may be better to have
120
170
InventoryEntries without ids - though that seems wrong. For now,
121
171
this is a parallel hierarchy to InventoryEntry, and needs to become
122
172
one of several things: decorates to that hierarchy, children of, or
412
410
# no parents, return an empty revision tree.
413
411
# in the future this should return the tree for
414
412
# 'empty:' - the implicit root empty tree.
415
return self.branch.repository.revision_tree(
416
_mod_revision.NULL_REVISION)
418
return self.revision_tree(revision_id)
419
except errors.NoSuchRevision:
413
return self.branch.repository.revision_tree(None)
416
xml = self.read_basis_inventory()
417
inv = xml5.serializer_v5.read_inventory_from_string(xml)
418
inv.root.revision = revision_id
421
if inv is not None and inv.revision_id == revision_id:
422
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
421
424
# No cached copy available, retrieve from the repository.
422
425
# FIXME? RBC 20060403 should we cache the inventory locally
423
426
# at this point ?
425
428
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
429
except errors.RevisionNotPresent:
427
430
# the basis tree *may* be a ghost or a low level error may have
428
# occurred. If the revision is present, its a problem, if its not
431
# occured. If the revision is present, its a problem, if its not
430
433
if self.branch.repository.has_revision(revision_id):
432
435
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
437
self._flush_ignore_list_cache()
436
return self.branch.repository.revision_tree(None)
439
@deprecated_method(zero_eight)
440
def create(branch, directory):
441
"""Create a workingtree for branch at directory.
443
If existing_directory already exists it must have a .bzr directory.
444
If it does not exist, it will be created.
446
This returns a new WorkingTree object for the new checkout.
448
TODO FIXME RBC 20060124 when we have checkout formats in place this
449
should accept an optional revisionid to checkout [and reject this if
450
checking out into the same dir as a pre-checkout-aware branch format.]
452
XXX: When BzrDir is present, these should be created through that
455
warnings.warn('delete WorkingTree.create', stacklevel=3)
456
transport = get_transport(directory)
457
if branch.bzrdir.root_transport.base == transport.base:
459
return branch.bzrdir.create_workingtree()
460
# different directory,
461
# create a branch reference
462
# and now a working tree.
463
raise NotImplementedError
466
@deprecated_method(zero_eight)
467
def create_standalone(directory):
468
"""Create a checkout and a branch and a repo at directory.
470
Directory must exist and be empty.
472
please use BzrDir.create_standalone_workingtree
474
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
476
def relpath(self, path):
440
477
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
479
The path may be absolute or relative. If its a relative path it is
443
480
interpreted relative to the python current working directory.
445
482
return osutils.relpath(self.basedir, path)
447
484
def has_filename(self, filename):
448
485
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
459
stat_value = _fstat(file_obj.fileno())
460
if filtered and self.supports_content_filtering():
461
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
463
return (file_obj, stat_value)
465
def get_file_text(self, file_id, path=None, filtered=True):
466
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
486
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
487
"""See Tree.annotate_iter
489
This implementation will use the basis tree implementation if possible.
490
Lines not in the basis are attributed to CURRENT_REVISION
492
If there are pending merges, lines added by those merges will be
493
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
533
def _get_ancestors(self, default_revision):
534
ancestors = set([default_revision])
535
for parent_id in self.get_parent_ids():
536
ancestors.update(self.branch.repository.get_ancestry(
537
parent_id, topo_sorted=False))
487
def get_file(self, file_id):
488
return self.get_file_byname(self.id2path(file_id))
490
def get_file_text(self, file_id):
491
return self.get_file(file_id).read()
493
def get_file_byname(self, filename):
494
return file(self.abspath(filename), 'rb')
540
496
def get_parent_ids(self):
541
497
"""See Tree.get_parent_ids.
543
499
This implementation reads the pending merges list and last_revision
544
500
value and uses that to decide what the parents list should be.
546
last_rev = _mod_revision.ensure_null(self._last_revision())
547
if _mod_revision.NULL_REVISION == last_rev:
502
last_rev = self._last_revision()
550
506
parents = [last_rev]
552
merges_bytes = self._transport.get_bytes('pending-merges')
553
except errors.NoSuchFile:
508
merges_file = self._control_files.get_utf8('pending-merges')
556
for l in osutils.split_lines(merges_bytes):
557
revision_id = l.rstrip('\n')
558
parents.append(revision_id)
512
for l in merges_file.readlines():
513
parents.append(l.rstrip('\n'))
562
516
def get_root_id(self):
563
517
"""Return the id of this trees root"""
564
return self._inventory.root.file_id
518
inv = self.read_working_inventory()
519
return inv.root.file_id
566
521
def _get_store_filename(self, file_id):
567
522
## XXX: badly named; this is not in the store at all
568
523
return self.abspath(self.id2path(file_id))
571
def clone(self, to_bzrdir, revision_id=None):
526
def clone(self, to_bzrdir, revision_id=None, basis=None):
572
527
"""Duplicate this working tree into to_bzr, including all state.
574
529
Specifically modified files are kept as modified, but
575
530
ignored and unknown files are discarded.
577
532
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
535
If not None, the cloned tree will have its last revision set to
536
revision, and and difference between the source trees last revision
582
537
and this one merged in.
540
If not None, a closer copy of a tree which may have some files in
541
common, and which file content should be preferentially copied from.
584
543
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
544
result = self._format.initialize(to_bzrdir)
586
545
self.copy_content_into(result, revision_id)
590
549
def copy_content_into(self, tree, revision_id=None):
591
550
"""Copy the current content and user files of this tree into tree."""
592
tree.set_root_id(self.get_root_id())
593
551
if revision_id is None:
594
552
merge.transform_tree(tree, self)
617
591
__contains__ = has_id
619
593
def get_file_size(self, file_id):
620
"""See Tree.get_file_size"""
621
# XXX: this returns the on-disk size; it should probably return the
624
return os.path.getsize(self.id2abspath(file_id))
626
if e.errno != errno.ENOENT:
594
return os.path.getsize(self.id2abspath(file_id))
632
def get_file_sha1(self, file_id, path=None, stat_value=None):
597
def get_file_sha1(self, file_id, path=None):
634
599
path = self._inventory.id2path(file_id)
635
return self._hashcache.get_sha1(path, stat_value)
600
return self._hashcache.get_sha1(path)
637
602
def get_file_mtime(self, file_id, path=None):
639
path = self.inventory.id2path(file_id)
604
path = self._inventory.id2path(file_id)
640
605
return os.lstat(self.abspath(path)).st_mtime
642
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
file_id = self.path2id(path)
645
# For unversioned files on win32, we just assume they are not
648
return self._inventory[file_id].executable
650
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
mode = stat_result.st_mode
652
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
654
607
if not supports_executable():
655
608
def is_executable(self, file_id, path=None):
656
609
return self._inventory[file_id].executable
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_basis
661
611
def is_executable(self, file_id, path=None):
663
path = self.id2path(file_id)
613
path = self._inventory.id2path(file_id)
664
614
mode = os.lstat(self.abspath(path)).st_mode
665
615
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
667
_is_executable_from_path_and_stat = \
668
_is_executable_from_path_and_stat_from_stat
670
@needs_tree_write_lock
671
def _add(self, files, ids, kinds):
672
"""See MutableTree._add."""
618
def add(self, files, ids=None):
619
"""Make files versioned.
621
Note that the command line normally calls smart_add instead,
622
which can automatically recurse.
624
This adds the files to the inventory, so that they will be
625
recorded by the next commit.
628
List of paths to add, relative to the base of the tree.
631
If set, use these instead of automatically generated ids.
632
Must be the same length as the list of files, but may
633
contain None for ids that are to be autogenerated.
635
TODO: Perhaps have an option to add the ids even if the files do
638
TODO: Perhaps callback with the ids and paths as they're added.
673
640
# TODO: Re-adding a file that is removed in the working copy
674
641
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
676
# function - they should be part of lock_write and unlock.
678
for f, file_id, kind in zip(files, ids, kinds):
642
if isinstance(files, basestring):
643
assert(ids is None or isinstance(ids, basestring))
649
ids = [None] * len(files)
651
assert(len(ids) == len(files))
653
inv = self.read_working_inventory()
654
for f,file_id in zip(files, ids):
655
if self.is_control_filename(f):
656
raise errors.ForbiddenControlFileError(filename=f)
661
raise BzrError("cannot add top-level %r" % f)
663
fullpath = normpath(self.abspath(f))
665
kind = file_kind(fullpath)
667
if e.errno == errno.ENOENT:
668
raise NoSuchFile(fullpath)
669
if not InventoryEntry.versionable_kind(kind):
670
raise errors.BadFileKindError(filename=f, kind=kind)
679
671
if file_id is None:
680
672
inv.add_path(f, kind=kind)
682
674
inv.add_path(f, kind=kind, file_id=file_id)
683
self._inventory_is_modified = True
685
@needs_tree_write_lock
686
def _gather_kinds(self, files, kinds):
687
"""See MutableTree._gather_kinds."""
688
for pos, f in enumerate(files):
689
if kinds[pos] is None:
690
fullpath = normpath(self.abspath(f))
692
kinds[pos] = file_kind(fullpath)
694
if e.errno == errno.ENOENT:
695
raise errors.NoSuchFile(fullpath)
676
self._write_inventory(inv)
697
678
@needs_write_lock
698
679
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
747
728
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
749
def path_content_summary(self, path, _lstat=os.lstat,
750
_mapper=osutils.file_kind_from_stat_mode):
751
"""See Tree.path_content_summary."""
752
abspath = self.abspath(path)
754
stat_result = _lstat(abspath)
756
if getattr(e, 'errno', None) == errno.ENOENT:
758
return ('missing', None, None, None)
759
# propagate other errors
761
kind = _mapper(stat_result.st_mode)
763
return self._file_content_summary(path, stat_result)
764
elif kind == 'directory':
765
# perhaps it looks like a plain directory, but it's really a
767
if self._directory_is_tree_reference(path):
768
kind = 'tree-reference'
769
return kind, None, None, None
770
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
774
return (kind, None, None, None)
776
def _file_content_summary(self, path, stat_result):
777
size = stat_result.st_size
778
executable = self._is_executable_from_path_and_stat(path, stat_result)
779
# try for a stat cache lookup
780
return ('file', size, executable, self._sha_from_stat(
783
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
"""Common ghost checking functionality from set_parent_*.
786
This checks that the left hand-parent exists if there are any
789
if len(revision_ids) > 0:
790
leftmost_id = revision_ids[0]
791
if (not allow_leftmost_as_ghost and not
792
self.branch.repository.has_revision(leftmost_id)):
793
raise errors.GhostRevisionUnusableHere(leftmost_id)
795
def _set_merges_from_parent_ids(self, parent_ids):
796
merges = parent_ids[1:]
797
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
800
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
"""Check that all merged revisions are proper 'heads'.
803
This will always return the first revision_id, and any merged revisions
806
if len(revision_ids) == 0:
808
graph = self.branch.repository.get_graph()
809
heads = graph.heads(revision_ids)
810
new_revision_ids = revision_ids[:1]
811
for revision_id in revision_ids[1:]:
812
if revision_id in heads and revision_id not in new_revision_ids:
813
new_revision_ids.append(revision_id)
814
if new_revision_ids != revision_ids:
815
trace.mutter('requested to set revision_ids = %s,'
816
' but filtered to %s', revision_ids, new_revision_ids)
817
return new_revision_ids
819
@needs_tree_write_lock
730
@deprecated_method(zero_eleven)
732
def pending_merges(self):
733
"""Return a list of pending merges.
735
These are revisions that have been merged into the working
736
directory but not yet committed.
738
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
739
instead - which is available on all tree objects.
741
return self.get_parent_ids()[1:]
820
744
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
745
"""Set the parent ids to revision_ids.
823
747
See also set_parent_trees. This api will try to retrieve the tree data
824
748
for each element of revision_ids from the trees repository. If you have
825
749
tree data already available, it is more efficient to use
829
753
:param revision_ids: The revision_ids to set as the parent ids of this
830
754
working tree. Any of these may be ghosts.
832
self._check_parents_for_ghosts(revision_ids,
833
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
for revision_id in revision_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
839
756
if len(revision_ids) > 0:
840
self.set_last_revision(revision_ids[0])
757
leftmost_id = revision_ids[0]
758
if (not allow_leftmost_as_ghost and not
759
self.branch.repository.has_revision(leftmost_id)):
760
raise errors.GhostRevisionUnusableHere(leftmost_id)
761
self.set_last_revision(leftmost_id)
842
self.set_last_revision(_mod_revision.NULL_REVISION)
844
self._set_merges_from_parent_ids(revision_ids)
846
@needs_tree_write_lock
763
self.set_last_revision(None)
764
merges = revision_ids[1:]
765
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
847
768
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
"""See MutableTree.set_parent_trees."""
849
parent_ids = [rev for (rev, tree) in parents_list]
850
for revision_id in parent_ids:
851
_mod_revision.check_not_reserved_id(revision_id)
769
"""Set the parents of the working tree.
853
self._check_parents_for_ghosts(parent_ids,
771
:param parents_list: A list of (revision_id, tree) tuples.
772
If tree is None, then that element is treated as an unreachable
773
parent tree - i.e. a ghost.
775
# parent trees are not used in current format trees, delegate to
777
self.set_parent_ids([rev for (rev, tree) in parents_list],
854
778
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
856
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
858
if len(parent_ids) == 0:
859
leftmost_parent_id = _mod_revision.NULL_REVISION
860
leftmost_parent_tree = None
862
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
864
if self._change_last_revision(leftmost_parent_id):
865
if leftmost_parent_tree is None:
866
# If we don't have a tree, fall back to reading the
867
# parent tree from the repository.
868
self._cache_basis_inventory(leftmost_parent_id)
870
inv = leftmost_parent_tree.inventory
871
xml = self._create_basis_xml_from_inventory(
872
leftmost_parent_id, inv)
873
self._write_basis_inventory(xml)
874
self._set_merges_from_parent_ids(parent_ids)
876
@needs_tree_write_lock
877
781
def set_pending_merges(self, rev_list):
878
782
parents = self.get_parent_ids()
879
783
leftmost = parents[:1]
880
784
new_parents = leftmost + rev_list
881
785
self.set_parent_ids(new_parents)
883
@needs_tree_write_lock
884
788
def set_merge_modified(self, modified_hashes):
885
789
def iter_stanzas():
886
790
for file_id, hash in modified_hashes.iteritems():
887
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
791
yield Stanza(file_id=file_id, hash=hash)
888
792
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
890
def _sha_from_stat(self, path, stat_result):
891
"""Get a sha digest from the tree's stat cache.
893
The default implementation assumes no stat cache is present.
895
:param path: The path.
896
:param stat_result: The stat result being looked up.
900
795
def _put_rio(self, filename, stanzas, header):
901
self._must_be_locked()
902
796
my_file = rio_file(stanzas, header)
903
self._transport.put_file(filename, my_file,
904
mode=self.bzrdir._get_file_mode())
797
self._control_files.put(filename, my_file)
906
@needs_write_lock # because merge pulls data into the branch.
907
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
merge_type=None, force=False):
800
def merge_from_branch(self, branch, to_revision=None):
909
801
"""Merge from a branch into this working tree.
911
803
:param branch: The branch to merge from.
912
:param to_revision: If non-None, the merge will merge to to_revision,
913
but not beyond it. to_revision does not need to be in the history
914
of the branch when it is supplied. If None, to_revision defaults to
804
:param to_revision: If non-None, the merge will merge to to_revision, but
805
not beyond it. to_revision does not need to be in the history of
806
the branch when it is supplied. If None, to_revision defaults to
915
807
branch.last_revision().
917
809
from bzrlib.merge import Merger, Merge3Merger
918
merger = Merger(self.branch, this_tree=self)
919
# check that there are no local alterations
920
if not force and self.has_changes():
921
raise errors.UncommittedChanges(self)
922
if to_revision is None:
923
to_revision = _mod_revision.ensure_null(branch.last_revision())
924
merger.other_rev_id = to_revision
925
if _mod_revision.is_null(merger.other_rev_id):
926
raise errors.NoCommits(branch)
927
self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
merger.other_basis = merger.other_rev_id
929
merger.other_tree = self.branch.repository.revision_tree(
931
merger.other_branch = branch
932
if from_revision is None:
810
pb = bzrlib.ui.ui_factory.nested_progress_bar()
812
merger = Merger(self.branch, this_tree=self, pb=pb)
813
merger.pp = ProgressPhase("Merge phase", 5, pb)
814
merger.pp.next_phase()
815
# check that there are no
817
merger.check_basis(check_clean=True, require_commits=False)
818
if to_revision is None:
819
to_revision = branch.last_revision()
820
merger.other_rev_id = to_revision
821
if merger.other_rev_id is None:
822
raise error.NoCommits(branch)
823
self.branch.fetch(branch, last_revision=merger.other_rev_id)
824
merger.other_basis = merger.other_rev_id
825
merger.other_tree = self.branch.repository.revision_tree(
827
merger.pp.next_phase()
933
828
merger.find_base()
935
merger.set_base_revision(from_revision, branch)
936
if merger.base_rev_id == merger.other_rev_id:
937
raise errors.PointlessMerge
938
merger.backup_files = False
939
if merge_type is None:
829
if merger.base_rev_id == merger.other_rev_id:
830
raise errors.PointlessMerge
831
merger.backup_files = False
940
832
merger.merge_type = Merge3Merger
942
merger.merge_type = merge_type
943
merger.set_interesting_files(None)
944
merger.show_base = False
945
merger.reprocess = False
946
conflicts = merger.do_merge()
833
merger.set_interesting_files(None)
834
merger.show_base = False
835
merger.reprocess = False
836
conflicts = merger.do_merge()
951
843
def merge_modified(self):
952
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
955
typically called after we make some automatic updates to the tree
958
This returns a map of file_id->sha1, containing only files which are
959
still in the working inventory and have that text hash.
962
hashfile = self._transport.get('merge-hashes')
963
except errors.NoSuchFile:
845
hashfile = self._control_files.get('merge-hashes')
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
971
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
985
def mkdir(self, path, file_id=None):
986
"""See MutableTree.mkdir()."""
988
file_id = generate_ids.gen_file_id(os.path.basename(path))
989
os.mkdir(self.abspath(path))
990
self.add(path, file_id, 'directory')
850
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
851
raise MergeModifiedFormatError()
852
except StopIteration:
853
raise MergeModifiedFormatError()
854
for s in RioReader(hashfile):
855
file_id = s.get("file_id")
856
if file_id not in self.inventory:
859
if hash == self.get_file_sha1(file_id):
860
merge_hashes[file_id] = hash
993
863
def get_symlink_target(self, file_id):
994
abspath = self.id2abspath(file_id)
995
target = osutils.readlink(abspath)
999
def subsume(self, other_tree):
1000
def add_children(inventory, entry):
1001
for child_entry in entry.children.values():
1002
inventory._byid[child_entry.file_id] = child_entry
1003
if child_entry.kind == 'directory':
1004
add_children(inventory, child_entry)
1005
if other_tree.get_root_id() == self.get_root_id():
1006
raise errors.BadSubsumeSource(self, other_tree,
1007
'Trees have the same root')
1009
other_tree_path = self.relpath(other_tree.basedir)
1010
except errors.PathNotChild:
1011
raise errors.BadSubsumeSource(self, other_tree,
1012
'Tree is not contained by the other')
1013
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1014
if new_root_parent is None:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Parent directory is not versioned.')
1017
# We need to ensure that the result of a fetch will have a
1018
# versionedfile for the other_tree root, and only fetching into
1019
# RepositoryKnit2 guarantees that.
1020
if not self.branch.repository.supports_rich_root():
1021
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1022
other_tree.lock_tree_write()
1024
new_parents = other_tree.get_parent_ids()
1025
other_root = other_tree.inventory.root
1026
other_root.parent_id = new_root_parent
1027
other_root.name = osutils.basename(other_tree_path)
1028
self.inventory.add(other_root)
1029
add_children(self.inventory, other_root)
1030
self._write_inventory(self.inventory)
1031
# normally we don't want to fetch whole repositories, but i think
1032
# here we really do want to consolidate the whole thing.
1033
for parent_id in other_tree.get_parent_ids():
1034
self.branch.fetch(other_tree.branch, parent_id)
1035
self.add_parent_tree_id(parent_id)
1038
other_tree.bzrdir.retire_bzrdir()
1040
def _setup_directory_is_tree_reference(self):
1041
if self._branch.repository._format.supports_tree_reference:
1042
self._directory_is_tree_reference = \
1043
self._directory_may_be_tree_reference
1045
self._directory_is_tree_reference = \
1046
self._directory_is_never_tree_reference
1048
def _directory_is_never_tree_reference(self, relpath):
1051
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
1053
# it's a tree reference, except that the root of the tree is not
1054
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
# TODO: We could ask all the control formats whether they
1056
# recognize this directory, but at the moment there's no cheap api
1057
# to do that. Since we probably can only nest bzr checkouts and
1058
# they always use this name it's ok for now. -- mbp 20060306
1060
# FIXME: There is an unhandled case here of a subdirectory
1061
# containing .bzr but not a branch; that will probably blow up
1062
# when you try to commit it. It might happen if there is a
1063
# checkout in a subdirectory. This can be avoided by not adding
1066
@needs_tree_write_lock
1067
def extract(self, file_id, format=None):
1068
"""Extract a subtree from this tree.
1070
A new branch will be created, relative to the path for this tree.
1074
segments = osutils.splitpath(path)
1075
transport = self.branch.bzrdir.root_transport
1076
for name in segments:
1077
transport = transport.clone(name)
1078
transport.ensure_base()
1081
sub_path = self.id2path(file_id)
1082
branch_transport = mkdirs(sub_path)
1084
format = self.bzrdir.cloning_metadir()
1085
branch_transport.ensure_base()
1086
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
repo = branch_bzrdir.find_repository()
1089
except errors.NoRepositoryPresent:
1090
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
1093
new_branch = branch_bzrdir.create_branch()
1094
new_branch.pull(self.branch)
1095
for parent_id in self.get_parent_ids():
1096
new_branch.fetch(self.branch, parent_id)
1097
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
if tree_transport.base != branch_transport.base:
1099
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1103
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1105
wt.set_parent_ids(self.get_parent_ids())
1106
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1108
new_root = my_inv[file_id]
1109
my_inv.remove_recursive_id(file_id)
1110
new_root.parent_id = None
1111
child_inv.add(new_root)
1112
self._write_inventory(my_inv)
1113
wt._write_inventory(child_inv)
1116
def _serialize(self, inventory, out_file):
1117
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1120
def _deserialize(selt, in_file):
1121
return xml5.serializer_v5.read_inventory(in_file)
1124
"""Write the in memory inventory to disk."""
1125
# TODO: Maybe this should only write on dirty ?
1126
if self._control_files._lock_mode != 'w':
1127
raise errors.NotWriteLocked(self)
1129
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1133
self._inventory_is_modified = False
1135
def _kind(self, relpath):
1136
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
864
return os.readlink(self.id2abspath(file_id))
866
def file_class(self, filename):
867
if self.path2id(filename):
869
elif self.is_ignored(filename):
874
def list_files(self):
875
"""Recursively list all files as (path, class, kind, id, entry).
1141
877
Lists, but does not descend into unversioned directories.
1142
879
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
882
Skips the control directory.
1149
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
# with it. So callers should be careful to always read_lock the tree.
1151
if not self.is_locked():
1152
raise errors.ObjectNotLocked(self)
1154
inv = self.inventory
1155
if from_dir is None and include_root is True:
1156
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
884
inv = self._inventory
1157
885
# Convert these into local objects to save lookup times
1158
886
pathjoin = osutils.pathjoin
1159
file_kind = self._kind
887
file_kind = osutils.file_kind
1161
889
# transport.base ends in a slash, we want the piece
1162
890
# between the last two slashes
1240
965
except KeyError:
1241
966
yield fp[1:], c, fk, None, TreeEntry()
1244
969
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
972
# But do this child first
973
new_children = os.listdir(fap)
975
new_children = collections.deque(new_children)
976
stack.append((f_ie.file_id, fp, fap, new_children))
977
# Break out of inner loop, so that we start outer loop with child
1257
980
# if we finished all children, pop it off the stack
1260
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
985
def move(self, from_paths, to_name):
1262
986
"""Rename files.
1264
to_dir must exist in the inventory.
1266
If to_dir exists and is a directory, the files are moved into
1267
it, keeping their old names.
1269
Note that to_dir is only the last component of the new name;
988
to_name must exist in the inventory.
990
If to_name exists and is a directory, the files are moved into
991
it, keeping their old names.
993
Note that to_name is only the last component of the new name;
1270
994
this doesn't change the directory.
1272
For each entry in from_paths the move mode will be determined
1275
The first mode moves the file in the filesystem and updates the
1276
inventory. The second mode only updates the inventory without
1277
touching the file on the filesystem. This is the new mode introduced
1280
move uses the second mode if 'after == True' and the target is not
1281
versioned but present in the working tree.
1283
move uses the second mode if 'after == False' and the source is
1284
versioned but no longer in the working tree, and the target is not
1285
versioned but present in the working tree.
1287
move uses the first mode if 'after == False' and the source is
1288
versioned and present in the working tree, and the target is not
1289
versioned and not present in the working tree.
1291
Everything else results in an error.
1293
996
This returns a list of (from_path, to_path) pairs for each
1294
997
entry that is moved.
1299
# check for deprecated use of signature
1301
to_dir = kwargs.get('to_name', None)
1303
raise TypeError('You must supply a target directory')
1305
symbol_versioning.warn('The parameter to_name was deprecated'
1306
' in version 0.13. Use to_dir instead',
1309
# check destination directory
1310
if isinstance(from_paths, basestring):
1000
## TODO: Option to move IDs only
1001
assert not isinstance(from_paths, basestring)
1312
1002
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
1003
to_abs = self.abspath(to_name)
1314
1004
if not isdir(to_abs):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotADirectory(to_abs))
1317
if not self.has_filename(to_dir):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotInWorkingDirectory(to_dir))
1320
to_dir_id = inv.path2id(to_dir)
1321
if to_dir_id is None:
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotVersionedError(path=str(to_dir)))
1005
raise BzrError("destination %r is not a directory" % to_abs)
1006
if not self.has_filename(to_name):
1007
raise BzrError("destination %r not in working directory" % to_abs)
1008
to_dir_id = inv.path2id(to_name)
1009
if to_dir_id is None and to_name != '':
1010
raise BzrError("destination %r is not a versioned directory" % to_name)
1325
1011
to_dir_ie = inv[to_dir_id]
1326
1012
if to_dir_ie.kind != 'directory':
1327
raise errors.BzrMoveFailedError('',to_dir,
1328
errors.NotADirectory(to_abs))
1330
# create rename entries and tuples
1331
for from_rel in from_paths:
1332
from_tail = splitpath(from_rel)[-1]
1333
from_id = inv.path2id(from_rel)
1335
raise errors.BzrMoveFailedError(from_rel,to_dir,
1336
errors.NotVersionedError(path=str(from_rel)))
1338
from_entry = inv[from_id]
1339
from_parent_id = from_entry.parent_id
1340
to_rel = pathjoin(to_dir, from_tail)
1341
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1343
from_tail=from_tail,
1344
from_parent_id=from_parent_id,
1345
to_rel=to_rel, to_tail=from_tail,
1346
to_parent_id=to_dir_id)
1347
rename_entries.append(rename_entry)
1348
rename_tuples.append((from_rel, to_rel))
1350
# determine which move mode to use. checks also for movability
1351
rename_entries = self._determine_mv_mode(rename_entries, after)
1353
original_modified = self._inventory_is_modified
1013
raise BzrError("destination %r is not a directory" % to_abs)
1015
to_idpath = inv.get_idpath(to_dir_id)
1017
for f in from_paths:
1018
if not self.has_filename(f):
1019
raise BzrError("%r does not exist in working tree" % f)
1020
f_id = inv.path2id(f)
1022
raise BzrError("%r is not versioned" % f)
1023
name_tail = splitpath(f)[-1]
1024
dest_path = pathjoin(to_name, name_tail)
1025
if self.has_filename(dest_path):
1026
raise BzrError("destination %r already exists" % dest_path)
1027
if f_id in to_idpath:
1028
raise BzrError("can't move %r to a subdirectory of itself" % f)
1030
# OK, so there's a race here, it's possible that someone will
1031
# create a file in this interval and then the rename might be
1032
# left half-done. But we should have caught most problems.
1033
orig_inv = deepcopy(self.inventory)
1356
self._inventory_is_modified = True
1357
self._move(rename_entries)
1035
for f in from_paths:
1036
name_tail = splitpath(f)[-1]
1037
dest_path = pathjoin(to_name, name_tail)
1038
result.append((f, dest_path))
1039
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1041
osutils.rename(self.abspath(f), self.abspath(dest_path))
1043
raise BzrError("failed to rename %r to %r: %s" %
1044
(f, dest_path, e[1]),
1045
["rename rolled back"])
1359
1047
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
1048
self._set_inventory(orig_inv)
1362
1050
self._write_inventory(inv)
1363
return rename_tuples
1365
def _determine_mv_mode(self, rename_entries, after=False):
1366
"""Determines for each from-to pair if both inventory and working tree
1367
or only the inventory has to be changed.
1369
Also does basic plausability tests.
1371
inv = self.inventory
1373
for rename_entry in rename_entries:
1374
# store to local variables for easier reference
1375
from_rel = rename_entry.from_rel
1376
from_id = rename_entry.from_id
1377
to_rel = rename_entry.to_rel
1378
to_id = inv.path2id(to_rel)
1379
only_change_inv = False
1381
# check the inventory for source and destination
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(from_rel)))
1385
if to_id is not None:
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.AlreadyVersionedError(path=str(to_rel)))
1389
# try to determine the mode for rename (only change inv or change
1390
# inv and file system)
1392
if not self.has_filename(to_rel):
1393
raise errors.BzrMoveFailedError(from_id,to_rel,
1394
errors.NoSuchFile(path=str(to_rel),
1395
extra="New file has not been created yet"))
1396
only_change_inv = True
1397
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1398
only_change_inv = True
1399
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
only_change_inv = False
1401
elif (not self.case_sensitive
1402
and from_rel.lower() == to_rel.lower()
1403
and self.has_filename(from_rel)):
1404
only_change_inv = False
1406
# something is wrong, so lets determine what exactly
1407
if not self.has_filename(from_rel) and \
1408
not self.has_filename(to_rel):
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.PathsDoNotExist(paths=(str(from_rel),
1413
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1414
rename_entry.only_change_inv = only_change_inv
1415
return rename_entries
1417
def _move(self, rename_entries):
1418
"""Moves a list of files.
1420
Depending on the value of the flag 'only_change_inv', the
1421
file will be moved on the file system or not.
1423
inv = self.inventory
1426
for entry in rename_entries:
1428
self._move_entry(entry)
1430
self._rollback_move(moved)
1434
def _rollback_move(self, moved):
1435
"""Try to rollback a previous move in case of an filesystem error."""
1436
inv = self.inventory
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1441
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
entry.from_tail, entry.from_parent_id,
1443
entry.only_change_inv))
1444
except errors.BzrMoveFailedError, e:
1445
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1446
" The working tree is in an inconsistent state."
1447
" Please consider doing a 'bzr revert'."
1448
" Error message is: %s" % e)
1450
def _move_entry(self, entry):
1451
inv = self.inventory
1452
from_rel_abs = self.abspath(entry.from_rel)
1453
to_rel_abs = self.abspath(entry.to_rel)
1454
if from_rel_abs == to_rel_abs:
1455
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1456
"Source and target are identical.")
1458
if not entry.only_change_inv:
1460
osutils.rename(from_rel_abs, to_rel_abs)
1462
raise errors.BzrMoveFailedError(entry.from_rel,
1464
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1466
@needs_tree_write_lock
1467
def rename_one(self, from_rel, to_rel, after=False):
1054
def rename_one(self, from_rel, to_rel):
1468
1055
"""Rename one file.
1470
1057
This can change the directory or the filename or both.
1472
rename_one has several 'modes' to work. First, it can rename a physical
1473
file and change the file_id. That is the normal mode. Second, it can
1474
only change the file_id without touching any physical file. This is
1475
the new mode introduced in version 0.15.
1477
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1478
versioned but present in the working tree.
1480
rename_one uses the second mode if 'after == False' and 'from_rel' is
1481
versioned but no longer in the working tree, and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the first mode if 'after == False' and 'from_rel' is
1485
versioned and present in the working tree, and 'to_rel' is not
1486
versioned and not present in the working tree.
1488
Everything else results in an error.
1490
1059
inv = self.inventory
1493
# create rename entries and tuples
1494
from_tail = splitpath(from_rel)[-1]
1495
from_id = inv.path2id(from_rel)
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1508
from_parent_id = from_entry.parent_id
1060
if not self.has_filename(from_rel):
1061
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1062
if self.has_filename(to_rel):
1063
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1065
file_id = inv.path2id(from_rel)
1067
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1069
entry = inv[file_id]
1070
from_parent = entry.parent_id
1071
from_name = entry.name
1073
if inv.path2id(to_rel):
1074
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1509
1076
to_dir, to_tail = os.path.split(to_rel)
1510
1077
to_dir_id = inv.path2id(to_dir)
1511
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1513
from_tail=from_tail,
1514
from_parent_id=from_parent_id,
1515
to_rel=to_rel, to_tail=to_tail,
1516
to_parent_id=to_dir_id)
1517
rename_entries.append(rename_entry)
1519
# determine which move mode to use. checks also for movability
1520
rename_entries = self._determine_mv_mode(rename_entries, after)
1522
# check if the target changed directory and if the target directory is
1524
if to_dir_id is None:
1525
raise errors.BzrMoveFailedError(from_rel,to_rel,
1526
errors.NotVersionedError(path=str(to_dir)))
1528
# all checks done. now we can continue with our actual work
1529
mutter('rename_one:\n'
1534
' to_dir_id {%s}\n',
1535
from_id, from_rel, to_rel, to_dir, to_dir_id)
1537
self._move(rename_entries)
1078
if to_dir_id is None and to_dir != '':
1079
raise BzrError("can't determine destination directory id for %r" % to_dir)
1081
mutter("rename_one:")
1082
mutter(" file_id {%s}" % file_id)
1083
mutter(" from_rel %r" % from_rel)
1084
mutter(" to_rel %r" % to_rel)
1085
mutter(" to_dir %r" % to_dir)
1086
mutter(" to_dir_id {%s}" % to_dir_id)
1088
inv.rename(file_id, to_dir_id, to_tail)
1090
from_abs = self.abspath(from_rel)
1091
to_abs = self.abspath(to_rel)
1093
osutils.rename(from_abs, to_abs)
1095
inv.rename(file_id, from_parent, from_name)
1096
raise BzrError("failed to rename %r to %r: %s"
1097
% (from_abs, to_abs, e[1]),
1098
["rename rolled back"])
1538
1099
self._write_inventory(inv)
1540
class _RenameEntry(object):
1541
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1542
to_rel, to_tail, to_parent_id, only_change_inv=False):
1543
self.from_rel = from_rel
1544
self.from_id = from_id
1545
self.from_tail = from_tail
1546
self.from_parent_id = from_parent_id
1547
self.to_rel = to_rel
1548
self.to_tail = to_tail
1549
self.to_parent_id = to_parent_id
1550
self.only_change_inv = only_change_inv
1552
1101
@needs_read_lock
1553
1102
def unknowns(self):
1554
1103
"""Return all unknown files.
1714
1303
if ignoreset is not None:
1715
1304
return ignoreset
1717
ignore_globs = set()
1306
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1718
1307
ignore_globs.update(ignores.get_runtime_ignores())
1719
1309
ignore_globs.update(ignores.get_user_ignores())
1720
1311
if self.has_filename(bzrlib.IGNORE_FILENAME):
1721
1312
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1723
1314
ignore_globs.update(ignores.parse_ignore_file(f))
1726
1318
self._ignoreset = ignore_globs
1319
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1727
1320
return ignore_globs
1729
def _flush_ignore_list_cache(self):
1730
"""Resets the cached ignore list to force a cache rebuild."""
1731
self._ignoreset = None
1732
self._ignoreglobster = None
1322
def _get_ignore_rules_as_regex(self):
1323
"""Return a regex of the ignore rules and a mapping dict.
1325
:return: (ignore rules compiled regex, dictionary mapping rule group
1326
indices to original rule.)
1328
if getattr(self, '_ignoreset', None) is None:
1329
self.get_ignore_list()
1330
return self._ignore_regex
1734
1332
def is_ignored(self, filename):
1735
1333
r"""Check whether the filename matches an ignore pattern.
1737
1335
Patterns containing '/' or '\' need to match the whole path;
1738
others match against only the last component. Patterns starting
1739
with '!' are ignore exceptions. Exceptions take precedence
1740
over regular patterns and cause the filename to not be ignored.
1336
others match against only the last component.
1742
1338
If the file is ignored, returns the pattern which caused it to
1743
1339
be ignored, otherwise None. So this can simply be used as a
1744
1340
boolean if desired."""
1745
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1747
return self._ignoreglobster.match(filename)
1342
# TODO: Use '**' to match directories, and other extended
1343
# globbing stuff from cvs/rsync.
1345
# XXX: fnmatch is actually not quite what we want: it's only
1346
# approximately the same as real Unix fnmatch, and doesn't
1347
# treat dotfiles correctly and allows * to match /.
1348
# Eventually it should be replaced with something more
1351
rules = self._get_ignore_rules_as_regex()
1352
for regex, mapping in rules:
1353
match = regex.match(filename)
1354
if match is not None:
1355
# one or more of the groups in mapping will have a non-None
1357
groups = match.groups()
1358
rules = [mapping[group] for group in
1359
mapping if groups[group] is not None]
1749
1363
def kind(self, file_id):
1750
1364
return file_kind(self.id2abspath(file_id))
1752
def stored_kind(self, file_id):
1753
"""See Tree.stored_kind"""
1754
return self.inventory[file_id].kind
1756
def _comparison_data(self, entry, path):
1757
abspath = self.abspath(path)
1759
stat_value = os.lstat(abspath)
1761
if getattr(e, 'errno', None) == errno.ENOENT:
1768
mode = stat_value.st_mode
1769
kind = osutils.file_kind_from_stat_mode(mode)
1770
if not supports_executable():
1771
executable = entry is not None and entry.executable
1773
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1774
return kind, executable, stat_value
1776
def _file_size(self, entry, stat_value):
1777
return stat_value.st_size
1779
1366
def last_revision(self):
1780
"""Return the last revision of the branch for this tree.
1782
This format tree does not support a separate marker for last-revision
1783
compared to the branch.
1785
See MutableTree.last_revision
1367
"""Return the last revision id of this working tree.
1369
In early branch formats this was the same as the branch last_revision,
1370
but that cannot be relied upon - for working tree operations,
1371
always use tree.last_revision(). This returns the left most parent id,
1372
or None if there are no parents.
1374
This was deprecated as of 0.11. Please use get_parent_ids instead.
1787
1376
return self._last_revision()
1789
1378
@needs_read_lock
1790
1379
def _last_revision(self):
1791
1380
"""helper for get_parent_ids."""
1792
return _mod_revision.ensure_null(self.branch.last_revision())
1381
return self.branch.last_revision()
1794
1383
def is_locked(self):
1795
1384
return self._control_files.is_locked()
1797
def _must_be_locked(self):
1798
if not self.is_locked():
1799
raise errors.ObjectNotLocked(self)
1801
1386
def lock_read(self):
1802
"""Lock the tree for reading.
1804
This also locks the branch, and can be unlocked via self.unlock().
1806
:return: A bzrlib.lock.LogicalLockResult.
1808
if not self.is_locked():
1810
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1815
self.branch.unlock()
1818
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1823
if not self.is_locked():
1825
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1387
"""See Branch.lock_read, and WorkingTree.unlock."""
1388
self.branch.lock_read()
1390
return self._control_files.lock_read()
1830
1392
self.branch.unlock()
1833
1395
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1838
if not self.is_locked():
1396
"""See Branch.lock_write, and WorkingTree.unlock."""
1840
1397
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1399
return self._control_files.lock_write()
1845
1401
self.branch.unlock()
1883
1429
self.branch.set_revision_history([new_revision])
1886
def _write_basis_inventory(self, xml):
1887
"""Write the basis inventory XML to the basis-inventory file"""
1888
path = self._basis_inventory_name()
1890
self._transport.put_file(path, sio,
1891
mode=self.bzrdir._get_file_mode())
1893
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
"""Create the text that will be saved in basis-inventory"""
1895
inventory.revision_id = revision_id
1896
return xml7.serializer_v7.write_inventory_to_string(inventory)
1898
1432
def _cache_basis_inventory(self, new_revision):
1899
1433
"""Cache new_revision as the basis inventory."""
1900
1434
# TODO: this should allow the ready-to-use inventory to be passed in,
1901
1435
# as commit already has that ready-to-use [while the format is the
1902
1436
# same, that is].
1904
# this double handles the inventory - unpack and repack -
1438
# this double handles the inventory - unpack and repack -
1905
1439
# but is easier to understand. We can/should put a conditional
1906
1440
# in here based on whether the inventory is in the latest format
1907
1441
# - perhaps we should repack all inventories on a repository
1909
1443
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1444
# xml contains 'revision_id="', then we assume the right
1911
1445
# revision_id is set. We must check for this full string, because a
1912
1446
# root node id can legitimately look like 'revision_id' but cannot
1913
1447
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1915
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1917
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1920
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
self._write_basis_inventory(xml)
1448
xml = self.branch.repository.get_inventory_xml(new_revision)
1449
if not 'revision_id="' in xml.split('\n', 1)[0]:
1450
inv = self.branch.repository.deserialise_inventory(
1452
inv.revision_id = new_revision
1453
xml = xml5.serializer_v5.write_inventory_to_string(inv)
1454
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1455
path = self._basis_inventory_name()
1457
self._control_files.put(path, sio)
1922
1458
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1461
def read_basis_inventory(self):
1926
1462
"""Read the cached basis inventory."""
1927
1463
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1464
return self._control_files.get(path).read()
1930
1466
@needs_read_lock
1931
1467
def read_working_inventory(self):
1932
"""Read the working inventory.
1934
:raises errors.InventoryModified: read_working_inventory will fail
1935
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1938
# XXX: Deprecate this.
1468
"""Read the working inventory."""
1939
1469
# ElementTree does its own conversion from UTF-8, so open in
1941
if self._inventory_is_modified:
1942
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1948
self._set_inventory(result, dirty=False)
1471
result = xml5.serializer_v5.read_inventory(
1472
self._control_files.get('inventory'))
1473
self._set_inventory(result)
1951
@needs_tree_write_lock
1952
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1954
"""Remove nominated files from the working inventory.
1956
:files: File paths relative to the basedir.
1957
:keep_files: If true, the files will also be kept.
1958
:force: Delete files and directories, even if they are changed and
1959
even if the directories are not empty.
1477
def remove(self, files, verbose=False, to_file=None):
1478
"""Remove nominated files from the working inventory..
1480
This does not remove their text. This does not run on XXX on what? RBC
1482
TODO: Refuse to remove modified files unless --force is given?
1484
TODO: Do something useful with directories.
1486
TODO: Should this remove the text or not? Tough call; not
1487
removing may be useful and the user can just use use rm, and
1488
is the opposite of add. Removing it is consistent with most
1489
other tools. Maybe an option.
1491
## TODO: Normalize names
1492
## TODO: Remove nested loops; better scalability
1961
1493
if isinstance(files, basestring):
1962
1494
files = [files]
1967
unknown_nested_files=set()
1969
to_file = sys.stdout
1971
def recurse_directory_to_add_files(directory):
1972
# Recurse directory and add all files
1973
# so we can check if they have changed.
1974
for parent_info, file_infos in\
1975
self.walkdirs(directory):
1976
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1977
# Is it versioned or ignored?
1978
if self.path2id(relpath) or self.is_ignored(relpath):
1979
# Add nested content for deletion.
1980
new_files.add(relpath)
1982
# Files which are not versioned and not ignored
1983
# should be treated as unknown.
1984
unknown_nested_files.add((relpath, None, kind))
1986
for filename in files:
1987
# Get file name into canonical form.
1988
abspath = self.abspath(filename)
1989
filename = self.relpath(abspath)
1990
if len(filename) > 0:
1991
new_files.add(filename)
1992
recurse_directory_to_add_files(filename)
1994
files = list(new_files)
1997
return # nothing to do
1999
# Sort needed to first handle directory content before the directory
2000
files.sort(reverse=True)
2002
# Bail out if we are going to delete files we shouldn't
2003
if not keep_files and not force:
2004
has_changed_files = len(unknown_nested_files) > 0
2005
if not has_changed_files:
2006
for (file_id, path, content_change, versioned, parent_id, name,
2007
kind, executable) in self.iter_changes(self.basis_tree(),
2008
include_unchanged=True, require_versioned=False,
2009
want_unversioned=True, specific_files=files):
2010
if versioned == (False, False):
2011
# The record is unknown ...
2012
if not self.is_ignored(path[1]):
2013
# ... but not ignored
2014
has_changed_files = True
2016
elif content_change and (kind[1] is not None):
2017
# Versioned and changed, but not deleted
2018
has_changed_files = True
2021
if has_changed_files:
2022
# Make delta show ALL applicable changes in error message.
2023
tree_delta = self.changes_from(self.basis_tree(),
2024
require_versioned=False, want_unversioned=True,
2025
specific_files=files)
2026
for unknown_file in unknown_nested_files:
2027
if unknown_file not in tree_delta.unversioned:
2028
tree_delta.unversioned.extend((unknown_file,))
2029
raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
# Build inv_delta and delete files where applicable,
2032
# do this before any modifications to inventory.
1496
inv = self.inventory
1498
# do this before any modifications
2033
1499
for f in files:
2034
fid = self.path2id(f)
1500
fid = inv.path2id(f)
2037
message = "%s is not versioned." % (f,)
2040
# having removed it, it must be either ignored or unknown
2041
if self.is_ignored(f):
2045
# XXX: Really should be a more abstract reporter interface
2046
kind_ch = osutils.kind_marker(self.kind(fid))
2047
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2049
inv_delta.append((f, None, fid, None))
2050
message = "removed %s" % (f,)
2053
abs_path = self.abspath(f)
2054
if osutils.lexists(abs_path):
2055
if (osutils.isdir(abs_path) and
2056
len(os.listdir(abs_path)) > 0):
2058
osutils.rmtree(abs_path)
2060
message = "%s is not an empty directory "\
2061
"and won't be deleted." % (f,)
2063
osutils.delete_any(abs_path)
2064
message = "deleted %s" % (f,)
2065
elif message is not None:
2066
# Only care if we haven't done anything yet.
2067
message = "%s does not exist." % (f,)
2069
# Print only one message (if any) per file.
2070
if message is not None:
2072
self.apply_inventory_delta(inv_delta)
2074
@needs_tree_write_lock
2075
def revert(self, filenames=None, old_tree=None, backups=True,
2076
pb=None, report_changes=False):
1502
# TODO: Perhaps make this just a warning, and continue?
1503
# This tends to happen when
1504
raise NotVersionedError(path=f)
1506
# having remove it, it must be either ignored or unknown
1507
if self.is_ignored(f):
1511
textui.show_status(new_status, inv[fid].kind, f,
1515
self._write_inventory(inv)
1518
def revert(self, filenames, old_tree=None, backups=True,
1519
pb=DummyProgress()):
2077
1520
from bzrlib.conflicts import resolve
2080
symbol_versioning.warn('Using [] to revert all files is deprecated'
2081
' as of bzr 0.91. Please use None (the default) instead.',
2082
DeprecationWarning, stacklevel=2)
2083
1521
if old_tree is None:
2084
basis_tree = self.basis_tree()
2085
basis_tree.lock_read()
2086
old_tree = basis_tree
1522
old_tree = self.basis_tree()
1523
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1524
if not len(filenames):
1525
self.set_parent_ids(self.get_parent_ids()[:1])
2090
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2092
if filenames is None and len(self.get_parent_ids()) > 1:
2094
last_revision = self.last_revision()
2095
if last_revision != _mod_revision.NULL_REVISION:
2096
if basis_tree is None:
2097
basis_tree = self.basis_tree()
2098
basis_tree.lock_read()
2099
parent_trees.append((last_revision, basis_tree))
2100
self.set_parent_trees(parent_trees)
2103
resolve(self, filenames, ignore_misses=True, recursive=True)
2105
if basis_tree is not None:
1528
resolve(self, filenames, ignore_misses=True)
2107
1529
return conflicts
2109
def revision_tree(self, revision_id):
2110
"""See Tree.revision_tree.
2112
WorkingTree can supply revision_trees for the basis revision only
2113
because there is only one cached inventory in the bzr directory.
2115
if revision_id == self.last_revision():
2117
xml = self.read_basis_inventory()
2118
except errors.NoSuchFile:
2122
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2123
# dont use the repository revision_tree api because we want
2124
# to supply the inventory.
2125
if inv.revision_id == revision_id:
2126
return revisiontree.RevisionTree(self.branch.repository,
2128
except errors.BadInventoryFormat:
2130
# raise if there was no inventory, or if we read the wrong inventory.
2131
raise errors.NoSuchRevisionInTree(self, revision_id)
2133
1531
# XXX: This method should be deprecated in favour of taking in a proper
2134
1532
# new Inventory object.
2135
@needs_tree_write_lock
2136
1534
def set_inventory(self, new_inventory_list):
2137
1535
from bzrlib.inventory import (Inventory,
2138
1536
InventoryDirectory,
2141
1540
inv = Inventory(self.get_root_id())
2151
1550
elif kind == 'symlink':
2152
1551
inv.add(InventoryLink(file_id, name, parent))
2154
raise errors.BzrError("unknown kind %r" % kind)
1553
raise BzrError("unknown kind %r" % kind)
2155
1554
self._write_inventory(inv)
2157
@needs_tree_write_lock
2158
1557
def set_root_id(self, file_id):
2159
1558
"""Set the root id for this tree."""
2163
'WorkingTree.set_root_id with fileid=None')
2164
file_id = osutils.safe_file_id(file_id)
2165
self._set_root_id(file_id)
2167
def _set_root_id(self, file_id):
2168
"""Set the root id for this tree, in a format specific manner.
2170
:param file_id: The file id to assign to the root. It must not be
2171
present in the current inventory or an error will occur. It must
2172
not be None, but rather a valid file id.
2174
inv = self._inventory
1559
inv = self.read_working_inventory()
2175
1560
orig_root_id = inv.root.file_id
2176
# TODO: it might be nice to exit early if there was nothing
2177
# to do, saving us from trigger a sync on unlock.
2178
self._inventory_is_modified = True
2179
# we preserve the root inventory entry object, but
2180
# unlinkit from the byid index
2181
1561
del inv._byid[inv.root.file_id]
2182
1562
inv.root.file_id = file_id
2183
# and link it into the index with the new changed id.
2184
1563
inv._byid[inv.root.file_id] = inv.root
2185
# and finally update all children to reference the new id.
2186
# XXX: this should be safe to just look at the root.children
2187
# list, not the WHOLE INVENTORY.
2188
1564
for fid in inv:
2189
1565
entry = inv[fid]
2190
1566
if entry.parent_id == orig_root_id:
2191
1567
entry.parent_id = inv.root.file_id
1568
self._write_inventory(inv)
2193
1570
def unlock(self):
2194
1571
"""See Branch.unlock.
2196
1573
WorkingTree locking just uses the Branch locking facilities.
2197
1574
This is current because all working trees have an embedded branch
2198
1575
within them. IF in the future, we were to make branch data shareable
2199
between multiple working trees, i.e. via shared storage, then we
1576
between multiple working trees, i.e. via shared storage, then we
2200
1577
would probably want to lock both the local tree, and the branch.
2202
1579
raise NotImplementedError(self.unlock)
2206
def update(self, change_reporter=None, possible_transports=None,
2207
revision=None, old_tip=_marker):
2208
1583
"""Update a working tree along its branch.
2210
This will update the branch if its bound too, which means we have
2211
multiple trees involved:
2213
- The new basis tree of the master.
2214
- The old basis tree of the branch.
2215
- The old basis tree of the working tree.
2216
- The current working tree state.
2218
Pathologically, all three may be different, and non-ancestors of each
2219
other. Conceptually we want to:
2221
- Preserve the wt.basis->wt.state changes
2222
- Transform the wt.basis to the new master basis.
2223
- Apply a merge of the old branch basis to get any 'local' changes from
2225
- Restore the wt.basis->wt.state changes.
1585
This will update the branch if its bound too, which means we have multiple trees involved:
1586
The new basis tree of the master.
1587
The old basis tree of the branch.
1588
The old basis tree of the working tree.
1589
The current working tree state.
1590
pathologically all three may be different, and non ancestors of each other.
1591
Conceptually we want to:
1592
Preserve the wt.basis->wt.state changes
1593
Transform the wt.basis to the new master basis.
1594
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1595
Restore the wt.basis->wt.state changes.
2227
1597
There isn't a single operation at the moment to do that, so we:
2228
- Merge current state -> basis tree of the master w.r.t. the old tree
2230
- Do a 'normal' merge of the old branch basis if it is relevant.
2232
:param revision: The target revision to update to. Must be in the
2234
:param old_tip: If branch.update() has already been run, the value it
2235
returned (old tip of the branch or None). _marker is used
2238
if self.branch.get_bound_location() is not None:
2240
update_branch = (old_tip is self._marker)
2242
self.lock_tree_write()
2243
update_branch = False
2246
old_tip = self.branch.update(possible_transports)
2248
if old_tip is self._marker:
2250
return self._update_tree(old_tip, change_reporter, revision)
2254
@needs_tree_write_lock
2255
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2256
"""Update a tree to the master branch.
2258
:param old_tip: if supplied, the previous tip revision the branch,
2259
before it was changed to the master branch's tip.
1598
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1599
Do a 'normal' merge of the old branch basis if it is relevant.
1601
old_tip = self.branch.update()
2261
1602
# here if old_tip is not None, it is the old tip of the branch before
2262
1603
# it was updated from the master branch. This should become a pending
2263
1604
# merge in the working tree to preserve the user existing work. we
2264
1605
# cant set that until we update the working trees last revision to be
2265
1606
# one from the new branch, because it will just get absorbed by the
2266
1607
# parent de-duplication logic.
2268
1609
# We MUST save it even if an error occurs, because otherwise the users
2269
1610
# local work is unreferenced and will appear to have been lost.
2273
1614
last_rev = self.get_parent_ids()[0]
2274
1615
except IndexError:
2275
last_rev = _mod_revision.NULL_REVISION
2276
if revision is None:
2277
revision = self.branch.last_revision()
2279
old_tip = old_tip or _mod_revision.NULL_REVISION
2281
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
# the branch we are bound to was updated
2283
# merge those changes in first
2284
base_tree = self.basis_tree()
2285
other_tree = self.branch.repository.revision_tree(old_tip)
2286
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
base_tree, this_tree=self,
2288
change_reporter=change_reporter)
2290
self.add_parent_tree((old_tip, other_tree))
2291
trace.note('Rerun update after fixing the conflicts.')
2294
if last_rev != _mod_revision.ensure_null(revision):
2295
# the working tree is up to date with the branch
2296
# we can merge the specified revision from master
2297
to_tree = self.branch.repository.revision_tree(revision)
2298
to_root_id = to_tree.get_root_id()
1617
if last_rev != self.branch.last_revision():
1618
# merge tree state up to new branch tip.
2300
1619
basis = self.basis_tree()
2303
if (basis.inventory.root is None
2304
or basis.inventory.root.file_id != to_root_id):
2305
self.set_root_id(to_root_id)
2310
# determine the branch point
2311
graph = self.branch.repository.get_graph()
2312
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
change_reporter=change_reporter)
2319
self.set_last_revision(revision)
1620
to_tree = self.branch.basis_tree()
1621
result += merge.merge_inner(
2320
1626
# TODO - dedup parents list with things merged by pull ?
2321
1627
# reuse the tree we've updated to to set the basis:
2322
parent_trees = [(revision, to_tree)]
1628
parent_trees = [(self.branch.last_revision(), to_tree)]
2323
1629
merges = self.get_parent_ids()[1:]
2324
1630
# Ideally we ask the tree for the trees here, that way the working
2325
# tree can decide whether to give us the entire tree or give us a
1631
# tree can decide whether to give us teh entire tree or give us a
2326
1632
# lazy initialised tree. dirstate for instance will have the trees
2327
1633
# in ram already, whereas a last-revision + basis-inventory tree
2328
1634
# will not, but also does not need them when setting parents.
2329
1635
for parent in merges:
2330
1636
parent_trees.append(
2331
1637
(parent, self.branch.repository.revision_tree(parent)))
2332
if not _mod_revision.is_null(old_tip):
1638
if old_tip is not None:
2333
1639
parent_trees.append(
2334
1640
(old_tip, self.branch.repository.revision_tree(old_tip)))
2335
1641
self.set_parent_trees(parent_trees)
2336
1642
last_rev = parent_trees[0][0]
2339
def _write_hashcache_if_dirty(self):
2340
"""Write out the hashcache if it is dirty."""
2341
if self._hashcache.needs_write:
1644
# the working tree had the same last-revision as the master
1645
# branch did. We may still have pivot local work from the local
1646
# branch into old_tip:
1647
if old_tip is not None:
1648
self.add_parent_tree_id(old_tip)
1649
if old_tip and old_tip != last_rev:
1650
# our last revision was not the prior branch last revision
1651
# and we have converted that last revision to a pending merge.
1652
# base is somewhere between the branch tip now
1653
# and the now pending merge
1654
from bzrlib.revision import common_ancestor
2343
self._hashcache.write()
2345
if e.errno not in (errno.EPERM, errno.EACCES):
2347
# TODO: jam 20061219 Should this be a warning? A single line
2348
# warning might be sufficient to let the user know what
2350
mutter('Could not write hashcache for %s\nError: %s',
2351
self._hashcache.cache_file_name(), e)
1656
base_rev_id = common_ancestor(self.branch.last_revision(),
1658
self.branch.repository)
1659
except errors.NoCommonAncestor:
1661
base_tree = self.branch.repository.revision_tree(base_rev_id)
1662
other_tree = self.branch.repository.revision_tree(old_tip)
1663
result += merge.merge_inner(
2353
@needs_tree_write_lock
2354
1671
def _write_inventory(self, inv):
2355
1672
"""Write inventory as the current inventory."""
2356
self._set_inventory(inv, dirty=True)
1674
xml5.serializer_v5.write_inventory(inv, sio)
1676
self._control_files.put('inventory', sio)
1677
self._set_inventory(inv)
1678
mutter('wrote working inventory')
2359
1680
def set_conflicts(self, arg):
2360
raise errors.UnsupportedOperation(self.set_conflicts, self)
1681
raise UnsupportedOperation(self.set_conflicts, self)
2362
1683
def add_conflicts(self, arg):
2363
raise errors.UnsupportedOperation(self.add_conflicts, self)
1684
raise UnsupportedOperation(self.add_conflicts, self)
2365
1686
@needs_read_lock
2366
1687
def conflicts(self):
2388
1709
file_id=self.path2id(conflicted)))
2389
1710
return conflicts
2391
def walkdirs(self, prefix=""):
2392
"""Walk the directories of this tree.
2394
returns a generator which yields items in the form:
2395
((curren_directory_path, fileid),
2396
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2399
This API returns a generator, which is only valid during the current
2400
tree transaction - within a single lock_read or lock_write duration.
2402
If the tree is not locked, it may cause an error to be raised,
2403
depending on the tree implementation.
2405
disk_top = self.abspath(prefix)
2406
if disk_top.endswith('/'):
2407
disk_top = disk_top[:-1]
2408
top_strip_len = len(disk_top) + 1
2409
inventory_iterator = self._walkdirs(prefix)
2410
disk_iterator = osutils.walkdirs(disk_top, prefix)
2412
current_disk = disk_iterator.next()
2413
disk_finished = False
2415
if not (e.errno == errno.ENOENT or
2416
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2419
disk_finished = True
2421
current_inv = inventory_iterator.next()
2422
inv_finished = False
2423
except StopIteration:
2426
while not inv_finished or not disk_finished:
2428
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2429
cur_disk_dir_content) = current_disk
2431
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2432
cur_disk_dir_content) = ((None, None), None)
2433
if not disk_finished:
2434
# strip out .bzr dirs
2435
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2436
len(cur_disk_dir_content) > 0):
2437
# osutils.walkdirs can be made nicer -
2438
# yield the path-from-prefix rather than the pathjoined
2440
bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
if (bzrdir_loc < len(cur_disk_dir_content)
2443
and self.bzrdir.is_control_filename(
2444
cur_disk_dir_content[bzrdir_loc][0])):
2445
# we dont yield the contents of, or, .bzr itself.
2446
del cur_disk_dir_content[bzrdir_loc]
2448
# everything is unknown
2451
# everything is missing
2454
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2456
# disk is before inventory - unknown
2457
dirblock = [(relpath, basename, kind, stat, None, None) for
2458
relpath, basename, kind, stat, top_path in
2459
cur_disk_dir_content]
2460
yield (cur_disk_dir_relpath, None), dirblock
2462
current_disk = disk_iterator.next()
2463
except StopIteration:
2464
disk_finished = True
2466
# inventory is before disk - missing.
2467
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2468
for relpath, basename, dkind, stat, fileid, kind in
2470
yield (current_inv[0][0], current_inv[0][1]), dirblock
2472
current_inv = inventory_iterator.next()
2473
except StopIteration:
2476
# versioned present directory
2477
# merge the inventory and disk data together
2479
for relpath, subiterator in itertools.groupby(sorted(
2480
current_inv[1] + cur_disk_dir_content,
2481
key=operator.itemgetter(0)), operator.itemgetter(1)):
2482
path_elements = list(subiterator)
2483
if len(path_elements) == 2:
2484
inv_row, disk_row = path_elements
2485
# versioned, present file
2486
dirblock.append((inv_row[0],
2487
inv_row[1], disk_row[2],
2488
disk_row[3], inv_row[4],
2490
elif len(path_elements[0]) == 5:
2492
dirblock.append((path_elements[0][0],
2493
path_elements[0][1], path_elements[0][2],
2494
path_elements[0][3], None, None))
2495
elif len(path_elements[0]) == 6:
2496
# versioned, absent file.
2497
dirblock.append((path_elements[0][0],
2498
path_elements[0][1], 'unknown', None,
2499
path_elements[0][4], path_elements[0][5]))
2501
raise NotImplementedError('unreachable code')
2502
yield current_inv[0], dirblock
2504
current_inv = inventory_iterator.next()
2505
except StopIteration:
2508
current_disk = disk_iterator.next()
2509
except StopIteration:
2510
disk_finished = True
2512
def _walkdirs(self, prefix=""):
2513
"""Walk the directories of this tree.
2515
:prefix: is used as the directrory to start with.
2516
returns a generator which yields items in the form:
2517
((curren_directory_path, fileid),
2518
[(file1_path, file1_name, file1_kind, None, file1_id,
2521
_directory = 'directory'
2522
# get the root in the inventory
2523
inv = self.inventory
2524
top_id = inv.path2id(prefix)
2528
pending = [(prefix, '', _directory, None, top_id, None)]
2531
currentdir = pending.pop()
2532
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2533
top_id = currentdir[4]
2535
relroot = currentdir[0] + '/'
2538
# FIXME: stash the node in pending
2540
if entry.kind == 'directory':
2541
for name, child in entry.sorted_children():
2542
dirblock.append((relroot + name, name, child.kind, None,
2543
child.file_id, child.kind
2545
yield (currentdir[0], entry.file_id), dirblock
2546
# push the user specified dirs from dirblock
2547
for dir in reversed(dirblock):
2548
if dir[2] == _directory:
2551
@needs_tree_write_lock
2552
def auto_resolve(self):
2553
"""Automatically resolve text conflicts according to contents.
2555
Only text conflicts are auto_resolvable. Files with no conflict markers
2556
are considered 'resolved', because bzr always puts conflict markers
2557
into files that have text conflicts. The corresponding .THIS .BASE and
2558
.OTHER files are deleted, as per 'resolve'.
2559
:return: a tuple of ConflictLists: (un_resolved, resolved).
2561
un_resolved = _mod_conflicts.ConflictList()
2562
resolved = _mod_conflicts.ConflictList()
2563
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2564
for conflict in self.conflicts():
2565
if (conflict.typestring != 'text conflict' or
2566
self.kind(conflict.file_id) != 'file'):
2567
un_resolved.append(conflict)
2569
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2571
for line in my_file:
2572
if conflict_re.search(line):
2573
un_resolved.append(conflict)
2576
resolved.append(conflict)
2579
resolved.remove_files(self)
2580
self.set_conflicts(un_resolved)
2581
return un_resolved, resolved
2584
def _check(self, references):
2585
"""Check the tree for consistency.
2587
:param references: A dict with keys matching the items returned by
2588
self._get_check_refs(), and values from looking those keys up in
2591
tree_basis = self.basis_tree()
2592
tree_basis.lock_read()
2594
repo_basis = references[('trees', self.last_revision())]
2595
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2596
raise errors.BzrCheckError(
2597
"Mismatched basis inventory content.")
2602
def _validate(self):
2603
"""Validate internal structures.
2605
This is meant mostly for the test suite. To give it a chance to detect
2606
corruption after actions have occurred. The default implementation is a
2609
:return: None. An exception should be raised if there is an error.
2613
def _get_rules_searcher(self, default_searcher):
2614
"""See Tree._get_rules_searcher."""
2615
if self._rules_searcher is None:
2616
self._rules_searcher = super(WorkingTree,
2617
self)._get_rules_searcher(default_searcher)
2618
return self._rules_searcher
2620
def get_shelf_manager(self):
2621
"""Return the ShelfManager for this WorkingTree."""
2622
from bzrlib.shelf import ShelfManager
2623
return ShelfManager(self, self._transport)
2626
1713
class WorkingTree2(WorkingTree):
2627
1714
"""This is the Format 2 working tree.
2629
This was the first weave based working tree.
1716
This was the first weave based working tree.
2630
1717
- uses os locks for locking.
2631
1718
- uses the branch last-revision.
2634
def __init__(self, *args, **kwargs):
2635
super(WorkingTree2, self).__init__(*args, **kwargs)
2636
# WorkingTree2 has more of a constraint that self._inventory must
2637
# exist. Because this is an older format, we don't mind the overhead
2638
# caused by the extra computation here.
2640
# Newer WorkingTree's should only have self._inventory set when they
2642
if self._inventory is None:
2643
self.read_working_inventory()
2645
def _get_check_refs(self):
2646
"""Return the references needed to perform a check of this tree."""
2647
return [('trees', self.last_revision())]
2649
def lock_tree_write(self):
2650
"""See WorkingTree.lock_tree_write().
2652
In Format2 WorkingTrees we have a single lock for the branch and tree
2653
so lock_tree_write() degrades to lock_write().
2655
:return: An object with an unlock method which will release the lock
2658
self.branch.lock_write()
2660
self._control_files.lock_write()
2663
self.branch.unlock()
2666
1721
def unlock(self):
2667
# do non-implementation specific cleanup
2670
1722
# we share control files:
2671
if self._control_files._lock_count == 3:
2672
# _inventory_is_modified is always False during a read lock.
2673
if self._inventory_is_modified:
2675
self._write_hashcache_if_dirty()
1723
if self._hashcache.needs_write and self._control_files._lock_count==3:
1724
self._hashcache.write()
2677
1725
# reverse order of locking.
2679
1727
return self._control_files.unlock()
2854
1885
def unregister_format(klass, format):
1886
assert klass._formats[format.get_format_string()] is format
2855
1887
del klass._formats[format.get_format_string()]
2858
1891
class WorkingTreeFormat2(WorkingTreeFormat):
2859
"""The second working tree format.
1892
"""The second working tree format.
2861
1894
This format modified the hash cache from the format 1 hash cache.
2864
upgrade_recommended = True
2866
1897
def get_format_description(self):
2867
1898
"""See WorkingTreeFormat.get_format_description()."""
2868
1899
return "Working tree format 2"
2870
def _stub_initialize_on_transport(self, transport, file_mode):
2871
"""Workaround: create control files for a remote working tree.
1901
def stub_initialize_remote(self, control_files):
1902
"""As a special workaround create critical control files for a remote working tree
2873
1904
This ensures that it can later be updated and dealt with locally,
2874
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1905
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2875
1906
no working tree. (See bug #43064).
2877
1908
sio = StringIO()
2878
inv = inventory.Inventory()
2879
xml5.serializer_v5.write_inventory(inv, sio, working=True)
1910
xml5.serializer_v5.write_inventory(inv, sio)
2881
transport.put_file('inventory', sio, file_mode)
2882
transport.put_bytes('pending-merges', '', file_mode)
2884
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2885
accelerator_tree=None, hardlink=False):
1912
control_files.put('inventory', sio)
1914
control_files.put_utf8('pending-merges', '')
1917
def initialize(self, a_bzrdir, revision_id=None):
2886
1918
"""See WorkingTreeFormat.initialize()."""
2887
1919
if not isinstance(a_bzrdir.transport, LocalTransport):
2888
1920
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2889
if from_branch is not None:
2890
branch = from_branch
2892
branch = a_bzrdir.open_branch()
2893
if revision_id is None:
2894
revision_id = _mod_revision.ensure_null(branch.last_revision())
2897
branch.generate_revision_history(revision_id)
2900
inv = inventory.Inventory()
1921
branch = a_bzrdir.open_branch()
1922
if revision_id is not None:
1925
revision_history = branch.revision_history()
1927
position = revision_history.index(revision_id)
1929
raise errors.NoSuchRevision(branch, revision_id)
1930
branch.set_revision_history(revision_history[:position + 1])
1933
revision = branch.last_revision()
2901
1935
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
1938
_internal=True,
2906
1940
_bzrdir=a_bzrdir)
2907
basis_tree = branch.repository.revision_tree(revision_id)
2908
if basis_tree.inventory.root is not None:
2909
wt.set_root_id(basis_tree.get_root_id())
2910
# set the parent list and cache the basis tree.
2911
if _mod_revision.is_null(revision_id):
2914
parent_trees = [(revision_id, basis_tree)]
2915
wt.set_parent_trees(parent_trees)
1941
wt._write_inventory(inv)
1942
wt.set_root_id(inv.root.file_id)
1943
basis_tree = branch.repository.revision_tree(revision)
1944
wt.set_parent_trees([(revision, basis_tree)])
2916
1945
transform.build_tree(basis_tree, wt)
added
removed
bzrlib/workingtree.py
