13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""WorkingTree object and friends.
19
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
23
new revision based on the workingtree and its inventory.
25
25
At the moment every WorkingTree has its own branch. Remote
51
59
conflicts as _mod_conflicts,
60
revision as _mod_revision,
69
77
import bzrlib.branch
70
78
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
78
83
from bzrlib import symbol_versioning
79
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lockable_files import LockableFiles
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
86
from bzrlib.lockable_files import LockableFiles, TransportLock
81
87
from bzrlib.lockdir import LockDir
82
88
import bzrlib.mutabletree
83
89
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
85
90
from bzrlib.osutils import (
93
100
supports_executable,
95
from bzrlib.filters import filtered_input_file
96
102
from bzrlib.trace import mutter, note
97
103
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
106
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
106
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
121
@deprecated_function(zero_thirteen)
122
def gen_file_id(name):
123
"""Return new file id for the basename 'name'.
125
Use bzrlib.generate_ids.gen_file_id() instead
127
return generate_ids.gen_file_id(name)
130
@deprecated_function(zero_thirteen)
132
"""Return a new tree-root file id.
134
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
136
return generate_ids.gen_root_id()
115
139
class TreeEntry(object):
116
140
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
142
This needs further inspection, it may be better to have
119
143
InventoryEntries without ids - though that seems wrong. For now,
120
144
this is a parallel hierarchy to InventoryEntry, and needs to become
121
145
one of several things: decorates to that hierarchy, children of, or
243
265
# the Format factory and creation methods that are
244
266
# permitted to do this.
245
267
self._set_inventory(_inventory, dirty=False)
246
self._detect_case_handling()
247
self._rules_searcher = None
248
self.views = self._make_views()
251
def user_transport(self):
252
return self.bzrdir.user_transport
255
def control_transport(self):
256
return self._transport
258
def _detect_case_handling(self):
259
wt_trans = self.bzrdir.get_workingtree_transport(None)
261
wt_trans.stat("FoRMaT")
262
except errors.NoSuchFile:
263
self.case_sensitive = True
265
self.case_sensitive = False
267
self._setup_directory_is_tree_reference()
269
269
branch = property(
270
270
fget=lambda self: self._branch,
285
285
self._control_files.break_lock()
286
286
self.branch.break_lock()
288
def _get_check_refs(self):
289
"""Return the references needed to perform a check of this tree.
291
The default implementation returns no refs, and is only suitable for
292
trees that have no local caching and can commit on ghosts at any time.
294
:seealso: bzrlib.check for details about check_refs.
298
288
def requires_rich_root(self):
299
289
return self._format.requires_rich_root
301
291
def supports_tree_reference(self):
304
def supports_content_filtering(self):
305
return self._format.supports_content_filtering()
307
def supports_views(self):
308
return self.views.supports_views()
310
294
def _set_inventory(self, inv, dirty):
311
295
"""Set the internal cached inventory.
387
356
if osutils.lexists(self.abspath(path)):
390
def all_file_ids(self):
391
"""See Tree.iter_all_file_ids"""
392
return set(self.inventory)
394
359
def __repr__(self):
395
360
return "<%s of %s>" % (self.__class__.__name__,
396
361
getattr(self, 'basedir', None))
398
363
def abspath(self, filename):
399
364
return pathjoin(self.basedir, filename)
366
def canonicalpath(self, filename):
367
"""Normanize filename"""
368
return self.relpath(self.abspath(filename))
401
370
def basis_tree(self):
402
371
"""Return RevisionTree for the current last revision.
404
373
If the left most parent is a ghost then the returned tree will be an
405
empty tree - one obtained by calling
406
repository.revision_tree(NULL_REVISION).
374
empty tree - one obtained by calling repository.revision_tree(None).
409
377
revision_id = self.get_parent_ids()[0]
422
389
# at this point ?
424
391
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
392
except errors.RevisionNotPresent:
426
393
# the basis tree *may* be a ghost or a low level error may have
427
# occurred. If the revision is present, its a problem, if its not
394
# occured. If the revision is present, its a problem, if its not
429
396
if self.branch.repository.has_revision(revision_id):
431
398
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
399
return self.branch.repository.revision_tree(None)
402
@deprecated_method(zero_eight)
403
def create(branch, directory):
404
"""Create a workingtree for branch at directory.
406
If existing_directory already exists it must have a .bzr directory.
407
If it does not exist, it will be created.
409
This returns a new WorkingTree object for the new checkout.
411
TODO FIXME RBC 20060124 when we have checkout formats in place this
412
should accept an optional revisionid to checkout [and reject this if
413
checking out into the same dir as a pre-checkout-aware branch format.]
415
XXX: When BzrDir is present, these should be created through that
418
warnings.warn('delete WorkingTree.create', stacklevel=3)
419
transport = get_transport(directory)
420
if branch.bzrdir.root_transport.base == transport.base:
422
return branch.bzrdir.create_workingtree()
423
# different directory,
424
# create a branch reference
425
# and now a working tree.
426
raise NotImplementedError
429
@deprecated_method(zero_eight)
430
def create_standalone(directory):
431
"""Create a checkout and a branch and a repo at directory.
433
Directory must exist and be empty.
435
please use BzrDir.create_standalone_workingtree
437
return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
439
def relpath(self, path):
439
440
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
442
The path may be absolute or relative. If its a relative path it is
442
443
interpreted relative to the python current working directory.
444
445
return osutils.relpath(self.basedir, path)
446
447
def has_filename(self, filename):
447
448
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
450
def get_file(self, file_id):
451
file_id = osutils.safe_file_id(file_id)
452
return self.get_file_byname(self.id2path(file_id))
454
def get_file_text(self, file_id):
455
file_id = osutils.safe_file_id(file_id)
456
return self.get_file(file_id).read()
458
def get_file_byname(self, filename):
459
return file(self.abspath(filename), 'rb')
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
462
def annotate_iter(self, file_id):
486
463
"""See Tree.annotate_iter
488
465
This implementation will use the basis tree implementation if possible.
492
469
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
470
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
472
file_id = osutils.safe_file_id(file_id)
473
basis = self.basis_tree()
476
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
477
require_versioned=True).next()
478
changed_content, kind = changes[2], changes[6]
479
if not changed_content:
480
return basis.annotate_iter(file_id)
484
if kind[0] != 'file':
487
old_lines = list(basis.annotate_iter(file_id))
489
for tree in self.branch.repository.revision_trees(
490
self.get_parent_ids()[1:]):
491
if file_id not in tree:
493
old.append(list(tree.annotate_iter(file_id)))
494
return annotate.reannotate(old, self.get_file(file_id).readlines(),
539
499
def get_parent_ids(self):
540
500
"""See Tree.get_parent_ids.
542
502
This implementation reads the pending merges list and last_revision
543
503
value and uses that to decide what the parents list should be.
545
last_rev = _mod_revision.ensure_null(self._last_revision())
546
if _mod_revision.NULL_REVISION == last_rev:
505
last_rev = self._last_revision()
549
509
parents = [last_rev]
551
merges_bytes = self._transport.get_bytes('pending-merges')
511
merges_file = self._control_files.get('pending-merges')
552
512
except errors.NoSuchFile:
555
for l in osutils.split_lines(merges_bytes):
556
revision_id = l.rstrip('\n')
515
for l in merges_file.readlines():
516
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
517
parents.append(revision_id)
561
521
def get_root_id(self):
562
522
"""Return the id of this trees root"""
563
523
return self._inventory.root.file_id
565
525
def _get_store_filename(self, file_id):
566
526
## XXX: badly named; this is not in the store at all
527
file_id = osutils.safe_file_id(file_id)
567
528
return self.abspath(self.id2path(file_id))
570
def clone(self, to_bzrdir, revision_id=None):
531
def clone(self, to_bzrdir, revision_id=None, basis=None):
571
532
"""Duplicate this working tree into to_bzr, including all state.
573
534
Specifically modified files are kept as modified, but
574
535
ignored and unknown files are discarded.
576
537
If you want to make a new line of development, see bzrdir.sprout()
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
540
If not None, the cloned tree will have its last revision set to
541
revision, and and difference between the source trees last revision
581
542
and this one merged in.
545
If not None, a closer copy of a tree which may have some files in
546
common, and which file content should be preferentially copied from.
583
548
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
549
result = self._format.initialize(to_bzrdir)
585
550
self.copy_content_into(result, revision_id)
616
584
__contains__ = has_id
618
586
def get_file_size(self, file_id):
619
"""See Tree.get_file_size"""
620
# XXX: this returns the on-disk size; it should probably return the
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
587
file_id = osutils.safe_file_id(file_id)
588
return os.path.getsize(self.id2abspath(file_id))
631
591
def get_file_sha1(self, file_id, path=None, stat_value=None):
592
file_id = osutils.safe_file_id(file_id)
633
594
path = self._inventory.id2path(file_id)
634
595
return self._hashcache.get_sha1(path, stat_value)
636
597
def get_file_mtime(self, file_id, path=None):
598
file_id = osutils.safe_file_id(file_id)
638
600
path = self.inventory.id2path(file_id)
639
601
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
603
if not supports_executable():
654
604
def is_executable(self, file_id, path=None):
605
file_id = osutils.safe_file_id(file_id)
655
606
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
608
def is_executable(self, file_id, path=None):
610
file_id = osutils.safe_file_id(file_id)
662
611
path = self.id2path(file_id)
663
612
mode = os.lstat(self.abspath(path)).st_mode
664
613
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
615
@needs_tree_write_lock
670
616
def _add(self, files, ids, kinds):
671
617
"""See MutableTree._add."""
672
618
# TODO: Re-adding a file that is removed in the working copy
673
619
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
620
# the read and write working inventory should not occur in this
675
621
# function - they should be part of lock_write and unlock.
622
inv = self.read_working_inventory()
677
623
for f, file_id, kind in zip(files, ids, kinds):
624
assert kind is not None
678
625
if file_id is None:
679
626
inv.add_path(f, kind=kind)
628
file_id = osutils.safe_file_id(file_id)
681
629
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
630
self._write_inventory(inv)
684
632
@needs_tree_write_lock
685
633
def _gather_kinds(self, files, kinds):
746
694
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
def path_content_summary(self, path, _lstat=os.lstat,
749
_mapper=osutils.file_kind_from_stat_mode):
750
"""See Tree.path_content_summary."""
751
abspath = self.abspath(path)
753
stat_result = _lstat(abspath)
755
if getattr(e, 'errno', None) == errno.ENOENT:
757
return ('missing', None, None, None)
758
# propagate other errors
760
kind = _mapper(stat_result.st_mode)
762
return self._file_content_summary(path, stat_result)
763
elif kind == 'directory':
764
# perhaps it looks like a plain directory, but it's really a
766
if self._directory_is_tree_reference(path):
767
kind = 'tree-reference'
768
return kind, None, None, None
769
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
773
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
return ('file', size, executable, self._sha_from_stat(
696
@deprecated_method(zero_eleven)
698
def pending_merges(self):
699
"""Return a list of pending merges.
701
These are revisions that have been merged into the working
702
directory but not yet committed.
704
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
705
instead - which is available on all tree objects.
707
return self.get_parent_ids()[1:]
782
709
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
710
"""Common ghost checking functionality from set_parent_*.
794
721
def _set_merges_from_parent_ids(self, parent_ids):
795
722
merges = parent_ids[1:]
796
self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
mode=self.bzrdir._get_file_mode())
799
def _filter_parent_ids_by_ancestry(self, revision_ids):
800
"""Check that all merged revisions are proper 'heads'.
802
This will always return the first revision_id, and any merged revisions
805
if len(revision_ids) == 0:
807
graph = self.branch.repository.get_graph()
808
heads = graph.heads(revision_ids)
809
new_revision_ids = revision_ids[:1]
810
for revision_id in revision_ids[1:]:
811
if revision_id in heads and revision_id not in new_revision_ids:
812
new_revision_ids.append(revision_id)
813
if new_revision_ids != revision_ids:
814
trace.mutter('requested to set revision_ids = %s,'
815
' but filtered to %s', revision_ids, new_revision_ids)
816
return new_revision_ids
723
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
725
@needs_tree_write_lock
819
726
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
727
"""Set the parent ids to revision_ids.
822
729
See also set_parent_trees. This api will try to retrieve the tree data
823
730
for each element of revision_ids from the trees repository. If you have
824
731
tree data already available, it is more efficient to use
828
735
:param revision_ids: The revision_ids to set as the parent ids of this
829
736
working tree. Any of these may be ghosts.
738
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
739
self._check_parents_for_ghosts(revision_ids,
832
740
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
742
if len(revision_ids) > 0:
839
743
self.set_last_revision(revision_ids[0])
841
self.set_last_revision(_mod_revision.NULL_REVISION)
745
self.set_last_revision(None)
843
747
self._set_merges_from_parent_ids(revision_ids)
845
749
@needs_tree_write_lock
846
750
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
751
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
752
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
852
754
self._check_parents_for_ghosts(parent_ids,
853
755
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
757
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
758
leftmost_parent_id = None
859
759
leftmost_parent_tree = None
861
761
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
886
786
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
787
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
889
def _sha_from_stat(self, path, stat_result):
890
"""Get a sha digest from the tree's stat cache.
892
The default implementation assumes no stat cache is present.
894
:param path: The path.
895
:param stat_result: The stat result being looked up.
899
789
def _put_rio(self, filename, stanzas, header):
900
790
self._must_be_locked()
901
791
my_file = rio_file(stanzas, header)
902
self._transport.put_file(filename, my_file,
903
mode=self.bzrdir._get_file_mode())
792
self._control_files.put(filename, my_file)
905
794
@needs_write_lock # because merge pulls data into the branch.
906
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
merge_type=None, force=False):
795
def merge_from_branch(self, branch, to_revision=None):
908
796
"""Merge from a branch into this working tree.
910
798
:param branch: The branch to merge from.
914
802
branch.last_revision().
916
804
from bzrlib.merge import Merger, Merge3Merger
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
805
pb = bzrlib.ui.ui_factory.nested_progress_bar()
807
merger = Merger(self.branch, this_tree=self, pb=pb)
808
merger.pp = ProgressPhase("Merge phase", 5, pb)
809
merger.pp.next_phase()
810
# check that there are no
812
merger.check_basis(check_clean=True, require_commits=False)
813
if to_revision is None:
814
to_revision = branch.last_revision()
816
to_revision = osutils.safe_revision_id(to_revision)
817
merger.other_rev_id = to_revision
818
if merger.other_rev_id is None:
819
raise error.NoCommits(branch)
820
self.branch.fetch(branch, last_revision=merger.other_rev_id)
821
merger.other_basis = merger.other_rev_id
822
merger.other_tree = self.branch.repository.revision_tree(
824
merger.other_branch = branch
825
merger.pp.next_phase()
932
826
merger.find_base()
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
827
if merger.base_rev_id == merger.other_rev_id:
828
raise errors.PointlessMerge
829
merger.backup_files = False
939
830
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
831
merger.set_interesting_files(None)
832
merger.show_base = False
833
merger.reprocess = False
834
conflicts = merger.do_merge()
950
841
def merge_modified(self):
951
842
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
844
The list is initialized by WorkingTree.set_merge_modified, which is
954
845
typically called after we make some automatic updates to the tree
955
846
because of a merge.
958
849
still in the working inventory and have that text hash.
961
hashfile = self._transport.get('merge-hashes')
852
hashfile = self._control_files.get('merge-hashes')
962
853
except errors.NoSuchFile:
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
857
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
858
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
merge_hashes[file_id] = text_hash
859
except StopIteration:
860
raise errors.MergeModifiedFormatError()
861
for s in RioReader(hashfile):
862
# RioReader reads in Unicode, so convert file_ids back to utf8
863
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
864
if file_id not in self.inventory:
866
text_hash = s.get("hash")
867
if text_hash == self.get_file_sha1(file_id):
868
merge_hashes[file_id] = text_hash
983
871
@needs_write_lock
984
872
def mkdir(self, path, file_id=None):
1036
923
other_tree.unlock()
1037
924
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
926
@needs_tree_write_lock
1066
927
def extract(self, file_id, format=None):
1067
928
"""Extract a subtree from this tree.
1069
930
A new branch will be created, relative to the path for this tree.
1074
935
transport = self.branch.bzrdir.root_transport
1075
936
for name in segments:
1076
937
transport = transport.clone(name)
1077
transport.ensure_base()
940
except errors.FileExists:
1078
942
return transport
1080
944
sub_path = self.id2path(file_id)
1081
945
branch_transport = mkdirs(sub_path)
1082
946
if format is None:
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
947
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
949
branch_transport.mkdir('.')
950
except errors.FileExists:
1085
952
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
954
repo = branch_bzrdir.find_repository()
1088
955
except errors.NoRepositoryPresent:
1089
956
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
957
assert repo.supports_rich_root()
959
if not repo.supports_rich_root():
960
raise errors.RootNotRich()
1092
961
new_branch = branch_bzrdir.create_branch()
1093
962
new_branch.pull(self.branch)
1094
963
for parent_id in self.get_parent_ids():
1096
965
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
966
if tree_transport.base != branch_transport.base:
1098
967
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
968
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
970
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
971
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
972
wt.set_parent_ids(self.get_parent_ids())
1105
973
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
974
child_inv = Inventory(root_id=None)
1107
975
new_root = my_inv[file_id]
1108
976
my_inv.remove_recursive_id(file_id)
1109
977
new_root.parent_id = None
1127
994
sio = StringIO()
1128
995
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
997
self._control_files.put('inventory', sio)
1132
998
self._inventory_is_modified = False
1134
1000
def _kind(self, relpath):
1135
1001
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
1003
def list_files(self, include_root=False):
1004
"""Recursively list all files as (path, class, kind, id, entry).
1140
1006
Lists, but does not descend into unversioned directories.
1141
1008
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
1011
Skips the control directory.
1148
1013
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1014
# with it. So callers should be careful to always read_lock the tree.
1164
1029
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1031
# directory file_id, relative path, absolute path, reverse sorted children
1167
if from_dir is not None:
1168
from_dir_id = inv.path2id(from_dir)
1169
if from_dir_id is None:
1170
# Directory not versioned
1172
from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
from_dir_id = inv.root.file_id
1175
from_dir_abspath = self.basedir
1176
children = os.listdir(from_dir_abspath)
1032
children = os.listdir(self.basedir)
1177
1033
children.sort()
1178
# jam 20060527 The kernel sized tree seems equivalent whether we
1034
# jam 20060527 The kernel sized tree seems equivalent whether we
1179
1035
# use a deque and popleft to keep them sorted, or if we use a plain
1180
1036
# list and just reverse() them.
1181
1037
children = collections.deque(children)
1182
stack = [(from_dir_id, u'', from_dir_abspath, children)]
1038
stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1040
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1239
1095
except KeyError:
1240
1096
yield fp[1:], c, fk, None, TreeEntry()
1243
1099
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
1102
# But do this child first
1103
new_children = os.listdir(fap)
1105
new_children = collections.deque(new_children)
1106
stack.append((f_ie.file_id, fp, fap, new_children))
1107
# Break out of inner loop,
1108
# so that we start outer loop with child
1256
1111
# if we finished all children, pop it off the stack
1493
1343
from_tail = splitpath(from_rel)[-1]
1494
1344
from_id = inv.path2id(from_rel)
1495
1345
if from_id is None:
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1346
raise errors.BzrRenameFailedError(from_rel,to_rel,
1347
errors.NotVersionedError(path=str(from_rel)))
1348
from_entry = inv[from_id]
1507
1349
from_parent_id = from_entry.parent_id
1508
1350
to_dir, to_tail = os.path.split(to_rel)
1509
1351
to_dir_id = inv.path2id(to_dir)
1571
1413
:raises: NoSuchId if any fileid is not currently versioned.
1573
1415
for file_id in file_ids:
1574
if file_id not in self._inventory:
1575
raise errors.NoSuchId(self, file_id)
1576
for file_id in file_ids:
1416
file_id = osutils.safe_file_id(file_id)
1577
1417
if self._inventory.has_id(file_id):
1578
1418
self._inventory.remove_recursive_id(file_id)
1420
raise errors.NoSuchId(self, file_id)
1579
1421
if len(file_ids):
1580
# in the future this should just set a dirty bit to wait for the
1422
# in the future this should just set a dirty bit to wait for the
1581
1423
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1424
# with the current in -memory inventory rather than triggering
1583
1425
# a read, it is more complex - we need to teach read_inventory
1584
1426
# to know when to read, and when to not read first... and possibly
1585
1427
# to save first when the in memory one may be corrupted.
1586
1428
# so for now, we just only write it if it is indeed dirty.
1587
1429
# - RBC 20060907
1588
1430
self._write_inventory(self._inventory)
1432
@deprecated_method(zero_eight)
1433
def iter_conflicts(self):
1434
"""List all files in the tree that have text or content conflicts.
1435
DEPRECATED. Use conflicts instead."""
1436
return self._iter_conflicts()
1590
1438
def _iter_conflicts(self):
1591
1439
conflicted = set()
1601
1449
@needs_write_lock
1602
1450
def pull(self, source, overwrite=False, stop_revision=None,
1603
change_reporter=None, possible_transports=None, local=False):
1451
change_reporter=None):
1452
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1453
source.lock_read()
1455
pp = ProgressPhase("Pull phase", 2, top_pb)
1606
1457
old_revision_info = self.branch.last_revision_info()
1607
1458
basis_tree = self.basis_tree()
1608
count = self.branch.pull(source, overwrite, stop_revision,
1609
possible_transports=possible_transports,
1459
count = self.branch.pull(source, overwrite, stop_revision)
1611
1460
new_revision_info = self.branch.last_revision_info()
1612
1461
if new_revision_info != old_revision_info:
1613
1463
repository = self.branch.repository
1464
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1465
basis_tree.lock_read()
1616
1467
new_basis_tree = self.branch.basis_tree()
1619
1470
new_basis_tree,
1621
1472
this_tree=self,
1623
1474
change_reporter=change_reporter)
1624
basis_root_id = basis_tree.get_root_id()
1625
new_root_id = new_basis_tree.get_root_id()
1626
if basis_root_id != new_root_id:
1627
self.set_root_id(new_root_id)
1475
if (basis_tree.inventory.root is None and
1476
new_basis_tree.inventory.root is not None):
1477
self.set_root_id(new_basis_tree.inventory.root.file_id)
1629
1480
basis_tree.unlock()
1630
1481
# TODO - dedup parents list with things merged by pull ?
1631
1482
# reuse the revisiontree we merged against to set the new
1633
1484
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
# we have to pull the merge trees out again, because
1635
# merge_inner has set the ids. - this corner is not yet
1485
# we have to pull the merge trees out again, because
1486
# merge_inner has set the ids. - this corner is not yet
1636
1487
# layered well enough to prevent double handling.
1637
1488
# XXX TODO: Fix the double handling: telling the tree about
1638
1489
# the already known parent data is wasteful.
1734
1580
r"""Check whether the filename matches an ignore pattern.
1736
1582
Patterns containing '/' or '\' need to match the whole path;
1737
others match against only the last component. Patterns starting
1738
with '!' are ignore exceptions. Exceptions take precedence
1739
over regular patterns and cause the filename to not be ignored.
1583
others match against only the last component.
1741
1585
If the file is ignored, returns the pattern which caused it to
1742
1586
be ignored, otherwise None. So this can simply be used as a
1743
1587
boolean if desired."""
1744
1588
if getattr(self, '_ignoreglobster', None) is None:
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1589
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1590
return self._ignoreglobster.match(filename)
1748
1592
def kind(self, file_id):
1749
1593
return file_kind(self.id2abspath(file_id))
1751
def stored_kind(self, file_id):
1752
"""See Tree.stored_kind"""
1753
return self.inventory[file_id].kind
1755
1595
def _comparison_data(self, entry, path):
1756
1596
abspath = self.abspath(path)
1839
1679
def _reset_data(self):
1840
1680
"""Reset transient data that cannot be revalidated."""
1841
1681
self._inventory_is_modified = False
1842
f = self._transport.get('inventory')
1844
result = self._deserialize(f)
1682
result = self._deserialize(self._control_files.get('inventory'))
1847
1683
self._set_inventory(result, dirty=False)
1849
1685
@needs_tree_write_lock
1850
1686
def set_last_revision(self, new_revision):
1851
1687
"""Change the last revision in the working tree."""
1688
new_revision = osutils.safe_revision_id(new_revision)
1852
1689
if self._change_last_revision(new_revision):
1853
1690
self._cache_basis_inventory(new_revision)
1855
1692
def _change_last_revision(self, new_revision):
1856
1693
"""Template method part of set_last_revision to perform the change.
1858
1695
This is used to allow WorkingTree3 instances to not affect branch
1859
1696
when their last revision is set.
1861
if _mod_revision.is_null(new_revision):
1698
if new_revision is None:
1862
1699
self.branch.set_revision_history([])
1871
1708
def _write_basis_inventory(self, xml):
1872
1709
"""Write the basis inventory XML to the basis-inventory file"""
1710
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1711
path = self._basis_inventory_name()
1874
1712
sio = StringIO(xml)
1875
self._transport.put_file(path, sio,
1876
mode=self.bzrdir._get_file_mode())
1713
self._control_files.put(path, sio)
1878
1715
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1716
"""Create the text that will be saved in basis-inventory"""
1880
inventory.revision_id = revision_id
1717
# TODO: jam 20070209 This should be redundant, as the revision_id
1718
# as all callers should have already converted the revision_id to
1720
inventory.revision_id = osutils.safe_revision_id(revision_id)
1881
1721
return xml7.serializer_v7.write_inventory_to_string(inventory)
1883
1723
def _cache_basis_inventory(self, new_revision):
1886
1726
# as commit already has that ready-to-use [while the format is the
1887
1727
# same, that is].
1889
# this double handles the inventory - unpack and repack -
1729
# this double handles the inventory - unpack and repack -
1890
1730
# but is easier to understand. We can/should put a conditional
1891
1731
# in here based on whether the inventory is in the latest format
1892
1732
# - perhaps we should repack all inventories on a repository
1894
1734
# the fast path is to copy the raw xml from the repository. If the
1895
# xml contains 'revision_id="', then we assume the right
1735
# xml contains 'revision_id="', then we assume the right
1896
1736
# revision_id is set. We must check for this full string, because a
1897
1737
# root node id can legitimately look like 'revision_id' but cannot
1898
1738
# contain a '"'.
1899
xml = self.branch.repository._get_inventory_xml(new_revision)
1739
xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1740
firstline = xml.split('\n', 1)[0]
1901
if (not 'revision_id="' in firstline or
1741
if (not 'revision_id="' in firstline or
1902
1742
'format="7"' not in firstline):
1903
inv = self.branch.repository._serializer.read_inventory_from_string(
1743
inv = self.branch.repository.deserialise_inventory(
1905
1745
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1746
self._write_basis_inventory(xml)
1907
1747
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1750
def read_basis_inventory(self):
1911
1751
"""Read the cached basis inventory."""
1912
1752
path = self._basis_inventory_name()
1913
return self._transport.get_bytes(path)
1753
return self._control_files.get(path).read()
1915
1755
@needs_read_lock
1916
1756
def read_working_inventory(self):
1917
1757
"""Read the working inventory.
1919
1759
:raises errors.InventoryModified: read_working_inventory will fail
1920
1760
when the current in memory inventory has been modified.
1922
# conceptually this should be an implementation detail of the tree.
1762
# conceptually this should be an implementation detail of the tree.
1923
1763
# XXX: Deprecate this.
1924
1764
# ElementTree does its own conversion from UTF-8, so open in
1926
1766
if self._inventory_is_modified:
1927
1767
raise errors.InventoryModified(self)
1928
f = self._transport.get('inventory')
1930
result = self._deserialize(f)
1768
result = self._deserialize(self._control_files.get('inventory'))
1933
1769
self._set_inventory(result, dirty=False)
1936
1772
@needs_tree_write_lock
1937
1773
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1939
"""Remove nominated files from the working inventory.
1775
"""Remove nominated files from the working inventor.
1941
1777
:files: File paths relative to the basedir.
1942
1778
:keep_files: If true, the files will also be kept.
1946
1782
if isinstance(files, basestring):
1947
1783
files = [files]
1785
inv = self.inventory
1951
1787
new_files=set()
1952
unknown_nested_files=set()
1954
to_file = sys.stdout
1788
unknown_files_in_directory=set()
1956
1790
def recurse_directory_to_add_files(directory):
1957
# Recurse directory and add all files
1791
# recurse directory and add all files
1958
1792
# so we can check if they have changed.
1959
for parent_info, file_infos in\
1960
self.walkdirs(directory):
1961
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
# Is it versioned or ignored?
1963
if self.path2id(relpath) or self.is_ignored(relpath):
1964
# Add nested content for deletion.
1965
new_files.add(relpath)
1967
# Files which are not versioned and not ignored
1968
# should be treated as unknown.
1969
unknown_nested_files.add((relpath, None, kind))
1793
for contained_dir_info in self.walkdirs(directory):
1794
for file_info in contained_dir_info[1]:
1795
if file_info[2] == 'file':
1796
canonicalpath = self.canonicalpath(file_info[0])
1797
if file_info[4]: #is it versioned?
1798
new_files.add(canonicalpath)
1800
unknown_files_in_directory.add(
1801
(canonicalpath, None, file_info[2]))
1971
1803
for filename in files:
1972
1804
# Get file name into canonical form.
1973
abspath = self.abspath(filename)
1974
filename = self.relpath(abspath)
1805
filename = self.canonicalpath(filename)
1975
1806
if len(filename) > 0:
1976
1807
new_files.add(filename)
1977
recurse_directory_to_add_files(filename)
1979
files = list(new_files)
1982
return # nothing to do
1808
if osutils.isdir(filename):
1809
recurse_directory_to_add_files(filename)
1810
files = [f for f in new_files]
1984
1812
# Sort needed to first handle directory content before the directory
1985
1813
files.sort(reverse=True)
1987
# Bail out if we are going to delete files we shouldn't
1988
1814
if not keep_files and not force:
1989
has_changed_files = len(unknown_nested_files) > 0
1990
if not has_changed_files:
1991
for (file_id, path, content_change, versioned, parent_id, name,
1992
kind, executable) in self.iter_changes(self.basis_tree(),
1993
include_unchanged=True, require_versioned=False,
1994
want_unversioned=True, specific_files=files):
1995
if versioned == (False, False):
1996
# The record is unknown ...
1997
if not self.is_ignored(path[1]):
1998
# ... but not ignored
1999
has_changed_files = True
2001
elif content_change and (kind[1] is not None):
2002
# Versioned and changed, but not deleted
2003
has_changed_files = True
2006
if has_changed_files:
2007
# Make delta show ALL applicable changes in error message.
2008
tree_delta = self.changes_from(self.basis_tree(),
2009
require_versioned=False, want_unversioned=True,
2010
specific_files=files)
2011
for unknown_file in unknown_nested_files:
2012
if unknown_file not in tree_delta.unversioned:
2013
tree_delta.unversioned.extend((unknown_file,))
1815
tree_delta = self.changes_from(self.basis_tree(),
1816
specific_files=files)
1817
for unknown_file in unknown_files_in_directory:
1818
tree_delta.unversioned.extend((unknown_file,))
1819
if bool(tree_delta.modified
1821
or tree_delta.renamed
1822
or tree_delta.kind_changed
1823
or tree_delta.unversioned):
2014
1824
raise errors.BzrRemoveChangedFilesError(tree_delta)
2016
# Build inv_delta and delete files where applicable,
2017
# do this before any modifications to inventory.
1826
# do this before any modifications
2018
1827
for f in files:
2019
fid = self.path2id(f)
1828
fid = inv.path2id(f)
2022
message = "%s is not versioned." % (f,)
1831
message="%s is not versioned." % (f,)
2025
1834
# having removed it, it must be either ignored or unknown
2027
1836
new_status = 'I'
2029
1838
new_status = '?'
2030
# XXX: Really should be a more abstract reporter interface
2031
kind_ch = osutils.kind_marker(self.kind(fid))
2032
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2034
inv_delta.append((f, None, fid, None))
2035
message = "removed %s" % (f,)
1839
textui.show_status(new_status, inv[fid].kind, f,
1843
message="removed %s" % (f,)
2037
1845
if not keep_files:
2038
abs_path = self.abspath(f)
2039
if osutils.lexists(abs_path):
2040
if (osutils.isdir(abs_path) and
2041
len(os.listdir(abs_path)) > 0):
2043
osutils.rmtree(abs_path)
2045
message = "%s is not an empty directory "\
2046
"and won't be deleted." % (f,)
1846
if osutils.lexists(f):
1847
if osutils.isdir(f) and len(os.listdir(f)) > 0:
1848
message="%s is not empty directory "\
1849
"and won't be deleted." % (f,)
2048
osutils.delete_any(abs_path)
2049
message = "deleted %s" % (f,)
1851
osutils.delete_any(f)
1852
message="deleted %s" % (f,)
2050
1853
elif message is not None:
2051
# Only care if we haven't done anything yet.
2052
message = "%s does not exist." % (f,)
1854
# only care if we haven't done anything yet.
1855
message="%s does not exist." % (f,)
2054
# Print only one message (if any) per file.
1857
# print only one message (if any) per file.
2055
1858
if message is not None:
2057
self.apply_inventory_delta(inv_delta)
1860
self._write_inventory(inv)
2059
1862
@needs_tree_write_lock
2060
def revert(self, filenames=None, old_tree=None, backups=True,
2061
pb=None, report_changes=False):
1863
def revert(self, filenames, old_tree=None, backups=True,
1864
pb=DummyProgress(), report_changes=False):
2062
1865
from bzrlib.conflicts import resolve
2065
symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
' as of bzr 0.91. Please use None (the default) instead.',
2067
DeprecationWarning, stacklevel=2)
2068
1866
if old_tree is None:
2069
basis_tree = self.basis_tree()
2070
basis_tree.lock_read()
2071
old_tree = basis_tree
1867
old_tree = self.basis_tree()
1868
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1870
if not len(filenames):
1871
self.set_parent_ids(self.get_parent_ids()[:1])
2075
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2077
if filenames is None and len(self.get_parent_ids()) > 1:
2079
last_revision = self.last_revision()
2080
if last_revision != _mod_revision.NULL_REVISION:
2081
if basis_tree is None:
2082
basis_tree = self.basis_tree()
2083
basis_tree.lock_read()
2084
parent_trees.append((last_revision, basis_tree))
2085
self.set_parent_trees(parent_trees)
2088
resolve(self, filenames, ignore_misses=True, recursive=True)
2090
if basis_tree is not None:
1874
resolve(self, filenames, ignore_misses=True)
2092
1875
return conflicts
2094
1877
def revision_tree(self, revision_id):
2142
1926
@needs_tree_write_lock
2143
1927
def set_root_id(self, file_id):
2144
1928
"""Set the root id for this tree."""
2146
1930
if file_id is None:
2148
'WorkingTree.set_root_id with fileid=None')
2149
file_id = osutils.safe_file_id(file_id)
1931
symbol_versioning.warn(symbol_versioning.zero_twelve
1932
% 'WorkingTree.set_root_id with fileid=None',
1937
file_id = osutils.safe_file_id(file_id)
2150
1938
self._set_root_id(file_id)
2152
1940
def _set_root_id(self, file_id):
2153
1941
"""Set the root id for this tree, in a format specific manner.
2155
:param file_id: The file id to assign to the root. It must not be
1943
:param file_id: The file id to assign to the root. It must not be
2156
1944
present in the current inventory or an error will occur. It must
2157
1945
not be None, but rather a valid file id.
2178
1966
def unlock(self):
2179
1967
"""See Branch.unlock.
2181
1969
WorkingTree locking just uses the Branch locking facilities.
2182
1970
This is current because all working trees have an embedded branch
2183
1971
within them. IF in the future, we were to make branch data shareable
2184
between multiple working trees, i.e. via shared storage, then we
1972
between multiple working trees, i.e. via shared storage, then we
2185
1973
would probably want to lock both the local tree, and the branch.
2187
1975
raise NotImplementedError(self.unlock)
2191
def update(self, change_reporter=None, possible_transports=None,
2192
revision=None, old_tip=_marker):
2193
1978
"""Update a working tree along its branch.
2195
1980
This will update the branch if its bound too, which means we have
2213
1998
- Merge current state -> basis tree of the master w.r.t. the old tree
2215
2000
- Do a 'normal' merge of the old branch basis if it is relevant.
2217
:param revision: The target revision to update to. Must be in the
2219
:param old_tip: If branch.update() has already been run, the value it
2220
returned (old tip of the branch or None). _marker is used
2223
if self.branch.get_bound_location() is not None:
2002
if self.branch.get_master_branch() is not None:
2224
2003
self.lock_write()
2225
update_branch = (old_tip is self._marker)
2004
update_branch = True
2227
2006
self.lock_tree_write()
2228
2007
update_branch = False
2230
2009
if update_branch:
2231
old_tip = self.branch.update(possible_transports)
2010
old_tip = self.branch.update()
2233
if old_tip is self._marker:
2235
return self._update_tree(old_tip, change_reporter, revision)
2013
return self._update_tree(old_tip)
2239
2017
@needs_tree_write_lock
2240
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2018
def _update_tree(self, old_tip=None):
2241
2019
"""Update a tree to the master branch.
2243
2021
:param old_tip: if supplied, the previous tip revision the branch,
2249
2027
# cant set that until we update the working trees last revision to be
2250
2028
# one from the new branch, because it will just get absorbed by the
2251
2029
# parent de-duplication logic.
2253
2031
# We MUST save it even if an error occurs, because otherwise the users
2254
2032
# local work is unreferenced and will appear to have been lost.
2258
2036
last_rev = self.get_parent_ids()[0]
2259
2037
except IndexError:
2260
last_rev = _mod_revision.NULL_REVISION
2261
if revision is None:
2262
revision = self.branch.last_revision()
2264
old_tip = old_tip or _mod_revision.NULL_REVISION
2266
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
# the branch we are bound to was updated
2268
# merge those changes in first
2269
base_tree = self.basis_tree()
2270
other_tree = self.branch.repository.revision_tree(old_tip)
2271
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
base_tree, this_tree=self,
2273
change_reporter=change_reporter)
2275
self.add_parent_tree((old_tip, other_tree))
2276
trace.note('Rerun update after fixing the conflicts.')
2279
if last_rev != _mod_revision.ensure_null(revision):
2280
# the working tree is up to date with the branch
2281
# we can merge the specified revision from master
2282
to_tree = self.branch.repository.revision_tree(revision)
2283
to_root_id = to_tree.get_root_id()
2039
if last_rev != self.branch.last_revision():
2040
# merge tree state up to new branch tip.
2285
2041
basis = self.basis_tree()
2286
2042
basis.lock_read()
2288
if (basis.inventory.root is None
2289
or basis.inventory.root.file_id != to_root_id):
2290
self.set_root_id(to_root_id)
2044
to_tree = self.branch.basis_tree()
2045
if basis.inventory.root is None:
2046
self.set_root_id(to_tree.inventory.root.file_id)
2048
result += merge.merge_inner(
2295
# determine the branch point
2296
graph = self.branch.repository.get_graph()
2297
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2299
base_tree = self.branch.repository.revision_tree(base_rev_id)
2301
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2303
change_reporter=change_reporter)
2304
self.set_last_revision(revision)
2305
2055
# TODO - dedup parents list with things merged by pull ?
2306
2056
# reuse the tree we've updated to to set the basis:
2307
parent_trees = [(revision, to_tree)]
2057
parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2058
merges = self.get_parent_ids()[1:]
2309
2059
# Ideally we ask the tree for the trees here, that way the working
2310
# tree can decide whether to give us the entire tree or give us a
2060
# tree can decide whether to give us teh entire tree or give us a
2311
2061
# lazy initialised tree. dirstate for instance will have the trees
2312
2062
# in ram already, whereas a last-revision + basis-inventory tree
2313
2063
# will not, but also does not need them when setting parents.
2314
2064
for parent in merges:
2315
2065
parent_trees.append(
2316
2066
(parent, self.branch.repository.revision_tree(parent)))
2317
if not _mod_revision.is_null(old_tip):
2067
if old_tip is not None:
2318
2068
parent_trees.append(
2319
2069
(old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2070
self.set_parent_trees(parent_trees)
2321
2071
last_rev = parent_trees[0][0]
2073
# the working tree had the same last-revision as the master
2074
# branch did. We may still have pivot local work from the local
2075
# branch into old_tip:
2076
if old_tip is not None:
2077
self.add_parent_tree_id(old_tip)
2078
if old_tip and old_tip != last_rev:
2079
# our last revision was not the prior branch last revision
2080
# and we have converted that last revision to a pending merge.
2081
# base is somewhere between the branch tip now
2082
# and the now pending merge
2084
# Since we just modified the working tree and inventory, flush out
2085
# the current state, before we modify it again.
2086
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2087
# requires it only because TreeTransform directly munges the
2088
# inventory and calls tree._write_inventory(). Ultimately we
2089
# should be able to remove this extra flush.
2091
from bzrlib.revision import common_ancestor
2093
base_rev_id = common_ancestor(self.branch.last_revision(),
2095
self.branch.repository)
2096
except errors.NoCommonAncestor:
2098
base_tree = self.branch.repository.revision_tree(base_rev_id)
2099
other_tree = self.branch.repository.revision_tree(old_tip)
2100
result += merge.merge_inner(
2324
2107
def _write_hashcache_if_dirty(self):
2325
2108
"""Write out the hashcache if it is dirty."""
2409
2191
current_inv = None
2410
2192
inv_finished = True
2411
2193
while not inv_finished or not disk_finished:
2413
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
cur_disk_dir_content) = current_disk
2416
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
cur_disk_dir_content) = ((None, None), None)
2418
2194
if not disk_finished:
2419
2195
# strip out .bzr dirs
2420
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
len(cur_disk_dir_content) > 0):
2422
# osutils.walkdirs can be made nicer -
2196
if current_disk[0][1][top_strip_len:] == '':
2197
# osutils.walkdirs can be made nicer -
2423
2198
# yield the path-from-prefix rather than the pathjoined
2425
bzrdir_loc = bisect_left(cur_disk_dir_content,
2427
if (bzrdir_loc < len(cur_disk_dir_content)
2428
and self.bzrdir.is_control_filename(
2429
cur_disk_dir_content[bzrdir_loc][0])):
2200
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2201
if current_disk[1][bzrdir_loc][0] == '.bzr':
2430
2202
# we dont yield the contents of, or, .bzr itself.
2431
del cur_disk_dir_content[bzrdir_loc]
2203
del current_disk[1][bzrdir_loc]
2432
2204
if inv_finished:
2433
2205
# everything is unknown
2436
2208
# everything is missing
2439
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2211
direction = cmp(current_inv[0][0], current_disk[0][0])
2440
2212
if direction > 0:
2441
2213
# disk is before inventory - unknown
2442
2214
dirblock = [(relpath, basename, kind, stat, None, None) for
2443
relpath, basename, kind, stat, top_path in
2444
cur_disk_dir_content]
2445
yield (cur_disk_dir_relpath, None), dirblock
2215
relpath, basename, kind, stat, top_path in current_disk[1]]
2216
yield (current_disk[0][0], None), dirblock
2447
2218
current_disk = disk_iterator.next()
2448
2219
except StopIteration:
2523
2293
# FIXME: stash the node in pending
2524
2294
entry = inv[top_id]
2525
if entry.kind == 'directory':
2526
for name, child in entry.sorted_children():
2527
dirblock.append((relroot + name, name, child.kind, None,
2528
child.file_id, child.kind
2295
for name, child in entry.sorted_children():
2296
dirblock.append((relroot + name, name, child.kind, None,
2297
child.file_id, child.kind
2530
2299
yield (currentdir[0], entry.file_id), dirblock
2531
2300
# push the user specified dirs from dirblock
2532
2301
for dir in reversed(dirblock):
2565
2334
self.set_conflicts(un_resolved)
2566
2335
return un_resolved, resolved
2569
def _check(self, references):
2570
"""Check the tree for consistency.
2572
:param references: A dict with keys matching the items returned by
2573
self._get_check_refs(), and values from looking those keys up in
2576
tree_basis = self.basis_tree()
2577
tree_basis.lock_read()
2579
repo_basis = references[('trees', self.last_revision())]
2580
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
raise errors.BzrCheckError(
2582
"Mismatched basis inventory content.")
2587
def _validate(self):
2588
"""Validate internal structures.
2590
This is meant mostly for the test suite. To give it a chance to detect
2591
corruption after actions have occurred. The default implementation is a
2594
:return: None. An exception should be raised if there is an error.
2598
def _get_rules_searcher(self, default_searcher):
2599
"""See Tree._get_rules_searcher."""
2600
if self._rules_searcher is None:
2601
self._rules_searcher = super(WorkingTree,
2602
self)._get_rules_searcher(default_searcher)
2603
return self._rules_searcher
2605
def get_shelf_manager(self):
2606
"""Return the ShelfManager for this WorkingTree."""
2607
from bzrlib.shelf import ShelfManager
2608
return ShelfManager(self, self._transport)
2611
2338
class WorkingTree2(WorkingTree):
2612
2339
"""This is the Format 2 working tree.
2614
This was the first weave based working tree.
2341
This was the first weave based working tree.
2615
2342
- uses os locks for locking.
2616
2343
- uses the branch last-revision.
2676
2396
def _last_revision(self):
2677
2397
"""See Mutable.last_revision."""
2679
return self._transport.get_bytes('last-revision')
2399
return osutils.safe_revision_id(
2400
self._control_files.get('last-revision').read())
2680
2401
except errors.NoSuchFile:
2681
return _mod_revision.NULL_REVISION
2683
2404
def _change_last_revision(self, revision_id):
2684
2405
"""See WorkingTree._change_last_revision."""
2685
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2406
if revision_id is None or revision_id == NULL_REVISION:
2687
self._transport.delete('last-revision')
2408
self._control_files._transport.delete('last-revision')
2688
2409
except errors.NoSuchFile:
2692
self._transport.put_bytes('last-revision', revision_id,
2693
mode=self.bzrdir._get_file_mode())
2413
self._control_files.put_bytes('last-revision', revision_id)
2696
def _get_check_refs(self):
2697
"""Return the references needed to perform a check of this tree."""
2698
return [('trees', self.last_revision())]
2700
2416
@needs_tree_write_lock
2701
2417
def set_conflicts(self, conflicts):
2702
self._put_rio('conflicts', conflicts.to_stanzas(),
2418
self._put_rio('conflicts', conflicts.to_stanzas(),
2703
2419
CONFLICT_HEADER_1)
2705
2421
@needs_tree_write_lock
2712
2428
@needs_read_lock
2713
2429
def conflicts(self):
2715
confile = self._transport.get('conflicts')
2431
confile = self._control_files.get('conflicts')
2716
2432
except errors.NoSuchFile:
2717
2433
return _mod_conflicts.ConflictList()
2720
if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
raise errors.ConflictFormatError()
2722
except StopIteration:
2435
if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2436
raise errors.ConflictFormatError()
2724
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2437
except StopIteration:
2438
raise errors.ConflictFormatError()
2439
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2728
2441
def unlock(self):
2729
# do non-implementation specific cleanup
2731
2442
if self._control_files._lock_count == 1:
2732
2443
# _inventory_is_modified is always False during a read lock.
2733
2444
if self._inventory_is_modified:
2835
2551
def unregister_format(klass, format):
2552
assert klass._formats[format.get_format_string()] is format
2836
2553
del klass._formats[format.get_format_string()]
2839
2557
class WorkingTreeFormat2(WorkingTreeFormat):
2840
"""The second working tree format.
2558
"""The second working tree format.
2842
2560
This format modified the hash cache from the format 1 hash cache.
2845
upgrade_recommended = True
2847
2563
def get_format_description(self):
2848
2564
"""See WorkingTreeFormat.get_format_description()."""
2849
2565
return "Working tree format 2"
2851
def _stub_initialize_on_transport(self, transport, file_mode):
2852
"""Workaround: create control files for a remote working tree.
2567
def stub_initialize_remote(self, control_files):
2568
"""As a special workaround create critical control files for a remote working tree
2854
2570
This ensures that it can later be updated and dealt with locally,
2855
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2571
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
2572
no working tree. (See bug #43064).
2858
2574
sio = StringIO()
2859
inv = inventory.Inventory()
2860
xml5.serializer_v5.write_inventory(inv, sio, working=True)
2576
xml5.serializer_v5.write_inventory(inv, sio)
2862
transport.put_file('inventory', sio, file_mode)
2863
transport.put_bytes('pending-merges', '', file_mode)
2865
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
accelerator_tree=None, hardlink=False):
2578
control_files.put('inventory', sio)
2580
control_files.put_bytes('pending-merges', '')
2583
def initialize(self, a_bzrdir, revision_id=None):
2867
2584
"""See WorkingTreeFormat.initialize()."""
2868
2585
if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2586
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
if from_branch is not None:
2871
branch = from_branch
2873
branch = a_bzrdir.open_branch()
2874
if revision_id is None:
2875
revision_id = _mod_revision.ensure_null(branch.last_revision())
2878
branch.generate_revision_history(revision_id)
2881
inv = inventory.Inventory()
2587
branch = a_bzrdir.open_branch()
2588
if revision_id is not None:
2589
revision_id = osutils.safe_revision_id(revision_id)
2592
revision_history = branch.revision_history()
2594
position = revision_history.index(revision_id)
2596
raise errors.NoSuchRevision(branch, revision_id)
2597
branch.set_revision_history(revision_history[:position + 1])
2600
revision = branch.last_revision()
2882
2602
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2885
2605
_internal=True,
2887
2607
_bzrdir=a_bzrdir)
2888
basis_tree = branch.repository.revision_tree(revision_id)
2608
basis_tree = branch.repository.revision_tree(revision)
2889
2609
if basis_tree.inventory.root is not None:
2890
wt.set_root_id(basis_tree.get_root_id())
2610
wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2611
# set the parent list and cache the basis tree.
2892
if _mod_revision.is_null(revision_id):
2895
parent_trees = [(revision_id, basis_tree)]
2896
wt.set_parent_trees(parent_trees)
2612
wt.set_parent_trees([(revision, basis_tree)])
2897
2613
transform.build_tree(basis_tree, wt)
2953
2667
def _open_control_files(self, a_bzrdir):
2954
2668
transport = a_bzrdir.get_workingtree_transport(None)
2955
return LockableFiles(transport, self._lock_file_name,
2669
return LockableFiles(transport, self._lock_file_name,
2956
2670
self._lock_class)
2958
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
accelerator_tree=None, hardlink=False):
2672
def initialize(self, a_bzrdir, revision_id=None):
2960
2673
"""See WorkingTreeFormat.initialize().
2962
:param revision_id: if supplied, create a working tree at a different
2963
revision than the branch is at.
2964
:param accelerator_tree: A tree which can be used for retrieving file
2965
contents more quickly than the revision tree, i.e. a workingtree.
2966
The revision tree will be used for cases where accelerator_tree's
2967
content is different.
2968
:param hardlink: If true, hard-link files from accelerator_tree,
2675
revision_id allows creating a working tree at a different
2676
revision than the branch is at.
2971
2678
if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2679
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2681
control_files = self._open_control_files(a_bzrdir)
2975
2682
control_files.create_lock()
2976
2683
control_files.lock_write()
2977
transport.put_bytes('format', self.get_format_string(),
2978
mode=a_bzrdir._get_file_mode())
2979
if from_branch is not None:
2980
branch = from_branch
2684
control_files.put_utf8('format', self.get_format_string())
2685
branch = a_bzrdir.open_branch()
2686
if revision_id is None:
2687
revision_id = branch.last_revision()
2982
branch = a_bzrdir.open_branch()
2983
if revision_id is None:
2984
revision_id = _mod_revision.ensure_null(branch.last_revision())
2689
revision_id = osutils.safe_revision_id(revision_id)
2985
2690
# WorkingTree3 can handle an inventory which has a unique root id.
2986
2691
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
2692
# those trees. And because there isn't a format bump inbetween, we
3049
2753
return self.get_format_string()
3052
__default_format = WorkingTreeFormat6()
2756
__default_format = WorkingTreeFormat4()
3053
2757
WorkingTreeFormat.register_format(__default_format)
3054
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2758
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2759
WorkingTreeFormat.set_default_format(__default_format)
3058
2760
# formats which have no format string are not discoverable
3059
2761
# and not independently creatable, so are not registered.
3060
2762
_legacy_formats = [WorkingTreeFormat2(),
2766
class WorkingTreeTestProviderAdapter(object):
2767
"""A tool to generate a suite testing multiple workingtree formats at once.
2769
This is done by copying the test once for each transport and injecting
2770
the transport_server, transport_readonly_server, and workingtree_format
2771
classes into each copy. Each copy is also given a new id() to make it
2775
def __init__(self, transport_server, transport_readonly_server, formats):
2776
self._transport_server = transport_server
2777
self._transport_readonly_server = transport_readonly_server
2778
self._formats = formats
2780
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2781
"""Clone test for adaption."""
2782
new_test = deepcopy(test)
2783
new_test.transport_server = self._transport_server
2784
new_test.transport_readonly_server = self._transport_readonly_server
2785
new_test.bzrdir_format = bzrdir_format
2786
new_test.workingtree_format = workingtree_format
2787
def make_new_test_id():
2788
new_id = "%s(%s)" % (test.id(), variation)
2789
return lambda: new_id
2790
new_test.id = make_new_test_id()
2793
def adapt(self, test):
2794
from bzrlib.tests import TestSuite
2795
result = TestSuite()
2796
for workingtree_format, bzrdir_format in self._formats:
2797
new_test = self._clone_test(
2800
workingtree_format, workingtree_format.__class__.__name__)
2801
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
