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
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
39
44
from bisect import bisect_left
46
from copy import deepcopy
48
55
from bzrlib import (
51
58
conflicts as _mod_conflicts,
60
revision as _mod_revision,
69
76
import bzrlib.branch
70
77
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
79
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
82
from bzrlib import symbol_versioning
79
83
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lockable_files import LockableFiles
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
85
from bzrlib.lockable_files import LockableFiles, TransportLock
81
86
from bzrlib.lockdir import LockDir
82
87
import bzrlib.mutabletree
83
88
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
89
from bzrlib.osutils import (
93
99
supports_executable,
95
from bzrlib.filters import filtered_input_file
96
101
from bzrlib.trace import mutter, note
97
102
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
103
from bzrlib.progress import DummyProgress, ProgressPhase
104
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
105
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
106
from bzrlib.symbol_versioning import (deprecated_passed,
109
DEPRECATED_PARAMETER,
106
116
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.
110
117
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
120
@deprecated_function(zero_thirteen)
121
def gen_file_id(name):
122
"""Return new file id for the basename 'name'.
124
Use bzrlib.generate_ids.gen_file_id() instead
126
return generate_ids.gen_file_id(name)
129
@deprecated_function(zero_thirteen)
131
"""Return a new tree-root file id.
133
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
135
return generate_ids.gen_root_id()
115
138
class TreeEntry(object):
116
139
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
141
This needs further inspection, it may be better to have
119
142
InventoryEntries without ids - though that seems wrong. For now,
120
143
this is a parallel hierarchy to InventoryEntry, and needs to become
121
144
one of several things: decorates to that hierarchy, children of, or
192
"""Construct a WorkingTree instance. This is not a public API.
210
"""Construct a WorkingTree for basedir.
194
:param branch: A branch to override probing for the branch.
212
If the branch is not supplied, it is opened automatically.
213
If the branch is supplied, it must be the branch for this basedir.
214
(branch.base is not cross checked, because for remote branches that
215
would be meaningless).
196
217
self._format = _format
197
218
self.bzrdir = _bzrdir
198
219
if not _internal:
199
raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
"WorkingTree.open() to obtain a WorkingTree.")
220
# not created via open etc.
221
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
"Please use bzrdir.open_workingtree or WorkingTree.open().",
225
wt = WorkingTree.open(basedir)
226
self._branch = wt.branch
227
self.basedir = wt.basedir
228
self._control_files = wt._control_files
229
self._hashcache = wt._hashcache
230
self._set_inventory(wt._inventory, dirty=False)
231
self._format = wt._format
232
self.bzrdir = wt.bzrdir
233
assert isinstance(basedir, basestring), \
234
"base directory %r is not a string" % basedir
201
235
basedir = safe_unicode(basedir)
202
236
mutter("opening working tree %r", basedir)
203
237
if deprecated_passed(branch):
239
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
240
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
241
" WorkingTree.open().",
204
245
self._branch = branch
206
247
self._branch = self.bzrdir.open_branch()
422
404
# at this point ?
424
406
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
407
except errors.RevisionNotPresent:
426
408
# the basis tree *may* be a ghost or a low level error may have
427
# occurred. If the revision is present, its a problem, if its not
409
# occured. If the revision is present, its a problem, if its not
429
411
if self.branch.repository.has_revision(revision_id):
431
413
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
414
return self.branch.repository.revision_tree(None)
417
@deprecated_method(zero_eight)
418
def create(branch, directory):
419
"""Create a workingtree for branch at directory.
421
If existing_directory already exists it must have a .bzr directory.
422
If it does not exist, it will be created.
424
This returns a new WorkingTree object for the new checkout.
426
TODO FIXME RBC 20060124 when we have checkout formats in place this
427
should accept an optional revisionid to checkout [and reject this if
428
checking out into the same dir as a pre-checkout-aware branch format.]
430
XXX: When BzrDir is present, these should be created through that
433
warnings.warn('delete WorkingTree.create', stacklevel=3)
434
transport = get_transport(directory)
435
if branch.bzrdir.root_transport.base == transport.base:
437
return branch.bzrdir.create_workingtree()
438
# different directory,
439
# create a branch reference
440
# and now a working tree.
441
raise NotImplementedError
444
@deprecated_method(zero_eight)
445
def create_standalone(directory):
446
"""Create a checkout and a branch and a repo at directory.
448
Directory must exist and be empty.
450
please use BzrDir.create_standalone_workingtree
452
return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
454
def relpath(self, path):
439
455
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
457
The path may be absolute or relative. If its a relative path it is
442
458
interpreted relative to the python current working directory.
444
460
return osutils.relpath(self.basedir, path)
446
462
def has_filename(self, filename):
447
463
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
465
def get_file(self, file_id):
466
file_id = osutils.safe_file_id(file_id)
467
return self.get_file_byname(self.id2path(file_id))
469
def get_file_text(self, file_id):
470
file_id = osutils.safe_file_id(file_id)
471
return self.get_file(file_id).read()
473
def get_file_byname(self, filename):
474
return file(self.abspath(filename), 'rb')
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
477
def annotate_iter(self, file_id):
486
478
"""See Tree.annotate_iter
488
480
This implementation will use the basis tree implementation if possible.
492
484
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
485
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
487
file_id = osutils.safe_file_id(file_id)
488
basis = self.basis_tree()
489
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
490
require_versioned=True).next()
491
changed_content, kind = changes[2], changes[6]
492
if not changed_content:
493
return basis.annotate_iter(file_id)
497
if kind[0] != 'file':
500
old_lines = list(basis.annotate_iter(file_id))
502
for tree in self.branch.repository.revision_trees(
503
self.get_parent_ids()[1:]):
504
if file_id not in tree:
506
old.append(list(tree.annotate_iter(file_id)))
507
return annotate.reannotate(old, self.get_file(file_id).readlines(),
539
510
def get_parent_ids(self):
540
511
"""See Tree.get_parent_ids.
542
513
This implementation reads the pending merges list and last_revision
543
514
value and uses that to decide what the parents list should be.
545
last_rev = _mod_revision.ensure_null(self._last_revision())
546
if _mod_revision.NULL_REVISION == last_rev:
516
last_rev = self._last_revision()
549
520
parents = [last_rev]
551
merges_bytes = self._transport.get_bytes('pending-merges')
522
merges_file = self._control_files.get('pending-merges')
552
523
except errors.NoSuchFile:
555
for l in osutils.split_lines(merges_bytes):
556
revision_id = l.rstrip('\n')
526
for l in merges_file.readlines():
527
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
528
parents.append(revision_id)
561
532
def get_root_id(self):
562
533
"""Return the id of this trees root"""
563
534
return self._inventory.root.file_id
565
536
def _get_store_filename(self, file_id):
566
537
## XXX: badly named; this is not in the store at all
538
file_id = osutils.safe_file_id(file_id)
567
539
return self.abspath(self.id2path(file_id))
570
def clone(self, to_bzrdir, revision_id=None):
542
def clone(self, to_bzrdir, revision_id=None, basis=None):
571
543
"""Duplicate this working tree into to_bzr, including all state.
573
545
Specifically modified files are kept as modified, but
574
546
ignored and unknown files are discarded.
576
548
If you want to make a new line of development, see bzrdir.sprout()
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
551
If not None, the cloned tree will have its last revision set to
552
revision, and and difference between the source trees last revision
581
553
and this one merged in.
556
If not None, a closer copy of a tree which may have some files in
557
common, and which file content should be preferentially copied from.
583
559
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
560
result = self._format.initialize(to_bzrdir)
585
561
self.copy_content_into(result, revision_id)
616
595
__contains__ = has_id
618
597
def get_file_size(self, file_id):
619
"""See Tree.get_file_size"""
620
# XXX: this returns the on-disk size; it should probably return the
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
598
file_id = osutils.safe_file_id(file_id)
599
return os.path.getsize(self.id2abspath(file_id))
631
602
def get_file_sha1(self, file_id, path=None, stat_value=None):
603
file_id = osutils.safe_file_id(file_id)
633
605
path = self._inventory.id2path(file_id)
634
606
return self._hashcache.get_sha1(path, stat_value)
636
608
def get_file_mtime(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
638
611
path = self.inventory.id2path(file_id)
639
612
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
614
if not supports_executable():
654
615
def is_executable(self, file_id, path=None):
616
file_id = osutils.safe_file_id(file_id)
655
617
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
619
def is_executable(self, file_id, path=None):
621
file_id = osutils.safe_file_id(file_id)
662
622
path = self.id2path(file_id)
663
623
mode = os.lstat(self.abspath(path)).st_mode
664
624
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
626
@needs_tree_write_lock
670
627
def _add(self, files, ids, kinds):
671
628
"""See MutableTree._add."""
672
629
# TODO: Re-adding a file that is removed in the working copy
673
630
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
631
# the read and write working inventory should not occur in this
675
632
# function - they should be part of lock_write and unlock.
633
inv = self.read_working_inventory()
677
634
for f, file_id, kind in zip(files, ids, kinds):
635
assert kind is not None
678
636
if file_id is None:
679
637
inv.add_path(f, kind=kind)
639
file_id = osutils.safe_file_id(file_id)
681
640
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
641
self._write_inventory(inv)
684
643
@needs_tree_write_lock
685
644
def _gather_kinds(self, files, kinds):
746
705
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
def path_content_summary(self, path, _lstat=os.lstat,
749
_mapper=osutils.file_kind_from_stat_mode):
750
"""See Tree.path_content_summary."""
751
abspath = self.abspath(path)
753
stat_result = _lstat(abspath)
755
if getattr(e, 'errno', None) == errno.ENOENT:
757
return ('missing', None, None, None)
758
# propagate other errors
760
kind = _mapper(stat_result.st_mode)
762
return self._file_content_summary(path, stat_result)
763
elif kind == 'directory':
764
# perhaps it looks like a plain directory, but it's really a
766
if self._directory_is_tree_reference(path):
767
kind = 'tree-reference'
768
return kind, None, None, None
769
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
773
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
return ('file', size, executable, self._sha_from_stat(
707
@deprecated_method(zero_eleven)
709
def pending_merges(self):
710
"""Return a list of pending merges.
712
These are revisions that have been merged into the working
713
directory but not yet committed.
715
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
716
instead - which is available on all tree objects.
718
return self.get_parent_ids()[1:]
782
720
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
721
"""Common ghost checking functionality from set_parent_*.
828
746
:param revision_ids: The revision_ids to set as the parent ids of this
829
747
working tree. Any of these may be ghosts.
749
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
750
self._check_parents_for_ghosts(revision_ids,
832
751
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
753
if len(revision_ids) > 0:
839
754
self.set_last_revision(revision_ids[0])
841
self.set_last_revision(_mod_revision.NULL_REVISION)
756
self.set_last_revision(None)
843
758
self._set_merges_from_parent_ids(revision_ids)
845
760
@needs_tree_write_lock
846
761
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
762
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
763
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
852
765
self._check_parents_for_ghosts(parent_ids,
853
766
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
768
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
769
leftmost_parent_id = None
859
770
leftmost_parent_tree = None
861
772
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
914
813
branch.last_revision().
916
815
from bzrlib.merge import Merger, Merge3Merger
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
816
pb = bzrlib.ui.ui_factory.nested_progress_bar()
818
merger = Merger(self.branch, this_tree=self, pb=pb)
819
merger.pp = ProgressPhase("Merge phase", 5, pb)
820
merger.pp.next_phase()
821
# check that there are no
823
merger.check_basis(check_clean=True, require_commits=False)
824
if to_revision is None:
825
to_revision = branch.last_revision()
827
to_revision = osutils.safe_revision_id(to_revision)
828
merger.other_rev_id = to_revision
829
if merger.other_rev_id is None:
830
raise error.NoCommits(branch)
831
self.branch.fetch(branch, last_revision=merger.other_rev_id)
832
merger.other_basis = merger.other_rev_id
833
merger.other_tree = self.branch.repository.revision_tree(
835
merger.other_branch = branch
836
merger.pp.next_phase()
932
837
merger.find_base()
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
838
if merger.base_rev_id == merger.other_rev_id:
839
raise errors.PointlessMerge
840
merger.backup_files = False
939
841
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
842
merger.set_interesting_files(None)
843
merger.show_base = False
844
merger.reprocess = False
845
conflicts = merger.do_merge()
950
852
def merge_modified(self):
951
853
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
855
The list is initialized by WorkingTree.set_merge_modified, which is
954
856
typically called after we make some automatic updates to the tree
955
857
because of a merge.
1036
933
other_tree.unlock()
1037
934
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
936
@needs_tree_write_lock
1066
937
def extract(self, file_id, format=None):
1067
938
"""Extract a subtree from this tree.
1069
940
A new branch will be created, relative to the path for this tree.
1072
942
def mkdirs(path):
1073
943
segments = osutils.splitpath(path)
1074
944
transport = self.branch.bzrdir.root_transport
1075
945
for name in segments:
1076
946
transport = transport.clone(name)
1077
transport.ensure_base()
949
except errors.FileExists:
1078
951
return transport
1080
953
sub_path = self.id2path(file_id)
1081
954
branch_transport = mkdirs(sub_path)
1082
955
if format is None:
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
956
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
958
branch_transport.mkdir('.')
959
except errors.FileExists:
1085
961
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
963
repo = branch_bzrdir.find_repository()
1088
964
except errors.NoRepositoryPresent:
1089
965
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
966
assert repo.supports_rich_root()
968
if not repo.supports_rich_root():
969
raise errors.RootNotRich()
1092
970
new_branch = branch_bzrdir.create_branch()
1093
971
new_branch.pull(self.branch)
1094
972
for parent_id in self.get_parent_ids():
1127
1003
sio = StringIO()
1128
1004
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1006
self._control_files.put('inventory', sio)
1132
1007
self._inventory_is_modified = False
1134
def _kind(self, relpath):
1135
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
1009
def list_files(self, include_root=False):
1010
"""Recursively list all files as (path, class, kind, id, entry).
1140
1012
Lists, but does not descend into unversioned directories.
1141
1014
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
1017
Skips the control directory.
1148
1019
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1020
# with it. So callers should be careful to always read_lock the tree.
1910
1762
def read_basis_inventory(self):
1911
1763
"""Read the cached basis inventory."""
1912
1764
path = self._basis_inventory_name()
1913
return self._transport.get_bytes(path)
1765
return self._control_files.get(path).read()
1915
1767
@needs_read_lock
1916
1768
def read_working_inventory(self):
1917
1769
"""Read the working inventory.
1919
1771
:raises errors.InventoryModified: read_working_inventory will fail
1920
1772
when the current in memory inventory has been modified.
1922
# conceptually this should be an implementation detail of the tree.
1774
# conceptually this should be an implementation detail of the tree.
1923
1775
# XXX: Deprecate this.
1924
1776
# ElementTree does its own conversion from UTF-8, so open in
1926
1778
if self._inventory_is_modified:
1927
1779
raise errors.InventoryModified(self)
1928
f = self._transport.get('inventory')
1930
result = self._deserialize(f)
1780
result = self._deserialize(self._control_files.get('inventory'))
1933
1781
self._set_inventory(result, dirty=False)
1936
1784
@needs_tree_write_lock
1937
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1939
"""Remove nominated files from the working inventory.
1941
:files: File paths relative to the basedir.
1942
:keep_files: If true, the files will also be kept.
1943
:force: Delete files and directories, even if they are changed and
1944
even if the directories are not empty.
1785
def remove(self, files, verbose=False, to_file=None):
1786
"""Remove nominated files from the working inventory..
1788
This does not remove their text. This does not run on XXX on what? RBC
1790
TODO: Refuse to remove modified files unless --force is given?
1792
TODO: Do something useful with directories.
1794
TODO: Should this remove the text or not? Tough call; not
1795
removing may be useful and the user can just use use rm, and
1796
is the opposite of add. Removing it is consistent with most
1797
other tools. Maybe an option.
1799
## TODO: Normalize names
1800
## TODO: Remove nested loops; better scalability
1946
1801
if isinstance(files, basestring):
1947
1802
files = [files]
1952
unknown_nested_files=set()
1954
to_file = sys.stdout
1956
def recurse_directory_to_add_files(directory):
1957
# Recurse directory and add all files
1958
# so we can check if they have changed.
1959
for parent_info, file_infos in\
1960
self.walkdirs(directory):
1961
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
# Is it versioned or ignored?
1963
if self.path2id(relpath) or self.is_ignored(relpath):
1964
# Add nested content for deletion.
1965
new_files.add(relpath)
1967
# Files which are not versioned and not ignored
1968
# should be treated as unknown.
1969
unknown_nested_files.add((relpath, None, kind))
1971
for filename in files:
1972
# Get file name into canonical form.
1973
abspath = self.abspath(filename)
1974
filename = self.relpath(abspath)
1975
if len(filename) > 0:
1976
new_files.add(filename)
1977
recurse_directory_to_add_files(filename)
1979
files = list(new_files)
1982
return # nothing to do
1984
# Sort needed to first handle directory content before the directory
1985
files.sort(reverse=True)
1987
# Bail out if we are going to delete files we shouldn't
1988
if not keep_files and not force:
1989
has_changed_files = len(unknown_nested_files) > 0
1990
if not has_changed_files:
1991
for (file_id, path, content_change, versioned, parent_id, name,
1992
kind, executable) in self.iter_changes(self.basis_tree(),
1993
include_unchanged=True, require_versioned=False,
1994
want_unversioned=True, specific_files=files):
1995
if versioned == (False, False):
1996
# The record is unknown ...
1997
if not self.is_ignored(path[1]):
1998
# ... but not ignored
1999
has_changed_files = True
2001
elif content_change and (kind[1] is not None):
2002
# Versioned and changed, but not deleted
2003
has_changed_files = True
2006
if has_changed_files:
2007
# Make delta show ALL applicable changes in error message.
2008
tree_delta = self.changes_from(self.basis_tree(),
2009
require_versioned=False, want_unversioned=True,
2010
specific_files=files)
2011
for unknown_file in unknown_nested_files:
2012
if unknown_file not in tree_delta.unversioned:
2013
tree_delta.unversioned.extend((unknown_file,))
2014
raise errors.BzrRemoveChangedFilesError(tree_delta)
2016
# Build inv_delta and delete files where applicable,
2017
# do this before any modifications to inventory.
1804
inv = self.inventory
1806
# do this before any modifications
2018
1807
for f in files:
2019
fid = self.path2id(f)
1808
fid = inv.path2id(f)
2022
message = "%s is not versioned." % (f,)
1810
note("%s is not versioned."%f)
2025
# having removed it, it must be either ignored or unknown
1813
# having remove it, it must be either ignored or unknown
2026
1814
if self.is_ignored(f):
2027
1815
new_status = 'I'
2029
1817
new_status = '?'
2030
# XXX: Really should be a more abstract reporter interface
2031
kind_ch = osutils.kind_marker(self.kind(fid))
2032
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2034
inv_delta.append((f, None, fid, None))
2035
message = "removed %s" % (f,)
2038
abs_path = self.abspath(f)
2039
if osutils.lexists(abs_path):
2040
if (osutils.isdir(abs_path) and
2041
len(os.listdir(abs_path)) > 0):
2043
osutils.rmtree(abs_path)
2045
message = "%s is not an empty directory "\
2046
"and won't be deleted." % (f,)
2048
osutils.delete_any(abs_path)
2049
message = "deleted %s" % (f,)
2050
elif message is not None:
2051
# Only care if we haven't done anything yet.
2052
message = "%s does not exist." % (f,)
2054
# Print only one message (if any) per file.
2055
if message is not None:
2057
self.apply_inventory_delta(inv_delta)
1818
textui.show_status(new_status, inv[fid].kind, f,
1822
self._write_inventory(inv)
2059
1824
@needs_tree_write_lock
2060
def revert(self, filenames=None, old_tree=None, backups=True,
2061
pb=None, report_changes=False):
1825
def revert(self, filenames, old_tree=None, backups=True,
1826
pb=DummyProgress(), report_changes=False):
2062
1827
from bzrlib.conflicts import resolve
2065
symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
' as of bzr 0.91. Please use None (the default) instead.',
2067
DeprecationWarning, stacklevel=2)
2068
1828
if old_tree is None:
2069
basis_tree = self.basis_tree()
2070
basis_tree.lock_read()
2071
old_tree = basis_tree
1829
old_tree = self.basis_tree()
1830
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1832
if not len(filenames):
1833
self.set_parent_ids(self.get_parent_ids()[:1])
2075
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2077
if filenames is None and len(self.get_parent_ids()) > 1:
2079
last_revision = self.last_revision()
2080
if last_revision != _mod_revision.NULL_REVISION:
2081
if basis_tree is None:
2082
basis_tree = self.basis_tree()
2083
basis_tree.lock_read()
2084
parent_trees.append((last_revision, basis_tree))
2085
self.set_parent_trees(parent_trees)
2088
resolve(self, filenames, ignore_misses=True, recursive=True)
2090
if basis_tree is not None:
1836
resolve(self, filenames, ignore_misses=True)
2092
1837
return conflicts
2094
1839
def revision_tree(self, revision_id):
2249
1989
# cant set that until we update the working trees last revision to be
2250
1990
# one from the new branch, because it will just get absorbed by the
2251
1991
# parent de-duplication logic.
2253
1993
# We MUST save it even if an error occurs, because otherwise the users
2254
1994
# local work is unreferenced and will appear to have been lost.
2258
1998
last_rev = self.get_parent_ids()[0]
2259
1999
except IndexError:
2260
last_rev = _mod_revision.NULL_REVISION
2261
if revision is None:
2262
revision = self.branch.last_revision()
2264
old_tip = old_tip or _mod_revision.NULL_REVISION
2266
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
# the branch we are bound to was updated
2268
# merge those changes in first
2269
base_tree = self.basis_tree()
2270
other_tree = self.branch.repository.revision_tree(old_tip)
2271
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
base_tree, this_tree=self,
2273
change_reporter=change_reporter)
2275
self.add_parent_tree((old_tip, other_tree))
2276
trace.note('Rerun update after fixing the conflicts.')
2279
if last_rev != _mod_revision.ensure_null(revision):
2280
# the working tree is up to date with the branch
2281
# we can merge the specified revision from master
2282
to_tree = self.branch.repository.revision_tree(revision)
2283
to_root_id = to_tree.get_root_id()
2001
if last_rev != self.branch.last_revision():
2002
# merge tree state up to new branch tip.
2285
2003
basis = self.basis_tree()
2286
2004
basis.lock_read()
2288
if (basis.inventory.root is None
2289
or basis.inventory.root.file_id != to_root_id):
2290
self.set_root_id(to_root_id)
2006
to_tree = self.branch.basis_tree()
2007
if basis.inventory.root is None:
2008
self.set_root_id(to_tree.inventory.root.file_id)
2010
result += merge.merge_inner(
2295
# determine the branch point
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2301
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
change_reporter=change_reporter)
2304
self.set_last_revision(revision)
2305
2017
# TODO - dedup parents list with things merged by pull ?
2306
2018
# reuse the tree we've updated to to set the basis:
2307
parent_trees = [(revision, to_tree)]
2019
parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2020
merges = self.get_parent_ids()[1:]
2309
2021
# Ideally we ask the tree for the trees here, that way the working
2310
# tree can decide whether to give us the entire tree or give us a
2022
# tree can decide whether to give us teh entire tree or give us a
2311
2023
# lazy initialised tree. dirstate for instance will have the trees
2312
2024
# in ram already, whereas a last-revision + basis-inventory tree
2313
2025
# will not, but also does not need them when setting parents.
2314
2026
for parent in merges:
2315
2027
parent_trees.append(
2316
2028
(parent, self.branch.repository.revision_tree(parent)))
2317
if not _mod_revision.is_null(old_tip):
2029
if old_tip is not None:
2318
2030
parent_trees.append(
2319
2031
(old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2032
self.set_parent_trees(parent_trees)
2321
2033
last_rev = parent_trees[0][0]
2035
# the working tree had the same last-revision as the master
2036
# branch did. We may still have pivot local work from the local
2037
# branch into old_tip:
2038
if old_tip is not None:
2039
self.add_parent_tree_id(old_tip)
2040
if old_tip and old_tip != last_rev:
2041
# our last revision was not the prior branch last revision
2042
# and we have converted that last revision to a pending merge.
2043
# base is somewhere between the branch tip now
2044
# and the now pending merge
2046
# Since we just modified the working tree and inventory, flush out
2047
# the current state, before we modify it again.
2048
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2049
# requires it only because TreeTransform directly munges the
2050
# inventory and calls tree._write_inventory(). Ultimately we
2051
# should be able to remove this extra flush.
2053
from bzrlib.revision import common_ancestor
2055
base_rev_id = common_ancestor(self.branch.last_revision(),
2057
self.branch.repository)
2058
except errors.NoCommonAncestor:
2060
base_tree = self.branch.repository.revision_tree(base_rev_id)
2061
other_tree = self.branch.repository.revision_tree(old_tip)
2062
result += merge.merge_inner(
2324
2069
def _write_hashcache_if_dirty(self):
2325
2070
"""Write out the hashcache if it is dirty."""
2523
2242
# FIXME: stash the node in pending
2524
2243
entry = inv[top_id]
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
child.file_id, child.kind
2244
for name, child in entry.sorted_children():
2245
dirblock.append((relroot + name, name, child.kind, None,
2246
child.file_id, child.kind
2530
2248
yield (currentdir[0], entry.file_id), dirblock
2531
2249
# push the user specified dirs from dirblock
2532
2250
for dir in reversed(dirblock):
2533
2251
if dir[2] == _directory:
2534
2252
pending.append(dir)
2536
@needs_tree_write_lock
2537
def auto_resolve(self):
2538
"""Automatically resolve text conflicts according to contents.
2540
Only text conflicts are auto_resolvable. Files with no conflict markers
2541
are considered 'resolved', because bzr always puts conflict markers
2542
into files that have text conflicts. The corresponding .THIS .BASE and
2543
.OTHER files are deleted, as per 'resolve'.
2544
:return: a tuple of ConflictLists: (un_resolved, resolved).
2546
un_resolved = _mod_conflicts.ConflictList()
2547
resolved = _mod_conflicts.ConflictList()
2548
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2549
for conflict in self.conflicts():
2550
if (conflict.typestring != 'text conflict' or
2551
self.kind(conflict.file_id) != 'file'):
2552
un_resolved.append(conflict)
2554
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2556
for line in my_file:
2557
if conflict_re.search(line):
2558
un_resolved.append(conflict)
2561
resolved.append(conflict)
2564
resolved.remove_files(self)
2565
self.set_conflicts(un_resolved)
2566
return un_resolved, resolved
2569
def _check(self, references):
2570
"""Check the tree for consistency.
2572
:param references: A dict with keys matching the items returned by
2573
self._get_check_refs(), and values from looking those keys up in
2576
tree_basis = self.basis_tree()
2577
tree_basis.lock_read()
2579
repo_basis = references[('trees', self.last_revision())]
2580
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
raise errors.BzrCheckError(
2582
"Mismatched basis inventory content.")
2587
def _validate(self):
2588
"""Validate internal structures.
2590
This is meant mostly for the test suite. To give it a chance to detect
2591
corruption after actions have occurred. The default implementation is a
2594
:return: None. An exception should be raised if there is an error.
2598
def _get_rules_searcher(self, default_searcher):
2599
"""See Tree._get_rules_searcher."""
2600
if self._rules_searcher is None:
2601
self._rules_searcher = super(WorkingTree,
2602
self)._get_rules_searcher(default_searcher)
2603
return self._rules_searcher
2605
def get_shelf_manager(self):
2606
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
2608
return ShelfManager(self, self._transport)
2611
2255
class WorkingTree2(WorkingTree):
2612
2256
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2258
This was the first weave based working tree.
2615
2259
- uses os locks for locking.
2616
2260
- uses the branch last-revision.
2619
def __init__(self, *args, **kwargs):
2620
super(WorkingTree2, self).__init__(*args, **kwargs)
2621
# WorkingTree2 has more of a constraint that self._inventory must
2622
# exist. Because this is an older format, we don't mind the overhead
2623
# caused by the extra computation here.
2625
# Newer WorkingTree's should only have self._inventory set when they
2627
if self._inventory is None:
2628
self.read_working_inventory()
2630
def _get_check_refs(self):
2631
"""Return the references needed to perform a check of this tree."""
2632
return [('trees', self.last_revision())]
2634
2263
def lock_tree_write(self):
2635
2264
"""See WorkingTree.lock_tree_write().
2835
2457
def unregister_format(klass, format):
2458
assert klass._formats[format.get_format_string()] is format
2836
2459
del klass._formats[format.get_format_string()]
2839
2463
class WorkingTreeFormat2(WorkingTreeFormat):
2840
"""The second working tree format.
2464
"""The second working tree format.
2842
2466
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
2847
2469
def get_format_description(self):
2848
2470
"""See WorkingTreeFormat.get_format_description()."""
2849
2471
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2473
def stub_initialize_remote(self, control_files):
2474
"""As a special workaround create critical control files for a remote working tree
2854
2476
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2477
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
2478
no working tree. (See bug #43064).
2858
2480
sio = StringIO()
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2482
xml5.serializer_v5.write_inventory(inv, sio)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2484
control_files.put('inventory', sio)
2486
control_files.put_bytes('pending-merges', '')
2489
def initialize(self, a_bzrdir, revision_id=None):
2867
2490
"""See WorkingTreeFormat.initialize()."""
2868
2491
if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2492
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
2493
branch = a_bzrdir.open_branch()
2494
if revision_id is not None:
2495
revision_id = osutils.safe_revision_id(revision_id)
2498
revision_history = branch.revision_history()
2500
position = revision_history.index(revision_id)
2502
raise errors.NoSuchRevision(branch, revision_id)
2503
branch.set_revision_history(revision_history[:position + 1])
2506
revision = branch.last_revision()
2882
2508
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2885
2511
_internal=True,
2887
2513
_bzrdir=a_bzrdir)
2888
basis_tree = branch.repository.revision_tree(revision_id)
2514
basis_tree = branch.repository.revision_tree(revision)
2889
2515
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2516
wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2517
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
2518
wt.set_parent_trees([(revision, basis_tree)])
2897
2519
transform.build_tree(basis_tree, wt)
3049
2659
return self.get_format_string()
3052
__default_format = WorkingTreeFormat6()
2662
__default_format = WorkingTreeFormat4()
3053
2663
WorkingTreeFormat.register_format(__default_format)
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2664
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2665
WorkingTreeFormat.set_default_format(__default_format)
3058
2666
# formats which have no format string are not discoverable
3059
2667
# and not independently creatable, so are not registered.
3060
2668
_legacy_formats = [WorkingTreeFormat2(),
2672
class WorkingTreeTestProviderAdapter(object):
2673
"""A tool to generate a suite testing multiple workingtree formats at once.
2675
This is done by copying the test once for each transport and injecting
2676
the transport_server, transport_readonly_server, and workingtree_format
2677
classes into each copy. Each copy is also given a new id() to make it
2681
def __init__(self, transport_server, transport_readonly_server, formats):
2682
self._transport_server = transport_server
2683
self._transport_readonly_server = transport_readonly_server
2684
self._formats = formats
2686
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2687
"""Clone test for adaption."""
2688
new_test = deepcopy(test)
2689
new_test.transport_server = self._transport_server
2690
new_test.transport_readonly_server = self._transport_readonly_server
2691
new_test.bzrdir_format = bzrdir_format
2692
new_test.workingtree_format = workingtree_format
2693
def make_new_test_id():
2694
new_id = "%s(%s)" % (test.id(), variation)
2695
return lambda: new_id
2696
new_test.id = make_new_test_id()
2699
def adapt(self, test):
2700
from bzrlib.tests import TestSuite
2701
result = TestSuite()
2702
for workingtree_format, bzrdir_format in self._formats:
2703
new_test = self._clone_test(
2706
workingtree_format, workingtree_format.__class__.__name__)
2707
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
