68
354
inv = self._inventory
69
355
for path, ie in inv.iter_entries():
70
if os.path.exists(self.abspath(path)):
356
if osutils.lexists(self.abspath(path)):
74
359
def __repr__(self):
75
360
return "<%s of %s>" % (self.__class__.__name__,
76
361
getattr(self, 'basedir', None))
80
363
def abspath(self, filename):
81
return os.path.join(self.basedir, filename)
364
return pathjoin(self.basedir, filename)
366
def basis_tree(self):
367
"""Return RevisionTree for the current last revision.
369
If the left most parent is a ghost then the returned tree will be an
370
empty tree - one obtained by calling repository.revision_tree(None).
373
revision_id = self.get_parent_ids()[0]
375
# no parents, return an empty revision tree.
376
# in the future this should return the tree for
377
# 'empty:' - the implicit root empty tree.
378
return self.branch.repository.revision_tree(None)
380
return self.revision_tree(revision_id)
381
except errors.NoSuchRevision:
383
# No cached copy available, retrieve from the repository.
384
# FIXME? RBC 20060403 should we cache the inventory locally
387
return self.branch.repository.revision_tree(revision_id)
388
except errors.RevisionNotPresent:
389
# the basis tree *may* be a ghost or a low level error may have
390
# occured. If the revision is present, its a problem, if its not
392
if self.branch.repository.has_revision(revision_id):
394
# the basis tree is a ghost so return an empty tree.
395
return self.branch.repository.revision_tree(None)
398
@deprecated_method(zero_eight)
399
def create(branch, directory):
400
"""Create a workingtree for branch at directory.
402
If existing_directory already exists it must have a .bzr directory.
403
If it does not exist, it will be created.
405
This returns a new WorkingTree object for the new checkout.
407
TODO FIXME RBC 20060124 when we have checkout formats in place this
408
should accept an optional revisionid to checkout [and reject this if
409
checking out into the same dir as a pre-checkout-aware branch format.]
411
XXX: When BzrDir is present, these should be created through that
414
warnings.warn('delete WorkingTree.create', stacklevel=3)
415
transport = get_transport(directory)
416
if branch.bzrdir.root_transport.base == transport.base:
418
return branch.bzrdir.create_workingtree()
419
# different directory,
420
# create a branch reference
421
# and now a working tree.
422
raise NotImplementedError
425
@deprecated_method(zero_eight)
426
def create_standalone(directory):
427
"""Create a checkout and a branch and a repo at directory.
429
Directory must exist and be empty.
431
please use BzrDir.create_standalone_workingtree
433
return bzrdir.BzrDir.create_standalone_workingtree(directory)
435
def relpath(self, path):
436
"""Return the local path portion from a given path.
438
The path may be absolute or relative. If its a relative path it is
439
interpreted relative to the python current working directory.
441
return osutils.relpath(self.basedir, path)
83
443
def has_filename(self, filename):
84
return os.path.exists(self.abspath(filename))
444
return osutils.lexists(self.abspath(filename))
86
446
def get_file(self, file_id):
447
file_id = osutils.safe_file_id(file_id)
87
448
return self.get_file_byname(self.id2path(file_id))
450
def get_file_text(self, file_id):
451
file_id = osutils.safe_file_id(file_id)
452
return self.get_file(file_id).read()
89
454
def get_file_byname(self, filename):
90
455
return file(self.abspath(filename), 'rb')
458
def annotate_iter(self, file_id):
459
"""See Tree.annotate_iter
461
This implementation will use the basis tree implementation if possible.
462
Lines not in the basis are attributed to CURRENT_REVISION
464
If there are pending merges, lines added by those merges will be
465
incorrectly attributed to CURRENT_REVISION (but after committing, the
466
attribution will be correct).
468
file_id = osutils.safe_file_id(file_id)
469
basis = self.basis_tree()
472
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
473
require_versioned=True).next()
474
changed_content, kind = changes[2], changes[6]
475
if not changed_content:
476
return basis.annotate_iter(file_id)
480
if kind[0] != 'file':
483
old_lines = list(basis.annotate_iter(file_id))
485
for tree in self.branch.repository.revision_trees(
486
self.get_parent_ids()[1:]):
487
if file_id not in tree:
489
old.append(list(tree.annotate_iter(file_id)))
490
return annotate.reannotate(old, self.get_file(file_id).readlines(),
495
def get_parent_ids(self):
496
"""See Tree.get_parent_ids.
498
This implementation reads the pending merges list and last_revision
499
value and uses that to decide what the parents list should be.
501
last_rev = self._last_revision()
507
merges_file = self._control_files.get('pending-merges')
508
except errors.NoSuchFile:
511
for l in merges_file.readlines():
512
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
513
parents.append(revision_id)
517
def get_root_id(self):
518
"""Return the id of this trees root"""
519
return self._inventory.root.file_id
92
521
def _get_store_filename(self, file_id):
93
## XXX: badly named; this isn't in the store at all
94
return self.abspath(self.id2path(file_id))
522
## XXX: badly named; this is not in the store at all
523
file_id = osutils.safe_file_id(file_id)
524
return self.abspath(self.id2path(file_id))
527
def clone(self, to_bzrdir, revision_id=None, basis=None):
528
"""Duplicate this working tree into to_bzr, including all state.
530
Specifically modified files are kept as modified, but
531
ignored and unknown files are discarded.
533
If you want to make a new line of development, see bzrdir.sprout()
536
If not None, the cloned tree will have its last revision set to
537
revision, and and difference between the source trees last revision
538
and this one merged in.
541
If not None, a closer copy of a tree which may have some files in
542
common, and which file content should be preferentially copied from.
544
# assumes the target bzr dir format is compatible.
545
result = self._format.initialize(to_bzrdir)
546
self.copy_content_into(result, revision_id)
550
def copy_content_into(self, tree, revision_id=None):
551
"""Copy the current content and user files of this tree into tree."""
552
tree.set_root_id(self.get_root_id())
553
if revision_id is None:
554
merge.transform_tree(tree, self)
556
# TODO now merge from tree.last_revision to revision (to preserve
557
# user local changes)
558
merge.transform_tree(tree, self)
559
tree.set_parent_ids([revision_id])
561
def id2abspath(self, file_id):
562
file_id = osutils.safe_file_id(file_id)
563
return self.abspath(self.id2path(file_id))
97
565
def has_id(self, file_id):
98
566
# files that have been deleted are excluded
567
file_id = osutils.safe_file_id(file_id)
100
569
if not inv.has_id(file_id):
102
571
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
572
return osutils.lexists(self.abspath(path))
574
def has_or_had_id(self, file_id):
575
file_id = osutils.safe_file_id(file_id)
576
if file_id == self.inventory.root.file_id:
578
return self.inventory.has_id(file_id)
106
580
__contains__ = has_id
109
582
def get_file_size(self, file_id):
110
# is this still called?
111
raise NotImplementedError()
114
def get_file_sha1(self, file_id):
115
path = self._inventory.id2path(file_id)
116
return self._hashcache.get_sha1(path)
119
def file_class(self, filename):
120
if self.path2id(filename):
122
elif self.is_ignored(filename):
128
def list_files(self):
129
"""Recursively list all files as (path, class, kind, id).
583
file_id = osutils.safe_file_id(file_id)
584
return os.path.getsize(self.id2abspath(file_id))
587
def get_file_sha1(self, file_id, path=None, stat_value=None):
588
file_id = osutils.safe_file_id(file_id)
590
path = self._inventory.id2path(file_id)
591
return self._hashcache.get_sha1(path, stat_value)
593
def get_file_mtime(self, file_id, path=None):
594
file_id = osutils.safe_file_id(file_id)
596
path = self.inventory.id2path(file_id)
597
return os.lstat(self.abspath(path)).st_mtime
599
if not supports_executable():
600
def is_executable(self, file_id, path=None):
601
file_id = osutils.safe_file_id(file_id)
602
return self._inventory[file_id].executable
604
def is_executable(self, file_id, path=None):
606
file_id = osutils.safe_file_id(file_id)
607
path = self.id2path(file_id)
608
mode = os.lstat(self.abspath(path)).st_mode
609
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
611
@needs_tree_write_lock
612
def _add(self, files, ids, kinds):
613
"""See MutableTree._add."""
614
# TODO: Re-adding a file that is removed in the working copy
615
# should probably put it back with the previous ID.
616
# the read and write working inventory should not occur in this
617
# function - they should be part of lock_write and unlock.
618
inv = self.read_working_inventory()
619
for f, file_id, kind in zip(files, ids, kinds):
620
assert kind is not None
622
inv.add_path(f, kind=kind)
624
file_id = osutils.safe_file_id(file_id)
625
inv.add_path(f, kind=kind, file_id=file_id)
626
self._write_inventory(inv)
628
@needs_tree_write_lock
629
def _gather_kinds(self, files, kinds):
630
"""See MutableTree._gather_kinds."""
631
for pos, f in enumerate(files):
632
if kinds[pos] is None:
633
fullpath = normpath(self.abspath(f))
635
kinds[pos] = file_kind(fullpath)
637
if e.errno == errno.ENOENT:
638
raise errors.NoSuchFile(fullpath)
641
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
642
"""Add revision_id as a parent.
644
This is equivalent to retrieving the current list of parent ids
645
and setting the list to its value plus revision_id.
647
:param revision_id: The revision id to add to the parent list. It may
648
be a ghost revision as long as its not the first parent to be added,
649
or the allow_leftmost_as_ghost parameter is set True.
650
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
652
parents = self.get_parent_ids() + [revision_id]
653
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
654
or allow_leftmost_as_ghost)
656
@needs_tree_write_lock
657
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
658
"""Add revision_id, tree tuple as a parent.
660
This is equivalent to retrieving the current list of parent trees
661
and setting the list to its value plus parent_tuple. See also
662
add_parent_tree_id - if you only have a parent id available it will be
663
simpler to use that api. If you have the parent already available, using
664
this api is preferred.
666
:param parent_tuple: The (revision id, tree) to add to the parent list.
667
If the revision_id is a ghost, pass None for the tree.
668
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
670
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
671
if len(parent_ids) > 1:
672
# the leftmost may have already been a ghost, preserve that if it
674
allow_leftmost_as_ghost = True
675
self.set_parent_ids(parent_ids,
676
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
678
@needs_tree_write_lock
679
def add_pending_merge(self, *revision_ids):
680
# TODO: Perhaps should check at this point that the
681
# history of the revision is actually present?
682
parents = self.get_parent_ids()
684
for rev_id in revision_ids:
685
if rev_id in parents:
687
parents.append(rev_id)
690
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
692
@deprecated_method(zero_eleven)
694
def pending_merges(self):
695
"""Return a list of pending merges.
697
These are revisions that have been merged into the working
698
directory but not yet committed.
700
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
701
instead - which is available on all tree objects.
703
return self.get_parent_ids()[1:]
705
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
706
"""Common ghost checking functionality from set_parent_*.
708
This checks that the left hand-parent exists if there are any
711
if len(revision_ids) > 0:
712
leftmost_id = revision_ids[0]
713
if (not allow_leftmost_as_ghost and not
714
self.branch.repository.has_revision(leftmost_id)):
715
raise errors.GhostRevisionUnusableHere(leftmost_id)
717
def _set_merges_from_parent_ids(self, parent_ids):
718
merges = parent_ids[1:]
719
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
721
@needs_tree_write_lock
722
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
723
"""Set the parent ids to revision_ids.
725
See also set_parent_trees. This api will try to retrieve the tree data
726
for each element of revision_ids from the trees repository. If you have
727
tree data already available, it is more efficient to use
728
set_parent_trees rather than set_parent_ids. set_parent_ids is however
729
an easier API to use.
731
:param revision_ids: The revision_ids to set as the parent ids of this
732
working tree. Any of these may be ghosts.
734
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
735
self._check_parents_for_ghosts(revision_ids,
736
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
738
if len(revision_ids) > 0:
739
self.set_last_revision(revision_ids[0])
741
self.set_last_revision(None)
743
self._set_merges_from_parent_ids(revision_ids)
745
@needs_tree_write_lock
746
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
747
"""See MutableTree.set_parent_trees."""
748
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
750
self._check_parents_for_ghosts(parent_ids,
751
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
753
if len(parent_ids) == 0:
754
leftmost_parent_id = None
755
leftmost_parent_tree = None
757
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
759
if self._change_last_revision(leftmost_parent_id):
760
if leftmost_parent_tree is None:
761
# If we don't have a tree, fall back to reading the
762
# parent tree from the repository.
763
self._cache_basis_inventory(leftmost_parent_id)
765
inv = leftmost_parent_tree.inventory
766
xml = self._create_basis_xml_from_inventory(
767
leftmost_parent_id, inv)
768
self._write_basis_inventory(xml)
769
self._set_merges_from_parent_ids(parent_ids)
771
@needs_tree_write_lock
772
def set_pending_merges(self, rev_list):
773
parents = self.get_parent_ids()
774
leftmost = parents[:1]
775
new_parents = leftmost + rev_list
776
self.set_parent_ids(new_parents)
778
@needs_tree_write_lock
779
def set_merge_modified(self, modified_hashes):
781
for file_id, hash in modified_hashes.iteritems():
782
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
783
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
785
def _put_rio(self, filename, stanzas, header):
786
self._must_be_locked()
787
my_file = rio_file(stanzas, header)
788
self._control_files.put(filename, my_file)
790
@needs_write_lock # because merge pulls data into the branch.
791
def merge_from_branch(self, branch, to_revision=None):
792
"""Merge from a branch into this working tree.
794
:param branch: The branch to merge from.
795
:param to_revision: If non-None, the merge will merge to to_revision,
796
but not beyond it. to_revision does not need to be in the history
797
of the branch when it is supplied. If None, to_revision defaults to
798
branch.last_revision().
800
from bzrlib.merge import Merger, Merge3Merger
801
pb = bzrlib.ui.ui_factory.nested_progress_bar()
803
merger = Merger(self.branch, this_tree=self, pb=pb)
804
merger.pp = ProgressPhase("Merge phase", 5, pb)
805
merger.pp.next_phase()
806
# check that there are no
808
merger.check_basis(check_clean=True, require_commits=False)
809
if to_revision is None:
810
to_revision = branch.last_revision()
812
to_revision = osutils.safe_revision_id(to_revision)
813
merger.other_rev_id = to_revision
814
if merger.other_rev_id is None:
815
raise error.NoCommits(branch)
816
self.branch.fetch(branch, last_revision=merger.other_rev_id)
817
merger.other_basis = merger.other_rev_id
818
merger.other_tree = self.branch.repository.revision_tree(
820
merger.other_branch = branch
821
merger.pp.next_phase()
823
if merger.base_rev_id == merger.other_rev_id:
824
raise errors.PointlessMerge
825
merger.backup_files = False
826
merger.merge_type = Merge3Merger
827
merger.set_interesting_files(None)
828
merger.show_base = False
829
merger.reprocess = False
830
conflicts = merger.do_merge()
837
def merge_modified(self):
838
"""Return a dictionary of files modified by a merge.
840
The list is initialized by WorkingTree.set_merge_modified, which is
841
typically called after we make some automatic updates to the tree
844
This returns a map of file_id->sha1, containing only files which are
845
still in the working inventory and have that text hash.
848
hashfile = self._control_files.get('merge-hashes')
849
except errors.NoSuchFile:
853
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
854
raise errors.MergeModifiedFormatError()
855
except StopIteration:
856
raise errors.MergeModifiedFormatError()
857
for s in RioReader(hashfile):
858
# RioReader reads in Unicode, so convert file_ids back to utf8
859
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
860
if file_id not in self.inventory:
862
text_hash = s.get("hash")
863
if text_hash == self.get_file_sha1(file_id):
864
merge_hashes[file_id] = text_hash
868
def mkdir(self, path, file_id=None):
869
"""See MutableTree.mkdir()."""
871
file_id = generate_ids.gen_file_id(os.path.basename(path))
872
os.mkdir(self.abspath(path))
873
self.add(path, file_id, 'directory')
876
def get_symlink_target(self, file_id):
877
file_id = osutils.safe_file_id(file_id)
878
return os.readlink(self.id2abspath(file_id))
881
def subsume(self, other_tree):
882
def add_children(inventory, entry):
883
for child_entry in entry.children.values():
884
inventory._byid[child_entry.file_id] = child_entry
885
if child_entry.kind == 'directory':
886
add_children(inventory, child_entry)
887
if other_tree.get_root_id() == self.get_root_id():
888
raise errors.BadSubsumeSource(self, other_tree,
889
'Trees have the same root')
891
other_tree_path = self.relpath(other_tree.basedir)
892
except errors.PathNotChild:
893
raise errors.BadSubsumeSource(self, other_tree,
894
'Tree is not contained by the other')
895
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
896
if new_root_parent is None:
897
raise errors.BadSubsumeSource(self, other_tree,
898
'Parent directory is not versioned.')
899
# We need to ensure that the result of a fetch will have a
900
# versionedfile for the other_tree root, and only fetching into
901
# RepositoryKnit2 guarantees that.
902
if not self.branch.repository.supports_rich_root():
903
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
904
other_tree.lock_tree_write()
906
new_parents = other_tree.get_parent_ids()
907
other_root = other_tree.inventory.root
908
other_root.parent_id = new_root_parent
909
other_root.name = osutils.basename(other_tree_path)
910
self.inventory.add(other_root)
911
add_children(self.inventory, other_root)
912
self._write_inventory(self.inventory)
913
# normally we don't want to fetch whole repositories, but i think
914
# here we really do want to consolidate the whole thing.
915
for parent_id in other_tree.get_parent_ids():
916
self.branch.fetch(other_tree.branch, parent_id)
917
self.add_parent_tree_id(parent_id)
920
other_tree.bzrdir.retire_bzrdir()
922
@needs_tree_write_lock
923
def extract(self, file_id, format=None):
924
"""Extract a subtree from this tree.
926
A new branch will be created, relative to the path for this tree.
930
segments = osutils.splitpath(path)
931
transport = self.branch.bzrdir.root_transport
932
for name in segments:
933
transport = transport.clone(name)
936
except errors.FileExists:
940
sub_path = self.id2path(file_id)
941
branch_transport = mkdirs(sub_path)
943
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
945
branch_transport.mkdir('.')
946
except errors.FileExists:
948
branch_bzrdir = format.initialize_on_transport(branch_transport)
950
repo = branch_bzrdir.find_repository()
951
except errors.NoRepositoryPresent:
952
repo = branch_bzrdir.create_repository()
953
assert repo.supports_rich_root()
955
if not repo.supports_rich_root():
956
raise errors.RootNotRich()
957
new_branch = branch_bzrdir.create_branch()
958
new_branch.pull(self.branch)
959
for parent_id in self.get_parent_ids():
960
new_branch.fetch(self.branch, parent_id)
961
tree_transport = self.bzrdir.root_transport.clone(sub_path)
962
if tree_transport.base != branch_transport.base:
963
tree_bzrdir = format.initialize_on_transport(tree_transport)
964
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
966
tree_bzrdir = branch_bzrdir
967
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
968
wt.set_parent_ids(self.get_parent_ids())
969
my_inv = self.inventory
970
child_inv = Inventory(root_id=None)
971
new_root = my_inv[file_id]
972
my_inv.remove_recursive_id(file_id)
973
new_root.parent_id = None
974
child_inv.add(new_root)
975
self._write_inventory(my_inv)
976
wt._write_inventory(child_inv)
979
def _serialize(self, inventory, out_file):
980
xml5.serializer_v5.write_inventory(self._inventory, out_file)
982
def _deserialize(selt, in_file):
983
return xml5.serializer_v5.read_inventory(in_file)
986
"""Write the in memory inventory to disk."""
987
# TODO: Maybe this should only write on dirty ?
988
if self._control_files._lock_mode != 'w':
989
raise errors.NotWriteLocked(self)
991
self._serialize(self._inventory, sio)
993
self._control_files.put('inventory', sio)
994
self._inventory_is_modified = False
996
def _kind(self, relpath):
997
return osutils.file_kind(self.abspath(relpath))
999
def list_files(self, include_root=False):
1000
"""Recursively list all files as (path, class, kind, id, entry).
131
1002
Lists, but does not descend into unversioned directories.
136
1007
Skips the control directory.
138
from osutils import appendpath, file_kind
141
inv = self._inventory
143
def descend(from_dir_relpath, from_dir_id, dp):
1009
# list_files is an iterator, so @needs_read_lock doesn't work properly
1010
# with it. So callers should be careful to always read_lock the tree.
1011
if not self.is_locked():
1012
raise errors.ObjectNotLocked(self)
1014
inv = self.inventory
1015
if include_root is True:
1016
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1017
# Convert these into local objects to save lookup times
1018
pathjoin = osutils.pathjoin
1019
file_kind = self._kind
1021
# transport.base ends in a slash, we want the piece
1022
# between the last two slashes
1023
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1025
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1027
# directory file_id, relative path, absolute path, reverse sorted children
1028
children = os.listdir(self.basedir)
1030
# jam 20060527 The kernel sized tree seems equivalent whether we
1031
# use a deque and popleft to keep them sorted, or if we use a plain
1032
# list and just reverse() them.
1033
children = collections.deque(children)
1034
stack = [(inv.root.file_id, u'', self.basedir, children)]
1036
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1039
f = children.popleft()
147
1040
## TODO: If we find a subdirectory with its own .bzr
148
1041
## directory, then that is a separate tree and we
149
1042
## should exclude it.
150
if bzrlib.BZRDIR == f:
1044
# the bzrdir for this tree
1045
if transport_base_dir == f:
154
fp = appendpath(from_dir_relpath, f)
1048
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1049
# and 'f' doesn't begin with one, we can do a string op, rather
1050
# than the checks of pathjoin(), all relative paths will have an extra slash
1052
fp = from_dir_relpath + '/' + f
157
fap = appendpath(dp, f)
1055
fap = from_dir_abspath + '/' + f
159
1057
f_ie = inv.get_child(from_dir_id, f)
162
elif self.is_ignored(fp):
1060
elif self.is_ignored(fp[1:]):
1063
# we may not have found this file, because of a unicode issue
1064
f_norm, can_access = osutils.normalized_filename(f)
1065
if f == f_norm or not can_access:
1066
# No change, so treat this file normally
1069
# this file can be accessed by a normalized path
1070
# check again if it is versioned
1071
# these lines are repeated here for performance
1073
fp = from_dir_relpath + '/' + f
1074
fap = from_dir_abspath + '/' + f
1075
f_ie = inv.get_child(from_dir_id, f)
1078
elif self.is_ignored(fp[1:]):
167
1083
fk = file_kind(fap)
1085
# make a last minute entry
171
raise BzrCheckError("file %r entered as kind %r id %r, "
173
% (fap, f_ie.kind, f_ie.file_id, fk))
175
yield fp, c, fk, (f_ie and f_ie.file_id)
1087
yield fp[1:], c, fk, f_ie.file_id, f_ie
1090
yield fp[1:], c, fk, None, fk_entries[fk]()
1092
yield fp[1:], c, fk, None, TreeEntry()
177
1095
if fk != 'directory':
181
# don't descend unversioned directories
184
for ff in descend(fp, f_ie.file_id, fap):
187
for f in descend('', inv.root.file_id, self.basedir):
1098
# But do this child first
1099
new_children = os.listdir(fap)
1101
new_children = collections.deque(new_children)
1102
stack.append((f_ie.file_id, fp, fap, new_children))
1103
# Break out of inner loop,
1104
# so that we start outer loop with child
1107
# if we finished all children, pop it off the stack
1110
@needs_tree_write_lock
1111
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1114
to_dir must exist in the inventory.
1116
If to_dir exists and is a directory, the files are moved into
1117
it, keeping their old names.
1119
Note that to_dir is only the last component of the new name;
1120
this doesn't change the directory.
1122
For each entry in from_paths the move mode will be determined
1125
The first mode moves the file in the filesystem and updates the
1126
inventory. The second mode only updates the inventory without
1127
touching the file on the filesystem. This is the new mode introduced
1130
move uses the second mode if 'after == True' and the target is not
1131
versioned but present in the working tree.
1133
move uses the second mode if 'after == False' and the source is
1134
versioned but no longer in the working tree, and the target is not
1135
versioned but present in the working tree.
1137
move uses the first mode if 'after == False' and the source is
1138
versioned and present in the working tree, and the target is not
1139
versioned and not present in the working tree.
1141
Everything else results in an error.
1143
This returns a list of (from_path, to_path) pairs for each
1144
entry that is moved.
1149
# check for deprecated use of signature
1151
to_dir = kwargs.get('to_name', None)
1153
raise TypeError('You must supply a target directory')
1155
symbol_versioning.warn('The parameter to_name was deprecated'
1156
' in version 0.13. Use to_dir instead',
1159
# check destination directory
1160
assert not isinstance(from_paths, basestring)
1161
inv = self.inventory
1162
to_abs = self.abspath(to_dir)
1163
if not isdir(to_abs):
1164
raise errors.BzrMoveFailedError('',to_dir,
1165
errors.NotADirectory(to_abs))
1166
if not self.has_filename(to_dir):
1167
raise errors.BzrMoveFailedError('',to_dir,
1168
errors.NotInWorkingDirectory(to_dir))
1169
to_dir_id = inv.path2id(to_dir)
1170
if to_dir_id is None:
1171
raise errors.BzrMoveFailedError('',to_dir,
1172
errors.NotVersionedError(path=str(to_dir)))
1174
to_dir_ie = inv[to_dir_id]
1175
if to_dir_ie.kind != 'directory':
1176
raise errors.BzrMoveFailedError('',to_dir,
1177
errors.NotADirectory(to_abs))
1179
# create rename entries and tuples
1180
for from_rel in from_paths:
1181
from_tail = splitpath(from_rel)[-1]
1182
from_id = inv.path2id(from_rel)
1184
raise errors.BzrMoveFailedError(from_rel,to_dir,
1185
errors.NotVersionedError(path=str(from_rel)))
1187
from_entry = inv[from_id]
1188
from_parent_id = from_entry.parent_id
1189
to_rel = pathjoin(to_dir, from_tail)
1190
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1192
from_tail=from_tail,
1193
from_parent_id=from_parent_id,
1194
to_rel=to_rel, to_tail=from_tail,
1195
to_parent_id=to_dir_id)
1196
rename_entries.append(rename_entry)
1197
rename_tuples.append((from_rel, to_rel))
1199
# determine which move mode to use. checks also for movability
1200
rename_entries = self._determine_mv_mode(rename_entries, after)
1202
original_modified = self._inventory_is_modified
1205
self._inventory_is_modified = True
1206
self._move(rename_entries)
1208
# restore the inventory on error
1209
self._inventory_is_modified = original_modified
1211
self._write_inventory(inv)
1212
return rename_tuples
1214
def _determine_mv_mode(self, rename_entries, after=False):
1215
"""Determines for each from-to pair if both inventory and working tree
1216
or only the inventory has to be changed.
1218
Also does basic plausability tests.
1220
inv = self.inventory
1222
for rename_entry in rename_entries:
1223
# store to local variables for easier reference
1224
from_rel = rename_entry.from_rel
1225
from_id = rename_entry.from_id
1226
to_rel = rename_entry.to_rel
1227
to_id = inv.path2id(to_rel)
1228
only_change_inv = False
1230
# check the inventory for source and destination
1232
raise errors.BzrMoveFailedError(from_rel,to_rel,
1233
errors.NotVersionedError(path=str(from_rel)))
1234
if to_id is not None:
1235
raise errors.BzrMoveFailedError(from_rel,to_rel,
1236
errors.AlreadyVersionedError(path=str(to_rel)))
1238
# try to determine the mode for rename (only change inv or change
1239
# inv and file system)
1241
if not self.has_filename(to_rel):
1242
raise errors.BzrMoveFailedError(from_id,to_rel,
1243
errors.NoSuchFile(path=str(to_rel),
1244
extra="New file has not been created yet"))
1245
only_change_inv = True
1246
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1247
only_change_inv = True
1248
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1249
only_change_inv = False
1251
# something is wrong, so lets determine what exactly
1252
if not self.has_filename(from_rel) and \
1253
not self.has_filename(to_rel):
1254
raise errors.BzrRenameFailedError(from_rel,to_rel,
1255
errors.PathsDoNotExist(paths=(str(from_rel),
1258
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1259
extra="(Use --after to update the Bazaar id)")
1260
rename_entry.only_change_inv = only_change_inv
1261
return rename_entries
1263
def _move(self, rename_entries):
1264
"""Moves a list of files.
1266
Depending on the value of the flag 'only_change_inv', the
1267
file will be moved on the file system or not.
1269
inv = self.inventory
1272
for entry in rename_entries:
1274
self._move_entry(entry)
1276
self._rollback_move(moved)
1280
def _rollback_move(self, moved):
1281
"""Try to rollback a previous move in case of an filesystem error."""
1282
inv = self.inventory
1285
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1286
entry.to_tail, entry.to_parent_id, entry.from_rel,
1287
entry.from_tail, entry.from_parent_id,
1288
entry.only_change_inv))
1289
except errors.BzrMoveFailedError, e:
1290
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1291
" The working tree is in an inconsistent state."
1292
" Please consider doing a 'bzr revert'."
1293
" Error message is: %s" % e)
1295
def _move_entry(self, entry):
1296
inv = self.inventory
1297
from_rel_abs = self.abspath(entry.from_rel)
1298
to_rel_abs = self.abspath(entry.to_rel)
1299
if from_rel_abs == to_rel_abs:
1300
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1301
"Source and target are identical.")
1303
if not entry.only_change_inv:
1305
osutils.rename(from_rel_abs, to_rel_abs)
1307
raise errors.BzrMoveFailedError(entry.from_rel,
1309
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1311
@needs_tree_write_lock
1312
def rename_one(self, from_rel, to_rel, after=False):
1315
This can change the directory or the filename or both.
1317
rename_one has several 'modes' to work. First, it can rename a physical
1318
file and change the file_id. That is the normal mode. Second, it can
1319
only change the file_id without touching any physical file. This is
1320
the new mode introduced in version 0.15.
1322
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1323
versioned but present in the working tree.
1325
rename_one uses the second mode if 'after == False' and 'from_rel' is
1326
versioned but no longer in the working tree, and 'to_rel' is not
1327
versioned but present in the working tree.
1329
rename_one uses the first mode if 'after == False' and 'from_rel' is
1330
versioned and present in the working tree, and 'to_rel' is not
1331
versioned and not present in the working tree.
1333
Everything else results in an error.
1335
inv = self.inventory
1338
# create rename entries and tuples
1339
from_tail = splitpath(from_rel)[-1]
1340
from_id = inv.path2id(from_rel)
1342
raise errors.BzrRenameFailedError(from_rel,to_rel,
1343
errors.NotVersionedError(path=str(from_rel)))
1344
from_entry = inv[from_id]
1345
from_parent_id = from_entry.parent_id
1346
to_dir, to_tail = os.path.split(to_rel)
1347
to_dir_id = inv.path2id(to_dir)
1348
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1350
from_tail=from_tail,
1351
from_parent_id=from_parent_id,
1352
to_rel=to_rel, to_tail=to_tail,
1353
to_parent_id=to_dir_id)
1354
rename_entries.append(rename_entry)
1356
# determine which move mode to use. checks also for movability
1357
rename_entries = self._determine_mv_mode(rename_entries, after)
1359
# check if the target changed directory and if the target directory is
1361
if to_dir_id is None:
1362
raise errors.BzrMoveFailedError(from_rel,to_rel,
1363
errors.NotVersionedError(path=str(to_dir)))
1365
# all checks done. now we can continue with our actual work
1366
mutter('rename_one:\n'
1371
' to_dir_id {%s}\n',
1372
from_id, from_rel, to_rel, to_dir, to_dir_id)
1374
self._move(rename_entries)
1375
self._write_inventory(inv)
1377
class _RenameEntry(object):
1378
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1379
to_rel, to_tail, to_parent_id, only_change_inv=False):
1380
self.from_rel = from_rel
1381
self.from_id = from_id
1382
self.from_tail = from_tail
1383
self.from_parent_id = from_parent_id
1384
self.to_rel = to_rel
1385
self.to_tail = to_tail
1386
self.to_parent_id = to_parent_id
1387
self.only_change_inv = only_change_inv
192
1390
def unknowns(self):
193
for subp in self.extras():
194
if not self.is_ignored(subp):
1391
"""Return all unknown files.
1393
These are files in the working directory that are not versioned or
1394
control files or ignored.
1396
# force the extras method to be fully executed before returning, to
1397
# prevent race conditions with the lock
1399
[subp for subp in self.extras() if not self.is_ignored(subp)])
1401
@needs_tree_write_lock
1402
def unversion(self, file_ids):
1403
"""Remove the file ids in file_ids from the current versioned set.
1405
When a file_id is unversioned, all of its children are automatically
1408
:param file_ids: The file ids to stop versioning.
1409
:raises: NoSuchId if any fileid is not currently versioned.
1411
for file_id in file_ids:
1412
file_id = osutils.safe_file_id(file_id)
1413
if self._inventory.has_id(file_id):
1414
self._inventory.remove_recursive_id(file_id)
1416
raise errors.NoSuchId(self, file_id)
1418
# in the future this should just set a dirty bit to wait for the
1419
# final unlock. However, until all methods of workingtree start
1420
# with the current in -memory inventory rather than triggering
1421
# a read, it is more complex - we need to teach read_inventory
1422
# to know when to read, and when to not read first... and possibly
1423
# to save first when the in memory one may be corrupted.
1424
# so for now, we just only write it if it is indeed dirty.
1426
self._write_inventory(self._inventory)
1428
@deprecated_method(zero_eight)
1429
def iter_conflicts(self):
1430
"""List all files in the tree that have text or content conflicts.
1431
DEPRECATED. Use conflicts instead."""
1432
return self._iter_conflicts()
1434
def _iter_conflicts(self):
1436
for info in self.list_files():
1438
stem = get_conflicted_stem(path)
1441
if stem not in conflicted:
1442
conflicted.add(stem)
1446
def pull(self, source, overwrite=False, stop_revision=None,
1447
change_reporter=None):
1448
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1451
pp = ProgressPhase("Pull phase", 2, top_pb)
1453
old_revision_info = self.branch.last_revision_info()
1454
basis_tree = self.basis_tree()
1455
count = self.branch.pull(source, overwrite, stop_revision)
1456
new_revision_info = self.branch.last_revision_info()
1457
if new_revision_info != old_revision_info:
1459
repository = self.branch.repository
1460
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1461
basis_tree.lock_read()
1463
new_basis_tree = self.branch.basis_tree()
1470
change_reporter=change_reporter)
1471
if (basis_tree.inventory.root is None and
1472
new_basis_tree.inventory.root is not None):
1473
self.set_root_id(new_basis_tree.inventory.root.file_id)
1477
# TODO - dedup parents list with things merged by pull ?
1478
# reuse the revisiontree we merged against to set the new
1480
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1481
# we have to pull the merge trees out again, because
1482
# merge_inner has set the ids. - this corner is not yet
1483
# layered well enough to prevent double handling.
1484
# XXX TODO: Fix the double handling: telling the tree about
1485
# the already known parent data is wasteful.
1486
merges = self.get_parent_ids()[1:]
1487
parent_trees.extend([
1488
(parent, repository.revision_tree(parent)) for
1490
self.set_parent_trees(parent_trees)
1497
def put_file_bytes_non_atomic(self, file_id, bytes):
1498
"""See MutableTree.put_file_bytes_non_atomic."""
1499
file_id = osutils.safe_file_id(file_id)
1500
stream = file(self.id2abspath(file_id), 'wb')
1505
# TODO: update the hashcache here ?
198
1507
def extras(self):
199
"""Yield all unknown files in this WorkingTree.
1508
"""Yield all unversioned files in this WorkingTree.
201
If there are any unknown directories then only the directory is
202
returned, not all its children. But if there are unknown files
1510
If there are any unversioned directories then only the directory is
1511
returned, not all its children. But if there are unversioned files
203
1512
under a versioned subdirectory, they are returned.
205
1514
Currently returned depth-first, sorted by name within directories.
1515
This is the same order used by 'osutils.walkdirs'.
207
1517
## TODO: Work from given directory downwards
208
from osutils import isdir, appendpath
210
1518
for path, dir_entry in self.inventory.directories():
211
mutter("search for unknowns in %r" % path)
1519
# mutter("search for unknowns in %r", path)
212
1520
dirabs = self.abspath(path)
213
1521
if not isdir(dirabs):
214
1522
# e.g. directory deleted
259
1581
If the file is ignored, returns the pattern which caused it to
260
1582
be ignored, otherwise None. So this can simply be used as a
261
1583
boolean if desired."""
263
# TODO: Use '**' to match directories, and other extended
264
# globbing stuff from cvs/rsync.
266
# XXX: fnmatch is actually not quite what we want: it's only
267
# approximately the same as real Unix fnmatch, and doesn't
268
# treat dotfiles correctly and allows * to match /.
269
# Eventually it should be replaced with something more
273
from osutils import splitpath
275
for pat in self.get_ignore_list():
276
if '/' in pat or '\\' in pat:
278
# as a special case, you can put ./ at the start of a
279
# pattern; this is good to match in the top-level
282
if (pat[:2] == './') or (pat[:2] == '.\\'):
286
if fnmatch.fnmatchcase(filename, newpat):
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1584
if getattr(self, '_ignoreglobster', None) is None:
1585
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1586
return self._ignoreglobster.match(filename)
1588
def kind(self, file_id):
1589
return file_kind(self.id2abspath(file_id))
1591
def _comparison_data(self, entry, path):
1592
abspath = self.abspath(path)
1594
stat_value = os.lstat(abspath)
1596
if getattr(e, 'errno', None) == errno.ENOENT:
1603
mode = stat_value.st_mode
1604
kind = osutils.file_kind_from_stat_mode(mode)
1605
if not supports_executable():
1606
executable = entry.executable
1608
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1609
return kind, executable, stat_value
1611
def _file_size(self, entry, stat_value):
1612
return stat_value.st_size
1614
def last_revision(self):
1615
"""Return the last revision of the branch for this tree.
1617
This format tree does not support a separate marker for last-revision
1618
compared to the branch.
1620
See MutableTree.last_revision
1622
return self._last_revision()
1625
def _last_revision(self):
1626
"""helper for get_parent_ids."""
1627
return self.branch.last_revision()
1629
def is_locked(self):
1630
return self._control_files.is_locked()
1632
def _must_be_locked(self):
1633
if not self.is_locked():
1634
raise errors.ObjectNotLocked(self)
1636
def lock_read(self):
1637
"""See Branch.lock_read, and WorkingTree.unlock."""
1638
if not self.is_locked():
1640
self.branch.lock_read()
1642
return self._control_files.lock_read()
1644
self.branch.unlock()
1647
def lock_tree_write(self):
1648
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1649
if not self.is_locked():
1651
self.branch.lock_read()
1653
return self._control_files.lock_write()
1655
self.branch.unlock()
1658
def lock_write(self):
1659
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1660
if not self.is_locked():
1662
self.branch.lock_write()
1664
return self._control_files.lock_write()
1666
self.branch.unlock()
1669
def get_physical_lock_status(self):
1670
return self._control_files.get_physical_lock_status()
1672
def _basis_inventory_name(self):
1673
return 'basis-inventory-cache'
1675
def _reset_data(self):
1676
"""Reset transient data that cannot be revalidated."""
1677
self._inventory_is_modified = False
1678
result = self._deserialize(self._control_files.get('inventory'))
1679
self._set_inventory(result, dirty=False)
1681
@needs_tree_write_lock
1682
def set_last_revision(self, new_revision):
1683
"""Change the last revision in the working tree."""
1684
new_revision = osutils.safe_revision_id(new_revision)
1685
if self._change_last_revision(new_revision):
1686
self._cache_basis_inventory(new_revision)
1688
def _change_last_revision(self, new_revision):
1689
"""Template method part of set_last_revision to perform the change.
1691
This is used to allow WorkingTree3 instances to not affect branch
1692
when their last revision is set.
1694
if new_revision is None:
1695
self.branch.set_revision_history([])
1698
self.branch.generate_revision_history(new_revision)
1699
except errors.NoSuchRevision:
1700
# not present in the repo - dont try to set it deeper than the tip
1701
self.branch.set_revision_history([new_revision])
1704
def _write_basis_inventory(self, xml):
1705
"""Write the basis inventory XML to the basis-inventory file"""
1706
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1707
path = self._basis_inventory_name()
1709
self._control_files.put(path, sio)
1711
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1712
"""Create the text that will be saved in basis-inventory"""
1713
# TODO: jam 20070209 This should be redundant, as the revision_id
1714
# as all callers should have already converted the revision_id to
1716
inventory.revision_id = osutils.safe_revision_id(revision_id)
1717
return xml7.serializer_v7.write_inventory_to_string(inventory)
1719
def _cache_basis_inventory(self, new_revision):
1720
"""Cache new_revision as the basis inventory."""
1721
# TODO: this should allow the ready-to-use inventory to be passed in,
1722
# as commit already has that ready-to-use [while the format is the
1725
# this double handles the inventory - unpack and repack -
1726
# but is easier to understand. We can/should put a conditional
1727
# in here based on whether the inventory is in the latest format
1728
# - perhaps we should repack all inventories on a repository
1730
# the fast path is to copy the raw xml from the repository. If the
1731
# xml contains 'revision_id="', then we assume the right
1732
# revision_id is set. We must check for this full string, because a
1733
# root node id can legitimately look like 'revision_id' but cannot
1735
xml = self.branch.repository.get_inventory_xml(new_revision)
1736
firstline = xml.split('\n', 1)[0]
1737
if (not 'revision_id="' in firstline or
1738
'format="7"' not in firstline):
1739
inv = self.branch.repository.deserialise_inventory(
1741
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1742
self._write_basis_inventory(xml)
1743
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1746
def read_basis_inventory(self):
1747
"""Read the cached basis inventory."""
1748
path = self._basis_inventory_name()
1749
return self._control_files.get(path).read()
1752
def read_working_inventory(self):
1753
"""Read the working inventory.
1755
:raises errors.InventoryModified: read_working_inventory will fail
1756
when the current in memory inventory has been modified.
1758
# conceptually this should be an implementation detail of the tree.
1759
# XXX: Deprecate this.
1760
# ElementTree does its own conversion from UTF-8, so open in
1762
if self._inventory_is_modified:
1763
raise errors.InventoryModified(self)
1764
result = self._deserialize(self._control_files.get('inventory'))
1765
self._set_inventory(result, dirty=False)
1768
@needs_tree_write_lock
1769
def remove(self, files, verbose=False, to_file=None, delete_files=False):
1770
"""Remove nominated files from the working inventory..
1772
TODO: Refuse to remove modified files unless --force is given?
1774
TODO: Do something useful with directories.
1776
:delete_files: If true, the files will also be delete.
1777
At present recursion is not supported.
1779
## TODO: Normalize names
1780
## TODO: Remove nested loops; better scalability
1781
if isinstance(files, basestring):
1784
inv = self.inventory
1786
# Sort needed when deleting files:
1787
# first delete directory content before the directory
1790
files.sort(reverse=True)
1792
# do this before any modifications
1794
fid = inv.path2id(f)
1797
message="%s is not versioned."%f
1800
# having remove it, it must be either ignored or unknown
1801
if self.is_ignored(f):
1805
textui.show_status(new_status, inv[fid].kind, f,
1808
message="removed %s"%f
1810
if osutils.lexists(f):
1811
osutils.delete_any(f)
1812
message="deleted %s"%f
1814
message="%s does not exist."%f
1815
# print only one message per file.
1816
if message is not None:
1818
self._write_inventory(inv)
1820
@needs_tree_write_lock
1821
def revert(self, filenames, old_tree=None, backups=True,
1822
pb=DummyProgress(), report_changes=False):
1823
from bzrlib.conflicts import resolve
1824
if old_tree is None:
1825
old_tree = self.basis_tree()
1826
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1828
if not len(filenames):
1829
self.set_parent_ids(self.get_parent_ids()[:1])
1832
resolve(self, filenames, ignore_misses=True)
1835
def revision_tree(self, revision_id):
1836
"""See Tree.revision_tree.
1838
WorkingTree can supply revision_trees for the basis revision only
1839
because there is only one cached inventory in the bzr directory.
1841
if revision_id == self.last_revision():
1843
xml = self.read_basis_inventory()
1844
except errors.NoSuchFile:
1848
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1849
# dont use the repository revision_tree api because we want
1850
# to supply the inventory.
1851
if inv.revision_id == revision_id:
1852
return revisiontree.RevisionTree(self.branch.repository,
1854
except errors.BadInventoryFormat:
1856
# raise if there was no inventory, or if we read the wrong inventory.
1857
raise errors.NoSuchRevisionInTree(self, revision_id)
1859
# XXX: This method should be deprecated in favour of taking in a proper
1860
# new Inventory object.
1861
@needs_tree_write_lock
1862
def set_inventory(self, new_inventory_list):
1863
from bzrlib.inventory import (Inventory,
1868
inv = Inventory(self.get_root_id())
1869
for path, file_id, parent, kind in new_inventory_list:
1870
name = os.path.basename(path)
1873
# fixme, there should be a factory function inv,add_??
1874
if kind == 'directory':
1875
inv.add(InventoryDirectory(file_id, name, parent))
1876
elif kind == 'file':
1877
inv.add(InventoryFile(file_id, name, parent))
1878
elif kind == 'symlink':
1879
inv.add(InventoryLink(file_id, name, parent))
1881
raise errors.BzrError("unknown kind %r" % kind)
1882
self._write_inventory(inv)
1884
@needs_tree_write_lock
1885
def set_root_id(self, file_id):
1886
"""Set the root id for this tree."""
1889
symbol_versioning.warn(symbol_versioning.zero_twelve
1890
% 'WorkingTree.set_root_id with fileid=None',
1895
file_id = osutils.safe_file_id(file_id)
1896
self._set_root_id(file_id)
1898
def _set_root_id(self, file_id):
1899
"""Set the root id for this tree, in a format specific manner.
1901
:param file_id: The file id to assign to the root. It must not be
1902
present in the current inventory or an error will occur. It must
1903
not be None, but rather a valid file id.
1905
inv = self._inventory
1906
orig_root_id = inv.root.file_id
1907
# TODO: it might be nice to exit early if there was nothing
1908
# to do, saving us from trigger a sync on unlock.
1909
self._inventory_is_modified = True
1910
# we preserve the root inventory entry object, but
1911
# unlinkit from the byid index
1912
del inv._byid[inv.root.file_id]
1913
inv.root.file_id = file_id
1914
# and link it into the index with the new changed id.
1915
inv._byid[inv.root.file_id] = inv.root
1916
# and finally update all children to reference the new id.
1917
# XXX: this should be safe to just look at the root.children
1918
# list, not the WHOLE INVENTORY.
1921
if entry.parent_id == orig_root_id:
1922
entry.parent_id = inv.root.file_id
1925
"""See Branch.unlock.
1927
WorkingTree locking just uses the Branch locking facilities.
1928
This is current because all working trees have an embedded branch
1929
within them. IF in the future, we were to make branch data shareable
1930
between multiple working trees, i.e. via shared storage, then we
1931
would probably want to lock both the local tree, and the branch.
1933
raise NotImplementedError(self.unlock)
1936
"""Update a working tree along its branch.
1938
This will update the branch if its bound too, which means we have
1939
multiple trees involved:
1941
- The new basis tree of the master.
1942
- The old basis tree of the branch.
1943
- The old basis tree of the working tree.
1944
- The current working tree state.
1946
Pathologically, all three may be different, and non-ancestors of each
1947
other. Conceptually we want to:
1949
- Preserve the wt.basis->wt.state changes
1950
- Transform the wt.basis to the new master basis.
1951
- Apply a merge of the old branch basis to get any 'local' changes from
1953
- Restore the wt.basis->wt.state changes.
1955
There isn't a single operation at the moment to do that, so we:
1956
- Merge current state -> basis tree of the master w.r.t. the old tree
1958
- Do a 'normal' merge of the old branch basis if it is relevant.
1960
if self.branch.get_master_branch() is not None:
1962
update_branch = True
1964
self.lock_tree_write()
1965
update_branch = False
1968
old_tip = self.branch.update()
1971
return self._update_tree(old_tip)
1975
@needs_tree_write_lock
1976
def _update_tree(self, old_tip=None):
1977
"""Update a tree to the master branch.
1979
:param old_tip: if supplied, the previous tip revision the branch,
1980
before it was changed to the master branch's tip.
1982
# here if old_tip is not None, it is the old tip of the branch before
1983
# it was updated from the master branch. This should become a pending
1984
# merge in the working tree to preserve the user existing work. we
1985
# cant set that until we update the working trees last revision to be
1986
# one from the new branch, because it will just get absorbed by the
1987
# parent de-duplication logic.
1989
# We MUST save it even if an error occurs, because otherwise the users
1990
# local work is unreferenced and will appear to have been lost.
1994
last_rev = self.get_parent_ids()[0]
1997
if last_rev != self.branch.last_revision():
1998
# merge tree state up to new branch tip.
1999
basis = self.basis_tree()
2002
to_tree = self.branch.basis_tree()
2003
if basis.inventory.root is None:
2004
self.set_root_id(to_tree.inventory.root.file_id)
2006
result += merge.merge_inner(
2013
# TODO - dedup parents list with things merged by pull ?
2014
# reuse the tree we've updated to to set the basis:
2015
parent_trees = [(self.branch.last_revision(), to_tree)]
2016
merges = self.get_parent_ids()[1:]
2017
# Ideally we ask the tree for the trees here, that way the working
2018
# tree can decide whether to give us teh entire tree or give us a
2019
# lazy initialised tree. dirstate for instance will have the trees
2020
# in ram already, whereas a last-revision + basis-inventory tree
2021
# will not, but also does not need them when setting parents.
2022
for parent in merges:
2023
parent_trees.append(
2024
(parent, self.branch.repository.revision_tree(parent)))
2025
if old_tip is not None:
2026
parent_trees.append(
2027
(old_tip, self.branch.repository.revision_tree(old_tip)))
2028
self.set_parent_trees(parent_trees)
2029
last_rev = parent_trees[0][0]
2031
# the working tree had the same last-revision as the master
2032
# branch did. We may still have pivot local work from the local
2033
# branch into old_tip:
2034
if old_tip is not None:
2035
self.add_parent_tree_id(old_tip)
2036
if old_tip and old_tip != last_rev:
2037
# our last revision was not the prior branch last revision
2038
# and we have converted that last revision to a pending merge.
2039
# base is somewhere between the branch tip now
2040
# and the now pending merge
2042
# Since we just modified the working tree and inventory, flush out
2043
# the current state, before we modify it again.
2044
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2045
# requires it only because TreeTransform directly munges the
2046
# inventory and calls tree._write_inventory(). Ultimately we
2047
# should be able to remove this extra flush.
2049
from bzrlib.revision import common_ancestor
2051
base_rev_id = common_ancestor(self.branch.last_revision(),
2053
self.branch.repository)
2054
except errors.NoCommonAncestor:
2056
base_tree = self.branch.repository.revision_tree(base_rev_id)
2057
other_tree = self.branch.repository.revision_tree(old_tip)
2058
result += merge.merge_inner(
2065
def _write_hashcache_if_dirty(self):
2066
"""Write out the hashcache if it is dirty."""
2067
if self._hashcache.needs_write:
2069
self._hashcache.write()
2071
if e.errno not in (errno.EPERM, errno.EACCES):
2073
# TODO: jam 20061219 Should this be a warning? A single line
2074
# warning might be sufficient to let the user know what
2076
mutter('Could not write hashcache for %s\nError: %s',
2077
self._hashcache.cache_file_name(), e)
2079
@needs_tree_write_lock
2080
def _write_inventory(self, inv):
2081
"""Write inventory as the current inventory."""
2082
self._set_inventory(inv, dirty=True)
2085
def set_conflicts(self, arg):
2086
raise errors.UnsupportedOperation(self.set_conflicts, self)
2088
def add_conflicts(self, arg):
2089
raise errors.UnsupportedOperation(self.add_conflicts, self)
2092
def conflicts(self):
2093
conflicts = _mod_conflicts.ConflictList()
2094
for conflicted in self._iter_conflicts():
2097
if file_kind(self.abspath(conflicted)) != "file":
2099
except errors.NoSuchFile:
2102
for suffix in ('.THIS', '.OTHER'):
2104
kind = file_kind(self.abspath(conflicted+suffix))
2107
except errors.NoSuchFile:
2111
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2112
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2114
file_id=self.path2id(conflicted)))
2117
def walkdirs(self, prefix=""):
2118
"""Walk the directories of this tree.
2120
This API returns a generator, which is only valid during the current
2121
tree transaction - within a single lock_read or lock_write duration.
2123
If the tree is not locked, it may cause an error to be raised, depending
2124
on the tree implementation.
2126
disk_top = self.abspath(prefix)
2127
if disk_top.endswith('/'):
2128
disk_top = disk_top[:-1]
2129
top_strip_len = len(disk_top) + 1
2130
inventory_iterator = self._walkdirs(prefix)
2131
disk_iterator = osutils.walkdirs(disk_top, prefix)
2133
current_disk = disk_iterator.next()
2134
disk_finished = False
2136
if e.errno != errno.ENOENT:
2139
disk_finished = True
2141
current_inv = inventory_iterator.next()
2142
inv_finished = False
2143
except StopIteration:
2146
while not inv_finished or not disk_finished:
2147
if not disk_finished:
2148
# strip out .bzr dirs
2149
if current_disk[0][1][top_strip_len:] == '':
2150
# osutils.walkdirs can be made nicer -
2151
# yield the path-from-prefix rather than the pathjoined
2153
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2154
if current_disk[1][bzrdir_loc][0] == '.bzr':
2155
# we dont yield the contents of, or, .bzr itself.
2156
del current_disk[1][bzrdir_loc]
2158
# everything is unknown
2161
# everything is missing
2164
direction = cmp(current_inv[0][0], current_disk[0][0])
2166
# disk is before inventory - unknown
2167
dirblock = [(relpath, basename, kind, stat, None, None) for
2168
relpath, basename, kind, stat, top_path in current_disk[1]]
2169
yield (current_disk[0][0], None), dirblock
2171
current_disk = disk_iterator.next()
2172
except StopIteration:
2173
disk_finished = True
2175
# inventory is before disk - missing.
2176
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2177
for relpath, basename, dkind, stat, fileid, kind in
2179
yield (current_inv[0][0], current_inv[0][1]), dirblock
2181
current_inv = inventory_iterator.next()
2182
except StopIteration:
2185
# versioned present directory
2186
# merge the inventory and disk data together
2188
for relpath, subiterator in itertools.groupby(sorted(
2189
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2190
path_elements = list(subiterator)
2191
if len(path_elements) == 2:
2192
inv_row, disk_row = path_elements
2193
# versioned, present file
2194
dirblock.append((inv_row[0],
2195
inv_row[1], disk_row[2],
2196
disk_row[3], inv_row[4],
2198
elif len(path_elements[0]) == 5:
2200
dirblock.append((path_elements[0][0],
2201
path_elements[0][1], path_elements[0][2],
2202
path_elements[0][3], None, None))
2203
elif len(path_elements[0]) == 6:
2204
# versioned, absent file.
2205
dirblock.append((path_elements[0][0],
2206
path_elements[0][1], 'unknown', None,
2207
path_elements[0][4], path_elements[0][5]))
2209
raise NotImplementedError('unreachable code')
2210
yield current_inv[0], dirblock
2212
current_inv = inventory_iterator.next()
2213
except StopIteration:
2216
current_disk = disk_iterator.next()
2217
except StopIteration:
2218
disk_finished = True
2220
def _walkdirs(self, prefix=""):
2221
_directory = 'directory'
2222
# get the root in the inventory
2223
inv = self.inventory
2224
top_id = inv.path2id(prefix)
2228
pending = [(prefix, '', _directory, None, top_id, None)]
2231
currentdir = pending.pop()
2232
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2233
top_id = currentdir[4]
2235
relroot = currentdir[0] + '/'
2238
# FIXME: stash the node in pending
2240
for name, child in entry.sorted_children():
2241
dirblock.append((relroot + name, name, child.kind, None,
2242
child.file_id, child.kind
2244
yield (currentdir[0], entry.file_id), dirblock
2245
# push the user specified dirs from dirblock
2246
for dir in reversed(dirblock):
2247
if dir[2] == _directory:
2250
@needs_tree_write_lock
2251
def auto_resolve(self):
2252
"""Automatically resolve text conflicts according to contents.
2254
Only text conflicts are auto_resolvable. Files with no conflict markers
2255
are considered 'resolved', because bzr always puts conflict markers
2256
into files that have text conflicts. The corresponding .THIS .BASE and
2257
.OTHER files are deleted, as per 'resolve'.
2258
:return: a tuple of ConflictLists: (un_resolved, resolved).
2260
un_resolved = _mod_conflicts.ConflictList()
2261
resolved = _mod_conflicts.ConflictList()
2262
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2263
for conflict in self.conflicts():
2264
if (conflict.typestring != 'text conflict' or
2265
self.kind(conflict.file_id) != 'file'):
2266
un_resolved.append(conflict)
2268
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2270
for line in my_file:
2271
if conflict_re.search(line):
2272
un_resolved.append(conflict)
2275
resolved.append(conflict)
2278
resolved.remove_files(self)
2279
self.set_conflicts(un_resolved)
2280
return un_resolved, resolved
2283
class WorkingTree2(WorkingTree):
2284
"""This is the Format 2 working tree.
2286
This was the first weave based working tree.
2287
- uses os locks for locking.
2288
- uses the branch last-revision.
2291
def __init__(self, *args, **kwargs):
2292
super(WorkingTree2, self).__init__(*args, **kwargs)
2293
# WorkingTree2 has more of a constraint that self._inventory must
2294
# exist. Because this is an older format, we don't mind the overhead
2295
# caused by the extra computation here.
2297
# Newer WorkingTree's should only have self._inventory set when they
2299
if self._inventory is None:
2300
self.read_working_inventory()
2302
def lock_tree_write(self):
2303
"""See WorkingTree.lock_tree_write().
2305
In Format2 WorkingTrees we have a single lock for the branch and tree
2306
so lock_tree_write() degrades to lock_write().
2308
self.branch.lock_write()
2310
return self._control_files.lock_write()
2312
self.branch.unlock()
2316
# we share control files:
2317
if self._control_files._lock_count == 3:
2318
# _inventory_is_modified is always False during a read lock.
2319
if self._inventory_is_modified:
2321
self._write_hashcache_if_dirty()
2323
# reverse order of locking.
2325
return self._control_files.unlock()
2327
self.branch.unlock()
2330
class WorkingTree3(WorkingTree):
2331
"""This is the Format 3 working tree.
2333
This differs from the base WorkingTree by:
2334
- having its own file lock
2335
- having its own last-revision property.
2337
This is new in bzr 0.8
2341
def _last_revision(self):
2342
"""See Mutable.last_revision."""
2344
return osutils.safe_revision_id(
2345
self._control_files.get('last-revision').read())
2346
except errors.NoSuchFile:
b'\\ No newline at end of file'
2349
def _change_last_revision(self, revision_id):
2350
"""See WorkingTree._change_last_revision."""
2351
if revision_id is None or revision_id == NULL_REVISION:
2353
self._control_files._transport.delete('last-revision')
2354
except errors.NoSuchFile:
2358
self._control_files.put_bytes('last-revision', revision_id)
2361
@needs_tree_write_lock
2362
def set_conflicts(self, conflicts):
2363
self._put_rio('conflicts', conflicts.to_stanzas(),
2366
@needs_tree_write_lock
2367
def add_conflicts(self, new_conflicts):
2368
conflict_set = set(self.conflicts())
2369
conflict_set.update(set(list(new_conflicts)))
2370
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2371
key=_mod_conflicts.Conflict.sort_key)))
2374
def conflicts(self):
2376
confile = self._control_files.get('conflicts')
2377
except errors.NoSuchFile:
2378
return _mod_conflicts.ConflictList()
2380
if confile.next() != CONFLICT_HEADER_1 + '\n':
2381
raise errors.ConflictFormatError()
2382
except StopIteration:
2383
raise errors.ConflictFormatError()
2384
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2387
if self._control_files._lock_count == 1:
2388
# _inventory_is_modified is always False during a read lock.
2389
if self._inventory_is_modified:
2391
self._write_hashcache_if_dirty()
2392
# reverse order of locking.
2394
return self._control_files.unlock()
2396
self.branch.unlock()
2399
def get_conflicted_stem(path):
2400
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2401
if path.endswith(suffix):
2402
return path[:-len(suffix)]
2405
@deprecated_function(zero_eight)
2406
def is_control_file(filename):
2407
"""See WorkingTree.is_control_filename(filename)."""
2408
## FIXME: better check
2409
filename = normpath(filename)
2410
while filename != '':
2411
head, tail = os.path.split(filename)
2412
## mutter('check %r for control file' % ((head, tail),))
2415
if filename == head:
2421
class WorkingTreeFormat(object):
2422
"""An encapsulation of the initialization and open routines for a format.
2424
Formats provide three things:
2425
* An initialization routine,
2429
Formats are placed in an dict by their format string for reference
2430
during workingtree opening. Its not required that these be instances, they
2431
can be classes themselves with class methods - it simply depends on
2432
whether state is needed for a given format or not.
2434
Once a format is deprecated, just deprecate the initialize and open
2435
methods on the format class. Do not deprecate the object, as the
2436
object will be created every time regardless.
2439
_default_format = None
2440
"""The default format used for new trees."""
2443
"""The known formats."""
2445
requires_rich_root = False
2448
def find_format(klass, a_bzrdir):
2449
"""Return the format for the working tree object in a_bzrdir."""
2451
transport = a_bzrdir.get_workingtree_transport(None)
2452
format_string = transport.get("format").read()
2453
return klass._formats[format_string]
2454
except errors.NoSuchFile:
2455
raise errors.NoWorkingTree(base=transport.base)
2457
raise errors.UnknownFormatError(format=format_string)
2459
def __eq__(self, other):
2460
return self.__class__ is other.__class__
2462
def __ne__(self, other):
2463
return not (self == other)
2466
def get_default_format(klass):
2467
"""Return the current default format."""
2468
return klass._default_format
2470
def get_format_string(self):
2471
"""Return the ASCII format string that identifies this format."""
2472
raise NotImplementedError(self.get_format_string)
2474
def get_format_description(self):
2475
"""Return the short description for this format."""
2476
raise NotImplementedError(self.get_format_description)
2478
def is_supported(self):
2479
"""Is this format supported?
2481
Supported formats can be initialized and opened.
2482
Unsupported formats may not support initialization or committing or
2483
some other features depending on the reason for not being supported.
2488
def register_format(klass, format):
2489
klass._formats[format.get_format_string()] = format
2492
def set_default_format(klass, format):
2493
klass._default_format = format
2496
def unregister_format(klass, format):
2497
assert klass._formats[format.get_format_string()] is format
2498
del klass._formats[format.get_format_string()]
2502
class WorkingTreeFormat2(WorkingTreeFormat):
2503
"""The second working tree format.
2505
This format modified the hash cache from the format 1 hash cache.
2508
def get_format_description(self):
2509
"""See WorkingTreeFormat.get_format_description()."""
2510
return "Working tree format 2"
2512
def stub_initialize_remote(self, control_files):
2513
"""As a special workaround create critical control files for a remote working tree
2515
This ensures that it can later be updated and dealt with locally,
2516
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2517
no working tree. (See bug #43064).
2521
xml5.serializer_v5.write_inventory(inv, sio)
2523
control_files.put('inventory', sio)
2525
control_files.put_bytes('pending-merges', '')
2528
def initialize(self, a_bzrdir, revision_id=None):
2529
"""See WorkingTreeFormat.initialize()."""
2530
if not isinstance(a_bzrdir.transport, LocalTransport):
2531
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2532
branch = a_bzrdir.open_branch()
2533
if revision_id is not None:
2534
revision_id = osutils.safe_revision_id(revision_id)
2537
revision_history = branch.revision_history()
2539
position = revision_history.index(revision_id)
2541
raise errors.NoSuchRevision(branch, revision_id)
2542
branch.set_revision_history(revision_history[:position + 1])
2545
revision = branch.last_revision()
2547
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2553
basis_tree = branch.repository.revision_tree(revision)
2554
if basis_tree.inventory.root is not None:
2555
wt.set_root_id(basis_tree.inventory.root.file_id)
2556
# set the parent list and cache the basis tree.
2557
wt.set_parent_trees([(revision, basis_tree)])
2558
transform.build_tree(basis_tree, wt)
2562
super(WorkingTreeFormat2, self).__init__()
2563
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2565
def open(self, a_bzrdir, _found=False):
2566
"""Return the WorkingTree object for a_bzrdir
2568
_found is a private parameter, do not use it. It is used to indicate
2569
if format probing has already been done.
2572
# we are being called directly and must probe.
2573
raise NotImplementedError
2574
if not isinstance(a_bzrdir.transport, LocalTransport):
2575
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2576
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2582
class WorkingTreeFormat3(WorkingTreeFormat):
2583
"""The second working tree format updated to record a format marker.
2586
- exists within a metadir controlling .bzr
2587
- includes an explicit version marker for the workingtree control
2588
files, separate from the BzrDir format
2589
- modifies the hash cache format
2591
- uses a LockDir to guard access for writes.
2594
def get_format_string(self):
2595
"""See WorkingTreeFormat.get_format_string()."""
2596
return "Bazaar-NG Working Tree format 3"
2598
def get_format_description(self):
2599
"""See WorkingTreeFormat.get_format_description()."""
2600
return "Working tree format 3"
2602
_lock_file_name = 'lock'
2603
_lock_class = LockDir
2605
_tree_class = WorkingTree3
2607
def __get_matchingbzrdir(self):
2608
return bzrdir.BzrDirMetaFormat1()
2610
_matchingbzrdir = property(__get_matchingbzrdir)
2612
def _open_control_files(self, a_bzrdir):
2613
transport = a_bzrdir.get_workingtree_transport(None)
2614
return LockableFiles(transport, self._lock_file_name,
2617
def initialize(self, a_bzrdir, revision_id=None):
2618
"""See WorkingTreeFormat.initialize().
2620
revision_id allows creating a working tree at a different
2621
revision than the branch is at.
2623
if not isinstance(a_bzrdir.transport, LocalTransport):
2624
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2625
transport = a_bzrdir.get_workingtree_transport(self)
2626
control_files = self._open_control_files(a_bzrdir)
2627
control_files.create_lock()
2628
control_files.lock_write()
2629
control_files.put_utf8('format', self.get_format_string())
2630
branch = a_bzrdir.open_branch()
2631
if revision_id is None:
2632
revision_id = branch.last_revision()
2634
revision_id = osutils.safe_revision_id(revision_id)
2635
# WorkingTree3 can handle an inventory which has a unique root id.
2636
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2637
# those trees. And because there isn't a format bump inbetween, we
2638
# are maintaining compatibility with older clients.
2639
# inv = Inventory(root_id=gen_root_id())
2640
inv = self._initial_inventory()
2641
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2647
_control_files=control_files)
2648
wt.lock_tree_write()
2650
basis_tree = branch.repository.revision_tree(revision_id)
2651
# only set an explicit root id if there is one to set.
2652
if basis_tree.inventory.root is not None:
2653
wt.set_root_id(basis_tree.inventory.root.file_id)
2654
if revision_id == NULL_REVISION:
2655
wt.set_parent_trees([])
2657
wt.set_parent_trees([(revision_id, basis_tree)])
2658
transform.build_tree(basis_tree, wt)
2660
# Unlock in this order so that the unlock-triggers-flush in
2661
# WorkingTree is given a chance to fire.
2662
control_files.unlock()
2666
def _initial_inventory(self):
2670
super(WorkingTreeFormat3, self).__init__()
2672
def open(self, a_bzrdir, _found=False):
2673
"""Return the WorkingTree object for a_bzrdir
2675
_found is a private parameter, do not use it. It is used to indicate
2676
if format probing has already been done.
2679
# we are being called directly and must probe.
2680
raise NotImplementedError
2681
if not isinstance(a_bzrdir.transport, LocalTransport):
2682
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2683
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2685
def _open(self, a_bzrdir, control_files):
2686
"""Open the tree itself.
2688
:param a_bzrdir: the dir for the tree.
2689
:param control_files: the control files for the tree.
2691
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2695
_control_files=control_files)
2698
return self.get_format_string()
2701
__default_format = WorkingTreeFormat4()
2702
WorkingTreeFormat.register_format(__default_format)
2703
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2704
WorkingTreeFormat.set_default_format(__default_format)
2705
# formats which have no format string are not discoverable
2706
# and not independently creatable, so are not registered.
2707
_legacy_formats = [WorkingTreeFormat2(),
2711
class WorkingTreeTestProviderAdapter(object):
2712
"""A tool to generate a suite testing multiple workingtree formats at once.
2714
This is done by copying the test once for each transport and injecting
2715
the transport_server, transport_readonly_server, and workingtree_format
2716
classes into each copy. Each copy is also given a new id() to make it
2720
def __init__(self, transport_server, transport_readonly_server, formats):
2721
self._transport_server = transport_server
2722
self._transport_readonly_server = transport_readonly_server
2723
self._formats = formats
2725
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2726
"""Clone test for adaption."""
2727
new_test = deepcopy(test)
2728
new_test.transport_server = self._transport_server
2729
new_test.transport_readonly_server = self._transport_readonly_server
2730
new_test.bzrdir_format = bzrdir_format
2731
new_test.workingtree_format = workingtree_format
2732
def make_new_test_id():
2733
new_id = "%s(%s)" % (test.id(), variation)
2734
return lambda: new_id
2735
new_test.id = make_new_test_id()
2738
def adapt(self, test):
2739
from bzrlib.tests import TestSuite
2740
result = TestSuite()
2741
for workingtree_format, bzrdir_format in self._formats:
2742
new_test = self._clone_test(
2745
workingtree_format, workingtree_format.__class__.__name__)
2746
result.addTest(new_test)