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,
68
from bzrlib.transport import get_transport
70
from bzrlib.workingtree_4 import (
72
77
from bzrlib import symbol_versioning
73
78
from bzrlib.decorators import needs_read_lock, needs_write_lock
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
79
from bzrlib.lock import LogicalLockResult
80
from bzrlib.lockable_files import LockableFiles
86
81
from bzrlib.lockdir import LockDir
87
82
import bzrlib.mutabletree
88
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
89
85
from bzrlib.osutils import (
99
93
supports_executable,
95
from bzrlib.filters import filtered_input_file
101
96
from bzrlib.trace import mutter, note
102
97
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION
106
import bzrlib.revisiontree
98
from bzrlib.revision import CURRENT_REVISION
107
99
from bzrlib.rio import RioReader, rio_file, Stanza
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
117
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.
118
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
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')
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
171
115
class TreeEntry(object):
172
116
"""An entry that implements the minimum interface used by commands.
174
This needs further inspection, it may be better to have
118
This needs further inspection, it may be better to have
175
119
InventoryEntries without ids - though that seems wrong. For now,
176
120
this is a parallel hierarchy to InventoryEntry, and needs to become
177
121
one of several things: decorates to that hierarchy, children of, or
417
414
# no parents, return an empty revision tree.
418
415
# in the future this should return the tree for
419
416
# 'empty:' - the implicit root empty tree.
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):
417
return self.branch.repository.revision_tree(
418
_mod_revision.NULL_REVISION)
420
return self.revision_tree(revision_id)
421
except errors.NoSuchRevision:
430
423
# No cached copy available, retrieve from the repository.
431
424
# FIXME? RBC 20060403 should we cache the inventory locally
432
425
# at this point ?
434
427
return self.branch.repository.revision_tree(revision_id)
435
except errors.RevisionNotPresent:
428
except (errors.RevisionNotPresent, errors.NoSuchRevision):
436
429
# the basis tree *may* be a ghost or a low level error may have
437
# occured. If the revision is present, its a problem, if its not
430
# occurred. If the revision is present, its a problem, if its not
439
432
if self.branch.repository.has_revision(revision_id):
441
434
# the basis tree is a ghost so return an empty tree.
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)
435
return self.branch.repository.revision_tree(
436
_mod_revision.NULL_REVISION)
439
self._flush_ignore_list_cache()
482
441
def relpath(self, path):
483
442
"""Return the local path portion from a given path.
485
The path may be absolute or relative. If its a relative path it is
444
The path may be absolute or relative. If its a relative path it is
486
445
interpreted relative to the python current working directory.
488
447
return osutils.relpath(self.basedir, path)
490
449
def has_filename(self, filename):
491
450
return osutils.lexists(self.abspath(filename))
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')
452
def get_file(self, file_id, path=None, filtered=True):
453
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
455
def get_file_with_stat(self, file_id, path=None, filtered=True,
457
"""See Tree.get_file_with_stat."""
459
path = self.id2path(file_id)
460
file_obj = self.get_file_byname(path, filtered=False)
461
stat_value = _fstat(file_obj.fileno())
462
if filtered and self.supports_content_filtering():
463
filters = self._content_filter_stack(path)
464
file_obj = filtered_input_file(file_obj, filters)
465
return (file_obj, stat_value)
467
def get_file_text(self, file_id, path=None, filtered=True):
468
my_file = self.get_file(file_id, path=path, filtered=filtered)
470
return my_file.read()
474
def get_file_byname(self, filename, filtered=True):
475
path = self.abspath(filename)
477
if filtered and self.supports_content_filtering():
478
filters = self._content_filter_stack(filename)
479
return filtered_input_file(f, filters)
483
def get_file_lines(self, file_id, path=None, filtered=True):
484
"""See Tree.get_file_lines()"""
485
file = self.get_file(file_id, path, filtered=filtered)
487
return file.readlines()
492
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
"""See Tree.annotate_iter
495
This implementation will use the basis tree implementation if possible.
496
Lines not in the basis are attributed to CURRENT_REVISION
498
If there are pending merges, lines added by those merges will be
499
incorrectly attributed to CURRENT_REVISION (but after committing, the
500
attribution will be correct).
502
maybe_file_parent_keys = []
503
for parent_id in self.get_parent_ids():
505
parent_tree = self.revision_tree(parent_id)
506
except errors.NoSuchRevisionInTree:
507
parent_tree = self.branch.repository.revision_tree(parent_id)
508
parent_tree.lock_read()
510
if file_id not in parent_tree:
512
ie = parent_tree.inventory[file_id]
513
if ie.kind != 'file':
514
# Note: this is slightly unnecessary, because symlinks and
515
# directories have a "text" which is the empty text, and we
516
# know that won't mess up annotations. But it seems cleaner
518
parent_text_key = (file_id, ie.revision)
519
if parent_text_key not in maybe_file_parent_keys:
520
maybe_file_parent_keys.append(parent_text_key)
523
graph = _mod_graph.Graph(self.branch.repository.texts)
524
heads = graph.heads(maybe_file_parent_keys)
525
file_parent_keys = []
526
for key in maybe_file_parent_keys:
528
file_parent_keys.append(key)
530
# Now we have the parents of this content
531
annotator = self.branch.repository.texts.get_annotator()
532
text = self.get_file_text(file_id)
533
this_key =(file_id, default_revision)
534
annotator.add_special_text(this_key, file_parent_keys, text)
535
annotations = [(key[-1], line)
536
for key, line in annotator.annotate_flat(this_key)]
539
def _get_ancestors(self, default_revision):
540
ancestors = set([default_revision])
541
for parent_id in self.get_parent_ids():
542
ancestors.update(self.branch.repository.get_ancestry(
543
parent_id, topo_sorted=False))
502
546
def get_parent_ids(self):
503
547
"""See Tree.get_parent_ids.
505
549
This implementation reads the pending merges list and last_revision
506
550
value and uses that to decide what the parents list should be.
508
last_rev = self._last_revision()
552
last_rev = _mod_revision.ensure_null(self._last_revision())
553
if _mod_revision.NULL_REVISION == last_rev:
512
556
parents = [last_rev]
514
merges_file = self._control_files.get_utf8('pending-merges')
558
merges_bytes = self._transport.get_bytes('pending-merges')
559
except errors.NoSuchFile:
518
for l in merges_file.readlines():
519
parents.append(l.rstrip('\n'))
562
for l in osutils.split_lines(merges_bytes):
563
revision_id = l.rstrip('\n')
564
parents.append(revision_id)
523
568
def get_root_id(self):
524
569
"""Return the id of this trees root"""
525
570
return self._inventory.root.file_id
527
572
def _get_store_filename(self, file_id):
528
573
## XXX: badly named; this is not in the store at all
529
574
return self.abspath(self.id2path(file_id))
532
def clone(self, to_bzrdir, revision_id=None, basis=None):
577
def clone(self, to_bzrdir, revision_id=None):
533
578
"""Duplicate this working tree into to_bzr, including all state.
535
580
Specifically modified files are kept as modified, but
536
581
ignored and unknown files are discarded.
538
583
If you want to make a new line of development, see bzrdir.sprout()
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
586
If not None, the cloned tree will have its last revision set to
587
revision, and difference between the source trees last revision
543
588
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.
549
590
# assumes the target bzr dir format is compatible.
550
result = self._format.initialize(to_bzrdir)
591
result = to_bzrdir.create_workingtree()
551
592
self.copy_content_into(result, revision_id)
582
623
__contains__ = has_id
584
625
def get_file_size(self, file_id):
585
return os.path.getsize(self.id2abspath(file_id))
626
"""See Tree.get_file_size"""
627
# XXX: this returns the on-disk size; it should probably return the
630
return os.path.getsize(self.id2abspath(file_id))
632
if e.errno != errno.ENOENT:
588
def get_file_sha1(self, file_id, path=None):
638
def get_file_sha1(self, file_id, path=None, stat_value=None):
590
640
path = self._inventory.id2path(file_id)
591
return self._hashcache.get_sha1(path)
641
return self._hashcache.get_sha1(path, stat_value)
593
643
def get_file_mtime(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
645
path = self.inventory.id2path(file_id)
596
646
return os.lstat(self.abspath(path)).st_mtime
648
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
649
file_id = self.path2id(path)
651
# For unversioned files on win32, we just assume they are not
654
return self._inventory[file_id].executable
656
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
657
mode = stat_result.st_mode
658
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
598
660
if not supports_executable():
599
661
def is_executable(self, file_id, path=None):
600
662
return self._inventory[file_id].executable
664
_is_executable_from_path_and_stat = \
665
_is_executable_from_path_and_stat_from_basis
602
667
def is_executable(self, file_id, path=None):
604
path = self._inventory.id2path(file_id)
669
path = self.id2path(file_id)
605
670
mode = os.lstat(self.abspath(path)).st_mode
606
671
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
673
_is_executable_from_path_and_stat = \
674
_is_executable_from_path_and_stat_from_stat
676
@needs_tree_write_lock
609
677
def _add(self, files, ids, kinds):
610
678
"""See MutableTree._add."""
611
679
# TODO: Re-adding a file that is removed in the working copy
612
680
# should probably put it back with the previous ID.
613
# the read and write working inventory should not occur in this
681
# the read and write working inventory should not occur in this
614
682
# function - they should be part of lock_write and unlock.
615
inv = self.read_working_inventory()
616
684
for f, file_id, kind in zip(files, ids, kinds):
617
assert kind is not None
618
685
if file_id is None:
619
686
inv.add_path(f, kind=kind)
621
688
inv.add_path(f, kind=kind, file_id=file_id)
622
self._write_inventory(inv)
689
self._inventory_is_modified = True
624
691
@needs_tree_write_lock
625
692
def _gather_kinds(self, files, kinds):
774
890
def set_merge_modified(self, modified_hashes):
775
891
def iter_stanzas():
776
892
for file_id, hash in modified_hashes.iteritems():
777
yield Stanza(file_id=file_id, hash=hash)
893
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
778
894
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
780
@needs_tree_write_lock
896
def _sha_from_stat(self, path, stat_result):
897
"""Get a sha digest from the tree's stat cache.
899
The default implementation assumes no stat cache is present.
901
:param path: The path.
902
:param stat_result: The stat result being looked up.
781
906
def _put_rio(self, filename, stanzas, header):
907
self._must_be_locked()
782
908
my_file = rio_file(stanzas, header)
783
self._control_files.put(filename, my_file)
909
self._transport.put_file(filename, my_file,
910
mode=self.bzrdir._get_file_mode())
785
912
@needs_write_lock # because merge pulls data into the branch.
786
def merge_from_branch(self, branch, to_revision=None):
913
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
914
merge_type=None, force=False):
787
915
"""Merge from a branch into this working tree.
789
917
:param branch: The branch to merge from.
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
918
:param to_revision: If non-None, the merge will merge to to_revision,
919
but not beyond it. to_revision does not need to be in the history
920
of the branch when it is supplied. If None, to_revision defaults to
793
921
branch.last_revision().
795
923
from bzrlib.merge import Merger, Merge3Merger
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()
924
merger = Merger(self.branch, this_tree=self)
925
# check that there are no local alterations
926
if not force and self.has_changes():
927
raise errors.UncommittedChanges(self)
928
if to_revision is None:
929
to_revision = _mod_revision.ensure_null(branch.last_revision())
930
merger.other_rev_id = to_revision
931
if _mod_revision.is_null(merger.other_rev_id):
932
raise errors.NoCommits(branch)
933
self.branch.fetch(branch, last_revision=merger.other_rev_id)
934
merger.other_basis = merger.other_rev_id
935
merger.other_tree = self.branch.repository.revision_tree(
937
merger.other_branch = branch
938
if from_revision is None:
814
939
merger.find_base()
815
if merger.base_rev_id == merger.other_rev_id:
816
raise errors.PointlessMerge
817
merger.backup_files = False
941
merger.set_base_revision(from_revision, branch)
942
if merger.base_rev_id == merger.other_rev_id:
943
raise errors.PointlessMerge
944
merger.backup_files = False
945
if merge_type is None:
818
946
merger.merge_type = Merge3Merger
819
merger.set_interesting_files(None)
820
merger.show_base = False
821
merger.reprocess = False
822
conflicts = merger.do_merge()
948
merger.merge_type = merge_type
949
merger.set_interesting_files(None)
950
merger.show_base = False
951
merger.reprocess = False
952
conflicts = merger.do_merge()
829
957
def merge_modified(self):
958
"""Return a dictionary of files modified by a merge.
960
The list is initialized by WorkingTree.set_merge_modified, which is
961
typically called after we make some automatic updates to the tree
964
This returns a map of file_id->sha1, containing only files which are
965
still in the working inventory and have that text hash.
831
hashfile = self._control_files.get('merge-hashes')
968
hashfile = self._transport.get('merge-hashes')
969
except errors.NoSuchFile:
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
974
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
975
raise errors.MergeModifiedFormatError()
976
except StopIteration:
977
raise errors.MergeModifiedFormatError()
978
for s in RioReader(hashfile):
979
# RioReader reads in Unicode, so convert file_ids back to utf8
980
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
981
if file_id not in self.inventory:
983
text_hash = s.get("hash")
984
if text_hash == self.get_file_sha1(file_id):
985
merge_hashes[file_id] = text_hash
849
990
@needs_write_lock
850
991
def mkdir(self, path, file_id=None):
851
992
"""See MutableTree.mkdir()."""
852
993
if file_id is None:
853
file_id = gen_file_id(os.path.basename(path))
994
file_id = generate_ids.gen_file_id(os.path.basename(path))
854
995
os.mkdir(self.abspath(path))
855
996
self.add(path, file_id, 'directory')
858
999
def get_symlink_target(self, file_id):
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):
1000
abspath = self.id2abspath(file_id)
1001
target = osutils.readlink(abspath)
1005
def subsume(self, other_tree):
1006
def add_children(inventory, entry):
1007
for child_entry in entry.children.values():
1008
inventory._byid[child_entry.file_id] = child_entry
1009
if child_entry.kind == 'directory':
1010
add_children(inventory, child_entry)
1011
if other_tree.get_root_id() == self.get_root_id():
1012
raise errors.BadSubsumeSource(self, other_tree,
1013
'Trees have the same root')
1015
other_tree_path = self.relpath(other_tree.basedir)
1016
except errors.PathNotChild:
1017
raise errors.BadSubsumeSource(self, other_tree,
1018
'Tree is not contained by the other')
1019
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1020
if new_root_parent is None:
1021
raise errors.BadSubsumeSource(self, other_tree,
1022
'Parent directory is not versioned.')
1023
# We need to ensure that the result of a fetch will have a
1024
# versionedfile for the other_tree root, and only fetching into
1025
# RepositoryKnit2 guarantees that.
1026
if not self.branch.repository.supports_rich_root():
1027
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1028
other_tree.lock_tree_write()
1030
new_parents = other_tree.get_parent_ids()
1031
other_root = other_tree.inventory.root
1032
other_root.parent_id = new_root_parent
1033
other_root.name = osutils.basename(other_tree_path)
1034
self.inventory.add(other_root)
1035
add_children(self.inventory, other_root)
1036
self._write_inventory(self.inventory)
1037
# normally we don't want to fetch whole repositories, but i think
1038
# here we really do want to consolidate the whole thing.
1039
for parent_id in other_tree.get_parent_ids():
1040
self.branch.fetch(other_tree.branch, parent_id)
1041
self.add_parent_tree_id(parent_id)
1044
other_tree.bzrdir.retire_bzrdir()
1046
def _setup_directory_is_tree_reference(self):
1047
if self._branch.repository._format.supports_tree_reference:
1048
self._directory_is_tree_reference = \
1049
self._directory_may_be_tree_reference
1051
self._directory_is_tree_reference = \
1052
self._directory_is_never_tree_reference
1054
def _directory_is_never_tree_reference(self, relpath):
1057
def _directory_may_be_tree_reference(self, relpath):
1058
# as a special case, if a directory contains control files then
1059
# it's a tree reference, except that the root of the tree is not
1060
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1061
# TODO: We could ask all the control formats whether they
1062
# recognize this directory, but at the moment there's no cheap api
1063
# to do that. Since we probably can only nest bzr checkouts and
1064
# they always use this name it's ok for now. -- mbp 20060306
1066
# FIXME: There is an unhandled case here of a subdirectory
1067
# containing .bzr but not a branch; that will probably blow up
1068
# when you try to commit it. It might happen if there is a
1069
# checkout in a subdirectory. This can be avoided by not adding
1072
@needs_tree_write_lock
1073
def extract(self, file_id, format=None):
1074
"""Extract a subtree from this tree.
1076
A new branch will be created, relative to the path for this tree.
1080
segments = osutils.splitpath(path)
1081
transport = self.branch.bzrdir.root_transport
1082
for name in segments:
1083
transport = transport.clone(name)
1084
transport.ensure_base()
1087
sub_path = self.id2path(file_id)
1088
branch_transport = mkdirs(sub_path)
1090
format = self.bzrdir.cloning_metadir()
1091
branch_transport.ensure_base()
1092
branch_bzrdir = format.initialize_on_transport(branch_transport)
1094
repo = branch_bzrdir.find_repository()
1095
except errors.NoRepositoryPresent:
1096
repo = branch_bzrdir.create_repository()
1097
if not repo.supports_rich_root():
1098
raise errors.RootNotRich()
1099
new_branch = branch_bzrdir.create_branch()
1100
new_branch.pull(self.branch)
1101
for parent_id in self.get_parent_ids():
1102
new_branch.fetch(self.branch, parent_id)
1103
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1104
if tree_transport.base != branch_transport.base:
1105
tree_bzrdir = format.initialize_on_transport(tree_transport)
1106
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1107
target_branch=new_branch)
1109
tree_bzrdir = branch_bzrdir
1110
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1111
wt.set_parent_ids(self.get_parent_ids())
1112
my_inv = self.inventory
1113
child_inv = inventory.Inventory(root_id=None)
1114
new_root = my_inv[file_id]
1115
my_inv.remove_recursive_id(file_id)
1116
new_root.parent_id = None
1117
child_inv.add(new_root)
1118
self._write_inventory(my_inv)
1119
wt._write_inventory(child_inv)
1122
def _serialize(self, inventory, out_file):
1123
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1126
def _deserialize(selt, in_file):
1127
return xml5.serializer_v5.read_inventory(in_file)
869
1129
def flush(self):
870
1130
"""Write the in memory inventory to disk."""
973
1246
except KeyError:
974
1247
yield fp[1:], c, fk, None, TreeEntry()
977
1250
if fk != 'directory':
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
1253
# But do this child first if recursing down
1255
new_children = os.listdir(fap)
1257
new_children = collections.deque(new_children)
1258
stack.append((f_ie.file_id, fp, fap, new_children))
1259
# Break out of inner loop,
1260
# so that we start outer loop with child
988
1263
# if we finished all children, pop it off the stack
991
1266
@needs_tree_write_lock
992
def move(self, from_paths, to_name):
1267
def move(self, from_paths, to_dir=None, after=False, **kwargs):
993
1268
"""Rename files.
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
to_dir must exist in the inventory.
1272
If to_dir exists and is a directory, the files are moved into
1273
it, keeping their old names.
1275
Note that to_dir is only the last component of the new name;
1001
1276
this doesn't change the directory.
1278
For each entry in from_paths the move mode will be determined
1281
The first mode moves the file in the filesystem and updates the
1282
inventory. The second mode only updates the inventory without
1283
touching the file on the filesystem. This is the new mode introduced
1286
move uses the second mode if 'after == True' and the target is not
1287
versioned but present in the working tree.
1289
move uses the second mode if 'after == False' and the source is
1290
versioned but no longer in the working tree, and the target is not
1291
versioned but present in the working tree.
1293
move uses the first mode if 'after == False' and the source is
1294
versioned and present in the working tree, and the target is not
1295
versioned and not present in the working tree.
1297
Everything else results in an error.
1003
1299
This returns a list of (from_path, to_path) pairs for each
1004
1300
entry that is moved.
1007
## TODO: Option to move IDs only
1008
assert not isinstance(from_paths, basestring)
1305
# check for deprecated use of signature
1307
to_dir = kwargs.get('to_name', None)
1309
raise TypeError('You must supply a target directory')
1311
symbol_versioning.warn('The parameter to_name was deprecated'
1312
' in version 0.13. Use to_dir instead',
1315
# check destination directory
1316
if isinstance(from_paths, basestring):
1009
1318
inv = self.inventory
1010
to_abs = self.abspath(to_name)
1319
to_abs = self.abspath(to_dir)
1011
1320
if not isdir(to_abs):
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)
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotADirectory(to_abs))
1323
if not self.has_filename(to_dir):
1324
raise errors.BzrMoveFailedError('',to_dir,
1325
errors.NotInWorkingDirectory(to_dir))
1326
to_dir_id = inv.path2id(to_dir)
1327
if to_dir_id is None:
1328
raise errors.BzrMoveFailedError('',to_dir,
1329
errors.NotVersionedError(path=str(to_dir)))
1018
1331
to_dir_ie = inv[to_dir_id]
1019
1332
if to_dir_ie.kind != 'directory':
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)
1333
raise errors.BzrMoveFailedError('',to_dir,
1334
errors.NotADirectory(to_abs))
1336
# create rename entries and tuples
1337
for from_rel in from_paths:
1338
from_tail = splitpath(from_rel)[-1]
1339
from_id = inv.path2id(from_rel)
1341
raise errors.BzrMoveFailedError(from_rel,to_dir,
1342
errors.NotVersionedError(path=str(from_rel)))
1344
from_entry = inv[from_id]
1345
from_parent_id = from_entry.parent_id
1346
to_rel = pathjoin(to_dir, from_tail)
1347
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1349
from_tail=from_tail,
1350
from_parent_id=from_parent_id,
1351
to_rel=to_rel, to_tail=from_tail,
1352
to_parent_id=to_dir_id)
1353
rename_entries.append(rename_entry)
1354
rename_tuples.append((from_rel, to_rel))
1356
# determine which move mode to use. checks also for movability
1357
rename_entries = self._determine_mv_mode(rename_entries, after)
1041
1359
original_modified = self._inventory_is_modified
1043
1361
if len(from_paths):
1044
1362
self._inventory_is_modified = True
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]))
1363
self._move(rename_entries)
1056
1365
# restore the inventory on error
1057
self._set_inventory(orig_inv, dirty=original_modified)
1366
self._inventory_is_modified = original_modified
1059
1368
self._write_inventory(inv)
1369
return rename_tuples
1371
def _determine_mv_mode(self, rename_entries, after=False):
1372
"""Determines for each from-to pair if both inventory and working tree
1373
or only the inventory has to be changed.
1375
Also does basic plausability tests.
1377
inv = self.inventory
1379
for rename_entry in rename_entries:
1380
# store to local variables for easier reference
1381
from_rel = rename_entry.from_rel
1382
from_id = rename_entry.from_id
1383
to_rel = rename_entry.to_rel
1384
to_id = inv.path2id(to_rel)
1385
only_change_inv = False
1387
# check the inventory for source and destination
1389
raise errors.BzrMoveFailedError(from_rel,to_rel,
1390
errors.NotVersionedError(path=str(from_rel)))
1391
if to_id is not None:
1392
raise errors.BzrMoveFailedError(from_rel,to_rel,
1393
errors.AlreadyVersionedError(path=str(to_rel)))
1395
# try to determine the mode for rename (only change inv or change
1396
# inv and file system)
1398
if not self.has_filename(to_rel):
1399
raise errors.BzrMoveFailedError(from_id,to_rel,
1400
errors.NoSuchFile(path=str(to_rel),
1401
extra="New file has not been created yet"))
1402
only_change_inv = True
1403
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1404
only_change_inv = True
1405
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1406
only_change_inv = False
1407
elif (not self.case_sensitive
1408
and from_rel.lower() == to_rel.lower()
1409
and self.has_filename(from_rel)):
1410
only_change_inv = False
1412
# something is wrong, so lets determine what exactly
1413
if not self.has_filename(from_rel) and \
1414
not self.has_filename(to_rel):
1415
raise errors.BzrRenameFailedError(from_rel,to_rel,
1416
errors.PathsDoNotExist(paths=(str(from_rel),
1419
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1420
rename_entry.only_change_inv = only_change_inv
1421
return rename_entries
1423
def _move(self, rename_entries):
1424
"""Moves a list of files.
1426
Depending on the value of the flag 'only_change_inv', the
1427
file will be moved on the file system or not.
1429
inv = self.inventory
1432
for entry in rename_entries:
1434
self._move_entry(entry)
1436
self._rollback_move(moved)
1440
def _rollback_move(self, moved):
1441
"""Try to rollback a previous move in case of an filesystem error."""
1442
inv = self.inventory
1445
self._move_entry(WorkingTree._RenameEntry(
1446
entry.to_rel, entry.from_id,
1447
entry.to_tail, entry.to_parent_id, entry.from_rel,
1448
entry.from_tail, entry.from_parent_id,
1449
entry.only_change_inv))
1450
except errors.BzrMoveFailedError, e:
1451
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1452
" The working tree is in an inconsistent state."
1453
" Please consider doing a 'bzr revert'."
1454
" Error message is: %s" % e)
1456
def _move_entry(self, entry):
1457
inv = self.inventory
1458
from_rel_abs = self.abspath(entry.from_rel)
1459
to_rel_abs = self.abspath(entry.to_rel)
1460
if from_rel_abs == to_rel_abs:
1461
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1462
"Source and target are identical.")
1464
if not entry.only_change_inv:
1466
osutils.rename(from_rel_abs, to_rel_abs)
1468
raise errors.BzrMoveFailedError(entry.from_rel,
1470
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1062
1472
@needs_tree_write_lock
1063
def rename_one(self, from_rel, to_rel):
1473
def rename_one(self, from_rel, to_rel, after=False):
1064
1474
"""Rename one file.
1066
1476
This can change the directory or the filename or both.
1478
rename_one has several 'modes' to work. First, it can rename a physical
1479
file and change the file_id. That is the normal mode. Second, it can
1480
only change the file_id without touching any physical file. This is
1481
the new mode introduced in version 0.15.
1483
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1484
versioned but present in the working tree.
1486
rename_one uses the second mode if 'after == False' and 'from_rel' is
1487
versioned but no longer in the working tree, and 'to_rel' is not
1488
versioned but present in the working tree.
1490
rename_one uses the first mode if 'after == False' and 'from_rel' is
1491
versioned and present in the working tree, and 'to_rel' is not
1492
versioned and not present in the working tree.
1494
Everything else results in an error.
1068
1496
inv = self.inventory
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)
1499
# create rename entries and tuples
1500
from_tail = splitpath(from_rel)[-1]
1501
from_id = inv.path2id(from_rel)
1503
# if file is missing in the inventory maybe it's in the basis_tree
1504
basis_tree = self.branch.basis_tree()
1505
from_id = basis_tree.path2id(from_rel)
1507
raise errors.BzrRenameFailedError(from_rel,to_rel,
1508
errors.NotVersionedError(path=str(from_rel)))
1509
# put entry back in the inventory so we can rename it
1510
from_entry = basis_tree.inventory[from_id].copy()
1513
from_entry = inv[from_id]
1514
from_parent_id = from_entry.parent_id
1085
1515
to_dir, to_tail = os.path.split(to_rel)
1086
1516
to_dir_id = inv.path2id(to_dir)
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]))
1517
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1519
from_tail=from_tail,
1520
from_parent_id=from_parent_id,
1521
to_rel=to_rel, to_tail=to_tail,
1522
to_parent_id=to_dir_id)
1523
rename_entries.append(rename_entry)
1525
# determine which move mode to use. checks also for movability
1526
rename_entries = self._determine_mv_mode(rename_entries, after)
1528
# check if the target changed directory and if the target directory is
1530
if to_dir_id is None:
1531
raise errors.BzrMoveFailedError(from_rel,to_rel,
1532
errors.NotVersionedError(path=str(to_dir)))
1534
# all checks done. now we can continue with our actual work
1535
mutter('rename_one:\n'
1540
' to_dir_id {%s}\n',
1541
from_id, from_rel, to_rel, to_dir, to_dir_id)
1543
self._move(rename_entries)
1107
1544
self._write_inventory(inv)
1546
class _RenameEntry(object):
1547
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1548
to_rel, to_tail, to_parent_id, only_change_inv=False):
1549
self.from_rel = from_rel
1550
self.from_id = from_id
1551
self.from_tail = from_tail
1552
self.from_parent_id = from_parent_id
1553
self.to_rel = to_rel
1554
self.to_tail = to_tail
1555
self.to_parent_id = to_parent_id
1556
self.only_change_inv = only_change_inv
1109
1558
@needs_read_lock
1110
1559
def unknowns(self):
1111
1560
"""Return all unknown files.
1324
1720
if ignoreset is not None:
1325
1721
return ignoreset
1327
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1723
ignore_globs = set()
1328
1724
ignore_globs.update(ignores.get_runtime_ignores())
1330
1725
ignore_globs.update(ignores.get_user_ignores())
1332
1726
if self.has_filename(bzrlib.IGNORE_FILENAME):
1333
1727
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1335
1729
ignore_globs.update(ignores.parse_ignore_file(f))
1339
1732
self._ignoreset = ignore_globs
1340
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1341
1733
return ignore_globs
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
1735
def _flush_ignore_list_cache(self):
1736
"""Resets the cached ignore list to force a cache rebuild."""
1737
self._ignoreset = None
1738
self._ignoreglobster = None
1353
1740
def is_ignored(self, filename):
1354
1741
r"""Check whether the filename matches an ignore pattern.
1356
1743
Patterns containing '/' or '\' need to match the whole path;
1357
others match against only the last component.
1744
others match against only the last component. Patterns starting
1745
with '!' are ignore exceptions. Exceptions take precedence
1746
over regular patterns and cause the filename to not be ignored.
1359
1748
If the file is ignored, returns the pattern which caused it to
1360
1749
be ignored, otherwise None. So this can simply be used as a
1361
1750
boolean if desired."""
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]
1751
if getattr(self, '_ignoreglobster', None) is None:
1752
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1753
return self._ignoreglobster.match(filename)
1384
1755
def kind(self, file_id):
1385
1756
return file_kind(self.id2abspath(file_id))
1758
def stored_kind(self, file_id):
1759
"""See Tree.stored_kind"""
1760
return self.inventory[file_id].kind
1762
def _comparison_data(self, entry, path):
1763
abspath = self.abspath(path)
1765
stat_value = os.lstat(abspath)
1767
if getattr(e, 'errno', None) == errno.ENOENT:
1774
mode = stat_value.st_mode
1775
kind = osutils.file_kind_from_stat_mode(mode)
1776
if not supports_executable():
1777
executable = entry is not None and entry.executable
1779
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1780
return kind, executable, stat_value
1782
def _file_size(self, entry, stat_value):
1783
return stat_value.st_size
1387
1785
def last_revision(self):
1388
1786
"""Return the last revision of the branch for this tree.
1499
1931
def read_basis_inventory(self):
1500
1932
"""Read the cached basis inventory."""
1501
1933
path = self._basis_inventory_name()
1502
return self._control_files.get(path).read()
1934
return self._transport.get_bytes(path)
1504
1936
@needs_read_lock
1505
1937
def read_working_inventory(self):
1506
1938
"""Read the working inventory.
1508
1940
:raises errors.InventoryModified: read_working_inventory will fail
1509
1941
when the current in memory inventory has been modified.
1511
# conceptually this should be an implementation detail of the tree.
1943
# conceptually this should be an implementation detail of the tree.
1512
1944
# XXX: Deprecate this.
1513
1945
# ElementTree does its own conversion from UTF-8, so open in
1515
1947
if self._inventory_is_modified:
1516
1948
raise errors.InventoryModified(self)
1517
result = xml5.serializer_v5.read_inventory(
1518
self._control_files.get('inventory'))
1949
f = self._transport.get('inventory')
1951
result = self._deserialize(f)
1519
1954
self._set_inventory(result, dirty=False)
1522
1957
@needs_tree_write_lock
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.
1958
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1960
"""Remove nominated files from the working inventory.
1962
:files: File paths relative to the basedir.
1963
:keep_files: If true, the files will also be kept.
1964
:force: Delete files and directories, even if they are changed and
1965
even if the directories are not empty.
1537
## TODO: Normalize names
1538
## TODO: Remove nested loops; better scalability
1539
1967
if isinstance(files, basestring):
1540
1968
files = [files]
1542
inv = self.inventory
1544
# do this before any modifications
1972
all_files = set() # specified and nested files
1973
unknown_nested_files=set()
1975
to_file = sys.stdout
1977
files_to_backup = []
1979
def recurse_directory_to_add_files(directory):
1980
# Recurse directory and add all files
1981
# so we can check if they have changed.
1982
for parent_info, file_infos in self.walkdirs(directory):
1983
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1984
# Is it versioned or ignored?
1985
if self.path2id(relpath):
1986
# Add nested content for deletion.
1987
all_files.add(relpath)
1989
# Files which are not versioned
1990
# should be treated as unknown.
1991
files_to_backup.append(relpath)
1993
for filename in files:
1994
# Get file name into canonical form.
1995
abspath = self.abspath(filename)
1996
filename = self.relpath(abspath)
1997
if len(filename) > 0:
1998
all_files.add(filename)
1999
recurse_directory_to_add_files(filename)
2001
files = list(all_files)
2004
return # nothing to do
2006
# Sort needed to first handle directory content before the directory
2007
files.sort(reverse=True)
2009
# Bail out if we are going to delete files we shouldn't
2010
if not keep_files and not force:
2011
for (file_id, path, content_change, versioned, parent_id, name,
2012
kind, executable) in self.iter_changes(self.basis_tree(),
2013
include_unchanged=True, require_versioned=False,
2014
want_unversioned=True, specific_files=files):
2015
if versioned[0] == False:
2016
# The record is unknown or newly added
2017
files_to_backup.append(path[1])
2018
elif (content_change and (kind[1] is not None) and
2019
osutils.is_inside_any(files, path[1])):
2020
# Versioned and changed, but not deleted, and still
2021
# in one of the dirs to be deleted.
2022
files_to_backup.append(path[1])
2024
def backup(file_to_backup):
2025
backup_name = self.bzrdir.generate_backup_name(file_to_backup)
2026
osutils.rename(abs_path, self.abspath(backup_name))
2027
return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
2029
# Build inv_delta and delete files where applicable,
2030
# do this before any modifications to inventory.
1545
2031
for f in files:
1546
fid = inv.path2id(f)
2032
fid = self.path2id(f)
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)
2035
message = "%s is not versioned." % (f,)
2038
# having removed it, it must be either ignored or unknown
2039
if self.is_ignored(f):
2043
# XXX: Really should be a more abstract reporter interface
2044
kind_ch = osutils.kind_marker(self.kind(fid))
2045
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2047
inv_delta.append((f, None, fid, None))
2048
message = "removed %s" % (f,)
2051
abs_path = self.abspath(f)
2052
if osutils.lexists(abs_path):
2053
if (osutils.isdir(abs_path) and
2054
len(os.listdir(abs_path)) > 0):
2056
osutils.rmtree(abs_path)
2057
message = "deleted %s" % (f,)
2061
if f in files_to_backup:
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)
1563
2075
@needs_tree_write_lock
1564
def revert(self, filenames, old_tree=None, backups=True,
1565
pb=DummyProgress()):
2076
def revert(self, filenames=None, old_tree=None, backups=True,
2077
pb=None, report_changes=False):
1566
2078
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)
1567
2084
if old_tree is None:
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])
2085
basis_tree = self.basis_tree()
2086
basis_tree.lock_read()
2087
old_tree = basis_tree
1574
resolve(self, filenames, ignore_misses=True)
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:
1575
2108
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)
1577
2134
# XXX: This method should be deprecated in favour of taking in a proper
1578
2135
# new Inventory object.
1579
2136
@needs_tree_write_lock
1580
2137
def set_inventory(self, new_inventory_list):
1581
2138
from bzrlib.inventory import (Inventory,
1582
2139
InventoryDirectory,
1586
2142
inv = Inventory(self.get_root_id())
1692
2265
# cant set that until we update the working trees last revision to be
1693
2266
# one from the new branch, because it will just get absorbed by the
1694
2267
# parent de-duplication logic.
1696
2269
# We MUST save it even if an error occurs, because otherwise the users
1697
2270
# local work is unreferenced and will appear to have been lost.
1701
2274
last_rev = self.get_parent_ids()[0]
1702
2275
except IndexError:
1704
if last_rev != self.branch.last_revision():
1705
# merge tree state up to new branch tip.
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()
1706
2301
basis = self.basis_tree()
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(
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)
1715
2321
# TODO - dedup parents list with things merged by pull ?
1716
2322
# reuse the tree we've updated to to set the basis:
1717
parent_trees = [(self.branch.last_revision(), to_tree)]
2323
parent_trees = [(revision, to_tree)]
1718
2324
merges = self.get_parent_ids()[1:]
1719
2325
# Ideally we ask the tree for the trees here, that way the working
1720
# tree can decide whether to give us teh entire tree or give us a
2326
# tree can decide whether to give us the entire tree or give us a
1721
2327
# lazy initialised tree. dirstate for instance will have the trees
1722
2328
# in ram already, whereas a last-revision + basis-inventory tree
1723
2329
# will not, but also does not need them when setting parents.
1724
2330
for parent in merges:
1725
2331
parent_trees.append(
1726
2332
(parent, self.branch.repository.revision_tree(parent)))
1727
if old_tip is not None:
2333
if not _mod_revision.is_null(old_tip):
1728
2334
parent_trees.append(
1729
2335
(old_tip, self.branch.repository.revision_tree(old_tip)))
1730
2336
self.set_parent_trees(parent_trees)
1731
2337
last_rev = parent_trees[0][0]
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
2340
def _write_hashcache_if_dirty(self):
2341
"""Write out the hashcache if it is dirty."""
2342
if self._hashcache.needs_write:
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(
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)
1759
2354
@needs_tree_write_lock
1760
2355
def _write_inventory(self, inv):
1794
2389
file_id=self.path2id(conflicted)))
1795
2390
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)
1798
2627
class WorkingTree2(WorkingTree):
1799
2628
"""This is the Format 2 working tree.
1801
This was the first weave based working tree.
2630
This was the first weave based working tree.
1802
2631
- uses os locks for locking.
1803
2632
- 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())]
1806
2650
def lock_tree_write(self):
1807
2651
"""See WorkingTree.lock_tree_write().
1809
2653
In Format2 WorkingTrees we have a single lock for the branch and tree
1810
2654
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
1812
2659
self.branch.lock_write()
1814
return self._control_files.lock_write()
2661
self._control_files.lock_write()
1816
2664
self.branch.unlock()
1819
2667
def unlock(self):
2668
# do non-implementation specific cleanup
1820
2671
# we share control files:
1821
2672
if self._control_files._lock_count == 3:
1822
2673
# _inventory_is_modified is always False during a read lock.
1823
2674
if self._inventory_is_modified:
1825
if self._hashcache.needs_write:
1826
self._hashcache.write()
2676
self._write_hashcache_if_dirty()
1827
2678
# reverse order of locking.
1829
2680
return self._control_files.unlock()
1991
2855
def unregister_format(klass, format):
1992
assert klass._formats[format.get_format_string()] is format
1993
2856
del klass._formats[format.get_format_string()]
1997
2859
class WorkingTreeFormat2(WorkingTreeFormat):
1998
"""The second working tree format.
2860
"""The second working tree format.
2000
2862
This format modified the hash cache from the format 1 hash cache.
2865
upgrade_recommended = True
2003
2867
def get_format_description(self):
2004
2868
"""See WorkingTreeFormat.get_format_description()."""
2005
2869
return "Working tree format 2"
2007
def stub_initialize_remote(self, control_files):
2008
"""As a special workaround create critical control files for a remote working tree
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2010
2874
This ensures that it can later be updated and dealt with locally,
2011
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2012
2876
no working tree. (See bug #43064).
2014
2878
sio = StringIO()
2016
xml5.serializer_v5.write_inventory(inv, sio)
2879
inv = inventory.Inventory()
2880
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2018
control_files.put('inventory', sio)
2020
control_files.put_utf8('pending-merges', '')
2023
def initialize(self, a_bzrdir, revision_id=None):
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):
2024
2887
"""See WorkingTreeFormat.initialize()."""
2025
2888
if not isinstance(a_bzrdir.transport, LocalTransport):
2026
2889
raise errors.NotLocalUrl(a_bzrdir.transport.base)
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()
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()
2041
2902
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2044
2905
_internal=True,
2046
2907
_bzrdir=a_bzrdir)
2047
basis_tree = branch.repository.revision_tree(revision)
2908
basis_tree = branch.repository.revision_tree(revision_id)
2048
2909
if basis_tree.inventory.root is not None:
2049
wt.set_root_id(basis_tree.inventory.root.file_id)
2910
wt.set_root_id(basis_tree.get_root_id())
2050
2911
# set the parent list and cache the basis tree.
2051
wt.set_parent_trees([(revision, basis_tree)])
2912
if _mod_revision.is_null(revision_id):
2915
parent_trees = [(revision_id, basis_tree)]
2916
wt.set_parent_trees(parent_trees)
2052
2917
transform.build_tree(basis_tree, wt)
2163
3050
raise NotImplementedError
2164
3051
if not isinstance(a_bzrdir.transport, LocalTransport):
2165
3052
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2166
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3053
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2168
3056
def _open(self, a_bzrdir, control_files):
2169
3057
"""Open the tree itself.
2171
3059
:param a_bzrdir: the dir for the tree.
2172
3060
:param control_files: the control files for the tree.
2174
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2178
_control_files=control_files)
3062
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3066
_control_files=control_files)
2180
3068
def __str__(self):
2181
3069
return self.get_format_string()
3072
__default_format = WorkingTreeFormat6()
3073
WorkingTreeFormat.register_format(__default_format)
3074
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
WorkingTreeFormat.set_default_format(__default_format)
2184
3078
# formats which have no format string are not discoverable
2185
3079
# and not independently creatable, so are not registered.
2186
__default_format = WorkingTreeFormat3()
2187
WorkingTreeFormat.register_format(__default_format)
2188
WorkingTreeFormat.set_default_format(__default_format)
2189
3080
_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
