1
# Copyright (C) 2005, 2006, 2007 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(), """
44
from bisect import bisect_left
46
from copy import deepcopy
59
conflicts as _mod_conflicts,
78
from bzrlib.transport import get_transport
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
from bzrlib import symbol_versioning
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
86
from bzrlib.lockable_files import LockableFiles, TransportLock
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib.osutils import (
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
@deprecated_function(zero_thirteen)
122
def gen_file_id(name):
123
"""Return new file id for the basename 'name'.
125
Use bzrlib.generate_ids.gen_file_id() instead
127
return generate_ids.gen_file_id(name)
130
@deprecated_function(zero_thirteen)
132
"""Return a new tree-root file id.
134
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
136
return generate_ids.gen_root_id()
139
class TreeEntry(object):
140
"""An entry that implements the minimum interface used by commands.
142
This needs further inspection, it may be better to have
143
InventoryEntries without ids - though that seems wrong. For now,
144
this is a parallel hierarchy to InventoryEntry, and needs to become
145
one of several things: decorates to that hierarchy, children of, or
147
Another note is that these objects are currently only used when there is
148
no InventoryEntry available - i.e. for unversioned objects.
149
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
152
def __eq__(self, other):
153
# yes, this us ugly, TODO: best practice __eq__ style.
154
return (isinstance(other, TreeEntry)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class TreeDirectory(TreeEntry):
162
"""See TreeEntry. This is a directory in a working tree."""
164
def __eq__(self, other):
165
return (isinstance(other, TreeDirectory)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeFile(TreeEntry):
173
"""See TreeEntry. This is a regular file in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeFile)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeLink(TreeEntry):
184
"""See TreeEntry. This is a symlink in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeLink)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class WorkingTree(bzrlib.mutabletree.MutableTree):
195
"""Working copy tree.
197
The inventory is held in the `Branch` working-inventory, and the
198
files are in a directory on disk.
200
It is possible for a `WorkingTree` to have a filename which is
201
not listed in the Inventory and vice versa.
204
def __init__(self, basedir='.',
205
branch=DEPRECATED_PARAMETER,
211
"""Construct a WorkingTree instance. This is not a public API.
213
:param branch: A branch to override probing for the branch.
215
self._format = _format
216
self.bzrdir = _bzrdir
218
raise errors.BzrError("Please use bzrdir.open_workingtree or "
219
"WorkingTree.open() to obtain a WorkingTree.")
220
assert isinstance(basedir, basestring), \
221
"base directory %r is not a string" % basedir
222
basedir = safe_unicode(basedir)
223
mutter("opening working tree %r", basedir)
224
if deprecated_passed(branch):
225
self._branch = branch
227
self._branch = self.bzrdir.open_branch()
228
self.basedir = realpath(basedir)
229
# if branch is at our basedir and is a format 6 or less
230
if isinstance(self._format, WorkingTreeFormat2):
231
# share control object
232
self._control_files = self.branch.control_files
234
# assume all other formats have their own control files.
235
assert isinstance(_control_files, LockableFiles), \
236
"_control_files must be a LockableFiles, not %r" \
238
self._control_files = _control_files
239
# update the whole cache up front and write to disk if anything changed;
240
# in the future we might want to do this more selectively
241
# two possible ways offer themselves : in self._unlock, write the cache
242
# if needed, or, when the cache sees a change, append it to the hash
243
# cache file, and have the parser take the most recent entry for a
245
wt_trans = self.bzrdir.get_workingtree_transport(None)
246
cache_filename = wt_trans.local_abspath('stat-cache')
247
self._hashcache = hashcache.HashCache(basedir, cache_filename,
248
self._control_files._file_mode)
251
# is this scan needed ? it makes things kinda slow.
258
if _inventory is None:
259
# This will be acquired on lock_read() or lock_write()
260
self._inventory_is_modified = False
261
self._inventory = None
263
# the caller of __init__ has provided an inventory,
264
# we assume they know what they are doing - as its only
265
# the Format factory and creation methods that are
266
# permitted to do this.
267
self._set_inventory(_inventory, dirty=False)
270
fget=lambda self: self._branch,
271
doc="""The branch this WorkingTree is connected to.
273
This cannot be set - it is reflective of the actual disk structure
274
the working tree has been constructed from.
277
def break_lock(self):
278
"""Break a lock if one is present from another instance.
280
Uses the ui factory to ask for confirmation if the lock may be from
283
This will probe the repository for its lock as well.
285
self._control_files.break_lock()
286
self.branch.break_lock()
288
def requires_rich_root(self):
289
return self._format.requires_rich_root
291
def supports_tree_reference(self):
294
def _set_inventory(self, inv, dirty):
295
"""Set the internal cached inventory.
297
:param inv: The inventory to set.
298
:param dirty: A boolean indicating whether the inventory is the same
299
logical inventory as whats on disk. If True the inventory is not
300
the same and should be written to disk or data will be lost, if
301
False then the inventory is the same as that on disk and any
302
serialisation would be unneeded overhead.
304
assert inv.root is not None
305
self._inventory = inv
306
self._inventory_is_modified = dirty
309
def open(path=None, _unsupported=False):
310
"""Open an existing working tree at path.
314
path = os.path.getcwdu()
315
control = bzrdir.BzrDir.open(path, _unsupported)
316
return control.open_workingtree(_unsupported)
319
def open_containing(path=None):
320
"""Open an existing working tree which has its root about path.
322
This probes for a working tree at path and searches upwards from there.
324
Basically we keep looking up until we find the control directory or
325
run into /. If there isn't one, raises NotBranchError.
326
TODO: give this a new exception.
327
If there is one, it is returned, along with the unused portion of path.
329
:return: The WorkingTree that contains 'path', and the rest of path
332
path = osutils.getcwd()
333
control, relpath = bzrdir.BzrDir.open_containing(path)
335
return control.open_workingtree(), relpath
338
def open_downlevel(path=None):
339
"""Open an unsupported working tree.
341
Only intended for advanced situations like upgrading part of a bzrdir.
343
return WorkingTree.open(path, _unsupported=True)
345
# should be deprecated - this is slow and in any case treating them as a
346
# container is (we now know) bad style -- mbp 20070302
347
## @deprecated_method(zero_fifteen)
349
"""Iterate through file_ids for this tree.
351
file_ids are in a WorkingTree if they are in the working inventory
352
and the working file exists.
354
inv = self._inventory
355
for path, ie in inv.iter_entries():
356
if osutils.lexists(self.abspath(path)):
360
return "<%s of %s>" % (self.__class__.__name__,
361
getattr(self, 'basedir', None))
363
def abspath(self, filename):
364
return pathjoin(self.basedir, filename)
366
def basis_tree(self):
367
"""Return RevisionTree for the current last revision.
369
If the left most parent is a ghost then the returned tree will be an
370
empty tree - one obtained by calling repository.revision_tree(None).
373
revision_id = self.get_parent_ids()[0]
375
# no parents, return an empty revision tree.
376
# in the future this should return the tree for
377
# 'empty:' - the implicit root empty tree.
378
return self.branch.repository.revision_tree(None)
380
return self.revision_tree(revision_id)
381
except errors.NoSuchRevision:
383
# No cached copy available, retrieve from the repository.
384
# FIXME? RBC 20060403 should we cache the inventory locally
387
return self.branch.repository.revision_tree(revision_id)
388
except errors.RevisionNotPresent:
389
# the basis tree *may* be a ghost or a low level error may have
390
# occured. If the revision is present, its a problem, if its not
392
if self.branch.repository.has_revision(revision_id):
394
# the basis tree is a ghost so return an empty tree.
395
return self.branch.repository.revision_tree(None)
398
@deprecated_method(zero_eight)
399
def create(branch, directory):
400
"""Create a workingtree for branch at directory.
402
If existing_directory already exists it must have a .bzr directory.
403
If it does not exist, it will be created.
405
This returns a new WorkingTree object for the new checkout.
407
TODO FIXME RBC 20060124 when we have checkout formats in place this
408
should accept an optional revisionid to checkout [and reject this if
409
checking out into the same dir as a pre-checkout-aware branch format.]
411
XXX: When BzrDir is present, these should be created through that
414
warnings.warn('delete WorkingTree.create', stacklevel=3)
415
transport = get_transport(directory)
416
if branch.bzrdir.root_transport.base == transport.base:
418
return branch.bzrdir.create_workingtree()
419
# different directory,
420
# create a branch reference
421
# and now a working tree.
422
raise NotImplementedError
425
@deprecated_method(zero_eight)
426
def create_standalone(directory):
427
"""Create a checkout and a branch and a repo at directory.
429
Directory must exist and be empty.
431
please use BzrDir.create_standalone_workingtree
433
return bzrdir.BzrDir.create_standalone_workingtree(directory)
435
def relpath(self, path):
436
"""Return the local path portion from a given path.
438
The path may be absolute or relative. If its a relative path it is
439
interpreted relative to the python current working directory.
441
return osutils.relpath(self.basedir, path)
443
def has_filename(self, filename):
444
return osutils.lexists(self.abspath(filename))
446
def get_file(self, file_id):
447
file_id = osutils.safe_file_id(file_id)
448
return self.get_file_byname(self.id2path(file_id))
450
def get_file_text(self, file_id):
451
file_id = osutils.safe_file_id(file_id)
452
return self.get_file(file_id).read()
454
def get_file_byname(self, filename):
455
return file(self.abspath(filename), 'rb')
458
def annotate_iter(self, file_id):
459
"""See Tree.annotate_iter
461
This implementation will use the basis tree implementation if possible.
462
Lines not in the basis are attributed to CURRENT_REVISION
464
If there are pending merges, lines added by those merges will be
465
incorrectly attributed to CURRENT_REVISION (but after committing, the
466
attribution will be correct).
468
file_id = osutils.safe_file_id(file_id)
469
basis = self.basis_tree()
472
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
473
require_versioned=True).next()
474
changed_content, kind = changes[2], changes[6]
475
if not changed_content:
476
return basis.annotate_iter(file_id)
480
if kind[0] != 'file':
483
old_lines = list(basis.annotate_iter(file_id))
485
for tree in self.branch.repository.revision_trees(
486
self.get_parent_ids()[1:]):
487
if file_id not in tree:
489
old.append(list(tree.annotate_iter(file_id)))
490
return annotate.reannotate(old, self.get_file(file_id).readlines(),
495
def get_parent_ids(self):
496
"""See Tree.get_parent_ids.
498
This implementation reads the pending merges list and last_revision
499
value and uses that to decide what the parents list should be.
501
last_rev = self._last_revision()
507
merges_file = self._control_files.get('pending-merges')
508
except errors.NoSuchFile:
511
for l in merges_file.readlines():
512
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
513
parents.append(revision_id)
517
def get_root_id(self):
518
"""Return the id of this trees root"""
519
return self._inventory.root.file_id
521
def _get_store_filename(self, file_id):
522
## XXX: badly named; this is not in the store at all
523
file_id = osutils.safe_file_id(file_id)
524
return self.abspath(self.id2path(file_id))
527
def clone(self, to_bzrdir, revision_id=None):
528
"""Duplicate this working tree into to_bzr, including all state.
530
Specifically modified files are kept as modified, but
531
ignored and unknown files are discarded.
533
If you want to make a new line of development, see bzrdir.sprout()
536
If not None, the cloned tree will have its last revision set to
537
revision, and and difference between the source trees last revision
538
and this one merged in.
540
# assumes the target bzr dir format is compatible.
541
result = self._format.initialize(to_bzrdir)
542
self.copy_content_into(result, revision_id)
546
def copy_content_into(self, tree, revision_id=None):
547
"""Copy the current content and user files of this tree into tree."""
548
tree.set_root_id(self.get_root_id())
549
if revision_id is None:
550
merge.transform_tree(tree, self)
552
# TODO now merge from tree.last_revision to revision (to preserve
553
# user local changes)
554
merge.transform_tree(tree, self)
555
tree.set_parent_ids([revision_id])
557
def id2abspath(self, file_id):
558
file_id = osutils.safe_file_id(file_id)
559
return self.abspath(self.id2path(file_id))
561
def has_id(self, file_id):
562
# files that have been deleted are excluded
563
file_id = osutils.safe_file_id(file_id)
565
if not inv.has_id(file_id):
567
path = inv.id2path(file_id)
568
return osutils.lexists(self.abspath(path))
570
def has_or_had_id(self, file_id):
571
file_id = osutils.safe_file_id(file_id)
572
if file_id == self.inventory.root.file_id:
574
return self.inventory.has_id(file_id)
576
__contains__ = has_id
578
def get_file_size(self, file_id):
579
file_id = osutils.safe_file_id(file_id)
580
return os.path.getsize(self.id2abspath(file_id))
583
def get_file_sha1(self, file_id, path=None, stat_value=None):
584
file_id = osutils.safe_file_id(file_id)
586
path = self._inventory.id2path(file_id)
587
return self._hashcache.get_sha1(path, stat_value)
589
def get_file_mtime(self, file_id, path=None):
590
file_id = osutils.safe_file_id(file_id)
592
path = self.inventory.id2path(file_id)
593
return os.lstat(self.abspath(path)).st_mtime
595
if not supports_executable():
596
def is_executable(self, file_id, path=None):
597
file_id = osutils.safe_file_id(file_id)
598
return self._inventory[file_id].executable
600
def is_executable(self, file_id, path=None):
602
file_id = osutils.safe_file_id(file_id)
603
path = self.id2path(file_id)
604
mode = os.lstat(self.abspath(path)).st_mode
605
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
607
@needs_tree_write_lock
608
def _add(self, files, ids, kinds):
609
"""See MutableTree._add."""
610
# TODO: Re-adding a file that is removed in the working copy
611
# should probably put it back with the previous ID.
612
# the read and write working inventory should not occur in this
613
# function - they should be part of lock_write and unlock.
614
inv = self.read_working_inventory()
615
for f, file_id, kind in zip(files, ids, kinds):
616
assert kind is not None
618
inv.add_path(f, kind=kind)
620
file_id = osutils.safe_file_id(file_id)
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 errors.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, allow_leftmost_as_ghost=len(parents) > 1
650
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_bytes('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
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
731
self._check_parents_for_ghosts(revision_ids,
732
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
734
if len(revision_ids) > 0:
735
self.set_last_revision(revision_ids[0])
737
self.set_last_revision(None)
739
self._set_merges_from_parent_ids(revision_ids)
741
@needs_tree_write_lock
742
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
743
"""See MutableTree.set_parent_trees."""
744
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
746
self._check_parents_for_ghosts(parent_ids,
747
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
749
if len(parent_ids) == 0:
750
leftmost_parent_id = None
751
leftmost_parent_tree = None
753
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
755
if self._change_last_revision(leftmost_parent_id):
756
if leftmost_parent_tree is None:
757
# If we don't have a tree, fall back to reading the
758
# parent tree from the repository.
759
self._cache_basis_inventory(leftmost_parent_id)
761
inv = leftmost_parent_tree.inventory
762
xml = self._create_basis_xml_from_inventory(
763
leftmost_parent_id, inv)
764
self._write_basis_inventory(xml)
765
self._set_merges_from_parent_ids(parent_ids)
767
@needs_tree_write_lock
768
def set_pending_merges(self, rev_list):
769
parents = self.get_parent_ids()
770
leftmost = parents[:1]
771
new_parents = leftmost + rev_list
772
self.set_parent_ids(new_parents)
774
@needs_tree_write_lock
775
def set_merge_modified(self, modified_hashes):
777
for file_id, hash in modified_hashes.iteritems():
778
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
779
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
781
def _put_rio(self, filename, stanzas, header):
782
self._must_be_locked()
783
my_file = rio_file(stanzas, header)
784
self._control_files.put(filename, my_file)
786
@needs_write_lock # because merge pulls data into the branch.
787
def merge_from_branch(self, branch, to_revision=None):
788
"""Merge from a branch into this working tree.
790
:param branch: The branch to merge from.
791
:param to_revision: If non-None, the merge will merge to to_revision,
792
but not beyond it. to_revision does not need to be in the history
793
of the branch when it is supplied. If None, to_revision defaults to
794
branch.last_revision().
796
from bzrlib.merge import Merger, Merge3Merger
797
pb = bzrlib.ui.ui_factory.nested_progress_bar()
799
merger = Merger(self.branch, this_tree=self, pb=pb)
800
merger.pp = ProgressPhase("Merge phase", 5, pb)
801
merger.pp.next_phase()
802
# check that there are no
804
merger.check_basis(check_clean=True, require_commits=False)
805
if to_revision is None:
806
to_revision = branch.last_revision()
808
to_revision = osutils.safe_revision_id(to_revision)
809
merger.other_rev_id = to_revision
810
if merger.other_rev_id is None:
811
raise error.NoCommits(branch)
812
self.branch.fetch(branch, last_revision=merger.other_rev_id)
813
merger.other_basis = merger.other_rev_id
814
merger.other_tree = self.branch.repository.revision_tree(
816
merger.other_branch = branch
817
merger.pp.next_phase()
819
if merger.base_rev_id == merger.other_rev_id:
820
raise errors.PointlessMerge
821
merger.backup_files = False
822
merger.merge_type = Merge3Merger
823
merger.set_interesting_files(None)
824
merger.show_base = False
825
merger.reprocess = False
826
conflicts = merger.do_merge()
833
def merge_modified(self):
834
"""Return a dictionary of files modified by a merge.
836
The list is initialized by WorkingTree.set_merge_modified, which is
837
typically called after we make some automatic updates to the tree
840
This returns a map of file_id->sha1, containing only files which are
841
still in the working inventory and have that text hash.
844
hashfile = self._control_files.get('merge-hashes')
845
except errors.NoSuchFile:
849
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
850
raise errors.MergeModifiedFormatError()
851
except StopIteration:
852
raise errors.MergeModifiedFormatError()
853
for s in RioReader(hashfile):
854
# RioReader reads in Unicode, so convert file_ids back to utf8
855
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
856
if file_id not in self.inventory:
858
text_hash = s.get("hash")
859
if text_hash == self.get_file_sha1(file_id):
860
merge_hashes[file_id] = text_hash
864
def mkdir(self, path, file_id=None):
865
"""See MutableTree.mkdir()."""
867
file_id = generate_ids.gen_file_id(os.path.basename(path))
868
os.mkdir(self.abspath(path))
869
self.add(path, file_id, 'directory')
872
def get_symlink_target(self, file_id):
873
file_id = osutils.safe_file_id(file_id)
874
return os.readlink(self.id2abspath(file_id))
877
def subsume(self, other_tree):
878
def add_children(inventory, entry):
879
for child_entry in entry.children.values():
880
inventory._byid[child_entry.file_id] = child_entry
881
if child_entry.kind == 'directory':
882
add_children(inventory, child_entry)
883
if other_tree.get_root_id() == self.get_root_id():
884
raise errors.BadSubsumeSource(self, other_tree,
885
'Trees have the same root')
887
other_tree_path = self.relpath(other_tree.basedir)
888
except errors.PathNotChild:
889
raise errors.BadSubsumeSource(self, other_tree,
890
'Tree is not contained by the other')
891
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
892
if new_root_parent is None:
893
raise errors.BadSubsumeSource(self, other_tree,
894
'Parent directory is not versioned.')
895
# We need to ensure that the result of a fetch will have a
896
# versionedfile for the other_tree root, and only fetching into
897
# RepositoryKnit2 guarantees that.
898
if not self.branch.repository.supports_rich_root():
899
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
900
other_tree.lock_tree_write()
902
new_parents = other_tree.get_parent_ids()
903
other_root = other_tree.inventory.root
904
other_root.parent_id = new_root_parent
905
other_root.name = osutils.basename(other_tree_path)
906
self.inventory.add(other_root)
907
add_children(self.inventory, other_root)
908
self._write_inventory(self.inventory)
909
# normally we don't want to fetch whole repositories, but i think
910
# here we really do want to consolidate the whole thing.
911
for parent_id in other_tree.get_parent_ids():
912
self.branch.fetch(other_tree.branch, parent_id)
913
self.add_parent_tree_id(parent_id)
916
other_tree.bzrdir.retire_bzrdir()
918
@needs_tree_write_lock
919
def extract(self, file_id, format=None):
920
"""Extract a subtree from this tree.
922
A new branch will be created, relative to the path for this tree.
926
segments = osutils.splitpath(path)
927
transport = self.branch.bzrdir.root_transport
928
for name in segments:
929
transport = transport.clone(name)
932
except errors.FileExists:
936
sub_path = self.id2path(file_id)
937
branch_transport = mkdirs(sub_path)
939
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
941
branch_transport.mkdir('.')
942
except errors.FileExists:
944
branch_bzrdir = format.initialize_on_transport(branch_transport)
946
repo = branch_bzrdir.find_repository()
947
except errors.NoRepositoryPresent:
948
repo = branch_bzrdir.create_repository()
949
assert repo.supports_rich_root()
951
if not repo.supports_rich_root():
952
raise errors.RootNotRich()
953
new_branch = branch_bzrdir.create_branch()
954
new_branch.pull(self.branch)
955
for parent_id in self.get_parent_ids():
956
new_branch.fetch(self.branch, parent_id)
957
tree_transport = self.bzrdir.root_transport.clone(sub_path)
958
if tree_transport.base != branch_transport.base:
959
tree_bzrdir = format.initialize_on_transport(tree_transport)
960
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
962
tree_bzrdir = branch_bzrdir
963
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
964
wt.set_parent_ids(self.get_parent_ids())
965
my_inv = self.inventory
966
child_inv = Inventory(root_id=None)
967
new_root = my_inv[file_id]
968
my_inv.remove_recursive_id(file_id)
969
new_root.parent_id = None
970
child_inv.add(new_root)
971
self._write_inventory(my_inv)
972
wt._write_inventory(child_inv)
975
def _serialize(self, inventory, out_file):
976
xml5.serializer_v5.write_inventory(self._inventory, out_file)
978
def _deserialize(selt, in_file):
979
return xml5.serializer_v5.read_inventory(in_file)
982
"""Write the in memory inventory to disk."""
983
# TODO: Maybe this should only write on dirty ?
984
if self._control_files._lock_mode != 'w':
985
raise errors.NotWriteLocked(self)
987
self._serialize(self._inventory, sio)
989
self._control_files.put('inventory', sio)
990
self._inventory_is_modified = False
992
def _kind(self, relpath):
993
return osutils.file_kind(self.abspath(relpath))
995
def list_files(self, include_root=False):
996
"""Recursively list all files as (path, class, kind, id, entry).
998
Lists, but does not descend into unversioned directories.
1000
This does not include files that have been deleted in this
1003
Skips the control directory.
1005
# list_files is an iterator, so @needs_read_lock doesn't work properly
1006
# with it. So callers should be careful to always read_lock the tree.
1007
if not self.is_locked():
1008
raise errors.ObjectNotLocked(self)
1010
inv = self.inventory
1011
if include_root is True:
1012
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1013
# Convert these into local objects to save lookup times
1014
pathjoin = osutils.pathjoin
1015
file_kind = self._kind
1017
# transport.base ends in a slash, we want the piece
1018
# between the last two slashes
1019
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1021
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1023
# directory file_id, relative path, absolute path, reverse sorted children
1024
children = os.listdir(self.basedir)
1026
# jam 20060527 The kernel sized tree seems equivalent whether we
1027
# use a deque and popleft to keep them sorted, or if we use a plain
1028
# list and just reverse() them.
1029
children = collections.deque(children)
1030
stack = [(inv.root.file_id, u'', self.basedir, children)]
1032
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1035
f = children.popleft()
1036
## TODO: If we find a subdirectory with its own .bzr
1037
## directory, then that is a separate tree and we
1038
## should exclude it.
1040
# the bzrdir for this tree
1041
if transport_base_dir == f:
1044
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1045
# and 'f' doesn't begin with one, we can do a string op, rather
1046
# than the checks of pathjoin(), all relative paths will have an extra slash
1048
fp = from_dir_relpath + '/' + f
1051
fap = from_dir_abspath + '/' + f
1053
f_ie = inv.get_child(from_dir_id, f)
1056
elif self.is_ignored(fp[1:]):
1059
# we may not have found this file, because of a unicode issue
1060
f_norm, can_access = osutils.normalized_filename(f)
1061
if f == f_norm or not can_access:
1062
# No change, so treat this file normally
1065
# this file can be accessed by a normalized path
1066
# check again if it is versioned
1067
# these lines are repeated here for performance
1069
fp = from_dir_relpath + '/' + f
1070
fap = from_dir_abspath + '/' + f
1071
f_ie = inv.get_child(from_dir_id, f)
1074
elif self.is_ignored(fp[1:]):
1081
# make a last minute entry
1083
yield fp[1:], c, fk, f_ie.file_id, f_ie
1086
yield fp[1:], c, fk, None, fk_entries[fk]()
1088
yield fp[1:], c, fk, None, TreeEntry()
1091
if fk != 'directory':
1094
# But do this child first
1095
new_children = os.listdir(fap)
1097
new_children = collections.deque(new_children)
1098
stack.append((f_ie.file_id, fp, fap, new_children))
1099
# Break out of inner loop,
1100
# so that we start outer loop with child
1103
# if we finished all children, pop it off the stack
1106
@needs_tree_write_lock
1107
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1110
to_dir must exist in the inventory.
1112
If to_dir exists and is a directory, the files are moved into
1113
it, keeping their old names.
1115
Note that to_dir is only the last component of the new name;
1116
this doesn't change the directory.
1118
For each entry in from_paths the move mode will be determined
1121
The first mode moves the file in the filesystem and updates the
1122
inventory. The second mode only updates the inventory without
1123
touching the file on the filesystem. This is the new mode introduced
1126
move uses the second mode if 'after == True' and the target is not
1127
versioned but present in the working tree.
1129
move uses the second mode if 'after == False' and the source is
1130
versioned but no longer in the working tree, and the target is not
1131
versioned but present in the working tree.
1133
move uses the first mode if 'after == False' and the source is
1134
versioned and present in the working tree, and the target is not
1135
versioned and not present in the working tree.
1137
Everything else results in an error.
1139
This returns a list of (from_path, to_path) pairs for each
1140
entry that is moved.
1145
# check for deprecated use of signature
1147
to_dir = kwargs.get('to_name', None)
1149
raise TypeError('You must supply a target directory')
1151
symbol_versioning.warn('The parameter to_name was deprecated'
1152
' in version 0.13. Use to_dir instead',
1155
# check destination directory
1156
assert not isinstance(from_paths, basestring)
1157
inv = self.inventory
1158
to_abs = self.abspath(to_dir)
1159
if not isdir(to_abs):
1160
raise errors.BzrMoveFailedError('',to_dir,
1161
errors.NotADirectory(to_abs))
1162
if not self.has_filename(to_dir):
1163
raise errors.BzrMoveFailedError('',to_dir,
1164
errors.NotInWorkingDirectory(to_dir))
1165
to_dir_id = inv.path2id(to_dir)
1166
if to_dir_id is None:
1167
raise errors.BzrMoveFailedError('',to_dir,
1168
errors.NotVersionedError(path=str(to_dir)))
1170
to_dir_ie = inv[to_dir_id]
1171
if to_dir_ie.kind != 'directory':
1172
raise errors.BzrMoveFailedError('',to_dir,
1173
errors.NotADirectory(to_abs))
1175
# create rename entries and tuples
1176
for from_rel in from_paths:
1177
from_tail = splitpath(from_rel)[-1]
1178
from_id = inv.path2id(from_rel)
1180
raise errors.BzrMoveFailedError(from_rel,to_dir,
1181
errors.NotVersionedError(path=str(from_rel)))
1183
from_entry = inv[from_id]
1184
from_parent_id = from_entry.parent_id
1185
to_rel = pathjoin(to_dir, from_tail)
1186
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1188
from_tail=from_tail,
1189
from_parent_id=from_parent_id,
1190
to_rel=to_rel, to_tail=from_tail,
1191
to_parent_id=to_dir_id)
1192
rename_entries.append(rename_entry)
1193
rename_tuples.append((from_rel, to_rel))
1195
# determine which move mode to use. checks also for movability
1196
rename_entries = self._determine_mv_mode(rename_entries, after)
1198
original_modified = self._inventory_is_modified
1201
self._inventory_is_modified = True
1202
self._move(rename_entries)
1204
# restore the inventory on error
1205
self._inventory_is_modified = original_modified
1207
self._write_inventory(inv)
1208
return rename_tuples
1210
def _determine_mv_mode(self, rename_entries, after=False):
1211
"""Determines for each from-to pair if both inventory and working tree
1212
or only the inventory has to be changed.
1214
Also does basic plausability tests.
1216
inv = self.inventory
1218
for rename_entry in rename_entries:
1219
# store to local variables for easier reference
1220
from_rel = rename_entry.from_rel
1221
from_id = rename_entry.from_id
1222
to_rel = rename_entry.to_rel
1223
to_id = inv.path2id(to_rel)
1224
only_change_inv = False
1226
# check the inventory for source and destination
1228
raise errors.BzrMoveFailedError(from_rel,to_rel,
1229
errors.NotVersionedError(path=str(from_rel)))
1230
if to_id is not None:
1231
raise errors.BzrMoveFailedError(from_rel,to_rel,
1232
errors.AlreadyVersionedError(path=str(to_rel)))
1234
# try to determine the mode for rename (only change inv or change
1235
# inv and file system)
1237
if not self.has_filename(to_rel):
1238
raise errors.BzrMoveFailedError(from_id,to_rel,
1239
errors.NoSuchFile(path=str(to_rel),
1240
extra="New file has not been created yet"))
1241
only_change_inv = True
1242
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1243
only_change_inv = True
1244
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1245
only_change_inv = False
1247
# something is wrong, so lets determine what exactly
1248
if not self.has_filename(from_rel) and \
1249
not self.has_filename(to_rel):
1250
raise errors.BzrRenameFailedError(from_rel,to_rel,
1251
errors.PathsDoNotExist(paths=(str(from_rel),
1254
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1255
extra="(Use --after to update the Bazaar id)")
1256
rename_entry.only_change_inv = only_change_inv
1257
return rename_entries
1259
def _move(self, rename_entries):
1260
"""Moves a list of files.
1262
Depending on the value of the flag 'only_change_inv', the
1263
file will be moved on the file system or not.
1265
inv = self.inventory
1268
for entry in rename_entries:
1270
self._move_entry(entry)
1272
self._rollback_move(moved)
1276
def _rollback_move(self, moved):
1277
"""Try to rollback a previous move in case of an filesystem error."""
1278
inv = self.inventory
1281
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1282
entry.to_tail, entry.to_parent_id, entry.from_rel,
1283
entry.from_tail, entry.from_parent_id,
1284
entry.only_change_inv))
1285
except errors.BzrMoveFailedError, e:
1286
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1287
" The working tree is in an inconsistent state."
1288
" Please consider doing a 'bzr revert'."
1289
" Error message is: %s" % e)
1291
def _move_entry(self, entry):
1292
inv = self.inventory
1293
from_rel_abs = self.abspath(entry.from_rel)
1294
to_rel_abs = self.abspath(entry.to_rel)
1295
if from_rel_abs == to_rel_abs:
1296
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1297
"Source and target are identical.")
1299
if not entry.only_change_inv:
1301
osutils.rename(from_rel_abs, to_rel_abs)
1303
raise errors.BzrMoveFailedError(entry.from_rel,
1305
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1307
@needs_tree_write_lock
1308
def rename_one(self, from_rel, to_rel, after=False):
1311
This can change the directory or the filename or both.
1313
rename_one has several 'modes' to work. First, it can rename a physical
1314
file and change the file_id. That is the normal mode. Second, it can
1315
only change the file_id without touching any physical file. This is
1316
the new mode introduced in version 0.15.
1318
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1319
versioned but present in the working tree.
1321
rename_one uses the second mode if 'after == False' and 'from_rel' is
1322
versioned but no longer in the working tree, and 'to_rel' is not
1323
versioned but present in the working tree.
1325
rename_one uses the first mode if 'after == False' and 'from_rel' is
1326
versioned and present in the working tree, and 'to_rel' is not
1327
versioned and not present in the working tree.
1329
Everything else results in an error.
1331
inv = self.inventory
1334
# create rename entries and tuples
1335
from_tail = splitpath(from_rel)[-1]
1336
from_id = inv.path2id(from_rel)
1338
raise errors.BzrRenameFailedError(from_rel,to_rel,
1339
errors.NotVersionedError(path=str(from_rel)))
1340
from_entry = inv[from_id]
1341
from_parent_id = from_entry.parent_id
1342
to_dir, to_tail = os.path.split(to_rel)
1343
to_dir_id = inv.path2id(to_dir)
1344
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1346
from_tail=from_tail,
1347
from_parent_id=from_parent_id,
1348
to_rel=to_rel, to_tail=to_tail,
1349
to_parent_id=to_dir_id)
1350
rename_entries.append(rename_entry)
1352
# determine which move mode to use. checks also for movability
1353
rename_entries = self._determine_mv_mode(rename_entries, after)
1355
# check if the target changed directory and if the target directory is
1357
if to_dir_id is None:
1358
raise errors.BzrMoveFailedError(from_rel,to_rel,
1359
errors.NotVersionedError(path=str(to_dir)))
1361
# all checks done. now we can continue with our actual work
1362
mutter('rename_one:\n'
1367
' to_dir_id {%s}\n',
1368
from_id, from_rel, to_rel, to_dir, to_dir_id)
1370
self._move(rename_entries)
1371
self._write_inventory(inv)
1373
class _RenameEntry(object):
1374
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1375
to_rel, to_tail, to_parent_id, only_change_inv=False):
1376
self.from_rel = from_rel
1377
self.from_id = from_id
1378
self.from_tail = from_tail
1379
self.from_parent_id = from_parent_id
1380
self.to_rel = to_rel
1381
self.to_tail = to_tail
1382
self.to_parent_id = to_parent_id
1383
self.only_change_inv = only_change_inv
1387
"""Return all unknown files.
1389
These are files in the working directory that are not versioned or
1390
control files or ignored.
1392
# force the extras method to be fully executed before returning, to
1393
# prevent race conditions with the lock
1395
[subp for subp in self.extras() if not self.is_ignored(subp)])
1397
@needs_tree_write_lock
1398
def unversion(self, file_ids):
1399
"""Remove the file ids in file_ids from the current versioned set.
1401
When a file_id is unversioned, all of its children are automatically
1404
:param file_ids: The file ids to stop versioning.
1405
:raises: NoSuchId if any fileid is not currently versioned.
1407
for file_id in file_ids:
1408
file_id = osutils.safe_file_id(file_id)
1409
if self._inventory.has_id(file_id):
1410
self._inventory.remove_recursive_id(file_id)
1412
raise errors.NoSuchId(self, file_id)
1414
# in the future this should just set a dirty bit to wait for the
1415
# final unlock. However, until all methods of workingtree start
1416
# with the current in -memory inventory rather than triggering
1417
# a read, it is more complex - we need to teach read_inventory
1418
# to know when to read, and when to not read first... and possibly
1419
# to save first when the in memory one may be corrupted.
1420
# so for now, we just only write it if it is indeed dirty.
1422
self._write_inventory(self._inventory)
1424
@deprecated_method(zero_eight)
1425
def iter_conflicts(self):
1426
"""List all files in the tree that have text or content conflicts.
1427
DEPRECATED. Use conflicts instead."""
1428
return self._iter_conflicts()
1430
def _iter_conflicts(self):
1432
for info in self.list_files():
1434
stem = get_conflicted_stem(path)
1437
if stem not in conflicted:
1438
conflicted.add(stem)
1442
def pull(self, source, overwrite=False, stop_revision=None,
1443
change_reporter=None):
1444
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1447
pp = ProgressPhase("Pull phase", 2, top_pb)
1449
old_revision_info = self.branch.last_revision_info()
1450
basis_tree = self.basis_tree()
1451
count = self.branch.pull(source, overwrite, stop_revision)
1452
new_revision_info = self.branch.last_revision_info()
1453
if new_revision_info != old_revision_info:
1455
repository = self.branch.repository
1456
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1457
basis_tree.lock_read()
1459
new_basis_tree = self.branch.basis_tree()
1466
change_reporter=change_reporter)
1467
if (basis_tree.inventory.root is None and
1468
new_basis_tree.inventory.root is not None):
1469
self.set_root_id(new_basis_tree.inventory.root.file_id)
1473
# TODO - dedup parents list with things merged by pull ?
1474
# reuse the revisiontree we merged against to set the new
1476
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1477
# we have to pull the merge trees out again, because
1478
# merge_inner has set the ids. - this corner is not yet
1479
# layered well enough to prevent double handling.
1480
# XXX TODO: Fix the double handling: telling the tree about
1481
# the already known parent data is wasteful.
1482
merges = self.get_parent_ids()[1:]
1483
parent_trees.extend([
1484
(parent, repository.revision_tree(parent)) for
1486
self.set_parent_trees(parent_trees)
1493
def put_file_bytes_non_atomic(self, file_id, bytes):
1494
"""See MutableTree.put_file_bytes_non_atomic."""
1495
file_id = osutils.safe_file_id(file_id)
1496
stream = file(self.id2abspath(file_id), 'wb')
1501
# TODO: update the hashcache here ?
1504
"""Yield all unversioned files in this WorkingTree.
1506
If there are any unversioned directories then only the directory is
1507
returned, not all its children. But if there are unversioned files
1508
under a versioned subdirectory, they are returned.
1510
Currently returned depth-first, sorted by name within directories.
1511
This is the same order used by 'osutils.walkdirs'.
1513
## TODO: Work from given directory downwards
1514
for path, dir_entry in self.inventory.directories():
1515
# mutter("search for unknowns in %r", path)
1516
dirabs = self.abspath(path)
1517
if not isdir(dirabs):
1518
# e.g. directory deleted
1522
for subf in os.listdir(dirabs):
1525
if subf not in dir_entry.children:
1526
subf_norm, can_access = osutils.normalized_filename(subf)
1527
if subf_norm != subf and can_access:
1528
if subf_norm not in dir_entry.children:
1529
fl.append(subf_norm)
1535
subp = pathjoin(path, subf)
1538
def ignored_files(self):
1539
"""Yield list of PATH, IGNORE_PATTERN"""
1540
for subp in self.extras():
1541
pat = self.is_ignored(subp)
1545
def get_ignore_list(self):
1546
"""Return list of ignore patterns.
1548
Cached in the Tree object after the first call.
1550
ignoreset = getattr(self, '_ignoreset', None)
1551
if ignoreset is not None:
1554
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1555
ignore_globs.update(ignores.get_runtime_ignores())
1556
ignore_globs.update(ignores.get_user_ignores())
1557
if self.has_filename(bzrlib.IGNORE_FILENAME):
1558
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1560
ignore_globs.update(ignores.parse_ignore_file(f))
1563
self._ignoreset = ignore_globs
1566
def _flush_ignore_list_cache(self):
1567
"""Resets the cached ignore list to force a cache rebuild."""
1568
self._ignoreset = None
1569
self._ignoreglobster = None
1571
def is_ignored(self, filename):
1572
r"""Check whether the filename matches an ignore pattern.
1574
Patterns containing '/' or '\' need to match the whole path;
1575
others match against only the last component.
1577
If the file is ignored, returns the pattern which caused it to
1578
be ignored, otherwise None. So this can simply be used as a
1579
boolean if desired."""
1580
if getattr(self, '_ignoreglobster', None) is None:
1581
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1582
return self._ignoreglobster.match(filename)
1584
def kind(self, file_id):
1585
return file_kind(self.id2abspath(file_id))
1587
def _comparison_data(self, entry, path):
1588
abspath = self.abspath(path)
1590
stat_value = os.lstat(abspath)
1592
if getattr(e, 'errno', None) == errno.ENOENT:
1599
mode = stat_value.st_mode
1600
kind = osutils.file_kind_from_stat_mode(mode)
1601
if not supports_executable():
1602
executable = entry.executable
1604
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1605
return kind, executable, stat_value
1607
def _file_size(self, entry, stat_value):
1608
return stat_value.st_size
1610
def last_revision(self):
1611
"""Return the last revision of the branch for this tree.
1613
This format tree does not support a separate marker for last-revision
1614
compared to the branch.
1616
See MutableTree.last_revision
1618
return self._last_revision()
1621
def _last_revision(self):
1622
"""helper for get_parent_ids."""
1623
return self.branch.last_revision()
1625
def is_locked(self):
1626
return self._control_files.is_locked()
1628
def _must_be_locked(self):
1629
if not self.is_locked():
1630
raise errors.ObjectNotLocked(self)
1632
def lock_read(self):
1633
"""See Branch.lock_read, and WorkingTree.unlock."""
1634
if not self.is_locked():
1636
self.branch.lock_read()
1638
return self._control_files.lock_read()
1640
self.branch.unlock()
1643
def lock_tree_write(self):
1644
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1645
if not self.is_locked():
1647
self.branch.lock_read()
1649
return self._control_files.lock_write()
1651
self.branch.unlock()
1654
def lock_write(self):
1655
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1656
if not self.is_locked():
1658
self.branch.lock_write()
1660
return self._control_files.lock_write()
1662
self.branch.unlock()
1665
def get_physical_lock_status(self):
1666
return self._control_files.get_physical_lock_status()
1668
def _basis_inventory_name(self):
1669
return 'basis-inventory-cache'
1671
def _reset_data(self):
1672
"""Reset transient data that cannot be revalidated."""
1673
self._inventory_is_modified = False
1674
result = self._deserialize(self._control_files.get('inventory'))
1675
self._set_inventory(result, dirty=False)
1677
@needs_tree_write_lock
1678
def set_last_revision(self, new_revision):
1679
"""Change the last revision in the working tree."""
1680
new_revision = osutils.safe_revision_id(new_revision)
1681
if self._change_last_revision(new_revision):
1682
self._cache_basis_inventory(new_revision)
1684
def _change_last_revision(self, new_revision):
1685
"""Template method part of set_last_revision to perform the change.
1687
This is used to allow WorkingTree3 instances to not affect branch
1688
when their last revision is set.
1690
if new_revision is None:
1691
self.branch.set_revision_history([])
1694
self.branch.generate_revision_history(new_revision)
1695
except errors.NoSuchRevision:
1696
# not present in the repo - dont try to set it deeper than the tip
1697
self.branch.set_revision_history([new_revision])
1700
def _write_basis_inventory(self, xml):
1701
"""Write the basis inventory XML to the basis-inventory file"""
1702
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1703
path = self._basis_inventory_name()
1705
self._control_files.put(path, sio)
1707
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1708
"""Create the text that will be saved in basis-inventory"""
1709
# TODO: jam 20070209 This should be redundant, as the revision_id
1710
# as all callers should have already converted the revision_id to
1712
inventory.revision_id = osutils.safe_revision_id(revision_id)
1713
return xml7.serializer_v7.write_inventory_to_string(inventory)
1715
def _cache_basis_inventory(self, new_revision):
1716
"""Cache new_revision as the basis inventory."""
1717
# TODO: this should allow the ready-to-use inventory to be passed in,
1718
# as commit already has that ready-to-use [while the format is the
1721
# this double handles the inventory - unpack and repack -
1722
# but is easier to understand. We can/should put a conditional
1723
# in here based on whether the inventory is in the latest format
1724
# - perhaps we should repack all inventories on a repository
1726
# the fast path is to copy the raw xml from the repository. If the
1727
# xml contains 'revision_id="', then we assume the right
1728
# revision_id is set. We must check for this full string, because a
1729
# root node id can legitimately look like 'revision_id' but cannot
1731
xml = self.branch.repository.get_inventory_xml(new_revision)
1732
firstline = xml.split('\n', 1)[0]
1733
if (not 'revision_id="' in firstline or
1734
'format="7"' not in firstline):
1735
inv = self.branch.repository.deserialise_inventory(
1737
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1738
self._write_basis_inventory(xml)
1739
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1742
def read_basis_inventory(self):
1743
"""Read the cached basis inventory."""
1744
path = self._basis_inventory_name()
1745
return self._control_files.get(path).read()
1748
def read_working_inventory(self):
1749
"""Read the working inventory.
1751
:raises errors.InventoryModified: read_working_inventory will fail
1752
when the current in memory inventory has been modified.
1754
# conceptually this should be an implementation detail of the tree.
1755
# XXX: Deprecate this.
1756
# ElementTree does its own conversion from UTF-8, so open in
1758
if self._inventory_is_modified:
1759
raise errors.InventoryModified(self)
1760
result = self._deserialize(self._control_files.get('inventory'))
1761
self._set_inventory(result, dirty=False)
1764
@needs_tree_write_lock
1765
def remove(self, files, verbose=False, to_file=None):
1766
"""Remove nominated files from the working inventory..
1768
This does not remove their text. This does not run on XXX on what? RBC
1770
TODO: Refuse to remove modified files unless --force is given?
1772
TODO: Do something useful with directories.
1774
TODO: Should this remove the text or not? Tough call; not
1775
removing may be useful and the user can just use use rm, and
1776
is the opposite of add. Removing it is consistent with most
1777
other tools. Maybe an option.
1779
## TODO: Normalize names
1780
## TODO: Remove nested loops; better scalability
1781
if isinstance(files, basestring):
1784
inv = self.inventory
1786
# do this before any modifications
1788
fid = inv.path2id(f)
1790
note("%s is not versioned."%f)
1793
# having remove it, it must be either ignored or unknown
1794
if self.is_ignored(f):
1798
textui.show_status(new_status, inv[fid].kind, f,
1802
self._write_inventory(inv)
1804
@needs_tree_write_lock
1805
def revert(self, filenames, old_tree=None, backups=True,
1806
pb=DummyProgress(), report_changes=False):
1807
from bzrlib.conflicts import resolve
1808
if old_tree is None:
1809
old_tree = self.basis_tree()
1810
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1812
if not len(filenames):
1813
self.set_parent_ids(self.get_parent_ids()[:1])
1816
resolve(self, filenames, ignore_misses=True)
1819
def revision_tree(self, revision_id):
1820
"""See Tree.revision_tree.
1822
WorkingTree can supply revision_trees for the basis revision only
1823
because there is only one cached inventory in the bzr directory.
1825
if revision_id == self.last_revision():
1827
xml = self.read_basis_inventory()
1828
except errors.NoSuchFile:
1832
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1833
# dont use the repository revision_tree api because we want
1834
# to supply the inventory.
1835
if inv.revision_id == revision_id:
1836
return revisiontree.RevisionTree(self.branch.repository,
1838
except errors.BadInventoryFormat:
1840
# raise if there was no inventory, or if we read the wrong inventory.
1841
raise errors.NoSuchRevisionInTree(self, revision_id)
1843
# XXX: This method should be deprecated in favour of taking in a proper
1844
# new Inventory object.
1845
@needs_tree_write_lock
1846
def set_inventory(self, new_inventory_list):
1847
from bzrlib.inventory import (Inventory,
1852
inv = Inventory(self.get_root_id())
1853
for path, file_id, parent, kind in new_inventory_list:
1854
name = os.path.basename(path)
1857
# fixme, there should be a factory function inv,add_??
1858
if kind == 'directory':
1859
inv.add(InventoryDirectory(file_id, name, parent))
1860
elif kind == 'file':
1861
inv.add(InventoryFile(file_id, name, parent))
1862
elif kind == 'symlink':
1863
inv.add(InventoryLink(file_id, name, parent))
1865
raise errors.BzrError("unknown kind %r" % kind)
1866
self._write_inventory(inv)
1868
@needs_tree_write_lock
1869
def set_root_id(self, file_id):
1870
"""Set the root id for this tree."""
1873
symbol_versioning.warn(symbol_versioning.zero_twelve
1874
% 'WorkingTree.set_root_id with fileid=None',
1879
file_id = osutils.safe_file_id(file_id)
1880
self._set_root_id(file_id)
1882
def _set_root_id(self, file_id):
1883
"""Set the root id for this tree, in a format specific manner.
1885
:param file_id: The file id to assign to the root. It must not be
1886
present in the current inventory or an error will occur. It must
1887
not be None, but rather a valid file id.
1889
inv = self._inventory
1890
orig_root_id = inv.root.file_id
1891
# TODO: it might be nice to exit early if there was nothing
1892
# to do, saving us from trigger a sync on unlock.
1893
self._inventory_is_modified = True
1894
# we preserve the root inventory entry object, but
1895
# unlinkit from the byid index
1896
del inv._byid[inv.root.file_id]
1897
inv.root.file_id = file_id
1898
# and link it into the index with the new changed id.
1899
inv._byid[inv.root.file_id] = inv.root
1900
# and finally update all children to reference the new id.
1901
# XXX: this should be safe to just look at the root.children
1902
# list, not the WHOLE INVENTORY.
1905
if entry.parent_id == orig_root_id:
1906
entry.parent_id = inv.root.file_id
1909
"""See Branch.unlock.
1911
WorkingTree locking just uses the Branch locking facilities.
1912
This is current because all working trees have an embedded branch
1913
within them. IF in the future, we were to make branch data shareable
1914
between multiple working trees, i.e. via shared storage, then we
1915
would probably want to lock both the local tree, and the branch.
1917
raise NotImplementedError(self.unlock)
1920
"""Update a working tree along its branch.
1922
This will update the branch if its bound too, which means we have
1923
multiple trees involved:
1925
- The new basis tree of the master.
1926
- The old basis tree of the branch.
1927
- The old basis tree of the working tree.
1928
- The current working tree state.
1930
Pathologically, all three may be different, and non-ancestors of each
1931
other. Conceptually we want to:
1933
- Preserve the wt.basis->wt.state changes
1934
- Transform the wt.basis to the new master basis.
1935
- Apply a merge of the old branch basis to get any 'local' changes from
1937
- Restore the wt.basis->wt.state changes.
1939
There isn't a single operation at the moment to do that, so we:
1940
- Merge current state -> basis tree of the master w.r.t. the old tree
1942
- Do a 'normal' merge of the old branch basis if it is relevant.
1944
if self.branch.get_master_branch() is not None:
1946
update_branch = True
1948
self.lock_tree_write()
1949
update_branch = False
1952
old_tip = self.branch.update()
1955
return self._update_tree(old_tip)
1959
@needs_tree_write_lock
1960
def _update_tree(self, old_tip=None):
1961
"""Update a tree to the master branch.
1963
:param old_tip: if supplied, the previous tip revision the branch,
1964
before it was changed to the master branch's tip.
1966
# here if old_tip is not None, it is the old tip of the branch before
1967
# it was updated from the master branch. This should become a pending
1968
# merge in the working tree to preserve the user existing work. we
1969
# cant set that until we update the working trees last revision to be
1970
# one from the new branch, because it will just get absorbed by the
1971
# parent de-duplication logic.
1973
# We MUST save it even if an error occurs, because otherwise the users
1974
# local work is unreferenced and will appear to have been lost.
1978
last_rev = self.get_parent_ids()[0]
1981
if last_rev != self.branch.last_revision():
1982
# merge tree state up to new branch tip.
1983
basis = self.basis_tree()
1986
to_tree = self.branch.basis_tree()
1987
if basis.inventory.root is None:
1988
self.set_root_id(to_tree.inventory.root.file_id)
1990
result += merge.merge_inner(
1997
# TODO - dedup parents list with things merged by pull ?
1998
# reuse the tree we've updated to to set the basis:
1999
parent_trees = [(self.branch.last_revision(), to_tree)]
2000
merges = self.get_parent_ids()[1:]
2001
# Ideally we ask the tree for the trees here, that way the working
2002
# tree can decide whether to give us teh entire tree or give us a
2003
# lazy initialised tree. dirstate for instance will have the trees
2004
# in ram already, whereas a last-revision + basis-inventory tree
2005
# will not, but also does not need them when setting parents.
2006
for parent in merges:
2007
parent_trees.append(
2008
(parent, self.branch.repository.revision_tree(parent)))
2009
if old_tip is not None:
2010
parent_trees.append(
2011
(old_tip, self.branch.repository.revision_tree(old_tip)))
2012
self.set_parent_trees(parent_trees)
2013
last_rev = parent_trees[0][0]
2015
# the working tree had the same last-revision as the master
2016
# branch did. We may still have pivot local work from the local
2017
# branch into old_tip:
2018
if old_tip is not None:
2019
self.add_parent_tree_id(old_tip)
2020
if old_tip and old_tip != last_rev:
2021
# our last revision was not the prior branch last revision
2022
# and we have converted that last revision to a pending merge.
2023
# base is somewhere between the branch tip now
2024
# and the now pending merge
2026
# Since we just modified the working tree and inventory, flush out
2027
# the current state, before we modify it again.
2028
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2029
# requires it only because TreeTransform directly munges the
2030
# inventory and calls tree._write_inventory(). Ultimately we
2031
# should be able to remove this extra flush.
2033
from bzrlib.revision import common_ancestor
2035
base_rev_id = common_ancestor(self.branch.last_revision(),
2037
self.branch.repository)
2038
except errors.NoCommonAncestor:
2040
base_tree = self.branch.repository.revision_tree(base_rev_id)
2041
other_tree = self.branch.repository.revision_tree(old_tip)
2042
result += merge.merge_inner(
2049
def _write_hashcache_if_dirty(self):
2050
"""Write out the hashcache if it is dirty."""
2051
if self._hashcache.needs_write:
2053
self._hashcache.write()
2055
if e.errno not in (errno.EPERM, errno.EACCES):
2057
# TODO: jam 20061219 Should this be a warning? A single line
2058
# warning might be sufficient to let the user know what
2060
mutter('Could not write hashcache for %s\nError: %s',
2061
self._hashcache.cache_file_name(), e)
2063
@needs_tree_write_lock
2064
def _write_inventory(self, inv):
2065
"""Write inventory as the current inventory."""
2066
self._set_inventory(inv, dirty=True)
2069
def set_conflicts(self, arg):
2070
raise errors.UnsupportedOperation(self.set_conflicts, self)
2072
def add_conflicts(self, arg):
2073
raise errors.UnsupportedOperation(self.add_conflicts, self)
2076
def conflicts(self):
2077
conflicts = _mod_conflicts.ConflictList()
2078
for conflicted in self._iter_conflicts():
2081
if file_kind(self.abspath(conflicted)) != "file":
2083
except errors.NoSuchFile:
2086
for suffix in ('.THIS', '.OTHER'):
2088
kind = file_kind(self.abspath(conflicted+suffix))
2091
except errors.NoSuchFile:
2095
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2096
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2098
file_id=self.path2id(conflicted)))
2101
def walkdirs(self, prefix=""):
2102
"""Walk the directories of this tree.
2104
This API returns a generator, which is only valid during the current
2105
tree transaction - within a single lock_read or lock_write duration.
2107
If the tree is not locked, it may cause an error to be raised, depending
2108
on the tree implementation.
2110
disk_top = self.abspath(prefix)
2111
if disk_top.endswith('/'):
2112
disk_top = disk_top[:-1]
2113
top_strip_len = len(disk_top) + 1
2114
inventory_iterator = self._walkdirs(prefix)
2115
disk_iterator = osutils.walkdirs(disk_top, prefix)
2117
current_disk = disk_iterator.next()
2118
disk_finished = False
2120
if e.errno != errno.ENOENT:
2123
disk_finished = True
2125
current_inv = inventory_iterator.next()
2126
inv_finished = False
2127
except StopIteration:
2130
while not inv_finished or not disk_finished:
2131
if not disk_finished:
2132
# strip out .bzr dirs
2133
if current_disk[0][1][top_strip_len:] == '':
2134
# osutils.walkdirs can be made nicer -
2135
# yield the path-from-prefix rather than the pathjoined
2137
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2138
if current_disk[1][bzrdir_loc][0] == '.bzr':
2139
# we dont yield the contents of, or, .bzr itself.
2140
del current_disk[1][bzrdir_loc]
2142
# everything is unknown
2145
# everything is missing
2148
direction = cmp(current_inv[0][0], current_disk[0][0])
2150
# disk is before inventory - unknown
2151
dirblock = [(relpath, basename, kind, stat, None, None) for
2152
relpath, basename, kind, stat, top_path in current_disk[1]]
2153
yield (current_disk[0][0], None), dirblock
2155
current_disk = disk_iterator.next()
2156
except StopIteration:
2157
disk_finished = True
2159
# inventory is before disk - missing.
2160
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2161
for relpath, basename, dkind, stat, fileid, kind in
2163
yield (current_inv[0][0], current_inv[0][1]), dirblock
2165
current_inv = inventory_iterator.next()
2166
except StopIteration:
2169
# versioned present directory
2170
# merge the inventory and disk data together
2172
for relpath, subiterator in itertools.groupby(sorted(
2173
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2174
path_elements = list(subiterator)
2175
if len(path_elements) == 2:
2176
inv_row, disk_row = path_elements
2177
# versioned, present file
2178
dirblock.append((inv_row[0],
2179
inv_row[1], disk_row[2],
2180
disk_row[3], inv_row[4],
2182
elif len(path_elements[0]) == 5:
2184
dirblock.append((path_elements[0][0],
2185
path_elements[0][1], path_elements[0][2],
2186
path_elements[0][3], None, None))
2187
elif len(path_elements[0]) == 6:
2188
# versioned, absent file.
2189
dirblock.append((path_elements[0][0],
2190
path_elements[0][1], 'unknown', None,
2191
path_elements[0][4], path_elements[0][5]))
2193
raise NotImplementedError('unreachable code')
2194
yield current_inv[0], dirblock
2196
current_inv = inventory_iterator.next()
2197
except StopIteration:
2200
current_disk = disk_iterator.next()
2201
except StopIteration:
2202
disk_finished = True
2204
def _walkdirs(self, prefix=""):
2205
_directory = 'directory'
2206
# get the root in the inventory
2207
inv = self.inventory
2208
top_id = inv.path2id(prefix)
2212
pending = [(prefix, '', _directory, None, top_id, None)]
2215
currentdir = pending.pop()
2216
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2217
top_id = currentdir[4]
2219
relroot = currentdir[0] + '/'
2222
# FIXME: stash the node in pending
2224
for name, child in entry.sorted_children():
2225
dirblock.append((relroot + name, name, child.kind, None,
2226
child.file_id, child.kind
2228
yield (currentdir[0], entry.file_id), dirblock
2229
# push the user specified dirs from dirblock
2230
for dir in reversed(dirblock):
2231
if dir[2] == _directory:
2234
@needs_tree_write_lock
2235
def auto_resolve(self):
2236
"""Automatically resolve text conflicts according to contents.
2238
Only text conflicts are auto_resolvable. Files with no conflict markers
2239
are considered 'resolved', because bzr always puts conflict markers
2240
into files that have text conflicts. The corresponding .THIS .BASE and
2241
.OTHER files are deleted, as per 'resolve'.
2242
:return: a tuple of ConflictLists: (un_resolved, resolved).
2244
un_resolved = _mod_conflicts.ConflictList()
2245
resolved = _mod_conflicts.ConflictList()
2246
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2247
for conflict in self.conflicts():
2248
if (conflict.typestring != 'text conflict' or
2249
self.kind(conflict.file_id) != 'file'):
2250
un_resolved.append(conflict)
2252
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2254
for line in my_file:
2255
if conflict_re.search(line):
2256
un_resolved.append(conflict)
2259
resolved.append(conflict)
2262
resolved.remove_files(self)
2263
self.set_conflicts(un_resolved)
2264
return un_resolved, resolved
2267
class WorkingTree2(WorkingTree):
2268
"""This is the Format 2 working tree.
2270
This was the first weave based working tree.
2271
- uses os locks for locking.
2272
- uses the branch last-revision.
2275
def __init__(self, *args, **kwargs):
2276
super(WorkingTree2, self).__init__(*args, **kwargs)
2277
# WorkingTree2 has more of a constraint that self._inventory must
2278
# exist. Because this is an older format, we don't mind the overhead
2279
# caused by the extra computation here.
2281
# Newer WorkingTree's should only have self._inventory set when they
2283
if self._inventory is None:
2284
self.read_working_inventory()
2286
def lock_tree_write(self):
2287
"""See WorkingTree.lock_tree_write().
2289
In Format2 WorkingTrees we have a single lock for the branch and tree
2290
so lock_tree_write() degrades to lock_write().
2292
self.branch.lock_write()
2294
return self._control_files.lock_write()
2296
self.branch.unlock()
2300
# we share control files:
2301
if self._control_files._lock_count == 3:
2302
# _inventory_is_modified is always False during a read lock.
2303
if self._inventory_is_modified:
2305
self._write_hashcache_if_dirty()
2307
# reverse order of locking.
2309
return self._control_files.unlock()
2311
self.branch.unlock()
2314
class WorkingTree3(WorkingTree):
2315
"""This is the Format 3 working tree.
2317
This differs from the base WorkingTree by:
2318
- having its own file lock
2319
- having its own last-revision property.
2321
This is new in bzr 0.8
2325
def _last_revision(self):
2326
"""See Mutable.last_revision."""
2328
return osutils.safe_revision_id(
2329
self._control_files.get('last-revision').read())
2330
except errors.NoSuchFile:
2333
def _change_last_revision(self, revision_id):
2334
"""See WorkingTree._change_last_revision."""
2335
if revision_id is None or revision_id == NULL_REVISION:
2337
self._control_files._transport.delete('last-revision')
2338
except errors.NoSuchFile:
2342
self._control_files.put_bytes('last-revision', revision_id)
2345
@needs_tree_write_lock
2346
def set_conflicts(self, conflicts):
2347
self._put_rio('conflicts', conflicts.to_stanzas(),
2350
@needs_tree_write_lock
2351
def add_conflicts(self, new_conflicts):
2352
conflict_set = set(self.conflicts())
2353
conflict_set.update(set(list(new_conflicts)))
2354
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2355
key=_mod_conflicts.Conflict.sort_key)))
2358
def conflicts(self):
2360
confile = self._control_files.get('conflicts')
2361
except errors.NoSuchFile:
2362
return _mod_conflicts.ConflictList()
2364
if confile.next() != CONFLICT_HEADER_1 + '\n':
2365
raise errors.ConflictFormatError()
2366
except StopIteration:
2367
raise errors.ConflictFormatError()
2368
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2371
if self._control_files._lock_count == 1:
2372
# _inventory_is_modified is always False during a read lock.
2373
if self._inventory_is_modified:
2375
self._write_hashcache_if_dirty()
2376
# reverse order of locking.
2378
return self._control_files.unlock()
2380
self.branch.unlock()
2383
def get_conflicted_stem(path):
2384
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2385
if path.endswith(suffix):
2386
return path[:-len(suffix)]
2389
@deprecated_function(zero_eight)
2390
def is_control_file(filename):
2391
"""See WorkingTree.is_control_filename(filename)."""
2392
## FIXME: better check
2393
filename = normpath(filename)
2394
while filename != '':
2395
head, tail = os.path.split(filename)
2396
## mutter('check %r for control file' % ((head, tail),))
2399
if filename == head:
2405
class WorkingTreeFormat(object):
2406
"""An encapsulation of the initialization and open routines for a format.
2408
Formats provide three things:
2409
* An initialization routine,
2413
Formats are placed in an dict by their format string for reference
2414
during workingtree opening. Its not required that these be instances, they
2415
can be classes themselves with class methods - it simply depends on
2416
whether state is needed for a given format or not.
2418
Once a format is deprecated, just deprecate the initialize and open
2419
methods on the format class. Do not deprecate the object, as the
2420
object will be created every time regardless.
2423
_default_format = None
2424
"""The default format used for new trees."""
2427
"""The known formats."""
2429
requires_rich_root = False
2432
def find_format(klass, a_bzrdir):
2433
"""Return the format for the working tree object in a_bzrdir."""
2435
transport = a_bzrdir.get_workingtree_transport(None)
2436
format_string = transport.get("format").read()
2437
return klass._formats[format_string]
2438
except errors.NoSuchFile:
2439
raise errors.NoWorkingTree(base=transport.base)
2441
raise errors.UnknownFormatError(format=format_string)
2443
def __eq__(self, other):
2444
return self.__class__ is other.__class__
2446
def __ne__(self, other):
2447
return not (self == other)
2450
def get_default_format(klass):
2451
"""Return the current default format."""
2452
return klass._default_format
2454
def get_format_string(self):
2455
"""Return the ASCII format string that identifies this format."""
2456
raise NotImplementedError(self.get_format_string)
2458
def get_format_description(self):
2459
"""Return the short description for this format."""
2460
raise NotImplementedError(self.get_format_description)
2462
def is_supported(self):
2463
"""Is this format supported?
2465
Supported formats can be initialized and opened.
2466
Unsupported formats may not support initialization or committing or
2467
some other features depending on the reason for not being supported.
2472
def register_format(klass, format):
2473
klass._formats[format.get_format_string()] = format
2476
def set_default_format(klass, format):
2477
klass._default_format = format
2480
def unregister_format(klass, format):
2481
assert klass._formats[format.get_format_string()] is format
2482
del klass._formats[format.get_format_string()]
2486
class WorkingTreeFormat2(WorkingTreeFormat):
2487
"""The second working tree format.
2489
This format modified the hash cache from the format 1 hash cache.
2492
def get_format_description(self):
2493
"""See WorkingTreeFormat.get_format_description()."""
2494
return "Working tree format 2"
2496
def stub_initialize_remote(self, control_files):
2497
"""As a special workaround create critical control files for a remote working tree
2499
This ensures that it can later be updated and dealt with locally,
2500
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2501
no working tree. (See bug #43064).
2505
xml5.serializer_v5.write_inventory(inv, sio)
2507
control_files.put('inventory', sio)
2509
control_files.put_bytes('pending-merges', '')
2512
def initialize(self, a_bzrdir, revision_id=None):
2513
"""See WorkingTreeFormat.initialize()."""
2514
if not isinstance(a_bzrdir.transport, LocalTransport):
2515
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2516
branch = a_bzrdir.open_branch()
2517
if revision_id is not None:
2518
revision_id = osutils.safe_revision_id(revision_id)
2521
revision_history = branch.revision_history()
2523
position = revision_history.index(revision_id)
2525
raise errors.NoSuchRevision(branch, revision_id)
2526
branch.set_revision_history(revision_history[:position + 1])
2529
revision = branch.last_revision()
2531
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2537
basis_tree = branch.repository.revision_tree(revision)
2538
if basis_tree.inventory.root is not None:
2539
wt.set_root_id(basis_tree.inventory.root.file_id)
2540
# set the parent list and cache the basis tree.
2541
wt.set_parent_trees([(revision, basis_tree)])
2542
transform.build_tree(basis_tree, wt)
2546
super(WorkingTreeFormat2, self).__init__()
2547
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2549
def open(self, a_bzrdir, _found=False):
2550
"""Return the WorkingTree object for a_bzrdir
2552
_found is a private parameter, do not use it. It is used to indicate
2553
if format probing has already been done.
2556
# we are being called directly and must probe.
2557
raise NotImplementedError
2558
if not isinstance(a_bzrdir.transport, LocalTransport):
2559
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2560
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2566
class WorkingTreeFormat3(WorkingTreeFormat):
2567
"""The second working tree format updated to record a format marker.
2570
- exists within a metadir controlling .bzr
2571
- includes an explicit version marker for the workingtree control
2572
files, separate from the BzrDir format
2573
- modifies the hash cache format
2575
- uses a LockDir to guard access for writes.
2578
def get_format_string(self):
2579
"""See WorkingTreeFormat.get_format_string()."""
2580
return "Bazaar-NG Working Tree format 3"
2582
def get_format_description(self):
2583
"""See WorkingTreeFormat.get_format_description()."""
2584
return "Working tree format 3"
2586
_lock_file_name = 'lock'
2587
_lock_class = LockDir
2589
_tree_class = WorkingTree3
2591
def __get_matchingbzrdir(self):
2592
return bzrdir.BzrDirMetaFormat1()
2594
_matchingbzrdir = property(__get_matchingbzrdir)
2596
def _open_control_files(self, a_bzrdir):
2597
transport = a_bzrdir.get_workingtree_transport(None)
2598
return LockableFiles(transport, self._lock_file_name,
2601
def initialize(self, a_bzrdir, revision_id=None):
2602
"""See WorkingTreeFormat.initialize().
2604
revision_id allows creating a working tree at a different
2605
revision than the branch is at.
2607
if not isinstance(a_bzrdir.transport, LocalTransport):
2608
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2609
transport = a_bzrdir.get_workingtree_transport(self)
2610
control_files = self._open_control_files(a_bzrdir)
2611
control_files.create_lock()
2612
control_files.lock_write()
2613
control_files.put_utf8('format', self.get_format_string())
2614
branch = a_bzrdir.open_branch()
2615
if revision_id is None:
2616
revision_id = branch.last_revision()
2618
revision_id = osutils.safe_revision_id(revision_id)
2619
# WorkingTree3 can handle an inventory which has a unique root id.
2620
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2621
# those trees. And because there isn't a format bump inbetween, we
2622
# are maintaining compatibility with older clients.
2623
# inv = Inventory(root_id=gen_root_id())
2624
inv = self._initial_inventory()
2625
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2631
_control_files=control_files)
2632
wt.lock_tree_write()
2634
basis_tree = branch.repository.revision_tree(revision_id)
2635
# only set an explicit root id if there is one to set.
2636
if basis_tree.inventory.root is not None:
2637
wt.set_root_id(basis_tree.inventory.root.file_id)
2638
if revision_id == NULL_REVISION:
2639
wt.set_parent_trees([])
2641
wt.set_parent_trees([(revision_id, basis_tree)])
2642
transform.build_tree(basis_tree, wt)
2644
# Unlock in this order so that the unlock-triggers-flush in
2645
# WorkingTree is given a chance to fire.
2646
control_files.unlock()
2650
def _initial_inventory(self):
2654
super(WorkingTreeFormat3, self).__init__()
2656
def open(self, a_bzrdir, _found=False):
2657
"""Return the WorkingTree object for a_bzrdir
2659
_found is a private parameter, do not use it. It is used to indicate
2660
if format probing has already been done.
2663
# we are being called directly and must probe.
2664
raise NotImplementedError
2665
if not isinstance(a_bzrdir.transport, LocalTransport):
2666
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2667
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2669
def _open(self, a_bzrdir, control_files):
2670
"""Open the tree itself.
2672
:param a_bzrdir: the dir for the tree.
2673
:param control_files: the control files for the tree.
2675
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2679
_control_files=control_files)
2682
return self.get_format_string()
2685
__default_format = WorkingTreeFormat4()
2686
WorkingTreeFormat.register_format(__default_format)
2687
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2688
WorkingTreeFormat.set_default_format(__default_format)
2689
# formats which have no format string are not discoverable
2690
# and not independently creatable, so are not registered.
2691
_legacy_formats = [WorkingTreeFormat2(),
2695
class WorkingTreeTestProviderAdapter(object):
2696
"""A tool to generate a suite testing multiple workingtree formats at once.
2698
This is done by copying the test once for each transport and injecting
2699
the transport_server, transport_readonly_server, and workingtree_format
2700
classes into each copy. Each copy is also given a new id() to make it
2704
def __init__(self, transport_server, transport_readonly_server, formats):
2705
self._transport_server = transport_server
2706
self._transport_readonly_server = transport_readonly_server
2707
self._formats = formats
2709
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2710
"""Clone test for adaption."""
2711
new_test = deepcopy(test)
2712
new_test.transport_server = self._transport_server
2713
new_test.transport_readonly_server = self._transport_readonly_server
2714
new_test.bzrdir_format = bzrdir_format
2715
new_test.workingtree_format = workingtree_format
2716
def make_new_test_id():
2717
new_id = "%s(%s)" % (test.id(), variation)
2718
return lambda: new_id
2719
new_test.id = make_new_test_id()
2722
def adapt(self, test):
2723
from bzrlib.tests import TestSuite
2724
result = TestSuite()
2725
for workingtree_format, bzrdir_format in self._formats:
2726
new_test = self._clone_test(
2729
workingtree_format, workingtree_format.__class__.__name__)
2730
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
