65
83
MergeModifiedFormatError,
66
84
UnsupportedOperation,
68
from bzrlib.inventory import InventoryEntry, Inventory
86
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
69
87
from bzrlib.lockable_files import LockableFiles, TransportLock
70
88
from bzrlib.lockdir import LockDir
71
from bzrlib.merge import merge_inner, transform_tree
89
import bzrlib.mutabletree
90
from bzrlib.mutabletree import needs_tree_write_lock
72
91
from bzrlib.osutils import (
103
from bzrlib.trace import mutter, note
104
from bzrlib.transport.local import LocalTransport
90
105
from bzrlib.progress import DummyProgress, ProgressPhase
91
from bzrlib.revision import NULL_REVISION
106
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
92
107
from bzrlib.rio import RioReader, rio_file, Stanza
93
from bzrlib.symbol_versioning import *
94
from bzrlib.textui import show_status
96
from bzrlib.transform import build_tree
97
from bzrlib.trace import mutter, note
98
from bzrlib.transport import get_transport
99
from bzrlib.transport.local import LocalTransport
108
from bzrlib.symbol_versioning import (deprecated_passed,
111
DEPRECATED_PARAMETER,
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
@deprecated_function(zero_thirteen)
104
123
def gen_file_id(name):
105
"""Return new file id.
107
This should probably generate proper UUIDs, but for the moment we
108
cope with just randomness because running uuidgen every time is
111
from binascii import hexlify
112
from time import time
115
idx = name.rfind('/')
117
name = name[idx+1 : ]
118
idx = name.rfind('\\')
120
name = name[idx+1 : ]
122
# make it not a hidden file
123
name = name.lstrip('.')
125
# remove any wierd characters; we don't escape them but rather
127
name = re.sub(r'[^\w.]', '', name)
129
s = hexlify(rand_bytes(8))
130
return '-'.join((name, compact_date(time()), s))
124
"""Return new file id for the basename 'name'.
126
Use bzrlib.generate_ids.gen_file_id() instead
128
return generate_ids.gen_file_id(name)
131
@deprecated_function(zero_thirteen)
133
132
def gen_root_id():
134
"""Return a new tree-root file id."""
135
return gen_file_id('TREE_ROOT')
133
"""Return a new tree-root file id.
135
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
137
return generate_ids.gen_root_id()
138
140
class TreeEntry(object):
139
"""An entry that implements the minium interface used by commands.
141
"""An entry that implements the minimum interface used by commands.
141
143
This needs further inspection, it may be better to have
142
144
InventoryEntries without ids - though that seems wrong. For now,
267
264
# if needed, or, when the cache sees a change, append it to the hash
268
265
# cache file, and have the parser take the most recent entry for a
269
266
# given path only.
270
cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
271
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
267
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
268
self._hashcache = hashcache.HashCache(basedir, cache_filename,
269
self._control_files._file_mode)
273
272
# is this scan needed ? it makes things kinda slow.
276
275
if hc.needs_write:
277
276
mutter("write hc")
280
279
if _inventory is None:
281
self._set_inventory(self.read_working_inventory())
280
self._inventory_is_modified = False
281
self.read_working_inventory()
283
self._set_inventory(_inventory)
285
def _set_inventory(self, inv):
283
# the caller of __init__ has provided an inventory,
284
# we assume they know what they are doing - as its only
285
# the Format factory and creation methods that are
286
# permitted to do this.
287
self._set_inventory(_inventory, dirty=False)
290
fget=lambda self: self._branch,
291
doc="""The branch this WorkingTree is connected to.
293
This cannot be set - it is reflective of the actual disk structure
294
the working tree has been constructed from.
297
def break_lock(self):
298
"""Break a lock if one is present from another instance.
300
Uses the ui factory to ask for confirmation if the lock may be from
303
This will probe the repository for its lock as well.
305
self._control_files.break_lock()
306
self.branch.break_lock()
308
def _set_inventory(self, inv, dirty):
309
"""Set the internal cached inventory.
311
:param inv: The inventory to set.
312
:param dirty: A boolean indicating whether the inventory is the same
313
logical inventory as whats on disk. If True the inventory is not
314
the same and should be written to disk or data will be lost, if
315
False then the inventory is the same as that on disk and any
316
serialisation would be unneeded overhead.
318
assert inv.root is not None
286
319
self._inventory = inv
287
self.path2id = self._inventory.path2id
289
def is_control_filename(self, filename):
290
"""True if filename is the name of a control file in this tree.
292
This is true IF and ONLY IF the filename is part of the meta data
293
that bzr controls in this tree. I.E. a random .bzr directory placed
294
on disk will not be a control file for this tree.
297
self.bzrdir.transport.relpath(self.abspath(filename))
299
except errors.PathNotChild:
320
self._inventory_is_modified = dirty
303
323
def open(path=None, _unsupported=False):
405
444
return bzrdir.BzrDir.create_standalone_workingtree(directory)
407
def relpath(self, abs):
408
"""Return the local path portion from a given absolute path."""
409
return relpath(self.basedir, abs)
446
def relpath(self, path):
447
"""Return the local path portion from a given path.
449
The path may be absolute or relative. If its a relative path it is
450
interpreted relative to the python current working directory.
452
return osutils.relpath(self.basedir, path)
411
454
def has_filename(self, filename):
412
return bzrlib.osutils.lexists(self.abspath(filename))
455
return osutils.lexists(self.abspath(filename))
414
457
def get_file(self, file_id):
415
458
return self.get_file_byname(self.id2path(file_id))
460
def get_file_text(self, file_id):
461
return self.get_file(file_id).read()
417
463
def get_file_byname(self, filename):
418
464
return file(self.abspath(filename), 'rb')
466
def annotate_iter(self, file_id):
467
"""See Tree.annotate_iter
469
This implementation will use the basis tree implementation if possible.
470
Lines not in the basis are attributed to CURRENT_REVISION
472
If there are pending merges, lines added by those merges will be
473
incorrectly attributed to CURRENT_REVISION (but after committing, the
474
attribution will be correct).
476
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [file_id]).next()
478
changed_content, kind = changes[2], changes[6]
479
if not changed_content:
480
return basis.annotate_iter(file_id)
484
if kind[0] != 'file':
487
old_lines = list(basis.annotate_iter(file_id))
489
for tree in self.branch.repository.revision_trees(
490
self.get_parent_ids()[1:]):
491
if file_id not in tree:
493
old.append(list(tree.annotate_iter(file_id)))
494
return annotate.reannotate(old, self.get_file(file_id).readlines(),
497
def get_parent_ids(self):
498
"""See Tree.get_parent_ids.
500
This implementation reads the pending merges list and last_revision
501
value and uses that to decide what the parents list should be.
503
last_rev = self._last_revision()
509
merges_file = self._control_files.get_utf8('pending-merges')
513
for l in merges_file.readlines():
514
parents.append(l.rstrip('\n'))
420
518
def get_root_id(self):
421
519
"""Return the id of this trees root"""
422
inv = self.read_working_inventory()
423
return inv.root.file_id
520
return self._inventory.root.file_id
425
522
def _get_store_filename(self, file_id):
426
523
## XXX: badly named; this is not in the store at all
496
580
return os.path.getsize(self.id2abspath(file_id))
499
def get_file_sha1(self, file_id):
500
path = self._inventory.id2path(file_id)
501
return self._hashcache.get_sha1(path)
503
def is_executable(self, file_id):
504
if not supports_executable():
583
def get_file_sha1(self, file_id, path=None, stat_value=None):
585
path = self._inventory.id2path(file_id)
586
return self._hashcache.get_sha1(path, stat_value)
588
def get_file_mtime(self, file_id, path=None):
590
path = self._inventory.id2path(file_id)
591
return os.lstat(self.abspath(path)).st_mtime
593
if not supports_executable():
594
def is_executable(self, file_id, path=None):
505
595
return self._inventory[file_id].executable
507
path = self._inventory.id2path(file_id)
597
def is_executable(self, file_id, path=None):
599
path = self._inventory.id2path(file_id)
508
600
mode = os.lstat(self.abspath(path)).st_mode
509
return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
601
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
511
603
@needs_write_lock
512
def add(self, files, ids=None):
513
"""Make files versioned.
515
Note that the command line normally calls smart_add instead,
516
which can automatically recurse.
518
This adds the files to the inventory, so that they will be
519
recorded by the next commit.
522
List of paths to add, relative to the base of the tree.
525
If set, use these instead of automatically generated ids.
526
Must be the same length as the list of files, but may
527
contain None for ids that are to be autogenerated.
529
TODO: Perhaps have an option to add the ids even if the files do
532
TODO: Perhaps callback with the ids and paths as they're added.
604
def _add(self, files, ids, kinds):
605
"""See MutableTree._add."""
534
606
# TODO: Re-adding a file that is removed in the working copy
535
607
# should probably put it back with the previous ID.
536
if isinstance(files, basestring):
537
assert(ids is None or isinstance(ids, basestring))
543
ids = [None] * len(files)
545
assert(len(ids) == len(files))
608
# the read and write working inventory should not occur in this
609
# function - they should be part of lock_write and unlock.
547
610
inv = self.read_working_inventory()
548
for f,file_id in zip(files, ids):
549
if self.is_control_filename(f):
550
raise BzrError("cannot add control file %s" % quotefn(f))
555
raise BzrError("cannot add top-level %r" % f)
557
fullpath = normpath(self.abspath(f))
560
kind = file_kind(fullpath)
562
if e.errno == errno.ENOENT:
563
raise NoSuchFile(fullpath)
564
# maybe something better?
565
raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
567
if not InventoryEntry.versionable_kind(kind):
568
raise BzrError('cannot add: not a versionable file ('
569
'i.e. regular file, symlink or directory): %s' % quotefn(f))
611
for f, file_id, kind in zip(files, ids, kinds):
612
assert kind is not None
571
613
if file_id is None:
572
file_id = gen_file_id(f)
573
inv.add_path(f, kind=kind, file_id=file_id)
575
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
614
inv.add_path(f, kind=kind)
616
inv.add_path(f, kind=kind, file_id=file_id)
576
617
self._write_inventory(inv)
619
@needs_tree_write_lock
620
def _gather_kinds(self, files, kinds):
621
"""See MutableTree._gather_kinds."""
622
for pos, f in enumerate(files):
623
if kinds[pos] is None:
624
fullpath = normpath(self.abspath(f))
626
kinds[pos] = file_kind(fullpath)
628
if e.errno == errno.ENOENT:
629
raise NoSuchFile(fullpath)
578
631
@needs_write_lock
632
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
633
"""Add revision_id as a parent.
635
This is equivalent to retrieving the current list of parent ids
636
and setting the list to its value plus revision_id.
638
:param revision_id: The revision id to add to the parent list. It may
639
be a ghost revision as long as its not the first parent to be added,
640
or the allow_leftmost_as_ghost parameter is set True.
641
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
643
parents = self.get_parent_ids() + [revision_id]
644
self.set_parent_ids(parents,
645
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
647
@needs_tree_write_lock
648
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
649
"""Add revision_id, tree tuple as a parent.
651
This is equivalent to retrieving the current list of parent trees
652
and setting the list to its value plus parent_tuple. See also
653
add_parent_tree_id - if you only have a parent id available it will be
654
simpler to use that api. If you have the parent already available, using
655
this api is preferred.
657
:param parent_tuple: The (revision id, tree) to add to the parent list.
658
If the revision_id is a ghost, pass None for the tree.
659
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
661
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
662
if len(parent_ids) > 1:
663
# the leftmost may have already been a ghost, preserve that if it
665
allow_leftmost_as_ghost = True
666
self.set_parent_ids(parent_ids,
667
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
669
@needs_tree_write_lock
579
670
def add_pending_merge(self, *revision_ids):
580
671
# TODO: Perhaps should check at this point that the
581
672
# history of the revision is actually present?
582
p = self.pending_merges()
673
parents = self.get_parent_ids()
584
675
for rev_id in revision_ids:
676
if rev_id in parents:
678
parents.append(rev_id)
590
self.set_pending_merges(p)
681
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
683
@deprecated_method(zero_eleven)
593
685
def pending_merges(self):
594
686
"""Return a list of pending merges.
596
688
These are revisions that have been merged into the working
597
689
directory but not yet committed.
600
merges_file = self._control_files.get_utf8('pending-merges')
602
if e.errno != errno.ENOENT:
606
for l in merges_file.readlines():
607
p.append(l.rstrip('\n'))
691
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
692
instead - which is available on all tree objects.
694
return self.get_parent_ids()[1:]
696
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
697
"""Common ghost checking functionality from set_parent_*.
699
This checks that the left hand-parent exists if there are any
702
if len(revision_ids) > 0:
703
leftmost_id = revision_ids[0]
704
if (not allow_leftmost_as_ghost and not
705
self.branch.repository.has_revision(leftmost_id)):
706
raise errors.GhostRevisionUnusableHere(leftmost_id)
708
def _set_merges_from_parent_ids(self, parent_ids):
709
merges = parent_ids[1:]
710
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
712
@needs_tree_write_lock
713
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
714
"""Set the parent ids to revision_ids.
716
See also set_parent_trees. This api will try to retrieve the tree data
717
for each element of revision_ids from the trees repository. If you have
718
tree data already available, it is more efficient to use
719
set_parent_trees rather than set_parent_ids. set_parent_ids is however
720
an easier API to use.
722
:param revision_ids: The revision_ids to set as the parent ids of this
723
working tree. Any of these may be ghosts.
725
self._check_parents_for_ghosts(revision_ids,
726
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
728
if len(revision_ids) > 0:
729
self.set_last_revision(revision_ids[0])
731
self.set_last_revision(None)
733
self._set_merges_from_parent_ids(revision_ids)
735
@needs_tree_write_lock
736
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
737
"""See MutableTree.set_parent_trees."""
738
parent_ids = [rev for (rev, tree) in parents_list]
740
self._check_parents_for_ghosts(parent_ids,
741
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
743
if len(parent_ids) == 0:
744
leftmost_parent_id = None
745
leftmost_parent_tree = None
747
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
749
if self._change_last_revision(leftmost_parent_id):
750
if leftmost_parent_tree is None:
751
# If we don't have a tree, fall back to reading the
752
# parent tree from the repository.
753
self._cache_basis_inventory(leftmost_parent_id)
755
inv = leftmost_parent_tree.inventory
756
xml = self._create_basis_xml_from_inventory(
757
leftmost_parent_id, inv)
758
self._write_basis_inventory(xml)
759
self._set_merges_from_parent_ids(parent_ids)
761
@needs_tree_write_lock
611
762
def set_pending_merges(self, rev_list):
612
self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
763
parents = self.get_parent_ids()
764
leftmost = parents[:1]
765
new_parents = leftmost + rev_list
766
self.set_parent_ids(new_parents)
768
@needs_tree_write_lock
615
769
def set_merge_modified(self, modified_hashes):
616
770
def iter_stanzas():
617
771
for file_id, hash in modified_hashes.iteritems():
618
772
yield Stanza(file_id=file_id, hash=hash)
619
773
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
775
@needs_tree_write_lock
622
776
def _put_rio(self, filename, stanzas, header):
623
777
my_file = rio_file(stanzas, header)
624
778
self._control_files.put(filename, my_file)
780
@needs_write_lock # because merge pulls data into the branch.
781
def merge_from_branch(self, branch, to_revision=None):
782
"""Merge from a branch into this working tree.
784
:param branch: The branch to merge from.
785
:param to_revision: If non-None, the merge will merge to to_revision, but
786
not beyond it. to_revision does not need to be in the history of
787
the branch when it is supplied. If None, to_revision defaults to
788
branch.last_revision().
790
from bzrlib.merge import Merger, Merge3Merger
791
pb = bzrlib.ui.ui_factory.nested_progress_bar()
793
merger = Merger(self.branch, this_tree=self, pb=pb)
794
merger.pp = ProgressPhase("Merge phase", 5, pb)
795
merger.pp.next_phase()
796
# check that there are no
798
merger.check_basis(check_clean=True, require_commits=False)
799
if to_revision is None:
800
to_revision = branch.last_revision()
801
merger.other_rev_id = to_revision
802
if merger.other_rev_id is None:
803
raise error.NoCommits(branch)
804
self.branch.fetch(branch, last_revision=merger.other_rev_id)
805
merger.other_basis = merger.other_rev_id
806
merger.other_tree = self.branch.repository.revision_tree(
808
merger.pp.next_phase()
810
if merger.base_rev_id == merger.other_rev_id:
811
raise errors.PointlessMerge
812
merger.backup_files = False
813
merger.merge_type = Merge3Merger
814
merger.set_interesting_files(None)
815
merger.show_base = False
816
merger.reprocess = False
817
conflicts = merger.do_merge()
627
824
def merge_modified(self):
666
883
Skips the control directory.
668
885
inv = self._inventory
670
def descend(from_dir_relpath, from_dir_id, dp):
886
if include_root is True:
887
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
888
# Convert these into local objects to save lookup times
889
pathjoin = osutils.pathjoin
890
file_kind = osutils.file_kind
892
# transport.base ends in a slash, we want the piece
893
# between the last two slashes
894
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
896
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
898
# directory file_id, relative path, absolute path, reverse sorted children
899
children = os.listdir(self.basedir)
901
# jam 20060527 The kernel sized tree seems equivalent whether we
902
# use a deque and popleft to keep them sorted, or if we use a plain
903
# list and just reverse() them.
904
children = collections.deque(children)
905
stack = [(inv.root.file_id, u'', self.basedir, children)]
907
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
910
f = children.popleft()
674
911
## TODO: If we find a subdirectory with its own .bzr
675
912
## directory, then that is a separate tree and we
676
913
## should exclude it.
678
915
# the bzrdir for this tree
679
if self.bzrdir.transport.base.endswith(f + '/'):
916
if transport_base_dir == f:
683
fp = appendpath(from_dir_relpath, f)
919
# we know that from_dir_relpath and from_dir_abspath never end in a slash
920
# and 'f' doesn't begin with one, we can do a string op, rather
921
# than the checks of pathjoin(), all relative paths will have an extra slash
923
fp = from_dir_relpath + '/' + f
686
fap = appendpath(dp, f)
926
fap = from_dir_abspath + '/' + f
688
928
f_ie = inv.get_child(from_dir_id, f)
691
elif self.is_ignored(fp):
931
elif self.is_ignored(fp[1:]):
934
# we may not have found this file, because of a unicode issue
935
f_norm, can_access = osutils.normalized_filename(f)
936
if f == f_norm or not can_access:
937
# No change, so treat this file normally
940
# this file can be accessed by a normalized path
941
# check again if it is versioned
942
# these lines are repeated here for performance
944
fp = from_dir_relpath + '/' + f
945
fap = from_dir_abspath + '/' + f
946
f_ie = inv.get_child(from_dir_id, f)
949
elif self.is_ignored(fp[1:]):
696
954
fk = file_kind(fap)
981
1291
If the file is ignored, returns the pattern which caused it to
982
1292
be ignored, otherwise None. So this can simply be used as a
983
1293
boolean if desired."""
985
# TODO: Use '**' to match directories, and other extended
986
# globbing stuff from cvs/rsync.
988
# XXX: fnmatch is actually not quite what we want: it's only
989
# approximately the same as real Unix fnmatch, and doesn't
990
# treat dotfiles correctly and allows * to match /.
991
# Eventually it should be replaced with something more
994
for pat in self.get_ignore_list():
995
if '/' in pat or '\\' in pat:
997
# as a special case, you can put ./ at the start of a
998
# pattern; this is good to match in the top-level
1001
if (pat[:2] == './') or (pat[:2] == '.\\'):
1005
if fnmatch.fnmatchcase(filename, newpat):
1008
if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1294
if getattr(self, '_ignoreglobster', None) is None:
1295
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1296
return self._ignoreglobster.match(filename)
1013
1298
def kind(self, file_id):
1014
1299
return file_kind(self.id2abspath(file_id))
1301
def _comparison_data(self, entry, path):
1302
abspath = self.abspath(path)
1304
stat_value = os.lstat(abspath)
1306
if getattr(e, 'errno', None) == errno.ENOENT:
1313
mode = stat_value.st_mode
1314
kind = osutils.file_kind_from_stat_mode(mode)
1315
if not supports_executable():
1316
executable = entry.executable
1318
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1319
return kind, executable, stat_value
1321
def _file_size(self, entry, stat_value):
1322
return stat_value.st_size
1017
1324
def last_revision(self):
1018
"""Return the last revision id of this working tree.
1020
In early branch formats this was == the branch last_revision,
1021
but that cannot be relied upon - for working tree operations,
1022
always use tree.last_revision().
1325
"""Return the last revision of the branch for this tree.
1327
This format tree does not support a separate marker for last-revision
1328
compared to the branch.
1330
See MutableTree.last_revision
1332
return self._last_revision()
1335
def _last_revision(self):
1336
"""helper for get_parent_ids."""
1024
1337
return self.branch.last_revision()
1339
def is_locked(self):
1340
return self._control_files.is_locked()
1026
1342
def lock_read(self):
1027
1343
"""See Branch.lock_read, and WorkingTree.unlock."""
1028
1344
self.branch.lock_read()
1059
1387
if new_revision is None:
1060
1388
self.branch.set_revision_history([])
1062
# current format is locked in with the branch
1063
revision_history = self.branch.revision_history()
1065
position = revision_history.index(new_revision)
1067
raise errors.NoSuchRevision(self.branch, new_revision)
1068
self.branch.set_revision_history(revision_history[:position + 1])
1391
self.branch.generate_revision_history(new_revision)
1392
except errors.NoSuchRevision:
1393
# not present in the repo - dont try to set it deeper than the tip
1394
self.branch.set_revision_history([new_revision])
1397
def _write_basis_inventory(self, xml):
1398
"""Write the basis inventory XML to the basis-inventory file"""
1399
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1400
path = self._basis_inventory_name()
1402
self._control_files.put(path, sio)
1404
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1405
"""Create the text that will be saved in basis-inventory"""
1406
inventory.revision_id = revision_id
1407
return xml6.serializer_v6.write_inventory_to_string(inventory)
1071
1409
def _cache_basis_inventory(self, new_revision):
1072
1410
"""Cache new_revision as the basis inventory."""
1411
# TODO: this should allow the ready-to-use inventory to be passed in,
1412
# as commit already has that ready-to-use [while the format is the
1074
1415
# this double handles the inventory - unpack and repack -
1075
1416
# but is easier to understand. We can/should put a conditional
1076
1417
# in here based on whether the inventory is in the latest format
1077
1418
# - perhaps we should repack all inventories on a repository
1079
inv = self.branch.repository.get_inventory(new_revision)
1080
inv.revision_id = new_revision
1081
xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1083
path = self._basis_inventory_name()
1084
self._control_files.put_utf8(path, xml)
1085
except WeaveRevisionNotPresent:
1420
# the fast path is to copy the raw xml from the repository. If the
1421
# xml contains 'revision_id="', then we assume the right
1422
# revision_id is set. We must check for this full string, because a
1423
# root node id can legitimately look like 'revision_id' but cannot
1425
xml = self.branch.repository.get_inventory_xml(new_revision)
1426
firstline = xml.split('\n', 1)[0]
1427
if (not 'revision_id="' in firstline or
1428
'format="6"' not in firstline):
1429
inv = self.branch.repository.deserialise_inventory(
1431
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1432
self._write_basis_inventory(xml)
1433
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1088
1436
def read_basis_inventory(self):
1089
1437
"""Read the cached basis inventory."""
1090
1438
path = self._basis_inventory_name()
1091
return self._control_files.get_utf8(path).read()
1439
return self._control_files.get(path).read()
1093
1441
@needs_read_lock
1094
1442
def read_working_inventory(self):
1095
"""Read the working inventory."""
1443
"""Read the working inventory.
1445
:raises errors.InventoryModified: read_working_inventory will fail
1446
when the current in memory inventory has been modified.
1448
# conceptually this should be an implementation detail of the tree.
1449
# XXX: Deprecate this.
1096
1450
# ElementTree does its own conversion from UTF-8, so open in
1098
result = bzrlib.xml5.serializer_v5.read_inventory(
1452
if self._inventory_is_modified:
1453
raise errors.InventoryModified(self)
1454
result = xml5.serializer_v5.read_inventory(
1099
1455
self._control_files.get('inventory'))
1100
self._set_inventory(result)
1456
self._set_inventory(result, dirty=False)
1104
def remove(self, files, verbose=False):
1459
@needs_tree_write_lock
1460
def remove(self, files, verbose=False, to_file=None):
1105
1461
"""Remove nominated files from the working inventory..
1107
1463
This does not remove their text. This does not run on XXX on what? RBC
1129
1485
# TODO: Perhaps make this just a warning, and continue?
1130
1486
# This tends to happen when
1131
1487
raise NotVersionedError(path=f)
1132
mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1134
1489
# having remove it, it must be either ignored or unknown
1135
1490
if self.is_ignored(f):
1136
1491
new_status = 'I'
1138
1493
new_status = '?'
1139
show_status(new_status, inv[fid].kind, quotefn(f))
1494
textui.show_status(new_status, inv[fid].kind, f,
1142
1498
self._write_inventory(inv)
1500
@needs_tree_write_lock
1145
1501
def revert(self, filenames, old_tree=None, backups=True,
1146
1502
pb=DummyProgress()):
1147
from transform import revert
1148
from conflicts import resolve
1503
from bzrlib.conflicts import resolve
1149
1504
if old_tree is None:
1150
1505
old_tree = self.basis_tree()
1151
conflicts = revert(self, old_tree, filenames, backups, pb)
1506
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1152
1507
if not len(filenames):
1153
self.set_pending_merges([])
1508
self.set_parent_ids(self.get_parent_ids()[:1])
1156
1511
resolve(self, filenames, ignore_misses=True)
1157
1512
return conflicts
1514
def revision_tree(self, revision_id):
1515
"""See Tree.revision_tree.
1517
WorkingTree can supply revision_trees for the basis revision only
1518
because there is only one cached inventory in the bzr directory.
1520
if revision_id == self.last_revision():
1522
xml = self.read_basis_inventory()
1527
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1528
# dont use the repository revision_tree api because we want
1529
# to supply the inventory.
1530
if inv.revision_id == revision_id:
1531
return revisiontree.RevisionTree(self.branch.repository,
1533
except errors.BadInventoryFormat:
1535
# raise if there was no inventory, or if we read the wrong inventory.
1536
raise errors.NoSuchRevisionInTree(self, revision_id)
1159
1538
# XXX: This method should be deprecated in favour of taking in a proper
1160
1539
# new Inventory object.
1540
@needs_tree_write_lock
1162
1541
def set_inventory(self, new_inventory_list):
1163
1542
from bzrlib.inventory import (Inventory,
1164
1543
InventoryDirectory,
1204
1598
between multiple working trees, i.e. via shared storage, then we
1205
1599
would probably want to lock both the local tree, and the branch.
1207
# FIXME: We want to write out the hashcache only when the last lock on
1208
# this working copy is released. Peeking at the lock count is a bit
1209
# of a nasty hack; probably it's better to have a transaction object,
1210
# which can do some finalization when it's either successfully or
1211
# unsuccessfully completed. (Denys's original patch did that.)
1212
# RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
# wrongly. Hookinh into unllock on the control files object is fine though.
1215
# TODO: split this per format so there is no ugly if block
1216
if self._hashcache.needs_write and (
1217
# dedicated lock files
1218
self._control_files._lock_count==1 or
1220
(self._control_files is self.branch.control_files and
1221
self._control_files._lock_count==3)):
1222
self._hashcache.write()
1223
# reverse order of locking.
1224
result = self._control_files.unlock()
1226
self.branch.unlock()
1601
raise NotImplementedError(self.unlock)
1231
1603
def update(self):
1232
1604
"""Update a working tree along its branch.
1234
This will update the branch if its bound too, which means we have multiple trees involved:
1235
The new basis tree of the master.
1236
The old basis tree of the branch.
1237
The old basis tree of the working tree.
1238
The current working tree state.
1239
pathologically all three may be different, and non ancestors of each other.
1240
Conceptually we want to:
1241
Preserve the wt.basis->wt.state changes
1242
Transform the wt.basis to the new master basis.
1243
Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
Restore the wt.basis->wt.state changes.
1606
This will update the branch if its bound too, which means we have
1607
multiple trees involved:
1609
- The new basis tree of the master.
1610
- The old basis tree of the branch.
1611
- The old basis tree of the working tree.
1612
- The current working tree state.
1614
Pathologically, all three may be different, and non-ancestors of each
1615
other. Conceptually we want to:
1617
- Preserve the wt.basis->wt.state changes
1618
- Transform the wt.basis to the new master basis.
1619
- Apply a merge of the old branch basis to get any 'local' changes from
1621
- Restore the wt.basis->wt.state changes.
1246
1623
There isn't a single operation at the moment to do that, so we:
1247
Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
Do a 'normal' merge of the old branch basis if it is relevant.
1624
- Merge current state -> basis tree of the master w.r.t. the old tree
1626
- Do a 'normal' merge of the old branch basis if it is relevant.
1250
old_tip = self.branch.update()
1251
if old_tip is not None:
1252
self.add_pending_merge(old_tip)
1253
self.branch.lock_read()
1628
if self.branch.get_master_branch() is not None:
1630
update_branch = True
1632
self.lock_tree_write()
1633
update_branch = False
1256
if self.last_revision() != self.branch.last_revision():
1257
# merge tree state up to new branch tip.
1258
basis = self.basis_tree()
1259
to_tree = self.branch.basis_tree()
1260
result += merge_inner(self.branch,
1264
self.set_last_revision(self.branch.last_revision())
1265
if old_tip and old_tip != self.last_revision():
1266
# our last revision was not the prior branch last reivison
1267
# and we have converted that last revision to a pending merge.
1268
# base is somewhere between the branch tip now
1269
# and the now pending merge
1270
from bzrlib.revision import common_ancestor
1272
base_rev_id = common_ancestor(self.branch.last_revision(),
1274
self.branch.repository)
1275
except errors.NoCommonAncestor:
1277
base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
other_tree = self.branch.repository.revision_tree(old_tip)
1279
result += merge_inner(self.branch,
1636
old_tip = self.branch.update()
1639
return self._update_tree(old_tip)
1285
self.branch.unlock()
1643
@needs_tree_write_lock
1644
def _update_tree(self, old_tip=None):
1645
"""Update a tree to the master branch.
1647
:param old_tip: if supplied, the previous tip revision the branch,
1648
before it was changed to the master branch's tip.
1650
# here if old_tip is not None, it is the old tip of the branch before
1651
# it was updated from the master branch. This should become a pending
1652
# merge in the working tree to preserve the user existing work. we
1653
# cant set that until we update the working trees last revision to be
1654
# one from the new branch, because it will just get absorbed by the
1655
# parent de-duplication logic.
1657
# We MUST save it even if an error occurs, because otherwise the users
1658
# local work is unreferenced and will appear to have been lost.
1662
last_rev = self.get_parent_ids()[0]
1665
if last_rev != self.branch.last_revision():
1666
# merge tree state up to new branch tip.
1667
basis = self.basis_tree()
1668
to_tree = self.branch.basis_tree()
1669
if basis.inventory.root is None:
1670
self.set_root_id(to_tree.inventory.root.file_id)
1671
result += merge.merge_inner(
1676
# TODO - dedup parents list with things merged by pull ?
1677
# reuse the tree we've updated to to set the basis:
1678
parent_trees = [(self.branch.last_revision(), to_tree)]
1679
merges = self.get_parent_ids()[1:]
1680
# Ideally we ask the tree for the trees here, that way the working
1681
# tree can decide whether to give us teh entire tree or give us a
1682
# lazy initialised tree. dirstate for instance will have the trees
1683
# in ram already, whereas a last-revision + basis-inventory tree
1684
# will not, but also does not need them when setting parents.
1685
for parent in merges:
1686
parent_trees.append(
1687
(parent, self.branch.repository.revision_tree(parent)))
1688
if old_tip is not None:
1689
parent_trees.append(
1690
(old_tip, self.branch.repository.revision_tree(old_tip)))
1691
self.set_parent_trees(parent_trees)
1692
last_rev = parent_trees[0][0]
1694
# the working tree had the same last-revision as the master
1695
# branch did. We may still have pivot local work from the local
1696
# branch into old_tip:
1697
if old_tip is not None:
1698
self.add_parent_tree_id(old_tip)
1699
if old_tip and old_tip != last_rev:
1700
# our last revision was not the prior branch last revision
1701
# and we have converted that last revision to a pending merge.
1702
# base is somewhere between the branch tip now
1703
# and the now pending merge
1704
from bzrlib.revision import common_ancestor
1706
base_rev_id = common_ancestor(self.branch.last_revision(),
1708
self.branch.repository)
1709
except errors.NoCommonAncestor:
1711
base_tree = self.branch.repository.revision_tree(base_rev_id)
1712
other_tree = self.branch.repository.revision_tree(old_tip)
1713
result += merge.merge_inner(
1720
def _write_hashcache_if_dirty(self):
1721
"""Write out the hashcache if it is dirty."""
1722
if self._hashcache.needs_write:
1724
self._hashcache.write()
1726
if e.errno not in (errno.EPERM, errno.EACCES):
1728
# TODO: jam 20061219 Should this be a warning? A single line
1729
# warning might be sufficient to let the user know what
1731
mutter('Could not write hashcache for %s\nError: %s',
1732
self._hashcache.cache_file_name(), e)
1734
@needs_tree_write_lock
1288
1735
def _write_inventory(self, inv):
1289
1736
"""Write inventory as the current inventory."""
1291
bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1293
self._control_files.put('inventory', sio)
1294
self._set_inventory(inv)
1295
mutter('wrote working inventory')
1737
self._set_inventory(inv, dirty=True)
1297
1740
def set_conflicts(self, arg):
1298
1741
raise UnsupportedOperation(self.set_conflicts, self)
1743
def add_conflicts(self, arg):
1744
raise UnsupportedOperation(self.add_conflicts, self)
1300
1746
@needs_read_lock
1301
1747
def conflicts(self):
1302
conflicts = ConflictList()
1748
conflicts = _mod_conflicts.ConflictList()
1303
1749
for conflicted in self._iter_conflicts():
1306
1752
if file_kind(self.abspath(conflicted)) != "file":
1309
if e.errno == errno.ENOENT:
1754
except errors.NoSuchFile:
1313
1756
if text is True:
1314
1757
for suffix in ('.THIS', '.OTHER'):
1316
1759
kind = file_kind(self.abspath(conflicted+suffix))
1318
if e.errno == errno.ENOENT:
1762
except errors.NoSuchFile:
1326
1766
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
conflicts.append(Conflict.factory(ctype, path=conflicted,
1767
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1328
1769
file_id=self.path2id(conflicted)))
1329
1770
return conflicts
1773
class WorkingTree2(WorkingTree):
1774
"""This is the Format 2 working tree.
1776
This was the first weave based working tree.
1777
- uses os locks for locking.
1778
- uses the branch last-revision.
1781
def lock_tree_write(self):
1782
"""See WorkingTree.lock_tree_write().
1784
In Format2 WorkingTrees we have a single lock for the branch and tree
1785
so lock_tree_write() degrades to lock_write().
1787
self.branch.lock_write()
1789
return self._control_files.lock_write()
1791
self.branch.unlock()
1795
# we share control files:
1796
if self._control_files._lock_count == 3:
1797
# _inventory_is_modified is always False during a read lock.
1798
if self._inventory_is_modified:
1800
self._write_hashcache_if_dirty()
1802
# reverse order of locking.
1804
return self._control_files.unlock()
1806
self.branch.unlock()
1332
1809
class WorkingTree3(WorkingTree):
1333
1810
"""This is the Format 3 working tree.
added
removed
bzrlib/workingtree.py
