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
68
import bzrlib.branch
70
69
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
73
from bzrlib import symbol_versioning
79
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
75
from bzrlib.errors import (BzrCheckError,
78
WeaveRevisionNotPresent,
82
MergeModifiedFormatError,
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
86
from bzrlib.lockable_files import LockableFiles, TransportLock
82
87
from bzrlib.lockdir import LockDir
83
88
import bzrlib.mutabletree
84
89
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
90
from bzrlib.osutils import (
94
100
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
102
from bzrlib.trace import mutter, note
98
103
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
105
from bzrlib.progress import DummyProgress, ProgressPhase
106
from bzrlib.revision import NULL_REVISION
107
import bzrlib.revisiontree
100
108
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
109
from bzrlib.symbol_versioning import (deprecated_passed,
112
DEPRECATED_PARAMETER,
107
119
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
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
123
@deprecated_function(zero_thirteen)
124
def gen_file_id(name):
125
"""Return new file id for the basename 'name'.
127
Use bzrlib.generate_ids.gen_file_id() instead
129
return generate_ids.gen_file_id(name)
132
@deprecated_function(zero_thirteen)
134
"""Return a new tree-root file id.
136
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
138
return generate_ids.gen_root_id()
116
141
class TreeEntry(object):
117
142
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
144
This needs further inspection, it may be better to have
120
145
InventoryEntries without ids - though that seems wrong. For now,
121
146
this is a parallel hierarchy to InventoryEntry, and needs to become
122
147
one of several things: decorates to that hierarchy, children of, or
412
387
# no parents, return an empty revision tree.
413
388
# in the future this should return the tree for
414
389
# '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:
390
return self.branch.repository.revision_tree(None)
393
xml = self.read_basis_inventory()
394
inv = xml6.serializer_v6.read_inventory_from_string(xml)
395
if inv is not None and inv.revision_id == revision_id:
396
return bzrlib.revisiontree.RevisionTree(
397
self.branch.repository, inv, revision_id)
398
except (NoSuchFile, errors.BadInventoryFormat):
421
400
# No cached copy available, retrieve from the repository.
422
401
# FIXME? RBC 20060403 should we cache the inventory locally
423
402
# at this point ?
425
404
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
405
except errors.RevisionNotPresent:
427
406
# 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
407
# occured. If the revision is present, its a problem, if its not
430
409
if self.branch.repository.has_revision(revision_id):
432
411
# 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()
412
return self.branch.repository.revision_tree(None)
415
@deprecated_method(zero_eight)
416
def create(branch, directory):
417
"""Create a workingtree for branch at directory.
419
If existing_directory already exists it must have a .bzr directory.
420
If it does not exist, it will be created.
422
This returns a new WorkingTree object for the new checkout.
424
TODO FIXME RBC 20060124 when we have checkout formats in place this
425
should accept an optional revisionid to checkout [and reject this if
426
checking out into the same dir as a pre-checkout-aware branch format.]
428
XXX: When BzrDir is present, these should be created through that
431
warnings.warn('delete WorkingTree.create', stacklevel=3)
432
transport = get_transport(directory)
433
if branch.bzrdir.root_transport.base == transport.base:
435
return branch.bzrdir.create_workingtree()
436
# different directory,
437
# create a branch reference
438
# and now a working tree.
439
raise NotImplementedError
442
@deprecated_method(zero_eight)
443
def create_standalone(directory):
444
"""Create a checkout and a branch and a repo at directory.
446
Directory must exist and be empty.
448
please use BzrDir.create_standalone_workingtree
450
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
452
def relpath(self, path):
440
453
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
455
The path may be absolute or relative. If its a relative path it is
443
456
interpreted relative to the python current working directory.
445
458
return osutils.relpath(self.basedir, path)
447
460
def has_filename(self, filename):
448
461
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
my_file = self.get_file(file_id, path=path, filtered=filtered)
468
return my_file.read()
472
def get_file_byname(self, filename, filtered=True):
473
path = self.abspath(filename)
475
if filtered and self.supports_content_filtering():
476
filters = self._content_filter_stack(filename)
477
return filtered_input_file(f, filters)
481
def get_file_lines(self, file_id, path=None, filtered=True):
482
"""See Tree.get_file_lines()"""
483
file = self.get_file(file_id, path, filtered=filtered)
485
return file.readlines()
490
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
491
"""See Tree.annotate_iter
493
This implementation will use the basis tree implementation if possible.
494
Lines not in the basis are attributed to CURRENT_REVISION
496
If there are pending merges, lines added by those merges will be
497
incorrectly attributed to CURRENT_REVISION (but after committing, the
498
attribution will be correct).
500
maybe_file_parent_keys = []
501
for parent_id in self.get_parent_ids():
503
parent_tree = self.revision_tree(parent_id)
504
except errors.NoSuchRevisionInTree:
505
parent_tree = self.branch.repository.revision_tree(parent_id)
506
parent_tree.lock_read()
508
if file_id not in parent_tree:
510
ie = parent_tree.inventory[file_id]
511
if ie.kind != 'file':
512
# Note: this is slightly unnecessary, because symlinks and
513
# directories have a "text" which is the empty text, and we
514
# know that won't mess up annotations. But it seems cleaner
516
parent_text_key = (file_id, ie.revision)
517
if parent_text_key not in maybe_file_parent_keys:
518
maybe_file_parent_keys.append(parent_text_key)
521
graph = _mod_graph.Graph(self.branch.repository.texts)
522
heads = graph.heads(maybe_file_parent_keys)
523
file_parent_keys = []
524
for key in maybe_file_parent_keys:
526
file_parent_keys.append(key)
528
# Now we have the parents of this content
529
annotator = self.branch.repository.texts.get_annotator()
530
text = self.get_file_text(file_id)
531
this_key =(file_id, default_revision)
532
annotator.add_special_text(this_key, file_parent_keys, text)
533
annotations = [(key[-1], line)
534
for key, line in annotator.annotate_flat(this_key)]
537
def _get_ancestors(self, default_revision):
538
ancestors = set([default_revision])
539
for parent_id in self.get_parent_ids():
540
ancestors.update(self.branch.repository.get_ancestry(
541
parent_id, topo_sorted=False))
463
def get_file(self, file_id):
464
return self.get_file_byname(self.id2path(file_id))
466
def get_file_text(self, file_id):
467
return self.get_file(file_id).read()
469
def get_file_byname(self, filename):
470
return file(self.abspath(filename), 'rb')
544
472
def get_parent_ids(self):
545
473
"""See Tree.get_parent_ids.
547
475
This implementation reads the pending merges list and last_revision
548
476
value and uses that to decide what the parents list should be.
550
last_rev = _mod_revision.ensure_null(self._last_revision())
551
if _mod_revision.NULL_REVISION == last_rev:
478
last_rev = self._last_revision()
554
482
parents = [last_rev]
556
merges_bytes = self._transport.get_bytes('pending-merges')
557
except errors.NoSuchFile:
484
merges_file = self._control_files.get_utf8('pending-merges')
560
for l in osutils.split_lines(merges_bytes):
561
revision_id = l.rstrip('\n')
562
parents.append(revision_id)
488
for l in merges_file.readlines():
489
parents.append(l.rstrip('\n'))
566
493
def get_root_id(self):
567
494
"""Return the id of this trees root"""
568
495
return self._inventory.root.file_id
570
497
def _get_store_filename(self, file_id):
571
498
## XXX: badly named; this is not in the store at all
572
499
return self.abspath(self.id2path(file_id))
575
def clone(self, to_bzrdir, revision_id=None):
502
def clone(self, to_bzrdir, revision_id=None, basis=None):
576
503
"""Duplicate this working tree into to_bzr, including all state.
578
505
Specifically modified files are kept as modified, but
579
506
ignored and unknown files are discarded.
581
508
If you want to make a new line of development, see bzrdir.sprout()
584
If not None, the cloned tree will have its last revision set to
585
revision, and difference between the source trees last revision
511
If not None, the cloned tree will have its last revision set to
512
revision, and and difference between the source trees last revision
586
513
and this one merged in.
516
If not None, a closer copy of a tree which may have some files in
517
common, and which file content should be preferentially copied from.
588
519
# assumes the target bzr dir format is compatible.
589
result = to_bzrdir.create_workingtree()
520
result = self._format.initialize(to_bzrdir)
590
521
self.copy_content_into(result, revision_id)
621
552
__contains__ = has_id
623
554
def get_file_size(self, file_id):
624
"""See Tree.get_file_size"""
625
# XXX: this returns the on-disk size; it should probably return the
628
return os.path.getsize(self.id2abspath(file_id))
630
if e.errno != errno.ENOENT:
555
return os.path.getsize(self.id2abspath(file_id))
636
def get_file_sha1(self, file_id, path=None, stat_value=None):
558
def get_file_sha1(self, file_id, path=None):
638
560
path = self._inventory.id2path(file_id)
639
return self._hashcache.get_sha1(path, stat_value)
561
return self._hashcache.get_sha1(path)
641
563
def get_file_mtime(self, file_id, path=None):
643
path = self.inventory.id2path(file_id)
565
path = self._inventory.id2path(file_id)
644
566
return os.lstat(self.abspath(path)).st_mtime
646
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
647
file_id = self.path2id(path)
649
# For unversioned files on win32, we just assume they are not
652
return self._inventory[file_id].executable
654
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
655
mode = stat_result.st_mode
656
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
658
568
if not supports_executable():
659
569
def is_executable(self, file_id, path=None):
660
570
return self._inventory[file_id].executable
662
_is_executable_from_path_and_stat = \
663
_is_executable_from_path_and_stat_from_basis
665
572
def is_executable(self, file_id, path=None):
667
path = self.id2path(file_id)
574
path = self._inventory.id2path(file_id)
668
575
mode = os.lstat(self.abspath(path)).st_mode
669
576
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
671
_is_executable_from_path_and_stat = \
672
_is_executable_from_path_and_stat_from_stat
674
@needs_tree_write_lock
675
579
def _add(self, files, ids, kinds):
676
580
"""See MutableTree._add."""
677
581
# TODO: Re-adding a file that is removed in the working copy
678
582
# should probably put it back with the previous ID.
679
# the read and write working inventory should not occur in this
583
# the read and write working inventory should not occur in this
680
584
# function - they should be part of lock_write and unlock.
585
inv = self.read_working_inventory()
682
586
for f, file_id, kind in zip(files, ids, kinds):
587
assert kind is not None
683
588
if file_id is None:
684
589
inv.add_path(f, kind=kind)
686
591
inv.add_path(f, kind=kind, file_id=file_id)
687
self._inventory_is_modified = True
592
self._write_inventory(inv)
689
594
@needs_tree_write_lock
690
595
def _gather_kinds(self, files, kinds):
888
744
def set_merge_modified(self, modified_hashes):
889
745
def iter_stanzas():
890
746
for file_id, hash in modified_hashes.iteritems():
891
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
747
yield Stanza(file_id=file_id, hash=hash)
892
748
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
894
def _sha_from_stat(self, path, stat_result):
895
"""Get a sha digest from the tree's stat cache.
897
The default implementation assumes no stat cache is present.
899
:param path: The path.
900
:param stat_result: The stat result being looked up.
750
@needs_tree_write_lock
904
751
def _put_rio(self, filename, stanzas, header):
905
self._must_be_locked()
906
752
my_file = rio_file(stanzas, header)
907
self._transport.put_file(filename, my_file,
908
mode=self.bzrdir._get_file_mode())
753
self._control_files.put(filename, my_file)
910
755
@needs_write_lock # because merge pulls data into the branch.
911
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
912
merge_type=None, force=False):
756
def merge_from_branch(self, branch, to_revision=None):
913
757
"""Merge from a branch into this working tree.
915
759
:param branch: The branch to merge from.
916
:param to_revision: If non-None, the merge will merge to to_revision,
917
but not beyond it. to_revision does not need to be in the history
918
of the branch when it is supplied. If None, to_revision defaults to
760
:param to_revision: If non-None, the merge will merge to to_revision, but
761
not beyond it. to_revision does not need to be in the history of
762
the branch when it is supplied. If None, to_revision defaults to
919
763
branch.last_revision().
921
765
from bzrlib.merge import Merger, Merge3Merger
922
merger = Merger(self.branch, this_tree=self)
923
# check that there are no local alterations
924
if not force and self.has_changes():
925
raise errors.UncommittedChanges(self)
926
if to_revision is None:
927
to_revision = _mod_revision.ensure_null(branch.last_revision())
928
merger.other_rev_id = to_revision
929
if _mod_revision.is_null(merger.other_rev_id):
930
raise errors.NoCommits(branch)
931
self.branch.fetch(branch, last_revision=merger.other_rev_id)
932
merger.other_basis = merger.other_rev_id
933
merger.other_tree = self.branch.repository.revision_tree(
935
merger.other_branch = branch
936
if from_revision is None:
766
pb = bzrlib.ui.ui_factory.nested_progress_bar()
768
merger = Merger(self.branch, this_tree=self, pb=pb)
769
merger.pp = ProgressPhase("Merge phase", 5, pb)
770
merger.pp.next_phase()
771
# check that there are no
773
merger.check_basis(check_clean=True, require_commits=False)
774
if to_revision is None:
775
to_revision = branch.last_revision()
776
merger.other_rev_id = to_revision
777
if merger.other_rev_id is None:
778
raise error.NoCommits(branch)
779
self.branch.fetch(branch, last_revision=merger.other_rev_id)
780
merger.other_basis = merger.other_rev_id
781
merger.other_tree = self.branch.repository.revision_tree(
783
merger.pp.next_phase()
937
784
merger.find_base()
939
merger.set_base_revision(from_revision, branch)
940
if merger.base_rev_id == merger.other_rev_id:
941
raise errors.PointlessMerge
942
merger.backup_files = False
943
if merge_type is None:
785
if merger.base_rev_id == merger.other_rev_id:
786
raise errors.PointlessMerge
787
merger.backup_files = False
944
788
merger.merge_type = Merge3Merger
946
merger.merge_type = merge_type
947
merger.set_interesting_files(None)
948
merger.show_base = False
949
merger.reprocess = False
950
conflicts = merger.do_merge()
789
merger.set_interesting_files(None)
790
merger.show_base = False
791
merger.reprocess = False
792
conflicts = merger.do_merge()
955
799
def merge_modified(self):
956
"""Return a dictionary of files modified by a merge.
958
The list is initialized by WorkingTree.set_merge_modified, which is
959
typically called after we make some automatic updates to the tree
962
This returns a map of file_id->sha1, containing only files which are
963
still in the working inventory and have that text hash.
966
hashfile = self._transport.get('merge-hashes')
967
except errors.NoSuchFile:
801
hashfile = self._control_files.get('merge-hashes')
972
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
973
raise errors.MergeModifiedFormatError()
974
except StopIteration:
975
raise errors.MergeModifiedFormatError()
976
for s in RioReader(hashfile):
977
# RioReader reads in Unicode, so convert file_ids back to utf8
978
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
979
if file_id not in self.inventory:
981
text_hash = s.get("hash")
982
if text_hash == self.get_file_sha1(file_id):
983
merge_hashes[file_id] = text_hash
806
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
807
raise MergeModifiedFormatError()
808
except StopIteration:
809
raise MergeModifiedFormatError()
810
for s in RioReader(hashfile):
811
file_id = s.get("file_id")
812
if file_id not in self.inventory:
815
if hash == self.get_file_sha1(file_id):
816
merge_hashes[file_id] = hash
988
819
@needs_write_lock
989
820
def mkdir(self, path, file_id=None):
997
828
def get_symlink_target(self, file_id):
998
abspath = self.id2abspath(file_id)
999
target = osutils.readlink(abspath)
1003
def subsume(self, other_tree):
1004
def add_children(inventory, entry):
1005
for child_entry in entry.children.values():
1006
inventory._byid[child_entry.file_id] = child_entry
1007
if child_entry.kind == 'directory':
1008
add_children(inventory, child_entry)
1009
if other_tree.get_root_id() == self.get_root_id():
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Trees have the same root')
1013
other_tree_path = self.relpath(other_tree.basedir)
1014
except errors.PathNotChild:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Tree is not contained by the other')
1017
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1018
if new_root_parent is None:
1019
raise errors.BadSubsumeSource(self, other_tree,
1020
'Parent directory is not versioned.')
1021
# We need to ensure that the result of a fetch will have a
1022
# versionedfile for the other_tree root, and only fetching into
1023
# RepositoryKnit2 guarantees that.
1024
if not self.branch.repository.supports_rich_root():
1025
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1026
other_tree.lock_tree_write()
1028
new_parents = other_tree.get_parent_ids()
1029
other_root = other_tree.inventory.root
1030
other_root.parent_id = new_root_parent
1031
other_root.name = osutils.basename(other_tree_path)
1032
self.inventory.add(other_root)
1033
add_children(self.inventory, other_root)
1034
self._write_inventory(self.inventory)
1035
# normally we don't want to fetch whole repositories, but i think
1036
# here we really do want to consolidate the whole thing.
1037
for parent_id in other_tree.get_parent_ids():
1038
self.branch.fetch(other_tree.branch, parent_id)
1039
self.add_parent_tree_id(parent_id)
1042
other_tree.bzrdir.retire_bzrdir()
1044
def _setup_directory_is_tree_reference(self):
1045
if self._branch.repository._format.supports_tree_reference:
1046
self._directory_is_tree_reference = \
1047
self._directory_may_be_tree_reference
1049
self._directory_is_tree_reference = \
1050
self._directory_is_never_tree_reference
1052
def _directory_is_never_tree_reference(self, relpath):
1055
def _directory_may_be_tree_reference(self, relpath):
1056
# as a special case, if a directory contains control files then
1057
# it's a tree reference, except that the root of the tree is not
1058
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1059
# TODO: We could ask all the control formats whether they
1060
# recognize this directory, but at the moment there's no cheap api
1061
# to do that. Since we probably can only nest bzr checkouts and
1062
# they always use this name it's ok for now. -- mbp 20060306
1064
# FIXME: There is an unhandled case here of a subdirectory
1065
# containing .bzr but not a branch; that will probably blow up
1066
# when you try to commit it. It might happen if there is a
1067
# checkout in a subdirectory. This can be avoided by not adding
1070
@needs_tree_write_lock
1071
def extract(self, file_id, format=None):
1072
"""Extract a subtree from this tree.
1074
A new branch will be created, relative to the path for this tree.
1078
segments = osutils.splitpath(path)
1079
transport = self.branch.bzrdir.root_transport
1080
for name in segments:
1081
transport = transport.clone(name)
1082
transport.ensure_base()
1085
sub_path = self.id2path(file_id)
1086
branch_transport = mkdirs(sub_path)
1088
format = self.bzrdir.cloning_metadir()
1089
branch_transport.ensure_base()
1090
branch_bzrdir = format.initialize_on_transport(branch_transport)
1092
repo = branch_bzrdir.find_repository()
1093
except errors.NoRepositoryPresent:
1094
repo = branch_bzrdir.create_repository()
1095
if not repo.supports_rich_root():
1096
raise errors.RootNotRich()
1097
new_branch = branch_bzrdir.create_branch()
1098
new_branch.pull(self.branch)
1099
for parent_id in self.get_parent_ids():
1100
new_branch.fetch(self.branch, parent_id)
1101
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1102
if tree_transport.base != branch_transport.base:
1103
tree_bzrdir = format.initialize_on_transport(tree_transport)
1104
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1105
target_branch=new_branch)
1107
tree_bzrdir = branch_bzrdir
1108
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1109
wt.set_parent_ids(self.get_parent_ids())
1110
my_inv = self.inventory
1111
child_inv = inventory.Inventory(root_id=None)
1112
new_root = my_inv[file_id]
1113
my_inv.remove_recursive_id(file_id)
1114
new_root.parent_id = None
1115
child_inv.add(new_root)
1116
self._write_inventory(my_inv)
1117
wt._write_inventory(child_inv)
1120
def _serialize(self, inventory, out_file):
1121
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1124
def _deserialize(selt, in_file):
1125
return xml5.serializer_v5.read_inventory(in_file)
829
return os.readlink(self.id2abspath(file_id))
831
def file_class(self, filename):
832
if self.path2id(filename):
834
elif self.is_ignored(filename):
1127
839
def flush(self):
1128
840
"""Write the in memory inventory to disk."""
1244
943
except KeyError:
1245
944
yield fp[1:], c, fk, None, TreeEntry()
1248
947
if fk != 'directory':
1251
# But do this child first if recursing down
1253
new_children = os.listdir(fap)
1255
new_children = collections.deque(new_children)
1256
stack.append((f_ie.file_id, fp, fap, new_children))
1257
# Break out of inner loop,
1258
# so that we start outer loop with child
950
# But do this child first
951
new_children = os.listdir(fap)
953
new_children = collections.deque(new_children)
954
stack.append((f_ie.file_id, fp, fap, new_children))
955
# Break out of inner loop, so that we start outer loop with child
1261
958
# if we finished all children, pop it off the stack
1264
961
@needs_tree_write_lock
1265
def move(self, from_paths, to_dir=None, after=False, **kwargs):
962
def move(self, from_paths, to_name):
1266
963
"""Rename files.
1268
to_dir must exist in the inventory.
1270
If to_dir exists and is a directory, the files are moved into
1271
it, keeping their old names.
1273
Note that to_dir is only the last component of the new name;
965
to_name must exist in the inventory.
967
If to_name exists and is a directory, the files are moved into
968
it, keeping their old names.
970
Note that to_name is only the last component of the new name;
1274
971
this doesn't change the directory.
1276
For each entry in from_paths the move mode will be determined
1279
The first mode moves the file in the filesystem and updates the
1280
inventory. The second mode only updates the inventory without
1281
touching the file on the filesystem. This is the new mode introduced
1284
move uses the second mode if 'after == True' and the target is not
1285
versioned but present in the working tree.
1287
move uses the second mode if 'after == False' and the source is
1288
versioned but no longer in the working tree, and the target is not
1289
versioned but present in the working tree.
1291
move uses the first mode if 'after == False' and the source is
1292
versioned and present in the working tree, and the target is not
1293
versioned and not present in the working tree.
1295
Everything else results in an error.
1297
973
This returns a list of (from_path, to_path) pairs for each
1298
974
entry that is moved.
1303
# check for deprecated use of signature
1305
to_dir = kwargs.get('to_name', None)
1307
raise TypeError('You must supply a target directory')
1309
symbol_versioning.warn('The parameter to_name was deprecated'
1310
' in version 0.13. Use to_dir instead',
1313
# check destination directory
1314
if isinstance(from_paths, basestring):
977
## TODO: Option to move IDs only
978
assert not isinstance(from_paths, basestring)
1316
979
inv = self.inventory
1317
to_abs = self.abspath(to_dir)
980
to_abs = self.abspath(to_name)
1318
981
if not isdir(to_abs):
1319
raise errors.BzrMoveFailedError('',to_dir,
1320
errors.NotADirectory(to_abs))
1321
if not self.has_filename(to_dir):
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotInWorkingDirectory(to_dir))
1324
to_dir_id = inv.path2id(to_dir)
1325
if to_dir_id is None:
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotVersionedError(path=str(to_dir)))
982
raise BzrError("destination %r is not a directory" % to_abs)
983
if not self.has_filename(to_name):
984
raise BzrError("destination %r not in working directory" % to_abs)
985
to_dir_id = inv.path2id(to_name)
986
if to_dir_id is None and to_name != '':
987
raise BzrError("destination %r is not a versioned directory" % to_name)
1329
988
to_dir_ie = inv[to_dir_id]
1330
989
if to_dir_ie.kind != 'directory':
1331
raise errors.BzrMoveFailedError('',to_dir,
1332
errors.NotADirectory(to_abs))
1334
# create rename entries and tuples
1335
for from_rel in from_paths:
1336
from_tail = splitpath(from_rel)[-1]
1337
from_id = inv.path2id(from_rel)
1339
raise errors.BzrMoveFailedError(from_rel,to_dir,
1340
errors.NotVersionedError(path=str(from_rel)))
1342
from_entry = inv[from_id]
1343
from_parent_id = from_entry.parent_id
1344
to_rel = pathjoin(to_dir, from_tail)
1345
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1347
from_tail=from_tail,
1348
from_parent_id=from_parent_id,
1349
to_rel=to_rel, to_tail=from_tail,
1350
to_parent_id=to_dir_id)
1351
rename_entries.append(rename_entry)
1352
rename_tuples.append((from_rel, to_rel))
1354
# determine which move mode to use. checks also for movability
1355
rename_entries = self._determine_mv_mode(rename_entries, after)
990
raise BzrError("destination %r is not a directory" % to_abs)
992
to_idpath = inv.get_idpath(to_dir_id)
995
if not self.has_filename(f):
996
raise BzrError("%r does not exist in working tree" % f)
997
f_id = inv.path2id(f)
999
raise BzrError("%r is not versioned" % f)
1000
name_tail = splitpath(f)[-1]
1001
dest_path = pathjoin(to_name, name_tail)
1002
if self.has_filename(dest_path):
1003
raise BzrError("destination %r already exists" % dest_path)
1004
if f_id in to_idpath:
1005
raise BzrError("can't move %r to a subdirectory of itself" % f)
1007
# OK, so there's a race here, it's possible that someone will
1008
# create a file in this interval and then the rename might be
1009
# left half-done. But we should have caught most problems.
1010
orig_inv = deepcopy(self.inventory)
1357
1011
original_modified = self._inventory_is_modified
1359
1013
if len(from_paths):
1360
1014
self._inventory_is_modified = True
1361
self._move(rename_entries)
1015
for f in from_paths:
1016
name_tail = splitpath(f)[-1]
1017
dest_path = pathjoin(to_name, name_tail)
1018
result.append((f, dest_path))
1019
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1021
osutils.rename(self.abspath(f), self.abspath(dest_path))
1023
raise BzrError("failed to rename %r to %r: %s" %
1024
(f, dest_path, e[1]))
1363
1026
# restore the inventory on error
1364
self._inventory_is_modified = original_modified
1027
self._set_inventory(orig_inv, dirty=original_modified)
1366
1029
self._write_inventory(inv)
1367
return rename_tuples
1369
def _determine_mv_mode(self, rename_entries, after=False):
1370
"""Determines for each from-to pair if both inventory and working tree
1371
or only the inventory has to be changed.
1373
Also does basic plausability tests.
1375
inv = self.inventory
1377
for rename_entry in rename_entries:
1378
# store to local variables for easier reference
1379
from_rel = rename_entry.from_rel
1380
from_id = rename_entry.from_id
1381
to_rel = rename_entry.to_rel
1382
to_id = inv.path2id(to_rel)
1383
only_change_inv = False
1385
# check the inventory for source and destination
1387
raise errors.BzrMoveFailedError(from_rel,to_rel,
1388
errors.NotVersionedError(path=str(from_rel)))
1389
if to_id is not None:
1390
raise errors.BzrMoveFailedError(from_rel,to_rel,
1391
errors.AlreadyVersionedError(path=str(to_rel)))
1393
# try to determine the mode for rename (only change inv or change
1394
# inv and file system)
1396
if not self.has_filename(to_rel):
1397
raise errors.BzrMoveFailedError(from_id,to_rel,
1398
errors.NoSuchFile(path=str(to_rel),
1399
extra="New file has not been created yet"))
1400
only_change_inv = True
1401
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1402
only_change_inv = True
1403
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1404
only_change_inv = False
1405
elif (not self.case_sensitive
1406
and from_rel.lower() == to_rel.lower()
1407
and self.has_filename(from_rel)):
1408
only_change_inv = False
1410
# something is wrong, so lets determine what exactly
1411
if not self.has_filename(from_rel) and \
1412
not self.has_filename(to_rel):
1413
raise errors.BzrRenameFailedError(from_rel,to_rel,
1414
errors.PathsDoNotExist(paths=(str(from_rel),
1417
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1418
rename_entry.only_change_inv = only_change_inv
1419
return rename_entries
1421
def _move(self, rename_entries):
1422
"""Moves a list of files.
1424
Depending on the value of the flag 'only_change_inv', the
1425
file will be moved on the file system or not.
1427
inv = self.inventory
1430
for entry in rename_entries:
1432
self._move_entry(entry)
1434
self._rollback_move(moved)
1438
def _rollback_move(self, moved):
1439
"""Try to rollback a previous move in case of an filesystem error."""
1440
inv = self.inventory
1443
self._move_entry(WorkingTree._RenameEntry(
1444
entry.to_rel, entry.from_id,
1445
entry.to_tail, entry.to_parent_id, entry.from_rel,
1446
entry.from_tail, entry.from_parent_id,
1447
entry.only_change_inv))
1448
except errors.BzrMoveFailedError, e:
1449
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1450
" The working tree is in an inconsistent state."
1451
" Please consider doing a 'bzr revert'."
1452
" Error message is: %s" % e)
1454
def _move_entry(self, entry):
1455
inv = self.inventory
1456
from_rel_abs = self.abspath(entry.from_rel)
1457
to_rel_abs = self.abspath(entry.to_rel)
1458
if from_rel_abs == to_rel_abs:
1459
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1460
"Source and target are identical.")
1462
if not entry.only_change_inv:
1464
osutils.rename(from_rel_abs, to_rel_abs)
1466
raise errors.BzrMoveFailedError(entry.from_rel,
1468
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1470
1032
@needs_tree_write_lock
1471
def rename_one(self, from_rel, to_rel, after=False):
1033
def rename_one(self, from_rel, to_rel):
1472
1034
"""Rename one file.
1474
1036
This can change the directory or the filename or both.
1476
rename_one has several 'modes' to work. First, it can rename a physical
1477
file and change the file_id. That is the normal mode. Second, it can
1478
only change the file_id without touching any physical file. This is
1479
the new mode introduced in version 0.15.
1481
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the second mode if 'after == False' and 'from_rel' is
1485
versioned but no longer in the working tree, and 'to_rel' is not
1486
versioned but present in the working tree.
1488
rename_one uses the first mode if 'after == False' and 'from_rel' is
1489
versioned and present in the working tree, and 'to_rel' is not
1490
versioned and not present in the working tree.
1492
Everything else results in an error.
1494
1038
inv = self.inventory
1497
# create rename entries and tuples
1498
from_tail = splitpath(from_rel)[-1]
1499
from_id = inv.path2id(from_rel)
1501
# if file is missing in the inventory maybe it's in the basis_tree
1502
basis_tree = self.branch.basis_tree()
1503
from_id = basis_tree.path2id(from_rel)
1505
raise errors.BzrRenameFailedError(from_rel,to_rel,
1506
errors.NotVersionedError(path=str(from_rel)))
1507
# put entry back in the inventory so we can rename it
1508
from_entry = basis_tree.inventory[from_id].copy()
1511
from_entry = inv[from_id]
1512
from_parent_id = from_entry.parent_id
1039
if not self.has_filename(from_rel):
1040
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1041
if self.has_filename(to_rel):
1042
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1044
file_id = inv.path2id(from_rel)
1046
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1048
entry = inv[file_id]
1049
from_parent = entry.parent_id
1050
from_name = entry.name
1052
if inv.path2id(to_rel):
1053
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1513
1055
to_dir, to_tail = os.path.split(to_rel)
1514
1056
to_dir_id = inv.path2id(to_dir)
1515
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1517
from_tail=from_tail,
1518
from_parent_id=from_parent_id,
1519
to_rel=to_rel, to_tail=to_tail,
1520
to_parent_id=to_dir_id)
1521
rename_entries.append(rename_entry)
1523
# determine which move mode to use. checks also for movability
1524
rename_entries = self._determine_mv_mode(rename_entries, after)
1526
# check if the target changed directory and if the target directory is
1528
if to_dir_id is None:
1529
raise errors.BzrMoveFailedError(from_rel,to_rel,
1530
errors.NotVersionedError(path=str(to_dir)))
1532
# all checks done. now we can continue with our actual work
1533
mutter('rename_one:\n'
1538
' to_dir_id {%s}\n',
1539
from_id, from_rel, to_rel, to_dir, to_dir_id)
1541
self._move(rename_entries)
1057
if to_dir_id is None and to_dir != '':
1058
raise BzrError("can't determine destination directory id for %r" % to_dir)
1060
mutter("rename_one:")
1061
mutter(" file_id {%s}" % file_id)
1062
mutter(" from_rel %r" % from_rel)
1063
mutter(" to_rel %r" % to_rel)
1064
mutter(" to_dir %r" % to_dir)
1065
mutter(" to_dir_id {%s}" % to_dir_id)
1067
inv.rename(file_id, to_dir_id, to_tail)
1069
from_abs = self.abspath(from_rel)
1070
to_abs = self.abspath(to_rel)
1072
osutils.rename(from_abs, to_abs)
1074
inv.rename(file_id, from_parent, from_name)
1075
raise BzrError("failed to rename %r to %r: %s"
1076
% (from_abs, to_abs, e[1]))
1542
1077
self._write_inventory(inv)
1544
class _RenameEntry(object):
1545
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1546
to_rel, to_tail, to_parent_id, only_change_inv=False):
1547
self.from_rel = from_rel
1548
self.from_id = from_id
1549
self.from_tail = from_tail
1550
self.from_parent_id = from_parent_id
1551
self.to_rel = to_rel
1552
self.to_tail = to_tail
1553
self.to_parent_id = to_parent_id
1554
self.only_change_inv = only_change_inv
1556
1079
@needs_read_lock
1557
1080
def unknowns(self):
1558
1081
"""Return all unknown files.
1718
1294
if ignoreset is not None:
1719
1295
return ignoreset
1721
ignore_globs = set()
1297
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1722
1298
ignore_globs.update(ignores.get_runtime_ignores())
1723
1300
ignore_globs.update(ignores.get_user_ignores())
1724
1302
if self.has_filename(bzrlib.IGNORE_FILENAME):
1725
1303
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1727
1305
ignore_globs.update(ignores.parse_ignore_file(f))
1730
1309
self._ignoreset = ignore_globs
1310
self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1731
1311
return ignore_globs
1733
def _flush_ignore_list_cache(self):
1734
"""Resets the cached ignore list to force a cache rebuild."""
1735
self._ignoreset = None
1736
self._ignoreglobster = None
1313
def _get_ignore_rules_as_regex(self):
1314
"""Return a regex of the ignore rules and a mapping dict.
1316
:return: (ignore rules compiled regex, dictionary mapping rule group
1317
indices to original rule.)
1319
if getattr(self, '_ignoreset', None) is None:
1320
self.get_ignore_list()
1321
return self._ignore_regex
1738
1323
def is_ignored(self, filename):
1739
1324
r"""Check whether the filename matches an ignore pattern.
1741
1326
Patterns containing '/' or '\' need to match the whole path;
1742
others match against only the last component. Patterns starting
1743
with '!' are ignore exceptions. Exceptions take precedence
1744
over regular patterns and cause the filename to not be ignored.
1327
others match against only the last component.
1746
1329
If the file is ignored, returns the pattern which caused it to
1747
1330
be ignored, otherwise None. So this can simply be used as a
1748
1331
boolean if desired."""
1749
if getattr(self, '_ignoreglobster', None) is None:
1750
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1751
return self._ignoreglobster.match(filename)
1333
# TODO: Use '**' to match directories, and other extended
1334
# globbing stuff from cvs/rsync.
1336
# XXX: fnmatch is actually not quite what we want: it's only
1337
# approximately the same as real Unix fnmatch, and doesn't
1338
# treat dotfiles correctly and allows * to match /.
1339
# Eventually it should be replaced with something more
1342
rules = self._get_ignore_rules_as_regex()
1343
for regex, mapping in rules:
1344
match = regex.match(filename)
1345
if match is not None:
1346
# one or more of the groups in mapping will have a non-None
1348
groups = match.groups()
1349
rules = [mapping[group] for group in
1350
mapping if groups[group] is not None]
1753
1354
def kind(self, file_id):
1754
1355
return file_kind(self.id2abspath(file_id))
1756
def stored_kind(self, file_id):
1757
"""See Tree.stored_kind"""
1758
return self.inventory[file_id].kind
1760
def _comparison_data(self, entry, path):
1761
abspath = self.abspath(path)
1763
stat_value = os.lstat(abspath)
1765
if getattr(e, 'errno', None) == errno.ENOENT:
1772
mode = stat_value.st_mode
1773
kind = osutils.file_kind_from_stat_mode(mode)
1774
if not supports_executable():
1775
executable = entry is not None and entry.executable
1777
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1778
return kind, executable, stat_value
1780
def _file_size(self, entry, stat_value):
1781
return stat_value.st_size
1783
1357
def last_revision(self):
1784
1358
"""Return the last revision of the branch for this tree.
1929
1469
def read_basis_inventory(self):
1930
1470
"""Read the cached basis inventory."""
1931
1471
path = self._basis_inventory_name()
1932
return self._transport.get_bytes(path)
1472
return self._control_files.get(path).read()
1934
1474
@needs_read_lock
1935
1475
def read_working_inventory(self):
1936
1476
"""Read the working inventory.
1938
1478
:raises errors.InventoryModified: read_working_inventory will fail
1939
1479
when the current in memory inventory has been modified.
1941
# conceptually this should be an implementation detail of the tree.
1481
# conceptually this should be an implementation detail of the tree.
1942
1482
# XXX: Deprecate this.
1943
1483
# ElementTree does its own conversion from UTF-8, so open in
1945
1485
if self._inventory_is_modified:
1946
1486
raise errors.InventoryModified(self)
1947
f = self._transport.get('inventory')
1949
result = self._deserialize(f)
1487
result = xml5.serializer_v5.read_inventory(
1488
self._control_files.get('inventory'))
1952
1489
self._set_inventory(result, dirty=False)
1955
1492
@needs_tree_write_lock
1956
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1958
"""Remove nominated files from the working inventory.
1960
:files: File paths relative to the basedir.
1961
:keep_files: If true, the files will also be kept.
1962
:force: Delete files and directories, even if they are changed and
1963
even if the directories are not empty.
1493
def remove(self, files, verbose=False, to_file=None):
1494
"""Remove nominated files from the working inventory..
1496
This does not remove their text. This does not run on XXX on what? RBC
1498
TODO: Refuse to remove modified files unless --force is given?
1500
TODO: Do something useful with directories.
1502
TODO: Should this remove the text or not? Tough call; not
1503
removing may be useful and the user can just use use rm, and
1504
is the opposite of add. Removing it is consistent with most
1505
other tools. Maybe an option.
1507
## TODO: Normalize names
1508
## TODO: Remove nested loops; better scalability
1965
1509
if isinstance(files, basestring):
1966
1510
files = [files]
1971
unknown_nested_files=set()
1973
to_file = sys.stdout
1975
def recurse_directory_to_add_files(directory):
1976
# Recurse directory and add all files
1977
# so we can check if they have changed.
1978
for parent_info, file_infos in self.walkdirs(directory):
1979
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1980
# Is it versioned or ignored?
1981
if self.path2id(relpath) or self.is_ignored(relpath):
1982
# Add nested content for deletion.
1983
new_files.add(relpath)
1985
# Files which are not versioned and not ignored
1986
# should be treated as unknown.
1987
unknown_nested_files.add((relpath, None, kind))
1989
for filename in files:
1990
# Get file name into canonical form.
1991
abspath = self.abspath(filename)
1992
filename = self.relpath(abspath)
1993
if len(filename) > 0:
1994
new_files.add(filename)
1995
recurse_directory_to_add_files(filename)
1997
files = list(new_files)
2000
return # nothing to do
2002
# Sort needed to first handle directory content before the directory
2003
files.sort(reverse=True)
2005
# Bail out if we are going to delete files we shouldn't
2006
if not keep_files and not force:
2007
has_changed_files = len(unknown_nested_files) > 0
2008
if not has_changed_files:
2009
for (file_id, path, content_change, versioned, parent_id, name,
2010
kind, executable) in self.iter_changes(self.basis_tree(),
2011
include_unchanged=True, require_versioned=False,
2012
want_unversioned=True, specific_files=files):
2013
if versioned == (False, False):
2014
# The record is unknown ...
2015
if not self.is_ignored(path[1]):
2016
# ... but not ignored
2017
has_changed_files = True
2019
elif (content_change and (kind[1] is not None) and
2020
osutils.is_inside_any(files, path[1])):
2021
# Versioned and changed, but not deleted, and still
2022
# in one of the dirs to be deleted.
2023
has_changed_files = True
2026
if has_changed_files:
2027
# Make delta show ALL applicable changes in error message.
2028
tree_delta = self.changes_from(self.basis_tree(),
2029
require_versioned=False, want_unversioned=True,
2030
specific_files=files)
2031
for unknown_file in unknown_nested_files:
2032
if unknown_file not in tree_delta.unversioned:
2033
tree_delta.unversioned.extend((unknown_file,))
2034
raise errors.BzrRemoveChangedFilesError(tree_delta)
2036
# Build inv_delta and delete files where applicable,
2037
# do this before any modifications to inventory.
1512
inv = self.inventory
1514
# do this before any modifications
2038
1515
for f in files:
2039
fid = self.path2id(f)
1516
fid = inv.path2id(f)
2042
message = "%s is not versioned." % (f,)
2045
# having removed it, it must be either ignored or unknown
2046
if self.is_ignored(f):
2050
# XXX: Really should be a more abstract reporter interface
2051
kind_ch = osutils.kind_marker(self.kind(fid))
2052
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2054
inv_delta.append((f, None, fid, None))
2055
message = "removed %s" % (f,)
2058
abs_path = self.abspath(f)
2059
if osutils.lexists(abs_path):
2060
if (osutils.isdir(abs_path) and
2061
len(os.listdir(abs_path)) > 0):
2063
osutils.rmtree(abs_path)
2065
message = "%s is not an empty directory "\
2066
"and won't be deleted." % (f,)
2068
osutils.delete_any(abs_path)
2069
message = "deleted %s" % (f,)
2070
elif message is not None:
2071
# Only care if we haven't done anything yet.
2072
message = "%s does not exist." % (f,)
2074
# Print only one message (if any) per file.
2075
if message is not None:
2077
self.apply_inventory_delta(inv_delta)
1518
# TODO: Perhaps make this just a warning, and continue?
1519
# This tends to happen when
1520
raise NotVersionedError(path=f)
1522
# having remove it, it must be either ignored or unknown
1523
if self.is_ignored(f):
1527
textui.show_status(new_status, inv[fid].kind, f,
1531
self._write_inventory(inv)
2079
1533
@needs_tree_write_lock
2080
def revert(self, filenames=None, old_tree=None, backups=True,
2081
pb=None, report_changes=False):
1534
def revert(self, filenames, old_tree=None, backups=True,
1535
pb=DummyProgress()):
2082
1536
from bzrlib.conflicts import resolve
2085
symbol_versioning.warn('Using [] to revert all files is deprecated'
2086
' as of bzr 0.91. Please use None (the default) instead.',
2087
DeprecationWarning, stacklevel=2)
2088
1537
if old_tree is None:
2089
basis_tree = self.basis_tree()
2090
basis_tree.lock_read()
2091
old_tree = basis_tree
1538
old_tree = self.basis_tree()
1539
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1540
if not len(filenames):
1541
self.set_parent_ids(self.get_parent_ids()[:1])
2095
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2097
if filenames is None and len(self.get_parent_ids()) > 1:
2099
last_revision = self.last_revision()
2100
if last_revision != _mod_revision.NULL_REVISION:
2101
if basis_tree is None:
2102
basis_tree = self.basis_tree()
2103
basis_tree.lock_read()
2104
parent_trees.append((last_revision, basis_tree))
2105
self.set_parent_trees(parent_trees)
2108
resolve(self, filenames, ignore_misses=True, recursive=True)
2110
if basis_tree is not None:
1544
resolve(self, filenames, ignore_misses=True)
2112
1545
return conflicts
2114
def revision_tree(self, revision_id):
2115
"""See Tree.revision_tree.
2117
WorkingTree can supply revision_trees for the basis revision only
2118
because there is only one cached inventory in the bzr directory.
2120
if revision_id == self.last_revision():
2122
xml = self.read_basis_inventory()
2123
except errors.NoSuchFile:
2127
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2128
# dont use the repository revision_tree api because we want
2129
# to supply the inventory.
2130
if inv.revision_id == revision_id:
2131
return revisiontree.RevisionTree(self.branch.repository,
2133
except errors.BadInventoryFormat:
2135
# raise if there was no inventory, or if we read the wrong inventory.
2136
raise errors.NoSuchRevisionInTree(self, revision_id)
2138
1547
# XXX: This method should be deprecated in favour of taking in a proper
2139
1548
# new Inventory object.
2140
1549
@needs_tree_write_lock
2141
1550
def set_inventory(self, new_inventory_list):
2142
1551
from bzrlib.inventory import (Inventory,
2143
1552
InventoryDirectory,
2146
1556
inv = Inventory(self.get_root_id())
2269
1662
# cant set that until we update the working trees last revision to be
2270
1663
# one from the new branch, because it will just get absorbed by the
2271
1664
# parent de-duplication logic.
2273
1666
# We MUST save it even if an error occurs, because otherwise the users
2274
1667
# local work is unreferenced and will appear to have been lost.
2278
1671
last_rev = self.get_parent_ids()[0]
2279
1672
except IndexError:
2280
last_rev = _mod_revision.NULL_REVISION
2281
if revision is None:
2282
revision = self.branch.last_revision()
2284
old_tip = old_tip or _mod_revision.NULL_REVISION
2286
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2287
# the branch we are bound to was updated
2288
# merge those changes in first
2289
base_tree = self.basis_tree()
2290
other_tree = self.branch.repository.revision_tree(old_tip)
2291
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2292
base_tree, this_tree=self,
2293
change_reporter=change_reporter)
2295
self.add_parent_tree((old_tip, other_tree))
2296
trace.note('Rerun update after fixing the conflicts.')
2299
if last_rev != _mod_revision.ensure_null(revision):
2300
# the working tree is up to date with the branch
2301
# we can merge the specified revision from master
2302
to_tree = self.branch.repository.revision_tree(revision)
2303
to_root_id = to_tree.get_root_id()
1674
if last_rev != self.branch.last_revision():
1675
# merge tree state up to new branch tip.
2305
1676
basis = self.basis_tree()
2308
if (basis.inventory.root is None
2309
or basis.inventory.root.file_id != to_root_id):
2310
self.set_root_id(to_root_id)
2315
# determine the branch point
2316
graph = self.branch.repository.get_graph()
2317
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2319
base_tree = self.branch.repository.revision_tree(base_rev_id)
2321
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2323
change_reporter=change_reporter)
2324
self.set_last_revision(revision)
1677
to_tree = self.branch.basis_tree()
1678
if basis.inventory.root is None:
1679
self.set_root_id(to_tree.inventory.root.file_id)
1680
result += merge.merge_inner(
2325
1685
# TODO - dedup parents list with things merged by pull ?
2326
1686
# reuse the tree we've updated to to set the basis:
2327
parent_trees = [(revision, to_tree)]
1687
parent_trees = [(self.branch.last_revision(), to_tree)]
2328
1688
merges = self.get_parent_ids()[1:]
2329
1689
# Ideally we ask the tree for the trees here, that way the working
2330
# tree can decide whether to give us the entire tree or give us a
1690
# tree can decide whether to give us teh entire tree or give us a
2331
1691
# lazy initialised tree. dirstate for instance will have the trees
2332
1692
# in ram already, whereas a last-revision + basis-inventory tree
2333
1693
# will not, but also does not need them when setting parents.
2334
1694
for parent in merges:
2335
1695
parent_trees.append(
2336
1696
(parent, self.branch.repository.revision_tree(parent)))
2337
if not _mod_revision.is_null(old_tip):
1697
if old_tip is not None:
2338
1698
parent_trees.append(
2339
1699
(old_tip, self.branch.repository.revision_tree(old_tip)))
2340
1700
self.set_parent_trees(parent_trees)
2341
1701
last_rev = parent_trees[0][0]
2344
def _write_hashcache_if_dirty(self):
2345
"""Write out the hashcache if it is dirty."""
2346
if self._hashcache.needs_write:
1703
# the working tree had the same last-revision as the master
1704
# branch did. We may still have pivot local work from the local
1705
# branch into old_tip:
1706
if old_tip is not None:
1707
self.add_parent_tree_id(old_tip)
1708
if old_tip and old_tip != last_rev:
1709
# our last revision was not the prior branch last revision
1710
# and we have converted that last revision to a pending merge.
1711
# base is somewhere between the branch tip now
1712
# and the now pending merge
1713
from bzrlib.revision import common_ancestor
2348
self._hashcache.write()
2350
if e.errno not in (errno.EPERM, errno.EACCES):
2352
# TODO: jam 20061219 Should this be a warning? A single line
2353
# warning might be sufficient to let the user know what
2355
mutter('Could not write hashcache for %s\nError: %s',
2356
self._hashcache.cache_file_name(), e)
1715
base_rev_id = common_ancestor(self.branch.last_revision(),
1717
self.branch.repository)
1718
except errors.NoCommonAncestor:
1720
base_tree = self.branch.repository.revision_tree(base_rev_id)
1721
other_tree = self.branch.repository.revision_tree(old_tip)
1722
result += merge.merge_inner(
2358
1729
@needs_tree_write_lock
2359
1730
def _write_inventory(self, inv):
2393
1764
file_id=self.path2id(conflicted)))
2394
1765
return conflicts
2396
def walkdirs(self, prefix=""):
2397
"""Walk the directories of this tree.
2399
returns a generator which yields items in the form:
2400
((curren_directory_path, fileid),
2401
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2404
This API returns a generator, which is only valid during the current
2405
tree transaction - within a single lock_read or lock_write duration.
2407
If the tree is not locked, it may cause an error to be raised,
2408
depending on the tree implementation.
2410
disk_top = self.abspath(prefix)
2411
if disk_top.endswith('/'):
2412
disk_top = disk_top[:-1]
2413
top_strip_len = len(disk_top) + 1
2414
inventory_iterator = self._walkdirs(prefix)
2415
disk_iterator = osutils.walkdirs(disk_top, prefix)
2417
current_disk = disk_iterator.next()
2418
disk_finished = False
2420
if not (e.errno == errno.ENOENT or
2421
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2424
disk_finished = True
2426
current_inv = inventory_iterator.next()
2427
inv_finished = False
2428
except StopIteration:
2431
while not inv_finished or not disk_finished:
2433
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
cur_disk_dir_content) = current_disk
2436
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2437
cur_disk_dir_content) = ((None, None), None)
2438
if not disk_finished:
2439
# strip out .bzr dirs
2440
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2441
len(cur_disk_dir_content) > 0):
2442
# osutils.walkdirs can be made nicer -
2443
# yield the path-from-prefix rather than the pathjoined
2445
bzrdir_loc = bisect_left(cur_disk_dir_content,
2447
if (bzrdir_loc < len(cur_disk_dir_content)
2448
and self.bzrdir.is_control_filename(
2449
cur_disk_dir_content[bzrdir_loc][0])):
2450
# we dont yield the contents of, or, .bzr itself.
2451
del cur_disk_dir_content[bzrdir_loc]
2453
# everything is unknown
2456
# everything is missing
2459
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2461
# disk is before inventory - unknown
2462
dirblock = [(relpath, basename, kind, stat, None, None) for
2463
relpath, basename, kind, stat, top_path in
2464
cur_disk_dir_content]
2465
yield (cur_disk_dir_relpath, None), dirblock
2467
current_disk = disk_iterator.next()
2468
except StopIteration:
2469
disk_finished = True
2471
# inventory is before disk - missing.
2472
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2473
for relpath, basename, dkind, stat, fileid, kind in
2475
yield (current_inv[0][0], current_inv[0][1]), dirblock
2477
current_inv = inventory_iterator.next()
2478
except StopIteration:
2481
# versioned present directory
2482
# merge the inventory and disk data together
2484
for relpath, subiterator in itertools.groupby(sorted(
2485
current_inv[1] + cur_disk_dir_content,
2486
key=operator.itemgetter(0)), operator.itemgetter(1)):
2487
path_elements = list(subiterator)
2488
if len(path_elements) == 2:
2489
inv_row, disk_row = path_elements
2490
# versioned, present file
2491
dirblock.append((inv_row[0],
2492
inv_row[1], disk_row[2],
2493
disk_row[3], inv_row[4],
2495
elif len(path_elements[0]) == 5:
2497
dirblock.append((path_elements[0][0],
2498
path_elements[0][1], path_elements[0][2],
2499
path_elements[0][3], None, None))
2500
elif len(path_elements[0]) == 6:
2501
# versioned, absent file.
2502
dirblock.append((path_elements[0][0],
2503
path_elements[0][1], 'unknown', None,
2504
path_elements[0][4], path_elements[0][5]))
2506
raise NotImplementedError('unreachable code')
2507
yield current_inv[0], dirblock
2509
current_inv = inventory_iterator.next()
2510
except StopIteration:
2513
current_disk = disk_iterator.next()
2514
except StopIteration:
2515
disk_finished = True
2517
def _walkdirs(self, prefix=""):
2518
"""Walk the directories of this tree.
2520
:prefix: is used as the directrory to start with.
2521
returns a generator which yields items in the form:
2522
((curren_directory_path, fileid),
2523
[(file1_path, file1_name, file1_kind, None, file1_id,
2526
_directory = 'directory'
2527
# get the root in the inventory
2528
inv = self.inventory
2529
top_id = inv.path2id(prefix)
2533
pending = [(prefix, '', _directory, None, top_id, None)]
2536
currentdir = pending.pop()
2537
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2538
top_id = currentdir[4]
2540
relroot = currentdir[0] + '/'
2543
# FIXME: stash the node in pending
2545
if entry.kind == 'directory':
2546
for name, child in entry.sorted_children():
2547
dirblock.append((relroot + name, name, child.kind, None,
2548
child.file_id, child.kind
2550
yield (currentdir[0], entry.file_id), dirblock
2551
# push the user specified dirs from dirblock
2552
for dir in reversed(dirblock):
2553
if dir[2] == _directory:
2556
@needs_tree_write_lock
2557
def auto_resolve(self):
2558
"""Automatically resolve text conflicts according to contents.
2560
Only text conflicts are auto_resolvable. Files with no conflict markers
2561
are considered 'resolved', because bzr always puts conflict markers
2562
into files that have text conflicts. The corresponding .THIS .BASE and
2563
.OTHER files are deleted, as per 'resolve'.
2564
:return: a tuple of ConflictLists: (un_resolved, resolved).
2566
un_resolved = _mod_conflicts.ConflictList()
2567
resolved = _mod_conflicts.ConflictList()
2568
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2569
for conflict in self.conflicts():
2570
if (conflict.typestring != 'text conflict' or
2571
self.kind(conflict.file_id) != 'file'):
2572
un_resolved.append(conflict)
2574
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2576
for line in my_file:
2577
if conflict_re.search(line):
2578
un_resolved.append(conflict)
2581
resolved.append(conflict)
2584
resolved.remove_files(self)
2585
self.set_conflicts(un_resolved)
2586
return un_resolved, resolved
2589
def _check(self, references):
2590
"""Check the tree for consistency.
2592
:param references: A dict with keys matching the items returned by
2593
self._get_check_refs(), and values from looking those keys up in
2596
tree_basis = self.basis_tree()
2597
tree_basis.lock_read()
2599
repo_basis = references[('trees', self.last_revision())]
2600
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2601
raise errors.BzrCheckError(
2602
"Mismatched basis inventory content.")
2607
def _validate(self):
2608
"""Validate internal structures.
2610
This is meant mostly for the test suite. To give it a chance to detect
2611
corruption after actions have occurred. The default implementation is a
2614
:return: None. An exception should be raised if there is an error.
2618
def _get_rules_searcher(self, default_searcher):
2619
"""See Tree._get_rules_searcher."""
2620
if self._rules_searcher is None:
2621
self._rules_searcher = super(WorkingTree,
2622
self)._get_rules_searcher(default_searcher)
2623
return self._rules_searcher
2625
def get_shelf_manager(self):
2626
"""Return the ShelfManager for this WorkingTree."""
2627
from bzrlib.shelf import ShelfManager
2628
return ShelfManager(self, self._transport)
2631
1768
class WorkingTree2(WorkingTree):
2632
1769
"""This is the Format 2 working tree.
2634
This was the first weave based working tree.
1771
This was the first weave based working tree.
2635
1772
- uses os locks for locking.
2636
1773
- uses the branch last-revision.
2639
def __init__(self, *args, **kwargs):
2640
super(WorkingTree2, self).__init__(*args, **kwargs)
2641
# WorkingTree2 has more of a constraint that self._inventory must
2642
# exist. Because this is an older format, we don't mind the overhead
2643
# caused by the extra computation here.
2645
# Newer WorkingTree's should only have self._inventory set when they
2647
if self._inventory is None:
2648
self.read_working_inventory()
2650
def _get_check_refs(self):
2651
"""Return the references needed to perform a check of this tree."""
2652
return [('trees', self.last_revision())]
2654
1776
def lock_tree_write(self):
2655
1777
"""See WorkingTree.lock_tree_write().
2657
1779
In Format2 WorkingTrees we have a single lock for the branch and tree
2658
1780
so lock_tree_write() degrades to lock_write().
2660
:return: An object with an unlock method which will release the lock
2663
1782
self.branch.lock_write()
2665
self._control_files.lock_write()
1784
return self._control_files.lock_write()
2668
1786
self.branch.unlock()
2671
1789
def unlock(self):
2672
# do non-implementation specific cleanup
2675
1790
# we share control files:
2676
1791
if self._control_files._lock_count == 3:
2677
1792
# _inventory_is_modified is always False during a read lock.
2678
1793
if self._inventory_is_modified:
2680
self._write_hashcache_if_dirty()
1795
if self._hashcache.needs_write:
1796
self._hashcache.write()
2682
1797
# reverse order of locking.
2684
1799
return self._control_files.unlock()
2859
1961
def unregister_format(klass, format):
1962
assert klass._formats[format.get_format_string()] is format
2860
1963
del klass._formats[format.get_format_string()]
2863
1967
class WorkingTreeFormat2(WorkingTreeFormat):
2864
"""The second working tree format.
1968
"""The second working tree format.
2866
1970
This format modified the hash cache from the format 1 hash cache.
2869
upgrade_recommended = True
2871
1973
def get_format_description(self):
2872
1974
"""See WorkingTreeFormat.get_format_description()."""
2873
1975
return "Working tree format 2"
2875
def _stub_initialize_on_transport(self, transport, file_mode):
2876
"""Workaround: create control files for a remote working tree.
1977
def stub_initialize_remote(self, control_files):
1978
"""As a special workaround create critical control files for a remote working tree
2878
1980
This ensures that it can later be updated and dealt with locally,
2879
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1981
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2880
1982
no working tree. (See bug #43064).
2882
1984
sio = StringIO()
2883
inv = inventory.Inventory()
2884
xml5.serializer_v5.write_inventory(inv, sio, working=True)
1986
xml5.serializer_v5.write_inventory(inv, sio)
2886
transport.put_file('inventory', sio, file_mode)
2887
transport.put_bytes('pending-merges', '', file_mode)
2889
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2890
accelerator_tree=None, hardlink=False):
1988
control_files.put('inventory', sio)
1990
control_files.put_utf8('pending-merges', '')
1993
def initialize(self, a_bzrdir, revision_id=None):
2891
1994
"""See WorkingTreeFormat.initialize()."""
2892
1995
if not isinstance(a_bzrdir.transport, LocalTransport):
2893
1996
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2894
if from_branch is not None:
2895
branch = from_branch
2897
branch = a_bzrdir.open_branch()
2898
if revision_id is None:
2899
revision_id = _mod_revision.ensure_null(branch.last_revision())
2902
branch.generate_revision_history(revision_id)
2905
inv = inventory.Inventory()
1997
branch = a_bzrdir.open_branch()
1998
if revision_id is not None:
2001
revision_history = branch.revision_history()
2003
position = revision_history.index(revision_id)
2005
raise errors.NoSuchRevision(branch, revision_id)
2006
branch.set_revision_history(revision_history[:position + 1])
2009
revision = branch.last_revision()
2906
2011
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2909
2014
_internal=True,
2911
2016
_bzrdir=a_bzrdir)
2912
basis_tree = branch.repository.revision_tree(revision_id)
2017
basis_tree = branch.repository.revision_tree(revision)
2913
2018
if basis_tree.inventory.root is not None:
2914
wt.set_root_id(basis_tree.get_root_id())
2019
wt.set_root_id(basis_tree.inventory.root.file_id)
2915
2020
# set the parent list and cache the basis tree.
2916
if _mod_revision.is_null(revision_id):
2919
parent_trees = [(revision_id, basis_tree)]
2920
wt.set_parent_trees(parent_trees)
2021
wt.set_parent_trees([(revision, basis_tree)])
2921
2022
transform.build_tree(basis_tree, wt)
3054
2133
raise NotImplementedError
3055
2134
if not isinstance(a_bzrdir.transport, LocalTransport):
3056
2135
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3057
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2136
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3060
2138
def _open(self, a_bzrdir, control_files):
3061
2139
"""Open the tree itself.
3063
2141
:param a_bzrdir: the dir for the tree.
3064
2142
:param control_files: the control files for the tree.
3066
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3070
_control_files=control_files)
2144
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2148
_control_files=control_files)
3072
2150
def __str__(self):
3073
2151
return self.get_format_string()
3076
__default_format = WorkingTreeFormat6()
2154
# formats which have no format string are not discoverable
2155
# and not independently creatable, so are not registered.
2156
__default_format = WorkingTreeFormat3()
3077
2157
WorkingTreeFormat.register_format(__default_format)
3078
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3079
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3080
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3081
2158
WorkingTreeFormat.set_default_format(__default_format)
3082
# formats which have no format string are not discoverable
3083
# and not independently creatable, so are not registered.
3084
2159
_legacy_formats = [WorkingTreeFormat2(),
2163
class WorkingTreeTestProviderAdapter(object):
2164
"""A tool to generate a suite testing multiple workingtree formats at once.
2166
This is done by copying the test once for each transport and injecting
2167
the transport_server, transport_readonly_server, and workingtree_format
2168
classes into each copy. Each copy is also given a new id() to make it
2172
def __init__(self, transport_server, transport_readonly_server, formats):
2173
self._transport_server = transport_server
2174
self._transport_readonly_server = transport_readonly_server
2175
self._formats = formats
2177
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2178
"""Clone test for adaption."""
2179
new_test = deepcopy(test)
2180
new_test.transport_server = self._transport_server
2181
new_test.transport_readonly_server = self._transport_readonly_server
2182
new_test.bzrdir_format = bzrdir_format
2183
new_test.workingtree_format = workingtree_format
2184
def make_new_test_id():
2185
new_id = "%s(%s)" % (test.id(), variation)
2186
return lambda: new_id
2187
new_test.id = make_new_test_id()
2190
def adapt(self, test):
2191
from bzrlib.tests import TestSuite
2192
result = TestSuite()
2193
for workingtree_format, bzrdir_format in self._formats:
2194
new_test = self._clone_test(
2197
workingtree_format, workingtree_format.__class__.__name__)
2198
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
