68
380
inv = self._inventory
69
381
for path, ie in inv.iter_entries():
70
if os.path.exists(self.abspath(path)):
382
if osutils.lexists(self.abspath(path)):
385
def all_file_ids(self):
386
"""See Tree.iter_all_file_ids"""
387
return set(self.inventory)
74
389
def __repr__(self):
75
390
return "<%s of %s>" % (self.__class__.__name__,
76
391
getattr(self, 'basedir', None))
80
393
def abspath(self, filename):
81
return os.path.join(self.basedir, filename)
394
return pathjoin(self.basedir, filename)
396
def basis_tree(self):
397
"""Return RevisionTree for the current last revision.
399
If the left most parent is a ghost then the returned tree will be an
400
empty tree - one obtained by calling
401
repository.revision_tree(NULL_REVISION).
404
revision_id = self.get_parent_ids()[0]
406
# no parents, return an empty revision tree.
407
# in the future this should return the tree for
408
# 'empty:' - the implicit root empty tree.
409
return self.branch.repository.revision_tree(
410
_mod_revision.NULL_REVISION)
412
return self.revision_tree(revision_id)
413
except errors.NoSuchRevision:
415
# No cached copy available, retrieve from the repository.
416
# FIXME? RBC 20060403 should we cache the inventory locally
419
return self.branch.repository.revision_tree(revision_id)
420
except (errors.RevisionNotPresent, errors.NoSuchRevision):
421
# the basis tree *may* be a ghost or a low level error may have
422
# occurred. If the revision is present, its a problem, if its not
424
if self.branch.repository.has_revision(revision_id):
426
# the basis tree is a ghost so return an empty tree.
427
return self.branch.repository.revision_tree(
428
_mod_revision.NULL_REVISION)
431
self._flush_ignore_list_cache()
433
def relpath(self, path):
434
"""Return the local path portion from a given path.
436
The path may be absolute or relative. If its a relative path it is
437
interpreted relative to the python current working directory.
439
return osutils.relpath(self.basedir, path)
83
441
def has_filename(self, filename):
84
return os.path.exists(self.abspath(filename))
86
def get_file(self, file_id):
87
return self.get_file_byname(self.id2path(file_id))
89
def get_file_byname(self, filename):
90
return file(self.abspath(filename), 'rb')
442
return osutils.lexists(self.abspath(filename))
444
def get_file(self, file_id, path=None, filtered=True):
445
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
447
def get_file_with_stat(self, file_id, path=None, filtered=True,
449
"""See Tree.get_file_with_stat."""
451
path = self.id2path(file_id)
452
file_obj = self.get_file_byname(path, filtered=False)
453
stat_value = _fstat(file_obj.fileno())
454
if self.supports_content_filtering() and filtered:
455
filters = self._content_filter_stack(path)
456
file_obj = filtered_input_file(file_obj, filters)
457
return (file_obj, stat_value)
459
def get_file_text(self, file_id, path=None, filtered=True):
460
return self.get_file(file_id, path=path, filtered=filtered).read()
462
def get_file_byname(self, filename, filtered=True):
463
path = self.abspath(filename)
465
if self.supports_content_filtering() and filtered:
466
filters = self._content_filter_stack(filename)
467
return filtered_input_file(f, filters)
471
def get_file_lines(self, file_id, path=None, filtered=True):
472
"""See Tree.get_file_lines()"""
473
file = self.get_file(file_id, path, filtered=filtered)
475
return file.readlines()
480
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
481
"""See Tree.annotate_iter
483
This implementation will use the basis tree implementation if possible.
484
Lines not in the basis are attributed to CURRENT_REVISION
486
If there are pending merges, lines added by those merges will be
487
incorrectly attributed to CURRENT_REVISION (but after committing, the
488
attribution will be correct).
490
basis = self.basis_tree()
493
changes = self.iter_changes(basis, True, [self.id2path(file_id)],
494
require_versioned=True).next()
495
changed_content, kind = changes[2], changes[6]
496
if not changed_content:
497
return basis.annotate_iter(file_id)
501
if kind[0] != 'file':
504
old_lines = list(basis.annotate_iter(file_id))
506
for tree in self.branch.repository.revision_trees(
507
self.get_parent_ids()[1:]):
508
if file_id not in tree:
510
old.append(list(tree.annotate_iter(file_id)))
511
return annotate.reannotate(old, self.get_file(file_id).readlines(),
516
def _get_ancestors(self, default_revision):
517
ancestors = set([default_revision])
518
for parent_id in self.get_parent_ids():
519
ancestors.update(self.branch.repository.get_ancestry(
520
parent_id, topo_sorted=False))
523
def get_parent_ids(self):
524
"""See Tree.get_parent_ids.
526
This implementation reads the pending merges list and last_revision
527
value and uses that to decide what the parents list should be.
529
last_rev = _mod_revision.ensure_null(self._last_revision())
530
if _mod_revision.NULL_REVISION == last_rev:
535
merges_file = self._transport.get('pending-merges')
536
except errors.NoSuchFile:
539
for l in merges_file.readlines():
540
revision_id = l.rstrip('\n')
541
parents.append(revision_id)
545
def get_root_id(self):
546
"""Return the id of this trees root"""
547
return self._inventory.root.file_id
92
549
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))
550
## XXX: badly named; this is not in the store at all
551
return self.abspath(self.id2path(file_id))
554
def clone(self, to_bzrdir, revision_id=None):
555
"""Duplicate this working tree into to_bzr, including all state.
557
Specifically modified files are kept as modified, but
558
ignored and unknown files are discarded.
560
If you want to make a new line of development, see bzrdir.sprout()
563
If not None, the cloned tree will have its last revision set to
564
revision, and difference between the source trees last revision
565
and this one merged in.
567
# assumes the target bzr dir format is compatible.
568
result = to_bzrdir.create_workingtree()
569
self.copy_content_into(result, revision_id)
573
def copy_content_into(self, tree, revision_id=None):
574
"""Copy the current content and user files of this tree into tree."""
575
tree.set_root_id(self.get_root_id())
576
if revision_id is None:
577
merge.transform_tree(tree, self)
579
# TODO now merge from tree.last_revision to revision (to preserve
580
# user local changes)
581
merge.transform_tree(tree, self)
582
tree.set_parent_ids([revision_id])
584
def id2abspath(self, file_id):
585
return self.abspath(self.id2path(file_id))
97
587
def has_id(self, file_id):
98
588
# files that have been deleted are excluded
100
590
if not inv.has_id(file_id):
102
592
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
593
return osutils.lexists(self.abspath(path))
595
def has_or_had_id(self, file_id):
596
if file_id == self.inventory.root.file_id:
598
return self.inventory.has_id(file_id)
106
600
__contains__ = has_id
109
602
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).
603
"""See Tree.get_file_size"""
605
return os.path.getsize(self.id2abspath(file_id))
607
if e.errno != errno.ENOENT:
613
def get_file_sha1(self, file_id, path=None, stat_value=None):
615
path = self._inventory.id2path(file_id)
616
return self._hashcache.get_sha1(path, stat_value)
618
def get_file_mtime(self, file_id, path=None):
620
path = self.inventory.id2path(file_id)
621
return os.lstat(self.abspath(path)).st_mtime
623
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
624
file_id = self.path2id(path)
625
return self._inventory[file_id].executable
627
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
628
mode = stat_result.st_mode
629
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
631
if not supports_executable():
632
def is_executable(self, file_id, path=None):
633
return self._inventory[file_id].executable
635
_is_executable_from_path_and_stat = \
636
_is_executable_from_path_and_stat_from_basis
638
def is_executable(self, file_id, path=None):
640
path = self.id2path(file_id)
641
mode = os.lstat(self.abspath(path)).st_mode
642
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
644
_is_executable_from_path_and_stat = \
645
_is_executable_from_path_and_stat_from_stat
647
@needs_tree_write_lock
648
def _add(self, files, ids, kinds):
649
"""See MutableTree._add."""
650
# TODO: Re-adding a file that is removed in the working copy
651
# should probably put it back with the previous ID.
652
# the read and write working inventory should not occur in this
653
# function - they should be part of lock_write and unlock.
655
for f, file_id, kind in zip(files, ids, kinds):
657
inv.add_path(f, kind=kind)
659
inv.add_path(f, kind=kind, file_id=file_id)
660
self._inventory_is_modified = True
662
@needs_tree_write_lock
663
def _gather_kinds(self, files, kinds):
664
"""See MutableTree._gather_kinds."""
665
for pos, f in enumerate(files):
666
if kinds[pos] is None:
667
fullpath = normpath(self.abspath(f))
669
kinds[pos] = file_kind(fullpath)
671
if e.errno == errno.ENOENT:
672
raise errors.NoSuchFile(fullpath)
675
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
676
"""Add revision_id as a parent.
678
This is equivalent to retrieving the current list of parent ids
679
and setting the list to its value plus revision_id.
681
:param revision_id: The revision id to add to the parent list. It may
682
be a ghost revision as long as its not the first parent to be added,
683
or the allow_leftmost_as_ghost parameter is set True.
684
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
686
parents = self.get_parent_ids() + [revision_id]
687
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
688
or allow_leftmost_as_ghost)
690
@needs_tree_write_lock
691
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
692
"""Add revision_id, tree tuple as a parent.
694
This is equivalent to retrieving the current list of parent trees
695
and setting the list to its value plus parent_tuple. See also
696
add_parent_tree_id - if you only have a parent id available it will be
697
simpler to use that api. If you have the parent already available, using
698
this api is preferred.
700
:param parent_tuple: The (revision id, tree) to add to the parent list.
701
If the revision_id is a ghost, pass None for the tree.
702
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
704
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
705
if len(parent_ids) > 1:
706
# the leftmost may have already been a ghost, preserve that if it
708
allow_leftmost_as_ghost = True
709
self.set_parent_ids(parent_ids,
710
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
712
@needs_tree_write_lock
713
def add_pending_merge(self, *revision_ids):
714
# TODO: Perhaps should check at this point that the
715
# history of the revision is actually present?
716
parents = self.get_parent_ids()
718
for rev_id in revision_ids:
719
if rev_id in parents:
721
parents.append(rev_id)
724
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
726
def path_content_summary(self, path, _lstat=os.lstat,
727
_mapper=osutils.file_kind_from_stat_mode):
728
"""See Tree.path_content_summary."""
729
abspath = self.abspath(path)
731
stat_result = _lstat(abspath)
733
if getattr(e, 'errno', None) == errno.ENOENT:
735
return ('missing', None, None, None)
736
# propagate other errors
738
kind = _mapper(stat_result.st_mode)
740
size = stat_result.st_size
741
# try for a stat cache lookup
742
executable = self._is_executable_from_path_and_stat(path, stat_result)
743
return (kind, size, executable, self._sha_from_stat(
745
elif kind == 'directory':
746
# perhaps it looks like a plain directory, but it's really a
748
if self._directory_is_tree_reference(path):
749
kind = 'tree-reference'
750
return kind, None, None, None
751
elif kind == 'symlink':
752
target = osutils.readlink(abspath)
753
return ('symlink', None, None, target)
755
return (kind, None, None, None)
757
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
758
"""Common ghost checking functionality from set_parent_*.
760
This checks that the left hand-parent exists if there are any
763
if len(revision_ids) > 0:
764
leftmost_id = revision_ids[0]
765
if (not allow_leftmost_as_ghost and not
766
self.branch.repository.has_revision(leftmost_id)):
767
raise errors.GhostRevisionUnusableHere(leftmost_id)
769
def _set_merges_from_parent_ids(self, parent_ids):
770
merges = parent_ids[1:]
771
self._transport.put_bytes('pending-merges', '\n'.join(merges),
772
mode=self.bzrdir._get_file_mode())
774
def _filter_parent_ids_by_ancestry(self, revision_ids):
775
"""Check that all merged revisions are proper 'heads'.
777
This will always return the first revision_id, and any merged revisions
780
if len(revision_ids) == 0:
782
graph = self.branch.repository.get_graph()
783
heads = graph.heads(revision_ids)
784
new_revision_ids = revision_ids[:1]
785
for revision_id in revision_ids[1:]:
786
if revision_id in heads and revision_id not in new_revision_ids:
787
new_revision_ids.append(revision_id)
788
if new_revision_ids != revision_ids:
789
trace.mutter('requested to set revision_ids = %s,'
790
' but filtered to %s', revision_ids, new_revision_ids)
791
return new_revision_ids
793
@needs_tree_write_lock
794
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
795
"""Set the parent ids to revision_ids.
797
See also set_parent_trees. This api will try to retrieve the tree data
798
for each element of revision_ids from the trees repository. If you have
799
tree data already available, it is more efficient to use
800
set_parent_trees rather than set_parent_ids. set_parent_ids is however
801
an easier API to use.
803
:param revision_ids: The revision_ids to set as the parent ids of this
804
working tree. Any of these may be ghosts.
806
self._check_parents_for_ghosts(revision_ids,
807
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
808
for revision_id in revision_ids:
809
_mod_revision.check_not_reserved_id(revision_id)
811
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
813
if len(revision_ids) > 0:
814
self.set_last_revision(revision_ids[0])
816
self.set_last_revision(_mod_revision.NULL_REVISION)
818
self._set_merges_from_parent_ids(revision_ids)
820
@needs_tree_write_lock
821
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
822
"""See MutableTree.set_parent_trees."""
823
parent_ids = [rev for (rev, tree) in parents_list]
824
for revision_id in parent_ids:
825
_mod_revision.check_not_reserved_id(revision_id)
827
self._check_parents_for_ghosts(parent_ids,
828
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
830
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
832
if len(parent_ids) == 0:
833
leftmost_parent_id = _mod_revision.NULL_REVISION
834
leftmost_parent_tree = None
836
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
838
if self._change_last_revision(leftmost_parent_id):
839
if leftmost_parent_tree is None:
840
# If we don't have a tree, fall back to reading the
841
# parent tree from the repository.
842
self._cache_basis_inventory(leftmost_parent_id)
844
inv = leftmost_parent_tree.inventory
845
xml = self._create_basis_xml_from_inventory(
846
leftmost_parent_id, inv)
847
self._write_basis_inventory(xml)
848
self._set_merges_from_parent_ids(parent_ids)
850
@needs_tree_write_lock
851
def set_pending_merges(self, rev_list):
852
parents = self.get_parent_ids()
853
leftmost = parents[:1]
854
new_parents = leftmost + rev_list
855
self.set_parent_ids(new_parents)
857
@needs_tree_write_lock
858
def set_merge_modified(self, modified_hashes):
860
for file_id, hash in modified_hashes.iteritems():
861
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
862
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
864
def _sha_from_stat(self, path, stat_result):
865
"""Get a sha digest from the tree's stat cache.
867
The default implementation assumes no stat cache is present.
869
:param path: The path.
870
:param stat_result: The stat result being looked up.
874
def _put_rio(self, filename, stanzas, header):
875
self._must_be_locked()
876
my_file = rio_file(stanzas, header)
877
self._transport.put_file(filename, my_file,
878
mode=self.bzrdir._get_file_mode())
880
@needs_write_lock # because merge pulls data into the branch.
881
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
883
"""Merge from a branch into this working tree.
885
:param branch: The branch to merge from.
886
:param to_revision: If non-None, the merge will merge to to_revision,
887
but not beyond it. to_revision does not need to be in the history
888
of the branch when it is supplied. If None, to_revision defaults to
889
branch.last_revision().
891
from bzrlib.merge import Merger, Merge3Merger
892
pb = bzrlib.ui.ui_factory.nested_progress_bar()
894
merger = Merger(self.branch, this_tree=self, pb=pb)
895
merger.pp = ProgressPhase("Merge phase", 5, pb)
896
merger.pp.next_phase()
897
# check that there are no
899
merger.check_basis(check_clean=True, require_commits=False)
900
if to_revision is None:
901
to_revision = _mod_revision.ensure_null(branch.last_revision())
902
merger.other_rev_id = to_revision
903
if _mod_revision.is_null(merger.other_rev_id):
904
raise errors.NoCommits(branch)
905
self.branch.fetch(branch, last_revision=merger.other_rev_id)
906
merger.other_basis = merger.other_rev_id
907
merger.other_tree = self.branch.repository.revision_tree(
909
merger.other_branch = branch
910
merger.pp.next_phase()
911
if from_revision is None:
914
merger.set_base_revision(from_revision, branch)
915
if merger.base_rev_id == merger.other_rev_id:
916
raise errors.PointlessMerge
917
merger.backup_files = False
918
if merge_type is None:
919
merger.merge_type = Merge3Merger
921
merger.merge_type = merge_type
922
merger.set_interesting_files(None)
923
merger.show_base = False
924
merger.reprocess = False
925
conflicts = merger.do_merge()
932
def merge_modified(self):
933
"""Return a dictionary of files modified by a merge.
935
The list is initialized by WorkingTree.set_merge_modified, which is
936
typically called after we make some automatic updates to the tree
939
This returns a map of file_id->sha1, containing only files which are
940
still in the working inventory and have that text hash.
943
hashfile = self._transport.get('merge-hashes')
944
except errors.NoSuchFile:
949
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
950
raise errors.MergeModifiedFormatError()
951
except StopIteration:
952
raise errors.MergeModifiedFormatError()
953
for s in RioReader(hashfile):
954
# RioReader reads in Unicode, so convert file_ids back to utf8
955
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
956
if file_id not in self.inventory:
958
text_hash = s.get("hash")
959
if text_hash == self.get_file_sha1(file_id):
960
merge_hashes[file_id] = text_hash
966
def mkdir(self, path, file_id=None):
967
"""See MutableTree.mkdir()."""
969
file_id = generate_ids.gen_file_id(os.path.basename(path))
970
os.mkdir(self.abspath(path))
971
self.add(path, file_id, 'directory')
974
def get_symlink_target(self, file_id):
975
abspath = self.id2abspath(file_id)
976
target = osutils.readlink(abspath)
980
def subsume(self, other_tree):
981
def add_children(inventory, entry):
982
for child_entry in entry.children.values():
983
inventory._byid[child_entry.file_id] = child_entry
984
if child_entry.kind == 'directory':
985
add_children(inventory, child_entry)
986
if other_tree.get_root_id() == self.get_root_id():
987
raise errors.BadSubsumeSource(self, other_tree,
988
'Trees have the same root')
990
other_tree_path = self.relpath(other_tree.basedir)
991
except errors.PathNotChild:
992
raise errors.BadSubsumeSource(self, other_tree,
993
'Tree is not contained by the other')
994
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
995
if new_root_parent is None:
996
raise errors.BadSubsumeSource(self, other_tree,
997
'Parent directory is not versioned.')
998
# We need to ensure that the result of a fetch will have a
999
# versionedfile for the other_tree root, and only fetching into
1000
# RepositoryKnit2 guarantees that.
1001
if not self.branch.repository.supports_rich_root():
1002
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1003
other_tree.lock_tree_write()
1005
new_parents = other_tree.get_parent_ids()
1006
other_root = other_tree.inventory.root
1007
other_root.parent_id = new_root_parent
1008
other_root.name = osutils.basename(other_tree_path)
1009
self.inventory.add(other_root)
1010
add_children(self.inventory, other_root)
1011
self._write_inventory(self.inventory)
1012
# normally we don't want to fetch whole repositories, but i think
1013
# here we really do want to consolidate the whole thing.
1014
for parent_id in other_tree.get_parent_ids():
1015
self.branch.fetch(other_tree.branch, parent_id)
1016
self.add_parent_tree_id(parent_id)
1019
other_tree.bzrdir.retire_bzrdir()
1021
def _setup_directory_is_tree_reference(self):
1022
if self._branch.repository._format.supports_tree_reference:
1023
self._directory_is_tree_reference = \
1024
self._directory_may_be_tree_reference
1026
self._directory_is_tree_reference = \
1027
self._directory_is_never_tree_reference
1029
def _directory_is_never_tree_reference(self, relpath):
1032
def _directory_may_be_tree_reference(self, relpath):
1033
# as a special case, if a directory contains control files then
1034
# it's a tree reference, except that the root of the tree is not
1035
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1036
# TODO: We could ask all the control formats whether they
1037
# recognize this directory, but at the moment there's no cheap api
1038
# to do that. Since we probably can only nest bzr checkouts and
1039
# they always use this name it's ok for now. -- mbp 20060306
1041
# FIXME: There is an unhandled case here of a subdirectory
1042
# containing .bzr but not a branch; that will probably blow up
1043
# when you try to commit it. It might happen if there is a
1044
# checkout in a subdirectory. This can be avoided by not adding
1047
@needs_tree_write_lock
1048
def extract(self, file_id, format=None):
1049
"""Extract a subtree from this tree.
1051
A new branch will be created, relative to the path for this tree.
1055
segments = osutils.splitpath(path)
1056
transport = self.branch.bzrdir.root_transport
1057
for name in segments:
1058
transport = transport.clone(name)
1059
transport.ensure_base()
1062
sub_path = self.id2path(file_id)
1063
branch_transport = mkdirs(sub_path)
1065
format = self.bzrdir.cloning_metadir()
1066
branch_transport.ensure_base()
1067
branch_bzrdir = format.initialize_on_transport(branch_transport)
1069
repo = branch_bzrdir.find_repository()
1070
except errors.NoRepositoryPresent:
1071
repo = branch_bzrdir.create_repository()
1072
if not repo.supports_rich_root():
1073
raise errors.RootNotRich()
1074
new_branch = branch_bzrdir.create_branch()
1075
new_branch.pull(self.branch)
1076
for parent_id in self.get_parent_ids():
1077
new_branch.fetch(self.branch, parent_id)
1078
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1079
if tree_transport.base != branch_transport.base:
1080
tree_bzrdir = format.initialize_on_transport(tree_transport)
1081
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1083
tree_bzrdir = branch_bzrdir
1084
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1085
wt.set_parent_ids(self.get_parent_ids())
1086
my_inv = self.inventory
1087
child_inv = Inventory(root_id=None)
1088
new_root = my_inv[file_id]
1089
my_inv.remove_recursive_id(file_id)
1090
new_root.parent_id = None
1091
child_inv.add(new_root)
1092
self._write_inventory(my_inv)
1093
wt._write_inventory(child_inv)
1096
def _serialize(self, inventory, out_file):
1097
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1100
def _deserialize(selt, in_file):
1101
return xml5.serializer_v5.read_inventory(in_file)
1104
"""Write the in memory inventory to disk."""
1105
# TODO: Maybe this should only write on dirty ?
1106
if self._control_files._lock_mode != 'w':
1107
raise errors.NotWriteLocked(self)
1109
self._serialize(self._inventory, sio)
1111
self._transport.put_file('inventory', sio,
1112
mode=self.bzrdir._get_file_mode())
1113
self._inventory_is_modified = False
1115
def _kind(self, relpath):
1116
return osutils.file_kind(self.abspath(relpath))
1118
def list_files(self, include_root=False):
1119
"""Recursively list all files as (path, class, kind, id, entry).
131
1121
Lists, but does not descend into unversioned directories.
136
1126
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):
1128
# list_files is an iterator, so @needs_read_lock doesn't work properly
1129
# with it. So callers should be careful to always read_lock the tree.
1130
if not self.is_locked():
1131
raise errors.ObjectNotLocked(self)
1133
inv = self.inventory
1134
if include_root is True:
1135
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1136
# Convert these into local objects to save lookup times
1137
pathjoin = osutils.pathjoin
1138
file_kind = self._kind
1140
# transport.base ends in a slash, we want the piece
1141
# between the last two slashes
1142
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1144
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1146
# directory file_id, relative path, absolute path, reverse sorted children
1147
children = os.listdir(self.basedir)
1149
# jam 20060527 The kernel sized tree seems equivalent whether we
1150
# use a deque and popleft to keep them sorted, or if we use a plain
1151
# list and just reverse() them.
1152
children = collections.deque(children)
1153
stack = [(inv.root.file_id, u'', self.basedir, children)]
1155
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1158
f = children.popleft()
147
1159
## TODO: If we find a subdirectory with its own .bzr
148
1160
## directory, then that is a separate tree and we
149
1161
## should exclude it.
150
if bzrlib.BZRDIR == f:
1163
# the bzrdir for this tree
1164
if transport_base_dir == f:
154
fp = appendpath(from_dir_relpath, f)
1167
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1168
# and 'f' doesn't begin with one, we can do a string op, rather
1169
# than the checks of pathjoin(), all relative paths will have an extra slash
1171
fp = from_dir_relpath + '/' + f
157
fap = appendpath(dp, f)
1174
fap = from_dir_abspath + '/' + f
159
1176
f_ie = inv.get_child(from_dir_id, f)
162
elif self.is_ignored(fp):
1179
elif self.is_ignored(fp[1:]):
1182
# we may not have found this file, because of a unicode issue
1183
f_norm, can_access = osutils.normalized_filename(f)
1184
if f == f_norm or not can_access:
1185
# No change, so treat this file normally
1188
# this file can be accessed by a normalized path
1189
# check again if it is versioned
1190
# these lines are repeated here for performance
1192
fp = from_dir_relpath + '/' + f
1193
fap = from_dir_abspath + '/' + f
1194
f_ie = inv.get_child(from_dir_id, f)
1197
elif self.is_ignored(fp[1:]):
167
1202
fk = file_kind(fap)
1204
# 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)
1206
yield fp[1:], c, fk, f_ie.file_id, f_ie
1209
yield fp[1:], c, fk, None, fk_entries[fk]()
1211
yield fp[1:], c, fk, None, TreeEntry()
177
1214
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):
1217
# But do this child first
1218
new_children = os.listdir(fap)
1220
new_children = collections.deque(new_children)
1221
stack.append((f_ie.file_id, fp, fap, new_children))
1222
# Break out of inner loop,
1223
# so that we start outer loop with child
1226
# if we finished all children, pop it off the stack
1229
@needs_tree_write_lock
1230
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1233
to_dir must exist in the inventory.
1235
If to_dir exists and is a directory, the files are moved into
1236
it, keeping their old names.
1238
Note that to_dir is only the last component of the new name;
1239
this doesn't change the directory.
1241
For each entry in from_paths the move mode will be determined
1244
The first mode moves the file in the filesystem and updates the
1245
inventory. The second mode only updates the inventory without
1246
touching the file on the filesystem. This is the new mode introduced
1249
move uses the second mode if 'after == True' and the target is not
1250
versioned but present in the working tree.
1252
move uses the second mode if 'after == False' and the source is
1253
versioned but no longer in the working tree, and the target is not
1254
versioned but present in the working tree.
1256
move uses the first mode if 'after == False' and the source is
1257
versioned and present in the working tree, and the target is not
1258
versioned and not present in the working tree.
1260
Everything else results in an error.
1262
This returns a list of (from_path, to_path) pairs for each
1263
entry that is moved.
1268
# check for deprecated use of signature
1270
to_dir = kwargs.get('to_name', None)
1272
raise TypeError('You must supply a target directory')
1274
symbol_versioning.warn('The parameter to_name was deprecated'
1275
' in version 0.13. Use to_dir instead',
1278
# check destination directory
1279
if isinstance(from_paths, basestring):
1281
inv = self.inventory
1282
to_abs = self.abspath(to_dir)
1283
if not isdir(to_abs):
1284
raise errors.BzrMoveFailedError('',to_dir,
1285
errors.NotADirectory(to_abs))
1286
if not self.has_filename(to_dir):
1287
raise errors.BzrMoveFailedError('',to_dir,
1288
errors.NotInWorkingDirectory(to_dir))
1289
to_dir_id = inv.path2id(to_dir)
1290
if to_dir_id is None:
1291
raise errors.BzrMoveFailedError('',to_dir,
1292
errors.NotVersionedError(path=str(to_dir)))
1294
to_dir_ie = inv[to_dir_id]
1295
if to_dir_ie.kind != 'directory':
1296
raise errors.BzrMoveFailedError('',to_dir,
1297
errors.NotADirectory(to_abs))
1299
# create rename entries and tuples
1300
for from_rel in from_paths:
1301
from_tail = splitpath(from_rel)[-1]
1302
from_id = inv.path2id(from_rel)
1304
raise errors.BzrMoveFailedError(from_rel,to_dir,
1305
errors.NotVersionedError(path=str(from_rel)))
1307
from_entry = inv[from_id]
1308
from_parent_id = from_entry.parent_id
1309
to_rel = pathjoin(to_dir, from_tail)
1310
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1312
from_tail=from_tail,
1313
from_parent_id=from_parent_id,
1314
to_rel=to_rel, to_tail=from_tail,
1315
to_parent_id=to_dir_id)
1316
rename_entries.append(rename_entry)
1317
rename_tuples.append((from_rel, to_rel))
1319
# determine which move mode to use. checks also for movability
1320
rename_entries = self._determine_mv_mode(rename_entries, after)
1322
original_modified = self._inventory_is_modified
1325
self._inventory_is_modified = True
1326
self._move(rename_entries)
1328
# restore the inventory on error
1329
self._inventory_is_modified = original_modified
1331
self._write_inventory(inv)
1332
return rename_tuples
1334
def _determine_mv_mode(self, rename_entries, after=False):
1335
"""Determines for each from-to pair if both inventory and working tree
1336
or only the inventory has to be changed.
1338
Also does basic plausability tests.
1340
inv = self.inventory
1342
for rename_entry in rename_entries:
1343
# store to local variables for easier reference
1344
from_rel = rename_entry.from_rel
1345
from_id = rename_entry.from_id
1346
to_rel = rename_entry.to_rel
1347
to_id = inv.path2id(to_rel)
1348
only_change_inv = False
1350
# check the inventory for source and destination
1352
raise errors.BzrMoveFailedError(from_rel,to_rel,
1353
errors.NotVersionedError(path=str(from_rel)))
1354
if to_id is not None:
1355
raise errors.BzrMoveFailedError(from_rel,to_rel,
1356
errors.AlreadyVersionedError(path=str(to_rel)))
1358
# try to determine the mode for rename (only change inv or change
1359
# inv and file system)
1361
if not self.has_filename(to_rel):
1362
raise errors.BzrMoveFailedError(from_id,to_rel,
1363
errors.NoSuchFile(path=str(to_rel),
1364
extra="New file has not been created yet"))
1365
only_change_inv = True
1366
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1367
only_change_inv = True
1368
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1369
only_change_inv = False
1370
elif (not self.case_sensitive
1371
and from_rel.lower() == to_rel.lower()
1372
and self.has_filename(from_rel)):
1373
only_change_inv = False
1375
# something is wrong, so lets determine what exactly
1376
if not self.has_filename(from_rel) and \
1377
not self.has_filename(to_rel):
1378
raise errors.BzrRenameFailedError(from_rel,to_rel,
1379
errors.PathsDoNotExist(paths=(str(from_rel),
1382
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1383
rename_entry.only_change_inv = only_change_inv
1384
return rename_entries
1386
def _move(self, rename_entries):
1387
"""Moves a list of files.
1389
Depending on the value of the flag 'only_change_inv', the
1390
file will be moved on the file system or not.
1392
inv = self.inventory
1395
for entry in rename_entries:
1397
self._move_entry(entry)
1399
self._rollback_move(moved)
1403
def _rollback_move(self, moved):
1404
"""Try to rollback a previous move in case of an filesystem error."""
1405
inv = self.inventory
1408
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1409
entry.to_tail, entry.to_parent_id, entry.from_rel,
1410
entry.from_tail, entry.from_parent_id,
1411
entry.only_change_inv))
1412
except errors.BzrMoveFailedError, e:
1413
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1414
" The working tree is in an inconsistent state."
1415
" Please consider doing a 'bzr revert'."
1416
" Error message is: %s" % e)
1418
def _move_entry(self, entry):
1419
inv = self.inventory
1420
from_rel_abs = self.abspath(entry.from_rel)
1421
to_rel_abs = self.abspath(entry.to_rel)
1422
if from_rel_abs == to_rel_abs:
1423
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1424
"Source and target are identical.")
1426
if not entry.only_change_inv:
1428
osutils.rename(from_rel_abs, to_rel_abs)
1430
raise errors.BzrMoveFailedError(entry.from_rel,
1432
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1434
@needs_tree_write_lock
1435
def rename_one(self, from_rel, to_rel, after=False):
1438
This can change the directory or the filename or both.
1440
rename_one has several 'modes' to work. First, it can rename a physical
1441
file and change the file_id. That is the normal mode. Second, it can
1442
only change the file_id without touching any physical file. This is
1443
the new mode introduced in version 0.15.
1445
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1446
versioned but present in the working tree.
1448
rename_one uses the second mode if 'after == False' and 'from_rel' is
1449
versioned but no longer in the working tree, and 'to_rel' is not
1450
versioned but present in the working tree.
1452
rename_one uses the first mode if 'after == False' and 'from_rel' is
1453
versioned and present in the working tree, and 'to_rel' is not
1454
versioned and not present in the working tree.
1456
Everything else results in an error.
1458
inv = self.inventory
1461
# create rename entries and tuples
1462
from_tail = splitpath(from_rel)[-1]
1463
from_id = inv.path2id(from_rel)
1465
raise errors.BzrRenameFailedError(from_rel,to_rel,
1466
errors.NotVersionedError(path=str(from_rel)))
1467
from_entry = inv[from_id]
1468
from_parent_id = from_entry.parent_id
1469
to_dir, to_tail = os.path.split(to_rel)
1470
to_dir_id = inv.path2id(to_dir)
1471
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1473
from_tail=from_tail,
1474
from_parent_id=from_parent_id,
1475
to_rel=to_rel, to_tail=to_tail,
1476
to_parent_id=to_dir_id)
1477
rename_entries.append(rename_entry)
1479
# determine which move mode to use. checks also for movability
1480
rename_entries = self._determine_mv_mode(rename_entries, after)
1482
# check if the target changed directory and if the target directory is
1484
if to_dir_id is None:
1485
raise errors.BzrMoveFailedError(from_rel,to_rel,
1486
errors.NotVersionedError(path=str(to_dir)))
1488
# all checks done. now we can continue with our actual work
1489
mutter('rename_one:\n'
1494
' to_dir_id {%s}\n',
1495
from_id, from_rel, to_rel, to_dir, to_dir_id)
1497
self._move(rename_entries)
1498
self._write_inventory(inv)
1500
class _RenameEntry(object):
1501
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1502
to_rel, to_tail, to_parent_id, only_change_inv=False):
1503
self.from_rel = from_rel
1504
self.from_id = from_id
1505
self.from_tail = from_tail
1506
self.from_parent_id = from_parent_id
1507
self.to_rel = to_rel
1508
self.to_tail = to_tail
1509
self.to_parent_id = to_parent_id
1510
self.only_change_inv = only_change_inv
192
1513
def unknowns(self):
193
for subp in self.extras():
194
if not self.is_ignored(subp):
1514
"""Return all unknown files.
1516
These are files in the working directory that are not versioned or
1517
control files or ignored.
1519
# force the extras method to be fully executed before returning, to
1520
# prevent race conditions with the lock
1522
[subp for subp in self.extras() if not self.is_ignored(subp)])
1524
@needs_tree_write_lock
1525
def unversion(self, file_ids):
1526
"""Remove the file ids in file_ids from the current versioned set.
1528
When a file_id is unversioned, all of its children are automatically
1531
:param file_ids: The file ids to stop versioning.
1532
:raises: NoSuchId if any fileid is not currently versioned.
1534
for file_id in file_ids:
1535
if file_id not in self._inventory:
1536
raise errors.NoSuchId(self, file_id)
1537
for file_id in file_ids:
1538
if self._inventory.has_id(file_id):
1539
self._inventory.remove_recursive_id(file_id)
1541
# in the future this should just set a dirty bit to wait for the
1542
# final unlock. However, until all methods of workingtree start
1543
# with the current in -memory inventory rather than triggering
1544
# a read, it is more complex - we need to teach read_inventory
1545
# to know when to read, and when to not read first... and possibly
1546
# to save first when the in memory one may be corrupted.
1547
# so for now, we just only write it if it is indeed dirty.
1549
self._write_inventory(self._inventory)
1551
def _iter_conflicts(self):
1553
for info in self.list_files():
1555
stem = get_conflicted_stem(path)
1558
if stem not in conflicted:
1559
conflicted.add(stem)
1563
def pull(self, source, overwrite=False, stop_revision=None,
1564
change_reporter=None, possible_transports=None, local=False):
1565
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1568
pp = ProgressPhase("Pull phase", 2, top_pb)
1570
old_revision_info = self.branch.last_revision_info()
1571
basis_tree = self.basis_tree()
1572
count = self.branch.pull(source, overwrite, stop_revision,
1573
possible_transports=possible_transports,
1575
new_revision_info = self.branch.last_revision_info()
1576
if new_revision_info != old_revision_info:
1578
repository = self.branch.repository
1579
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1580
basis_tree.lock_read()
1582
new_basis_tree = self.branch.basis_tree()
1589
change_reporter=change_reporter)
1590
if (basis_tree.inventory.root is None and
1591
new_basis_tree.inventory.root is not None):
1592
self.set_root_id(new_basis_tree.get_root_id())
1596
# TODO - dedup parents list with things merged by pull ?
1597
# reuse the revisiontree we merged against to set the new
1599
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1600
# we have to pull the merge trees out again, because
1601
# merge_inner has set the ids. - this corner is not yet
1602
# layered well enough to prevent double handling.
1603
# XXX TODO: Fix the double handling: telling the tree about
1604
# the already known parent data is wasteful.
1605
merges = self.get_parent_ids()[1:]
1606
parent_trees.extend([
1607
(parent, repository.revision_tree(parent)) for
1609
self.set_parent_trees(parent_trees)
1616
def put_file_bytes_non_atomic(self, file_id, bytes):
1617
"""See MutableTree.put_file_bytes_non_atomic."""
1618
stream = file(self.id2abspath(file_id), 'wb')
1623
# TODO: update the hashcache here ?
198
1625
def extras(self):
199
"""Yield all unknown files in this WorkingTree.
1626
"""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
1628
If there are any unversioned directories then only the directory is
1629
returned, not all its children. But if there are unversioned files
203
1630
under a versioned subdirectory, they are returned.
205
1632
Currently returned depth-first, sorted by name within directories.
1633
This is the same order used by 'osutils.walkdirs'.
207
1635
## TODO: Work from given directory downwards
208
from osutils import isdir, appendpath
210
1636
for path, dir_entry in self.inventory.directories():
211
mutter("search for unknowns in %r" % path)
1637
# mutter("search for unknowns in %r", path)
212
1638
dirabs = self.abspath(path)
213
1639
if not isdir(dirabs):
214
1640
# e.g. directory deleted
259
1706
If the file is ignored, returns the pattern which caused it to
260
1707
be ignored, otherwise None. So this can simply be used as a
261
1708
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] == '.\\'):
1709
if getattr(self, '_ignoreglobster', None) is None:
1710
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1711
return self._ignoreglobster.match(filename)
1713
def kind(self, file_id):
1714
return file_kind(self.id2abspath(file_id))
1716
def stored_kind(self, file_id):
1717
"""See Tree.stored_kind"""
1718
return self.inventory[file_id].kind
1720
def _comparison_data(self, entry, path):
1721
abspath = self.abspath(path)
1723
stat_value = os.lstat(abspath)
1725
if getattr(e, 'errno', None) == errno.ENOENT:
1732
mode = stat_value.st_mode
1733
kind = osutils.file_kind_from_stat_mode(mode)
1734
if not supports_executable():
1735
executable = entry is not None and entry.executable
1737
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1738
return kind, executable, stat_value
1740
def _file_size(self, entry, stat_value):
1741
return stat_value.st_size
1743
def last_revision(self):
1744
"""Return the last revision of the branch for this tree.
1746
This format tree does not support a separate marker for last-revision
1747
compared to the branch.
1749
See MutableTree.last_revision
1751
return self._last_revision()
1754
def _last_revision(self):
1755
"""helper for get_parent_ids."""
1756
return _mod_revision.ensure_null(self.branch.last_revision())
1758
def is_locked(self):
1759
return self._control_files.is_locked()
1761
def _must_be_locked(self):
1762
if not self.is_locked():
1763
raise errors.ObjectNotLocked(self)
1765
def lock_read(self):
1766
"""See Branch.lock_read, and WorkingTree.unlock."""
1767
if not self.is_locked():
1769
self.branch.lock_read()
1771
return self._control_files.lock_read()
1773
self.branch.unlock()
1776
def lock_tree_write(self):
1777
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1778
if not self.is_locked():
1780
self.branch.lock_read()
1782
return self._control_files.lock_write()
1784
self.branch.unlock()
1787
def lock_write(self):
1788
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1789
if not self.is_locked():
1791
self.branch.lock_write()
1793
return self._control_files.lock_write()
1795
self.branch.unlock()
1798
def get_physical_lock_status(self):
1799
return self._control_files.get_physical_lock_status()
1801
def _basis_inventory_name(self):
1802
return 'basis-inventory-cache'
1804
def _reset_data(self):
1805
"""Reset transient data that cannot be revalidated."""
1806
self._inventory_is_modified = False
1807
result = self._deserialize(self._transport.get('inventory'))
1808
self._set_inventory(result, dirty=False)
1810
@needs_tree_write_lock
1811
def set_last_revision(self, new_revision):
1812
"""Change the last revision in the working tree."""
1813
if self._change_last_revision(new_revision):
1814
self._cache_basis_inventory(new_revision)
1816
def _change_last_revision(self, new_revision):
1817
"""Template method part of set_last_revision to perform the change.
1819
This is used to allow WorkingTree3 instances to not affect branch
1820
when their last revision is set.
1822
if _mod_revision.is_null(new_revision):
1823
self.branch.set_revision_history([])
1826
self.branch.generate_revision_history(new_revision)
1827
except errors.NoSuchRevision:
1828
# not present in the repo - dont try to set it deeper than the tip
1829
self.branch.set_revision_history([new_revision])
1832
def _write_basis_inventory(self, xml):
1833
"""Write the basis inventory XML to the basis-inventory file"""
1834
path = self._basis_inventory_name()
1836
self._transport.put_file(path, sio,
1837
mode=self.bzrdir._get_file_mode())
1839
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1840
"""Create the text that will be saved in basis-inventory"""
1841
inventory.revision_id = revision_id
1842
return xml7.serializer_v7.write_inventory_to_string(inventory)
1844
def _cache_basis_inventory(self, new_revision):
1845
"""Cache new_revision as the basis inventory."""
1846
# TODO: this should allow the ready-to-use inventory to be passed in,
1847
# as commit already has that ready-to-use [while the format is the
1850
# this double handles the inventory - unpack and repack -
1851
# but is easier to understand. We can/should put a conditional
1852
# in here based on whether the inventory is in the latest format
1853
# - perhaps we should repack all inventories on a repository
1855
# the fast path is to copy the raw xml from the repository. If the
1856
# xml contains 'revision_id="', then we assume the right
1857
# revision_id is set. We must check for this full string, because a
1858
# root node id can legitimately look like 'revision_id' but cannot
1860
xml = self.branch.repository.get_inventory_xml(new_revision)
1861
firstline = xml.split('\n', 1)[0]
1862
if (not 'revision_id="' in firstline or
1863
'format="7"' not in firstline):
1864
inv = self.branch.repository.deserialise_inventory(
1866
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1867
self._write_basis_inventory(xml)
1868
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1871
def read_basis_inventory(self):
1872
"""Read the cached basis inventory."""
1873
path = self._basis_inventory_name()
1874
return self._transport.get_bytes(path)
1877
def read_working_inventory(self):
1878
"""Read the working inventory.
1880
:raises errors.InventoryModified: read_working_inventory will fail
1881
when the current in memory inventory has been modified.
1883
# conceptually this should be an implementation detail of the tree.
1884
# XXX: Deprecate this.
1885
# ElementTree does its own conversion from UTF-8, so open in
1887
if self._inventory_is_modified:
1888
raise errors.InventoryModified(self)
1889
result = self._deserialize(self._transport.get('inventory'))
1890
self._set_inventory(result, dirty=False)
1893
@needs_tree_write_lock
1894
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1896
"""Remove nominated files from the working inventory.
1898
:files: File paths relative to the basedir.
1899
:keep_files: If true, the files will also be kept.
1900
:force: Delete files and directories, even if they are changed and
1901
even if the directories are not empty.
1903
if isinstance(files, basestring):
1909
unknown_nested_files=set()
1911
def recurse_directory_to_add_files(directory):
1912
# Recurse directory and add all files
1913
# so we can check if they have changed.
1914
for parent_info, file_infos in\
1915
self.walkdirs(directory):
1916
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1917
# Is it versioned or ignored?
1918
if self.path2id(relpath) or self.is_ignored(relpath):
1919
# Add nested content for deletion.
1920
new_files.add(relpath)
1922
# Files which are not versioned and not ignored
1923
# should be treated as unknown.
1924
unknown_nested_files.add((relpath, None, kind))
1926
for filename in files:
1927
# Get file name into canonical form.
1928
abspath = self.abspath(filename)
1929
filename = self.relpath(abspath)
1930
if len(filename) > 0:
1931
new_files.add(filename)
1932
recurse_directory_to_add_files(filename)
1934
files = list(new_files)
1937
return # nothing to do
1939
# Sort needed to first handle directory content before the directory
1940
files.sort(reverse=True)
1942
# Bail out if we are going to delete files we shouldn't
1943
if not keep_files and not force:
1944
has_changed_files = len(unknown_nested_files) > 0
1945
if not has_changed_files:
1946
for (file_id, path, content_change, versioned, parent_id, name,
1947
kind, executable) in self.iter_changes(self.basis_tree(),
1948
include_unchanged=True, require_versioned=False,
1949
want_unversioned=True, specific_files=files):
1950
if versioned == (False, False):
1951
# The record is unknown ...
1952
if not self.is_ignored(path[1]):
1953
# ... but not ignored
1954
has_changed_files = True
1956
elif content_change and (kind[1] is not None):
1957
# Versioned and changed, but not deleted
1958
has_changed_files = True
1961
if has_changed_files:
1962
# Make delta show ALL applicable changes in error message.
1963
tree_delta = self.changes_from(self.basis_tree(),
1964
require_versioned=False, want_unversioned=True,
1965
specific_files=files)
1966
for unknown_file in unknown_nested_files:
1967
if unknown_file not in tree_delta.unversioned:
1968
tree_delta.unversioned.extend((unknown_file,))
1969
raise errors.BzrRemoveChangedFilesError(tree_delta)
1971
# Build inv_delta and delete files where applicable,
1972
# do this before any modifications to inventory.
1974
fid = self.path2id(f)
1977
message = "%s is not versioned." % (f,)
1980
# having removed it, it must be either ignored or unknown
1981
if self.is_ignored(f):
1985
textui.show_status(new_status, self.kind(fid), f,
1988
inv_delta.append((f, None, fid, None))
1989
message = "removed %s" % (f,)
1992
abs_path = self.abspath(f)
1993
if osutils.lexists(abs_path):
1994
if (osutils.isdir(abs_path) and
1995
len(os.listdir(abs_path)) > 0):
1997
osutils.rmtree(abs_path)
1999
message = "%s is not an empty directory "\
2000
"and won't be deleted." % (f,)
2002
osutils.delete_any(abs_path)
2003
message = "deleted %s" % (f,)
2004
elif message is not None:
2005
# Only care if we haven't done anything yet.
2006
message = "%s does not exist." % (f,)
2008
# Print only one message (if any) per file.
2009
if message is not None:
2011
self.apply_inventory_delta(inv_delta)
2013
@needs_tree_write_lock
2014
def revert(self, filenames=None, old_tree=None, backups=True,
2015
pb=DummyProgress(), report_changes=False):
2016
from bzrlib.conflicts import resolve
2019
symbol_versioning.warn('Using [] to revert all files is deprecated'
2020
' as of bzr 0.91. Please use None (the default) instead.',
2021
DeprecationWarning, stacklevel=2)
2022
if old_tree is None:
2023
basis_tree = self.basis_tree()
2024
basis_tree.lock_read()
2025
old_tree = basis_tree
2029
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2031
if filenames is None and len(self.get_parent_ids()) > 1:
2033
last_revision = self.last_revision()
2034
if last_revision != NULL_REVISION:
2035
if basis_tree is None:
2036
basis_tree = self.basis_tree()
2037
basis_tree.lock_read()
2038
parent_trees.append((last_revision, basis_tree))
2039
self.set_parent_trees(parent_trees)
2042
resolve(self, filenames, ignore_misses=True, recursive=True)
2044
if basis_tree is not None:
2048
def revision_tree(self, revision_id):
2049
"""See Tree.revision_tree.
2051
WorkingTree can supply revision_trees for the basis revision only
2052
because there is only one cached inventory in the bzr directory.
2054
if revision_id == self.last_revision():
2056
xml = self.read_basis_inventory()
2057
except errors.NoSuchFile:
2061
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2062
# dont use the repository revision_tree api because we want
2063
# to supply the inventory.
2064
if inv.revision_id == revision_id:
2065
return revisiontree.RevisionTree(self.branch.repository,
2067
except errors.BadInventoryFormat:
2069
# raise if there was no inventory, or if we read the wrong inventory.
2070
raise errors.NoSuchRevisionInTree(self, revision_id)
2072
# XXX: This method should be deprecated in favour of taking in a proper
2073
# new Inventory object.
2074
@needs_tree_write_lock
2075
def set_inventory(self, new_inventory_list):
2076
from bzrlib.inventory import (Inventory,
2081
inv = Inventory(self.get_root_id())
2082
for path, file_id, parent, kind in new_inventory_list:
2083
name = os.path.basename(path)
2086
# fixme, there should be a factory function inv,add_??
2087
if kind == 'directory':
2088
inv.add(InventoryDirectory(file_id, name, parent))
2089
elif kind == 'file':
2090
inv.add(InventoryFile(file_id, name, parent))
2091
elif kind == 'symlink':
2092
inv.add(InventoryLink(file_id, name, parent))
2094
raise errors.BzrError("unknown kind %r" % kind)
2095
self._write_inventory(inv)
2097
@needs_tree_write_lock
2098
def set_root_id(self, file_id):
2099
"""Set the root id for this tree."""
2103
'WorkingTree.set_root_id with fileid=None')
2104
file_id = osutils.safe_file_id(file_id)
2105
self._set_root_id(file_id)
2107
def _set_root_id(self, file_id):
2108
"""Set the root id for this tree, in a format specific manner.
2110
:param file_id: The file id to assign to the root. It must not be
2111
present in the current inventory or an error will occur. It must
2112
not be None, but rather a valid file id.
2114
inv = self._inventory
2115
orig_root_id = inv.root.file_id
2116
# TODO: it might be nice to exit early if there was nothing
2117
# to do, saving us from trigger a sync on unlock.
2118
self._inventory_is_modified = True
2119
# we preserve the root inventory entry object, but
2120
# unlinkit from the byid index
2121
del inv._byid[inv.root.file_id]
2122
inv.root.file_id = file_id
2123
# and link it into the index with the new changed id.
2124
inv._byid[inv.root.file_id] = inv.root
2125
# and finally update all children to reference the new id.
2126
# XXX: this should be safe to just look at the root.children
2127
# list, not the WHOLE INVENTORY.
2130
if entry.parent_id == orig_root_id:
2131
entry.parent_id = inv.root.file_id
2134
"""See Branch.unlock.
2136
WorkingTree locking just uses the Branch locking facilities.
2137
This is current because all working trees have an embedded branch
2138
within them. IF in the future, we were to make branch data shareable
2139
between multiple working trees, i.e. via shared storage, then we
2140
would probably want to lock both the local tree, and the branch.
2142
raise NotImplementedError(self.unlock)
2144
def update(self, change_reporter=None, possible_transports=None):
2145
"""Update a working tree along its branch.
2147
This will update the branch if its bound too, which means we have
2148
multiple trees involved:
2150
- The new basis tree of the master.
2151
- The old basis tree of the branch.
2152
- The old basis tree of the working tree.
2153
- The current working tree state.
2155
Pathologically, all three may be different, and non-ancestors of each
2156
other. Conceptually we want to:
2158
- Preserve the wt.basis->wt.state changes
2159
- Transform the wt.basis to the new master basis.
2160
- Apply a merge of the old branch basis to get any 'local' changes from
2162
- Restore the wt.basis->wt.state changes.
2164
There isn't a single operation at the moment to do that, so we:
2165
- Merge current state -> basis tree of the master w.r.t. the old tree
2167
- Do a 'normal' merge of the old branch basis if it is relevant.
2169
if self.branch.get_bound_location() is not None:
2171
update_branch = True
2173
self.lock_tree_write()
2174
update_branch = False
2177
old_tip = self.branch.update(possible_transports)
2180
return self._update_tree(old_tip, change_reporter)
2184
@needs_tree_write_lock
2185
def _update_tree(self, old_tip=None, change_reporter=None):
2186
"""Update a tree to the master branch.
2188
:param old_tip: if supplied, the previous tip revision the branch,
2189
before it was changed to the master branch's tip.
2191
# here if old_tip is not None, it is the old tip of the branch before
2192
# it was updated from the master branch. This should become a pending
2193
# merge in the working tree to preserve the user existing work. we
2194
# cant set that until we update the working trees last revision to be
2195
# one from the new branch, because it will just get absorbed by the
2196
# parent de-duplication logic.
2198
# We MUST save it even if an error occurs, because otherwise the users
2199
# local work is unreferenced and will appear to have been lost.
2203
last_rev = self.get_parent_ids()[0]
2205
last_rev = _mod_revision.NULL_REVISION
2206
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2207
# merge tree state up to new branch tip.
2208
basis = self.basis_tree()
2211
to_tree = self.branch.basis_tree()
2212
if basis.inventory.root is None:
2213
self.set_root_id(to_tree.get_root_id())
2215
result += merge.merge_inner(
2220
change_reporter=change_reporter)
2223
# TODO - dedup parents list with things merged by pull ?
2224
# reuse the tree we've updated to to set the basis:
2225
parent_trees = [(self.branch.last_revision(), to_tree)]
2226
merges = self.get_parent_ids()[1:]
2227
# Ideally we ask the tree for the trees here, that way the working
2228
# tree can decide whether to give us the entire tree or give us a
2229
# lazy initialised tree. dirstate for instance will have the trees
2230
# in ram already, whereas a last-revision + basis-inventory tree
2231
# will not, but also does not need them when setting parents.
2232
for parent in merges:
2233
parent_trees.append(
2234
(parent, self.branch.repository.revision_tree(parent)))
2235
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2236
parent_trees.append(
2237
(old_tip, self.branch.repository.revision_tree(old_tip)))
2238
self.set_parent_trees(parent_trees)
2239
last_rev = parent_trees[0][0]
2241
# the working tree had the same last-revision as the master
2242
# branch did. We may still have pivot local work from the local
2243
# branch into old_tip:
2244
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2245
self.add_parent_tree_id(old_tip)
2246
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2247
and old_tip != last_rev):
2248
# our last revision was not the prior branch last revision
2249
# and we have converted that last revision to a pending merge.
2250
# base is somewhere between the branch tip now
2251
# and the now pending merge
2253
# Since we just modified the working tree and inventory, flush out
2254
# the current state, before we modify it again.
2255
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2256
# requires it only because TreeTransform directly munges the
2257
# inventory and calls tree._write_inventory(). Ultimately we
2258
# should be able to remove this extra flush.
2260
graph = self.branch.repository.get_graph()
2261
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2263
base_tree = self.branch.repository.revision_tree(base_rev_id)
2264
other_tree = self.branch.repository.revision_tree(old_tip)
2265
result += merge.merge_inner(
2270
change_reporter=change_reporter)
2273
def _write_hashcache_if_dirty(self):
2274
"""Write out the hashcache if it is dirty."""
2275
if self._hashcache.needs_write:
2277
self._hashcache.write()
2279
if e.errno not in (errno.EPERM, errno.EACCES):
2281
# TODO: jam 20061219 Should this be a warning? A single line
2282
# warning might be sufficient to let the user know what
2284
mutter('Could not write hashcache for %s\nError: %s',
2285
self._hashcache.cache_file_name(), e)
2287
@needs_tree_write_lock
2288
def _write_inventory(self, inv):
2289
"""Write inventory as the current inventory."""
2290
self._set_inventory(inv, dirty=True)
2293
def set_conflicts(self, arg):
2294
raise errors.UnsupportedOperation(self.set_conflicts, self)
2296
def add_conflicts(self, arg):
2297
raise errors.UnsupportedOperation(self.add_conflicts, self)
2300
def conflicts(self):
2301
conflicts = _mod_conflicts.ConflictList()
2302
for conflicted in self._iter_conflicts():
2305
if file_kind(self.abspath(conflicted)) != "file":
2307
except errors.NoSuchFile:
2310
for suffix in ('.THIS', '.OTHER'):
2312
kind = file_kind(self.abspath(conflicted+suffix))
2315
except errors.NoSuchFile:
2319
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2320
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2322
file_id=self.path2id(conflicted)))
2325
def walkdirs(self, prefix=""):
2326
"""Walk the directories of this tree.
2328
returns a generator which yields items in the form:
2329
((curren_directory_path, fileid),
2330
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2333
This API returns a generator, which is only valid during the current
2334
tree transaction - within a single lock_read or lock_write duration.
2336
If the tree is not locked, it may cause an error to be raised,
2337
depending on the tree implementation.
2339
disk_top = self.abspath(prefix)
2340
if disk_top.endswith('/'):
2341
disk_top = disk_top[:-1]
2342
top_strip_len = len(disk_top) + 1
2343
inventory_iterator = self._walkdirs(prefix)
2344
disk_iterator = osutils.walkdirs(disk_top, prefix)
2346
current_disk = disk_iterator.next()
2347
disk_finished = False
2349
if not (e.errno == errno.ENOENT or
2350
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2353
disk_finished = True
2355
current_inv = inventory_iterator.next()
2356
inv_finished = False
2357
except StopIteration:
2360
while not inv_finished or not disk_finished:
2362
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2363
cur_disk_dir_content) = current_disk
2365
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2366
cur_disk_dir_content) = ((None, None), None)
2367
if not disk_finished:
2368
# strip out .bzr dirs
2369
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2370
len(cur_disk_dir_content) > 0):
2371
# osutils.walkdirs can be made nicer -
2372
# yield the path-from-prefix rather than the pathjoined
2374
bzrdir_loc = bisect_left(cur_disk_dir_content,
2376
if (bzrdir_loc < len(cur_disk_dir_content)
2377
and self.bzrdir.is_control_filename(
2378
cur_disk_dir_content[bzrdir_loc][0])):
2379
# we dont yield the contents of, or, .bzr itself.
2380
del cur_disk_dir_content[bzrdir_loc]
2382
# everything is unknown
2385
# everything is missing
2388
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2390
# disk is before inventory - unknown
2391
dirblock = [(relpath, basename, kind, stat, None, None) for
2392
relpath, basename, kind, stat, top_path in
2393
cur_disk_dir_content]
2394
yield (cur_disk_dir_relpath, None), dirblock
2396
current_disk = disk_iterator.next()
2397
except StopIteration:
2398
disk_finished = True
2400
# inventory is before disk - missing.
2401
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2402
for relpath, basename, dkind, stat, fileid, kind in
2404
yield (current_inv[0][0], current_inv[0][1]), dirblock
2406
current_inv = inventory_iterator.next()
2407
except StopIteration:
2410
# versioned present directory
2411
# merge the inventory and disk data together
2413
for relpath, subiterator in itertools.groupby(sorted(
2414
current_inv[1] + cur_disk_dir_content,
2415
key=operator.itemgetter(0)), operator.itemgetter(1)):
2416
path_elements = list(subiterator)
2417
if len(path_elements) == 2:
2418
inv_row, disk_row = path_elements
2419
# versioned, present file
2420
dirblock.append((inv_row[0],
2421
inv_row[1], disk_row[2],
2422
disk_row[3], inv_row[4],
2424
elif len(path_elements[0]) == 5:
2426
dirblock.append((path_elements[0][0],
2427
path_elements[0][1], path_elements[0][2],
2428
path_elements[0][3], None, None))
2429
elif len(path_elements[0]) == 6:
2430
# versioned, absent file.
2431
dirblock.append((path_elements[0][0],
2432
path_elements[0][1], 'unknown', None,
2433
path_elements[0][4], path_elements[0][5]))
2435
raise NotImplementedError('unreachable code')
2436
yield current_inv[0], dirblock
2438
current_inv = inventory_iterator.next()
2439
except StopIteration:
2442
current_disk = disk_iterator.next()
2443
except StopIteration:
2444
disk_finished = True
2446
def _walkdirs(self, prefix=""):
2447
"""Walk the directories of this tree.
2449
:prefix: is used as the directrory to start with.
2450
returns a generator which yields items in the form:
2451
((curren_directory_path, fileid),
2452
[(file1_path, file1_name, file1_kind, None, file1_id,
2455
_directory = 'directory'
2456
# get the root in the inventory
2457
inv = self.inventory
2458
top_id = inv.path2id(prefix)
2462
pending = [(prefix, '', _directory, None, top_id, None)]
2465
currentdir = pending.pop()
2466
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2467
top_id = currentdir[4]
2469
relroot = currentdir[0] + '/'
2472
# FIXME: stash the node in pending
2474
if entry.kind == 'directory':
2475
for name, child in entry.sorted_children():
2476
dirblock.append((relroot + name, name, child.kind, None,
2477
child.file_id, child.kind
2479
yield (currentdir[0], entry.file_id), dirblock
2480
# push the user specified dirs from dirblock
2481
for dir in reversed(dirblock):
2482
if dir[2] == _directory:
2485
@needs_tree_write_lock
2486
def auto_resolve(self):
2487
"""Automatically resolve text conflicts according to contents.
2489
Only text conflicts are auto_resolvable. Files with no conflict markers
2490
are considered 'resolved', because bzr always puts conflict markers
2491
into files that have text conflicts. The corresponding .THIS .BASE and
2492
.OTHER files are deleted, as per 'resolve'.
2493
:return: a tuple of ConflictLists: (un_resolved, resolved).
2495
un_resolved = _mod_conflicts.ConflictList()
2496
resolved = _mod_conflicts.ConflictList()
2497
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2498
for conflict in self.conflicts():
2499
if (conflict.typestring != 'text conflict' or
2500
self.kind(conflict.file_id) != 'file'):
2501
un_resolved.append(conflict)
2503
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2505
for line in my_file:
2506
if conflict_re.search(line):
2507
un_resolved.append(conflict)
286
if fnmatch.fnmatchcase(filename, newpat):
2510
resolved.append(conflict)
2513
resolved.remove_files(self)
2514
self.set_conflicts(un_resolved)
2515
return un_resolved, resolved
2519
tree_basis = self.basis_tree()
2520
tree_basis.lock_read()
2522
repo_basis = self.branch.repository.revision_tree(
2523
self.last_revision())
2524
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2525
raise errors.BzrCheckError(
2526
"Mismatched basis inventory content.")
2531
def _validate(self):
2532
"""Validate internal structures.
2534
This is meant mostly for the test suite. To give it a chance to detect
2535
corruption after actions have occurred. The default implementation is a
2538
:return: None. An exception should be raised if there is an error.
2543
def _get_rules_searcher(self, default_searcher):
2544
"""See Tree._get_rules_searcher."""
2545
if self._rules_searcher is None:
2546
self._rules_searcher = super(WorkingTree,
2547
self)._get_rules_searcher(default_searcher)
2548
return self._rules_searcher
2550
def get_shelf_manager(self):
2551
"""Return the ShelfManager for this WorkingTree."""
2552
from bzrlib.shelf import ShelfManager
2553
return ShelfManager(self, self._transport)
2556
class WorkingTree2(WorkingTree):
2557
"""This is the Format 2 working tree.
2559
This was the first weave based working tree.
2560
- uses os locks for locking.
2561
- uses the branch last-revision.
2564
def __init__(self, *args, **kwargs):
2565
super(WorkingTree2, self).__init__(*args, **kwargs)
2566
# WorkingTree2 has more of a constraint that self._inventory must
2567
# exist. Because this is an older format, we don't mind the overhead
2568
# caused by the extra computation here.
2570
# Newer WorkingTree's should only have self._inventory set when they
2572
if self._inventory is None:
2573
self.read_working_inventory()
2575
def lock_tree_write(self):
2576
"""See WorkingTree.lock_tree_write().
2578
In Format2 WorkingTrees we have a single lock for the branch and tree
2579
so lock_tree_write() degrades to lock_write().
2581
self.branch.lock_write()
2583
return self._control_files.lock_write()
2585
self.branch.unlock()
2589
# do non-implementation specific cleanup
2592
# we share control files:
2593
if self._control_files._lock_count == 3:
2594
# _inventory_is_modified is always False during a read lock.
2595
if self._inventory_is_modified:
2597
self._write_hashcache_if_dirty()
2599
# reverse order of locking.
2601
return self._control_files.unlock()
2603
self.branch.unlock()
2606
class WorkingTree3(WorkingTree):
2607
"""This is the Format 3 working tree.
2609
This differs from the base WorkingTree by:
2610
- having its own file lock
2611
- having its own last-revision property.
2613
This is new in bzr 0.8
2617
def _last_revision(self):
2618
"""See Mutable.last_revision."""
2620
return self._transport.get_bytes('last-revision')
2621
except errors.NoSuchFile:
2622
return _mod_revision.NULL_REVISION
2624
def _change_last_revision(self, revision_id):
2625
"""See WorkingTree._change_last_revision."""
2626
if revision_id is None or revision_id == NULL_REVISION:
2628
self._transport.delete('last-revision')
2629
except errors.NoSuchFile:
2633
self._transport.put_bytes('last-revision', revision_id,
2634
mode=self.bzrdir._get_file_mode())
2637
@needs_tree_write_lock
2638
def set_conflicts(self, conflicts):
2639
self._put_rio('conflicts', conflicts.to_stanzas(),
2642
@needs_tree_write_lock
2643
def add_conflicts(self, new_conflicts):
2644
conflict_set = set(self.conflicts())
2645
conflict_set.update(set(list(new_conflicts)))
2646
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2647
key=_mod_conflicts.Conflict.sort_key)))
2650
def conflicts(self):
2652
confile = self._transport.get('conflicts')
2653
except errors.NoSuchFile:
2654
return _mod_conflicts.ConflictList()
2657
if confile.next() != CONFLICT_HEADER_1 + '\n':
2658
raise errors.ConflictFormatError()
2659
except StopIteration:
2660
raise errors.ConflictFormatError()
2661
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2666
# do non-implementation specific cleanup
2668
if self._control_files._lock_count == 1:
2669
# _inventory_is_modified is always False during a read lock.
2670
if self._inventory_is_modified:
2672
self._write_hashcache_if_dirty()
2673
# reverse order of locking.
2675
return self._control_files.unlock()
2677
self.branch.unlock()
2680
def get_conflicted_stem(path):
2681
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2682
if path.endswith(suffix):
2683
return path[:-len(suffix)]
2686
class WorkingTreeFormat(object):
2687
"""An encapsulation of the initialization and open routines for a format.
2689
Formats provide three things:
2690
* An initialization routine,
2694
Formats are placed in an dict by their format string for reference
2695
during workingtree opening. Its not required that these be instances, they
2696
can be classes themselves with class methods - it simply depends on
2697
whether state is needed for a given format or not.
2699
Once a format is deprecated, just deprecate the initialize and open
2700
methods on the format class. Do not deprecate the object, as the
2701
object will be created every time regardless.
2704
_default_format = None
2705
"""The default format used for new trees."""
2708
"""The known formats."""
2710
requires_rich_root = False
2712
upgrade_recommended = False
2715
def find_format(klass, a_bzrdir):
2716
"""Return the format for the working tree object in a_bzrdir."""
2718
transport = a_bzrdir.get_workingtree_transport(None)
2719
format_string = transport.get("format").read()
2720
return klass._formats[format_string]
2721
except errors.NoSuchFile:
2722
raise errors.NoWorkingTree(base=transport.base)
2724
raise errors.UnknownFormatError(format=format_string,
2725
kind="working tree")
2727
def __eq__(self, other):
2728
return self.__class__ is other.__class__
2730
def __ne__(self, other):
2731
return not (self == other)
2734
def get_default_format(klass):
2735
"""Return the current default format."""
2736
return klass._default_format
2738
def get_format_string(self):
2739
"""Return the ASCII format string that identifies this format."""
2740
raise NotImplementedError(self.get_format_string)
2742
def get_format_description(self):
2743
"""Return the short description for this format."""
2744
raise NotImplementedError(self.get_format_description)
2746
def is_supported(self):
2747
"""Is this format supported?
2749
Supported formats can be initialized and opened.
2750
Unsupported formats may not support initialization or committing or
2751
some other features depending on the reason for not being supported.
2755
def supports_content_filtering(self):
2756
"""True if this format supports content filtering."""
2759
def supports_views(self):
2760
"""True if this format supports stored views."""
2764
def register_format(klass, format):
2765
klass._formats[format.get_format_string()] = format
2768
def set_default_format(klass, format):
2769
klass._default_format = format
2772
def unregister_format(klass, format):
2773
del klass._formats[format.get_format_string()]
2776
class WorkingTreeFormat2(WorkingTreeFormat):
2777
"""The second working tree format.
2779
This format modified the hash cache from the format 1 hash cache.
2782
upgrade_recommended = True
2784
def get_format_description(self):
2785
"""See WorkingTreeFormat.get_format_description()."""
2786
return "Working tree format 2"
2788
def _stub_initialize_on_transport(self, transport, file_mode):
2789
"""Workaround: create control files for a remote working tree.
2791
This ensures that it can later be updated and dealt with locally,
2792
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2793
no working tree. (See bug #43064).
2797
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2799
transport.put_file('inventory', sio, file_mode)
2800
transport.put_bytes('pending-merges', '', file_mode)
2802
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2803
accelerator_tree=None, hardlink=False):
2804
"""See WorkingTreeFormat.initialize()."""
2805
if not isinstance(a_bzrdir.transport, LocalTransport):
2806
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2807
if from_branch is not None:
2808
branch = from_branch
2810
branch = a_bzrdir.open_branch()
2811
if revision_id is None:
2812
revision_id = _mod_revision.ensure_null(branch.last_revision())
2815
branch.generate_revision_history(revision_id)
2819
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2825
basis_tree = branch.repository.revision_tree(revision_id)
2826
if basis_tree.inventory.root is not None:
2827
wt.set_root_id(basis_tree.get_root_id())
2828
# set the parent list and cache the basis tree.
2829
if _mod_revision.is_null(revision_id):
2832
parent_trees = [(revision_id, basis_tree)]
2833
wt.set_parent_trees(parent_trees)
2834
transform.build_tree(basis_tree, wt)
2838
super(WorkingTreeFormat2, self).__init__()
2839
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2841
def open(self, a_bzrdir, _found=False):
2842
"""Return the WorkingTree object for a_bzrdir
2844
_found is a private parameter, do not use it. It is used to indicate
2845
if format probing has already been done.
2848
# we are being called directly and must probe.
2849
raise NotImplementedError
2850
if not isinstance(a_bzrdir.transport, LocalTransport):
2851
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2852
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2858
class WorkingTreeFormat3(WorkingTreeFormat):
2859
"""The second working tree format updated to record a format marker.
2862
- exists within a metadir controlling .bzr
2863
- includes an explicit version marker for the workingtree control
2864
files, separate from the BzrDir format
2865
- modifies the hash cache format
2867
- uses a LockDir to guard access for writes.
2870
upgrade_recommended = True
2872
def get_format_string(self):
2873
"""See WorkingTreeFormat.get_format_string()."""
2874
return "Bazaar-NG Working Tree format 3"
2876
def get_format_description(self):
2877
"""See WorkingTreeFormat.get_format_description()."""
2878
return "Working tree format 3"
2880
_lock_file_name = 'lock'
2881
_lock_class = LockDir
2883
_tree_class = WorkingTree3
2885
def __get_matchingbzrdir(self):
2886
return bzrdir.BzrDirMetaFormat1()
2888
_matchingbzrdir = property(__get_matchingbzrdir)
2890
def _open_control_files(self, a_bzrdir):
2891
transport = a_bzrdir.get_workingtree_transport(None)
2892
return LockableFiles(transport, self._lock_file_name,
2895
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2896
accelerator_tree=None, hardlink=False):
2897
"""See WorkingTreeFormat.initialize().
2899
:param revision_id: if supplied, create a working tree at a different
2900
revision than the branch is at.
2901
:param accelerator_tree: A tree which can be used for retrieving file
2902
contents more quickly than the revision tree, i.e. a workingtree.
2903
The revision tree will be used for cases where accelerator_tree's
2904
content is different.
2905
:param hardlink: If true, hard-link files from accelerator_tree,
2908
if not isinstance(a_bzrdir.transport, LocalTransport):
2909
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2910
transport = a_bzrdir.get_workingtree_transport(self)
2911
control_files = self._open_control_files(a_bzrdir)
2912
control_files.create_lock()
2913
control_files.lock_write()
2914
transport.put_bytes('format', self.get_format_string(),
2915
mode=a_bzrdir._get_file_mode())
2916
if from_branch is not None:
2917
branch = from_branch
2919
branch = a_bzrdir.open_branch()
2920
if revision_id is None:
2921
revision_id = _mod_revision.ensure_null(branch.last_revision())
2922
# WorkingTree3 can handle an inventory which has a unique root id.
2923
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2924
# those trees. And because there isn't a format bump inbetween, we
2925
# are maintaining compatibility with older clients.
2926
# inv = Inventory(root_id=gen_root_id())
2927
inv = self._initial_inventory()
2928
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2934
_control_files=control_files)
2935
wt.lock_tree_write()
2937
basis_tree = branch.repository.revision_tree(revision_id)
2938
# only set an explicit root id if there is one to set.
2939
if basis_tree.inventory.root is not None:
2940
wt.set_root_id(basis_tree.get_root_id())
2941
if revision_id == NULL_REVISION:
2942
wt.set_parent_trees([])
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
b'\\ No newline at end of file'
2944
wt.set_parent_trees([(revision_id, basis_tree)])
2945
transform.build_tree(basis_tree, wt)
2947
# Unlock in this order so that the unlock-triggers-flush in
2948
# WorkingTree is given a chance to fire.
2949
control_files.unlock()
2953
def _initial_inventory(self):
2957
super(WorkingTreeFormat3, self).__init__()
2959
def open(self, a_bzrdir, _found=False):
2960
"""Return the WorkingTree object for a_bzrdir
2962
_found is a private parameter, do not use it. It is used to indicate
2963
if format probing has already been done.
2966
# we are being called directly and must probe.
2967
raise NotImplementedError
2968
if not isinstance(a_bzrdir.transport, LocalTransport):
2969
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2970
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2973
def _open(self, a_bzrdir, control_files):
2974
"""Open the tree itself.
2976
:param a_bzrdir: the dir for the tree.
2977
:param control_files: the control files for the tree.
2979
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2983
_control_files=control_files)
2986
return self.get_format_string()
2989
__default_format = WorkingTreeFormat4()
2990
WorkingTreeFormat.register_format(__default_format)
2991
WorkingTreeFormat.register_format(WorkingTreeFormat6())
2992
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2993
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2994
WorkingTreeFormat.set_default_format(__default_format)
2995
# formats which have no format string are not discoverable
2996
# and not independently creatable, so are not registered.
2997
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
