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.lock import LogicalLockResult
81
from bzrlib.lockable_files import LockableFiles
59
import bzrlib.errors as errors
60
from bzrlib.errors import (BzrCheckError,
63
WeaveRevisionNotPresent,
67
MergeModifiedFormatError,
70
from bzrlib.inventory import InventoryEntry, Inventory
71
from bzrlib.lockable_files import LockableFiles, TransportLock
82
72
from bzrlib.lockdir import LockDir
83
import bzrlib.mutabletree
84
from bzrlib.mutabletree import needs_tree_write_lock
85
from bzrlib import osutils
73
from bzrlib.merge import merge_inner, transform_tree
86
74
from bzrlib.osutils import (
96
from bzrlib.filters import filtered_input_file
91
from bzrlib.progress import DummyProgress, ProgressPhase
92
from bzrlib.revision import NULL_REVISION
93
from bzrlib.rio import RioReader, rio_file, Stanza
94
from bzrlib.symbol_versioning import *
95
from bzrlib.textui import show_status
97
from bzrlib.transform import build_tree
97
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport import get_transport
98
100
from bzrlib.transport.local import LocalTransport
99
from bzrlib.revision import CURRENT_REVISION
100
from bzrlib.rio import RioReader, rio_file, Stanza
101
from bzrlib.symbol_versioning import (
103
DEPRECATED_PARAMETER,
107
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
# TODO: Modifying the conflict objects or their type is currently nearly
109
# impossible as there is no clear relationship between the working tree format
110
# and the conflict list file format.
111
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
105
# the regex here does the following:
106
# 1) remove any weird characters; we don't escape them but rather
108
# 2) match leading '.'s to make it not hidden
109
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
110
_gen_id_suffix = None
114
def _next_id_suffix():
115
"""Create a new file id suffix that is reasonably unique.
117
On the first call we combine the current time with 64 bits of randomness
118
to give a highly probably globally unique number. Then each call in the same
119
process adds 1 to a serial number we append to that unique value.
121
# XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather
122
# than having to move the id randomness out of the inner loop like this.
123
# XXX TODO: for the global randomness this uses we should add the thread-id
124
# before the serial #.
125
global _gen_id_suffix, _gen_id_serial
126
if _gen_id_suffix is None:
127
_gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
129
return _gen_id_suffix + str(_gen_id_serial)
132
def gen_file_id(name):
133
"""Return new file id for the basename 'name'.
135
The uniqueness is supplied from _next_id_suffix.
137
# XXX TODO: squash the filename to lowercase.
138
# XXX TODO: truncate the filename to something like 20 or 30 chars.
139
# XXX TODO: consider what to do with ids that look like illegal filepaths
140
# on platforms we support.
141
return _gen_file_id_re.sub('', name) + _next_id_suffix()
145
"""Return a new tree-root file id."""
146
return gen_file_id('TREE_ROOT')
116
149
class TreeEntry(object):
117
"""An entry that implements the minimum interface used by commands.
150
"""An entry that implements the minium interface used by commands.
119
This needs further inspection, it may be better to have
152
This needs further inspection, it may be better to have
120
153
InventoryEntries without ids - though that seems wrong. For now,
121
154
this is a parallel hierarchy to InventoryEntry, and needs to become
122
155
one of several things: decorates to that hierarchy, children of, or
386
371
inv = self._inventory
387
372
for path, ie in inv.iter_entries():
388
if osutils.lexists(self.abspath(path)):
373
if bzrlib.osutils.lexists(self.abspath(path)):
391
def all_file_ids(self):
392
"""See Tree.iter_all_file_ids"""
393
return set(self.inventory)
395
376
def __repr__(self):
396
377
return "<%s of %s>" % (self.__class__.__name__,
397
378
getattr(self, 'basedir', None))
399
380
def abspath(self, filename):
400
381
return pathjoin(self.basedir, filename)
402
383
def basis_tree(self):
403
"""Return RevisionTree for the current last revision.
405
If the left most parent is a ghost then the returned tree will be an
406
empty tree - one obtained by calling
407
repository.revision_tree(NULL_REVISION).
410
revision_id = self.get_parent_ids()[0]
412
# no parents, return an empty revision tree.
413
# in the future this should return the tree for
414
# 'empty:' - the implicit root empty tree.
415
return self.branch.repository.revision_tree(
416
_mod_revision.NULL_REVISION)
418
return self.revision_tree(revision_id)
419
except errors.NoSuchRevision:
421
# No cached copy available, retrieve from the repository.
422
# FIXME? RBC 20060403 should we cache the inventory locally
425
return self.branch.repository.revision_tree(revision_id)
426
except (errors.RevisionNotPresent, errors.NoSuchRevision):
427
# the basis tree *may* be a ghost or a low level error may have
428
# occurred. If the revision is present, its a problem, if its not
430
if self.branch.repository.has_revision(revision_id):
432
# the basis tree is a ghost so return an empty tree.
433
return self.branch.repository.revision_tree(
434
_mod_revision.NULL_REVISION)
437
self._flush_ignore_list_cache()
384
"""Return RevisionTree for the current last revision."""
385
revision_id = self.last_revision()
386
if revision_id is not None:
388
xml = self.read_basis_inventory()
389
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
392
if inv is not None and inv.revision_id == revision_id:
393
return bzrlib.tree.RevisionTree(self.branch.repository, inv,
395
# FIXME? RBC 20060403 should we cache the inventory here ?
396
return self.branch.repository.revision_tree(revision_id)
399
@deprecated_method(zero_eight)
400
def create(branch, directory):
401
"""Create a workingtree for branch at directory.
403
If existing_directory already exists it must have a .bzr directory.
404
If it does not exist, it will be created.
406
This returns a new WorkingTree object for the new checkout.
408
TODO FIXME RBC 20060124 when we have checkout formats in place this
409
should accept an optional revisionid to checkout [and reject this if
410
checking out into the same dir as a pre-checkout-aware branch format.]
412
XXX: When BzrDir is present, these should be created through that
415
warn('delete WorkingTree.create', stacklevel=3)
416
transport = get_transport(directory)
417
if branch.bzrdir.root_transport.base == transport.base:
419
return branch.bzrdir.create_workingtree()
420
# different directory,
421
# create a branch reference
422
# and now a working tree.
423
raise NotImplementedError
426
@deprecated_method(zero_eight)
427
def create_standalone(directory):
428
"""Create a checkout and a branch and a repo at directory.
430
Directory must exist and be empty.
432
please use BzrDir.create_standalone_workingtree
434
return bzrdir.BzrDir.create_standalone_workingtree(directory)
439
436
def relpath(self, path):
440
437
"""Return the local path portion from a given path.
442
The path may be absolute or relative. If its a relative path it is
439
The path may be absolute or relative. If its a relative path it is
443
440
interpreted relative to the python current working directory.
445
return osutils.relpath(self.basedir, path)
442
return relpath(self.basedir, path)
447
444
def has_filename(self, filename):
448
return osutils.lexists(self.abspath(filename))
450
def get_file(self, file_id, path=None, filtered=True):
451
return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
453
def get_file_with_stat(self, file_id, path=None, filtered=True,
455
"""See Tree.get_file_with_stat."""
457
path = self.id2path(file_id)
458
file_obj = self.get_file_byname(path, filtered=False)
459
stat_value = _fstat(file_obj.fileno())
460
if filtered and self.supports_content_filtering():
461
filters = self._content_filter_stack(path)
462
file_obj = filtered_input_file(file_obj, filters)
463
return (file_obj, stat_value)
465
def get_file_text(self, file_id, path=None, filtered=True):
466
return self.get_file(file_id, path=path, filtered=filtered).read()
468
def get_file_byname(self, filename, filtered=True):
469
path = self.abspath(filename)
471
if filtered and self.supports_content_filtering():
472
filters = self._content_filter_stack(filename)
473
return filtered_input_file(f, filters)
477
def get_file_lines(self, file_id, path=None, filtered=True):
478
"""See Tree.get_file_lines()"""
479
file = self.get_file(file_id, path, filtered=filtered)
481
return file.readlines()
486
def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
487
"""See Tree.annotate_iter
489
This implementation will use the basis tree implementation if possible.
490
Lines not in the basis are attributed to CURRENT_REVISION
492
If there are pending merges, lines added by those merges will be
493
incorrectly attributed to CURRENT_REVISION (but after committing, the
494
attribution will be correct).
496
maybe_file_parent_keys = []
497
for parent_id in self.get_parent_ids():
499
parent_tree = self.revision_tree(parent_id)
500
except errors.NoSuchRevisionInTree:
501
parent_tree = self.branch.repository.revision_tree(parent_id)
502
parent_tree.lock_read()
504
if file_id not in parent_tree:
506
ie = parent_tree.inventory[file_id]
507
if ie.kind != 'file':
508
# Note: this is slightly unnecessary, because symlinks and
509
# directories have a "text" which is the empty text, and we
510
# know that won't mess up annotations. But it seems cleaner
512
parent_text_key = (file_id, ie.revision)
513
if parent_text_key not in maybe_file_parent_keys:
514
maybe_file_parent_keys.append(parent_text_key)
517
graph = _mod_graph.Graph(self.branch.repository.texts)
518
heads = graph.heads(maybe_file_parent_keys)
519
file_parent_keys = []
520
for key in maybe_file_parent_keys:
522
file_parent_keys.append(key)
524
# Now we have the parents of this content
525
annotator = self.branch.repository.texts.get_annotator()
526
text = self.get_file(file_id).read()
527
this_key =(file_id, default_revision)
528
annotator.add_special_text(this_key, file_parent_keys, text)
529
annotations = [(key[-1], line)
530
for key, line in annotator.annotate_flat(this_key)]
533
def _get_ancestors(self, default_revision):
534
ancestors = set([default_revision])
535
for parent_id in self.get_parent_ids():
536
ancestors.update(self.branch.repository.get_ancestry(
537
parent_id, topo_sorted=False))
540
def get_parent_ids(self):
541
"""See Tree.get_parent_ids.
543
This implementation reads the pending merges list and last_revision
544
value and uses that to decide what the parents list should be.
546
last_rev = _mod_revision.ensure_null(self._last_revision())
547
if _mod_revision.NULL_REVISION == last_rev:
552
merges_bytes = self._transport.get_bytes('pending-merges')
553
except errors.NoSuchFile:
556
for l in osutils.split_lines(merges_bytes):
557
revision_id = l.rstrip('\n')
558
parents.append(revision_id)
445
return bzrlib.osutils.lexists(self.abspath(filename))
447
def get_file(self, file_id):
448
return self.get_file_byname(self.id2path(file_id))
450
def get_file_byname(self, filename):
451
return file(self.abspath(filename), 'rb')
562
453
def get_root_id(self):
563
454
"""Return the id of this trees root"""
564
return self._inventory.root.file_id
455
inv = self.read_working_inventory()
456
return inv.root.file_id
566
458
def _get_store_filename(self, file_id):
567
459
## XXX: badly named; this is not in the store at all
568
460
return self.abspath(self.id2path(file_id))
571
def clone(self, to_bzrdir, revision_id=None):
463
def clone(self, to_bzrdir, revision_id=None, basis=None):
572
464
"""Duplicate this working tree into to_bzr, including all state.
574
466
Specifically modified files are kept as modified, but
575
467
ignored and unknown files are discarded.
577
469
If you want to make a new line of development, see bzrdir.sprout()
580
If not None, the cloned tree will have its last revision set to
581
revision, and difference between the source trees last revision
472
If not None, the cloned tree will have its last revision set to
473
revision, and and difference between the source trees last revision
582
474
and this one merged in.
477
If not None, a closer copy of a tree which may have some files in
478
common, and which file content should be preferentially copied from.
584
480
# assumes the target bzr dir format is compatible.
585
result = to_bzrdir.create_workingtree()
481
result = self._format.initialize(to_bzrdir)
586
482
self.copy_content_into(result, revision_id)
590
486
def copy_content_into(self, tree, revision_id=None):
591
487
"""Copy the current content and user files of this tree into tree."""
592
tree.set_root_id(self.get_root_id())
593
488
if revision_id is None:
594
merge.transform_tree(tree, self)
489
transform_tree(tree, self)
596
# TODO now merge from tree.last_revision to revision (to preserve
597
# user local changes)
598
merge.transform_tree(tree, self)
599
tree.set_parent_ids([revision_id])
491
# TODO now merge from tree.last_revision to revision
492
transform_tree(tree, self)
493
tree.set_last_revision(revision_id)
496
def commit(self, message=None, revprops=None, *args, **kwargs):
497
# avoid circular imports
498
from bzrlib.commit import Commit
501
if not 'branch-nick' in revprops:
502
revprops['branch-nick'] = self.branch.nick
503
# args for wt.commit start at message from the Commit.commit method,
504
# but with branch a kwarg now, passing in args as is results in the
505
#message being used for the branch
506
args = (DEPRECATED_PARAMETER, message, ) + args
507
Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
508
self._set_inventory(self.read_working_inventory())
601
510
def id2abspath(self, file_id):
602
511
return self.abspath(self.id2path(file_id))
604
513
def has_id(self, file_id):
605
514
# files that have been deleted are excluded
515
inv = self._inventory
607
516
if not inv.has_id(file_id):
609
518
path = inv.id2path(file_id)
610
return osutils.lexists(self.abspath(path))
519
return bzrlib.osutils.lexists(self.abspath(path))
612
521
def has_or_had_id(self, file_id):
613
522
if file_id == self.inventory.root.file_id:
617
526
__contains__ = has_id
619
528
def get_file_size(self, file_id):
620
"""See Tree.get_file_size"""
621
# XXX: this returns the on-disk size; it should probably return the
624
return os.path.getsize(self.id2abspath(file_id))
626
if e.errno != errno.ENOENT:
529
return os.path.getsize(self.id2abspath(file_id))
632
def get_file_sha1(self, file_id, path=None, stat_value=None):
532
def get_file_sha1(self, file_id, path=None):
634
534
path = self._inventory.id2path(file_id)
635
return self._hashcache.get_sha1(path, stat_value)
637
def get_file_mtime(self, file_id, path=None):
639
path = self.inventory.id2path(file_id)
640
return os.lstat(self.abspath(path)).st_mtime
642
def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
file_id = self.path2id(path)
645
# For unversioned files on win32, we just assume they are not
648
return self._inventory[file_id].executable
650
def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
651
mode = stat_result.st_mode
652
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
535
return self._hashcache.get_sha1(path)
654
537
if not supports_executable():
655
538
def is_executable(self, file_id, path=None):
656
539
return self._inventory[file_id].executable
658
_is_executable_from_path_and_stat = \
659
_is_executable_from_path_and_stat_from_basis
661
541
def is_executable(self, file_id, path=None):
663
path = self.id2path(file_id)
543
path = self._inventory.id2path(file_id)
664
544
mode = os.lstat(self.abspath(path)).st_mode
665
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
667
_is_executable_from_path_and_stat = \
668
_is_executable_from_path_and_stat_from_stat
670
@needs_tree_write_lock
671
def _add(self, files, ids, kinds):
672
"""See MutableTree._add."""
545
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
548
def add(self, files, ids=None):
549
"""Make files versioned.
551
Note that the command line normally calls smart_add instead,
552
which can automatically recurse.
554
This adds the files to the inventory, so that they will be
555
recorded by the next commit.
558
List of paths to add, relative to the base of the tree.
561
If set, use these instead of automatically generated ids.
562
Must be the same length as the list of files, but may
563
contain None for ids that are to be autogenerated.
565
TODO: Perhaps have an option to add the ids even if the files do
568
TODO: Perhaps callback with the ids and paths as they're added.
673
570
# TODO: Re-adding a file that is removed in the working copy
674
571
# should probably put it back with the previous ID.
675
# the read and write working inventory should not occur in this
676
# function - they should be part of lock_write and unlock.
678
for f, file_id, kind in zip(files, ids, kinds):
572
if isinstance(files, basestring):
573
assert(ids is None or isinstance(ids, basestring))
579
ids = [None] * len(files)
581
assert(len(ids) == len(files))
583
inv = self.read_working_inventory()
584
for f,file_id in zip(files, ids):
585
if self.is_control_filename(f):
586
raise BzrError("cannot add control file %s" % quotefn(f))
591
raise BzrError("cannot add top-level %r" % f)
593
fullpath = normpath(self.abspath(f))
596
kind = file_kind(fullpath)
598
if e.errno == errno.ENOENT:
599
raise NoSuchFile(fullpath)
600
# maybe something better?
601
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
603
if not InventoryEntry.versionable_kind(kind):
604
raise BzrError('cannot add: not a versionable file ('
605
'i.e. regular file, symlink or directory): %s' % quotefn(f))
679
607
if file_id is None:
680
608
inv.add_path(f, kind=kind)
682
610
inv.add_path(f, kind=kind, file_id=file_id)
683
self._inventory_is_modified = True
685
@needs_tree_write_lock
686
def _gather_kinds(self, files, kinds):
687
"""See MutableTree._gather_kinds."""
688
for pos, f in enumerate(files):
689
if kinds[pos] is None:
690
fullpath = normpath(self.abspath(f))
692
kinds[pos] = file_kind(fullpath)
694
if e.errno == errno.ENOENT:
695
raise errors.NoSuchFile(fullpath)
612
self._write_inventory(inv)
697
614
@needs_write_lock
698
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
699
"""Add revision_id as a parent.
701
This is equivalent to retrieving the current list of parent ids
702
and setting the list to its value plus revision_id.
704
:param revision_id: The revision id to add to the parent list. It may
705
be a ghost revision as long as its not the first parent to be added,
706
or the allow_leftmost_as_ghost parameter is set True.
707
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
709
parents = self.get_parent_ids() + [revision_id]
710
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
711
or allow_leftmost_as_ghost)
713
@needs_tree_write_lock
714
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
715
"""Add revision_id, tree tuple as a parent.
717
This is equivalent to retrieving the current list of parent trees
718
and setting the list to its value plus parent_tuple. See also
719
add_parent_tree_id - if you only have a parent id available it will be
720
simpler to use that api. If you have the parent already available, using
721
this api is preferred.
723
:param parent_tuple: The (revision id, tree) to add to the parent list.
724
If the revision_id is a ghost, pass None for the tree.
725
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
727
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
728
if len(parent_ids) > 1:
729
# the leftmost may have already been a ghost, preserve that if it
731
allow_leftmost_as_ghost = True
732
self.set_parent_ids(parent_ids,
733
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
735
@needs_tree_write_lock
736
615
def add_pending_merge(self, *revision_ids):
737
616
# TODO: Perhaps should check at this point that the
738
617
# history of the revision is actually present?
739
parents = self.get_parent_ids()
618
p = self.pending_merges()
741
620
for rev_id in revision_ids:
742
if rev_id in parents:
744
parents.append(rev_id)
747
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
749
def path_content_summary(self, path, _lstat=os.lstat,
750
_mapper=osutils.file_kind_from_stat_mode):
751
"""See Tree.path_content_summary."""
752
abspath = self.abspath(path)
626
self.set_pending_merges(p)
629
def pending_merges(self):
630
"""Return a list of pending merges.
632
These are revisions that have been merged into the working
633
directory but not yet committed.
754
stat_result = _lstat(abspath)
636
merges_file = self._control_files.get_utf8('pending-merges')
755
637
except OSError, e:
756
if getattr(e, 'errno', None) == errno.ENOENT:
758
return ('missing', None, None, None)
759
# propagate other errors
761
kind = _mapper(stat_result.st_mode)
763
return self._file_content_summary(path, stat_result)
764
elif kind == 'directory':
765
# perhaps it looks like a plain directory, but it's really a
767
if self._directory_is_tree_reference(path):
768
kind = 'tree-reference'
769
return kind, None, None, None
770
elif kind == 'symlink':
771
target = osutils.readlink(abspath)
772
return ('symlink', None, None, target)
774
return (kind, None, None, None)
776
def _file_content_summary(self, path, stat_result):
777
size = stat_result.st_size
778
executable = self._is_executable_from_path_and_stat(path, stat_result)
779
# try for a stat cache lookup
780
return ('file', size, executable, self._sha_from_stat(
783
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
"""Common ghost checking functionality from set_parent_*.
786
This checks that the left hand-parent exists if there are any
789
if len(revision_ids) > 0:
790
leftmost_id = revision_ids[0]
791
if (not allow_leftmost_as_ghost and not
792
self.branch.repository.has_revision(leftmost_id)):
793
raise errors.GhostRevisionUnusableHere(leftmost_id)
795
def _set_merges_from_parent_ids(self, parent_ids):
796
merges = parent_ids[1:]
797
self._transport.put_bytes('pending-merges', '\n'.join(merges),
798
mode=self.bzrdir._get_file_mode())
800
def _filter_parent_ids_by_ancestry(self, revision_ids):
801
"""Check that all merged revisions are proper 'heads'.
803
This will always return the first revision_id, and any merged revisions
806
if len(revision_ids) == 0:
808
graph = self.branch.repository.get_graph()
809
heads = graph.heads(revision_ids)
810
new_revision_ids = revision_ids[:1]
811
for revision_id in revision_ids[1:]:
812
if revision_id in heads and revision_id not in new_revision_ids:
813
new_revision_ids.append(revision_id)
814
if new_revision_ids != revision_ids:
815
trace.mutter('requested to set revision_ids = %s,'
816
' but filtered to %s', revision_ids, new_revision_ids)
817
return new_revision_ids
819
@needs_tree_write_lock
820
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
"""Set the parent ids to revision_ids.
823
See also set_parent_trees. This api will try to retrieve the tree data
824
for each element of revision_ids from the trees repository. If you have
825
tree data already available, it is more efficient to use
826
set_parent_trees rather than set_parent_ids. set_parent_ids is however
827
an easier API to use.
829
:param revision_ids: The revision_ids to set as the parent ids of this
830
working tree. Any of these may be ghosts.
832
self._check_parents_for_ghosts(revision_ids,
833
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
for revision_id in revision_ids:
835
_mod_revision.check_not_reserved_id(revision_id)
837
revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
839
if len(revision_ids) > 0:
840
self.set_last_revision(revision_ids[0])
842
self.set_last_revision(_mod_revision.NULL_REVISION)
844
self._set_merges_from_parent_ids(revision_ids)
846
@needs_tree_write_lock
847
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
"""See MutableTree.set_parent_trees."""
849
parent_ids = [rev for (rev, tree) in parents_list]
850
for revision_id in parent_ids:
851
_mod_revision.check_not_reserved_id(revision_id)
853
self._check_parents_for_ghosts(parent_ids,
854
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
856
parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
858
if len(parent_ids) == 0:
859
leftmost_parent_id = _mod_revision.NULL_REVISION
860
leftmost_parent_tree = None
862
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
864
if self._change_last_revision(leftmost_parent_id):
865
if leftmost_parent_tree is None:
866
# If we don't have a tree, fall back to reading the
867
# parent tree from the repository.
868
self._cache_basis_inventory(leftmost_parent_id)
870
inv = leftmost_parent_tree.inventory
871
xml = self._create_basis_xml_from_inventory(
872
leftmost_parent_id, inv)
873
self._write_basis_inventory(xml)
874
self._set_merges_from_parent_ids(parent_ids)
876
@needs_tree_write_lock
638
if e.errno != errno.ENOENT:
642
for l in merges_file.readlines():
643
p.append(l.rstrip('\n'))
877
647
def set_pending_merges(self, rev_list):
878
parents = self.get_parent_ids()
879
leftmost = parents[:1]
880
new_parents = leftmost + rev_list
881
self.set_parent_ids(new_parents)
648
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
883
@needs_tree_write_lock
884
651
def set_merge_modified(self, modified_hashes):
885
652
def iter_stanzas():
886
653
for file_id, hash in modified_hashes.iteritems():
887
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
654
yield Stanza(file_id=file_id, hash=hash)
888
655
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
890
def _sha_from_stat(self, path, stat_result):
891
"""Get a sha digest from the tree's stat cache.
893
The default implementation assumes no stat cache is present.
895
:param path: The path.
896
:param stat_result: The stat result being looked up.
900
658
def _put_rio(self, filename, stanzas, header):
901
self._must_be_locked()
902
659
my_file = rio_file(stanzas, header)
903
self._transport.put_file(filename, my_file,
904
mode=self.bzrdir._get_file_mode())
906
@needs_write_lock # because merge pulls data into the branch.
907
def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
merge_type=None, force=False):
909
"""Merge from a branch into this working tree.
911
:param branch: The branch to merge from.
912
:param to_revision: If non-None, the merge will merge to to_revision,
913
but not beyond it. to_revision does not need to be in the history
914
of the branch when it is supplied. If None, to_revision defaults to
915
branch.last_revision().
917
from bzrlib.merge import Merger, Merge3Merger
918
merger = Merger(self.branch, this_tree=self)
919
# check that there are no local alterations
920
if not force and self.has_changes():
921
raise errors.UncommittedChanges(self)
922
if to_revision is None:
923
to_revision = _mod_revision.ensure_null(branch.last_revision())
924
merger.other_rev_id = to_revision
925
if _mod_revision.is_null(merger.other_rev_id):
926
raise errors.NoCommits(branch)
927
self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
merger.other_basis = merger.other_rev_id
929
merger.other_tree = self.branch.repository.revision_tree(
931
merger.other_branch = branch
932
if from_revision is None:
935
merger.set_base_revision(from_revision, branch)
936
if merger.base_rev_id == merger.other_rev_id:
937
raise errors.PointlessMerge
938
merger.backup_files = False
939
if merge_type is None:
940
merger.merge_type = Merge3Merger
942
merger.merge_type = merge_type
943
merger.set_interesting_files(None)
944
merger.show_base = False
945
merger.reprocess = False
946
conflicts = merger.do_merge()
660
self._control_files.put(filename, my_file)
951
663
def merge_modified(self):
952
"""Return a dictionary of files modified by a merge.
954
The list is initialized by WorkingTree.set_merge_modified, which is
955
typically called after we make some automatic updates to the tree
958
This returns a map of file_id->sha1, containing only files which are
959
still in the working inventory and have that text hash.
962
hashfile = self._transport.get('merge-hashes')
963
except errors.NoSuchFile:
665
hashfile = self._control_files.get('merge-hashes')
968
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
raise errors.MergeModifiedFormatError()
970
except StopIteration:
971
raise errors.MergeModifiedFormatError()
972
for s in RioReader(hashfile):
973
# RioReader reads in Unicode, so convert file_ids back to utf8
974
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
975
if file_id not in self.inventory:
977
text_hash = s.get("hash")
978
if text_hash == self.get_file_sha1(file_id):
979
merge_hashes[file_id] = text_hash
985
def mkdir(self, path, file_id=None):
986
"""See MutableTree.mkdir()."""
988
file_id = generate_ids.gen_file_id(os.path.basename(path))
989
os.mkdir(self.abspath(path))
990
self.add(path, file_id, 'directory')
670
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
671
raise MergeModifiedFormatError()
672
except StopIteration:
673
raise MergeModifiedFormatError()
674
for s in RioReader(hashfile):
675
file_id = s.get("file_id")
676
if file_id not in self.inventory:
679
if hash == self.get_file_sha1(file_id):
680
merge_hashes[file_id] = hash
993
683
def get_symlink_target(self, file_id):
994
abspath = self.id2abspath(file_id)
995
target = osutils.readlink(abspath)
999
def subsume(self, other_tree):
1000
def add_children(inventory, entry):
1001
for child_entry in entry.children.values():
1002
inventory._byid[child_entry.file_id] = child_entry
1003
if child_entry.kind == 'directory':
1004
add_children(inventory, child_entry)
1005
if other_tree.get_root_id() == self.get_root_id():
1006
raise errors.BadSubsumeSource(self, other_tree,
1007
'Trees have the same root')
1009
other_tree_path = self.relpath(other_tree.basedir)
1010
except errors.PathNotChild:
1011
raise errors.BadSubsumeSource(self, other_tree,
1012
'Tree is not contained by the other')
1013
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1014
if new_root_parent is None:
1015
raise errors.BadSubsumeSource(self, other_tree,
1016
'Parent directory is not versioned.')
1017
# We need to ensure that the result of a fetch will have a
1018
# versionedfile for the other_tree root, and only fetching into
1019
# RepositoryKnit2 guarantees that.
1020
if not self.branch.repository.supports_rich_root():
1021
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1022
other_tree.lock_tree_write()
1024
new_parents = other_tree.get_parent_ids()
1025
other_root = other_tree.inventory.root
1026
other_root.parent_id = new_root_parent
1027
other_root.name = osutils.basename(other_tree_path)
1028
self.inventory.add(other_root)
1029
add_children(self.inventory, other_root)
1030
self._write_inventory(self.inventory)
1031
# normally we don't want to fetch whole repositories, but i think
1032
# here we really do want to consolidate the whole thing.
1033
for parent_id in other_tree.get_parent_ids():
1034
self.branch.fetch(other_tree.branch, parent_id)
1035
self.add_parent_tree_id(parent_id)
1038
other_tree.bzrdir.retire_bzrdir()
1040
def _setup_directory_is_tree_reference(self):
1041
if self._branch.repository._format.supports_tree_reference:
1042
self._directory_is_tree_reference = \
1043
self._directory_may_be_tree_reference
1045
self._directory_is_tree_reference = \
1046
self._directory_is_never_tree_reference
1048
def _directory_is_never_tree_reference(self, relpath):
1051
def _directory_may_be_tree_reference(self, relpath):
1052
# as a special case, if a directory contains control files then
1053
# it's a tree reference, except that the root of the tree is not
1054
return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
# TODO: We could ask all the control formats whether they
1056
# recognize this directory, but at the moment there's no cheap api
1057
# to do that. Since we probably can only nest bzr checkouts and
1058
# they always use this name it's ok for now. -- mbp 20060306
1060
# FIXME: There is an unhandled case here of a subdirectory
1061
# containing .bzr but not a branch; that will probably blow up
1062
# when you try to commit it. It might happen if there is a
1063
# checkout in a subdirectory. This can be avoided by not adding
1066
@needs_tree_write_lock
1067
def extract(self, file_id, format=None):
1068
"""Extract a subtree from this tree.
1070
A new branch will be created, relative to the path for this tree.
1074
segments = osutils.splitpath(path)
1075
transport = self.branch.bzrdir.root_transport
1076
for name in segments:
1077
transport = transport.clone(name)
1078
transport.ensure_base()
1081
sub_path = self.id2path(file_id)
1082
branch_transport = mkdirs(sub_path)
1084
format = self.bzrdir.cloning_metadir()
1085
branch_transport.ensure_base()
1086
branch_bzrdir = format.initialize_on_transport(branch_transport)
1088
repo = branch_bzrdir.find_repository()
1089
except errors.NoRepositoryPresent:
1090
repo = branch_bzrdir.create_repository()
1091
if not repo.supports_rich_root():
1092
raise errors.RootNotRich()
1093
new_branch = branch_bzrdir.create_branch()
1094
new_branch.pull(self.branch)
1095
for parent_id in self.get_parent_ids():
1096
new_branch.fetch(self.branch, parent_id)
1097
tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
if tree_transport.base != branch_transport.base:
1099
tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
target_branch=new_branch)
1103
tree_bzrdir = branch_bzrdir
1104
wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1105
wt.set_parent_ids(self.get_parent_ids())
1106
my_inv = self.inventory
1107
child_inv = inventory.Inventory(root_id=None)
1108
new_root = my_inv[file_id]
1109
my_inv.remove_recursive_id(file_id)
1110
new_root.parent_id = None
1111
child_inv.add(new_root)
1112
self._write_inventory(my_inv)
1113
wt._write_inventory(child_inv)
1116
def _serialize(self, inventory, out_file):
1117
xml5.serializer_v5.write_inventory(self._inventory, out_file,
1120
def _deserialize(selt, in_file):
1121
return xml5.serializer_v5.read_inventory(in_file)
1124
"""Write the in memory inventory to disk."""
1125
# TODO: Maybe this should only write on dirty ?
1126
if self._control_files._lock_mode != 'w':
1127
raise errors.NotWriteLocked(self)
1129
self._serialize(self._inventory, sio)
1131
self._transport.put_file('inventory', sio,
1132
mode=self.bzrdir._get_file_mode())
1133
self._inventory_is_modified = False
1135
def _kind(self, relpath):
1136
return osutils.file_kind(self.abspath(relpath))
1138
def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
"""List all files as (path, class, kind, id, entry).
684
return os.readlink(self.id2abspath(file_id))
686
def file_class(self, filename):
687
if self.path2id(filename):
689
elif self.is_ignored(filename):
694
def list_files(self):
695
"""Recursively list all files as (path, class, kind, id, entry).
1141
697
Lists, but does not descend into unversioned directories.
1142
699
This does not include files that have been deleted in this
1143
tree. Skips the control directory.
1145
:param include_root: if True, return an entry for the root
1146
:param from_dir: start from this directory or None for the root
1147
:param recursive: whether to recurse into subdirectories or not
702
Skips the control directory.
1149
# list_files is an iterator, so @needs_read_lock doesn't work properly
1150
# with it. So callers should be careful to always read_lock the tree.
1151
if not self.is_locked():
1152
raise errors.ObjectNotLocked(self)
1154
inv = self.inventory
1155
if from_dir is None and include_root is True:
1156
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
704
inv = self._inventory
1157
705
# Convert these into local objects to save lookup times
1158
pathjoin = osutils.pathjoin
1159
file_kind = self._kind
706
pathjoin = bzrlib.osutils.pathjoin
707
file_kind = bzrlib.osutils.file_kind
1161
709
# transport.base ends in a slash, we want the piece
1162
710
# between the last two slashes
1240
767
except KeyError:
1241
768
yield fp[1:], c, fk, None, TreeEntry()
1244
771
if fk != 'directory':
1247
# But do this child first if recursing down
1249
new_children = os.listdir(fap)
1251
new_children = collections.deque(new_children)
1252
stack.append((f_ie.file_id, fp, fap, new_children))
1253
# Break out of inner loop,
1254
# so that we start outer loop with child
774
# But do this child first
775
new_children = os.listdir(fap)
777
new_children = collections.deque(new_children)
778
stack.append((f_ie.file_id, fp, fap, new_children))
779
# Break out of inner loop, so that we start outer loop with child
1257
782
# if we finished all children, pop it off the stack
1260
@needs_tree_write_lock
1261
def move(self, from_paths, to_dir=None, after=False, **kwargs):
787
def move(self, from_paths, to_name):
1262
788
"""Rename files.
1264
to_dir must exist in the inventory.
1266
If to_dir exists and is a directory, the files are moved into
1267
it, keeping their old names.
1269
Note that to_dir is only the last component of the new name;
790
to_name must exist in the inventory.
792
If to_name exists and is a directory, the files are moved into
793
it, keeping their old names.
795
Note that to_name is only the last component of the new name;
1270
796
this doesn't change the directory.
1272
For each entry in from_paths the move mode will be determined
1275
The first mode moves the file in the filesystem and updates the
1276
inventory. The second mode only updates the inventory without
1277
touching the file on the filesystem. This is the new mode introduced
1280
move uses the second mode if 'after == True' and the target is not
1281
versioned but present in the working tree.
1283
move uses the second mode if 'after == False' and the source is
1284
versioned but no longer in the working tree, and the target is not
1285
versioned but present in the working tree.
1287
move uses the first mode if 'after == False' and the source is
1288
versioned and present in the working tree, and the target is not
1289
versioned and not present in the working tree.
1291
Everything else results in an error.
1293
798
This returns a list of (from_path, to_path) pairs for each
1294
799
entry that is moved.
1299
# check for deprecated use of signature
1301
to_dir = kwargs.get('to_name', None)
1303
raise TypeError('You must supply a target directory')
1305
symbol_versioning.warn('The parameter to_name was deprecated'
1306
' in version 0.13. Use to_dir instead',
1309
# check destination directory
1310
if isinstance(from_paths, basestring):
802
## TODO: Option to move IDs only
803
assert not isinstance(from_paths, basestring)
1312
804
inv = self.inventory
1313
to_abs = self.abspath(to_dir)
805
to_abs = self.abspath(to_name)
1314
806
if not isdir(to_abs):
1315
raise errors.BzrMoveFailedError('',to_dir,
1316
errors.NotADirectory(to_abs))
1317
if not self.has_filename(to_dir):
1318
raise errors.BzrMoveFailedError('',to_dir,
1319
errors.NotInWorkingDirectory(to_dir))
1320
to_dir_id = inv.path2id(to_dir)
1321
if to_dir_id is None:
1322
raise errors.BzrMoveFailedError('',to_dir,
1323
errors.NotVersionedError(path=str(to_dir)))
807
raise BzrError("destination %r is not a directory" % to_abs)
808
if not self.has_filename(to_name):
809
raise BzrError("destination %r not in working directory" % to_abs)
810
to_dir_id = inv.path2id(to_name)
811
if to_dir_id == None and to_name != '':
812
raise BzrError("destination %r is not a versioned directory" % to_name)
1325
813
to_dir_ie = inv[to_dir_id]
1326
if to_dir_ie.kind != 'directory':
1327
raise errors.BzrMoveFailedError('',to_dir,
1328
errors.NotADirectory(to_abs))
1330
# create rename entries and tuples
1331
for from_rel in from_paths:
1332
from_tail = splitpath(from_rel)[-1]
1333
from_id = inv.path2id(from_rel)
1335
raise errors.BzrMoveFailedError(from_rel,to_dir,
1336
errors.NotVersionedError(path=str(from_rel)))
1338
from_entry = inv[from_id]
1339
from_parent_id = from_entry.parent_id
1340
to_rel = pathjoin(to_dir, from_tail)
1341
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1343
from_tail=from_tail,
1344
from_parent_id=from_parent_id,
1345
to_rel=to_rel, to_tail=from_tail,
1346
to_parent_id=to_dir_id)
1347
rename_entries.append(rename_entry)
1348
rename_tuples.append((from_rel, to_rel))
1350
# determine which move mode to use. checks also for movability
1351
rename_entries = self._determine_mv_mode(rename_entries, after)
1353
original_modified = self._inventory_is_modified
814
if to_dir_ie.kind not in ('directory', 'root_directory'):
815
raise BzrError("destination %r is not a directory" % to_abs)
817
to_idpath = inv.get_idpath(to_dir_id)
820
if not self.has_filename(f):
821
raise BzrError("%r does not exist in working tree" % f)
822
f_id = inv.path2id(f)
824
raise BzrError("%r is not versioned" % f)
825
name_tail = splitpath(f)[-1]
826
dest_path = pathjoin(to_name, name_tail)
827
if self.has_filename(dest_path):
828
raise BzrError("destination %r already exists" % dest_path)
829
if f_id in to_idpath:
830
raise BzrError("can't move %r to a subdirectory of itself" % f)
832
# OK, so there's a race here, it's possible that someone will
833
# create a file in this interval and then the rename might be
834
# left half-done. But we should have caught most problems.
835
orig_inv = deepcopy(self.inventory)
1356
self._inventory_is_modified = True
1357
self._move(rename_entries)
838
name_tail = splitpath(f)[-1]
839
dest_path = pathjoin(to_name, name_tail)
840
result.append((f, dest_path))
841
inv.rename(inv.path2id(f), to_dir_id, name_tail)
843
rename(self.abspath(f), self.abspath(dest_path))
845
raise BzrError("failed to rename %r to %r: %s" %
846
(f, dest_path, e[1]),
847
["rename rolled back"])
1359
849
# restore the inventory on error
1360
self._inventory_is_modified = original_modified
850
self._set_inventory(orig_inv)
1362
852
self._write_inventory(inv)
1363
return rename_tuples
1365
def _determine_mv_mode(self, rename_entries, after=False):
1366
"""Determines for each from-to pair if both inventory and working tree
1367
or only the inventory has to be changed.
1369
Also does basic plausability tests.
1371
inv = self.inventory
1373
for rename_entry in rename_entries:
1374
# store to local variables for easier reference
1375
from_rel = rename_entry.from_rel
1376
from_id = rename_entry.from_id
1377
to_rel = rename_entry.to_rel
1378
to_id = inv.path2id(to_rel)
1379
only_change_inv = False
1381
# check the inventory for source and destination
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(from_rel)))
1385
if to_id is not None:
1386
raise errors.BzrMoveFailedError(from_rel,to_rel,
1387
errors.AlreadyVersionedError(path=str(to_rel)))
1389
# try to determine the mode for rename (only change inv or change
1390
# inv and file system)
1392
if not self.has_filename(to_rel):
1393
raise errors.BzrMoveFailedError(from_id,to_rel,
1394
errors.NoSuchFile(path=str(to_rel),
1395
extra="New file has not been created yet"))
1396
only_change_inv = True
1397
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1398
only_change_inv = True
1399
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
only_change_inv = False
1401
elif (not self.case_sensitive
1402
and from_rel.lower() == to_rel.lower()
1403
and self.has_filename(from_rel)):
1404
only_change_inv = False
1406
# something is wrong, so lets determine what exactly
1407
if not self.has_filename(from_rel) and \
1408
not self.has_filename(to_rel):
1409
raise errors.BzrRenameFailedError(from_rel,to_rel,
1410
errors.PathsDoNotExist(paths=(str(from_rel),
1413
raise errors.RenameFailedFilesExist(from_rel, to_rel)
1414
rename_entry.only_change_inv = only_change_inv
1415
return rename_entries
1417
def _move(self, rename_entries):
1418
"""Moves a list of files.
1420
Depending on the value of the flag 'only_change_inv', the
1421
file will be moved on the file system or not.
1423
inv = self.inventory
1426
for entry in rename_entries:
1428
self._move_entry(entry)
1430
self._rollback_move(moved)
1434
def _rollback_move(self, moved):
1435
"""Try to rollback a previous move in case of an filesystem error."""
1436
inv = self.inventory
1439
self._move_entry(WorkingTree._RenameEntry(
1440
entry.to_rel, entry.from_id,
1441
entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
entry.from_tail, entry.from_parent_id,
1443
entry.only_change_inv))
1444
except errors.BzrMoveFailedError, e:
1445
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1446
" The working tree is in an inconsistent state."
1447
" Please consider doing a 'bzr revert'."
1448
" Error message is: %s" % e)
1450
def _move_entry(self, entry):
1451
inv = self.inventory
1452
from_rel_abs = self.abspath(entry.from_rel)
1453
to_rel_abs = self.abspath(entry.to_rel)
1454
if from_rel_abs == to_rel_abs:
1455
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1456
"Source and target are identical.")
1458
if not entry.only_change_inv:
1460
osutils.rename(from_rel_abs, to_rel_abs)
1462
raise errors.BzrMoveFailedError(entry.from_rel,
1464
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1466
@needs_tree_write_lock
1467
def rename_one(self, from_rel, to_rel, after=False):
856
def rename_one(self, from_rel, to_rel):
1468
857
"""Rename one file.
1470
859
This can change the directory or the filename or both.
1472
rename_one has several 'modes' to work. First, it can rename a physical
1473
file and change the file_id. That is the normal mode. Second, it can
1474
only change the file_id without touching any physical file. This is
1475
the new mode introduced in version 0.15.
1477
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1478
versioned but present in the working tree.
1480
rename_one uses the second mode if 'after == False' and 'from_rel' is
1481
versioned but no longer in the working tree, and 'to_rel' is not
1482
versioned but present in the working tree.
1484
rename_one uses the first mode if 'after == False' and 'from_rel' is
1485
versioned and present in the working tree, and 'to_rel' is not
1486
versioned and not present in the working tree.
1488
Everything else results in an error.
1490
861
inv = self.inventory
1493
# create rename entries and tuples
1494
from_tail = splitpath(from_rel)[-1]
1495
from_id = inv.path2id(from_rel)
1497
# if file is missing in the inventory maybe it's in the basis_tree
1498
basis_tree = self.branch.basis_tree()
1499
from_id = basis_tree.path2id(from_rel)
1501
raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
errors.NotVersionedError(path=str(from_rel)))
1503
# put entry back in the inventory so we can rename it
1504
from_entry = basis_tree.inventory[from_id].copy()
1507
from_entry = inv[from_id]
1508
from_parent_id = from_entry.parent_id
862
if not self.has_filename(from_rel):
863
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
864
if self.has_filename(to_rel):
865
raise BzrError("can't rename: new working file %r already exists" % to_rel)
867
file_id = inv.path2id(from_rel)
869
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
872
from_parent = entry.parent_id
873
from_name = entry.name
875
if inv.path2id(to_rel):
876
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1509
878
to_dir, to_tail = os.path.split(to_rel)
1510
879
to_dir_id = inv.path2id(to_dir)
1511
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1513
from_tail=from_tail,
1514
from_parent_id=from_parent_id,
1515
to_rel=to_rel, to_tail=to_tail,
1516
to_parent_id=to_dir_id)
1517
rename_entries.append(rename_entry)
1519
# determine which move mode to use. checks also for movability
1520
rename_entries = self._determine_mv_mode(rename_entries, after)
1522
# check if the target changed directory and if the target directory is
1524
if to_dir_id is None:
1525
raise errors.BzrMoveFailedError(from_rel,to_rel,
1526
errors.NotVersionedError(path=str(to_dir)))
1528
# all checks done. now we can continue with our actual work
1529
mutter('rename_one:\n'
1534
' to_dir_id {%s}\n',
1535
from_id, from_rel, to_rel, to_dir, to_dir_id)
1537
self._move(rename_entries)
880
if to_dir_id == None and to_dir != '':
881
raise BzrError("can't determine destination directory id for %r" % to_dir)
883
mutter("rename_one:")
884
mutter(" file_id {%s}" % file_id)
885
mutter(" from_rel %r" % from_rel)
886
mutter(" to_rel %r" % to_rel)
887
mutter(" to_dir %r" % to_dir)
888
mutter(" to_dir_id {%s}" % to_dir_id)
890
inv.rename(file_id, to_dir_id, to_tail)
892
from_abs = self.abspath(from_rel)
893
to_abs = self.abspath(to_rel)
895
rename(from_abs, to_abs)
897
inv.rename(file_id, from_parent, from_name)
898
raise BzrError("failed to rename %r to %r: %s"
899
% (from_abs, to_abs, e[1]),
900
["rename rolled back"])
1538
901
self._write_inventory(inv)
1540
class _RenameEntry(object):
1541
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1542
to_rel, to_tail, to_parent_id, only_change_inv=False):
1543
self.from_rel = from_rel
1544
self.from_id = from_id
1545
self.from_tail = from_tail
1546
self.from_parent_id = from_parent_id
1547
self.to_rel = to_rel
1548
self.to_tail = to_tail
1549
self.to_parent_id = to_parent_id
1550
self.only_change_inv = only_change_inv
1552
903
@needs_read_lock
1553
904
def unknowns(self):
1554
905
"""Return all unknown files.
1556
907
These are files in the working directory that are not versioned or
1557
908
control files or ignored.
1559
# force the extras method to be fully executed before returning, to
1560
# prevent race conditions with the lock
1562
[subp for subp in self.extras() if not self.is_ignored(subp)])
1564
@needs_tree_write_lock
1565
def unversion(self, file_ids):
1566
"""Remove the file ids in file_ids from the current versioned set.
1568
When a file_id is unversioned, all of its children are automatically
1571
:param file_ids: The file ids to stop versioning.
1572
:raises: NoSuchId if any fileid is not currently versioned.
1574
for file_id in file_ids:
1575
if file_id not in self._inventory:
1576
raise errors.NoSuchId(self, file_id)
1577
for file_id in file_ids:
1578
if self._inventory.has_id(file_id):
1579
self._inventory.remove_recursive_id(file_id)
1581
# in the future this should just set a dirty bit to wait for the
1582
# final unlock. However, until all methods of workingtree start
1583
# with the current in -memory inventory rather than triggering
1584
# a read, it is more complex - we need to teach read_inventory
1585
# to know when to read, and when to not read first... and possibly
1586
# to save first when the in memory one may be corrupted.
1587
# so for now, we just only write it if it is indeed dirty.
1589
self._write_inventory(self._inventory)
910
>>> from bzrlib.bzrdir import ScratchDir
911
>>> d = ScratchDir(files=['foo', 'foo~'])
912
>>> b = d.open_branch()
913
>>> tree = d.open_workingtree()
914
>>> map(str, tree.unknowns())
917
>>> list(b.unknowns())
919
>>> tree.remove('foo')
920
>>> list(b.unknowns())
923
for subp in self.extras():
924
if not self.is_ignored(subp):
927
@deprecated_method(zero_eight)
928
def iter_conflicts(self):
929
"""List all files in the tree that have text or content conflicts.
930
DEPRECATED. Use conflicts instead."""
931
return self._iter_conflicts()
1591
933
def _iter_conflicts(self):
1592
934
conflicted = set()
1711
1070
Cached in the Tree object after the first call.
1713
ignoreset = getattr(self, '_ignoreset', None)
1714
if ignoreset is not None:
1072
if hasattr(self, '_ignorelist'):
1073
return self._ignorelist
1717
ignore_globs = set()
1718
ignore_globs.update(ignores.get_runtime_ignores())
1719
ignore_globs.update(ignores.get_user_ignores())
1075
l = bzrlib.DEFAULT_IGNORE[:]
1720
1076
if self.has_filename(bzrlib.IGNORE_FILENAME):
1721
1077
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1723
ignore_globs.update(ignores.parse_ignore_file(f))
1726
self._ignoreset = ignore_globs
1729
def _flush_ignore_list_cache(self):
1730
"""Resets the cached ignore list to force a cache rebuild."""
1731
self._ignoreset = None
1732
self._ignoreglobster = None
1078
l.extend([line.rstrip("\n\r") for line in f.readlines()])
1079
self._ignorelist = l
1080
self._ignore_regex = self._combine_ignore_rules(l)
1083
def _get_ignore_rules_as_regex(self):
1084
"""Return a regex of the ignore rules and a mapping dict.
1086
:return: (ignore rules compiled regex, dictionary mapping rule group
1087
indices to original rule.)
1089
if getattr(self, '_ignorelist', None) is None:
1090
self.get_ignore_list()
1091
return self._ignore_regex
1734
1093
def is_ignored(self, filename):
1735
1094
r"""Check whether the filename matches an ignore pattern.
1737
1096
Patterns containing '/' or '\' need to match the whole path;
1738
others match against only the last component. Patterns starting
1739
with '!' are ignore exceptions. Exceptions take precedence
1740
over regular patterns and cause the filename to not be ignored.
1097
others match against only the last component.
1742
1099
If the file is ignored, returns the pattern which caused it to
1743
1100
be ignored, otherwise None. So this can simply be used as a
1744
1101
boolean if desired."""
1745
if getattr(self, '_ignoreglobster', None) is None:
1746
self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1747
return self._ignoreglobster.match(filename)
1103
# TODO: Use '**' to match directories, and other extended
1104
# globbing stuff from cvs/rsync.
1106
# XXX: fnmatch is actually not quite what we want: it's only
1107
# approximately the same as real Unix fnmatch, and doesn't
1108
# treat dotfiles correctly and allows * to match /.
1109
# Eventually it should be replaced with something more
1112
rules = self._get_ignore_rules_as_regex()
1113
for regex, mapping in rules:
1114
match = regex.match(filename)
1115
if match is not None:
1116
# one or more of the groups in mapping will have a non-None group
1118
groups = match.groups()
1119
rules = [mapping[group] for group in
1120
mapping if groups[group] is not None]
1749
1124
def kind(self, file_id):
1750
1125
return file_kind(self.id2abspath(file_id))
1752
def stored_kind(self, file_id):
1753
"""See Tree.stored_kind"""
1754
return self.inventory[file_id].kind
1756
def _comparison_data(self, entry, path):
1757
abspath = self.abspath(path)
1759
stat_value = os.lstat(abspath)
1761
if getattr(e, 'errno', None) == errno.ENOENT:
1768
mode = stat_value.st_mode
1769
kind = osutils.file_kind_from_stat_mode(mode)
1770
if not supports_executable():
1771
executable = entry is not None and entry.executable
1773
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1774
return kind, executable, stat_value
1776
def _file_size(self, entry, stat_value):
1777
return stat_value.st_size
1779
1128
def last_revision(self):
1780
"""Return the last revision of the branch for this tree.
1782
This format tree does not support a separate marker for last-revision
1783
compared to the branch.
1785
See MutableTree.last_revision
1129
"""Return the last revision id of this working tree.
1131
In early branch formats this was == the branch last_revision,
1132
but that cannot be relied upon - for working tree operations,
1133
always use tree.last_revision().
1787
return self._last_revision()
1790
def _last_revision(self):
1791
"""helper for get_parent_ids."""
1792
return _mod_revision.ensure_null(self.branch.last_revision())
1135
return self.branch.last_revision()
1794
1137
def is_locked(self):
1795
1138
return self._control_files.is_locked()
1797
def _must_be_locked(self):
1798
if not self.is_locked():
1799
raise errors.ObjectNotLocked(self)
1801
1140
def lock_read(self):
1802
"""Lock the tree for reading.
1804
This also locks the branch, and can be unlocked via self.unlock().
1806
:return: A bzrlib.lock.LogicalLockResult.
1808
if not self.is_locked():
1810
self.branch.lock_read()
1812
self._control_files.lock_read()
1813
return LogicalLockResult(self.unlock)
1815
self.branch.unlock()
1818
def lock_tree_write(self):
1819
"""See MutableTree.lock_tree_write, and WorkingTree.unlock.
1821
:return: A bzrlib.lock.LogicalLockResult.
1823
if not self.is_locked():
1825
self.branch.lock_read()
1827
self._control_files.lock_write()
1828
return LogicalLockResult(self.unlock)
1141
"""See Branch.lock_read, and WorkingTree.unlock."""
1142
self.branch.lock_read()
1144
return self._control_files.lock_read()
1830
1146
self.branch.unlock()
1833
1149
def lock_write(self):
1834
"""See MutableTree.lock_write, and WorkingTree.unlock.
1836
:return: A bzrlib.lock.LogicalLockResult.
1838
if not self.is_locked():
1150
"""See Branch.lock_write, and WorkingTree.unlock."""
1840
1151
self.branch.lock_write()
1842
self._control_files.lock_write()
1843
return LogicalLockResult(self.unlock)
1153
return self._control_files.lock_write()
1845
1155
self.branch.unlock()
1870
1170
def _change_last_revision(self, new_revision):
1871
1171
"""Template method part of set_last_revision to perform the change.
1873
1173
This is used to allow WorkingTree3 instances to not affect branch
1874
1174
when their last revision is set.
1876
if _mod_revision.is_null(new_revision):
1176
if new_revision is None:
1877
1177
self.branch.set_revision_history([])
1179
# current format is locked in with the branch
1180
revision_history = self.branch.revision_history()
1880
self.branch.generate_revision_history(new_revision)
1881
except errors.NoSuchRevision:
1882
# not present in the repo - dont try to set it deeper than the tip
1883
self.branch.set_revision_history([new_revision])
1182
position = revision_history.index(new_revision)
1184
raise errors.NoSuchRevision(self.branch, new_revision)
1185
self.branch.set_revision_history(revision_history[:position + 1])
1886
def _write_basis_inventory(self, xml):
1887
"""Write the basis inventory XML to the basis-inventory file"""
1888
path = self._basis_inventory_name()
1890
self._transport.put_file(path, sio,
1891
mode=self.bzrdir._get_file_mode())
1893
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
"""Create the text that will be saved in basis-inventory"""
1895
inventory.revision_id = revision_id
1896
return xml7.serializer_v7.write_inventory_to_string(inventory)
1898
1188
def _cache_basis_inventory(self, new_revision):
1899
1189
"""Cache new_revision as the basis inventory."""
1900
# TODO: this should allow the ready-to-use inventory to be passed in,
1901
# as commit already has that ready-to-use [while the format is the
1904
# this double handles the inventory - unpack and repack -
1191
# this double handles the inventory - unpack and repack -
1905
1192
# but is easier to understand. We can/should put a conditional
1906
1193
# in here based on whether the inventory is in the latest format
1907
1194
# - perhaps we should repack all inventories on a repository
1909
# the fast path is to copy the raw xml from the repository. If the
1910
# xml contains 'revision_id="', then we assume the right
1911
# revision_id is set. We must check for this full string, because a
1912
# root node id can legitimately look like 'revision_id' but cannot
1914
xml = self.branch.repository._get_inventory_xml(new_revision)
1915
firstline = xml.split('\n', 1)[0]
1916
if (not 'revision_id="' in firstline or
1917
'format="7"' not in firstline):
1918
inv = self.branch.repository._serializer.read_inventory_from_string(
1920
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
self._write_basis_inventory(xml)
1922
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1196
inv = self.branch.repository.get_inventory(new_revision)
1197
inv.revision_id = new_revision
1198
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1200
path = self._basis_inventory_name()
1201
self._control_files.put_utf8(path, xml)
1202
except WeaveRevisionNotPresent:
1925
1205
def read_basis_inventory(self):
1926
1206
"""Read the cached basis inventory."""
1927
1207
path = self._basis_inventory_name()
1928
return self._transport.get_bytes(path)
1208
return self._control_files.get_utf8(path).read()
1930
1210
@needs_read_lock
1931
1211
def read_working_inventory(self):
1932
"""Read the working inventory.
1934
:raises errors.InventoryModified: read_working_inventory will fail
1935
when the current in memory inventory has been modified.
1937
# conceptually this should be an implementation detail of the tree.
1938
# XXX: Deprecate this.
1212
"""Read the working inventory."""
1939
1213
# ElementTree does its own conversion from UTF-8, so open in
1941
if self._inventory_is_modified:
1942
raise errors.InventoryModified(self)
1943
f = self._transport.get('inventory')
1945
result = self._deserialize(f)
1948
self._set_inventory(result, dirty=False)
1215
result = bzrlib.xml5.serializer_v5.read_inventory(
1216
self._control_files.get('inventory'))
1217
self._set_inventory(result)
1951
@needs_tree_write_lock
1952
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1954
"""Remove nominated files from the working inventory.
1956
:files: File paths relative to the basedir.
1957
:keep_files: If true, the files will also be kept.
1958
:force: Delete files and directories, even if they are changed and
1959
even if the directories are not empty.
1221
def remove(self, files, verbose=False):
1222
"""Remove nominated files from the working inventory..
1224
This does not remove their text. This does not run on XXX on what? RBC
1226
TODO: Refuse to remove modified files unless --force is given?
1228
TODO: Do something useful with directories.
1230
TODO: Should this remove the text or not? Tough call; not
1231
removing may be useful and the user can just use use rm, and
1232
is the opposite of add. Removing it is consistent with most
1233
other tools. Maybe an option.
1235
## TODO: Normalize names
1236
## TODO: Remove nested loops; better scalability
1961
1237
if isinstance(files, basestring):
1962
1238
files = [files]
1967
unknown_nested_files=set()
1969
to_file = sys.stdout
1971
def recurse_directory_to_add_files(directory):
1972
# Recurse directory and add all files
1973
# so we can check if they have changed.
1974
for parent_info, file_infos in self.walkdirs(directory):
1975
for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
# Is it versioned or ignored?
1977
if self.path2id(relpath) or self.is_ignored(relpath):
1978
# Add nested content for deletion.
1979
new_files.add(relpath)
1981
# Files which are not versioned and not ignored
1982
# should be treated as unknown.
1983
unknown_nested_files.add((relpath, None, kind))
1985
for filename in files:
1986
# Get file name into canonical form.
1987
abspath = self.abspath(filename)
1988
filename = self.relpath(abspath)
1989
if len(filename) > 0:
1990
new_files.add(filename)
1991
recurse_directory_to_add_files(filename)
1993
files = list(new_files)
1996
return # nothing to do
1998
# Sort needed to first handle directory content before the directory
1999
files.sort(reverse=True)
2001
# Bail out if we are going to delete files we shouldn't
2002
if not keep_files and not force:
2003
has_changed_files = len(unknown_nested_files) > 0
2004
if not has_changed_files:
2005
for (file_id, path, content_change, versioned, parent_id, name,
2006
kind, executable) in self.iter_changes(self.basis_tree(),
2007
include_unchanged=True, require_versioned=False,
2008
want_unversioned=True, specific_files=files):
2009
if versioned == (False, False):
2010
# The record is unknown ...
2011
if not self.is_ignored(path[1]):
2012
# ... but not ignored
2013
has_changed_files = True
2015
elif (content_change and (kind[1] is not None) and
2016
osutils.is_inside_any(files, path[1])):
2017
# Versioned and changed, but not deleted, and still
2018
# in one of the dirs to be deleted.
2019
has_changed_files = True
2022
if has_changed_files:
2023
# Make delta show ALL applicable changes in error message.
2024
tree_delta = self.changes_from(self.basis_tree(),
2025
require_versioned=False, want_unversioned=True,
2026
specific_files=files)
2027
for unknown_file in unknown_nested_files:
2028
if unknown_file not in tree_delta.unversioned:
2029
tree_delta.unversioned.extend((unknown_file,))
2030
raise errors.BzrRemoveChangedFilesError(tree_delta)
2032
# Build inv_delta and delete files where applicable,
2033
# do this before any modifications to inventory.
1240
inv = self.inventory
1242
# do this before any modifications
2034
1243
for f in files:
2035
fid = self.path2id(f)
1244
fid = inv.path2id(f)
2038
message = "%s is not versioned." % (f,)
2041
# having removed it, it must be either ignored or unknown
2042
if self.is_ignored(f):
2046
# XXX: Really should be a more abstract reporter interface
2047
kind_ch = osutils.kind_marker(self.kind(fid))
2048
to_file.write(new_status + ' ' + f + kind_ch + '\n')
2050
inv_delta.append((f, None, fid, None))
2051
message = "removed %s" % (f,)
2054
abs_path = self.abspath(f)
2055
if osutils.lexists(abs_path):
2056
if (osutils.isdir(abs_path) and
2057
len(os.listdir(abs_path)) > 0):
2059
osutils.rmtree(abs_path)
2061
message = "%s is not an empty directory "\
2062
"and won't be deleted." % (f,)
2064
osutils.delete_any(abs_path)
2065
message = "deleted %s" % (f,)
2066
elif message is not None:
2067
# Only care if we haven't done anything yet.
2068
message = "%s does not exist." % (f,)
2070
# Print only one message (if any) per file.
2071
if message is not None:
2073
self.apply_inventory_delta(inv_delta)
2075
@needs_tree_write_lock
2076
def revert(self, filenames=None, old_tree=None, backups=True,
2077
pb=None, report_changes=False):
2078
from bzrlib.conflicts import resolve
2081
symbol_versioning.warn('Using [] to revert all files is deprecated'
2082
' as of bzr 0.91. Please use None (the default) instead.',
2083
DeprecationWarning, stacklevel=2)
1246
# TODO: Perhaps make this just a warning, and continue?
1247
# This tends to happen when
1248
raise NotVersionedError(path=f)
1249
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1251
# having remove it, it must be either ignored or unknown
1252
if self.is_ignored(f):
1256
show_status(new_status, inv[fid].kind, quotefn(f))
1259
self._write_inventory(inv)
1262
def revert(self, filenames, old_tree=None, backups=True,
1263
pb=DummyProgress()):
1264
from transform import revert
1265
from conflicts import resolve
2084
1266
if old_tree is None:
2085
basis_tree = self.basis_tree()
2086
basis_tree.lock_read()
2087
old_tree = basis_tree
1267
old_tree = self.basis_tree()
1268
conflicts = revert(self, old_tree, filenames, backups, pb)
1269
if not len(filenames):
1270
self.set_pending_merges([])
2091
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2093
if filenames is None and len(self.get_parent_ids()) > 1:
2095
last_revision = self.last_revision()
2096
if last_revision != _mod_revision.NULL_REVISION:
2097
if basis_tree is None:
2098
basis_tree = self.basis_tree()
2099
basis_tree.lock_read()
2100
parent_trees.append((last_revision, basis_tree))
2101
self.set_parent_trees(parent_trees)
2104
resolve(self, filenames, ignore_misses=True, recursive=True)
2106
if basis_tree is not None:
1273
resolve(self, filenames, ignore_misses=True)
2108
1274
return conflicts
2110
def revision_tree(self, revision_id):
2111
"""See Tree.revision_tree.
2113
WorkingTree can supply revision_trees for the basis revision only
2114
because there is only one cached inventory in the bzr directory.
2116
if revision_id == self.last_revision():
2118
xml = self.read_basis_inventory()
2119
except errors.NoSuchFile:
2123
inv = xml7.serializer_v7.read_inventory_from_string(xml)
2124
# dont use the repository revision_tree api because we want
2125
# to supply the inventory.
2126
if inv.revision_id == revision_id:
2127
return revisiontree.RevisionTree(self.branch.repository,
2129
except errors.BadInventoryFormat:
2131
# raise if there was no inventory, or if we read the wrong inventory.
2132
raise errors.NoSuchRevisionInTree(self, revision_id)
2134
1276
# XXX: This method should be deprecated in favour of taking in a proper
2135
1277
# new Inventory object.
2136
@needs_tree_write_lock
2137
1279
def set_inventory(self, new_inventory_list):
2138
1280
from bzrlib.inventory import (Inventory,
2139
1281
InventoryDirectory,
2142
1285
inv = Inventory(self.get_root_id())
2152
1295
elif kind == 'symlink':
2153
1296
inv.add(InventoryLink(file_id, name, parent))
2155
raise errors.BzrError("unknown kind %r" % kind)
1298
raise BzrError("unknown kind %r" % kind)
2156
1299
self._write_inventory(inv)
2158
@needs_tree_write_lock
2159
1302
def set_root_id(self, file_id):
2160
1303
"""Set the root id for this tree."""
2164
'WorkingTree.set_root_id with fileid=None')
2165
file_id = osutils.safe_file_id(file_id)
2166
self._set_root_id(file_id)
2168
def _set_root_id(self, file_id):
2169
"""Set the root id for this tree, in a format specific manner.
2171
:param file_id: The file id to assign to the root. It must not be
2172
present in the current inventory or an error will occur. It must
2173
not be None, but rather a valid file id.
2175
inv = self._inventory
1304
inv = self.read_working_inventory()
2176
1305
orig_root_id = inv.root.file_id
2177
# TODO: it might be nice to exit early if there was nothing
2178
# to do, saving us from trigger a sync on unlock.
2179
self._inventory_is_modified = True
2180
# we preserve the root inventory entry object, but
2181
# unlinkit from the byid index
2182
1306
del inv._byid[inv.root.file_id]
2183
1307
inv.root.file_id = file_id
2184
# and link it into the index with the new changed id.
2185
1308
inv._byid[inv.root.file_id] = inv.root
2186
# and finally update all children to reference the new id.
2187
# XXX: this should be safe to just look at the root.children
2188
# list, not the WHOLE INVENTORY.
2189
1309
for fid in inv:
2190
1310
entry = inv[fid]
2191
1311
if entry.parent_id == orig_root_id:
2192
1312
entry.parent_id = inv.root.file_id
1313
self._write_inventory(inv)
2194
1315
def unlock(self):
2195
1316
"""See Branch.unlock.
2197
1318
WorkingTree locking just uses the Branch locking facilities.
2198
1319
This is current because all working trees have an embedded branch
2199
1320
within them. IF in the future, we were to make branch data shareable
2200
between multiple working trees, i.e. via shared storage, then we
1321
between multiple working trees, i.e. via shared storage, then we
2201
1322
would probably want to lock both the local tree, and the branch.
2203
raise NotImplementedError(self.unlock)
2207
def update(self, change_reporter=None, possible_transports=None,
2208
revision=None, old_tip=_marker):
1324
# FIXME: We want to write out the hashcache only when the last lock on
1325
# this working copy is released. Peeking at the lock count is a bit
1326
# of a nasty hack; probably it's better to have a transaction object,
1327
# which can do some finalization when it's either successfully or
1328
# unsuccessfully completed. (Denys's original patch did that.)
1329
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1330
# wrongly. Hookinh into unllock on the control files object is fine though.
1332
# TODO: split this per format so there is no ugly if block
1333
if self._hashcache.needs_write and (
1334
# dedicated lock files
1335
self._control_files._lock_count==1 or
1337
(self._control_files is self.branch.control_files and
1338
self._control_files._lock_count==3)):
1339
self._hashcache.write()
1340
# reverse order of locking.
1342
return self._control_files.unlock()
1344
self.branch.unlock()
2209
1348
"""Update a working tree along its branch.
2211
This will update the branch if its bound too, which means we have
2212
multiple trees involved:
2214
- The new basis tree of the master.
2215
- The old basis tree of the branch.
2216
- The old basis tree of the working tree.
2217
- The current working tree state.
2219
Pathologically, all three may be different, and non-ancestors of each
2220
other. Conceptually we want to:
2222
- Preserve the wt.basis->wt.state changes
2223
- Transform the wt.basis to the new master basis.
2224
- Apply a merge of the old branch basis to get any 'local' changes from
2226
- Restore the wt.basis->wt.state changes.
1350
This will update the branch if its bound too, which means we have multiple trees involved:
1351
The new basis tree of the master.
1352
The old basis tree of the branch.
1353
The old basis tree of the working tree.
1354
The current working tree state.
1355
pathologically all three may be different, and non ancestors of each other.
1356
Conceptually we want to:
1357
Preserve the wt.basis->wt.state changes
1358
Transform the wt.basis to the new master basis.
1359
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1360
Restore the wt.basis->wt.state changes.
2228
1362
There isn't a single operation at the moment to do that, so we:
2229
- Merge current state -> basis tree of the master w.r.t. the old tree
2231
- Do a 'normal' merge of the old branch basis if it is relevant.
2233
:param revision: The target revision to update to. Must be in the
2235
:param old_tip: If branch.update() has already been run, the value it
2236
returned (old tip of the branch or None). _marker is used
1363
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1364
Do a 'normal' merge of the old branch basis if it is relevant.
2239
if self.branch.get_bound_location() is not None:
2241
update_branch = (old_tip is self._marker)
2243
self.lock_tree_write()
2244
update_branch = False
1366
old_tip = self.branch.update()
1367
if old_tip is not None:
1368
self.add_pending_merge(old_tip)
1369
self.branch.lock_read()
2247
old_tip = self.branch.update(possible_transports)
2249
if old_tip is self._marker:
2251
return self._update_tree(old_tip, change_reporter, revision)
1372
if self.last_revision() != self.branch.last_revision():
1373
# merge tree state up to new branch tip.
1374
basis = self.basis_tree()
1375
to_tree = self.branch.basis_tree()
1376
result += merge_inner(self.branch,
1380
self.set_last_revision(self.branch.last_revision())
1381
if old_tip and old_tip != self.last_revision():
1382
# our last revision was not the prior branch last reivison
1383
# and we have converted that last revision to a pending merge.
1384
# base is somewhere between the branch tip now
1385
# and the now pending merge
1386
from bzrlib.revision import common_ancestor
1388
base_rev_id = common_ancestor(self.branch.last_revision(),
1390
self.branch.repository)
1391
except errors.NoCommonAncestor:
1393
base_tree = self.branch.repository.revision_tree(base_rev_id)
1394
other_tree = self.branch.repository.revision_tree(old_tip)
1395
result += merge_inner(self.branch,
2255
@needs_tree_write_lock
2256
def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
2257
"""Update a tree to the master branch.
2259
:param old_tip: if supplied, the previous tip revision the branch,
2260
before it was changed to the master branch's tip.
2262
# here if old_tip is not None, it is the old tip of the branch before
2263
# it was updated from the master branch. This should become a pending
2264
# merge in the working tree to preserve the user existing work. we
2265
# cant set that until we update the working trees last revision to be
2266
# one from the new branch, because it will just get absorbed by the
2267
# parent de-duplication logic.
2269
# We MUST save it even if an error occurs, because otherwise the users
2270
# local work is unreferenced and will appear to have been lost.
2274
last_rev = self.get_parent_ids()[0]
2276
last_rev = _mod_revision.NULL_REVISION
2277
if revision is None:
2278
revision = self.branch.last_revision()
2280
old_tip = old_tip or _mod_revision.NULL_REVISION
2282
if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
# the branch we are bound to was updated
2284
# merge those changes in first
2285
base_tree = self.basis_tree()
2286
other_tree = self.branch.repository.revision_tree(old_tip)
2287
nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
base_tree, this_tree=self,
2289
change_reporter=change_reporter)
2291
self.add_parent_tree((old_tip, other_tree))
2292
trace.note('Rerun update after fixing the conflicts.')
2295
if last_rev != _mod_revision.ensure_null(revision):
2296
# the working tree is up to date with the branch
2297
# we can merge the specified revision from master
2298
to_tree = self.branch.repository.revision_tree(revision)
2299
to_root_id = to_tree.get_root_id()
2301
basis = self.basis_tree()
2304
if (basis.inventory.root is None
2305
or basis.inventory.root.file_id != to_root_id):
2306
self.set_root_id(to_root_id)
2311
# determine the branch point
2312
graph = self.branch.repository.get_graph()
2313
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
change_reporter=change_reporter)
2320
self.set_last_revision(revision)
2321
# TODO - dedup parents list with things merged by pull ?
2322
# reuse the tree we've updated to to set the basis:
2323
parent_trees = [(revision, to_tree)]
2324
merges = self.get_parent_ids()[1:]
2325
# Ideally we ask the tree for the trees here, that way the working
2326
# tree can decide whether to give us the entire tree or give us a
2327
# lazy initialised tree. dirstate for instance will have the trees
2328
# in ram already, whereas a last-revision + basis-inventory tree
2329
# will not, but also does not need them when setting parents.
2330
for parent in merges:
2331
parent_trees.append(
2332
(parent, self.branch.repository.revision_tree(parent)))
2333
if not _mod_revision.is_null(old_tip):
2334
parent_trees.append(
2335
(old_tip, self.branch.repository.revision_tree(old_tip)))
2336
self.set_parent_trees(parent_trees)
2337
last_rev = parent_trees[0][0]
2340
def _write_hashcache_if_dirty(self):
2341
"""Write out the hashcache if it is dirty."""
2342
if self._hashcache.needs_write:
2344
self._hashcache.write()
2346
if e.errno not in (errno.EPERM, errno.EACCES):
2348
# TODO: jam 20061219 Should this be a warning? A single line
2349
# warning might be sufficient to let the user know what
2351
mutter('Could not write hashcache for %s\nError: %s',
2352
self._hashcache.cache_file_name(), e)
2354
@needs_tree_write_lock
1401
self.branch.unlock()
2355
1404
def _write_inventory(self, inv):
2356
1405
"""Write inventory as the current inventory."""
2357
self._set_inventory(inv, dirty=True)
1407
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1409
self._control_files.put('inventory', sio)
1410
self._set_inventory(inv)
1411
mutter('wrote working inventory')
2360
1413
def set_conflicts(self, arg):
2361
raise errors.UnsupportedOperation(self.set_conflicts, self)
2363
def add_conflicts(self, arg):
2364
raise errors.UnsupportedOperation(self.add_conflicts, self)
1414
raise UnsupportedOperation(self.set_conflicts, self)
2366
1416
@needs_read_lock
2367
1417
def conflicts(self):
2368
conflicts = _mod_conflicts.ConflictList()
1418
conflicts = ConflictList()
2369
1419
for conflicted in self._iter_conflicts():
2372
1422
if file_kind(self.abspath(conflicted)) != "file":
2374
except errors.NoSuchFile:
1425
if e.errno == errno.ENOENT:
2376
1429
if text is True:
2377
1430
for suffix in ('.THIS', '.OTHER'):
2379
1432
kind = file_kind(self.abspath(conflicted+suffix))
1434
if e.errno == errno.ENOENT:
2382
except errors.NoSuchFile:
2386
1442
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2387
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1443
conflicts.append(Conflict.factory(ctype, path=conflicted,
2389
1444
file_id=self.path2id(conflicted)))
2390
1445
return conflicts
2392
def walkdirs(self, prefix=""):
2393
"""Walk the directories of this tree.
2395
returns a generator which yields items in the form:
2396
((curren_directory_path, fileid),
2397
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2400
This API returns a generator, which is only valid during the current
2401
tree transaction - within a single lock_read or lock_write duration.
2403
If the tree is not locked, it may cause an error to be raised,
2404
depending on the tree implementation.
2406
disk_top = self.abspath(prefix)
2407
if disk_top.endswith('/'):
2408
disk_top = disk_top[:-1]
2409
top_strip_len = len(disk_top) + 1
2410
inventory_iterator = self._walkdirs(prefix)
2411
disk_iterator = osutils.walkdirs(disk_top, prefix)
2413
current_disk = disk_iterator.next()
2414
disk_finished = False
2416
if not (e.errno == errno.ENOENT or
2417
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2420
disk_finished = True
2422
current_inv = inventory_iterator.next()
2423
inv_finished = False
2424
except StopIteration:
2427
while not inv_finished or not disk_finished:
2429
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2430
cur_disk_dir_content) = current_disk
2432
((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2433
cur_disk_dir_content) = ((None, None), None)
2434
if not disk_finished:
2435
# strip out .bzr dirs
2436
if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2437
len(cur_disk_dir_content) > 0):
2438
# osutils.walkdirs can be made nicer -
2439
# yield the path-from-prefix rather than the pathjoined
2441
bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
if (bzrdir_loc < len(cur_disk_dir_content)
2444
and self.bzrdir.is_control_filename(
2445
cur_disk_dir_content[bzrdir_loc][0])):
2446
# we dont yield the contents of, or, .bzr itself.
2447
del cur_disk_dir_content[bzrdir_loc]
2449
# everything is unknown
2452
# everything is missing
2455
direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2457
# disk is before inventory - unknown
2458
dirblock = [(relpath, basename, kind, stat, None, None) for
2459
relpath, basename, kind, stat, top_path in
2460
cur_disk_dir_content]
2461
yield (cur_disk_dir_relpath, None), dirblock
2463
current_disk = disk_iterator.next()
2464
except StopIteration:
2465
disk_finished = True
2467
# inventory is before disk - missing.
2468
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
for relpath, basename, dkind, stat, fileid, kind in
2471
yield (current_inv[0][0], current_inv[0][1]), dirblock
2473
current_inv = inventory_iterator.next()
2474
except StopIteration:
2477
# versioned present directory
2478
# merge the inventory and disk data together
2480
for relpath, subiterator in itertools.groupby(sorted(
2481
current_inv[1] + cur_disk_dir_content,
2482
key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
path_elements = list(subiterator)
2484
if len(path_elements) == 2:
2485
inv_row, disk_row = path_elements
2486
# versioned, present file
2487
dirblock.append((inv_row[0],
2488
inv_row[1], disk_row[2],
2489
disk_row[3], inv_row[4],
2491
elif len(path_elements[0]) == 5:
2493
dirblock.append((path_elements[0][0],
2494
path_elements[0][1], path_elements[0][2],
2495
path_elements[0][3], None, None))
2496
elif len(path_elements[0]) == 6:
2497
# versioned, absent file.
2498
dirblock.append((path_elements[0][0],
2499
path_elements[0][1], 'unknown', None,
2500
path_elements[0][4], path_elements[0][5]))
2502
raise NotImplementedError('unreachable code')
2503
yield current_inv[0], dirblock
2505
current_inv = inventory_iterator.next()
2506
except StopIteration:
2509
current_disk = disk_iterator.next()
2510
except StopIteration:
2511
disk_finished = True
2513
def _walkdirs(self, prefix=""):
2514
"""Walk the directories of this tree.
2516
:prefix: is used as the directrory to start with.
2517
returns a generator which yields items in the form:
2518
((curren_directory_path, fileid),
2519
[(file1_path, file1_name, file1_kind, None, file1_id,
2522
_directory = 'directory'
2523
# get the root in the inventory
2524
inv = self.inventory
2525
top_id = inv.path2id(prefix)
2529
pending = [(prefix, '', _directory, None, top_id, None)]
2532
currentdir = pending.pop()
2533
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2534
top_id = currentdir[4]
2536
relroot = currentdir[0] + '/'
2539
# FIXME: stash the node in pending
2541
if entry.kind == 'directory':
2542
for name, child in entry.sorted_children():
2543
dirblock.append((relroot + name, name, child.kind, None,
2544
child.file_id, child.kind
2546
yield (currentdir[0], entry.file_id), dirblock
2547
# push the user specified dirs from dirblock
2548
for dir in reversed(dirblock):
2549
if dir[2] == _directory:
2552
@needs_tree_write_lock
2553
def auto_resolve(self):
2554
"""Automatically resolve text conflicts according to contents.
2556
Only text conflicts are auto_resolvable. Files with no conflict markers
2557
are considered 'resolved', because bzr always puts conflict markers
2558
into files that have text conflicts. The corresponding .THIS .BASE and
2559
.OTHER files are deleted, as per 'resolve'.
2560
:return: a tuple of ConflictLists: (un_resolved, resolved).
2562
un_resolved = _mod_conflicts.ConflictList()
2563
resolved = _mod_conflicts.ConflictList()
2564
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2565
for conflict in self.conflicts():
2566
if (conflict.typestring != 'text conflict' or
2567
self.kind(conflict.file_id) != 'file'):
2568
un_resolved.append(conflict)
2570
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2572
for line in my_file:
2573
if conflict_re.search(line):
2574
un_resolved.append(conflict)
2577
resolved.append(conflict)
2580
resolved.remove_files(self)
2581
self.set_conflicts(un_resolved)
2582
return un_resolved, resolved
2585
def _check(self, references):
2586
"""Check the tree for consistency.
2588
:param references: A dict with keys matching the items returned by
2589
self._get_check_refs(), and values from looking those keys up in
2592
tree_basis = self.basis_tree()
2593
tree_basis.lock_read()
2595
repo_basis = references[('trees', self.last_revision())]
2596
if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
raise errors.BzrCheckError(
2598
"Mismatched basis inventory content.")
2603
def _validate(self):
2604
"""Validate internal structures.
2606
This is meant mostly for the test suite. To give it a chance to detect
2607
corruption after actions have occurred. The default implementation is a
2610
:return: None. An exception should be raised if there is an error.
2614
def _get_rules_searcher(self, default_searcher):
2615
"""See Tree._get_rules_searcher."""
2616
if self._rules_searcher is None:
2617
self._rules_searcher = super(WorkingTree,
2618
self)._get_rules_searcher(default_searcher)
2619
return self._rules_searcher
2621
def get_shelf_manager(self):
2622
"""Return the ShelfManager for this WorkingTree."""
2623
from bzrlib.shelf import ShelfManager
2624
return ShelfManager(self, self._transport)
2627
class WorkingTree2(WorkingTree):
2628
"""This is the Format 2 working tree.
2630
This was the first weave based working tree.
2631
- uses os locks for locking.
2632
- uses the branch last-revision.
2635
def __init__(self, *args, **kwargs):
2636
super(WorkingTree2, self).__init__(*args, **kwargs)
2637
# WorkingTree2 has more of a constraint that self._inventory must
2638
# exist. Because this is an older format, we don't mind the overhead
2639
# caused by the extra computation here.
2641
# Newer WorkingTree's should only have self._inventory set when they
2643
if self._inventory is None:
2644
self.read_working_inventory()
2646
def _get_check_refs(self):
2647
"""Return the references needed to perform a check of this tree."""
2648
return [('trees', self.last_revision())]
2650
def lock_tree_write(self):
2651
"""See WorkingTree.lock_tree_write().
2653
In Format2 WorkingTrees we have a single lock for the branch and tree
2654
so lock_tree_write() degrades to lock_write().
2656
:return: An object with an unlock method which will release the lock
2659
self.branch.lock_write()
2661
self._control_files.lock_write()
2664
self.branch.unlock()
2668
# do non-implementation specific cleanup
2671
# we share control files:
2672
if self._control_files._lock_count == 3:
2673
# _inventory_is_modified is always False during a read lock.
2674
if self._inventory_is_modified:
2676
self._write_hashcache_if_dirty()
2678
# reverse order of locking.
2680
return self._control_files.unlock()
2682
self.branch.unlock()
2685
1448
class WorkingTree3(WorkingTree):
2686
1449
"""This is the Format 3 working tree.
added
removed
bzrlib/workingtree.py
