1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
45
from copy import deepcopy
54
conflicts as _mod_conflicts,
68
from bzrlib.transport import get_transport
72
from bzrlib import symbol_versioning
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
74
from bzrlib.errors import (BzrCheckError,
77
WeaveRevisionNotPresent,
81
MergeModifiedFormatError,
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
85
from bzrlib.lockable_files import LockableFiles, TransportLock
86
from bzrlib.lockdir import LockDir
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
106
import bzrlib.revisiontree
107
from bzrlib.rio import RioReader, rio_file, Stanza
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)
123
def gen_file_id(name):
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
"""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()
140
class TreeEntry(object):
141
"""An entry that implements the minimum interface used by commands.
143
This needs further inspection, it may be better to have
144
InventoryEntries without ids - though that seems wrong. For now,
145
this is a parallel hierarchy to InventoryEntry, and needs to become
146
one of several things: decorates to that hierarchy, children of, or
148
Another note is that these objects are currently only used when there is
149
no InventoryEntry available - i.e. for unversioned objects.
150
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
153
def __eq__(self, other):
154
# yes, this us ugly, TODO: best practice __eq__ style.
155
return (isinstance(other, TreeEntry)
156
and other.__class__ == self.__class__)
158
def kind_character(self):
162
class TreeDirectory(TreeEntry):
163
"""See TreeEntry. This is a directory in a working tree."""
165
def __eq__(self, other):
166
return (isinstance(other, TreeDirectory)
167
and other.__class__ == self.__class__)
169
def kind_character(self):
173
class TreeFile(TreeEntry):
174
"""See TreeEntry. This is a regular file in a working tree."""
176
def __eq__(self, other):
177
return (isinstance(other, TreeFile)
178
and other.__class__ == self.__class__)
180
def kind_character(self):
184
class TreeLink(TreeEntry):
185
"""See TreeEntry. This is a symlink in a working tree."""
187
def __eq__(self, other):
188
return (isinstance(other, TreeLink)
189
and other.__class__ == self.__class__)
191
def kind_character(self):
195
class WorkingTree(bzrlib.mutabletree.MutableTree):
196
"""Working copy tree.
198
The inventory is held in the `Branch` working-inventory, and the
199
files are in a directory on disk.
201
It is possible for a `WorkingTree` to have a filename which is
202
not listed in the Inventory and vice versa.
205
def __init__(self, basedir='.',
206
branch=DEPRECATED_PARAMETER,
212
"""Construct a WorkingTree for basedir.
214
If the branch is not supplied, it is opened automatically.
215
If the branch is supplied, it must be the branch for this basedir.
216
(branch.base is not cross checked, because for remote branches that
217
would be meaningless).
219
self._format = _format
220
self.bzrdir = _bzrdir
222
# not created via open etc.
223
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
224
"Please use bzrdir.open_workingtree or WorkingTree.open().",
227
wt = WorkingTree.open(basedir)
228
self._branch = wt.branch
229
self.basedir = wt.basedir
230
self._control_files = wt._control_files
231
self._hashcache = wt._hashcache
232
self._set_inventory(wt._inventory, dirty=False)
233
self._format = wt._format
234
self.bzrdir = wt.bzrdir
235
from bzrlib.hashcache import HashCache
236
from bzrlib.trace import note, mutter
237
assert isinstance(basedir, basestring), \
238
"base directory %r is not a string" % basedir
239
basedir = safe_unicode(basedir)
240
mutter("opening working tree %r", basedir)
241
if deprecated_passed(branch):
243
warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
244
" Please use bzrdir.open_workingtree() or"
245
" WorkingTree.open().",
249
self._branch = branch
251
self._branch = self.bzrdir.open_branch()
252
self.basedir = realpath(basedir)
253
# if branch is at our basedir and is a format 6 or less
254
if isinstance(self._format, WorkingTreeFormat2):
255
# share control object
256
self._control_files = self.branch.control_files
258
# assume all other formats have their own control files.
259
assert isinstance(_control_files, LockableFiles), \
260
"_control_files must be a LockableFiles, not %r" \
262
self._control_files = _control_files
263
# update the whole cache up front and write to disk if anything changed;
264
# in the future we might want to do this more selectively
265
# two possible ways offer themselves : in self._unlock, write the cache
266
# if needed, or, when the cache sees a change, append it to the hash
267
# cache file, and have the parser take the most recent entry for a
269
cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
270
hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
# is this scan needed ? it makes things kinda slow.
279
if _inventory is None:
280
self._inventory_is_modified = False
281
self.read_working_inventory()
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
319
self._inventory = inv
320
self._inventory_is_modified = dirty
323
def open(path=None, _unsupported=False):
324
"""Open an existing working tree at path.
328
path = os.path.getcwdu()
329
control = bzrdir.BzrDir.open(path, _unsupported)
330
return control.open_workingtree(_unsupported)
333
def open_containing(path=None):
334
"""Open an existing working tree which has its root about path.
336
This probes for a working tree at path and searches upwards from there.
338
Basically we keep looking up until we find the control directory or
339
run into /. If there isn't one, raises NotBranchError.
340
TODO: give this a new exception.
341
If there is one, it is returned, along with the unused portion of path.
343
:return: The WorkingTree that contains 'path', and the rest of path
346
path = osutils.getcwd()
347
control, relpath = bzrdir.BzrDir.open_containing(path)
349
return control.open_workingtree(), relpath
352
def open_downlevel(path=None):
353
"""Open an unsupported working tree.
355
Only intended for advanced situations like upgrading part of a bzrdir.
357
return WorkingTree.open(path, _unsupported=True)
360
"""Iterate through file_ids for this tree.
362
file_ids are in a WorkingTree if they are in the working inventory
363
and the working file exists.
365
inv = self._inventory
366
for path, ie in inv.iter_entries():
367
if osutils.lexists(self.abspath(path)):
371
return "<%s of %s>" % (self.__class__.__name__,
372
getattr(self, 'basedir', None))
374
def abspath(self, filename):
375
return pathjoin(self.basedir, filename)
377
def basis_tree(self):
378
"""Return RevisionTree for the current last revision.
380
If the left most parent is a ghost then the returned tree will be an
381
empty tree - one obtained by calling repository.revision_tree(None).
384
revision_id = self.get_parent_ids()[0]
386
# no parents, return an empty revision tree.
387
# in the future this should return the tree for
388
# 'empty:' - the implicit root empty tree.
389
return self.branch.repository.revision_tree(None)
392
xml = self.read_basis_inventory()
393
inv = xml6.serializer_v6.read_inventory_from_string(xml)
394
if inv is not None and inv.revision_id == revision_id:
395
return bzrlib.revisiontree.RevisionTree(
396
self.branch.repository, inv, revision_id)
397
except (NoSuchFile, errors.BadInventoryFormat):
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except errors.RevisionNotPresent:
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(None)
414
@deprecated_method(zero_eight)
415
def create(branch, directory):
416
"""Create a workingtree for branch at directory.
418
If existing_directory already exists it must have a .bzr directory.
419
If it does not exist, it will be created.
421
This returns a new WorkingTree object for the new checkout.
423
TODO FIXME RBC 20060124 when we have checkout formats in place this
424
should accept an optional revisionid to checkout [and reject this if
425
checking out into the same dir as a pre-checkout-aware branch format.]
427
XXX: When BzrDir is present, these should be created through that
430
warnings.warn('delete WorkingTree.create', stacklevel=3)
431
transport = get_transport(directory)
432
if branch.bzrdir.root_transport.base == transport.base:
434
return branch.bzrdir.create_workingtree()
435
# different directory,
436
# create a branch reference
437
# and now a working tree.
438
raise NotImplementedError
441
@deprecated_method(zero_eight)
442
def create_standalone(directory):
443
"""Create a checkout and a branch and a repo at directory.
445
Directory must exist and be empty.
447
please use BzrDir.create_standalone_workingtree
449
return bzrdir.BzrDir.create_standalone_workingtree(directory)
451
def relpath(self, path):
452
"""Return the local path portion from a given path.
454
The path may be absolute or relative. If its a relative path it is
455
interpreted relative to the python current working directory.
457
return osutils.relpath(self.basedir, path)
459
def has_filename(self, filename):
460
return osutils.lexists(self.abspath(filename))
462
def get_file(self, file_id):
463
return self.get_file_byname(self.id2path(file_id))
465
def get_file_text(self, file_id):
466
return self.get_file(file_id).read()
468
def get_file_byname(self, filename):
469
return file(self.abspath(filename), 'rb')
471
def annotate_iter(self, file_id):
472
"""See Tree.annotate_iter
474
This implementation will use the basis tree implementation if possible.
475
Lines not in the basis are attributed to CURRENT_REVISION
477
If there are pending merges, lines added by those merges will be
478
incorrectly attributed to CURRENT_REVISION (but after committing, the
479
attribution will be correct).
481
basis = self.basis_tree()
482
changes = self._iter_changes(basis, True, [file_id]).next()
483
changed_content, kind = changes[2], changes[6]
484
if not changed_content:
485
return basis.annotate_iter(file_id)
489
if kind[0] != 'file':
492
old_lines = list(basis.annotate_iter(file_id))
494
for tree in self.branch.repository.revision_trees(
495
self.get_parent_ids()[1:]):
496
if file_id not in tree:
498
old.append(list(tree.annotate_iter(file_id)))
499
return annotate.reannotate(old, self.get_file(file_id).readlines(),
502
def get_parent_ids(self):
503
"""See Tree.get_parent_ids.
505
This implementation reads the pending merges list and last_revision
506
value and uses that to decide what the parents list should be.
508
last_rev = self._last_revision()
514
merges_file = self._control_files.get_utf8('pending-merges')
518
for l in merges_file.readlines():
519
parents.append(l.rstrip('\n'))
523
def get_root_id(self):
524
"""Return the id of this trees root"""
525
return self._inventory.root.file_id
527
def _get_store_filename(self, file_id):
528
## XXX: badly named; this is not in the store at all
529
return self.abspath(self.id2path(file_id))
532
def clone(self, to_bzrdir, revision_id=None, basis=None):
533
"""Duplicate this working tree into to_bzr, including all state.
535
Specifically modified files are kept as modified, but
536
ignored and unknown files are discarded.
538
If you want to make a new line of development, see bzrdir.sprout()
541
If not None, the cloned tree will have its last revision set to
542
revision, and and difference between the source trees last revision
543
and this one merged in.
546
If not None, a closer copy of a tree which may have some files in
547
common, and which file content should be preferentially copied from.
549
# assumes the target bzr dir format is compatible.
550
result = self._format.initialize(to_bzrdir)
551
self.copy_content_into(result, revision_id)
555
def copy_content_into(self, tree, revision_id=None):
556
"""Copy the current content and user files of this tree into tree."""
557
tree.set_root_id(self.get_root_id())
558
if revision_id is None:
559
merge.transform_tree(tree, self)
561
# TODO now merge from tree.last_revision to revision (to preserve
562
# user local changes)
563
merge.transform_tree(tree, self)
564
tree.set_parent_ids([revision_id])
566
def id2abspath(self, file_id):
567
return self.abspath(self.id2path(file_id))
569
def has_id(self, file_id):
570
# files that have been deleted are excluded
571
inv = self._inventory
572
if not inv.has_id(file_id):
574
path = inv.id2path(file_id)
575
return osutils.lexists(self.abspath(path))
577
def has_or_had_id(self, file_id):
578
if file_id == self.inventory.root.file_id:
580
return self.inventory.has_id(file_id)
582
__contains__ = has_id
584
def get_file_size(self, file_id):
585
return os.path.getsize(self.id2abspath(file_id))
588
def get_file_sha1(self, file_id, path=None, stat_value=None):
590
path = self._inventory.id2path(file_id)
591
return self._hashcache.get_sha1(path, stat_value)
593
def get_file_mtime(self, file_id, path=None):
595
path = self._inventory.id2path(file_id)
596
return os.lstat(self.abspath(path)).st_mtime
598
if not supports_executable():
599
def is_executable(self, file_id, path=None):
600
return self._inventory[file_id].executable
602
def is_executable(self, file_id, path=None):
604
path = self._inventory.id2path(file_id)
605
mode = os.lstat(self.abspath(path)).st_mode
606
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
609
def _add(self, files, ids, kinds):
610
"""See MutableTree._add."""
611
# TODO: Re-adding a file that is removed in the working copy
612
# should probably put it back with the previous ID.
613
# the read and write working inventory should not occur in this
614
# function - they should be part of lock_write and unlock.
615
inv = self.read_working_inventory()
616
for f, file_id, kind in zip(files, ids, kinds):
617
assert kind is not None
619
inv.add_path(f, kind=kind)
621
inv.add_path(f, kind=kind, file_id=file_id)
622
self._write_inventory(inv)
624
@needs_tree_write_lock
625
def _gather_kinds(self, files, kinds):
626
"""See MutableTree._gather_kinds."""
627
for pos, f in enumerate(files):
628
if kinds[pos] is None:
629
fullpath = normpath(self.abspath(f))
631
kinds[pos] = file_kind(fullpath)
633
if e.errno == errno.ENOENT:
634
raise NoSuchFile(fullpath)
637
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
638
"""Add revision_id as a parent.
640
This is equivalent to retrieving the current list of parent ids
641
and setting the list to its value plus revision_id.
643
:param revision_id: The revision id to add to the parent list. It may
644
be a ghost revision as long as its not the first parent to be added,
645
or the allow_leftmost_as_ghost parameter is set True.
646
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
648
parents = self.get_parent_ids() + [revision_id]
649
self.set_parent_ids(parents,
650
allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
652
@needs_tree_write_lock
653
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
654
"""Add revision_id, tree tuple as a parent.
656
This is equivalent to retrieving the current list of parent trees
657
and setting the list to its value plus parent_tuple. See also
658
add_parent_tree_id - if you only have a parent id available it will be
659
simpler to use that api. If you have the parent already available, using
660
this api is preferred.
662
:param parent_tuple: The (revision id, tree) to add to the parent list.
663
If the revision_id is a ghost, pass None for the tree.
664
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
666
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
667
if len(parent_ids) > 1:
668
# the leftmost may have already been a ghost, preserve that if it
670
allow_leftmost_as_ghost = True
671
self.set_parent_ids(parent_ids,
672
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
674
@needs_tree_write_lock
675
def add_pending_merge(self, *revision_ids):
676
# TODO: Perhaps should check at this point that the
677
# history of the revision is actually present?
678
parents = self.get_parent_ids()
680
for rev_id in revision_ids:
681
if rev_id in parents:
683
parents.append(rev_id)
686
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
688
@deprecated_method(zero_eleven)
690
def pending_merges(self):
691
"""Return a list of pending merges.
693
These are revisions that have been merged into the working
694
directory but not yet committed.
696
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
697
instead - which is available on all tree objects.
699
return self.get_parent_ids()[1:]
701
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
702
"""Common ghost checking functionality from set_parent_*.
704
This checks that the left hand-parent exists if there are any
707
if len(revision_ids) > 0:
708
leftmost_id = revision_ids[0]
709
if (not allow_leftmost_as_ghost and not
710
self.branch.repository.has_revision(leftmost_id)):
711
raise errors.GhostRevisionUnusableHere(leftmost_id)
713
def _set_merges_from_parent_ids(self, parent_ids):
714
merges = parent_ids[1:]
715
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
717
@needs_tree_write_lock
718
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
719
"""Set the parent ids to revision_ids.
721
See also set_parent_trees. This api will try to retrieve the tree data
722
for each element of revision_ids from the trees repository. If you have
723
tree data already available, it is more efficient to use
724
set_parent_trees rather than set_parent_ids. set_parent_ids is however
725
an easier API to use.
727
:param revision_ids: The revision_ids to set as the parent ids of this
728
working tree. Any of these may be ghosts.
730
self._check_parents_for_ghosts(revision_ids,
731
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
733
if len(revision_ids) > 0:
734
self.set_last_revision(revision_ids[0])
736
self.set_last_revision(None)
738
self._set_merges_from_parent_ids(revision_ids)
740
@needs_tree_write_lock
741
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
742
"""See MutableTree.set_parent_trees."""
743
parent_ids = [rev for (rev, tree) in parents_list]
745
self._check_parents_for_ghosts(parent_ids,
746
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
748
if len(parent_ids) == 0:
749
leftmost_parent_id = None
750
leftmost_parent_tree = None
752
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
754
if self._change_last_revision(leftmost_parent_id):
755
if leftmost_parent_tree is None:
756
# If we don't have a tree, fall back to reading the
757
# parent tree from the repository.
758
self._cache_basis_inventory(leftmost_parent_id)
760
inv = leftmost_parent_tree.inventory
761
xml = self._create_basis_xml_from_inventory(
762
leftmost_parent_id, inv)
763
self._write_basis_inventory(xml)
764
self._set_merges_from_parent_ids(parent_ids)
766
@needs_tree_write_lock
767
def set_pending_merges(self, rev_list):
768
parents = self.get_parent_ids()
769
leftmost = parents[:1]
770
new_parents = leftmost + rev_list
771
self.set_parent_ids(new_parents)
773
@needs_tree_write_lock
774
def set_merge_modified(self, modified_hashes):
776
for file_id, hash in modified_hashes.iteritems():
777
yield Stanza(file_id=file_id, hash=hash)
778
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
780
@needs_tree_write_lock
781
def _put_rio(self, filename, stanzas, header):
782
my_file = rio_file(stanzas, header)
783
self._control_files.put(filename, my_file)
785
@needs_write_lock # because merge pulls data into the branch.
786
def merge_from_branch(self, branch, to_revision=None):
787
"""Merge from a branch into this working tree.
789
:param branch: The branch to merge from.
790
:param to_revision: If non-None, the merge will merge to to_revision, but
791
not beyond it. to_revision does not need to be in the history of
792
the branch when it is supplied. If None, to_revision defaults to
793
branch.last_revision().
795
from bzrlib.merge import Merger, Merge3Merger
796
pb = bzrlib.ui.ui_factory.nested_progress_bar()
798
merger = Merger(self.branch, this_tree=self, pb=pb)
799
merger.pp = ProgressPhase("Merge phase", 5, pb)
800
merger.pp.next_phase()
801
# check that there are no
803
merger.check_basis(check_clean=True, require_commits=False)
804
if to_revision is None:
805
to_revision = branch.last_revision()
806
merger.other_rev_id = to_revision
807
if merger.other_rev_id is None:
808
raise error.NoCommits(branch)
809
self.branch.fetch(branch, last_revision=merger.other_rev_id)
810
merger.other_basis = merger.other_rev_id
811
merger.other_tree = self.branch.repository.revision_tree(
813
merger.pp.next_phase()
815
if merger.base_rev_id == merger.other_rev_id:
816
raise errors.PointlessMerge
817
merger.backup_files = False
818
merger.merge_type = Merge3Merger
819
merger.set_interesting_files(None)
820
merger.show_base = False
821
merger.reprocess = False
822
conflicts = merger.do_merge()
829
def merge_modified(self):
831
hashfile = self._control_files.get('merge-hashes')
836
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
837
raise MergeModifiedFormatError()
838
except StopIteration:
839
raise MergeModifiedFormatError()
840
for s in RioReader(hashfile):
841
file_id = s.get("file_id")
842
if file_id not in self.inventory:
845
if hash == self.get_file_sha1(file_id):
846
merge_hashes[file_id] = hash
850
def mkdir(self, path, file_id=None):
851
"""See MutableTree.mkdir()."""
853
file_id = generate_ids.gen_file_id(os.path.basename(path))
854
os.mkdir(self.abspath(path))
855
self.add(path, file_id, 'directory')
858
def get_symlink_target(self, file_id):
859
return os.readlink(self.id2abspath(file_id))
861
def file_class(self, filename):
862
if self.path2id(filename):
864
elif self.is_ignored(filename):
870
"""Write the in memory inventory to disk."""
871
# TODO: Maybe this should only write on dirty ?
872
if self._control_files._lock_mode != 'w':
873
raise errors.NotWriteLocked(self)
875
xml5.serializer_v5.write_inventory(self._inventory, sio)
877
self._control_files.put('inventory', sio)
878
self._inventory_is_modified = False
880
def list_files(self, include_root=False):
881
"""Recursively list all files as (path, class, kind, id, entry).
883
Lists, but does not descend into unversioned directories.
885
This does not include files that have been deleted in this
888
Skips the control directory.
890
inv = self._inventory
891
if include_root is True:
892
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
893
# Convert these into local objects to save lookup times
894
pathjoin = osutils.pathjoin
895
file_kind = osutils.file_kind
897
# transport.base ends in a slash, we want the piece
898
# between the last two slashes
899
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
901
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
903
# directory file_id, relative path, absolute path, reverse sorted children
904
children = os.listdir(self.basedir)
906
# jam 20060527 The kernel sized tree seems equivalent whether we
907
# use a deque and popleft to keep them sorted, or if we use a plain
908
# list and just reverse() them.
909
children = collections.deque(children)
910
stack = [(inv.root.file_id, u'', self.basedir, children)]
912
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
915
f = children.popleft()
916
## TODO: If we find a subdirectory with its own .bzr
917
## directory, then that is a separate tree and we
918
## should exclude it.
920
# the bzrdir for this tree
921
if transport_base_dir == f:
924
# we know that from_dir_relpath and from_dir_abspath never end in a slash
925
# and 'f' doesn't begin with one, we can do a string op, rather
926
# than the checks of pathjoin(), all relative paths will have an extra slash
928
fp = from_dir_relpath + '/' + f
931
fap = from_dir_abspath + '/' + f
933
f_ie = inv.get_child(from_dir_id, f)
936
elif self.is_ignored(fp[1:]):
939
# we may not have found this file, because of a unicode issue
940
f_norm, can_access = osutils.normalized_filename(f)
941
if f == f_norm or not can_access:
942
# No change, so treat this file normally
945
# this file can be accessed by a normalized path
946
# check again if it is versioned
947
# these lines are repeated here for performance
949
fp = from_dir_relpath + '/' + f
950
fap = from_dir_abspath + '/' + f
951
f_ie = inv.get_child(from_dir_id, f)
954
elif self.is_ignored(fp[1:]):
963
raise BzrCheckError("file %r entered as kind %r id %r, "
965
% (fap, f_ie.kind, f_ie.file_id, fk))
967
# make a last minute entry
969
yield fp[1:], c, fk, f_ie.file_id, f_ie
972
yield fp[1:], c, fk, None, fk_entries[fk]()
974
yield fp[1:], c, fk, None, TreeEntry()
977
if fk != 'directory':
980
# But do this child first
981
new_children = os.listdir(fap)
983
new_children = collections.deque(new_children)
984
stack.append((f_ie.file_id, fp, fap, new_children))
985
# Break out of inner loop, so that we start outer loop with child
988
# if we finished all children, pop it off the stack
991
@needs_tree_write_lock
992
def move(self, from_paths, to_name):
995
to_name must exist in the inventory.
997
If to_name exists and is a directory, the files are moved into
998
it, keeping their old names.
1000
Note that to_name is only the last component of the new name;
1001
this doesn't change the directory.
1003
This returns a list of (from_path, to_path) pairs for each
1004
entry that is moved.
1007
## TODO: Option to move IDs only
1008
assert not isinstance(from_paths, basestring)
1009
inv = self.inventory
1010
to_abs = self.abspath(to_name)
1011
if not isdir(to_abs):
1012
raise BzrError("destination %r is not a directory" % to_abs)
1013
if not self.has_filename(to_name):
1014
raise BzrError("destination %r not in working directory" % to_abs)
1015
to_dir_id = inv.path2id(to_name)
1016
if to_dir_id is None and to_name != '':
1017
raise BzrError("destination %r is not a versioned directory" % to_name)
1018
to_dir_ie = inv[to_dir_id]
1019
if to_dir_ie.kind != 'directory':
1020
raise BzrError("destination %r is not a directory" % to_abs)
1022
to_idpath = inv.get_idpath(to_dir_id)
1024
for f in from_paths:
1025
if not self.has_filename(f):
1026
raise BzrError("%r does not exist in working tree" % f)
1027
f_id = inv.path2id(f)
1029
raise BzrError("%r is not versioned" % f)
1030
name_tail = splitpath(f)[-1]
1031
dest_path = pathjoin(to_name, name_tail)
1032
if self.has_filename(dest_path):
1033
raise BzrError("destination %r already exists" % dest_path)
1034
if f_id in to_idpath:
1035
raise BzrError("can't move %r to a subdirectory of itself" % f)
1037
# OK, so there's a race here, it's possible that someone will
1038
# create a file in this interval and then the rename might be
1039
# left half-done. But we should have caught most problems.
1040
orig_inv = deepcopy(self.inventory)
1041
original_modified = self._inventory_is_modified
1044
self._inventory_is_modified = True
1045
for f in from_paths:
1046
name_tail = splitpath(f)[-1]
1047
dest_path = pathjoin(to_name, name_tail)
1048
result.append((f, dest_path))
1049
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1051
osutils.rename(self.abspath(f), self.abspath(dest_path))
1053
raise BzrError("failed to rename %r to %r: %s" %
1054
(f, dest_path, e[1]))
1056
# restore the inventory on error
1057
self._set_inventory(orig_inv, dirty=original_modified)
1059
self._write_inventory(inv)
1062
@needs_tree_write_lock
1063
def rename_one(self, from_rel, to_rel):
1066
This can change the directory or the filename or both.
1068
inv = self.inventory
1069
if not self.has_filename(from_rel):
1070
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1071
if self.has_filename(to_rel):
1072
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1074
file_id = inv.path2id(from_rel)
1076
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1078
entry = inv[file_id]
1079
from_parent = entry.parent_id
1080
from_name = entry.name
1082
if inv.path2id(to_rel):
1083
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1085
to_dir, to_tail = os.path.split(to_rel)
1086
to_dir_id = inv.path2id(to_dir)
1087
if to_dir_id is None and to_dir != '':
1088
raise BzrError("can't determine destination directory id for %r" % to_dir)
1090
mutter("rename_one:")
1091
mutter(" file_id {%s}" % file_id)
1092
mutter(" from_rel %r" % from_rel)
1093
mutter(" to_rel %r" % to_rel)
1094
mutter(" to_dir %r" % to_dir)
1095
mutter(" to_dir_id {%s}" % to_dir_id)
1097
inv.rename(file_id, to_dir_id, to_tail)
1099
from_abs = self.abspath(from_rel)
1100
to_abs = self.abspath(to_rel)
1102
osutils.rename(from_abs, to_abs)
1104
inv.rename(file_id, from_parent, from_name)
1105
raise BzrError("failed to rename %r to %r: %s"
1106
% (from_abs, to_abs, e[1]))
1107
self._write_inventory(inv)
1111
"""Return all unknown files.
1113
These are files in the working directory that are not versioned or
1114
control files or ignored.
1116
for subp in self.extras():
1117
if not self.is_ignored(subp):
1120
@needs_tree_write_lock
1121
def unversion(self, file_ids):
1122
"""Remove the file ids in file_ids from the current versioned set.
1124
When a file_id is unversioned, all of its children are automatically
1127
:param file_ids: The file ids to stop versioning.
1128
:raises: NoSuchId if any fileid is not currently versioned.
1130
for file_id in file_ids:
1131
if self._inventory.has_id(file_id):
1132
self._inventory.remove_recursive_id(file_id)
1134
raise errors.NoSuchId(self, file_id)
1136
# in the future this should just set a dirty bit to wait for the
1137
# final unlock. However, until all methods of workingtree start
1138
# with the current in -memory inventory rather than triggering
1139
# a read, it is more complex - we need to teach read_inventory
1140
# to know when to read, and when to not read first... and possibly
1141
# to save first when the in memory one may be corrupted.
1142
# so for now, we just only write it if it is indeed dirty.
1144
self._write_inventory(self._inventory)
1146
@deprecated_method(zero_eight)
1147
def iter_conflicts(self):
1148
"""List all files in the tree that have text or content conflicts.
1149
DEPRECATED. Use conflicts instead."""
1150
return self._iter_conflicts()
1152
def _iter_conflicts(self):
1154
for info in self.list_files():
1156
stem = get_conflicted_stem(path)
1159
if stem not in conflicted:
1160
conflicted.add(stem)
1164
def pull(self, source, overwrite=False, stop_revision=None):
1165
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1168
pp = ProgressPhase("Pull phase", 2, top_pb)
1170
old_revision_history = self.branch.revision_history()
1171
basis_tree = self.basis_tree()
1172
count = self.branch.pull(source, overwrite, stop_revision)
1173
new_revision_history = self.branch.revision_history()
1174
if new_revision_history != old_revision_history:
1176
if len(old_revision_history):
1177
other_revision = old_revision_history[-1]
1179
other_revision = None
1180
repository = self.branch.repository
1181
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1183
new_basis_tree = self.branch.basis_tree()
1190
if (basis_tree.inventory.root is None and
1191
new_basis_tree.inventory.root is not None):
1192
self.set_root_id(new_basis_tree.inventory.root.file_id)
1195
# TODO - dedup parents list with things merged by pull ?
1196
# reuse the revisiontree we merged against to set the new
1198
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1199
# we have to pull the merge trees out again, because
1200
# merge_inner has set the ids. - this corner is not yet
1201
# layered well enough to prevent double handling.
1202
merges = self.get_parent_ids()[1:]
1203
parent_trees.extend([
1204
(parent, repository.revision_tree(parent)) for
1206
self.set_parent_trees(parent_trees)
1213
def put_file_bytes_non_atomic(self, file_id, bytes):
1214
"""See MutableTree.put_file_bytes_non_atomic."""
1215
stream = file(self.id2abspath(file_id), 'wb')
1220
# TODO: update the hashcache here ?
1223
"""Yield all unknown files in this WorkingTree.
1225
If there are any unknown directories then only the directory is
1226
returned, not all its children. But if there are unknown files
1227
under a versioned subdirectory, they are returned.
1229
Currently returned depth-first, sorted by name within directories.
1231
## TODO: Work from given directory downwards
1232
for path, dir_entry in self.inventory.directories():
1233
# mutter("search for unknowns in %r", path)
1234
dirabs = self.abspath(path)
1235
if not isdir(dirabs):
1236
# e.g. directory deleted
1240
for subf in os.listdir(dirabs):
1243
if subf not in dir_entry.children:
1244
subf_norm, can_access = osutils.normalized_filename(subf)
1245
if subf_norm != subf and can_access:
1246
if subf_norm not in dir_entry.children:
1247
fl.append(subf_norm)
1253
subp = pathjoin(path, subf)
1257
def ignored_files(self):
1258
"""Yield list of PATH, IGNORE_PATTERN"""
1259
for subp in self.extras():
1260
pat = self.is_ignored(subp)
1264
def get_ignore_list(self):
1265
"""Return list of ignore patterns.
1267
Cached in the Tree object after the first call.
1269
ignoreset = getattr(self, '_ignoreset', None)
1270
if ignoreset is not None:
1273
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1274
ignore_globs.update(ignores.get_runtime_ignores())
1275
ignore_globs.update(ignores.get_user_ignores())
1276
if self.has_filename(bzrlib.IGNORE_FILENAME):
1277
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1279
ignore_globs.update(ignores.parse_ignore_file(f))
1282
self._ignoreset = ignore_globs
1285
def _flush_ignore_list_cache(self):
1286
"""Resets the cached ignore list to force a cache rebuild."""
1287
self._ignoreset = None
1288
self._ignoreglobster = None
1290
def is_ignored(self, filename):
1291
r"""Check whether the filename matches an ignore pattern.
1293
Patterns containing '/' or '\' need to match the whole path;
1294
others match against only the last component.
1296
If the file is ignored, returns the pattern which caused it to
1297
be ignored, otherwise None. So this can simply be used as a
1298
boolean if desired."""
1299
if getattr(self, '_ignoreglobster', None) is None:
1300
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1301
return self._ignoreglobster.match(filename)
1303
def kind(self, file_id):
1304
return file_kind(self.id2abspath(file_id))
1306
def _comparison_data(self, entry, path):
1307
abspath = self.abspath(path)
1309
stat_value = os.lstat(abspath)
1311
if getattr(e, 'errno', None) == errno.ENOENT:
1318
mode = stat_value.st_mode
1319
kind = osutils.file_kind_from_stat_mode(mode)
1320
if not supports_executable():
1321
executable = entry.executable
1323
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1324
return kind, executable, stat_value
1326
def _file_size(self, entry, stat_value):
1327
return stat_value.st_size
1329
def last_revision(self):
1330
"""Return the last revision of the branch for this tree.
1332
This format tree does not support a separate marker for last-revision
1333
compared to the branch.
1335
See MutableTree.last_revision
1337
return self._last_revision()
1340
def _last_revision(self):
1341
"""helper for get_parent_ids."""
1342
return self.branch.last_revision()
1344
def is_locked(self):
1345
return self._control_files.is_locked()
1347
def lock_read(self):
1348
"""See Branch.lock_read, and WorkingTree.unlock."""
1349
self.branch.lock_read()
1351
return self._control_files.lock_read()
1353
self.branch.unlock()
1356
def lock_tree_write(self):
1357
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1358
self.branch.lock_read()
1360
return self._control_files.lock_write()
1362
self.branch.unlock()
1365
def lock_write(self):
1366
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1367
self.branch.lock_write()
1369
return self._control_files.lock_write()
1371
self.branch.unlock()
1374
def get_physical_lock_status(self):
1375
return self._control_files.get_physical_lock_status()
1377
def _basis_inventory_name(self):
1378
return 'basis-inventory-cache'
1380
@needs_tree_write_lock
1381
def set_last_revision(self, new_revision):
1382
"""Change the last revision in the working tree."""
1383
if self._change_last_revision(new_revision):
1384
self._cache_basis_inventory(new_revision)
1386
def _change_last_revision(self, new_revision):
1387
"""Template method part of set_last_revision to perform the change.
1389
This is used to allow WorkingTree3 instances to not affect branch
1390
when their last revision is set.
1392
if new_revision is None:
1393
self.branch.set_revision_history([])
1396
self.branch.generate_revision_history(new_revision)
1397
except errors.NoSuchRevision:
1398
# not present in the repo - dont try to set it deeper than the tip
1399
self.branch.set_revision_history([new_revision])
1402
def _write_basis_inventory(self, xml):
1403
"""Write the basis inventory XML to the basis-inventory file"""
1404
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1405
path = self._basis_inventory_name()
1407
self._control_files.put(path, sio)
1409
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1410
"""Create the text that will be saved in basis-inventory"""
1411
inventory.revision_id = revision_id
1412
return xml6.serializer_v6.write_inventory_to_string(inventory)
1414
def _cache_basis_inventory(self, new_revision):
1415
"""Cache new_revision as the basis inventory."""
1416
# TODO: this should allow the ready-to-use inventory to be passed in,
1417
# as commit already has that ready-to-use [while the format is the
1420
# this double handles the inventory - unpack and repack -
1421
# but is easier to understand. We can/should put a conditional
1422
# in here based on whether the inventory is in the latest format
1423
# - perhaps we should repack all inventories on a repository
1425
# the fast path is to copy the raw xml from the repository. If the
1426
# xml contains 'revision_id="', then we assume the right
1427
# revision_id is set. We must check for this full string, because a
1428
# root node id can legitimately look like 'revision_id' but cannot
1430
xml = self.branch.repository.get_inventory_xml(new_revision)
1431
firstline = xml.split('\n', 1)[0]
1432
if (not 'revision_id="' in firstline or
1433
'format="6"' not in firstline):
1434
inv = self.branch.repository.deserialise_inventory(
1436
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1437
self._write_basis_inventory(xml)
1438
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1441
def read_basis_inventory(self):
1442
"""Read the cached basis inventory."""
1443
path = self._basis_inventory_name()
1444
return self._control_files.get(path).read()
1447
def read_working_inventory(self):
1448
"""Read the working inventory.
1450
:raises errors.InventoryModified: read_working_inventory will fail
1451
when the current in memory inventory has been modified.
1453
# conceptually this should be an implementation detail of the tree.
1454
# XXX: Deprecate this.
1455
# ElementTree does its own conversion from UTF-8, so open in
1457
if self._inventory_is_modified:
1458
raise errors.InventoryModified(self)
1459
result = xml5.serializer_v5.read_inventory(
1460
self._control_files.get('inventory'))
1461
self._set_inventory(result, dirty=False)
1464
@needs_tree_write_lock
1465
def remove(self, files, verbose=False, to_file=None):
1466
"""Remove nominated files from the working inventory..
1468
This does not remove their text. This does not run on XXX on what? RBC
1470
TODO: Refuse to remove modified files unless --force is given?
1472
TODO: Do something useful with directories.
1474
TODO: Should this remove the text or not? Tough call; not
1475
removing may be useful and the user can just use use rm, and
1476
is the opposite of add. Removing it is consistent with most
1477
other tools. Maybe an option.
1479
## TODO: Normalize names
1480
## TODO: Remove nested loops; better scalability
1481
if isinstance(files, basestring):
1484
inv = self.inventory
1486
# do this before any modifications
1488
fid = inv.path2id(f)
1490
# TODO: Perhaps make this just a warning, and continue?
1491
# This tends to happen when
1492
raise NotVersionedError(path=f)
1494
# having remove it, it must be either ignored or unknown
1495
if self.is_ignored(f):
1499
textui.show_status(new_status, inv[fid].kind, f,
1503
self._write_inventory(inv)
1505
@needs_tree_write_lock
1506
def revert(self, filenames, old_tree=None, backups=True,
1507
pb=DummyProgress()):
1508
from bzrlib.conflicts import resolve
1509
if old_tree is None:
1510
old_tree = self.basis_tree()
1511
conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1512
if not len(filenames):
1513
self.set_parent_ids(self.get_parent_ids()[:1])
1516
resolve(self, filenames, ignore_misses=True)
1519
# XXX: This method should be deprecated in favour of taking in a proper
1520
# new Inventory object.
1521
@needs_tree_write_lock
1522
def set_inventory(self, new_inventory_list):
1523
from bzrlib.inventory import (Inventory,
1528
inv = Inventory(self.get_root_id())
1529
for path, file_id, parent, kind in new_inventory_list:
1530
name = os.path.basename(path)
1533
# fixme, there should be a factory function inv,add_??
1534
if kind == 'directory':
1535
inv.add(InventoryDirectory(file_id, name, parent))
1536
elif kind == 'file':
1537
inv.add(InventoryFile(file_id, name, parent))
1538
elif kind == 'symlink':
1539
inv.add(InventoryLink(file_id, name, parent))
1541
raise BzrError("unknown kind %r" % kind)
1542
self._write_inventory(inv)
1544
@needs_tree_write_lock
1545
def set_root_id(self, file_id):
1546
"""Set the root id for this tree."""
1549
symbol_versioning.warn(symbol_versioning.zero_twelve
1550
% 'WorkingTree.set_root_id with fileid=None',
1554
inv = self._inventory
1555
orig_root_id = inv.root.file_id
1556
# TODO: it might be nice to exit early if there was nothing
1557
# to do, saving us from trigger a sync on unlock.
1558
self._inventory_is_modified = True
1559
# we preserve the root inventory entry object, but
1560
# unlinkit from the byid index
1561
del inv._byid[inv.root.file_id]
1562
inv.root.file_id = file_id
1563
# and link it into the index with the new changed id.
1564
inv._byid[inv.root.file_id] = inv.root
1565
# and finally update all children to reference the new id.
1566
# XXX: this should be safe to just look at the root.children
1567
# list, not the WHOLE INVENTORY.
1570
if entry.parent_id == orig_root_id:
1571
entry.parent_id = inv.root.file_id
1574
"""See Branch.unlock.
1576
WorkingTree locking just uses the Branch locking facilities.
1577
This is current because all working trees have an embedded branch
1578
within them. IF in the future, we were to make branch data shareable
1579
between multiple working trees, i.e. via shared storage, then we
1580
would probably want to lock both the local tree, and the branch.
1582
raise NotImplementedError(self.unlock)
1585
"""Update a working tree along its branch.
1587
This will update the branch if its bound too, which means we have
1588
multiple trees involved:
1590
- The new basis tree of the master.
1591
- The old basis tree of the branch.
1592
- The old basis tree of the working tree.
1593
- The current working tree state.
1595
Pathologically, all three may be different, and non-ancestors of each
1596
other. Conceptually we want to:
1598
- Preserve the wt.basis->wt.state changes
1599
- Transform the wt.basis to the new master basis.
1600
- Apply a merge of the old branch basis to get any 'local' changes from
1602
- Restore the wt.basis->wt.state changes.
1604
There isn't a single operation at the moment to do that, so we:
1605
- Merge current state -> basis tree of the master w.r.t. the old tree
1607
- Do a 'normal' merge of the old branch basis if it is relevant.
1609
if self.branch.get_master_branch() is not None:
1611
update_branch = True
1613
self.lock_tree_write()
1614
update_branch = False
1617
old_tip = self.branch.update()
1620
return self._update_tree(old_tip)
1624
@needs_tree_write_lock
1625
def _update_tree(self, old_tip=None):
1626
"""Update a tree to the master branch.
1628
:param old_tip: if supplied, the previous tip revision the branch,
1629
before it was changed to the master branch's tip.
1631
# here if old_tip is not None, it is the old tip of the branch before
1632
# it was updated from the master branch. This should become a pending
1633
# merge in the working tree to preserve the user existing work. we
1634
# cant set that until we update the working trees last revision to be
1635
# one from the new branch, because it will just get absorbed by the
1636
# parent de-duplication logic.
1638
# We MUST save it even if an error occurs, because otherwise the users
1639
# local work is unreferenced and will appear to have been lost.
1643
last_rev = self.get_parent_ids()[0]
1646
if last_rev != self.branch.last_revision():
1647
# merge tree state up to new branch tip.
1648
basis = self.basis_tree()
1649
to_tree = self.branch.basis_tree()
1650
if basis.inventory.root is None:
1651
self.set_root_id(to_tree.inventory.root.file_id)
1652
result += merge.merge_inner(
1657
# TODO - dedup parents list with things merged by pull ?
1658
# reuse the tree we've updated to to set the basis:
1659
parent_trees = [(self.branch.last_revision(), to_tree)]
1660
merges = self.get_parent_ids()[1:]
1661
# Ideally we ask the tree for the trees here, that way the working
1662
# tree can decide whether to give us teh entire tree or give us a
1663
# lazy initialised tree. dirstate for instance will have the trees
1664
# in ram already, whereas a last-revision + basis-inventory tree
1665
# will not, but also does not need them when setting parents.
1666
for parent in merges:
1667
parent_trees.append(
1668
(parent, self.branch.repository.revision_tree(parent)))
1669
if old_tip is not None:
1670
parent_trees.append(
1671
(old_tip, self.branch.repository.revision_tree(old_tip)))
1672
self.set_parent_trees(parent_trees)
1673
last_rev = parent_trees[0][0]
1675
# the working tree had the same last-revision as the master
1676
# branch did. We may still have pivot local work from the local
1677
# branch into old_tip:
1678
if old_tip is not None:
1679
self.add_parent_tree_id(old_tip)
1680
if old_tip and old_tip != last_rev:
1681
# our last revision was not the prior branch last revision
1682
# and we have converted that last revision to a pending merge.
1683
# base is somewhere between the branch tip now
1684
# and the now pending merge
1685
from bzrlib.revision import common_ancestor
1687
base_rev_id = common_ancestor(self.branch.last_revision(),
1689
self.branch.repository)
1690
except errors.NoCommonAncestor:
1692
base_tree = self.branch.repository.revision_tree(base_rev_id)
1693
other_tree = self.branch.repository.revision_tree(old_tip)
1694
result += merge.merge_inner(
1701
@needs_tree_write_lock
1702
def _write_inventory(self, inv):
1703
"""Write inventory as the current inventory."""
1704
self._set_inventory(inv, dirty=True)
1707
def set_conflicts(self, arg):
1708
raise UnsupportedOperation(self.set_conflicts, self)
1710
def add_conflicts(self, arg):
1711
raise UnsupportedOperation(self.add_conflicts, self)
1714
def conflicts(self):
1715
conflicts = _mod_conflicts.ConflictList()
1716
for conflicted in self._iter_conflicts():
1719
if file_kind(self.abspath(conflicted)) != "file":
1721
except errors.NoSuchFile:
1724
for suffix in ('.THIS', '.OTHER'):
1726
kind = file_kind(self.abspath(conflicted+suffix))
1729
except errors.NoSuchFile:
1733
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1734
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1736
file_id=self.path2id(conflicted)))
1740
class WorkingTree2(WorkingTree):
1741
"""This is the Format 2 working tree.
1743
This was the first weave based working tree.
1744
- uses os locks for locking.
1745
- uses the branch last-revision.
1748
def lock_tree_write(self):
1749
"""See WorkingTree.lock_tree_write().
1751
In Format2 WorkingTrees we have a single lock for the branch and tree
1752
so lock_tree_write() degrades to lock_write().
1754
self.branch.lock_write()
1756
return self._control_files.lock_write()
1758
self.branch.unlock()
1762
# we share control files:
1763
if self._control_files._lock_count == 3:
1764
# _inventory_is_modified is always False during a read lock.
1765
if self._inventory_is_modified:
1767
if self._hashcache.needs_write:
1768
self._hashcache.write()
1769
# reverse order of locking.
1771
return self._control_files.unlock()
1773
self.branch.unlock()
1776
class WorkingTree3(WorkingTree):
1777
"""This is the Format 3 working tree.
1779
This differs from the base WorkingTree by:
1780
- having its own file lock
1781
- having its own last-revision property.
1783
This is new in bzr 0.8
1787
def _last_revision(self):
1788
"""See Mutable.last_revision."""
1790
return self._control_files.get_utf8('last-revision').read()
1794
def _change_last_revision(self, revision_id):
1795
"""See WorkingTree._change_last_revision."""
1796
if revision_id is None or revision_id == NULL_REVISION:
1798
self._control_files._transport.delete('last-revision')
1799
except errors.NoSuchFile:
1803
self._control_files.put_utf8('last-revision', revision_id)
1806
@needs_tree_write_lock
1807
def set_conflicts(self, conflicts):
1808
self._put_rio('conflicts', conflicts.to_stanzas(),
1811
@needs_tree_write_lock
1812
def add_conflicts(self, new_conflicts):
1813
conflict_set = set(self.conflicts())
1814
conflict_set.update(set(list(new_conflicts)))
1815
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1816
key=_mod_conflicts.Conflict.sort_key)))
1819
def conflicts(self):
1821
confile = self._control_files.get('conflicts')
1823
return _mod_conflicts.ConflictList()
1825
if confile.next() != CONFLICT_HEADER_1 + '\n':
1826
raise ConflictFormatError()
1827
except StopIteration:
1828
raise ConflictFormatError()
1829
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
1832
if self._control_files._lock_count == 1:
1833
# _inventory_is_modified is always False during a read lock.
1834
if self._inventory_is_modified:
1836
if self._hashcache.needs_write:
1837
self._hashcache.write()
1838
# reverse order of locking.
1840
return self._control_files.unlock()
1842
self.branch.unlock()
1845
def get_conflicted_stem(path):
1846
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1847
if path.endswith(suffix):
1848
return path[:-len(suffix)]
1850
@deprecated_function(zero_eight)
1851
def is_control_file(filename):
1852
"""See WorkingTree.is_control_filename(filename)."""
1853
## FIXME: better check
1854
filename = normpath(filename)
1855
while filename != '':
1856
head, tail = os.path.split(filename)
1857
## mutter('check %r for control file' % ((head, tail),))
1860
if filename == head:
1866
class WorkingTreeFormat(object):
1867
"""An encapsulation of the initialization and open routines for a format.
1869
Formats provide three things:
1870
* An initialization routine,
1874
Formats are placed in an dict by their format string for reference
1875
during workingtree opening. Its not required that these be instances, they
1876
can be classes themselves with class methods - it simply depends on
1877
whether state is needed for a given format or not.
1879
Once a format is deprecated, just deprecate the initialize and open
1880
methods on the format class. Do not deprecate the object, as the
1881
object will be created every time regardless.
1884
_default_format = None
1885
"""The default format used for new trees."""
1888
"""The known formats."""
1891
def find_format(klass, a_bzrdir):
1892
"""Return the format for the working tree object in a_bzrdir."""
1894
transport = a_bzrdir.get_workingtree_transport(None)
1895
format_string = transport.get("format").read()
1896
return klass._formats[format_string]
1898
raise errors.NoWorkingTree(base=transport.base)
1900
raise errors.UnknownFormatError(format=format_string)
1903
def get_default_format(klass):
1904
"""Return the current default format."""
1905
return klass._default_format
1907
def get_format_string(self):
1908
"""Return the ASCII format string that identifies this format."""
1909
raise NotImplementedError(self.get_format_string)
1911
def get_format_description(self):
1912
"""Return the short description for this format."""
1913
raise NotImplementedError(self.get_format_description)
1915
def is_supported(self):
1916
"""Is this format supported?
1918
Supported formats can be initialized and opened.
1919
Unsupported formats may not support initialization or committing or
1920
some other features depending on the reason for not being supported.
1925
def register_format(klass, format):
1926
klass._formats[format.get_format_string()] = format
1929
def set_default_format(klass, format):
1930
klass._default_format = format
1933
def unregister_format(klass, format):
1934
assert klass._formats[format.get_format_string()] is format
1935
del klass._formats[format.get_format_string()]
1939
class WorkingTreeFormat2(WorkingTreeFormat):
1940
"""The second working tree format.
1942
This format modified the hash cache from the format 1 hash cache.
1945
def get_format_description(self):
1946
"""See WorkingTreeFormat.get_format_description()."""
1947
return "Working tree format 2"
1949
def stub_initialize_remote(self, control_files):
1950
"""As a special workaround create critical control files for a remote working tree
1952
This ensures that it can later be updated and dealt with locally,
1953
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1954
no working tree. (See bug #43064).
1958
xml5.serializer_v5.write_inventory(inv, sio)
1960
control_files.put('inventory', sio)
1962
control_files.put_utf8('pending-merges', '')
1965
def initialize(self, a_bzrdir, revision_id=None):
1966
"""See WorkingTreeFormat.initialize()."""
1967
if not isinstance(a_bzrdir.transport, LocalTransport):
1968
raise errors.NotLocalUrl(a_bzrdir.transport.base)
1969
branch = a_bzrdir.open_branch()
1970
if revision_id is not None:
1973
revision_history = branch.revision_history()
1975
position = revision_history.index(revision_id)
1977
raise errors.NoSuchRevision(branch, revision_id)
1978
branch.set_revision_history(revision_history[:position + 1])
1981
revision = branch.last_revision()
1983
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1989
basis_tree = branch.repository.revision_tree(revision)
1990
if basis_tree.inventory.root is not None:
1991
wt.set_root_id(basis_tree.inventory.root.file_id)
1992
# set the parent list and cache the basis tree.
1993
wt.set_parent_trees([(revision, basis_tree)])
1994
transform.build_tree(basis_tree, wt)
1998
super(WorkingTreeFormat2, self).__init__()
1999
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2001
def open(self, a_bzrdir, _found=False):
2002
"""Return the WorkingTree object for a_bzrdir
2004
_found is a private parameter, do not use it. It is used to indicate
2005
if format probing has already been done.
2008
# we are being called directly and must probe.
2009
raise NotImplementedError
2010
if not isinstance(a_bzrdir.transport, LocalTransport):
2011
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2012
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2018
class WorkingTreeFormat3(WorkingTreeFormat):
2019
"""The second working tree format updated to record a format marker.
2022
- exists within a metadir controlling .bzr
2023
- includes an explicit version marker for the workingtree control
2024
files, separate from the BzrDir format
2025
- modifies the hash cache format
2027
- uses a LockDir to guard access for writes.
2030
def get_format_string(self):
2031
"""See WorkingTreeFormat.get_format_string()."""
2032
return "Bazaar-NG Working Tree format 3"
2034
def get_format_description(self):
2035
"""See WorkingTreeFormat.get_format_description()."""
2036
return "Working tree format 3"
2038
_lock_file_name = 'lock'
2039
_lock_class = LockDir
2041
def _open_control_files(self, a_bzrdir):
2042
transport = a_bzrdir.get_workingtree_transport(None)
2043
return LockableFiles(transport, self._lock_file_name,
2046
def initialize(self, a_bzrdir, revision_id=None):
2047
"""See WorkingTreeFormat.initialize().
2049
revision_id allows creating a working tree at a different
2050
revision than the branch is at.
2052
if not isinstance(a_bzrdir.transport, LocalTransport):
2053
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2054
transport = a_bzrdir.get_workingtree_transport(self)
2055
control_files = self._open_control_files(a_bzrdir)
2056
control_files.create_lock()
2057
control_files.lock_write()
2058
control_files.put_utf8('format', self.get_format_string())
2059
branch = a_bzrdir.open_branch()
2060
if revision_id is None:
2061
revision_id = branch.last_revision()
2062
# WorkingTree3 can handle an inventory which has a unique root id.
2063
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2064
# those trees. And because there isn't a format bump inbetween, we
2065
# are maintaining compatibility with older clients.
2066
# inv = Inventory(root_id=gen_root_id())
2068
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2074
_control_files=control_files)
2075
wt.lock_tree_write()
2077
basis_tree = branch.repository.revision_tree(revision_id)
2078
# only set an explicit root id if there is one to set.
2079
if basis_tree.inventory.root is not None:
2080
wt.set_root_id(basis_tree.inventory.root.file_id)
2081
if revision_id == NULL_REVISION:
2082
wt.set_parent_trees([])
2084
wt.set_parent_trees([(revision_id, basis_tree)])
2085
transform.build_tree(basis_tree, wt)
2087
# Unlock in this order so that the unlock-triggers-flush in
2088
# WorkingTree is given a chance to fire.
2089
control_files.unlock()
2094
super(WorkingTreeFormat3, self).__init__()
2095
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2097
def open(self, a_bzrdir, _found=False):
2098
"""Return the WorkingTree object for a_bzrdir
2100
_found is a private parameter, do not use it. It is used to indicate
2101
if format probing has already been done.
2104
# we are being called directly and must probe.
2105
raise NotImplementedError
2106
if not isinstance(a_bzrdir.transport, LocalTransport):
2107
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2108
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2110
def _open(self, a_bzrdir, control_files):
2111
"""Open the tree itself.
2113
:param a_bzrdir: the dir for the tree.
2114
:param control_files: the control files for the tree.
2116
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2120
_control_files=control_files)
2123
return self.get_format_string()
2126
# formats which have no format string are not discoverable
2127
# and not independently creatable, so are not registered.
2128
__default_format = WorkingTreeFormat3()
2129
WorkingTreeFormat.register_format(__default_format)
2130
WorkingTreeFormat.set_default_format(__default_format)
2131
_legacy_formats = [WorkingTreeFormat2(),
2135
class WorkingTreeTestProviderAdapter(object):
2136
"""A tool to generate a suite testing multiple workingtree formats at once.
2138
This is done by copying the test once for each transport and injecting
2139
the transport_server, transport_readonly_server, and workingtree_format
2140
classes into each copy. Each copy is also given a new id() to make it
2144
def __init__(self, transport_server, transport_readonly_server, formats):
2145
self._transport_server = transport_server
2146
self._transport_readonly_server = transport_readonly_server
2147
self._formats = formats
2149
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2150
"""Clone test for adaption."""
2151
new_test = deepcopy(test)
2152
new_test.transport_server = self._transport_server
2153
new_test.transport_readonly_server = self._transport_readonly_server
2154
new_test.bzrdir_format = bzrdir_format
2155
new_test.workingtree_format = workingtree_format
2156
def make_new_test_id():
2157
new_id = "%s(%s)" % (test.id(), variation)
2158
return lambda: new_id
2159
new_test.id = make_new_test_id()
2162
def adapt(self, test):
2163
from bzrlib.tests import TestSuite
2164
result = TestSuite()
2165
for workingtree_format, bzrdir_format in self._formats:
2166
new_test = self._clone_test(
2169
workingtree_format, workingtree_format.__class__.__name__)
2170
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
