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
67
import bzrlib.branch
70
68
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
72
from bzrlib import symbol_versioning
79
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
74
from bzrlib.errors import (BzrCheckError,
77
WeaveRevisionNotPresent,
81
MergeModifiedFormatError,
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
85
from bzrlib.lockable_files import LockableFiles, TransportLock
82
86
from bzrlib.lockdir import LockDir
83
87
import bzrlib.mutabletree
84
88
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
89
from bzrlib.osutils import (
94
99
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
101
from bzrlib.trace import mutter, note
98
102
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION
106
import bzrlib.revisiontree
100
107
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
107
117
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
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
120
# the regex removes any weird characters; we don't escape them
121
# but rather just pull them out
122
_gen_file_id_re = re.compile(r'[^\w.]')
123
_gen_id_suffix = None
127
def _next_id_suffix():
128
"""Create a new file id suffix that is reasonably unique.
130
On the first call we combine the current time with 64 bits of randomness
131
to give a highly probably globally unique number. Then each call in the same
132
process adds 1 to a serial number we append to that unique value.
134
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
135
# than having to move the id randomness out of the inner loop like this.
136
# XXX TODO: for the global randomness this uses we should add the thread-id
137
# before the serial #.
138
global _gen_id_suffix, _gen_id_serial
139
if _gen_id_suffix is None:
140
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
142
return _gen_id_suffix + str(_gen_id_serial)
145
def gen_file_id(name):
146
"""Return new file id for the basename 'name'.
148
The uniqueness is supplied from _next_id_suffix.
150
# The real randomness is in the _next_id_suffix, the
151
# rest of the identifier is just to be nice.
153
# 1) Remove non-ascii word characters to keep the ids portable
154
# 2) squash to lowercase, so the file id doesn't have to
155
# be escaped (case insensitive filesystems would bork for ids
156
# that only differred in case without escaping).
157
# 3) truncate the filename to 20 chars. Long filenames also bork on some
159
# 4) Removing starting '.' characters to prevent the file ids from
160
# being considered hidden.
161
ascii_word_only = _gen_file_id_re.sub('', name.lower())
162
short_no_dots = ascii_word_only.lstrip('.')[:20]
163
return short_no_dots + _next_id_suffix()
167
"""Return a new tree-root file id."""
168
return gen_file_id('tree_root')
116
171
class TreeEntry(object):
117
172
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
174
This needs further inspection, it may be better to have
120
175
InventoryEntries without ids - though that seems wrong. For now,
121
176
this is a parallel hierarchy to InventoryEntry, and needs to become
122
177
one of several things: decorates to that hierarchy, children of, or
412
417
# no parents, return an empty revision tree.
413
418
# in the future this should return the tree for
414
419
# '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:
420
return self.branch.repository.revision_tree(None)
423
xml = self.read_basis_inventory()
424
inv = xml6.serializer_v6.read_inventory_from_string(xml)
425
if inv is not None and inv.revision_id == revision_id:
426
return bzrlib.revisiontree.RevisionTree(
427
self.branch.repository, inv, revision_id)
428
except (NoSuchFile, errors.BadInventoryFormat):
421
430
# No cached copy available, retrieve from the repository.
422
431
# FIXME? RBC 20060403 should we cache the inventory locally
423
432
# at this point ?
425
434
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
435
except errors.RevisionNotPresent:
427
436
# 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
437
# occured. If the revision is present, its a problem, if its not
430
439
if self.branch.repository.has_revision(revision_id):
432
441
# 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()
442
return self.branch.repository.revision_tree(None)
445
@deprecated_method(zero_eight)
446
def create(branch, directory):
447
"""Create a workingtree for branch at directory.
449
If existing_directory already exists it must have a .bzr directory.
450
If it does not exist, it will be created.
452
This returns a new WorkingTree object for the new checkout.
454
TODO FIXME RBC 20060124 when we have checkout formats in place this
455
should accept an optional revisionid to checkout [and reject this if
456
checking out into the same dir as a pre-checkout-aware branch format.]
458
XXX: When BzrDir is present, these should be created through that
461
warnings.warn('delete WorkingTree.create', stacklevel=3)
462
transport = get_transport(directory)
463
if branch.bzrdir.root_transport.base == transport.base:
465
return branch.bzrdir.create_workingtree()
466
# different directory,
467
# create a branch reference
468
# and now a working tree.
469
raise NotImplementedError
472
@deprecated_method(zero_eight)
473
def create_standalone(directory):
474
"""Create a checkout and a branch and a repo at directory.
476
Directory must exist and be empty.
478
please use BzrDir.create_standalone_workingtree
480
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
482
def relpath(self, path):
440
483
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
485
The path may be absolute or relative. If its a relative path it is
443
486
interpreted relative to the python current working directory.
445
488
return osutils.relpath(self.basedir, path)
447
490
def has_filename(self, filename):
448
491
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))
493
def get_file(self, file_id):
494
return self.get_file_byname(self.id2path(file_id))
496
def get_file_text(self, file_id):
497
return self.get_file(file_id).read()
499
def get_file_byname(self, filename):
500
return file(self.abspath(filename), 'rb')
540
502
def get_parent_ids(self):
541
503
"""See Tree.get_parent_ids.
543
505
This implementation reads the pending merges list and last_revision
544
506
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:
508
last_rev = self._last_revision()
550
512
parents = [last_rev]
552
merges_bytes = self._transport.get_bytes('pending-merges')
553
except errors.NoSuchFile:
514
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)
518
for l in merges_file.readlines():
519
parents.append(l.rstrip('\n'))
562
523
def get_root_id(self):
563
524
"""Return the id of this trees root"""
564
525
return self._inventory.root.file_id
566
527
def _get_store_filename(self, file_id):
567
528
## XXX: badly named; this is not in the store at all
568
529
return self.abspath(self.id2path(file_id))
571
def clone(self, to_bzrdir, revision_id=None):
532
def clone(self, to_bzrdir, revision_id=None, basis=None):
572
533
"""Duplicate this working tree into to_bzr, including all state.
574
535
Specifically modified files are kept as modified, but
575
536
ignored and unknown files are discarded.
577
538
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
541
If not None, the cloned tree will have its last revision set to
542
revision, and and difference between the source trees last revision
582
543
and this one merged in.
546
If not None, a closer copy of a tree which may have some files in
547
common, and which file content should be preferentially copied from.
584
549
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
550
result = self._format.initialize(to_bzrdir)
586
551
self.copy_content_into(result, revision_id)
617
582
__contains__ = has_id
619
584
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:
585
return os.path.getsize(self.id2abspath(file_id))
632
def get_file_sha1(self, file_id, path=None, stat_value=None):
588
def get_file_sha1(self, file_id, path=None):
634
590
path = self._inventory.id2path(file_id)
635
return self._hashcache.get_sha1(path, stat_value)
591
return self._hashcache.get_sha1(path)
637
593
def get_file_mtime(self, file_id, path=None):
639
path = self.inventory.id2path(file_id)
595
path = self._inventory.id2path(file_id)
640
596
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
598
if not supports_executable():
655
599
def is_executable(self, file_id, path=None):
656
600
return self._inventory[file_id].executable
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_basis
661
602
def is_executable(self, file_id, path=None):
663
path = self.id2path(file_id)
604
path = self._inventory.id2path(file_id)
664
605
mode = os.lstat(self.abspath(path)).st_mode
665
606
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
609
def _add(self, files, ids, kinds):
672
610
"""See MutableTree._add."""
673
611
# TODO: Re-adding a file that is removed in the working copy
674
612
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
613
# the read and write working inventory should not occur in this
676
614
# function - they should be part of lock_write and unlock.
615
inv = self.read_working_inventory()
678
616
for f, file_id, kind in zip(files, ids, kinds):
617
assert kind is not None
679
618
if file_id is None:
680
619
inv.add_path(f, kind=kind)
682
621
inv.add_path(f, kind=kind, file_id=file_id)
683
self._inventory_is_modified = True
622
self._write_inventory(inv)
685
624
@needs_tree_write_lock
686
625
def _gather_kinds(self, files, kinds):
884
774
def set_merge_modified(self, modified_hashes):
885
775
def iter_stanzas():
886
776
for file_id, hash in modified_hashes.iteritems():
887
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
777
yield Stanza(file_id=file_id, hash=hash)
888
778
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.
780
@needs_tree_write_lock
900
781
def _put_rio(self, filename, stanzas, header):
901
self._must_be_locked()
902
782
my_file = rio_file(stanzas, header)
903
self._transport.put_file(filename, my_file,
904
mode=self.bzrdir._get_file_mode())
783
self._control_files.put(filename, my_file)
906
785
@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):
786
def merge_from_branch(self, branch, to_revision=None):
909
787
"""Merge from a branch into this working tree.
911
789
: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
790
:param to_revision: If non-None, the merge will merge to to_revision, but
791
not beyond it. to_revision does not need to be in the history of
792
the branch when it is supplied. If None, to_revision defaults to
915
793
branch.last_revision().
917
795
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:
796
pb = bzrlib.ui.ui_factory.nested_progress_bar()
798
merger = Merger(self.branch, this_tree=self, pb=pb)
799
merger.pp = ProgressPhase("Merge phase", 5, pb)
800
merger.pp.next_phase()
801
# check that there are no
803
merger.check_basis(check_clean=True, require_commits=False)
804
if to_revision is None:
805
to_revision = branch.last_revision()
806
merger.other_rev_id = to_revision
807
if merger.other_rev_id is None:
808
raise error.NoCommits(branch)
809
self.branch.fetch(branch, last_revision=merger.other_rev_id)
810
merger.other_basis = merger.other_rev_id
811
merger.other_tree = self.branch.repository.revision_tree(
813
merger.pp.next_phase()
933
814
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:
815
if merger.base_rev_id == merger.other_rev_id:
816
raise errors.PointlessMerge
817
merger.backup_files = False
940
818
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()
819
merger.set_interesting_files(None)
820
merger.show_base = False
821
merger.reprocess = False
822
conflicts = merger.do_merge()
951
829
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:
831
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
836
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
837
raise MergeModifiedFormatError()
838
except StopIteration:
839
raise MergeModifiedFormatError()
840
for s in RioReader(hashfile):
841
file_id = s.get("file_id")
842
if file_id not in self.inventory:
845
if hash == self.get_file_sha1(file_id):
846
merge_hashes[file_id] = hash
984
849
@needs_write_lock
985
850
def mkdir(self, path, file_id=None):
986
851
"""See MutableTree.mkdir()."""
987
852
if file_id is None:
988
file_id = generate_ids.gen_file_id(os.path.basename(path))
853
file_id = gen_file_id(os.path.basename(path))
989
854
os.mkdir(self.abspath(path))
990
855
self.add(path, file_id, 'directory')
993
858
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)
859
return os.readlink(self.id2abspath(file_id))
861
def file_class(self, filename):
862
if self.path2id(filename):
864
elif self.is_ignored(filename):
1123
869
def flush(self):
1124
870
"""Write the in memory inventory to disk."""
1240
973
except KeyError:
1241
974
yield fp[1:], c, fk, None, TreeEntry()
1244
977
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
980
# But do this child first
981
new_children = os.listdir(fap)
983
new_children = collections.deque(new_children)
984
stack.append((f_ie.file_id, fp, fap, new_children))
985
# Break out of inner loop, so that we start outer loop with child
1257
988
# if we finished all children, pop it off the stack
1260
991
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
992
def move(self, from_paths, to_name):
1262
993
"""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;
995
to_name must exist in the inventory.
997
If to_name exists and is a directory, the files are moved into
998
it, keeping their old names.
1000
Note that to_name is only the last component of the new name;
1270
1001
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
1003
This returns a list of (from_path, to_path) pairs for each
1294
1004
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):
1007
## TODO: Option to move IDs only
1008
assert not isinstance(from_paths, basestring)
1312
1009
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
1010
to_abs = self.abspath(to_name)
1314
1011
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)))
1012
raise BzrError("destination %r is not a directory" % to_abs)
1013
if not self.has_filename(to_name):
1014
raise BzrError("destination %r not in working directory" % to_abs)
1015
to_dir_id = inv.path2id(to_name)
1016
if to_dir_id is None and to_name != '':
1017
raise BzrError("destination %r is not a versioned directory" % to_name)
1325
1018
to_dir_ie = inv[to_dir_id]
1326
1019
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)
1020
raise BzrError("destination %r is not a directory" % to_abs)
1022
to_idpath = inv.get_idpath(to_dir_id)
1024
for f in from_paths:
1025
if not self.has_filename(f):
1026
raise BzrError("%r does not exist in working tree" % f)
1027
f_id = inv.path2id(f)
1029
raise BzrError("%r is not versioned" % f)
1030
name_tail = splitpath(f)[-1]
1031
dest_path = pathjoin(to_name, name_tail)
1032
if self.has_filename(dest_path):
1033
raise BzrError("destination %r already exists" % dest_path)
1034
if f_id in to_idpath:
1035
raise BzrError("can't move %r to a subdirectory of itself" % f)
1037
# OK, so there's a race here, it's possible that someone will
1038
# create a file in this interval and then the rename might be
1039
# left half-done. But we should have caught most problems.
1040
orig_inv = deepcopy(self.inventory)
1353
1041
original_modified = self._inventory_is_modified
1355
1043
if len(from_paths):
1356
1044
self._inventory_is_modified = True
1357
self._move(rename_entries)
1045
for f in from_paths:
1046
name_tail = splitpath(f)[-1]
1047
dest_path = pathjoin(to_name, name_tail)
1048
result.append((f, dest_path))
1049
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1051
osutils.rename(self.abspath(f), self.abspath(dest_path))
1053
raise BzrError("failed to rename %r to %r: %s" %
1054
(f, dest_path, e[1]))
1359
1056
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
1057
self._set_inventory(orig_inv, dirty=original_modified)
1362
1059
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
1062
@needs_tree_write_lock
1467
def rename_one(self, from_rel, to_rel, after=False):
1063
def rename_one(self, from_rel, to_rel):
1468
1064
"""Rename one file.
1470
1066
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
1068
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
1069
if not self.has_filename(from_rel):
1070
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1071
if self.has_filename(to_rel):
1072
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1074
file_id = inv.path2id(from_rel)
1076
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1078
entry = inv[file_id]
1079
from_parent = entry.parent_id
1080
from_name = entry.name
1082
if inv.path2id(to_rel):
1083
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1509
1085
to_dir, to_tail = os.path.split(to_rel)
1510
1086
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)
1087
if to_dir_id is None and to_dir != '':
1088
raise BzrError("can't determine destination directory id for %r" % to_dir)
1090
mutter("rename_one:")
1091
mutter(" file_id {%s}" % file_id)
1092
mutter(" from_rel %r" % from_rel)
1093
mutter(" to_rel %r" % to_rel)
1094
mutter(" to_dir %r" % to_dir)
1095
mutter(" to_dir_id {%s}" % to_dir_id)
1097
inv.rename(file_id, to_dir_id, to_tail)
1099
from_abs = self.abspath(from_rel)
1100
to_abs = self.abspath(to_rel)
1102
osutils.rename(from_abs, to_abs)
1104
inv.rename(file_id, from_parent, from_name)
1105
raise BzrError("failed to rename %r to %r: %s"
1106
% (from_abs, to_abs, e[1]))
1538
1107
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
1109
@needs_read_lock
1553
1110
def unknowns(self):
1554
1111
"""Return all unknown files.
1714
1324
if ignoreset is not None:
1715
1325
return ignoreset
1717
ignore_globs = set()
1327
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1718
1328
ignore_globs.update(ignores.get_runtime_ignores())
1719
1330
ignore_globs.update(ignores.get_user_ignores())
1720
1332
if self.has_filename(bzrlib.IGNORE_FILENAME):
1721
1333
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1723
1335
ignore_globs.update(ignores.parse_ignore_file(f))
1726
1339
self._ignoreset = ignore_globs
1340
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1727
1341
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
1343
def _get_ignore_rules_as_regex(self):
1344
"""Return a regex of the ignore rules and a mapping dict.
1346
:return: (ignore rules compiled regex, dictionary mapping rule group
1347
indices to original rule.)
1349
if getattr(self, '_ignoreset', None) is None:
1350
self.get_ignore_list()
1351
return self._ignore_regex
1734
1353
def is_ignored(self, filename):
1735
1354
r"""Check whether the filename matches an ignore pattern.
1737
1356
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.
1357
others match against only the last component.
1742
1359
If the file is ignored, returns the pattern which caused it to
1743
1360
be ignored, otherwise None. So this can simply be used as a
1744
1361
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)
1363
# TODO: Use '**' to match directories, and other extended
1364
# globbing stuff from cvs/rsync.
1366
# XXX: fnmatch is actually not quite what we want: it's only
1367
# approximately the same as real Unix fnmatch, and doesn't
1368
# treat dotfiles correctly and allows * to match /.
1369
# Eventually it should be replaced with something more
1372
rules = self._get_ignore_rules_as_regex()
1373
for regex, mapping in rules:
1374
match = regex.match(filename)
1375
if match is not None:
1376
# one or more of the groups in mapping will have a non-None
1378
groups = match.groups()
1379
rules = [mapping[group] for group in
1380
mapping if groups[group] is not None]
1749
1384
def kind(self, file_id):
1750
1385
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
1387
def last_revision(self):
1780
1388
"""Return the last revision of the branch for this tree.
1925
1499
def read_basis_inventory(self):
1926
1500
"""Read the cached basis inventory."""
1927
1501
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1502
return self._control_files.get(path).read()
1930
1504
@needs_read_lock
1931
1505
def read_working_inventory(self):
1932
1506
"""Read the working inventory.
1934
1508
:raises errors.InventoryModified: read_working_inventory will fail
1935
1509
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1511
# conceptually this should be an implementation detail of the tree.
1938
1512
# XXX: Deprecate this.
1939
1513
# ElementTree does its own conversion from UTF-8, so open in
1941
1515
if self._inventory_is_modified:
1942
1516
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1517
result = xml5.serializer_v5.read_inventory(
1518
self._control_files.get('inventory'))
1948
1519
self._set_inventory(result, dirty=False)
1951
1522
@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.
1523
def remove(self, files, verbose=False, to_file=None):
1524
"""Remove nominated files from the working inventory..
1526
This does not remove their text. This does not run on XXX on what? RBC
1528
TODO: Refuse to remove modified files unless --force is given?
1530
TODO: Do something useful with directories.
1532
TODO: Should this remove the text or not? Tough call; not
1533
removing may be useful and the user can just use use rm, and
1534
is the opposite of add. Removing it is consistent with most
1535
other tools. Maybe an option.
1537
## TODO: Normalize names
1538
## TODO: Remove nested loops; better scalability
1961
1539
if isinstance(files, basestring):
1962
1540
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 self.walkdirs(directory):
1975
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
# Is it versioned or ignored?
1977
if self.path2id(relpath) or self.is_ignored(relpath):
1978
# Add nested content for deletion.
1979
new_files.add(relpath)
1981
# Files which are not versioned and not ignored
1982
# should be treated as unknown.
1983
unknown_nested_files.add((relpath, None, kind))
1985
for filename in files:
1986
# Get file name into canonical form.
1987
abspath = self.abspath(filename)
1988
filename = self.relpath(abspath)
1989
if len(filename) > 0:
1990
new_files.add(filename)
1991
recurse_directory_to_add_files(filename)
1993
files = list(new_files)
1996
return # nothing to do
1998
# Sort needed to first handle directory content before the directory
1999
files.sort(reverse=True)
2001
# Bail out if we are going to delete files we shouldn't
2002
if not keep_files and not force:
2003
has_changed_files = len(unknown_nested_files) > 0
2004
if not has_changed_files:
2005
for (file_id, path, content_change, versioned, parent_id, name,
2006
kind, executable) in self.iter_changes(self.basis_tree(),
2007
include_unchanged=True, require_versioned=False,
2008
want_unversioned=True, specific_files=files):
2009
if versioned == (False, False):
2010
# The record is unknown ...
2011
if not self.is_ignored(path[1]):
2012
# ... but not ignored
2013
has_changed_files = True
2015
elif (content_change and (kind[1] is not None) and
2016
osutils.is_inside_any(files, path[1])):
2017
# Versioned and changed, but not deleted, and still
2018
# in one of the dirs to be deleted.
2019
has_changed_files = True
2022
if has_changed_files:
2023
# Make delta show ALL applicable changes in error message.
2024
tree_delta = self.changes_from(self.basis_tree(),
2025
require_versioned=False, want_unversioned=True,
2026
specific_files=files)
2027
for unknown_file in unknown_nested_files:
2028
if unknown_file not in tree_delta.unversioned:
2029
tree_delta.unversioned.extend((unknown_file,))
2030
raise errors.BzrRemoveChangedFilesError(tree_delta)
2032
# Build inv_delta and delete files where applicable,
2033
# do this before any modifications to inventory.
1542
inv = self.inventory
1544
# do this before any modifications
2034
1545
for f in files:
2035
fid = self.path2id(f)
1546
fid = inv.path2id(f)
2038
message = "%s is not versioned." % (f,)
2041
# having removed it, it must be either ignored or unknown
2042
if self.is_ignored(f):
2046
# XXX: Really should be a more abstract reporter interface
2047
kind_ch = osutils.kind_marker(self.kind(fid))
2048
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2050
inv_delta.append((f, None, fid, None))
2051
message = "removed %s" % (f,)
2054
abs_path = self.abspath(f)
2055
if osutils.lexists(abs_path):
2056
if (osutils.isdir(abs_path) and
2057
len(os.listdir(abs_path)) > 0):
2059
osutils.rmtree(abs_path)
2061
message = "%s is not an empty directory "\
2062
"and won't be deleted." % (f,)
2064
osutils.delete_any(abs_path)
2065
message = "deleted %s" % (f,)
2066
elif message is not None:
2067
# Only care if we haven't done anything yet.
2068
message = "%s does not exist." % (f,)
2070
# Print only one message (if any) per file.
2071
if message is not None:
2073
self.apply_inventory_delta(inv_delta)
1548
# TODO: Perhaps make this just a warning, and continue?
1549
# This tends to happen when
1550
raise NotVersionedError(path=f)
1552
# having remove it, it must be either ignored or unknown
1553
if self.is_ignored(f):
1557
textui.show_status(new_status, inv[fid].kind, f,
1561
self._write_inventory(inv)
2075
1563
@needs_tree_write_lock
2076
def revert(self, filenames=None, old_tree=None, backups=True,
2077
pb=None, report_changes=False):
1564
def revert(self, filenames, old_tree=None, backups=True,
1565
pb=DummyProgress()):
2078
1566
from bzrlib.conflicts import resolve
2081
symbol_versioning.warn('Using [] to revert all files is deprecated'
2082
' as of bzr 0.91. Please use None (the default) instead.',
2083
DeprecationWarning, stacklevel=2)
2084
1567
if old_tree is None:
2085
basis_tree = self.basis_tree()
2086
basis_tree.lock_read()
2087
old_tree = basis_tree
1568
old_tree = self.basis_tree()
1569
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1570
if not len(filenames):
1571
self.set_parent_ids(self.get_parent_ids()[:1])
2091
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2093
if filenames is None and len(self.get_parent_ids()) > 1:
2095
last_revision = self.last_revision()
2096
if last_revision != _mod_revision.NULL_REVISION:
2097
if basis_tree is None:
2098
basis_tree = self.basis_tree()
2099
basis_tree.lock_read()
2100
parent_trees.append((last_revision, basis_tree))
2101
self.set_parent_trees(parent_trees)
2104
resolve(self, filenames, ignore_misses=True, recursive=True)
2106
if basis_tree is not None:
1574
resolve(self, filenames, ignore_misses=True)
2108
1575
return conflicts
2110
def revision_tree(self, revision_id):
2111
"""See Tree.revision_tree.
2113
WorkingTree can supply revision_trees for the basis revision only
2114
because there is only one cached inventory in the bzr directory.
2116
if revision_id == self.last_revision():
2118
xml = self.read_basis_inventory()
2119
except errors.NoSuchFile:
2123
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2124
# dont use the repository revision_tree api because we want
2125
# to supply the inventory.
2126
if inv.revision_id == revision_id:
2127
return revisiontree.RevisionTree(self.branch.repository,
2129
except errors.BadInventoryFormat:
2131
# raise if there was no inventory, or if we read the wrong inventory.
2132
raise errors.NoSuchRevisionInTree(self, revision_id)
2134
1577
# XXX: This method should be deprecated in favour of taking in a proper
2135
1578
# new Inventory object.
2136
1579
@needs_tree_write_lock
2137
1580
def set_inventory(self, new_inventory_list):
2138
1581
from bzrlib.inventory import (Inventory,
2139
1582
InventoryDirectory,
2142
1586
inv = Inventory(self.get_root_id())
2265
1692
# cant set that until we update the working trees last revision to be
2266
1693
# one from the new branch, because it will just get absorbed by the
2267
1694
# parent de-duplication logic.
2269
1696
# We MUST save it even if an error occurs, because otherwise the users
2270
1697
# local work is unreferenced and will appear to have been lost.
2274
1701
last_rev = self.get_parent_ids()[0]
2275
1702
except IndexError:
2276
last_rev = _mod_revision.NULL_REVISION
2277
if revision is None:
2278
revision = self.branch.last_revision()
2280
old_tip = old_tip or _mod_revision.NULL_REVISION
2282
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
# the branch we are bound to was updated
2284
# merge those changes in first
2285
base_tree = self.basis_tree()
2286
other_tree = self.branch.repository.revision_tree(old_tip)
2287
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
base_tree, this_tree=self,
2289
change_reporter=change_reporter)
2291
self.add_parent_tree((old_tip, other_tree))
2292
trace.note('Rerun update after fixing the conflicts.')
2295
if last_rev != _mod_revision.ensure_null(revision):
2296
# the working tree is up to date with the branch
2297
# we can merge the specified revision from master
2298
to_tree = self.branch.repository.revision_tree(revision)
2299
to_root_id = to_tree.get_root_id()
1704
if last_rev != self.branch.last_revision():
1705
# merge tree state up to new branch tip.
2301
1706
basis = self.basis_tree()
2304
if (basis.inventory.root is None
2305
or basis.inventory.root.file_id != to_root_id):
2306
self.set_root_id(to_root_id)
2311
# determine the branch point
2312
graph = self.branch.repository.get_graph()
2313
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
change_reporter=change_reporter)
2320
self.set_last_revision(revision)
1707
to_tree = self.branch.basis_tree()
1708
if basis.inventory.root is None:
1709
self.set_root_id(to_tree.inventory.root.file_id)
1710
result += merge.merge_inner(
2321
1715
# TODO - dedup parents list with things merged by pull ?
2322
1716
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
1717
parent_trees = [(self.branch.last_revision(), to_tree)]
2324
1718
merges = self.get_parent_ids()[1:]
2325
1719
# Ideally we ask the tree for the trees here, that way the working
2326
# tree can decide whether to give us the entire tree or give us a
1720
# tree can decide whether to give us teh entire tree or give us a
2327
1721
# lazy initialised tree. dirstate for instance will have the trees
2328
1722
# in ram already, whereas a last-revision + basis-inventory tree
2329
1723
# will not, but also does not need them when setting parents.
2330
1724
for parent in merges:
2331
1725
parent_trees.append(
2332
1726
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
1727
if old_tip is not None:
2334
1728
parent_trees.append(
2335
1729
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
1730
self.set_parent_trees(parent_trees)
2337
1731
last_rev = parent_trees[0][0]
2340
def _write_hashcache_if_dirty(self):
2341
"""Write out the hashcache if it is dirty."""
2342
if self._hashcache.needs_write:
1733
# the working tree had the same last-revision as the master
1734
# branch did. We may still have pivot local work from the local
1735
# branch into old_tip:
1736
if old_tip is not None:
1737
self.add_parent_tree_id(old_tip)
1738
if old_tip and old_tip != last_rev:
1739
# our last revision was not the prior branch last revision
1740
# and we have converted that last revision to a pending merge.
1741
# base is somewhere between the branch tip now
1742
# and the now pending merge
1743
from bzrlib.revision import common_ancestor
2344
self._hashcache.write()
2346
if e.errno not in (errno.EPERM, errno.EACCES):
2348
# TODO: jam 20061219 Should this be a warning? A single line
2349
# warning might be sufficient to let the user know what
2351
mutter('Could not write hashcache for %s\nError: %s',
2352
self._hashcache.cache_file_name(), e)
1745
base_rev_id = common_ancestor(self.branch.last_revision(),
1747
self.branch.repository)
1748
except errors.NoCommonAncestor:
1750
base_tree = self.branch.repository.revision_tree(base_rev_id)
1751
other_tree = self.branch.repository.revision_tree(old_tip)
1752
result += merge.merge_inner(
2354
1759
@needs_tree_write_lock
2355
1760
def _write_inventory(self, inv):
2389
1794
file_id=self.path2id(conflicted)))
2390
1795
return conflicts
2392
def walkdirs(self, prefix=""):
2393
"""Walk the directories of this tree.
2395
returns a generator which yields items in the form:
2396
((curren_directory_path, fileid),
2397
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2400
This API returns a generator, which is only valid during the current
2401
tree transaction - within a single lock_read or lock_write duration.
2403
If the tree is not locked, it may cause an error to be raised,
2404
depending on the tree implementation.
2406
disk_top = self.abspath(prefix)
2407
if disk_top.endswith('/'):
2408
disk_top = disk_top[:-1]
2409
top_strip_len = len(disk_top) + 1
2410
inventory_iterator = self._walkdirs(prefix)
2411
disk_iterator = osutils.walkdirs(disk_top, prefix)
2413
current_disk = disk_iterator.next()
2414
disk_finished = False
2416
if not (e.errno == errno.ENOENT or
2417
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2420
disk_finished = True
2422
current_inv = inventory_iterator.next()
2423
inv_finished = False
2424
except StopIteration:
2427
while not inv_finished or not disk_finished:
2429
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2430
cur_disk_dir_content) = current_disk
2432
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
cur_disk_dir_content) = ((None, None), None)
2434
if not disk_finished:
2435
# strip out .bzr dirs
2436
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2437
len(cur_disk_dir_content) > 0):
2438
# osutils.walkdirs can be made nicer -
2439
# yield the path-from-prefix rather than the pathjoined
2441
bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
if (bzrdir_loc < len(cur_disk_dir_content)
2444
and self.bzrdir.is_control_filename(
2445
cur_disk_dir_content[bzrdir_loc][0])):
2446
# we dont yield the contents of, or, .bzr itself.
2447
del cur_disk_dir_content[bzrdir_loc]
2449
# everything is unknown
2452
# everything is missing
2455
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2457
# disk is before inventory - unknown
2458
dirblock = [(relpath, basename, kind, stat, None, None) for
2459
relpath, basename, kind, stat, top_path in
2460
cur_disk_dir_content]
2461
yield (cur_disk_dir_relpath, None), dirblock
2463
current_disk = disk_iterator.next()
2464
except StopIteration:
2465
disk_finished = True
2467
# inventory is before disk - missing.
2468
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
for relpath, basename, dkind, stat, fileid, kind in
2471
yield (current_inv[0][0], current_inv[0][1]), dirblock
2473
current_inv = inventory_iterator.next()
2474
except StopIteration:
2477
# versioned present directory
2478
# merge the inventory and disk data together
2480
for relpath, subiterator in itertools.groupby(sorted(
2481
current_inv[1] + cur_disk_dir_content,
2482
key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
path_elements = list(subiterator)
2484
if len(path_elements) == 2:
2485
inv_row, disk_row = path_elements
2486
# versioned, present file
2487
dirblock.append((inv_row[0],
2488
inv_row[1], disk_row[2],
2489
disk_row[3], inv_row[4],
2491
elif len(path_elements[0]) == 5:
2493
dirblock.append((path_elements[0][0],
2494
path_elements[0][1], path_elements[0][2],
2495
path_elements[0][3], None, None))
2496
elif len(path_elements[0]) == 6:
2497
# versioned, absent file.
2498
dirblock.append((path_elements[0][0],
2499
path_elements[0][1], 'unknown', None,
2500
path_elements[0][4], path_elements[0][5]))
2502
raise NotImplementedError('unreachable code')
2503
yield current_inv[0], dirblock
2505
current_inv = inventory_iterator.next()
2506
except StopIteration:
2509
current_disk = disk_iterator.next()
2510
except StopIteration:
2511
disk_finished = True
2513
def _walkdirs(self, prefix=""):
2514
"""Walk the directories of this tree.
2516
:prefix: is used as the directrory to start with.
2517
returns a generator which yields items in the form:
2518
((curren_directory_path, fileid),
2519
[(file1_path, file1_name, file1_kind, None, file1_id,
2522
_directory = 'directory'
2523
# get the root in the inventory
2524
inv = self.inventory
2525
top_id = inv.path2id(prefix)
2529
pending = [(prefix, '', _directory, None, top_id, None)]
2532
currentdir = pending.pop()
2533
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2534
top_id = currentdir[4]
2536
relroot = currentdir[0] + '/'
2539
# FIXME: stash the node in pending
2541
if entry.kind == 'directory':
2542
for name, child in entry.sorted_children():
2543
dirblock.append((relroot + name, name, child.kind, None,
2544
child.file_id, child.kind
2546
yield (currentdir[0], entry.file_id), dirblock
2547
# push the user specified dirs from dirblock
2548
for dir in reversed(dirblock):
2549
if dir[2] == _directory:
2552
@needs_tree_write_lock
2553
def auto_resolve(self):
2554
"""Automatically resolve text conflicts according to contents.
2556
Only text conflicts are auto_resolvable. Files with no conflict markers
2557
are considered 'resolved', because bzr always puts conflict markers
2558
into files that have text conflicts. The corresponding .THIS .BASE and
2559
.OTHER files are deleted, as per 'resolve'.
2560
:return: a tuple of ConflictLists: (un_resolved, resolved).
2562
un_resolved = _mod_conflicts.ConflictList()
2563
resolved = _mod_conflicts.ConflictList()
2564
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2565
for conflict in self.conflicts():
2566
if (conflict.typestring != 'text conflict' or
2567
self.kind(conflict.file_id) != 'file'):
2568
un_resolved.append(conflict)
2570
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2572
for line in my_file:
2573
if conflict_re.search(line):
2574
un_resolved.append(conflict)
2577
resolved.append(conflict)
2580
resolved.remove_files(self)
2581
self.set_conflicts(un_resolved)
2582
return un_resolved, resolved
2585
def _check(self, references):
2586
"""Check the tree for consistency.
2588
:param references: A dict with keys matching the items returned by
2589
self._get_check_refs(), and values from looking those keys up in
2592
tree_basis = self.basis_tree()
2593
tree_basis.lock_read()
2595
repo_basis = references[('trees', self.last_revision())]
2596
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
raise errors.BzrCheckError(
2598
"Mismatched basis inventory content.")
2603
def _validate(self):
2604
"""Validate internal structures.
2606
This is meant mostly for the test suite. To give it a chance to detect
2607
corruption after actions have occurred. The default implementation is a
2610
:return: None. An exception should be raised if there is an error.
2614
def _get_rules_searcher(self, default_searcher):
2615
"""See Tree._get_rules_searcher."""
2616
if self._rules_searcher is None:
2617
self._rules_searcher = super(WorkingTree,
2618
self)._get_rules_searcher(default_searcher)
2619
return self._rules_searcher
2621
def get_shelf_manager(self):
2622
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
2624
return ShelfManager(self, self._transport)
2627
1798
class WorkingTree2(WorkingTree):
2628
1799
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
1801
This was the first weave based working tree.
2631
1802
- uses os locks for locking.
2632
1803
- uses the branch last-revision.
2635
def __init__(self, *args, **kwargs):
2636
super(WorkingTree2, self).__init__(*args, **kwargs)
2637
# WorkingTree2 has more of a constraint that self._inventory must
2638
# exist. Because this is an older format, we don't mind the overhead
2639
# caused by the extra computation here.
2641
# Newer WorkingTree's should only have self._inventory set when they
2643
if self._inventory is None:
2644
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
2650
1806
def lock_tree_write(self):
2651
1807
"""See WorkingTree.lock_tree_write().
2653
1809
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
1810
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
2659
1812
self.branch.lock_write()
2661
self._control_files.lock_write()
1814
return self._control_files.lock_write()
2664
1816
self.branch.unlock()
2667
1819
def unlock(self):
2668
# do non-implementation specific cleanup
2671
1820
# we share control files:
2672
1821
if self._control_files._lock_count == 3:
2673
1822
# _inventory_is_modified is always False during a read lock.
2674
1823
if self._inventory_is_modified:
2676
self._write_hashcache_if_dirty()
1825
if self._hashcache.needs_write:
1826
self._hashcache.write()
2678
1827
# reverse order of locking.
2680
1829
return self._control_files.unlock()
2855
1991
def unregister_format(klass, format):
1992
assert klass._formats[format.get_format_string()] is format
2856
1993
del klass._formats[format.get_format_string()]
2859
1997
class WorkingTreeFormat2(WorkingTreeFormat):
2860
"""The second working tree format.
1998
"""The second working tree format.
2862
2000
This format modified the hash cache from the format 1 hash cache.
2865
upgrade_recommended = True
2867
2003
def get_format_description(self):
2868
2004
"""See WorkingTreeFormat.get_format_description()."""
2869
2005
return "Working tree format 2"
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2007
def stub_initialize_remote(self, control_files):
2008
"""As a special workaround create critical control files for a remote working tree
2874
2010
This ensures that it can later be updated and dealt with locally,
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2011
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
2012
no working tree. (See bug #43064).
2878
2014
sio = StringIO()
2879
inv = inventory.Inventory()
2880
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2016
xml5.serializer_v5.write_inventory(inv, sio)
2882
transport.put_file('inventory', sio, file_mode)
2883
transport.put_bytes('pending-merges', '', file_mode)
2885
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
accelerator_tree=None, hardlink=False):
2018
control_files.put('inventory', sio)
2020
control_files.put_utf8('pending-merges', '')
2023
def initialize(self, a_bzrdir, revision_id=None):
2887
2024
"""See WorkingTreeFormat.initialize()."""
2888
2025
if not isinstance(a_bzrdir.transport, LocalTransport):
2889
2026
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2890
if from_branch is not None:
2891
branch = from_branch
2893
branch = a_bzrdir.open_branch()
2894
if revision_id is None:
2895
revision_id = _mod_revision.ensure_null(branch.last_revision())
2898
branch.generate_revision_history(revision_id)
2901
inv = inventory.Inventory()
2027
branch = a_bzrdir.open_branch()
2028
if revision_id is not None:
2031
revision_history = branch.revision_history()
2033
position = revision_history.index(revision_id)
2035
raise errors.NoSuchRevision(branch, revision_id)
2036
branch.set_revision_history(revision_history[:position + 1])
2039
revision = branch.last_revision()
2902
2041
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2905
2044
_internal=True,
2907
2046
_bzrdir=a_bzrdir)
2908
basis_tree = branch.repository.revision_tree(revision_id)
2047
basis_tree = branch.repository.revision_tree(revision)
2909
2048
if basis_tree.inventory.root is not None:
2910
wt.set_root_id(basis_tree.get_root_id())
2049
wt.set_root_id(basis_tree.inventory.root.file_id)
2911
2050
# set the parent list and cache the basis tree.
2912
if _mod_revision.is_null(revision_id):
2915
parent_trees = [(revision_id, basis_tree)]
2916
wt.set_parent_trees(parent_trees)
2051
wt.set_parent_trees([(revision, basis_tree)])
2917
2052
transform.build_tree(basis_tree, wt)
3050
2163
raise NotImplementedError
3051
2164
if not isinstance(a_bzrdir.transport, LocalTransport):
3052
2165
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3053
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2166
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3056
2168
def _open(self, a_bzrdir, control_files):
3057
2169
"""Open the tree itself.
3059
2171
:param a_bzrdir: the dir for the tree.
3060
2172
:param control_files: the control files for the tree.
3062
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3066
_control_files=control_files)
2174
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2178
_control_files=control_files)
3068
2180
def __str__(self):
3069
2181
return self.get_format_string()
3072
__default_format = WorkingTreeFormat6()
2184
# formats which have no format string are not discoverable
2185
# and not independently creatable, so are not registered.
2186
__default_format = WorkingTreeFormat3()
3073
2187
WorkingTreeFormat.register_format(__default_format)
3074
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2188
WorkingTreeFormat.set_default_format(__default_format)
3078
# formats which have no format string are not discoverable
3079
# and not independently creatable, so are not registered.
3080
2189
_legacy_formats = [WorkingTreeFormat2(),
2193
class WorkingTreeTestProviderAdapter(object):
2194
"""A tool to generate a suite testing multiple workingtree formats at once.
2196
This is done by copying the test once for each transport and injecting
2197
the transport_server, transport_readonly_server, and workingtree_format
2198
classes into each copy. Each copy is also given a new id() to make it
2202
def __init__(self, transport_server, transport_readonly_server, formats):
2203
self._transport_server = transport_server
2204
self._transport_readonly_server = transport_readonly_server
2205
self._formats = formats
2207
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2208
"""Clone test for adaption."""
2209
new_test = deepcopy(test)
2210
new_test.transport_server = self._transport_server
2211
new_test.transport_readonly_server = self._transport_readonly_server
2212
new_test.bzrdir_format = bzrdir_format
2213
new_test.workingtree_format = workingtree_format
2214
def make_new_test_id():
2215
new_id = "%s(%s)" % (test.id(), variation)
2216
return lambda: new_id
2217
new_test.id = make_new_test_id()
2220
def adapt(self, test):
2221
from bzrlib.tests import TestSuite
2222
result = TestSuite()
2223
for workingtree_format, bzrdir_format in self._formats:
2224
new_test = self._clone_test(
2227
workingtree_format, workingtree_format.__class__.__name__)
2228
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
