68
361
inv = self._inventory
69
362
for path, ie in inv.iter_entries():
70
if os.path.exists(self.abspath(path)):
363
if osutils.lexists(self.abspath(path)):
74
366
def __repr__(self):
75
367
return "<%s of %s>" % (self.__class__.__name__,
76
368
getattr(self, 'basedir', None))
80
370
def abspath(self, filename):
81
return os.path.join(self.basedir, filename)
371
return pathjoin(self.basedir, filename)
373
def basis_tree(self):
374
"""Return RevisionTree for the current last revision.
376
If the left most parent is a ghost then the returned tree will be an
377
empty tree - one obtained by calling repository.revision_tree(None).
380
revision_id = self.get_parent_ids()[0]
382
# no parents, return an empty revision tree.
383
# in the future this should return the tree for
384
# 'empty:' - the implicit root empty tree.
385
return self.branch.repository.revision_tree(None)
387
return self.revision_tree(revision_id)
388
except errors.NoSuchRevision:
390
# No cached copy available, retrieve from the repository.
391
# FIXME? RBC 20060403 should we cache the inventory locally
394
return self.branch.repository.revision_tree(revision_id)
395
except errors.RevisionNotPresent:
396
# the basis tree *may* be a ghost or a low level error may have
397
# occured. If the revision is present, its a problem, if its not
399
if self.branch.repository.has_revision(revision_id):
401
# the basis tree is a ghost so return an empty tree.
402
return self.branch.repository.revision_tree(None)
405
@deprecated_method(zero_eight)
406
def create(branch, directory):
407
"""Create a workingtree for branch at directory.
409
If existing_directory already exists it must have a .bzr directory.
410
If it does not exist, it will be created.
412
This returns a new WorkingTree object for the new checkout.
414
TODO FIXME RBC 20060124 when we have checkout formats in place this
415
should accept an optional revisionid to checkout [and reject this if
416
checking out into the same dir as a pre-checkout-aware branch format.]
418
XXX: When BzrDir is present, these should be created through that
421
warnings.warn('delete WorkingTree.create', stacklevel=3)
422
transport = get_transport(directory)
423
if branch.bzrdir.root_transport.base == transport.base:
425
return branch.bzrdir.create_workingtree()
426
# different directory,
427
# create a branch reference
428
# and now a working tree.
429
raise NotImplementedError
432
@deprecated_method(zero_eight)
433
def create_standalone(directory):
434
"""Create a checkout and a branch and a repo at directory.
436
Directory must exist and be empty.
438
please use BzrDir.create_standalone_workingtree
440
return bzrdir.BzrDir.create_standalone_workingtree(directory)
442
def relpath(self, path):
443
"""Return the local path portion from a given path.
445
The path may be absolute or relative. If its a relative path it is
446
interpreted relative to the python current working directory.
448
return osutils.relpath(self.basedir, path)
83
450
def has_filename(self, filename):
84
return os.path.exists(self.abspath(filename))
451
return osutils.lexists(self.abspath(filename))
86
453
def get_file(self, file_id):
87
454
return self.get_file_byname(self.id2path(file_id))
456
def get_file_text(self, file_id):
457
return self.get_file(file_id).read()
89
459
def get_file_byname(self, filename):
90
460
return file(self.abspath(filename), 'rb')
463
def annotate_iter(self, file_id):
464
"""See Tree.annotate_iter
466
This implementation will use the basis tree implementation if possible.
467
Lines not in the basis are attributed to CURRENT_REVISION
469
If there are pending merges, lines added by those merges will be
470
incorrectly attributed to CURRENT_REVISION (but after committing, the
471
attribution will be correct).
473
basis = self.basis_tree()
474
changes = self._iter_changes(basis, True, [file_id]).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
494
def get_parent_ids(self):
495
"""See Tree.get_parent_ids.
497
This implementation reads the pending merges list and last_revision
498
value and uses that to decide what the parents list should be.
500
last_rev = self._last_revision()
506
merges_file = self._control_files.get_utf8('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
parents.append(l.rstrip('\n'))
515
def get_root_id(self):
516
"""Return the id of this trees root"""
517
return self._inventory.root.file_id
92
519
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))
520
## XXX: badly named; this is not in the store at all
521
return self.abspath(self.id2path(file_id))
524
def clone(self, to_bzrdir, revision_id=None, basis=None):
525
"""Duplicate this working tree into to_bzr, including all state.
527
Specifically modified files are kept as modified, but
528
ignored and unknown files are discarded.
530
If you want to make a new line of development, see bzrdir.sprout()
533
If not None, the cloned tree will have its last revision set to
534
revision, and and difference between the source trees last revision
535
and this one merged in.
538
If not None, a closer copy of a tree which may have some files in
539
common, and which file content should be preferentially copied from.
541
# assumes the target bzr dir format is compatible.
542
result = self._format.initialize(to_bzrdir)
543
self.copy_content_into(result, revision_id)
547
def copy_content_into(self, tree, revision_id=None):
548
"""Copy the current content and user files of this tree into tree."""
549
tree.set_root_id(self.get_root_id())
550
if revision_id is None:
551
merge.transform_tree(tree, self)
553
# TODO now merge from tree.last_revision to revision (to preserve
554
# user local changes)
555
merge.transform_tree(tree, self)
556
tree.set_parent_ids([revision_id])
558
def id2abspath(self, file_id):
559
return self.abspath(self.id2path(file_id))
97
561
def has_id(self, file_id):
98
562
# files that have been deleted are excluded
99
563
inv = self._inventory
100
564
if not inv.has_id(file_id):
102
566
path = inv.id2path(file_id)
103
return os.path.exists(self.abspath(path))
567
return osutils.lexists(self.abspath(path))
569
def has_or_had_id(self, file_id):
570
if file_id == self.inventory.root.file_id:
572
return self.inventory.has_id(file_id)
106
574
__contains__ = has_id
109
576
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)
577
return os.path.getsize(self.id2abspath(file_id))
580
def get_file_sha1(self, file_id, path=None, stat_value=None):
582
path = self._inventory.id2path(file_id)
583
return self._hashcache.get_sha1(path, stat_value)
585
def get_file_mtime(self, file_id, path=None):
587
path = self._inventory.id2path(file_id)
588
return os.lstat(self.abspath(path)).st_mtime
590
if not supports_executable():
591
def is_executable(self, file_id, path=None):
592
return self._inventory[file_id].executable
594
def is_executable(self, file_id, path=None):
596
path = self.id2path(file_id)
597
mode = os.lstat(self.abspath(path)).st_mode
598
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
601
def _add(self, files, ids, kinds):
602
"""See MutableTree._add."""
603
# TODO: Re-adding a file that is removed in the working copy
604
# should probably put it back with the previous ID.
605
# the read and write working inventory should not occur in this
606
# function - they should be part of lock_write and unlock.
607
inv = self.read_working_inventory()
608
for f, file_id, kind in zip(files, ids, kinds):
609
assert kind is not None
611
inv.add_path(f, kind=kind)
613
inv.add_path(f, kind=kind, file_id=file_id)
614
self._write_inventory(inv)
616
@needs_tree_write_lock
617
def _gather_kinds(self, files, kinds):
618
"""See MutableTree._gather_kinds."""
619
for pos, f in enumerate(files):
620
if kinds[pos] is None:
621
fullpath = normpath(self.abspath(f))
623
kinds[pos] = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise errors.NoSuchFile(fullpath)
629
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
630
"""Add revision_id as a parent.
632
This is equivalent to retrieving the current list of parent ids
633
and setting the list to its value plus revision_id.
635
:param revision_id: The revision id to add to the parent list. It may
636
be a ghost revision as long as its not the first parent to be added,
637
or the allow_leftmost_as_ghost parameter is set True.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parents = self.get_parent_ids() + [revision_id]
641
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
642
or allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
646
"""Add revision_id, tree tuple as a parent.
648
This is equivalent to retrieving the current list of parent trees
649
and setting the list to its value plus parent_tuple. See also
650
add_parent_tree_id - if you only have a parent id available it will be
651
simpler to use that api. If you have the parent already available, using
652
this api is preferred.
654
:param parent_tuple: The (revision id, tree) to add to the parent list.
655
If the revision_id is a ghost, pass None for the tree.
656
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
659
if len(parent_ids) > 1:
660
# the leftmost may have already been a ghost, preserve that if it
662
allow_leftmost_as_ghost = True
663
self.set_parent_ids(parent_ids,
664
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
@needs_tree_write_lock
667
def add_pending_merge(self, *revision_ids):
668
# TODO: Perhaps should check at this point that the
669
# history of the revision is actually present?
670
parents = self.get_parent_ids()
672
for rev_id in revision_ids:
673
if rev_id in parents:
675
parents.append(rev_id)
678
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
@deprecated_method(zero_eleven)
682
def pending_merges(self):
683
"""Return a list of pending merges.
685
These are revisions that have been merged into the working
686
directory but not yet committed.
688
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
689
instead - which is available on all tree objects.
691
return self.get_parent_ids()[1:]
693
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
694
"""Common ghost checking functionality from set_parent_*.
696
This checks that the left hand-parent exists if there are any
699
if len(revision_ids) > 0:
700
leftmost_id = revision_ids[0]
701
if (not allow_leftmost_as_ghost and not
702
self.branch.repository.has_revision(leftmost_id)):
703
raise errors.GhostRevisionUnusableHere(leftmost_id)
705
def _set_merges_from_parent_ids(self, parent_ids):
706
merges = parent_ids[1:]
707
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
709
@needs_tree_write_lock
710
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
711
"""Set the parent ids to revision_ids.
713
See also set_parent_trees. This api will try to retrieve the tree data
714
for each element of revision_ids from the trees repository. If you have
715
tree data already available, it is more efficient to use
716
set_parent_trees rather than set_parent_ids. set_parent_ids is however
717
an easier API to use.
719
:param revision_ids: The revision_ids to set as the parent ids of this
720
working tree. Any of these may be ghosts.
722
self._check_parents_for_ghosts(revision_ids,
723
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
725
if len(revision_ids) > 0:
726
self.set_last_revision(revision_ids[0])
728
self.set_last_revision(None)
730
self._set_merges_from_parent_ids(revision_ids)
732
@needs_tree_write_lock
733
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
734
"""See MutableTree.set_parent_trees."""
735
parent_ids = [rev for (rev, tree) in parents_list]
737
self._check_parents_for_ghosts(parent_ids,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
if len(parent_ids) == 0:
741
leftmost_parent_id = None
742
leftmost_parent_tree = None
744
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
746
if self._change_last_revision(leftmost_parent_id):
747
if leftmost_parent_tree is None:
748
# If we don't have a tree, fall back to reading the
749
# parent tree from the repository.
750
self._cache_basis_inventory(leftmost_parent_id)
752
inv = leftmost_parent_tree.inventory
753
xml = self._create_basis_xml_from_inventory(
754
leftmost_parent_id, inv)
755
self._write_basis_inventory(xml)
756
self._set_merges_from_parent_ids(parent_ids)
758
@needs_tree_write_lock
759
def set_pending_merges(self, rev_list):
760
parents = self.get_parent_ids()
761
leftmost = parents[:1]
762
new_parents = leftmost + rev_list
763
self.set_parent_ids(new_parents)
765
@needs_tree_write_lock
766
def set_merge_modified(self, modified_hashes):
768
for file_id, hash in modified_hashes.iteritems():
769
yield Stanza(file_id=file_id, hash=hash)
770
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
772
@needs_tree_write_lock
773
def _put_rio(self, filename, stanzas, header):
774
my_file = rio_file(stanzas, header)
775
self._control_files.put(filename, my_file)
777
@needs_write_lock # because merge pulls data into the branch.
778
def merge_from_branch(self, branch, to_revision=None):
779
"""Merge from a branch into this working tree.
781
:param branch: The branch to merge from.
782
:param to_revision: If non-None, the merge will merge to to_revision,
783
but not beyond it. to_revision does not need to be in the history
784
of the branch when it is supplied. If None, to_revision defaults to
785
branch.last_revision().
787
from bzrlib.merge import Merger, Merge3Merger
788
pb = bzrlib.ui.ui_factory.nested_progress_bar()
790
merger = Merger(self.branch, this_tree=self, pb=pb)
791
merger.pp = ProgressPhase("Merge phase", 5, pb)
792
merger.pp.next_phase()
793
# check that there are no
795
merger.check_basis(check_clean=True, require_commits=False)
796
if to_revision is None:
797
to_revision = branch.last_revision()
798
merger.other_rev_id = to_revision
799
if merger.other_rev_id is None:
800
raise error.NoCommits(branch)
801
self.branch.fetch(branch, last_revision=merger.other_rev_id)
802
merger.other_basis = merger.other_rev_id
803
merger.other_tree = self.branch.repository.revision_tree(
805
merger.pp.next_phase()
807
if merger.base_rev_id == merger.other_rev_id:
808
raise errors.PointlessMerge
809
merger.backup_files = False
810
merger.merge_type = Merge3Merger
811
merger.set_interesting_files(None)
812
merger.show_base = False
813
merger.reprocess = False
814
conflicts = merger.do_merge()
821
def merge_modified(self):
823
hashfile = self._control_files.get('merge-hashes')
824
except errors.NoSuchFile:
828
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
829
raise errors.MergeModifiedFormatError()
830
except StopIteration:
831
raise errors.MergeModifiedFormatError()
832
for s in RioReader(hashfile):
833
file_id = s.get("file_id")
834
if file_id not in self.inventory:
837
if hash == self.get_file_sha1(file_id):
838
merge_hashes[file_id] = hash
842
def mkdir(self, path, file_id=None):
843
"""See MutableTree.mkdir()."""
845
file_id = generate_ids.gen_file_id(os.path.basename(path))
846
os.mkdir(self.abspath(path))
847
self.add(path, file_id, 'directory')
850
def get_symlink_target(self, file_id):
851
return os.readlink(self.id2abspath(file_id))
119
853
def file_class(self, filename):
120
854
if self.path2id(filename):
136
880
Skips the control directory.
138
from osutils import appendpath, file_kind
141
inv = self._inventory
143
def descend(from_dir_relpath, from_dir_id, dp):
882
# list_files is an iterator, so @needs_read_lock doesn't work properly
883
# with it. So callers should be careful to always read_lock the tree.
884
if not self.is_locked():
885
raise errors.ObjectNotLocked(self)
888
if include_root is True:
889
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
890
# Convert these into local objects to save lookup times
891
pathjoin = osutils.pathjoin
892
file_kind = osutils.file_kind
894
# transport.base ends in a slash, we want the piece
895
# between the last two slashes
896
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
898
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
900
# directory file_id, relative path, absolute path, reverse sorted children
901
children = os.listdir(self.basedir)
903
# jam 20060527 The kernel sized tree seems equivalent whether we
904
# use a deque and popleft to keep them sorted, or if we use a plain
905
# list and just reverse() them.
906
children = collections.deque(children)
907
stack = [(inv.root.file_id, u'', self.basedir, children)]
909
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
912
f = children.popleft()
147
913
## TODO: If we find a subdirectory with its own .bzr
148
914
## directory, then that is a separate tree and we
149
915
## should exclude it.
150
if bzrlib.BZRDIR == f:
917
# the bzrdir for this tree
918
if transport_base_dir == f:
154
fp = appendpath(from_dir_relpath, f)
921
# we know that from_dir_relpath and from_dir_abspath never end in a slash
922
# and 'f' doesn't begin with one, we can do a string op, rather
923
# than the checks of pathjoin(), all relative paths will have an extra slash
925
fp = from_dir_relpath + '/' + f
157
fap = appendpath(dp, f)
928
fap = from_dir_abspath + '/' + f
159
930
f_ie = inv.get_child(from_dir_id, f)
162
elif self.is_ignored(fp):
933
elif self.is_ignored(fp[1:]):
936
# we may not have found this file, because of a unicode issue
937
f_norm, can_access = osutils.normalized_filename(f)
938
if f == f_norm or not can_access:
939
# No change, so treat this file normally
942
# this file can be accessed by a normalized path
943
# check again if it is versioned
944
# these lines are repeated here for performance
946
fp = from_dir_relpath + '/' + f
947
fap = from_dir_abspath + '/' + f
948
f_ie = inv.get_child(from_dir_id, f)
951
elif self.is_ignored(fp[1:]):
167
956
fk = file_kind(fap)
170
959
if f_ie.kind != fk:
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)
960
raise errors.BzrCheckError(
961
"file %r entered as kind %r id %r, now of kind %r"
962
% (fap, f_ie.kind, f_ie.file_id, fk))
964
# make a last minute entry
966
yield fp[1:], c, fk, f_ie.file_id, f_ie
969
yield fp[1:], c, fk, None, fk_entries[fk]()
971
yield fp[1:], c, fk, None, TreeEntry()
177
974
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):
977
# But do this child first
978
new_children = os.listdir(fap)
980
new_children = collections.deque(new_children)
981
stack.append((f_ie.file_id, fp, fap, new_children))
982
# Break out of inner loop,
983
# so that we start outer loop with child
986
# if we finished all children, pop it off the stack
989
@needs_tree_write_lock
990
def move(self, from_paths, to_dir=None, after=False, **kwargs):
993
to_dir must exist in the inventory.
995
If to_dir exists and is a directory, the files are moved into
996
it, keeping their old names.
998
Note that to_dir is only the last component of the new name;
999
this doesn't change the directory.
1001
For each entry in from_paths the move mode will be determined
1004
The first mode moves the file in the filesystem and updates the
1005
inventory. The second mode only updates the inventory without
1006
touching the file on the filesystem. This is the new mode introduced
1009
move uses the second mode if 'after == True' and the target is not
1010
versioned but present in the working tree.
1012
move uses the second mode if 'after == False' and the source is
1013
versioned but no longer in the working tree, and the target is not
1014
versioned but present in the working tree.
1016
move uses the first mode if 'after == False' and the source is
1017
versioned and present in the working tree, and the target is not
1018
versioned and not present in the working tree.
1020
Everything else results in an error.
1022
This returns a list of (from_path, to_path) pairs for each
1023
entry that is moved.
1028
# check for deprecated use of signature
1030
to_dir = kwargs.get('to_name', None)
1032
raise TypeError('You must supply a target directory')
1034
symbol_versioning.warn('The parameter to_name was deprecated'
1035
' in version 0.13. Use to_dir instead',
1038
# check destination directory
1039
assert not isinstance(from_paths, basestring)
1040
inv = self.inventory
1041
to_abs = self.abspath(to_dir)
1042
if not isdir(to_abs):
1043
raise errors.BzrMoveFailedError('',to_dir,
1044
errors.NotADirectory(to_abs))
1045
if not self.has_filename(to_dir):
1046
raise errors.BzrMoveFailedError('',to_dir,
1047
errors.NotInWorkingDirectory(to_dir))
1048
to_dir_id = inv.path2id(to_dir)
1049
if to_dir_id is None:
1050
raise errors.BzrMoveFailedError('',to_dir,
1051
errors.NotVersionedError(path=str(to_dir)))
1053
to_dir_ie = inv[to_dir_id]
1054
if to_dir_ie.kind != 'directory':
1055
raise errors.BzrMoveFailedError('',to_dir,
1056
errors.NotADirectory(to_abs))
1058
# create rename entries and tuples
1059
for from_rel in from_paths:
1060
from_tail = splitpath(from_rel)[-1]
1061
from_id = inv.path2id(from_rel)
1063
raise errors.BzrMoveFailedError(from_rel,to_dir,
1064
errors.NotVersionedError(path=str(from_rel)))
1066
from_entry = inv[from_id]
1067
from_parent_id = from_entry.parent_id
1068
to_rel = pathjoin(to_dir, from_tail)
1069
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1071
from_tail=from_tail,
1072
from_parent_id=from_parent_id,
1073
to_rel=to_rel, to_tail=from_tail,
1074
to_parent_id=to_dir_id)
1075
rename_entries.append(rename_entry)
1076
rename_tuples.append((from_rel, to_rel))
1078
# determine which move mode to use. checks also for movability
1079
rename_entries = self._determine_mv_mode(rename_entries, after)
1081
original_modified = self._inventory_is_modified
1084
self._inventory_is_modified = True
1085
self._move(rename_entries)
1087
# restore the inventory on error
1088
self._inventory_is_modified = original_modified
1090
self._write_inventory(inv)
1091
return rename_tuples
1093
def _determine_mv_mode(self, rename_entries, after=False):
1094
"""Determines for each from-to pair if both inventory and working tree
1095
or only the inventory has to be changed.
1097
Also does basic plausability tests.
1099
inv = self.inventory
1101
for rename_entry in rename_entries:
1102
# store to local variables for easier reference
1103
from_rel = rename_entry.from_rel
1104
from_id = rename_entry.from_id
1105
to_rel = rename_entry.to_rel
1106
to_id = inv.path2id(to_rel)
1107
only_change_inv = False
1109
# check the inventory for source and destination
1111
raise errors.BzrMoveFailedError(from_rel,to_rel,
1112
errors.NotVersionedError(path=str(from_rel)))
1113
if to_id is not None:
1114
raise errors.BzrMoveFailedError(from_rel,to_rel,
1115
errors.AlreadyVersionedError(path=str(to_rel)))
1117
# try to determine the mode for rename (only change inv or change
1118
# inv and file system)
1120
if not self.has_filename(to_rel):
1121
raise errors.BzrMoveFailedError(from_id,to_rel,
1122
errors.NoSuchFile(path=str(to_rel),
1123
extra="New file has not been created yet"))
1124
only_change_inv = True
1125
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1126
only_change_inv = True
1127
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1128
only_change_inv = False
1130
# something is wrong, so lets determine what exactly
1131
if not self.has_filename(from_rel) and \
1132
not self.has_filename(to_rel):
1133
raise errors.BzrRenameFailedError(from_rel,to_rel,
1134
errors.PathsDoNotExist(paths=(str(from_rel),
1137
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1138
extra="(Use --after to update the Bazaar id)")
1139
rename_entry.only_change_inv = only_change_inv
1140
return rename_entries
1142
def _move(self, rename_entries):
1143
"""Moves a list of files.
1145
Depending on the value of the flag 'only_change_inv', the
1146
file will be moved on the file system or not.
1148
inv = self.inventory
1151
for entry in rename_entries:
1153
self._move_entry(entry)
1155
self._rollback_move(moved)
1159
def _rollback_move(self, moved):
1160
"""Try to rollback a previous move in case of an filesystem error."""
1161
inv = self.inventory
1164
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1165
entry.to_tail, entry.to_parent_id, entry.from_rel,
1166
entry.from_tail, entry.from_parent_id,
1167
entry.only_change_inv))
1168
except errors.BzrMoveFailedError, e:
1169
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1170
" The working tree is in an inconsistent state."
1171
" Please consider doing a 'bzr revert'."
1172
" Error message is: %s" % e)
1174
def _move_entry(self, entry):
1175
inv = self.inventory
1176
from_rel_abs = self.abspath(entry.from_rel)
1177
to_rel_abs = self.abspath(entry.to_rel)
1178
if from_rel_abs == to_rel_abs:
1179
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1180
"Source and target are identical.")
1182
if not entry.only_change_inv:
1184
osutils.rename(from_rel_abs, to_rel_abs)
1186
raise errors.BzrMoveFailedError(entry.from_rel,
1188
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1190
@needs_tree_write_lock
1191
def rename_one(self, from_rel, to_rel, after=False):
1194
This can change the directory or the filename or both.
1196
rename_one has several 'modes' to work. First, it can rename a physical
1197
file and change the file_id. That is the normal mode. Second, it can
1198
only change the file_id without touching any physical file. This is
1199
the new mode introduced in version 0.15.
1201
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1202
versioned but present in the working tree.
1204
rename_one uses the second mode if 'after == False' and 'from_rel' is
1205
versioned but no longer in the working tree, and 'to_rel' is not
1206
versioned but present in the working tree.
1208
rename_one uses the first mode if 'after == False' and 'from_rel' is
1209
versioned and present in the working tree, and 'to_rel' is not
1210
versioned and not present in the working tree.
1212
Everything else results in an error.
1214
inv = self.inventory
1217
# create rename entries and tuples
1218
from_tail = splitpath(from_rel)[-1]
1219
from_id = inv.path2id(from_rel)
1221
raise errors.BzrRenameFailedError(from_rel,to_rel,
1222
errors.NotVersionedError(path=str(from_rel)))
1223
from_entry = inv[from_id]
1224
from_parent_id = from_entry.parent_id
1225
to_dir, to_tail = os.path.split(to_rel)
1226
to_dir_id = inv.path2id(to_dir)
1227
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1229
from_tail=from_tail,
1230
from_parent_id=from_parent_id,
1231
to_rel=to_rel, to_tail=to_tail,
1232
to_parent_id=to_dir_id)
1233
rename_entries.append(rename_entry)
1235
# determine which move mode to use. checks also for movability
1236
rename_entries = self._determine_mv_mode(rename_entries, after)
1238
# check if the target changed directory and if the target directory is
1240
if to_dir_id is None:
1241
raise errors.BzrMoveFailedError(from_rel,to_rel,
1242
errors.NotVersionedError(path=str(to_dir)))
1244
# all checks done. now we can continue with our actual work
1245
mutter('rename_one:\n'
1250
' to_dir_id {%s}\n',
1251
from_id, from_rel, to_rel, to_dir, to_dir_id)
1253
self._move(rename_entries)
1254
self._write_inventory(inv)
1256
class _RenameEntry(object):
1257
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1258
to_rel, to_tail, to_parent_id, only_change_inv=False):
1259
self.from_rel = from_rel
1260
self.from_id = from_id
1261
self.from_tail = from_tail
1262
self.from_parent_id = from_parent_id
1263
self.to_rel = to_rel
1264
self.to_tail = to_tail
1265
self.to_parent_id = to_parent_id
1266
self.only_change_inv = only_change_inv
192
1269
def unknowns(self):
193
for subp in self.extras():
194
if not self.is_ignored(subp):
1270
"""Return all unknown files.
1272
These are files in the working directory that are not versioned or
1273
control files or ignored.
1275
# force the extras method to be fully executed before returning, to
1276
# prevent race conditions with the lock
1278
[subp for subp in self.extras() if not self.is_ignored(subp)])
1280
@needs_tree_write_lock
1281
def unversion(self, file_ids):
1282
"""Remove the file ids in file_ids from the current versioned set.
1284
When a file_id is unversioned, all of its children are automatically
1287
:param file_ids: The file ids to stop versioning.
1288
:raises: NoSuchId if any fileid is not currently versioned.
1290
for file_id in file_ids:
1291
if self._inventory.has_id(file_id):
1292
self._inventory.remove_recursive_id(file_id)
1294
raise errors.NoSuchId(self, file_id)
1296
# in the future this should just set a dirty bit to wait for the
1297
# final unlock. However, until all methods of workingtree start
1298
# with the current in -memory inventory rather than triggering
1299
# a read, it is more complex - we need to teach read_inventory
1300
# to know when to read, and when to not read first... and possibly
1301
# to save first when the in memory one may be corrupted.
1302
# so for now, we just only write it if it is indeed dirty.
1304
self._write_inventory(self._inventory)
1306
@deprecated_method(zero_eight)
1307
def iter_conflicts(self):
1308
"""List all files in the tree that have text or content conflicts.
1309
DEPRECATED. Use conflicts instead."""
1310
return self._iter_conflicts()
1312
def _iter_conflicts(self):
1314
for info in self.list_files():
1316
stem = get_conflicted_stem(path)
1319
if stem not in conflicted:
1320
conflicted.add(stem)
1324
def pull(self, source, overwrite=False, stop_revision=None):
1325
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1328
pp = ProgressPhase("Pull phase", 2, top_pb)
1330
old_revision_history = self.branch.revision_history()
1331
basis_tree = self.basis_tree()
1332
count = self.branch.pull(source, overwrite, stop_revision)
1333
new_revision_history = self.branch.revision_history()
1334
if new_revision_history != old_revision_history:
1336
if len(old_revision_history):
1337
other_revision = old_revision_history[-1]
1339
other_revision = None
1340
repository = self.branch.repository
1341
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1342
basis_tree.lock_read()
1344
new_basis_tree = self.branch.basis_tree()
1351
if (basis_tree.inventory.root is None and
1352
new_basis_tree.inventory.root is not None):
1353
self.set_root_id(new_basis_tree.inventory.root.file_id)
1357
# TODO - dedup parents list with things merged by pull ?
1358
# reuse the revisiontree we merged against to set the new
1360
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1361
# we have to pull the merge trees out again, because
1362
# merge_inner has set the ids. - this corner is not yet
1363
# layered well enough to prevent double handling.
1364
# XXX TODO: Fix the double handling: telling the tree about
1365
# the already known parent data is wasteful.
1366
merges = self.get_parent_ids()[1:]
1367
parent_trees.extend([
1368
(parent, repository.revision_tree(parent)) for
1370
self.set_parent_trees(parent_trees)
1377
def put_file_bytes_non_atomic(self, file_id, bytes):
1378
"""See MutableTree.put_file_bytes_non_atomic."""
1379
stream = file(self.id2abspath(file_id), 'wb')
1384
# TODO: update the hashcache here ?
198
1386
def extras(self):
199
1387
"""Yield all unknown files in this WorkingTree.
259
1459
If the file is ignored, returns the pattern which caused it to
260
1460
be ignored, otherwise None. So this can simply be used as a
261
1461
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] == '.\\'):
1462
if getattr(self, '_ignoreglobster', None) is None:
1463
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1464
return self._ignoreglobster.match(filename)
1466
def kind(self, file_id):
1467
return file_kind(self.id2abspath(file_id))
1469
def _comparison_data(self, entry, path):
1470
abspath = self.abspath(path)
1472
stat_value = os.lstat(abspath)
1474
if getattr(e, 'errno', None) == errno.ENOENT:
1481
mode = stat_value.st_mode
1482
kind = osutils.file_kind_from_stat_mode(mode)
1483
if not supports_executable():
1484
executable = entry.executable
1486
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1487
return kind, executable, stat_value
1489
def _file_size(self, entry, stat_value):
1490
return stat_value.st_size
1492
def last_revision(self):
1493
"""Return the last revision of the branch for this tree.
1495
This format tree does not support a separate marker for last-revision
1496
compared to the branch.
1498
See MutableTree.last_revision
1500
return self._last_revision()
1503
def _last_revision(self):
1504
"""helper for get_parent_ids."""
1505
return self.branch.last_revision()
1507
def is_locked(self):
1508
return self._control_files.is_locked()
1510
def lock_read(self):
1511
"""See Branch.lock_read, and WorkingTree.unlock."""
1512
self.branch.lock_read()
1514
return self._control_files.lock_read()
1516
self.branch.unlock()
1519
def lock_tree_write(self):
1520
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1521
self.branch.lock_read()
1523
return self._control_files.lock_write()
1525
self.branch.unlock()
1528
def lock_write(self):
1529
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1530
self.branch.lock_write()
1532
return self._control_files.lock_write()
1534
self.branch.unlock()
1537
def get_physical_lock_status(self):
1538
return self._control_files.get_physical_lock_status()
1540
def _basis_inventory_name(self):
1541
return 'basis-inventory-cache'
1543
@needs_tree_write_lock
1544
def set_last_revision(self, new_revision):
1545
"""Change the last revision in the working tree."""
1546
if self._change_last_revision(new_revision):
1547
self._cache_basis_inventory(new_revision)
1549
def _change_last_revision(self, new_revision):
1550
"""Template method part of set_last_revision to perform the change.
1552
This is used to allow WorkingTree3 instances to not affect branch
1553
when their last revision is set.
1555
if new_revision is None:
1556
self.branch.set_revision_history([])
1559
self.branch.generate_revision_history(new_revision)
1560
except errors.NoSuchRevision:
1561
# not present in the repo - dont try to set it deeper than the tip
1562
self.branch.set_revision_history([new_revision])
1565
def _write_basis_inventory(self, xml):
1566
"""Write the basis inventory XML to the basis-inventory file"""
1567
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1568
path = self._basis_inventory_name()
1570
self._control_files.put(path, sio)
1572
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1573
"""Create the text that will be saved in basis-inventory"""
1574
inventory.revision_id = revision_id
1575
return xml6.serializer_v6.write_inventory_to_string(inventory)
1577
def _cache_basis_inventory(self, new_revision):
1578
"""Cache new_revision as the basis inventory."""
1579
# TODO: this should allow the ready-to-use inventory to be passed in,
1580
# as commit already has that ready-to-use [while the format is the
1583
# this double handles the inventory - unpack and repack -
1584
# but is easier to understand. We can/should put a conditional
1585
# in here based on whether the inventory is in the latest format
1586
# - perhaps we should repack all inventories on a repository
1588
# the fast path is to copy the raw xml from the repository. If the
1589
# xml contains 'revision_id="', then we assume the right
1590
# revision_id is set. We must check for this full string, because a
1591
# root node id can legitimately look like 'revision_id' but cannot
1593
xml = self.branch.repository.get_inventory_xml(new_revision)
1594
firstline = xml.split('\n', 1)[0]
1595
if (not 'revision_id="' in firstline or
1596
'format="6"' not in firstline):
1597
inv = self.branch.repository.deserialise_inventory(
1599
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1600
self._write_basis_inventory(xml)
1601
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1604
def read_basis_inventory(self):
1605
"""Read the cached basis inventory."""
1606
path = self._basis_inventory_name()
1607
return self._control_files.get(path).read()
1610
def read_working_inventory(self):
1611
"""Read the working inventory.
1613
:raises errors.InventoryModified: read_working_inventory will fail
1614
when the current in memory inventory has been modified.
1616
# conceptually this should be an implementation detail of the tree.
1617
# XXX: Deprecate this.
1618
# ElementTree does its own conversion from UTF-8, so open in
1620
if self._inventory_is_modified:
1621
raise errors.InventoryModified(self)
1622
result = xml5.serializer_v5.read_inventory(
1623
self._control_files.get('inventory'))
1624
self._set_inventory(result, dirty=False)
1627
@needs_tree_write_lock
1628
def remove(self, files, verbose=False, to_file=None):
1629
"""Remove nominated files from the working inventory..
1631
This does not remove their text. This does not run on XXX on what? RBC
1633
TODO: Refuse to remove modified files unless --force is given?
1635
TODO: Do something useful with directories.
1637
TODO: Should this remove the text or not? Tough call; not
1638
removing may be useful and the user can just use use rm, and
1639
is the opposite of add. Removing it is consistent with most
1640
other tools. Maybe an option.
1642
## TODO: Normalize names
1643
## TODO: Remove nested loops; better scalability
1644
if isinstance(files, basestring):
1647
inv = self.inventory
1649
# do this before any modifications
1651
fid = inv.path2id(f)
1653
# TODO: Perhaps make this just a warning, and continue?
1654
# This tends to happen when
1655
raise errors.NotVersionedError(path=f)
1657
# having remove it, it must be either ignored or unknown
1658
if self.is_ignored(f):
286
if fnmatch.fnmatchcase(filename, newpat):
289
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1662
textui.show_status(new_status, inv[fid].kind, f,
1666
self._write_inventory(inv)
1668
@needs_tree_write_lock
1669
def revert(self, filenames, old_tree=None, backups=True,
1670
pb=DummyProgress(), report_changes=False):
1671
from bzrlib.conflicts import resolve
1672
if old_tree is None:
1673
old_tree = self.basis_tree()
1674
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1676
if not len(filenames):
1677
self.set_parent_ids(self.get_parent_ids()[:1])
1680
resolve(self, filenames, ignore_misses=True)
1683
def revision_tree(self, revision_id):
1684
"""See Tree.revision_tree.
1686
WorkingTree can supply revision_trees for the basis revision only
1687
because there is only one cached inventory in the bzr directory.
1689
if revision_id == self.last_revision():
1691
xml = self.read_basis_inventory()
1692
except errors.NoSuchFile:
1696
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1697
# dont use the repository revision_tree api because we want
1698
# to supply the inventory.
1699
if inv.revision_id == revision_id:
1700
return revisiontree.RevisionTree(self.branch.repository,
1702
except errors.BadInventoryFormat:
1704
# raise if there was no inventory, or if we read the wrong inventory.
1705
raise errors.NoSuchRevisionInTree(self, revision_id)
1707
# XXX: This method should be deprecated in favour of taking in a proper
1708
# new Inventory object.
1709
@needs_tree_write_lock
1710
def set_inventory(self, new_inventory_list):
1711
from bzrlib.inventory import (Inventory,
1716
inv = Inventory(self.get_root_id())
1717
for path, file_id, parent, kind in new_inventory_list:
1718
name = os.path.basename(path)
1721
# fixme, there should be a factory function inv,add_??
1722
if kind == 'directory':
1723
inv.add(InventoryDirectory(file_id, name, parent))
1724
elif kind == 'file':
1725
inv.add(InventoryFile(file_id, name, parent))
1726
elif kind == 'symlink':
1727
inv.add(InventoryLink(file_id, name, parent))
1729
raise errors.BzrError("unknown kind %r" % kind)
1730
self._write_inventory(inv)
1732
@needs_tree_write_lock
1733
def set_root_id(self, file_id):
1734
"""Set the root id for this tree."""
1737
symbol_versioning.warn(symbol_versioning.zero_twelve
1738
% 'WorkingTree.set_root_id with fileid=None',
1742
self._set_root_id(file_id)
1744
def _set_root_id(self, file_id):
1745
"""Set the root id for this tree, in a format specific manner.
1747
:param file_id: The file id to assign to the root. It must not be
1748
present in the current inventory or an error will occur. It must
1749
not be None, but rather a valid file id.
1751
inv = self._inventory
1752
orig_root_id = inv.root.file_id
1753
# TODO: it might be nice to exit early if there was nothing
1754
# to do, saving us from trigger a sync on unlock.
1755
self._inventory_is_modified = True
1756
# we preserve the root inventory entry object, but
1757
# unlinkit from the byid index
1758
del inv._byid[inv.root.file_id]
1759
inv.root.file_id = file_id
1760
# and link it into the index with the new changed id.
1761
inv._byid[inv.root.file_id] = inv.root
1762
# and finally update all children to reference the new id.
1763
# XXX: this should be safe to just look at the root.children
1764
# list, not the WHOLE INVENTORY.
1767
if entry.parent_id == orig_root_id:
1768
entry.parent_id = inv.root.file_id
1771
"""See Branch.unlock.
1773
WorkingTree locking just uses the Branch locking facilities.
1774
This is current because all working trees have an embedded branch
1775
within them. IF in the future, we were to make branch data shareable
1776
between multiple working trees, i.e. via shared storage, then we
1777
would probably want to lock both the local tree, and the branch.
1779
raise NotImplementedError(self.unlock)
1782
"""Update a working tree along its branch.
1784
This will update the branch if its bound too, which means we have
1785
multiple trees involved:
1787
- The new basis tree of the master.
1788
- The old basis tree of the branch.
1789
- The old basis tree of the working tree.
1790
- The current working tree state.
1792
Pathologically, all three may be different, and non-ancestors of each
1793
other. Conceptually we want to:
1795
- Preserve the wt.basis->wt.state changes
1796
- Transform the wt.basis to the new master basis.
1797
- Apply a merge of the old branch basis to get any 'local' changes from
1799
- Restore the wt.basis->wt.state changes.
1801
There isn't a single operation at the moment to do that, so we:
1802
- Merge current state -> basis tree of the master w.r.t. the old tree
1804
- Do a 'normal' merge of the old branch basis if it is relevant.
1806
if self.branch.get_master_branch() is not None:
1808
update_branch = True
1810
self.lock_tree_write()
1811
update_branch = False
1814
old_tip = self.branch.update()
1817
return self._update_tree(old_tip)
1821
@needs_tree_write_lock
1822
def _update_tree(self, old_tip=None):
1823
"""Update a tree to the master branch.
1825
:param old_tip: if supplied, the previous tip revision the branch,
1826
before it was changed to the master branch's tip.
1828
# here if old_tip is not None, it is the old tip of the branch before
1829
# it was updated from the master branch. This should become a pending
1830
# merge in the working tree to preserve the user existing work. we
1831
# cant set that until we update the working trees last revision to be
1832
# one from the new branch, because it will just get absorbed by the
1833
# parent de-duplication logic.
1835
# We MUST save it even if an error occurs, because otherwise the users
1836
# local work is unreferenced and will appear to have been lost.
1840
last_rev = self.get_parent_ids()[0]
1843
if last_rev != self.branch.last_revision():
1844
# merge tree state up to new branch tip.
1845
basis = self.basis_tree()
1848
to_tree = self.branch.basis_tree()
1849
if basis.inventory.root is None:
1850
self.set_root_id(to_tree.inventory.root.file_id)
1851
result += merge.merge_inner(
1858
# TODO - dedup parents list with things merged by pull ?
1859
# reuse the tree we've updated to to set the basis:
1860
parent_trees = [(self.branch.last_revision(), to_tree)]
1861
merges = self.get_parent_ids()[1:]
1862
# Ideally we ask the tree for the trees here, that way the working
1863
# tree can decide whether to give us teh entire tree or give us a
1864
# lazy initialised tree. dirstate for instance will have the trees
1865
# in ram already, whereas a last-revision + basis-inventory tree
1866
# will not, but also does not need them when setting parents.
1867
for parent in merges:
1868
parent_trees.append(
1869
(parent, self.branch.repository.revision_tree(parent)))
1870
if old_tip is not None:
1871
parent_trees.append(
1872
(old_tip, self.branch.repository.revision_tree(old_tip)))
1873
self.set_parent_trees(parent_trees)
1874
last_rev = parent_trees[0][0]
1876
# the working tree had the same last-revision as the master
1877
# branch did. We may still have pivot local work from the local
1878
# branch into old_tip:
1879
if old_tip is not None:
1880
self.add_parent_tree_id(old_tip)
1881
if old_tip and old_tip != last_rev:
1882
# our last revision was not the prior branch last revision
1883
# and we have converted that last revision to a pending merge.
1884
# base is somewhere between the branch tip now
1885
# and the now pending merge
1887
# Since we just modified the working tree and inventory, flush out
1888
# the current state, before we modify it again.
1889
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
1890
# requires it only because TreeTransform directly munges the
1891
# inventory and calls tree._write_inventory(). Ultimately we
1892
# should be able to remove this extra flush.
1894
from bzrlib.revision import common_ancestor
1896
base_rev_id = common_ancestor(self.branch.last_revision(),
1898
self.branch.repository)
1899
except errors.NoCommonAncestor:
1901
base_tree = self.branch.repository.revision_tree(base_rev_id)
1902
other_tree = self.branch.repository.revision_tree(old_tip)
1903
result += merge.merge_inner(
1910
def _write_hashcache_if_dirty(self):
1911
"""Write out the hashcache if it is dirty."""
1912
if self._hashcache.needs_write:
1914
self._hashcache.write()
1916
if e.errno not in (errno.EPERM, errno.EACCES):
1918
# TODO: jam 20061219 Should this be a warning? A single line
1919
# warning might be sufficient to let the user know what
1921
mutter('Could not write hashcache for %s\nError: %s',
1922
self._hashcache.cache_file_name(), e)
1924
@needs_tree_write_lock
1925
def _write_inventory(self, inv):
1926
"""Write inventory as the current inventory."""
1927
self._set_inventory(inv, dirty=True)
1930
def set_conflicts(self, arg):
1931
raise errors.UnsupportedOperation(self.set_conflicts, self)
1933
def add_conflicts(self, arg):
1934
raise errors.UnsupportedOperation(self.add_conflicts, self)
1937
def conflicts(self):
1938
conflicts = _mod_conflicts.ConflictList()
1939
for conflicted in self._iter_conflicts():
1942
if file_kind(self.abspath(conflicted)) != "file":
1944
except errors.NoSuchFile:
1947
for suffix in ('.THIS', '.OTHER'):
1949
kind = file_kind(self.abspath(conflicted+suffix))
1952
except errors.NoSuchFile:
1956
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1957
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1959
file_id=self.path2id(conflicted)))
1962
def walkdirs(self, prefix=""):
1963
"""Walk the directories of this tree.
1965
This API returns a generator, which is only valid during the current
1966
tree transaction - within a single lock_read or lock_write duration.
1968
If the tree is not locked, it may cause an error to be raised, depending
1969
on the tree implementation.
1971
disk_top = self.abspath(prefix)
1972
if disk_top.endswith('/'):
1973
disk_top = disk_top[:-1]
1974
top_strip_len = len(disk_top) + 1
1975
inventory_iterator = self._walkdirs(prefix)
1976
disk_iterator = osutils.walkdirs(disk_top, prefix)
1978
current_disk = disk_iterator.next()
1979
disk_finished = False
1981
if e.errno != errno.ENOENT:
1984
disk_finished = True
1986
current_inv = inventory_iterator.next()
1987
inv_finished = False
1988
except StopIteration:
1991
while not inv_finished or not disk_finished:
1992
if not disk_finished:
1993
# strip out .bzr dirs
1994
if current_disk[0][1][top_strip_len:] == '':
1995
# osutils.walkdirs can be made nicer -
1996
# yield the path-from-prefix rather than the pathjoined
1998
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
1999
if current_disk[1][bzrdir_loc][0] == '.bzr':
2000
# we dont yield the contents of, or, .bzr itself.
2001
del current_disk[1][bzrdir_loc]
2003
# everything is unknown
2006
# everything is missing
2009
direction = cmp(current_inv[0][0], current_disk[0][0])
2011
# disk is before inventory - unknown
2012
dirblock = [(relpath, basename, kind, stat, None, None) for
2013
relpath, basename, kind, stat, top_path in current_disk[1]]
2014
yield (current_disk[0][0], None), dirblock
2016
current_disk = disk_iterator.next()
2017
except StopIteration:
2018
disk_finished = True
2020
# inventory is before disk - missing.
2021
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2022
for relpath, basename, dkind, stat, fileid, kind in
2024
yield (current_inv[0][0], current_inv[0][1]), dirblock
2026
current_inv = inventory_iterator.next()
2027
except StopIteration:
2030
# versioned present directory
2031
# merge the inventory and disk data together
2033
for relpath, subiterator in itertools.groupby(sorted(
2034
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2035
path_elements = list(subiterator)
2036
if len(path_elements) == 2:
2037
inv_row, disk_row = path_elements
2038
# versioned, present file
2039
dirblock.append((inv_row[0],
2040
inv_row[1], disk_row[2],
2041
disk_row[3], inv_row[4],
2043
elif len(path_elements[0]) == 5:
2045
dirblock.append((path_elements[0][0],
2046
path_elements[0][1], path_elements[0][2],
2047
path_elements[0][3], None, None))
2048
elif len(path_elements[0]) == 6:
2049
# versioned, absent file.
2050
dirblock.append((path_elements[0][0],
2051
path_elements[0][1], 'unknown', None,
2052
path_elements[0][4], path_elements[0][5]))
2054
raise NotImplementedError('unreachable code')
2055
yield current_inv[0], dirblock
2057
current_inv = inventory_iterator.next()
2058
except StopIteration:
2061
current_disk = disk_iterator.next()
2062
except StopIteration:
2063
disk_finished = True
2065
def _walkdirs(self, prefix=""):
2066
_directory = 'directory'
2067
# get the root in the inventory
2068
inv = self.inventory
2069
top_id = inv.path2id(prefix)
2073
pending = [(prefix, '', _directory, None, top_id, None)]
2076
currentdir = pending.pop()
2077
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2078
top_id = currentdir[4]
2080
relroot = currentdir[0] + '/'
2083
# FIXME: stash the node in pending
2085
for name, child in entry.sorted_children():
2086
dirblock.append((relroot + name, name, child.kind, None,
2087
child.file_id, child.kind
2089
yield (currentdir[0], entry.file_id), dirblock
2090
# push the user specified dirs from dirblock
2091
for dir in reversed(dirblock):
2092
if dir[2] == _directory:
2096
class WorkingTree2(WorkingTree):
2097
"""This is the Format 2 working tree.
2099
This was the first weave based working tree.
2100
- uses os locks for locking.
2101
- uses the branch last-revision.
2104
def lock_tree_write(self):
2105
"""See WorkingTree.lock_tree_write().
2107
In Format2 WorkingTrees we have a single lock for the branch and tree
2108
so lock_tree_write() degrades to lock_write().
2110
self.branch.lock_write()
2112
return self._control_files.lock_write()
2114
self.branch.unlock()
2118
# we share control files:
2119
if self._control_files._lock_count == 3:
2120
# _inventory_is_modified is always False during a read lock.
2121
if self._inventory_is_modified:
2123
self._write_hashcache_if_dirty()
2125
# reverse order of locking.
2127
return self._control_files.unlock()
2129
self.branch.unlock()
2132
class WorkingTree3(WorkingTree):
2133
"""This is the Format 3 working tree.
2135
This differs from the base WorkingTree by:
2136
- having its own file lock
2137
- having its own last-revision property.
2139
This is new in bzr 0.8
2143
def _last_revision(self):
2144
"""See Mutable.last_revision."""
2146
return self._control_files.get_utf8('last-revision').read()
2147
except errors.NoSuchFile:
b'\\ No newline at end of file'
2150
def _change_last_revision(self, revision_id):
2151
"""See WorkingTree._change_last_revision."""
2152
if revision_id is None or revision_id == NULL_REVISION:
2154
self._control_files._transport.delete('last-revision')
2155
except errors.NoSuchFile:
2159
self._control_files.put_utf8('last-revision', revision_id)
2162
@needs_tree_write_lock
2163
def set_conflicts(self, conflicts):
2164
self._put_rio('conflicts', conflicts.to_stanzas(),
2167
@needs_tree_write_lock
2168
def add_conflicts(self, new_conflicts):
2169
conflict_set = set(self.conflicts())
2170
conflict_set.update(set(list(new_conflicts)))
2171
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2172
key=_mod_conflicts.Conflict.sort_key)))
2175
def conflicts(self):
2177
confile = self._control_files.get('conflicts')
2178
except errors.NoSuchFile:
2179
return _mod_conflicts.ConflictList()
2181
if confile.next() != CONFLICT_HEADER_1 + '\n':
2182
raise errors.ConflictFormatError()
2183
except StopIteration:
2184
raise errors.ConflictFormatError()
2185
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2188
if self._control_files._lock_count == 1:
2189
# _inventory_is_modified is always False during a read lock.
2190
if self._inventory_is_modified:
2192
self._write_hashcache_if_dirty()
2193
# reverse order of locking.
2195
return self._control_files.unlock()
2197
self.branch.unlock()
2200
def get_conflicted_stem(path):
2201
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2202
if path.endswith(suffix):
2203
return path[:-len(suffix)]
2206
@deprecated_function(zero_eight)
2207
def is_control_file(filename):
2208
"""See WorkingTree.is_control_filename(filename)."""
2209
## FIXME: better check
2210
filename = normpath(filename)
2211
while filename != '':
2212
head, tail = os.path.split(filename)
2213
## mutter('check %r for control file' % ((head, tail),))
2216
if filename == head:
2222
class WorkingTreeFormat(object):
2223
"""An encapsulation of the initialization and open routines for a format.
2225
Formats provide three things:
2226
* An initialization routine,
2230
Formats are placed in an dict by their format string for reference
2231
during workingtree opening. Its not required that these be instances, they
2232
can be classes themselves with class methods - it simply depends on
2233
whether state is needed for a given format or not.
2235
Once a format is deprecated, just deprecate the initialize and open
2236
methods on the format class. Do not deprecate the object, as the
2237
object will be created every time regardless.
2240
_default_format = None
2241
"""The default format used for new trees."""
2244
"""The known formats."""
2247
def find_format(klass, a_bzrdir):
2248
"""Return the format for the working tree object in a_bzrdir."""
2250
transport = a_bzrdir.get_workingtree_transport(None)
2251
format_string = transport.get("format").read()
2252
return klass._formats[format_string]
2253
except errors.NoSuchFile:
2254
raise errors.NoWorkingTree(base=transport.base)
2256
raise errors.UnknownFormatError(format=format_string)
2259
def get_default_format(klass):
2260
"""Return the current default format."""
2261
return klass._default_format
2263
def get_format_string(self):
2264
"""Return the ASCII format string that identifies this format."""
2265
raise NotImplementedError(self.get_format_string)
2267
def get_format_description(self):
2268
"""Return the short description for this format."""
2269
raise NotImplementedError(self.get_format_description)
2271
def is_supported(self):
2272
"""Is this format supported?
2274
Supported formats can be initialized and opened.
2275
Unsupported formats may not support initialization or committing or
2276
some other features depending on the reason for not being supported.
2281
def register_format(klass, format):
2282
klass._formats[format.get_format_string()] = format
2285
def set_default_format(klass, format):
2286
klass._default_format = format
2289
def unregister_format(klass, format):
2290
assert klass._formats[format.get_format_string()] is format
2291
del klass._formats[format.get_format_string()]
2295
class WorkingTreeFormat2(WorkingTreeFormat):
2296
"""The second working tree format.
2298
This format modified the hash cache from the format 1 hash cache.
2301
def get_format_description(self):
2302
"""See WorkingTreeFormat.get_format_description()."""
2303
return "Working tree format 2"
2305
def stub_initialize_remote(self, control_files):
2306
"""As a special workaround create critical control files for a remote working tree
2308
This ensures that it can later be updated and dealt with locally,
2309
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2310
no working tree. (See bug #43064).
2314
xml5.serializer_v5.write_inventory(inv, sio)
2316
control_files.put('inventory', sio)
2318
control_files.put_utf8('pending-merges', '')
2321
def initialize(self, a_bzrdir, revision_id=None):
2322
"""See WorkingTreeFormat.initialize()."""
2323
if not isinstance(a_bzrdir.transport, LocalTransport):
2324
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2325
branch = a_bzrdir.open_branch()
2326
if revision_id is not None:
2329
revision_history = branch.revision_history()
2331
position = revision_history.index(revision_id)
2333
raise errors.NoSuchRevision(branch, revision_id)
2334
branch.set_revision_history(revision_history[:position + 1])
2337
revision = branch.last_revision()
2339
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2345
basis_tree = branch.repository.revision_tree(revision)
2346
if basis_tree.inventory.root is not None:
2347
wt.set_root_id(basis_tree.inventory.root.file_id)
2348
# set the parent list and cache the basis tree.
2349
wt.set_parent_trees([(revision, basis_tree)])
2350
transform.build_tree(basis_tree, wt)
2354
super(WorkingTreeFormat2, self).__init__()
2355
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2357
def open(self, a_bzrdir, _found=False):
2358
"""Return the WorkingTree object for a_bzrdir
2360
_found is a private parameter, do not use it. It is used to indicate
2361
if format probing has already been done.
2364
# we are being called directly and must probe.
2365
raise NotImplementedError
2366
if not isinstance(a_bzrdir.transport, LocalTransport):
2367
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2368
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2374
class WorkingTreeFormat3(WorkingTreeFormat):
2375
"""The second working tree format updated to record a format marker.
2378
- exists within a metadir controlling .bzr
2379
- includes an explicit version marker for the workingtree control
2380
files, separate from the BzrDir format
2381
- modifies the hash cache format
2383
- uses a LockDir to guard access for writes.
2386
def get_format_string(self):
2387
"""See WorkingTreeFormat.get_format_string()."""
2388
return "Bazaar-NG Working Tree format 3"
2390
def get_format_description(self):
2391
"""See WorkingTreeFormat.get_format_description()."""
2392
return "Working tree format 3"
2394
_lock_file_name = 'lock'
2395
_lock_class = LockDir
2397
def _open_control_files(self, a_bzrdir):
2398
transport = a_bzrdir.get_workingtree_transport(None)
2399
return LockableFiles(transport, self._lock_file_name,
2402
def initialize(self, a_bzrdir, revision_id=None):
2403
"""See WorkingTreeFormat.initialize().
2405
revision_id allows creating a working tree at a different
2406
revision than the branch is at.
2408
if not isinstance(a_bzrdir.transport, LocalTransport):
2409
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2410
transport = a_bzrdir.get_workingtree_transport(self)
2411
control_files = self._open_control_files(a_bzrdir)
2412
control_files.create_lock()
2413
control_files.lock_write()
2414
control_files.put_utf8('format', self.get_format_string())
2415
branch = a_bzrdir.open_branch()
2416
if revision_id is None:
2417
revision_id = branch.last_revision()
2418
# WorkingTree3 can handle an inventory which has a unique root id.
2419
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2420
# those trees. And because there isn't a format bump inbetween, we
2421
# are maintaining compatibility with older clients.
2422
# inv = Inventory(root_id=gen_root_id())
2424
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2430
_control_files=control_files)
2431
wt.lock_tree_write()
2433
basis_tree = branch.repository.revision_tree(revision_id)
2434
# only set an explicit root id if there is one to set.
2435
if basis_tree.inventory.root is not None:
2436
wt.set_root_id(basis_tree.inventory.root.file_id)
2437
if revision_id == NULL_REVISION:
2438
wt.set_parent_trees([])
2440
wt.set_parent_trees([(revision_id, basis_tree)])
2441
transform.build_tree(basis_tree, wt)
2443
# Unlock in this order so that the unlock-triggers-flush in
2444
# WorkingTree is given a chance to fire.
2445
control_files.unlock()
2450
super(WorkingTreeFormat3, self).__init__()
2451
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2453
def open(self, a_bzrdir, _found=False):
2454
"""Return the WorkingTree object for a_bzrdir
2456
_found is a private parameter, do not use it. It is used to indicate
2457
if format probing has already been done.
2460
# we are being called directly and must probe.
2461
raise NotImplementedError
2462
if not isinstance(a_bzrdir.transport, LocalTransport):
2463
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2464
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2466
def _open(self, a_bzrdir, control_files):
2467
"""Open the tree itself.
2469
:param a_bzrdir: the dir for the tree.
2470
:param control_files: the control files for the tree.
2472
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2476
_control_files=control_files)
2479
return self.get_format_string()
2482
__default_format = WorkingTreeFormat3()
2483
WorkingTreeFormat.register_format(__default_format)
2484
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2485
WorkingTreeFormat.set_default_format(__default_format)
2486
# formats which have no format string are not discoverable
2487
# and not independently creatable, so are not registered.
2488
_legacy_formats = [WorkingTreeFormat2(),
2492
class WorkingTreeTestProviderAdapter(object):
2493
"""A tool to generate a suite testing multiple workingtree formats at once.
2495
This is done by copying the test once for each transport and injecting
2496
the transport_server, transport_readonly_server, and workingtree_format
2497
classes into each copy. Each copy is also given a new id() to make it
2501
def __init__(self, transport_server, transport_readonly_server, formats):
2502
self._transport_server = transport_server
2503
self._transport_readonly_server = transport_readonly_server
2504
self._formats = formats
2506
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2507
"""Clone test for adaption."""
2508
new_test = deepcopy(test)
2509
new_test.transport_server = self._transport_server
2510
new_test.transport_readonly_server = self._transport_readonly_server
2511
new_test.bzrdir_format = bzrdir_format
2512
new_test.workingtree_format = workingtree_format
2513
def make_new_test_id():
2514
new_id = "%s(%s)" % (test.id(), variation)
2515
return lambda: new_id
2516
new_test.id = make_new_test_id()
2519
def adapt(self, test):
2520
from bzrlib.tests import TestSuite
2521
result = TestSuite()
2522
for workingtree_format, bzrdir_format in self._formats:
2523
new_test = self._clone_test(
2526
workingtree_format, workingtree_format.__class__.__name__)
2527
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
