359
46
and the working file exists.
361
48
inv = self._inventory
362
for path, ie in inv.iter_entries():
363
if osutils.lexists(self.abspath(path)):
49
for file_id in self._inventory:
50
# TODO: This is slightly redundant; we should be able to just
51
# check the statcache but it only includes regular files.
52
# only include files which still exist on disk
55
if ((file_id in self._statcache)
56
or (os.path.exists(self.abspath(inv.id2path(file_id))))):
366
61
def __repr__(self):
367
62
return "<%s of %s>" % (self.__class__.__name__,
368
getattr(self, 'basedir', None))
370
65
def abspath(self, 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)
66
return os.path.join(self.basedir, filename)
450
68
def has_filename(self, filename):
451
return osutils.lexists(self.abspath(filename))
69
return os.path.exists(self.abspath(filename))
453
71
def get_file(self, file_id):
454
file_id = osutils.safe_file_id(file_id)
455
72
return self.get_file_byname(self.id2path(file_id))
457
def get_file_text(self, file_id):
458
file_id = osutils.safe_file_id(file_id)
459
return self.get_file(file_id).read()
461
74
def get_file_byname(self, filename):
462
75
return file(self.abspath(filename), 'rb')
465
def annotate_iter(self, file_id):
466
"""See Tree.annotate_iter
468
This implementation will use the basis tree implementation if possible.
469
Lines not in the basis are attributed to CURRENT_REVISION
471
If there are pending merges, lines added by those merges will be
472
incorrectly attributed to CURRENT_REVISION (but after committing, the
473
attribution will be correct).
475
file_id = osutils.safe_file_id(file_id)
476
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
478
require_versioned=True).next()
479
changed_content, kind = changes[2], changes[6]
480
if not changed_content:
481
return basis.annotate_iter(file_id)
485
if kind[0] != 'file':
488
old_lines = list(basis.annotate_iter(file_id))
490
for tree in self.branch.repository.revision_trees(
491
self.get_parent_ids()[1:]):
492
if file_id not in tree:
494
old.append(list(tree.annotate_iter(file_id)))
495
return annotate.reannotate(old, self.get_file(file_id).readlines(),
498
def get_parent_ids(self):
499
"""See Tree.get_parent_ids.
501
This implementation reads the pending merges list and last_revision
502
value and uses that to decide what the parents list should be.
504
last_rev = self._last_revision()
510
merges_file = self._control_files.get('pending-merges')
511
except errors.NoSuchFile:
514
for l in merges_file.readlines():
515
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
516
parents.append(revision_id)
520
def get_root_id(self):
521
"""Return the id of this trees root"""
522
return self._inventory.root.file_id
524
77
def _get_store_filename(self, file_id):
525
## XXX: badly named; this is not in the store at all
526
file_id = osutils.safe_file_id(file_id)
527
return self.abspath(self.id2path(file_id))
530
def clone(self, to_bzrdir, revision_id=None, basis=None):
531
"""Duplicate this working tree into to_bzr, including all state.
533
Specifically modified files are kept as modified, but
534
ignored and unknown files are discarded.
536
If you want to make a new line of development, see bzrdir.sprout()
539
If not None, the cloned tree will have its last revision set to
540
revision, and and difference between the source trees last revision
541
and this one merged in.
544
If not None, a closer copy of a tree which may have some files in
545
common, and which file content should be preferentially copied from.
547
# assumes the target bzr dir format is compatible.
548
result = self._format.initialize(to_bzrdir)
549
self.copy_content_into(result, revision_id)
553
def copy_content_into(self, tree, revision_id=None):
554
"""Copy the current content and user files of this tree into tree."""
555
tree.set_root_id(self.get_root_id())
556
if revision_id is None:
557
merge.transform_tree(tree, self)
559
# TODO now merge from tree.last_revision to revision (to preserve
560
# user local changes)
561
merge.transform_tree(tree, self)
562
tree.set_parent_ids([revision_id])
564
def id2abspath(self, file_id):
565
file_id = osutils.safe_file_id(file_id)
566
return self.abspath(self.id2path(file_id))
78
## XXX: badly named; this isn't in the store at all
79
return self.abspath(self.id2path(file_id))
568
82
def has_id(self, file_id):
569
83
# files that have been deleted are excluded
570
file_id = osutils.safe_file_id(file_id)
572
if not inv.has_id(file_id):
84
if not self.inventory.has_id(file_id):
574
path = inv.id2path(file_id)
575
return osutils.lexists(self.abspath(path))
577
def has_or_had_id(self, file_id):
578
file_id = osutils.safe_file_id(file_id)
579
if file_id == self.inventory.root.file_id:
86
if file_id in self._statcache:
581
return self.inventory.has_id(file_id)
88
return os.path.exists(self.abspath(self.id2path(file_id)))
583
91
__contains__ = has_id
94
def _update_statcache(self):
96
if not self._statcache:
97
self._statcache = statcache.update_cache(self.basedir, self.inventory)
585
99
def get_file_size(self, file_id):
586
file_id = osutils.safe_file_id(file_id)
587
return os.path.getsize(self.id2abspath(file_id))
590
def get_file_sha1(self, file_id, path=None, stat_value=None):
591
file_id = osutils.safe_file_id(file_id)
593
path = self._inventory.id2path(file_id)
594
return self._hashcache.get_sha1(path, stat_value)
596
def get_file_mtime(self, file_id, path=None):
597
file_id = osutils.safe_file_id(file_id)
599
path = self.inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
if not supports_executable():
603
def is_executable(self, file_id, path=None):
604
file_id = osutils.safe_file_id(file_id)
605
return self._inventory[file_id].executable
607
def is_executable(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
610
path = self.id2path(file_id)
611
mode = os.lstat(self.abspath(path)).st_mode
612
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
615
def _add(self, files, ids, kinds):
616
"""See MutableTree._add."""
617
# TODO: Re-adding a file that is removed in the working copy
618
# should probably put it back with the previous ID.
619
# the read and write working inventory should not occur in this
620
# function - they should be part of lock_write and unlock.
621
inv = self.read_working_inventory()
622
for f, file_id, kind in zip(files, ids, kinds):
623
assert kind is not None
625
inv.add_path(f, kind=kind)
627
file_id = osutils.safe_file_id(file_id)
628
inv.add_path(f, kind=kind, file_id=file_id)
629
self._write_inventory(inv)
631
@needs_tree_write_lock
632
def _gather_kinds(self, files, kinds):
633
"""See MutableTree._gather_kinds."""
634
for pos, f in enumerate(files):
635
if kinds[pos] is None:
636
fullpath = normpath(self.abspath(f))
638
kinds[pos] = file_kind(fullpath)
640
if e.errno == errno.ENOENT:
641
raise errors.NoSuchFile(fullpath)
644
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
645
"""Add revision_id as a parent.
647
This is equivalent to retrieving the current list of parent ids
648
and setting the list to its value plus revision_id.
650
:param revision_id: The revision id to add to the parent list. It may
651
be a ghost revision as long as its not the first parent to be added,
652
or the allow_leftmost_as_ghost parameter is set True.
653
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
655
parents = self.get_parent_ids() + [revision_id]
656
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
657
or allow_leftmost_as_ghost)
659
@needs_tree_write_lock
660
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
661
"""Add revision_id, tree tuple as a parent.
663
This is equivalent to retrieving the current list of parent trees
664
and setting the list to its value plus parent_tuple. See also
665
add_parent_tree_id - if you only have a parent id available it will be
666
simpler to use that api. If you have the parent already available, using
667
this api is preferred.
669
:param parent_tuple: The (revision id, tree) to add to the parent list.
670
If the revision_id is a ghost, pass None for the tree.
671
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
673
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
674
if len(parent_ids) > 1:
675
# the leftmost may have already been a ghost, preserve that if it
677
allow_leftmost_as_ghost = True
678
self.set_parent_ids(parent_ids,
679
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
681
@needs_tree_write_lock
682
def add_pending_merge(self, *revision_ids):
683
# TODO: Perhaps should check at this point that the
684
# history of the revision is actually present?
685
parents = self.get_parent_ids()
687
for rev_id in revision_ids:
688
if rev_id in parents:
690
parents.append(rev_id)
693
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
695
@deprecated_method(zero_eleven)
697
def pending_merges(self):
698
"""Return a list of pending merges.
700
These are revisions that have been merged into the working
701
directory but not yet committed.
703
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
704
instead - which is available on all tree objects.
706
return self.get_parent_ids()[1:]
708
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
709
"""Common ghost checking functionality from set_parent_*.
711
This checks that the left hand-parent exists if there are any
714
if len(revision_ids) > 0:
715
leftmost_id = revision_ids[0]
716
if (not allow_leftmost_as_ghost and not
717
self.branch.repository.has_revision(leftmost_id)):
718
raise errors.GhostRevisionUnusableHere(leftmost_id)
720
def _set_merges_from_parent_ids(self, parent_ids):
721
merges = parent_ids[1:]
722
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
724
@needs_tree_write_lock
725
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
726
"""Set the parent ids to revision_ids.
728
See also set_parent_trees. This api will try to retrieve the tree data
729
for each element of revision_ids from the trees repository. If you have
730
tree data already available, it is more efficient to use
731
set_parent_trees rather than set_parent_ids. set_parent_ids is however
732
an easier API to use.
734
:param revision_ids: The revision_ids to set as the parent ids of this
735
working tree. Any of these may be ghosts.
737
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
738
self._check_parents_for_ghosts(revision_ids,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
741
if len(revision_ids) > 0:
742
self.set_last_revision(revision_ids[0])
744
self.set_last_revision(None)
746
self._set_merges_from_parent_ids(revision_ids)
748
@needs_tree_write_lock
749
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
750
"""See MutableTree.set_parent_trees."""
751
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
753
self._check_parents_for_ghosts(parent_ids,
754
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
756
if len(parent_ids) == 0:
757
leftmost_parent_id = None
758
leftmost_parent_tree = None
760
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
762
if self._change_last_revision(leftmost_parent_id):
763
if leftmost_parent_tree is None:
764
# If we don't have a tree, fall back to reading the
765
# parent tree from the repository.
766
self._cache_basis_inventory(leftmost_parent_id)
768
inv = leftmost_parent_tree.inventory
769
xml = self._create_basis_xml_from_inventory(
770
leftmost_parent_id, inv)
771
self._write_basis_inventory(xml)
772
self._set_merges_from_parent_ids(parent_ids)
774
@needs_tree_write_lock
775
def set_pending_merges(self, rev_list):
776
parents = self.get_parent_ids()
777
leftmost = parents[:1]
778
new_parents = leftmost + rev_list
779
self.set_parent_ids(new_parents)
781
@needs_tree_write_lock
782
def set_merge_modified(self, modified_hashes):
784
for file_id, hash in modified_hashes.iteritems():
785
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
786
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
788
@needs_tree_write_lock
789
def _put_rio(self, filename, stanzas, header):
790
my_file = rio_file(stanzas, header)
791
self._control_files.put(filename, my_file)
793
@needs_write_lock # because merge pulls data into the branch.
794
def merge_from_branch(self, branch, to_revision=None):
795
"""Merge from a branch into this working tree.
797
:param branch: The branch to merge from.
798
:param to_revision: If non-None, the merge will merge to to_revision,
799
but not beyond it. to_revision does not need to be in the history
800
of the branch when it is supplied. If None, to_revision defaults to
801
branch.last_revision().
803
from bzrlib.merge import Merger, Merge3Merger
804
pb = bzrlib.ui.ui_factory.nested_progress_bar()
806
merger = Merger(self.branch, this_tree=self, pb=pb)
807
merger.pp = ProgressPhase("Merge phase", 5, pb)
808
merger.pp.next_phase()
809
# check that there are no
811
merger.check_basis(check_clean=True, require_commits=False)
812
if to_revision is None:
813
to_revision = branch.last_revision()
815
to_revision = osutils.safe_revision_id(to_revision)
816
merger.other_rev_id = to_revision
817
if merger.other_rev_id is None:
818
raise error.NoCommits(branch)
819
self.branch.fetch(branch, last_revision=merger.other_rev_id)
820
merger.other_basis = merger.other_rev_id
821
merger.other_tree = self.branch.repository.revision_tree(
823
merger.pp.next_phase()
825
if merger.base_rev_id == merger.other_rev_id:
826
raise errors.PointlessMerge
827
merger.backup_files = False
828
merger.merge_type = Merge3Merger
829
merger.set_interesting_files(None)
830
merger.show_base = False
831
merger.reprocess = False
832
conflicts = merger.do_merge()
839
def merge_modified(self):
841
hashfile = self._control_files.get('merge-hashes')
842
except errors.NoSuchFile:
846
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
847
raise errors.MergeModifiedFormatError()
848
except StopIteration:
849
raise errors.MergeModifiedFormatError()
850
for s in RioReader(hashfile):
851
file_id = s.get("file_id")
852
if file_id not in self.inventory:
855
if hash == self.get_file_sha1(file_id):
856
merge_hashes[file_id] = hash
860
def mkdir(self, path, file_id=None):
861
"""See MutableTree.mkdir()."""
863
file_id = generate_ids.gen_file_id(os.path.basename(path))
864
os.mkdir(self.abspath(path))
865
self.add(path, file_id, 'directory')
868
def get_symlink_target(self, file_id):
869
return os.readlink(self.id2abspath(file_id))
101
return os.stat(self._get_store_filename(file_id))[stat.ST_SIZE]
104
def get_file_sha1(self, file_id):
105
return self._statcache[file_id][statcache.SC_SHA1]
871
108
def file_class(self, filename):
872
109
if self.path2id(filename):
898
125
Skips the control directory.
900
# list_files is an iterator, so @needs_read_lock doesn't work properly
901
# with it. So callers should be careful to always read_lock the tree.
902
if not self.is_locked():
903
raise errors.ObjectNotLocked(self)
127
from osutils import appendpath, file_kind
905
130
inv = self.inventory
906
if include_root is True:
907
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
908
# Convert these into local objects to save lookup times
909
pathjoin = osutils.pathjoin
910
file_kind = osutils.file_kind
912
# transport.base ends in a slash, we want the piece
913
# between the last two slashes
914
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
916
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
918
# directory file_id, relative path, absolute path, reverse sorted children
919
children = os.listdir(self.basedir)
921
# jam 20060527 The kernel sized tree seems equivalent whether we
922
# use a deque and popleft to keep them sorted, or if we use a plain
923
# list and just reverse() them.
924
children = collections.deque(children)
925
stack = [(inv.root.file_id, u'', self.basedir, children)]
927
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
930
f = children.popleft()
132
def descend(from_dir_relpath, from_dir_id, dp):
931
136
## TODO: If we find a subdirectory with its own .bzr
932
137
## directory, then that is a separate tree and we
933
138
## should exclude it.
935
# the bzrdir for this tree
936
if transport_base_dir == f:
139
if bzrlib.BZRDIR == f:
939
# we know that from_dir_relpath and from_dir_abspath never end in a slash
940
# and 'f' doesn't begin with one, we can do a string op, rather
941
# than the checks of pathjoin(), all relative paths will have an extra slash
943
fp = from_dir_relpath + '/' + f
143
fp = appendpath(from_dir_relpath, f)
946
fap = from_dir_abspath + '/' + f
146
fap = appendpath(dp, f)
948
148
f_ie = inv.get_child(from_dir_id, f)
951
elif self.is_ignored(fp[1:]):
151
elif self.is_ignored(fp):
954
# we may not have found this file, because of a unicode issue
955
f_norm, can_access = osutils.normalized_filename(f)
956
if f == f_norm or not can_access:
957
# No change, so treat this file normally
960
# this file can be accessed by a normalized path
961
# check again if it is versioned
962
# these lines are repeated here for performance
964
fp = from_dir_relpath + '/' + f
965
fap = from_dir_abspath + '/' + f
966
f_ie = inv.get_child(from_dir_id, f)
969
elif self.is_ignored(fp[1:]):
974
156
fk = file_kind(fap)
977
159
if f_ie.kind != fk:
978
raise errors.BzrCheckError(
979
"file %r entered as kind %r id %r, now of kind %r"
980
% (fap, f_ie.kind, f_ie.file_id, fk))
982
# make a last minute entry
984
yield fp[1:], c, fk, f_ie.file_id, f_ie
987
yield fp[1:], c, fk, None, fk_entries[fk]()
989
yield fp[1:], c, fk, None, TreeEntry()
160
raise BzrCheckError("file %r entered as kind %r id %r, "
162
% (fap, f_ie.kind, f_ie.file_id, fk))
164
yield fp, c, fk, (f_ie and f_ie.file_id)
992
166
if fk != 'directory':
995
# But do this child first
996
new_children = os.listdir(fap)
998
new_children = collections.deque(new_children)
999
stack.append((f_ie.file_id, fp, fap, new_children))
1000
# Break out of inner loop,
1001
# so that we start outer loop with child
1004
# if we finished all children, pop it off the stack
1007
@needs_tree_write_lock
1008
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1011
to_dir must exist in the inventory.
1013
If to_dir exists and is a directory, the files are moved into
1014
it, keeping their old names.
1016
Note that to_dir is only the last component of the new name;
1017
this doesn't change the directory.
1019
For each entry in from_paths the move mode will be determined
1022
The first mode moves the file in the filesystem and updates the
1023
inventory. The second mode only updates the inventory without
1024
touching the file on the filesystem. This is the new mode introduced
1027
move uses the second mode if 'after == True' and the target is not
1028
versioned but present in the working tree.
1030
move uses the second mode if 'after == False' and the source is
1031
versioned but no longer in the working tree, and the target is not
1032
versioned but present in the working tree.
1034
move uses the first mode if 'after == False' and the source is
1035
versioned and present in the working tree, and the target is not
1036
versioned and not present in the working tree.
1038
Everything else results in an error.
1040
This returns a list of (from_path, to_path) pairs for each
1041
entry that is moved.
1046
# check for deprecated use of signature
1048
to_dir = kwargs.get('to_name', None)
1050
raise TypeError('You must supply a target directory')
1052
symbol_versioning.warn('The parameter to_name was deprecated'
1053
' in version 0.13. Use to_dir instead',
1056
# check destination directory
1057
assert not isinstance(from_paths, basestring)
1058
inv = self.inventory
1059
to_abs = self.abspath(to_dir)
1060
if not isdir(to_abs):
1061
raise errors.BzrMoveFailedError('',to_dir,
1062
errors.NotADirectory(to_abs))
1063
if not self.has_filename(to_dir):
1064
raise errors.BzrMoveFailedError('',to_dir,
1065
errors.NotInWorkingDirectory(to_dir))
1066
to_dir_id = inv.path2id(to_dir)
1067
if to_dir_id is None:
1068
raise errors.BzrMoveFailedError('',to_dir,
1069
errors.NotVersionedError(path=str(to_dir)))
1071
to_dir_ie = inv[to_dir_id]
1072
if to_dir_ie.kind != 'directory':
1073
raise errors.BzrMoveFailedError('',to_dir,
1074
errors.NotADirectory(to_abs))
1076
# create rename entries and tuples
1077
for from_rel in from_paths:
1078
from_tail = splitpath(from_rel)[-1]
1079
from_id = inv.path2id(from_rel)
1081
raise errors.BzrMoveFailedError(from_rel,to_dir,
1082
errors.NotVersionedError(path=str(from_rel)))
1084
from_entry = inv[from_id]
1085
from_parent_id = from_entry.parent_id
1086
to_rel = pathjoin(to_dir, from_tail)
1087
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1089
from_tail=from_tail,
1090
from_parent_id=from_parent_id,
1091
to_rel=to_rel, to_tail=from_tail,
1092
to_parent_id=to_dir_id)
1093
rename_entries.append(rename_entry)
1094
rename_tuples.append((from_rel, to_rel))
1096
# determine which move mode to use. checks also for movability
1097
rename_entries = self._determine_mv_mode(rename_entries, after)
1099
original_modified = self._inventory_is_modified
1102
self._inventory_is_modified = True
1103
self._move(rename_entries)
1105
# restore the inventory on error
1106
self._inventory_is_modified = original_modified
1108
self._write_inventory(inv)
1109
return rename_tuples
1111
def _determine_mv_mode(self, rename_entries, after=False):
1112
"""Determines for each from-to pair if both inventory and working tree
1113
or only the inventory has to be changed.
1115
Also does basic plausability tests.
1117
inv = self.inventory
1119
for rename_entry in rename_entries:
1120
# store to local variables for easier reference
1121
from_rel = rename_entry.from_rel
1122
from_id = rename_entry.from_id
1123
to_rel = rename_entry.to_rel
1124
to_id = inv.path2id(to_rel)
1125
only_change_inv = False
1127
# check the inventory for source and destination
1129
raise errors.BzrMoveFailedError(from_rel,to_rel,
1130
errors.NotVersionedError(path=str(from_rel)))
1131
if to_id is not None:
1132
raise errors.BzrMoveFailedError(from_rel,to_rel,
1133
errors.AlreadyVersionedError(path=str(to_rel)))
1135
# try to determine the mode for rename (only change inv or change
1136
# inv and file system)
1138
if not self.has_filename(to_rel):
1139
raise errors.BzrMoveFailedError(from_id,to_rel,
1140
errors.NoSuchFile(path=str(to_rel),
1141
extra="New file has not been created yet"))
1142
only_change_inv = True
1143
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1144
only_change_inv = True
1145
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1146
only_change_inv = False
1148
# something is wrong, so lets determine what exactly
1149
if not self.has_filename(from_rel) and \
1150
not self.has_filename(to_rel):
1151
raise errors.BzrRenameFailedError(from_rel,to_rel,
1152
errors.PathsDoNotExist(paths=(str(from_rel),
1155
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1156
extra="(Use --after to update the Bazaar id)")
1157
rename_entry.only_change_inv = only_change_inv
1158
return rename_entries
1160
def _move(self, rename_entries):
1161
"""Moves a list of files.
1163
Depending on the value of the flag 'only_change_inv', the
1164
file will be moved on the file system or not.
1166
inv = self.inventory
1169
for entry in rename_entries:
1171
self._move_entry(entry)
1173
self._rollback_move(moved)
1177
def _rollback_move(self, moved):
1178
"""Try to rollback a previous move in case of an filesystem error."""
1179
inv = self.inventory
1182
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1183
entry.to_tail, entry.to_parent_id, entry.from_rel,
1184
entry.from_tail, entry.from_parent_id,
1185
entry.only_change_inv))
1186
except errors.BzrMoveFailedError, e:
1187
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1188
" The working tree is in an inconsistent state."
1189
" Please consider doing a 'bzr revert'."
1190
" Error message is: %s" % e)
1192
def _move_entry(self, entry):
1193
inv = self.inventory
1194
from_rel_abs = self.abspath(entry.from_rel)
1195
to_rel_abs = self.abspath(entry.to_rel)
1196
if from_rel_abs == to_rel_abs:
1197
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1198
"Source and target are identical.")
1200
if not entry.only_change_inv:
1202
osutils.rename(from_rel_abs, to_rel_abs)
1204
raise errors.BzrMoveFailedError(entry.from_rel,
1206
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1208
@needs_tree_write_lock
1209
def rename_one(self, from_rel, to_rel, after=False):
1212
This can change the directory or the filename or both.
1214
rename_one has several 'modes' to work. First, it can rename a physical
1215
file and change the file_id. That is the normal mode. Second, it can
1216
only change the file_id without touching any physical file. This is
1217
the new mode introduced in version 0.15.
1219
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1220
versioned but present in the working tree.
1222
rename_one uses the second mode if 'after == False' and 'from_rel' is
1223
versioned but no longer in the working tree, and 'to_rel' is not
1224
versioned but present in the working tree.
1226
rename_one uses the first mode if 'after == False' and 'from_rel' is
1227
versioned and present in the working tree, and 'to_rel' is not
1228
versioned and not present in the working tree.
1230
Everything else results in an error.
1232
inv = self.inventory
1235
# create rename entries and tuples
1236
from_tail = splitpath(from_rel)[-1]
1237
from_id = inv.path2id(from_rel)
1239
raise errors.BzrRenameFailedError(from_rel,to_rel,
1240
errors.NotVersionedError(path=str(from_rel)))
1241
from_entry = inv[from_id]
1242
from_parent_id = from_entry.parent_id
1243
to_dir, to_tail = os.path.split(to_rel)
1244
to_dir_id = inv.path2id(to_dir)
1245
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1247
from_tail=from_tail,
1248
from_parent_id=from_parent_id,
1249
to_rel=to_rel, to_tail=to_tail,
1250
to_parent_id=to_dir_id)
1251
rename_entries.append(rename_entry)
1253
# determine which move mode to use. checks also for movability
1254
rename_entries = self._determine_mv_mode(rename_entries, after)
1256
# check if the target changed directory and if the target directory is
1258
if to_dir_id is None:
1259
raise errors.BzrMoveFailedError(from_rel,to_rel,
1260
errors.NotVersionedError(path=str(to_dir)))
1262
# all checks done. now we can continue with our actual work
1263
mutter('rename_one:\n'
1268
' to_dir_id {%s}\n',
1269
from_id, from_rel, to_rel, to_dir, to_dir_id)
1271
self._move(rename_entries)
1272
self._write_inventory(inv)
1274
class _RenameEntry(object):
1275
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1276
to_rel, to_tail, to_parent_id, only_change_inv=False):
1277
self.from_rel = from_rel
1278
self.from_id = from_id
1279
self.from_tail = from_tail
1280
self.from_parent_id = from_parent_id
1281
self.to_rel = to_rel
1282
self.to_tail = to_tail
1283
self.to_parent_id = to_parent_id
1284
self.only_change_inv = only_change_inv
170
# don't descend unversioned directories
173
for ff in descend(fp, f_ie.file_id, fap):
176
for f in descend('', inv.root.file_id, self.basedir):
1287
181
def unknowns(self):
1288
"""Return all unknown files.
1290
These are files in the working directory that are not versioned or
1291
control files or ignored.
1293
# force the extras method to be fully executed before returning, to
1294
# prevent race conditions with the lock
1296
[subp for subp in self.extras() if not self.is_ignored(subp)])
1298
@needs_tree_write_lock
1299
def unversion(self, file_ids):
1300
"""Remove the file ids in file_ids from the current versioned set.
1302
When a file_id is unversioned, all of its children are automatically
1305
:param file_ids: The file ids to stop versioning.
1306
:raises: NoSuchId if any fileid is not currently versioned.
1308
for file_id in file_ids:
1309
file_id = osutils.safe_file_id(file_id)
1310
if self._inventory.has_id(file_id):
1311
self._inventory.remove_recursive_id(file_id)
1313
raise errors.NoSuchId(self, file_id)
1315
# in the future this should just set a dirty bit to wait for the
1316
# final unlock. However, until all methods of workingtree start
1317
# with the current in -memory inventory rather than triggering
1318
# a read, it is more complex - we need to teach read_inventory
1319
# to know when to read, and when to not read first... and possibly
1320
# to save first when the in memory one may be corrupted.
1321
# so for now, we just only write it if it is indeed dirty.
1323
self._write_inventory(self._inventory)
1325
@deprecated_method(zero_eight)
1326
def iter_conflicts(self):
1327
"""List all files in the tree that have text or content conflicts.
1328
DEPRECATED. Use conflicts instead."""
1329
return self._iter_conflicts()
1331
def _iter_conflicts(self):
1333
for info in self.list_files():
1335
stem = get_conflicted_stem(path)
1338
if stem not in conflicted:
1339
conflicted.add(stem)
1343
def pull(self, source, overwrite=False, stop_revision=None,
1344
change_reporter=None):
1345
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1348
pp = ProgressPhase("Pull phase", 2, top_pb)
1350
old_revision_info = self.branch.last_revision_info()
1351
basis_tree = self.basis_tree()
1352
count = self.branch.pull(source, overwrite, stop_revision)
1353
new_revision_info = self.branch.last_revision_info()
1354
if new_revision_info != old_revision_info:
1356
repository = self.branch.repository
1357
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1358
basis_tree.lock_read()
1360
new_basis_tree = self.branch.basis_tree()
1367
change_reporter=change_reporter)
1368
if (basis_tree.inventory.root is None and
1369
new_basis_tree.inventory.root is not None):
1370
self.set_root_id(new_basis_tree.inventory.root.file_id)
1374
# TODO - dedup parents list with things merged by pull ?
1375
# reuse the revisiontree we merged against to set the new
1377
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1378
# we have to pull the merge trees out again, because
1379
# merge_inner has set the ids. - this corner is not yet
1380
# layered well enough to prevent double handling.
1381
# XXX TODO: Fix the double handling: telling the tree about
1382
# the already known parent data is wasteful.
1383
merges = self.get_parent_ids()[1:]
1384
parent_trees.extend([
1385
(parent, repository.revision_tree(parent)) for
1387
self.set_parent_trees(parent_trees)
1394
def put_file_bytes_non_atomic(self, file_id, bytes):
1395
"""See MutableTree.put_file_bytes_non_atomic."""
1396
file_id = osutils.safe_file_id(file_id)
1397
stream = file(self.id2abspath(file_id), 'wb')
1402
# TODO: update the hashcache here ?
182
for subp in self.extras():
183
if not self.is_ignored(subp):
1404
187
def extras(self):
1405
188
"""Yield all unknown files in this WorkingTree.
1477
248
If the file is ignored, returns the pattern which caused it to
1478
249
be ignored, otherwise None. So this can simply be used as a
1479
250
boolean if desired."""
1480
if getattr(self, '_ignoreglobster', None) is None:
1481
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1482
return self._ignoreglobster.match(filename)
1484
def kind(self, file_id):
1485
return file_kind(self.id2abspath(file_id))
1487
def _comparison_data(self, entry, path):
1488
abspath = self.abspath(path)
1490
stat_value = os.lstat(abspath)
1492
if getattr(e, 'errno', None) == errno.ENOENT:
1499
mode = stat_value.st_mode
1500
kind = osutils.file_kind_from_stat_mode(mode)
1501
if not supports_executable():
1502
executable = entry.executable
1504
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1505
return kind, executable, stat_value
1507
def _file_size(self, entry, stat_value):
1508
return stat_value.st_size
1510
def last_revision(self):
1511
"""Return the last revision of the branch for this tree.
1513
This format tree does not support a separate marker for last-revision
1514
compared to the branch.
1516
See MutableTree.last_revision
1518
return self._last_revision()
1521
def _last_revision(self):
1522
"""helper for get_parent_ids."""
1523
return self.branch.last_revision()
1525
def is_locked(self):
1526
return self._control_files.is_locked()
1528
def lock_read(self):
1529
"""See Branch.lock_read, and WorkingTree.unlock."""
1530
self.branch.lock_read()
1532
return self._control_files.lock_read()
1534
self.branch.unlock()
1537
def lock_tree_write(self):
1538
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1539
self.branch.lock_read()
1541
return self._control_files.lock_write()
1543
self.branch.unlock()
1546
def lock_write(self):
1547
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1548
self.branch.lock_write()
1550
return self._control_files.lock_write()
1552
self.branch.unlock()
1555
def get_physical_lock_status(self):
1556
return self._control_files.get_physical_lock_status()
1558
def _basis_inventory_name(self):
1559
return 'basis-inventory-cache'
1561
@needs_tree_write_lock
1562
def set_last_revision(self, new_revision):
1563
"""Change the last revision in the working tree."""
1564
new_revision = osutils.safe_revision_id(new_revision)
1565
if self._change_last_revision(new_revision):
1566
self._cache_basis_inventory(new_revision)
1568
def _change_last_revision(self, new_revision):
1569
"""Template method part of set_last_revision to perform the change.
1571
This is used to allow WorkingTree3 instances to not affect branch
1572
when their last revision is set.
1574
if new_revision is None:
1575
self.branch.set_revision_history([])
1578
self.branch.generate_revision_history(new_revision)
1579
except errors.NoSuchRevision:
1580
# not present in the repo - dont try to set it deeper than the tip
1581
self.branch.set_revision_history([new_revision])
1584
def _write_basis_inventory(self, xml):
1585
"""Write the basis inventory XML to the basis-inventory file"""
1586
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1587
path = self._basis_inventory_name()
1589
self._control_files.put(path, sio)
1591
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1592
"""Create the text that will be saved in basis-inventory"""
1593
# TODO: jam 20070209 This should be redundant, as the revision_id
1594
# as all callers should have already converted the revision_id to
1596
inventory.revision_id = osutils.safe_revision_id(revision_id)
1597
return xml6.serializer_v6.write_inventory_to_string(inventory)
1599
def _cache_basis_inventory(self, new_revision):
1600
"""Cache new_revision as the basis inventory."""
1601
# TODO: this should allow the ready-to-use inventory to be passed in,
1602
# as commit already has that ready-to-use [while the format is the
1605
# this double handles the inventory - unpack and repack -
1606
# but is easier to understand. We can/should put a conditional
1607
# in here based on whether the inventory is in the latest format
1608
# - perhaps we should repack all inventories on a repository
1610
# the fast path is to copy the raw xml from the repository. If the
1611
# xml contains 'revision_id="', then we assume the right
1612
# revision_id is set. We must check for this full string, because a
1613
# root node id can legitimately look like 'revision_id' but cannot
1615
xml = self.branch.repository.get_inventory_xml(new_revision)
1616
firstline = xml.split('\n', 1)[0]
1617
if (not 'revision_id="' in firstline or
1618
'format="6"' not in firstline):
1619
inv = self.branch.repository.deserialise_inventory(
1621
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1622
self._write_basis_inventory(xml)
1623
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1626
def read_basis_inventory(self):
1627
"""Read the cached basis inventory."""
1628
path = self._basis_inventory_name()
1629
return self._control_files.get(path).read()
1632
def read_working_inventory(self):
1633
"""Read the working inventory.
1635
:raises errors.InventoryModified: read_working_inventory will fail
1636
when the current in memory inventory has been modified.
1638
# conceptually this should be an implementation detail of the tree.
1639
# XXX: Deprecate this.
1640
# ElementTree does its own conversion from UTF-8, so open in
1642
if self._inventory_is_modified:
1643
raise errors.InventoryModified(self)
1644
result = xml5.serializer_v5.read_inventory(
1645
self._control_files.get('inventory'))
1646
self._set_inventory(result, dirty=False)
1649
@needs_tree_write_lock
1650
def remove(self, files, verbose=False, to_file=None):
1651
"""Remove nominated files from the working inventory..
1653
This does not remove their text. This does not run on XXX on what? RBC
1655
TODO: Refuse to remove modified files unless --force is given?
1657
TODO: Do something useful with directories.
1659
TODO: Should this remove the text or not? Tough call; not
1660
removing may be useful and the user can just use use rm, and
1661
is the opposite of add. Removing it is consistent with most
1662
other tools. Maybe an option.
1664
## TODO: Normalize names
1665
## TODO: Remove nested loops; better scalability
1666
if isinstance(files, basestring):
1669
inv = self.inventory
1671
# do this before any modifications
1673
fid = inv.path2id(f)
1675
note("%s is not versioned."%f)
1678
# having remove it, it must be either ignored or unknown
1679
if self.is_ignored(f):
1683
textui.show_status(new_status, inv[fid].kind, f,
1687
self._write_inventory(inv)
1689
@needs_tree_write_lock
1690
def revert(self, filenames, old_tree=None, backups=True,
1691
pb=DummyProgress(), report_changes=False):
1692
from bzrlib.conflicts import resolve
1693
if old_tree is None:
1694
old_tree = self.basis_tree()
1695
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1697
if not len(filenames):
1698
self.set_parent_ids(self.get_parent_ids()[:1])
1701
resolve(self, filenames, ignore_misses=True)
1704
def revision_tree(self, revision_id):
1705
"""See Tree.revision_tree.
1707
WorkingTree can supply revision_trees for the basis revision only
1708
because there is only one cached inventory in the bzr directory.
1710
if revision_id == self.last_revision():
1712
xml = self.read_basis_inventory()
1713
except errors.NoSuchFile:
1717
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1718
# dont use the repository revision_tree api because we want
1719
# to supply the inventory.
1720
if inv.revision_id == revision_id:
1721
return revisiontree.RevisionTree(self.branch.repository,
1723
except errors.BadInventoryFormat:
1725
# raise if there was no inventory, or if we read the wrong inventory.
1726
raise errors.NoSuchRevisionInTree(self, revision_id)
1728
# XXX: This method should be deprecated in favour of taking in a proper
1729
# new Inventory object.
1730
@needs_tree_write_lock
1731
def set_inventory(self, new_inventory_list):
1732
from bzrlib.inventory import (Inventory,
1737
inv = Inventory(self.get_root_id())
1738
for path, file_id, parent, kind in new_inventory_list:
1739
name = os.path.basename(path)
1742
# fixme, there should be a factory function inv,add_??
1743
if kind == 'directory':
1744
inv.add(InventoryDirectory(file_id, name, parent))
1745
elif kind == 'file':
1746
inv.add(InventoryFile(file_id, name, parent))
1747
elif kind == 'symlink':
1748
inv.add(InventoryLink(file_id, name, parent))
1750
raise errors.BzrError("unknown kind %r" % kind)
1751
self._write_inventory(inv)
1753
@needs_tree_write_lock
1754
def set_root_id(self, file_id):
1755
"""Set the root id for this tree."""
1758
symbol_versioning.warn(symbol_versioning.zero_twelve
1759
% 'WorkingTree.set_root_id with fileid=None',
1764
file_id = osutils.safe_file_id(file_id)
1765
self._set_root_id(file_id)
1767
def _set_root_id(self, file_id):
1768
"""Set the root id for this tree, in a format specific manner.
1770
:param file_id: The file id to assign to the root. It must not be
1771
present in the current inventory or an error will occur. It must
1772
not be None, but rather a valid file id.
1774
inv = self._inventory
1775
orig_root_id = inv.root.file_id
1776
# TODO: it might be nice to exit early if there was nothing
1777
# to do, saving us from trigger a sync on unlock.
1778
self._inventory_is_modified = True
1779
# we preserve the root inventory entry object, but
1780
# unlinkit from the byid index
1781
del inv._byid[inv.root.file_id]
1782
inv.root.file_id = file_id
1783
# and link it into the index with the new changed id.
1784
inv._byid[inv.root.file_id] = inv.root
1785
# and finally update all children to reference the new id.
1786
# XXX: this should be safe to just look at the root.children
1787
# list, not the WHOLE INVENTORY.
1790
if entry.parent_id == orig_root_id:
1791
entry.parent_id = inv.root.file_id
1794
"""See Branch.unlock.
1796
WorkingTree locking just uses the Branch locking facilities.
1797
This is current because all working trees have an embedded branch
1798
within them. IF in the future, we were to make branch data shareable
1799
between multiple working trees, i.e. via shared storage, then we
1800
would probably want to lock both the local tree, and the branch.
1802
raise NotImplementedError(self.unlock)
1805
"""Update a working tree along its branch.
1807
This will update the branch if its bound too, which means we have
1808
multiple trees involved:
1810
- The new basis tree of the master.
1811
- The old basis tree of the branch.
1812
- The old basis tree of the working tree.
1813
- The current working tree state.
1815
Pathologically, all three may be different, and non-ancestors of each
1816
other. Conceptually we want to:
1818
- Preserve the wt.basis->wt.state changes
1819
- Transform the wt.basis to the new master basis.
1820
- Apply a merge of the old branch basis to get any 'local' changes from
1822
- Restore the wt.basis->wt.state changes.
1824
There isn't a single operation at the moment to do that, so we:
1825
- Merge current state -> basis tree of the master w.r.t. the old tree
1827
- Do a 'normal' merge of the old branch basis if it is relevant.
1829
if self.branch.get_master_branch() is not None:
1831
update_branch = True
1833
self.lock_tree_write()
1834
update_branch = False
1837
old_tip = self.branch.update()
1840
return self._update_tree(old_tip)
1844
@needs_tree_write_lock
1845
def _update_tree(self, old_tip=None):
1846
"""Update a tree to the master branch.
1848
:param old_tip: if supplied, the previous tip revision the branch,
1849
before it was changed to the master branch's tip.
1851
# here if old_tip is not None, it is the old tip of the branch before
1852
# it was updated from the master branch. This should become a pending
1853
# merge in the working tree to preserve the user existing work. we
1854
# cant set that until we update the working trees last revision to be
1855
# one from the new branch, because it will just get absorbed by the
1856
# parent de-duplication logic.
1858
# We MUST save it even if an error occurs, because otherwise the users
1859
# local work is unreferenced and will appear to have been lost.
1863
last_rev = self.get_parent_ids()[0]
1866
if last_rev != self.branch.last_revision():
1867
# merge tree state up to new branch tip.
1868
basis = self.basis_tree()
1871
to_tree = self.branch.basis_tree()
1872
if basis.inventory.root is None and self.inventory.root is None:
1873
self.set_root_id(to_tree.inventory.root.file_id)
1874
result += merge.merge_inner(
1881
# TODO - dedup parents list with things merged by pull ?
1882
# reuse the tree we've updated to to set the basis:
1883
parent_trees = [(self.branch.last_revision(), to_tree)]
1884
merges = self.get_parent_ids()[1:]
1885
# Ideally we ask the tree for the trees here, that way the working
1886
# tree can decide whether to give us teh entire tree or give us a
1887
# lazy initialised tree. dirstate for instance will have the trees
1888
# in ram already, whereas a last-revision + basis-inventory tree
1889
# will not, but also does not need them when setting parents.
1890
for parent in merges:
1891
parent_trees.append(
1892
(parent, self.branch.repository.revision_tree(parent)))
1893
if old_tip is not None:
1894
parent_trees.append(
1895
(old_tip, self.branch.repository.revision_tree(old_tip)))
1896
self.set_parent_trees(parent_trees)
1897
last_rev = parent_trees[0][0]
1899
# the working tree had the same last-revision as the master
1900
# branch did. We may still have pivot local work from the local
1901
# branch into old_tip:
1902
if old_tip is not None:
1903
self.add_parent_tree_id(old_tip)
1904
if old_tip and old_tip != last_rev:
1905
# our last revision was not the prior branch last revision
1906
# and we have converted that last revision to a pending merge.
1907
# base is somewhere between the branch tip now
1908
# and the now pending merge
1910
# Since we just modified the working tree and inventory, flush out
1911
# the current state, before we modify it again.
1912
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
1913
# requires it only because TreeTransform directly munges the
1914
# inventory and calls tree._write_inventory(). Ultimately we
1915
# should be able to remove this extra flush.
1917
from bzrlib.revision import common_ancestor
1919
base_rev_id = common_ancestor(self.branch.last_revision(),
1921
self.branch.repository)
1922
except errors.NoCommonAncestor:
1924
base_tree = self.branch.repository.revision_tree(base_rev_id)
1925
other_tree = self.branch.repository.revision_tree(old_tip)
1926
result += merge.merge_inner(
1933
def _write_hashcache_if_dirty(self):
1934
"""Write out the hashcache if it is dirty."""
1935
if self._hashcache.needs_write:
1937
self._hashcache.write()
1939
if e.errno not in (errno.EPERM, errno.EACCES):
1941
# TODO: jam 20061219 Should this be a warning? A single line
1942
# warning might be sufficient to let the user know what
1944
mutter('Could not write hashcache for %s\nError: %s',
1945
self._hashcache.cache_file_name(), e)
1947
@needs_tree_write_lock
1948
def _write_inventory(self, inv):
1949
"""Write inventory as the current inventory."""
1950
self._set_inventory(inv, dirty=True)
1953
def set_conflicts(self, arg):
1954
raise errors.UnsupportedOperation(self.set_conflicts, self)
1956
def add_conflicts(self, arg):
1957
raise errors.UnsupportedOperation(self.add_conflicts, self)
1960
def conflicts(self):
1961
conflicts = _mod_conflicts.ConflictList()
1962
for conflicted in self._iter_conflicts():
1965
if file_kind(self.abspath(conflicted)) != "file":
1967
except errors.NoSuchFile:
1970
for suffix in ('.THIS', '.OTHER'):
1972
kind = file_kind(self.abspath(conflicted+suffix))
1975
except errors.NoSuchFile:
1979
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1980
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1982
file_id=self.path2id(conflicted)))
1985
def walkdirs(self, prefix=""):
1986
"""Walk the directories of this tree.
1988
This API returns a generator, which is only valid during the current
1989
tree transaction - within a single lock_read or lock_write duration.
1991
If the tree is not locked, it may cause an error to be raised, depending
1992
on the tree implementation.
1994
disk_top = self.abspath(prefix)
1995
if disk_top.endswith('/'):
1996
disk_top = disk_top[:-1]
1997
top_strip_len = len(disk_top) + 1
1998
inventory_iterator = self._walkdirs(prefix)
1999
disk_iterator = osutils.walkdirs(disk_top, prefix)
2001
current_disk = disk_iterator.next()
2002
disk_finished = False
2004
if e.errno != errno.ENOENT:
2007
disk_finished = True
2009
current_inv = inventory_iterator.next()
2010
inv_finished = False
2011
except StopIteration:
2014
while not inv_finished or not disk_finished:
2015
if not disk_finished:
2016
# strip out .bzr dirs
2017
if current_disk[0][1][top_strip_len:] == '':
2018
# osutils.walkdirs can be made nicer -
2019
# yield the path-from-prefix rather than the pathjoined
2021
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2022
if current_disk[1][bzrdir_loc][0] == '.bzr':
2023
# we dont yield the contents of, or, .bzr itself.
2024
del current_disk[1][bzrdir_loc]
2026
# everything is unknown
2029
# everything is missing
2032
direction = cmp(current_inv[0][0], current_disk[0][0])
2034
# disk is before inventory - unknown
2035
dirblock = [(relpath, basename, kind, stat, None, None) for
2036
relpath, basename, kind, stat, top_path in current_disk[1]]
2037
yield (current_disk[0][0], None), dirblock
2039
current_disk = disk_iterator.next()
2040
except StopIteration:
2041
disk_finished = True
2043
# inventory is before disk - missing.
2044
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2045
for relpath, basename, dkind, stat, fileid, kind in
2047
yield (current_inv[0][0], current_inv[0][1]), dirblock
2049
current_inv = inventory_iterator.next()
2050
except StopIteration:
2053
# versioned present directory
2054
# merge the inventory and disk data together
2056
for relpath, subiterator in itertools.groupby(sorted(
2057
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2058
path_elements = list(subiterator)
2059
if len(path_elements) == 2:
2060
inv_row, disk_row = path_elements
2061
# versioned, present file
2062
dirblock.append((inv_row[0],
2063
inv_row[1], disk_row[2],
2064
disk_row[3], inv_row[4],
2066
elif len(path_elements[0]) == 5:
2068
dirblock.append((path_elements[0][0],
2069
path_elements[0][1], path_elements[0][2],
2070
path_elements[0][3], None, None))
2071
elif len(path_elements[0]) == 6:
2072
# versioned, absent file.
2073
dirblock.append((path_elements[0][0],
2074
path_elements[0][1], 'unknown', None,
2075
path_elements[0][4], path_elements[0][5]))
2077
raise NotImplementedError('unreachable code')
2078
yield current_inv[0], dirblock
2080
current_inv = inventory_iterator.next()
2081
except StopIteration:
2084
current_disk = disk_iterator.next()
2085
except StopIteration:
2086
disk_finished = True
2088
def _walkdirs(self, prefix=""):
2089
_directory = 'directory'
2090
# get the root in the inventory
2091
inv = self.inventory
2092
top_id = inv.path2id(prefix)
2096
pending = [(prefix, '', _directory, None, top_id, None)]
2099
currentdir = pending.pop()
2100
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2101
top_id = currentdir[4]
2103
relroot = currentdir[0] + '/'
2106
# FIXME: stash the node in pending
2108
for name, child in entry.sorted_children():
2109
dirblock.append((relroot + name, name, child.kind, None,
2110
child.file_id, child.kind
2112
yield (currentdir[0], entry.file_id), dirblock
2113
# push the user specified dirs from dirblock
2114
for dir in reversed(dirblock):
2115
if dir[2] == _directory:
2119
class WorkingTree2(WorkingTree):
2120
"""This is the Format 2 working tree.
2122
This was the first weave based working tree.
2123
- uses os locks for locking.
2124
- uses the branch last-revision.
2127
def lock_tree_write(self):
2128
"""See WorkingTree.lock_tree_write().
2130
In Format2 WorkingTrees we have a single lock for the branch and tree
2131
so lock_tree_write() degrades to lock_write().
2133
self.branch.lock_write()
2135
return self._control_files.lock_write()
2137
self.branch.unlock()
2141
# we share control files:
2142
if self._control_files._lock_count == 3:
2143
# _inventory_is_modified is always False during a read lock.
2144
if self._inventory_is_modified:
2146
self._write_hashcache_if_dirty()
2148
# reverse order of locking.
2150
return self._control_files.unlock()
2152
self.branch.unlock()
2155
class WorkingTree3(WorkingTree):
2156
"""This is the Format 3 working tree.
2158
This differs from the base WorkingTree by:
2159
- having its own file lock
2160
- having its own last-revision property.
2162
This is new in bzr 0.8
2166
def _last_revision(self):
2167
"""See Mutable.last_revision."""
2169
return osutils.safe_revision_id(
2170
self._control_files.get('last-revision').read())
2171
except errors.NoSuchFile:
252
# TODO: Use '**' to match directories, and other extended
253
# globbing stuff from cvs/rsync.
255
# XXX: fnmatch is actually not quite what we want: it's only
256
# approximately the same as real Unix fnmatch, and doesn't
257
# treat dotfiles correctly and allows * to match /.
258
# Eventually it should be replaced with something more
262
from osutils import splitpath
264
for pat in self.get_ignore_list():
265
if '/' in pat or '\\' in pat:
267
# as a special case, you can put ./ at the start of a
268
# pattern; this is good to match in the top-level
271
if (pat[:2] == './') or (pat[:2] == '.\\'):
275
if fnmatch.fnmatchcase(filename, newpat):
278
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
2174
def _change_last_revision(self, revision_id):
2175
"""See WorkingTree._change_last_revision."""
2176
if revision_id is None or revision_id == NULL_REVISION:
2178
self._control_files._transport.delete('last-revision')
2179
except errors.NoSuchFile:
2183
self._control_files.put_bytes('last-revision', revision_id)
2186
@needs_tree_write_lock
2187
def set_conflicts(self, conflicts):
2188
self._put_rio('conflicts', conflicts.to_stanzas(),
2191
@needs_tree_write_lock
2192
def add_conflicts(self, new_conflicts):
2193
conflict_set = set(self.conflicts())
2194
conflict_set.update(set(list(new_conflicts)))
2195
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2196
key=_mod_conflicts.Conflict.sort_key)))
2199
def conflicts(self):
2201
confile = self._control_files.get('conflicts')
2202
except errors.NoSuchFile:
2203
return _mod_conflicts.ConflictList()
2205
if confile.next() != CONFLICT_HEADER_1 + '\n':
2206
raise errors.ConflictFormatError()
2207
except StopIteration:
2208
raise errors.ConflictFormatError()
2209
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2212
if self._control_files._lock_count == 1:
2213
# _inventory_is_modified is always False during a read lock.
2214
if self._inventory_is_modified:
2216
self._write_hashcache_if_dirty()
2217
# reverse order of locking.
2219
return self._control_files.unlock()
2221
self.branch.unlock()
2224
def get_conflicted_stem(path):
2225
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2226
if path.endswith(suffix):
2227
return path[:-len(suffix)]
2230
@deprecated_function(zero_eight)
2231
def is_control_file(filename):
2232
"""See WorkingTree.is_control_filename(filename)."""
2233
## FIXME: better check
2234
filename = normpath(filename)
2235
while filename != '':
2236
head, tail = os.path.split(filename)
2237
## mutter('check %r for control file' % ((head, tail),))
2240
if filename == head:
2246
class WorkingTreeFormat(object):
2247
"""An encapsulation of the initialization and open routines for a format.
2249
Formats provide three things:
2250
* An initialization routine,
2254
Formats are placed in an dict by their format string for reference
2255
during workingtree opening. Its not required that these be instances, they
2256
can be classes themselves with class methods - it simply depends on
2257
whether state is needed for a given format or not.
2259
Once a format is deprecated, just deprecate the initialize and open
2260
methods on the format class. Do not deprecate the object, as the
2261
object will be created every time regardless.
2264
_default_format = None
2265
"""The default format used for new trees."""
2268
"""The known formats."""
2271
def find_format(klass, a_bzrdir):
2272
"""Return the format for the working tree object in a_bzrdir."""
2274
transport = a_bzrdir.get_workingtree_transport(None)
2275
format_string = transport.get("format").read()
2276
return klass._formats[format_string]
2277
except errors.NoSuchFile:
2278
raise errors.NoWorkingTree(base=transport.base)
2280
raise errors.UnknownFormatError(format=format_string)
2283
def get_default_format(klass):
2284
"""Return the current default format."""
2285
return klass._default_format
2287
def get_format_string(self):
2288
"""Return the ASCII format string that identifies this format."""
2289
raise NotImplementedError(self.get_format_string)
2291
def get_format_description(self):
2292
"""Return the short description for this format."""
2293
raise NotImplementedError(self.get_format_description)
2295
def is_supported(self):
2296
"""Is this format supported?
2298
Supported formats can be initialized and opened.
2299
Unsupported formats may not support initialization or committing or
2300
some other features depending on the reason for not being supported.
2305
def register_format(klass, format):
2306
klass._formats[format.get_format_string()] = format
2309
def set_default_format(klass, format):
2310
klass._default_format = format
2313
def unregister_format(klass, format):
2314
assert klass._formats[format.get_format_string()] is format
2315
del klass._formats[format.get_format_string()]
2319
class WorkingTreeFormat2(WorkingTreeFormat):
2320
"""The second working tree format.
2322
This format modified the hash cache from the format 1 hash cache.
2325
def get_format_description(self):
2326
"""See WorkingTreeFormat.get_format_description()."""
2327
return "Working tree format 2"
2329
def stub_initialize_remote(self, control_files):
2330
"""As a special workaround create critical control files for a remote working tree
2332
This ensures that it can later be updated and dealt with locally,
2333
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2334
no working tree. (See bug #43064).
2338
xml5.serializer_v5.write_inventory(inv, sio)
2340
control_files.put('inventory', sio)
2342
control_files.put_bytes('pending-merges', '')
2345
def initialize(self, a_bzrdir, revision_id=None):
2346
"""See WorkingTreeFormat.initialize()."""
2347
if not isinstance(a_bzrdir.transport, LocalTransport):
2348
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2349
branch = a_bzrdir.open_branch()
2350
if revision_id is not None:
2351
revision_id = osutils.safe_revision_id(revision_id)
2354
revision_history = branch.revision_history()
2356
position = revision_history.index(revision_id)
2358
raise errors.NoSuchRevision(branch, revision_id)
2359
branch.set_revision_history(revision_history[:position + 1])
2362
revision = branch.last_revision()
2364
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2370
basis_tree = branch.repository.revision_tree(revision)
2371
if basis_tree.inventory.root is not None:
2372
wt.set_root_id(basis_tree.inventory.root.file_id)
2373
# set the parent list and cache the basis tree.
2374
wt.set_parent_trees([(revision, basis_tree)])
2375
transform.build_tree(basis_tree, wt)
2379
super(WorkingTreeFormat2, self).__init__()
2380
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2382
def open(self, a_bzrdir, _found=False):
2383
"""Return the WorkingTree object for a_bzrdir
2385
_found is a private parameter, do not use it. It is used to indicate
2386
if format probing has already been done.
2389
# we are being called directly and must probe.
2390
raise NotImplementedError
2391
if not isinstance(a_bzrdir.transport, LocalTransport):
2392
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2393
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2399
class WorkingTreeFormat3(WorkingTreeFormat):
2400
"""The second working tree format updated to record a format marker.
2403
- exists within a metadir controlling .bzr
2404
- includes an explicit version marker for the workingtree control
2405
files, separate from the BzrDir format
2406
- modifies the hash cache format
2408
- uses a LockDir to guard access for writes.
2411
def get_format_string(self):
2412
"""See WorkingTreeFormat.get_format_string()."""
2413
return "Bazaar-NG Working Tree format 3"
2415
def get_format_description(self):
2416
"""See WorkingTreeFormat.get_format_description()."""
2417
return "Working tree format 3"
2419
_lock_file_name = 'lock'
2420
_lock_class = LockDir
2422
def _open_control_files(self, a_bzrdir):
2423
transport = a_bzrdir.get_workingtree_transport(None)
2424
return LockableFiles(transport, self._lock_file_name,
2427
def initialize(self, a_bzrdir, revision_id=None):
2428
"""See WorkingTreeFormat.initialize().
2430
revision_id allows creating a working tree at a different
2431
revision than the branch is at.
2433
if not isinstance(a_bzrdir.transport, LocalTransport):
2434
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2435
transport = a_bzrdir.get_workingtree_transport(self)
2436
control_files = self._open_control_files(a_bzrdir)
2437
control_files.create_lock()
2438
control_files.lock_write()
2439
control_files.put_utf8('format', self.get_format_string())
2440
branch = a_bzrdir.open_branch()
2441
if revision_id is None:
2442
revision_id = branch.last_revision()
2444
revision_id = osutils.safe_revision_id(revision_id)
2445
# WorkingTree3 can handle an inventory which has a unique root id.
2446
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2447
# those trees. And because there isn't a format bump inbetween, we
2448
# are maintaining compatibility with older clients.
2449
# inv = Inventory(root_id=gen_root_id())
2451
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2457
_control_files=control_files)
2458
wt.lock_tree_write()
2460
basis_tree = branch.repository.revision_tree(revision_id)
2461
# only set an explicit root id if there is one to set.
2462
if basis_tree.inventory.root is not None:
2463
wt.set_root_id(basis_tree.inventory.root.file_id)
2464
if revision_id == NULL_REVISION:
2465
wt.set_parent_trees([])
2467
wt.set_parent_trees([(revision_id, basis_tree)])
2468
transform.build_tree(basis_tree, wt)
2470
# Unlock in this order so that the unlock-triggers-flush in
2471
# WorkingTree is given a chance to fire.
2472
control_files.unlock()
2477
super(WorkingTreeFormat3, self).__init__()
2478
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2480
def open(self, a_bzrdir, _found=False):
2481
"""Return the WorkingTree object for a_bzrdir
2483
_found is a private parameter, do not use it. It is used to indicate
2484
if format probing has already been done.
2487
# we are being called directly and must probe.
2488
raise NotImplementedError
2489
if not isinstance(a_bzrdir.transport, LocalTransport):
2490
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2491
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2493
def _open(self, a_bzrdir, control_files):
2494
"""Open the tree itself.
2496
:param a_bzrdir: the dir for the tree.
2497
:param control_files: the control files for the tree.
2499
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2503
_control_files=control_files)
2506
return self.get_format_string()
2509
__default_format = WorkingTreeFormat3()
2510
WorkingTreeFormat.register_format(__default_format)
2511
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2512
WorkingTreeFormat.set_default_format(__default_format)
2513
# formats which have no format string are not discoverable
2514
# and not independently creatable, so are not registered.
2515
_legacy_formats = [WorkingTreeFormat2(),
2519
class WorkingTreeTestProviderAdapter(object):
2520
"""A tool to generate a suite testing multiple workingtree formats at once.
2522
This is done by copying the test once for each transport and injecting
2523
the transport_server, transport_readonly_server, and workingtree_format
2524
classes into each copy. Each copy is also given a new id() to make it
2528
def __init__(self, transport_server, transport_readonly_server, formats):
2529
self._transport_server = transport_server
2530
self._transport_readonly_server = transport_readonly_server
2531
self._formats = formats
2533
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2534
"""Clone test for adaption."""
2535
new_test = deepcopy(test)
2536
new_test.transport_server = self._transport_server
2537
new_test.transport_readonly_server = self._transport_readonly_server
2538
new_test.bzrdir_format = bzrdir_format
2539
new_test.workingtree_format = workingtree_format
2540
def make_new_test_id():
2541
new_id = "%s(%s)" % (test.id(), variation)
2542
return lambda: new_id
2543
new_test.id = make_new_test_id()
2546
def adapt(self, test):
2547
from bzrlib.tests import TestSuite
2548
result = TestSuite()
2549
for workingtree_format, bzrdir_format in self._formats:
2550
new_test = self._clone_test(
2553
workingtree_format, workingtree_format.__class__.__name__)
2554
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
