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(), """
44
from bisect import bisect_left
46
from copy import deepcopy
57
conflicts as _mod_conflicts,
74
from bzrlib.transport import get_transport
76
from bzrlib.workingtree_4 import WorkingTreeFormat4
79
from bzrlib import symbol_versioning
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
81
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
82
from bzrlib.lockable_files import LockableFiles, TransportLock
83
from bzrlib.lockdir import LockDir
84
import bzrlib.mutabletree
85
from bzrlib.mutabletree import needs_tree_write_lock
86
from bzrlib.osutils import (
98
from bzrlib.trace import mutter, note
99
from bzrlib.transport.local import LocalTransport
100
from bzrlib.progress import DummyProgress, ProgressPhase
101
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
102
from bzrlib.rio import RioReader, rio_file, Stanza
103
from bzrlib.symbol_versioning import (deprecated_passed,
106
DEPRECATED_PARAMETER,
113
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
117
@deprecated_function(zero_thirteen)
118
def gen_file_id(name):
119
"""Return new file id for the basename 'name'.
121
Use bzrlib.generate_ids.gen_file_id() instead
123
return generate_ids.gen_file_id(name)
126
@deprecated_function(zero_thirteen)
128
"""Return a new tree-root file id.
130
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
132
return generate_ids.gen_root_id()
135
class TreeEntry(object):
136
"""An entry that implements the minimum interface used by commands.
138
This needs further inspection, it may be better to have
139
InventoryEntries without ids - though that seems wrong. For now,
140
this is a parallel hierarchy to InventoryEntry, and needs to become
141
one of several things: decorates to that hierarchy, children of, or
143
Another note is that these objects are currently only used when there is
144
no InventoryEntry available - i.e. for unversioned objects.
145
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
148
def __eq__(self, other):
149
# yes, this us ugly, TODO: best practice __eq__ style.
150
return (isinstance(other, TreeEntry)
151
and other.__class__ == self.__class__)
153
def kind_character(self):
157
class TreeDirectory(TreeEntry):
158
"""See TreeEntry. This is a directory in a working tree."""
160
def __eq__(self, other):
161
return (isinstance(other, TreeDirectory)
162
and other.__class__ == self.__class__)
164
def kind_character(self):
168
class TreeFile(TreeEntry):
169
"""See TreeEntry. This is a regular file in a working tree."""
171
def __eq__(self, other):
172
return (isinstance(other, TreeFile)
173
and other.__class__ == self.__class__)
175
def kind_character(self):
179
class TreeLink(TreeEntry):
180
"""See TreeEntry. This is a symlink in a working tree."""
182
def __eq__(self, other):
183
return (isinstance(other, TreeLink)
184
and other.__class__ == self.__class__)
186
def kind_character(self):
190
class WorkingTree(bzrlib.mutabletree.MutableTree):
191
"""Working copy tree.
193
The inventory is held in the `Branch` working-inventory, and the
194
files are in a directory on disk.
196
It is possible for a `WorkingTree` to have a filename which is
197
not listed in the Inventory and vice versa.
200
def __init__(self, basedir='.',
201
branch=DEPRECATED_PARAMETER,
207
"""Construct a WorkingTree for basedir.
209
If the branch is not supplied, it is opened automatically.
210
If the branch is supplied, it must be the branch for this basedir.
211
(branch.base is not cross checked, because for remote branches that
212
would be meaningless).
214
self._format = _format
215
self.bzrdir = _bzrdir
217
# not created via open etc.
218
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
219
"Please use bzrdir.open_workingtree or WorkingTree.open().",
222
wt = WorkingTree.open(basedir)
223
self._branch = wt.branch
224
self.basedir = wt.basedir
225
self._control_files = wt._control_files
226
self._hashcache = wt._hashcache
227
self._set_inventory(wt._inventory, dirty=False)
228
self._format = wt._format
229
self.bzrdir = wt.bzrdir
230
assert isinstance(basedir, basestring), \
231
"base directory %r is not a string" % basedir
232
basedir = safe_unicode(basedir)
233
mutter("opening working tree %r", basedir)
234
if deprecated_passed(branch):
236
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
237
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
238
" WorkingTree.open().",
242
self._branch = branch
244
self._branch = self.bzrdir.open_branch()
245
self.basedir = realpath(basedir)
246
# if branch is at our basedir and is a format 6 or less
247
if isinstance(self._format, WorkingTreeFormat2):
248
# share control object
249
self._control_files = self.branch.control_files
251
# assume all other formats have their own control files.
252
assert isinstance(_control_files, LockableFiles), \
253
"_control_files must be a LockableFiles, not %r" \
255
self._control_files = _control_files
256
# update the whole cache up front and write to disk if anything changed;
257
# in the future we might want to do this more selectively
258
# two possible ways offer themselves : in self._unlock, write the cache
259
# if needed, or, when the cache sees a change, append it to the hash
260
# cache file, and have the parser take the most recent entry for a
262
wt_trans = self.bzrdir.get_workingtree_transport(None)
263
cache_filename = wt_trans.local_abspath('stat-cache')
264
self._hashcache = hashcache.HashCache(basedir, cache_filename,
265
self._control_files._file_mode)
268
# is this scan needed ? it makes things kinda slow.
275
if _inventory is None:
276
self._inventory_is_modified = False
277
self.read_working_inventory()
279
# the caller of __init__ has provided an inventory,
280
# we assume they know what they are doing - as its only
281
# the Format factory and creation methods that are
282
# permitted to do this.
283
self._set_inventory(_inventory, dirty=False)
286
fget=lambda self: self._branch,
287
doc="""The branch this WorkingTree is connected to.
289
This cannot be set - it is reflective of the actual disk structure
290
the working tree has been constructed from.
293
def break_lock(self):
294
"""Break a lock if one is present from another instance.
296
Uses the ui factory to ask for confirmation if the lock may be from
299
This will probe the repository for its lock as well.
301
self._control_files.break_lock()
302
self.branch.break_lock()
304
def _set_inventory(self, inv, dirty):
305
"""Set the internal cached inventory.
307
:param inv: The inventory to set.
308
:param dirty: A boolean indicating whether the inventory is the same
309
logical inventory as whats on disk. If True the inventory is not
310
the same and should be written to disk or data will be lost, if
311
False then the inventory is the same as that on disk and any
312
serialisation would be unneeded overhead.
314
assert inv.root is not None
315
self._inventory = inv
316
self._inventory_is_modified = dirty
319
def open(path=None, _unsupported=False):
320
"""Open an existing working tree at path.
324
path = os.path.getcwdu()
325
control = bzrdir.BzrDir.open(path, _unsupported)
326
return control.open_workingtree(_unsupported)
329
def open_containing(path=None):
330
"""Open an existing working tree which has its root about path.
332
This probes for a working tree at path and searches upwards from there.
334
Basically we keep looking up until we find the control directory or
335
run into /. If there isn't one, raises NotBranchError.
336
TODO: give this a new exception.
337
If there is one, it is returned, along with the unused portion of path.
339
:return: The WorkingTree that contains 'path', and the rest of path
342
path = osutils.getcwd()
343
control, relpath = bzrdir.BzrDir.open_containing(path)
345
return control.open_workingtree(), relpath
348
def open_downlevel(path=None):
349
"""Open an unsupported working tree.
351
Only intended for advanced situations like upgrading part of a bzrdir.
353
return WorkingTree.open(path, _unsupported=True)
356
"""Iterate through file_ids for this tree.
358
file_ids are in a WorkingTree if they are in the working inventory
359
and the working file exists.
361
inv = self._inventory
362
for path, ie in inv.iter_entries():
363
if osutils.lexists(self.abspath(path)):
367
return "<%s of %s>" % (self.__class__.__name__,
368
getattr(self, 'basedir', None))
370
def abspath(self, filename):
371
return pathjoin(self.basedir, filename)
373
def basis_tree(self):
374
"""Return RevisionTree for the current last revision.
376
If the left most parent is a ghost then the returned tree will be an
377
empty tree - one obtained by calling repository.revision_tree(None).
380
revision_id = self.get_parent_ids()[0]
382
# no parents, return an empty revision tree.
383
# in the future this should return the tree for
384
# 'empty:' - the implicit root empty tree.
385
return self.branch.repository.revision_tree(None)
387
return self.revision_tree(revision_id)
388
except errors.NoSuchRevision:
390
# No cached copy available, retrieve from the repository.
391
# FIXME? RBC 20060403 should we cache the inventory locally
394
return self.branch.repository.revision_tree(revision_id)
395
except errors.RevisionNotPresent:
396
# the basis tree *may* be a ghost or a low level error may have
397
# occured. If the revision is present, its a problem, if its not
399
if self.branch.repository.has_revision(revision_id):
401
# the basis tree is a ghost so return an empty tree.
402
return self.branch.repository.revision_tree(None)
405
@deprecated_method(zero_eight)
406
def create(branch, directory):
407
"""Create a workingtree for branch at directory.
409
If existing_directory already exists it must have a .bzr directory.
410
If it does not exist, it will be created.
412
This returns a new WorkingTree object for the new checkout.
414
TODO FIXME RBC 20060124 when we have checkout formats in place this
415
should accept an optional revisionid to checkout [and reject this if
416
checking out into the same dir as a pre-checkout-aware branch format.]
418
XXX: When BzrDir is present, these should be created through that
421
warnings.warn('delete WorkingTree.create', stacklevel=3)
422
transport = get_transport(directory)
423
if branch.bzrdir.root_transport.base == transport.base:
425
return branch.bzrdir.create_workingtree()
426
# different directory,
427
# create a branch reference
428
# and now a working tree.
429
raise NotImplementedError
432
@deprecated_method(zero_eight)
433
def create_standalone(directory):
434
"""Create a checkout and a branch and a repo at directory.
436
Directory must exist and be empty.
438
please use BzrDir.create_standalone_workingtree
440
return bzrdir.BzrDir.create_standalone_workingtree(directory)
442
def relpath(self, path):
443
"""Return the local path portion from a given path.
445
The path may be absolute or relative. If its a relative path it is
446
interpreted relative to the python current working directory.
448
return osutils.relpath(self.basedir, path)
450
def has_filename(self, filename):
451
return osutils.lexists(self.abspath(filename))
453
def get_file(self, file_id):
454
return self.get_file_byname(self.id2path(file_id))
456
def get_file_text(self, file_id):
457
return self.get_file(file_id).read()
459
def get_file_byname(self, filename):
460
return file(self.abspath(filename), 'rb')
463
def annotate_iter(self, file_id):
464
"""See Tree.annotate_iter
466
This implementation will use the basis tree implementation if possible.
467
Lines not in the basis are attributed to CURRENT_REVISION
469
If there are pending merges, lines added by those merges will be
470
incorrectly attributed to CURRENT_REVISION (but after committing, the
471
attribution will be correct).
473
basis = self.basis_tree()
474
changes = self._iter_changes(basis, True, [file_id]).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
494
def get_parent_ids(self):
495
"""See Tree.get_parent_ids.
497
This implementation reads the pending merges list and last_revision
498
value and uses that to decide what the parents list should be.
500
last_rev = self._last_revision()
506
merges_file = self._control_files.get_utf8('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
parents.append(l.rstrip('\n'))
515
def get_root_id(self):
516
"""Return the id of this trees root"""
517
return self._inventory.root.file_id
519
def _get_store_filename(self, file_id):
520
## XXX: badly named; this is not in the store at all
521
return self.abspath(self.id2path(file_id))
524
def clone(self, to_bzrdir, revision_id=None, basis=None):
525
"""Duplicate this working tree into to_bzr, including all state.
527
Specifically modified files are kept as modified, but
528
ignored and unknown files are discarded.
530
If you want to make a new line of development, see bzrdir.sprout()
533
If not None, the cloned tree will have its last revision set to
534
revision, and and difference between the source trees last revision
535
and this one merged in.
538
If not None, a closer copy of a tree which may have some files in
539
common, and which file content should be preferentially copied from.
541
# assumes the target bzr dir format is compatible.
542
result = self._format.initialize(to_bzrdir)
543
self.copy_content_into(result, revision_id)
547
def copy_content_into(self, tree, revision_id=None):
548
"""Copy the current content and user files of this tree into tree."""
549
tree.set_root_id(self.get_root_id())
550
if revision_id is None:
551
merge.transform_tree(tree, self)
553
# TODO now merge from tree.last_revision to revision (to preserve
554
# user local changes)
555
merge.transform_tree(tree, self)
556
tree.set_parent_ids([revision_id])
558
def id2abspath(self, 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
inv = self._inventory
564
if not inv.has_id(file_id):
566
path = inv.id2path(file_id)
567
return osutils.lexists(self.abspath(path))
569
def has_or_had_id(self, file_id):
570
if file_id == self.inventory.root.file_id:
572
return self.inventory.has_id(file_id)
574
__contains__ = has_id
576
def get_file_size(self, file_id):
577
return os.path.getsize(self.id2abspath(file_id))
580
def get_file_sha1(self, file_id, path=None, stat_value=None):
582
path = self._inventory.id2path(file_id)
583
return self._hashcache.get_sha1(path, stat_value)
585
def get_file_mtime(self, file_id, path=None):
587
path = self._inventory.id2path(file_id)
588
return os.lstat(self.abspath(path)).st_mtime
590
if not supports_executable():
591
def is_executable(self, file_id, path=None):
592
return self._inventory[file_id].executable
594
def is_executable(self, file_id, path=None):
596
path = self.id2path(file_id)
597
mode = os.lstat(self.abspath(path)).st_mode
598
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
601
def _add(self, files, ids, kinds):
602
"""See MutableTree._add."""
603
# TODO: Re-adding a file that is removed in the working copy
604
# should probably put it back with the previous ID.
605
# the read and write working inventory should not occur in this
606
# function - they should be part of lock_write and unlock.
607
inv = self.read_working_inventory()
608
for f, file_id, kind in zip(files, ids, kinds):
609
assert kind is not None
611
inv.add_path(f, kind=kind)
613
inv.add_path(f, kind=kind, file_id=file_id)
614
self._write_inventory(inv)
616
@needs_tree_write_lock
617
def _gather_kinds(self, files, kinds):
618
"""See MutableTree._gather_kinds."""
619
for pos, f in enumerate(files):
620
if kinds[pos] is None:
621
fullpath = normpath(self.abspath(f))
623
kinds[pos] = file_kind(fullpath)
625
if e.errno == errno.ENOENT:
626
raise errors.NoSuchFile(fullpath)
629
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
630
"""Add revision_id as a parent.
632
This is equivalent to retrieving the current list of parent ids
633
and setting the list to its value plus revision_id.
635
:param revision_id: The revision id to add to the parent list. It may
636
be a ghost revision as long as its not the first parent to be added,
637
or the allow_leftmost_as_ghost parameter is set True.
638
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
parents = self.get_parent_ids() + [revision_id]
641
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
642
or allow_leftmost_as_ghost)
644
@needs_tree_write_lock
645
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
646
"""Add revision_id, tree tuple as a parent.
648
This is equivalent to retrieving the current list of parent trees
649
and setting the list to its value plus parent_tuple. See also
650
add_parent_tree_id - if you only have a parent id available it will be
651
simpler to use that api. If you have the parent already available, using
652
this api is preferred.
654
:param parent_tuple: The (revision id, tree) to add to the parent list.
655
If the revision_id is a ghost, pass None for the tree.
656
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
658
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
659
if len(parent_ids) > 1:
660
# the leftmost may have already been a ghost, preserve that if it
662
allow_leftmost_as_ghost = True
663
self.set_parent_ids(parent_ids,
664
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
666
@needs_tree_write_lock
667
def add_pending_merge(self, *revision_ids):
668
# TODO: Perhaps should check at this point that the
669
# history of the revision is actually present?
670
parents = self.get_parent_ids()
672
for rev_id in revision_ids:
673
if rev_id in parents:
675
parents.append(rev_id)
678
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
680
@deprecated_method(zero_eleven)
682
def pending_merges(self):
683
"""Return a list of pending merges.
685
These are revisions that have been merged into the working
686
directory but not yet committed.
688
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
689
instead - which is available on all tree objects.
691
return self.get_parent_ids()[1:]
693
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
694
"""Common ghost checking functionality from set_parent_*.
696
This checks that the left hand-parent exists if there are any
699
if len(revision_ids) > 0:
700
leftmost_id = revision_ids[0]
701
if (not allow_leftmost_as_ghost and not
702
self.branch.repository.has_revision(leftmost_id)):
703
raise errors.GhostRevisionUnusableHere(leftmost_id)
705
def _set_merges_from_parent_ids(self, parent_ids):
706
merges = parent_ids[1:]
707
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
709
@needs_tree_write_lock
710
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
711
"""Set the parent ids to revision_ids.
713
See also set_parent_trees. This api will try to retrieve the tree data
714
for each element of revision_ids from the trees repository. If you have
715
tree data already available, it is more efficient to use
716
set_parent_trees rather than set_parent_ids. set_parent_ids is however
717
an easier API to use.
719
:param revision_ids: The revision_ids to set as the parent ids of this
720
working tree. Any of these may be ghosts.
722
self._check_parents_for_ghosts(revision_ids,
723
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
725
if len(revision_ids) > 0:
726
self.set_last_revision(revision_ids[0])
728
self.set_last_revision(None)
730
self._set_merges_from_parent_ids(revision_ids)
732
@needs_tree_write_lock
733
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
734
"""See MutableTree.set_parent_trees."""
735
parent_ids = [rev for (rev, tree) in parents_list]
737
self._check_parents_for_ghosts(parent_ids,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
if len(parent_ids) == 0:
741
leftmost_parent_id = None
742
leftmost_parent_tree = None
744
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
746
if self._change_last_revision(leftmost_parent_id):
747
if leftmost_parent_tree is None:
748
# If we don't have a tree, fall back to reading the
749
# parent tree from the repository.
750
self._cache_basis_inventory(leftmost_parent_id)
752
inv = leftmost_parent_tree.inventory
753
xml = self._create_basis_xml_from_inventory(
754
leftmost_parent_id, inv)
755
self._write_basis_inventory(xml)
756
self._set_merges_from_parent_ids(parent_ids)
758
@needs_tree_write_lock
759
def set_pending_merges(self, rev_list):
760
parents = self.get_parent_ids()
761
leftmost = parents[:1]
762
new_parents = leftmost + rev_list
763
self.set_parent_ids(new_parents)
765
@needs_tree_write_lock
766
def set_merge_modified(self, modified_hashes):
768
for file_id, hash in modified_hashes.iteritems():
769
yield Stanza(file_id=file_id, hash=hash)
770
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
772
@needs_tree_write_lock
773
def _put_rio(self, filename, stanzas, header):
774
my_file = rio_file(stanzas, header)
775
self._control_files.put(filename, my_file)
777
@needs_write_lock # because merge pulls data into the branch.
778
def merge_from_branch(self, branch, to_revision=None):
779
"""Merge from a branch into this working tree.
781
:param branch: The branch to merge from.
782
:param to_revision: If non-None, the merge will merge to to_revision,
783
but not beyond it. to_revision does not need to be in the history
784
of the branch when it is supplied. If None, to_revision defaults to
785
branch.last_revision().
787
from bzrlib.merge import Merger, Merge3Merger
788
pb = bzrlib.ui.ui_factory.nested_progress_bar()
790
merger = Merger(self.branch, this_tree=self, pb=pb)
791
merger.pp = ProgressPhase("Merge phase", 5, pb)
792
merger.pp.next_phase()
793
# check that there are no
795
merger.check_basis(check_clean=True, require_commits=False)
796
if to_revision is None:
797
to_revision = branch.last_revision()
798
merger.other_rev_id = to_revision
799
if merger.other_rev_id is None:
800
raise error.NoCommits(branch)
801
self.branch.fetch(branch, last_revision=merger.other_rev_id)
802
merger.other_basis = merger.other_rev_id
803
merger.other_tree = self.branch.repository.revision_tree(
805
merger.pp.next_phase()
807
if merger.base_rev_id == merger.other_rev_id:
808
raise errors.PointlessMerge
809
merger.backup_files = False
810
merger.merge_type = Merge3Merger
811
merger.set_interesting_files(None)
812
merger.show_base = False
813
merger.reprocess = False
814
conflicts = merger.do_merge()
821
def merge_modified(self):
823
hashfile = self._control_files.get('merge-hashes')
824
except errors.NoSuchFile:
828
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
829
raise errors.MergeModifiedFormatError()
830
except StopIteration:
831
raise errors.MergeModifiedFormatError()
832
for s in RioReader(hashfile):
833
file_id = s.get("file_id")
834
if file_id not in self.inventory:
837
if hash == self.get_file_sha1(file_id):
838
merge_hashes[file_id] = hash
842
def mkdir(self, path, file_id=None):
843
"""See MutableTree.mkdir()."""
845
file_id = generate_ids.gen_file_id(os.path.basename(path))
846
os.mkdir(self.abspath(path))
847
self.add(path, file_id, 'directory')
850
def get_symlink_target(self, file_id):
851
return os.readlink(self.id2abspath(file_id))
853
def file_class(self, filename):
854
if self.path2id(filename):
856
elif self.is_ignored(filename):
862
"""Write the in memory inventory to disk."""
863
# TODO: Maybe this should only write on dirty ?
864
if self._control_files._lock_mode != 'w':
865
raise errors.NotWriteLocked(self)
867
xml5.serializer_v5.write_inventory(self._inventory, sio)
869
self._control_files.put('inventory', sio)
870
self._inventory_is_modified = False
872
def list_files(self, include_root=False):
873
"""Recursively list all files as (path, class, kind, id, entry).
875
Lists, but does not descend into unversioned directories.
877
This does not include files that have been deleted in this
880
Skips the control directory.
882
inv = self._inventory
883
if include_root is True:
884
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
885
# Convert these into local objects to save lookup times
886
pathjoin = osutils.pathjoin
887
file_kind = osutils.file_kind
889
# transport.base ends in a slash, we want the piece
890
# between the last two slashes
891
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
893
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
895
# directory file_id, relative path, absolute path, reverse sorted children
896
children = os.listdir(self.basedir)
898
# jam 20060527 The kernel sized tree seems equivalent whether we
899
# use a deque and popleft to keep them sorted, or if we use a plain
900
# list and just reverse() them.
901
children = collections.deque(children)
902
stack = [(inv.root.file_id, u'', self.basedir, children)]
904
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
907
f = children.popleft()
908
## TODO: If we find a subdirectory with its own .bzr
909
## directory, then that is a separate tree and we
910
## should exclude it.
912
# the bzrdir for this tree
913
if transport_base_dir == f:
916
# we know that from_dir_relpath and from_dir_abspath never end in a slash
917
# and 'f' doesn't begin with one, we can do a string op, rather
918
# than the checks of pathjoin(), all relative paths will have an extra slash
920
fp = from_dir_relpath + '/' + f
923
fap = from_dir_abspath + '/' + f
925
f_ie = inv.get_child(from_dir_id, f)
928
elif self.is_ignored(fp[1:]):
931
# we may not have found this file, because of a unicode issue
932
f_norm, can_access = osutils.normalized_filename(f)
933
if f == f_norm or not can_access:
934
# No change, so treat this file normally
937
# this file can be accessed by a normalized path
938
# check again if it is versioned
939
# these lines are repeated here for performance
941
fp = from_dir_relpath + '/' + f
942
fap = from_dir_abspath + '/' + f
943
f_ie = inv.get_child(from_dir_id, f)
946
elif self.is_ignored(fp[1:]):
955
raise errors.BzrCheckError(
956
"file %r entered as kind %r id %r, now of kind %r"
957
% (fap, f_ie.kind, f_ie.file_id, fk))
959
# make a last minute entry
961
yield fp[1:], c, fk, f_ie.file_id, f_ie
964
yield fp[1:], c, fk, None, fk_entries[fk]()
966
yield fp[1:], c, fk, None, TreeEntry()
969
if fk != 'directory':
972
# But do this child first
973
new_children = os.listdir(fap)
975
new_children = collections.deque(new_children)
976
stack.append((f_ie.file_id, fp, fap, new_children))
977
# Break out of inner loop,
978
# so that we start outer loop with child
981
# if we finished all children, pop it off the stack
984
@needs_tree_write_lock
985
def move(self, from_paths, to_dir=None, after=False, **kwargs):
988
to_dir must exist in the inventory.
990
If to_dir exists and is a directory, the files are moved into
991
it, keeping their old names.
993
Note that to_dir is only the last component of the new name;
994
this doesn't change the directory.
996
For each entry in from_paths the move mode will be determined
999
The first mode moves the file in the filesystem and updates the
1000
inventory. The second mode only updates the inventory without
1001
touching the file on the filesystem. This is the new mode introduced
1004
move uses the second mode if 'after == True' and the target is not
1005
versioned but present in the working tree.
1007
move uses the second mode if 'after == False' and the source is
1008
versioned but no longer in the working tree, and the target is not
1009
versioned but present in the working tree.
1011
move uses the first mode if 'after == False' and the source is
1012
versioned and present in the working tree, and the target is not
1013
versioned and not present in the working tree.
1015
Everything else results in an error.
1017
This returns a list of (from_path, to_path) pairs for each
1018
entry that is moved.
1023
# check for deprecated use of signature
1025
to_dir = kwargs.get('to_name', None)
1027
raise TypeError('You must supply a target directory')
1029
symbol_versioning.warn('The parameter to_name was deprecated'
1030
' in version 0.13. Use to_dir instead',
1033
# check destination directory
1034
assert not isinstance(from_paths, basestring)
1035
inv = self.inventory
1036
to_abs = self.abspath(to_dir)
1037
if not isdir(to_abs):
1038
raise errors.BzrMoveFailedError('',to_dir,
1039
errors.NotADirectory(to_abs))
1040
if not self.has_filename(to_dir):
1041
raise errors.BzrMoveFailedError('',to_dir,
1042
errors.NotInWorkingDirectory(to_dir))
1043
to_dir_id = inv.path2id(to_dir)
1044
if to_dir_id is None:
1045
raise errors.BzrMoveFailedError('',to_dir,
1046
errors.NotVersionedError(path=str(to_dir)))
1048
to_dir_ie = inv[to_dir_id]
1049
if to_dir_ie.kind != 'directory':
1050
raise errors.BzrMoveFailedError('',to_dir,
1051
errors.NotADirectory(to_abs))
1053
# create rename entries and tuples
1054
for from_rel in from_paths:
1055
from_tail = splitpath(from_rel)[-1]
1056
from_id = inv.path2id(from_rel)
1058
raise errors.BzrMoveFailedError(from_rel,to_dir,
1059
errors.NotVersionedError(path=str(from_rel)))
1061
from_entry = inv[from_id]
1062
from_parent_id = from_entry.parent_id
1063
to_rel = pathjoin(to_dir, from_tail)
1064
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1066
from_tail=from_tail,
1067
from_parent_id=from_parent_id,
1068
to_rel=to_rel, to_tail=from_tail,
1069
to_parent_id=to_dir_id)
1070
rename_entries.append(rename_entry)
1071
rename_tuples.append((from_rel, to_rel))
1073
# determine which move mode to use. checks also for movability
1074
rename_entries = self._determine_mv_mode(rename_entries, after)
1076
original_modified = self._inventory_is_modified
1079
self._inventory_is_modified = True
1080
self._move(rename_entries)
1082
# restore the inventory on error
1083
self._inventory_is_modified = original_modified
1085
self._write_inventory(inv)
1086
return rename_tuples
1088
def _determine_mv_mode(self, rename_entries, after=False):
1089
"""Determines for each from-to pair if both inventory and working tree
1090
or only the inventory has to be changed.
1092
Also does basic plausability tests.
1094
inv = self.inventory
1096
for rename_entry in rename_entries:
1097
# store to local variables for easier reference
1098
from_rel = rename_entry.from_rel
1099
from_id = rename_entry.from_id
1100
to_rel = rename_entry.to_rel
1101
to_id = inv.path2id(to_rel)
1102
only_change_inv = False
1104
# check the inventory for source and destination
1106
raise errors.BzrMoveFailedError(from_rel,to_rel,
1107
errors.NotVersionedError(path=str(from_rel)))
1108
if to_id is not None:
1109
raise errors.BzrMoveFailedError(from_rel,to_rel,
1110
errors.AlreadyVersionedError(path=str(to_rel)))
1112
# try to determine the mode for rename (only change inv or change
1113
# inv and file system)
1115
if not self.has_filename(to_rel):
1116
raise errors.BzrMoveFailedError(from_id,to_rel,
1117
errors.NoSuchFile(path=str(to_rel),
1118
extra="New file has not been created yet"))
1119
only_change_inv = True
1120
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1121
only_change_inv = True
1122
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1123
only_change_inv = False
1125
# something is wrong, so lets determine what exactly
1126
if not self.has_filename(from_rel) and \
1127
not self.has_filename(to_rel):
1128
raise errors.BzrRenameFailedError(from_rel,to_rel,
1129
errors.PathsDoNotExist(paths=(str(from_rel),
1132
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1133
extra="(Use --after to update the Bazaar id)")
1134
rename_entry.only_change_inv = only_change_inv
1135
return rename_entries
1137
def _move(self, rename_entries):
1138
"""Moves a list of files.
1140
Depending on the value of the flag 'only_change_inv', the
1141
file will be moved on the file system or not.
1143
inv = self.inventory
1146
for entry in rename_entries:
1148
self._move_entry(entry)
1150
self._rollback_move(moved)
1154
def _rollback_move(self, moved):
1155
"""Try to rollback a previous move in case of an filesystem error."""
1156
inv = self.inventory
1159
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1160
entry.to_tail, entry.to_parent_id, entry.from_rel,
1161
entry.from_tail, entry.from_parent_id,
1162
entry.only_change_inv))
1163
except errors.BzrMoveFailedError, e:
1164
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1165
" The working tree is in an inconsistent state."
1166
" Please consider doing a 'bzr revert'."
1167
" Error message is: %s" % e)
1169
def _move_entry(self, entry):
1170
inv = self.inventory
1171
from_rel_abs = self.abspath(entry.from_rel)
1172
to_rel_abs = self.abspath(entry.to_rel)
1173
if from_rel_abs == to_rel_abs:
1174
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1175
"Source and target are identical.")
1177
if not entry.only_change_inv:
1179
osutils.rename(from_rel_abs, to_rel_abs)
1181
raise errors.BzrMoveFailedError(entry.from_rel,
1183
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1185
@needs_tree_write_lock
1186
def rename_one(self, from_rel, to_rel, after=False):
1189
This can change the directory or the filename or both.
1191
rename_one has several 'modes' to work. First, it can rename a physical
1192
file and change the file_id. That is the normal mode. Second, it can
1193
only change the file_id without touching any physical file. This is
1194
the new mode introduced in version 0.15.
1196
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1197
versioned but present in the working tree.
1199
rename_one uses the second mode if 'after == False' and 'from_rel' is
1200
versioned but no longer in the working tree, and 'to_rel' is not
1201
versioned but present in the working tree.
1203
rename_one uses the first mode if 'after == False' and 'from_rel' is
1204
versioned and present in the working tree, and 'to_rel' is not
1205
versioned and not present in the working tree.
1207
Everything else results in an error.
1209
inv = self.inventory
1212
# create rename entries and tuples
1213
from_tail = splitpath(from_rel)[-1]
1214
from_id = inv.path2id(from_rel)
1216
raise errors.BzrRenameFailedError(from_rel,to_rel,
1217
errors.NotVersionedError(path=str(from_rel)))
1218
from_entry = inv[from_id]
1219
from_parent_id = from_entry.parent_id
1220
to_dir, to_tail = os.path.split(to_rel)
1221
to_dir_id = inv.path2id(to_dir)
1222
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1224
from_tail=from_tail,
1225
from_parent_id=from_parent_id,
1226
to_rel=to_rel, to_tail=to_tail,
1227
to_parent_id=to_dir_id)
1228
rename_entries.append(rename_entry)
1230
# determine which move mode to use. checks also for movability
1231
rename_entries = self._determine_mv_mode(rename_entries, after)
1233
# check if the target changed directory and if the target directory is
1235
if to_dir_id is None:
1236
raise errors.BzrMoveFailedError(from_rel,to_rel,
1237
errors.NotVersionedError(path=str(to_dir)))
1239
# all checks done. now we can continue with our actual work
1240
mutter('rename_one:\n'
1245
' to_dir_id {%s}\n',
1246
from_id, from_rel, to_rel, to_dir, to_dir_id)
1248
self._move(rename_entries)
1249
self._write_inventory(inv)
1251
class _RenameEntry(object):
1252
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1253
to_rel, to_tail, to_parent_id, only_change_inv=False):
1254
self.from_rel = from_rel
1255
self.from_id = from_id
1256
self.from_tail = from_tail
1257
self.from_parent_id = from_parent_id
1258
self.to_rel = to_rel
1259
self.to_tail = to_tail
1260
self.to_parent_id = to_parent_id
1261
self.only_change_inv = only_change_inv
1265
"""Return all unknown files.
1267
These are files in the working directory that are not versioned or
1268
control files or ignored.
1270
# force the extras method to be fully executed before returning, to
1271
# prevent race conditions with the lock
1273
[subp for subp in self.extras() if not self.is_ignored(subp)])
1275
@needs_tree_write_lock
1276
def unversion(self, file_ids):
1277
"""Remove the file ids in file_ids from the current versioned set.
1279
When a file_id is unversioned, all of its children are automatically
1282
:param file_ids: The file ids to stop versioning.
1283
:raises: NoSuchId if any fileid is not currently versioned.
1285
for file_id in file_ids:
1286
if self._inventory.has_id(file_id):
1287
self._inventory.remove_recursive_id(file_id)
1289
raise errors.NoSuchId(self, file_id)
1291
# in the future this should just set a dirty bit to wait for the
1292
# final unlock. However, until all methods of workingtree start
1293
# with the current in -memory inventory rather than triggering
1294
# a read, it is more complex - we need to teach read_inventory
1295
# to know when to read, and when to not read first... and possibly
1296
# to save first when the in memory one may be corrupted.
1297
# so for now, we just only write it if it is indeed dirty.
1299
self._write_inventory(self._inventory)
1301
@deprecated_method(zero_eight)
1302
def iter_conflicts(self):
1303
"""List all files in the tree that have text or content conflicts.
1304
DEPRECATED. Use conflicts instead."""
1305
return self._iter_conflicts()
1307
def _iter_conflicts(self):
1309
for info in self.list_files():
1311
stem = get_conflicted_stem(path)
1314
if stem not in conflicted:
1315
conflicted.add(stem)
1319
def pull(self, source, overwrite=False, stop_revision=None):
1320
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1323
pp = ProgressPhase("Pull phase", 2, top_pb)
1325
old_revision_history = self.branch.revision_history()
1326
basis_tree = self.basis_tree()
1327
count = self.branch.pull(source, overwrite, stop_revision)
1328
new_revision_history = self.branch.revision_history()
1329
if new_revision_history != old_revision_history:
1331
if len(old_revision_history):
1332
other_revision = old_revision_history[-1]
1334
other_revision = None
1335
repository = self.branch.repository
1336
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1338
new_basis_tree = self.branch.basis_tree()
1345
if (basis_tree.inventory.root is None and
1346
new_basis_tree.inventory.root is not None):
1347
self.set_root_id(new_basis_tree.inventory.root.file_id)
1350
# TODO - dedup parents list with things merged by pull ?
1351
# reuse the revisiontree we merged against to set the new
1353
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1354
# we have to pull the merge trees out again, because
1355
# merge_inner has set the ids. - this corner is not yet
1356
# layered well enough to prevent double handling.
1357
merges = self.get_parent_ids()[1:]
1358
parent_trees.extend([
1359
(parent, repository.revision_tree(parent)) for
1361
self.set_parent_trees(parent_trees)
1368
def put_file_bytes_non_atomic(self, file_id, bytes):
1369
"""See MutableTree.put_file_bytes_non_atomic."""
1370
stream = file(self.id2abspath(file_id), 'wb')
1375
# TODO: update the hashcache here ?
1378
"""Yield all unknown files in this WorkingTree.
1380
If there are any unknown directories then only the directory is
1381
returned, not all its children. But if there are unknown files
1382
under a versioned subdirectory, they are returned.
1384
Currently returned depth-first, sorted by name within directories.
1386
## TODO: Work from given directory downwards
1387
for path, dir_entry in self.inventory.directories():
1388
# mutter("search for unknowns in %r", path)
1389
dirabs = self.abspath(path)
1390
if not isdir(dirabs):
1391
# e.g. directory deleted
1395
for subf in os.listdir(dirabs):
1398
if subf not in dir_entry.children:
1399
subf_norm, can_access = osutils.normalized_filename(subf)
1400
if subf_norm != subf and can_access:
1401
if subf_norm not in dir_entry.children:
1402
fl.append(subf_norm)
1408
subp = pathjoin(path, subf)
1411
def ignored_files(self):
1412
"""Yield list of PATH, IGNORE_PATTERN"""
1413
for subp in self.extras():
1414
pat = self.is_ignored(subp)
1418
def get_ignore_list(self):
1419
"""Return list of ignore patterns.
1421
Cached in the Tree object after the first call.
1423
ignoreset = getattr(self, '_ignoreset', None)
1424
if ignoreset is not None:
1427
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1428
ignore_globs.update(ignores.get_runtime_ignores())
1429
ignore_globs.update(ignores.get_user_ignores())
1430
if self.has_filename(bzrlib.IGNORE_FILENAME):
1431
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1433
ignore_globs.update(ignores.parse_ignore_file(f))
1436
self._ignoreset = ignore_globs
1439
def _flush_ignore_list_cache(self):
1440
"""Resets the cached ignore list to force a cache rebuild."""
1441
self._ignoreset = None
1442
self._ignoreglobster = None
1444
def is_ignored(self, filename):
1445
r"""Check whether the filename matches an ignore pattern.
1447
Patterns containing '/' or '\' need to match the whole path;
1448
others match against only the last component.
1450
If the file is ignored, returns the pattern which caused it to
1451
be ignored, otherwise None. So this can simply be used as a
1452
boolean if desired."""
1453
if getattr(self, '_ignoreglobster', None) is None:
1454
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1455
return self._ignoreglobster.match(filename)
1457
def kind(self, file_id):
1458
return file_kind(self.id2abspath(file_id))
1460
def _comparison_data(self, entry, path):
1461
abspath = self.abspath(path)
1463
stat_value = os.lstat(abspath)
1465
if getattr(e, 'errno', None) == errno.ENOENT:
1472
mode = stat_value.st_mode
1473
kind = osutils.file_kind_from_stat_mode(mode)
1474
if not supports_executable():
1475
executable = entry.executable
1477
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1478
return kind, executable, stat_value
1480
def _file_size(self, entry, stat_value):
1481
return stat_value.st_size
1483
def last_revision(self):
1484
"""Return the last revision of the branch for this tree.
1486
This format tree does not support a separate marker for last-revision
1487
compared to the branch.
1489
See MutableTree.last_revision
1491
return self._last_revision()
1494
def _last_revision(self):
1495
"""helper for get_parent_ids."""
1496
return self.branch.last_revision()
1498
def is_locked(self):
1499
return self._control_files.is_locked()
1501
def lock_read(self):
1502
"""See Branch.lock_read, and WorkingTree.unlock."""
1503
self.branch.lock_read()
1505
return self._control_files.lock_read()
1507
self.branch.unlock()
1510
def lock_tree_write(self):
1511
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1512
self.branch.lock_read()
1514
return self._control_files.lock_write()
1516
self.branch.unlock()
1519
def lock_write(self):
1520
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1521
self.branch.lock_write()
1523
return self._control_files.lock_write()
1525
self.branch.unlock()
1528
def get_physical_lock_status(self):
1529
return self._control_files.get_physical_lock_status()
1531
def _basis_inventory_name(self):
1532
return 'basis-inventory-cache'
1534
@needs_tree_write_lock
1535
def set_last_revision(self, new_revision):
1536
"""Change the last revision in the working tree."""
1537
if self._change_last_revision(new_revision):
1538
self._cache_basis_inventory(new_revision)
1540
def _change_last_revision(self, new_revision):
1541
"""Template method part of set_last_revision to perform the change.
1543
This is used to allow WorkingTree3 instances to not affect branch
1544
when their last revision is set.
1546
if new_revision is None:
1547
self.branch.set_revision_history([])
1550
self.branch.generate_revision_history(new_revision)
1551
except errors.NoSuchRevision:
1552
# not present in the repo - dont try to set it deeper than the tip
1553
self.branch.set_revision_history([new_revision])
1556
def _write_basis_inventory(self, xml):
1557
"""Write the basis inventory XML to the basis-inventory file"""
1558
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1559
path = self._basis_inventory_name()
1561
self._control_files.put(path, sio)
1563
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1564
"""Create the text that will be saved in basis-inventory"""
1565
inventory.revision_id = revision_id
1566
return xml6.serializer_v6.write_inventory_to_string(inventory)
1568
def _cache_basis_inventory(self, new_revision):
1569
"""Cache new_revision as the basis inventory."""
1570
# TODO: this should allow the ready-to-use inventory to be passed in,
1571
# as commit already has that ready-to-use [while the format is the
1574
# this double handles the inventory - unpack and repack -
1575
# but is easier to understand. We can/should put a conditional
1576
# in here based on whether the inventory is in the latest format
1577
# - perhaps we should repack all inventories on a repository
1579
# the fast path is to copy the raw xml from the repository. If the
1580
# xml contains 'revision_id="', then we assume the right
1581
# revision_id is set. We must check for this full string, because a
1582
# root node id can legitimately look like 'revision_id' but cannot
1584
xml = self.branch.repository.get_inventory_xml(new_revision)
1585
firstline = xml.split('\n', 1)[0]
1586
if (not 'revision_id="' in firstline or
1587
'format="6"' not in firstline):
1588
inv = self.branch.repository.deserialise_inventory(
1590
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1591
self._write_basis_inventory(xml)
1592
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1595
def read_basis_inventory(self):
1596
"""Read the cached basis inventory."""
1597
path = self._basis_inventory_name()
1598
return self._control_files.get(path).read()
1601
def read_working_inventory(self):
1602
"""Read the working inventory.
1604
:raises errors.InventoryModified: read_working_inventory will fail
1605
when the current in memory inventory has been modified.
1607
# conceptually this should be an implementation detail of the tree.
1608
# XXX: Deprecate this.
1609
# ElementTree does its own conversion from UTF-8, so open in
1611
if self._inventory_is_modified:
1612
raise errors.InventoryModified(self)
1613
result = xml5.serializer_v5.read_inventory(
1614
self._control_files.get('inventory'))
1615
self._set_inventory(result, dirty=False)
1618
@needs_tree_write_lock
1619
def remove(self, files, verbose=False, to_file=None):
1620
"""Remove nominated files from the working inventory..
1622
This does not remove their text. This does not run on XXX on what? RBC
1624
TODO: Refuse to remove modified files unless --force is given?
1626
TODO: Do something useful with directories.
1628
TODO: Should this remove the text or not? Tough call; not
1629
removing may be useful and the user can just use use rm, and
1630
is the opposite of add. Removing it is consistent with most
1631
other tools. Maybe an option.
1633
## TODO: Normalize names
1634
## TODO: Remove nested loops; better scalability
1635
if isinstance(files, basestring):
1638
inv = self.inventory
1640
# do this before any modifications
1642
fid = inv.path2id(f)
1644
# TODO: Perhaps make this just a warning, and continue?
1645
# This tends to happen when
1646
raise errors.NotVersionedError(path=f)
1648
# having remove it, it must be either ignored or unknown
1649
if self.is_ignored(f):
1653
textui.show_status(new_status, inv[fid].kind, f,
1657
self._write_inventory(inv)
1659
@needs_tree_write_lock
1660
def revert(self, filenames, old_tree=None, backups=True,
1661
pb=DummyProgress(), report_changes=False):
1662
from bzrlib.conflicts import resolve
1663
if old_tree is None:
1664
old_tree = self.basis_tree()
1665
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1667
if not len(filenames):
1668
self.set_parent_ids(self.get_parent_ids()[:1])
1671
resolve(self, filenames, ignore_misses=True)
1674
def revision_tree(self, revision_id):
1675
"""See Tree.revision_tree.
1677
WorkingTree can supply revision_trees for the basis revision only
1678
because there is only one cached inventory in the bzr directory.
1680
if revision_id == self.last_revision():
1682
xml = self.read_basis_inventory()
1683
except errors.NoSuchFile:
1687
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1688
# dont use the repository revision_tree api because we want
1689
# to supply the inventory.
1690
if inv.revision_id == revision_id:
1691
return revisiontree.RevisionTree(self.branch.repository,
1693
except errors.BadInventoryFormat:
1695
# raise if there was no inventory, or if we read the wrong inventory.
1696
raise errors.NoSuchRevisionInTree(self, revision_id)
1698
# XXX: This method should be deprecated in favour of taking in a proper
1699
# new Inventory object.
1700
@needs_tree_write_lock
1701
def set_inventory(self, new_inventory_list):
1702
from bzrlib.inventory import (Inventory,
1707
inv = Inventory(self.get_root_id())
1708
for path, file_id, parent, kind in new_inventory_list:
1709
name = os.path.basename(path)
1712
# fixme, there should be a factory function inv,add_??
1713
if kind == 'directory':
1714
inv.add(InventoryDirectory(file_id, name, parent))
1715
elif kind == 'file':
1716
inv.add(InventoryFile(file_id, name, parent))
1717
elif kind == 'symlink':
1718
inv.add(InventoryLink(file_id, name, parent))
1720
raise errors.BzrError("unknown kind %r" % kind)
1721
self._write_inventory(inv)
1723
@needs_tree_write_lock
1724
def set_root_id(self, file_id):
1725
"""Set the root id for this tree."""
1728
symbol_versioning.warn(symbol_versioning.zero_twelve
1729
% 'WorkingTree.set_root_id with fileid=None',
1733
self._set_root_id(file_id)
1735
def _set_root_id(self, file_id):
1736
"""Set the root id for this tree, in a format specific manner.
1738
:param file_id: The file id to assign to the root. It must not be
1739
present in the current inventory or an error will occur. It must
1740
not be None, but rather a valid file id.
1742
inv = self._inventory
1743
orig_root_id = inv.root.file_id
1744
# TODO: it might be nice to exit early if there was nothing
1745
# to do, saving us from trigger a sync on unlock.
1746
self._inventory_is_modified = True
1747
# we preserve the root inventory entry object, but
1748
# unlinkit from the byid index
1749
del inv._byid[inv.root.file_id]
1750
inv.root.file_id = file_id
1751
# and link it into the index with the new changed id.
1752
inv._byid[inv.root.file_id] = inv.root
1753
# and finally update all children to reference the new id.
1754
# XXX: this should be safe to just look at the root.children
1755
# list, not the WHOLE INVENTORY.
1758
if entry.parent_id == orig_root_id:
1759
entry.parent_id = inv.root.file_id
1762
"""See Branch.unlock.
1764
WorkingTree locking just uses the Branch locking facilities.
1765
This is current because all working trees have an embedded branch
1766
within them. IF in the future, we were to make branch data shareable
1767
between multiple working trees, i.e. via shared storage, then we
1768
would probably want to lock both the local tree, and the branch.
1770
raise NotImplementedError(self.unlock)
1773
"""Update a working tree along its branch.
1775
This will update the branch if its bound too, which means we have
1776
multiple trees involved:
1778
- The new basis tree of the master.
1779
- The old basis tree of the branch.
1780
- The old basis tree of the working tree.
1781
- The current working tree state.
1783
Pathologically, all three may be different, and non-ancestors of each
1784
other. Conceptually we want to:
1786
- Preserve the wt.basis->wt.state changes
1787
- Transform the wt.basis to the new master basis.
1788
- Apply a merge of the old branch basis to get any 'local' changes from
1790
- Restore the wt.basis->wt.state changes.
1792
There isn't a single operation at the moment to do that, so we:
1793
- Merge current state -> basis tree of the master w.r.t. the old tree
1795
- Do a 'normal' merge of the old branch basis if it is relevant.
1797
if self.branch.get_master_branch() is not None:
1799
update_branch = True
1801
self.lock_tree_write()
1802
update_branch = False
1805
old_tip = self.branch.update()
1808
return self._update_tree(old_tip)
1812
@needs_tree_write_lock
1813
def _update_tree(self, old_tip=None):
1814
"""Update a tree to the master branch.
1816
:param old_tip: if supplied, the previous tip revision the branch,
1817
before it was changed to the master branch's tip.
1819
# here if old_tip is not None, it is the old tip of the branch before
1820
# it was updated from the master branch. This should become a pending
1821
# merge in the working tree to preserve the user existing work. we
1822
# cant set that until we update the working trees last revision to be
1823
# one from the new branch, because it will just get absorbed by the
1824
# parent de-duplication logic.
1826
# We MUST save it even if an error occurs, because otherwise the users
1827
# local work is unreferenced and will appear to have been lost.
1831
last_rev = self.get_parent_ids()[0]
1834
if last_rev != self.branch.last_revision():
1835
# merge tree state up to new branch tip.
1836
basis = self.basis_tree()
1837
to_tree = self.branch.basis_tree()
1838
if basis.inventory.root is None:
1839
self.set_root_id(to_tree.inventory.root.file_id)
1840
result += merge.merge_inner(
1845
# TODO - dedup parents list with things merged by pull ?
1846
# reuse the tree we've updated to to set the basis:
1847
parent_trees = [(self.branch.last_revision(), to_tree)]
1848
merges = self.get_parent_ids()[1:]
1849
# Ideally we ask the tree for the trees here, that way the working
1850
# tree can decide whether to give us teh entire tree or give us a
1851
# lazy initialised tree. dirstate for instance will have the trees
1852
# in ram already, whereas a last-revision + basis-inventory tree
1853
# will not, but also does not need them when setting parents.
1854
for parent in merges:
1855
parent_trees.append(
1856
(parent, self.branch.repository.revision_tree(parent)))
1857
if old_tip is not None:
1858
parent_trees.append(
1859
(old_tip, self.branch.repository.revision_tree(old_tip)))
1860
self.set_parent_trees(parent_trees)
1861
last_rev = parent_trees[0][0]
1863
# the working tree had the same last-revision as the master
1864
# branch did. We may still have pivot local work from the local
1865
# branch into old_tip:
1866
if old_tip is not None:
1867
self.add_parent_tree_id(old_tip)
1868
if old_tip and old_tip != last_rev:
1869
# our last revision was not the prior branch last revision
1870
# and we have converted that last revision to a pending merge.
1871
# base is somewhere between the branch tip now
1872
# and the now pending merge
1873
from bzrlib.revision import common_ancestor
1875
base_rev_id = common_ancestor(self.branch.last_revision(),
1877
self.branch.repository)
1878
except errors.NoCommonAncestor:
1880
base_tree = self.branch.repository.revision_tree(base_rev_id)
1881
other_tree = self.branch.repository.revision_tree(old_tip)
1882
result += merge.merge_inner(
1889
def _write_hashcache_if_dirty(self):
1890
"""Write out the hashcache if it is dirty."""
1891
if self._hashcache.needs_write:
1893
self._hashcache.write()
1895
if e.errno not in (errno.EPERM, errno.EACCES):
1897
# TODO: jam 20061219 Should this be a warning? A single line
1898
# warning might be sufficient to let the user know what
1900
mutter('Could not write hashcache for %s\nError: %s',
1901
self._hashcache.cache_file_name(), e)
1903
@needs_tree_write_lock
1904
def _write_inventory(self, inv):
1905
"""Write inventory as the current inventory."""
1906
self._set_inventory(inv, dirty=True)
1909
def set_conflicts(self, arg):
1910
raise errors.UnsupportedOperation(self.set_conflicts, self)
1912
def add_conflicts(self, arg):
1913
raise errors.UnsupportedOperation(self.add_conflicts, self)
1916
def conflicts(self):
1917
conflicts = _mod_conflicts.ConflictList()
1918
for conflicted in self._iter_conflicts():
1921
if file_kind(self.abspath(conflicted)) != "file":
1923
except errors.NoSuchFile:
1926
for suffix in ('.THIS', '.OTHER'):
1928
kind = file_kind(self.abspath(conflicted+suffix))
1931
except errors.NoSuchFile:
1935
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1936
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1938
file_id=self.path2id(conflicted)))
1941
def walkdirs(self, prefix=""):
1942
"""Walk the directories of this tree.
1944
This API returns a generator, which is only valid during the current
1945
tree transaction - within a single lock_read or lock_write duration.
1947
If the tree is not locked, it may cause an error to be raised, depending
1948
on the tree implementation.
1950
disk_top = self.abspath(prefix)
1951
if disk_top.endswith('/'):
1952
disk_top = disk_top[:-1]
1953
top_strip_len = len(disk_top) + 1
1954
inventory_iterator = self._walkdirs(prefix)
1955
disk_iterator = osutils.walkdirs(disk_top, prefix)
1957
current_disk = disk_iterator.next()
1958
disk_finished = False
1960
if e.errno != errno.ENOENT:
1963
disk_finished = True
1965
current_inv = inventory_iterator.next()
1966
inv_finished = False
1967
except StopIteration:
1970
while not inv_finished or not disk_finished:
1971
if not disk_finished:
1972
# strip out .bzr dirs
1973
if current_disk[0][1][top_strip_len:] == '':
1974
# osutils.walkdirs can be made nicer -
1975
# yield the path-from-prefix rather than the pathjoined
1977
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
1978
if current_disk[1][bzrdir_loc][0] == '.bzr':
1979
# we dont yield the contents of, or, .bzr itself.
1980
del current_disk[1][bzrdir_loc]
1982
# everything is unknown
1985
# everything is missing
1988
direction = cmp(current_inv[0][0], current_disk[0][0])
1990
# disk is before inventory - unknown
1991
dirblock = [(relpath, basename, kind, stat, None, None) for
1992
relpath, basename, kind, stat, top_path in current_disk[1]]
1993
yield (current_disk[0][0], None), dirblock
1995
current_disk = disk_iterator.next()
1996
except StopIteration:
1997
disk_finished = True
1999
# inventory is before disk - missing.
2000
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2001
for relpath, basename, dkind, stat, fileid, kind in
2003
yield (current_inv[0][0], current_inv[0][1]), dirblock
2005
current_inv = inventory_iterator.next()
2006
except StopIteration:
2009
# versioned present directory
2010
# merge the inventory and disk data together
2012
for relpath, subiterator in itertools.groupby(sorted(
2013
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2014
path_elements = list(subiterator)
2015
if len(path_elements) == 2:
2016
inv_row, disk_row = path_elements
2017
# versioned, present file
2018
dirblock.append((inv_row[0],
2019
inv_row[1], disk_row[2],
2020
disk_row[3], inv_row[4],
2022
elif len(path_elements[0]) == 5:
2024
dirblock.append((path_elements[0][0],
2025
path_elements[0][1], path_elements[0][2],
2026
path_elements[0][3], None, None))
2027
elif len(path_elements[0]) == 6:
2028
# versioned, absent file.
2029
dirblock.append((path_elements[0][0],
2030
path_elements[0][1], 'unknown', None,
2031
path_elements[0][4], path_elements[0][5]))
2033
raise NotImplementedError('unreachable code')
2034
yield current_inv[0], dirblock
2036
current_inv = inventory_iterator.next()
2037
except StopIteration:
2040
current_disk = disk_iterator.next()
2041
except StopIteration:
2042
disk_finished = True
2044
def _walkdirs(self, prefix=""):
2045
_directory = 'directory'
2046
# get the root in the inventory
2047
inv = self.inventory
2048
top_id = inv.path2id(prefix)
2052
pending = [(prefix, '', _directory, None, top_id, None)]
2055
currentdir = pending.pop()
2056
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2057
top_id = currentdir[4]
2059
relroot = currentdir[0] + '/'
2062
# FIXME: stash the node in pending
2064
for name, child in entry.sorted_children():
2065
dirblock.append((relroot + name, name, child.kind, None,
2066
child.file_id, child.kind
2068
yield (currentdir[0], entry.file_id), dirblock
2069
# push the user specified dirs from dirblock
2070
for dir in reversed(dirblock):
2071
if dir[2] == _directory:
2075
class WorkingTree2(WorkingTree):
2076
"""This is the Format 2 working tree.
2078
This was the first weave based working tree.
2079
- uses os locks for locking.
2080
- uses the branch last-revision.
2083
def lock_tree_write(self):
2084
"""See WorkingTree.lock_tree_write().
2086
In Format2 WorkingTrees we have a single lock for the branch and tree
2087
so lock_tree_write() degrades to lock_write().
2089
self.branch.lock_write()
2091
return self._control_files.lock_write()
2093
self.branch.unlock()
2097
# we share control files:
2098
if self._control_files._lock_count == 3:
2099
# _inventory_is_modified is always False during a read lock.
2100
if self._inventory_is_modified:
2102
self._write_hashcache_if_dirty()
2104
# reverse order of locking.
2106
return self._control_files.unlock()
2108
self.branch.unlock()
2111
class WorkingTree3(WorkingTree):
2112
"""This is the Format 3 working tree.
2114
This differs from the base WorkingTree by:
2115
- having its own file lock
2116
- having its own last-revision property.
2118
This is new in bzr 0.8
2122
def _last_revision(self):
2123
"""See Mutable.last_revision."""
2125
return self._control_files.get_utf8('last-revision').read()
2126
except errors.NoSuchFile:
2129
def _change_last_revision(self, revision_id):
2130
"""See WorkingTree._change_last_revision."""
2131
if revision_id is None or revision_id == NULL_REVISION:
2133
self._control_files._transport.delete('last-revision')
2134
except errors.NoSuchFile:
2138
self._control_files.put_utf8('last-revision', revision_id)
2141
@needs_tree_write_lock
2142
def set_conflicts(self, conflicts):
2143
self._put_rio('conflicts', conflicts.to_stanzas(),
2146
@needs_tree_write_lock
2147
def add_conflicts(self, new_conflicts):
2148
conflict_set = set(self.conflicts())
2149
conflict_set.update(set(list(new_conflicts)))
2150
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2151
key=_mod_conflicts.Conflict.sort_key)))
2154
def conflicts(self):
2156
confile = self._control_files.get('conflicts')
2157
except errors.NoSuchFile:
2158
return _mod_conflicts.ConflictList()
2160
if confile.next() != CONFLICT_HEADER_1 + '\n':
2161
raise errors.ConflictFormatError()
2162
except StopIteration:
2163
raise errors.ConflictFormatError()
2164
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2167
if self._control_files._lock_count == 1:
2168
# _inventory_is_modified is always False during a read lock.
2169
if self._inventory_is_modified:
2171
self._write_hashcache_if_dirty()
2172
# reverse order of locking.
2174
return self._control_files.unlock()
2176
self.branch.unlock()
2179
def get_conflicted_stem(path):
2180
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2181
if path.endswith(suffix):
2182
return path[:-len(suffix)]
2185
@deprecated_function(zero_eight)
2186
def is_control_file(filename):
2187
"""See WorkingTree.is_control_filename(filename)."""
2188
## FIXME: better check
2189
filename = normpath(filename)
2190
while filename != '':
2191
head, tail = os.path.split(filename)
2192
## mutter('check %r for control file' % ((head, tail),))
2195
if filename == head:
2201
class WorkingTreeFormat(object):
2202
"""An encapsulation of the initialization and open routines for a format.
2204
Formats provide three things:
2205
* An initialization routine,
2209
Formats are placed in an dict by their format string for reference
2210
during workingtree opening. Its not required that these be instances, they
2211
can be classes themselves with class methods - it simply depends on
2212
whether state is needed for a given format or not.
2214
Once a format is deprecated, just deprecate the initialize and open
2215
methods on the format class. Do not deprecate the object, as the
2216
object will be created every time regardless.
2219
_default_format = None
2220
"""The default format used for new trees."""
2223
"""The known formats."""
2226
def find_format(klass, a_bzrdir):
2227
"""Return the format for the working tree object in a_bzrdir."""
2229
transport = a_bzrdir.get_workingtree_transport(None)
2230
format_string = transport.get("format").read()
2231
return klass._formats[format_string]
2232
except errors.NoSuchFile:
2233
raise errors.NoWorkingTree(base=transport.base)
2235
raise errors.UnknownFormatError(format=format_string)
2238
def get_default_format(klass):
2239
"""Return the current default format."""
2240
return klass._default_format
2242
def get_format_string(self):
2243
"""Return the ASCII format string that identifies this format."""
2244
raise NotImplementedError(self.get_format_string)
2246
def get_format_description(self):
2247
"""Return the short description for this format."""
2248
raise NotImplementedError(self.get_format_description)
2250
def is_supported(self):
2251
"""Is this format supported?
2253
Supported formats can be initialized and opened.
2254
Unsupported formats may not support initialization or committing or
2255
some other features depending on the reason for not being supported.
2260
def register_format(klass, format):
2261
klass._formats[format.get_format_string()] = format
2264
def set_default_format(klass, format):
2265
klass._default_format = format
2268
def unregister_format(klass, format):
2269
assert klass._formats[format.get_format_string()] is format
2270
del klass._formats[format.get_format_string()]
2274
class WorkingTreeFormat2(WorkingTreeFormat):
2275
"""The second working tree format.
2277
This format modified the hash cache from the format 1 hash cache.
2280
def get_format_description(self):
2281
"""See WorkingTreeFormat.get_format_description()."""
2282
return "Working tree format 2"
2284
def stub_initialize_remote(self, control_files):
2285
"""As a special workaround create critical control files for a remote working tree
2287
This ensures that it can later be updated and dealt with locally,
2288
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2289
no working tree. (See bug #43064).
2293
xml5.serializer_v5.write_inventory(inv, sio)
2295
control_files.put('inventory', sio)
2297
control_files.put_utf8('pending-merges', '')
2300
def initialize(self, a_bzrdir, revision_id=None):
2301
"""See WorkingTreeFormat.initialize()."""
2302
if not isinstance(a_bzrdir.transport, LocalTransport):
2303
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2304
branch = a_bzrdir.open_branch()
2305
if revision_id is not None:
2308
revision_history = branch.revision_history()
2310
position = revision_history.index(revision_id)
2312
raise errors.NoSuchRevision(branch, revision_id)
2313
branch.set_revision_history(revision_history[:position + 1])
2316
revision = branch.last_revision()
2318
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2324
basis_tree = branch.repository.revision_tree(revision)
2325
if basis_tree.inventory.root is not None:
2326
wt.set_root_id(basis_tree.inventory.root.file_id)
2327
# set the parent list and cache the basis tree.
2328
wt.set_parent_trees([(revision, basis_tree)])
2329
transform.build_tree(basis_tree, wt)
2333
super(WorkingTreeFormat2, self).__init__()
2334
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2336
def open(self, a_bzrdir, _found=False):
2337
"""Return the WorkingTree object for a_bzrdir
2339
_found is a private parameter, do not use it. It is used to indicate
2340
if format probing has already been done.
2343
# we are being called directly and must probe.
2344
raise NotImplementedError
2345
if not isinstance(a_bzrdir.transport, LocalTransport):
2346
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2347
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2353
class WorkingTreeFormat3(WorkingTreeFormat):
2354
"""The second working tree format updated to record a format marker.
2357
- exists within a metadir controlling .bzr
2358
- includes an explicit version marker for the workingtree control
2359
files, separate from the BzrDir format
2360
- modifies the hash cache format
2362
- uses a LockDir to guard access for writes.
2365
def get_format_string(self):
2366
"""See WorkingTreeFormat.get_format_string()."""
2367
return "Bazaar-NG Working Tree format 3"
2369
def get_format_description(self):
2370
"""See WorkingTreeFormat.get_format_description()."""
2371
return "Working tree format 3"
2373
_lock_file_name = 'lock'
2374
_lock_class = LockDir
2376
def _open_control_files(self, a_bzrdir):
2377
transport = a_bzrdir.get_workingtree_transport(None)
2378
return LockableFiles(transport, self._lock_file_name,
2381
def initialize(self, a_bzrdir, revision_id=None):
2382
"""See WorkingTreeFormat.initialize().
2384
revision_id allows creating a working tree at a different
2385
revision than the branch is at.
2387
if not isinstance(a_bzrdir.transport, LocalTransport):
2388
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2389
transport = a_bzrdir.get_workingtree_transport(self)
2390
control_files = self._open_control_files(a_bzrdir)
2391
control_files.create_lock()
2392
control_files.lock_write()
2393
control_files.put_utf8('format', self.get_format_string())
2394
branch = a_bzrdir.open_branch()
2395
if revision_id is None:
2396
revision_id = branch.last_revision()
2397
# WorkingTree3 can handle an inventory which has a unique root id.
2398
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2399
# those trees. And because there isn't a format bump inbetween, we
2400
# are maintaining compatibility with older clients.
2401
# inv = Inventory(root_id=gen_root_id())
2403
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2409
_control_files=control_files)
2410
wt.lock_tree_write()
2412
basis_tree = branch.repository.revision_tree(revision_id)
2413
# only set an explicit root id if there is one to set.
2414
if basis_tree.inventory.root is not None:
2415
wt.set_root_id(basis_tree.inventory.root.file_id)
2416
if revision_id == NULL_REVISION:
2417
wt.set_parent_trees([])
2419
wt.set_parent_trees([(revision_id, basis_tree)])
2420
transform.build_tree(basis_tree, wt)
2422
# Unlock in this order so that the unlock-triggers-flush in
2423
# WorkingTree is given a chance to fire.
2424
control_files.unlock()
2429
super(WorkingTreeFormat3, self).__init__()
2430
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2432
def open(self, a_bzrdir, _found=False):
2433
"""Return the WorkingTree object for a_bzrdir
2435
_found is a private parameter, do not use it. It is used to indicate
2436
if format probing has already been done.
2439
# we are being called directly and must probe.
2440
raise NotImplementedError
2441
if not isinstance(a_bzrdir.transport, LocalTransport):
2442
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2443
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2445
def _open(self, a_bzrdir, control_files):
2446
"""Open the tree itself.
2448
:param a_bzrdir: the dir for the tree.
2449
:param control_files: the control files for the tree.
2451
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2455
_control_files=control_files)
2458
return self.get_format_string()
2461
__default_format = WorkingTreeFormat3()
2462
WorkingTreeFormat.register_format(__default_format)
2463
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2464
WorkingTreeFormat.set_default_format(__default_format)
2465
# formats which have no format string are not discoverable
2466
# and not independently creatable, so are not registered.
2467
_legacy_formats = [WorkingTreeFormat2(),
2471
class WorkingTreeTestProviderAdapter(object):
2472
"""A tool to generate a suite testing multiple workingtree formats at once.
2474
This is done by copying the test once for each transport and injecting
2475
the transport_server, transport_readonly_server, and workingtree_format
2476
classes into each copy. Each copy is also given a new id() to make it
2480
def __init__(self, transport_server, transport_readonly_server, formats):
2481
self._transport_server = transport_server
2482
self._transport_readonly_server = transport_readonly_server
2483
self._formats = formats
2485
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2486
"""Clone test for adaption."""
2487
new_test = deepcopy(test)
2488
new_test.transport_server = self._transport_server
2489
new_test.transport_readonly_server = self._transport_readonly_server
2490
new_test.bzrdir_format = bzrdir_format
2491
new_test.workingtree_format = workingtree_format
2492
def make_new_test_id():
2493
new_id = "%s(%s)" % (test.id(), variation)
2494
return lambda: new_id
2495
new_test.id = make_new_test_id()
2498
def adapt(self, test):
2499
from bzrlib.tests import TestSuite
2500
result = TestSuite()
2501
for workingtree_format, bzrdir_format in self._formats:
2502
new_test = self._clone_test(
2505
workingtree_format, workingtree_format.__class__.__name__)
2506
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
