70
380
inv = self._inventory
71
381
for path, ie in inv.iter_entries():
72
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)
76
389
def __repr__(self):
77
390
return "<%s of %s>" % (self.__class__.__name__,
78
391
getattr(self, 'basedir', None))
82
393
def abspath(self, filename):
83
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)
85
441
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))
91
def get_file_byname(self, filename):
92
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 filtered and self.supports_content_filtering():
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 filtered and self.supports_content_filtering():
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
94
549
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))
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))
99
587
def has_id(self, file_id):
100
588
# files that have been deleted are excluded
101
inv = self._inventory
102
590
if not inv.has_id(file_id):
104
592
path = inv.id2path(file_id)
105
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)
108
600
__contains__ = has_id
111
602
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).
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, from_dir=None, recursive=True):
1119
"""List all files as (path, class, kind, id, entry).
133
1121
Lists, but does not descend into unversioned directories.
135
1122
This does not include files that have been deleted in this
1123
tree. Skips the control directory.
138
Skips the control directory.
1125
:param include_root: if True, do not return an entry for the root
1126
:param from_dir: start from this directory or None for the root
1127
:param recursive: whether to recurse into subdirectories or not
140
inv = self._inventory
142
def descend(from_dir_relpath, from_dir_id, dp):
1129
# list_files is an iterator, so @needs_read_lock doesn't work properly
1130
# with it. So callers should be careful to always read_lock the tree.
1131
if not self.is_locked():
1132
raise errors.ObjectNotLocked(self)
1134
inv = self.inventory
1135
if from_dir is None and include_root is True:
1136
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1137
# Convert these into local objects to save lookup times
1138
pathjoin = osutils.pathjoin
1139
file_kind = self._kind
1141
# transport.base ends in a slash, we want the piece
1142
# between the last two slashes
1143
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1145
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1147
# directory file_id, relative path, absolute path, reverse sorted children
1148
if from_dir is not None:
1149
from_dir_id = inv.path2id(from_dir)
1150
if from_dir_id is None:
1151
# Directory not versioned
1153
from_dir_abspath = pathjoin(self.basedir, from_dir)
1155
from_dir_id = inv.root.file_id
1156
from_dir_abspath = self.basedir
1157
children = os.listdir(from_dir_abspath)
1159
# jam 20060527 The kernel sized tree seems equivalent whether we
1160
# use a deque and popleft to keep them sorted, or if we use a plain
1161
# list and just reverse() them.
1162
children = collections.deque(children)
1163
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1165
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1168
f = children.popleft()
146
1169
## TODO: If we find a subdirectory with its own .bzr
147
1170
## directory, then that is a separate tree and we
148
1171
## should exclude it.
149
if bzrlib.BZRDIR == f:
1173
# the bzrdir for this tree
1174
if transport_base_dir == f:
153
fp = appendpath(from_dir_relpath, f)
1177
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1178
# and 'f' doesn't begin with one, we can do a string op, rather
1179
# than the checks of pathjoin(), all relative paths will have an extra slash
1181
fp = from_dir_relpath + '/' + f
156
fap = appendpath(dp, f)
1184
fap = from_dir_abspath + '/' + f
158
1186
f_ie = inv.get_child(from_dir_id, f)
161
elif self.is_ignored(fp):
1189
elif self.is_ignored(fp[1:]):
1192
# we may not have found this file, because of a unicode issue
1193
f_norm, can_access = osutils.normalized_filename(f)
1194
if f == f_norm or not can_access:
1195
# No change, so treat this file normally
1198
# this file can be accessed by a normalized path
1199
# check again if it is versioned
1200
# these lines are repeated here for performance
1202
fp = from_dir_relpath + '/' + f
1203
fap = from_dir_abspath + '/' + f
1204
f_ie = inv.get_child(from_dir_id, f)
1207
elif self.is_ignored(fp[1:]):
166
1212
fk = file_kind(fap)
1214
# 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)
1216
yield fp[1:], c, fk, f_ie.file_id, f_ie
1219
yield fp[1:], c, fk, None, fk_entries[fk]()
1221
yield fp[1:], c, fk, None, TreeEntry()
176
1224
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):
1227
# But do this child first if recursing down
1229
new_children = os.listdir(fap)
1231
new_children = collections.deque(new_children)
1232
stack.append((f_ie.file_id, fp, fap, new_children))
1233
# Break out of inner loop,
1234
# so that we start outer loop with child
1237
# if we finished all children, pop it off the stack
1240
@needs_tree_write_lock
1241
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1244
to_dir must exist in the inventory.
1246
If to_dir exists and is a directory, the files are moved into
1247
it, keeping their old names.
1249
Note that to_dir is only the last component of the new name;
1250
this doesn't change the directory.
1252
For each entry in from_paths the move mode will be determined
1255
The first mode moves the file in the filesystem and updates the
1256
inventory. The second mode only updates the inventory without
1257
touching the file on the filesystem. This is the new mode introduced
1260
move uses the second mode if 'after == True' and the target is not
1261
versioned but present in the working tree.
1263
move uses the second mode if 'after == False' and the source is
1264
versioned but no longer in the working tree, and the target is not
1265
versioned but present in the working tree.
1267
move uses the first mode if 'after == False' and the source is
1268
versioned and present in the working tree, and the target is not
1269
versioned and not present in the working tree.
1271
Everything else results in an error.
1273
This returns a list of (from_path, to_path) pairs for each
1274
entry that is moved.
1279
# check for deprecated use of signature
1281
to_dir = kwargs.get('to_name', None)
1283
raise TypeError('You must supply a target directory')
1285
symbol_versioning.warn('The parameter to_name was deprecated'
1286
' in version 0.13. Use to_dir instead',
1289
# check destination directory
1290
if isinstance(from_paths, basestring):
1292
inv = self.inventory
1293
to_abs = self.abspath(to_dir)
1294
if not isdir(to_abs):
1295
raise errors.BzrMoveFailedError('',to_dir,
1296
errors.NotADirectory(to_abs))
1297
if not self.has_filename(to_dir):
1298
raise errors.BzrMoveFailedError('',to_dir,
1299
errors.NotInWorkingDirectory(to_dir))
1300
to_dir_id = inv.path2id(to_dir)
1301
if to_dir_id is None:
1302
raise errors.BzrMoveFailedError('',to_dir,
1303
errors.NotVersionedError(path=str(to_dir)))
1305
to_dir_ie = inv[to_dir_id]
1306
if to_dir_ie.kind != 'directory':
1307
raise errors.BzrMoveFailedError('',to_dir,
1308
errors.NotADirectory(to_abs))
1310
# create rename entries and tuples
1311
for from_rel in from_paths:
1312
from_tail = splitpath(from_rel)[-1]
1313
from_id = inv.path2id(from_rel)
1315
raise errors.BzrMoveFailedError(from_rel,to_dir,
1316
errors.NotVersionedError(path=str(from_rel)))
1318
from_entry = inv[from_id]
1319
from_parent_id = from_entry.parent_id
1320
to_rel = pathjoin(to_dir, from_tail)
1321
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1323
from_tail=from_tail,
1324
from_parent_id=from_parent_id,
1325
to_rel=to_rel, to_tail=from_tail,
1326
to_parent_id=to_dir_id)
1327
rename_entries.append(rename_entry)
1328
rename_tuples.append((from_rel, to_rel))
1330
# determine which move mode to use. checks also for movability
1331
rename_entries = self._determine_mv_mode(rename_entries, after)
1333
original_modified = self._inventory_is_modified
1336
self._inventory_is_modified = True
1337
self._move(rename_entries)
1339
# restore the inventory on error
1340
self._inventory_is_modified = original_modified
1342
self._write_inventory(inv)
1343
return rename_tuples
1345
def _determine_mv_mode(self, rename_entries, after=False):
1346
"""Determines for each from-to pair if both inventory and working tree
1347
or only the inventory has to be changed.
1349
Also does basic plausability tests.
1351
inv = self.inventory
1353
for rename_entry in rename_entries:
1354
# store to local variables for easier reference
1355
from_rel = rename_entry.from_rel
1356
from_id = rename_entry.from_id
1357
to_rel = rename_entry.to_rel
1358
to_id = inv.path2id(to_rel)
1359
only_change_inv = False
1361
# check the inventory for source and destination
1363
raise errors.BzrMoveFailedError(from_rel,to_rel,
1364
errors.NotVersionedError(path=str(from_rel)))
1365
if to_id is not None:
1366
raise errors.BzrMoveFailedError(from_rel,to_rel,
1367
errors.AlreadyVersionedError(path=str(to_rel)))
1369
# try to determine the mode for rename (only change inv or change
1370
# inv and file system)
1372
if not self.has_filename(to_rel):
1373
raise errors.BzrMoveFailedError(from_id,to_rel,
1374
errors.NoSuchFile(path=str(to_rel),
1375
extra="New file has not been created yet"))
1376
only_change_inv = True
1377
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1378
only_change_inv = True
1379
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1380
only_change_inv = False
1381
elif (not self.case_sensitive
1382
and from_rel.lower() == to_rel.lower()
1383
and self.has_filename(from_rel)):
1384
only_change_inv = False
1386
# something is wrong, so lets determine what exactly
1387
if not self.has_filename(from_rel) and \
1388
not self.has_filename(to_rel):
1389
raise errors.BzrRenameFailedError(from_rel,to_rel,
1390
errors.PathsDoNotExist(paths=(str(from_rel),
1393
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1394
rename_entry.only_change_inv = only_change_inv
1395
return rename_entries
1397
def _move(self, rename_entries):
1398
"""Moves a list of files.
1400
Depending on the value of the flag 'only_change_inv', the
1401
file will be moved on the file system or not.
1403
inv = self.inventory
1406
for entry in rename_entries:
1408
self._move_entry(entry)
1410
self._rollback_move(moved)
1414
def _rollback_move(self, moved):
1415
"""Try to rollback a previous move in case of an filesystem error."""
1416
inv = self.inventory
1419
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1420
entry.to_tail, entry.to_parent_id, entry.from_rel,
1421
entry.from_tail, entry.from_parent_id,
1422
entry.only_change_inv))
1423
except errors.BzrMoveFailedError, e:
1424
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1425
" The working tree is in an inconsistent state."
1426
" Please consider doing a 'bzr revert'."
1427
" Error message is: %s" % e)
1429
def _move_entry(self, entry):
1430
inv = self.inventory
1431
from_rel_abs = self.abspath(entry.from_rel)
1432
to_rel_abs = self.abspath(entry.to_rel)
1433
if from_rel_abs == to_rel_abs:
1434
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1435
"Source and target are identical.")
1437
if not entry.only_change_inv:
1439
osutils.rename(from_rel_abs, to_rel_abs)
1441
raise errors.BzrMoveFailedError(entry.from_rel,
1443
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1445
@needs_tree_write_lock
1446
def rename_one(self, from_rel, to_rel, after=False):
1449
This can change the directory or the filename or both.
1451
rename_one has several 'modes' to work. First, it can rename a physical
1452
file and change the file_id. That is the normal mode. Second, it can
1453
only change the file_id without touching any physical file. This is
1454
the new mode introduced in version 0.15.
1456
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1457
versioned but present in the working tree.
1459
rename_one uses the second mode if 'after == False' and 'from_rel' is
1460
versioned but no longer in the working tree, and 'to_rel' is not
1461
versioned but present in the working tree.
1463
rename_one uses the first mode if 'after == False' and 'from_rel' is
1464
versioned and present in the working tree, and 'to_rel' is not
1465
versioned and not present in the working tree.
1467
Everything else results in an error.
1469
inv = self.inventory
1472
# create rename entries and tuples
1473
from_tail = splitpath(from_rel)[-1]
1474
from_id = inv.path2id(from_rel)
1476
raise errors.BzrRenameFailedError(from_rel,to_rel,
1477
errors.NotVersionedError(path=str(from_rel)))
1478
from_entry = inv[from_id]
1479
from_parent_id = from_entry.parent_id
1480
to_dir, to_tail = os.path.split(to_rel)
1481
to_dir_id = inv.path2id(to_dir)
1482
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1484
from_tail=from_tail,
1485
from_parent_id=from_parent_id,
1486
to_rel=to_rel, to_tail=to_tail,
1487
to_parent_id=to_dir_id)
1488
rename_entries.append(rename_entry)
1490
# determine which move mode to use. checks also for movability
1491
rename_entries = self._determine_mv_mode(rename_entries, after)
1493
# check if the target changed directory and if the target directory is
1495
if to_dir_id is None:
1496
raise errors.BzrMoveFailedError(from_rel,to_rel,
1497
errors.NotVersionedError(path=str(to_dir)))
1499
# all checks done. now we can continue with our actual work
1500
mutter('rename_one:\n'
1505
' to_dir_id {%s}\n',
1506
from_id, from_rel, to_rel, to_dir, to_dir_id)
1508
self._move(rename_entries)
1509
self._write_inventory(inv)
1511
class _RenameEntry(object):
1512
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1513
to_rel, to_tail, to_parent_id, only_change_inv=False):
1514
self.from_rel = from_rel
1515
self.from_id = from_id
1516
self.from_tail = from_tail
1517
self.from_parent_id = from_parent_id
1518
self.to_rel = to_rel
1519
self.to_tail = to_tail
1520
self.to_parent_id = to_parent_id
1521
self.only_change_inv = only_change_inv
191
1524
def unknowns(self):
192
for subp in self.extras():
193
if not self.is_ignored(subp):
1525
"""Return all unknown files.
1527
These are files in the working directory that are not versioned or
1528
control files or ignored.
1530
# force the extras method to be fully executed before returning, to
1531
# prevent race conditions with the lock
1533
[subp for subp in self.extras() if not self.is_ignored(subp)])
1535
@needs_tree_write_lock
1536
def unversion(self, file_ids):
1537
"""Remove the file ids in file_ids from the current versioned set.
1539
When a file_id is unversioned, all of its children are automatically
1542
:param file_ids: The file ids to stop versioning.
1543
:raises: NoSuchId if any fileid is not currently versioned.
1545
for file_id in file_ids:
1546
if file_id not in self._inventory:
1547
raise errors.NoSuchId(self, file_id)
1548
for file_id in file_ids:
1549
if self._inventory.has_id(file_id):
1550
self._inventory.remove_recursive_id(file_id)
1552
# in the future this should just set a dirty bit to wait for the
1553
# final unlock. However, until all methods of workingtree start
1554
# with the current in -memory inventory rather than triggering
1555
# a read, it is more complex - we need to teach read_inventory
1556
# to know when to read, and when to not read first... and possibly
1557
# to save first when the in memory one may be corrupted.
1558
# so for now, we just only write it if it is indeed dirty.
1560
self._write_inventory(self._inventory)
1562
def _iter_conflicts(self):
1564
for info in self.list_files():
1566
stem = get_conflicted_stem(path)
1569
if stem not in conflicted:
1570
conflicted.add(stem)
1574
def pull(self, source, overwrite=False, stop_revision=None,
1575
change_reporter=None, possible_transports=None, local=False):
1576
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1579
pp = ProgressPhase("Pull phase", 2, top_pb)
1581
old_revision_info = self.branch.last_revision_info()
1582
basis_tree = self.basis_tree()
1583
count = self.branch.pull(source, overwrite, stop_revision,
1584
possible_transports=possible_transports,
1586
new_revision_info = self.branch.last_revision_info()
1587
if new_revision_info != old_revision_info:
1589
repository = self.branch.repository
1590
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1591
basis_tree.lock_read()
1593
new_basis_tree = self.branch.basis_tree()
1600
change_reporter=change_reporter)
1601
if (basis_tree.inventory.root is None and
1602
new_basis_tree.inventory.root is not None):
1603
self.set_root_id(new_basis_tree.get_root_id())
1607
# TODO - dedup parents list with things merged by pull ?
1608
# reuse the revisiontree we merged against to set the new
1610
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1611
# we have to pull the merge trees out again, because
1612
# merge_inner has set the ids. - this corner is not yet
1613
# layered well enough to prevent double handling.
1614
# XXX TODO: Fix the double handling: telling the tree about
1615
# the already known parent data is wasteful.
1616
merges = self.get_parent_ids()[1:]
1617
parent_trees.extend([
1618
(parent, repository.revision_tree(parent)) for
1620
self.set_parent_trees(parent_trees)
1627
def put_file_bytes_non_atomic(self, file_id, bytes):
1628
"""See MutableTree.put_file_bytes_non_atomic."""
1629
stream = file(self.id2abspath(file_id), 'wb')
1634
# TODO: update the hashcache here ?
197
1636
def extras(self):
198
"""Yield all unknown files in this WorkingTree.
1637
"""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
1639
If there are any unversioned directories then only the directory is
1640
returned, not all its children. But if there are unversioned files
202
1641
under a versioned subdirectory, they are returned.
204
1643
Currently returned depth-first, sorted by name within directories.
1644
This is the same order used by 'osutils.walkdirs'.
206
1646
## TODO: Work from given directory downwards
207
1647
for path, dir_entry in self.inventory.directories():
208
mutter("search for unknowns in %r" % path)
1648
# mutter("search for unknowns in %r", path)
209
1649
dirabs = self.abspath(path)
210
1650
if not isdir(dirabs):
211
1651
# e.g. directory deleted
256
1717
If the file is ignored, returns the pattern which caused it to
257
1718
be ignored, otherwise None. So this can simply be used as a
258
1719
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] == '.\\'):
1720
if getattr(self, '_ignoreglobster', None) is None:
1721
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1722
return self._ignoreglobster.match(filename)
1724
def kind(self, file_id):
1725
return file_kind(self.id2abspath(file_id))
1727
def stored_kind(self, file_id):
1728
"""See Tree.stored_kind"""
1729
return self.inventory[file_id].kind
1731
def _comparison_data(self, entry, path):
1732
abspath = self.abspath(path)
1734
stat_value = os.lstat(abspath)
1736
if getattr(e, 'errno', None) == errno.ENOENT:
1743
mode = stat_value.st_mode
1744
kind = osutils.file_kind_from_stat_mode(mode)
1745
if not supports_executable():
1746
executable = entry is not None and entry.executable
1748
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1749
return kind, executable, stat_value
1751
def _file_size(self, entry, stat_value):
1752
return stat_value.st_size
1754
def last_revision(self):
1755
"""Return the last revision of the branch for this tree.
1757
This format tree does not support a separate marker for last-revision
1758
compared to the branch.
1760
See MutableTree.last_revision
1762
return self._last_revision()
1765
def _last_revision(self):
1766
"""helper for get_parent_ids."""
1767
return _mod_revision.ensure_null(self.branch.last_revision())
1769
def is_locked(self):
1770
return self._control_files.is_locked()
1772
def _must_be_locked(self):
1773
if not self.is_locked():
1774
raise errors.ObjectNotLocked(self)
1776
def lock_read(self):
1777
"""See Branch.lock_read, and WorkingTree.unlock."""
1778
if not self.is_locked():
1780
self.branch.lock_read()
1782
return self._control_files.lock_read()
1784
self.branch.unlock()
1787
def lock_tree_write(self):
1788
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1789
if not self.is_locked():
1791
self.branch.lock_read()
1793
return self._control_files.lock_write()
1795
self.branch.unlock()
1798
def lock_write(self):
1799
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1800
if not self.is_locked():
1802
self.branch.lock_write()
1804
return self._control_files.lock_write()
1806
self.branch.unlock()
1809
def get_physical_lock_status(self):
1810
return self._control_files.get_physical_lock_status()
1812
def _basis_inventory_name(self):
1813
return 'basis-inventory-cache'
1815
def _reset_data(self):
1816
"""Reset transient data that cannot be revalidated."""
1817
self._inventory_is_modified = False
1818
result = self._deserialize(self._transport.get('inventory'))
1819
self._set_inventory(result, dirty=False)
1821
@needs_tree_write_lock
1822
def set_last_revision(self, new_revision):
1823
"""Change the last revision in the working tree."""
1824
if self._change_last_revision(new_revision):
1825
self._cache_basis_inventory(new_revision)
1827
def _change_last_revision(self, new_revision):
1828
"""Template method part of set_last_revision to perform the change.
1830
This is used to allow WorkingTree3 instances to not affect branch
1831
when their last revision is set.
1833
if _mod_revision.is_null(new_revision):
1834
self.branch.set_revision_history([])
1837
self.branch.generate_revision_history(new_revision)
1838
except errors.NoSuchRevision:
1839
# not present in the repo - dont try to set it deeper than the tip
1840
self.branch.set_revision_history([new_revision])
1843
def _write_basis_inventory(self, xml):
1844
"""Write the basis inventory XML to the basis-inventory file"""
1845
path = self._basis_inventory_name()
1847
self._transport.put_file(path, sio,
1848
mode=self.bzrdir._get_file_mode())
1850
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1851
"""Create the text that will be saved in basis-inventory"""
1852
inventory.revision_id = revision_id
1853
return xml7.serializer_v7.write_inventory_to_string(inventory)
1855
def _cache_basis_inventory(self, new_revision):
1856
"""Cache new_revision as the basis inventory."""
1857
# TODO: this should allow the ready-to-use inventory to be passed in,
1858
# as commit already has that ready-to-use [while the format is the
1861
# this double handles the inventory - unpack and repack -
1862
# but is easier to understand. We can/should put a conditional
1863
# in here based on whether the inventory is in the latest format
1864
# - perhaps we should repack all inventories on a repository
1866
# the fast path is to copy the raw xml from the repository. If the
1867
# xml contains 'revision_id="', then we assume the right
1868
# revision_id is set. We must check for this full string, because a
1869
# root node id can legitimately look like 'revision_id' but cannot
1871
xml = self.branch.repository.get_inventory_xml(new_revision)
1872
firstline = xml.split('\n', 1)[0]
1873
if (not 'revision_id="' in firstline or
1874
'format="7"' not in firstline):
1875
inv = self.branch.repository.deserialise_inventory(
1877
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1878
self._write_basis_inventory(xml)
1879
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1882
def read_basis_inventory(self):
1883
"""Read the cached basis inventory."""
1884
path = self._basis_inventory_name()
1885
return self._transport.get_bytes(path)
1888
def read_working_inventory(self):
1889
"""Read the working inventory.
1891
:raises errors.InventoryModified: read_working_inventory will fail
1892
when the current in memory inventory has been modified.
1894
# conceptually this should be an implementation detail of the tree.
1895
# XXX: Deprecate this.
1896
# ElementTree does its own conversion from UTF-8, so open in
1898
if self._inventory_is_modified:
1899
raise errors.InventoryModified(self)
1900
result = self._deserialize(self._transport.get('inventory'))
1901
self._set_inventory(result, dirty=False)
1904
@needs_tree_write_lock
1905
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1907
"""Remove nominated files from the working inventory.
1909
:files: File paths relative to the basedir.
1910
:keep_files: If true, the files will also be kept.
1911
:force: Delete files and directories, even if they are changed and
1912
even if the directories are not empty.
1914
if isinstance(files, basestring):
1920
unknown_nested_files=set()
1922
def recurse_directory_to_add_files(directory):
1923
# Recurse directory and add all files
1924
# so we can check if they have changed.
1925
for parent_info, file_infos in\
1926
self.walkdirs(directory):
1927
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1928
# Is it versioned or ignored?
1929
if self.path2id(relpath) or self.is_ignored(relpath):
1930
# Add nested content for deletion.
1931
new_files.add(relpath)
1933
# Files which are not versioned and not ignored
1934
# should be treated as unknown.
1935
unknown_nested_files.add((relpath, None, kind))
1937
for filename in files:
1938
# Get file name into canonical form.
1939
abspath = self.abspath(filename)
1940
filename = self.relpath(abspath)
1941
if len(filename) > 0:
1942
new_files.add(filename)
1943
recurse_directory_to_add_files(filename)
1945
files = list(new_files)
1948
return # nothing to do
1950
# Sort needed to first handle directory content before the directory
1951
files.sort(reverse=True)
1953
# Bail out if we are going to delete files we shouldn't
1954
if not keep_files and not force:
1955
has_changed_files = len(unknown_nested_files) > 0
1956
if not has_changed_files:
1957
for (file_id, path, content_change, versioned, parent_id, name,
1958
kind, executable) in self.iter_changes(self.basis_tree(),
1959
include_unchanged=True, require_versioned=False,
1960
want_unversioned=True, specific_files=files):
1961
if versioned == (False, False):
1962
# The record is unknown ...
1963
if not self.is_ignored(path[1]):
1964
# ... but not ignored
1965
has_changed_files = True
1967
elif content_change and (kind[1] is not None):
1968
# Versioned and changed, but not deleted
1969
has_changed_files = True
1972
if has_changed_files:
1973
# Make delta show ALL applicable changes in error message.
1974
tree_delta = self.changes_from(self.basis_tree(),
1975
require_versioned=False, want_unversioned=True,
1976
specific_files=files)
1977
for unknown_file in unknown_nested_files:
1978
if unknown_file not in tree_delta.unversioned:
1979
tree_delta.unversioned.extend((unknown_file,))
1980
raise errors.BzrRemoveChangedFilesError(tree_delta)
1982
# Build inv_delta and delete files where applicable,
1983
# do this before any modifications to inventory.
1985
fid = self.path2id(f)
1988
message = "%s is not versioned." % (f,)
1991
# having removed it, it must be either ignored or unknown
1992
if self.is_ignored(f):
1996
textui.show_status(new_status, self.kind(fid), f,
1999
inv_delta.append((f, None, fid, None))
2000
message = "removed %s" % (f,)
2003
abs_path = self.abspath(f)
2004
if osutils.lexists(abs_path):
2005
if (osutils.isdir(abs_path) and
2006
len(os.listdir(abs_path)) > 0):
2008
osutils.rmtree(abs_path)
2010
message = "%s is not an empty directory "\
2011
"and won't be deleted." % (f,)
2013
osutils.delete_any(abs_path)
2014
message = "deleted %s" % (f,)
2015
elif message is not None:
2016
# Only care if we haven't done anything yet.
2017
message = "%s does not exist." % (f,)
2019
# Print only one message (if any) per file.
2020
if message is not None:
2022
self.apply_inventory_delta(inv_delta)
2024
@needs_tree_write_lock
2025
def revert(self, filenames=None, old_tree=None, backups=True,
2026
pb=DummyProgress(), report_changes=False):
2027
from bzrlib.conflicts import resolve
2030
symbol_versioning.warn('Using [] to revert all files is deprecated'
2031
' as of bzr 0.91. Please use None (the default) instead.',
2032
DeprecationWarning, stacklevel=2)
2033
if old_tree is None:
2034
basis_tree = self.basis_tree()
2035
basis_tree.lock_read()
2036
old_tree = basis_tree
2040
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2042
if filenames is None and len(self.get_parent_ids()) > 1:
2044
last_revision = self.last_revision()
2045
if last_revision != NULL_REVISION:
2046
if basis_tree is None:
2047
basis_tree = self.basis_tree()
2048
basis_tree.lock_read()
2049
parent_trees.append((last_revision, basis_tree))
2050
self.set_parent_trees(parent_trees)
2053
resolve(self, filenames, ignore_misses=True, recursive=True)
2055
if basis_tree is not None:
2059
def revision_tree(self, revision_id):
2060
"""See Tree.revision_tree.
2062
WorkingTree can supply revision_trees for the basis revision only
2063
because there is only one cached inventory in the bzr directory.
2065
if revision_id == self.last_revision():
2067
xml = self.read_basis_inventory()
2068
except errors.NoSuchFile:
2072
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2073
# dont use the repository revision_tree api because we want
2074
# to supply the inventory.
2075
if inv.revision_id == revision_id:
2076
return revisiontree.RevisionTree(self.branch.repository,
2078
except errors.BadInventoryFormat:
2080
# raise if there was no inventory, or if we read the wrong inventory.
2081
raise errors.NoSuchRevisionInTree(self, revision_id)
2083
# XXX: This method should be deprecated in favour of taking in a proper
2084
# new Inventory object.
2085
@needs_tree_write_lock
2086
def set_inventory(self, new_inventory_list):
2087
from bzrlib.inventory import (Inventory,
2092
inv = Inventory(self.get_root_id())
2093
for path, file_id, parent, kind in new_inventory_list:
2094
name = os.path.basename(path)
2097
# fixme, there should be a factory function inv,add_??
2098
if kind == 'directory':
2099
inv.add(InventoryDirectory(file_id, name, parent))
2100
elif kind == 'file':
2101
inv.add(InventoryFile(file_id, name, parent))
2102
elif kind == 'symlink':
2103
inv.add(InventoryLink(file_id, name, parent))
2105
raise errors.BzrError("unknown kind %r" % kind)
2106
self._write_inventory(inv)
2108
@needs_tree_write_lock
2109
def set_root_id(self, file_id):
2110
"""Set the root id for this tree."""
2114
'WorkingTree.set_root_id with fileid=None')
2115
file_id = osutils.safe_file_id(file_id)
2116
self._set_root_id(file_id)
2118
def _set_root_id(self, file_id):
2119
"""Set the root id for this tree, in a format specific manner.
2121
:param file_id: The file id to assign to the root. It must not be
2122
present in the current inventory or an error will occur. It must
2123
not be None, but rather a valid file id.
2125
inv = self._inventory
2126
orig_root_id = inv.root.file_id
2127
# TODO: it might be nice to exit early if there was nothing
2128
# to do, saving us from trigger a sync on unlock.
2129
self._inventory_is_modified = True
2130
# we preserve the root inventory entry object, but
2131
# unlinkit from the byid index
2132
del inv._byid[inv.root.file_id]
2133
inv.root.file_id = file_id
2134
# and link it into the index with the new changed id.
2135
inv._byid[inv.root.file_id] = inv.root
2136
# and finally update all children to reference the new id.
2137
# XXX: this should be safe to just look at the root.children
2138
# list, not the WHOLE INVENTORY.
2141
if entry.parent_id == orig_root_id:
2142
entry.parent_id = inv.root.file_id
2145
"""See Branch.unlock.
2147
WorkingTree locking just uses the Branch locking facilities.
2148
This is current because all working trees have an embedded branch
2149
within them. IF in the future, we were to make branch data shareable
2150
between multiple working trees, i.e. via shared storage, then we
2151
would probably want to lock both the local tree, and the branch.
2153
raise NotImplementedError(self.unlock)
2155
def update(self, change_reporter=None, possible_transports=None):
2156
"""Update a working tree along its branch.
2158
This will update the branch if its bound too, which means we have
2159
multiple trees involved:
2161
- The new basis tree of the master.
2162
- The old basis tree of the branch.
2163
- The old basis tree of the working tree.
2164
- The current working tree state.
2166
Pathologically, all three may be different, and non-ancestors of each
2167
other. Conceptually we want to:
2169
- Preserve the wt.basis->wt.state changes
2170
- Transform the wt.basis to the new master basis.
2171
- Apply a merge of the old branch basis to get any 'local' changes from
2173
- Restore the wt.basis->wt.state changes.
2175
There isn't a single operation at the moment to do that, so we:
2176
- Merge current state -> basis tree of the master w.r.t. the old tree
2178
- Do a 'normal' merge of the old branch basis if it is relevant.
2180
if self.branch.get_bound_location() is not None:
2182
update_branch = True
2184
self.lock_tree_write()
2185
update_branch = False
2188
old_tip = self.branch.update(possible_transports)
2191
return self._update_tree(old_tip, change_reporter)
2195
@needs_tree_write_lock
2196
def _update_tree(self, old_tip=None, change_reporter=None):
2197
"""Update a tree to the master branch.
2199
:param old_tip: if supplied, the previous tip revision the branch,
2200
before it was changed to the master branch's tip.
2202
# here if old_tip is not None, it is the old tip of the branch before
2203
# it was updated from the master branch. This should become a pending
2204
# merge in the working tree to preserve the user existing work. we
2205
# cant set that until we update the working trees last revision to be
2206
# one from the new branch, because it will just get absorbed by the
2207
# parent de-duplication logic.
2209
# We MUST save it even if an error occurs, because otherwise the users
2210
# local work is unreferenced and will appear to have been lost.
2214
last_rev = self.get_parent_ids()[0]
2216
last_rev = _mod_revision.NULL_REVISION
2217
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2218
# merge tree state up to new branch tip.
2219
basis = self.basis_tree()
2222
to_tree = self.branch.basis_tree()
2223
if basis.inventory.root is None:
2224
self.set_root_id(to_tree.get_root_id())
2226
result += merge.merge_inner(
2231
change_reporter=change_reporter)
2234
# TODO - dedup parents list with things merged by pull ?
2235
# reuse the tree we've updated to to set the basis:
2236
parent_trees = [(self.branch.last_revision(), to_tree)]
2237
merges = self.get_parent_ids()[1:]
2238
# Ideally we ask the tree for the trees here, that way the working
2239
# tree can decide whether to give us the entire tree or give us a
2240
# lazy initialised tree. dirstate for instance will have the trees
2241
# in ram already, whereas a last-revision + basis-inventory tree
2242
# will not, but also does not need them when setting parents.
2243
for parent in merges:
2244
parent_trees.append(
2245
(parent, self.branch.repository.revision_tree(parent)))
2246
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2247
parent_trees.append(
2248
(old_tip, self.branch.repository.revision_tree(old_tip)))
2249
self.set_parent_trees(parent_trees)
2250
last_rev = parent_trees[0][0]
2252
# the working tree had the same last-revision as the master
2253
# branch did. We may still have pivot local work from the local
2254
# branch into old_tip:
2255
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2256
self.add_parent_tree_id(old_tip)
2257
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2258
and old_tip != last_rev):
2259
# our last revision was not the prior branch last revision
2260
# and we have converted that last revision to a pending merge.
2261
# base is somewhere between the branch tip now
2262
# and the now pending merge
2264
# Since we just modified the working tree and inventory, flush out
2265
# the current state, before we modify it again.
2266
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2267
# requires it only because TreeTransform directly munges the
2268
# inventory and calls tree._write_inventory(). Ultimately we
2269
# should be able to remove this extra flush.
2271
graph = self.branch.repository.get_graph()
2272
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2274
base_tree = self.branch.repository.revision_tree(base_rev_id)
2275
other_tree = self.branch.repository.revision_tree(old_tip)
2276
result += merge.merge_inner(
2281
change_reporter=change_reporter)
2284
def _write_hashcache_if_dirty(self):
2285
"""Write out the hashcache if it is dirty."""
2286
if self._hashcache.needs_write:
2288
self._hashcache.write()
2290
if e.errno not in (errno.EPERM, errno.EACCES):
2292
# TODO: jam 20061219 Should this be a warning? A single line
2293
# warning might be sufficient to let the user know what
2295
mutter('Could not write hashcache for %s\nError: %s',
2296
self._hashcache.cache_file_name(), e)
2298
@needs_tree_write_lock
2299
def _write_inventory(self, inv):
2300
"""Write inventory as the current inventory."""
2301
self._set_inventory(inv, dirty=True)
2304
def set_conflicts(self, arg):
2305
raise errors.UnsupportedOperation(self.set_conflicts, self)
2307
def add_conflicts(self, arg):
2308
raise errors.UnsupportedOperation(self.add_conflicts, self)
2311
def conflicts(self):
2312
conflicts = _mod_conflicts.ConflictList()
2313
for conflicted in self._iter_conflicts():
2316
if file_kind(self.abspath(conflicted)) != "file":
2318
except errors.NoSuchFile:
2321
for suffix in ('.THIS', '.OTHER'):
2323
kind = file_kind(self.abspath(conflicted+suffix))
2326
except errors.NoSuchFile:
2330
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2331
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2333
file_id=self.path2id(conflicted)))
2336
def walkdirs(self, prefix=""):
2337
"""Walk the directories of this tree.
2339
returns a generator which yields items in the form:
2340
((curren_directory_path, fileid),
2341
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2344
This API returns a generator, which is only valid during the current
2345
tree transaction - within a single lock_read or lock_write duration.
2347
If the tree is not locked, it may cause an error to be raised,
2348
depending on the tree implementation.
2350
disk_top = self.abspath(prefix)
2351
if disk_top.endswith('/'):
2352
disk_top = disk_top[:-1]
2353
top_strip_len = len(disk_top) + 1
2354
inventory_iterator = self._walkdirs(prefix)
2355
disk_iterator = osutils.walkdirs(disk_top, prefix)
2357
current_disk = disk_iterator.next()
2358
disk_finished = False
2360
if not (e.errno == errno.ENOENT or
2361
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2364
disk_finished = True
2366
current_inv = inventory_iterator.next()
2367
inv_finished = False
2368
except StopIteration:
2371
while not inv_finished or not disk_finished:
2373
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2374
cur_disk_dir_content) = current_disk
2376
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2377
cur_disk_dir_content) = ((None, None), None)
2378
if not disk_finished:
2379
# strip out .bzr dirs
2380
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2381
len(cur_disk_dir_content) > 0):
2382
# osutils.walkdirs can be made nicer -
2383
# yield the path-from-prefix rather than the pathjoined
2385
bzrdir_loc = bisect_left(cur_disk_dir_content,
2387
if (bzrdir_loc < len(cur_disk_dir_content)
2388
and self.bzrdir.is_control_filename(
2389
cur_disk_dir_content[bzrdir_loc][0])):
2390
# we dont yield the contents of, or, .bzr itself.
2391
del cur_disk_dir_content[bzrdir_loc]
2393
# everything is unknown
2396
# everything is missing
2399
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2401
# disk is before inventory - unknown
2402
dirblock = [(relpath, basename, kind, stat, None, None) for
2403
relpath, basename, kind, stat, top_path in
2404
cur_disk_dir_content]
2405
yield (cur_disk_dir_relpath, None), dirblock
2407
current_disk = disk_iterator.next()
2408
except StopIteration:
2409
disk_finished = True
2411
# inventory is before disk - missing.
2412
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2413
for relpath, basename, dkind, stat, fileid, kind in
2415
yield (current_inv[0][0], current_inv[0][1]), dirblock
2417
current_inv = inventory_iterator.next()
2418
except StopIteration:
2421
# versioned present directory
2422
# merge the inventory and disk data together
2424
for relpath, subiterator in itertools.groupby(sorted(
2425
current_inv[1] + cur_disk_dir_content,
2426
key=operator.itemgetter(0)), operator.itemgetter(1)):
2427
path_elements = list(subiterator)
2428
if len(path_elements) == 2:
2429
inv_row, disk_row = path_elements
2430
# versioned, present file
2431
dirblock.append((inv_row[0],
2432
inv_row[1], disk_row[2],
2433
disk_row[3], inv_row[4],
2435
elif len(path_elements[0]) == 5:
2437
dirblock.append((path_elements[0][0],
2438
path_elements[0][1], path_elements[0][2],
2439
path_elements[0][3], None, None))
2440
elif len(path_elements[0]) == 6:
2441
# versioned, absent file.
2442
dirblock.append((path_elements[0][0],
2443
path_elements[0][1], 'unknown', None,
2444
path_elements[0][4], path_elements[0][5]))
2446
raise NotImplementedError('unreachable code')
2447
yield current_inv[0], dirblock
2449
current_inv = inventory_iterator.next()
2450
except StopIteration:
2453
current_disk = disk_iterator.next()
2454
except StopIteration:
2455
disk_finished = True
2457
def _walkdirs(self, prefix=""):
2458
"""Walk the directories of this tree.
2460
:prefix: is used as the directrory to start with.
2461
returns a generator which yields items in the form:
2462
((curren_directory_path, fileid),
2463
[(file1_path, file1_name, file1_kind, None, file1_id,
2466
_directory = 'directory'
2467
# get the root in the inventory
2468
inv = self.inventory
2469
top_id = inv.path2id(prefix)
2473
pending = [(prefix, '', _directory, None, top_id, None)]
2476
currentdir = pending.pop()
2477
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2478
top_id = currentdir[4]
2480
relroot = currentdir[0] + '/'
2483
# FIXME: stash the node in pending
2485
if entry.kind == 'directory':
2486
for name, child in entry.sorted_children():
2487
dirblock.append((relroot + name, name, child.kind, None,
2488
child.file_id, child.kind
2490
yield (currentdir[0], entry.file_id), dirblock
2491
# push the user specified dirs from dirblock
2492
for dir in reversed(dirblock):
2493
if dir[2] == _directory:
2496
@needs_tree_write_lock
2497
def auto_resolve(self):
2498
"""Automatically resolve text conflicts according to contents.
2500
Only text conflicts are auto_resolvable. Files with no conflict markers
2501
are considered 'resolved', because bzr always puts conflict markers
2502
into files that have text conflicts. The corresponding .THIS .BASE and
2503
.OTHER files are deleted, as per 'resolve'.
2504
:return: a tuple of ConflictLists: (un_resolved, resolved).
2506
un_resolved = _mod_conflicts.ConflictList()
2507
resolved = _mod_conflicts.ConflictList()
2508
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2509
for conflict in self.conflicts():
2510
if (conflict.typestring != 'text conflict' or
2511
self.kind(conflict.file_id) != 'file'):
2512
un_resolved.append(conflict)
2514
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2516
for line in my_file:
2517
if conflict_re.search(line):
2518
un_resolved.append(conflict)
280
if fnmatch.fnmatchcase(filename, newpat):
2521
resolved.append(conflict)
2524
resolved.remove_files(self)
2525
self.set_conflicts(un_resolved)
2526
return un_resolved, resolved
2530
tree_basis = self.basis_tree()
2531
tree_basis.lock_read()
2533
repo_basis = self.branch.repository.revision_tree(
2534
self.last_revision())
2535
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2536
raise errors.BzrCheckError(
2537
"Mismatched basis inventory content.")
2542
def _validate(self):
2543
"""Validate internal structures.
2545
This is meant mostly for the test suite. To give it a chance to detect
2546
corruption after actions have occurred. The default implementation is a
2549
:return: None. An exception should be raised if there is an error.
2554
def _get_rules_searcher(self, default_searcher):
2555
"""See Tree._get_rules_searcher."""
2556
if self._rules_searcher is None:
2557
self._rules_searcher = super(WorkingTree,
2558
self)._get_rules_searcher(default_searcher)
2559
return self._rules_searcher
2561
def get_shelf_manager(self):
2562
"""Return the ShelfManager for this WorkingTree."""
2563
from bzrlib.shelf import ShelfManager
2564
return ShelfManager(self, self._transport)
2567
class WorkingTree2(WorkingTree):
2568
"""This is the Format 2 working tree.
2570
This was the first weave based working tree.
2571
- uses os locks for locking.
2572
- uses the branch last-revision.
2575
def __init__(self, *args, **kwargs):
2576
super(WorkingTree2, self).__init__(*args, **kwargs)
2577
# WorkingTree2 has more of a constraint that self._inventory must
2578
# exist. Because this is an older format, we don't mind the overhead
2579
# caused by the extra computation here.
2581
# Newer WorkingTree's should only have self._inventory set when they
2583
if self._inventory is None:
2584
self.read_working_inventory()
2586
def lock_tree_write(self):
2587
"""See WorkingTree.lock_tree_write().
2589
In Format2 WorkingTrees we have a single lock for the branch and tree
2590
so lock_tree_write() degrades to lock_write().
2592
self.branch.lock_write()
2594
return self._control_files.lock_write()
2596
self.branch.unlock()
2600
# do non-implementation specific cleanup
2603
# we share control files:
2604
if self._control_files._lock_count == 3:
2605
# _inventory_is_modified is always False during a read lock.
2606
if self._inventory_is_modified:
2608
self._write_hashcache_if_dirty()
2610
# reverse order of locking.
2612
return self._control_files.unlock()
2614
self.branch.unlock()
2617
class WorkingTree3(WorkingTree):
2618
"""This is the Format 3 working tree.
2620
This differs from the base WorkingTree by:
2621
- having its own file lock
2622
- having its own last-revision property.
2624
This is new in bzr 0.8
2628
def _last_revision(self):
2629
"""See Mutable.last_revision."""
2631
return self._transport.get_bytes('last-revision')
2632
except errors.NoSuchFile:
2633
return _mod_revision.NULL_REVISION
2635
def _change_last_revision(self, revision_id):
2636
"""See WorkingTree._change_last_revision."""
2637
if revision_id is None or revision_id == NULL_REVISION:
2639
self._transport.delete('last-revision')
2640
except errors.NoSuchFile:
2644
self._transport.put_bytes('last-revision', revision_id,
2645
mode=self.bzrdir._get_file_mode())
2648
@needs_tree_write_lock
2649
def set_conflicts(self, conflicts):
2650
self._put_rio('conflicts', conflicts.to_stanzas(),
2653
@needs_tree_write_lock
2654
def add_conflicts(self, new_conflicts):
2655
conflict_set = set(self.conflicts())
2656
conflict_set.update(set(list(new_conflicts)))
2657
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2658
key=_mod_conflicts.Conflict.sort_key)))
2661
def conflicts(self):
2663
confile = self._transport.get('conflicts')
2664
except errors.NoSuchFile:
2665
return _mod_conflicts.ConflictList()
2668
if confile.next() != CONFLICT_HEADER_1 + '\n':
2669
raise errors.ConflictFormatError()
2670
except StopIteration:
2671
raise errors.ConflictFormatError()
2672
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2677
# do non-implementation specific cleanup
2679
if self._control_files._lock_count == 1:
2680
# _inventory_is_modified is always False during a read lock.
2681
if self._inventory_is_modified:
2683
self._write_hashcache_if_dirty()
2684
# reverse order of locking.
2686
return self._control_files.unlock()
2688
self.branch.unlock()
2691
def get_conflicted_stem(path):
2692
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2693
if path.endswith(suffix):
2694
return path[:-len(suffix)]
2697
class WorkingTreeFormat(object):
2698
"""An encapsulation of the initialization and open routines for a format.
2700
Formats provide three things:
2701
* An initialization routine,
2705
Formats are placed in an dict by their format string for reference
2706
during workingtree opening. Its not required that these be instances, they
2707
can be classes themselves with class methods - it simply depends on
2708
whether state is needed for a given format or not.
2710
Once a format is deprecated, just deprecate the initialize and open
2711
methods on the format class. Do not deprecate the object, as the
2712
object will be created every time regardless.
2715
_default_format = None
2716
"""The default format used for new trees."""
2719
"""The known formats."""
2721
requires_rich_root = False
2723
upgrade_recommended = False
2726
def find_format(klass, a_bzrdir):
2727
"""Return the format for the working tree object in a_bzrdir."""
2729
transport = a_bzrdir.get_workingtree_transport(None)
2730
format_string = transport.get("format").read()
2731
return klass._formats[format_string]
2732
except errors.NoSuchFile:
2733
raise errors.NoWorkingTree(base=transport.base)
2735
raise errors.UnknownFormatError(format=format_string,
2736
kind="working tree")
2738
def __eq__(self, other):
2739
return self.__class__ is other.__class__
2741
def __ne__(self, other):
2742
return not (self == other)
2745
def get_default_format(klass):
2746
"""Return the current default format."""
2747
return klass._default_format
2749
def get_format_string(self):
2750
"""Return the ASCII format string that identifies this format."""
2751
raise NotImplementedError(self.get_format_string)
2753
def get_format_description(self):
2754
"""Return the short description for this format."""
2755
raise NotImplementedError(self.get_format_description)
2757
def is_supported(self):
2758
"""Is this format supported?
2760
Supported formats can be initialized and opened.
2761
Unsupported formats may not support initialization or committing or
2762
some other features depending on the reason for not being supported.
2766
def supports_content_filtering(self):
2767
"""True if this format supports content filtering."""
2770
def supports_views(self):
2771
"""True if this format supports stored views."""
2775
def register_format(klass, format):
2776
klass._formats[format.get_format_string()] = format
2779
def set_default_format(klass, format):
2780
klass._default_format = format
2783
def unregister_format(klass, format):
2784
del klass._formats[format.get_format_string()]
2787
class WorkingTreeFormat2(WorkingTreeFormat):
2788
"""The second working tree format.
2790
This format modified the hash cache from the format 1 hash cache.
2793
upgrade_recommended = True
2795
def get_format_description(self):
2796
"""See WorkingTreeFormat.get_format_description()."""
2797
return "Working tree format 2"
2799
def _stub_initialize_on_transport(self, transport, file_mode):
2800
"""Workaround: create control files for a remote working tree.
2802
This ensures that it can later be updated and dealt with locally,
2803
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2804
no working tree. (See bug #43064).
2808
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2810
transport.put_file('inventory', sio, file_mode)
2811
transport.put_bytes('pending-merges', '', file_mode)
2813
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2814
accelerator_tree=None, hardlink=False):
2815
"""See WorkingTreeFormat.initialize()."""
2816
if not isinstance(a_bzrdir.transport, LocalTransport):
2817
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2818
if from_branch is not None:
2819
branch = from_branch
2821
branch = a_bzrdir.open_branch()
2822
if revision_id is None:
2823
revision_id = _mod_revision.ensure_null(branch.last_revision())
2826
branch.generate_revision_history(revision_id)
2830
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2836
basis_tree = branch.repository.revision_tree(revision_id)
2837
if basis_tree.inventory.root is not None:
2838
wt.set_root_id(basis_tree.get_root_id())
2839
# set the parent list and cache the basis tree.
2840
if _mod_revision.is_null(revision_id):
2843
parent_trees = [(revision_id, basis_tree)]
2844
wt.set_parent_trees(parent_trees)
2845
transform.build_tree(basis_tree, wt)
2849
super(WorkingTreeFormat2, self).__init__()
2850
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2852
def open(self, a_bzrdir, _found=False):
2853
"""Return the WorkingTree object for a_bzrdir
2855
_found is a private parameter, do not use it. It is used to indicate
2856
if format probing has already been done.
2859
# we are being called directly and must probe.
2860
raise NotImplementedError
2861
if not isinstance(a_bzrdir.transport, LocalTransport):
2862
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2863
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2869
class WorkingTreeFormat3(WorkingTreeFormat):
2870
"""The second working tree format updated to record a format marker.
2873
- exists within a metadir controlling .bzr
2874
- includes an explicit version marker for the workingtree control
2875
files, separate from the BzrDir format
2876
- modifies the hash cache format
2878
- uses a LockDir to guard access for writes.
2881
upgrade_recommended = True
2883
def get_format_string(self):
2884
"""See WorkingTreeFormat.get_format_string()."""
2885
return "Bazaar-NG Working Tree format 3"
2887
def get_format_description(self):
2888
"""See WorkingTreeFormat.get_format_description()."""
2889
return "Working tree format 3"
2891
_lock_file_name = 'lock'
2892
_lock_class = LockDir
2894
_tree_class = WorkingTree3
2896
def __get_matchingbzrdir(self):
2897
return bzrdir.BzrDirMetaFormat1()
2899
_matchingbzrdir = property(__get_matchingbzrdir)
2901
def _open_control_files(self, a_bzrdir):
2902
transport = a_bzrdir.get_workingtree_transport(None)
2903
return LockableFiles(transport, self._lock_file_name,
2906
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2907
accelerator_tree=None, hardlink=False):
2908
"""See WorkingTreeFormat.initialize().
2910
:param revision_id: if supplied, create a working tree at a different
2911
revision than the branch is at.
2912
:param accelerator_tree: A tree which can be used for retrieving file
2913
contents more quickly than the revision tree, i.e. a workingtree.
2914
The revision tree will be used for cases where accelerator_tree's
2915
content is different.
2916
:param hardlink: If true, hard-link files from accelerator_tree,
2919
if not isinstance(a_bzrdir.transport, LocalTransport):
2920
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2921
transport = a_bzrdir.get_workingtree_transport(self)
2922
control_files = self._open_control_files(a_bzrdir)
2923
control_files.create_lock()
2924
control_files.lock_write()
2925
transport.put_bytes('format', self.get_format_string(),
2926
mode=a_bzrdir._get_file_mode())
2927
if from_branch is not None:
2928
branch = from_branch
2930
branch = a_bzrdir.open_branch()
2931
if revision_id is None:
2932
revision_id = _mod_revision.ensure_null(branch.last_revision())
2933
# WorkingTree3 can handle an inventory which has a unique root id.
2934
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2935
# those trees. And because there isn't a format bump inbetween, we
2936
# are maintaining compatibility with older clients.
2937
# inv = Inventory(root_id=gen_root_id())
2938
inv = self._initial_inventory()
2939
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2945
_control_files=control_files)
2946
wt.lock_tree_write()
2948
basis_tree = branch.repository.revision_tree(revision_id)
2949
# only set an explicit root id if there is one to set.
2950
if basis_tree.inventory.root is not None:
2951
wt.set_root_id(basis_tree.get_root_id())
2952
if revision_id == NULL_REVISION:
2953
wt.set_parent_trees([])
283
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
2955
wt.set_parent_trees([(revision_id, basis_tree)])
2956
transform.build_tree(basis_tree, wt)
2958
# Unlock in this order so that the unlock-triggers-flush in
2959
# WorkingTree is given a chance to fire.
2960
control_files.unlock()
2964
def _initial_inventory(self):
2968
super(WorkingTreeFormat3, self).__init__()
2970
def open(self, a_bzrdir, _found=False):
2971
"""Return the WorkingTree object for a_bzrdir
2973
_found is a private parameter, do not use it. It is used to indicate
2974
if format probing has already been done.
2977
# we are being called directly and must probe.
2978
raise NotImplementedError
2979
if not isinstance(a_bzrdir.transport, LocalTransport):
2980
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2981
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2984
def _open(self, a_bzrdir, control_files):
2985
"""Open the tree itself.
2987
:param a_bzrdir: the dir for the tree.
2988
:param control_files: the control files for the tree.
2990
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2994
_control_files=control_files)
2997
return self.get_format_string()
3000
__default_format = WorkingTreeFormat4()
3001
WorkingTreeFormat.register_format(__default_format)
3002
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3003
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3004
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3005
WorkingTreeFormat.set_default_format(__default_format)
3006
# formats which have no format string are not discoverable
3007
# and not independently creatable, so are not registered.
3008
_legacy_formats = [WorkingTreeFormat2(),