29
29
WorkingTree.open(dir).
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
35
# TODO: Give the workingtree sole responsibility for the working inventory;
36
# remove the variable and references to it from the branch. This may require
37
# updating the commit code so as to update the inventory within the working
38
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
# At the moment they may alias the inventory and have old copies of it in
40
# memory. (Now done? -- mbp 20060309)
42
from binascii import hexlify
44
from copy import deepcopy
33
45
from cStringIO import StringIO
37
from bzrlib.lazy_import import lazy_import
38
lazy_import(globals(), """
39
from bisect import bisect_left
51
conflicts as _mod_conflicts,
60
revision as _mod_revision,
70
from bzrlib.transport import get_transport
71
from bzrlib.workingtree_4 import (
78
from bzrlib import symbol_versioning
53
from bzrlib.atomicfile import AtomicFile
54
from bzrlib.branch import (Branch,
56
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
57
import bzrlib.bzrdir as bzrdir
79
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
from bzrlib.lockable_files import LockableFiles
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
64
WeaveRevisionNotPresent,
68
MergeModifiedFormatError,
71
from bzrlib.inventory import InventoryEntry, Inventory
72
from bzrlib.lockable_files import LockableFiles, TransportLock
81
73
from bzrlib.lockdir import LockDir
82
import bzrlib.mutabletree
83
from bzrlib.mutabletree import needs_tree_write_lock
84
from bzrlib import osutils
74
from bzrlib.merge import merge_inner, transform_tree
85
75
from bzrlib.osutils import (
95
from bzrlib.filters import filtered_input_file
92
from bzrlib.progress import DummyProgress, ProgressPhase
93
from bzrlib.revision import NULL_REVISION
94
from bzrlib.rio import RioReader, rio_file, Stanza
95
from bzrlib.symbol_versioning import *
96
from bzrlib.textui import show_status
98
from bzrlib.transform import build_tree
96
99
from bzrlib.trace import mutter, note
100
from bzrlib.transport import get_transport
97
101
from bzrlib.transport.local import LocalTransport
98
from bzrlib.revision import CURRENT_REVISION
99
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (
102
DEPRECATED_PARAMETER,
106
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
# TODO: Modifying the conflict objects or their type is currently nearly
108
# impossible as there is no clear relationship between the working tree format
109
# and the conflict list file format.
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
102
import bzrlib.urlutils as urlutils
107
# the regex here does the following:
108
# 1) remove any weird characters; we don't escape them but rather
110
# 2) match leading '.'s to make it not hidden
111
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
112
_gen_id_suffix = None
116
def _next_id_suffix():
117
"""Create a new file id suffix that is reasonably unique.
119
On the first call we combine the current time with 64 bits of randomness
120
to give a highly probably globally unique number. Then each call in the same
121
process adds 1 to a serial number we append to that unique value.
123
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
124
# than having to move the id randomness out of the inner loop like this.
125
# XXX TODO: for the global randomness this uses we should add the thread-id
126
# before the serial #.
127
global _gen_id_suffix, _gen_id_serial
128
if _gen_id_suffix is None:
129
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
131
return _gen_id_suffix + str(_gen_id_serial)
134
def gen_file_id(name):
135
"""Return new file id for the basename 'name'.
137
The uniqueness is supplied from _next_id_suffix.
139
# XXX TODO: squash the filename to lowercase.
140
# XXX TODO: truncate the filename to something like 20 or 30 chars.
141
# XXX TODO: consider what to do with ids that look like illegal filepaths
142
# on platforms we support.
143
return _gen_file_id_re.sub('', name) + _next_id_suffix()
147
"""Return a new tree-root file id."""
148
return gen_file_id('TREE_ROOT')
115
151
class TreeEntry(object):
116
152
"""An entry that implements the minimum interface used by commands.
118
This needs further inspection, it may be better to have
154
This needs further inspection, it may be better to have
119
155
InventoryEntries without ids - though that seems wrong. For now,
120
156
this is a parallel hierarchy to InventoryEntry, and needs to become
121
157
one of several things: decorates to that hierarchy, children of, or
385
376
inv = self._inventory
386
377
for path, ie in inv.iter_entries():
387
if osutils.lexists(self.abspath(path)):
378
if bzrlib.osutils.lexists(self.abspath(path)):
390
def all_file_ids(self):
391
"""See Tree.iter_all_file_ids"""
392
return set(self.inventory)
394
381
def __repr__(self):
395
382
return "<%s of %s>" % (self.__class__.__name__,
396
383
getattr(self, 'basedir', None))
398
385
def abspath(self, filename):
399
386
return pathjoin(self.basedir, filename)
401
388
def basis_tree(self):
402
"""Return RevisionTree for the current last revision.
404
If the left most parent is a ghost then the returned tree will be an
405
empty tree - one obtained by calling
406
repository.revision_tree(NULL_REVISION).
409
revision_id = self.get_parent_ids()[0]
411
# no parents, return an empty revision tree.
412
# in the future this should return the tree for
413
# 'empty:' - the implicit root empty tree.
414
return self.branch.repository.revision_tree(
415
_mod_revision.NULL_REVISION)
417
return self.revision_tree(revision_id)
418
except errors.NoSuchRevision:
420
# No cached copy available, retrieve from the repository.
421
# FIXME? RBC 20060403 should we cache the inventory locally
424
return self.branch.repository.revision_tree(revision_id)
425
except (errors.RevisionNotPresent, errors.NoSuchRevision):
426
# the basis tree *may* be a ghost or a low level error may have
427
# occurred. If the revision is present, its a problem, if its not
429
if self.branch.repository.has_revision(revision_id):
431
# the basis tree is a ghost so return an empty tree.
432
return self.branch.repository.revision_tree(
433
_mod_revision.NULL_REVISION)
436
self._flush_ignore_list_cache()
389
"""Return RevisionTree for the current last revision."""
390
revision_id = self.last_revision()
391
if revision_id is not None:
393
xml = self.read_basis_inventory()
394
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
397
if inv is not None and inv.revision_id == revision_id:
398
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
400
# FIXME? RBC 20060403 should we cache the inventory here ?
401
return self.branch.repository.revision_tree(revision_id)
404
@deprecated_method(zero_eight)
405
def create(branch, directory):
406
"""Create a workingtree for branch at directory.
408
If existing_directory already exists it must have a .bzr directory.
409
If it does not exist, it will be created.
411
This returns a new WorkingTree object for the new checkout.
413
TODO FIXME RBC 20060124 when we have checkout formats in place this
414
should accept an optional revisionid to checkout [and reject this if
415
checking out into the same dir as a pre-checkout-aware branch format.]
417
XXX: When BzrDir is present, these should be created through that
420
warn('delete WorkingTree.create', stacklevel=3)
421
transport = get_transport(directory)
422
if branch.bzrdir.root_transport.base == transport.base:
424
return branch.bzrdir.create_workingtree()
425
# different directory,
426
# create a branch reference
427
# and now a working tree.
428
raise NotImplementedError
431
@deprecated_method(zero_eight)
432
def create_standalone(directory):
433
"""Create a checkout and a branch and a repo at directory.
435
Directory must exist and be empty.
437
please use BzrDir.create_standalone_workingtree
439
return bzrdir.BzrDir.create_standalone_workingtree(directory)
438
441
def relpath(self, path):
439
442
"""Return the local path portion from a given path.
441
The path may be absolute or relative. If its a relative path it is
444
The path may be absolute or relative. If its a relative path it is
442
445
interpreted relative to the python current working directory.
444
return osutils.relpath(self.basedir, path)
447
return relpath(self.basedir, path)
446
449
def has_filename(self, filename):
447
return osutils.lexists(self.abspath(filename))
449
def get_file(self, file_id, path=None, filtered=True):
450
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
452
def get_file_with_stat(self, file_id, path=None, filtered=True,
454
"""See Tree.get_file_with_stat."""
456
path = self.id2path(file_id)
457
file_obj = self.get_file_byname(path, filtered=False)
458
stat_value = _fstat(file_obj.fileno())
459
if filtered and self.supports_content_filtering():
460
filters = self._content_filter_stack(path)
461
file_obj = filtered_input_file(file_obj, filters)
462
return (file_obj, stat_value)
464
def get_file_text(self, file_id, path=None, filtered=True):
465
return self.get_file(file_id, path=path, filtered=filtered).read()
467
def get_file_byname(self, filename, filtered=True):
468
path = self.abspath(filename)
470
if filtered and self.supports_content_filtering():
471
filters = self._content_filter_stack(filename)
472
return filtered_input_file(f, filters)
476
def get_file_lines(self, file_id, path=None, filtered=True):
477
"""See Tree.get_file_lines()"""
478
file = self.get_file(file_id, path, filtered=filtered)
480
return file.readlines()
485
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
"""See Tree.annotate_iter
488
This implementation will use the basis tree implementation if possible.
489
Lines not in the basis are attributed to CURRENT_REVISION
491
If there are pending merges, lines added by those merges will be
492
incorrectly attributed to CURRENT_REVISION (but after committing, the
493
attribution will be correct).
495
maybe_file_parent_keys = []
496
for parent_id in self.get_parent_ids():
498
parent_tree = self.revision_tree(parent_id)
499
except errors.NoSuchRevisionInTree:
500
parent_tree = self.branch.repository.revision_tree(parent_id)
501
parent_tree.lock_read()
503
if file_id not in parent_tree:
505
ie = parent_tree.inventory[file_id]
506
if ie.kind != 'file':
507
# Note: this is slightly unnecessary, because symlinks and
508
# directories have a "text" which is the empty text, and we
509
# know that won't mess up annotations. But it seems cleaner
511
parent_text_key = (file_id, ie.revision)
512
if parent_text_key not in maybe_file_parent_keys:
513
maybe_file_parent_keys.append(parent_text_key)
516
graph = _mod_graph.Graph(self.branch.repository.texts)
517
heads = graph.heads(maybe_file_parent_keys)
518
file_parent_keys = []
519
for key in maybe_file_parent_keys:
521
file_parent_keys.append(key)
523
# Now we have the parents of this content
524
annotator = self.branch.repository.texts.get_annotator()
525
text = self.get_file(file_id).read()
526
this_key =(file_id, default_revision)
527
annotator.add_special_text(this_key, file_parent_keys, text)
528
annotations = [(key[-1], line)
529
for key, line in annotator.annotate_flat(this_key)]
532
def _get_ancestors(self, default_revision):
533
ancestors = set([default_revision])
534
for parent_id in self.get_parent_ids():
535
ancestors.update(self.branch.repository.get_ancestry(
536
parent_id, topo_sorted=False))
539
def get_parent_ids(self):
540
"""See Tree.get_parent_ids.
542
This implementation reads the pending merges list and last_revision
543
value and uses that to decide what the parents list should be.
545
last_rev = _mod_revision.ensure_null(self._last_revision())
546
if _mod_revision.NULL_REVISION == last_rev:
551
merges_bytes = self._transport.get_bytes('pending-merges')
552
except errors.NoSuchFile:
555
for l in osutils.split_lines(merges_bytes):
556
revision_id = l.rstrip('\n')
557
parents.append(revision_id)
450
return bzrlib.osutils.lexists(self.abspath(filename))
452
def get_file(self, file_id):
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_byname(self, filename):
456
return file(self.abspath(filename), 'rb')
561
458
def get_root_id(self):
562
459
"""Return the id of this trees root"""
563
return self._inventory.root.file_id
460
inv = self.read_working_inventory()
461
return inv.root.file_id
565
463
def _get_store_filename(self, file_id):
566
464
## XXX: badly named; this is not in the store at all
567
465
return self.abspath(self.id2path(file_id))
570
def clone(self, to_bzrdir, revision_id=None):
468
def clone(self, to_bzrdir, revision_id=None, basis=None):
571
469
"""Duplicate this working tree into to_bzr, including all state.
573
471
Specifically modified files are kept as modified, but
574
472
ignored and unknown files are discarded.
576
474
If you want to make a new line of development, see bzrdir.sprout()
579
If not None, the cloned tree will have its last revision set to
580
revision, and difference between the source trees last revision
477
If not None, the cloned tree will have its last revision set to
478
revision, and and difference between the source trees last revision
581
479
and this one merged in.
482
If not None, a closer copy of a tree which may have some files in
483
common, and which file content should be preferentially copied from.
583
485
# assumes the target bzr dir format is compatible.
584
result = to_bzrdir.create_workingtree()
486
result = self._format.initialize(to_bzrdir)
585
487
self.copy_content_into(result, revision_id)
589
491
def copy_content_into(self, tree, revision_id=None):
590
492
"""Copy the current content and user files of this tree into tree."""
591
tree.set_root_id(self.get_root_id())
592
493
if revision_id is None:
593
merge.transform_tree(tree, self)
494
transform_tree(tree, self)
595
# TODO now merge from tree.last_revision to revision (to preserve
596
# user local changes)
597
merge.transform_tree(tree, self)
598
tree.set_parent_ids([revision_id])
496
# TODO now merge from tree.last_revision to revision
497
transform_tree(tree, self)
498
tree.set_last_revision(revision_id)
501
def commit(self, message=None, revprops=None, *args, **kwargs):
502
# avoid circular imports
503
from bzrlib.commit import Commit
506
if not 'branch-nick' in revprops:
507
revprops['branch-nick'] = self.branch.nick
508
# args for wt.commit start at message from the Commit.commit method,
509
# but with branch a kwarg now, passing in args as is results in the
510
#message being used for the branch
511
args = (DEPRECATED_PARAMETER, message, ) + args
512
committed_id = Commit().commit( working_tree=self, revprops=revprops,
514
self._set_inventory(self.read_working_inventory())
600
517
def id2abspath(self, file_id):
601
518
return self.abspath(self.id2path(file_id))
603
520
def has_id(self, file_id):
604
521
# files that have been deleted are excluded
522
inv = self._inventory
606
523
if not inv.has_id(file_id):
608
525
path = inv.id2path(file_id)
609
return osutils.lexists(self.abspath(path))
526
return bzrlib.osutils.lexists(self.abspath(path))
611
528
def has_or_had_id(self, file_id):
612
529
if file_id == self.inventory.root.file_id:
616
533
__contains__ = has_id
618
535
def get_file_size(self, file_id):
619
"""See Tree.get_file_size"""
620
# XXX: this returns the on-disk size; it should probably return the
623
return os.path.getsize(self.id2abspath(file_id))
625
if e.errno != errno.ENOENT:
536
return os.path.getsize(self.id2abspath(file_id))
631
def get_file_sha1(self, file_id, path=None, stat_value=None):
539
def get_file_sha1(self, file_id, path=None):
633
541
path = self._inventory.id2path(file_id)
634
return self._hashcache.get_sha1(path, stat_value)
542
return self._hashcache.get_sha1(path)
636
544
def get_file_mtime(self, file_id, path=None):
638
path = self.inventory.id2path(file_id)
546
path = self._inventory.id2path(file_id)
639
547
return os.lstat(self.abspath(path)).st_mtime
641
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
file_id = self.path2id(path)
644
# For unversioned files on win32, we just assume they are not
647
return self._inventory[file_id].executable
649
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
mode = stat_result.st_mode
651
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
653
549
if not supports_executable():
654
550
def is_executable(self, file_id, path=None):
655
551
return self._inventory[file_id].executable
657
_is_executable_from_path_and_stat = \
658
_is_executable_from_path_and_stat_from_basis
660
553
def is_executable(self, file_id, path=None):
662
path = self.id2path(file_id)
555
path = self._inventory.id2path(file_id)
663
556
mode = os.lstat(self.abspath(path)).st_mode
664
557
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
_is_executable_from_path_and_stat = \
667
_is_executable_from_path_and_stat_from_stat
669
@needs_tree_write_lock
670
def _add(self, files, ids, kinds):
671
"""See MutableTree._add."""
560
def add(self, files, ids=None):
561
"""Make files versioned.
563
Note that the command line normally calls smart_add instead,
564
which can automatically recurse.
566
This adds the files to the inventory, so that they will be
567
recorded by the next commit.
570
List of paths to add, relative to the base of the tree.
573
If set, use these instead of automatically generated ids.
574
Must be the same length as the list of files, but may
575
contain None for ids that are to be autogenerated.
577
TODO: Perhaps have an option to add the ids even if the files do
580
TODO: Perhaps callback with the ids and paths as they're added.
672
582
# TODO: Re-adding a file that is removed in the working copy
673
583
# should probably put it back with the previous ID.
674
# the read and write working inventory should not occur in this
675
# function - they should be part of lock_write and unlock.
677
for f, file_id, kind in zip(files, ids, kinds):
584
if isinstance(files, basestring):
585
assert(ids is None or isinstance(ids, basestring))
591
ids = [None] * len(files)
593
assert(len(ids) == len(files))
595
inv = self.read_working_inventory()
596
for f,file_id in zip(files, ids):
597
if self.is_control_filename(f):
598
raise BzrError("cannot add control file %s" % quotefn(f))
603
raise BzrError("cannot add top-level %r" % f)
605
fullpath = normpath(self.abspath(f))
608
kind = file_kind(fullpath)
610
if e.errno == errno.ENOENT:
611
raise NoSuchFile(fullpath)
612
# maybe something better?
613
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
615
if not InventoryEntry.versionable_kind(kind):
616
raise BzrError('cannot add: not a versionable file ('
617
'i.e. regular file, symlink or directory): %s' % quotefn(f))
678
619
if file_id is None:
679
620
inv.add_path(f, kind=kind)
681
622
inv.add_path(f, kind=kind, file_id=file_id)
682
self._inventory_is_modified = True
684
@needs_tree_write_lock
685
def _gather_kinds(self, files, kinds):
686
"""See MutableTree._gather_kinds."""
687
for pos, f in enumerate(files):
688
if kinds[pos] is None:
689
fullpath = normpath(self.abspath(f))
691
kinds[pos] = file_kind(fullpath)
693
if e.errno == errno.ENOENT:
694
raise errors.NoSuchFile(fullpath)
624
self._write_inventory(inv)
696
626
@needs_write_lock
697
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
698
"""Add revision_id as a parent.
700
This is equivalent to retrieving the current list of parent ids
701
and setting the list to its value plus revision_id.
703
:param revision_id: The revision id to add to the parent list. It may
704
be a ghost revision as long as its not the first parent to be added,
705
or the allow_leftmost_as_ghost parameter is set True.
706
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
708
parents = self.get_parent_ids() + [revision_id]
709
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
710
or allow_leftmost_as_ghost)
712
@needs_tree_write_lock
713
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
714
"""Add revision_id, tree tuple as a parent.
716
This is equivalent to retrieving the current list of parent trees
717
and setting the list to its value plus parent_tuple. See also
718
add_parent_tree_id - if you only have a parent id available it will be
719
simpler to use that api. If you have the parent already available, using
720
this api is preferred.
722
:param parent_tuple: The (revision id, tree) to add to the parent list.
723
If the revision_id is a ghost, pass None for the tree.
724
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
726
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
727
if len(parent_ids) > 1:
728
# the leftmost may have already been a ghost, preserve that if it
730
allow_leftmost_as_ghost = True
731
self.set_parent_ids(parent_ids,
732
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
734
@needs_tree_write_lock
735
627
def add_pending_merge(self, *revision_ids):
736
628
# TODO: Perhaps should check at this point that the
737
629
# history of the revision is actually present?
738
parents = self.get_parent_ids()
630
p = self.pending_merges()
740
632
for rev_id in revision_ids:
741
if rev_id in parents:
743
parents.append(rev_id)
746
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
def path_content_summary(self, path, _lstat=os.lstat,
749
_mapper=osutils.file_kind_from_stat_mode):
750
"""See Tree.path_content_summary."""
751
abspath = self.abspath(path)
638
self.set_pending_merges(p)
641
def pending_merges(self):
642
"""Return a list of pending merges.
644
These are revisions that have been merged into the working
645
directory but not yet committed.
753
stat_result = _lstat(abspath)
648
merges_file = self._control_files.get_utf8('pending-merges')
754
649
except OSError, e:
755
if getattr(e, 'errno', None) == errno.ENOENT:
757
return ('missing', None, None, None)
758
# propagate other errors
760
kind = _mapper(stat_result.st_mode)
762
return self._file_content_summary(path, stat_result)
763
elif kind == 'directory':
764
# perhaps it looks like a plain directory, but it's really a
766
if self._directory_is_tree_reference(path):
767
kind = 'tree-reference'
768
return kind, None, None, None
769
elif kind == 'symlink':
770
target = osutils.readlink(abspath)
771
return ('symlink', None, None, target)
773
return (kind, None, None, None)
775
def _file_content_summary(self, path, stat_result):
776
size = stat_result.st_size
777
executable = self._is_executable_from_path_and_stat(path, stat_result)
778
# try for a stat cache lookup
779
return ('file', size, executable, self._sha_from_stat(
782
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
"""Common ghost checking functionality from set_parent_*.
785
This checks that the left hand-parent exists if there are any
788
if len(revision_ids) > 0:
789
leftmost_id = revision_ids[0]
790
if (not allow_leftmost_as_ghost and not
791
self.branch.repository.has_revision(leftmost_id)):
792
raise errors.GhostRevisionUnusableHere(leftmost_id)
794
def _set_merges_from_parent_ids(self, parent_ids):
795
merges = parent_ids[1:]
796
self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
mode=self.bzrdir._get_file_mode())
799
def _filter_parent_ids_by_ancestry(self, revision_ids):
800
"""Check that all merged revisions are proper 'heads'.
802
This will always return the first revision_id, and any merged revisions
805
if len(revision_ids) == 0:
807
graph = self.branch.repository.get_graph()
808
heads = graph.heads(revision_ids)
809
new_revision_ids = revision_ids[:1]
810
for revision_id in revision_ids[1:]:
811
if revision_id in heads and revision_id not in new_revision_ids:
812
new_revision_ids.append(revision_id)
813
if new_revision_ids != revision_ids:
814
trace.mutter('requested to set revision_ids = %s,'
815
' but filtered to %s', revision_ids, new_revision_ids)
816
return new_revision_ids
818
@needs_tree_write_lock
819
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
"""Set the parent ids to revision_ids.
822
See also set_parent_trees. This api will try to retrieve the tree data
823
for each element of revision_ids from the trees repository. If you have
824
tree data already available, it is more efficient to use
825
set_parent_trees rather than set_parent_ids. set_parent_ids is however
826
an easier API to use.
828
:param revision_ids: The revision_ids to set as the parent ids of this
829
working tree. Any of these may be ghosts.
831
self._check_parents_for_ghosts(revision_ids,
832
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
for revision_id in revision_ids:
834
_mod_revision.check_not_reserved_id(revision_id)
836
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
if len(revision_ids) > 0:
839
self.set_last_revision(revision_ids[0])
841
self.set_last_revision(_mod_revision.NULL_REVISION)
843
self._set_merges_from_parent_ids(revision_ids)
845
@needs_tree_write_lock
846
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
"""See MutableTree.set_parent_trees."""
848
parent_ids = [rev for (rev, tree) in parents_list]
849
for revision_id in parent_ids:
850
_mod_revision.check_not_reserved_id(revision_id)
852
self._check_parents_for_ghosts(parent_ids,
853
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
if len(parent_ids) == 0:
858
leftmost_parent_id = _mod_revision.NULL_REVISION
859
leftmost_parent_tree = None
861
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
863
if self._change_last_revision(leftmost_parent_id):
864
if leftmost_parent_tree is None:
865
# If we don't have a tree, fall back to reading the
866
# parent tree from the repository.
867
self._cache_basis_inventory(leftmost_parent_id)
869
inv = leftmost_parent_tree.inventory
870
xml = self._create_basis_xml_from_inventory(
871
leftmost_parent_id, inv)
872
self._write_basis_inventory(xml)
873
self._set_merges_from_parent_ids(parent_ids)
875
@needs_tree_write_lock
650
if e.errno != errno.ENOENT:
654
for l in merges_file.readlines():
655
p.append(l.rstrip('\n'))
876
659
def set_pending_merges(self, rev_list):
877
parents = self.get_parent_ids()
878
leftmost = parents[:1]
879
new_parents = leftmost + rev_list
880
self.set_parent_ids(new_parents)
660
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
882
@needs_tree_write_lock
883
663
def set_merge_modified(self, modified_hashes):
884
664
def iter_stanzas():
885
665
for file_id, hash in modified_hashes.iteritems():
886
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
666
yield Stanza(file_id=file_id, hash=hash)
887
667
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
889
def _sha_from_stat(self, path, stat_result):
890
"""Get a sha digest from the tree's stat cache.
892
The default implementation assumes no stat cache is present.
894
:param path: The path.
895
:param stat_result: The stat result being looked up.
899
670
def _put_rio(self, filename, stanzas, header):
900
self._must_be_locked()
901
671
my_file = rio_file(stanzas, header)
902
self._transport.put_file(filename, my_file,
903
mode=self.bzrdir._get_file_mode())
905
@needs_write_lock # because merge pulls data into the branch.
906
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
merge_type=None, force=False):
908
"""Merge from a branch into this working tree.
910
:param branch: The branch to merge from.
911
:param to_revision: If non-None, the merge will merge to to_revision,
912
but not beyond it. to_revision does not need to be in the history
913
of the branch when it is supplied. If None, to_revision defaults to
914
branch.last_revision().
916
from bzrlib.merge import Merger, Merge3Merger
917
merger = Merger(self.branch, this_tree=self)
918
# check that there are no local alterations
919
if not force and self.has_changes():
920
raise errors.UncommittedChanges(self)
921
if to_revision is None:
922
to_revision = _mod_revision.ensure_null(branch.last_revision())
923
merger.other_rev_id = to_revision
924
if _mod_revision.is_null(merger.other_rev_id):
925
raise errors.NoCommits(branch)
926
self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
merger.other_basis = merger.other_rev_id
928
merger.other_tree = self.branch.repository.revision_tree(
930
merger.other_branch = branch
931
if from_revision is None:
934
merger.set_base_revision(from_revision, branch)
935
if merger.base_rev_id == merger.other_rev_id:
936
raise errors.PointlessMerge
937
merger.backup_files = False
938
if merge_type is None:
939
merger.merge_type = Merge3Merger
941
merger.merge_type = merge_type
942
merger.set_interesting_files(None)
943
merger.show_base = False
944
merger.reprocess = False
945
conflicts = merger.do_merge()
672
self._control_files.put(filename, my_file)
950
675
def merge_modified(self):
951
"""Return a dictionary of files modified by a merge.
953
The list is initialized by WorkingTree.set_merge_modified, which is
954
typically called after we make some automatic updates to the tree
957
This returns a map of file_id->sha1, containing only files which are
958
still in the working inventory and have that text hash.
961
hashfile = self._transport.get('merge-hashes')
962
except errors.NoSuchFile:
677
hashfile = self._control_files.get('merge-hashes')
967
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
raise errors.MergeModifiedFormatError()
969
except StopIteration:
970
raise errors.MergeModifiedFormatError()
971
for s in RioReader(hashfile):
972
# RioReader reads in Unicode, so convert file_ids back to utf8
973
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
if file_id not in self.inventory:
976
text_hash = s.get("hash")
977
if text_hash == self.get_file_sha1(file_id):
978
merge_hashes[file_id] = text_hash
984
def mkdir(self, path, file_id=None):
985
"""See MutableTree.mkdir()."""
987
file_id = generate_ids.gen_file_id(os.path.basename(path))
988
os.mkdir(self.abspath(path))
989
self.add(path, file_id, 'directory')
682
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
683
raise MergeModifiedFormatError()
684
except StopIteration:
685
raise MergeModifiedFormatError()
686
for s in RioReader(hashfile):
687
file_id = s.get("file_id")
688
if file_id not in self.inventory:
691
if hash == self.get_file_sha1(file_id):
692
merge_hashes[file_id] = hash
992
695
def get_symlink_target(self, file_id):
993
abspath = self.id2abspath(file_id)
994
target = osutils.readlink(abspath)
998
def subsume(self, other_tree):
999
def add_children(inventory, entry):
1000
for child_entry in entry.children.values():
1001
inventory._byid[child_entry.file_id] = child_entry
1002
if child_entry.kind == 'directory':
1003
add_children(inventory, child_entry)
1004
if other_tree.get_root_id() == self.get_root_id():
1005
raise errors.BadSubsumeSource(self, other_tree,
1006
'Trees have the same root')
1008
other_tree_path = self.relpath(other_tree.basedir)
1009
except errors.PathNotChild:
1010
raise errors.BadSubsumeSource(self, other_tree,
1011
'Tree is not contained by the other')
1012
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
if new_root_parent is None:
1014
raise errors.BadSubsumeSource(self, other_tree,
1015
'Parent directory is not versioned.')
1016
# We need to ensure that the result of a fetch will have a
1017
# versionedfile for the other_tree root, and only fetching into
1018
# RepositoryKnit2 guarantees that.
1019
if not self.branch.repository.supports_rich_root():
1020
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
other_tree.lock_tree_write()
1023
new_parents = other_tree.get_parent_ids()
1024
other_root = other_tree.inventory.root
1025
other_root.parent_id = new_root_parent
1026
other_root.name = osutils.basename(other_tree_path)
1027
self.inventory.add(other_root)
1028
add_children(self.inventory, other_root)
1029
self._write_inventory(self.inventory)
1030
# normally we don't want to fetch whole repositories, but i think
1031
# here we really do want to consolidate the whole thing.
1032
for parent_id in other_tree.get_parent_ids():
1033
self.branch.fetch(other_tree.branch, parent_id)
1034
self.add_parent_tree_id(parent_id)
1037
other_tree.bzrdir.retire_bzrdir()
1039
def _setup_directory_is_tree_reference(self):
1040
if self._branch.repository._format.supports_tree_reference:
1041
self._directory_is_tree_reference = \
1042
self._directory_may_be_tree_reference
1044
self._directory_is_tree_reference = \
1045
self._directory_is_never_tree_reference
1047
def _directory_is_never_tree_reference(self, relpath):
1050
def _directory_may_be_tree_reference(self, relpath):
1051
# as a special case, if a directory contains control files then
1052
# it's a tree reference, except that the root of the tree is not
1053
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
# TODO: We could ask all the control formats whether they
1055
# recognize this directory, but at the moment there's no cheap api
1056
# to do that. Since we probably can only nest bzr checkouts and
1057
# they always use this name it's ok for now. -- mbp 20060306
1059
# FIXME: There is an unhandled case here of a subdirectory
1060
# containing .bzr but not a branch; that will probably blow up
1061
# when you try to commit it. It might happen if there is a
1062
# checkout in a subdirectory. This can be avoided by not adding
1065
@needs_tree_write_lock
1066
def extract(self, file_id, format=None):
1067
"""Extract a subtree from this tree.
1069
A new branch will be created, relative to the path for this tree.
1073
segments = osutils.splitpath(path)
1074
transport = self.branch.bzrdir.root_transport
1075
for name in segments:
1076
transport = transport.clone(name)
1077
transport.ensure_base()
1080
sub_path = self.id2path(file_id)
1081
branch_transport = mkdirs(sub_path)
1083
format = self.bzrdir.cloning_metadir()
1084
branch_transport.ensure_base()
1085
branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
repo = branch_bzrdir.find_repository()
1088
except errors.NoRepositoryPresent:
1089
repo = branch_bzrdir.create_repository()
1090
if not repo.supports_rich_root():
1091
raise errors.RootNotRich()
1092
new_branch = branch_bzrdir.create_branch()
1093
new_branch.pull(self.branch)
1094
for parent_id in self.get_parent_ids():
1095
new_branch.fetch(self.branch, parent_id)
1096
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
if tree_transport.base != branch_transport.base:
1098
tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
target_branch=new_branch)
1102
tree_bzrdir = branch_bzrdir
1103
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
wt.set_parent_ids(self.get_parent_ids())
1105
my_inv = self.inventory
1106
child_inv = inventory.Inventory(root_id=None)
1107
new_root = my_inv[file_id]
1108
my_inv.remove_recursive_id(file_id)
1109
new_root.parent_id = None
1110
child_inv.add(new_root)
1111
self._write_inventory(my_inv)
1112
wt._write_inventory(child_inv)
1115
def _serialize(self, inventory, out_file):
1116
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1119
def _deserialize(selt, in_file):
1120
return xml5.serializer_v5.read_inventory(in_file)
1123
"""Write the in memory inventory to disk."""
1124
# TODO: Maybe this should only write on dirty ?
1125
if self._control_files._lock_mode != 'w':
1126
raise errors.NotWriteLocked(self)
1128
self._serialize(self._inventory, sio)
1130
self._transport.put_file('inventory', sio,
1131
mode=self.bzrdir._get_file_mode())
1132
self._inventory_is_modified = False
1134
def _kind(self, relpath):
1135
return osutils.file_kind(self.abspath(relpath))
1137
def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
"""List all files as (path, class, kind, id, entry).
696
return os.readlink(self.id2abspath(file_id))
698
def file_class(self, filename):
699
if self.path2id(filename):
701
elif self.is_ignored(filename):
706
def list_files(self):
707
"""Recursively list all files as (path, class, kind, id, entry).
1140
709
Lists, but does not descend into unversioned directories.
1141
711
This does not include files that have been deleted in this
1142
tree. Skips the control directory.
1144
:param include_root: if True, return an entry for the root
1145
:param from_dir: start from this directory or None for the root
1146
:param recursive: whether to recurse into subdirectories or not
714
Skips the control directory.
1148
# list_files is an iterator, so @needs_read_lock doesn't work properly
1149
# with it. So callers should be careful to always read_lock the tree.
1150
if not self.is_locked():
1151
raise errors.ObjectNotLocked(self)
1153
inv = self.inventory
1154
if from_dir is None and include_root is True:
1155
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
716
inv = self._inventory
1156
717
# Convert these into local objects to save lookup times
1157
pathjoin = osutils.pathjoin
1158
file_kind = self._kind
718
pathjoin = bzrlib.osutils.pathjoin
719
file_kind = bzrlib.osutils.file_kind
1160
721
# transport.base ends in a slash, we want the piece
1161
722
# between the last two slashes
1239
779
except KeyError:
1240
780
yield fp[1:], c, fk, None, TreeEntry()
1243
783
if fk != 'directory':
1246
# But do this child first if recursing down
1248
new_children = os.listdir(fap)
1250
new_children = collections.deque(new_children)
1251
stack.append((f_ie.file_id, fp, fap, new_children))
1252
# Break out of inner loop,
1253
# so that we start outer loop with child
786
# But do this child first
787
new_children = os.listdir(fap)
789
new_children = collections.deque(new_children)
790
stack.append((f_ie.file_id, fp, fap, new_children))
791
# Break out of inner loop, so that we start outer loop with child
1256
794
# if we finished all children, pop it off the stack
1259
@needs_tree_write_lock
1260
def move(self, from_paths, to_dir=None, after=False, **kwargs):
799
def move(self, from_paths, to_name):
1261
800
"""Rename files.
1263
to_dir must exist in the inventory.
1265
If to_dir exists and is a directory, the files are moved into
1266
it, keeping their old names.
1268
Note that to_dir is only the last component of the new name;
802
to_name must exist in the inventory.
804
If to_name exists and is a directory, the files are moved into
805
it, keeping their old names.
807
Note that to_name is only the last component of the new name;
1269
808
this doesn't change the directory.
1271
For each entry in from_paths the move mode will be determined
1274
The first mode moves the file in the filesystem and updates the
1275
inventory. The second mode only updates the inventory without
1276
touching the file on the filesystem. This is the new mode introduced
1279
move uses the second mode if 'after == True' and the target is not
1280
versioned but present in the working tree.
1282
move uses the second mode if 'after == False' and the source is
1283
versioned but no longer in the working tree, and the target is not
1284
versioned but present in the working tree.
1286
move uses the first mode if 'after == False' and the source is
1287
versioned and present in the working tree, and the target is not
1288
versioned and not present in the working tree.
1290
Everything else results in an error.
1292
810
This returns a list of (from_path, to_path) pairs for each
1293
811
entry that is moved.
1298
# check for deprecated use of signature
1300
to_dir = kwargs.get('to_name', None)
1302
raise TypeError('You must supply a target directory')
1304
symbol_versioning.warn('The parameter to_name was deprecated'
1305
' in version 0.13. Use to_dir instead',
1308
# check destination directory
1309
if isinstance(from_paths, basestring):
814
## TODO: Option to move IDs only
815
assert not isinstance(from_paths, basestring)
1311
816
inv = self.inventory
1312
to_abs = self.abspath(to_dir)
817
to_abs = self.abspath(to_name)
1313
818
if not isdir(to_abs):
1314
raise errors.BzrMoveFailedError('',to_dir,
1315
errors.NotADirectory(to_abs))
1316
if not self.has_filename(to_dir):
1317
raise errors.BzrMoveFailedError('',to_dir,
1318
errors.NotInWorkingDirectory(to_dir))
1319
to_dir_id = inv.path2id(to_dir)
1320
if to_dir_id is None:
1321
raise errors.BzrMoveFailedError('',to_dir,
1322
errors.NotVersionedError(path=str(to_dir)))
819
raise BzrError("destination %r is not a directory" % to_abs)
820
if not self.has_filename(to_name):
821
raise BzrError("destination %r not in working directory" % to_abs)
822
to_dir_id = inv.path2id(to_name)
823
if to_dir_id == None and to_name != '':
824
raise BzrError("destination %r is not a versioned directory" % to_name)
1324
825
to_dir_ie = inv[to_dir_id]
1325
if to_dir_ie.kind != 'directory':
1326
raise errors.BzrMoveFailedError('',to_dir,
1327
errors.NotADirectory(to_abs))
1329
# create rename entries and tuples
1330
for from_rel in from_paths:
1331
from_tail = splitpath(from_rel)[-1]
1332
from_id = inv.path2id(from_rel)
1334
raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
errors.NotVersionedError(path=str(from_rel)))
1337
from_entry = inv[from_id]
1338
from_parent_id = from_entry.parent_id
1339
to_rel = pathjoin(to_dir, from_tail)
1340
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1342
from_tail=from_tail,
1343
from_parent_id=from_parent_id,
1344
to_rel=to_rel, to_tail=from_tail,
1345
to_parent_id=to_dir_id)
1346
rename_entries.append(rename_entry)
1347
rename_tuples.append((from_rel, to_rel))
1349
# determine which move mode to use. checks also for movability
1350
rename_entries = self._determine_mv_mode(rename_entries, after)
1352
original_modified = self._inventory_is_modified
826
if to_dir_ie.kind not in ('directory', 'root_directory'):
827
raise BzrError("destination %r is not a directory" % to_abs)
829
to_idpath = inv.get_idpath(to_dir_id)
832
if not self.has_filename(f):
833
raise BzrError("%r does not exist in working tree" % f)
834
f_id = inv.path2id(f)
836
raise BzrError("%r is not versioned" % f)
837
name_tail = splitpath(f)[-1]
838
dest_path = pathjoin(to_name, name_tail)
839
if self.has_filename(dest_path):
840
raise BzrError("destination %r already exists" % dest_path)
841
if f_id in to_idpath:
842
raise BzrError("can't move %r to a subdirectory of itself" % f)
844
# OK, so there's a race here, it's possible that someone will
845
# create a file in this interval and then the rename might be
846
# left half-done. But we should have caught most problems.
847
orig_inv = deepcopy(self.inventory)
1355
self._inventory_is_modified = True
1356
self._move(rename_entries)
850
name_tail = splitpath(f)[-1]
851
dest_path = pathjoin(to_name, name_tail)
852
result.append((f, dest_path))
853
inv.rename(inv.path2id(f), to_dir_id, name_tail)
855
rename(self.abspath(f), self.abspath(dest_path))
857
raise BzrError("failed to rename %r to %r: %s" %
858
(f, dest_path, e[1]),
859
["rename rolled back"])
1358
861
# restore the inventory on error
1359
self._inventory_is_modified = original_modified
862
self._set_inventory(orig_inv)
1361
864
self._write_inventory(inv)
1362
return rename_tuples
1364
def _determine_mv_mode(self, rename_entries, after=False):
1365
"""Determines for each from-to pair if both inventory and working tree
1366
or only the inventory has to be changed.
1368
Also does basic plausability tests.
1370
inv = self.inventory
1372
for rename_entry in rename_entries:
1373
# store to local variables for easier reference
1374
from_rel = rename_entry.from_rel
1375
from_id = rename_entry.from_id
1376
to_rel = rename_entry.to_rel
1377
to_id = inv.path2id(to_rel)
1378
only_change_inv = False
1380
# check the inventory for source and destination
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.NotVersionedError(path=str(from_rel)))
1384
if to_id is not None:
1385
raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
errors.AlreadyVersionedError(path=str(to_rel)))
1388
# try to determine the mode for rename (only change inv or change
1389
# inv and file system)
1391
if not self.has_filename(to_rel):
1392
raise errors.BzrMoveFailedError(from_id,to_rel,
1393
errors.NoSuchFile(path=str(to_rel),
1394
extra="New file has not been created yet"))
1395
only_change_inv = True
1396
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
only_change_inv = True
1398
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
only_change_inv = False
1400
elif (not self.case_sensitive
1401
and from_rel.lower() == to_rel.lower()
1402
and self.has_filename(from_rel)):
1403
only_change_inv = False
1405
# something is wrong, so lets determine what exactly
1406
if not self.has_filename(from_rel) and \
1407
not self.has_filename(to_rel):
1408
raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
errors.PathsDoNotExist(paths=(str(from_rel),
1412
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
rename_entry.only_change_inv = only_change_inv
1414
return rename_entries
1416
def _move(self, rename_entries):
1417
"""Moves a list of files.
1419
Depending on the value of the flag 'only_change_inv', the
1420
file will be moved on the file system or not.
1422
inv = self.inventory
1425
for entry in rename_entries:
1427
self._move_entry(entry)
1429
self._rollback_move(moved)
1433
def _rollback_move(self, moved):
1434
"""Try to rollback a previous move in case of an filesystem error."""
1435
inv = self.inventory
1438
self._move_entry(WorkingTree._RenameEntry(
1439
entry.to_rel, entry.from_id,
1440
entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
entry.from_tail, entry.from_parent_id,
1442
entry.only_change_inv))
1443
except errors.BzrMoveFailedError, e:
1444
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
" The working tree is in an inconsistent state."
1446
" Please consider doing a 'bzr revert'."
1447
" Error message is: %s" % e)
1449
def _move_entry(self, entry):
1450
inv = self.inventory
1451
from_rel_abs = self.abspath(entry.from_rel)
1452
to_rel_abs = self.abspath(entry.to_rel)
1453
if from_rel_abs == to_rel_abs:
1454
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
"Source and target are identical.")
1457
if not entry.only_change_inv:
1459
osutils.rename(from_rel_abs, to_rel_abs)
1461
raise errors.BzrMoveFailedError(entry.from_rel,
1463
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1465
@needs_tree_write_lock
1466
def rename_one(self, from_rel, to_rel, after=False):
868
def rename_one(self, from_rel, to_rel):
1467
869
"""Rename one file.
1469
871
This can change the directory or the filename or both.
1471
rename_one has several 'modes' to work. First, it can rename a physical
1472
file and change the file_id. That is the normal mode. Second, it can
1473
only change the file_id without touching any physical file. This is
1474
the new mode introduced in version 0.15.
1476
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
versioned but present in the working tree.
1479
rename_one uses the second mode if 'after == False' and 'from_rel' is
1480
versioned but no longer in the working tree, and 'to_rel' is not
1481
versioned but present in the working tree.
1483
rename_one uses the first mode if 'after == False' and 'from_rel' is
1484
versioned and present in the working tree, and 'to_rel' is not
1485
versioned and not present in the working tree.
1487
Everything else results in an error.
1489
873
inv = self.inventory
1492
# create rename entries and tuples
1493
from_tail = splitpath(from_rel)[-1]
1494
from_id = inv.path2id(from_rel)
1496
# if file is missing in the inventory maybe it's in the basis_tree
1497
basis_tree = self.branch.basis_tree()
1498
from_id = basis_tree.path2id(from_rel)
1500
raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
errors.NotVersionedError(path=str(from_rel)))
1502
# put entry back in the inventory so we can rename it
1503
from_entry = basis_tree.inventory[from_id].copy()
1506
from_entry = inv[from_id]
1507
from_parent_id = from_entry.parent_id
874
if not self.has_filename(from_rel):
875
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
876
if self.has_filename(to_rel):
877
raise BzrError("can't rename: new working file %r already exists" % to_rel)
879
file_id = inv.path2id(from_rel)
881
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
884
from_parent = entry.parent_id
885
from_name = entry.name
887
if inv.path2id(to_rel):
888
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1508
890
to_dir, to_tail = os.path.split(to_rel)
1509
891
to_dir_id = inv.path2id(to_dir)
1510
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1512
from_tail=from_tail,
1513
from_parent_id=from_parent_id,
1514
to_rel=to_rel, to_tail=to_tail,
1515
to_parent_id=to_dir_id)
1516
rename_entries.append(rename_entry)
1518
# determine which move mode to use. checks also for movability
1519
rename_entries = self._determine_mv_mode(rename_entries, after)
1521
# check if the target changed directory and if the target directory is
1523
if to_dir_id is None:
1524
raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
errors.NotVersionedError(path=str(to_dir)))
1527
# all checks done. now we can continue with our actual work
1528
mutter('rename_one:\n'
1533
' to_dir_id {%s}\n',
1534
from_id, from_rel, to_rel, to_dir, to_dir_id)
1536
self._move(rename_entries)
892
if to_dir_id == None and to_dir != '':
893
raise BzrError("can't determine destination directory id for %r" % to_dir)
895
mutter("rename_one:")
896
mutter(" file_id {%s}" % file_id)
897
mutter(" from_rel %r" % from_rel)
898
mutter(" to_rel %r" % to_rel)
899
mutter(" to_dir %r" % to_dir)
900
mutter(" to_dir_id {%s}" % to_dir_id)
902
inv.rename(file_id, to_dir_id, to_tail)
904
from_abs = self.abspath(from_rel)
905
to_abs = self.abspath(to_rel)
907
rename(from_abs, to_abs)
909
inv.rename(file_id, from_parent, from_name)
910
raise BzrError("failed to rename %r to %r: %s"
911
% (from_abs, to_abs, e[1]),
912
["rename rolled back"])
1537
913
self._write_inventory(inv)
1539
class _RenameEntry(object):
1540
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
self.from_rel = from_rel
1543
self.from_id = from_id
1544
self.from_tail = from_tail
1545
self.from_parent_id = from_parent_id
1546
self.to_rel = to_rel
1547
self.to_tail = to_tail
1548
self.to_parent_id = to_parent_id
1549
self.only_change_inv = only_change_inv
1551
915
@needs_read_lock
1552
916
def unknowns(self):
1553
917
"""Return all unknown files.
1555
919
These are files in the working directory that are not versioned or
1556
920
control files or ignored.
1558
# force the extras method to be fully executed before returning, to
1559
# prevent race conditions with the lock
1561
[subp for subp in self.extras() if not self.is_ignored(subp)])
1563
@needs_tree_write_lock
1564
def unversion(self, file_ids):
1565
"""Remove the file ids in file_ids from the current versioned set.
1567
When a file_id is unversioned, all of its children are automatically
1570
:param file_ids: The file ids to stop versioning.
1571
:raises: NoSuchId if any fileid is not currently versioned.
1573
for file_id in file_ids:
1574
if file_id not in self._inventory:
1575
raise errors.NoSuchId(self, file_id)
1576
for file_id in file_ids:
1577
if self._inventory.has_id(file_id):
1578
self._inventory.remove_recursive_id(file_id)
1580
# in the future this should just set a dirty bit to wait for the
1581
# final unlock. However, until all methods of workingtree start
1582
# with the current in -memory inventory rather than triggering
1583
# a read, it is more complex - we need to teach read_inventory
1584
# to know when to read, and when to not read first... and possibly
1585
# to save first when the in memory one may be corrupted.
1586
# so for now, we just only write it if it is indeed dirty.
1588
self._write_inventory(self._inventory)
922
>>> from bzrlib.bzrdir import ScratchDir
923
>>> d = ScratchDir(files=['foo', 'foo~'])
924
>>> b = d.open_branch()
925
>>> tree = d.open_workingtree()
926
>>> map(str, tree.unknowns())
929
>>> list(b.unknowns())
931
>>> tree.remove('foo')
932
>>> list(b.unknowns())
935
for subp in self.extras():
936
if not self.is_ignored(subp):
939
@deprecated_method(zero_eight)
940
def iter_conflicts(self):
941
"""List all files in the tree that have text or content conflicts.
942
DEPRECATED. Use conflicts instead."""
943
return self._iter_conflicts()
1590
945
def _iter_conflicts(self):
1591
946
conflicted = set()
1710
1082
Cached in the Tree object after the first call.
1712
ignoreset = getattr(self, '_ignoreset', None)
1713
if ignoreset is not None:
1084
if hasattr(self, '_ignorelist'):
1085
return self._ignorelist
1716
ignore_globs = set()
1717
ignore_globs.update(ignores.get_runtime_ignores())
1718
ignore_globs.update(ignores.get_user_ignores())
1087
l = bzrlib.DEFAULT_IGNORE[:]
1719
1088
if self.has_filename(bzrlib.IGNORE_FILENAME):
1720
1089
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1722
ignore_globs.update(ignores.parse_ignore_file(f))
1725
self._ignoreset = ignore_globs
1728
def _flush_ignore_list_cache(self):
1729
"""Resets the cached ignore list to force a cache rebuild."""
1730
self._ignoreset = None
1731
self._ignoreglobster = None
1090
l.extend([line.rstrip("\n\r").decode('utf-8')
1091
for line in f.readlines()])
1092
self._ignorelist = l
1093
self._ignore_regex = self._combine_ignore_rules(l)
1096
def _get_ignore_rules_as_regex(self):
1097
"""Return a regex of the ignore rules and a mapping dict.
1099
:return: (ignore rules compiled regex, dictionary mapping rule group
1100
indices to original rule.)
1102
if getattr(self, '_ignorelist', None) is None:
1103
self.get_ignore_list()
1104
return self._ignore_regex
1733
1106
def is_ignored(self, filename):
1734
1107
r"""Check whether the filename matches an ignore pattern.
1736
1109
Patterns containing '/' or '\' need to match the whole path;
1737
others match against only the last component. Patterns starting
1738
with '!' are ignore exceptions. Exceptions take precedence
1739
over regular patterns and cause the filename to not be ignored.
1110
others match against only the last component.
1741
1112
If the file is ignored, returns the pattern which caused it to
1742
1113
be ignored, otherwise None. So this can simply be used as a
1743
1114
boolean if desired."""
1744
if getattr(self, '_ignoreglobster', None) is None:
1745
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1746
return self._ignoreglobster.match(filename)
1116
# TODO: Use '**' to match directories, and other extended
1117
# globbing stuff from cvs/rsync.
1119
# XXX: fnmatch is actually not quite what we want: it's only
1120
# approximately the same as real Unix fnmatch, and doesn't
1121
# treat dotfiles correctly and allows * to match /.
1122
# Eventually it should be replaced with something more
1125
rules = self._get_ignore_rules_as_regex()
1126
for regex, mapping in rules:
1127
match = regex.match(filename)
1128
if match is not None:
1129
# one or more of the groups in mapping will have a non-None group
1131
groups = match.groups()
1132
rules = [mapping[group] for group in
1133
mapping if groups[group] is not None]
1748
1137
def kind(self, file_id):
1749
1138
return file_kind(self.id2abspath(file_id))
1751
def stored_kind(self, file_id):
1752
"""See Tree.stored_kind"""
1753
return self.inventory[file_id].kind
1755
def _comparison_data(self, entry, path):
1756
abspath = self.abspath(path)
1758
stat_value = os.lstat(abspath)
1760
if getattr(e, 'errno', None) == errno.ENOENT:
1767
mode = stat_value.st_mode
1768
kind = osutils.file_kind_from_stat_mode(mode)
1769
if not supports_executable():
1770
executable = entry is not None and entry.executable
1772
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
return kind, executable, stat_value
1775
def _file_size(self, entry, stat_value):
1776
return stat_value.st_size
1778
1141
def last_revision(self):
1779
"""Return the last revision of the branch for this tree.
1781
This format tree does not support a separate marker for last-revision
1782
compared to the branch.
1784
See MutableTree.last_revision
1142
"""Return the last revision id of this working tree.
1144
In early branch formats this was == the branch last_revision,
1145
but that cannot be relied upon - for working tree operations,
1146
always use tree.last_revision().
1786
return self._last_revision()
1789
def _last_revision(self):
1790
"""helper for get_parent_ids."""
1791
return _mod_revision.ensure_null(self.branch.last_revision())
1148
return self.branch.last_revision()
1793
1150
def is_locked(self):
1794
1151
return self._control_files.is_locked()
1796
def _must_be_locked(self):
1797
if not self.is_locked():
1798
raise errors.ObjectNotLocked(self)
1800
1153
def lock_read(self):
1801
"""Lock the tree for reading.
1803
This also locks the branch, and can be unlocked via self.unlock().
1805
:return: An object with an unlock method which will release the lock
1808
if not self.is_locked():
1810
self.branch.lock_read()
1812
self._control_files.lock_read()
1815
self.branch.unlock()
1818
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: An object with an unlock method which will release the lock
1824
if not self.is_locked():
1826
self.branch.lock_read()
1828
self._control_files.lock_write()
1154
"""See Branch.lock_read, and WorkingTree.unlock."""
1155
self.branch.lock_read()
1157
return self._control_files.lock_read()
1831
1159
self.branch.unlock()
1834
1162
def lock_write(self):
1835
"""See MutableTree.lock_write, and WorkingTree.unlock.
1837
:return: An object with an unlock method which will release the lock
1840
if not self.is_locked():
1163
"""See Branch.lock_write, and WorkingTree.unlock."""
1842
1164
self.branch.lock_write()
1844
self._control_files.lock_write()
1166
return self._control_files.lock_write()
1847
1168
self.branch.unlock()
1872
1183
def _change_last_revision(self, new_revision):
1873
1184
"""Template method part of set_last_revision to perform the change.
1875
1186
This is used to allow WorkingTree3 instances to not affect branch
1876
1187
when their last revision is set.
1878
if _mod_revision.is_null(new_revision):
1189
if new_revision is None:
1879
1190
self.branch.set_revision_history([])
1192
# current format is locked in with the branch
1193
revision_history = self.branch.revision_history()
1882
self.branch.generate_revision_history(new_revision)
1883
except errors.NoSuchRevision:
1884
# not present in the repo - dont try to set it deeper than the tip
1885
self.branch.set_revision_history([new_revision])
1195
position = revision_history.index(new_revision)
1197
raise errors.NoSuchRevision(self.branch, new_revision)
1198
self.branch.set_revision_history(revision_history[:position + 1])
1888
def _write_basis_inventory(self, xml):
1889
"""Write the basis inventory XML to the basis-inventory file"""
1890
path = self._basis_inventory_name()
1892
self._transport.put_file(path, sio,
1893
mode=self.bzrdir._get_file_mode())
1895
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1896
"""Create the text that will be saved in basis-inventory"""
1897
inventory.revision_id = revision_id
1898
return xml7.serializer_v7.write_inventory_to_string(inventory)
1900
1201
def _cache_basis_inventory(self, new_revision):
1901
1202
"""Cache new_revision as the basis inventory."""
1902
1203
# TODO: this should allow the ready-to-use inventory to be passed in,
1903
1204
# as commit already has that ready-to-use [while the format is the
1904
1205
# same, that is].
1906
# this double handles the inventory - unpack and repack -
1207
# this double handles the inventory - unpack and repack -
1907
1208
# but is easier to understand. We can/should put a conditional
1908
1209
# in here based on whether the inventory is in the latest format
1909
1210
# - perhaps we should repack all inventories on a repository
1911
1212
# the fast path is to copy the raw xml from the repository. If the
1912
# xml contains 'revision_id="', then we assume the right
1213
# xml contains 'revision_id="', then we assume the right
1913
1214
# revision_id is set. We must check for this full string, because a
1914
1215
# root node id can legitimately look like 'revision_id' but cannot
1915
1216
# contain a '"'.
1916
xml = self.branch.repository._get_inventory_xml(new_revision)
1917
firstline = xml.split('\n', 1)[0]
1918
if (not 'revision_id="' in firstline or
1919
'format="7"' not in firstline):
1920
inv = self.branch.repository._serializer.read_inventory_from_string(
1922
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
self._write_basis_inventory(xml)
1924
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1217
xml = self.branch.repository.get_inventory_xml(new_revision)
1218
if not 'revision_id="' in xml.split('\n', 1)[0]:
1219
inv = self.branch.repository.deserialise_inventory(
1221
inv.revision_id = new_revision
1222
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1223
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1224
path = self._basis_inventory_name()
1226
self._control_files.put(path, sio)
1227
except WeaveRevisionNotPresent:
1927
1230
def read_basis_inventory(self):
1928
1231
"""Read the cached basis inventory."""
1929
1232
path = self._basis_inventory_name()
1930
return self._transport.get_bytes(path)
1233
return self._control_files.get(path).read()
1932
1235
@needs_read_lock
1933
1236
def read_working_inventory(self):
1934
"""Read the working inventory.
1936
:raises errors.InventoryModified: read_working_inventory will fail
1937
when the current in memory inventory has been modified.
1939
# conceptually this should be an implementation detail of the tree.
1940
# XXX: Deprecate this.
1237
"""Read the working inventory."""
1941
1238
# ElementTree does its own conversion from UTF-8, so open in
1943
if self._inventory_is_modified:
1944
raise errors.InventoryModified(self)
1945
f = self._transport.get('inventory')
1947
result = self._deserialize(f)
1950
self._set_inventory(result, dirty=False)
1240
result = bzrlib.xml5.serializer_v5.read_inventory(
1241
self._control_files.get('inventory'))
1242
self._set_inventory(result)
1953
@needs_tree_write_lock
1954
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1956
"""Remove nominated files from the working inventory.
1958
:files: File paths relative to the basedir.
1959
:keep_files: If true, the files will also be kept.
1960
:force: Delete files and directories, even if they are changed and
1961
even if the directories are not empty.
1246
def remove(self, files, verbose=False, to_file=None):
1247
"""Remove nominated files from the working inventory..
1249
This does not remove their text. This does not run on XXX on what? RBC
1251
TODO: Refuse to remove modified files unless --force is given?
1253
TODO: Do something useful with directories.
1255
TODO: Should this remove the text or not? Tough call; not
1256
removing may be useful and the user can just use use rm, and
1257
is the opposite of add. Removing it is consistent with most
1258
other tools. Maybe an option.
1260
## TODO: Normalize names
1261
## TODO: Remove nested loops; better scalability
1963
1262
if isinstance(files, basestring):
1964
1263
files = [files]
1969
unknown_nested_files=set()
1971
to_file = sys.stdout
1973
def recurse_directory_to_add_files(directory):
1974
# Recurse directory and add all files
1975
# so we can check if they have changed.
1976
for parent_info, file_infos in\
1977
self.walkdirs(directory):
1978
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1979
# Is it versioned or ignored?
1980
if self.path2id(relpath) or self.is_ignored(relpath):
1981
# Add nested content for deletion.
1982
new_files.add(relpath)
1984
# Files which are not versioned and not ignored
1985
# should be treated as unknown.
1986
unknown_nested_files.add((relpath, None, kind))
1988
for filename in files:
1989
# Get file name into canonical form.
1990
abspath = self.abspath(filename)
1991
filename = self.relpath(abspath)
1992
if len(filename) > 0:
1993
new_files.add(filename)
1994
recurse_directory_to_add_files(filename)
1996
files = list(new_files)
1999
return # nothing to do
2001
# Sort needed to first handle directory content before the directory
2002
files.sort(reverse=True)
2004
# Bail out if we are going to delete files we shouldn't
2005
if not keep_files and not force:
2006
has_changed_files = len(unknown_nested_files) > 0
2007
if not has_changed_files:
2008
for (file_id, path, content_change, versioned, parent_id, name,
2009
kind, executable) in self.iter_changes(self.basis_tree(),
2010
include_unchanged=True, require_versioned=False,
2011
want_unversioned=True, specific_files=files):
2012
if versioned == (False, False):
2013
# The record is unknown ...
2014
if not self.is_ignored(path[1]):
2015
# ... but not ignored
2016
has_changed_files = True
2018
elif content_change and (kind[1] is not None):
2019
# Versioned and changed, but not deleted
2020
has_changed_files = True
2023
if has_changed_files:
2024
# Make delta show ALL applicable changes in error message.
2025
tree_delta = self.changes_from(self.basis_tree(),
2026
require_versioned=False, want_unversioned=True,
2027
specific_files=files)
2028
for unknown_file in unknown_nested_files:
2029
if unknown_file not in tree_delta.unversioned:
2030
tree_delta.unversioned.extend((unknown_file,))
2031
raise errors.BzrRemoveChangedFilesError(tree_delta)
2033
# Build inv_delta and delete files where applicable,
2034
# do this before any modifications to inventory.
1265
inv = self.inventory
1267
# do this before any modifications
2035
1268
for f in files:
2036
fid = self.path2id(f)
1269
fid = inv.path2id(f)
2039
message = "%s is not versioned." % (f,)
2042
# having removed it, it must be either ignored or unknown
2043
if self.is_ignored(f):
2047
# XXX: Really should be a more abstract reporter interface
2048
kind_ch = osutils.kind_marker(self.kind(fid))
2049
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2051
inv_delta.append((f, None, fid, None))
2052
message = "removed %s" % (f,)
2055
abs_path = self.abspath(f)
2056
if osutils.lexists(abs_path):
2057
if (osutils.isdir(abs_path) and
2058
len(os.listdir(abs_path)) > 0):
2060
osutils.rmtree(abs_path)
2062
message = "%s is not an empty directory "\
2063
"and won't be deleted." % (f,)
2065
osutils.delete_any(abs_path)
2066
message = "deleted %s" % (f,)
2067
elif message is not None:
2068
# Only care if we haven't done anything yet.
2069
message = "%s does not exist." % (f,)
2071
# Print only one message (if any) per file.
2072
if message is not None:
2074
self.apply_inventory_delta(inv_delta)
2076
@needs_tree_write_lock
2077
def revert(self, filenames=None, old_tree=None, backups=True,
2078
pb=None, report_changes=False):
2079
from bzrlib.conflicts import resolve
2082
symbol_versioning.warn('Using [] to revert all files is deprecated'
2083
' as of bzr 0.91. Please use None (the default) instead.',
2084
DeprecationWarning, stacklevel=2)
1271
# TODO: Perhaps make this just a warning, and continue?
1272
# This tends to happen when
1273
raise NotVersionedError(path=f)
1274
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1276
# having remove it, it must be either ignored or unknown
1277
if self.is_ignored(f):
1281
show_status(new_status, inv[fid].kind, quotefn(f), to_file=to_file)
1284
self._write_inventory(inv)
1287
def revert(self, filenames, old_tree=None, backups=True,
1288
pb=DummyProgress()):
1289
from transform import revert
1290
from conflicts import resolve
2085
1291
if old_tree is None:
2086
basis_tree = self.basis_tree()
2087
basis_tree.lock_read()
2088
old_tree = basis_tree
1292
old_tree = self.basis_tree()
1293
conflicts = revert(self, old_tree, filenames, backups, pb)
1294
if not len(filenames):
1295
self.set_pending_merges([])
2092
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2094
if filenames is None and len(self.get_parent_ids()) > 1:
2096
last_revision = self.last_revision()
2097
if last_revision != _mod_revision.NULL_REVISION:
2098
if basis_tree is None:
2099
basis_tree = self.basis_tree()
2100
basis_tree.lock_read()
2101
parent_trees.append((last_revision, basis_tree))
2102
self.set_parent_trees(parent_trees)
2105
resolve(self, filenames, ignore_misses=True, recursive=True)
2107
if basis_tree is not None:
1298
resolve(self, filenames, ignore_misses=True)
2109
1299
return conflicts
2111
def revision_tree(self, revision_id):
2112
"""See Tree.revision_tree.
2114
WorkingTree can supply revision_trees for the basis revision only
2115
because there is only one cached inventory in the bzr directory.
2117
if revision_id == self.last_revision():
2119
xml = self.read_basis_inventory()
2120
except errors.NoSuchFile:
2124
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2125
# dont use the repository revision_tree api because we want
2126
# to supply the inventory.
2127
if inv.revision_id == revision_id:
2128
return revisiontree.RevisionTree(self.branch.repository,
2130
except errors.BadInventoryFormat:
2132
# raise if there was no inventory, or if we read the wrong inventory.
2133
raise errors.NoSuchRevisionInTree(self, revision_id)
2135
1301
# XXX: This method should be deprecated in favour of taking in a proper
2136
1302
# new Inventory object.
2137
@needs_tree_write_lock
2138
1304
def set_inventory(self, new_inventory_list):
2139
1305
from bzrlib.inventory import (Inventory,
2140
1306
InventoryDirectory,
2143
1310
inv = Inventory(self.get_root_id())
2153
1320
elif kind == 'symlink':
2154
1321
inv.add(InventoryLink(file_id, name, parent))
2156
raise errors.BzrError("unknown kind %r" % kind)
1323
raise BzrError("unknown kind %r" % kind)
2157
1324
self._write_inventory(inv)
2159
@needs_tree_write_lock
2160
1327
def set_root_id(self, file_id):
2161
1328
"""Set the root id for this tree."""
2165
'WorkingTree.set_root_id with fileid=None')
2166
file_id = osutils.safe_file_id(file_id)
2167
self._set_root_id(file_id)
2169
def _set_root_id(self, file_id):
2170
"""Set the root id for this tree, in a format specific manner.
2172
:param file_id: The file id to assign to the root. It must not be
2173
present in the current inventory or an error will occur. It must
2174
not be None, but rather a valid file id.
2176
inv = self._inventory
1329
inv = self.read_working_inventory()
2177
1330
orig_root_id = inv.root.file_id
2178
# TODO: it might be nice to exit early if there was nothing
2179
# to do, saving us from trigger a sync on unlock.
2180
self._inventory_is_modified = True
2181
# we preserve the root inventory entry object, but
2182
# unlinkit from the byid index
2183
1331
del inv._byid[inv.root.file_id]
2184
1332
inv.root.file_id = file_id
2185
# and link it into the index with the new changed id.
2186
1333
inv._byid[inv.root.file_id] = inv.root
2187
# and finally update all children to reference the new id.
2188
# XXX: this should be safe to just look at the root.children
2189
# list, not the WHOLE INVENTORY.
2190
1334
for fid in inv:
2191
1335
entry = inv[fid]
2192
1336
if entry.parent_id == orig_root_id:
2193
1337
entry.parent_id = inv.root.file_id
1338
self._write_inventory(inv)
2195
1340
def unlock(self):
2196
1341
"""See Branch.unlock.
2198
1343
WorkingTree locking just uses the Branch locking facilities.
2199
1344
This is current because all working trees have an embedded branch
2200
1345
within them. IF in the future, we were to make branch data shareable
2201
between multiple working trees, i.e. via shared storage, then we
1346
between multiple working trees, i.e. via shared storage, then we
2202
1347
would probably want to lock both the local tree, and the branch.
2204
raise NotImplementedError(self.unlock)
2208
def update(self, change_reporter=None, possible_transports=None,
2209
revision=None, old_tip=_marker):
1349
# FIXME: We want to write out the hashcache only when the last lock on
1350
# this working copy is released. Peeking at the lock count is a bit
1351
# of a nasty hack; probably it's better to have a transaction object,
1352
# which can do some finalization when it's either successfully or
1353
# unsuccessfully completed. (Denys's original patch did that.)
1354
# RBC 20060206 hooking into transaction will couple lock and transaction
1355
# wrongly. Hooking into unlock on the control files object is fine though.
1357
# TODO: split this per format so there is no ugly if block
1358
if self._hashcache.needs_write and (
1359
# dedicated lock files
1360
self._control_files._lock_count==1 or
1362
(self._control_files is self.branch.control_files and
1363
self._control_files._lock_count==3)):
1364
self._hashcache.write()
1365
# reverse order of locking.
1367
return self._control_files.unlock()
1369
self.branch.unlock()
2210
1373
"""Update a working tree along its branch.
2212
This will update the branch if its bound too, which means we have
2213
multiple trees involved:
2215
- The new basis tree of the master.
2216
- The old basis tree of the branch.
2217
- The old basis tree of the working tree.
2218
- The current working tree state.
2220
Pathologically, all three may be different, and non-ancestors of each
2221
other. Conceptually we want to:
2223
- Preserve the wt.basis->wt.state changes
2224
- Transform the wt.basis to the new master basis.
2225
- Apply a merge of the old branch basis to get any 'local' changes from
2227
- Restore the wt.basis->wt.state changes.
1375
This will update the branch if its bound too, which means we have multiple trees involved:
1376
The new basis tree of the master.
1377
The old basis tree of the branch.
1378
The old basis tree of the working tree.
1379
The current working tree state.
1380
pathologically all three may be different, and non ancestors of each other.
1381
Conceptually we want to:
1382
Preserve the wt.basis->wt.state changes
1383
Transform the wt.basis to the new master basis.
1384
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1385
Restore the wt.basis->wt.state changes.
2229
1387
There isn't a single operation at the moment to do that, so we:
2230
- Merge current state -> basis tree of the master w.r.t. the old tree
2232
- Do a 'normal' merge of the old branch basis if it is relevant.
2234
:param revision: The target revision to update to. Must be in the
2236
:param old_tip: If branch.update() has already been run, the value it
2237
returned (old tip of the branch or None). _marker is used
1388
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1389
Do a 'normal' merge of the old branch basis if it is relevant.
2240
if self.branch.get_bound_location() is not None:
2242
update_branch = (old_tip is self._marker)
2244
self.lock_tree_write()
2245
update_branch = False
1391
old_tip = self.branch.update()
1392
if old_tip is not None:
1393
self.add_pending_merge(old_tip)
1394
self.branch.lock_read()
2248
old_tip = self.branch.update(possible_transports)
2250
if old_tip is self._marker:
2252
return self._update_tree(old_tip, change_reporter, revision)
1397
if self.last_revision() != self.branch.last_revision():
1398
# merge tree state up to new branch tip.
1399
basis = self.basis_tree()
1400
to_tree = self.branch.basis_tree()
1401
result += merge_inner(self.branch,
1405
self.set_last_revision(self.branch.last_revision())
1406
if old_tip and old_tip != self.last_revision():
1407
# our last revision was not the prior branch last revision
1408
# and we have converted that last revision to a pending merge.
1409
# base is somewhere between the branch tip now
1410
# and the now pending merge
1411
from bzrlib.revision import common_ancestor
1413
base_rev_id = common_ancestor(self.branch.last_revision(),
1415
self.branch.repository)
1416
except errors.NoCommonAncestor:
1418
base_tree = self.branch.repository.revision_tree(base_rev_id)
1419
other_tree = self.branch.repository.revision_tree(old_tip)
1420
result += merge_inner(self.branch,
2256
@needs_tree_write_lock
2257
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2258
"""Update a tree to the master branch.
2260
:param old_tip: if supplied, the previous tip revision the branch,
2261
before it was changed to the master branch's tip.
2263
# here if old_tip is not None, it is the old tip of the branch before
2264
# it was updated from the master branch. This should become a pending
2265
# merge in the working tree to preserve the user existing work. we
2266
# cant set that until we update the working trees last revision to be
2267
# one from the new branch, because it will just get absorbed by the
2268
# parent de-duplication logic.
2270
# We MUST save it even if an error occurs, because otherwise the users
2271
# local work is unreferenced and will appear to have been lost.
2275
last_rev = self.get_parent_ids()[0]
2277
last_rev = _mod_revision.NULL_REVISION
2278
if revision is None:
2279
revision = self.branch.last_revision()
2281
old_tip = old_tip or _mod_revision.NULL_REVISION
2283
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
# the branch we are bound to was updated
2285
# merge those changes in first
2286
base_tree = self.basis_tree()
2287
other_tree = self.branch.repository.revision_tree(old_tip)
2288
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
base_tree, this_tree=self,
2290
change_reporter=change_reporter)
2292
self.add_parent_tree((old_tip, other_tree))
2293
trace.note('Rerun update after fixing the conflicts.')
2296
if last_rev != _mod_revision.ensure_null(revision):
2297
# the working tree is up to date with the branch
2298
# we can merge the specified revision from master
2299
to_tree = self.branch.repository.revision_tree(revision)
2300
to_root_id = to_tree.get_root_id()
2302
basis = self.basis_tree()
2305
if (basis.inventory.root is None
2306
or basis.inventory.root.file_id != to_root_id):
2307
self.set_root_id(to_root_id)
2312
# determine the branch point
2313
graph = self.branch.repository.get_graph()
2314
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2316
base_tree = self.branch.repository.revision_tree(base_rev_id)
2318
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2320
change_reporter=change_reporter)
2321
self.set_last_revision(revision)
2322
# TODO - dedup parents list with things merged by pull ?
2323
# reuse the tree we've updated to to set the basis:
2324
parent_trees = [(revision, to_tree)]
2325
merges = self.get_parent_ids()[1:]
2326
# Ideally we ask the tree for the trees here, that way the working
2327
# tree can decide whether to give us the entire tree or give us a
2328
# lazy initialised tree. dirstate for instance will have the trees
2329
# in ram already, whereas a last-revision + basis-inventory tree
2330
# will not, but also does not need them when setting parents.
2331
for parent in merges:
2332
parent_trees.append(
2333
(parent, self.branch.repository.revision_tree(parent)))
2334
if not _mod_revision.is_null(old_tip):
2335
parent_trees.append(
2336
(old_tip, self.branch.repository.revision_tree(old_tip)))
2337
self.set_parent_trees(parent_trees)
2338
last_rev = parent_trees[0][0]
2341
def _write_hashcache_if_dirty(self):
2342
"""Write out the hashcache if it is dirty."""
2343
if self._hashcache.needs_write:
2345
self._hashcache.write()
2347
if e.errno not in (errno.EPERM, errno.EACCES):
2349
# TODO: jam 20061219 Should this be a warning? A single line
2350
# warning might be sufficient to let the user know what
2352
mutter('Could not write hashcache for %s\nError: %s',
2353
self._hashcache.cache_file_name(), e)
2355
@needs_tree_write_lock
1426
self.branch.unlock()
2356
1429
def _write_inventory(self, inv):
2357
1430
"""Write inventory as the current inventory."""
2358
self._set_inventory(inv, dirty=True)
1432
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1434
self._control_files.put('inventory', sio)
1435
self._set_inventory(inv)
1436
mutter('wrote working inventory')
2361
1438
def set_conflicts(self, arg):
2362
raise errors.UnsupportedOperation(self.set_conflicts, self)
2364
def add_conflicts(self, arg):
2365
raise errors.UnsupportedOperation(self.add_conflicts, self)
1439
raise UnsupportedOperation(self.set_conflicts, self)
2367
1441
@needs_read_lock
2368
1442
def conflicts(self):
2369
conflicts = _mod_conflicts.ConflictList()
1443
conflicts = ConflictList()
2370
1444
for conflicted in self._iter_conflicts():
2385
1459
if text == False:
2387
1461
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2388
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1462
conflicts.append(Conflict.factory(ctype, path=conflicted,
2390
1463
file_id=self.path2id(conflicted)))
2391
1464
return conflicts
2393
def walkdirs(self, prefix=""):
2394
"""Walk the directories of this tree.
2396
returns a generator which yields items in the form:
2397
((curren_directory_path, fileid),
2398
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2401
This API returns a generator, which is only valid during the current
2402
tree transaction - within a single lock_read or lock_write duration.
2404
If the tree is not locked, it may cause an error to be raised,
2405
depending on the tree implementation.
2407
disk_top = self.abspath(prefix)
2408
if disk_top.endswith('/'):
2409
disk_top = disk_top[:-1]
2410
top_strip_len = len(disk_top) + 1
2411
inventory_iterator = self._walkdirs(prefix)
2412
disk_iterator = osutils.walkdirs(disk_top, prefix)
2414
current_disk = disk_iterator.next()
2415
disk_finished = False
2417
if not (e.errno == errno.ENOENT or
2418
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2421
disk_finished = True
2423
current_inv = inventory_iterator.next()
2424
inv_finished = False
2425
except StopIteration:
2428
while not inv_finished or not disk_finished:
2430
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2431
cur_disk_dir_content) = current_disk
2433
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
cur_disk_dir_content) = ((None, None), None)
2435
if not disk_finished:
2436
# strip out .bzr dirs
2437
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2438
len(cur_disk_dir_content) > 0):
2439
# osutils.walkdirs can be made nicer -
2440
# yield the path-from-prefix rather than the pathjoined
2442
bzrdir_loc = bisect_left(cur_disk_dir_content,
2444
if (bzrdir_loc < len(cur_disk_dir_content)
2445
and self.bzrdir.is_control_filename(
2446
cur_disk_dir_content[bzrdir_loc][0])):
2447
# we dont yield the contents of, or, .bzr itself.
2448
del cur_disk_dir_content[bzrdir_loc]
2450
# everything is unknown
2453
# everything is missing
2456
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2458
# disk is before inventory - unknown
2459
dirblock = [(relpath, basename, kind, stat, None, None) for
2460
relpath, basename, kind, stat, top_path in
2461
cur_disk_dir_content]
2462
yield (cur_disk_dir_relpath, None), dirblock
2464
current_disk = disk_iterator.next()
2465
except StopIteration:
2466
disk_finished = True
2468
# inventory is before disk - missing.
2469
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2470
for relpath, basename, dkind, stat, fileid, kind in
2472
yield (current_inv[0][0], current_inv[0][1]), dirblock
2474
current_inv = inventory_iterator.next()
2475
except StopIteration:
2478
# versioned present directory
2479
# merge the inventory and disk data together
2481
for relpath, subiterator in itertools.groupby(sorted(
2482
current_inv[1] + cur_disk_dir_content,
2483
key=operator.itemgetter(0)), operator.itemgetter(1)):
2484
path_elements = list(subiterator)
2485
if len(path_elements) == 2:
2486
inv_row, disk_row = path_elements
2487
# versioned, present file
2488
dirblock.append((inv_row[0],
2489
inv_row[1], disk_row[2],
2490
disk_row[3], inv_row[4],
2492
elif len(path_elements[0]) == 5:
2494
dirblock.append((path_elements[0][0],
2495
path_elements[0][1], path_elements[0][2],
2496
path_elements[0][3], None, None))
2497
elif len(path_elements[0]) == 6:
2498
# versioned, absent file.
2499
dirblock.append((path_elements[0][0],
2500
path_elements[0][1], 'unknown', None,
2501
path_elements[0][4], path_elements[0][5]))
2503
raise NotImplementedError('unreachable code')
2504
yield current_inv[0], dirblock
2506
current_inv = inventory_iterator.next()
2507
except StopIteration:
2510
current_disk = disk_iterator.next()
2511
except StopIteration:
2512
disk_finished = True
2514
def _walkdirs(self, prefix=""):
2515
"""Walk the directories of this tree.
2517
:prefix: is used as the directrory to start with.
2518
returns a generator which yields items in the form:
2519
((curren_directory_path, fileid),
2520
[(file1_path, file1_name, file1_kind, None, file1_id,
2523
_directory = 'directory'
2524
# get the root in the inventory
2525
inv = self.inventory
2526
top_id = inv.path2id(prefix)
2530
pending = [(prefix, '', _directory, None, top_id, None)]
2533
currentdir = pending.pop()
2534
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2535
top_id = currentdir[4]
2537
relroot = currentdir[0] + '/'
2540
# FIXME: stash the node in pending
2542
if entry.kind == 'directory':
2543
for name, child in entry.sorted_children():
2544
dirblock.append((relroot + name, name, child.kind, None,
2545
child.file_id, child.kind
2547
yield (currentdir[0], entry.file_id), dirblock
2548
# push the user specified dirs from dirblock
2549
for dir in reversed(dirblock):
2550
if dir[2] == _directory:
2553
@needs_tree_write_lock
2554
def auto_resolve(self):
2555
"""Automatically resolve text conflicts according to contents.
2557
Only text conflicts are auto_resolvable. Files with no conflict markers
2558
are considered 'resolved', because bzr always puts conflict markers
2559
into files that have text conflicts. The corresponding .THIS .BASE and
2560
.OTHER files are deleted, as per 'resolve'.
2561
:return: a tuple of ConflictLists: (un_resolved, resolved).
2563
un_resolved = _mod_conflicts.ConflictList()
2564
resolved = _mod_conflicts.ConflictList()
2565
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2566
for conflict in self.conflicts():
2567
if (conflict.typestring != 'text conflict' or
2568
self.kind(conflict.file_id) != 'file'):
2569
un_resolved.append(conflict)
2571
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2573
for line in my_file:
2574
if conflict_re.search(line):
2575
un_resolved.append(conflict)
2578
resolved.append(conflict)
2581
resolved.remove_files(self)
2582
self.set_conflicts(un_resolved)
2583
return un_resolved, resolved
2586
def _check(self, references):
2587
"""Check the tree for consistency.
2589
:param references: A dict with keys matching the items returned by
2590
self._get_check_refs(), and values from looking those keys up in
2593
tree_basis = self.basis_tree()
2594
tree_basis.lock_read()
2596
repo_basis = references[('trees', self.last_revision())]
2597
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
raise errors.BzrCheckError(
2599
"Mismatched basis inventory content.")
2604
def _validate(self):
2605
"""Validate internal structures.
2607
This is meant mostly for the test suite. To give it a chance to detect
2608
corruption after actions have occurred. The default implementation is a
2611
:return: None. An exception should be raised if there is an error.
2615
def _get_rules_searcher(self, default_searcher):
2616
"""See Tree._get_rules_searcher."""
2617
if self._rules_searcher is None:
2618
self._rules_searcher = super(WorkingTree,
2619
self)._get_rules_searcher(default_searcher)
2620
return self._rules_searcher
2622
def get_shelf_manager(self):
2623
"""Return the ShelfManager for this WorkingTree."""
2624
from bzrlib.shelf import ShelfManager
2625
return ShelfManager(self, self._transport)
2628
class WorkingTree2(WorkingTree):
2629
"""This is the Format 2 working tree.
2631
This was the first weave based working tree.
2632
- uses os locks for locking.
2633
- uses the branch last-revision.
2636
def __init__(self, *args, **kwargs):
2637
super(WorkingTree2, self).__init__(*args, **kwargs)
2638
# WorkingTree2 has more of a constraint that self._inventory must
2639
# exist. Because this is an older format, we don't mind the overhead
2640
# caused by the extra computation here.
2642
# Newer WorkingTree's should only have self._inventory set when they
2644
if self._inventory is None:
2645
self.read_working_inventory()
2647
def _get_check_refs(self):
2648
"""Return the references needed to perform a check of this tree."""
2649
return [('trees', self.last_revision())]
2651
def lock_tree_write(self):
2652
"""See WorkingTree.lock_tree_write().
2654
In Format2 WorkingTrees we have a single lock for the branch and tree
2655
so lock_tree_write() degrades to lock_write().
2657
:return: An object with an unlock method which will release the lock
2660
self.branch.lock_write()
2662
self._control_files.lock_write()
2665
self.branch.unlock()
2669
# do non-implementation specific cleanup
2672
# we share control files:
2673
if self._control_files._lock_count == 3:
2674
# _inventory_is_modified is always False during a read lock.
2675
if self._inventory_is_modified:
2677
self._write_hashcache_if_dirty()
2679
# reverse order of locking.
2681
return self._control_files.unlock()
2683
self.branch.unlock()
2686
1467
class WorkingTree3(WorkingTree):
2687
1468
"""This is the Format 3 working tree.
added
removed
bzrlib/workingtree.py
