13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
23
new revision based on the workingtree and its inventory.
25
25
At the moment every WorkingTree has its own branch. Remote
51
60
conflicts as _mod_conflicts,
60
revision as _mod_revision,
69
80
import bzrlib.branch
70
81
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
86
from bzrlib import symbol_versioning
79
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
82
90
from bzrlib.lockdir import LockDir
83
91
import bzrlib.mutabletree
84
92
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
86
93
from bzrlib.osutils import (
94
103
supports_executable,
96
from bzrlib.filters import filtered_input_file
97
105
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
109
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
107
120
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
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
116
144
class TreeEntry(object):
117
145
"""An entry that implements the minimum interface used by commands.
119
This needs further inspection, it may be better to have
147
This needs further inspection, it may be better to have
120
148
InventoryEntries without ids - though that seems wrong. For now,
121
149
this is a parallel hierarchy to InventoryEntry, and needs to become
122
150
one of several things: decorates to that hierarchy, children of, or
244
270
# the Format factory and creation methods that are
245
271
# permitted to do this.
246
272
self._set_inventory(_inventory, dirty=False)
247
self._detect_case_handling()
248
self._rules_searcher = None
249
self.views = self._make_views()
252
def user_transport(self):
253
return self.bzrdir.user_transport
256
def control_transport(self):
257
return self._transport
259
def _detect_case_handling(self):
260
wt_trans = self.bzrdir.get_workingtree_transport(None)
262
wt_trans.stat("FoRMaT")
263
except errors.NoSuchFile:
264
self.case_sensitive = True
266
self.case_sensitive = False
268
self._setup_directory_is_tree_reference()
270
274
branch = property(
271
275
fget=lambda self: self._branch,
286
290
self._control_files.break_lock()
287
291
self.branch.break_lock()
289
def _get_check_refs(self):
290
"""Return the references needed to perform a check of this tree.
292
The default implementation returns no refs, and is only suitable for
293
trees that have no local caching and can commit on ghosts at any time.
295
:seealso: bzrlib.check for details about check_refs.
299
293
def requires_rich_root(self):
300
294
return self._format.requires_rich_root
302
296
def supports_tree_reference(self):
305
def supports_content_filtering(self):
306
return self._format.supports_content_filtering()
308
def supports_views(self):
309
return self.views.supports_views()
311
299
def _set_inventory(self, inv, dirty):
312
300
"""Set the internal cached inventory.
423
390
# at this point ?
425
392
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
393
except errors.RevisionNotPresent:
427
394
# 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
395
# occured. If the revision is present, its a problem, if its not
430
397
if self.branch.repository.has_revision(revision_id):
432
399
# 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()
400
return self.branch.repository.revision_tree(None)
403
@deprecated_method(zero_eight)
404
def create(branch, directory):
405
"""Create a workingtree for branch at directory.
407
If existing_directory already exists it must have a .bzr directory.
408
If it does not exist, it will be created.
410
This returns a new WorkingTree object for the new checkout.
412
TODO FIXME RBC 20060124 when we have checkout formats in place this
413
should accept an optional revisionid to checkout [and reject this if
414
checking out into the same dir as a pre-checkout-aware branch format.]
416
XXX: When BzrDir is present, these should be created through that
419
warnings.warn('delete WorkingTree.create', stacklevel=3)
420
transport = get_transport(directory)
421
if branch.bzrdir.root_transport.base == transport.base:
423
return branch.bzrdir.create_workingtree()
424
# different directory,
425
# create a branch reference
426
# and now a working tree.
427
raise NotImplementedError
430
@deprecated_method(zero_eight)
431
def create_standalone(directory):
432
"""Create a checkout and a branch and a repo at directory.
434
Directory must exist and be empty.
436
please use BzrDir.create_standalone_workingtree
438
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
440
def relpath(self, path):
440
441
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
443
The path may be absolute or relative. If its a relative path it is
443
444
interpreted relative to the python current working directory.
445
446
return osutils.relpath(self.basedir, path)
447
448
def has_filename(self, filename):
448
449
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
459
stat_value = _fstat(file_obj.fileno())
460
if filtered and self.supports_content_filtering():
461
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
463
return (file_obj, stat_value)
465
def get_file_text(self, file_id, path=None, filtered=True):
466
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
451
def get_file(self, file_id):
452
file_id = osutils.safe_file_id(file_id)
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_text(self, file_id):
456
file_id = osutils.safe_file_id(file_id)
457
return self.get_file(file_id).read()
459
def get_file_byname(self, filename):
460
return file(self.abspath(filename), 'rb')
486
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
463
def annotate_iter(self, file_id):
487
464
"""See Tree.annotate_iter
489
466
This implementation will use the basis tree implementation if possible.
493
470
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
471
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
533
def _get_ancestors(self, default_revision):
534
ancestors = set([default_revision])
535
for parent_id in self.get_parent_ids():
536
ancestors.update(self.branch.repository.get_ancestry(
537
parent_id, topo_sorted=False))
473
file_id = osutils.safe_file_id(file_id)
474
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
478
require_versioned=True).next()
479
changed_content, kind = changes[2], changes[6]
480
if not changed_content:
481
return basis.annotate_iter(file_id)
485
if kind[0] != 'file':
488
old_lines = list(basis.annotate_iter(file_id))
490
for tree in self.branch.repository.revision_trees(
491
self.get_parent_ids()[1:]):
492
if file_id not in tree:
494
old.append(list(tree.annotate_iter(file_id)))
495
return annotate.reannotate(old, self.get_file(file_id).readlines(),
540
500
def get_parent_ids(self):
541
501
"""See Tree.get_parent_ids.
543
503
This implementation reads the pending merges list and last_revision
544
504
value and uses that to decide what the parents list should be.
546
last_rev = _mod_revision.ensure_null(self._last_revision())
547
if _mod_revision.NULL_REVISION == last_rev:
506
last_rev = self._last_revision()
550
510
parents = [last_rev]
552
merges_bytes = self._transport.get_bytes('pending-merges')
512
merges_file = self._control_files.get('pending-merges')
553
513
except errors.NoSuchFile:
556
for l in osutils.split_lines(merges_bytes):
557
revision_id = l.rstrip('\n')
516
for l in merges_file.readlines():
517
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
558
518
parents.append(revision_id)
562
522
def get_root_id(self):
563
523
"""Return the id of this trees root"""
564
524
return self._inventory.root.file_id
566
526
def _get_store_filename(self, file_id):
567
527
## XXX: badly named; this is not in the store at all
528
file_id = osutils.safe_file_id(file_id)
568
529
return self.abspath(self.id2path(file_id))
571
532
def clone(self, to_bzrdir, revision_id=None):
572
533
"""Duplicate this working tree into to_bzr, including all state.
574
535
Specifically modified files are kept as modified, but
575
536
ignored and unknown files are discarded.
577
538
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
541
If not None, the cloned tree will have its last revision set to
542
revision, and and difference between the source trees last revision
582
543
and this one merged in.
584
545
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
546
result = self._format.initialize(to_bzrdir)
586
547
self.copy_content_into(result, revision_id)
617
581
__contains__ = has_id
619
583
def get_file_size(self, file_id):
620
"""See Tree.get_file_size"""
621
# XXX: this returns the on-disk size; it should probably return the
624
return os.path.getsize(self.id2abspath(file_id))
626
if e.errno != errno.ENOENT:
584
file_id = osutils.safe_file_id(file_id)
585
return os.path.getsize(self.id2abspath(file_id))
632
588
def get_file_sha1(self, file_id, path=None, stat_value=None):
589
file_id = osutils.safe_file_id(file_id)
634
591
path = self._inventory.id2path(file_id)
635
592
return self._hashcache.get_sha1(path, stat_value)
637
594
def get_file_mtime(self, file_id, path=None):
595
file_id = osutils.safe_file_id(file_id)
639
597
path = self.inventory.id2path(file_id)
640
598
return os.lstat(self.abspath(path)).st_mtime
642
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
file_id = self.path2id(path)
645
# For unversioned files on win32, we just assume they are not
648
return self._inventory[file_id].executable
650
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
mode = stat_result.st_mode
652
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
654
600
if not supports_executable():
655
601
def is_executable(self, file_id, path=None):
602
file_id = osutils.safe_file_id(file_id)
656
603
return self._inventory[file_id].executable
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_basis
661
605
def is_executable(self, file_id, path=None):
607
file_id = osutils.safe_file_id(file_id)
663
608
path = self.id2path(file_id)
664
609
mode = os.lstat(self.abspath(path)).st_mode
665
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
667
_is_executable_from_path_and_stat = \
668
_is_executable_from_path_and_stat_from_stat
670
612
@needs_tree_write_lock
671
613
def _add(self, files, ids, kinds):
672
614
"""See MutableTree._add."""
673
615
# TODO: Re-adding a file that is removed in the working copy
674
616
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
617
# the read and write working inventory should not occur in this
676
618
# function - they should be part of lock_write and unlock.
619
inv = self.read_working_inventory()
678
620
for f, file_id, kind in zip(files, ids, kinds):
621
assert kind is not None
679
622
if file_id is None:
680
623
inv.add_path(f, kind=kind)
625
file_id = osutils.safe_file_id(file_id)
682
626
inv.add_path(f, kind=kind, file_id=file_id)
683
self._inventory_is_modified = True
627
self._write_inventory(inv)
685
629
@needs_tree_write_lock
686
630
def _gather_kinds(self, files, kinds):
747
691
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
749
def path_content_summary(self, path, _lstat=os.lstat,
750
_mapper=osutils.file_kind_from_stat_mode):
751
"""See Tree.path_content_summary."""
752
abspath = self.abspath(path)
754
stat_result = _lstat(abspath)
756
if getattr(e, 'errno', None) == errno.ENOENT:
758
return ('missing', None, None, None)
759
# propagate other errors
761
kind = _mapper(stat_result.st_mode)
763
return self._file_content_summary(path, stat_result)
764
elif kind == 'directory':
765
# perhaps it looks like a plain directory, but it's really a
767
if self._directory_is_tree_reference(path):
768
kind = 'tree-reference'
769
return kind, None, None, None
770
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
774
return (kind, None, None, None)
776
def _file_content_summary(self, path, stat_result):
777
size = stat_result.st_size
778
executable = self._is_executable_from_path_and_stat(path, stat_result)
779
# try for a stat cache lookup
780
return ('file', size, executable, self._sha_from_stat(
693
@deprecated_method(zero_eleven)
695
def pending_merges(self):
696
"""Return a list of pending merges.
698
These are revisions that have been merged into the working
699
directory but not yet committed.
701
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
702
instead - which is available on all tree objects.
704
return self.get_parent_ids()[1:]
783
706
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
707
"""Common ghost checking functionality from set_parent_*.
795
718
def _set_merges_from_parent_ids(self, parent_ids):
796
719
merges = parent_ids[1:]
797
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
800
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
"""Check that all merged revisions are proper 'heads'.
803
This will always return the first revision_id, and any merged revisions
806
if len(revision_ids) == 0:
808
graph = self.branch.repository.get_graph()
809
heads = graph.heads(revision_ids)
810
new_revision_ids = revision_ids[:1]
811
for revision_id in revision_ids[1:]:
812
if revision_id in heads and revision_id not in new_revision_ids:
813
new_revision_ids.append(revision_id)
814
if new_revision_ids != revision_ids:
815
trace.mutter('requested to set revision_ids = %s,'
816
' but filtered to %s', revision_ids, new_revision_ids)
817
return new_revision_ids
720
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
819
722
@needs_tree_write_lock
820
723
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
724
"""Set the parent ids to revision_ids.
823
726
See also set_parent_trees. This api will try to retrieve the tree data
824
727
for each element of revision_ids from the trees repository. If you have
825
728
tree data already available, it is more efficient to use
829
732
:param revision_ids: The revision_ids to set as the parent ids of this
830
733
working tree. Any of these may be ghosts.
735
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
832
736
self._check_parents_for_ghosts(revision_ids,
833
737
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
for revision_id in revision_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
839
739
if len(revision_ids) > 0:
840
740
self.set_last_revision(revision_ids[0])
842
self.set_last_revision(_mod_revision.NULL_REVISION)
742
self.set_last_revision(None)
844
744
self._set_merges_from_parent_ids(revision_ids)
846
746
@needs_tree_write_lock
847
747
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
748
"""See MutableTree.set_parent_trees."""
849
parent_ids = [rev for (rev, tree) in parents_list]
850
for revision_id in parent_ids:
851
_mod_revision.check_not_reserved_id(revision_id)
749
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
853
751
self._check_parents_for_ghosts(parent_ids,
854
752
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
856
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
858
754
if len(parent_ids) == 0:
859
leftmost_parent_id = _mod_revision.NULL_REVISION
755
leftmost_parent_id = None
860
756
leftmost_parent_tree = None
862
758
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
887
783
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
888
784
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
890
def _sha_from_stat(self, path, stat_result):
891
"""Get a sha digest from the tree's stat cache.
893
The default implementation assumes no stat cache is present.
895
:param path: The path.
896
:param stat_result: The stat result being looked up.
900
786
def _put_rio(self, filename, stanzas, header):
901
787
self._must_be_locked()
902
788
my_file = rio_file(stanzas, header)
903
self._transport.put_file(filename, my_file,
904
mode=self.bzrdir._get_file_mode())
789
self._control_files.put(filename, my_file)
906
791
@needs_write_lock # because merge pulls data into the branch.
907
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
merge_type=None, force=False):
792
def merge_from_branch(self, branch, to_revision=None):
909
793
"""Merge from a branch into this working tree.
911
795
:param branch: The branch to merge from.
915
799
branch.last_revision().
917
801
from bzrlib.merge import Merger, Merge3Merger
918
merger = Merger(self.branch, this_tree=self)
919
# check that there are no local alterations
920
if not force and self.has_changes():
921
raise errors.UncommittedChanges(self)
922
if to_revision is None:
923
to_revision = _mod_revision.ensure_null(branch.last_revision())
924
merger.other_rev_id = to_revision
925
if _mod_revision.is_null(merger.other_rev_id):
926
raise errors.NoCommits(branch)
927
self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
merger.other_basis = merger.other_rev_id
929
merger.other_tree = self.branch.repository.revision_tree(
931
merger.other_branch = branch
932
if from_revision is None:
802
pb = bzrlib.ui.ui_factory.nested_progress_bar()
804
merger = Merger(self.branch, this_tree=self, pb=pb)
805
merger.pp = ProgressPhase("Merge phase", 5, pb)
806
merger.pp.next_phase()
807
# check that there are no
809
merger.check_basis(check_clean=True, require_commits=False)
810
if to_revision is None:
811
to_revision = branch.last_revision()
813
to_revision = osutils.safe_revision_id(to_revision)
814
merger.other_rev_id = to_revision
815
if merger.other_rev_id is None:
816
raise error.NoCommits(branch)
817
self.branch.fetch(branch, last_revision=merger.other_rev_id)
818
merger.other_basis = merger.other_rev_id
819
merger.other_tree = self.branch.repository.revision_tree(
821
merger.other_branch = branch
822
merger.pp.next_phase()
933
823
merger.find_base()
935
merger.set_base_revision(from_revision, branch)
936
if merger.base_rev_id == merger.other_rev_id:
937
raise errors.PointlessMerge
938
merger.backup_files = False
939
if merge_type is None:
824
if merger.base_rev_id == merger.other_rev_id:
825
raise errors.PointlessMerge
826
merger.backup_files = False
940
827
merger.merge_type = Merge3Merger
942
merger.merge_type = merge_type
943
merger.set_interesting_files(None)
944
merger.show_base = False
945
merger.reprocess = False
946
conflicts = merger.do_merge()
828
merger.set_interesting_files(None)
829
merger.show_base = False
830
merger.reprocess = False
831
conflicts = merger.do_merge()
951
838
def merge_modified(self):
952
839
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
841
The list is initialized by WorkingTree.set_merge_modified, which is
955
842
typically called after we make some automatic updates to the tree
956
843
because of a merge.
959
846
still in the working inventory and have that text hash.
962
hashfile = self._transport.get('merge-hashes')
849
hashfile = self._control_files.get('merge-hashes')
963
850
except errors.NoSuchFile:
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
854
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
855
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
856
except StopIteration:
857
raise errors.MergeModifiedFormatError()
858
for s in RioReader(hashfile):
859
# RioReader reads in Unicode, so convert file_ids back to utf8
860
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
861
if file_id not in self.inventory:
863
text_hash = s.get("hash")
864
if text_hash == self.get_file_sha1(file_id):
865
merge_hashes[file_id] = text_hash
984
868
@needs_write_lock
985
869
def mkdir(self, path, file_id=None):
1037
920
other_tree.unlock()
1038
921
other_tree.bzrdir.retire_bzrdir()
1040
def _setup_directory_is_tree_reference(self):
1041
if self._branch.repository._format.supports_tree_reference:
1042
self._directory_is_tree_reference = \
1043
self._directory_may_be_tree_reference
1045
self._directory_is_tree_reference = \
1046
self._directory_is_never_tree_reference
1048
def _directory_is_never_tree_reference(self, relpath):
1051
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
1053
# it's a tree reference, except that the root of the tree is not
1054
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
# TODO: We could ask all the control formats whether they
1056
# recognize this directory, but at the moment there's no cheap api
1057
# to do that. Since we probably can only nest bzr checkouts and
1058
# they always use this name it's ok for now. -- mbp 20060306
1060
# FIXME: There is an unhandled case here of a subdirectory
1061
# containing .bzr but not a branch; that will probably blow up
1062
# when you try to commit it. It might happen if there is a
1063
# checkout in a subdirectory. This can be avoided by not adding
1066
923
@needs_tree_write_lock
1067
924
def extract(self, file_id, format=None):
1068
925
"""Extract a subtree from this tree.
1070
927
A new branch will be created, relative to the path for this tree.
1077
934
transport = transport.clone(name)
1078
935
transport.ensure_base()
1079
936
return transport
1081
938
sub_path = self.id2path(file_id)
1082
939
branch_transport = mkdirs(sub_path)
1083
940
if format is None:
1084
format = self.bzrdir.cloning_metadir()
941
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1085
942
branch_transport.ensure_base()
1086
943
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
945
repo = branch_bzrdir.find_repository()
1089
946
except errors.NoRepositoryPresent:
1090
947
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
948
assert repo.supports_rich_root()
950
if not repo.supports_rich_root():
951
raise errors.RootNotRich()
1093
952
new_branch = branch_bzrdir.create_branch()
1094
953
new_branch.pull(self.branch)
1095
954
for parent_id in self.get_parent_ids():
1097
956
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
957
if tree_transport.base != branch_transport.base:
1099
958
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
959
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1103
961
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
962
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
963
wt.set_parent_ids(self.get_parent_ids())
1106
964
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
965
child_inv = Inventory(root_id=None)
1108
966
new_root = my_inv[file_id]
1109
967
my_inv.remove_recursive_id(file_id)
1110
968
new_root.parent_id = None
1128
985
sio = StringIO()
1129
986
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
988
self._control_files.put('inventory', sio)
1133
989
self._inventory_is_modified = False
1135
991
def _kind(self, relpath):
1136
992
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
994
def list_files(self, include_root=False):
995
"""Recursively list all files as (path, class, kind, id, entry).
1141
997
Lists, but does not descend into unversioned directories.
1142
999
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
1002
Skips the control directory.
1149
1004
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1005
# with it. So callers should be careful to always read_lock the tree.
1165
1020
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1167
1022
# directory file_id, relative path, absolute path, reverse sorted children
1168
if from_dir is not None:
1169
from_dir_id = inv.path2id(from_dir)
1170
if from_dir_id is None:
1171
# Directory not versioned
1173
from_dir_abspath = pathjoin(self.basedir, from_dir)
1175
from_dir_id = inv.root.file_id
1176
from_dir_abspath = self.basedir
1177
children = os.listdir(from_dir_abspath)
1023
children = os.listdir(self.basedir)
1178
1024
children.sort()
1179
# jam 20060527 The kernel sized tree seems equivalent whether we
1025
# jam 20060527 The kernel sized tree seems equivalent whether we
1180
1026
# use a deque and popleft to keep them sorted, or if we use a plain
1181
1027
# list and just reverse() them.
1182
1028
children = collections.deque(children)
1183
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1029
stack = [(inv.root.file_id, u'', self.basedir, children)]
1185
1031
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1240
1086
except KeyError:
1241
1087
yield fp[1:], c, fk, None, TreeEntry()
1244
1090
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
1093
# But do this child first
1094
new_children = os.listdir(fap)
1096
new_children = collections.deque(new_children)
1097
stack.append((f_ie.file_id, fp, fap, new_children))
1098
# Break out of inner loop,
1099
# so that we start outer loop with child
1257
1102
# if we finished all children, pop it off the stack
1494
1334
from_tail = splitpath(from_rel)[-1]
1495
1335
from_id = inv.path2id(from_rel)
1496
1336
if from_id is None:
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1337
raise errors.BzrRenameFailedError(from_rel,to_rel,
1338
errors.NotVersionedError(path=str(from_rel)))
1339
from_entry = inv[from_id]
1508
1340
from_parent_id = from_entry.parent_id
1509
1341
to_dir, to_tail = os.path.split(to_rel)
1510
1342
to_dir_id = inv.path2id(to_dir)
1572
1404
:raises: NoSuchId if any fileid is not currently versioned.
1574
1406
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1407
file_id = osutils.safe_file_id(file_id)
1578
1408
if self._inventory.has_id(file_id):
1579
1409
self._inventory.remove_recursive_id(file_id)
1411
raise errors.NoSuchId(self, file_id)
1580
1412
if len(file_ids):
1581
# in the future this should just set a dirty bit to wait for the
1413
# in the future this should just set a dirty bit to wait for the
1582
1414
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1415
# with the current in -memory inventory rather than triggering
1584
1416
# a read, it is more complex - we need to teach read_inventory
1585
1417
# to know when to read, and when to not read first... and possibly
1586
1418
# to save first when the in memory one may be corrupted.
1587
1419
# so for now, we just only write it if it is indeed dirty.
1588
1420
# - RBC 20060907
1589
1421
self._write_inventory(self._inventory)
1423
@deprecated_method(zero_eight)
1424
def iter_conflicts(self):
1425
"""List all files in the tree that have text or content conflicts.
1426
DEPRECATED. Use conflicts instead."""
1427
return self._iter_conflicts()
1591
1429
def _iter_conflicts(self):
1592
1430
conflicted = set()
1602
1440
@needs_write_lock
1603
1441
def pull(self, source, overwrite=False, stop_revision=None,
1604
change_reporter=None, possible_transports=None, local=False):
1442
change_reporter=None):
1443
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1444
source.lock_read()
1446
pp = ProgressPhase("Pull phase", 2, top_pb)
1607
1448
old_revision_info = self.branch.last_revision_info()
1608
1449
basis_tree = self.basis_tree()
1609
count = self.branch.pull(source, overwrite, stop_revision,
1610
possible_transports=possible_transports,
1450
count = self.branch.pull(source, overwrite, stop_revision)
1612
1451
new_revision_info = self.branch.last_revision_info()
1613
1452
if new_revision_info != old_revision_info:
1614
1454
repository = self.branch.repository
1455
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1456
basis_tree.lock_read()
1617
1458
new_basis_tree = self.branch.basis_tree()
1620
1461
new_basis_tree,
1622
1463
this_tree=self,
1624
1465
change_reporter=change_reporter)
1625
basis_root_id = basis_tree.get_root_id()
1626
new_root_id = new_basis_tree.get_root_id()
1627
if basis_root_id != new_root_id:
1628
self.set_root_id(new_root_id)
1466
if (basis_tree.inventory.root is None and
1467
new_basis_tree.inventory.root is not None):
1468
self.set_root_id(new_basis_tree.inventory.root.file_id)
1630
1471
basis_tree.unlock()
1631
1472
# TODO - dedup parents list with things merged by pull ?
1632
1473
# reuse the revisiontree we merged against to set the new
1634
1475
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1635
# we have to pull the merge trees out again, because
1636
# merge_inner has set the ids. - this corner is not yet
1476
# we have to pull the merge trees out again, because
1477
# merge_inner has set the ids. - this corner is not yet
1637
1478
# layered well enough to prevent double handling.
1638
1479
# XXX TODO: Fix the double handling: telling the tree about
1639
1480
# the already known parent data is wasteful.
1735
1571
r"""Check whether the filename matches an ignore pattern.
1737
1573
Patterns containing '/' or '\' need to match the whole path;
1738
others match against only the last component. Patterns starting
1739
with '!' are ignore exceptions. Exceptions take precedence
1740
over regular patterns and cause the filename to not be ignored.
1574
others match against only the last component.
1742
1576
If the file is ignored, returns the pattern which caused it to
1743
1577
be ignored, otherwise None. So this can simply be used as a
1744
1578
boolean if desired."""
1745
1579
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1580
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1581
return self._ignoreglobster.match(filename)
1749
1583
def kind(self, file_id):
1750
1584
return file_kind(self.id2abspath(file_id))
1752
def stored_kind(self, file_id):
1753
"""See Tree.stored_kind"""
1754
return self.inventory[file_id].kind
1756
1586
def _comparison_data(self, entry, path):
1757
1587
abspath = self.abspath(path)
1799
1629
raise errors.ObjectNotLocked(self)
1801
1631
def lock_read(self):
1802
"""Lock the tree for reading.
1804
This also locks the branch, and can be unlocked via self.unlock().
1806
:return: A bzrlib.lock.LogicalLockResult.
1632
"""See Branch.lock_read, and WorkingTree.unlock."""
1808
1633
if not self.is_locked():
1809
1634
self._reset_data()
1810
1635
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1637
return self._control_files.lock_read()
1815
1639
self.branch.unlock()
1818
1642
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1643
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1644
if not self.is_locked():
1824
1645
self._reset_data()
1825
1646
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1648
return self._control_files.lock_write()
1830
1650
self.branch.unlock()
1833
1653
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1654
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1655
if not self.is_locked():
1839
1656
self._reset_data()
1840
1657
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1659
return self._control_files.lock_write()
1845
1661
self.branch.unlock()
1854
1670
def _reset_data(self):
1855
1671
"""Reset transient data that cannot be revalidated."""
1856
1672
self._inventory_is_modified = False
1857
f = self._transport.get('inventory')
1859
result = self._deserialize(f)
1673
result = self._deserialize(self._control_files.get('inventory'))
1862
1674
self._set_inventory(result, dirty=False)
1864
1676
@needs_tree_write_lock
1865
1677
def set_last_revision(self, new_revision):
1866
1678
"""Change the last revision in the working tree."""
1679
new_revision = osutils.safe_revision_id(new_revision)
1867
1680
if self._change_last_revision(new_revision):
1868
1681
self._cache_basis_inventory(new_revision)
1870
1683
def _change_last_revision(self, new_revision):
1871
1684
"""Template method part of set_last_revision to perform the change.
1873
1686
This is used to allow WorkingTree3 instances to not affect branch
1874
1687
when their last revision is set.
1876
if _mod_revision.is_null(new_revision):
1689
if new_revision is None:
1877
1690
self.branch.set_revision_history([])
1886
1699
def _write_basis_inventory(self, xml):
1887
1700
"""Write the basis inventory XML to the basis-inventory file"""
1701
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1888
1702
path = self._basis_inventory_name()
1889
1703
sio = StringIO(xml)
1890
self._transport.put_file(path, sio,
1891
mode=self.bzrdir._get_file_mode())
1704
self._control_files.put(path, sio)
1893
1706
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1707
"""Create the text that will be saved in basis-inventory"""
1895
inventory.revision_id = revision_id
1708
# TODO: jam 20070209 This should be redundant, as the revision_id
1709
# as all callers should have already converted the revision_id to
1711
inventory.revision_id = osutils.safe_revision_id(revision_id)
1896
1712
return xml7.serializer_v7.write_inventory_to_string(inventory)
1898
1714
def _cache_basis_inventory(self, new_revision):
1901
1717
# as commit already has that ready-to-use [while the format is the
1902
1718
# same, that is].
1904
# this double handles the inventory - unpack and repack -
1720
# this double handles the inventory - unpack and repack -
1905
1721
# but is easier to understand. We can/should put a conditional
1906
1722
# in here based on whether the inventory is in the latest format
1907
1723
# - perhaps we should repack all inventories on a repository
1909
1725
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1726
# xml contains 'revision_id="', then we assume the right
1911
1727
# revision_id is set. We must check for this full string, because a
1912
1728
# root node id can legitimately look like 'revision_id' but cannot
1913
1729
# contain a '"'.
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1730
xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1731
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1732
if (not 'revision_id="' in firstline or
1917
1733
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1734
inv = self.branch.repository.deserialise_inventory(
1920
1736
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1737
self._write_basis_inventory(xml)
1922
1738
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1741
def read_basis_inventory(self):
1926
1742
"""Read the cached basis inventory."""
1927
1743
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1744
return self._control_files.get(path).read()
1930
1746
@needs_read_lock
1931
1747
def read_working_inventory(self):
1932
1748
"""Read the working inventory.
1934
1750
:raises errors.InventoryModified: read_working_inventory will fail
1935
1751
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1753
# conceptually this should be an implementation detail of the tree.
1938
1754
# XXX: Deprecate this.
1939
1755
# ElementTree does its own conversion from UTF-8, so open in
1941
1757
if self._inventory_is_modified:
1942
1758
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1759
result = self._deserialize(self._control_files.get('inventory'))
1948
1760
self._set_inventory(result, dirty=False)
1951
1763
@needs_tree_write_lock
1952
1764
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1954
"""Remove nominated files from the working inventory.
1766
"""Remove nominated files from the working inventor.
1956
1768
:files: File paths relative to the basedir.
1957
1769
:keep_files: If true, the files will also be kept.
1958
1770
:force: Delete files and directories, even if they are changed and
1959
1771
even if the directories are not empty.
1773
## TODO: Normalize names
1961
1775
if isinstance(files, basestring):
1962
1776
files = [files]
1966
1780
new_files=set()
1967
unknown_nested_files=set()
1969
to_file = sys.stdout
1781
unknown_files_in_directory=set()
1971
1783
def recurse_directory_to_add_files(directory):
1972
# Recurse directory and add all files
1784
# recurse directory and add all files
1973
1785
# so we can check if they have changed.
1974
1786
for parent_info, file_infos in\
1975
self.walkdirs(directory):
1976
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1977
# Is it versioned or ignored?
1978
if self.path2id(relpath) or self.is_ignored(relpath):
1979
# Add nested content for deletion.
1980
new_files.add(relpath)
1982
# Files which are not versioned and not ignored
1983
# should be treated as unknown.
1984
unknown_nested_files.add((relpath, None, kind))
1787
osutils.walkdirs(self.abspath(directory),
1789
for relpath, basename, kind, lstat, abspath in file_infos:
1791
if self.path2id(relpath): #is it versioned?
1792
new_files.add(relpath)
1794
unknown_files_in_directory.add(
1795
(relpath, None, kind))
1986
1797
for filename in files:
1987
1798
# Get file name into canonical form.
1989
1800
filename = self.relpath(abspath)
1990
1801
if len(filename) > 0:
1991
1802
new_files.add(filename)
1992
recurse_directory_to_add_files(filename)
1994
files = list(new_files)
1997
return # nothing to do
1803
if osutils.isdir(abspath):
1804
recurse_directory_to_add_files(filename)
1805
files = [f for f in new_files]
1999
1807
# Sort needed to first handle directory content before the directory
2000
1808
files.sort(reverse=True)
2002
# Bail out if we are going to delete files we shouldn't
2003
1809
if not keep_files and not force:
2004
has_changed_files = len(unknown_nested_files) > 0
2005
if not has_changed_files:
2006
for (file_id, path, content_change, versioned, parent_id, name,
2007
kind, executable) in self.iter_changes(self.basis_tree(),
2008
include_unchanged=True, require_versioned=False,
2009
want_unversioned=True, specific_files=files):
2010
if versioned == (False, False):
2011
# The record is unknown ...
2012
if not self.is_ignored(path[1]):
2013
# ... but not ignored
2014
has_changed_files = True
2016
elif content_change and (kind[1] is not None):
2017
# Versioned and changed, but not deleted
2018
has_changed_files = True
2021
if has_changed_files:
2022
# Make delta show ALL applicable changes in error message.
2023
tree_delta = self.changes_from(self.basis_tree(),
2024
require_versioned=False, want_unversioned=True,
2025
specific_files=files)
2026
for unknown_file in unknown_nested_files:
2027
if unknown_file not in tree_delta.unversioned:
2028
tree_delta.unversioned.extend((unknown_file,))
1810
tree_delta = self.changes_from(self.basis_tree(),
1811
specific_files=files)
1812
for unknown_file in unknown_files_in_directory:
1813
tree_delta.unversioned.extend((unknown_file,))
1814
if bool(tree_delta.modified
1816
or tree_delta.renamed
1817
or tree_delta.kind_changed
1818
or tree_delta.unversioned):
2029
1819
raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
# Build inv_delta and delete files where applicable,
2032
# do this before any modifications to inventory.
1821
# do this before any modifications
2033
1822
for f in files:
2034
1823
fid = self.path2id(f)
2037
message = "%s is not versioned." % (f,)
1826
message="%s is not versioned." % (f,)
2040
1829
# having removed it, it must be either ignored or unknown
2042
1831
new_status = 'I'
2044
1833
new_status = '?'
2045
# XXX: Really should be a more abstract reporter interface
2046
kind_ch = osutils.kind_marker(self.kind(fid))
2047
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1834
textui.show_status(new_status, self.kind(fid), f,
2049
1837
inv_delta.append((f, None, fid, None))
2050
message = "removed %s" % (f,)
1838
message="removed %s" % (f,)
2052
1840
if not keep_files:
2053
1841
abs_path = self.abspath(f)
2054
1842
if osutils.lexists(abs_path):
2055
1843
if (osutils.isdir(abs_path) and
2056
1844
len(os.listdir(abs_path)) > 0):
2058
osutils.rmtree(abs_path)
2060
message = "%s is not an empty directory "\
2061
"and won't be deleted." % (f,)
1845
message="%s is not empty directory "\
1846
"and won't be deleted." % (f,)
2063
1848
osutils.delete_any(abs_path)
2064
message = "deleted %s" % (f,)
1849
message="deleted %s" % (f,)
2065
1850
elif message is not None:
2066
# Only care if we haven't done anything yet.
2067
message = "%s does not exist." % (f,)
1851
# only care if we haven't done anything yet.
1852
message="%s does not exist." % (f,)
2069
# Print only one message (if any) per file.
1854
# print only one message (if any) per file.
2070
1855
if message is not None:
2072
1857
self.apply_inventory_delta(inv_delta)
2074
1859
@needs_tree_write_lock
2075
def revert(self, filenames=None, old_tree=None, backups=True,
2076
pb=None, report_changes=False):
1860
def revert(self, filenames, old_tree=None, backups=True,
1861
pb=DummyProgress(), report_changes=False):
2077
1862
from bzrlib.conflicts import resolve
2080
symbol_versioning.warn('Using [] to revert all files is deprecated'
2081
' as of bzr 0.91. Please use None (the default) instead.',
2082
DeprecationWarning, stacklevel=2)
2083
1863
if old_tree is None:
2084
basis_tree = self.basis_tree()
2085
basis_tree.lock_read()
2086
old_tree = basis_tree
1864
old_tree = self.basis_tree()
1865
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1867
if not len(filenames):
1868
self.set_parent_ids(self.get_parent_ids()[:1])
2090
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2092
if filenames is None and len(self.get_parent_ids()) > 1:
2094
last_revision = self.last_revision()
2095
if last_revision != _mod_revision.NULL_REVISION:
2096
if basis_tree is None:
2097
basis_tree = self.basis_tree()
2098
basis_tree.lock_read()
2099
parent_trees.append((last_revision, basis_tree))
2100
self.set_parent_trees(parent_trees)
2103
resolve(self, filenames, ignore_misses=True, recursive=True)
2105
if basis_tree is not None:
1871
resolve(self, filenames, ignore_misses=True)
2107
1872
return conflicts
2109
1874
def revision_tree(self, revision_id):
2157
1923
@needs_tree_write_lock
2158
1924
def set_root_id(self, file_id):
2159
1925
"""Set the root id for this tree."""
2161
1927
if file_id is None:
2163
'WorkingTree.set_root_id with fileid=None')
2164
file_id = osutils.safe_file_id(file_id)
1928
symbol_versioning.warn(symbol_versioning.zero_twelve
1929
% 'WorkingTree.set_root_id with fileid=None',
1934
file_id = osutils.safe_file_id(file_id)
2165
1935
self._set_root_id(file_id)
2167
1937
def _set_root_id(self, file_id):
2168
1938
"""Set the root id for this tree, in a format specific manner.
2170
:param file_id: The file id to assign to the root. It must not be
1940
:param file_id: The file id to assign to the root. It must not be
2171
1941
present in the current inventory or an error will occur. It must
2172
1942
not be None, but rather a valid file id.
2193
1963
def unlock(self):
2194
1964
"""See Branch.unlock.
2196
1966
WorkingTree locking just uses the Branch locking facilities.
2197
1967
This is current because all working trees have an embedded branch
2198
1968
within them. IF in the future, we were to make branch data shareable
2199
between multiple working trees, i.e. via shared storage, then we
1969
between multiple working trees, i.e. via shared storage, then we
2200
1970
would probably want to lock both the local tree, and the branch.
2202
1972
raise NotImplementedError(self.unlock)
2206
def update(self, change_reporter=None, possible_transports=None,
2207
revision=None, old_tip=_marker):
2208
1975
"""Update a working tree along its branch.
2210
1977
This will update the branch if its bound too, which means we have
2228
1995
- Merge current state -> basis tree of the master w.r.t. the old tree
2230
1997
- Do a 'normal' merge of the old branch basis if it is relevant.
2232
:param revision: The target revision to update to. Must be in the
2234
:param old_tip: If branch.update() has already been run, the value it
2235
returned (old tip of the branch or None). _marker is used
2238
if self.branch.get_bound_location() is not None:
1999
if self.branch.get_master_branch() is not None:
2239
2000
self.lock_write()
2240
update_branch = (old_tip is self._marker)
2001
update_branch = True
2242
2003
self.lock_tree_write()
2243
2004
update_branch = False
2245
2006
if update_branch:
2246
old_tip = self.branch.update(possible_transports)
2007
old_tip = self.branch.update()
2248
if old_tip is self._marker:
2250
return self._update_tree(old_tip, change_reporter, revision)
2010
return self._update_tree(old_tip)
2254
2014
@needs_tree_write_lock
2255
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2015
def _update_tree(self, old_tip=None):
2256
2016
"""Update a tree to the master branch.
2258
2018
:param old_tip: if supplied, the previous tip revision the branch,
2264
2024
# cant set that until we update the working trees last revision to be
2265
2025
# one from the new branch, because it will just get absorbed by the
2266
2026
# parent de-duplication logic.
2268
2028
# We MUST save it even if an error occurs, because otherwise the users
2269
2029
# local work is unreferenced and will appear to have been lost.
2273
2033
last_rev = self.get_parent_ids()[0]
2274
2034
except IndexError:
2275
last_rev = _mod_revision.NULL_REVISION
2276
if revision is None:
2277
revision = self.branch.last_revision()
2279
old_tip = old_tip or _mod_revision.NULL_REVISION
2281
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2282
# the branch we are bound to was updated
2283
# merge those changes in first
2284
base_tree = self.basis_tree()
2285
other_tree = self.branch.repository.revision_tree(old_tip)
2286
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2287
base_tree, this_tree=self,
2288
change_reporter=change_reporter)
2290
self.add_parent_tree((old_tip, other_tree))
2291
trace.note('Rerun update after fixing the conflicts.')
2294
if last_rev != _mod_revision.ensure_null(revision):
2295
# the working tree is up to date with the branch
2296
# we can merge the specified revision from master
2297
to_tree = self.branch.repository.revision_tree(revision)
2298
to_root_id = to_tree.get_root_id()
2036
if last_rev != self.branch.last_revision():
2037
# merge tree state up to new branch tip.
2300
2038
basis = self.basis_tree()
2301
2039
basis.lock_read()
2303
if (basis.inventory.root is None
2304
or basis.inventory.root.file_id != to_root_id):
2305
self.set_root_id(to_root_id)
2041
to_tree = self.branch.basis_tree()
2042
if basis.inventory.root is None:
2043
self.set_root_id(to_tree.inventory.root.file_id)
2045
result += merge.merge_inner(
2310
# determine the branch point
2311
graph = self.branch.repository.get_graph()
2312
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
change_reporter=change_reporter)
2319
self.set_last_revision(revision)
2320
2052
# TODO - dedup parents list with things merged by pull ?
2321
2053
# reuse the tree we've updated to to set the basis:
2322
parent_trees = [(revision, to_tree)]
2054
parent_trees = [(self.branch.last_revision(), to_tree)]
2323
2055
merges = self.get_parent_ids()[1:]
2324
2056
# Ideally we ask the tree for the trees here, that way the working
2325
# tree can decide whether to give us the entire tree or give us a
2057
# tree can decide whether to give us teh entire tree or give us a
2326
2058
# lazy initialised tree. dirstate for instance will have the trees
2327
2059
# in ram already, whereas a last-revision + basis-inventory tree
2328
2060
# will not, but also does not need them when setting parents.
2329
2061
for parent in merges:
2330
2062
parent_trees.append(
2331
2063
(parent, self.branch.repository.revision_tree(parent)))
2332
if not _mod_revision.is_null(old_tip):
2064
if old_tip is not None:
2333
2065
parent_trees.append(
2334
2066
(old_tip, self.branch.repository.revision_tree(old_tip)))
2335
2067
self.set_parent_trees(parent_trees)
2336
2068
last_rev = parent_trees[0][0]
2070
# the working tree had the same last-revision as the master
2071
# branch did. We may still have pivot local work from the local
2072
# branch into old_tip:
2073
if old_tip is not None:
2074
self.add_parent_tree_id(old_tip)
2075
if old_tip and old_tip != last_rev:
2076
# our last revision was not the prior branch last revision
2077
# and we have converted that last revision to a pending merge.
2078
# base is somewhere between the branch tip now
2079
# and the now pending merge
2081
# Since we just modified the working tree and inventory, flush out
2082
# the current state, before we modify it again.
2083
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2084
# requires it only because TreeTransform directly munges the
2085
# inventory and calls tree._write_inventory(). Ultimately we
2086
# should be able to remove this extra flush.
2088
from bzrlib.revision import common_ancestor
2090
base_rev_id = common_ancestor(self.branch.last_revision(),
2092
self.branch.repository)
2093
except errors.NoCommonAncestor:
2095
base_tree = self.branch.repository.revision_tree(base_rev_id)
2096
other_tree = self.branch.repository.revision_tree(old_tip)
2097
result += merge.merge_inner(
2339
2104
def _write_hashcache_if_dirty(self):
2340
2105
"""Write out the hashcache if it is dirty."""
2424
2189
current_inv = None
2425
2190
inv_finished = True
2426
2191
while not inv_finished or not disk_finished:
2428
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2429
cur_disk_dir_content) = current_disk
2431
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2432
cur_disk_dir_content) = ((None, None), None)
2433
2192
if not disk_finished:
2434
2193
# strip out .bzr dirs
2435
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2436
len(cur_disk_dir_content) > 0):
2437
# osutils.walkdirs can be made nicer -
2194
if current_disk[0][1][top_strip_len:] == '':
2195
# osutils.walkdirs can be made nicer -
2438
2196
# yield the path-from-prefix rather than the pathjoined
2440
bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
if (bzrdir_loc < len(cur_disk_dir_content)
2443
and self.bzrdir.is_control_filename(
2444
cur_disk_dir_content[bzrdir_loc][0])):
2198
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2199
if current_disk[1][bzrdir_loc][0] == '.bzr':
2445
2200
# we dont yield the contents of, or, .bzr itself.
2446
del cur_disk_dir_content[bzrdir_loc]
2201
del current_disk[1][bzrdir_loc]
2447
2202
if inv_finished:
2448
2203
# everything is unknown
2451
2206
# everything is missing
2454
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2209
direction = cmp(current_inv[0][0], current_disk[0][0])
2455
2210
if direction > 0:
2456
2211
# disk is before inventory - unknown
2457
2212
dirblock = [(relpath, basename, kind, stat, None, None) for
2458
relpath, basename, kind, stat, top_path in
2459
cur_disk_dir_content]
2460
yield (cur_disk_dir_relpath, None), dirblock
2213
relpath, basename, kind, stat, top_path in current_disk[1]]
2214
yield (current_disk[0][0], None), dirblock
2462
2216
current_disk = disk_iterator.next()
2463
2217
except StopIteration:
2538
2291
# FIXME: stash the node in pending
2539
2292
entry = inv[top_id]
2540
if entry.kind == 'directory':
2541
for name, child in entry.sorted_children():
2542
dirblock.append((relroot + name, name, child.kind, None,
2543
child.file_id, child.kind
2293
for name, child in entry.sorted_children():
2294
dirblock.append((relroot + name, name, child.kind, None,
2295
child.file_id, child.kind
2545
2297
yield (currentdir[0], entry.file_id), dirblock
2546
2298
# push the user specified dirs from dirblock
2547
2299
for dir in reversed(dirblock):
2613
def _get_rules_searcher(self, default_searcher):
2614
"""See Tree._get_rules_searcher."""
2615
if self._rules_searcher is None:
2616
self._rules_searcher = super(WorkingTree,
2617
self)._get_rules_searcher(default_searcher)
2618
return self._rules_searcher
2620
def get_shelf_manager(self):
2621
"""Return the ShelfManager for this WorkingTree."""
2622
from bzrlib.shelf import ShelfManager
2623
return ShelfManager(self, self._transport)
2626
2347
class WorkingTree2(WorkingTree):
2627
2348
"""This is the Format 2 working tree.
2629
This was the first weave based working tree.
2350
This was the first weave based working tree.
2630
2351
- uses os locks for locking.
2631
2352
- uses the branch last-revision.
2642
2363
if self._inventory is None:
2643
2364
self.read_working_inventory()
2645
def _get_check_refs(self):
2646
"""Return the references needed to perform a check of this tree."""
2647
return [('trees', self.last_revision())]
2649
2366
def lock_tree_write(self):
2650
2367
"""See WorkingTree.lock_tree_write().
2652
2369
In Format2 WorkingTrees we have a single lock for the branch and tree
2653
2370
so lock_tree_write() degrades to lock_write().
2655
:return: An object with an unlock method which will release the lock
2658
2372
self.branch.lock_write()
2660
self._control_files.lock_write()
2374
return self._control_files.lock_write()
2663
2376
self.branch.unlock()
2666
2379
def unlock(self):
2667
# do non-implementation specific cleanup
2670
2380
# we share control files:
2671
2381
if self._control_files._lock_count == 3:
2672
2382
# _inventory_is_modified is always False during a read lock.
2673
2383
if self._inventory_is_modified:
2675
2385
self._write_hashcache_if_dirty()
2677
2387
# reverse order of locking.
2679
2389
return self._control_files.unlock()
2695
2405
def _last_revision(self):
2696
2406
"""See Mutable.last_revision."""
2698
return self._transport.get_bytes('last-revision')
2408
return osutils.safe_revision_id(
2409
self._control_files.get('last-revision').read())
2699
2410
except errors.NoSuchFile:
2700
return _mod_revision.NULL_REVISION
2702
2413
def _change_last_revision(self, revision_id):
2703
2414
"""See WorkingTree._change_last_revision."""
2704
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2415
if revision_id is None or revision_id == NULL_REVISION:
2706
self._transport.delete('last-revision')
2417
self._control_files._transport.delete('last-revision')
2707
2418
except errors.NoSuchFile:
2711
self._transport.put_bytes('last-revision', revision_id,
2712
mode=self.bzrdir._get_file_mode())
2422
self._control_files.put_bytes('last-revision', revision_id)
2715
def _get_check_refs(self):
2716
"""Return the references needed to perform a check of this tree."""
2717
return [('trees', self.last_revision())]
2719
2425
@needs_tree_write_lock
2720
2426
def set_conflicts(self, conflicts):
2721
self._put_rio('conflicts', conflicts.to_stanzas(),
2427
self._put_rio('conflicts', conflicts.to_stanzas(),
2722
2428
CONFLICT_HEADER_1)
2724
2430
@needs_tree_write_lock
2731
2437
@needs_read_lock
2732
2438
def conflicts(self):
2734
confile = self._transport.get('conflicts')
2440
confile = self._control_files.get('conflicts')
2735
2441
except errors.NoSuchFile:
2736
2442
return _mod_conflicts.ConflictList()
2739
if confile.next() != CONFLICT_HEADER_1 + '\n':
2740
raise errors.ConflictFormatError()
2741
except StopIteration:
2444
if confile.next() != CONFLICT_HEADER_1 + '\n':
2742
2445
raise errors.ConflictFormatError()
2743
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2446
except StopIteration:
2447
raise errors.ConflictFormatError()
2448
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2747
2450
def unlock(self):
2748
# do non-implementation specific cleanup
2750
2451
if self._control_files._lock_count == 1:
2751
2452
# _inventory_is_modified is always False during a read lock.
2752
2453
if self._inventory_is_modified:
2867
2576
"""See WorkingTreeFormat.get_format_description()."""
2868
2577
return "Working tree format 2"
2870
def _stub_initialize_on_transport(self, transport, file_mode):
2871
"""Workaround: create control files for a remote working tree.
2579
def stub_initialize_remote(self, control_files):
2580
"""As a special workaround create critical control files for a remote working tree
2873
2582
This ensures that it can later be updated and dealt with locally,
2874
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2583
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2875
2584
no working tree. (See bug #43064).
2877
2586
sio = StringIO()
2878
inv = inventory.Inventory()
2879
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2588
xml5.serializer_v5.write_inventory(inv, sio)
2881
transport.put_file('inventory', sio, file_mode)
2882
transport.put_bytes('pending-merges', '', file_mode)
2884
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2885
accelerator_tree=None, hardlink=False):
2590
control_files.put('inventory', sio)
2592
control_files.put_bytes('pending-merges', '')
2595
def initialize(self, a_bzrdir, revision_id=None):
2886
2596
"""See WorkingTreeFormat.initialize()."""
2887
2597
if not isinstance(a_bzrdir.transport, LocalTransport):
2888
2598
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2889
if from_branch is not None:
2890
branch = from_branch
2892
branch = a_bzrdir.open_branch()
2893
if revision_id is None:
2894
revision_id = _mod_revision.ensure_null(branch.last_revision())
2897
branch.generate_revision_history(revision_id)
2900
inv = inventory.Inventory()
2599
branch = a_bzrdir.open_branch()
2600
if revision_id is not None:
2601
revision_id = osutils.safe_revision_id(revision_id)
2604
revision_history = branch.revision_history()
2606
position = revision_history.index(revision_id)
2608
raise errors.NoSuchRevision(branch, revision_id)
2609
branch.set_revision_history(revision_history[:position + 1])
2612
revision = branch.last_revision()
2901
2614
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
2617
_internal=True,
2906
2619
_bzrdir=a_bzrdir)
2907
basis_tree = branch.repository.revision_tree(revision_id)
2620
basis_tree = branch.repository.revision_tree(revision)
2908
2621
if basis_tree.inventory.root is not None:
2909
wt.set_root_id(basis_tree.get_root_id())
2622
wt.set_root_id(basis_tree.inventory.root.file_id)
2910
2623
# set the parent list and cache the basis tree.
2911
if _mod_revision.is_null(revision_id):
2914
parent_trees = [(revision_id, basis_tree)]
2915
wt.set_parent_trees(parent_trees)
2624
wt.set_parent_trees([(revision, basis_tree)])
2916
2625
transform.build_tree(basis_tree, wt)
2972
2681
def _open_control_files(self, a_bzrdir):
2973
2682
transport = a_bzrdir.get_workingtree_transport(None)
2974
return LockableFiles(transport, self._lock_file_name,
2683
return LockableFiles(transport, self._lock_file_name,
2975
2684
self._lock_class)
2977
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2978
accelerator_tree=None, hardlink=False):
2686
def initialize(self, a_bzrdir, revision_id=None):
2979
2687
"""See WorkingTreeFormat.initialize().
2981
:param revision_id: if supplied, create a working tree at a different
2982
revision than the branch is at.
2983
:param accelerator_tree: A tree which can be used for retrieving file
2984
contents more quickly than the revision tree, i.e. a workingtree.
2985
The revision tree will be used for cases where accelerator_tree's
2986
content is different.
2987
:param hardlink: If true, hard-link files from accelerator_tree,
2689
revision_id allows creating a working tree at a different
2690
revision than the branch is at.
2990
2692
if not isinstance(a_bzrdir.transport, LocalTransport):
2991
2693
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2993
2695
control_files = self._open_control_files(a_bzrdir)
2994
2696
control_files.create_lock()
2995
2697
control_files.lock_write()
2996
transport.put_bytes('format', self.get_format_string(),
2997
mode=a_bzrdir._get_file_mode())
2998
if from_branch is not None:
2999
branch = from_branch
2698
control_files.put_utf8('format', self.get_format_string())
2699
branch = a_bzrdir.open_branch()
2700
if revision_id is None:
2701
revision_id = branch.last_revision()
3001
branch = a_bzrdir.open_branch()
3002
if revision_id is None:
3003
revision_id = _mod_revision.ensure_null(branch.last_revision())
2703
revision_id = osutils.safe_revision_id(revision_id)
3004
2704
# WorkingTree3 can handle an inventory which has a unique root id.
3005
2705
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3006
2706
# those trees. And because there isn't a format bump inbetween, we
3068
2768
return self.get_format_string()
3071
__default_format = WorkingTreeFormat6()
2771
__default_format = WorkingTreeFormat4()
3072
2772
WorkingTreeFormat.register_format(__default_format)
3073
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3074
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3075
2773
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3076
2774
WorkingTreeFormat.set_default_format(__default_format)
3077
2775
# formats which have no format string are not discoverable
3078
2776
# and not independently creatable, so are not registered.
3079
2777
_legacy_formats = [WorkingTreeFormat2(),
2781
class WorkingTreeTestProviderAdapter(object):
2782
"""A tool to generate a suite testing multiple workingtree formats at once.
2784
This is done by copying the test once for each transport and injecting
2785
the transport_server, transport_readonly_server, and workingtree_format
2786
classes into each copy. Each copy is also given a new id() to make it
2790
def __init__(self, transport_server, transport_readonly_server, formats):
2791
self._transport_server = transport_server
2792
self._transport_readonly_server = transport_readonly_server
2793
self._formats = formats
2795
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2796
"""Clone test for adaption."""
2797
new_test = deepcopy(test)
2798
new_test.transport_server = self._transport_server
2799
new_test.transport_readonly_server = self._transport_readonly_server
2800
new_test.bzrdir_format = bzrdir_format
2801
new_test.workingtree_format = workingtree_format
2802
def make_new_test_id():
2803
new_id = "%s(%s)" % (test.id(), variation)
2804
return lambda: new_id
2805
new_test.id = make_new_test_id()
2808
def adapt(self, test):
2809
from bzrlib.tests import TestSuite
2810
result = TestSuite()
2811
for workingtree_format, bzrdir_format in self._formats:
2812
new_test = self._clone_test(
2815
workingtree_format, workingtree_format.__class__.__name__)
2816
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
