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 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
maybe_file_parent_keys = []
491
for parent_id in self.get_parent_ids():
493
parent_tree = self.revision_tree(parent_id)
494
except errors.NoSuchRevisionInTree:
495
parent_tree = self.branch.repository.revision_tree(parent_id)
496
parent_tree.lock_read()
498
if file_id not in parent_tree:
500
ie = parent_tree.inventory[file_id]
501
if ie.kind != 'file':
502
# Note: this is slightly unnecessary, because symlinks and
503
# directories have a "text" which is the empty text, and we
504
# know that won't mess up annotations. But it seems cleaner
506
parent_text_key = (file_id, ie.revision)
507
if parent_text_key not in maybe_file_parent_keys:
508
maybe_file_parent_keys.append(parent_text_key)
511
graph = _mod_graph.Graph(self.branch.repository.texts)
512
heads = graph.heads(maybe_file_parent_keys)
513
file_parent_keys = []
514
for key in maybe_file_parent_keys:
516
file_parent_keys.append(key)
518
# Now we have the parents of this content
519
annotator = self.branch.repository.texts.get_annotator()
520
text = self.get_file(file_id).read()
521
this_key =(file_id, default_revision)
522
annotator.add_special_text(this_key, file_parent_keys, text)
523
annotations = [(key[-1], line)
524
for key, line in annotator.annotate_flat(this_key)]
527
def _get_ancestors(self, default_revision):
528
ancestors = set([default_revision])
529
for parent_id in self.get_parent_ids():
530
ancestors.update(self.branch.repository.get_ancestry(
531
parent_id, topo_sorted=False))
534
def get_parent_ids(self):
535
"""See Tree.get_parent_ids.
537
This implementation reads the pending merges list and last_revision
538
value and uses that to decide what the parents list should be.
540
last_rev = _mod_revision.ensure_null(self._last_revision())
541
if _mod_revision.NULL_REVISION == last_rev:
546
merges_bytes = self._transport.get_bytes('pending-merges')
547
except errors.NoSuchFile:
550
for l in osutils.split_lines(merges_bytes):
551
revision_id = l.rstrip('\n')
552
parents.append(revision_id)
556
def get_root_id(self):
557
"""Return the id of this trees root"""
558
return self._inventory.root.file_id
92
560
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))
561
## XXX: badly named; this is not in the store at all
562
return self.abspath(self.id2path(file_id))
565
def clone(self, to_bzrdir, revision_id=None):
566
"""Duplicate this working tree into to_bzr, including all state.
568
Specifically modified files are kept as modified, but
569
ignored and unknown files are discarded.
571
If you want to make a new line of development, see bzrdir.sprout()
574
If not None, the cloned tree will have its last revision set to
575
revision, and difference between the source trees last revision
576
and this one merged in.
578
# assumes the target bzr dir format is compatible.
579
result = to_bzrdir.create_workingtree()
580
self.copy_content_into(result, revision_id)
584
def copy_content_into(self, tree, revision_id=None):
585
"""Copy the current content and user files of this tree into tree."""
586
tree.set_root_id(self.get_root_id())
587
if revision_id is None:
588
merge.transform_tree(tree, self)
590
# TODO now merge from tree.last_revision to revision (to preserve
591
# user local changes)
592
merge.transform_tree(tree, self)
593
tree.set_parent_ids([revision_id])
595
def id2abspath(self, file_id):
596
return self.abspath(self.id2path(file_id))
97
598
def has_id(self, file_id):
98
599
# files that have been deleted are excluded
100
601
if not inv.has_id(file_id):
102
603
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
604
return osutils.lexists(self.abspath(path))
606
def has_or_had_id(self, file_id):
607
if file_id == self.inventory.root.file_id:
609
return self.inventory.has_id(file_id)
106
611
__contains__ = has_id
109
613
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).
614
"""See Tree.get_file_size"""
615
# XXX: this returns the on-disk size; it should probably return the
618
return os.path.getsize(self.id2abspath(file_id))
620
if e.errno != errno.ENOENT:
626
def get_file_sha1(self, file_id, path=None, stat_value=None):
628
path = self._inventory.id2path(file_id)
629
return self._hashcache.get_sha1(path, stat_value)
631
def get_file_mtime(self, file_id, path=None):
633
path = self.inventory.id2path(file_id)
634
return os.lstat(self.abspath(path)).st_mtime
636
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
637
file_id = self.path2id(path)
639
# For unversioned files on win32, we just assume they are not
642
return self._inventory[file_id].executable
644
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
645
mode = stat_result.st_mode
646
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
648
if not supports_executable():
649
def is_executable(self, file_id, path=None):
650
return self._inventory[file_id].executable
652
_is_executable_from_path_and_stat = \
653
_is_executable_from_path_and_stat_from_basis
655
def is_executable(self, file_id, path=None):
657
path = self.id2path(file_id)
658
mode = os.lstat(self.abspath(path)).st_mode
659
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
661
_is_executable_from_path_and_stat = \
662
_is_executable_from_path_and_stat_from_stat
664
@needs_tree_write_lock
665
def _add(self, files, ids, kinds):
666
"""See MutableTree._add."""
667
# TODO: Re-adding a file that is removed in the working copy
668
# should probably put it back with the previous ID.
669
# the read and write working inventory should not occur in this
670
# function - they should be part of lock_write and unlock.
672
for f, file_id, kind in zip(files, ids, kinds):
674
inv.add_path(f, kind=kind)
676
inv.add_path(f, kind=kind, file_id=file_id)
677
self._inventory_is_modified = True
679
@needs_tree_write_lock
680
def _gather_kinds(self, files, kinds):
681
"""See MutableTree._gather_kinds."""
682
for pos, f in enumerate(files):
683
if kinds[pos] is None:
684
fullpath = normpath(self.abspath(f))
686
kinds[pos] = file_kind(fullpath)
688
if e.errno == errno.ENOENT:
689
raise errors.NoSuchFile(fullpath)
692
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
693
"""Add revision_id as a parent.
695
This is equivalent to retrieving the current list of parent ids
696
and setting the list to its value plus revision_id.
698
:param revision_id: The revision id to add to the parent list. It may
699
be a ghost revision as long as its not the first parent to be added,
700
or the allow_leftmost_as_ghost parameter is set True.
701
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
703
parents = self.get_parent_ids() + [revision_id]
704
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
705
or allow_leftmost_as_ghost)
707
@needs_tree_write_lock
708
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
709
"""Add revision_id, tree tuple as a parent.
711
This is equivalent to retrieving the current list of parent trees
712
and setting the list to its value plus parent_tuple. See also
713
add_parent_tree_id - if you only have a parent id available it will be
714
simpler to use that api. If you have the parent already available, using
715
this api is preferred.
717
:param parent_tuple: The (revision id, tree) to add to the parent list.
718
If the revision_id is a ghost, pass None for the tree.
719
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
721
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
722
if len(parent_ids) > 1:
723
# the leftmost may have already been a ghost, preserve that if it
725
allow_leftmost_as_ghost = True
726
self.set_parent_ids(parent_ids,
727
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
729
@needs_tree_write_lock
730
def add_pending_merge(self, *revision_ids):
731
# TODO: Perhaps should check at this point that the
732
# history of the revision is actually present?
733
parents = self.get_parent_ids()
735
for rev_id in revision_ids:
736
if rev_id in parents:
738
parents.append(rev_id)
741
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
743
def path_content_summary(self, path, _lstat=os.lstat,
744
_mapper=osutils.file_kind_from_stat_mode):
745
"""See Tree.path_content_summary."""
746
abspath = self.abspath(path)
748
stat_result = _lstat(abspath)
750
if getattr(e, 'errno', None) == errno.ENOENT:
752
return ('missing', None, None, None)
753
# propagate other errors
755
kind = _mapper(stat_result.st_mode)
757
return self._file_content_summary(path, stat_result)
758
elif kind == 'directory':
759
# perhaps it looks like a plain directory, but it's really a
761
if self._directory_is_tree_reference(path):
762
kind = 'tree-reference'
763
return kind, None, None, None
764
elif kind == 'symlink':
765
target = osutils.readlink(abspath)
766
return ('symlink', None, None, target)
768
return (kind, None, None, None)
770
def _file_content_summary(self, path, stat_result):
771
size = stat_result.st_size
772
executable = self._is_executable_from_path_and_stat(path, stat_result)
773
# try for a stat cache lookup
774
return ('file', size, executable, self._sha_from_stat(
777
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
778
"""Common ghost checking functionality from set_parent_*.
780
This checks that the left hand-parent exists if there are any
783
if len(revision_ids) > 0:
784
leftmost_id = revision_ids[0]
785
if (not allow_leftmost_as_ghost and not
786
self.branch.repository.has_revision(leftmost_id)):
787
raise errors.GhostRevisionUnusableHere(leftmost_id)
789
def _set_merges_from_parent_ids(self, parent_ids):
790
merges = parent_ids[1:]
791
self._transport.put_bytes('pending-merges', '\n'.join(merges),
792
mode=self.bzrdir._get_file_mode())
794
def _filter_parent_ids_by_ancestry(self, revision_ids):
795
"""Check that all merged revisions are proper 'heads'.
797
This will always return the first revision_id, and any merged revisions
800
if len(revision_ids) == 0:
802
graph = self.branch.repository.get_graph()
803
heads = graph.heads(revision_ids)
804
new_revision_ids = revision_ids[:1]
805
for revision_id in revision_ids[1:]:
806
if revision_id in heads and revision_id not in new_revision_ids:
807
new_revision_ids.append(revision_id)
808
if new_revision_ids != revision_ids:
809
trace.mutter('requested to set revision_ids = %s,'
810
' but filtered to %s', revision_ids, new_revision_ids)
811
return new_revision_ids
813
@needs_tree_write_lock
814
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
815
"""Set the parent ids to revision_ids.
817
See also set_parent_trees. This api will try to retrieve the tree data
818
for each element of revision_ids from the trees repository. If you have
819
tree data already available, it is more efficient to use
820
set_parent_trees rather than set_parent_ids. set_parent_ids is however
821
an easier API to use.
823
:param revision_ids: The revision_ids to set as the parent ids of this
824
working tree. Any of these may be ghosts.
826
self._check_parents_for_ghosts(revision_ids,
827
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
828
for revision_id in revision_ids:
829
_mod_revision.check_not_reserved_id(revision_id)
831
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
833
if len(revision_ids) > 0:
834
self.set_last_revision(revision_ids[0])
836
self.set_last_revision(_mod_revision.NULL_REVISION)
838
self._set_merges_from_parent_ids(revision_ids)
840
@needs_tree_write_lock
841
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
842
"""See MutableTree.set_parent_trees."""
843
parent_ids = [rev for (rev, tree) in parents_list]
844
for revision_id in parent_ids:
845
_mod_revision.check_not_reserved_id(revision_id)
847
self._check_parents_for_ghosts(parent_ids,
848
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
850
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
852
if len(parent_ids) == 0:
853
leftmost_parent_id = _mod_revision.NULL_REVISION
854
leftmost_parent_tree = None
856
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
858
if self._change_last_revision(leftmost_parent_id):
859
if leftmost_parent_tree is None:
860
# If we don't have a tree, fall back to reading the
861
# parent tree from the repository.
862
self._cache_basis_inventory(leftmost_parent_id)
864
inv = leftmost_parent_tree.inventory
865
xml = self._create_basis_xml_from_inventory(
866
leftmost_parent_id, inv)
867
self._write_basis_inventory(xml)
868
self._set_merges_from_parent_ids(parent_ids)
870
@needs_tree_write_lock
871
def set_pending_merges(self, rev_list):
872
parents = self.get_parent_ids()
873
leftmost = parents[:1]
874
new_parents = leftmost + rev_list
875
self.set_parent_ids(new_parents)
877
@needs_tree_write_lock
878
def set_merge_modified(self, modified_hashes):
880
for file_id, hash in modified_hashes.iteritems():
881
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
882
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
884
def _sha_from_stat(self, path, stat_result):
885
"""Get a sha digest from the tree's stat cache.
887
The default implementation assumes no stat cache is present.
889
:param path: The path.
890
:param stat_result: The stat result being looked up.
894
def _put_rio(self, filename, stanzas, header):
895
self._must_be_locked()
896
my_file = rio_file(stanzas, header)
897
self._transport.put_file(filename, my_file,
898
mode=self.bzrdir._get_file_mode())
900
@needs_write_lock # because merge pulls data into the branch.
901
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
902
merge_type=None, force=False):
903
"""Merge from a branch into this working tree.
905
:param branch: The branch to merge from.
906
:param to_revision: If non-None, the merge will merge to to_revision,
907
but not beyond it. to_revision does not need to be in the history
908
of the branch when it is supplied. If None, to_revision defaults to
909
branch.last_revision().
911
from bzrlib.merge import Merger, Merge3Merger
912
merger = Merger(self.branch, this_tree=self)
913
# check that there are no local alterations
914
if not force and self.has_changes():
915
raise errors.UncommittedChanges(self)
916
if to_revision is None:
917
to_revision = _mod_revision.ensure_null(branch.last_revision())
918
merger.other_rev_id = to_revision
919
if _mod_revision.is_null(merger.other_rev_id):
920
raise errors.NoCommits(branch)
921
self.branch.fetch(branch, last_revision=merger.other_rev_id)
922
merger.other_basis = merger.other_rev_id
923
merger.other_tree = self.branch.repository.revision_tree(
925
merger.other_branch = branch
926
if from_revision is None:
929
merger.set_base_revision(from_revision, branch)
930
if merger.base_rev_id == merger.other_rev_id:
931
raise errors.PointlessMerge
932
merger.backup_files = False
933
if merge_type is None:
934
merger.merge_type = Merge3Merger
936
merger.merge_type = merge_type
937
merger.set_interesting_files(None)
938
merger.show_base = False
939
merger.reprocess = False
940
conflicts = merger.do_merge()
945
def merge_modified(self):
946
"""Return a dictionary of files modified by a merge.
948
The list is initialized by WorkingTree.set_merge_modified, which is
949
typically called after we make some automatic updates to the tree
952
This returns a map of file_id->sha1, containing only files which are
953
still in the working inventory and have that text hash.
956
hashfile = self._transport.get('merge-hashes')
957
except errors.NoSuchFile:
962
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
963
raise errors.MergeModifiedFormatError()
964
except StopIteration:
965
raise errors.MergeModifiedFormatError()
966
for s in RioReader(hashfile):
967
# RioReader reads in Unicode, so convert file_ids back to utf8
968
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
969
if file_id not in self.inventory:
971
text_hash = s.get("hash")
972
if text_hash == self.get_file_sha1(file_id):
973
merge_hashes[file_id] = text_hash
979
def mkdir(self, path, file_id=None):
980
"""See MutableTree.mkdir()."""
982
file_id = generate_ids.gen_file_id(os.path.basename(path))
983
os.mkdir(self.abspath(path))
984
self.add(path, file_id, 'directory')
987
def get_symlink_target(self, file_id):
988
abspath = self.id2abspath(file_id)
989
target = osutils.readlink(abspath)
993
def subsume(self, other_tree):
994
def add_children(inventory, entry):
995
for child_entry in entry.children.values():
996
inventory._byid[child_entry.file_id] = child_entry
997
if child_entry.kind == 'directory':
998
add_children(inventory, child_entry)
999
if other_tree.get_root_id() == self.get_root_id():
1000
raise errors.BadSubsumeSource(self, other_tree,
1001
'Trees have the same root')
1003
other_tree_path = self.relpath(other_tree.basedir)
1004
except errors.PathNotChild:
1005
raise errors.BadSubsumeSource(self, other_tree,
1006
'Tree is not contained by the other')
1007
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1008
if new_root_parent is None:
1009
raise errors.BadSubsumeSource(self, other_tree,
1010
'Parent directory is not versioned.')
1011
# We need to ensure that the result of a fetch will have a
1012
# versionedfile for the other_tree root, and only fetching into
1013
# RepositoryKnit2 guarantees that.
1014
if not self.branch.repository.supports_rich_root():
1015
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1016
other_tree.lock_tree_write()
1018
new_parents = other_tree.get_parent_ids()
1019
other_root = other_tree.inventory.root
1020
other_root.parent_id = new_root_parent
1021
other_root.name = osutils.basename(other_tree_path)
1022
self.inventory.add(other_root)
1023
add_children(self.inventory, other_root)
1024
self._write_inventory(self.inventory)
1025
# normally we don't want to fetch whole repositories, but i think
1026
# here we really do want to consolidate the whole thing.
1027
for parent_id in other_tree.get_parent_ids():
1028
self.branch.fetch(other_tree.branch, parent_id)
1029
self.add_parent_tree_id(parent_id)
1032
other_tree.bzrdir.retire_bzrdir()
1034
def _setup_directory_is_tree_reference(self):
1035
if self._branch.repository._format.supports_tree_reference:
1036
self._directory_is_tree_reference = \
1037
self._directory_may_be_tree_reference
1039
self._directory_is_tree_reference = \
1040
self._directory_is_never_tree_reference
1042
def _directory_is_never_tree_reference(self, relpath):
1045
def _directory_may_be_tree_reference(self, relpath):
1046
# as a special case, if a directory contains control files then
1047
# it's a tree reference, except that the root of the tree is not
1048
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1049
# TODO: We could ask all the control formats whether they
1050
# recognize this directory, but at the moment there's no cheap api
1051
# to do that. Since we probably can only nest bzr checkouts and
1052
# they always use this name it's ok for now. -- mbp 20060306
1054
# FIXME: There is an unhandled case here of a subdirectory
1055
# containing .bzr but not a branch; that will probably blow up
1056
# when you try to commit it. It might happen if there is a
1057
# checkout in a subdirectory. This can be avoided by not adding
1060
@needs_tree_write_lock
1061
def extract(self, file_id, format=None):
1062
"""Extract a subtree from this tree.
1064
A new branch will be created, relative to the path for this tree.
1068
segments = osutils.splitpath(path)
1069
transport = self.branch.bzrdir.root_transport
1070
for name in segments:
1071
transport = transport.clone(name)
1072
transport.ensure_base()
1075
sub_path = self.id2path(file_id)
1076
branch_transport = mkdirs(sub_path)
1078
format = self.bzrdir.cloning_metadir()
1079
branch_transport.ensure_base()
1080
branch_bzrdir = format.initialize_on_transport(branch_transport)
1082
repo = branch_bzrdir.find_repository()
1083
except errors.NoRepositoryPresent:
1084
repo = branch_bzrdir.create_repository()
1085
if not repo.supports_rich_root():
1086
raise errors.RootNotRich()
1087
new_branch = branch_bzrdir.create_branch()
1088
new_branch.pull(self.branch)
1089
for parent_id in self.get_parent_ids():
1090
new_branch.fetch(self.branch, parent_id)
1091
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1092
if tree_transport.base != branch_transport.base:
1093
tree_bzrdir = format.initialize_on_transport(tree_transport)
1094
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1096
tree_bzrdir = branch_bzrdir
1097
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1098
wt.set_parent_ids(self.get_parent_ids())
1099
my_inv = self.inventory
1100
child_inv = inventory.Inventory(root_id=None)
1101
new_root = my_inv[file_id]
1102
my_inv.remove_recursive_id(file_id)
1103
new_root.parent_id = None
1104
child_inv.add(new_root)
1105
self._write_inventory(my_inv)
1106
wt._write_inventory(child_inv)
1109
def _serialize(self, inventory, out_file):
1110
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1113
def _deserialize(selt, in_file):
1114
return xml5.serializer_v5.read_inventory(in_file)
1117
"""Write the in memory inventory to disk."""
1118
# TODO: Maybe this should only write on dirty ?
1119
if self._control_files._lock_mode != 'w':
1120
raise errors.NotWriteLocked(self)
1122
self._serialize(self._inventory, sio)
1124
self._transport.put_file('inventory', sio,
1125
mode=self.bzrdir._get_file_mode())
1126
self._inventory_is_modified = False
1128
def _kind(self, relpath):
1129
return osutils.file_kind(self.abspath(relpath))
1131
def list_files(self, include_root=False, from_dir=None, recursive=True):
1132
"""List all files as (path, class, kind, id, entry).
131
1134
Lists, but does not descend into unversioned directories.
133
1135
This does not include files that have been deleted in this
1136
tree. Skips the control directory.
136
Skips the control directory.
1138
:param include_root: if True, do not return an entry for the root
1139
:param from_dir: start from this directory or None for the root
1140
:param recursive: whether to recurse into subdirectories or not
138
from osutils import appendpath, file_kind
141
inv = self._inventory
143
def descend(from_dir_relpath, from_dir_id, dp):
1142
# list_files is an iterator, so @needs_read_lock doesn't work properly
1143
# with it. So callers should be careful to always read_lock the tree.
1144
if not self.is_locked():
1145
raise errors.ObjectNotLocked(self)
1147
inv = self.inventory
1148
if from_dir is None and include_root is True:
1149
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1150
# Convert these into local objects to save lookup times
1151
pathjoin = osutils.pathjoin
1152
file_kind = self._kind
1154
# transport.base ends in a slash, we want the piece
1155
# between the last two slashes
1156
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1158
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1160
# directory file_id, relative path, absolute path, reverse sorted children
1161
if from_dir is not None:
1162
from_dir_id = inv.path2id(from_dir)
1163
if from_dir_id is None:
1164
# Directory not versioned
1166
from_dir_abspath = pathjoin(self.basedir, from_dir)
1168
from_dir_id = inv.root.file_id
1169
from_dir_abspath = self.basedir
1170
children = os.listdir(from_dir_abspath)
1172
# jam 20060527 The kernel sized tree seems equivalent whether we
1173
# use a deque and popleft to keep them sorted, or if we use a plain
1174
# list and just reverse() them.
1175
children = collections.deque(children)
1176
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1178
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1181
f = children.popleft()
147
1182
## TODO: If we find a subdirectory with its own .bzr
148
1183
## directory, then that is a separate tree and we
149
1184
## should exclude it.
150
if bzrlib.BZRDIR == f:
1186
# the bzrdir for this tree
1187
if transport_base_dir == f:
154
fp = appendpath(from_dir_relpath, f)
1190
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1191
# and 'f' doesn't begin with one, we can do a string op, rather
1192
# than the checks of pathjoin(), all relative paths will have an extra slash
1194
fp = from_dir_relpath + '/' + f
157
fap = appendpath(dp, f)
1197
fap = from_dir_abspath + '/' + f
159
1199
f_ie = inv.get_child(from_dir_id, f)
162
elif self.is_ignored(fp):
1202
elif self.is_ignored(fp[1:]):
1205
# we may not have found this file, because of a unicode issue
1206
f_norm, can_access = osutils.normalized_filename(f)
1207
if f == f_norm or not can_access:
1208
# No change, so treat this file normally
1211
# this file can be accessed by a normalized path
1212
# check again if it is versioned
1213
# these lines are repeated here for performance
1215
fp = from_dir_relpath + '/' + f
1216
fap = from_dir_abspath + '/' + f
1217
f_ie = inv.get_child(from_dir_id, f)
1220
elif self.is_ignored(fp[1:]):
167
1225
fk = file_kind(fap)
1227
# 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)
1229
yield fp[1:], c, fk, f_ie.file_id, f_ie
1232
yield fp[1:], c, fk, None, fk_entries[fk]()
1234
yield fp[1:], c, fk, None, TreeEntry()
177
1237
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):
1240
# But do this child first if recursing down
1242
new_children = os.listdir(fap)
1244
new_children = collections.deque(new_children)
1245
stack.append((f_ie.file_id, fp, fap, new_children))
1246
# Break out of inner loop,
1247
# so that we start outer loop with child
1250
# if we finished all children, pop it off the stack
1253
@needs_tree_write_lock
1254
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1257
to_dir must exist in the inventory.
1259
If to_dir exists and is a directory, the files are moved into
1260
it, keeping their old names.
1262
Note that to_dir is only the last component of the new name;
1263
this doesn't change the directory.
1265
For each entry in from_paths the move mode will be determined
1268
The first mode moves the file in the filesystem and updates the
1269
inventory. The second mode only updates the inventory without
1270
touching the file on the filesystem. This is the new mode introduced
1273
move uses the second mode if 'after == True' and the target is not
1274
versioned but present in the working tree.
1276
move uses the second mode if 'after == False' and the source is
1277
versioned but no longer in the working tree, and the target is not
1278
versioned but present in the working tree.
1280
move uses the first mode if 'after == False' and the source is
1281
versioned and present in the working tree, and the target is not
1282
versioned and not present in the working tree.
1284
Everything else results in an error.
1286
This returns a list of (from_path, to_path) pairs for each
1287
entry that is moved.
1292
# check for deprecated use of signature
1294
to_dir = kwargs.get('to_name', None)
1296
raise TypeError('You must supply a target directory')
1298
symbol_versioning.warn('The parameter to_name was deprecated'
1299
' in version 0.13. Use to_dir instead',
1302
# check destination directory
1303
if isinstance(from_paths, basestring):
1305
inv = self.inventory
1306
to_abs = self.abspath(to_dir)
1307
if not isdir(to_abs):
1308
raise errors.BzrMoveFailedError('',to_dir,
1309
errors.NotADirectory(to_abs))
1310
if not self.has_filename(to_dir):
1311
raise errors.BzrMoveFailedError('',to_dir,
1312
errors.NotInWorkingDirectory(to_dir))
1313
to_dir_id = inv.path2id(to_dir)
1314
if to_dir_id is None:
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotVersionedError(path=str(to_dir)))
1318
to_dir_ie = inv[to_dir_id]
1319
if to_dir_ie.kind != 'directory':
1320
raise errors.BzrMoveFailedError('',to_dir,
1321
errors.NotADirectory(to_abs))
1323
# create rename entries and tuples
1324
for from_rel in from_paths:
1325
from_tail = splitpath(from_rel)[-1]
1326
from_id = inv.path2id(from_rel)
1328
raise errors.BzrMoveFailedError(from_rel,to_dir,
1329
errors.NotVersionedError(path=str(from_rel)))
1331
from_entry = inv[from_id]
1332
from_parent_id = from_entry.parent_id
1333
to_rel = pathjoin(to_dir, from_tail)
1334
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1336
from_tail=from_tail,
1337
from_parent_id=from_parent_id,
1338
to_rel=to_rel, to_tail=from_tail,
1339
to_parent_id=to_dir_id)
1340
rename_entries.append(rename_entry)
1341
rename_tuples.append((from_rel, to_rel))
1343
# determine which move mode to use. checks also for movability
1344
rename_entries = self._determine_mv_mode(rename_entries, after)
1346
original_modified = self._inventory_is_modified
1349
self._inventory_is_modified = True
1350
self._move(rename_entries)
1352
# restore the inventory on error
1353
self._inventory_is_modified = original_modified
1355
self._write_inventory(inv)
1356
return rename_tuples
1358
def _determine_mv_mode(self, rename_entries, after=False):
1359
"""Determines for each from-to pair if both inventory and working tree
1360
or only the inventory has to be changed.
1362
Also does basic plausability tests.
1364
inv = self.inventory
1366
for rename_entry in rename_entries:
1367
# store to local variables for easier reference
1368
from_rel = rename_entry.from_rel
1369
from_id = rename_entry.from_id
1370
to_rel = rename_entry.to_rel
1371
to_id = inv.path2id(to_rel)
1372
only_change_inv = False
1374
# check the inventory for source and destination
1376
raise errors.BzrMoveFailedError(from_rel,to_rel,
1377
errors.NotVersionedError(path=str(from_rel)))
1378
if to_id is not None:
1379
raise errors.BzrMoveFailedError(from_rel,to_rel,
1380
errors.AlreadyVersionedError(path=str(to_rel)))
1382
# try to determine the mode for rename (only change inv or change
1383
# inv and file system)
1385
if not self.has_filename(to_rel):
1386
raise errors.BzrMoveFailedError(from_id,to_rel,
1387
errors.NoSuchFile(path=str(to_rel),
1388
extra="New file has not been created yet"))
1389
only_change_inv = True
1390
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1391
only_change_inv = True
1392
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1393
only_change_inv = False
1394
elif (not self.case_sensitive
1395
and from_rel.lower() == to_rel.lower()
1396
and self.has_filename(from_rel)):
1397
only_change_inv = False
1399
# something is wrong, so lets determine what exactly
1400
if not self.has_filename(from_rel) and \
1401
not self.has_filename(to_rel):
1402
raise errors.BzrRenameFailedError(from_rel,to_rel,
1403
errors.PathsDoNotExist(paths=(str(from_rel),
1406
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1407
rename_entry.only_change_inv = only_change_inv
1408
return rename_entries
1410
def _move(self, rename_entries):
1411
"""Moves a list of files.
1413
Depending on the value of the flag 'only_change_inv', the
1414
file will be moved on the file system or not.
1416
inv = self.inventory
1419
for entry in rename_entries:
1421
self._move_entry(entry)
1423
self._rollback_move(moved)
1427
def _rollback_move(self, moved):
1428
"""Try to rollback a previous move in case of an filesystem error."""
1429
inv = self.inventory
1432
self._move_entry(WorkingTree._RenameEntry(
1433
entry.to_rel, entry.from_id,
1434
entry.to_tail, entry.to_parent_id, entry.from_rel,
1435
entry.from_tail, entry.from_parent_id,
1436
entry.only_change_inv))
1437
except errors.BzrMoveFailedError, e:
1438
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1439
" The working tree is in an inconsistent state."
1440
" Please consider doing a 'bzr revert'."
1441
" Error message is: %s" % e)
1443
def _move_entry(self, entry):
1444
inv = self.inventory
1445
from_rel_abs = self.abspath(entry.from_rel)
1446
to_rel_abs = self.abspath(entry.to_rel)
1447
if from_rel_abs == to_rel_abs:
1448
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1449
"Source and target are identical.")
1451
if not entry.only_change_inv:
1453
osutils.rename(from_rel_abs, to_rel_abs)
1455
raise errors.BzrMoveFailedError(entry.from_rel,
1457
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1459
@needs_tree_write_lock
1460
def rename_one(self, from_rel, to_rel, after=False):
1463
This can change the directory or the filename or both.
1465
rename_one has several 'modes' to work. First, it can rename a physical
1466
file and change the file_id. That is the normal mode. Second, it can
1467
only change the file_id without touching any physical file. This is
1468
the new mode introduced in version 0.15.
1470
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1471
versioned but present in the working tree.
1473
rename_one uses the second mode if 'after == False' and 'from_rel' is
1474
versioned but no longer in the working tree, and 'to_rel' is not
1475
versioned but present in the working tree.
1477
rename_one uses the first mode if 'after == False' and 'from_rel' is
1478
versioned and present in the working tree, and 'to_rel' is not
1479
versioned and not present in the working tree.
1481
Everything else results in an error.
1483
inv = self.inventory
1486
# create rename entries and tuples
1487
from_tail = splitpath(from_rel)[-1]
1488
from_id = inv.path2id(from_rel)
1490
# if file is missing in the inventory maybe it's in the basis_tree
1491
basis_tree = self.branch.basis_tree()
1492
from_id = basis_tree.path2id(from_rel)
1494
raise errors.BzrRenameFailedError(from_rel,to_rel,
1495
errors.NotVersionedError(path=str(from_rel)))
1496
# put entry back in the inventory so we can rename it
1497
from_entry = basis_tree.inventory[from_id].copy()
1500
from_entry = inv[from_id]
1501
from_parent_id = from_entry.parent_id
1502
to_dir, to_tail = os.path.split(to_rel)
1503
to_dir_id = inv.path2id(to_dir)
1504
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1506
from_tail=from_tail,
1507
from_parent_id=from_parent_id,
1508
to_rel=to_rel, to_tail=to_tail,
1509
to_parent_id=to_dir_id)
1510
rename_entries.append(rename_entry)
1512
# determine which move mode to use. checks also for movability
1513
rename_entries = self._determine_mv_mode(rename_entries, after)
1515
# check if the target changed directory and if the target directory is
1517
if to_dir_id is None:
1518
raise errors.BzrMoveFailedError(from_rel,to_rel,
1519
errors.NotVersionedError(path=str(to_dir)))
1521
# all checks done. now we can continue with our actual work
1522
mutter('rename_one:\n'
1527
' to_dir_id {%s}\n',
1528
from_id, from_rel, to_rel, to_dir, to_dir_id)
1530
self._move(rename_entries)
1531
self._write_inventory(inv)
1533
class _RenameEntry(object):
1534
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1535
to_rel, to_tail, to_parent_id, only_change_inv=False):
1536
self.from_rel = from_rel
1537
self.from_id = from_id
1538
self.from_tail = from_tail
1539
self.from_parent_id = from_parent_id
1540
self.to_rel = to_rel
1541
self.to_tail = to_tail
1542
self.to_parent_id = to_parent_id
1543
self.only_change_inv = only_change_inv
192
1546
def unknowns(self):
193
for subp in self.extras():
194
if not self.is_ignored(subp):
1547
"""Return all unknown files.
1549
These are files in the working directory that are not versioned or
1550
control files or ignored.
1552
# force the extras method to be fully executed before returning, to
1553
# prevent race conditions with the lock
1555
[subp for subp in self.extras() if not self.is_ignored(subp)])
1557
@needs_tree_write_lock
1558
def unversion(self, file_ids):
1559
"""Remove the file ids in file_ids from the current versioned set.
1561
When a file_id is unversioned, all of its children are automatically
1564
:param file_ids: The file ids to stop versioning.
1565
:raises: NoSuchId if any fileid is not currently versioned.
1567
for file_id in file_ids:
1568
if file_id not in self._inventory:
1569
raise errors.NoSuchId(self, file_id)
1570
for file_id in file_ids:
1571
if self._inventory.has_id(file_id):
1572
self._inventory.remove_recursive_id(file_id)
1574
# in the future this should just set a dirty bit to wait for the
1575
# final unlock. However, until all methods of workingtree start
1576
# with the current in -memory inventory rather than triggering
1577
# a read, it is more complex - we need to teach read_inventory
1578
# to know when to read, and when to not read first... and possibly
1579
# to save first when the in memory one may be corrupted.
1580
# so for now, we just only write it if it is indeed dirty.
1582
self._write_inventory(self._inventory)
1584
def _iter_conflicts(self):
1586
for info in self.list_files():
1588
stem = get_conflicted_stem(path)
1591
if stem not in conflicted:
1592
conflicted.add(stem)
1596
def pull(self, source, overwrite=False, stop_revision=None,
1597
change_reporter=None, possible_transports=None, local=False):
1600
old_revision_info = self.branch.last_revision_info()
1601
basis_tree = self.basis_tree()
1602
count = self.branch.pull(source, overwrite, stop_revision,
1603
possible_transports=possible_transports,
1605
new_revision_info = self.branch.last_revision_info()
1606
if new_revision_info != old_revision_info:
1607
repository = self.branch.repository
1608
basis_tree.lock_read()
1610
new_basis_tree = self.branch.basis_tree()
1617
change_reporter=change_reporter)
1618
basis_root_id = basis_tree.get_root_id()
1619
new_root_id = new_basis_tree.get_root_id()
1620
if basis_root_id != new_root_id:
1621
self.set_root_id(new_root_id)
1624
# TODO - dedup parents list with things merged by pull ?
1625
# reuse the revisiontree we merged against to set the new
1627
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1628
# we have to pull the merge trees out again, because
1629
# merge_inner has set the ids. - this corner is not yet
1630
# layered well enough to prevent double handling.
1631
# XXX TODO: Fix the double handling: telling the tree about
1632
# the already known parent data is wasteful.
1633
merges = self.get_parent_ids()[1:]
1634
parent_trees.extend([
1635
(parent, repository.revision_tree(parent)) for
1637
self.set_parent_trees(parent_trees)
1643
def put_file_bytes_non_atomic(self, file_id, bytes):
1644
"""See MutableTree.put_file_bytes_non_atomic."""
1645
stream = file(self.id2abspath(file_id), 'wb')
1650
# TODO: update the hashcache here ?
198
1652
def extras(self):
199
"""Yield all unknown files in this WorkingTree.
1653
"""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
1655
If there are any unversioned directories then only the directory is
1656
returned, not all its children. But if there are unversioned files
203
1657
under a versioned subdirectory, they are returned.
205
1659
Currently returned depth-first, sorted by name within directories.
1660
This is the same order used by 'osutils.walkdirs'.
207
1662
## TODO: Work from given directory downwards
208
from osutils import isdir, appendpath
210
1663
for path, dir_entry in self.inventory.directories():
211
mutter("search for unknowns in %r" % path)
1664
# mutter("search for unknowns in %r", path)
212
1665
dirabs = self.abspath(path)
213
1666
if not isdir(dirabs):
214
1667
# e.g. directory deleted
259
1733
If the file is ignored, returns the pattern which caused it to
260
1734
be ignored, otherwise None. So this can simply be used as a
261
1735
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] == '.\\'):
1736
if getattr(self, '_ignoreglobster', None) is None:
1737
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1738
return self._ignoreglobster.match(filename)
1740
def kind(self, file_id):
1741
return file_kind(self.id2abspath(file_id))
1743
def stored_kind(self, file_id):
1744
"""See Tree.stored_kind"""
1745
return self.inventory[file_id].kind
1747
def _comparison_data(self, entry, path):
1748
abspath = self.abspath(path)
1750
stat_value = os.lstat(abspath)
1752
if getattr(e, 'errno', None) == errno.ENOENT:
1759
mode = stat_value.st_mode
1760
kind = osutils.file_kind_from_stat_mode(mode)
1761
if not supports_executable():
1762
executable = entry is not None and entry.executable
1764
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1765
return kind, executable, stat_value
1767
def _file_size(self, entry, stat_value):
1768
return stat_value.st_size
1770
def last_revision(self):
1771
"""Return the last revision of the branch for this tree.
1773
This format tree does not support a separate marker for last-revision
1774
compared to the branch.
1776
See MutableTree.last_revision
1778
return self._last_revision()
1781
def _last_revision(self):
1782
"""helper for get_parent_ids."""
1783
return _mod_revision.ensure_null(self.branch.last_revision())
1785
def is_locked(self):
1786
return self._control_files.is_locked()
1788
def _must_be_locked(self):
1789
if not self.is_locked():
1790
raise errors.ObjectNotLocked(self)
1792
def lock_read(self):
1793
"""See Branch.lock_read, and WorkingTree.unlock."""
1794
if not self.is_locked():
1796
self.branch.lock_read()
1798
return self._control_files.lock_read()
1800
self.branch.unlock()
1803
def lock_tree_write(self):
1804
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1805
if not self.is_locked():
1807
self.branch.lock_read()
1809
return self._control_files.lock_write()
1811
self.branch.unlock()
1814
def lock_write(self):
1815
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1816
if not self.is_locked():
1818
self.branch.lock_write()
1820
return self._control_files.lock_write()
1822
self.branch.unlock()
1825
def get_physical_lock_status(self):
1826
return self._control_files.get_physical_lock_status()
1828
def _basis_inventory_name(self):
1829
return 'basis-inventory-cache'
1831
def _reset_data(self):
1832
"""Reset transient data that cannot be revalidated."""
1833
self._inventory_is_modified = False
1834
f = self._transport.get('inventory')
1836
result = self._deserialize(f)
1839
self._set_inventory(result, dirty=False)
1841
@needs_tree_write_lock
1842
def set_last_revision(self, new_revision):
1843
"""Change the last revision in the working tree."""
1844
if self._change_last_revision(new_revision):
1845
self._cache_basis_inventory(new_revision)
1847
def _change_last_revision(self, new_revision):
1848
"""Template method part of set_last_revision to perform the change.
1850
This is used to allow WorkingTree3 instances to not affect branch
1851
when their last revision is set.
1853
if _mod_revision.is_null(new_revision):
1854
self.branch.set_revision_history([])
1857
self.branch.generate_revision_history(new_revision)
1858
except errors.NoSuchRevision:
1859
# not present in the repo - dont try to set it deeper than the tip
1860
self.branch.set_revision_history([new_revision])
1863
def _write_basis_inventory(self, xml):
1864
"""Write the basis inventory XML to the basis-inventory file"""
1865
path = self._basis_inventory_name()
1867
self._transport.put_file(path, sio,
1868
mode=self.bzrdir._get_file_mode())
1870
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1871
"""Create the text that will be saved in basis-inventory"""
1872
inventory.revision_id = revision_id
1873
return xml7.serializer_v7.write_inventory_to_string(inventory)
1875
def _cache_basis_inventory(self, new_revision):
1876
"""Cache new_revision as the basis inventory."""
1877
# TODO: this should allow the ready-to-use inventory to be passed in,
1878
# as commit already has that ready-to-use [while the format is the
1881
# this double handles the inventory - unpack and repack -
1882
# but is easier to understand. We can/should put a conditional
1883
# in here based on whether the inventory is in the latest format
1884
# - perhaps we should repack all inventories on a repository
1886
# the fast path is to copy the raw xml from the repository. If the
1887
# xml contains 'revision_id="', then we assume the right
1888
# revision_id is set. We must check for this full string, because a
1889
# root node id can legitimately look like 'revision_id' but cannot
1891
xml = self.branch.repository.get_inventory_xml(new_revision)
1892
firstline = xml.split('\n', 1)[0]
1893
if (not 'revision_id="' in firstline or
1894
'format="7"' not in firstline):
1895
inv = self.branch.repository._serializer.read_inventory_from_string(
1897
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1898
self._write_basis_inventory(xml)
1899
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1902
def read_basis_inventory(self):
1903
"""Read the cached basis inventory."""
1904
path = self._basis_inventory_name()
1905
return self._transport.get_bytes(path)
1908
def read_working_inventory(self):
1909
"""Read the working inventory.
1911
:raises errors.InventoryModified: read_working_inventory will fail
1912
when the current in memory inventory has been modified.
1914
# conceptually this should be an implementation detail of the tree.
1915
# XXX: Deprecate this.
1916
# ElementTree does its own conversion from UTF-8, so open in
1918
if self._inventory_is_modified:
1919
raise errors.InventoryModified(self)
1920
f = self._transport.get('inventory')
1922
result = self._deserialize(f)
1925
self._set_inventory(result, dirty=False)
1928
@needs_tree_write_lock
1929
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1931
"""Remove nominated files from the working inventory.
1933
:files: File paths relative to the basedir.
1934
:keep_files: If true, the files will also be kept.
1935
:force: Delete files and directories, even if they are changed and
1936
even if the directories are not empty.
1938
if isinstance(files, basestring):
1944
unknown_nested_files=set()
1946
to_file = sys.stdout
1948
def recurse_directory_to_add_files(directory):
1949
# Recurse directory and add all files
1950
# so we can check if they have changed.
1951
for parent_info, file_infos in\
1952
self.walkdirs(directory):
1953
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1954
# Is it versioned or ignored?
1955
if self.path2id(relpath) or self.is_ignored(relpath):
1956
# Add nested content for deletion.
1957
new_files.add(relpath)
1959
# Files which are not versioned and not ignored
1960
# should be treated as unknown.
1961
unknown_nested_files.add((relpath, None, kind))
1963
for filename in files:
1964
# Get file name into canonical form.
1965
abspath = self.abspath(filename)
1966
filename = self.relpath(abspath)
1967
if len(filename) > 0:
1968
new_files.add(filename)
1969
recurse_directory_to_add_files(filename)
1971
files = list(new_files)
1974
return # nothing to do
1976
# Sort needed to first handle directory content before the directory
1977
files.sort(reverse=True)
1979
# Bail out if we are going to delete files we shouldn't
1980
if not keep_files and not force:
1981
has_changed_files = len(unknown_nested_files) > 0
1982
if not has_changed_files:
1983
for (file_id, path, content_change, versioned, parent_id, name,
1984
kind, executable) in self.iter_changes(self.basis_tree(),
1985
include_unchanged=True, require_versioned=False,
1986
want_unversioned=True, specific_files=files):
1987
if versioned == (False, False):
1988
# The record is unknown ...
1989
if not self.is_ignored(path[1]):
1990
# ... but not ignored
1991
has_changed_files = True
1993
elif content_change and (kind[1] is not None):
1994
# Versioned and changed, but not deleted
1995
has_changed_files = True
1998
if has_changed_files:
1999
# Make delta show ALL applicable changes in error message.
2000
tree_delta = self.changes_from(self.basis_tree(),
2001
require_versioned=False, want_unversioned=True,
2002
specific_files=files)
2003
for unknown_file in unknown_nested_files:
2004
if unknown_file not in tree_delta.unversioned:
2005
tree_delta.unversioned.extend((unknown_file,))
2006
raise errors.BzrRemoveChangedFilesError(tree_delta)
2008
# Build inv_delta and delete files where applicable,
2009
# do this before any modifications to inventory.
2011
fid = self.path2id(f)
2014
message = "%s is not versioned." % (f,)
2017
# having removed it, it must be either ignored or unknown
2018
if self.is_ignored(f):
2022
# XXX: Really should be a more abstract reporter interface
2023
kind_ch = osutils.kind_marker(self.kind(fid))
2024
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2026
inv_delta.append((f, None, fid, None))
2027
message = "removed %s" % (f,)
2030
abs_path = self.abspath(f)
2031
if osutils.lexists(abs_path):
2032
if (osutils.isdir(abs_path) and
2033
len(os.listdir(abs_path)) > 0):
2035
osutils.rmtree(abs_path)
2037
message = "%s is not an empty directory "\
2038
"and won't be deleted." % (f,)
2040
osutils.delete_any(abs_path)
2041
message = "deleted %s" % (f,)
2042
elif message is not None:
2043
# Only care if we haven't done anything yet.
2044
message = "%s does not exist." % (f,)
2046
# Print only one message (if any) per file.
2047
if message is not None:
2049
self.apply_inventory_delta(inv_delta)
2051
@needs_tree_write_lock
2052
def revert(self, filenames=None, old_tree=None, backups=True,
2053
pb=None, report_changes=False):
2054
from bzrlib.conflicts import resolve
2057
symbol_versioning.warn('Using [] to revert all files is deprecated'
2058
' as of bzr 0.91. Please use None (the default) instead.',
2059
DeprecationWarning, stacklevel=2)
2060
if old_tree is None:
2061
basis_tree = self.basis_tree()
2062
basis_tree.lock_read()
2063
old_tree = basis_tree
2067
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2069
if filenames is None and len(self.get_parent_ids()) > 1:
2071
last_revision = self.last_revision()
2072
if last_revision != _mod_revision.NULL_REVISION:
2073
if basis_tree is None:
2074
basis_tree = self.basis_tree()
2075
basis_tree.lock_read()
2076
parent_trees.append((last_revision, basis_tree))
2077
self.set_parent_trees(parent_trees)
2080
resolve(self, filenames, ignore_misses=True, recursive=True)
2082
if basis_tree is not None:
2086
def revision_tree(self, revision_id):
2087
"""See Tree.revision_tree.
2089
WorkingTree can supply revision_trees for the basis revision only
2090
because there is only one cached inventory in the bzr directory.
2092
if revision_id == self.last_revision():
2094
xml = self.read_basis_inventory()
2095
except errors.NoSuchFile:
2099
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2100
# dont use the repository revision_tree api because we want
2101
# to supply the inventory.
2102
if inv.revision_id == revision_id:
2103
return revisiontree.RevisionTree(self.branch.repository,
2105
except errors.BadInventoryFormat:
2107
# raise if there was no inventory, or if we read the wrong inventory.
2108
raise errors.NoSuchRevisionInTree(self, revision_id)
2110
# XXX: This method should be deprecated in favour of taking in a proper
2111
# new Inventory object.
2112
@needs_tree_write_lock
2113
def set_inventory(self, new_inventory_list):
2114
from bzrlib.inventory import (Inventory,
2118
inv = Inventory(self.get_root_id())
2119
for path, file_id, parent, kind in new_inventory_list:
2120
name = os.path.basename(path)
2123
# fixme, there should be a factory function inv,add_??
2124
if kind == 'directory':
2125
inv.add(InventoryDirectory(file_id, name, parent))
2126
elif kind == 'file':
2127
inv.add(InventoryFile(file_id, name, parent))
2128
elif kind == 'symlink':
2129
inv.add(InventoryLink(file_id, name, parent))
2131
raise errors.BzrError("unknown kind %r" % kind)
2132
self._write_inventory(inv)
2134
@needs_tree_write_lock
2135
def set_root_id(self, file_id):
2136
"""Set the root id for this tree."""
2140
'WorkingTree.set_root_id with fileid=None')
2141
file_id = osutils.safe_file_id(file_id)
2142
self._set_root_id(file_id)
2144
def _set_root_id(self, file_id):
2145
"""Set the root id for this tree, in a format specific manner.
2147
:param file_id: The file id to assign to the root. It must not be
2148
present in the current inventory or an error will occur. It must
2149
not be None, but rather a valid file id.
2151
inv = self._inventory
2152
orig_root_id = inv.root.file_id
2153
# TODO: it might be nice to exit early if there was nothing
2154
# to do, saving us from trigger a sync on unlock.
2155
self._inventory_is_modified = True
2156
# we preserve the root inventory entry object, but
2157
# unlinkit from the byid index
2158
del inv._byid[inv.root.file_id]
2159
inv.root.file_id = file_id
2160
# and link it into the index with the new changed id.
2161
inv._byid[inv.root.file_id] = inv.root
2162
# and finally update all children to reference the new id.
2163
# XXX: this should be safe to just look at the root.children
2164
# list, not the WHOLE INVENTORY.
2167
if entry.parent_id == orig_root_id:
2168
entry.parent_id = inv.root.file_id
2171
"""See Branch.unlock.
2173
WorkingTree locking just uses the Branch locking facilities.
2174
This is current because all working trees have an embedded branch
2175
within them. IF in the future, we were to make branch data shareable
2176
between multiple working trees, i.e. via shared storage, then we
2177
would probably want to lock both the local tree, and the branch.
2179
raise NotImplementedError(self.unlock)
2183
def update(self, change_reporter=None, possible_transports=None,
2184
revision=None, old_tip=_marker):
2185
"""Update a working tree along its branch.
2187
This will update the branch if its bound too, which means we have
2188
multiple trees involved:
2190
- The new basis tree of the master.
2191
- The old basis tree of the branch.
2192
- The old basis tree of the working tree.
2193
- The current working tree state.
2195
Pathologically, all three may be different, and non-ancestors of each
2196
other. Conceptually we want to:
2198
- Preserve the wt.basis->wt.state changes
2199
- Transform the wt.basis to the new master basis.
2200
- Apply a merge of the old branch basis to get any 'local' changes from
2202
- Restore the wt.basis->wt.state changes.
2204
There isn't a single operation at the moment to do that, so we:
2205
- Merge current state -> basis tree of the master w.r.t. the old tree
2207
- Do a 'normal' merge of the old branch basis if it is relevant.
2209
:param revision: The target revision to update to. Must be in the
2211
:param old_tip: If branch.update() has already been run, the value it
2212
returned (old tip of the branch or None). _marker is used
2215
if self.branch.get_bound_location() is not None:
2217
update_branch = (old_tip is self._marker)
2219
self.lock_tree_write()
2220
update_branch = False
2223
old_tip = self.branch.update(possible_transports)
2225
if old_tip is self._marker:
2227
return self._update_tree(old_tip, change_reporter, revision)
2231
@needs_tree_write_lock
2232
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2233
"""Update a tree to the master branch.
2235
:param old_tip: if supplied, the previous tip revision the branch,
2236
before it was changed to the master branch's tip.
2238
# here if old_tip is not None, it is the old tip of the branch before
2239
# it was updated from the master branch. This should become a pending
2240
# merge in the working tree to preserve the user existing work. we
2241
# cant set that until we update the working trees last revision to be
2242
# one from the new branch, because it will just get absorbed by the
2243
# parent de-duplication logic.
2245
# We MUST save it even if an error occurs, because otherwise the users
2246
# local work is unreferenced and will appear to have been lost.
2250
last_rev = self.get_parent_ids()[0]
2252
last_rev = _mod_revision.NULL_REVISION
2253
if revision is None:
2254
revision = self.branch.last_revision()
2256
if revision not in self.branch.revision_history():
2257
raise errors.NoSuchRevision(self.branch, revision)
2258
if last_rev != _mod_revision.ensure_null(revision):
2259
# merge tree state up to specified revision.
2260
basis = self.basis_tree()
2263
to_tree = self.branch.repository.revision_tree(revision)
2264
to_root_id = to_tree.get_root_id()
2265
if (basis.inventory.root is None
2266
or basis.inventory.root.file_id != to_root_id):
2267
self.set_root_id(to_root_id)
2269
result += merge.merge_inner(
2274
change_reporter=change_reporter)
2275
self.set_last_revision(revision)
2278
# TODO - dedup parents list with things merged by pull ?
2279
# reuse the tree we've updated to to set the basis:
2280
parent_trees = [(revision, to_tree)]
2281
merges = self.get_parent_ids()[1:]
2282
# Ideally we ask the tree for the trees here, that way the working
2283
# tree can decide whether to give us the entire tree or give us a
2284
# lazy initialised tree. dirstate for instance will have the trees
2285
# in ram already, whereas a last-revision + basis-inventory tree
2286
# will not, but also does not need them when setting parents.
2287
for parent in merges:
2288
parent_trees.append(
2289
(parent, self.branch.repository.revision_tree(parent)))
2290
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2291
parent_trees.append(
2292
(old_tip, self.branch.repository.revision_tree(old_tip)))
2293
self.set_parent_trees(parent_trees)
2294
last_rev = parent_trees[0][0]
2296
# the working tree had the same last-revision as the master
2297
# branch did. We may still have pivot local work from the local
2298
# branch into old_tip:
2299
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2300
self.add_parent_tree_id(old_tip)
2301
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2302
and old_tip != last_rev):
2303
# our last revision was not the prior branch last revision
2304
# and we have converted that last revision to a pending merge.
2305
# base is somewhere between the branch tip now
2306
# and the now pending merge
2308
# Since we just modified the working tree and inventory, flush out
2309
# the current state, before we modify it again.
2310
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2311
# requires it only because TreeTransform directly munges the
2312
# inventory and calls tree._write_inventory(). Ultimately we
2313
# should be able to remove this extra flush.
2315
graph = self.branch.repository.get_graph()
2316
base_rev_id = graph.find_unique_lca(revision, old_tip)
2317
base_tree = self.branch.repository.revision_tree(base_rev_id)
2318
other_tree = self.branch.repository.revision_tree(old_tip)
2319
result += merge.merge_inner(
2324
change_reporter=change_reporter)
2327
def _write_hashcache_if_dirty(self):
2328
"""Write out the hashcache if it is dirty."""
2329
if self._hashcache.needs_write:
2331
self._hashcache.write()
2333
if e.errno not in (errno.EPERM, errno.EACCES):
2335
# TODO: jam 20061219 Should this be a warning? A single line
2336
# warning might be sufficient to let the user know what
2338
mutter('Could not write hashcache for %s\nError: %s',
2339
self._hashcache.cache_file_name(), e)
2341
@needs_tree_write_lock
2342
def _write_inventory(self, inv):
2343
"""Write inventory as the current inventory."""
2344
self._set_inventory(inv, dirty=True)
2347
def set_conflicts(self, arg):
2348
raise errors.UnsupportedOperation(self.set_conflicts, self)
2350
def add_conflicts(self, arg):
2351
raise errors.UnsupportedOperation(self.add_conflicts, self)
2354
def conflicts(self):
2355
conflicts = _mod_conflicts.ConflictList()
2356
for conflicted in self._iter_conflicts():
2359
if file_kind(self.abspath(conflicted)) != "file":
2361
except errors.NoSuchFile:
2364
for suffix in ('.THIS', '.OTHER'):
2366
kind = file_kind(self.abspath(conflicted+suffix))
2369
except errors.NoSuchFile:
2373
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2374
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2376
file_id=self.path2id(conflicted)))
2379
def walkdirs(self, prefix=""):
2380
"""Walk the directories of this tree.
2382
returns a generator which yields items in the form:
2383
((curren_directory_path, fileid),
2384
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2387
This API returns a generator, which is only valid during the current
2388
tree transaction - within a single lock_read or lock_write duration.
2390
If the tree is not locked, it may cause an error to be raised,
2391
depending on the tree implementation.
2393
disk_top = self.abspath(prefix)
2394
if disk_top.endswith('/'):
2395
disk_top = disk_top[:-1]
2396
top_strip_len = len(disk_top) + 1
2397
inventory_iterator = self._walkdirs(prefix)
2398
disk_iterator = osutils.walkdirs(disk_top, prefix)
2400
current_disk = disk_iterator.next()
2401
disk_finished = False
2403
if not (e.errno == errno.ENOENT or
2404
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2407
disk_finished = True
2409
current_inv = inventory_iterator.next()
2410
inv_finished = False
2411
except StopIteration:
2414
while not inv_finished or not disk_finished:
2416
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
cur_disk_dir_content) = current_disk
2419
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2420
cur_disk_dir_content) = ((None, None), None)
2421
if not disk_finished:
2422
# strip out .bzr dirs
2423
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2424
len(cur_disk_dir_content) > 0):
2425
# osutils.walkdirs can be made nicer -
2426
# yield the path-from-prefix rather than the pathjoined
2428
bzrdir_loc = bisect_left(cur_disk_dir_content,
2430
if (bzrdir_loc < len(cur_disk_dir_content)
2431
and self.bzrdir.is_control_filename(
2432
cur_disk_dir_content[bzrdir_loc][0])):
2433
# we dont yield the contents of, or, .bzr itself.
2434
del cur_disk_dir_content[bzrdir_loc]
2436
# everything is unknown
2439
# everything is missing
2442
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2444
# disk is before inventory - unknown
2445
dirblock = [(relpath, basename, kind, stat, None, None) for
2446
relpath, basename, kind, stat, top_path in
2447
cur_disk_dir_content]
2448
yield (cur_disk_dir_relpath, None), dirblock
2450
current_disk = disk_iterator.next()
2451
except StopIteration:
2452
disk_finished = True
2454
# inventory is before disk - missing.
2455
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2456
for relpath, basename, dkind, stat, fileid, kind in
2458
yield (current_inv[0][0], current_inv[0][1]), dirblock
2460
current_inv = inventory_iterator.next()
2461
except StopIteration:
2464
# versioned present directory
2465
# merge the inventory and disk data together
2467
for relpath, subiterator in itertools.groupby(sorted(
2468
current_inv[1] + cur_disk_dir_content,
2469
key=operator.itemgetter(0)), operator.itemgetter(1)):
2470
path_elements = list(subiterator)
2471
if len(path_elements) == 2:
2472
inv_row, disk_row = path_elements
2473
# versioned, present file
2474
dirblock.append((inv_row[0],
2475
inv_row[1], disk_row[2],
2476
disk_row[3], inv_row[4],
2478
elif len(path_elements[0]) == 5:
2480
dirblock.append((path_elements[0][0],
2481
path_elements[0][1], path_elements[0][2],
2482
path_elements[0][3], None, None))
2483
elif len(path_elements[0]) == 6:
2484
# versioned, absent file.
2485
dirblock.append((path_elements[0][0],
2486
path_elements[0][1], 'unknown', None,
2487
path_elements[0][4], path_elements[0][5]))
2489
raise NotImplementedError('unreachable code')
2490
yield current_inv[0], dirblock
2492
current_inv = inventory_iterator.next()
2493
except StopIteration:
2496
current_disk = disk_iterator.next()
2497
except StopIteration:
2498
disk_finished = True
2500
def _walkdirs(self, prefix=""):
2501
"""Walk the directories of this tree.
2503
:prefix: is used as the directrory to start with.
2504
returns a generator which yields items in the form:
2505
((curren_directory_path, fileid),
2506
[(file1_path, file1_name, file1_kind, None, file1_id,
2509
_directory = 'directory'
2510
# get the root in the inventory
2511
inv = self.inventory
2512
top_id = inv.path2id(prefix)
2516
pending = [(prefix, '', _directory, None, top_id, None)]
2519
currentdir = pending.pop()
2520
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2521
top_id = currentdir[4]
2523
relroot = currentdir[0] + '/'
2526
# FIXME: stash the node in pending
2528
if entry.kind == 'directory':
2529
for name, child in entry.sorted_children():
2530
dirblock.append((relroot + name, name, child.kind, None,
2531
child.file_id, child.kind
2533
yield (currentdir[0], entry.file_id), dirblock
2534
# push the user specified dirs from dirblock
2535
for dir in reversed(dirblock):
2536
if dir[2] == _directory:
2539
@needs_tree_write_lock
2540
def auto_resolve(self):
2541
"""Automatically resolve text conflicts according to contents.
2543
Only text conflicts are auto_resolvable. Files with no conflict markers
2544
are considered 'resolved', because bzr always puts conflict markers
2545
into files that have text conflicts. The corresponding .THIS .BASE and
2546
.OTHER files are deleted, as per 'resolve'.
2547
:return: a tuple of ConflictLists: (un_resolved, resolved).
2549
un_resolved = _mod_conflicts.ConflictList()
2550
resolved = _mod_conflicts.ConflictList()
2551
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2552
for conflict in self.conflicts():
2553
if (conflict.typestring != 'text conflict' or
2554
self.kind(conflict.file_id) != 'file'):
2555
un_resolved.append(conflict)
2557
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2559
for line in my_file:
2560
if conflict_re.search(line):
2561
un_resolved.append(conflict)
286
if fnmatch.fnmatchcase(filename, newpat):
2564
resolved.append(conflict)
2567
resolved.remove_files(self)
2568
self.set_conflicts(un_resolved)
2569
return un_resolved, resolved
2572
def _check(self, references):
2573
"""Check the tree for consistency.
2575
:param references: A dict with keys matching the items returned by
2576
self._get_check_refs(), and values from looking those keys up in
2579
tree_basis = self.basis_tree()
2580
tree_basis.lock_read()
2582
repo_basis = references[('trees', self.last_revision())]
2583
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2584
raise errors.BzrCheckError(
2585
"Mismatched basis inventory content.")
2590
def _validate(self):
2591
"""Validate internal structures.
2593
This is meant mostly for the test suite. To give it a chance to detect
2594
corruption after actions have occurred. The default implementation is a
2597
:return: None. An exception should be raised if there is an error.
2601
def _get_rules_searcher(self, default_searcher):
2602
"""See Tree._get_rules_searcher."""
2603
if self._rules_searcher is None:
2604
self._rules_searcher = super(WorkingTree,
2605
self)._get_rules_searcher(default_searcher)
2606
return self._rules_searcher
2608
def get_shelf_manager(self):
2609
"""Return the ShelfManager for this WorkingTree."""
2610
from bzrlib.shelf import ShelfManager
2611
return ShelfManager(self, self._transport)
2614
class WorkingTree2(WorkingTree):
2615
"""This is the Format 2 working tree.
2617
This was the first weave based working tree.
2618
- uses os locks for locking.
2619
- uses the branch last-revision.
2622
def __init__(self, *args, **kwargs):
2623
super(WorkingTree2, self).__init__(*args, **kwargs)
2624
# WorkingTree2 has more of a constraint that self._inventory must
2625
# exist. Because this is an older format, we don't mind the overhead
2626
# caused by the extra computation here.
2628
# Newer WorkingTree's should only have self._inventory set when they
2630
if self._inventory is None:
2631
self.read_working_inventory()
2633
def _get_check_refs(self):
2634
"""Return the references needed to perform a check of this tree."""
2635
return [('trees', self.last_revision())]
2637
def lock_tree_write(self):
2638
"""See WorkingTree.lock_tree_write().
2640
In Format2 WorkingTrees we have a single lock for the branch and tree
2641
so lock_tree_write() degrades to lock_write().
2643
self.branch.lock_write()
2645
return self._control_files.lock_write()
2647
self.branch.unlock()
2651
# do non-implementation specific cleanup
2654
# we share control files:
2655
if self._control_files._lock_count == 3:
2656
# _inventory_is_modified is always False during a read lock.
2657
if self._inventory_is_modified:
2659
self._write_hashcache_if_dirty()
2661
# reverse order of locking.
2663
return self._control_files.unlock()
2665
self.branch.unlock()
2668
class WorkingTree3(WorkingTree):
2669
"""This is the Format 3 working tree.
2671
This differs from the base WorkingTree by:
2672
- having its own file lock
2673
- having its own last-revision property.
2675
This is new in bzr 0.8
2679
def _last_revision(self):
2680
"""See Mutable.last_revision."""
2682
return self._transport.get_bytes('last-revision')
2683
except errors.NoSuchFile:
2684
return _mod_revision.NULL_REVISION
2686
def _change_last_revision(self, revision_id):
2687
"""See WorkingTree._change_last_revision."""
2688
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2690
self._transport.delete('last-revision')
2691
except errors.NoSuchFile:
2695
self._transport.put_bytes('last-revision', revision_id,
2696
mode=self.bzrdir._get_file_mode())
2699
def _get_check_refs(self):
2700
"""Return the references needed to perform a check of this tree."""
2701
return [('trees', self.last_revision())]
2703
@needs_tree_write_lock
2704
def set_conflicts(self, conflicts):
2705
self._put_rio('conflicts', conflicts.to_stanzas(),
2708
@needs_tree_write_lock
2709
def add_conflicts(self, new_conflicts):
2710
conflict_set = set(self.conflicts())
2711
conflict_set.update(set(list(new_conflicts)))
2712
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2713
key=_mod_conflicts.Conflict.sort_key)))
2716
def conflicts(self):
2718
confile = self._transport.get('conflicts')
2719
except errors.NoSuchFile:
2720
return _mod_conflicts.ConflictList()
2723
if confile.next() != CONFLICT_HEADER_1 + '\n':
2724
raise errors.ConflictFormatError()
2725
except StopIteration:
2726
raise errors.ConflictFormatError()
2727
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2732
# do non-implementation specific cleanup
2734
if self._control_files._lock_count == 1:
2735
# _inventory_is_modified is always False during a read lock.
2736
if self._inventory_is_modified:
2738
self._write_hashcache_if_dirty()
2739
# reverse order of locking.
2741
return self._control_files.unlock()
2743
self.branch.unlock()
2746
def get_conflicted_stem(path):
2747
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2748
if path.endswith(suffix):
2749
return path[:-len(suffix)]
2752
class WorkingTreeFormat(object):
2753
"""An encapsulation of the initialization and open routines for a format.
2755
Formats provide three things:
2756
* An initialization routine,
2760
Formats are placed in an dict by their format string for reference
2761
during workingtree opening. Its not required that these be instances, they
2762
can be classes themselves with class methods - it simply depends on
2763
whether state is needed for a given format or not.
2765
Once a format is deprecated, just deprecate the initialize and open
2766
methods on the format class. Do not deprecate the object, as the
2767
object will be created every time regardless.
2770
_default_format = None
2771
"""The default format used for new trees."""
2774
"""The known formats."""
2776
requires_rich_root = False
2778
upgrade_recommended = False
2781
def find_format(klass, a_bzrdir):
2782
"""Return the format for the working tree object in a_bzrdir."""
2784
transport = a_bzrdir.get_workingtree_transport(None)
2785
format_string = transport.get_bytes("format")
2786
return klass._formats[format_string]
2787
except errors.NoSuchFile:
2788
raise errors.NoWorkingTree(base=transport.base)
2790
raise errors.UnknownFormatError(format=format_string,
2791
kind="working tree")
2793
def __eq__(self, other):
2794
return self.__class__ is other.__class__
2796
def __ne__(self, other):
2797
return not (self == other)
2800
def get_default_format(klass):
2801
"""Return the current default format."""
2802
return klass._default_format
2804
def get_format_string(self):
2805
"""Return the ASCII format string that identifies this format."""
2806
raise NotImplementedError(self.get_format_string)
2808
def get_format_description(self):
2809
"""Return the short description for this format."""
2810
raise NotImplementedError(self.get_format_description)
2812
def is_supported(self):
2813
"""Is this format supported?
2815
Supported formats can be initialized and opened.
2816
Unsupported formats may not support initialization or committing or
2817
some other features depending on the reason for not being supported.
2821
def supports_content_filtering(self):
2822
"""True if this format supports content filtering."""
2825
def supports_views(self):
2826
"""True if this format supports stored views."""
2830
def register_format(klass, format):
2831
klass._formats[format.get_format_string()] = format
2834
def set_default_format(klass, format):
2835
klass._default_format = format
2838
def unregister_format(klass, format):
2839
del klass._formats[format.get_format_string()]
2842
class WorkingTreeFormat2(WorkingTreeFormat):
2843
"""The second working tree format.
2845
This format modified the hash cache from the format 1 hash cache.
2848
upgrade_recommended = True
2850
def get_format_description(self):
2851
"""See WorkingTreeFormat.get_format_description()."""
2852
return "Working tree format 2"
2854
def _stub_initialize_on_transport(self, transport, file_mode):
2855
"""Workaround: create control files for a remote working tree.
2857
This ensures that it can later be updated and dealt with locally,
2858
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2859
no working tree. (See bug #43064).
2862
inv = inventory.Inventory()
2863
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2865
transport.put_file('inventory', sio, file_mode)
2866
transport.put_bytes('pending-merges', '', file_mode)
2868
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2869
accelerator_tree=None, hardlink=False):
2870
"""See WorkingTreeFormat.initialize()."""
2871
if not isinstance(a_bzrdir.transport, LocalTransport):
2872
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2873
if from_branch is not None:
2874
branch = from_branch
2876
branch = a_bzrdir.open_branch()
2877
if revision_id is None:
2878
revision_id = _mod_revision.ensure_null(branch.last_revision())
2881
branch.generate_revision_history(revision_id)
2884
inv = inventory.Inventory()
2885
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2891
basis_tree = branch.repository.revision_tree(revision_id)
2892
if basis_tree.inventory.root is not None:
2893
wt.set_root_id(basis_tree.get_root_id())
2894
# set the parent list and cache the basis tree.
2895
if _mod_revision.is_null(revision_id):
2898
parent_trees = [(revision_id, basis_tree)]
2899
wt.set_parent_trees(parent_trees)
2900
transform.build_tree(basis_tree, wt)
2904
super(WorkingTreeFormat2, self).__init__()
2905
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2907
def open(self, a_bzrdir, _found=False):
2908
"""Return the WorkingTree object for a_bzrdir
2910
_found is a private parameter, do not use it. It is used to indicate
2911
if format probing has already been done.
2914
# we are being called directly and must probe.
2915
raise NotImplementedError
2916
if not isinstance(a_bzrdir.transport, LocalTransport):
2917
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2918
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2924
class WorkingTreeFormat3(WorkingTreeFormat):
2925
"""The second working tree format updated to record a format marker.
2928
- exists within a metadir controlling .bzr
2929
- includes an explicit version marker for the workingtree control
2930
files, separate from the BzrDir format
2931
- modifies the hash cache format
2933
- uses a LockDir to guard access for writes.
2936
upgrade_recommended = True
2938
def get_format_string(self):
2939
"""See WorkingTreeFormat.get_format_string()."""
2940
return "Bazaar-NG Working Tree format 3"
2942
def get_format_description(self):
2943
"""See WorkingTreeFormat.get_format_description()."""
2944
return "Working tree format 3"
2946
_lock_file_name = 'lock'
2947
_lock_class = LockDir
2949
_tree_class = WorkingTree3
2951
def __get_matchingbzrdir(self):
2952
return bzrdir.BzrDirMetaFormat1()
2954
_matchingbzrdir = property(__get_matchingbzrdir)
2956
def _open_control_files(self, a_bzrdir):
2957
transport = a_bzrdir.get_workingtree_transport(None)
2958
return LockableFiles(transport, self._lock_file_name,
2961
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2962
accelerator_tree=None, hardlink=False):
2963
"""See WorkingTreeFormat.initialize().
2965
:param revision_id: if supplied, create a working tree at a different
2966
revision than the branch is at.
2967
:param accelerator_tree: A tree which can be used for retrieving file
2968
contents more quickly than the revision tree, i.e. a workingtree.
2969
The revision tree will be used for cases where accelerator_tree's
2970
content is different.
2971
:param hardlink: If true, hard-link files from accelerator_tree,
2974
if not isinstance(a_bzrdir.transport, LocalTransport):
2975
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2976
transport = a_bzrdir.get_workingtree_transport(self)
2977
control_files = self._open_control_files(a_bzrdir)
2978
control_files.create_lock()
2979
control_files.lock_write()
2980
transport.put_bytes('format', self.get_format_string(),
2981
mode=a_bzrdir._get_file_mode())
2982
if from_branch is not None:
2983
branch = from_branch
2985
branch = a_bzrdir.open_branch()
2986
if revision_id is None:
2987
revision_id = _mod_revision.ensure_null(branch.last_revision())
2988
# WorkingTree3 can handle an inventory which has a unique root id.
2989
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2990
# those trees. And because there isn't a format bump inbetween, we
2991
# are maintaining compatibility with older clients.
2992
# inv = Inventory(root_id=gen_root_id())
2993
inv = self._initial_inventory()
2994
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3000
_control_files=control_files)
3001
wt.lock_tree_write()
3003
basis_tree = branch.repository.revision_tree(revision_id)
3004
# only set an explicit root id if there is one to set.
3005
if basis_tree.inventory.root is not None:
3006
wt.set_root_id(basis_tree.get_root_id())
3007
if revision_id == _mod_revision.NULL_REVISION:
3008
wt.set_parent_trees([])
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
b'\\ No newline at end of file'
3010
wt.set_parent_trees([(revision_id, basis_tree)])
3011
transform.build_tree(basis_tree, wt)
3013
# Unlock in this order so that the unlock-triggers-flush in
3014
# WorkingTree is given a chance to fire.
3015
control_files.unlock()
3019
def _initial_inventory(self):
3020
return inventory.Inventory()
3023
super(WorkingTreeFormat3, self).__init__()
3025
def open(self, a_bzrdir, _found=False):
3026
"""Return the WorkingTree object for a_bzrdir
3028
_found is a private parameter, do not use it. It is used to indicate
3029
if format probing has already been done.
3032
# we are being called directly and must probe.
3033
raise NotImplementedError
3034
if not isinstance(a_bzrdir.transport, LocalTransport):
3035
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3036
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3039
def _open(self, a_bzrdir, control_files):
3040
"""Open the tree itself.
3042
:param a_bzrdir: the dir for the tree.
3043
:param control_files: the control files for the tree.
3045
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3049
_control_files=control_files)
3052
return self.get_format_string()
3055
__default_format = WorkingTreeFormat6()
3056
WorkingTreeFormat.register_format(__default_format)
3057
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3058
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3059
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3060
WorkingTreeFormat.set_default_format(__default_format)
3061
# formats which have no format string are not discoverable
3062
# and not independently creatable, so are not registered.
3063
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
