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)
39
33
from cStringIO import StringIO
43
37
from bzrlib.lazy_import import lazy_import
44
38
lazy_import(globals(), """
39
from bisect import bisect_left
46
from copy import deepcopy
54
48
from bzrlib import (
56
51
conflicts as _mod_conflicts,
60
revision as _mod_revision,
66
69
import bzrlib.branch
67
70
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
from bzrlib import symbol_versioning
71
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
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
80
from bzrlib.lockable_files import LockableFiles
84
81
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
85
from bzrlib.osutils import (
95
93
supports_executable,
95
from bzrlib.filters import filtered_input_file
97
96
from bzrlib.trace import mutter, note
98
97
from bzrlib.transport.local import LocalTransport
100
from bzrlib.progress import DummyProgress, ProgressPhase
101
from bzrlib.revision import NULL_REVISION
98
from bzrlib.revision import CURRENT_REVISION
102
99
from bzrlib.rio import RioReader, rio_file, Stanza
103
from bzrlib.symbol_versioning import (deprecated_passed,
106
DEPRECATED_PARAMETER,
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
112
106
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
113
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
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')
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
166
115
class TreeEntry(object):
167
116
"""An entry that implements the minimum interface used by commands.
169
This needs further inspection, it may be better to have
118
This needs further inspection, it may be better to have
170
119
InventoryEntries without ids - though that seems wrong. For now,
171
120
this is a parallel hierarchy to InventoryEntry, and needs to become
172
121
one of several things: decorates to that hierarchy, children of, or
410
411
# no parents, return an empty revision tree.
411
412
# in the future this should return the tree for
412
413
# 'empty:' - the implicit root empty tree.
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,
414
return self.branch.repository.revision_tree(
415
_mod_revision.NULL_REVISION)
417
return self.revision_tree(revision_id)
418
except errors.NoSuchRevision:
424
420
# No cached copy available, retrieve from the repository.
425
421
# FIXME? RBC 20060403 should we cache the inventory locally
426
422
# at this point ?
428
424
return self.branch.repository.revision_tree(revision_id)
429
except errors.RevisionNotPresent:
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
430
426
# the basis tree *may* be a ghost or a low level error may have
431
# occured. If the revision is present, its a problem, if its not
427
# occurred. If the revision is present, its a problem, if its not
433
429
if self.branch.repository.has_revision(revision_id):
435
431
# the basis tree is a ghost so return an empty tree.
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)
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
476
438
def relpath(self, path):
477
439
"""Return the local path portion from a given path.
479
The path may be absolute or relative. If its a relative path it is
441
The path may be absolute or relative. If its a relative path it is
480
442
interpreted relative to the python current working directory.
482
444
return osutils.relpath(self.basedir, path)
484
446
def has_filename(self, filename):
485
447
return osutils.lexists(self.abspath(filename))
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')
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
"""See Tree.annotate_iter
488
This implementation will use the basis tree implementation if possible.
489
Lines not in the basis are attributed to CURRENT_REVISION
491
If there are pending merges, lines added by those merges will be
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
496
539
def get_parent_ids(self):
497
540
"""See Tree.get_parent_ids.
499
542
This implementation reads the pending merges list and last_revision
500
543
value and uses that to decide what the parents list should be.
502
last_rev = self._last_revision()
545
last_rev = _mod_revision.ensure_null(self._last_revision())
546
if _mod_revision.NULL_REVISION == last_rev:
506
549
parents = [last_rev]
508
merges_file = self._control_files.get_utf8('pending-merges')
551
merges_bytes = self._transport.get_bytes('pending-merges')
552
except errors.NoSuchFile:
512
for l in merges_file.readlines():
513
parents.append(l.rstrip('\n'))
555
for l in osutils.split_lines(merges_bytes):
556
revision_id = l.rstrip('\n')
557
parents.append(revision_id)
516
561
def get_root_id(self):
517
562
"""Return the id of this trees root"""
518
inv = self.read_working_inventory()
519
return inv.root.file_id
563
return self._inventory.root.file_id
521
565
def _get_store_filename(self, file_id):
522
566
## XXX: badly named; this is not in the store at all
523
567
return self.abspath(self.id2path(file_id))
526
def clone(self, to_bzrdir, revision_id=None, basis=None):
570
def clone(self, to_bzrdir, revision_id=None):
527
571
"""Duplicate this working tree into to_bzr, including all state.
529
573
Specifically modified files are kept as modified, but
530
574
ignored and unknown files are discarded.
532
576
If you want to make a new line of development, see bzrdir.sprout()
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
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
537
581
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.
543
583
# assumes the target bzr dir format is compatible.
544
result = self._format.initialize(to_bzrdir)
584
result = to_bzrdir.create_workingtree()
545
585
self.copy_content_into(result, revision_id)
549
589
def copy_content_into(self, tree, revision_id=None):
550
590
"""Copy the current content and user files of this tree into tree."""
591
tree.set_root_id(self.get_root_id())
551
592
if revision_id is None:
552
593
merge.transform_tree(tree, self)
591
616
__contains__ = has_id
593
618
def get_file_size(self, file_id):
594
return os.path.getsize(self.id2abspath(file_id))
619
"""See Tree.get_file_size"""
620
# XXX: this returns the on-disk size; it should probably return the
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
597
def get_file_sha1(self, file_id, path=None):
631
def get_file_sha1(self, file_id, path=None, stat_value=None):
599
633
path = self._inventory.id2path(file_id)
600
return self._hashcache.get_sha1(path)
634
return self._hashcache.get_sha1(path, stat_value)
602
636
def get_file_mtime(self, file_id, path=None):
604
path = self._inventory.id2path(file_id)
638
path = self.inventory.id2path(file_id)
605
639
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
607
653
if not supports_executable():
608
654
def is_executable(self, file_id, path=None):
609
655
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
611
660
def is_executable(self, file_id, path=None):
613
path = self._inventory.id2path(file_id)
662
path = self.id2path(file_id)
614
663
mode = os.lstat(self.abspath(path)).st_mode
615
664
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
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.
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
@needs_tree_write_lock
670
def _add(self, files, ids, kinds):
671
"""See MutableTree._add."""
640
672
# TODO: Re-adding a file that is removed in the working copy
641
673
# should probably put it back with the previous ID.
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)
674
# the read and write working inventory should not occur in this
675
# function - they should be part of lock_write and unlock.
677
for f, file_id, kind in zip(files, ids, kinds):
671
678
if file_id is None:
672
679
inv.add_path(f, kind=kind)
674
681
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
676
self._write_inventory(inv)
684
@needs_tree_write_lock
685
def _gather_kinds(self, files, kinds):
686
"""See MutableTree._gather_kinds."""
687
for pos, f in enumerate(files):
688
if kinds[pos] is None:
689
fullpath = normpath(self.abspath(f))
691
kinds[pos] = file_kind(fullpath)
693
if e.errno == errno.ENOENT:
694
raise errors.NoSuchFile(fullpath)
678
696
@needs_write_lock
679
697
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
728
746
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
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:]
748
def path_content_summary(self, path, _lstat=os.lstat,
749
_mapper=osutils.file_kind_from_stat_mode):
750
"""See Tree.path_content_summary."""
751
abspath = self.abspath(path)
753
stat_result = _lstat(abspath)
755
if getattr(e, 'errno', None) == errno.ENOENT:
757
return ('missing', None, None, None)
758
# propagate other errors
760
kind = _mapper(stat_result.st_mode)
762
return self._file_content_summary(path, stat_result)
763
elif kind == 'directory':
764
# perhaps it looks like a plain directory, but it's really a
766
if self._directory_is_tree_reference(path):
767
kind = 'tree-reference'
768
return kind, None, None, None
769
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
773
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
return ('file', size, executable, self._sha_from_stat(
782
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
"""Common ghost checking functionality from set_parent_*.
785
This checks that the left hand-parent exists if there are any
788
if len(revision_ids) > 0:
789
leftmost_id = revision_ids[0]
790
if (not allow_leftmost_as_ghost and not
791
self.branch.repository.has_revision(leftmost_id)):
792
raise errors.GhostRevisionUnusableHere(leftmost_id)
794
def _set_merges_from_parent_ids(self, parent_ids):
795
merges = parent_ids[1:]
796
self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
mode=self.bzrdir._get_file_mode())
799
def _filter_parent_ids_by_ancestry(self, revision_ids):
800
"""Check that all merged revisions are proper 'heads'.
802
This will always return the first revision_id, and any merged revisions
805
if len(revision_ids) == 0:
807
graph = self.branch.repository.get_graph()
808
heads = graph.heads(revision_ids)
809
new_revision_ids = revision_ids[:1]
810
for revision_id in revision_ids[1:]:
811
if revision_id in heads and revision_id not in new_revision_ids:
812
new_revision_ids.append(revision_id)
813
if new_revision_ids != revision_ids:
814
trace.mutter('requested to set revision_ids = %s,'
815
' but filtered to %s', revision_ids, new_revision_ids)
816
return new_revision_ids
818
@needs_tree_write_lock
744
819
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
745
820
"""Set the parent ids to revision_ids.
747
822
See also set_parent_trees. This api will try to retrieve the tree data
748
823
for each element of revision_ids from the trees repository. If you have
749
824
tree data already available, it is more efficient to use
753
828
:param revision_ids: The revision_ids to set as the parent ids of this
754
829
working tree. Any of these may be ghosts.
831
self._check_parents_for_ghosts(revision_ids,
832
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
756
838
if len(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)
839
self.set_last_revision(revision_ids[0])
763
self.set_last_revision(None)
764
merges = revision_ids[1:]
765
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
841
self.set_last_revision(_mod_revision.NULL_REVISION)
843
self._set_merges_from_parent_ids(revision_ids)
845
@needs_tree_write_lock
768
846
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
769
"""Set the parents of the working tree.
847
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
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],
852
self._check_parents_for_ghosts(parent_ids,
778
853
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
859
leftmost_parent_tree = None
861
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
863
if self._change_last_revision(leftmost_parent_id):
864
if leftmost_parent_tree is None:
865
# If we don't have a tree, fall back to reading the
866
# parent tree from the repository.
867
self._cache_basis_inventory(leftmost_parent_id)
869
inv = leftmost_parent_tree.inventory
870
xml = self._create_basis_xml_from_inventory(
871
leftmost_parent_id, inv)
872
self._write_basis_inventory(xml)
873
self._set_merges_from_parent_ids(parent_ids)
875
@needs_tree_write_lock
781
876
def set_pending_merges(self, rev_list):
782
877
parents = self.get_parent_ids()
783
878
leftmost = parents[:1]
784
879
new_parents = leftmost + rev_list
785
880
self.set_parent_ids(new_parents)
882
@needs_tree_write_lock
788
883
def set_merge_modified(self, modified_hashes):
789
884
def iter_stanzas():
790
885
for file_id, hash in modified_hashes.iteritems():
791
yield Stanza(file_id=file_id, hash=hash)
886
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
792
887
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
889
def _sha_from_stat(self, path, stat_result):
890
"""Get a sha digest from the tree's stat cache.
892
The default implementation assumes no stat cache is present.
894
:param path: The path.
895
:param stat_result: The stat result being looked up.
795
899
def _put_rio(self, filename, stanzas, header):
900
self._must_be_locked()
796
901
my_file = rio_file(stanzas, header)
797
self._control_files.put(filename, my_file)
902
self._transport.put_file(filename, my_file,
903
mode=self.bzrdir._get_file_mode())
800
def merge_from_branch(self, branch, to_revision=None):
905
@needs_write_lock # because merge pulls data into the branch.
906
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
merge_type=None, force=False):
801
908
"""Merge from a branch into this working tree.
803
910
:param branch: The branch to merge from.
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
911
:param to_revision: If non-None, the merge will merge to to_revision,
912
but not beyond it. to_revision does not need to be in the history
913
of the branch when it is supplied. If None, to_revision defaults to
807
914
branch.last_revision().
809
916
from bzrlib.merge import Merger, Merge3Merger
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()
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
828
932
merger.find_base()
829
if merger.base_rev_id == merger.other_rev_id:
830
raise errors.PointlessMerge
831
merger.backup_files = False
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
832
939
merger.merge_type = Merge3Merger
833
merger.set_interesting_files(None)
834
merger.show_base = False
835
merger.reprocess = False
836
conflicts = merger.do_merge()
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
843
950
def merge_modified(self):
951
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
954
typically called after we make some automatic updates to the tree
957
This returns a map of file_id->sha1, containing only files which are
958
still in the working inventory and have that text hash.
845
hashfile = self._control_files.get('merge-hashes')
961
hashfile = self._transport.get('merge-hashes')
962
except errors.NoSuchFile:
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
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
970
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
merge_hashes[file_id] = text_hash
984
def mkdir(self, path, file_id=None):
985
"""See MutableTree.mkdir()."""
987
file_id = generate_ids.gen_file_id(os.path.basename(path))
988
os.mkdir(self.abspath(path))
989
self.add(path, file_id, 'directory')
863
992
def get_symlink_target(self, file_id):
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).
993
abspath = self.id2abspath(file_id)
994
target = osutils.readlink(abspath)
998
def subsume(self, other_tree):
999
def add_children(inventory, entry):
1000
for child_entry in entry.children.values():
1001
inventory._byid[child_entry.file_id] = child_entry
1002
if child_entry.kind == 'directory':
1003
add_children(inventory, child_entry)
1004
if other_tree.get_root_id() == self.get_root_id():
1005
raise errors.BadSubsumeSource(self, other_tree,
1006
'Trees have the same root')
1008
other_tree_path = self.relpath(other_tree.basedir)
1009
except errors.PathNotChild:
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Tree is not contained by the other')
1012
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
if new_root_parent is None:
1014
raise errors.BadSubsumeSource(self, other_tree,
1015
'Parent directory is not versioned.')
1016
# We need to ensure that the result of a fetch will have a
1017
# versionedfile for the other_tree root, and only fetching into
1018
# RepositoryKnit2 guarantees that.
1019
if not self.branch.repository.supports_rich_root():
1020
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
other_tree.lock_tree_write()
1023
new_parents = other_tree.get_parent_ids()
1024
other_root = other_tree.inventory.root
1025
other_root.parent_id = new_root_parent
1026
other_root.name = osutils.basename(other_tree_path)
1027
self.inventory.add(other_root)
1028
add_children(self.inventory, other_root)
1029
self._write_inventory(self.inventory)
1030
# normally we don't want to fetch whole repositories, but i think
1031
# here we really do want to consolidate the whole thing.
1032
for parent_id in other_tree.get_parent_ids():
1033
self.branch.fetch(other_tree.branch, parent_id)
1034
self.add_parent_tree_id(parent_id)
1037
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
@needs_tree_write_lock
1066
def extract(self, file_id, format=None):
1067
"""Extract a subtree from this tree.
1069
A new branch will be created, relative to the path for this tree.
1073
segments = osutils.splitpath(path)
1074
transport = self.branch.bzrdir.root_transport
1075
for name in segments:
1076
transport = transport.clone(name)
1077
transport.ensure_base()
1080
sub_path = self.id2path(file_id)
1081
branch_transport = mkdirs(sub_path)
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
1085
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
repo = branch_bzrdir.find_repository()
1088
except errors.NoRepositoryPresent:
1089
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1092
new_branch = branch_bzrdir.create_branch()
1093
new_branch.pull(self.branch)
1094
for parent_id in self.get_parent_ids():
1095
new_branch.fetch(self.branch, parent_id)
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
if tree_transport.base != branch_transport.base:
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1102
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
wt.set_parent_ids(self.get_parent_ids())
1105
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1107
new_root = my_inv[file_id]
1108
my_inv.remove_recursive_id(file_id)
1109
new_root.parent_id = None
1110
child_inv.add(new_root)
1111
self._write_inventory(my_inv)
1112
wt._write_inventory(child_inv)
1115
def _serialize(self, inventory, out_file):
1116
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1119
def _deserialize(selt, in_file):
1120
return xml5.serializer_v5.read_inventory(in_file)
1123
"""Write the in memory inventory to disk."""
1124
# TODO: Maybe this should only write on dirty ?
1125
if self._control_files._lock_mode != 'w':
1126
raise errors.NotWriteLocked(self)
1128
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1132
self._inventory_is_modified = False
1134
def _kind(self, relpath):
1135
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
877
1140
Lists, but does not descend into unversioned directories.
879
1141
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
882
Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
884
inv = self._inventory
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
# with it. So callers should be careful to always read_lock the tree.
1150
if not self.is_locked():
1151
raise errors.ObjectNotLocked(self)
1153
inv = self.inventory
1154
if from_dir is None and include_root is True:
1155
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
885
1156
# Convert these into local objects to save lookup times
886
1157
pathjoin = osutils.pathjoin
887
file_kind = osutils.file_kind
1158
file_kind = self._kind
889
1160
# transport.base ends in a slash, we want the piece
890
1161
# between the last two slashes
965
1239
except KeyError:
966
1240
yield fp[1:], c, fk, None, TreeEntry()
969
1243
if fk != 'directory':
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
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
980
1256
# if we finished all children, pop it off the stack
985
def move(self, from_paths, to_name):
1259
@needs_tree_write_lock
1260
def move(self, from_paths, to_dir=None, after=False, **kwargs):
986
1261
"""Rename files.
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;
1263
to_dir must exist in the inventory.
1265
If to_dir exists and is a directory, the files are moved into
1266
it, keeping their old names.
1268
Note that to_dir is only the last component of the new name;
994
1269
this doesn't change the directory.
1271
For each entry in from_paths the move mode will be determined
1274
The first mode moves the file in the filesystem and updates the
1275
inventory. The second mode only updates the inventory without
1276
touching the file on the filesystem. This is the new mode introduced
1279
move uses the second mode if 'after == True' and the target is not
1280
versioned but present in the working tree.
1282
move uses the second mode if 'after == False' and the source is
1283
versioned but no longer in the working tree, and the target is not
1284
versioned but present in the working tree.
1286
move uses the first mode if 'after == False' and the source is
1287
versioned and present in the working tree, and the target is not
1288
versioned and not present in the working tree.
1290
Everything else results in an error.
996
1292
This returns a list of (from_path, to_path) pairs for each
997
1293
entry that is moved.
1000
## TODO: Option to move IDs only
1001
assert not isinstance(from_paths, basestring)
1298
# check for deprecated use of signature
1300
to_dir = kwargs.get('to_name', None)
1302
raise TypeError('You must supply a target directory')
1304
symbol_versioning.warn('The parameter to_name was deprecated'
1305
' in version 0.13. Use to_dir instead',
1308
# check destination directory
1309
if isinstance(from_paths, basestring):
1002
1311
inv = self.inventory
1003
to_abs = self.abspath(to_name)
1312
to_abs = self.abspath(to_dir)
1004
1313
if not isdir(to_abs):
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)
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotADirectory(to_abs))
1316
if not self.has_filename(to_dir):
1317
raise errors.BzrMoveFailedError('',to_dir,
1318
errors.NotInWorkingDirectory(to_dir))
1319
to_dir_id = inv.path2id(to_dir)
1320
if to_dir_id is None:
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotVersionedError(path=str(to_dir)))
1011
1324
to_dir_ie = inv[to_dir_id]
1012
1325
if to_dir_ie.kind != 'directory':
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)
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotADirectory(to_abs))
1329
# create rename entries and tuples
1330
for from_rel in from_paths:
1331
from_tail = splitpath(from_rel)[-1]
1332
from_id = inv.path2id(from_rel)
1334
raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
errors.NotVersionedError(path=str(from_rel)))
1337
from_entry = inv[from_id]
1338
from_parent_id = from_entry.parent_id
1339
to_rel = pathjoin(to_dir, from_tail)
1340
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1342
from_tail=from_tail,
1343
from_parent_id=from_parent_id,
1344
to_rel=to_rel, to_tail=from_tail,
1345
to_parent_id=to_dir_id)
1346
rename_entries.append(rename_entry)
1347
rename_tuples.append((from_rel, to_rel))
1349
# determine which move mode to use. checks also for movability
1350
rename_entries = self._determine_mv_mode(rename_entries, after)
1352
original_modified = self._inventory_is_modified
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"])
1355
self._inventory_is_modified = True
1356
self._move(rename_entries)
1047
1358
# restore the inventory on error
1048
self._set_inventory(orig_inv)
1359
self._inventory_is_modified = original_modified
1050
1361
self._write_inventory(inv)
1054
def rename_one(self, from_rel, to_rel):
1362
return rename_tuples
1364
def _determine_mv_mode(self, rename_entries, after=False):
1365
"""Determines for each from-to pair if both inventory and working tree
1366
or only the inventory has to be changed.
1368
Also does basic plausability tests.
1370
inv = self.inventory
1372
for rename_entry in rename_entries:
1373
# store to local variables for easier reference
1374
from_rel = rename_entry.from_rel
1375
from_id = rename_entry.from_id
1376
to_rel = rename_entry.to_rel
1377
to_id = inv.path2id(to_rel)
1378
only_change_inv = False
1380
# check the inventory for source and destination
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.NotVersionedError(path=str(from_rel)))
1384
if to_id is not None:
1385
raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
errors.AlreadyVersionedError(path=str(to_rel)))
1388
# try to determine the mode for rename (only change inv or change
1389
# inv and file system)
1391
if not self.has_filename(to_rel):
1392
raise errors.BzrMoveFailedError(from_id,to_rel,
1393
errors.NoSuchFile(path=str(to_rel),
1394
extra="New file has not been created yet"))
1395
only_change_inv = True
1396
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
only_change_inv = True
1398
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
only_change_inv = False
1400
elif (not self.case_sensitive
1401
and from_rel.lower() == to_rel.lower()
1402
and self.has_filename(from_rel)):
1403
only_change_inv = False
1405
# something is wrong, so lets determine what exactly
1406
if not self.has_filename(from_rel) and \
1407
not self.has_filename(to_rel):
1408
raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
errors.PathsDoNotExist(paths=(str(from_rel),
1412
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
rename_entry.only_change_inv = only_change_inv
1414
return rename_entries
1416
def _move(self, rename_entries):
1417
"""Moves a list of files.
1419
Depending on the value of the flag 'only_change_inv', the
1420
file will be moved on the file system or not.
1422
inv = self.inventory
1425
for entry in rename_entries:
1427
self._move_entry(entry)
1429
self._rollback_move(moved)
1433
def _rollback_move(self, moved):
1434
"""Try to rollback a previous move in case of an filesystem error."""
1435
inv = self.inventory
1438
self._move_entry(WorkingTree._RenameEntry(
1439
entry.to_rel, entry.from_id,
1440
entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
entry.from_tail, entry.from_parent_id,
1442
entry.only_change_inv))
1443
except errors.BzrMoveFailedError, e:
1444
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
" The working tree is in an inconsistent state."
1446
" Please consider doing a 'bzr revert'."
1447
" Error message is: %s" % e)
1449
def _move_entry(self, entry):
1450
inv = self.inventory
1451
from_rel_abs = self.abspath(entry.from_rel)
1452
to_rel_abs = self.abspath(entry.to_rel)
1453
if from_rel_abs == to_rel_abs:
1454
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
"Source and target are identical.")
1457
if not entry.only_change_inv:
1459
osutils.rename(from_rel_abs, to_rel_abs)
1461
raise errors.BzrMoveFailedError(entry.from_rel,
1463
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1465
@needs_tree_write_lock
1466
def rename_one(self, from_rel, to_rel, after=False):
1055
1467
"""Rename one file.
1057
1469
This can change the directory or the filename or both.
1471
rename_one has several 'modes' to work. First, it can rename a physical
1472
file and change the file_id. That is the normal mode. Second, it can
1473
only change the file_id without touching any physical file. This is
1474
the new mode introduced in version 0.15.
1476
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
versioned but present in the working tree.
1479
rename_one uses the second mode if 'after == False' and 'from_rel' is
1480
versioned but no longer in the working tree, and 'to_rel' is not
1481
versioned but present in the working tree.
1483
rename_one uses the first mode if 'after == False' and 'from_rel' is
1484
versioned and present in the working tree, and 'to_rel' is not
1485
versioned and not present in the working tree.
1487
Everything else results in an error.
1059
1489
inv = self.inventory
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)
1492
# create rename entries and tuples
1493
from_tail = splitpath(from_rel)[-1]
1494
from_id = inv.path2id(from_rel)
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1507
from_parent_id = from_entry.parent_id
1076
1508
to_dir, to_tail = os.path.split(to_rel)
1077
1509
to_dir_id = inv.path2id(to_dir)
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"])
1510
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1512
from_tail=from_tail,
1513
from_parent_id=from_parent_id,
1514
to_rel=to_rel, to_tail=to_tail,
1515
to_parent_id=to_dir_id)
1516
rename_entries.append(rename_entry)
1518
# determine which move mode to use. checks also for movability
1519
rename_entries = self._determine_mv_mode(rename_entries, after)
1521
# check if the target changed directory and if the target directory is
1523
if to_dir_id is None:
1524
raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
errors.NotVersionedError(path=str(to_dir)))
1527
# all checks done. now we can continue with our actual work
1528
mutter('rename_one:\n'
1533
' to_dir_id {%s}\n',
1534
from_id, from_rel, to_rel, to_dir, to_dir_id)
1536
self._move(rename_entries)
1099
1537
self._write_inventory(inv)
1539
class _RenameEntry(object):
1540
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
self.from_rel = from_rel
1543
self.from_id = from_id
1544
self.from_tail = from_tail
1545
self.from_parent_id = from_parent_id
1546
self.to_rel = to_rel
1547
self.to_tail = to_tail
1548
self.to_parent_id = to_parent_id
1549
self.only_change_inv = only_change_inv
1101
1551
@needs_read_lock
1102
1552
def unknowns(self):
1103
1553
"""Return all unknown files.
1303
1713
if ignoreset is not None:
1304
1714
return ignoreset
1306
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1716
ignore_globs = set()
1307
1717
ignore_globs.update(ignores.get_runtime_ignores())
1309
1718
ignore_globs.update(ignores.get_user_ignores())
1311
1719
if self.has_filename(bzrlib.IGNORE_FILENAME):
1312
1720
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1314
1722
ignore_globs.update(ignores.parse_ignore_file(f))
1318
1725
self._ignoreset = ignore_globs
1319
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1320
1726
return ignore_globs
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
1728
def _flush_ignore_list_cache(self):
1729
"""Resets the cached ignore list to force a cache rebuild."""
1730
self._ignoreset = None
1731
self._ignoreglobster = None
1332
1733
def is_ignored(self, filename):
1333
1734
r"""Check whether the filename matches an ignore pattern.
1335
1736
Patterns containing '/' or '\' need to match the whole path;
1336
others match against only the last component.
1737
others match against only the last component. Patterns starting
1738
with '!' are ignore exceptions. Exceptions take precedence
1739
over regular patterns and cause the filename to not be ignored.
1338
1741
If the file is ignored, returns the pattern which caused it to
1339
1742
be ignored, otherwise None. So this can simply be used as a
1340
1743
boolean if desired."""
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]
1744
if getattr(self, '_ignoreglobster', None) is None:
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1746
return self._ignoreglobster.match(filename)
1363
1748
def kind(self, file_id):
1364
1749
return file_kind(self.id2abspath(file_id))
1751
def stored_kind(self, file_id):
1752
"""See Tree.stored_kind"""
1753
return self.inventory[file_id].kind
1755
def _comparison_data(self, entry, path):
1756
abspath = self.abspath(path)
1758
stat_value = os.lstat(abspath)
1760
if getattr(e, 'errno', None) == errno.ENOENT:
1767
mode = stat_value.st_mode
1768
kind = osutils.file_kind_from_stat_mode(mode)
1769
if not supports_executable():
1770
executable = entry is not None and entry.executable
1772
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
return kind, executable, stat_value
1775
def _file_size(self, entry, stat_value):
1776
return stat_value.st_size
1366
1778
def last_revision(self):
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.
1779
"""Return the last revision of the branch for this tree.
1781
This format tree does not support a separate marker for last-revision
1782
compared to the branch.
1784
See MutableTree.last_revision
1376
1786
return self._last_revision()
1378
1788
@needs_read_lock
1379
1789
def _last_revision(self):
1380
1790
"""helper for get_parent_ids."""
1381
return self.branch.last_revision()
1791
return _mod_revision.ensure_null(self.branch.last_revision())
1383
1793
def is_locked(self):
1384
1794
return self._control_files.is_locked()
1796
def _must_be_locked(self):
1797
if not self.is_locked():
1798
raise errors.ObjectNotLocked(self)
1386
1800
def lock_read(self):
1387
1801
"""See Branch.lock_read, and WorkingTree.unlock."""
1802
if not self.is_locked():
1388
1804
self.branch.lock_read()
1390
1806
return self._control_files.lock_read()
1429
1868
self.branch.set_revision_history([new_revision])
1871
def _write_basis_inventory(self, xml):
1872
"""Write the basis inventory XML to the basis-inventory file"""
1873
path = self._basis_inventory_name()
1875
self._transport.put_file(path, sio,
1876
mode=self.bzrdir._get_file_mode())
1878
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
"""Create the text that will be saved in basis-inventory"""
1880
inventory.revision_id = revision_id
1881
return xml7.serializer_v7.write_inventory_to_string(inventory)
1432
1883
def _cache_basis_inventory(self, new_revision):
1433
1884
"""Cache new_revision as the basis inventory."""
1434
1885
# TODO: this should allow the ready-to-use inventory to be passed in,
1435
1886
# as commit already has that ready-to-use [while the format is the
1436
1887
# same, that is].
1438
# this double handles the inventory - unpack and repack -
1889
# this double handles the inventory - unpack and repack -
1439
1890
# but is easier to understand. We can/should put a conditional
1440
1891
# in here based on whether the inventory is in the latest format
1441
1892
# - perhaps we should repack all inventories on a repository
1443
1894
# the fast path is to copy the raw xml from the repository. If the
1444
# xml contains 'revision_id="', then we assume the right
1895
# xml contains 'revision_id="', then we assume the right
1445
1896
# revision_id is set. We must check for this full string, because a
1446
1897
# root node id can legitimately look like 'revision_id' but cannot
1447
1898
# contain a '"'.
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)
1899
xml = self.branch.repository._get_inventory_xml(new_revision)
1900
firstline = xml.split('\n', 1)[0]
1901
if (not 'revision_id="' in firstline or
1902
'format="7"' not in firstline):
1903
inv = self.branch.repository._serializer.read_inventory_from_string(
1905
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
self._write_basis_inventory(xml)
1458
1907
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1461
1910
def read_basis_inventory(self):
1462
1911
"""Read the cached basis inventory."""
1463
1912
path = self._basis_inventory_name()
1464
return self._control_files.get(path).read()
1913
return self._transport.get_bytes(path)
1466
1915
@needs_read_lock
1467
1916
def read_working_inventory(self):
1468
"""Read the working inventory."""
1917
"""Read the working inventory.
1919
:raises errors.InventoryModified: read_working_inventory will fail
1920
when the current in memory inventory has been modified.
1922
# conceptually this should be an implementation detail of the tree.
1923
# XXX: Deprecate this.
1469
1924
# ElementTree does its own conversion from UTF-8, so open in
1471
result = xml5.serializer_v5.read_inventory(
1472
self._control_files.get('inventory'))
1473
self._set_inventory(result)
1926
if self._inventory_is_modified:
1927
raise errors.InventoryModified(self)
1928
f = self._transport.get('inventory')
1930
result = self._deserialize(f)
1933
self._set_inventory(result, dirty=False)
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.
1936
@needs_tree_write_lock
1937
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1939
"""Remove nominated files from the working inventory.
1941
:files: File paths relative to the basedir.
1942
:keep_files: If true, the files will also be kept.
1943
:force: Delete files and directories, even if they are changed and
1944
even if the directories are not empty.
1491
## TODO: Normalize names
1492
## TODO: Remove nested loops; better scalability
1493
1946
if isinstance(files, basestring):
1494
1947
files = [files]
1496
inv = self.inventory
1498
# do this before any modifications
1952
unknown_nested_files=set()
1954
to_file = sys.stdout
1956
def recurse_directory_to_add_files(directory):
1957
# Recurse directory and add all files
1958
# so we can check if they have changed.
1959
for parent_info, file_infos in\
1960
self.walkdirs(directory):
1961
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
# Is it versioned or ignored?
1963
if self.path2id(relpath) or self.is_ignored(relpath):
1964
# Add nested content for deletion.
1965
new_files.add(relpath)
1967
# Files which are not versioned and not ignored
1968
# should be treated as unknown.
1969
unknown_nested_files.add((relpath, None, kind))
1971
for filename in files:
1972
# Get file name into canonical form.
1973
abspath = self.abspath(filename)
1974
filename = self.relpath(abspath)
1975
if len(filename) > 0:
1976
new_files.add(filename)
1977
recurse_directory_to_add_files(filename)
1979
files = list(new_files)
1982
return # nothing to do
1984
# Sort needed to first handle directory content before the directory
1985
files.sort(reverse=True)
1987
# Bail out if we are going to delete files we shouldn't
1988
if not keep_files and not force:
1989
has_changed_files = len(unknown_nested_files) > 0
1990
if not has_changed_files:
1991
for (file_id, path, content_change, versioned, parent_id, name,
1992
kind, executable) in self.iter_changes(self.basis_tree(),
1993
include_unchanged=True, require_versioned=False,
1994
want_unversioned=True, specific_files=files):
1995
if versioned == (False, False):
1996
# The record is unknown ...
1997
if not self.is_ignored(path[1]):
1998
# ... but not ignored
1999
has_changed_files = True
2001
elif content_change and (kind[1] is not None):
2002
# Versioned and changed, but not deleted
2003
has_changed_files = True
2006
if has_changed_files:
2007
# Make delta show ALL applicable changes in error message.
2008
tree_delta = self.changes_from(self.basis_tree(),
2009
require_versioned=False, want_unversioned=True,
2010
specific_files=files)
2011
for unknown_file in unknown_nested_files:
2012
if unknown_file not in tree_delta.unversioned:
2013
tree_delta.unversioned.extend((unknown_file,))
2014
raise errors.BzrRemoveChangedFilesError(tree_delta)
2016
# Build inv_delta and delete files where applicable,
2017
# do this before any modifications to inventory.
1499
2018
for f in files:
1500
fid = inv.path2id(f)
2019
fid = self.path2id(f)
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()):
2022
message = "%s is not versioned." % (f,)
2025
# having removed it, it must be either ignored or unknown
2026
if self.is_ignored(f):
2030
# XXX: Really should be a more abstract reporter interface
2031
kind_ch = osutils.kind_marker(self.kind(fid))
2032
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2034
inv_delta.append((f, None, fid, None))
2035
message = "removed %s" % (f,)
2038
abs_path = self.abspath(f)
2039
if osutils.lexists(abs_path):
2040
if (osutils.isdir(abs_path) and
2041
len(os.listdir(abs_path)) > 0):
2043
osutils.rmtree(abs_path)
2045
message = "%s is not an empty directory "\
2046
"and won't be deleted." % (f,)
2048
osutils.delete_any(abs_path)
2049
message = "deleted %s" % (f,)
2050
elif message is not None:
2051
# Only care if we haven't done anything yet.
2052
message = "%s does not exist." % (f,)
2054
# Print only one message (if any) per file.
2055
if message is not None:
2057
self.apply_inventory_delta(inv_delta)
2059
@needs_tree_write_lock
2060
def revert(self, filenames=None, old_tree=None, backups=True,
2061
pb=None, report_changes=False):
1520
2062
from bzrlib.conflicts import resolve
2065
symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
' as of bzr 0.91. Please use None (the default) instead.',
2067
DeprecationWarning, stacklevel=2)
1521
2068
if old_tree is None:
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])
2069
basis_tree = self.basis_tree()
2070
basis_tree.lock_read()
2071
old_tree = basis_tree
1528
resolve(self, filenames, ignore_misses=True)
2075
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2077
if filenames is None and len(self.get_parent_ids()) > 1:
2079
last_revision = self.last_revision()
2080
if last_revision != _mod_revision.NULL_REVISION:
2081
if basis_tree is None:
2082
basis_tree = self.basis_tree()
2083
basis_tree.lock_read()
2084
parent_trees.append((last_revision, basis_tree))
2085
self.set_parent_trees(parent_trees)
2088
resolve(self, filenames, ignore_misses=True, recursive=True)
2090
if basis_tree is not None:
1529
2092
return conflicts
2094
def revision_tree(self, revision_id):
2095
"""See Tree.revision_tree.
2097
WorkingTree can supply revision_trees for the basis revision only
2098
because there is only one cached inventory in the bzr directory.
2100
if revision_id == self.last_revision():
2102
xml = self.read_basis_inventory()
2103
except errors.NoSuchFile:
2107
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2108
# dont use the repository revision_tree api because we want
2109
# to supply the inventory.
2110
if inv.revision_id == revision_id:
2111
return revisiontree.RevisionTree(self.branch.repository,
2113
except errors.BadInventoryFormat:
2115
# raise if there was no inventory, or if we read the wrong inventory.
2116
raise errors.NoSuchRevisionInTree(self, revision_id)
1531
2118
# XXX: This method should be deprecated in favour of taking in a proper
1532
2119
# new Inventory object.
2120
@needs_tree_write_lock
1534
2121
def set_inventory(self, new_inventory_list):
1535
2122
from bzrlib.inventory import (Inventory,
1536
2123
InventoryDirectory,
1540
2126
inv = Inventory(self.get_root_id())
1550
2136
elif kind == 'symlink':
1551
2137
inv.add(InventoryLink(file_id, name, parent))
1553
raise BzrError("unknown kind %r" % kind)
2139
raise errors.BzrError("unknown kind %r" % kind)
1554
2140
self._write_inventory(inv)
2142
@needs_tree_write_lock
1557
2143
def set_root_id(self, file_id):
1558
2144
"""Set the root id for this tree."""
1559
inv = self.read_working_inventory()
2148
'WorkingTree.set_root_id with fileid=None')
2149
file_id = osutils.safe_file_id(file_id)
2150
self._set_root_id(file_id)
2152
def _set_root_id(self, file_id):
2153
"""Set the root id for this tree, in a format specific manner.
2155
:param file_id: The file id to assign to the root. It must not be
2156
present in the current inventory or an error will occur. It must
2157
not be None, but rather a valid file id.
2159
inv = self._inventory
1560
2160
orig_root_id = inv.root.file_id
2161
# TODO: it might be nice to exit early if there was nothing
2162
# to do, saving us from trigger a sync on unlock.
2163
self._inventory_is_modified = True
2164
# we preserve the root inventory entry object, but
2165
# unlinkit from the byid index
1561
2166
del inv._byid[inv.root.file_id]
1562
2167
inv.root.file_id = file_id
2168
# and link it into the index with the new changed id.
1563
2169
inv._byid[inv.root.file_id] = inv.root
2170
# and finally update all children to reference the new id.
2171
# XXX: this should be safe to just look at the root.children
2172
# list, not the WHOLE INVENTORY.
1564
2173
for fid in inv:
1565
2174
entry = inv[fid]
1566
2175
if entry.parent_id == orig_root_id:
1567
2176
entry.parent_id = inv.root.file_id
1568
self._write_inventory(inv)
1570
2178
def unlock(self):
1571
2179
"""See Branch.unlock.
1573
2181
WorkingTree locking just uses the Branch locking facilities.
1574
2182
This is current because all working trees have an embedded branch
1575
2183
within them. IF in the future, we were to make branch data shareable
1576
between multiple working trees, i.e. via shared storage, then we
2184
between multiple working trees, i.e. via shared storage, then we
1577
2185
would probably want to lock both the local tree, and the branch.
1579
2187
raise NotImplementedError(self.unlock)
2191
def update(self, change_reporter=None, possible_transports=None,
2192
revision=None, old_tip=_marker):
1583
2193
"""Update a working tree along its branch.
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.
2195
This will update the branch if its bound too, which means we have
2196
multiple trees involved:
2198
- The new basis tree of the master.
2199
- The old basis tree of the branch.
2200
- The old basis tree of the working tree.
2201
- The current working tree state.
2203
Pathologically, all three may be different, and non-ancestors of each
2204
other. Conceptually we want to:
2206
- Preserve the wt.basis->wt.state changes
2207
- Transform the wt.basis to the new master basis.
2208
- Apply a merge of the old branch basis to get any 'local' changes from
2210
- Restore the wt.basis->wt.state changes.
1597
2212
There isn't a single operation at the moment to do that, so we:
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()
2213
- Merge current state -> basis tree of the master w.r.t. the old tree
2215
- Do a 'normal' merge of the old branch basis if it is relevant.
2217
:param revision: The target revision to update to. Must be in the
2219
:param old_tip: If branch.update() has already been run, the value it
2220
returned (old tip of the branch or None). _marker is used
2223
if self.branch.get_bound_location() is not None:
2225
update_branch = (old_tip is self._marker)
2227
self.lock_tree_write()
2228
update_branch = False
2231
old_tip = self.branch.update(possible_transports)
2233
if old_tip is self._marker:
2235
return self._update_tree(old_tip, change_reporter, revision)
2239
@needs_tree_write_lock
2240
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2241
"""Update a tree to the master branch.
2243
:param old_tip: if supplied, the previous tip revision the branch,
2244
before it was changed to the master branch's tip.
1602
2246
# here if old_tip is not None, it is the old tip of the branch before
1603
2247
# it was updated from the master branch. This should become a pending
1604
2248
# merge in the working tree to preserve the user existing work. we
1605
2249
# cant set that until we update the working trees last revision to be
1606
2250
# one from the new branch, because it will just get absorbed by the
1607
2251
# parent de-duplication logic.
1609
2253
# We MUST save it even if an error occurs, because otherwise the users
1610
2254
# local work is unreferenced and will appear to have been lost.
1614
2258
last_rev = self.get_parent_ids()[0]
1615
2259
except IndexError:
1617
if last_rev != self.branch.last_revision():
1618
# merge tree state up to new branch tip.
2260
last_rev = _mod_revision.NULL_REVISION
2261
if revision is None:
2262
revision = self.branch.last_revision()
2264
old_tip = old_tip or _mod_revision.NULL_REVISION
2266
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
# the branch we are bound to was updated
2268
# merge those changes in first
2269
base_tree = self.basis_tree()
2270
other_tree = self.branch.repository.revision_tree(old_tip)
2271
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
base_tree, this_tree=self,
2273
change_reporter=change_reporter)
2275
self.add_parent_tree((old_tip, other_tree))
2276
trace.note('Rerun update after fixing the conflicts.')
2279
if last_rev != _mod_revision.ensure_null(revision):
2280
# the working tree is up to date with the branch
2281
# we can merge the specified revision from master
2282
to_tree = self.branch.repository.revision_tree(revision)
2283
to_root_id = to_tree.get_root_id()
1619
2285
basis = self.basis_tree()
1620
to_tree = self.branch.basis_tree()
1621
result += merge.merge_inner(
2288
if (basis.inventory.root is None
2289
or basis.inventory.root.file_id != to_root_id):
2290
self.set_root_id(to_root_id)
2295
# determine the branch point
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2301
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
change_reporter=change_reporter)
2304
self.set_last_revision(revision)
1626
2305
# TODO - dedup parents list with things merged by pull ?
1627
2306
# reuse the tree we've updated to to set the basis:
1628
parent_trees = [(self.branch.last_revision(), to_tree)]
2307
parent_trees = [(revision, to_tree)]
1629
2308
merges = self.get_parent_ids()[1:]
1630
2309
# Ideally we ask the tree for the trees here, that way the working
1631
# tree can decide whether to give us teh entire tree or give us a
2310
# tree can decide whether to give us the entire tree or give us a
1632
2311
# lazy initialised tree. dirstate for instance will have the trees
1633
2312
# in ram already, whereas a last-revision + basis-inventory tree
1634
2313
# will not, but also does not need them when setting parents.
1635
2314
for parent in merges:
1636
2315
parent_trees.append(
1637
2316
(parent, self.branch.repository.revision_tree(parent)))
1638
if old_tip is not None:
2317
if not _mod_revision.is_null(old_tip):
1639
2318
parent_trees.append(
1640
2319
(old_tip, self.branch.repository.revision_tree(old_tip)))
1641
2320
self.set_parent_trees(parent_trees)
1642
2321
last_rev = parent_trees[0][0]
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
2324
def _write_hashcache_if_dirty(self):
2325
"""Write out the hashcache if it is dirty."""
2326
if self._hashcache.needs_write:
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(
2328
self._hashcache.write()
2330
if e.errno not in (errno.EPERM, errno.EACCES):
2332
# TODO: jam 20061219 Should this be a warning? A single line
2333
# warning might be sufficient to let the user know what
2335
mutter('Could not write hashcache for %s\nError: %s',
2336
self._hashcache.cache_file_name(), e)
2338
@needs_tree_write_lock
1671
2339
def _write_inventory(self, inv):
1672
2340
"""Write inventory as the current inventory."""
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')
2341
self._set_inventory(inv, dirty=True)
1680
2344
def set_conflicts(self, arg):
1681
raise UnsupportedOperation(self.set_conflicts, self)
2345
raise errors.UnsupportedOperation(self.set_conflicts, self)
1683
2347
def add_conflicts(self, arg):
1684
raise UnsupportedOperation(self.add_conflicts, self)
2348
raise errors.UnsupportedOperation(self.add_conflicts, self)
1686
2350
@needs_read_lock
1687
2351
def conflicts(self):
1709
2373
file_id=self.path2id(conflicted)))
1710
2374
return conflicts
2376
def walkdirs(self, prefix=""):
2377
"""Walk the directories of this tree.
2379
returns a generator which yields items in the form:
2380
((curren_directory_path, fileid),
2381
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2384
This API returns a generator, which is only valid during the current
2385
tree transaction - within a single lock_read or lock_write duration.
2387
If the tree is not locked, it may cause an error to be raised,
2388
depending on the tree implementation.
2390
disk_top = self.abspath(prefix)
2391
if disk_top.endswith('/'):
2392
disk_top = disk_top[:-1]
2393
top_strip_len = len(disk_top) + 1
2394
inventory_iterator = self._walkdirs(prefix)
2395
disk_iterator = osutils.walkdirs(disk_top, prefix)
2397
current_disk = disk_iterator.next()
2398
disk_finished = False
2400
if not (e.errno == errno.ENOENT or
2401
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2404
disk_finished = True
2406
current_inv = inventory_iterator.next()
2407
inv_finished = False
2408
except StopIteration:
2411
while not inv_finished or not disk_finished:
2413
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
cur_disk_dir_content) = current_disk
2416
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
cur_disk_dir_content) = ((None, None), None)
2418
if not disk_finished:
2419
# strip out .bzr dirs
2420
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
len(cur_disk_dir_content) > 0):
2422
# osutils.walkdirs can be made nicer -
2423
# yield the path-from-prefix rather than the pathjoined
2425
bzrdir_loc = bisect_left(cur_disk_dir_content,
2427
if (bzrdir_loc < len(cur_disk_dir_content)
2428
and self.bzrdir.is_control_filename(
2429
cur_disk_dir_content[bzrdir_loc][0])):
2430
# we dont yield the contents of, or, .bzr itself.
2431
del cur_disk_dir_content[bzrdir_loc]
2433
# everything is unknown
2436
# everything is missing
2439
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2441
# disk is before inventory - unknown
2442
dirblock = [(relpath, basename, kind, stat, None, None) for
2443
relpath, basename, kind, stat, top_path in
2444
cur_disk_dir_content]
2445
yield (cur_disk_dir_relpath, None), dirblock
2447
current_disk = disk_iterator.next()
2448
except StopIteration:
2449
disk_finished = True
2451
# inventory is before disk - missing.
2452
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
for relpath, basename, dkind, stat, fileid, kind in
2455
yield (current_inv[0][0], current_inv[0][1]), dirblock
2457
current_inv = inventory_iterator.next()
2458
except StopIteration:
2461
# versioned present directory
2462
# merge the inventory and disk data together
2464
for relpath, subiterator in itertools.groupby(sorted(
2465
current_inv[1] + cur_disk_dir_content,
2466
key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
path_elements = list(subiterator)
2468
if len(path_elements) == 2:
2469
inv_row, disk_row = path_elements
2470
# versioned, present file
2471
dirblock.append((inv_row[0],
2472
inv_row[1], disk_row[2],
2473
disk_row[3], inv_row[4],
2475
elif len(path_elements[0]) == 5:
2477
dirblock.append((path_elements[0][0],
2478
path_elements[0][1], path_elements[0][2],
2479
path_elements[0][3], None, None))
2480
elif len(path_elements[0]) == 6:
2481
# versioned, absent file.
2482
dirblock.append((path_elements[0][0],
2483
path_elements[0][1], 'unknown', None,
2484
path_elements[0][4], path_elements[0][5]))
2486
raise NotImplementedError('unreachable code')
2487
yield current_inv[0], dirblock
2489
current_inv = inventory_iterator.next()
2490
except StopIteration:
2493
current_disk = disk_iterator.next()
2494
except StopIteration:
2495
disk_finished = True
2497
def _walkdirs(self, prefix=""):
2498
"""Walk the directories of this tree.
2500
:prefix: is used as the directrory to start with.
2501
returns a generator which yields items in the form:
2502
((curren_directory_path, fileid),
2503
[(file1_path, file1_name, file1_kind, None, file1_id,
2506
_directory = 'directory'
2507
# get the root in the inventory
2508
inv = self.inventory
2509
top_id = inv.path2id(prefix)
2513
pending = [(prefix, '', _directory, None, top_id, None)]
2516
currentdir = pending.pop()
2517
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
top_id = currentdir[4]
2520
relroot = currentdir[0] + '/'
2523
# FIXME: stash the node in pending
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
child.file_id, child.kind
2530
yield (currentdir[0], entry.file_id), dirblock
2531
# push the user specified dirs from dirblock
2532
for dir in reversed(dirblock):
2533
if dir[2] == _directory:
2536
@needs_tree_write_lock
2537
def auto_resolve(self):
2538
"""Automatically resolve text conflicts according to contents.
2540
Only text conflicts are auto_resolvable. Files with no conflict markers
2541
are considered 'resolved', because bzr always puts conflict markers
2542
into files that have text conflicts. The corresponding .THIS .BASE and
2543
.OTHER files are deleted, as per 'resolve'.
2544
:return: a tuple of ConflictLists: (un_resolved, resolved).
2546
un_resolved = _mod_conflicts.ConflictList()
2547
resolved = _mod_conflicts.ConflictList()
2548
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2549
for conflict in self.conflicts():
2550
if (conflict.typestring != 'text conflict' or
2551
self.kind(conflict.file_id) != 'file'):
2552
un_resolved.append(conflict)
2554
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2556
for line in my_file:
2557
if conflict_re.search(line):
2558
un_resolved.append(conflict)
2561
resolved.append(conflict)
2564
resolved.remove_files(self)
2565
self.set_conflicts(un_resolved)
2566
return un_resolved, resolved
2569
def _check(self, references):
2570
"""Check the tree for consistency.
2572
:param references: A dict with keys matching the items returned by
2573
self._get_check_refs(), and values from looking those keys up in
2576
tree_basis = self.basis_tree()
2577
tree_basis.lock_read()
2579
repo_basis = references[('trees', self.last_revision())]
2580
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
raise errors.BzrCheckError(
2582
"Mismatched basis inventory content.")
2587
def _validate(self):
2588
"""Validate internal structures.
2590
This is meant mostly for the test suite. To give it a chance to detect
2591
corruption after actions have occurred. The default implementation is a
2594
:return: None. An exception should be raised if there is an error.
2598
def _get_rules_searcher(self, default_searcher):
2599
"""See Tree._get_rules_searcher."""
2600
if self._rules_searcher is None:
2601
self._rules_searcher = super(WorkingTree,
2602
self)._get_rules_searcher(default_searcher)
2603
return self._rules_searcher
2605
def get_shelf_manager(self):
2606
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
2608
return ShelfManager(self, self._transport)
1713
2611
class WorkingTree2(WorkingTree):
1714
2612
"""This is the Format 2 working tree.
1716
This was the first weave based working tree.
2614
This was the first weave based working tree.
1717
2615
- uses os locks for locking.
1718
2616
- uses the branch last-revision.
2619
def __init__(self, *args, **kwargs):
2620
super(WorkingTree2, self).__init__(*args, **kwargs)
2621
# WorkingTree2 has more of a constraint that self._inventory must
2622
# exist. Because this is an older format, we don't mind the overhead
2623
# caused by the extra computation here.
2625
# Newer WorkingTree's should only have self._inventory set when they
2627
if self._inventory is None:
2628
self.read_working_inventory()
2630
def _get_check_refs(self):
2631
"""Return the references needed to perform a check of this tree."""
2632
return [('trees', self.last_revision())]
2634
def lock_tree_write(self):
2635
"""See WorkingTree.lock_tree_write().
2637
In Format2 WorkingTrees we have a single lock for the branch and tree
2638
so lock_tree_write() degrades to lock_write().
2640
self.branch.lock_write()
2642
return self._control_files.lock_write()
2644
self.branch.unlock()
1721
2647
def unlock(self):
2648
# do non-implementation specific cleanup
1722
2651
# we share control files:
1723
if self._hashcache.needs_write and self._control_files._lock_count==3:
1724
self._hashcache.write()
2652
if self._control_files._lock_count == 3:
2653
# _inventory_is_modified is always False during a read lock.
2654
if self._inventory_is_modified:
2656
self._write_hashcache_if_dirty()
1725
2658
# reverse order of locking.
1727
2660
return self._control_files.unlock()
1885
2835
def unregister_format(klass, format):
1886
assert klass._formats[format.get_format_string()] is format
1887
2836
del klass._formats[format.get_format_string()]
1891
2839
class WorkingTreeFormat2(WorkingTreeFormat):
1892
"""The second working tree format.
2840
"""The second working tree format.
1894
2842
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
1897
2847
def get_format_description(self):
1898
2848
"""See WorkingTreeFormat.get_format_description()."""
1899
2849
return "Working tree format 2"
1901
def stub_initialize_remote(self, control_files):
1902
"""As a special workaround create critical control files for a remote working tree
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
1904
2854
This ensures that it can later be updated and dealt with locally,
1905
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1906
2856
no working tree. (See bug #43064).
1908
2858
sio = StringIO()
1910
xml5.serializer_v5.write_inventory(inv, sio)
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
1912
control_files.put('inventory', sio)
1914
control_files.put_utf8('pending-merges', '')
1917
def initialize(self, a_bzrdir, revision_id=None):
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
1918
2867
"""See WorkingTreeFormat.initialize()."""
1919
2868
if not isinstance(a_bzrdir.transport, LocalTransport):
1920
2869
raise errors.NotLocalUrl(a_bzrdir.transport.base)
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()
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
1935
2882
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1938
2885
_internal=True,
1940
2887
_bzrdir=a_bzrdir)
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)])
2888
basis_tree = branch.repository.revision_tree(revision_id)
2889
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2891
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
1945
2897
transform.build_tree(basis_tree, wt)
added
removed
bzrlib/workingtree.py
