168
388
inv = self._inventory
169
389
for path, ie in inv.iter_entries():
170
if bzrlib.osutils.lexists(self.abspath(path)):
390
if osutils.lexists(self.abspath(path)):
393
def all_file_ids(self):
394
"""See Tree.iter_all_file_ids"""
395
return set(self.inventory)
174
397
def __repr__(self):
175
398
return "<%s of %s>" % (self.__class__.__name__,
176
399
getattr(self, 'basedir', None))
180
401
def abspath(self, filename):
181
return os.path.join(self.basedir, filename)
183
def relpath(self, abspath):
184
"""Return the local path portion from a given absolute path."""
185
return relpath(self.basedir, abspath)
402
return pathjoin(self.basedir, filename)
404
def basis_tree(self):
405
"""Return RevisionTree for the current last revision.
407
If the left most parent is a ghost then the returned tree will be an
408
empty tree - one obtained by calling
409
repository.revision_tree(NULL_REVISION).
412
revision_id = self.get_parent_ids()[0]
414
# no parents, return an empty revision tree.
415
# in the future this should return the tree for
416
# 'empty:' - the implicit root empty tree.
417
return self.branch.repository.revision_tree(
418
_mod_revision.NULL_REVISION)
420
return self.revision_tree(revision_id)
421
except errors.NoSuchRevision:
423
# No cached copy available, retrieve from the repository.
424
# FIXME? RBC 20060403 should we cache the inventory locally
427
return self.branch.repository.revision_tree(revision_id)
428
except (errors.RevisionNotPresent, errors.NoSuchRevision):
429
# the basis tree *may* be a ghost or a low level error may have
430
# occurred. If the revision is present, its a problem, if its not
432
if self.branch.repository.has_revision(revision_id):
434
# the basis tree is a ghost so return an empty tree.
435
return self.branch.repository.revision_tree(
436
_mod_revision.NULL_REVISION)
439
self._flush_ignore_list_cache()
441
def relpath(self, path):
442
"""Return the local path portion from a given path.
444
The path may be absolute or relative. If its a relative path it is
445
interpreted relative to the python current working directory.
447
return osutils.relpath(self.basedir, path)
187
449
def has_filename(self, filename):
188
return bzrlib.osutils.lexists(self.abspath(filename))
190
def get_file(self, file_id):
191
return self.get_file_byname(self.id2path(file_id))
193
def get_file_byname(self, filename):
194
return file(self.abspath(filename), 'rb')
450
return osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id, path=None, filtered=True):
453
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
455
def get_file_with_stat(self, file_id, path=None, filtered=True,
457
"""See Tree.get_file_with_stat."""
459
path = self.id2path(file_id)
460
file_obj = self.get_file_byname(path, filtered=False)
461
stat_value = _fstat(file_obj.fileno())
462
if filtered and self.supports_content_filtering():
463
filters = self._content_filter_stack(path)
464
file_obj = filtered_input_file(file_obj, filters)
465
return (file_obj, stat_value)
467
def get_file_text(self, file_id, path=None, filtered=True):
468
my_file = self.get_file(file_id, path=path, filtered=filtered)
470
return my_file.read()
474
def get_file_byname(self, filename, filtered=True):
475
path = self.abspath(filename)
477
if filtered and self.supports_content_filtering():
478
filters = self._content_filter_stack(filename)
479
return filtered_input_file(f, filters)
483
def get_file_lines(self, file_id, path=None, filtered=True):
484
"""See Tree.get_file_lines()"""
485
file = self.get_file(file_id, path, filtered=filtered)
487
return file.readlines()
492
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
"""See Tree.annotate_iter
495
This implementation will use the basis tree implementation if possible.
496
Lines not in the basis are attributed to CURRENT_REVISION
498
If there are pending merges, lines added by those merges will be
499
incorrectly attributed to CURRENT_REVISION (but after committing, the
500
attribution will be correct).
502
maybe_file_parent_keys = []
503
for parent_id in self.get_parent_ids():
505
parent_tree = self.revision_tree(parent_id)
506
except errors.NoSuchRevisionInTree:
507
parent_tree = self.branch.repository.revision_tree(parent_id)
508
parent_tree.lock_read()
510
if file_id not in parent_tree:
512
ie = parent_tree.inventory[file_id]
513
if ie.kind != 'file':
514
# Note: this is slightly unnecessary, because symlinks and
515
# directories have a "text" which is the empty text, and we
516
# know that won't mess up annotations. But it seems cleaner
518
parent_text_key = (file_id, ie.revision)
519
if parent_text_key not in maybe_file_parent_keys:
520
maybe_file_parent_keys.append(parent_text_key)
523
graph = _mod_graph.Graph(self.branch.repository.texts)
524
heads = graph.heads(maybe_file_parent_keys)
525
file_parent_keys = []
526
for key in maybe_file_parent_keys:
528
file_parent_keys.append(key)
530
# Now we have the parents of this content
531
annotator = self.branch.repository.texts.get_annotator()
532
text = self.get_file_text(file_id)
533
this_key =(file_id, default_revision)
534
annotator.add_special_text(this_key, file_parent_keys, text)
535
annotations = [(key[-1], line)
536
for key, line in annotator.annotate_flat(this_key)]
539
def _get_ancestors(self, default_revision):
540
ancestors = set([default_revision])
541
for parent_id in self.get_parent_ids():
542
ancestors.update(self.branch.repository.get_ancestry(
543
parent_id, topo_sorted=False))
546
def get_parent_ids(self):
547
"""See Tree.get_parent_ids.
549
This implementation reads the pending merges list and last_revision
550
value and uses that to decide what the parents list should be.
552
last_rev = _mod_revision.ensure_null(self._last_revision())
553
if _mod_revision.NULL_REVISION == last_rev:
558
merges_bytes = self._transport.get_bytes('pending-merges')
559
except errors.NoSuchFile:
562
for l in osutils.split_lines(merges_bytes):
563
revision_id = l.rstrip('\n')
564
parents.append(revision_id)
196
568
def get_root_id(self):
197
569
"""Return the id of this trees root"""
198
inv = self.read_working_inventory()
199
return inv.root.file_id
570
return self._inventory.root.file_id
201
572
def _get_store_filename(self, file_id):
202
## XXX: badly named; this isn't in the store at all
573
## XXX: badly named; this is not in the store at all
203
574
return self.abspath(self.id2path(file_id))
206
def commit(self, *args, **kw):
207
from bzrlib.commit import Commit
208
Commit().commit(self.branch, *args, **kw)
209
self._inventory = self.read_working_inventory()
577
def clone(self, to_bzrdir, revision_id=None):
578
"""Duplicate this working tree into to_bzr, including all state.
580
Specifically modified files are kept as modified, but
581
ignored and unknown files are discarded.
583
If you want to make a new line of development, see bzrdir.sprout()
586
If not None, the cloned tree will have its last revision set to
587
revision, and difference between the source trees last revision
588
and this one merged in.
590
# assumes the target bzr dir format is compatible.
591
result = to_bzrdir.create_workingtree()
592
self.copy_content_into(result, revision_id)
596
def copy_content_into(self, tree, revision_id=None):
597
"""Copy the current content and user files of this tree into tree."""
598
tree.set_root_id(self.get_root_id())
599
if revision_id is None:
600
merge.transform_tree(tree, self)
602
# TODO now merge from tree.last_revision to revision (to preserve
603
# user local changes)
604
merge.transform_tree(tree, self)
605
tree.set_parent_ids([revision_id])
211
607
def id2abspath(self, file_id):
212
608
return self.abspath(self.id2path(file_id))
215
610
def has_id(self, file_id):
216
611
# files that have been deleted are excluded
217
inv = self._inventory
218
613
if not inv.has_id(file_id):
220
615
path = inv.id2path(file_id)
221
return bzrlib.osutils.lexists(self.abspath(path))
616
return osutils.lexists(self.abspath(path))
223
618
def has_or_had_id(self, file_id):
224
619
if file_id == self.inventory.root.file_id:
226
621
return self.inventory.has_id(file_id)
228
623
__contains__ = has_id
231
625
def get_file_size(self, file_id):
232
return os.path.getsize(self.id2abspath(file_id))
234
def get_file_sha1(self, file_id):
235
path = self._inventory.id2path(file_id)
236
return self._hashcache.get_sha1(path)
239
def is_executable(self, file_id):
626
"""See Tree.get_file_size"""
627
# XXX: this returns the on-disk size; it should probably return the
630
return os.path.getsize(self.id2abspath(file_id))
632
if e.errno != errno.ENOENT:
638
def get_file_sha1(self, file_id, path=None, stat_value=None):
640
path = self._inventory.id2path(file_id)
641
return self._hashcache.get_sha1(path, stat_value)
643
def get_file_mtime(self, file_id, path=None):
645
path = self.inventory.id2path(file_id)
646
return os.lstat(self.abspath(path)).st_mtime
648
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
649
file_id = self.path2id(path)
651
# For unversioned files on win32, we just assume they are not
654
return self._inventory[file_id].executable
656
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
657
mode = stat_result.st_mode
658
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
660
if not supports_executable():
661
def is_executable(self, file_id, path=None):
241
662
return self._inventory[file_id].executable
243
path = self._inventory.id2path(file_id)
664
_is_executable_from_path_and_stat = \
665
_is_executable_from_path_and_stat_from_basis
667
def is_executable(self, file_id, path=None):
669
path = self.id2path(file_id)
244
670
mode = os.lstat(self.abspath(path)).st_mode
245
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
671
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
673
_is_executable_from_path_and_stat = \
674
_is_executable_from_path_and_stat_from_stat
676
@needs_tree_write_lock
677
def _add(self, files, ids, kinds):
678
"""See MutableTree._add."""
679
# TODO: Re-adding a file that is removed in the working copy
680
# should probably put it back with the previous ID.
681
# the read and write working inventory should not occur in this
682
# function - they should be part of lock_write and unlock.
684
for f, file_id, kind in zip(files, ids, kinds):
686
inv.add_path(f, kind=kind)
688
inv.add_path(f, kind=kind, file_id=file_id)
689
self._inventory_is_modified = True
691
@needs_tree_write_lock
692
def _gather_kinds(self, files, kinds):
693
"""See MutableTree._gather_kinds."""
694
for pos, f in enumerate(files):
695
if kinds[pos] is None:
696
fullpath = normpath(self.abspath(f))
698
kinds[pos] = file_kind(fullpath)
700
if e.errno == errno.ENOENT:
701
raise errors.NoSuchFile(fullpath)
247
703
@needs_write_lock
704
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
705
"""Add revision_id as a parent.
707
This is equivalent to retrieving the current list of parent ids
708
and setting the list to its value plus revision_id.
710
:param revision_id: The revision id to add to the parent list. It may
711
be a ghost revision as long as its not the first parent to be added,
712
or the allow_leftmost_as_ghost parameter is set True.
713
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
715
parents = self.get_parent_ids() + [revision_id]
716
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
717
or allow_leftmost_as_ghost)
719
@needs_tree_write_lock
720
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
721
"""Add revision_id, tree tuple as a parent.
723
This is equivalent to retrieving the current list of parent trees
724
and setting the list to its value plus parent_tuple. See also
725
add_parent_tree_id - if you only have a parent id available it will be
726
simpler to use that api. If you have the parent already available, using
727
this api is preferred.
729
:param parent_tuple: The (revision id, tree) to add to the parent list.
730
If the revision_id is a ghost, pass None for the tree.
731
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
733
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
734
if len(parent_ids) > 1:
735
# the leftmost may have already been a ghost, preserve that if it
737
allow_leftmost_as_ghost = True
738
self.set_parent_ids(parent_ids,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
741
@needs_tree_write_lock
248
742
def add_pending_merge(self, *revision_ids):
249
743
# TODO: Perhaps should check at this point that the
250
744
# history of the revision is actually present?
251
p = self.pending_merges()
745
parents = self.get_parent_ids()
253
747
for rev_id in revision_ids:
748
if rev_id in parents:
750
parents.append(rev_id)
259
self.set_pending_merges(p)
261
def pending_merges(self):
262
"""Return a list of pending merges.
264
These are revisions that have been merged into the working
265
directory but not yet committed.
267
cfn = self.branch._rel_controlfilename('pending-merges')
268
if not self.branch._transport.has(cfn):
271
for l in self.branch.controlfile('pending-merges', 'r').readlines():
272
p.append(l.rstrip('\n'))
753
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
755
def path_content_summary(self, path, _lstat=os.lstat,
756
_mapper=osutils.file_kind_from_stat_mode):
757
"""See Tree.path_content_summary."""
758
abspath = self.abspath(path)
760
stat_result = _lstat(abspath)
762
if getattr(e, 'errno', None) == errno.ENOENT:
764
return ('missing', None, None, None)
765
# propagate other errors
767
kind = _mapper(stat_result.st_mode)
769
return self._file_content_summary(path, stat_result)
770
elif kind == 'directory':
771
# perhaps it looks like a plain directory, but it's really a
773
if self._directory_is_tree_reference(path):
774
kind = 'tree-reference'
775
return kind, None, None, None
776
elif kind == 'symlink':
777
target = osutils.readlink(abspath)
778
return ('symlink', None, None, target)
780
return (kind, None, None, None)
782
def _file_content_summary(self, path, stat_result):
783
size = stat_result.st_size
784
executable = self._is_executable_from_path_and_stat(path, stat_result)
785
# try for a stat cache lookup
786
return ('file', size, executable, self._sha_from_stat(
789
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
790
"""Common ghost checking functionality from set_parent_*.
792
This checks that the left hand-parent exists if there are any
795
if len(revision_ids) > 0:
796
leftmost_id = revision_ids[0]
797
if (not allow_leftmost_as_ghost and not
798
self.branch.repository.has_revision(leftmost_id)):
799
raise errors.GhostRevisionUnusableHere(leftmost_id)
801
def _set_merges_from_parent_ids(self, parent_ids):
802
merges = parent_ids[1:]
803
self._transport.put_bytes('pending-merges', '\n'.join(merges),
804
mode=self.bzrdir._get_file_mode())
806
def _filter_parent_ids_by_ancestry(self, revision_ids):
807
"""Check that all merged revisions are proper 'heads'.
809
This will always return the first revision_id, and any merged revisions
812
if len(revision_ids) == 0:
814
graph = self.branch.repository.get_graph()
815
heads = graph.heads(revision_ids)
816
new_revision_ids = revision_ids[:1]
817
for revision_id in revision_ids[1:]:
818
if revision_id in heads and revision_id not in new_revision_ids:
819
new_revision_ids.append(revision_id)
820
if new_revision_ids != revision_ids:
821
trace.mutter('requested to set revision_ids = %s,'
822
' but filtered to %s', revision_ids, new_revision_ids)
823
return new_revision_ids
825
@needs_tree_write_lock
826
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
827
"""Set the parent ids to revision_ids.
829
See also set_parent_trees. This api will try to retrieve the tree data
830
for each element of revision_ids from the trees repository. If you have
831
tree data already available, it is more efficient to use
832
set_parent_trees rather than set_parent_ids. set_parent_ids is however
833
an easier API to use.
835
:param revision_ids: The revision_ids to set as the parent ids of this
836
working tree. Any of these may be ghosts.
838
self._check_parents_for_ghosts(revision_ids,
839
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
840
for revision_id in revision_ids:
841
_mod_revision.check_not_reserved_id(revision_id)
843
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
845
if len(revision_ids) > 0:
846
self.set_last_revision(revision_ids[0])
848
self.set_last_revision(_mod_revision.NULL_REVISION)
850
self._set_merges_from_parent_ids(revision_ids)
852
@needs_tree_write_lock
853
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
854
"""See MutableTree.set_parent_trees."""
855
parent_ids = [rev for (rev, tree) in parents_list]
856
for revision_id in parent_ids:
857
_mod_revision.check_not_reserved_id(revision_id)
859
self._check_parents_for_ghosts(parent_ids,
860
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
862
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
864
if len(parent_ids) == 0:
865
leftmost_parent_id = _mod_revision.NULL_REVISION
866
leftmost_parent_tree = None
868
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
870
if self._change_last_revision(leftmost_parent_id):
871
if leftmost_parent_tree is None:
872
# If we don't have a tree, fall back to reading the
873
# parent tree from the repository.
874
self._cache_basis_inventory(leftmost_parent_id)
876
inv = leftmost_parent_tree.inventory
877
xml = self._create_basis_xml_from_inventory(
878
leftmost_parent_id, inv)
879
self._write_basis_inventory(xml)
880
self._set_merges_from_parent_ids(parent_ids)
882
@needs_tree_write_lock
276
883
def set_pending_merges(self, rev_list):
277
self.branch.put_controlfile('pending-merges', '\n'.join(rev_list))
884
parents = self.get_parent_ids()
885
leftmost = parents[:1]
886
new_parents = leftmost + rev_list
887
self.set_parent_ids(new_parents)
889
@needs_tree_write_lock
890
def set_merge_modified(self, modified_hashes):
892
for file_id, hash in modified_hashes.iteritems():
893
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
894
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
896
def _sha_from_stat(self, path, stat_result):
897
"""Get a sha digest from the tree's stat cache.
899
The default implementation assumes no stat cache is present.
901
:param path: The path.
902
:param stat_result: The stat result being looked up.
906
def _put_rio(self, filename, stanzas, header):
907
self._must_be_locked()
908
my_file = rio_file(stanzas, header)
909
self._transport.put_file(filename, my_file,
910
mode=self.bzrdir._get_file_mode())
912
@needs_write_lock # because merge pulls data into the branch.
913
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
914
merge_type=None, force=False):
915
"""Merge from a branch into this working tree.
917
:param branch: The branch to merge from.
918
:param to_revision: If non-None, the merge will merge to to_revision,
919
but not beyond it. to_revision does not need to be in the history
920
of the branch when it is supplied. If None, to_revision defaults to
921
branch.last_revision().
923
from bzrlib.merge import Merger, Merge3Merger
924
merger = Merger(self.branch, this_tree=self)
925
# check that there are no local alterations
926
if not force and self.has_changes():
927
raise errors.UncommittedChanges(self)
928
if to_revision is None:
929
to_revision = _mod_revision.ensure_null(branch.last_revision())
930
merger.other_rev_id = to_revision
931
if _mod_revision.is_null(merger.other_rev_id):
932
raise errors.NoCommits(branch)
933
self.branch.fetch(branch, last_revision=merger.other_rev_id)
934
merger.other_basis = merger.other_rev_id
935
merger.other_tree = self.branch.repository.revision_tree(
937
merger.other_branch = branch
938
if from_revision is None:
941
merger.set_base_revision(from_revision, branch)
942
if merger.base_rev_id == merger.other_rev_id:
943
raise errors.PointlessMerge
944
merger.backup_files = False
945
if merge_type is None:
946
merger.merge_type = Merge3Merger
948
merger.merge_type = merge_type
949
merger.set_interesting_files(None)
950
merger.show_base = False
951
merger.reprocess = False
952
conflicts = merger.do_merge()
957
def merge_modified(self):
958
"""Return a dictionary of files modified by a merge.
960
The list is initialized by WorkingTree.set_merge_modified, which is
961
typically called after we make some automatic updates to the tree
964
This returns a map of file_id->sha1, containing only files which are
965
still in the working inventory and have that text hash.
968
hashfile = self._transport.get('merge-hashes')
969
except errors.NoSuchFile:
974
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
975
raise errors.MergeModifiedFormatError()
976
except StopIteration:
977
raise errors.MergeModifiedFormatError()
978
for s in RioReader(hashfile):
979
# RioReader reads in Unicode, so convert file_ids back to utf8
980
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
981
if file_id not in self.inventory:
983
text_hash = s.get("hash")
984
if text_hash == self.get_file_sha1(file_id):
985
merge_hashes[file_id] = text_hash
991
def mkdir(self, path, file_id=None):
992
"""See MutableTree.mkdir()."""
994
file_id = generate_ids.gen_file_id(os.path.basename(path))
995
os.mkdir(self.abspath(path))
996
self.add(path, file_id, 'directory')
279
999
def get_symlink_target(self, file_id):
280
return os.readlink(self.id2abspath(file_id))
282
def file_class(self, filename):
283
if self.path2id(filename):
285
elif self.is_ignored(filename):
291
def list_files(self):
292
"""Recursively list all files as (path, class, kind, id).
1000
abspath = self.id2abspath(file_id)
1001
target = osutils.readlink(abspath)
1005
def subsume(self, other_tree):
1006
def add_children(inventory, entry):
1007
for child_entry in entry.children.values():
1008
inventory._byid[child_entry.file_id] = child_entry
1009
if child_entry.kind == 'directory':
1010
add_children(inventory, child_entry)
1011
if other_tree.get_root_id() == self.get_root_id():
1012
raise errors.BadSubsumeSource(self, other_tree,
1013
'Trees have the same root')
1015
other_tree_path = self.relpath(other_tree.basedir)
1016
except errors.PathNotChild:
1017
raise errors.BadSubsumeSource(self, other_tree,
1018
'Tree is not contained by the other')
1019
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1020
if new_root_parent is None:
1021
raise errors.BadSubsumeSource(self, other_tree,
1022
'Parent directory is not versioned.')
1023
# We need to ensure that the result of a fetch will have a
1024
# versionedfile for the other_tree root, and only fetching into
1025
# RepositoryKnit2 guarantees that.
1026
if not self.branch.repository.supports_rich_root():
1027
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1028
other_tree.lock_tree_write()
1030
new_parents = other_tree.get_parent_ids()
1031
other_root = other_tree.inventory.root
1032
other_root.parent_id = new_root_parent
1033
other_root.name = osutils.basename(other_tree_path)
1034
self.inventory.add(other_root)
1035
add_children(self.inventory, other_root)
1036
self._write_inventory(self.inventory)
1037
# normally we don't want to fetch whole repositories, but i think
1038
# here we really do want to consolidate the whole thing.
1039
for parent_id in other_tree.get_parent_ids():
1040
self.branch.fetch(other_tree.branch, parent_id)
1041
self.add_parent_tree_id(parent_id)
1044
other_tree.bzrdir.retire_bzrdir()
1046
def _setup_directory_is_tree_reference(self):
1047
if self._branch.repository._format.supports_tree_reference:
1048
self._directory_is_tree_reference = \
1049
self._directory_may_be_tree_reference
1051
self._directory_is_tree_reference = \
1052
self._directory_is_never_tree_reference
1054
def _directory_is_never_tree_reference(self, relpath):
1057
def _directory_may_be_tree_reference(self, relpath):
1058
# as a special case, if a directory contains control files then
1059
# it's a tree reference, except that the root of the tree is not
1060
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1061
# TODO: We could ask all the control formats whether they
1062
# recognize this directory, but at the moment there's no cheap api
1063
# to do that. Since we probably can only nest bzr checkouts and
1064
# they always use this name it's ok for now. -- mbp 20060306
1066
# FIXME: There is an unhandled case here of a subdirectory
1067
# containing .bzr but not a branch; that will probably blow up
1068
# when you try to commit it. It might happen if there is a
1069
# checkout in a subdirectory. This can be avoided by not adding
1072
@needs_tree_write_lock
1073
def extract(self, file_id, format=None):
1074
"""Extract a subtree from this tree.
1076
A new branch will be created, relative to the path for this tree.
1080
segments = osutils.splitpath(path)
1081
transport = self.branch.bzrdir.root_transport
1082
for name in segments:
1083
transport = transport.clone(name)
1084
transport.ensure_base()
1087
sub_path = self.id2path(file_id)
1088
branch_transport = mkdirs(sub_path)
1090
format = self.bzrdir.cloning_metadir()
1091
branch_transport.ensure_base()
1092
branch_bzrdir = format.initialize_on_transport(branch_transport)
1094
repo = branch_bzrdir.find_repository()
1095
except errors.NoRepositoryPresent:
1096
repo = branch_bzrdir.create_repository()
1097
if not repo.supports_rich_root():
1098
raise errors.RootNotRich()
1099
new_branch = branch_bzrdir.create_branch()
1100
new_branch.pull(self.branch)
1101
for parent_id in self.get_parent_ids():
1102
new_branch.fetch(self.branch, parent_id)
1103
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1104
if tree_transport.base != branch_transport.base:
1105
tree_bzrdir = format.initialize_on_transport(tree_transport)
1106
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1107
target_branch=new_branch)
1109
tree_bzrdir = branch_bzrdir
1110
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1111
wt.set_parent_ids(self.get_parent_ids())
1112
my_inv = self.inventory
1113
child_inv = inventory.Inventory(root_id=None)
1114
new_root = my_inv[file_id]
1115
my_inv.remove_recursive_id(file_id)
1116
new_root.parent_id = None
1117
child_inv.add(new_root)
1118
self._write_inventory(my_inv)
1119
wt._write_inventory(child_inv)
1122
def _serialize(self, inventory, out_file):
1123
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1126
def _deserialize(selt, in_file):
1127
return xml5.serializer_v5.read_inventory(in_file)
1130
"""Write the in memory inventory to disk."""
1131
# TODO: Maybe this should only write on dirty ?
1132
if self._control_files._lock_mode != 'w':
1133
raise errors.NotWriteLocked(self)
1135
self._serialize(self._inventory, sio)
1137
self._transport.put_file('inventory', sio,
1138
mode=self.bzrdir._get_file_mode())
1139
self._inventory_is_modified = False
1141
def _kind(self, relpath):
1142
return osutils.file_kind(self.abspath(relpath))
1144
def list_files(self, include_root=False, from_dir=None, recursive=True):
1145
"""List all files as (path, class, kind, id, entry).
294
1147
Lists, but does not descend into unversioned directories.
296
1148
This does not include files that have been deleted in this
1149
tree. Skips the control directory.
299
Skips the control directory.
1151
:param include_root: if True, return an entry for the root
1152
:param from_dir: start from this directory or None for the root
1153
:param recursive: whether to recurse into subdirectories or not
301
inv = self._inventory
303
def descend(from_dir_relpath, from_dir_id, dp):
1155
# list_files is an iterator, so @needs_read_lock doesn't work properly
1156
# with it. So callers should be careful to always read_lock the tree.
1157
if not self.is_locked():
1158
raise errors.ObjectNotLocked(self)
1160
inv = self.inventory
1161
if from_dir is None and include_root is True:
1162
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1163
# Convert these into local objects to save lookup times
1164
pathjoin = osutils.pathjoin
1165
file_kind = self._kind
1167
# transport.base ends in a slash, we want the piece
1168
# between the last two slashes
1169
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1171
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1173
# directory file_id, relative path, absolute path, reverse sorted children
1174
if from_dir is not None:
1175
from_dir_id = inv.path2id(from_dir)
1176
if from_dir_id is None:
1177
# Directory not versioned
1179
from_dir_abspath = pathjoin(self.basedir, from_dir)
1181
from_dir_id = inv.root.file_id
1182
from_dir_abspath = self.basedir
1183
children = os.listdir(from_dir_abspath)
1185
# jam 20060527 The kernel sized tree seems equivalent whether we
1186
# use a deque and popleft to keep them sorted, or if we use a plain
1187
# list and just reverse() them.
1188
children = collections.deque(children)
1189
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1191
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1194
f = children.popleft()
307
1195
## TODO: If we find a subdirectory with its own .bzr
308
1196
## directory, then that is a separate tree and we
309
1197
## should exclude it.
310
if bzrlib.BZRDIR == f:
1199
# the bzrdir for this tree
1200
if transport_base_dir == f:
314
fp = appendpath(from_dir_relpath, f)
1203
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1204
# and 'f' doesn't begin with one, we can do a string op, rather
1205
# than the checks of pathjoin(), all relative paths will have an extra slash
1207
fp = from_dir_relpath + '/' + f
317
fap = appendpath(dp, f)
1210
fap = from_dir_abspath + '/' + f
319
1212
f_ie = inv.get_child(from_dir_id, f)
322
elif self.is_ignored(fp):
1215
elif self.is_ignored(fp[1:]):
1218
# we may not have found this file, because of a unicode issue
1219
f_norm, can_access = osutils.normalized_filename(f)
1220
if f == f_norm or not can_access:
1221
# No change, so treat this file normally
1224
# this file can be accessed by a normalized path
1225
# check again if it is versioned
1226
# these lines are repeated here for performance
1228
fp = from_dir_relpath + '/' + f
1229
fap = from_dir_abspath + '/' + f
1230
f_ie = inv.get_child(from_dir_id, f)
1233
elif self.is_ignored(fp[1:]):
327
1238
fk = file_kind(fap)
331
raise BzrCheckError("file %r entered as kind %r id %r, "
333
% (fap, f_ie.kind, f_ie.file_id, fk))
335
1240
# make a last minute entry
1242
yield fp[1:], c, fk, f_ie.file_id, f_ie
339
if fk == 'directory':
340
entry = TreeDirectory()
343
elif fk == 'symlink':
348
yield fp, c, fk, (f_ie and f_ie.file_id), entry
1245
yield fp[1:], c, fk, None, fk_entries[fk]()
1247
yield fp[1:], c, fk, None, TreeEntry()
350
1250
if fk != 'directory':
354
# don't descend unversioned directories
357
for ff in descend(fp, f_ie.file_id, fap):
360
for f in descend('', inv.root.file_id, self.basedir):
1253
# But do this child first if recursing down
1255
new_children = os.listdir(fap)
1257
new_children = collections.deque(new_children)
1258
stack.append((f_ie.file_id, fp, fap, new_children))
1259
# Break out of inner loop,
1260
# so that we start outer loop with child
1263
# if we finished all children, pop it off the stack
1266
@needs_tree_write_lock
1267
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1270
to_dir must exist in the inventory.
1272
If to_dir exists and is a directory, the files are moved into
1273
it, keeping their old names.
1275
Note that to_dir is only the last component of the new name;
1276
this doesn't change the directory.
1278
For each entry in from_paths the move mode will be determined
1281
The first mode moves the file in the filesystem and updates the
1282
inventory. The second mode only updates the inventory without
1283
touching the file on the filesystem. This is the new mode introduced
1286
move uses the second mode if 'after == True' and the target is not
1287
versioned but present in the working tree.
1289
move uses the second mode if 'after == False' and the source is
1290
versioned but no longer in the working tree, and the target is not
1291
versioned but present in the working tree.
1293
move uses the first mode if 'after == False' and the source is
1294
versioned and present in the working tree, and the target is not
1295
versioned and not present in the working tree.
1297
Everything else results in an error.
1299
This returns a list of (from_path, to_path) pairs for each
1300
entry that is moved.
1305
# check for deprecated use of signature
1307
to_dir = kwargs.get('to_name', None)
1309
raise TypeError('You must supply a target directory')
1311
symbol_versioning.warn('The parameter to_name was deprecated'
1312
' in version 0.13. Use to_dir instead',
1315
# check destination directory
1316
if isinstance(from_paths, basestring):
1318
inv = self.inventory
1319
to_abs = self.abspath(to_dir)
1320
if not isdir(to_abs):
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotADirectory(to_abs))
1323
if not self.has_filename(to_dir):
1324
raise errors.BzrMoveFailedError('',to_dir,
1325
errors.NotInWorkingDirectory(to_dir))
1326
to_dir_id = inv.path2id(to_dir)
1327
if to_dir_id is None:
1328
raise errors.BzrMoveFailedError('',to_dir,
1329
errors.NotVersionedError(path=str(to_dir)))
1331
to_dir_ie = inv[to_dir_id]
1332
if to_dir_ie.kind != 'directory':
1333
raise errors.BzrMoveFailedError('',to_dir,
1334
errors.NotADirectory(to_abs))
1336
# create rename entries and tuples
1337
for from_rel in from_paths:
1338
from_tail = splitpath(from_rel)[-1]
1339
from_id = inv.path2id(from_rel)
1341
raise errors.BzrMoveFailedError(from_rel,to_dir,
1342
errors.NotVersionedError(path=str(from_rel)))
1344
from_entry = inv[from_id]
1345
from_parent_id = from_entry.parent_id
1346
to_rel = pathjoin(to_dir, from_tail)
1347
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1349
from_tail=from_tail,
1350
from_parent_id=from_parent_id,
1351
to_rel=to_rel, to_tail=from_tail,
1352
to_parent_id=to_dir_id)
1353
rename_entries.append(rename_entry)
1354
rename_tuples.append((from_rel, to_rel))
1356
# determine which move mode to use. checks also for movability
1357
rename_entries = self._determine_mv_mode(rename_entries, after)
1359
original_modified = self._inventory_is_modified
1362
self._inventory_is_modified = True
1363
self._move(rename_entries)
1365
# restore the inventory on error
1366
self._inventory_is_modified = original_modified
1368
self._write_inventory(inv)
1369
return rename_tuples
1371
def _determine_mv_mode(self, rename_entries, after=False):
1372
"""Determines for each from-to pair if both inventory and working tree
1373
or only the inventory has to be changed.
1375
Also does basic plausability tests.
1377
inv = self.inventory
1379
for rename_entry in rename_entries:
1380
# store to local variables for easier reference
1381
from_rel = rename_entry.from_rel
1382
from_id = rename_entry.from_id
1383
to_rel = rename_entry.to_rel
1384
to_id = inv.path2id(to_rel)
1385
only_change_inv = False
1387
# check the inventory for source and destination
1389
raise errors.BzrMoveFailedError(from_rel,to_rel,
1390
errors.NotVersionedError(path=str(from_rel)))
1391
if to_id is not None:
1392
raise errors.BzrMoveFailedError(from_rel,to_rel,
1393
errors.AlreadyVersionedError(path=str(to_rel)))
1395
# try to determine the mode for rename (only change inv or change
1396
# inv and file system)
1398
if not self.has_filename(to_rel):
1399
raise errors.BzrMoveFailedError(from_id,to_rel,
1400
errors.NoSuchFile(path=str(to_rel),
1401
extra="New file has not been created yet"))
1402
only_change_inv = True
1403
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1404
only_change_inv = True
1405
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1406
only_change_inv = False
1407
elif (not self.case_sensitive
1408
and from_rel.lower() == to_rel.lower()
1409
and self.has_filename(from_rel)):
1410
only_change_inv = False
1412
# something is wrong, so lets determine what exactly
1413
if not self.has_filename(from_rel) and \
1414
not self.has_filename(to_rel):
1415
raise errors.BzrRenameFailedError(from_rel,to_rel,
1416
errors.PathsDoNotExist(paths=(str(from_rel),
1419
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1420
rename_entry.only_change_inv = only_change_inv
1421
return rename_entries
1423
def _move(self, rename_entries):
1424
"""Moves a list of files.
1426
Depending on the value of the flag 'only_change_inv', the
1427
file will be moved on the file system or not.
1429
inv = self.inventory
1432
for entry in rename_entries:
1434
self._move_entry(entry)
1436
self._rollback_move(moved)
1440
def _rollback_move(self, moved):
1441
"""Try to rollback a previous move in case of an filesystem error."""
1442
inv = self.inventory
1445
self._move_entry(WorkingTree._RenameEntry(
1446
entry.to_rel, entry.from_id,
1447
entry.to_tail, entry.to_parent_id, entry.from_rel,
1448
entry.from_tail, entry.from_parent_id,
1449
entry.only_change_inv))
1450
except errors.BzrMoveFailedError, e:
1451
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1452
" The working tree is in an inconsistent state."
1453
" Please consider doing a 'bzr revert'."
1454
" Error message is: %s" % e)
1456
def _move_entry(self, entry):
1457
inv = self.inventory
1458
from_rel_abs = self.abspath(entry.from_rel)
1459
to_rel_abs = self.abspath(entry.to_rel)
1460
if from_rel_abs == to_rel_abs:
1461
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1462
"Source and target are identical.")
1464
if not entry.only_change_inv:
1466
osutils.rename(from_rel_abs, to_rel_abs)
1468
raise errors.BzrMoveFailedError(entry.from_rel,
1470
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1472
@needs_tree_write_lock
1473
def rename_one(self, from_rel, to_rel, after=False):
1476
This can change the directory or the filename or both.
1478
rename_one has several 'modes' to work. First, it can rename a physical
1479
file and change the file_id. That is the normal mode. Second, it can
1480
only change the file_id without touching any physical file. This is
1481
the new mode introduced in version 0.15.
1483
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1484
versioned but present in the working tree.
1486
rename_one uses the second mode if 'after == False' and 'from_rel' is
1487
versioned but no longer in the working tree, and 'to_rel' is not
1488
versioned but present in the working tree.
1490
rename_one uses the first mode if 'after == False' and 'from_rel' is
1491
versioned and present in the working tree, and 'to_rel' is not
1492
versioned and not present in the working tree.
1494
Everything else results in an error.
1496
inv = self.inventory
1499
# create rename entries and tuples
1500
from_tail = splitpath(from_rel)[-1]
1501
from_id = inv.path2id(from_rel)
1503
# if file is missing in the inventory maybe it's in the basis_tree
1504
basis_tree = self.branch.basis_tree()
1505
from_id = basis_tree.path2id(from_rel)
1507
raise errors.BzrRenameFailedError(from_rel,to_rel,
1508
errors.NotVersionedError(path=str(from_rel)))
1509
# put entry back in the inventory so we can rename it
1510
from_entry = basis_tree.inventory[from_id].copy()
1513
from_entry = inv[from_id]
1514
from_parent_id = from_entry.parent_id
1515
to_dir, to_tail = os.path.split(to_rel)
1516
to_dir_id = inv.path2id(to_dir)
1517
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1519
from_tail=from_tail,
1520
from_parent_id=from_parent_id,
1521
to_rel=to_rel, to_tail=to_tail,
1522
to_parent_id=to_dir_id)
1523
rename_entries.append(rename_entry)
1525
# determine which move mode to use. checks also for movability
1526
rename_entries = self._determine_mv_mode(rename_entries, after)
1528
# check if the target changed directory and if the target directory is
1530
if to_dir_id is None:
1531
raise errors.BzrMoveFailedError(from_rel,to_rel,
1532
errors.NotVersionedError(path=str(to_dir)))
1534
# all checks done. now we can continue with our actual work
1535
mutter('rename_one:\n'
1540
' to_dir_id {%s}\n',
1541
from_id, from_rel, to_rel, to_dir, to_dir_id)
1543
self._move(rename_entries)
1544
self._write_inventory(inv)
1546
class _RenameEntry(object):
1547
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1548
to_rel, to_tail, to_parent_id, only_change_inv=False):
1549
self.from_rel = from_rel
1550
self.from_id = from_id
1551
self.from_tail = from_tail
1552
self.from_parent_id = from_parent_id
1553
self.to_rel = to_rel
1554
self.to_tail = to_tail
1555
self.to_parent_id = to_parent_id
1556
self.only_change_inv = only_change_inv
365
1559
def unknowns(self):
366
for subp in self.extras():
367
if not self.is_ignored(subp):
370
def iter_conflicts(self):
1560
"""Return all unknown files.
1562
These are files in the working directory that are not versioned or
1563
control files or ignored.
1565
# force the extras method to be fully executed before returning, to
1566
# prevent race conditions with the lock
1568
[subp for subp in self.extras() if not self.is_ignored(subp)])
1570
@needs_tree_write_lock
1571
def unversion(self, file_ids):
1572
"""Remove the file ids in file_ids from the current versioned set.
1574
When a file_id is unversioned, all of its children are automatically
1577
:param file_ids: The file ids to stop versioning.
1578
:raises: NoSuchId if any fileid is not currently versioned.
1580
for file_id in file_ids:
1581
if file_id not in self._inventory:
1582
raise errors.NoSuchId(self, file_id)
1583
for file_id in file_ids:
1584
if self._inventory.has_id(file_id):
1585
self._inventory.remove_recursive_id(file_id)
1587
# in the future this should just set a dirty bit to wait for the
1588
# final unlock. However, until all methods of workingtree start
1589
# with the current in -memory inventory rather than triggering
1590
# a read, it is more complex - we need to teach read_inventory
1591
# to know when to read, and when to not read first... and possibly
1592
# to save first when the in memory one may be corrupted.
1593
# so for now, we just only write it if it is indeed dirty.
1595
self._write_inventory(self._inventory)
1597
def _iter_conflicts(self):
371
1598
conflicted = set()
372
for path in (s[0] for s in self.list_files()):
1599
for info in self.list_files():
373
1601
stem = get_conflicted_stem(path)
374
1602
if stem is None:
417
1684
for subf in os.listdir(dirabs):
419
and (subf not in dir_entry.children)):
1685
if self.bzrdir.is_control_filename(subf):
1687
if subf not in dir_entry.children:
1690
can_access) = osutils.normalized_filename(subf)
1691
except UnicodeDecodeError:
1692
path_os_enc = path.encode(osutils._fs_enc)
1693
relpath = path_os_enc + '/' + subf
1694
raise errors.BadFilenameEncoding(relpath,
1696
if subf_norm != subf and can_access:
1697
if subf_norm not in dir_entry.children:
1698
fl.append(subf_norm)
424
subp = appendpath(path, subf)
1704
subp = pathjoin(path, subf)
428
1707
def ignored_files(self):
429
1708
"""Yield list of PATH, IGNORE_PATTERN"""
430
1709
for subp in self.extras():
431
1710
pat = self.is_ignored(subp)
436
1714
def get_ignore_list(self):
437
1715
"""Return list of ignore patterns.
439
1717
Cached in the Tree object after the first call.
441
if hasattr(self, '_ignorelist'):
442
return self._ignorelist
1719
ignoreset = getattr(self, '_ignoreset', None)
1720
if ignoreset is not None:
444
l = bzrlib.DEFAULT_IGNORE[:]
1723
ignore_globs = set()
1724
ignore_globs.update(ignores.get_runtime_ignores())
1725
ignore_globs.update(ignores.get_user_ignores())
445
1726
if self.has_filename(bzrlib.IGNORE_FILENAME):
446
1727
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
447
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1729
ignore_globs.update(ignores.parse_ignore_file(f))
1732
self._ignoreset = ignore_globs
1735
def _flush_ignore_list_cache(self):
1736
"""Resets the cached ignore list to force a cache rebuild."""
1737
self._ignoreset = None
1738
self._ignoreglobster = None
452
1740
def is_ignored(self, filename):
453
1741
r"""Check whether the filename matches an ignore pattern.
455
1743
Patterns containing '/' or '\' need to match the whole path;
456
others match against only the last component.
1744
others match against only the last component. Patterns starting
1745
with '!' are ignore exceptions. Exceptions take precedence
1746
over regular patterns and cause the filename to not be ignored.
458
1748
If the file is ignored, returns the pattern which caused it to
459
1749
be ignored, otherwise None. So this can simply be used as a
460
1750
boolean if desired."""
462
# TODO: Use '**' to match directories, and other extended
463
# globbing stuff from cvs/rsync.
465
# XXX: fnmatch is actually not quite what we want: it's only
466
# approximately the same as real Unix fnmatch, and doesn't
467
# treat dotfiles correctly and allows * to match /.
468
# Eventually it should be replaced with something more
471
for pat in self.get_ignore_list():
472
if '/' in pat or '\\' in pat:
474
# as a special case, you can put ./ at the start of a
475
# pattern; this is good to match in the top-level
478
if (pat[:2] == './') or (pat[:2] == '.\\'):
482
if fnmatch.fnmatchcase(filename, newpat):
485
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1751
if getattr(self, '_ignoreglobster', None) is None:
1752
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1753
return self._ignoreglobster.match(filename)
490
1755
def kind(self, file_id):
491
1756
return file_kind(self.id2abspath(file_id))
1758
def stored_kind(self, file_id):
1759
"""See Tree.stored_kind"""
1760
return self.inventory[file_id].kind
1762
def _comparison_data(self, entry, path):
1763
abspath = self.abspath(path)
1765
stat_value = os.lstat(abspath)
1767
if getattr(e, 'errno', None) == errno.ENOENT:
1774
mode = stat_value.st_mode
1775
kind = osutils.file_kind_from_stat_mode(mode)
1776
if not supports_executable():
1777
executable = entry is not None and entry.executable
1779
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1780
return kind, executable, stat_value
1782
def _file_size(self, entry, stat_value):
1783
return stat_value.st_size
1785
def last_revision(self):
1786
"""Return the last revision of the branch for this tree.
1788
This format tree does not support a separate marker for last-revision
1789
compared to the branch.
1791
See MutableTree.last_revision
1793
return self._last_revision()
1796
def _last_revision(self):
1797
"""helper for get_parent_ids."""
1798
return _mod_revision.ensure_null(self.branch.last_revision())
1800
def is_locked(self):
1801
return self._control_files.is_locked()
1803
def _must_be_locked(self):
1804
if not self.is_locked():
1805
raise errors.ObjectNotLocked(self)
493
1807
def lock_read(self):
494
"""See Branch.lock_read, and WorkingTree.unlock."""
495
return self.branch.lock_read()
1808
"""Lock the tree for reading.
1810
This also locks the branch, and can be unlocked via self.unlock().
1812
:return: A bzrlib.lock.LogicalLockResult.
1814
if not self.is_locked():
1816
self.branch.lock_read()
1818
self._control_files.lock_read()
1819
return LogicalLockResult(self.unlock)
1821
self.branch.unlock()
1824
def lock_tree_write(self):
1825
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1827
:return: A bzrlib.lock.LogicalLockResult.
1829
if not self.is_locked():
1831
self.branch.lock_read()
1833
self._control_files.lock_write()
1834
return LogicalLockResult(self.unlock)
1836
self.branch.unlock()
497
1839
def lock_write(self):
498
"""See Branch.lock_write, and WorkingTree.unlock."""
499
return self.branch.lock_write()
1840
"""See MutableTree.lock_write, and WorkingTree.unlock.
1842
:return: A bzrlib.lock.LogicalLockResult.
1844
if not self.is_locked():
1846
self.branch.lock_write()
1848
self._control_files.lock_write()
1849
return LogicalLockResult(self.unlock)
1851
self.branch.unlock()
1854
def get_physical_lock_status(self):
1855
return self._control_files.get_physical_lock_status()
1857
def _basis_inventory_name(self):
1858
return 'basis-inventory-cache'
1860
def _reset_data(self):
1861
"""Reset transient data that cannot be revalidated."""
1862
self._inventory_is_modified = False
1863
f = self._transport.get('inventory')
1865
result = self._deserialize(f)
1868
self._set_inventory(result, dirty=False)
1870
@needs_tree_write_lock
1871
def set_last_revision(self, new_revision):
1872
"""Change the last revision in the working tree."""
1873
if self._change_last_revision(new_revision):
1874
self._cache_basis_inventory(new_revision)
1876
def _change_last_revision(self, new_revision):
1877
"""Template method part of set_last_revision to perform the change.
1879
This is used to allow WorkingTree3 instances to not affect branch
1880
when their last revision is set.
1882
if _mod_revision.is_null(new_revision):
1883
self.branch.set_revision_history([])
1886
self.branch.generate_revision_history(new_revision)
1887
except errors.NoSuchRevision:
1888
# not present in the repo - dont try to set it deeper than the tip
1889
self.branch.set_revision_history([new_revision])
1892
def _write_basis_inventory(self, xml):
1893
"""Write the basis inventory XML to the basis-inventory file"""
1894
path = self._basis_inventory_name()
1896
self._transport.put_file(path, sio,
1897
mode=self.bzrdir._get_file_mode())
1899
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1900
"""Create the text that will be saved in basis-inventory"""
1901
inventory.revision_id = revision_id
1902
return xml7.serializer_v7.write_inventory_to_string(inventory)
1904
def _cache_basis_inventory(self, new_revision):
1905
"""Cache new_revision as the basis inventory."""
1906
# TODO: this should allow the ready-to-use inventory to be passed in,
1907
# as commit already has that ready-to-use [while the format is the
1910
# this double handles the inventory - unpack and repack -
1911
# but is easier to understand. We can/should put a conditional
1912
# in here based on whether the inventory is in the latest format
1913
# - perhaps we should repack all inventories on a repository
1915
# the fast path is to copy the raw xml from the repository. If the
1916
# xml contains 'revision_id="', then we assume the right
1917
# revision_id is set. We must check for this full string, because a
1918
# root node id can legitimately look like 'revision_id' but cannot
1920
xml = self.branch.repository._get_inventory_xml(new_revision)
1921
firstline = xml.split('\n', 1)[0]
1922
if (not 'revision_id="' in firstline or
1923
'format="7"' not in firstline):
1924
inv = self.branch.repository._serializer.read_inventory_from_string(
1926
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1927
self._write_basis_inventory(xml)
1928
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1931
def read_basis_inventory(self):
1932
"""Read the cached basis inventory."""
1933
path = self._basis_inventory_name()
1934
return self._transport.get_bytes(path)
501
1936
@needs_read_lock
502
1937
def read_working_inventory(self):
503
"""Read the working inventory."""
1938
"""Read the working inventory.
1940
:raises errors.InventoryModified: read_working_inventory will fail
1941
when the current in memory inventory has been modified.
1943
# conceptually this should be an implementation detail of the tree.
1944
# XXX: Deprecate this.
504
1945
# ElementTree does its own conversion from UTF-8, so open in
506
f = self.branch.controlfile('inventory', 'rb')
507
return bzrlib.xml5.serializer_v5.read_inventory(f)
510
def remove(self, files, verbose=False):
511
"""Remove nominated files from the working inventory..
513
This does not remove their text. This does not run on XXX on what? RBC
515
TODO: Refuse to remove modified files unless --force is given?
517
TODO: Do something useful with directories.
519
TODO: Should this remove the text or not? Tough call; not
520
removing may be useful and the user can just use use rm, and
521
is the opposite of add. Removing it is consistent with most
522
other tools. Maybe an option.
1947
if self._inventory_is_modified:
1948
raise errors.InventoryModified(self)
1949
f = self._transport.get('inventory')
1951
result = self._deserialize(f)
1954
self._set_inventory(result, dirty=False)
1957
@needs_tree_write_lock
1958
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1960
"""Remove nominated files from the working inventory.
1962
:files: File paths relative to the basedir.
1963
:keep_files: If true, the files will also be kept.
1964
:force: Delete files and directories, even if they are changed and
1965
even if the directories are not empty.
524
## TODO: Normalize names
525
## TODO: Remove nested loops; better scalability
526
1967
if isinstance(files, basestring):
531
# do this before any modifications
1972
all_files = set() # specified and nested files
1973
unknown_nested_files=set()
1975
to_file = sys.stdout
1977
files_to_backup = []
1979
def recurse_directory_to_add_files(directory):
1980
# Recurse directory and add all files
1981
# so we can check if they have changed.
1982
for parent_info, file_infos in self.walkdirs(directory):
1983
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1984
# Is it versioned or ignored?
1985
if self.path2id(relpath):
1986
# Add nested content for deletion.
1987
all_files.add(relpath)
1989
# Files which are not versioned
1990
# should be treated as unknown.
1991
files_to_backup.append(relpath)
1993
for filename in files:
1994
# Get file name into canonical form.
1995
abspath = self.abspath(filename)
1996
filename = self.relpath(abspath)
1997
if len(filename) > 0:
1998
all_files.add(filename)
1999
recurse_directory_to_add_files(filename)
2001
files = list(all_files)
2004
return # nothing to do
2006
# Sort needed to first handle directory content before the directory
2007
files.sort(reverse=True)
2009
# Bail out if we are going to delete files we shouldn't
2010
if not keep_files and not force:
2011
for (file_id, path, content_change, versioned, parent_id, name,
2012
kind, executable) in self.iter_changes(self.basis_tree(),
2013
include_unchanged=True, require_versioned=False,
2014
want_unversioned=True, specific_files=files):
2015
if versioned[0] == False:
2016
# The record is unknown or newly added
2017
files_to_backup.append(path[1])
2018
elif (content_change and (kind[1] is not None) and
2019
osutils.is_inside_any(files, path[1])):
2020
# Versioned and changed, but not deleted, and still
2021
# in one of the dirs to be deleted.
2022
files_to_backup.append(path[1])
2024
def backup(file_to_backup):
2025
backup_name = self.bzrdir.generate_backup_name(file_to_backup)
2026
osutils.rename(abs_path, self.abspath(backup_name))
2027
return "removed %s (but kept a copy: %s)" % (file_to_backup, backup_name)
2029
# Build inv_delta and delete files where applicable,
2030
# do this before any modifications to inventory.
2032
fid = self.path2id(f)
535
# TODO: Perhaps make this just a warning, and continue?
536
# This tends to happen when
537
raise NotVersionedError(path=f)
538
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
540
# having remove it, it must be either ignored or unknown
541
if self.is_ignored(f):
545
show_status(new_status, inv[fid].kind, quotefn(f))
548
self._write_inventory(inv)
551
def revert(self, filenames, old_tree=None, backups=True):
552
from bzrlib.merge import merge_inner
2035
message = "%s is not versioned." % (f,)
2038
# having removed it, it must be either ignored or unknown
2039
if self.is_ignored(f):
2043
# XXX: Really should be a more abstract reporter interface
2044
kind_ch = osutils.kind_marker(self.kind(fid))
2045
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2047
inv_delta.append((f, None, fid, None))
2048
message = "removed %s" % (f,)
2051
abs_path = self.abspath(f)
2052
if osutils.lexists(abs_path):
2053
if (osutils.isdir(abs_path) and
2054
len(os.listdir(abs_path)) > 0):
2056
osutils.rmtree(abs_path)
2057
message = "deleted %s" % (f,)
2061
if f in files_to_backup:
2064
osutils.delete_any(abs_path)
2065
message = "deleted %s" % (f,)
2066
elif message is not None:
2067
# Only care if we haven't done anything yet.
2068
message = "%s does not exist." % (f,)
2070
# Print only one message (if any) per file.
2071
if message is not None:
2073
self.apply_inventory_delta(inv_delta)
2075
@needs_tree_write_lock
2076
def revert(self, filenames=None, old_tree=None, backups=True,
2077
pb=None, report_changes=False):
2078
from bzrlib.conflicts import resolve
2081
symbol_versioning.warn('Using [] to revert all files is deprecated'
2082
' as of bzr 0.91. Please use None (the default) instead.',
2083
DeprecationWarning, stacklevel=2)
553
2084
if old_tree is None:
554
old_tree = self.branch.basis_tree()
555
merge_inner(self.branch, old_tree,
556
self, ignore_zero=True,
557
backup_files=backups,
558
interesting_files=filenames)
559
if not len(filenames):
560
self.set_pending_merges([])
2085
basis_tree = self.basis_tree()
2086
basis_tree.lock_read()
2087
old_tree = basis_tree
2091
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2093
if filenames is None and len(self.get_parent_ids()) > 1:
2095
last_revision = self.last_revision()
2096
if last_revision != _mod_revision.NULL_REVISION:
2097
if basis_tree is None:
2098
basis_tree = self.basis_tree()
2099
basis_tree.lock_read()
2100
parent_trees.append((last_revision, basis_tree))
2101
self.set_parent_trees(parent_trees)
2104
resolve(self, filenames, ignore_misses=True, recursive=True)
2106
if basis_tree is not None:
2110
def revision_tree(self, revision_id):
2111
"""See Tree.revision_tree.
2113
WorkingTree can supply revision_trees for the basis revision only
2114
because there is only one cached inventory in the bzr directory.
2116
if revision_id == self.last_revision():
2118
xml = self.read_basis_inventory()
2119
except errors.NoSuchFile:
2123
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2124
# dont use the repository revision_tree api because we want
2125
# to supply the inventory.
2126
if inv.revision_id == revision_id:
2127
return revisiontree.RevisionTree(self.branch.repository,
2129
except errors.BadInventoryFormat:
2131
# raise if there was no inventory, or if we read the wrong inventory.
2132
raise errors.NoSuchRevisionInTree(self, revision_id)
2134
# XXX: This method should be deprecated in favour of taking in a proper
2135
# new Inventory object.
2136
@needs_tree_write_lock
563
2137
def set_inventory(self, new_inventory_list):
564
2138
from bzrlib.inventory import (Inventory,
565
2139
InventoryDirectory,
569
2142
inv = Inventory(self.get_root_id())
579
2152
elif kind == 'symlink':
580
2153
inv.add(InventoryLink(file_id, name, parent))
582
raise BzrError("unknown kind %r" % kind)
2155
raise errors.BzrError("unknown kind %r" % kind)
583
2156
self._write_inventory(inv)
2158
@needs_tree_write_lock
586
2159
def set_root_id(self, file_id):
587
2160
"""Set the root id for this tree."""
588
inv = self.read_working_inventory()
2164
'WorkingTree.set_root_id with fileid=None')
2165
file_id = osutils.safe_file_id(file_id)
2166
self._set_root_id(file_id)
2168
def _set_root_id(self, file_id):
2169
"""Set the root id for this tree, in a format specific manner.
2171
:param file_id: The file id to assign to the root. It must not be
2172
present in the current inventory or an error will occur. It must
2173
not be None, but rather a valid file id.
2175
inv = self._inventory
589
2176
orig_root_id = inv.root.file_id
2177
# TODO: it might be nice to exit early if there was nothing
2178
# to do, saving us from trigger a sync on unlock.
2179
self._inventory_is_modified = True
2180
# we preserve the root inventory entry object, but
2181
# unlinkit from the byid index
590
2182
del inv._byid[inv.root.file_id]
591
2183
inv.root.file_id = file_id
2184
# and link it into the index with the new changed id.
592
2185
inv._byid[inv.root.file_id] = inv.root
2186
# and finally update all children to reference the new id.
2187
# XXX: this should be safe to just look at the root.children
2188
# list, not the WHOLE INVENTORY.
594
2190
entry = inv[fid]
595
if entry.parent_id in (None, orig_root_id):
2191
if entry.parent_id == orig_root_id:
596
2192
entry.parent_id = inv.root.file_id
597
self._write_inventory(inv)
599
2194
def unlock(self):
600
2195
"""See Branch.unlock.
602
2197
WorkingTree locking just uses the Branch locking facilities.
603
2198
This is current because all working trees have an embedded branch
604
2199
within them. IF in the future, we were to make branch data shareable
605
between multiple working trees, i.e. via shared storage, then we
2200
between multiple working trees, i.e. via shared storage, then we
606
2201
would probably want to lock both the local tree, and the branch.
608
return self.branch.unlock()
2203
raise NotImplementedError(self.unlock)
2207
def update(self, change_reporter=None, possible_transports=None,
2208
revision=None, old_tip=_marker):
2209
"""Update a working tree along its branch.
2211
This will update the branch if its bound too, which means we have
2212
multiple trees involved:
2214
- The new basis tree of the master.
2215
- The old basis tree of the branch.
2216
- The old basis tree of the working tree.
2217
- The current working tree state.
2219
Pathologically, all three may be different, and non-ancestors of each
2220
other. Conceptually we want to:
2222
- Preserve the wt.basis->wt.state changes
2223
- Transform the wt.basis to the new master basis.
2224
- Apply a merge of the old branch basis to get any 'local' changes from
2226
- Restore the wt.basis->wt.state changes.
2228
There isn't a single operation at the moment to do that, so we:
2229
- Merge current state -> basis tree of the master w.r.t. the old tree
2231
- Do a 'normal' merge of the old branch basis if it is relevant.
2233
:param revision: The target revision to update to. Must be in the
2235
:param old_tip: If branch.update() has already been run, the value it
2236
returned (old tip of the branch or None). _marker is used
2239
if self.branch.get_bound_location() is not None:
2241
update_branch = (old_tip is self._marker)
2243
self.lock_tree_write()
2244
update_branch = False
2247
old_tip = self.branch.update(possible_transports)
2249
if old_tip is self._marker:
2251
return self._update_tree(old_tip, change_reporter, revision)
2255
@needs_tree_write_lock
2256
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2257
"""Update a tree to the master branch.
2259
:param old_tip: if supplied, the previous tip revision the branch,
2260
before it was changed to the master branch's tip.
2262
# here if old_tip is not None, it is the old tip of the branch before
2263
# it was updated from the master branch. This should become a pending
2264
# merge in the working tree to preserve the user existing work. we
2265
# cant set that until we update the working trees last revision to be
2266
# one from the new branch, because it will just get absorbed by the
2267
# parent de-duplication logic.
2269
# We MUST save it even if an error occurs, because otherwise the users
2270
# local work is unreferenced and will appear to have been lost.
2274
last_rev = self.get_parent_ids()[0]
2276
last_rev = _mod_revision.NULL_REVISION
2277
if revision is None:
2278
revision = self.branch.last_revision()
2280
old_tip = old_tip or _mod_revision.NULL_REVISION
2282
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
# the branch we are bound to was updated
2284
# merge those changes in first
2285
base_tree = self.basis_tree()
2286
other_tree = self.branch.repository.revision_tree(old_tip)
2287
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
base_tree, this_tree=self,
2289
change_reporter=change_reporter)
2291
self.add_parent_tree((old_tip, other_tree))
2292
trace.note('Rerun update after fixing the conflicts.')
2295
if last_rev != _mod_revision.ensure_null(revision):
2296
# the working tree is up to date with the branch
2297
# we can merge the specified revision from master
2298
to_tree = self.branch.repository.revision_tree(revision)
2299
to_root_id = to_tree.get_root_id()
2301
basis = self.basis_tree()
2304
if (basis.inventory.root is None
2305
or basis.inventory.root.file_id != to_root_id):
2306
self.set_root_id(to_root_id)
2311
# determine the branch point
2312
graph = self.branch.repository.get_graph()
2313
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
change_reporter=change_reporter)
2320
self.set_last_revision(revision)
2321
# TODO - dedup parents list with things merged by pull ?
2322
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
2324
merges = self.get_parent_ids()[1:]
2325
# Ideally we ask the tree for the trees here, that way the working
2326
# tree can decide whether to give us the entire tree or give us a
2327
# lazy initialised tree. dirstate for instance will have the trees
2328
# in ram already, whereas a last-revision + basis-inventory tree
2329
# will not, but also does not need them when setting parents.
2330
for parent in merges:
2331
parent_trees.append(
2332
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
2334
parent_trees.append(
2335
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
self.set_parent_trees(parent_trees)
2337
last_rev = parent_trees[0][0]
2340
def _write_hashcache_if_dirty(self):
2341
"""Write out the hashcache if it is dirty."""
2342
if self._hashcache.needs_write:
2344
self._hashcache.write()
2346
if e.errno not in (errno.EPERM, errno.EACCES):
2348
# TODO: jam 20061219 Should this be a warning? A single line
2349
# warning might be sufficient to let the user know what
2351
mutter('Could not write hashcache for %s\nError: %s',
2352
self._hashcache.cache_file_name(), e)
2354
@needs_tree_write_lock
611
2355
def _write_inventory(self, inv):
612
2356
"""Write inventory as the current inventory."""
613
from cStringIO import StringIO
614
from bzrlib.atomicfile import AtomicFile
616
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
618
f = AtomicFile(self.branch.controlfilename('inventory'))
624
mutter('wrote working inventory')
627
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
2357
self._set_inventory(inv, dirty=True)
2360
def set_conflicts(self, arg):
2361
raise errors.UnsupportedOperation(self.set_conflicts, self)
2363
def add_conflicts(self, arg):
2364
raise errors.UnsupportedOperation(self.add_conflicts, self)
2367
def conflicts(self):
2368
conflicts = _mod_conflicts.ConflictList()
2369
for conflicted in self._iter_conflicts():
2372
if file_kind(self.abspath(conflicted)) != "file":
2374
except errors.NoSuchFile:
2377
for suffix in ('.THIS', '.OTHER'):
2379
kind = file_kind(self.abspath(conflicted+suffix))
2382
except errors.NoSuchFile:
2386
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2387
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2389
file_id=self.path2id(conflicted)))
2392
def walkdirs(self, prefix=""):
2393
"""Walk the directories of this tree.
2395
returns a generator which yields items in the form:
2396
((curren_directory_path, fileid),
2397
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2400
This API returns a generator, which is only valid during the current
2401
tree transaction - within a single lock_read or lock_write duration.
2403
If the tree is not locked, it may cause an error to be raised,
2404
depending on the tree implementation.
2406
disk_top = self.abspath(prefix)
2407
if disk_top.endswith('/'):
2408
disk_top = disk_top[:-1]
2409
top_strip_len = len(disk_top) + 1
2410
inventory_iterator = self._walkdirs(prefix)
2411
disk_iterator = osutils.walkdirs(disk_top, prefix)
2413
current_disk = disk_iterator.next()
2414
disk_finished = False
2416
if not (e.errno == errno.ENOENT or
2417
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2420
disk_finished = True
2422
current_inv = inventory_iterator.next()
2423
inv_finished = False
2424
except StopIteration:
2427
while not inv_finished or not disk_finished:
2429
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2430
cur_disk_dir_content) = current_disk
2432
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
cur_disk_dir_content) = ((None, None), None)
2434
if not disk_finished:
2435
# strip out .bzr dirs
2436
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2437
len(cur_disk_dir_content) > 0):
2438
# osutils.walkdirs can be made nicer -
2439
# yield the path-from-prefix rather than the pathjoined
2441
bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
if (bzrdir_loc < len(cur_disk_dir_content)
2444
and self.bzrdir.is_control_filename(
2445
cur_disk_dir_content[bzrdir_loc][0])):
2446
# we dont yield the contents of, or, .bzr itself.
2447
del cur_disk_dir_content[bzrdir_loc]
2449
# everything is unknown
2452
# everything is missing
2455
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2457
# disk is before inventory - unknown
2458
dirblock = [(relpath, basename, kind, stat, None, None) for
2459
relpath, basename, kind, stat, top_path in
2460
cur_disk_dir_content]
2461
yield (cur_disk_dir_relpath, None), dirblock
2463
current_disk = disk_iterator.next()
2464
except StopIteration:
2465
disk_finished = True
2467
# inventory is before disk - missing.
2468
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
for relpath, basename, dkind, stat, fileid, kind in
2471
yield (current_inv[0][0], current_inv[0][1]), dirblock
2473
current_inv = inventory_iterator.next()
2474
except StopIteration:
2477
# versioned present directory
2478
# merge the inventory and disk data together
2480
for relpath, subiterator in itertools.groupby(sorted(
2481
current_inv[1] + cur_disk_dir_content,
2482
key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
path_elements = list(subiterator)
2484
if len(path_elements) == 2:
2485
inv_row, disk_row = path_elements
2486
# versioned, present file
2487
dirblock.append((inv_row[0],
2488
inv_row[1], disk_row[2],
2489
disk_row[3], inv_row[4],
2491
elif len(path_elements[0]) == 5:
2493
dirblock.append((path_elements[0][0],
2494
path_elements[0][1], path_elements[0][2],
2495
path_elements[0][3], None, None))
2496
elif len(path_elements[0]) == 6:
2497
# versioned, absent file.
2498
dirblock.append((path_elements[0][0],
2499
path_elements[0][1], 'unknown', None,
2500
path_elements[0][4], path_elements[0][5]))
2502
raise NotImplementedError('unreachable code')
2503
yield current_inv[0], dirblock
2505
current_inv = inventory_iterator.next()
2506
except StopIteration:
2509
current_disk = disk_iterator.next()
2510
except StopIteration:
2511
disk_finished = True
2513
def _walkdirs(self, prefix=""):
2514
"""Walk the directories of this tree.
2516
:prefix: is used as the directrory to start with.
2517
returns a generator which yields items in the form:
2518
((curren_directory_path, fileid),
2519
[(file1_path, file1_name, file1_kind, None, file1_id,
2522
_directory = 'directory'
2523
# get the root in the inventory
2524
inv = self.inventory
2525
top_id = inv.path2id(prefix)
2529
pending = [(prefix, '', _directory, None, top_id, None)]
2532
currentdir = pending.pop()
2533
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2534
top_id = currentdir[4]
2536
relroot = currentdir[0] + '/'
2539
# FIXME: stash the node in pending
2541
if entry.kind == 'directory':
2542
for name, child in entry.sorted_children():
2543
dirblock.append((relroot + name, name, child.kind, None,
2544
child.file_id, child.kind
2546
yield (currentdir[0], entry.file_id), dirblock
2547
# push the user specified dirs from dirblock
2548
for dir in reversed(dirblock):
2549
if dir[2] == _directory:
2552
@needs_tree_write_lock
2553
def auto_resolve(self):
2554
"""Automatically resolve text conflicts according to contents.
2556
Only text conflicts are auto_resolvable. Files with no conflict markers
2557
are considered 'resolved', because bzr always puts conflict markers
2558
into files that have text conflicts. The corresponding .THIS .BASE and
2559
.OTHER files are deleted, as per 'resolve'.
2560
:return: a tuple of ConflictLists: (un_resolved, resolved).
2562
un_resolved = _mod_conflicts.ConflictList()
2563
resolved = _mod_conflicts.ConflictList()
2564
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2565
for conflict in self.conflicts():
2566
if (conflict.typestring != 'text conflict' or
2567
self.kind(conflict.file_id) != 'file'):
2568
un_resolved.append(conflict)
2570
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2572
for line in my_file:
2573
if conflict_re.search(line):
2574
un_resolved.append(conflict)
2577
resolved.append(conflict)
2580
resolved.remove_files(self)
2581
self.set_conflicts(un_resolved)
2582
return un_resolved, resolved
2585
def _check(self, references):
2586
"""Check the tree for consistency.
2588
:param references: A dict with keys matching the items returned by
2589
self._get_check_refs(), and values from looking those keys up in
2592
tree_basis = self.basis_tree()
2593
tree_basis.lock_read()
2595
repo_basis = references[('trees', self.last_revision())]
2596
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
raise errors.BzrCheckError(
2598
"Mismatched basis inventory content.")
2603
def _validate(self):
2604
"""Validate internal structures.
2606
This is meant mostly for the test suite. To give it a chance to detect
2607
corruption after actions have occurred. The default implementation is a
2610
:return: None. An exception should be raised if there is an error.
2614
def _get_rules_searcher(self, default_searcher):
2615
"""See Tree._get_rules_searcher."""
2616
if self._rules_searcher is None:
2617
self._rules_searcher = super(WorkingTree,
2618
self)._get_rules_searcher(default_searcher)
2619
return self._rules_searcher
2621
def get_shelf_manager(self):
2622
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
2624
return ShelfManager(self, self._transport)
2627
class WorkingTree2(WorkingTree):
2628
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
2631
- uses os locks for locking.
2632
- uses the branch last-revision.
2635
def __init__(self, *args, **kwargs):
2636
super(WorkingTree2, self).__init__(*args, **kwargs)
2637
# WorkingTree2 has more of a constraint that self._inventory must
2638
# exist. Because this is an older format, we don't mind the overhead
2639
# caused by the extra computation here.
2641
# Newer WorkingTree's should only have self._inventory set when they
2643
if self._inventory is None:
2644
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
2650
def lock_tree_write(self):
2651
"""See WorkingTree.lock_tree_write().
2653
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
2659
self.branch.lock_write()
2661
self._control_files.lock_write()
2664
self.branch.unlock()
2668
# do non-implementation specific cleanup
2671
# we share control files:
2672
if self._control_files._lock_count == 3:
2673
# _inventory_is_modified is always False during a read lock.
2674
if self._inventory_is_modified:
2676
self._write_hashcache_if_dirty()
2678
# reverse order of locking.
2680
return self._control_files.unlock()
2682
self.branch.unlock()
2685
class WorkingTree3(WorkingTree):
2686
"""This is the Format 3 working tree.
2688
This differs from the base WorkingTree by:
2689
- having its own file lock
2690
- having its own last-revision property.
2692
This is new in bzr 0.8
2696
def _last_revision(self):
2697
"""See Mutable.last_revision."""
2699
return self._transport.get_bytes('last-revision')
2700
except errors.NoSuchFile:
2701
return _mod_revision.NULL_REVISION
2703
def _change_last_revision(self, revision_id):
2704
"""See WorkingTree._change_last_revision."""
2705
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2707
self._transport.delete('last-revision')
2708
except errors.NoSuchFile:
2712
self._transport.put_bytes('last-revision', revision_id,
2713
mode=self.bzrdir._get_file_mode())
2716
def _get_check_refs(self):
2717
"""Return the references needed to perform a check of this tree."""
2718
return [('trees', self.last_revision())]
2720
@needs_tree_write_lock
2721
def set_conflicts(self, conflicts):
2722
self._put_rio('conflicts', conflicts.to_stanzas(),
2725
@needs_tree_write_lock
2726
def add_conflicts(self, new_conflicts):
2727
conflict_set = set(self.conflicts())
2728
conflict_set.update(set(list(new_conflicts)))
2729
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2730
key=_mod_conflicts.Conflict.sort_key)))
2733
def conflicts(self):
2735
confile = self._transport.get('conflicts')
2736
except errors.NoSuchFile:
2737
return _mod_conflicts.ConflictList()
2740
if confile.next() != CONFLICT_HEADER_1 + '\n':
2741
raise errors.ConflictFormatError()
2742
except StopIteration:
2743
raise errors.ConflictFormatError()
2744
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2749
# do non-implementation specific cleanup
2751
if self._control_files._lock_count == 1:
2752
# _inventory_is_modified is always False during a read lock.
2753
if self._inventory_is_modified:
2755
self._write_hashcache_if_dirty()
2756
# reverse order of locking.
2758
return self._control_files.unlock()
2760
self.branch.unlock()
628
2763
def get_conflicted_stem(path):
629
for suffix in CONFLICT_SUFFIXES:
2764
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
630
2765
if path.endswith(suffix):
631
2766
return path[:-len(suffix)]
2769
class WorkingTreeFormat(object):
2770
"""An encapsulation of the initialization and open routines for a format.
2772
Formats provide three things:
2773
* An initialization routine,
2777
Formats are placed in an dict by their format string for reference
2778
during workingtree opening. Its not required that these be instances, they
2779
can be classes themselves with class methods - it simply depends on
2780
whether state is needed for a given format or not.
2782
Once a format is deprecated, just deprecate the initialize and open
2783
methods on the format class. Do not deprecate the object, as the
2784
object will be created every time regardless.
2787
_default_format = None
2788
"""The default format used for new trees."""
2791
"""The known formats."""
2793
requires_rich_root = False
2795
upgrade_recommended = False
2798
def find_format(klass, a_bzrdir):
2799
"""Return the format for the working tree object in a_bzrdir."""
2801
transport = a_bzrdir.get_workingtree_transport(None)
2802
format_string = transport.get_bytes("format")
2803
return klass._formats[format_string]
2804
except errors.NoSuchFile:
2805
raise errors.NoWorkingTree(base=transport.base)
2807
raise errors.UnknownFormatError(format=format_string,
2808
kind="working tree")
2810
def __eq__(self, other):
2811
return self.__class__ is other.__class__
2813
def __ne__(self, other):
2814
return not (self == other)
2817
def get_default_format(klass):
2818
"""Return the current default format."""
2819
return klass._default_format
2821
def get_format_string(self):
2822
"""Return the ASCII format string that identifies this format."""
2823
raise NotImplementedError(self.get_format_string)
2825
def get_format_description(self):
2826
"""Return the short description for this format."""
2827
raise NotImplementedError(self.get_format_description)
2829
def is_supported(self):
2830
"""Is this format supported?
2832
Supported formats can be initialized and opened.
2833
Unsupported formats may not support initialization or committing or
2834
some other features depending on the reason for not being supported.
2838
def supports_content_filtering(self):
2839
"""True if this format supports content filtering."""
2842
def supports_views(self):
2843
"""True if this format supports stored views."""
2847
def register_format(klass, format):
2848
klass._formats[format.get_format_string()] = format
2851
def set_default_format(klass, format):
2852
klass._default_format = format
2855
def unregister_format(klass, format):
2856
del klass._formats[format.get_format_string()]
2859
class WorkingTreeFormat2(WorkingTreeFormat):
2860
"""The second working tree format.
2862
This format modified the hash cache from the format 1 hash cache.
2865
upgrade_recommended = True
2867
def get_format_description(self):
2868
"""See WorkingTreeFormat.get_format_description()."""
2869
return "Working tree format 2"
2871
def _stub_initialize_on_transport(self, transport, file_mode):
2872
"""Workaround: create control files for a remote working tree.
2874
This ensures that it can later be updated and dealt with locally,
2875
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2876
no working tree. (See bug #43064).
2879
inv = inventory.Inventory()
2880
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2882
transport.put_file('inventory', sio, file_mode)
2883
transport.put_bytes('pending-merges', '', file_mode)
2885
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2886
accelerator_tree=None, hardlink=False):
2887
"""See WorkingTreeFormat.initialize()."""
2888
if not isinstance(a_bzrdir.transport, LocalTransport):
2889
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2890
if from_branch is not None:
2891
branch = from_branch
2893
branch = a_bzrdir.open_branch()
2894
if revision_id is None:
2895
revision_id = _mod_revision.ensure_null(branch.last_revision())
2898
branch.generate_revision_history(revision_id)
2901
inv = inventory.Inventory()
2902
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2908
basis_tree = branch.repository.revision_tree(revision_id)
2909
if basis_tree.inventory.root is not None:
2910
wt.set_root_id(basis_tree.get_root_id())
2911
# set the parent list and cache the basis tree.
2912
if _mod_revision.is_null(revision_id):
2915
parent_trees = [(revision_id, basis_tree)]
2916
wt.set_parent_trees(parent_trees)
2917
transform.build_tree(basis_tree, wt)
2921
super(WorkingTreeFormat2, self).__init__()
2922
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2924
def open(self, a_bzrdir, _found=False):
2925
"""Return the WorkingTree object for a_bzrdir
2927
_found is a private parameter, do not use it. It is used to indicate
2928
if format probing has already been done.
2931
# we are being called directly and must probe.
2932
raise NotImplementedError
2933
if not isinstance(a_bzrdir.transport, LocalTransport):
2934
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2935
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2941
class WorkingTreeFormat3(WorkingTreeFormat):
2942
"""The second working tree format updated to record a format marker.
2945
- exists within a metadir controlling .bzr
2946
- includes an explicit version marker for the workingtree control
2947
files, separate from the BzrDir format
2948
- modifies the hash cache format
2950
- uses a LockDir to guard access for writes.
2953
upgrade_recommended = True
2955
def get_format_string(self):
2956
"""See WorkingTreeFormat.get_format_string()."""
2957
return "Bazaar-NG Working Tree format 3"
2959
def get_format_description(self):
2960
"""See WorkingTreeFormat.get_format_description()."""
2961
return "Working tree format 3"
2963
_lock_file_name = 'lock'
2964
_lock_class = LockDir
2966
_tree_class = WorkingTree3
2968
def __get_matchingbzrdir(self):
2969
return bzrdir.BzrDirMetaFormat1()
2971
_matchingbzrdir = property(__get_matchingbzrdir)
2973
def _open_control_files(self, a_bzrdir):
2974
transport = a_bzrdir.get_workingtree_transport(None)
2975
return LockableFiles(transport, self._lock_file_name,
2978
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
accelerator_tree=None, hardlink=False):
2980
"""See WorkingTreeFormat.initialize().
2982
:param revision_id: if supplied, create a working tree at a different
2983
revision than the branch is at.
2984
:param accelerator_tree: A tree which can be used for retrieving file
2985
contents more quickly than the revision tree, i.e. a workingtree.
2986
The revision tree will be used for cases where accelerator_tree's
2987
content is different.
2988
:param hardlink: If true, hard-link files from accelerator_tree,
2991
if not isinstance(a_bzrdir.transport, LocalTransport):
2992
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2993
transport = a_bzrdir.get_workingtree_transport(self)
2994
control_files = self._open_control_files(a_bzrdir)
2995
control_files.create_lock()
2996
control_files.lock_write()
2997
transport.put_bytes('format', self.get_format_string(),
2998
mode=a_bzrdir._get_file_mode())
2999
if from_branch is not None:
3000
branch = from_branch
3002
branch = a_bzrdir.open_branch()
3003
if revision_id is None:
3004
revision_id = _mod_revision.ensure_null(branch.last_revision())
3005
# WorkingTree3 can handle an inventory which has a unique root id.
3006
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3007
# those trees. And because there isn't a format bump inbetween, we
3008
# are maintaining compatibility with older clients.
3009
# inv = Inventory(root_id=gen_root_id())
3010
inv = self._initial_inventory()
3011
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3017
_control_files=control_files)
3018
wt.lock_tree_write()
3020
basis_tree = branch.repository.revision_tree(revision_id)
3021
# only set an explicit root id if there is one to set.
3022
if basis_tree.inventory.root is not None:
3023
wt.set_root_id(basis_tree.get_root_id())
3024
if revision_id == _mod_revision.NULL_REVISION:
3025
wt.set_parent_trees([])
3027
wt.set_parent_trees([(revision_id, basis_tree)])
3028
transform.build_tree(basis_tree, wt)
3030
# Unlock in this order so that the unlock-triggers-flush in
3031
# WorkingTree is given a chance to fire.
3032
control_files.unlock()
3036
def _initial_inventory(self):
3037
return inventory.Inventory()
3040
super(WorkingTreeFormat3, self).__init__()
3042
def open(self, a_bzrdir, _found=False):
3043
"""Return the WorkingTree object for a_bzrdir
3045
_found is a private parameter, do not use it. It is used to indicate
3046
if format probing has already been done.
3049
# we are being called directly and must probe.
3050
raise NotImplementedError
3051
if not isinstance(a_bzrdir.transport, LocalTransport):
3052
raise errors.NotLocalUrl(a_bzrdir.transport.base)
3053
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3056
def _open(self, a_bzrdir, control_files):
3057
"""Open the tree itself.
3059
:param a_bzrdir: the dir for the tree.
3060
:param control_files: the control files for the tree.
3062
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3066
_control_files=control_files)
3069
return self.get_format_string()
3072
__default_format = WorkingTreeFormat6()
3073
WorkingTreeFormat.register_format(__default_format)
3074
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
WorkingTreeFormat.set_default_format(__default_format)
3078
# formats which have no format string are not discoverable
3079
# and not independently creatable, so are not registered.
3080
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
