351
379
def abspath(self, filename):
352
380
return pathjoin(self.basedir, filename)
354
382
def basis_tree(self):
355
"""Return RevisionTree for the current last revision."""
356
revision_id = self.last_revision()
357
if revision_id is not None:
359
xml = self.read_basis_inventory()
360
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
363
if inv is not None and inv.revision_id == revision_id:
364
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
366
# FIXME? RBC 20060403 should we cache the inventory here ?
367
return self.branch.repository.revision_tree(revision_id)
370
@deprecated_method(zero_eight)
371
def create(branch, directory):
372
"""Create a workingtree for branch at directory.
374
If existing_directory already exists it must have a .bzr directory.
375
If it does not exist, it will be created.
377
This returns a new WorkingTree object for the new checkout.
379
TODO FIXME RBC 20060124 when we have checkout formats in place this
380
should accept an optional revisionid to checkout [and reject this if
381
checking out into the same dir as a pre-checkout-aware branch format.]
383
XXX: When BzrDir is present, these should be created through that
386
warn('delete WorkingTree.create', stacklevel=3)
387
transport = get_transport(directory)
388
if branch.bzrdir.root_transport.base == transport.base:
390
return branch.bzrdir.create_workingtree()
391
# different directory,
392
# create a branch reference
393
# and now a working tree.
394
raise NotImplementedError
397
@deprecated_method(zero_eight)
398
def create_standalone(directory):
399
"""Create a checkout and a branch and a repo at directory.
401
Directory must exist and be empty.
403
please use BzrDir.create_standalone_workingtree
405
return bzrdir.BzrDir.create_standalone_workingtree(directory)
407
def relpath(self, abs):
408
"""Return the local path portion from a given absolute path."""
409
return relpath(self.basedir, abs)
383
"""Return RevisionTree for the current last revision.
385
If the left most parent is a ghost then the returned tree will be an
386
empty tree - one obtained by calling
387
repository.revision_tree(NULL_REVISION).
390
revision_id = self.get_parent_ids()[0]
392
# no parents, return an empty revision tree.
393
# in the future this should return the tree for
394
# 'empty:' - the implicit root empty tree.
395
return self.branch.repository.revision_tree(
396
_mod_revision.NULL_REVISION)
398
return self.revision_tree(revision_id)
399
except errors.NoSuchRevision:
401
# No cached copy available, retrieve from the repository.
402
# FIXME? RBC 20060403 should we cache the inventory locally
405
return self.branch.repository.revision_tree(revision_id)
406
except (errors.RevisionNotPresent, errors.NoSuchRevision):
407
# the basis tree *may* be a ghost or a low level error may have
408
# occurred. If the revision is present, its a problem, if its not
410
if self.branch.repository.has_revision(revision_id):
412
# the basis tree is a ghost so return an empty tree.
413
return self.branch.repository.revision_tree(
414
_mod_revision.NULL_REVISION)
417
self._flush_ignore_list_cache()
419
def relpath(self, path):
420
"""Return the local path portion from a given path.
422
The path may be absolute or relative. If its a relative path it is
423
interpreted relative to the python current working directory.
425
return osutils.relpath(self.basedir, path)
411
427
def has_filename(self, filename):
412
return bzrlib.osutils.lexists(self.abspath(filename))
414
def get_file(self, file_id):
415
return self.get_file_byname(self.id2path(file_id))
417
def get_file_byname(self, filename):
418
return file(self.abspath(filename), 'rb')
428
return osutils.lexists(self.abspath(filename))
430
def get_file(self, file_id, path=None, filtered=True):
431
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
433
def get_file_with_stat(self, file_id, path=None, filtered=True,
434
_fstat=osutils.fstat):
435
"""See Tree.get_file_with_stat."""
437
path = self.id2path(file_id)
438
file_obj = self.get_file_byname(path, filtered=False)
439
stat_value = _fstat(file_obj.fileno())
440
if filtered and self.supports_content_filtering():
441
filters = self._content_filter_stack(path)
442
file_obj = _mod_filters.filtered_input_file(file_obj, filters)
443
return (file_obj, stat_value)
445
def get_file_text(self, file_id, path=None, filtered=True):
446
my_file = self.get_file(file_id, path=path, filtered=filtered)
448
return my_file.read()
452
def get_file_byname(self, filename, filtered=True):
453
path = self.abspath(filename)
455
if filtered and self.supports_content_filtering():
456
filters = self._content_filter_stack(filename)
457
return _mod_filters.filtered_input_file(f, filters)
461
def get_file_lines(self, file_id, path=None, filtered=True):
462
"""See Tree.get_file_lines()"""
463
file = self.get_file(file_id, path, filtered=filtered)
465
return file.readlines()
469
def get_parent_ids(self):
470
"""See Tree.get_parent_ids.
472
This implementation reads the pending merges list and last_revision
473
value and uses that to decide what the parents list should be.
475
last_rev = _mod_revision.ensure_null(self._last_revision())
476
if _mod_revision.NULL_REVISION == last_rev:
481
merges_bytes = self._transport.get_bytes('pending-merges')
482
except errors.NoSuchFile:
485
for l in osutils.split_lines(merges_bytes):
486
revision_id = l.rstrip('\n')
487
parents.append(revision_id)
420
490
def get_root_id(self):
421
491
"""Return the id of this trees root"""
422
inv = self.read_working_inventory()
423
return inv.root.file_id
425
def _get_store_filename(self, file_id):
426
## XXX: badly named; this is not in the store at all
427
return self.abspath(self.id2path(file_id))
492
raise NotImplementedError(self.get_root_id)
430
def clone(self, to_bzrdir, revision_id=None, basis=None):
495
def clone(self, to_controldir, revision_id=None):
431
496
"""Duplicate this working tree into to_bzr, including all state.
433
498
Specifically modified files are kept as modified, but
434
499
ignored and unknown files are discarded.
436
If you want to make a new line of development, see bzrdir.sprout()
501
If you want to make a new line of development, see ControlDir.sprout()
439
If not None, the cloned tree will have its last revision set to
440
revision, and and difference between the source trees last revision
504
If not None, the cloned tree will have its last revision set to
505
revision, and difference between the source trees last revision
441
506
and this one merged in.
444
If not None, a closer copy of a tree which may have some files in
445
common, and which file content should be preferentially copied from.
447
508
# assumes the target bzr dir format is compatible.
448
result = self._format.initialize(to_bzrdir)
509
result = to_controldir.create_workingtree()
449
510
self.copy_content_into(result, revision_id)
453
514
def copy_content_into(self, tree, revision_id=None):
454
515
"""Copy the current content and user files of this tree into tree."""
516
tree.set_root_id(self.get_root_id())
455
517
if revision_id is None:
456
transform_tree(tree, self)
518
merge.transform_tree(tree, self)
458
# TODO now merge from tree.last_revision to revision
459
transform_tree(tree, self)
460
tree.set_last_revision(revision_id)
463
def commit(self, message=None, revprops=None, *args, **kwargs):
464
# avoid circular imports
465
from bzrlib.commit import Commit
468
if not 'branch-nick' in revprops:
469
revprops['branch-nick'] = self.branch.nick
470
# args for wt.commit start at message from the Commit.commit method,
471
# but with branch a kwarg now, passing in args as is results in the
472
#message being used for the branch
473
args = (DEPRECATED_PARAMETER, message, ) + args
474
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
self._set_inventory(self.read_working_inventory())
520
# TODO now merge from tree.last_revision to revision (to preserve
521
# user local changes)
522
merge.transform_tree(tree, self)
523
if revision_id == _mod_revision.NULL_REVISION:
526
new_parents = [revision_id]
527
tree.set_parent_ids(new_parents)
477
529
def id2abspath(self, file_id):
478
530
return self.abspath(self.id2path(file_id))
480
def has_id(self, file_id):
481
# files that have been deleted are excluded
482
inv = self._inventory
483
if not inv.has_id(file_id):
485
path = inv.id2path(file_id)
486
return bzrlib.osutils.lexists(self.abspath(path))
488
def has_or_had_id(self, file_id):
489
if file_id == self.inventory.root.file_id:
491
return self.inventory.has_id(file_id)
493
__contains__ = has_id
532
def _check_for_tree_references(self, iterator):
533
"""See if directories have become tree-references."""
534
blocked_parent_ids = set()
535
for path, ie in iterator:
536
if ie.parent_id in blocked_parent_ids:
537
# This entry was pruned because one of its parents became a
538
# TreeReference. If this is a directory, mark it as blocked.
539
if ie.kind == 'directory':
540
blocked_parent_ids.add(ie.file_id)
542
if ie.kind == 'directory' and self._directory_is_tree_reference(path):
543
# This InventoryDirectory needs to be a TreeReference
544
ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
545
blocked_parent_ids.add(ie.file_id)
548
def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
549
"""See Tree.iter_entries_by_dir()"""
550
# The only trick here is that if we supports_tree_reference then we
551
# need to detect if a directory becomes a tree-reference.
552
iterator = super(WorkingTree, self).iter_entries_by_dir(
553
specific_file_ids=specific_file_ids,
554
yield_parents=yield_parents)
555
if not self.supports_tree_reference():
558
return self._check_for_tree_references(iterator)
495
560
def get_file_size(self, file_id):
496
return os.path.getsize(self.id2abspath(file_id))
499
def get_file_sha1(self, file_id):
500
path = self._inventory.id2path(file_id)
501
return self._hashcache.get_sha1(path)
503
def is_executable(self, file_id):
504
if not supports_executable():
505
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
508
mode = os.lstat(self.abspath(path)).st_mode
509
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
512
def add(self, files, ids=None):
513
"""Make files versioned.
515
Note that the command line normally calls smart_add instead,
516
which can automatically recurse.
518
This adds the files to the inventory, so that they will be
519
recorded by the next commit.
522
List of paths to add, relative to the base of the tree.
525
If set, use these instead of automatically generated ids.
526
Must be the same length as the list of files, but may
527
contain None for ids that are to be autogenerated.
529
TODO: Perhaps have an option to add the ids even if the files do
532
TODO: Perhaps callback with the ids and paths as they're added.
534
# TODO: Re-adding a file that is removed in the working copy
535
# should probably put it back with the previous ID.
536
if isinstance(files, basestring):
537
assert(ids is None or isinstance(ids, basestring))
543
ids = [None] * len(files)
545
assert(len(ids) == len(files))
547
inv = self.read_working_inventory()
548
for f,file_id in zip(files, ids):
549
if self.is_control_filename(f):
550
raise BzrError("cannot add control file %s" % quotefn(f))
555
raise BzrError("cannot add top-level %r" % f)
557
fullpath = normpath(self.abspath(f))
560
kind = file_kind(fullpath)
562
if e.errno == errno.ENOENT:
563
raise NoSuchFile(fullpath)
564
# maybe something better?
565
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
567
if not InventoryEntry.versionable_kind(kind):
568
raise BzrError('cannot add: not a versionable file ('
569
'i.e. regular file, symlink or directory): %s' % quotefn(f))
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
self._write_inventory(inv)
561
"""See Tree.get_file_size"""
562
# XXX: this returns the on-disk size; it should probably return the
565
return os.path.getsize(self.id2abspath(file_id))
567
if e.errno != errno.ENOENT:
572
@needs_tree_write_lock
573
def _gather_kinds(self, files, kinds):
574
"""See MutableTree._gather_kinds."""
575
for pos, f in enumerate(files):
576
if kinds[pos] is None:
577
fullpath = normpath(self.abspath(f))
579
kinds[pos] = file_kind(fullpath)
581
if e.errno == errno.ENOENT:
582
raise errors.NoSuchFile(fullpath)
585
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
586
"""Add revision_id as a parent.
588
This is equivalent to retrieving the current list of parent ids
589
and setting the list to its value plus revision_id.
591
:param revision_id: The revision id to add to the parent list. It may
592
be a ghost revision as long as its not the first parent to be
593
added, or the allow_leftmost_as_ghost parameter is set True.
594
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
596
parents = self.get_parent_ids() + [revision_id]
597
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
598
or allow_leftmost_as_ghost)
600
@needs_tree_write_lock
601
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
602
"""Add revision_id, tree tuple as a parent.
604
This is equivalent to retrieving the current list of parent trees
605
and setting the list to its value plus parent_tuple. See also
606
add_parent_tree_id - if you only have a parent id available it will be
607
simpler to use that api. If you have the parent already available, using
608
this api is preferred.
610
:param parent_tuple: The (revision id, tree) to add to the parent list.
611
If the revision_id is a ghost, pass None for the tree.
612
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
614
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
615
if len(parent_ids) > 1:
616
# the leftmost may have already been a ghost, preserve that if it
618
allow_leftmost_as_ghost = True
619
self.set_parent_ids(parent_ids,
620
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
622
@needs_tree_write_lock
579
623
def add_pending_merge(self, *revision_ids):
580
624
# TODO: Perhaps should check at this point that the
581
625
# history of the revision is actually present?
582
p = self.pending_merges()
626
parents = self.get_parent_ids()
584
628
for rev_id in revision_ids:
629
if rev_id in parents:
631
parents.append(rev_id)
590
self.set_pending_merges(p)
593
def pending_merges(self):
594
"""Return a list of pending merges.
596
These are revisions that have been merged into the working
597
directory but not yet committed.
634
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
636
def path_content_summary(self, path, _lstat=os.lstat,
637
_mapper=osutils.file_kind_from_stat_mode):
638
"""See Tree.path_content_summary."""
639
abspath = self.abspath(path)
600
merges_file = self._control_files.get_utf8('pending-merges')
641
stat_result = _lstat(abspath)
601
642
except OSError, e:
602
if e.errno != errno.ENOENT:
606
for l in merges_file.readlines():
607
p.append(l.rstrip('\n'))
643
if getattr(e, 'errno', None) == errno.ENOENT:
645
return ('missing', None, None, None)
646
# propagate other errors
648
kind = _mapper(stat_result.st_mode)
650
return self._file_content_summary(path, stat_result)
651
elif kind == 'directory':
652
# perhaps it looks like a plain directory, but it's really a
654
if self._directory_is_tree_reference(path):
655
kind = 'tree-reference'
656
return kind, None, None, None
657
elif kind == 'symlink':
658
target = osutils.readlink(abspath)
659
return ('symlink', None, None, target)
661
return (kind, None, None, None)
663
def _file_content_summary(self, path, stat_result):
664
size = stat_result.st_size
665
executable = self._is_executable_from_path_and_stat(path, stat_result)
666
# try for a stat cache lookup
667
return ('file', size, executable, self._sha_from_stat(
670
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
671
"""Common ghost checking functionality from set_parent_*.
673
This checks that the left hand-parent exists if there are any
676
if len(revision_ids) > 0:
677
leftmost_id = revision_ids[0]
678
if (not allow_leftmost_as_ghost and not
679
self.branch.repository.has_revision(leftmost_id)):
680
raise errors.GhostRevisionUnusableHere(leftmost_id)
682
def _set_merges_from_parent_ids(self, parent_ids):
683
merges = parent_ids[1:]
684
self._transport.put_bytes('pending-merges', '\n'.join(merges),
685
mode=self.bzrdir._get_file_mode())
687
def _filter_parent_ids_by_ancestry(self, revision_ids):
688
"""Check that all merged revisions are proper 'heads'.
690
This will always return the first revision_id, and any merged revisions
693
if len(revision_ids) == 0:
695
graph = self.branch.repository.get_graph()
696
heads = graph.heads(revision_ids)
697
new_revision_ids = revision_ids[:1]
698
for revision_id in revision_ids[1:]:
699
if revision_id in heads and revision_id not in new_revision_ids:
700
new_revision_ids.append(revision_id)
701
if new_revision_ids != revision_ids:
702
mutter('requested to set revision_ids = %s,'
703
' but filtered to %s', revision_ids, new_revision_ids)
704
return new_revision_ids
706
@needs_tree_write_lock
707
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
708
"""Set the parent ids to revision_ids.
710
See also set_parent_trees. This api will try to retrieve the tree data
711
for each element of revision_ids from the trees repository. If you have
712
tree data already available, it is more efficient to use
713
set_parent_trees rather than set_parent_ids. set_parent_ids is however
714
an easier API to use.
716
:param revision_ids: The revision_ids to set as the parent ids of this
717
working tree. Any of these may be ghosts.
719
self._check_parents_for_ghosts(revision_ids,
720
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
721
for revision_id in revision_ids:
722
_mod_revision.check_not_reserved_id(revision_id)
724
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
726
if len(revision_ids) > 0:
727
self.set_last_revision(revision_ids[0])
729
self.set_last_revision(_mod_revision.NULL_REVISION)
731
self._set_merges_from_parent_ids(revision_ids)
733
@needs_tree_write_lock
611
734
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
735
parents = self.get_parent_ids()
736
leftmost = parents[:1]
737
new_parents = leftmost + rev_list
738
self.set_parent_ids(new_parents)
740
@needs_tree_write_lock
615
741
def set_merge_modified(self, modified_hashes):
617
for file_id, hash in modified_hashes.iteritems():
618
yield Stanza(file_id=file_id, hash=hash)
619
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
622
def _put_rio(self, filename, stanzas, header):
623
my_file = rio_file(stanzas, header)
624
self._control_files.put(filename, my_file)
742
"""Set the merge modified hashes."""
743
raise NotImplementedError(self.set_merge_modified)
745
def _sha_from_stat(self, path, stat_result):
746
"""Get a sha digest from the tree's stat cache.
748
The default implementation assumes no stat cache is present.
750
:param path: The path.
751
:param stat_result: The stat result being looked up.
755
@needs_write_lock # because merge pulls data into the branch.
756
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
757
merge_type=None, force=False):
758
"""Merge from a branch into this working tree.
760
:param branch: The branch to merge from.
761
:param to_revision: If non-None, the merge will merge to to_revision,
762
but not beyond it. to_revision does not need to be in the history
763
of the branch when it is supplied. If None, to_revision defaults to
764
branch.last_revision().
766
from bzrlib.merge import Merger, Merge3Merger
767
merger = Merger(self.branch, this_tree=self)
768
# check that there are no local alterations
769
if not force and self.has_changes():
770
raise errors.UncommittedChanges(self)
771
if to_revision is None:
772
to_revision = _mod_revision.ensure_null(branch.last_revision())
773
merger.other_rev_id = to_revision
774
if _mod_revision.is_null(merger.other_rev_id):
775
raise errors.NoCommits(branch)
776
self.branch.fetch(branch, last_revision=merger.other_rev_id)
777
merger.other_basis = merger.other_rev_id
778
merger.other_tree = self.branch.repository.revision_tree(
780
merger.other_branch = branch
781
if from_revision is None:
784
merger.set_base_revision(from_revision, branch)
785
if merger.base_rev_id == merger.other_rev_id:
786
raise errors.PointlessMerge
787
merger.backup_files = False
788
if merge_type is None:
789
merger.merge_type = Merge3Merger
791
merger.merge_type = merge_type
792
merger.set_interesting_files(None)
793
merger.show_base = False
794
merger.reprocess = False
795
conflicts = merger.do_merge()
627
799
def merge_modified(self):
629
hashfile = self._control_files.get('merge-hashes')
634
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
raise MergeModifiedFormatError()
636
except StopIteration:
637
raise MergeModifiedFormatError()
638
for s in RioReader(hashfile):
639
file_id = s.get("file_id")
640
if file_id not in self.inventory:
643
if hash == self.get_file_sha1(file_id):
644
merge_hashes[file_id] = hash
647
def get_symlink_target(self, file_id):
648
return os.readlink(self.id2abspath(file_id))
650
def file_class(self, filename):
651
if self.path2id(filename):
653
elif self.is_ignored(filename):
658
def list_files(self):
659
"""Recursively list all files as (path, class, kind, id).
800
"""Return a dictionary of files modified by a merge.
802
The list is initialized by WorkingTree.set_merge_modified, which is
803
typically called after we make some automatic updates to the tree
806
This returns a map of file_id->sha1, containing only files which are
807
still in the working inventory and have that text hash.
809
raise NotImplementedError(self.merge_modified)
812
def mkdir(self, path, file_id=None):
813
"""See MutableTree.mkdir()."""
815
file_id = generate_ids.gen_file_id(os.path.basename(path))
816
os.mkdir(self.abspath(path))
817
self.add(path, file_id, 'directory')
820
def get_symlink_target(self, file_id, path=None):
822
abspath = self.abspath(path)
824
abspath = self.id2abspath(file_id)
825
target = osutils.readlink(abspath)
828
def subsume(self, other_tree):
829
raise NotImplementedError(self.subsume)
831
def _setup_directory_is_tree_reference(self):
832
if self._branch.repository._format.supports_tree_reference:
833
self._directory_is_tree_reference = \
834
self._directory_may_be_tree_reference
836
self._directory_is_tree_reference = \
837
self._directory_is_never_tree_reference
839
def _directory_is_never_tree_reference(self, relpath):
842
def _directory_may_be_tree_reference(self, relpath):
843
# as a special case, if a directory contains control files then
844
# it's a tree reference, except that the root of the tree is not
845
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
846
# TODO: We could ask all the control formats whether they
847
# recognize this directory, but at the moment there's no cheap api
848
# to do that. Since we probably can only nest bzr checkouts and
849
# they always use this name it's ok for now. -- mbp 20060306
851
# FIXME: There is an unhandled case here of a subdirectory
852
# containing .bzr but not a branch; that will probably blow up
853
# when you try to commit it. It might happen if there is a
854
# checkout in a subdirectory. This can be avoided by not adding
857
def extract(self, file_id, format=None):
858
"""Extract a subtree from this tree.
860
A new branch will be created, relative to the path for this tree.
862
raise NotImplementedError(self.extract)
865
"""Write the in memory meta data to disk."""
866
raise NotImplementedError(self.flush)
868
def _kind(self, relpath):
869
return osutils.file_kind(self.abspath(relpath))
871
def list_files(self, include_root=False, from_dir=None, recursive=True):
872
"""List all files as (path, class, kind, id, entry).
661
874
Lists, but does not descend into unversioned directories.
663
875
This does not include files that have been deleted in this
876
tree. Skips the control directory.
666
Skips the control directory.
878
:param include_root: if True, return an entry for the root
879
:param from_dir: start from this directory or None for the root
880
:param recursive: whether to recurse into subdirectories or not
668
inv = self._inventory
670
def descend(from_dir_relpath, from_dir_id, dp):
674
## TODO: If we find a subdirectory with its own .bzr
675
## directory, then that is a separate tree and we
676
## should exclude it.
678
# the bzrdir for this tree
679
if self.bzrdir.transport.base.endswith(f + '/'):
683
fp = appendpath(from_dir_relpath, f)
686
fap = appendpath(dp, f)
688
f_ie = inv.get_child(from_dir_id, f)
691
elif self.is_ignored(fp):
700
raise BzrCheckError("file %r entered as kind %r id %r, "
702
% (fap, f_ie.kind, f_ie.file_id, fk))
704
# make a last minute entry
708
if fk == 'directory':
709
entry = TreeDirectory()
712
elif fk == 'symlink':
717
yield fp, c, fk, (f_ie and f_ie.file_id), entry
719
if fk != 'directory':
723
# don't descend unversioned directories
726
for ff in descend(fp, f_ie.file_id, fap):
729
for f in descend(u'', inv.root.file_id, self.basedir):
733
def move(self, from_paths, to_name):
882
raise NotImplementedError(self.list_files)
884
def move(self, from_paths, to_dir=None, after=False):
736
to_name must exist in the inventory.
738
If to_name exists and is a directory, the files are moved into
739
it, keeping their old names.
741
Note that to_name is only the last component of the new name;
887
to_dir must be known to the working tree.
889
If to_dir exists and is a directory, the files are moved into
890
it, keeping their old names.
892
Note that to_dir is only the last component of the new name;
742
893
this doesn't change the directory.
895
For each entry in from_paths the move mode will be determined
898
The first mode moves the file in the filesystem and updates the
899
working tree metadata. The second mode only updates the working tree
900
metadata without touching the file on the filesystem.
902
move uses the second mode if 'after == True' and the target is not
903
versioned but present in the working tree.
905
move uses the second mode if 'after == False' and the source is
906
versioned but no longer in the working tree, and the target is not
907
versioned but present in the working tree.
909
move uses the first mode if 'after == False' and the source is
910
versioned and present in the working tree, and the target is not
911
versioned and not present in the working tree.
913
Everything else results in an error.
744
915
This returns a list of (from_path, to_path) pairs for each
745
916
entry that is moved.
748
## TODO: Option to move IDs only
749
assert not isinstance(from_paths, basestring)
751
to_abs = self.abspath(to_name)
752
if not isdir(to_abs):
753
raise BzrError("destination %r is not a directory" % to_abs)
754
if not self.has_filename(to_name):
755
raise BzrError("destination %r not in working directory" % to_abs)
756
to_dir_id = inv.path2id(to_name)
757
if to_dir_id == None and to_name != '':
758
raise BzrError("destination %r is not a versioned directory" % to_name)
759
to_dir_ie = inv[to_dir_id]
760
if to_dir_ie.kind not in ('directory', 'root_directory'):
761
raise BzrError("destination %r is not a directory" % to_abs)
763
to_idpath = inv.get_idpath(to_dir_id)
766
if not self.has_filename(f):
767
raise BzrError("%r does not exist in working tree" % f)
768
f_id = inv.path2id(f)
770
raise BzrError("%r is not versioned" % f)
771
name_tail = splitpath(f)[-1]
772
dest_path = appendpath(to_name, name_tail)
773
if self.has_filename(dest_path):
774
raise BzrError("destination %r already exists" % dest_path)
775
if f_id in to_idpath:
776
raise BzrError("can't move %r to a subdirectory of itself" % f)
778
# OK, so there's a race here, it's possible that someone will
779
# create a file in this interval and then the rename might be
780
# left half-done. But we should have caught most problems.
781
orig_inv = deepcopy(self.inventory)
784
name_tail = splitpath(f)[-1]
785
dest_path = appendpath(to_name, name_tail)
786
result.append((f, dest_path))
787
inv.rename(inv.path2id(f), to_dir_id, name_tail)
789
rename(self.abspath(f), self.abspath(dest_path))
791
raise BzrError("failed to rename %r to %r: %s" %
792
(f, dest_path, e[1]),
793
["rename rolled back"])
795
# restore the inventory on error
796
self._set_inventory(orig_inv)
798
self._write_inventory(inv)
802
def rename_one(self, from_rel, to_rel):
918
raise NotImplementedError(self.move)
920
@needs_tree_write_lock
921
def rename_one(self, from_rel, to_rel, after=False):
803
922
"""Rename one file.
805
924
This can change the directory or the filename or both.
926
rename_one has several 'modes' to work. First, it can rename a physical
927
file and change the file_id. That is the normal mode. Second, it can
928
only change the file_id without touching any physical file.
930
rename_one uses the second mode if 'after == True' and 'to_rel' is
931
either not versioned or newly added, and present in the working tree.
933
rename_one uses the second mode if 'after == False' and 'from_rel' is
934
versioned but no longer in the working tree, and 'to_rel' is not
935
versioned but present in the working tree.
937
rename_one uses the first mode if 'after == False' and 'from_rel' is
938
versioned and present in the working tree, and 'to_rel' is not
939
versioned and not present in the working tree.
941
Everything else results in an error.
808
if not self.has_filename(from_rel):
809
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
810
if self.has_filename(to_rel):
811
raise BzrError("can't rename: new working file %r already exists" % to_rel)
813
file_id = inv.path2id(from_rel)
815
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
818
from_parent = entry.parent_id
819
from_name = entry.name
821
if inv.path2id(to_rel):
822
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
824
to_dir, to_tail = os.path.split(to_rel)
825
to_dir_id = inv.path2id(to_dir)
826
if to_dir_id == None and to_dir != '':
827
raise BzrError("can't determine destination directory id for %r" % to_dir)
829
mutter("rename_one:")
830
mutter(" file_id {%s}" % file_id)
831
mutter(" from_rel %r" % from_rel)
832
mutter(" to_rel %r" % to_rel)
833
mutter(" to_dir %r" % to_dir)
834
mutter(" to_dir_id {%s}" % to_dir_id)
836
inv.rename(file_id, to_dir_id, to_tail)
838
from_abs = self.abspath(from_rel)
839
to_abs = self.abspath(to_rel)
841
rename(from_abs, to_abs)
843
inv.rename(file_id, from_parent, from_name)
844
raise BzrError("failed to rename %r to %r: %s"
845
% (from_abs, to_abs, e[1]),
846
["rename rolled back"])
847
self._write_inventory(inv)
943
raise NotImplementedError(self.rename_one)
850
946
def unknowns(self):
853
949
These are files in the working directory that are not versioned or
854
950
control files or ignored.
856
>>> from bzrlib.bzrdir import ScratchDir
857
>>> d = ScratchDir(files=['foo', 'foo~'])
858
>>> b = d.open_branch()
859
>>> tree = d.open_workingtree()
860
>>> map(str, tree.unknowns())
863
>>> list(b.unknowns())
865
>>> tree.remove('foo')
866
>>> list(b.unknowns())
869
for subp in self.extras():
870
if not self.is_ignored(subp):
873
@deprecated_method(zero_eight)
874
def iter_conflicts(self):
875
"""List all files in the tree that have text or content conflicts.
876
DEPRECATED. Use conflicts instead."""
877
return self._iter_conflicts()
879
def _iter_conflicts(self):
881
for path in (s[0] for s in self.list_files()):
882
stem = get_conflicted_stem(path)
885
if stem not in conflicted:
952
# force the extras method to be fully executed before returning, to
953
# prevent race conditions with the lock
955
[subp for subp in self.extras() if not self.is_ignored(subp)])
957
def unversion(self, file_ids):
958
"""Remove the file ids in file_ids from the current versioned set.
960
When a file_id is unversioned, all of its children are automatically
963
:param file_ids: The file ids to stop versioning.
964
:raises: NoSuchId if any fileid is not currently versioned.
966
raise NotImplementedError(self.unversion)
889
968
@needs_write_lock
890
def pull(self, source, overwrite=False, stop_revision=None):
891
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
969
def pull(self, source, overwrite=False, stop_revision=None,
970
change_reporter=None, possible_transports=None, local=False,
892
972
source.lock_read()
894
pp = ProgressPhase("Pull phase", 2, top_pb)
896
old_revision_history = self.branch.revision_history()
974
old_revision_info = self.branch.last_revision_info()
897
975
basis_tree = self.basis_tree()
898
count = self.branch.pull(source, overwrite, stop_revision)
899
new_revision_history = self.branch.revision_history()
900
if new_revision_history != old_revision_history:
902
if len(old_revision_history):
903
other_revision = old_revision_history[-1]
905
other_revision = None
976
count = self.branch.pull(source, overwrite, stop_revision,
977
possible_transports=possible_transports,
979
new_revision_info = self.branch.last_revision_info()
980
if new_revision_info != old_revision_info:
906
981
repository = self.branch.repository
907
pb = bzrlib.ui.ui_factory.nested_progress_bar()
982
if repository._format.fast_deltas:
983
parent_ids = self.get_parent_ids()
985
basis_id = parent_ids[0]
986
basis_tree = repository.revision_tree(basis_id)
987
basis_tree.lock_read()
909
merge_inner(self.branch,
910
self.branch.basis_tree(),
989
new_basis_tree = self.branch.basis_tree()
996
change_reporter=change_reporter,
998
basis_root_id = basis_tree.get_root_id()
999
new_root_id = new_basis_tree.get_root_id()
1000
if new_root_id is not None and basis_root_id != new_root_id:
1001
self.set_root_id(new_root_id)
916
self.set_last_revision(self.branch.last_revision())
1004
# TODO - dedup parents list with things merged by pull ?
1005
# reuse the revisiontree we merged against to set the new
1008
if self.branch.last_revision() != _mod_revision.NULL_REVISION:
1009
parent_trees.append(
1010
(self.branch.last_revision(), new_basis_tree))
1011
# we have to pull the merge trees out again, because
1012
# merge_inner has set the ids. - this corner is not yet
1013
# layered well enough to prevent double handling.
1014
# XXX TODO: Fix the double handling: telling the tree about
1015
# the already known parent data is wasteful.
1016
merges = self.get_parent_ids()[1:]
1017
parent_trees.extend([
1018
(parent, repository.revision_tree(parent)) for
1020
self.set_parent_trees(parent_trees)
1026
def put_file_bytes_non_atomic(self, file_id, bytes):
1027
"""See MutableTree.put_file_bytes_non_atomic."""
1028
stream = file(self.id2abspath(file_id), 'wb')
922
1034
def extras(self):
923
"""Yield all unknown files in this WorkingTree.
1035
"""Yield all unversioned files in this WorkingTree.
925
If there are any unknown directories then only the directory is
926
returned, not all its children. But if there are unknown files
1037
If there are any unversioned directories then only the directory is
1038
returned, not all its children. But if there are unversioned files
927
1039
under a versioned subdirectory, they are returned.
929
1041
Currently returned depth-first, sorted by name within directories.
1042
This is the same order used by 'osutils.walkdirs'.
931
## TODO: Work from given directory downwards
932
for path, dir_entry in self.inventory.directories():
933
mutter("search for unknowns in %r", path)
934
dirabs = self.abspath(path)
935
if not isdir(dirabs):
936
# e.g. directory deleted
940
for subf in os.listdir(dirabs):
942
and (subf not in dir_entry.children)):
947
subp = appendpath(path, subf)
1044
raise NotImplementedError(self.extras)
951
1046
def ignored_files(self):
952
1047
"""Yield list of PATH, IGNORE_PATTERN"""
953
1048
for subp in self.extras():
954
1049
pat = self.is_ignored(subp)
959
1053
def get_ignore_list(self):
960
1054
"""Return list of ignore patterns.
962
1056
Cached in the Tree object after the first call.
964
if hasattr(self, '_ignorelist'):
965
return self._ignorelist
1058
ignoreset = getattr(self, '_ignoreset', None)
1059
if ignoreset is not None:
967
l = bzrlib.DEFAULT_IGNORE[:]
1062
ignore_globs = set()
1063
ignore_globs.update(ignores.get_runtime_ignores())
1064
ignore_globs.update(ignores.get_user_ignores())
968
1065
if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1066
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
970
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1068
ignore_globs.update(ignores.parse_ignore_file(f))
1071
self._ignoreset = ignore_globs
1074
def _flush_ignore_list_cache(self):
1075
"""Resets the cached ignore list to force a cache rebuild."""
1076
self._ignoreset = None
1077
self._ignoreglobster = None
975
1079
def is_ignored(self, filename):
976
1080
r"""Check whether the filename matches an ignore pattern.
978
1082
Patterns containing '/' or '\' need to match the whole path;
979
others match against only the last component.
1083
others match against only the last component. Patterns starting
1084
with '!' are ignore exceptions. Exceptions take precedence
1085
over regular patterns and cause the filename to not be ignored.
981
1087
If the file is ignored, returns the pattern which caused it to
982
1088
be ignored, otherwise None. So this can simply be used as a
983
1089
boolean if desired."""
985
# TODO: Use '**' to match directories, and other extended
986
# globbing stuff from cvs/rsync.
988
# XXX: fnmatch is actually not quite what we want: it's only
989
# approximately the same as real Unix fnmatch, and doesn't
990
# treat dotfiles correctly and allows * to match /.
991
# Eventually it should be replaced with something more
994
for pat in self.get_ignore_list():
995
if '/' in pat or '\\' in pat:
997
# as a special case, you can put ./ at the start of a
998
# pattern; this is good to match in the top-level
1001
if (pat[:2] == './') or (pat[:2] == '.\\'):
1005
if fnmatch.fnmatchcase(filename, newpat):
1008
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1090
if getattr(self, '_ignoreglobster', None) is None:
1091
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1092
return self._ignoreglobster.match(filename)
1013
1094
def kind(self, file_id):
1014
1095
return file_kind(self.id2abspath(file_id))
1097
def stored_kind(self, file_id):
1098
"""See Tree.stored_kind"""
1099
raise NotImplementedError(self.stored_kind)
1101
def _comparison_data(self, entry, path):
1102
abspath = self.abspath(path)
1104
stat_value = os.lstat(abspath)
1106
if getattr(e, 'errno', None) == errno.ENOENT:
1113
mode = stat_value.st_mode
1114
kind = osutils.file_kind_from_stat_mode(mode)
1115
if not supports_executable():
1116
executable = entry is not None and entry.executable
1118
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1119
return kind, executable, stat_value
1121
def _file_size(self, entry, stat_value):
1122
return stat_value.st_size
1124
def last_revision(self):
1125
"""Return the last revision of the branch for this tree.
1127
This format tree does not support a separate marker for last-revision
1128
compared to the branch.
1130
See MutableTree.last_revision
1132
return self._last_revision()
1016
1134
@needs_read_lock
1017
def last_revision(self):
1018
"""Return the last revision id of this working tree.
1135
def _last_revision(self):
1136
"""helper for get_parent_ids."""
1137
return _mod_revision.ensure_null(self.branch.last_revision())
1020
In early branch formats this was == the branch last_revision,
1021
but that cannot be relied upon - for working tree operations,
1022
always use tree.last_revision().
1024
return self.branch.last_revision()
1139
def is_locked(self):
1140
"""Check if this tree is locked."""
1141
raise NotImplementedError(self.is_locked)
1026
1143
def lock_read(self):
1027
"""See Branch.lock_read, and WorkingTree.unlock."""
1028
self.branch.lock_read()
1030
return self._control_files.lock_read()
1032
self.branch.unlock()
1144
"""Lock the tree for reading.
1146
This also locks the branch, and can be unlocked via self.unlock().
1148
:return: A bzrlib.lock.LogicalLockResult.
1150
raise NotImplementedError(self.lock_read)
1152
def lock_tree_write(self):
1153
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1155
:return: A bzrlib.lock.LogicalLockResult.
1157
raise NotImplementedError(self.lock_tree_write)
1035
1159
def lock_write(self):
1036
"""See Branch.lock_write, and WorkingTree.unlock."""
1037
self.branch.lock_write()
1039
return self._control_files.lock_write()
1041
self.branch.unlock()
1044
def _basis_inventory_name(self):
1045
return 'basis-inventory'
1160
"""See MutableTree.lock_write, and WorkingTree.unlock.
1162
:return: A bzrlib.lock.LogicalLockResult.
1164
raise NotImplementedError(self.lock_write)
1166
def get_physical_lock_status(self):
1167
raise NotImplementedError(self.get_physical_lock_status)
1048
1169
def set_last_revision(self, new_revision):
1049
1170
"""Change the last revision in the working tree."""
1050
if self._change_last_revision(new_revision):
1051
self._cache_basis_inventory(new_revision)
1171
raise NotImplementedError(self.set_last_revision)
1053
1173
def _change_last_revision(self, new_revision):
1054
1174
"""Template method part of set_last_revision to perform the change.
1056
1176
This is used to allow WorkingTree3 instances to not affect branch
1057
1177
when their last revision is set.
1059
if new_revision is None:
1060
self.branch.set_revision_history([])
1179
if _mod_revision.is_null(new_revision):
1180
self.branch.set_last_revision_info(0, new_revision)
1062
# current format is locked in with the branch
1063
revision_history = self.branch.revision_history()
1182
_mod_revision.check_not_reserved_id(new_revision)
1065
position = revision_history.index(new_revision)
1067
raise errors.NoSuchRevision(self.branch, new_revision)
1068
self.branch.set_revision_history(revision_history[:position + 1])
1184
self.branch.generate_revision_history(new_revision)
1185
except errors.NoSuchRevision:
1186
# not present in the repo - dont try to set it deeper than the tip
1187
self.branch._set_revision_history([new_revision])
1071
def _cache_basis_inventory(self, new_revision):
1072
"""Cache new_revision as the basis inventory."""
1074
# this double handles the inventory - unpack and repack -
1075
# but is easier to understand. We can/should put a conditional
1076
# in here based on whether the inventory is in the latest format
1077
# - perhaps we should repack all inventories on a repository
1079
inv = self.branch.repository.get_inventory(new_revision)
1080
inv.revision_id = new_revision
1081
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1083
path = self._basis_inventory_name()
1084
self._control_files.put_utf8(path, xml)
1085
except WeaveRevisionNotPresent:
1088
def read_basis_inventory(self):
1089
"""Read the cached basis inventory."""
1090
path = self._basis_inventory_name()
1091
return self._control_files.get_utf8(path).read()
1094
def read_working_inventory(self):
1095
"""Read the working inventory."""
1096
# ElementTree does its own conversion from UTF-8, so open in
1098
result = bzrlib.xml5.serializer_v5.read_inventory(
1099
self._control_files.get('inventory'))
1100
self._set_inventory(result)
1104
def remove(self, files, verbose=False):
1105
"""Remove nominated files from the working inventory..
1107
This does not remove their text. This does not run on XXX on what? RBC
1109
TODO: Refuse to remove modified files unless --force is given?
1111
TODO: Do something useful with directories.
1113
TODO: Should this remove the text or not? Tough call; not
1114
removing may be useful and the user can just use use rm, and
1115
is the opposite of add. Removing it is consistent with most
1116
other tools. Maybe an option.
1190
@needs_tree_write_lock
1191
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1193
"""Remove nominated files from the working tree metadata.
1195
:files: File paths relative to the basedir.
1196
:keep_files: If true, the files will also be kept.
1197
:force: Delete files and directories, even if they are changed and
1198
even if the directories are not empty.
1118
## TODO: Normalize names
1119
## TODO: Remove nested loops; better scalability
1120
1200
if isinstance(files, basestring):
1121
1201
files = [files]
1123
inv = self.inventory
1125
# do this before any modifications
1205
all_files = set() # specified and nested files
1206
unknown_nested_files=set()
1208
to_file = sys.stdout
1210
files_to_backup = []
1212
def recurse_directory_to_add_files(directory):
1213
# Recurse directory and add all files
1214
# so we can check if they have changed.
1215
for parent_info, file_infos in self.walkdirs(directory):
1216
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1217
# Is it versioned or ignored?
1218
if self.path2id(relpath):
1219
# Add nested content for deletion.
1220
all_files.add(relpath)
1222
# Files which are not versioned
1223
# should be treated as unknown.
1224
files_to_backup.append(relpath)
1226
for filename in files:
1227
# Get file name into canonical form.
1228
abspath = self.abspath(filename)
1229
filename = self.relpath(abspath)
1230
if len(filename) > 0:
1231
all_files.add(filename)
1232
recurse_directory_to_add_files(filename)
1234
files = list(all_files)
1237
return # nothing to do
1239
# Sort needed to first handle directory content before the directory
1240
files.sort(reverse=True)
1242
# Bail out if we are going to delete files we shouldn't
1243
if not keep_files and not force:
1244
for (file_id, path, content_change, versioned, parent_id, name,
1245
kind, executable) in self.iter_changes(self.basis_tree(),
1246
include_unchanged=True, require_versioned=False,
1247
want_unversioned=True, specific_files=files):
1248
if versioned[0] == False:
1249
# The record is unknown or newly added
1250
files_to_backup.append(path[1])
1251
elif (content_change and (kind[1] is not None) and
1252
osutils.is_inside_any(files, path[1])):
1253
# Versioned and changed, but not deleted, and still
1254
# in one of the dirs to be deleted.
1255
files_to_backup.append(path[1])
1257
def backup(file_to_backup):
1258
backup_name = self.bzrdir._available_backup_name(file_to_backup)
1259
osutils.rename(abs_path, self.abspath(backup_name))
1260
return "removed %s (but kept a copy: %s)" % (file_to_backup,
1263
# Build inv_delta and delete files where applicable,
1264
# do this before any modifications to meta data.
1126
1265
for f in files:
1127
fid = inv.path2id(f)
1266
fid = self.path2id(f)
1129
# TODO: Perhaps make this just a warning, and continue?
1130
# This tends to happen when
1131
raise NotVersionedError(path=f)
1132
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1134
# having remove it, it must be either ignored or unknown
1135
if self.is_ignored(f):
1139
show_status(new_status, inv[fid].kind, quotefn(f))
1142
self._write_inventory(inv)
1145
def revert(self, filenames, old_tree=None, backups=True,
1146
pb=DummyProgress()):
1147
from transform import revert
1148
from conflicts import resolve
1269
message = "%s is not versioned." % (f,)
1272
# having removed it, it must be either ignored or unknown
1273
if self.is_ignored(f):
1277
# XXX: Really should be a more abstract reporter interface
1278
kind_ch = osutils.kind_marker(self.kind(fid))
1279
to_file.write(new_status + ' ' + f + kind_ch + '\n')
1281
inv_delta.append((f, None, fid, None))
1282
message = "removed %s" % (f,)
1285
abs_path = self.abspath(f)
1286
if osutils.lexists(abs_path):
1287
if (osutils.isdir(abs_path) and
1288
len(os.listdir(abs_path)) > 0):
1290
osutils.rmtree(abs_path)
1291
message = "deleted %s" % (f,)
1295
if f in files_to_backup:
1298
osutils.delete_any(abs_path)
1299
message = "deleted %s" % (f,)
1300
elif message is not None:
1301
# Only care if we haven't done anything yet.
1302
message = "%s does not exist." % (f,)
1304
# Print only one message (if any) per file.
1305
if message is not None:
1307
self.apply_inventory_delta(inv_delta)
1309
@needs_tree_write_lock
1310
def revert(self, filenames=None, old_tree=None, backups=True,
1311
pb=None, report_changes=False):
1312
from bzrlib.conflicts import resolve
1149
1313
if old_tree is None:
1150
old_tree = self.basis_tree()
1151
conflicts = revert(self, old_tree, filenames, backups, pb)
1152
if not len(filenames):
1153
self.set_pending_merges([])
1314
basis_tree = self.basis_tree()
1315
basis_tree.lock_read()
1316
old_tree = basis_tree
1156
resolve(self, filenames, ignore_misses=True)
1320
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1322
if filenames is None and len(self.get_parent_ids()) > 1:
1324
last_revision = self.last_revision()
1325
if last_revision != _mod_revision.NULL_REVISION:
1326
if basis_tree is None:
1327
basis_tree = self.basis_tree()
1328
basis_tree.lock_read()
1329
parent_trees.append((last_revision, basis_tree))
1330
self.set_parent_trees(parent_trees)
1333
resolve(self, filenames, ignore_misses=True, recursive=True)
1335
if basis_tree is not None:
1157
1337
return conflicts
1339
def revision_tree(self, revision_id):
1340
"""See Tree.revision_tree.
1342
WorkingTree can supply revision_trees for the basis revision only
1343
because there is only one cached inventory in the bzr directory.
1345
raise NotImplementedError(self.revision_tree)
1347
@needs_tree_write_lock
1348
def set_root_id(self, file_id):
1349
"""Set the root id for this tree."""
1353
'WorkingTree.set_root_id with fileid=None')
1354
file_id = osutils.safe_file_id(file_id)
1355
self._set_root_id(file_id)
1357
def _set_root_id(self, file_id):
1358
"""Set the root id for this tree, in a format specific manner.
1360
:param file_id: The file id to assign to the root. It must not be
1361
present in the current inventory or an error will occur. It must
1362
not be None, but rather a valid file id.
1364
raise NotImplementedError(self._set_root_id)
1367
"""See Branch.unlock.
1369
WorkingTree locking just uses the Branch locking facilities.
1370
This is current because all working trees have an embedded branch
1371
within them. IF in the future, we were to make branch data shareable
1372
between multiple working trees, i.e. via shared storage, then we
1373
would probably want to lock both the local tree, and the branch.
1375
raise NotImplementedError(self.unlock)
1379
def update(self, change_reporter=None, possible_transports=None,
1380
revision=None, old_tip=_marker, show_base=False):
1381
"""Update a working tree along its branch.
1383
This will update the branch if its bound too, which means we have
1384
multiple trees involved:
1386
- The new basis tree of the master.
1387
- The old basis tree of the branch.
1388
- The old basis tree of the working tree.
1389
- The current working tree state.
1391
Pathologically, all three may be different, and non-ancestors of each
1392
other. Conceptually we want to:
1394
- Preserve the wt.basis->wt.state changes
1395
- Transform the wt.basis to the new master basis.
1396
- Apply a merge of the old branch basis to get any 'local' changes from
1398
- Restore the wt.basis->wt.state changes.
1400
There isn't a single operation at the moment to do that, so we:
1402
- Merge current state -> basis tree of the master w.r.t. the old tree
1404
- Do a 'normal' merge of the old branch basis if it is relevant.
1406
:param revision: The target revision to update to. Must be in the
1408
:param old_tip: If branch.update() has already been run, the value it
1409
returned (old tip of the branch or None). _marker is used
1412
if self.branch.get_bound_location() is not None:
1414
update_branch = (old_tip is self._marker)
1416
self.lock_tree_write()
1417
update_branch = False
1420
old_tip = self.branch.update(possible_transports)
1422
if old_tip is self._marker:
1424
return self._update_tree(old_tip, change_reporter, revision, show_base)
1428
@needs_tree_write_lock
1429
def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1431
"""Update a tree to the master branch.
1433
:param old_tip: if supplied, the previous tip revision the branch,
1434
before it was changed to the master branch's tip.
1436
# here if old_tip is not None, it is the old tip of the branch before
1437
# it was updated from the master branch. This should become a pending
1438
# merge in the working tree to preserve the user existing work. we
1439
# cant set that until we update the working trees last revision to be
1440
# one from the new branch, because it will just get absorbed by the
1441
# parent de-duplication logic.
1443
# We MUST save it even if an error occurs, because otherwise the users
1444
# local work is unreferenced and will appear to have been lost.
1448
last_rev = self.get_parent_ids()[0]
1450
last_rev = _mod_revision.NULL_REVISION
1451
if revision is None:
1452
revision = self.branch.last_revision()
1454
old_tip = old_tip or _mod_revision.NULL_REVISION
1456
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
1457
# the branch we are bound to was updated
1458
# merge those changes in first
1459
base_tree = self.basis_tree()
1460
other_tree = self.branch.repository.revision_tree(old_tip)
1461
nb_conflicts = merge.merge_inner(self.branch, other_tree,
1462
base_tree, this_tree=self,
1463
change_reporter=change_reporter,
1464
show_base=show_base)
1466
self.add_parent_tree((old_tip, other_tree))
1467
note(gettext('Rerun update after fixing the conflicts.'))
1470
if last_rev != _mod_revision.ensure_null(revision):
1471
# the working tree is up to date with the branch
1472
# we can merge the specified revision from master
1473
to_tree = self.branch.repository.revision_tree(revision)
1474
to_root_id = to_tree.get_root_id()
1476
basis = self.basis_tree()
1479
if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
1480
self.set_root_id(to_root_id)
1485
# determine the branch point
1486
graph = self.branch.repository.get_graph()
1487
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
1489
base_tree = self.branch.repository.revision_tree(base_rev_id)
1491
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
1493
change_reporter=change_reporter,
1494
show_base=show_base)
1495
self.set_last_revision(revision)
1496
# TODO - dedup parents list with things merged by pull ?
1497
# reuse the tree we've updated to to set the basis:
1498
parent_trees = [(revision, to_tree)]
1499
merges = self.get_parent_ids()[1:]
1500
# Ideally we ask the tree for the trees here, that way the working
1501
# tree can decide whether to give us the entire tree or give us a
1502
# lazy initialised tree. dirstate for instance will have the trees
1503
# in ram already, whereas a last-revision + basis-inventory tree
1504
# will not, but also does not need them when setting parents.
1505
for parent in merges:
1506
parent_trees.append(
1507
(parent, self.branch.repository.revision_tree(parent)))
1508
if not _mod_revision.is_null(old_tip):
1509
parent_trees.append(
1510
(old_tip, self.branch.repository.revision_tree(old_tip)))
1511
self.set_parent_trees(parent_trees)
1512
last_rev = parent_trees[0][0]
1515
def set_conflicts(self, arg):
1516
raise errors.UnsupportedOperation(self.set_conflicts, self)
1518
def add_conflicts(self, arg):
1519
raise errors.UnsupportedOperation(self.add_conflicts, self)
1521
def conflicts(self):
1522
raise NotImplementedError(self.conflicts)
1524
def walkdirs(self, prefix=""):
1525
"""Walk the directories of this tree.
1527
returns a generator which yields items in the form:
1528
((curren_directory_path, fileid),
1529
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
1532
This API returns a generator, which is only valid during the current
1533
tree transaction - within a single lock_read or lock_write duration.
1535
If the tree is not locked, it may cause an error to be raised,
1536
depending on the tree implementation.
1538
disk_top = self.abspath(prefix)
1539
if disk_top.endswith('/'):
1540
disk_top = disk_top[:-1]
1541
top_strip_len = len(disk_top) + 1
1542
inventory_iterator = self._walkdirs(prefix)
1543
disk_iterator = osutils.walkdirs(disk_top, prefix)
1545
current_disk = disk_iterator.next()
1546
disk_finished = False
1548
if not (e.errno == errno.ENOENT or
1549
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1552
disk_finished = True
1554
current_inv = inventory_iterator.next()
1555
inv_finished = False
1556
except StopIteration:
1559
while not inv_finished or not disk_finished:
1561
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1562
cur_disk_dir_content) = current_disk
1564
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
1565
cur_disk_dir_content) = ((None, None), None)
1566
if not disk_finished:
1567
# strip out .bzr dirs
1568
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
1569
len(cur_disk_dir_content) > 0):
1570
# osutils.walkdirs can be made nicer -
1571
# yield the path-from-prefix rather than the pathjoined
1573
bzrdir_loc = bisect_left(cur_disk_dir_content,
1575
if (bzrdir_loc < len(cur_disk_dir_content)
1576
and self.bzrdir.is_control_filename(
1577
cur_disk_dir_content[bzrdir_loc][0])):
1578
# we dont yield the contents of, or, .bzr itself.
1579
del cur_disk_dir_content[bzrdir_loc]
1581
# everything is unknown
1584
# everything is missing
1587
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1589
# disk is before inventory - unknown
1590
dirblock = [(relpath, basename, kind, stat, None, None) for
1591
relpath, basename, kind, stat, top_path in
1592
cur_disk_dir_content]
1593
yield (cur_disk_dir_relpath, None), dirblock
1595
current_disk = disk_iterator.next()
1596
except StopIteration:
1597
disk_finished = True
1599
# inventory is before disk - missing.
1600
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
1601
for relpath, basename, dkind, stat, fileid, kind in
1603
yield (current_inv[0][0], current_inv[0][1]), dirblock
1605
current_inv = inventory_iterator.next()
1606
except StopIteration:
1609
# versioned present directory
1610
# merge the inventory and disk data together
1612
for relpath, subiterator in itertools.groupby(sorted(
1613
current_inv[1] + cur_disk_dir_content,
1614
key=operator.itemgetter(0)), operator.itemgetter(1)):
1615
path_elements = list(subiterator)
1616
if len(path_elements) == 2:
1617
inv_row, disk_row = path_elements
1618
# versioned, present file
1619
dirblock.append((inv_row[0],
1620
inv_row[1], disk_row[2],
1621
disk_row[3], inv_row[4],
1623
elif len(path_elements[0]) == 5:
1625
dirblock.append((path_elements[0][0],
1626
path_elements[0][1], path_elements[0][2],
1627
path_elements[0][3], None, None))
1628
elif len(path_elements[0]) == 6:
1629
# versioned, absent file.
1630
dirblock.append((path_elements[0][0],
1631
path_elements[0][1], 'unknown', None,
1632
path_elements[0][4], path_elements[0][5]))
1634
raise NotImplementedError('unreachable code')
1635
yield current_inv[0], dirblock
1637
current_inv = inventory_iterator.next()
1638
except StopIteration:
1641
current_disk = disk_iterator.next()
1642
except StopIteration:
1643
disk_finished = True
1645
def _walkdirs(self, prefix=""):
1646
"""Walk the directories of this tree.
1648
:param prefix: is used as the directrory to start with.
1649
:returns: a generator which yields items in the form::
1651
((curren_directory_path, fileid),
1652
[(file1_path, file1_name, file1_kind, None, file1_id,
1655
raise NotImplementedError(self._walkdirs)
1657
@needs_tree_write_lock
1658
def auto_resolve(self):
1659
"""Automatically resolve text conflicts according to contents.
1661
Only text conflicts are auto_resolvable. Files with no conflict markers
1662
are considered 'resolved', because bzr always puts conflict markers
1663
into files that have text conflicts. The corresponding .THIS .BASE and
1664
.OTHER files are deleted, as per 'resolve'.
1666
:return: a tuple of ConflictLists: (un_resolved, resolved).
1668
un_resolved = _mod_conflicts.ConflictList()
1669
resolved = _mod_conflicts.ConflictList()
1670
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1671
for conflict in self.conflicts():
1672
if (conflict.typestring != 'text conflict' or
1673
self.kind(conflict.file_id) != 'file'):
1674
un_resolved.append(conflict)
1676
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1678
for line in my_file:
1679
if conflict_re.search(line):
1680
un_resolved.append(conflict)
1683
resolved.append(conflict)
1686
resolved.remove_files(self)
1687
self.set_conflicts(un_resolved)
1688
return un_resolved, resolved
1690
def _validate(self):
1691
"""Validate internal structures.
1693
This is meant mostly for the test suite. To give it a chance to detect
1694
corruption after actions have occurred. The default implementation is a
1697
:return: None. An exception should be raised if there is an error.
1701
def check_state(self):
1702
"""Check that the working state is/isn't valid."""
1703
raise NotImplementedError(self.check_state)
1705
def reset_state(self, revision_ids=None):
1706
"""Reset the state of the working tree.
1708
This does a hard-reset to a last-known-good state. This is a way to
1709
fix if something got corrupted (like the .bzr/checkout/dirstate file)
1711
raise NotImplementedError(self.reset_state)
1713
def _get_rules_searcher(self, default_searcher):
1714
"""See Tree._get_rules_searcher."""
1715
if self._rules_searcher is None:
1716
self._rules_searcher = super(WorkingTree,
1717
self)._get_rules_searcher(default_searcher)
1718
return self._rules_searcher
1720
def get_shelf_manager(self):
1721
"""Return the ShelfManager for this WorkingTree."""
1722
from bzrlib.shelf import ShelfManager
1723
return ShelfManager(self, self._transport)
1726
class InventoryWorkingTree(WorkingTree,
1727
bzrlib.mutabletree.MutableInventoryTree):
1728
"""Base class for working trees that are inventory-oriented.
1730
The inventory is held in the `Branch` working-inventory, and the
1731
files are in a directory on disk.
1733
It is possible for a `WorkingTree` to have a filename which is
1734
not listed in the Inventory and vice versa.
1737
def __init__(self, basedir='.',
1738
branch=DEPRECATED_PARAMETER,
1740
_control_files=None,
1744
"""Construct a InventoryWorkingTree instance. This is not a public API.
1746
:param branch: A branch to override probing for the branch.
1748
super(InventoryWorkingTree, self).__init__(basedir=basedir,
1749
branch=branch, _transport=_control_files._transport,
1750
_internal=_internal, _format=_format, _bzrdir=_bzrdir)
1752
self._control_files = _control_files
1753
self._detect_case_handling()
1755
if _inventory is None:
1756
# This will be acquired on lock_read() or lock_write()
1757
self._inventory_is_modified = False
1758
self._inventory = None
1760
# the caller of __init__ has provided an inventory,
1761
# we assume they know what they are doing - as its only
1762
# the Format factory and creation methods that are
1763
# permitted to do this.
1764
self._set_inventory(_inventory, dirty=False)
1766
def _set_inventory(self, inv, dirty):
1767
"""Set the internal cached inventory.
1769
:param inv: The inventory to set.
1770
:param dirty: A boolean indicating whether the inventory is the same
1771
logical inventory as whats on disk. If True the inventory is not
1772
the same and should be written to disk or data will be lost, if
1773
False then the inventory is the same as that on disk and any
1774
serialisation would be unneeded overhead.
1776
self._inventory = inv
1777
self._inventory_is_modified = dirty
1779
def _detect_case_handling(self):
1780
wt_trans = self.bzrdir.get_workingtree_transport(None)
1782
wt_trans.stat(self._format.case_sensitive_filename)
1783
except errors.NoSuchFile:
1784
self.case_sensitive = True
1786
self.case_sensitive = False
1788
self._setup_directory_is_tree_reference()
1790
def _serialize(self, inventory, out_file):
1791
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1794
def _deserialize(selt, in_file):
1795
return xml5.serializer_v5.read_inventory(in_file)
1797
def break_lock(self):
1798
"""Break a lock if one is present from another instance.
1800
Uses the ui factory to ask for confirmation if the lock may be from
1803
This will probe the repository for its lock as well.
1805
self._control_files.break_lock()
1806
self.branch.break_lock()
1808
def is_locked(self):
1809
return self._control_files.is_locked()
1811
def _must_be_locked(self):
1812
if not self.is_locked():
1813
raise errors.ObjectNotLocked(self)
1815
def lock_read(self):
1816
"""Lock the tree for reading.
1818
This also locks the branch, and can be unlocked via self.unlock().
1820
:return: A bzrlib.lock.LogicalLockResult.
1822
if not self.is_locked():
1824
self.branch.lock_read()
1826
self._control_files.lock_read()
1827
return LogicalLockResult(self.unlock)
1829
self.branch.unlock()
1832
def lock_tree_write(self):
1833
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1835
:return: A bzrlib.lock.LogicalLockResult.
1837
if not self.is_locked():
1839
self.branch.lock_read()
1841
self._control_files.lock_write()
1842
return LogicalLockResult(self.unlock)
1844
self.branch.unlock()
1847
def lock_write(self):
1848
"""See MutableTree.lock_write, and WorkingTree.unlock.
1850
:return: A bzrlib.lock.LogicalLockResult.
1852
if not self.is_locked():
1854
self.branch.lock_write()
1856
self._control_files.lock_write()
1857
return LogicalLockResult(self.unlock)
1859
self.branch.unlock()
1862
def get_physical_lock_status(self):
1863
return self._control_files.get_physical_lock_status()
1865
@needs_tree_write_lock
1866
def _write_inventory(self, inv):
1867
"""Write inventory as the current inventory."""
1868
self._set_inventory(inv, dirty=True)
1159
1871
# XXX: This method should be deprecated in favour of taking in a proper
1160
1872
# new Inventory object.
1873
@needs_tree_write_lock
1162
1874
def set_inventory(self, new_inventory_list):
1163
1875
from bzrlib.inventory import (Inventory,
1164
1876
InventoryDirectory,
1168
1879
inv = Inventory(self.get_root_id())
1178
1889
elif kind == 'symlink':
1179
1890
inv.add(InventoryLink(file_id, name, parent))
1181
raise BzrError("unknown kind %r" % kind)
1892
raise errors.BzrError("unknown kind %r" % kind)
1182
1893
self._write_inventory(inv)
1185
def set_root_id(self, file_id):
1186
"""Set the root id for this tree."""
1187
inv = self.read_working_inventory()
1895
def _write_basis_inventory(self, xml):
1896
"""Write the basis inventory XML to the basis-inventory file"""
1897
path = self._basis_inventory_name()
1899
self._transport.put_file(path, sio,
1900
mode=self.bzrdir._get_file_mode())
1902
def _reset_data(self):
1903
"""Reset transient data that cannot be revalidated."""
1904
self._inventory_is_modified = False
1905
f = self._transport.get('inventory')
1907
result = self._deserialize(f)
1910
self._set_inventory(result, dirty=False)
1912
def _set_root_id(self, file_id):
1913
"""Set the root id for this tree, in a format specific manner.
1915
:param file_id: The file id to assign to the root. It must not be
1916
present in the current inventory or an error will occur. It must
1917
not be None, but rather a valid file id.
1919
inv = self._inventory
1188
1920
orig_root_id = inv.root.file_id
1921
# TODO: it might be nice to exit early if there was nothing
1922
# to do, saving us from trigger a sync on unlock.
1923
self._inventory_is_modified = True
1924
# we preserve the root inventory entry object, but
1925
# unlinkit from the byid index
1189
1926
del inv._byid[inv.root.file_id]
1190
1927
inv.root.file_id = file_id
1928
# and link it into the index with the new changed id.
1191
1929
inv._byid[inv.root.file_id] = inv.root
1930
# and finally update all children to reference the new id.
1931
# XXX: this should be safe to just look at the root.children
1932
# list, not the WHOLE INVENTORY.
1192
1933
for fid in inv:
1193
1934
entry = inv[fid]
1194
1935
if entry.parent_id == orig_root_id:
1195
1936
entry.parent_id = inv.root.file_id
1196
self._write_inventory(inv)
1199
"""See Branch.unlock.
1201
WorkingTree locking just uses the Branch locking facilities.
1202
This is current because all working trees have an embedded branch
1203
within them. IF in the future, we were to make branch data shareable
1204
between multiple working trees, i.e. via shared storage, then we
1205
would probably want to lock both the local tree, and the branch.
1207
# FIXME: We want to write out the hashcache only when the last lock on
1208
# this working copy is released. Peeking at the lock count is a bit
1209
# of a nasty hack; probably it's better to have a transaction object,
1210
# which can do some finalization when it's either successfully or
1211
# unsuccessfully completed. (Denys's original patch did that.)
1212
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
# wrongly. Hookinh into unllock on the control files object is fine though.
1215
# TODO: split this per format so there is no ugly if block
1216
if self._hashcache.needs_write and (
1217
# dedicated lock files
1218
self._control_files._lock_count==1 or
1220
(self._control_files is self.branch.control_files and
1221
self._control_files._lock_count==3)):
1222
self._hashcache.write()
1223
# reverse order of locking.
1224
result = self._control_files.unlock()
1226
self.branch.unlock()
1232
"""Update a working tree along its branch.
1234
This will update the branch if its bound too, which means we have multiple trees involved:
1235
The new basis tree of the master.
1236
The old basis tree of the branch.
1237
The old basis tree of the working tree.
1238
The current working tree state.
1239
pathologically all three may be different, and non ancestors of each other.
1240
Conceptually we want to:
1241
Preserve the wt.basis->wt.state changes
1242
Transform the wt.basis to the new master basis.
1243
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
Restore the wt.basis->wt.state changes.
1246
There isn't a single operation at the moment to do that, so we:
1247
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
Do a 'normal' merge of the old branch basis if it is relevant.
1250
old_tip = self.branch.update()
1251
if old_tip is not None:
1252
self.add_pending_merge(old_tip)
1253
self.branch.lock_read()
1256
if self.last_revision() != self.branch.last_revision():
1257
# merge tree state up to new branch tip.
1258
basis = self.basis_tree()
1259
to_tree = self.branch.basis_tree()
1260
result += merge_inner(self.branch,
1264
self.set_last_revision(self.branch.last_revision())
1265
if old_tip and old_tip != self.last_revision():
1266
# our last revision was not the prior branch last reivison
1267
# and we have converted that last revision to a pending merge.
1268
# base is somewhere between the branch tip now
1269
# and the now pending merge
1270
from bzrlib.revision import common_ancestor
1272
base_rev_id = common_ancestor(self.branch.last_revision(),
1274
self.branch.repository)
1275
except errors.NoCommonAncestor:
1277
base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
other_tree = self.branch.repository.revision_tree(old_tip)
1279
result += merge_inner(self.branch,
1285
self.branch.unlock()
1288
def _write_inventory(self, inv):
1289
"""Write inventory as the current inventory."""
1938
def all_file_ids(self):
1939
"""See Tree.iter_all_file_ids"""
1940
return set(self.inventory)
1942
@needs_tree_write_lock
1943
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1944
"""See MutableTree.set_parent_trees."""
1945
parent_ids = [rev for (rev, tree) in parents_list]
1946
for revision_id in parent_ids:
1947
_mod_revision.check_not_reserved_id(revision_id)
1949
self._check_parents_for_ghosts(parent_ids,
1950
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1952
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
1954
if len(parent_ids) == 0:
1955
leftmost_parent_id = _mod_revision.NULL_REVISION
1956
leftmost_parent_tree = None
1958
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
1960
if self._change_last_revision(leftmost_parent_id):
1961
if leftmost_parent_tree is None:
1962
# If we don't have a tree, fall back to reading the
1963
# parent tree from the repository.
1964
self._cache_basis_inventory(leftmost_parent_id)
1966
inv = leftmost_parent_tree.inventory
1967
xml = self._create_basis_xml_from_inventory(
1968
leftmost_parent_id, inv)
1969
self._write_basis_inventory(xml)
1970
self._set_merges_from_parent_ids(parent_ids)
1972
def _cache_basis_inventory(self, new_revision):
1973
"""Cache new_revision as the basis inventory."""
1974
# TODO: this should allow the ready-to-use inventory to be passed in,
1975
# as commit already has that ready-to-use [while the format is the
1978
# this double handles the inventory - unpack and repack -
1979
# but is easier to understand. We can/should put a conditional
1980
# in here based on whether the inventory is in the latest format
1981
# - perhaps we should repack all inventories on a repository
1983
# the fast path is to copy the raw xml from the repository. If the
1984
# xml contains 'revision_id="', then we assume the right
1985
# revision_id is set. We must check for this full string, because a
1986
# root node id can legitimately look like 'revision_id' but cannot
1988
xml = self.branch.repository._get_inventory_xml(new_revision)
1989
firstline = xml.split('\n', 1)[0]
1990
if (not 'revision_id="' in firstline or
1991
'format="7"' not in firstline):
1992
inv = self.branch.repository._serializer.read_inventory_from_string(
1994
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1995
self._write_basis_inventory(xml)
1996
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1999
def _basis_inventory_name(self):
2000
return 'basis-inventory-cache'
2002
def _create_basis_xml_from_inventory(self, revision_id, inventory):
2003
"""Create the text that will be saved in basis-inventory"""
2004
inventory.revision_id = revision_id
2005
return xml7.serializer_v7.write_inventory_to_string(inventory)
2007
@needs_tree_write_lock
2008
def set_conflicts(self, conflicts):
2009
self._put_rio('conflicts', conflicts.to_stanzas(),
2012
@needs_tree_write_lock
2013
def add_conflicts(self, new_conflicts):
2014
conflict_set = set(self.conflicts())
2015
conflict_set.update(set(list(new_conflicts)))
2016
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2017
key=_mod_conflicts.Conflict.sort_key)))
2020
def conflicts(self):
2022
confile = self._transport.get('conflicts')
2023
except errors.NoSuchFile:
2024
return _mod_conflicts.ConflictList()
2027
if confile.next() != CONFLICT_HEADER_1 + '\n':
2028
raise errors.ConflictFormatError()
2029
except StopIteration:
2030
raise errors.ConflictFormatError()
2031
reader = _mod_rio.RioReader(confile)
2032
return _mod_conflicts.ConflictList.from_stanzas(reader)
2036
def read_basis_inventory(self):
2037
"""Read the cached basis inventory."""
2038
path = self._basis_inventory_name()
2039
return self._transport.get_bytes(path)
2042
def read_working_inventory(self):
2043
"""Read the working inventory.
2045
:raises errors.InventoryModified: read_working_inventory will fail
2046
when the current in memory inventory has been modified.
2048
# conceptually this should be an implementation detail of the tree.
2049
# XXX: Deprecate this.
2050
# ElementTree does its own conversion from UTF-8, so open in
2052
if self._inventory_is_modified:
2053
raise errors.InventoryModified(self)
2054
f = self._transport.get('inventory')
2056
result = self._deserialize(f)
2059
self._set_inventory(result, dirty=False)
2063
def get_root_id(self):
2064
"""Return the id of this trees root"""
2065
return self._inventory.root.file_id
2067
def has_id(self, file_id):
2068
# files that have been deleted are excluded
2069
inv = self.inventory
2070
if not inv.has_id(file_id):
2072
path = inv.id2path(file_id)
2073
return osutils.lexists(self.abspath(path))
2075
def has_or_had_id(self, file_id):
2076
if file_id == self.inventory.root.file_id:
2078
return self.inventory.has_id(file_id)
2080
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2082
"""Iterate through file_ids for this tree.
2084
file_ids are in a WorkingTree if they are in the working inventory
2085
and the working file exists.
2087
inv = self._inventory
2088
for path, ie in inv.iter_entries():
2089
if osutils.lexists(self.abspath(path)):
2092
@needs_tree_write_lock
2093
def set_last_revision(self, new_revision):
2094
"""Change the last revision in the working tree."""
2095
if self._change_last_revision(new_revision):
2096
self._cache_basis_inventory(new_revision)
2098
def _get_check_refs(self):
2099
"""Return the references needed to perform a check of this tree.
2101
The default implementation returns no refs, and is only suitable for
2102
trees that have no local caching and can commit on ghosts at any time.
2104
:seealso: bzrlib.check for details about check_refs.
2109
def _check(self, references):
2110
"""Check the tree for consistency.
2112
:param references: A dict with keys matching the items returned by
2113
self._get_check_refs(), and values from looking those keys up in
2116
tree_basis = self.basis_tree()
2117
tree_basis.lock_read()
2119
repo_basis = references[('trees', self.last_revision())]
2120
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2121
raise errors.BzrCheckError(
2122
"Mismatched basis inventory content.")
2128
def check_state(self):
2129
"""Check that the working state is/isn't valid."""
2130
check_refs = self._get_check_refs()
2132
for ref in check_refs:
2135
refs[ref] = self.branch.repository.revision_tree(value)
2138
@needs_tree_write_lock
2139
def reset_state(self, revision_ids=None):
2140
"""Reset the state of the working tree.
2142
This does a hard-reset to a last-known-good state. This is a way to
2143
fix if something got corrupted (like the .bzr/checkout/dirstate file)
2145
if revision_ids is None:
2146
revision_ids = self.get_parent_ids()
2147
if not revision_ids:
2148
rt = self.branch.repository.revision_tree(
2149
_mod_revision.NULL_REVISION)
2151
rt = self.branch.repository.revision_tree(revision_ids[0])
2152
self._write_inventory(rt.inventory)
2153
self.set_parent_ids(revision_ids)
2156
"""Write the in memory inventory to disk."""
2157
# TODO: Maybe this should only write on dirty ?
2158
if self._control_files._lock_mode != 'w':
2159
raise errors.NotWriteLocked(self)
1290
2160
sio = StringIO()
1291
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
2161
self._serialize(self._inventory, sio)
1293
self._control_files.put('inventory', sio)
1294
self._set_inventory(inv)
1295
mutter('wrote working inventory')
1297
def set_conflicts(self, arg):
1298
raise UnsupportedOperation(self.set_conflicts, self)
1301
def conflicts(self):
1302
conflicts = ConflictList()
1303
for conflicted in self._iter_conflicts():
1306
if file_kind(self.abspath(conflicted)) != "file":
1309
if e.errno == errno.ENOENT:
1314
for suffix in ('.THIS', '.OTHER'):
1316
kind = file_kind(self.abspath(conflicted+suffix))
1318
if e.errno == errno.ENOENT:
1326
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
conflicts.append(Conflict.factory(ctype, path=conflicted,
1328
file_id=self.path2id(conflicted)))
1332
class WorkingTree3(WorkingTree):
1333
"""This is the Format 3 working tree.
1335
This differs from the base WorkingTree by:
1336
- having its own file lock
1337
- having its own last-revision property.
1339
This is new in bzr 0.8
1343
def last_revision(self):
1344
"""See WorkingTree.last_revision."""
2163
self._transport.put_file('inventory', sio,
2164
mode=self.bzrdir._get_file_mode())
2165
self._inventory_is_modified = False
2167
def get_file_mtime(self, file_id, path=None):
2168
"""See Tree.get_file_mtime."""
2170
path = self.inventory.id2path(file_id)
1346
return self._control_files.get_utf8('last-revision').read()
1350
def _change_last_revision(self, revision_id):
1351
"""See WorkingTree._change_last_revision."""
1352
if revision_id is None or revision_id == NULL_REVISION:
2172
return os.lstat(self.abspath(path)).st_mtime
2174
if e.errno == errno.ENOENT:
2175
raise errors.FileTimestampUnavailable(path)
2178
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
2179
file_id = self.path2id(path)
2181
# For unversioned files on win32, we just assume they are not
2184
return self._inventory[file_id].executable
2186
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
2187
mode = stat_result.st_mode
2188
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2190
if not supports_executable():
2191
def is_executable(self, file_id, path=None):
2192
return self._inventory[file_id].executable
2194
_is_executable_from_path_and_stat = \
2195
_is_executable_from_path_and_stat_from_basis
2197
def is_executable(self, file_id, path=None):
2199
path = self.id2path(file_id)
2200
mode = os.lstat(self.abspath(path)).st_mode
2201
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
2203
_is_executable_from_path_and_stat = \
2204
_is_executable_from_path_and_stat_from_stat
2206
@needs_tree_write_lock
2207
def _add(self, files, ids, kinds):
2208
"""See MutableTree._add."""
2209
# TODO: Re-adding a file that is removed in the working copy
2210
# should probably put it back with the previous ID.
2211
# the read and write working inventory should not occur in this
2212
# function - they should be part of lock_write and unlock.
2213
inv = self.inventory
2214
for f, file_id, kind in zip(files, ids, kinds):
2216
inv.add_path(f, kind=kind)
2218
inv.add_path(f, kind=kind, file_id=file_id)
2219
self._inventory_is_modified = True
2221
def revision_tree(self, revision_id):
2222
"""See WorkingTree.revision_id."""
2223
if revision_id == self.last_revision():
1354
self._control_files._transport.delete('last-revision')
2225
xml = self.read_basis_inventory()
1355
2226
except errors.NoSuchFile:
1360
self.branch.revision_history().index(revision_id)
1362
raise errors.NoSuchRevision(self.branch, revision_id)
1363
self._control_files.put_utf8('last-revision', revision_id)
2230
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2231
# dont use the repository revision_tree api because we want
2232
# to supply the inventory.
2233
if inv.revision_id == revision_id:
2234
return revisiontree.InventoryRevisionTree(
2235
self.branch.repository, inv, revision_id)
2236
except errors.BadInventoryFormat:
2238
# raise if there was no inventory, or if we read the wrong inventory.
2239
raise errors.NoSuchRevisionInTree(self, revision_id)
2242
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
2243
"""See Tree.annotate_iter
2245
This implementation will use the basis tree implementation if possible.
2246
Lines not in the basis are attributed to CURRENT_REVISION
2248
If there are pending merges, lines added by those merges will be
2249
incorrectly attributed to CURRENT_REVISION (but after committing, the
2250
attribution will be correct).
2252
maybe_file_parent_keys = []
2253
for parent_id in self.get_parent_ids():
2255
parent_tree = self.revision_tree(parent_id)
2256
except errors.NoSuchRevisionInTree:
2257
parent_tree = self.branch.repository.revision_tree(parent_id)
2258
parent_tree.lock_read()
2260
if not parent_tree.has_id(file_id):
2262
ie = parent_tree.inventory[file_id]
2263
if ie.kind != 'file':
2264
# Note: this is slightly unnecessary, because symlinks and
2265
# directories have a "text" which is the empty text, and we
2266
# know that won't mess up annotations. But it seems cleaner
2268
parent_text_key = (file_id, ie.revision)
2269
if parent_text_key not in maybe_file_parent_keys:
2270
maybe_file_parent_keys.append(parent_text_key)
2272
parent_tree.unlock()
2273
graph = _mod_graph.Graph(self.branch.repository.texts)
2274
heads = graph.heads(maybe_file_parent_keys)
2275
file_parent_keys = []
2276
for key in maybe_file_parent_keys:
2278
file_parent_keys.append(key)
2280
# Now we have the parents of this content
2281
annotator = self.branch.repository.texts.get_annotator()
2282
text = self.get_file_text(file_id)
2283
this_key =(file_id, default_revision)
2284
annotator.add_special_text(this_key, file_parent_keys, text)
2285
annotations = [(key[-1], line)
2286
for key, line in annotator.annotate_flat(this_key)]
2289
def _put_rio(self, filename, stanzas, header):
2290
self._must_be_locked()
2291
my_file = _mod_rio.rio_file(stanzas, header)
2292
self._transport.put_file(filename, my_file,
2293
mode=self.bzrdir._get_file_mode())
2295
@needs_tree_write_lock
2296
def set_merge_modified(self, modified_hashes):
2298
for file_id, hash in modified_hashes.iteritems():
2299
yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
2301
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
2304
def merge_modified(self):
2305
"""Return a dictionary of files modified by a merge.
2307
The list is initialized by WorkingTree.set_merge_modified, which is
2308
typically called after we make some automatic updates to the tree
2311
This returns a map of file_id->sha1, containing only files which are
2312
still in the working inventory and have that text hash.
2315
hashfile = self._transport.get('merge-hashes')
2316
except errors.NoSuchFile:
2321
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
2322
raise errors.MergeModifiedFormatError()
2323
except StopIteration:
2324
raise errors.MergeModifiedFormatError()
2325
for s in _mod_rio.RioReader(hashfile):
2326
# RioReader reads in Unicode, so convert file_ids back to utf8
2327
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
2328
if not self.inventory.has_id(file_id):
2330
text_hash = s.get("hash")
2331
if text_hash == self.get_file_sha1(file_id):
2332
merge_hashes[file_id] = text_hash
1366
2337
@needs_write_lock
1367
def set_conflicts(self, conflicts):
1368
self._put_rio('conflicts', conflicts.to_stanzas(),
1372
def conflicts(self):
1374
confile = self._control_files.get('conflicts')
1376
return ConflictList()
1378
if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
raise ConflictFormatError()
1380
except StopIteration:
1381
raise ConflictFormatError()
1382
return ConflictList.from_stanzas(RioReader(confile))
1385
def get_conflicted_stem(path):
1386
for suffix in CONFLICT_SUFFIXES:
1387
if path.endswith(suffix):
1388
return path[:-len(suffix)]
1390
@deprecated_function(zero_eight)
1391
def is_control_file(filename):
1392
"""See WorkingTree.is_control_filename(filename)."""
1393
## FIXME: better check
1394
filename = normpath(filename)
1395
while filename != '':
1396
head, tail = os.path.split(filename)
1397
## mutter('check %r for control file' % ((head, tail),))
1400
if filename == head:
1406
class WorkingTreeFormat(object):
2338
def subsume(self, other_tree):
2339
def add_children(inventory, entry):
2340
for child_entry in entry.children.values():
2341
inventory._byid[child_entry.file_id] = child_entry
2342
if child_entry.kind == 'directory':
2343
add_children(inventory, child_entry)
2344
if other_tree.get_root_id() == self.get_root_id():
2345
raise errors.BadSubsumeSource(self, other_tree,
2346
'Trees have the same root')
2348
other_tree_path = self.relpath(other_tree.basedir)
2349
except errors.PathNotChild:
2350
raise errors.BadSubsumeSource(self, other_tree,
2351
'Tree is not contained by the other')
2352
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
2353
if new_root_parent is None:
2354
raise errors.BadSubsumeSource(self, other_tree,
2355
'Parent directory is not versioned.')
2356
# We need to ensure that the result of a fetch will have a
2357
# versionedfile for the other_tree root, and only fetching into
2358
# RepositoryKnit2 guarantees that.
2359
if not self.branch.repository.supports_rich_root():
2360
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
2361
other_tree.lock_tree_write()
2363
new_parents = other_tree.get_parent_ids()
2364
other_root = other_tree.inventory.root
2365
other_root.parent_id = new_root_parent
2366
other_root.name = osutils.basename(other_tree_path)
2367
self.inventory.add(other_root)
2368
add_children(self.inventory, other_root)
2369
self._write_inventory(self.inventory)
2370
# normally we don't want to fetch whole repositories, but i think
2371
# here we really do want to consolidate the whole thing.
2372
for parent_id in other_tree.get_parent_ids():
2373
self.branch.fetch(other_tree.branch, parent_id)
2374
self.add_parent_tree_id(parent_id)
2377
other_tree.bzrdir.retire_bzrdir()
2379
@needs_tree_write_lock
2380
def extract(self, file_id, format=None):
2381
"""Extract a subtree from this tree.
2383
A new branch will be created, relative to the path for this tree.
2387
segments = osutils.splitpath(path)
2388
transport = self.branch.bzrdir.root_transport
2389
for name in segments:
2390
transport = transport.clone(name)
2391
transport.ensure_base()
2394
sub_path = self.id2path(file_id)
2395
branch_transport = mkdirs(sub_path)
2397
format = self.bzrdir.cloning_metadir()
2398
branch_transport.ensure_base()
2399
branch_bzrdir = format.initialize_on_transport(branch_transport)
2401
repo = branch_bzrdir.find_repository()
2402
except errors.NoRepositoryPresent:
2403
repo = branch_bzrdir.create_repository()
2404
if not repo.supports_rich_root():
2405
raise errors.RootNotRich()
2406
new_branch = branch_bzrdir.create_branch()
2407
new_branch.pull(self.branch)
2408
for parent_id in self.get_parent_ids():
2409
new_branch.fetch(self.branch, parent_id)
2410
tree_transport = self.bzrdir.root_transport.clone(sub_path)
2411
if tree_transport.base != branch_transport.base:
2412
tree_bzrdir = format.initialize_on_transport(tree_transport)
2413
branch.BranchReferenceFormat().initialize(tree_bzrdir,
2414
target_branch=new_branch)
2416
tree_bzrdir = branch_bzrdir
2417
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
2418
wt.set_parent_ids(self.get_parent_ids())
2419
my_inv = self.inventory
2420
child_inv = inventory.Inventory(root_id=None)
2421
new_root = my_inv[file_id]
2422
my_inv.remove_recursive_id(file_id)
2423
new_root.parent_id = None
2424
child_inv.add(new_root)
2425
self._write_inventory(my_inv)
2426
wt._write_inventory(child_inv)
2429
def list_files(self, include_root=False, from_dir=None, recursive=True):
2430
"""List all files as (path, class, kind, id, entry).
2432
Lists, but does not descend into unversioned directories.
2433
This does not include files that have been deleted in this
2434
tree. Skips the control directory.
2436
:param include_root: if True, return an entry for the root
2437
:param from_dir: start from this directory or None for the root
2438
:param recursive: whether to recurse into subdirectories or not
2440
# list_files is an iterator, so @needs_read_lock doesn't work properly
2441
# with it. So callers should be careful to always read_lock the tree.
2442
if not self.is_locked():
2443
raise errors.ObjectNotLocked(self)
2445
inv = self.inventory
2446
if from_dir is None and include_root is True:
2447
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
2448
# Convert these into local objects to save lookup times
2449
pathjoin = osutils.pathjoin
2450
file_kind = self._kind
2452
# transport.base ends in a slash, we want the piece
2453
# between the last two slashes
2454
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
2456
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
2458
# directory file_id, relative path, absolute path, reverse sorted children
2459
if from_dir is not None:
2460
from_dir_id = inv.path2id(from_dir)
2461
if from_dir_id is None:
2462
# Directory not versioned
2464
from_dir_abspath = pathjoin(self.basedir, from_dir)
2466
from_dir_id = inv.root.file_id
2467
from_dir_abspath = self.basedir
2468
children = os.listdir(from_dir_abspath)
2470
# jam 20060527 The kernel sized tree seems equivalent whether we
2471
# use a deque and popleft to keep them sorted, or if we use a plain
2472
# list and just reverse() them.
2473
children = collections.deque(children)
2474
stack = [(from_dir_id, u'', from_dir_abspath, children)]
2476
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
2479
f = children.popleft()
2480
## TODO: If we find a subdirectory with its own .bzr
2481
## directory, then that is a separate tree and we
2482
## should exclude it.
2484
# the bzrdir for this tree
2485
if transport_base_dir == f:
2488
# we know that from_dir_relpath and from_dir_abspath never end in a slash
2489
# and 'f' doesn't begin with one, we can do a string op, rather
2490
# than the checks of pathjoin(), all relative paths will have an extra slash
2492
fp = from_dir_relpath + '/' + f
2495
fap = from_dir_abspath + '/' + f
2497
dir_ie = inv[from_dir_id]
2498
if dir_ie.kind == 'directory':
2499
f_ie = dir_ie.children.get(f)
2504
elif self.is_ignored(fp[1:]):
2507
# we may not have found this file, because of a unicode
2508
# issue, or because the directory was actually a symlink.
2509
f_norm, can_access = osutils.normalized_filename(f)
2510
if f == f_norm or not can_access:
2511
# No change, so treat this file normally
2514
# this file can be accessed by a normalized path
2515
# check again if it is versioned
2516
# these lines are repeated here for performance
2518
fp = from_dir_relpath + '/' + f
2519
fap = from_dir_abspath + '/' + f
2520
f_ie = inv.get_child(from_dir_id, f)
2523
elif self.is_ignored(fp[1:]):
2530
# make a last minute entry
2532
yield fp[1:], c, fk, f_ie.file_id, f_ie
2535
yield fp[1:], c, fk, None, fk_entries[fk]()
2537
yield fp[1:], c, fk, None, TreeEntry()
2540
if fk != 'directory':
2543
# But do this child first if recursing down
2545
new_children = os.listdir(fap)
2547
new_children = collections.deque(new_children)
2548
stack.append((f_ie.file_id, fp, fap, new_children))
2549
# Break out of inner loop,
2550
# so that we start outer loop with child
2553
# if we finished all children, pop it off the stack
2556
@needs_tree_write_lock
2557
def move(self, from_paths, to_dir=None, after=False):
2560
to_dir must exist in the inventory.
2562
If to_dir exists and is a directory, the files are moved into
2563
it, keeping their old names.
2565
Note that to_dir is only the last component of the new name;
2566
this doesn't change the directory.
2568
For each entry in from_paths the move mode will be determined
2571
The first mode moves the file in the filesystem and updates the
2572
inventory. The second mode only updates the inventory without
2573
touching the file on the filesystem.
2575
move uses the second mode if 'after == True' and the target is
2576
either not versioned or newly added, and present in the working tree.
2578
move uses the second mode if 'after == False' and the source is
2579
versioned but no longer in the working tree, and the target is not
2580
versioned but present in the working tree.
2582
move uses the first mode if 'after == False' and the source is
2583
versioned and present in the working tree, and the target is not
2584
versioned and not present in the working tree.
2586
Everything else results in an error.
2588
This returns a list of (from_path, to_path) pairs for each
2589
entry that is moved.
2594
# check for deprecated use of signature
2596
raise TypeError('You must supply a target directory')
2597
# check destination directory
2598
if isinstance(from_paths, basestring):
2600
inv = self.inventory
2601
to_abs = self.abspath(to_dir)
2602
if not isdir(to_abs):
2603
raise errors.BzrMoveFailedError('',to_dir,
2604
errors.NotADirectory(to_abs))
2605
if not self.has_filename(to_dir):
2606
raise errors.BzrMoveFailedError('',to_dir,
2607
errors.NotInWorkingDirectory(to_dir))
2608
to_dir_id = inv.path2id(to_dir)
2609
if to_dir_id is None:
2610
raise errors.BzrMoveFailedError('',to_dir,
2611
errors.NotVersionedError(path=to_dir))
2613
to_dir_ie = inv[to_dir_id]
2614
if to_dir_ie.kind != 'directory':
2615
raise errors.BzrMoveFailedError('',to_dir,
2616
errors.NotADirectory(to_abs))
2618
# create rename entries and tuples
2619
for from_rel in from_paths:
2620
from_tail = splitpath(from_rel)[-1]
2621
from_id = inv.path2id(from_rel)
2623
raise errors.BzrMoveFailedError(from_rel,to_dir,
2624
errors.NotVersionedError(path=from_rel))
2626
from_entry = inv[from_id]
2627
from_parent_id = from_entry.parent_id
2628
to_rel = pathjoin(to_dir, from_tail)
2629
rename_entry = InventoryWorkingTree._RenameEntry(
2632
from_tail=from_tail,
2633
from_parent_id=from_parent_id,
2634
to_rel=to_rel, to_tail=from_tail,
2635
to_parent_id=to_dir_id)
2636
rename_entries.append(rename_entry)
2637
rename_tuples.append((from_rel, to_rel))
2639
# determine which move mode to use. checks also for movability
2640
rename_entries = self._determine_mv_mode(rename_entries, after)
2642
original_modified = self._inventory_is_modified
2645
self._inventory_is_modified = True
2646
self._move(rename_entries)
2648
# restore the inventory on error
2649
self._inventory_is_modified = original_modified
2651
self._write_inventory(inv)
2652
return rename_tuples
2654
@needs_tree_write_lock
2655
def rename_one(self, from_rel, to_rel, after=False):
2658
This can change the directory or the filename or both.
2660
rename_one has several 'modes' to work. First, it can rename a physical
2661
file and change the file_id. That is the normal mode. Second, it can
2662
only change the file_id without touching any physical file.
2664
rename_one uses the second mode if 'after == True' and 'to_rel' is not
2665
versioned but present in the working tree.
2667
rename_one uses the second mode if 'after == False' and 'from_rel' is
2668
versioned but no longer in the working tree, and 'to_rel' is not
2669
versioned but present in the working tree.
2671
rename_one uses the first mode if 'after == False' and 'from_rel' is
2672
versioned and present in the working tree, and 'to_rel' is not
2673
versioned and not present in the working tree.
2675
Everything else results in an error.
2677
inv = self.inventory
2680
# create rename entries and tuples
2681
from_tail = splitpath(from_rel)[-1]
2682
from_id = inv.path2id(from_rel)
2684
# if file is missing in the inventory maybe it's in the basis_tree
2685
basis_tree = self.branch.basis_tree()
2686
from_id = basis_tree.path2id(from_rel)
2688
raise errors.BzrRenameFailedError(from_rel,to_rel,
2689
errors.NotVersionedError(path=from_rel))
2690
# put entry back in the inventory so we can rename it
2691
from_entry = basis_tree.inventory[from_id].copy()
2694
from_entry = inv[from_id]
2695
from_parent_id = from_entry.parent_id
2696
to_dir, to_tail = os.path.split(to_rel)
2697
to_dir_id = inv.path2id(to_dir)
2698
rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
2700
from_tail=from_tail,
2701
from_parent_id=from_parent_id,
2702
to_rel=to_rel, to_tail=to_tail,
2703
to_parent_id=to_dir_id)
2704
rename_entries.append(rename_entry)
2706
# determine which move mode to use. checks also for movability
2707
rename_entries = self._determine_mv_mode(rename_entries, after)
2709
# check if the target changed directory and if the target directory is
2711
if to_dir_id is None:
2712
raise errors.BzrMoveFailedError(from_rel,to_rel,
2713
errors.NotVersionedError(path=to_dir))
2715
# all checks done. now we can continue with our actual work
2716
mutter('rename_one:\n'
2721
' to_dir_id {%s}\n',
2722
from_id, from_rel, to_rel, to_dir, to_dir_id)
2724
self._move(rename_entries)
2725
self._write_inventory(inv)
2727
class _RenameEntry(object):
2728
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2729
to_rel, to_tail, to_parent_id, only_change_inv=False,
2731
self.from_rel = from_rel
2732
self.from_id = from_id
2733
self.from_tail = from_tail
2734
self.from_parent_id = from_parent_id
2735
self.to_rel = to_rel
2736
self.to_tail = to_tail
2737
self.to_parent_id = to_parent_id
2738
self.change_id = change_id
2739
self.only_change_inv = only_change_inv
2741
def _determine_mv_mode(self, rename_entries, after=False):
2742
"""Determines for each from-to pair if both inventory and working tree
2743
or only the inventory has to be changed.
2745
Also does basic plausability tests.
2747
inv = self.inventory
2749
for rename_entry in rename_entries:
2750
# store to local variables for easier reference
2751
from_rel = rename_entry.from_rel
2752
from_id = rename_entry.from_id
2753
to_rel = rename_entry.to_rel
2754
to_id = inv.path2id(to_rel)
2755
only_change_inv = False
2758
# check the inventory for source and destination
2760
raise errors.BzrMoveFailedError(from_rel,to_rel,
2761
errors.NotVersionedError(path=from_rel))
2762
if to_id is not None:
2764
# allow it with --after but only if dest is newly added
2766
basis = self.basis_tree()
2769
if not basis.has_id(to_id):
2770
rename_entry.change_id = True
2775
raise errors.BzrMoveFailedError(from_rel,to_rel,
2776
errors.AlreadyVersionedError(path=to_rel))
2778
# try to determine the mode for rename (only change inv or change
2779
# inv and file system)
2781
if not self.has_filename(to_rel):
2782
raise errors.BzrMoveFailedError(from_id,to_rel,
2783
errors.NoSuchFile(path=to_rel,
2784
extra="New file has not been created yet"))
2785
only_change_inv = True
2786
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
2787
only_change_inv = True
2788
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
2789
only_change_inv = False
2790
elif (not self.case_sensitive
2791
and from_rel.lower() == to_rel.lower()
2792
and self.has_filename(from_rel)):
2793
only_change_inv = False
2795
# something is wrong, so lets determine what exactly
2796
if not self.has_filename(from_rel) and \
2797
not self.has_filename(to_rel):
2798
raise errors.BzrRenameFailedError(from_rel,to_rel,
2799
errors.PathsDoNotExist(paths=(str(from_rel),
2802
raise errors.RenameFailedFilesExist(from_rel, to_rel)
2803
rename_entry.only_change_inv = only_change_inv
2804
return rename_entries
2806
def _move(self, rename_entries):
2807
"""Moves a list of files.
2809
Depending on the value of the flag 'only_change_inv', the
2810
file will be moved on the file system or not.
2812
inv = self.inventory
2815
for entry in rename_entries:
2817
self._move_entry(entry)
2819
self._rollback_move(moved)
2823
def _rollback_move(self, moved):
2824
"""Try to rollback a previous move in case of an filesystem error."""
2825
inv = self.inventory
2828
self._move_entry(WorkingTree._RenameEntry(
2829
entry.to_rel, entry.from_id,
2830
entry.to_tail, entry.to_parent_id, entry.from_rel,
2831
entry.from_tail, entry.from_parent_id,
2832
entry.only_change_inv))
2833
except errors.BzrMoveFailedError, e:
2834
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2835
" The working tree is in an inconsistent state."
2836
" Please consider doing a 'bzr revert'."
2837
" Error message is: %s" % e)
2839
def _move_entry(self, entry):
2840
inv = self.inventory
2841
from_rel_abs = self.abspath(entry.from_rel)
2842
to_rel_abs = self.abspath(entry.to_rel)
2843
if from_rel_abs == to_rel_abs:
2844
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2845
"Source and target are identical.")
2847
if not entry.only_change_inv:
2849
osutils.rename(from_rel_abs, to_rel_abs)
2851
raise errors.BzrMoveFailedError(entry.from_rel,
2854
to_id = inv.path2id(entry.to_rel)
2855
inv.remove_recursive_id(to_id)
2856
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
2858
@needs_tree_write_lock
2859
def unversion(self, file_ids):
2860
"""Remove the file ids in file_ids from the current versioned set.
2862
When a file_id is unversioned, all of its children are automatically
2865
:param file_ids: The file ids to stop versioning.
2866
:raises: NoSuchId if any fileid is not currently versioned.
2868
for file_id in file_ids:
2869
if not self._inventory.has_id(file_id):
2870
raise errors.NoSuchId(self, file_id)
2871
for file_id in file_ids:
2872
if self._inventory.has_id(file_id):
2873
self._inventory.remove_recursive_id(file_id)
2875
# in the future this should just set a dirty bit to wait for the
2876
# final unlock. However, until all methods of workingtree start
2877
# with the current in -memory inventory rather than triggering
2878
# a read, it is more complex - we need to teach read_inventory
2879
# to know when to read, and when to not read first... and possibly
2880
# to save first when the in memory one may be corrupted.
2881
# so for now, we just only write it if it is indeed dirty.
2883
self._write_inventory(self._inventory)
2885
def stored_kind(self, file_id):
2886
"""See Tree.stored_kind"""
2887
return self.inventory[file_id].kind
2890
"""Yield all unversioned files in this WorkingTree.
2892
If there are any unversioned directories then only the directory is
2893
returned, not all its children. But if there are unversioned files
2894
under a versioned subdirectory, they are returned.
2896
Currently returned depth-first, sorted by name within directories.
2897
This is the same order used by 'osutils.walkdirs'.
2899
## TODO: Work from given directory downwards
2900
for path, dir_entry in self.inventory.directories():
2901
# mutter("search for unknowns in %r", path)
2902
dirabs = self.abspath(path)
2903
if not isdir(dirabs):
2904
# e.g. directory deleted
2908
for subf in os.listdir(dirabs):
2909
if self.bzrdir.is_control_filename(subf):
2911
if subf not in dir_entry.children:
2914
can_access) = osutils.normalized_filename(subf)
2915
except UnicodeDecodeError:
2916
path_os_enc = path.encode(osutils._fs_enc)
2917
relpath = path_os_enc + '/' + subf
2918
raise errors.BadFilenameEncoding(relpath,
2920
if subf_norm != subf and can_access:
2921
if subf_norm not in dir_entry.children:
2922
fl.append(subf_norm)
2928
subp = pathjoin(path, subf)
2931
def _walkdirs(self, prefix=""):
2932
"""Walk the directories of this tree.
2934
:param prefix: is used as the directrory to start with.
2935
:returns: a generator which yields items in the form::
2937
((curren_directory_path, fileid),
2938
[(file1_path, file1_name, file1_kind, None, file1_id,
2941
_directory = 'directory'
2942
# get the root in the inventory
2943
inv = self.inventory
2944
top_id = inv.path2id(prefix)
2948
pending = [(prefix, '', _directory, None, top_id, None)]
2951
currentdir = pending.pop()
2952
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2953
top_id = currentdir[4]
2955
relroot = currentdir[0] + '/'
2958
# FIXME: stash the node in pending
2960
if entry.kind == 'directory':
2961
for name, child in entry.sorted_children():
2962
dirblock.append((relroot + name, name, child.kind, None,
2963
child.file_id, child.kind
2965
yield (currentdir[0], entry.file_id), dirblock
2966
# push the user specified dirs from dirblock
2967
for dir in reversed(dirblock):
2968
if dir[2] == _directory:
2972
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
2973
"""Registry for working tree formats."""
2975
def __init__(self, other_registry=None):
2976
super(WorkingTreeFormatRegistry, self).__init__(other_registry)
2977
self._default_format = None
2978
self._default_format_key = None
2980
def get_default(self):
2981
"""Return the current default format."""
2982
if (self._default_format_key is not None and
2983
self._default_format is None):
2984
self._default_format = self.get(self._default_format_key)
2985
return self._default_format
2987
def set_default(self, format):
2988
"""Set the default format."""
2989
self._default_format = format
2990
self._default_format_key = None
2992
def set_default_key(self, format_string):
2993
"""Set the default format by its format string."""
2994
self._default_format_key = format_string
2995
self._default_format = None
2998
format_registry = WorkingTreeFormatRegistry()
3001
class WorkingTreeFormat(controldir.ControlComponentFormat):
1407
3002
"""An encapsulation of the initialization and open routines for a format.
1409
3004
Formats provide three things:
1456
3090
"""Is this format supported?
1458
3092
Supported formats can be initialized and opened.
1459
Unsupported formats may not support initialization or committing or
3093
Unsupported formats may not support initialization or committing or
1460
3094
some other features depending on the reason for not being supported.
3098
def supports_content_filtering(self):
3099
"""True if this format supports content filtering."""
3102
def supports_views(self):
3103
"""True if this format supports stored views."""
3107
@symbol_versioning.deprecated_method(
3108
symbol_versioning.deprecated_in((2, 4, 0)))
1465
3109
def register_format(klass, format):
1466
klass._formats[format.get_format_string()] = format
3110
format_registry.register(format)
3113
@symbol_versioning.deprecated_method(
3114
symbol_versioning.deprecated_in((2, 4, 0)))
3115
def register_extra_format(klass, format):
3116
format_registry.register_extra(format)
3119
@symbol_versioning.deprecated_method(
3120
symbol_versioning.deprecated_in((2, 4, 0)))
3121
def unregister_extra_format(klass, format):
3122
format_registry.unregister_extra(format)
3125
@symbol_versioning.deprecated_method(
3126
symbol_versioning.deprecated_in((2, 4, 0)))
3127
def get_formats(klass):
3128
return format_registry._get_all()
3131
@symbol_versioning.deprecated_method(
3132
symbol_versioning.deprecated_in((2, 4, 0)))
1469
3133
def set_default_format(klass, format):
1470
klass._default_format = format
3134
format_registry.set_default(format)
3137
@symbol_versioning.deprecated_method(
3138
symbol_versioning.deprecated_in((2, 4, 0)))
1473
3139
def unregister_format(klass, format):
1474
assert klass._formats[format.get_format_string()] is format
1475
del klass._formats[format.get_format_string()]
1479
class WorkingTreeFormat2(WorkingTreeFormat):
1480
"""The second working tree format.
1482
This format modified the hash cache from the format 1 hash cache.
1485
def get_format_description(self):
1486
"""See WorkingTreeFormat.get_format_description()."""
1487
return "Working tree format 2"
1489
def initialize(self, a_bzrdir, revision_id=None):
1490
"""See WorkingTreeFormat.initialize()."""
1491
if not isinstance(a_bzrdir.transport, LocalTransport):
1492
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1493
branch = a_bzrdir.open_branch()
1494
if revision_id is not None:
1497
revision_history = branch.revision_history()
1499
position = revision_history.index(revision_id)
1501
raise errors.NoSuchRevision(branch, revision_id)
1502
branch.set_revision_history(revision_history[:position + 1])
1505
revision = branch.last_revision()
1507
wt = WorkingTree(a_bzrdir.root_transport.base,
1513
wt._write_inventory(inv)
1514
wt.set_root_id(inv.root.file_id)
1515
wt.set_last_revision(revision)
1516
wt.set_pending_merges([])
1517
build_tree(wt.basis_tree(), wt)
1521
super(WorkingTreeFormat2, self).__init__()
1522
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1524
def open(self, a_bzrdir, _found=False):
1525
"""Return the WorkingTree object for a_bzrdir
1527
_found is a private parameter, do not use it. It is used to indicate
1528
if format probing has already been done.
1531
# we are being called directly and must probe.
1532
raise NotImplementedError
1533
if not isinstance(a_bzrdir.transport, LocalTransport):
1534
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
return WorkingTree(a_bzrdir.root_transport.base,
1541
class WorkingTreeFormat3(WorkingTreeFormat):
1542
"""The second working tree format updated to record a format marker.
1545
- exists within a metadir controlling .bzr
1546
- includes an explicit version marker for the workingtree control
1547
files, separate from the BzrDir format
1548
- modifies the hash cache format
1550
- uses a LockDir to guard access to the repository
1553
def get_format_string(self):
1554
"""See WorkingTreeFormat.get_format_string()."""
1555
return "Bazaar-NG Working Tree format 3"
1557
def get_format_description(self):
1558
"""See WorkingTreeFormat.get_format_description()."""
1559
return "Working tree format 3"
1561
_lock_file_name = 'lock'
1562
_lock_class = LockDir
1564
def _open_control_files(self, a_bzrdir):
1565
transport = a_bzrdir.get_workingtree_transport(None)
1566
return LockableFiles(transport, self._lock_file_name,
1569
def initialize(self, a_bzrdir, revision_id=None):
1570
"""See WorkingTreeFormat.initialize().
1572
revision_id allows creating a working tree at a differnet
1573
revision than the branch is at.
1575
if not isinstance(a_bzrdir.transport, LocalTransport):
1576
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1577
transport = a_bzrdir.get_workingtree_transport(self)
1578
control_files = self._open_control_files(a_bzrdir)
1579
control_files.create_lock()
1580
control_files.put_utf8('format', self.get_format_string())
1581
branch = a_bzrdir.open_branch()
1582
if revision_id is None:
1583
revision_id = branch.last_revision()
1585
wt = WorkingTree3(a_bzrdir.root_transport.base,
1591
_control_files=control_files)
1592
wt._write_inventory(inv)
1593
wt.set_root_id(inv.root.file_id)
1594
wt.set_last_revision(revision_id)
1595
wt.set_pending_merges([])
1596
build_tree(wt.basis_tree(), wt)
1600
super(WorkingTreeFormat3, self).__init__()
1601
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1603
def open(self, a_bzrdir, _found=False):
1604
"""Return the WorkingTree object for a_bzrdir
1606
_found is a private parameter, do not use it. It is used to indicate
1607
if format probing has already been done.
1610
# we are being called directly and must probe.
1611
raise NotImplementedError
1612
if not isinstance(a_bzrdir.transport, LocalTransport):
1613
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
control_files = self._open_control_files(a_bzrdir)
1615
return WorkingTree3(a_bzrdir.root_transport.base,
1619
_control_files=control_files)
1622
return self.get_format_string()
1625
# formats which have no format string are not discoverable
1626
# and not independently creatable, so are not registered.
1627
__default_format = WorkingTreeFormat3()
1628
WorkingTreeFormat.register_format(__default_format)
1629
WorkingTreeFormat.set_default_format(__default_format)
1630
_legacy_formats = [WorkingTreeFormat2(),
1634
class WorkingTreeTestProviderAdapter(object):
1635
"""A tool to generate a suite testing multiple workingtree formats at once.
1637
This is done by copying the test once for each transport and injecting
1638
the transport_server, transport_readonly_server, and workingtree_format
1639
classes into each copy. Each copy is also given a new id() to make it
1643
def __init__(self, transport_server, transport_readonly_server, formats):
1644
self._transport_server = transport_server
1645
self._transport_readonly_server = transport_readonly_server
1646
self._formats = formats
1648
def adapt(self, test):
1649
from bzrlib.tests import TestSuite
1650
result = TestSuite()
1651
for workingtree_format, bzrdir_format in self._formats:
1652
new_test = deepcopy(test)
1653
new_test.transport_server = self._transport_server
1654
new_test.transport_readonly_server = self._transport_readonly_server
1655
new_test.bzrdir_format = bzrdir_format
1656
new_test.workingtree_format = workingtree_format
1657
def make_new_test_id():
1658
new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1659
return lambda: new_id
1660
new_test.id = make_new_test_id()
1661
result.addTest(new_test)
3140
format_registry.remove(format)
3142
def get_controldir_for_branch(self):
3143
"""Get the control directory format for creating branches.
3145
This is to support testing of working tree formats that can not exist
3146
in the same control directory as a branch.
3148
return self._matchingbzrdir
3151
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
3152
"bzrlib.workingtree_4", "WorkingTreeFormat4")
3153
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
3154
"bzrlib.workingtree_4", "WorkingTreeFormat5")
3155
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
3156
"bzrlib.workingtree_4", "WorkingTreeFormat6")
3157
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
3158
"bzrlib.workingtree_3", "WorkingTreeFormat3")
3159
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")
added
removed
bzrlib/workingtree.py
