70
362
inv = self._inventory
71
363
for path, ie in inv.iter_entries():
72
if os.path.exists(self.abspath(path)):
364
if osutils.lexists(self.abspath(path)):
367
def all_file_ids(self):
368
"""See Tree.iter_all_file_ids"""
369
return set(self.inventory)
76
371
def __repr__(self):
77
372
return "<%s of %s>" % (self.__class__.__name__,
78
373
getattr(self, 'basedir', None))
82
375
def abspath(self, filename):
83
return os.path.join(self.basedir, filename)
376
return pathjoin(self.basedir, filename)
378
def basis_tree(self):
379
"""Return RevisionTree for the current last revision.
381
If the left most parent is a ghost then the returned tree will be an
382
empty tree - one obtained by calling
383
repository.revision_tree(NULL_REVISION).
386
revision_id = self.get_parent_ids()[0]
388
# no parents, return an empty revision tree.
389
# in the future this should return the tree for
390
# 'empty:' - the implicit root empty tree.
391
return self.branch.repository.revision_tree(
392
_mod_revision.NULL_REVISION)
394
return self.revision_tree(revision_id)
395
except errors.NoSuchRevision:
397
# No cached copy available, retrieve from the repository.
398
# FIXME? RBC 20060403 should we cache the inventory locally
401
return self.branch.repository.revision_tree(revision_id)
402
except (errors.RevisionNotPresent, errors.NoSuchRevision):
403
# the basis tree *may* be a ghost or a low level error may have
404
# occured. If the revision is present, its a problem, if its not
406
if self.branch.repository.has_revision(revision_id):
408
# the basis tree is a ghost so return an empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
413
self._flush_ignore_list_cache()
415
def relpath(self, path):
416
"""Return the local path portion from a given path.
418
The path may be absolute or relative. If its a relative path it is
419
interpreted relative to the python current working directory.
421
return osutils.relpath(self.basedir, path)
85
423
def has_filename(self, filename):
86
return os.path.exists(self.abspath(filename))
88
def get_file(self, file_id):
89
return self.get_file_byname(self.id2path(file_id))
424
return osutils.lexists(self.abspath(filename))
426
def get_file(self, file_id, path=None):
427
return self.get_file_with_stat(file_id, path)[0]
429
def get_file_with_stat(self, file_id, path=None, _fstat=os.fstat):
430
"""See MutableTree.get_file_with_stat."""
432
path = self.id2path(file_id)
433
file_obj = self.get_file_byname(path)
434
return (file_obj, _fstat(file_obj.fileno()))
436
def get_file_text(self, file_id):
437
return self.get_file(file_id).read()
91
439
def get_file_byname(self, filename):
92
440
return file(self.abspath(filename), 'rb')
443
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
444
"""See Tree.annotate_iter
446
This implementation will use the basis tree implementation if possible.
447
Lines not in the basis are attributed to CURRENT_REVISION
449
If there are pending merges, lines added by those merges will be
450
incorrectly attributed to CURRENT_REVISION (but after committing, the
451
attribution will be correct).
453
basis = self.basis_tree()
456
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
457
require_versioned=True).next()
458
changed_content, kind = changes[2], changes[6]
459
if not changed_content:
460
return basis.annotate_iter(file_id)
464
if kind[0] != 'file':
467
old_lines = list(basis.annotate_iter(file_id))
469
for tree in self.branch.repository.revision_trees(
470
self.get_parent_ids()[1:]):
471
if file_id not in tree:
473
old.append(list(tree.annotate_iter(file_id)))
474
return annotate.reannotate(old, self.get_file(file_id).readlines(),
479
def _get_ancestors(self, default_revision):
480
ancestors = set([default_revision])
481
for parent_id in self.get_parent_ids():
482
ancestors.update(self.branch.repository.get_ancestry(
483
parent_id, topo_sorted=False))
486
def get_parent_ids(self):
487
"""See Tree.get_parent_ids.
489
This implementation reads the pending merges list and last_revision
490
value and uses that to decide what the parents list should be.
492
last_rev = _mod_revision.ensure_null(self._last_revision())
493
if _mod_revision.NULL_REVISION == last_rev:
498
merges_file = self._transport.get('pending-merges')
499
except errors.NoSuchFile:
502
for l in merges_file.readlines():
503
revision_id = l.rstrip('\n')
504
parents.append(revision_id)
508
def get_root_id(self):
509
"""Return the id of this trees root"""
510
return self._inventory.root.file_id
94
512
def _get_store_filename(self, file_id):
95
## XXX: badly named; this isn't in the store at all
96
return self.abspath(self.id2path(file_id))
513
## XXX: badly named; this is not in the store at all
514
return self.abspath(self.id2path(file_id))
517
def clone(self, to_bzrdir, revision_id=None):
518
"""Duplicate this working tree into to_bzr, including all state.
520
Specifically modified files are kept as modified, but
521
ignored and unknown files are discarded.
523
If you want to make a new line of development, see bzrdir.sprout()
526
If not None, the cloned tree will have its last revision set to
527
revision, and and difference between the source trees last revision
528
and this one merged in.
530
# assumes the target bzr dir format is compatible.
531
result = to_bzrdir.create_workingtree()
532
self.copy_content_into(result, revision_id)
536
def copy_content_into(self, tree, revision_id=None):
537
"""Copy the current content and user files of this tree into tree."""
538
tree.set_root_id(self.get_root_id())
539
if revision_id is None:
540
merge.transform_tree(tree, self)
542
# TODO now merge from tree.last_revision to revision (to preserve
543
# user local changes)
544
merge.transform_tree(tree, self)
545
tree.set_parent_ids([revision_id])
547
def id2abspath(self, file_id):
548
return self.abspath(self.id2path(file_id))
99
550
def has_id(self, file_id):
100
551
# files that have been deleted are excluded
101
inv = self._inventory
102
553
if not inv.has_id(file_id):
104
555
path = inv.id2path(file_id)
105
return os.path.exists(self.abspath(path))
556
return osutils.lexists(self.abspath(path))
558
def has_or_had_id(self, file_id):
559
if file_id == self.inventory.root.file_id:
561
return self.inventory.has_id(file_id)
108
563
__contains__ = has_id
111
565
def get_file_size(self, file_id):
112
# is this still called?
113
raise NotImplementedError()
116
def get_file_sha1(self, file_id):
117
path = self._inventory.id2path(file_id)
118
return self._hashcache.get_sha1(path)
121
def file_class(self, filename):
122
if self.path2id(filename):
124
elif self.is_ignored(filename):
130
def list_files(self):
131
"""Recursively list all files as (path, class, kind, id).
566
"""See Tree.get_file_size"""
568
return os.path.getsize(self.id2abspath(file_id))
570
if e.errno != errno.ENOENT:
576
def get_file_sha1(self, file_id, path=None, stat_value=None):
578
path = self._inventory.id2path(file_id)
579
return self._hashcache.get_sha1(path, stat_value)
581
def get_file_mtime(self, file_id, path=None):
583
path = self.inventory.id2path(file_id)
584
return os.lstat(self.abspath(path)).st_mtime
586
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
587
file_id = self.path2id(path)
588
return self._inventory[file_id].executable
590
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
591
mode = stat_result.st_mode
592
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
594
if not supports_executable():
595
def is_executable(self, file_id, path=None):
596
return self._inventory[file_id].executable
598
_is_executable_from_path_and_stat = \
599
_is_executable_from_path_and_stat_from_basis
601
def is_executable(self, file_id, path=None):
603
path = self.id2path(file_id)
604
mode = os.lstat(self.abspath(path)).st_mode
605
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
607
_is_executable_from_path_and_stat = \
608
_is_executable_from_path_and_stat_from_stat
610
@needs_tree_write_lock
611
def _add(self, files, ids, kinds):
612
"""See MutableTree._add."""
613
# TODO: Re-adding a file that is removed in the working copy
614
# should probably put it back with the previous ID.
615
# the read and write working inventory should not occur in this
616
# function - they should be part of lock_write and unlock.
618
for f, file_id, kind in zip(files, ids, kinds):
620
inv.add_path(f, kind=kind)
622
inv.add_path(f, kind=kind, file_id=file_id)
623
self._inventory_is_modified = True
625
@needs_tree_write_lock
626
def _gather_kinds(self, files, kinds):
627
"""See MutableTree._gather_kinds."""
628
for pos, f in enumerate(files):
629
if kinds[pos] is None:
630
fullpath = normpath(self.abspath(f))
632
kinds[pos] = file_kind(fullpath)
634
if e.errno == errno.ENOENT:
635
raise errors.NoSuchFile(fullpath)
638
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
639
"""Add revision_id as a parent.
641
This is equivalent to retrieving the current list of parent ids
642
and setting the list to its value plus revision_id.
644
:param revision_id: The revision id to add to the parent list. It may
645
be a ghost revision as long as its not the first parent to be added,
646
or the allow_leftmost_as_ghost parameter is set True.
647
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
649
parents = self.get_parent_ids() + [revision_id]
650
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
651
or allow_leftmost_as_ghost)
653
@needs_tree_write_lock
654
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
655
"""Add revision_id, tree tuple as a parent.
657
This is equivalent to retrieving the current list of parent trees
658
and setting the list to its value plus parent_tuple. See also
659
add_parent_tree_id - if you only have a parent id available it will be
660
simpler to use that api. If you have the parent already available, using
661
this api is preferred.
663
:param parent_tuple: The (revision id, tree) to add to the parent list.
664
If the revision_id is a ghost, pass None for the tree.
665
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
667
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
668
if len(parent_ids) > 1:
669
# the leftmost may have already been a ghost, preserve that if it
671
allow_leftmost_as_ghost = True
672
self.set_parent_ids(parent_ids,
673
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
675
@needs_tree_write_lock
676
def add_pending_merge(self, *revision_ids):
677
# TODO: Perhaps should check at this point that the
678
# history of the revision is actually present?
679
parents = self.get_parent_ids()
681
for rev_id in revision_ids:
682
if rev_id in parents:
684
parents.append(rev_id)
687
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
689
def path_content_summary(self, path, _lstat=os.lstat,
690
_mapper=osutils.file_kind_from_stat_mode):
691
"""See Tree.path_content_summary."""
692
abspath = self.abspath(path)
694
stat_result = _lstat(abspath)
696
if getattr(e, 'errno', None) == errno.ENOENT:
698
return ('missing', None, None, None)
699
# propagate other errors
701
kind = _mapper(stat_result.st_mode)
703
size = stat_result.st_size
704
# try for a stat cache lookup
705
executable = self._is_executable_from_path_and_stat(path, stat_result)
706
return (kind, size, executable, self._sha_from_stat(
708
elif kind == 'directory':
709
# perhaps it looks like a plain directory, but it's really a
711
if self._directory_is_tree_reference(path):
712
kind = 'tree-reference'
713
return kind, None, None, None
714
elif kind == 'symlink':
715
return ('symlink', None, None, os.readlink(abspath))
717
return (kind, None, None, None)
719
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
720
"""Common ghost checking functionality from set_parent_*.
722
This checks that the left hand-parent exists if there are any
725
if len(revision_ids) > 0:
726
leftmost_id = revision_ids[0]
727
if (not allow_leftmost_as_ghost and not
728
self.branch.repository.has_revision(leftmost_id)):
729
raise errors.GhostRevisionUnusableHere(leftmost_id)
731
def _set_merges_from_parent_ids(self, parent_ids):
732
merges = parent_ids[1:]
733
self._transport.put_bytes('pending-merges', '\n'.join(merges),
734
mode=self._control_files._file_mode)
736
def _filter_parent_ids_by_ancestry(self, revision_ids):
737
"""Check that all merged revisions are proper 'heads'.
739
This will always return the first revision_id, and any merged revisions
742
if len(revision_ids) == 0:
744
graph = self.branch.repository.get_graph()
745
heads = graph.heads(revision_ids)
746
new_revision_ids = revision_ids[:1]
747
for revision_id in revision_ids[1:]:
748
if revision_id in heads and revision_id not in new_revision_ids:
749
new_revision_ids.append(revision_id)
750
if new_revision_ids != revision_ids:
751
trace.mutter('requested to set revision_ids = %s,'
752
' but filtered to %s', revision_ids, new_revision_ids)
753
return new_revision_ids
755
@needs_tree_write_lock
756
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
757
"""Set the parent ids to revision_ids.
759
See also set_parent_trees. This api will try to retrieve the tree data
760
for each element of revision_ids from the trees repository. If you have
761
tree data already available, it is more efficient to use
762
set_parent_trees rather than set_parent_ids. set_parent_ids is however
763
an easier API to use.
765
:param revision_ids: The revision_ids to set as the parent ids of this
766
working tree. Any of these may be ghosts.
768
self._check_parents_for_ghosts(revision_ids,
769
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
770
for revision_id in revision_ids:
771
_mod_revision.check_not_reserved_id(revision_id)
773
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
775
if len(revision_ids) > 0:
776
self.set_last_revision(revision_ids[0])
778
self.set_last_revision(_mod_revision.NULL_REVISION)
780
self._set_merges_from_parent_ids(revision_ids)
782
@needs_tree_write_lock
783
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
784
"""See MutableTree.set_parent_trees."""
785
parent_ids = [rev for (rev, tree) in parents_list]
786
for revision_id in parent_ids:
787
_mod_revision.check_not_reserved_id(revision_id)
789
self._check_parents_for_ghosts(parent_ids,
790
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
792
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
794
if len(parent_ids) == 0:
795
leftmost_parent_id = _mod_revision.NULL_REVISION
796
leftmost_parent_tree = None
798
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
800
if self._change_last_revision(leftmost_parent_id):
801
if leftmost_parent_tree is None:
802
# If we don't have a tree, fall back to reading the
803
# parent tree from the repository.
804
self._cache_basis_inventory(leftmost_parent_id)
806
inv = leftmost_parent_tree.inventory
807
xml = self._create_basis_xml_from_inventory(
808
leftmost_parent_id, inv)
809
self._write_basis_inventory(xml)
810
self._set_merges_from_parent_ids(parent_ids)
812
@needs_tree_write_lock
813
def set_pending_merges(self, rev_list):
814
parents = self.get_parent_ids()
815
leftmost = parents[:1]
816
new_parents = leftmost + rev_list
817
self.set_parent_ids(new_parents)
819
@needs_tree_write_lock
820
def set_merge_modified(self, modified_hashes):
822
for file_id, hash in modified_hashes.iteritems():
823
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
824
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
826
def _sha_from_stat(self, path, stat_result):
827
"""Get a sha digest from the tree's stat cache.
829
The default implementation assumes no stat cache is present.
831
:param path: The path.
832
:param stat_result: The stat result being looked up.
836
def _put_rio(self, filename, stanzas, header):
837
self._must_be_locked()
838
my_file = rio_file(stanzas, header)
839
self._transport.put_file(filename, my_file,
840
mode=self._control_files._file_mode)
842
@needs_write_lock # because merge pulls data into the branch.
843
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
845
"""Merge from a branch into this working tree.
847
:param branch: The branch to merge from.
848
:param to_revision: If non-None, the merge will merge to to_revision,
849
but not beyond it. to_revision does not need to be in the history
850
of the branch when it is supplied. If None, to_revision defaults to
851
branch.last_revision().
853
from bzrlib.merge import Merger, Merge3Merger
854
pb = bzrlib.ui.ui_factory.nested_progress_bar()
856
merger = Merger(self.branch, this_tree=self, pb=pb)
857
merger.pp = ProgressPhase("Merge phase", 5, pb)
858
merger.pp.next_phase()
859
# check that there are no
861
merger.check_basis(check_clean=True, require_commits=False)
862
if to_revision is None:
863
to_revision = _mod_revision.ensure_null(branch.last_revision())
864
merger.other_rev_id = to_revision
865
if _mod_revision.is_null(merger.other_rev_id):
866
raise errors.NoCommits(branch)
867
self.branch.fetch(branch, last_revision=merger.other_rev_id)
868
merger.other_basis = merger.other_rev_id
869
merger.other_tree = self.branch.repository.revision_tree(
871
merger.other_branch = branch
872
merger.pp.next_phase()
873
if from_revision is None:
876
merger.set_base_revision(from_revision, branch)
877
if merger.base_rev_id == merger.other_rev_id:
878
raise errors.PointlessMerge
879
merger.backup_files = False
880
if merge_type is None:
881
merger.merge_type = Merge3Merger
883
merger.merge_type = merge_type
884
merger.set_interesting_files(None)
885
merger.show_base = False
886
merger.reprocess = False
887
conflicts = merger.do_merge()
894
def merge_modified(self):
895
"""Return a dictionary of files modified by a merge.
897
The list is initialized by WorkingTree.set_merge_modified, which is
898
typically called after we make some automatic updates to the tree
901
This returns a map of file_id->sha1, containing only files which are
902
still in the working inventory and have that text hash.
905
hashfile = self._transport.get('merge-hashes')
906
except errors.NoSuchFile:
911
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
912
raise errors.MergeModifiedFormatError()
913
except StopIteration:
914
raise errors.MergeModifiedFormatError()
915
for s in RioReader(hashfile):
916
# RioReader reads in Unicode, so convert file_ids back to utf8
917
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
918
if file_id not in self.inventory:
920
text_hash = s.get("hash")
921
if text_hash == self.get_file_sha1(file_id):
922
merge_hashes[file_id] = text_hash
928
def mkdir(self, path, file_id=None):
929
"""See MutableTree.mkdir()."""
931
file_id = generate_ids.gen_file_id(os.path.basename(path))
932
os.mkdir(self.abspath(path))
933
self.add(path, file_id, 'directory')
936
def get_symlink_target(self, file_id):
937
return os.readlink(self.id2abspath(file_id))
940
def subsume(self, other_tree):
941
def add_children(inventory, entry):
942
for child_entry in entry.children.values():
943
inventory._byid[child_entry.file_id] = child_entry
944
if child_entry.kind == 'directory':
945
add_children(inventory, child_entry)
946
if other_tree.get_root_id() == self.get_root_id():
947
raise errors.BadSubsumeSource(self, other_tree,
948
'Trees have the same root')
950
other_tree_path = self.relpath(other_tree.basedir)
951
except errors.PathNotChild:
952
raise errors.BadSubsumeSource(self, other_tree,
953
'Tree is not contained by the other')
954
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
955
if new_root_parent is None:
956
raise errors.BadSubsumeSource(self, other_tree,
957
'Parent directory is not versioned.')
958
# We need to ensure that the result of a fetch will have a
959
# versionedfile for the other_tree root, and only fetching into
960
# RepositoryKnit2 guarantees that.
961
if not self.branch.repository.supports_rich_root():
962
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
963
other_tree.lock_tree_write()
965
new_parents = other_tree.get_parent_ids()
966
other_root = other_tree.inventory.root
967
other_root.parent_id = new_root_parent
968
other_root.name = osutils.basename(other_tree_path)
969
self.inventory.add(other_root)
970
add_children(self.inventory, other_root)
971
self._write_inventory(self.inventory)
972
# normally we don't want to fetch whole repositories, but i think
973
# here we really do want to consolidate the whole thing.
974
for parent_id in other_tree.get_parent_ids():
975
self.branch.fetch(other_tree.branch, parent_id)
976
self.add_parent_tree_id(parent_id)
979
other_tree.bzrdir.retire_bzrdir()
981
def _setup_directory_is_tree_reference(self):
982
if self._branch.repository._format.supports_tree_reference:
983
self._directory_is_tree_reference = \
984
self._directory_may_be_tree_reference
986
self._directory_is_tree_reference = \
987
self._directory_is_never_tree_reference
989
def _directory_is_never_tree_reference(self, relpath):
992
def _directory_may_be_tree_reference(self, relpath):
993
# as a special case, if a directory contains control files then
994
# it's a tree reference, except that the root of the tree is not
995
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
996
# TODO: We could ask all the control formats whether they
997
# recognize this directory, but at the moment there's no cheap api
998
# to do that. Since we probably can only nest bzr checkouts and
999
# they always use this name it's ok for now. -- mbp 20060306
1001
# FIXME: There is an unhandled case here of a subdirectory
1002
# containing .bzr but not a branch; that will probably blow up
1003
# when you try to commit it. It might happen if there is a
1004
# checkout in a subdirectory. This can be avoided by not adding
1007
@needs_tree_write_lock
1008
def extract(self, file_id, format=None):
1009
"""Extract a subtree from this tree.
1011
A new branch will be created, relative to the path for this tree.
1015
segments = osutils.splitpath(path)
1016
transport = self.branch.bzrdir.root_transport
1017
for name in segments:
1018
transport = transport.clone(name)
1019
transport.ensure_base()
1022
sub_path = self.id2path(file_id)
1023
branch_transport = mkdirs(sub_path)
1025
format = self.bzrdir.cloning_metadir()
1026
branch_transport.ensure_base()
1027
branch_bzrdir = format.initialize_on_transport(branch_transport)
1029
repo = branch_bzrdir.find_repository()
1030
except errors.NoRepositoryPresent:
1031
repo = branch_bzrdir.create_repository()
1032
if not repo.supports_rich_root():
1033
raise errors.RootNotRich()
1034
new_branch = branch_bzrdir.create_branch()
1035
new_branch.pull(self.branch)
1036
for parent_id in self.get_parent_ids():
1037
new_branch.fetch(self.branch, parent_id)
1038
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1039
if tree_transport.base != branch_transport.base:
1040
tree_bzrdir = format.initialize_on_transport(tree_transport)
1041
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1043
tree_bzrdir = branch_bzrdir
1044
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1045
wt.set_parent_ids(self.get_parent_ids())
1046
my_inv = self.inventory
1047
child_inv = Inventory(root_id=None)
1048
new_root = my_inv[file_id]
1049
my_inv.remove_recursive_id(file_id)
1050
new_root.parent_id = None
1051
child_inv.add(new_root)
1052
self._write_inventory(my_inv)
1053
wt._write_inventory(child_inv)
1056
def _serialize(self, inventory, out_file):
1057
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1060
def _deserialize(selt, in_file):
1061
return xml5.serializer_v5.read_inventory(in_file)
1064
"""Write the in memory inventory to disk."""
1065
# TODO: Maybe this should only write on dirty ?
1066
if self._control_files._lock_mode != 'w':
1067
raise errors.NotWriteLocked(self)
1069
self._serialize(self._inventory, sio)
1071
self._transport.put_file('inventory', sio,
1072
mode=self._control_files._file_mode)
1073
self._inventory_is_modified = False
1075
def _kind(self, relpath):
1076
return osutils.file_kind(self.abspath(relpath))
1078
def list_files(self, include_root=False):
1079
"""Recursively list all files as (path, class, kind, id, entry).
133
1081
Lists, but does not descend into unversioned directories.
138
1086
Skips the control directory.
140
inv = self._inventory
142
def descend(from_dir_relpath, from_dir_id, dp):
1088
# list_files is an iterator, so @needs_read_lock doesn't work properly
1089
# with it. So callers should be careful to always read_lock the tree.
1090
if not self.is_locked():
1091
raise errors.ObjectNotLocked(self)
1093
inv = self.inventory
1094
if include_root is True:
1095
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1096
# Convert these into local objects to save lookup times
1097
pathjoin = osutils.pathjoin
1098
file_kind = self._kind
1100
# transport.base ends in a slash, we want the piece
1101
# between the last two slashes
1102
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1104
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1106
# directory file_id, relative path, absolute path, reverse sorted children
1107
children = os.listdir(self.basedir)
1109
# jam 20060527 The kernel sized tree seems equivalent whether we
1110
# use a deque and popleft to keep them sorted, or if we use a plain
1111
# list and just reverse() them.
1112
children = collections.deque(children)
1113
stack = [(inv.root.file_id, u'', self.basedir, children)]
1115
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1118
f = children.popleft()
146
1119
## TODO: If we find a subdirectory with its own .bzr
147
1120
## directory, then that is a separate tree and we
148
1121
## should exclude it.
149
if bzrlib.BZRDIR == f:
1123
# the bzrdir for this tree
1124
if transport_base_dir == f:
153
fp = appendpath(from_dir_relpath, f)
1127
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1128
# and 'f' doesn't begin with one, we can do a string op, rather
1129
# than the checks of pathjoin(), all relative paths will have an extra slash
1131
fp = from_dir_relpath + '/' + f
156
fap = appendpath(dp, f)
1134
fap = from_dir_abspath + '/' + f
158
1136
f_ie = inv.get_child(from_dir_id, f)
161
elif self.is_ignored(fp):
1139
elif self.is_ignored(fp[1:]):
1142
# we may not have found this file, because of a unicode issue
1143
f_norm, can_access = osutils.normalized_filename(f)
1144
if f == f_norm or not can_access:
1145
# No change, so treat this file normally
1148
# this file can be accessed by a normalized path
1149
# check again if it is versioned
1150
# these lines are repeated here for performance
1152
fp = from_dir_relpath + '/' + f
1153
fap = from_dir_abspath + '/' + f
1154
f_ie = inv.get_child(from_dir_id, f)
1157
elif self.is_ignored(fp[1:]):
166
1162
fk = file_kind(fap)
1164
# make a last minute entry
170
raise BzrCheckError("file %r entered as kind %r id %r, "
172
% (fap, f_ie.kind, f_ie.file_id, fk))
174
yield fp, c, fk, (f_ie and f_ie.file_id)
1166
yield fp[1:], c, fk, f_ie.file_id, f_ie
1169
yield fp[1:], c, fk, None, fk_entries[fk]()
1171
yield fp[1:], c, fk, None, TreeEntry()
176
1174
if fk != 'directory':
180
# don't descend unversioned directories
183
for ff in descend(fp, f_ie.file_id, fap):
186
for f in descend('', inv.root.file_id, self.basedir):
1177
# But do this child first
1178
new_children = os.listdir(fap)
1180
new_children = collections.deque(new_children)
1181
stack.append((f_ie.file_id, fp, fap, new_children))
1182
# Break out of inner loop,
1183
# so that we start outer loop with child
1186
# if we finished all children, pop it off the stack
1189
@needs_tree_write_lock
1190
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1193
to_dir must exist in the inventory.
1195
If to_dir exists and is a directory, the files are moved into
1196
it, keeping their old names.
1198
Note that to_dir is only the last component of the new name;
1199
this doesn't change the directory.
1201
For each entry in from_paths the move mode will be determined
1204
The first mode moves the file in the filesystem and updates the
1205
inventory. The second mode only updates the inventory without
1206
touching the file on the filesystem. This is the new mode introduced
1209
move uses the second mode if 'after == True' and the target is not
1210
versioned but present in the working tree.
1212
move uses the second mode if 'after == False' and the source is
1213
versioned but no longer in the working tree, and the target is not
1214
versioned but present in the working tree.
1216
move uses the first mode if 'after == False' and the source is
1217
versioned and present in the working tree, and the target is not
1218
versioned and not present in the working tree.
1220
Everything else results in an error.
1222
This returns a list of (from_path, to_path) pairs for each
1223
entry that is moved.
1228
# check for deprecated use of signature
1230
to_dir = kwargs.get('to_name', None)
1232
raise TypeError('You must supply a target directory')
1234
symbol_versioning.warn('The parameter to_name was deprecated'
1235
' in version 0.13. Use to_dir instead',
1238
# check destination directory
1239
if isinstance(from_paths, basestring):
1241
inv = self.inventory
1242
to_abs = self.abspath(to_dir)
1243
if not isdir(to_abs):
1244
raise errors.BzrMoveFailedError('',to_dir,
1245
errors.NotADirectory(to_abs))
1246
if not self.has_filename(to_dir):
1247
raise errors.BzrMoveFailedError('',to_dir,
1248
errors.NotInWorkingDirectory(to_dir))
1249
to_dir_id = inv.path2id(to_dir)
1250
if to_dir_id is None:
1251
raise errors.BzrMoveFailedError('',to_dir,
1252
errors.NotVersionedError(path=str(to_dir)))
1254
to_dir_ie = inv[to_dir_id]
1255
if to_dir_ie.kind != 'directory':
1256
raise errors.BzrMoveFailedError('',to_dir,
1257
errors.NotADirectory(to_abs))
1259
# create rename entries and tuples
1260
for from_rel in from_paths:
1261
from_tail = splitpath(from_rel)[-1]
1262
from_id = inv.path2id(from_rel)
1264
raise errors.BzrMoveFailedError(from_rel,to_dir,
1265
errors.NotVersionedError(path=str(from_rel)))
1267
from_entry = inv[from_id]
1268
from_parent_id = from_entry.parent_id
1269
to_rel = pathjoin(to_dir, from_tail)
1270
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1272
from_tail=from_tail,
1273
from_parent_id=from_parent_id,
1274
to_rel=to_rel, to_tail=from_tail,
1275
to_parent_id=to_dir_id)
1276
rename_entries.append(rename_entry)
1277
rename_tuples.append((from_rel, to_rel))
1279
# determine which move mode to use. checks also for movability
1280
rename_entries = self._determine_mv_mode(rename_entries, after)
1282
original_modified = self._inventory_is_modified
1285
self._inventory_is_modified = True
1286
self._move(rename_entries)
1288
# restore the inventory on error
1289
self._inventory_is_modified = original_modified
1291
self._write_inventory(inv)
1292
return rename_tuples
1294
def _determine_mv_mode(self, rename_entries, after=False):
1295
"""Determines for each from-to pair if both inventory and working tree
1296
or only the inventory has to be changed.
1298
Also does basic plausability tests.
1300
inv = self.inventory
1302
for rename_entry in rename_entries:
1303
# store to local variables for easier reference
1304
from_rel = rename_entry.from_rel
1305
from_id = rename_entry.from_id
1306
to_rel = rename_entry.to_rel
1307
to_id = inv.path2id(to_rel)
1308
only_change_inv = False
1310
# check the inventory for source and destination
1312
raise errors.BzrMoveFailedError(from_rel,to_rel,
1313
errors.NotVersionedError(path=str(from_rel)))
1314
if to_id is not None:
1315
raise errors.BzrMoveFailedError(from_rel,to_rel,
1316
errors.AlreadyVersionedError(path=str(to_rel)))
1318
# try to determine the mode for rename (only change inv or change
1319
# inv and file system)
1321
if not self.has_filename(to_rel):
1322
raise errors.BzrMoveFailedError(from_id,to_rel,
1323
errors.NoSuchFile(path=str(to_rel),
1324
extra="New file has not been created yet"))
1325
only_change_inv = True
1326
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1327
only_change_inv = True
1328
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1329
only_change_inv = False
1330
elif (not self.case_sensitive
1331
and from_rel.lower() == to_rel.lower()
1332
and self.has_filename(from_rel)):
1333
only_change_inv = False
1335
# something is wrong, so lets determine what exactly
1336
if not self.has_filename(from_rel) and \
1337
not self.has_filename(to_rel):
1338
raise errors.BzrRenameFailedError(from_rel,to_rel,
1339
errors.PathsDoNotExist(paths=(str(from_rel),
1342
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1343
rename_entry.only_change_inv = only_change_inv
1344
return rename_entries
1346
def _move(self, rename_entries):
1347
"""Moves a list of files.
1349
Depending on the value of the flag 'only_change_inv', the
1350
file will be moved on the file system or not.
1352
inv = self.inventory
1355
for entry in rename_entries:
1357
self._move_entry(entry)
1359
self._rollback_move(moved)
1363
def _rollback_move(self, moved):
1364
"""Try to rollback a previous move in case of an filesystem error."""
1365
inv = self.inventory
1368
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1369
entry.to_tail, entry.to_parent_id, entry.from_rel,
1370
entry.from_tail, entry.from_parent_id,
1371
entry.only_change_inv))
1372
except errors.BzrMoveFailedError, e:
1373
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1374
" The working tree is in an inconsistent state."
1375
" Please consider doing a 'bzr revert'."
1376
" Error message is: %s" % e)
1378
def _move_entry(self, entry):
1379
inv = self.inventory
1380
from_rel_abs = self.abspath(entry.from_rel)
1381
to_rel_abs = self.abspath(entry.to_rel)
1382
if from_rel_abs == to_rel_abs:
1383
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1384
"Source and target are identical.")
1386
if not entry.only_change_inv:
1388
osutils.rename(from_rel_abs, to_rel_abs)
1390
raise errors.BzrMoveFailedError(entry.from_rel,
1392
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1394
@needs_tree_write_lock
1395
def rename_one(self, from_rel, to_rel, after=False):
1398
This can change the directory or the filename or both.
1400
rename_one has several 'modes' to work. First, it can rename a physical
1401
file and change the file_id. That is the normal mode. Second, it can
1402
only change the file_id without touching any physical file. This is
1403
the new mode introduced in version 0.15.
1405
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1406
versioned but present in the working tree.
1408
rename_one uses the second mode if 'after == False' and 'from_rel' is
1409
versioned but no longer in the working tree, and 'to_rel' is not
1410
versioned but present in the working tree.
1412
rename_one uses the first mode if 'after == False' and 'from_rel' is
1413
versioned and present in the working tree, and 'to_rel' is not
1414
versioned and not present in the working tree.
1416
Everything else results in an error.
1418
inv = self.inventory
1421
# create rename entries and tuples
1422
from_tail = splitpath(from_rel)[-1]
1423
from_id = inv.path2id(from_rel)
1425
raise errors.BzrRenameFailedError(from_rel,to_rel,
1426
errors.NotVersionedError(path=str(from_rel)))
1427
from_entry = inv[from_id]
1428
from_parent_id = from_entry.parent_id
1429
to_dir, to_tail = os.path.split(to_rel)
1430
to_dir_id = inv.path2id(to_dir)
1431
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1433
from_tail=from_tail,
1434
from_parent_id=from_parent_id,
1435
to_rel=to_rel, to_tail=to_tail,
1436
to_parent_id=to_dir_id)
1437
rename_entries.append(rename_entry)
1439
# determine which move mode to use. checks also for movability
1440
rename_entries = self._determine_mv_mode(rename_entries, after)
1442
# check if the target changed directory and if the target directory is
1444
if to_dir_id is None:
1445
raise errors.BzrMoveFailedError(from_rel,to_rel,
1446
errors.NotVersionedError(path=str(to_dir)))
1448
# all checks done. now we can continue with our actual work
1449
mutter('rename_one:\n'
1454
' to_dir_id {%s}\n',
1455
from_id, from_rel, to_rel, to_dir, to_dir_id)
1457
self._move(rename_entries)
1458
self._write_inventory(inv)
1460
class _RenameEntry(object):
1461
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1462
to_rel, to_tail, to_parent_id, only_change_inv=False):
1463
self.from_rel = from_rel
1464
self.from_id = from_id
1465
self.from_tail = from_tail
1466
self.from_parent_id = from_parent_id
1467
self.to_rel = to_rel
1468
self.to_tail = to_tail
1469
self.to_parent_id = to_parent_id
1470
self.only_change_inv = only_change_inv
191
1473
def unknowns(self):
192
for subp in self.extras():
193
if not self.is_ignored(subp):
1474
"""Return all unknown files.
1476
These are files in the working directory that are not versioned or
1477
control files or ignored.
1479
# force the extras method to be fully executed before returning, to
1480
# prevent race conditions with the lock
1482
[subp for subp in self.extras() if not self.is_ignored(subp)])
1484
@needs_tree_write_lock
1485
def unversion(self, file_ids):
1486
"""Remove the file ids in file_ids from the current versioned set.
1488
When a file_id is unversioned, all of its children are automatically
1491
:param file_ids: The file ids to stop versioning.
1492
:raises: NoSuchId if any fileid is not currently versioned.
1494
for file_id in file_ids:
1495
if self._inventory.has_id(file_id):
1496
self._inventory.remove_recursive_id(file_id)
1498
raise errors.NoSuchId(self, file_id)
1500
# in the future this should just set a dirty bit to wait for the
1501
# final unlock. However, until all methods of workingtree start
1502
# with the current in -memory inventory rather than triggering
1503
# a read, it is more complex - we need to teach read_inventory
1504
# to know when to read, and when to not read first... and possibly
1505
# to save first when the in memory one may be corrupted.
1506
# so for now, we just only write it if it is indeed dirty.
1508
self._write_inventory(self._inventory)
1510
def _iter_conflicts(self):
1512
for info in self.list_files():
1514
stem = get_conflicted_stem(path)
1517
if stem not in conflicted:
1518
conflicted.add(stem)
1522
def pull(self, source, overwrite=False, stop_revision=None,
1523
change_reporter=None, possible_transports=None):
1524
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1527
pp = ProgressPhase("Pull phase", 2, top_pb)
1529
old_revision_info = self.branch.last_revision_info()
1530
basis_tree = self.basis_tree()
1531
count = self.branch.pull(source, overwrite, stop_revision,
1532
possible_transports=possible_transports)
1533
new_revision_info = self.branch.last_revision_info()
1534
if new_revision_info != old_revision_info:
1536
repository = self.branch.repository
1537
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1538
basis_tree.lock_read()
1540
new_basis_tree = self.branch.basis_tree()
1547
change_reporter=change_reporter)
1548
if (basis_tree.inventory.root is None and
1549
new_basis_tree.inventory.root is not None):
1550
self.set_root_id(new_basis_tree.get_root_id())
1554
# TODO - dedup parents list with things merged by pull ?
1555
# reuse the revisiontree we merged against to set the new
1557
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1558
# we have to pull the merge trees out again, because
1559
# merge_inner has set the ids. - this corner is not yet
1560
# layered well enough to prevent double handling.
1561
# XXX TODO: Fix the double handling: telling the tree about
1562
# the already known parent data is wasteful.
1563
merges = self.get_parent_ids()[1:]
1564
parent_trees.extend([
1565
(parent, repository.revision_tree(parent)) for
1567
self.set_parent_trees(parent_trees)
1574
def put_file_bytes_non_atomic(self, file_id, bytes):
1575
"""See MutableTree.put_file_bytes_non_atomic."""
1576
stream = file(self.id2abspath(file_id), 'wb')
1581
# TODO: update the hashcache here ?
197
1583
def extras(self):
198
"""Yield all unknown files in this WorkingTree.
1584
"""Yield all unversioned files in this WorkingTree.
200
If there are any unknown directories then only the directory is
201
returned, not all its children. But if there are unknown files
1586
If there are any unversioned directories then only the directory is
1587
returned, not all its children. But if there are unversioned files
202
1588
under a versioned subdirectory, they are returned.
204
1590
Currently returned depth-first, sorted by name within directories.
1591
This is the same order used by 'osutils.walkdirs'.
206
1593
## TODO: Work from given directory downwards
207
1594
for path, dir_entry in self.inventory.directories():
208
mutter("search for unknowns in %r" % path)
1595
# mutter("search for unknowns in %r", path)
209
1596
dirabs = self.abspath(path)
210
1597
if not isdir(dirabs):
211
1598
# e.g. directory deleted
256
1664
If the file is ignored, returns the pattern which caused it to
257
1665
be ignored, otherwise None. So this can simply be used as a
258
1666
boolean if desired."""
260
# TODO: Use '**' to match directories, and other extended
261
# globbing stuff from cvs/rsync.
263
# XXX: fnmatch is actually not quite what we want: it's only
264
# approximately the same as real Unix fnmatch, and doesn't
265
# treat dotfiles correctly and allows * to match /.
266
# Eventually it should be replaced with something more
269
for pat in self.get_ignore_list():
270
if '/' in pat or '\\' in pat:
272
# as a special case, you can put ./ at the start of a
273
# pattern; this is good to match in the top-level
276
if (pat[:2] == './') or (pat[:2] == '.\\'):
1667
if getattr(self, '_ignoreglobster', None) is None:
1668
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1669
return self._ignoreglobster.match(filename)
1671
def kind(self, file_id):
1672
return file_kind(self.id2abspath(file_id))
1674
def stored_kind(self, file_id):
1675
"""See Tree.stored_kind"""
1676
return self.inventory[file_id].kind
1678
def _comparison_data(self, entry, path):
1679
abspath = self.abspath(path)
1681
stat_value = os.lstat(abspath)
1683
if getattr(e, 'errno', None) == errno.ENOENT:
1690
mode = stat_value.st_mode
1691
kind = osutils.file_kind_from_stat_mode(mode)
1692
if not supports_executable():
1693
executable = entry is not None and entry.executable
1695
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1696
return kind, executable, stat_value
1698
def _file_size(self, entry, stat_value):
1699
return stat_value.st_size
1701
def last_revision(self):
1702
"""Return the last revision of the branch for this tree.
1704
This format tree does not support a separate marker for last-revision
1705
compared to the branch.
1707
See MutableTree.last_revision
1709
return self._last_revision()
1712
def _last_revision(self):
1713
"""helper for get_parent_ids."""
1714
return _mod_revision.ensure_null(self.branch.last_revision())
1716
def is_locked(self):
1717
return self._control_files.is_locked()
1719
def _must_be_locked(self):
1720
if not self.is_locked():
1721
raise errors.ObjectNotLocked(self)
1723
def lock_read(self):
1724
"""See Branch.lock_read, and WorkingTree.unlock."""
1725
if not self.is_locked():
1727
self.branch.lock_read()
1729
return self._control_files.lock_read()
1731
self.branch.unlock()
1734
def lock_tree_write(self):
1735
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1736
if not self.is_locked():
1738
self.branch.lock_read()
1740
return self._control_files.lock_write()
1742
self.branch.unlock()
1745
def lock_write(self):
1746
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1747
if not self.is_locked():
1749
self.branch.lock_write()
1751
return self._control_files.lock_write()
1753
self.branch.unlock()
1756
def get_physical_lock_status(self):
1757
return self._control_files.get_physical_lock_status()
1759
def _basis_inventory_name(self):
1760
return 'basis-inventory-cache'
1762
def _reset_data(self):
1763
"""Reset transient data that cannot be revalidated."""
1764
self._inventory_is_modified = False
1765
result = self._deserialize(self._transport.get('inventory'))
1766
self._set_inventory(result, dirty=False)
1768
@needs_tree_write_lock
1769
def set_last_revision(self, new_revision):
1770
"""Change the last revision in the working tree."""
1771
if self._change_last_revision(new_revision):
1772
self._cache_basis_inventory(new_revision)
1774
def _change_last_revision(self, new_revision):
1775
"""Template method part of set_last_revision to perform the change.
1777
This is used to allow WorkingTree3 instances to not affect branch
1778
when their last revision is set.
1780
if _mod_revision.is_null(new_revision):
1781
self.branch.set_revision_history([])
1784
self.branch.generate_revision_history(new_revision)
1785
except errors.NoSuchRevision:
1786
# not present in the repo - dont try to set it deeper than the tip
1787
self.branch.set_revision_history([new_revision])
1790
def _write_basis_inventory(self, xml):
1791
"""Write the basis inventory XML to the basis-inventory file"""
1792
path = self._basis_inventory_name()
1794
self._transport.put_file(path, sio,
1795
mode=self._control_files._file_mode)
1797
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1798
"""Create the text that will be saved in basis-inventory"""
1799
inventory.revision_id = revision_id
1800
return xml7.serializer_v7.write_inventory_to_string(inventory)
1802
def _cache_basis_inventory(self, new_revision):
1803
"""Cache new_revision as the basis inventory."""
1804
# TODO: this should allow the ready-to-use inventory to be passed in,
1805
# as commit already has that ready-to-use [while the format is the
1808
# this double handles the inventory - unpack and repack -
1809
# but is easier to understand. We can/should put a conditional
1810
# in here based on whether the inventory is in the latest format
1811
# - perhaps we should repack all inventories on a repository
1813
# the fast path is to copy the raw xml from the repository. If the
1814
# xml contains 'revision_id="', then we assume the right
1815
# revision_id is set. We must check for this full string, because a
1816
# root node id can legitimately look like 'revision_id' but cannot
1818
xml = self.branch.repository.get_inventory_xml(new_revision)
1819
firstline = xml.split('\n', 1)[0]
1820
if (not 'revision_id="' in firstline or
1821
'format="7"' not in firstline):
1822
inv = self.branch.repository.deserialise_inventory(
1824
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1825
self._write_basis_inventory(xml)
1826
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1829
def read_basis_inventory(self):
1830
"""Read the cached basis inventory."""
1831
path = self._basis_inventory_name()
1832
return self._transport.get_bytes(path)
1835
def read_working_inventory(self):
1836
"""Read the working inventory.
1838
:raises errors.InventoryModified: read_working_inventory will fail
1839
when the current in memory inventory has been modified.
1841
# conceptually this should be an implementation detail of the tree.
1842
# XXX: Deprecate this.
1843
# ElementTree does its own conversion from UTF-8, so open in
1845
if self._inventory_is_modified:
1846
raise errors.InventoryModified(self)
1847
result = self._deserialize(self._transport.get('inventory'))
1848
self._set_inventory(result, dirty=False)
1851
@needs_tree_write_lock
1852
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1854
"""Remove nominated files from the working inventory.
1856
:files: File paths relative to the basedir.
1857
:keep_files: If true, the files will also be kept.
1858
:force: Delete files and directories, even if they are changed and
1859
even if the directories are not empty.
1861
if isinstance(files, basestring):
1867
unknown_nested_files=set()
1869
def recurse_directory_to_add_files(directory):
1870
# Recurse directory and add all files
1871
# so we can check if they have changed.
1872
for parent_info, file_infos in\
1873
self.walkdirs(directory):
1874
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1875
# Is it versioned or ignored?
1876
if self.path2id(relpath) or self.is_ignored(relpath):
1877
# Add nested content for deletion.
1878
new_files.add(relpath)
1880
# Files which are not versioned and not ignored
1881
# should be treated as unknown.
1882
unknown_nested_files.add((relpath, None, kind))
1884
for filename in files:
1885
# Get file name into canonical form.
1886
abspath = self.abspath(filename)
1887
filename = self.relpath(abspath)
1888
if len(filename) > 0:
1889
new_files.add(filename)
1890
recurse_directory_to_add_files(filename)
1892
files = list(new_files)
1895
return # nothing to do
1897
# Sort needed to first handle directory content before the directory
1898
files.sort(reverse=True)
1900
# Bail out if we are going to delete files we shouldn't
1901
if not keep_files and not force:
1902
has_changed_files = len(unknown_nested_files) > 0
1903
if not has_changed_files:
1904
for (file_id, path, content_change, versioned, parent_id, name,
1905
kind, executable) in self.iter_changes(self.basis_tree(),
1906
include_unchanged=True, require_versioned=False,
1907
want_unversioned=True, specific_files=files):
1908
if versioned == (False, False):
1909
# The record is unknown ...
1910
if not self.is_ignored(path[1]):
1911
# ... but not ignored
1912
has_changed_files = True
1914
elif content_change and (kind[1] is not None):
1915
# Versioned and changed, but not deleted
1916
has_changed_files = True
1919
if has_changed_files:
1920
# Make delta show ALL applicable changes in error message.
1921
tree_delta = self.changes_from(self.basis_tree(),
1922
require_versioned=False, want_unversioned=True,
1923
specific_files=files)
1924
for unknown_file in unknown_nested_files:
1925
if unknown_file not in tree_delta.unversioned:
1926
tree_delta.unversioned.extend((unknown_file,))
1927
raise errors.BzrRemoveChangedFilesError(tree_delta)
1929
# Build inv_delta and delete files where applicaple,
1930
# do this before any modifications to inventory.
1932
fid = self.path2id(f)
1935
message = "%s is not versioned." % (f,)
1938
# having removed it, it must be either ignored or unknown
1939
if self.is_ignored(f):
1943
textui.show_status(new_status, self.kind(fid), f,
1946
inv_delta.append((f, None, fid, None))
1947
message = "removed %s" % (f,)
1950
abs_path = self.abspath(f)
1951
if osutils.lexists(abs_path):
1952
if (osutils.isdir(abs_path) and
1953
len(os.listdir(abs_path)) > 0):
1955
osutils.rmtree(abs_path)
1957
message = "%s is not an empty directory "\
1958
"and won't be deleted." % (f,)
1960
osutils.delete_any(abs_path)
1961
message = "deleted %s" % (f,)
1962
elif message is not None:
1963
# Only care if we haven't done anything yet.
1964
message = "%s does not exist." % (f,)
1966
# Print only one message (if any) per file.
1967
if message is not None:
1969
self.apply_inventory_delta(inv_delta)
1971
@needs_tree_write_lock
1972
def revert(self, filenames=None, old_tree=None, backups=True,
1973
pb=DummyProgress(), report_changes=False):
1974
from bzrlib.conflicts import resolve
1977
symbol_versioning.warn('Using [] to revert all files is deprecated'
1978
' as of bzr 0.91. Please use None (the default) instead.',
1979
DeprecationWarning, stacklevel=2)
1980
if old_tree is None:
1981
basis_tree = self.basis_tree()
1982
basis_tree.lock_read()
1983
old_tree = basis_tree
1987
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1989
if filenames is None and len(self.get_parent_ids()) > 1:
1991
last_revision = self.last_revision()
1992
if last_revision != NULL_REVISION:
1993
if basis_tree is None:
1994
basis_tree = self.basis_tree()
1995
basis_tree.lock_read()
1996
parent_trees.append((last_revision, basis_tree))
1997
self.set_parent_trees(parent_trees)
2000
resolve(self, filenames, ignore_misses=True, recursive=True)
2002
if basis_tree is not None:
2006
def revision_tree(self, revision_id):
2007
"""See Tree.revision_tree.
2009
WorkingTree can supply revision_trees for the basis revision only
2010
because there is only one cached inventory in the bzr directory.
2012
if revision_id == self.last_revision():
2014
xml = self.read_basis_inventory()
2015
except errors.NoSuchFile:
2019
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2020
# dont use the repository revision_tree api because we want
2021
# to supply the inventory.
2022
if inv.revision_id == revision_id:
2023
return revisiontree.RevisionTree(self.branch.repository,
2025
except errors.BadInventoryFormat:
2027
# raise if there was no inventory, or if we read the wrong inventory.
2028
raise errors.NoSuchRevisionInTree(self, revision_id)
2030
# XXX: This method should be deprecated in favour of taking in a proper
2031
# new Inventory object.
2032
@needs_tree_write_lock
2033
def set_inventory(self, new_inventory_list):
2034
from bzrlib.inventory import (Inventory,
2039
inv = Inventory(self.get_root_id())
2040
for path, file_id, parent, kind in new_inventory_list:
2041
name = os.path.basename(path)
2044
# fixme, there should be a factory function inv,add_??
2045
if kind == 'directory':
2046
inv.add(InventoryDirectory(file_id, name, parent))
2047
elif kind == 'file':
2048
inv.add(InventoryFile(file_id, name, parent))
2049
elif kind == 'symlink':
2050
inv.add(InventoryLink(file_id, name, parent))
2052
raise errors.BzrError("unknown kind %r" % kind)
2053
self._write_inventory(inv)
2055
@needs_tree_write_lock
2056
def set_root_id(self, file_id):
2057
"""Set the root id for this tree."""
2061
'WorkingTree.set_root_id with fileid=None')
2062
file_id = osutils.safe_file_id(file_id)
2063
self._set_root_id(file_id)
2065
def _set_root_id(self, file_id):
2066
"""Set the root id for this tree, in a format specific manner.
2068
:param file_id: The file id to assign to the root. It must not be
2069
present in the current inventory or an error will occur. It must
2070
not be None, but rather a valid file id.
2072
inv = self._inventory
2073
orig_root_id = inv.root.file_id
2074
# TODO: it might be nice to exit early if there was nothing
2075
# to do, saving us from trigger a sync on unlock.
2076
self._inventory_is_modified = True
2077
# we preserve the root inventory entry object, but
2078
# unlinkit from the byid index
2079
del inv._byid[inv.root.file_id]
2080
inv.root.file_id = file_id
2081
# and link it into the index with the new changed id.
2082
inv._byid[inv.root.file_id] = inv.root
2083
# and finally update all children to reference the new id.
2084
# XXX: this should be safe to just look at the root.children
2085
# list, not the WHOLE INVENTORY.
2088
if entry.parent_id == orig_root_id:
2089
entry.parent_id = inv.root.file_id
2092
"""See Branch.unlock.
2094
WorkingTree locking just uses the Branch locking facilities.
2095
This is current because all working trees have an embedded branch
2096
within them. IF in the future, we were to make branch data shareable
2097
between multiple working trees, i.e. via shared storage, then we
2098
would probably want to lock both the local tree, and the branch.
2100
raise NotImplementedError(self.unlock)
2102
def update(self, change_reporter=None, possible_transports=None):
2103
"""Update a working tree along its branch.
2105
This will update the branch if its bound too, which means we have
2106
multiple trees involved:
2108
- The new basis tree of the master.
2109
- The old basis tree of the branch.
2110
- The old basis tree of the working tree.
2111
- The current working tree state.
2113
Pathologically, all three may be different, and non-ancestors of each
2114
other. Conceptually we want to:
2116
- Preserve the wt.basis->wt.state changes
2117
- Transform the wt.basis to the new master basis.
2118
- Apply a merge of the old branch basis to get any 'local' changes from
2120
- Restore the wt.basis->wt.state changes.
2122
There isn't a single operation at the moment to do that, so we:
2123
- Merge current state -> basis tree of the master w.r.t. the old tree
2125
- Do a 'normal' merge of the old branch basis if it is relevant.
2127
if self.branch.get_bound_location() is not None:
2129
update_branch = True
2131
self.lock_tree_write()
2132
update_branch = False
2135
old_tip = self.branch.update(possible_transports)
2138
return self._update_tree(old_tip, change_reporter)
2142
@needs_tree_write_lock
2143
def _update_tree(self, old_tip=None, change_reporter=None):
2144
"""Update a tree to the master branch.
2146
:param old_tip: if supplied, the previous tip revision the branch,
2147
before it was changed to the master branch's tip.
2149
# here if old_tip is not None, it is the old tip of the branch before
2150
# it was updated from the master branch. This should become a pending
2151
# merge in the working tree to preserve the user existing work. we
2152
# cant set that until we update the working trees last revision to be
2153
# one from the new branch, because it will just get absorbed by the
2154
# parent de-duplication logic.
2156
# We MUST save it even if an error occurs, because otherwise the users
2157
# local work is unreferenced and will appear to have been lost.
2161
last_rev = self.get_parent_ids()[0]
2163
last_rev = _mod_revision.NULL_REVISION
2164
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2165
# merge tree state up to new branch tip.
2166
basis = self.basis_tree()
2169
to_tree = self.branch.basis_tree()
2170
if basis.inventory.root is None:
2171
self.set_root_id(to_tree.get_root_id())
2173
result += merge.merge_inner(
2178
change_reporter=change_reporter)
2181
# TODO - dedup parents list with things merged by pull ?
2182
# reuse the tree we've updated to to set the basis:
2183
parent_trees = [(self.branch.last_revision(), to_tree)]
2184
merges = self.get_parent_ids()[1:]
2185
# Ideally we ask the tree for the trees here, that way the working
2186
# tree can decide whether to give us teh entire tree or give us a
2187
# lazy initialised tree. dirstate for instance will have the trees
2188
# in ram already, whereas a last-revision + basis-inventory tree
2189
# will not, but also does not need them when setting parents.
2190
for parent in merges:
2191
parent_trees.append(
2192
(parent, self.branch.repository.revision_tree(parent)))
2193
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2194
parent_trees.append(
2195
(old_tip, self.branch.repository.revision_tree(old_tip)))
2196
self.set_parent_trees(parent_trees)
2197
last_rev = parent_trees[0][0]
2199
# the working tree had the same last-revision as the master
2200
# branch did. We may still have pivot local work from the local
2201
# branch into old_tip:
2202
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2203
self.add_parent_tree_id(old_tip)
2204
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2205
and old_tip != last_rev):
2206
# our last revision was not the prior branch last revision
2207
# and we have converted that last revision to a pending merge.
2208
# base is somewhere between the branch tip now
2209
# and the now pending merge
2211
# Since we just modified the working tree and inventory, flush out
2212
# the current state, before we modify it again.
2213
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2214
# requires it only because TreeTransform directly munges the
2215
# inventory and calls tree._write_inventory(). Ultimately we
2216
# should be able to remove this extra flush.
2218
graph = self.branch.repository.get_graph()
2219
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2221
base_tree = self.branch.repository.revision_tree(base_rev_id)
2222
other_tree = self.branch.repository.revision_tree(old_tip)
2223
result += merge.merge_inner(
2228
change_reporter=change_reporter)
2231
def _write_hashcache_if_dirty(self):
2232
"""Write out the hashcache if it is dirty."""
2233
if self._hashcache.needs_write:
2235
self._hashcache.write()
2237
if e.errno not in (errno.EPERM, errno.EACCES):
2239
# TODO: jam 20061219 Should this be a warning? A single line
2240
# warning might be sufficient to let the user know what
2242
mutter('Could not write hashcache for %s\nError: %s',
2243
self._hashcache.cache_file_name(), e)
2245
@needs_tree_write_lock
2246
def _write_inventory(self, inv):
2247
"""Write inventory as the current inventory."""
2248
self._set_inventory(inv, dirty=True)
2251
def set_conflicts(self, arg):
2252
raise errors.UnsupportedOperation(self.set_conflicts, self)
2254
def add_conflicts(self, arg):
2255
raise errors.UnsupportedOperation(self.add_conflicts, self)
2258
def conflicts(self):
2259
conflicts = _mod_conflicts.ConflictList()
2260
for conflicted in self._iter_conflicts():
2263
if file_kind(self.abspath(conflicted)) != "file":
2265
except errors.NoSuchFile:
2268
for suffix in ('.THIS', '.OTHER'):
2270
kind = file_kind(self.abspath(conflicted+suffix))
2273
except errors.NoSuchFile:
2277
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2278
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2280
file_id=self.path2id(conflicted)))
2283
def walkdirs(self, prefix=""):
2284
"""Walk the directories of this tree.
2286
returns a generator which yields items in the form:
2287
((curren_directory_path, fileid),
2288
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2291
This API returns a generator, which is only valid during the current
2292
tree transaction - within a single lock_read or lock_write duration.
2294
If the tree is not locked, it may cause an error to be raised,
2295
depending on the tree implementation.
2297
disk_top = self.abspath(prefix)
2298
if disk_top.endswith('/'):
2299
disk_top = disk_top[:-1]
2300
top_strip_len = len(disk_top) + 1
2301
inventory_iterator = self._walkdirs(prefix)
2302
disk_iterator = osutils.walkdirs(disk_top, prefix)
2304
current_disk = disk_iterator.next()
2305
disk_finished = False
2307
if not (e.errno == errno.ENOENT or
2308
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2311
disk_finished = True
2313
current_inv = inventory_iterator.next()
2314
inv_finished = False
2315
except StopIteration:
2318
while not inv_finished or not disk_finished:
2320
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2321
cur_disk_dir_content) = current_disk
2323
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2324
cur_disk_dir_content) = ((None, None), None)
2325
if not disk_finished:
2326
# strip out .bzr dirs
2327
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2328
len(cur_disk_dir_content) > 0):
2329
# osutils.walkdirs can be made nicer -
2330
# yield the path-from-prefix rather than the pathjoined
2332
bzrdir_loc = bisect_left(cur_disk_dir_content,
2334
if (bzrdir_loc < len(cur_disk_dir_content)
2335
and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2336
# we dont yield the contents of, or, .bzr itself.
2337
del cur_disk_dir_content[bzrdir_loc]
2339
# everything is unknown
2342
# everything is missing
2345
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2347
# disk is before inventory - unknown
2348
dirblock = [(relpath, basename, kind, stat, None, None) for
2349
relpath, basename, kind, stat, top_path in
2350
cur_disk_dir_content]
2351
yield (cur_disk_dir_relpath, None), dirblock
2353
current_disk = disk_iterator.next()
2354
except StopIteration:
2355
disk_finished = True
2357
# inventory is before disk - missing.
2358
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2359
for relpath, basename, dkind, stat, fileid, kind in
2361
yield (current_inv[0][0], current_inv[0][1]), dirblock
2363
current_inv = inventory_iterator.next()
2364
except StopIteration:
2367
# versioned present directory
2368
# merge the inventory and disk data together
2370
for relpath, subiterator in itertools.groupby(sorted(
2371
current_inv[1] + cur_disk_dir_content,
2372
key=operator.itemgetter(0)), operator.itemgetter(1)):
2373
path_elements = list(subiterator)
2374
if len(path_elements) == 2:
2375
inv_row, disk_row = path_elements
2376
# versioned, present file
2377
dirblock.append((inv_row[0],
2378
inv_row[1], disk_row[2],
2379
disk_row[3], inv_row[4],
2381
elif len(path_elements[0]) == 5:
2383
dirblock.append((path_elements[0][0],
2384
path_elements[0][1], path_elements[0][2],
2385
path_elements[0][3], None, None))
2386
elif len(path_elements[0]) == 6:
2387
# versioned, absent file.
2388
dirblock.append((path_elements[0][0],
2389
path_elements[0][1], 'unknown', None,
2390
path_elements[0][4], path_elements[0][5]))
2392
raise NotImplementedError('unreachable code')
2393
yield current_inv[0], dirblock
2395
current_inv = inventory_iterator.next()
2396
except StopIteration:
2399
current_disk = disk_iterator.next()
2400
except StopIteration:
2401
disk_finished = True
2403
def _walkdirs(self, prefix=""):
2404
"""Walk the directories of this tree.
2406
:prefix: is used as the directrory to start with.
2407
returns a generator which yields items in the form:
2408
((curren_directory_path, fileid),
2409
[(file1_path, file1_name, file1_kind, None, file1_id,
2412
_directory = 'directory'
2413
# get the root in the inventory
2414
inv = self.inventory
2415
top_id = inv.path2id(prefix)
2419
pending = [(prefix, '', _directory, None, top_id, None)]
2422
currentdir = pending.pop()
2423
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2424
top_id = currentdir[4]
2426
relroot = currentdir[0] + '/'
2429
# FIXME: stash the node in pending
2431
if entry.kind == 'directory':
2432
for name, child in entry.sorted_children():
2433
dirblock.append((relroot + name, name, child.kind, None,
2434
child.file_id, child.kind
2436
yield (currentdir[0], entry.file_id), dirblock
2437
# push the user specified dirs from dirblock
2438
for dir in reversed(dirblock):
2439
if dir[2] == _directory:
2442
@needs_tree_write_lock
2443
def auto_resolve(self):
2444
"""Automatically resolve text conflicts according to contents.
2446
Only text conflicts are auto_resolvable. Files with no conflict markers
2447
are considered 'resolved', because bzr always puts conflict markers
2448
into files that have text conflicts. The corresponding .THIS .BASE and
2449
.OTHER files are deleted, as per 'resolve'.
2450
:return: a tuple of ConflictLists: (un_resolved, resolved).
2452
un_resolved = _mod_conflicts.ConflictList()
2453
resolved = _mod_conflicts.ConflictList()
2454
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2455
for conflict in self.conflicts():
2456
if (conflict.typestring != 'text conflict' or
2457
self.kind(conflict.file_id) != 'file'):
2458
un_resolved.append(conflict)
2460
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2462
for line in my_file:
2463
if conflict_re.search(line):
2464
un_resolved.append(conflict)
280
if fnmatch.fnmatchcase(filename, newpat):
2467
resolved.append(conflict)
2470
resolved.remove_files(self)
2471
self.set_conflicts(un_resolved)
2472
return un_resolved, resolved
2476
tree_basis = self.basis_tree()
2477
tree_basis.lock_read()
2479
repo_basis = self.branch.repository.revision_tree(
2480
self.last_revision())
2481
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2482
raise errors.BzrCheckError(
2483
"Mismatched basis inventory content.")
2488
def _validate(self):
2489
"""Validate internal structures.
2491
This is meant mostly for the test suite. To give it a chance to detect
2492
corruption after actions have occurred. The default implementation is a
2495
:return: None. An exception should be raised if there is an error.
2500
def _get_rules_searcher(self, default_searcher):
2501
"""See Tree._get_rules_searcher."""
2502
if self._rules_searcher is None:
2503
self._rules_searcher = super(WorkingTree,
2504
self)._get_rules_searcher(default_searcher)
2505
return self._rules_searcher
2508
class WorkingTree2(WorkingTree):
2509
"""This is the Format 2 working tree.
2511
This was the first weave based working tree.
2512
- uses os locks for locking.
2513
- uses the branch last-revision.
2516
def __init__(self, *args, **kwargs):
2517
super(WorkingTree2, self).__init__(*args, **kwargs)
2518
# WorkingTree2 has more of a constraint that self._inventory must
2519
# exist. Because this is an older format, we don't mind the overhead
2520
# caused by the extra computation here.
2522
# Newer WorkingTree's should only have self._inventory set when they
2524
if self._inventory is None:
2525
self.read_working_inventory()
2527
def lock_tree_write(self):
2528
"""See WorkingTree.lock_tree_write().
2530
In Format2 WorkingTrees we have a single lock for the branch and tree
2531
so lock_tree_write() degrades to lock_write().
2533
self.branch.lock_write()
2535
return self._control_files.lock_write()
2537
self.branch.unlock()
2541
# do non-implementation specific cleanup
2544
# we share control files:
2545
if self._control_files._lock_count == 3:
2546
# _inventory_is_modified is always False during a read lock.
2547
if self._inventory_is_modified:
2549
self._write_hashcache_if_dirty()
2551
# reverse order of locking.
2553
return self._control_files.unlock()
2555
self.branch.unlock()
2558
class WorkingTree3(WorkingTree):
2559
"""This is the Format 3 working tree.
2561
This differs from the base WorkingTree by:
2562
- having its own file lock
2563
- having its own last-revision property.
2565
This is new in bzr 0.8
2569
def _last_revision(self):
2570
"""See Mutable.last_revision."""
2572
return self._transport.get_bytes('last-revision')
2573
except errors.NoSuchFile:
2574
return _mod_revision.NULL_REVISION
2576
def _change_last_revision(self, revision_id):
2577
"""See WorkingTree._change_last_revision."""
2578
if revision_id is None or revision_id == NULL_REVISION:
2580
self._transport.delete('last-revision')
2581
except errors.NoSuchFile:
2585
self._transport.put_bytes('last-revision', revision_id,
2586
mode=self._control_files._file_mode)
2589
@needs_tree_write_lock
2590
def set_conflicts(self, conflicts):
2591
self._put_rio('conflicts', conflicts.to_stanzas(),
2594
@needs_tree_write_lock
2595
def add_conflicts(self, new_conflicts):
2596
conflict_set = set(self.conflicts())
2597
conflict_set.update(set(list(new_conflicts)))
2598
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2599
key=_mod_conflicts.Conflict.sort_key)))
2602
def conflicts(self):
2604
confile = self._transport.get('conflicts')
2605
except errors.NoSuchFile:
2606
return _mod_conflicts.ConflictList()
2609
if confile.next() != CONFLICT_HEADER_1 + '\n':
2610
raise errors.ConflictFormatError()
2611
except StopIteration:
2612
raise errors.ConflictFormatError()
2613
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2618
# do non-implementation specific cleanup
2620
if self._control_files._lock_count == 1:
2621
# _inventory_is_modified is always False during a read lock.
2622
if self._inventory_is_modified:
2624
self._write_hashcache_if_dirty()
2625
# reverse order of locking.
2627
return self._control_files.unlock()
2629
self.branch.unlock()
2632
def get_conflicted_stem(path):
2633
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2634
if path.endswith(suffix):
2635
return path[:-len(suffix)]
2638
class WorkingTreeFormat(object):
2639
"""An encapsulation of the initialization and open routines for a format.
2641
Formats provide three things:
2642
* An initialization routine,
2646
Formats are placed in an dict by their format string for reference
2647
during workingtree opening. Its not required that these be instances, they
2648
can be classes themselves with class methods - it simply depends on
2649
whether state is needed for a given format or not.
2651
Once a format is deprecated, just deprecate the initialize and open
2652
methods on the format class. Do not deprecate the object, as the
2653
object will be created every time regardless.
2656
_default_format = None
2657
"""The default format used for new trees."""
2660
"""The known formats."""
2662
requires_rich_root = False
2664
upgrade_recommended = False
2667
def find_format(klass, a_bzrdir):
2668
"""Return the format for the working tree object in a_bzrdir."""
2670
transport = a_bzrdir.get_workingtree_transport(None)
2671
format_string = transport.get("format").read()
2672
return klass._formats[format_string]
2673
except errors.NoSuchFile:
2674
raise errors.NoWorkingTree(base=transport.base)
2676
raise errors.UnknownFormatError(format=format_string,
2677
kind="working tree")
2679
def __eq__(self, other):
2680
return self.__class__ is other.__class__
2682
def __ne__(self, other):
2683
return not (self == other)
2686
def get_default_format(klass):
2687
"""Return the current default format."""
2688
return klass._default_format
2690
def get_format_string(self):
2691
"""Return the ASCII format string that identifies this format."""
2692
raise NotImplementedError(self.get_format_string)
2694
def get_format_description(self):
2695
"""Return the short description for this format."""
2696
raise NotImplementedError(self.get_format_description)
2698
def is_supported(self):
2699
"""Is this format supported?
2701
Supported formats can be initialized and opened.
2702
Unsupported formats may not support initialization or committing or
2703
some other features depending on the reason for not being supported.
2708
def register_format(klass, format):
2709
klass._formats[format.get_format_string()] = format
2712
def set_default_format(klass, format):
2713
klass._default_format = format
2716
def unregister_format(klass, format):
2717
del klass._formats[format.get_format_string()]
2720
class WorkingTreeFormat2(WorkingTreeFormat):
2721
"""The second working tree format.
2723
This format modified the hash cache from the format 1 hash cache.
2726
upgrade_recommended = True
2728
def get_format_description(self):
2729
"""See WorkingTreeFormat.get_format_description()."""
2730
return "Working tree format 2"
2732
def _stub_initialize_on_transport(self, transport, file_mode):
2733
"""Workaround: create control files for a remote working tree.
2735
This ensures that it can later be updated and dealt with locally,
2736
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2737
no working tree. (See bug #43064).
2741
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2743
transport.put_file('inventory', sio, file_mode)
2744
transport.put_bytes('pending-merges', '', file_mode)
2746
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2747
accelerator_tree=None, hardlink=False):
2748
"""See WorkingTreeFormat.initialize()."""
2749
if not isinstance(a_bzrdir.transport, LocalTransport):
2750
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2751
if from_branch is not None:
2752
branch = from_branch
2754
branch = a_bzrdir.open_branch()
2755
if revision_id is None:
2756
revision_id = _mod_revision.ensure_null(branch.last_revision())
2759
branch.generate_revision_history(revision_id)
2763
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2769
basis_tree = branch.repository.revision_tree(revision_id)
2770
if basis_tree.inventory.root is not None:
2771
wt.set_root_id(basis_tree.get_root_id())
2772
# set the parent list and cache the basis tree.
2773
if _mod_revision.is_null(revision_id):
2776
parent_trees = [(revision_id, basis_tree)]
2777
wt.set_parent_trees(parent_trees)
2778
transform.build_tree(basis_tree, wt)
2782
super(WorkingTreeFormat2, self).__init__()
2783
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2785
def open(self, a_bzrdir, _found=False):
2786
"""Return the WorkingTree object for a_bzrdir
2788
_found is a private parameter, do not use it. It is used to indicate
2789
if format probing has already been done.
2792
# we are being called directly and must probe.
2793
raise NotImplementedError
2794
if not isinstance(a_bzrdir.transport, LocalTransport):
2795
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2796
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2802
class WorkingTreeFormat3(WorkingTreeFormat):
2803
"""The second working tree format updated to record a format marker.
2806
- exists within a metadir controlling .bzr
2807
- includes an explicit version marker for the workingtree control
2808
files, separate from the BzrDir format
2809
- modifies the hash cache format
2811
- uses a LockDir to guard access for writes.
2814
upgrade_recommended = True
2816
def get_format_string(self):
2817
"""See WorkingTreeFormat.get_format_string()."""
2818
return "Bazaar-NG Working Tree format 3"
2820
def get_format_description(self):
2821
"""See WorkingTreeFormat.get_format_description()."""
2822
return "Working tree format 3"
2824
_lock_file_name = 'lock'
2825
_lock_class = LockDir
2827
_tree_class = WorkingTree3
2829
def __get_matchingbzrdir(self):
2830
return bzrdir.BzrDirMetaFormat1()
2832
_matchingbzrdir = property(__get_matchingbzrdir)
2834
def _open_control_files(self, a_bzrdir):
2835
transport = a_bzrdir.get_workingtree_transport(None)
2836
return LockableFiles(transport, self._lock_file_name,
2839
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2840
accelerator_tree=None, hardlink=False):
2841
"""See WorkingTreeFormat.initialize().
2843
:param revision_id: if supplied, create a working tree at a different
2844
revision than the branch is at.
2845
:param accelerator_tree: A tree which can be used for retrieving file
2846
contents more quickly than the revision tree, i.e. a workingtree.
2847
The revision tree will be used for cases where accelerator_tree's
2848
content is different.
2849
:param hardlink: If true, hard-link files from accelerator_tree,
2852
if not isinstance(a_bzrdir.transport, LocalTransport):
2853
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2854
transport = a_bzrdir.get_workingtree_transport(self)
2855
control_files = self._open_control_files(a_bzrdir)
2856
control_files.create_lock()
2857
control_files.lock_write()
2858
transport.put_bytes('format', self.get_format_string(),
2859
mode=control_files._file_mode)
2860
if from_branch is not None:
2861
branch = from_branch
2863
branch = a_bzrdir.open_branch()
2864
if revision_id is None:
2865
revision_id = _mod_revision.ensure_null(branch.last_revision())
2866
# WorkingTree3 can handle an inventory which has a unique root id.
2867
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2868
# those trees. And because there isn't a format bump inbetween, we
2869
# are maintaining compatibility with older clients.
2870
# inv = Inventory(root_id=gen_root_id())
2871
inv = self._initial_inventory()
2872
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2878
_control_files=control_files)
2879
wt.lock_tree_write()
2881
basis_tree = branch.repository.revision_tree(revision_id)
2882
# only set an explicit root id if there is one to set.
2883
if basis_tree.inventory.root is not None:
2884
wt.set_root_id(basis_tree.get_root_id())
2885
if revision_id == NULL_REVISION:
2886
wt.set_parent_trees([])
283
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
2888
wt.set_parent_trees([(revision_id, basis_tree)])
2889
transform.build_tree(basis_tree, wt)
2891
# Unlock in this order so that the unlock-triggers-flush in
2892
# WorkingTree is given a chance to fire.
2893
control_files.unlock()
2897
def _initial_inventory(self):
2901
super(WorkingTreeFormat3, self).__init__()
2903
def open(self, a_bzrdir, _found=False):
2904
"""Return the WorkingTree object for a_bzrdir
2906
_found is a private parameter, do not use it. It is used to indicate
2907
if format probing has already been done.
2910
# we are being called directly and must probe.
2911
raise NotImplementedError
2912
if not isinstance(a_bzrdir.transport, LocalTransport):
2913
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2914
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2917
def _open(self, a_bzrdir, control_files):
2918
"""Open the tree itself.
2920
:param a_bzrdir: the dir for the tree.
2921
:param control_files: the control files for the tree.
2923
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2927
_control_files=control_files)
2930
return self.get_format_string()
2933
__default_format = WorkingTreeFormat4()
2934
WorkingTreeFormat.register_format(__default_format)
2935
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2936
WorkingTreeFormat.set_default_format(__default_format)
2937
# formats which have no format string are not discoverable
2938
# and not independently creatable, so are not registered.
2939
_legacy_formats = [WorkingTreeFormat2(),