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('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
512
parents.append(revision_id)
516
def get_root_id(self):
517
"""Return the id of this trees root"""
518
return self._inventory.root.file_id
520
def _get_store_filename(self, file_id):
521
## XXX: badly named; this is not in the store at all
522
return self.abspath(self.id2path(file_id))
525
def clone(self, to_bzrdir, revision_id=None, basis=None):
526
"""Duplicate this working tree into to_bzr, including all state.
528
Specifically modified files are kept as modified, but
529
ignored and unknown files are discarded.
531
If you want to make a new line of development, see bzrdir.sprout()
534
If not None, the cloned tree will have its last revision set to
535
revision, and and difference between the source trees last revision
536
and this one merged in.
539
If not None, a closer copy of a tree which may have some files in
540
common, and which file content should be preferentially copied from.
542
# assumes the target bzr dir format is compatible.
543
result = self._format.initialize(to_bzrdir)
544
self.copy_content_into(result, revision_id)
548
def copy_content_into(self, tree, revision_id=None):
549
"""Copy the current content and user files of this tree into tree."""
550
tree.set_root_id(self.get_root_id())
551
if revision_id is None:
552
merge.transform_tree(tree, self)
554
# TODO now merge from tree.last_revision to revision (to preserve
555
# user local changes)
556
merge.transform_tree(tree, self)
557
tree.set_parent_ids([revision_id])
559
def id2abspath(self, file_id):
560
return self.abspath(self.id2path(file_id))
562
def has_id(self, file_id):
563
# files that have been deleted are excluded
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
if file_id == self.inventory.root.file_id:
573
return self.inventory.has_id(file_id)
575
__contains__ = has_id
577
def get_file_size(self, file_id):
578
return os.path.getsize(self.id2abspath(file_id))
581
def get_file_sha1(self, file_id, path=None, stat_value=None):
583
path = self._inventory.id2path(file_id)
584
return self._hashcache.get_sha1(path, stat_value)
586
def get_file_mtime(self, file_id, path=None):
588
path = self._inventory.id2path(file_id)
589
return os.lstat(self.abspath(path)).st_mtime
591
if not supports_executable():
592
def is_executable(self, file_id, path=None):
593
return self._inventory[file_id].executable
595
def is_executable(self, file_id, path=None):
597
path = self.id2path(file_id)
598
mode = os.lstat(self.abspath(path)).st_mode
599
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
602
def _add(self, files, ids, kinds):
603
"""See MutableTree._add."""
604
# TODO: Re-adding a file that is removed in the working copy
605
# should probably put it back with the previous ID.
606
# the read and write working inventory should not occur in this
607
# function - they should be part of lock_write and unlock.
608
inv = self.read_working_inventory()
609
for f, file_id, kind in zip(files, ids, kinds):
610
assert kind is not None
612
inv.add_path(f, kind=kind)
614
inv.add_path(f, kind=kind, file_id=file_id)
615
self._write_inventory(inv)
617
@needs_tree_write_lock
618
def _gather_kinds(self, files, kinds):
619
"""See MutableTree._gather_kinds."""
620
for pos, f in enumerate(files):
621
if kinds[pos] is None:
622
fullpath = normpath(self.abspath(f))
624
kinds[pos] = file_kind(fullpath)
626
if e.errno == errno.ENOENT:
627
raise errors.NoSuchFile(fullpath)
630
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
631
"""Add revision_id as a parent.
633
This is equivalent to retrieving the current list of parent ids
634
and setting the list to its value plus revision_id.
636
:param revision_id: The revision id to add to the parent list. It may
637
be a ghost revision as long as its not the first parent to be added,
638
or the allow_leftmost_as_ghost parameter is set True.
639
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
641
parents = self.get_parent_ids() + [revision_id]
642
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
643
or allow_leftmost_as_ghost)
645
@needs_tree_write_lock
646
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
647
"""Add revision_id, tree tuple as a parent.
649
This is equivalent to retrieving the current list of parent trees
650
and setting the list to its value plus parent_tuple. See also
651
add_parent_tree_id - if you only have a parent id available it will be
652
simpler to use that api. If you have the parent already available, using
653
this api is preferred.
655
:param parent_tuple: The (revision id, tree) to add to the parent list.
656
If the revision_id is a ghost, pass None for the tree.
657
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
659
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
660
if len(parent_ids) > 1:
661
# the leftmost may have already been a ghost, preserve that if it
663
allow_leftmost_as_ghost = True
664
self.set_parent_ids(parent_ids,
665
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
667
@needs_tree_write_lock
668
def add_pending_merge(self, *revision_ids):
669
# TODO: Perhaps should check at this point that the
670
# history of the revision is actually present?
671
parents = self.get_parent_ids()
673
for rev_id in revision_ids:
674
if rev_id in parents:
676
parents.append(rev_id)
679
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
681
@deprecated_method(zero_eleven)
683
def pending_merges(self):
684
"""Return a list of pending merges.
686
These are revisions that have been merged into the working
687
directory but not yet committed.
689
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
690
instead - which is available on all tree objects.
692
return self.get_parent_ids()[1:]
694
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
695
"""Common ghost checking functionality from set_parent_*.
697
This checks that the left hand-parent exists if there are any
700
if len(revision_ids) > 0:
701
leftmost_id = revision_ids[0]
702
if (not allow_leftmost_as_ghost and not
703
self.branch.repository.has_revision(leftmost_id)):
704
raise errors.GhostRevisionUnusableHere(leftmost_id)
706
def _set_merges_from_parent_ids(self, parent_ids):
707
merges = parent_ids[1:]
708
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
710
@needs_tree_write_lock
711
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
712
"""Set the parent ids to revision_ids.
714
See also set_parent_trees. This api will try to retrieve the tree data
715
for each element of revision_ids from the trees repository. If you have
716
tree data already available, it is more efficient to use
717
set_parent_trees rather than set_parent_ids. set_parent_ids is however
718
an easier API to use.
720
:param revision_ids: The revision_ids to set as the parent ids of this
721
working tree. Any of these may be ghosts.
723
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
724
self._check_parents_for_ghosts(revision_ids,
725
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
727
if len(revision_ids) > 0:
728
self.set_last_revision(revision_ids[0])
730
self.set_last_revision(None)
732
self._set_merges_from_parent_ids(revision_ids)
734
@needs_tree_write_lock
735
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
736
"""See MutableTree.set_parent_trees."""
737
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
739
self._check_parents_for_ghosts(parent_ids,
740
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
742
if len(parent_ids) == 0:
743
leftmost_parent_id = None
744
leftmost_parent_tree = None
746
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
748
if self._change_last_revision(leftmost_parent_id):
749
if leftmost_parent_tree is None:
750
# If we don't have a tree, fall back to reading the
751
# parent tree from the repository.
752
self._cache_basis_inventory(leftmost_parent_id)
754
inv = leftmost_parent_tree.inventory
755
xml = self._create_basis_xml_from_inventory(
756
leftmost_parent_id, inv)
757
self._write_basis_inventory(xml)
758
self._set_merges_from_parent_ids(parent_ids)
760
@needs_tree_write_lock
761
def set_pending_merges(self, rev_list):
762
parents = self.get_parent_ids()
763
leftmost = parents[:1]
764
new_parents = leftmost + rev_list
765
self.set_parent_ids(new_parents)
767
@needs_tree_write_lock
768
def set_merge_modified(self, modified_hashes):
770
for file_id, hash in modified_hashes.iteritems():
771
yield Stanza(file_id=file_id, hash=hash)
772
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
774
@needs_tree_write_lock
775
def _put_rio(self, filename, stanzas, header):
776
my_file = rio_file(stanzas, header)
777
self._control_files.put(filename, my_file)
779
@needs_write_lock # because merge pulls data into the branch.
780
def merge_from_branch(self, branch, to_revision=None):
781
"""Merge from a branch into this working tree.
783
:param branch: The branch to merge from.
784
:param to_revision: If non-None, the merge will merge to to_revision,
785
but not beyond it. to_revision does not need to be in the history
786
of the branch when it is supplied. If None, to_revision defaults to
787
branch.last_revision().
789
from bzrlib.merge import Merger, Merge3Merger
790
pb = bzrlib.ui.ui_factory.nested_progress_bar()
792
merger = Merger(self.branch, this_tree=self, pb=pb)
793
merger.pp = ProgressPhase("Merge phase", 5, pb)
794
merger.pp.next_phase()
795
# check that there are no
797
merger.check_basis(check_clean=True, require_commits=False)
798
if to_revision is None:
799
to_revision = branch.last_revision()
801
to_revision = osutils.safe_revision_id(to_revision)
802
merger.other_rev_id = to_revision
803
if merger.other_rev_id is None:
804
raise error.NoCommits(branch)
805
self.branch.fetch(branch, last_revision=merger.other_rev_id)
806
merger.other_basis = merger.other_rev_id
807
merger.other_tree = self.branch.repository.revision_tree(
809
merger.pp.next_phase()
811
if merger.base_rev_id == merger.other_rev_id:
812
raise errors.PointlessMerge
813
merger.backup_files = False
814
merger.merge_type = Merge3Merger
815
merger.set_interesting_files(None)
816
merger.show_base = False
817
merger.reprocess = False
818
conflicts = merger.do_merge()
825
def merge_modified(self):
827
hashfile = self._control_files.get('merge-hashes')
828
except errors.NoSuchFile:
832
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
833
raise errors.MergeModifiedFormatError()
834
except StopIteration:
835
raise errors.MergeModifiedFormatError()
836
for s in RioReader(hashfile):
837
file_id = s.get("file_id")
838
if file_id not in self.inventory:
841
if hash == self.get_file_sha1(file_id):
842
merge_hashes[file_id] = hash
846
def mkdir(self, path, file_id=None):
847
"""See MutableTree.mkdir()."""
849
file_id = generate_ids.gen_file_id(os.path.basename(path))
850
os.mkdir(self.abspath(path))
851
self.add(path, file_id, 'directory')
854
def get_symlink_target(self, file_id):
855
return os.readlink(self.id2abspath(file_id))
857
def file_class(self, filename):
858
if self.path2id(filename):
860
elif self.is_ignored(filename):
866
"""Write the in memory inventory to disk."""
867
# TODO: Maybe this should only write on dirty ?
868
if self._control_files._lock_mode != 'w':
869
raise errors.NotWriteLocked(self)
871
xml5.serializer_v5.write_inventory(self._inventory, sio)
873
self._control_files.put('inventory', sio)
874
self._inventory_is_modified = False
876
def list_files(self, include_root=False):
877
"""Recursively list all files as (path, class, kind, id, entry).
879
Lists, but does not descend into unversioned directories.
881
This does not include files that have been deleted in this
884
Skips the control directory.
886
# list_files is an iterator, so @needs_read_lock doesn't work properly
887
# with it. So callers should be careful to always read_lock the tree.
888
if not self.is_locked():
889
raise errors.ObjectNotLocked(self)
892
if include_root is True:
893
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
894
# Convert these into local objects to save lookup times
895
pathjoin = osutils.pathjoin
896
file_kind = osutils.file_kind
898
# transport.base ends in a slash, we want the piece
899
# between the last two slashes
900
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
902
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
904
# directory file_id, relative path, absolute path, reverse sorted children
905
children = os.listdir(self.basedir)
907
# jam 20060527 The kernel sized tree seems equivalent whether we
908
# use a deque and popleft to keep them sorted, or if we use a plain
909
# list and just reverse() them.
910
children = collections.deque(children)
911
stack = [(inv.root.file_id, u'', self.basedir, children)]
913
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
916
f = children.popleft()
917
## TODO: If we find a subdirectory with its own .bzr
918
## directory, then that is a separate tree and we
919
## should exclude it.
921
# the bzrdir for this tree
922
if transport_base_dir == f:
925
# we know that from_dir_relpath and from_dir_abspath never end in a slash
926
# and 'f' doesn't begin with one, we can do a string op, rather
927
# than the checks of pathjoin(), all relative paths will have an extra slash
929
fp = from_dir_relpath + '/' + f
932
fap = from_dir_abspath + '/' + f
934
f_ie = inv.get_child(from_dir_id, f)
937
elif self.is_ignored(fp[1:]):
940
# we may not have found this file, because of a unicode issue
941
f_norm, can_access = osutils.normalized_filename(f)
942
if f == f_norm or not can_access:
943
# No change, so treat this file normally
946
# this file can be accessed by a normalized path
947
# check again if it is versioned
948
# these lines are repeated here for performance
950
fp = from_dir_relpath + '/' + f
951
fap = from_dir_abspath + '/' + f
952
f_ie = inv.get_child(from_dir_id, f)
955
elif self.is_ignored(fp[1:]):
964
raise errors.BzrCheckError(
965
"file %r entered as kind %r id %r, now of kind %r"
966
% (fap, f_ie.kind, f_ie.file_id, fk))
968
# make a last minute entry
970
yield fp[1:], c, fk, f_ie.file_id, f_ie
973
yield fp[1:], c, fk, None, fk_entries[fk]()
975
yield fp[1:], c, fk, None, TreeEntry()
978
if fk != 'directory':
981
# But do this child first
982
new_children = os.listdir(fap)
984
new_children = collections.deque(new_children)
985
stack.append((f_ie.file_id, fp, fap, new_children))
986
# Break out of inner loop,
987
# so that we start outer loop with child
990
# if we finished all children, pop it off the stack
993
@needs_tree_write_lock
994
def move(self, from_paths, to_dir=None, after=False, **kwargs):
997
to_dir must exist in the inventory.
999
If to_dir exists and is a directory, the files are moved into
1000
it, keeping their old names.
1002
Note that to_dir is only the last component of the new name;
1003
this doesn't change the directory.
1005
For each entry in from_paths the move mode will be determined
1008
The first mode moves the file in the filesystem and updates the
1009
inventory. The second mode only updates the inventory without
1010
touching the file on the filesystem. This is the new mode introduced
1013
move uses the second mode if 'after == True' and the target is not
1014
versioned but present in the working tree.
1016
move uses the second mode if 'after == False' and the source is
1017
versioned but no longer in the working tree, and the target is not
1018
versioned but present in the working tree.
1020
move uses the first mode if 'after == False' and the source is
1021
versioned and present in the working tree, and the target is not
1022
versioned and not present in the working tree.
1024
Everything else results in an error.
1026
This returns a list of (from_path, to_path) pairs for each
1027
entry that is moved.
1032
# check for deprecated use of signature
1034
to_dir = kwargs.get('to_name', None)
1036
raise TypeError('You must supply a target directory')
1038
symbol_versioning.warn('The parameter to_name was deprecated'
1039
' in version 0.13. Use to_dir instead',
1042
# check destination directory
1043
assert not isinstance(from_paths, basestring)
1044
inv = self.inventory
1045
to_abs = self.abspath(to_dir)
1046
if not isdir(to_abs):
1047
raise errors.BzrMoveFailedError('',to_dir,
1048
errors.NotADirectory(to_abs))
1049
if not self.has_filename(to_dir):
1050
raise errors.BzrMoveFailedError('',to_dir,
1051
errors.NotInWorkingDirectory(to_dir))
1052
to_dir_id = inv.path2id(to_dir)
1053
if to_dir_id is None:
1054
raise errors.BzrMoveFailedError('',to_dir,
1055
errors.NotVersionedError(path=str(to_dir)))
1057
to_dir_ie = inv[to_dir_id]
1058
if to_dir_ie.kind != 'directory':
1059
raise errors.BzrMoveFailedError('',to_dir,
1060
errors.NotADirectory(to_abs))
1062
# create rename entries and tuples
1063
for from_rel in from_paths:
1064
from_tail = splitpath(from_rel)[-1]
1065
from_id = inv.path2id(from_rel)
1067
raise errors.BzrMoveFailedError(from_rel,to_dir,
1068
errors.NotVersionedError(path=str(from_rel)))
1070
from_entry = inv[from_id]
1071
from_parent_id = from_entry.parent_id
1072
to_rel = pathjoin(to_dir, from_tail)
1073
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1075
from_tail=from_tail,
1076
from_parent_id=from_parent_id,
1077
to_rel=to_rel, to_tail=from_tail,
1078
to_parent_id=to_dir_id)
1079
rename_entries.append(rename_entry)
1080
rename_tuples.append((from_rel, to_rel))
1082
# determine which move mode to use. checks also for movability
1083
rename_entries = self._determine_mv_mode(rename_entries, after)
1085
original_modified = self._inventory_is_modified
1088
self._inventory_is_modified = True
1089
self._move(rename_entries)
1091
# restore the inventory on error
1092
self._inventory_is_modified = original_modified
1094
self._write_inventory(inv)
1095
return rename_tuples
1097
def _determine_mv_mode(self, rename_entries, after=False):
1098
"""Determines for each from-to pair if both inventory and working tree
1099
or only the inventory has to be changed.
1101
Also does basic plausability tests.
1103
inv = self.inventory
1105
for rename_entry in rename_entries:
1106
# store to local variables for easier reference
1107
from_rel = rename_entry.from_rel
1108
from_id = rename_entry.from_id
1109
to_rel = rename_entry.to_rel
1110
to_id = inv.path2id(to_rel)
1111
only_change_inv = False
1113
# check the inventory for source and destination
1115
raise errors.BzrMoveFailedError(from_rel,to_rel,
1116
errors.NotVersionedError(path=str(from_rel)))
1117
if to_id is not None:
1118
raise errors.BzrMoveFailedError(from_rel,to_rel,
1119
errors.AlreadyVersionedError(path=str(to_rel)))
1121
# try to determine the mode for rename (only change inv or change
1122
# inv and file system)
1124
if not self.has_filename(to_rel):
1125
raise errors.BzrMoveFailedError(from_id,to_rel,
1126
errors.NoSuchFile(path=str(to_rel),
1127
extra="New file has not been created yet"))
1128
only_change_inv = True
1129
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1130
only_change_inv = True
1131
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1132
only_change_inv = False
1134
# something is wrong, so lets determine what exactly
1135
if not self.has_filename(from_rel) and \
1136
not self.has_filename(to_rel):
1137
raise errors.BzrRenameFailedError(from_rel,to_rel,
1138
errors.PathsDoNotExist(paths=(str(from_rel),
1141
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1142
extra="(Use --after to update the Bazaar id)")
1143
rename_entry.only_change_inv = only_change_inv
1144
return rename_entries
1146
def _move(self, rename_entries):
1147
"""Moves a list of files.
1149
Depending on the value of the flag 'only_change_inv', the
1150
file will be moved on the file system or not.
1152
inv = self.inventory
1155
for entry in rename_entries:
1157
self._move_entry(entry)
1159
self._rollback_move(moved)
1163
def _rollback_move(self, moved):
1164
"""Try to rollback a previous move in case of an filesystem error."""
1165
inv = self.inventory
1168
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1169
entry.to_tail, entry.to_parent_id, entry.from_rel,
1170
entry.from_tail, entry.from_parent_id,
1171
entry.only_change_inv))
1172
except errors.BzrMoveFailedError, e:
1173
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1174
" The working tree is in an inconsistent state."
1175
" Please consider doing a 'bzr revert'."
1176
" Error message is: %s" % e)
1178
def _move_entry(self, entry):
1179
inv = self.inventory
1180
from_rel_abs = self.abspath(entry.from_rel)
1181
to_rel_abs = self.abspath(entry.to_rel)
1182
if from_rel_abs == to_rel_abs:
1183
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1184
"Source and target are identical.")
1186
if not entry.only_change_inv:
1188
osutils.rename(from_rel_abs, to_rel_abs)
1190
raise errors.BzrMoveFailedError(entry.from_rel,
1192
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1194
@needs_tree_write_lock
1195
def rename_one(self, from_rel, to_rel, after=False):
1198
This can change the directory or the filename or both.
1200
rename_one has several 'modes' to work. First, it can rename a physical
1201
file and change the file_id. That is the normal mode. Second, it can
1202
only change the file_id without touching any physical file. This is
1203
the new mode introduced in version 0.15.
1205
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1206
versioned but present in the working tree.
1208
rename_one uses the second mode if 'after == False' and 'from_rel' is
1209
versioned but no longer in the working tree, and 'to_rel' is not
1210
versioned but present in the working tree.
1212
rename_one uses the first mode if 'after == False' and 'from_rel' is
1213
versioned and present in the working tree, and 'to_rel' is not
1214
versioned and not present in the working tree.
1216
Everything else results in an error.
1218
inv = self.inventory
1221
# create rename entries and tuples
1222
from_tail = splitpath(from_rel)[-1]
1223
from_id = inv.path2id(from_rel)
1225
raise errors.BzrRenameFailedError(from_rel,to_rel,
1226
errors.NotVersionedError(path=str(from_rel)))
1227
from_entry = inv[from_id]
1228
from_parent_id = from_entry.parent_id
1229
to_dir, to_tail = os.path.split(to_rel)
1230
to_dir_id = inv.path2id(to_dir)
1231
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1233
from_tail=from_tail,
1234
from_parent_id=from_parent_id,
1235
to_rel=to_rel, to_tail=to_tail,
1236
to_parent_id=to_dir_id)
1237
rename_entries.append(rename_entry)
1239
# determine which move mode to use. checks also for movability
1240
rename_entries = self._determine_mv_mode(rename_entries, after)
1242
# check if the target changed directory and if the target directory is
1244
if to_dir_id is None:
1245
raise errors.BzrMoveFailedError(from_rel,to_rel,
1246
errors.NotVersionedError(path=str(to_dir)))
1248
# all checks done. now we can continue with our actual work
1249
mutter('rename_one:\n'
1254
' to_dir_id {%s}\n',
1255
from_id, from_rel, to_rel, to_dir, to_dir_id)
1257
self._move(rename_entries)
1258
self._write_inventory(inv)
1260
class _RenameEntry(object):
1261
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1262
to_rel, to_tail, to_parent_id, only_change_inv=False):
1263
self.from_rel = from_rel
1264
self.from_id = from_id
1265
self.from_tail = from_tail
1266
self.from_parent_id = from_parent_id
1267
self.to_rel = to_rel
1268
self.to_tail = to_tail
1269
self.to_parent_id = to_parent_id
1270
self.only_change_inv = only_change_inv
1274
"""Return all unknown files.
1276
These are files in the working directory that are not versioned or
1277
control files or ignored.
1279
# force the extras method to be fully executed before returning, to
1280
# prevent race conditions with the lock
1282
[subp for subp in self.extras() if not self.is_ignored(subp)])
1284
@needs_tree_write_lock
1285
def unversion(self, file_ids):
1286
"""Remove the file ids in file_ids from the current versioned set.
1288
When a file_id is unversioned, all of its children are automatically
1291
:param file_ids: The file ids to stop versioning.
1292
:raises: NoSuchId if any fileid is not currently versioned.
1294
for file_id in file_ids:
1295
if self._inventory.has_id(file_id):
1296
self._inventory.remove_recursive_id(file_id)
1298
raise errors.NoSuchId(self, file_id)
1300
# in the future this should just set a dirty bit to wait for the
1301
# final unlock. However, until all methods of workingtree start
1302
# with the current in -memory inventory rather than triggering
1303
# a read, it is more complex - we need to teach read_inventory
1304
# to know when to read, and when to not read first... and possibly
1305
# to save first when the in memory one may be corrupted.
1306
# so for now, we just only write it if it is indeed dirty.
1308
self._write_inventory(self._inventory)
1310
@deprecated_method(zero_eight)
1311
def iter_conflicts(self):
1312
"""List all files in the tree that have text or content conflicts.
1313
DEPRECATED. Use conflicts instead."""
1314
return self._iter_conflicts()
1316
def _iter_conflicts(self):
1318
for info in self.list_files():
1320
stem = get_conflicted_stem(path)
1323
if stem not in conflicted:
1324
conflicted.add(stem)
1328
def pull(self, source, overwrite=False, stop_revision=None,
1329
change_reporter=None):
1330
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1333
pp = ProgressPhase("Pull phase", 2, top_pb)
1335
old_revision_info = self.branch.last_revision_info()
1336
basis_tree = self.basis_tree()
1337
count = self.branch.pull(source, overwrite, stop_revision)
1338
new_revision_info = self.branch.last_revision_info()
1339
if new_revision_info != old_revision_info:
1341
repository = self.branch.repository
1342
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1343
basis_tree.lock_read()
1345
new_basis_tree = self.branch.basis_tree()
1352
change_reporter=change_reporter)
1353
if (basis_tree.inventory.root is None and
1354
new_basis_tree.inventory.root is not None):
1355
self.set_root_id(new_basis_tree.inventory.root.file_id)
1359
# TODO - dedup parents list with things merged by pull ?
1360
# reuse the revisiontree we merged against to set the new
1362
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1363
# we have to pull the merge trees out again, because
1364
# merge_inner has set the ids. - this corner is not yet
1365
# layered well enough to prevent double handling.
1366
# XXX TODO: Fix the double handling: telling the tree about
1367
# the already known parent data is wasteful.
1368
merges = self.get_parent_ids()[1:]
1369
parent_trees.extend([
1370
(parent, repository.revision_tree(parent)) for
1372
self.set_parent_trees(parent_trees)
1379
def put_file_bytes_non_atomic(self, file_id, bytes):
1380
"""See MutableTree.put_file_bytes_non_atomic."""
1381
stream = file(self.id2abspath(file_id), 'wb')
1386
# TODO: update the hashcache here ?
1389
"""Yield all unknown files in this WorkingTree.
1391
If there are any unknown directories then only the directory is
1392
returned, not all its children. But if there are unknown files
1393
under a versioned subdirectory, they are returned.
1395
Currently returned depth-first, sorted by name within directories.
1397
## TODO: Work from given directory downwards
1398
for path, dir_entry in self.inventory.directories():
1399
# mutter("search for unknowns in %r", path)
1400
dirabs = self.abspath(path)
1401
if not isdir(dirabs):
1402
# e.g. directory deleted
1406
for subf in os.listdir(dirabs):
1409
if subf not in dir_entry.children:
1410
subf_norm, can_access = osutils.normalized_filename(subf)
1411
if subf_norm != subf and can_access:
1412
if subf_norm not in dir_entry.children:
1413
fl.append(subf_norm)
1419
subp = pathjoin(path, subf)
1422
def ignored_files(self):
1423
"""Yield list of PATH, IGNORE_PATTERN"""
1424
for subp in self.extras():
1425
pat = self.is_ignored(subp)
1429
def get_ignore_list(self):
1430
"""Return list of ignore patterns.
1432
Cached in the Tree object after the first call.
1434
ignoreset = getattr(self, '_ignoreset', None)
1435
if ignoreset is not None:
1438
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1439
ignore_globs.update(ignores.get_runtime_ignores())
1440
ignore_globs.update(ignores.get_user_ignores())
1441
if self.has_filename(bzrlib.IGNORE_FILENAME):
1442
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1444
ignore_globs.update(ignores.parse_ignore_file(f))
1447
self._ignoreset = ignore_globs
1450
def _flush_ignore_list_cache(self):
1451
"""Resets the cached ignore list to force a cache rebuild."""
1452
self._ignoreset = None
1453
self._ignoreglobster = None
1455
def is_ignored(self, filename):
1456
r"""Check whether the filename matches an ignore pattern.
1458
Patterns containing '/' or '\' need to match the whole path;
1459
others match against only the last component.
1461
If the file is ignored, returns the pattern which caused it to
1462
be ignored, otherwise None. So this can simply be used as a
1463
boolean if desired."""
1464
if getattr(self, '_ignoreglobster', None) is None:
1465
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1466
return self._ignoreglobster.match(filename)
1468
def kind(self, file_id):
1469
return file_kind(self.id2abspath(file_id))
1471
def _comparison_data(self, entry, path):
1472
abspath = self.abspath(path)
1474
stat_value = os.lstat(abspath)
1476
if getattr(e, 'errno', None) == errno.ENOENT:
1483
mode = stat_value.st_mode
1484
kind = osutils.file_kind_from_stat_mode(mode)
1485
if not supports_executable():
1486
executable = entry.executable
1488
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1489
return kind, executable, stat_value
1491
def _file_size(self, entry, stat_value):
1492
return stat_value.st_size
1494
def last_revision(self):
1495
"""Return the last revision of the branch for this tree.
1497
This format tree does not support a separate marker for last-revision
1498
compared to the branch.
1500
See MutableTree.last_revision
1502
return self._last_revision()
1505
def _last_revision(self):
1506
"""helper for get_parent_ids."""
1507
return self.branch.last_revision()
1509
def is_locked(self):
1510
return self._control_files.is_locked()
1512
def lock_read(self):
1513
"""See Branch.lock_read, and WorkingTree.unlock."""
1514
self.branch.lock_read()
1516
return self._control_files.lock_read()
1518
self.branch.unlock()
1521
def lock_tree_write(self):
1522
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1523
self.branch.lock_read()
1525
return self._control_files.lock_write()
1527
self.branch.unlock()
1530
def lock_write(self):
1531
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1532
self.branch.lock_write()
1534
return self._control_files.lock_write()
1536
self.branch.unlock()
1539
def get_physical_lock_status(self):
1540
return self._control_files.get_physical_lock_status()
1542
def _basis_inventory_name(self):
1543
return 'basis-inventory-cache'
1545
@needs_tree_write_lock
1546
def set_last_revision(self, new_revision):
1547
"""Change the last revision in the working tree."""
1548
new_revision = osutils.safe_revision_id(new_revision)
1549
if self._change_last_revision(new_revision):
1550
self._cache_basis_inventory(new_revision)
1552
def _change_last_revision(self, new_revision):
1553
"""Template method part of set_last_revision to perform the change.
1555
This is used to allow WorkingTree3 instances to not affect branch
1556
when their last revision is set.
1558
if new_revision is None:
1559
self.branch.set_revision_history([])
1562
self.branch.generate_revision_history(new_revision)
1563
except errors.NoSuchRevision:
1564
# not present in the repo - dont try to set it deeper than the tip
1565
self.branch.set_revision_history([new_revision])
1568
def _write_basis_inventory(self, xml):
1569
"""Write the basis inventory XML to the basis-inventory file"""
1570
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1571
path = self._basis_inventory_name()
1573
self._control_files.put(path, sio)
1575
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1576
"""Create the text that will be saved in basis-inventory"""
1577
# TODO: jam 20070209 This should be redundant, as the revision_id
1578
# as all callers should have already converted the revision_id to
1580
inventory.revision_id = osutils.safe_revision_id(revision_id)
1581
return xml6.serializer_v6.write_inventory_to_string(inventory)
1583
def _cache_basis_inventory(self, new_revision):
1584
"""Cache new_revision as the basis inventory."""
1585
# TODO: this should allow the ready-to-use inventory to be passed in,
1586
# as commit already has that ready-to-use [while the format is the
1589
# this double handles the inventory - unpack and repack -
1590
# but is easier to understand. We can/should put a conditional
1591
# in here based on whether the inventory is in the latest format
1592
# - perhaps we should repack all inventories on a repository
1594
# the fast path is to copy the raw xml from the repository. If the
1595
# xml contains 'revision_id="', then we assume the right
1596
# revision_id is set. We must check for this full string, because a
1597
# root node id can legitimately look like 'revision_id' but cannot
1599
xml = self.branch.repository.get_inventory_xml(new_revision)
1600
firstline = xml.split('\n', 1)[0]
1601
if (not 'revision_id="' in firstline or
1602
'format="6"' not in firstline):
1603
inv = self.branch.repository.deserialise_inventory(
1605
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1606
self._write_basis_inventory(xml)
1607
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1610
def read_basis_inventory(self):
1611
"""Read the cached basis inventory."""
1612
path = self._basis_inventory_name()
1613
return self._control_files.get(path).read()
1616
def read_working_inventory(self):
1617
"""Read the working inventory.
1619
:raises errors.InventoryModified: read_working_inventory will fail
1620
when the current in memory inventory has been modified.
1622
# conceptually this should be an implementation detail of the tree.
1623
# XXX: Deprecate this.
1624
# ElementTree does its own conversion from UTF-8, so open in
1626
if self._inventory_is_modified:
1627
raise errors.InventoryModified(self)
1628
result = xml5.serializer_v5.read_inventory(
1629
self._control_files.get('inventory'))
1630
self._set_inventory(result, dirty=False)
1633
@needs_tree_write_lock
1634
def remove(self, files, verbose=False, to_file=None):
1635
"""Remove nominated files from the working inventory..
1637
This does not remove their text. This does not run on XXX on what? RBC
1639
TODO: Refuse to remove modified files unless --force is given?
1641
TODO: Do something useful with directories.
1643
TODO: Should this remove the text or not? Tough call; not
1644
removing may be useful and the user can just use use rm, and
1645
is the opposite of add. Removing it is consistent with most
1646
other tools. Maybe an option.
1648
## TODO: Normalize names
1649
## TODO: Remove nested loops; better scalability
1650
if isinstance(files, basestring):
1653
inv = self.inventory
1655
# do this before any modifications
1657
fid = inv.path2id(f)
1659
note("%s is not versioned."%f)
1662
# having remove it, it must be either ignored or unknown
1663
if self.is_ignored(f):
1667
textui.show_status(new_status, inv[fid].kind, f,
1671
self._write_inventory(inv)
1673
@needs_tree_write_lock
1674
def revert(self, filenames, old_tree=None, backups=True,
1675
pb=DummyProgress(), report_changes=False):
1676
from bzrlib.conflicts import resolve
1677
if old_tree is None:
1678
old_tree = self.basis_tree()
1679
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1681
if not len(filenames):
1682
self.set_parent_ids(self.get_parent_ids()[:1])
1685
resolve(self, filenames, ignore_misses=True)
1688
def revision_tree(self, revision_id):
1689
"""See Tree.revision_tree.
1691
WorkingTree can supply revision_trees for the basis revision only
1692
because there is only one cached inventory in the bzr directory.
1694
if revision_id == self.last_revision():
1696
xml = self.read_basis_inventory()
1697
except errors.NoSuchFile:
1701
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1702
# dont use the repository revision_tree api because we want
1703
# to supply the inventory.
1704
if inv.revision_id == revision_id:
1705
return revisiontree.RevisionTree(self.branch.repository,
1707
except errors.BadInventoryFormat:
1709
# raise if there was no inventory, or if we read the wrong inventory.
1710
raise errors.NoSuchRevisionInTree(self, revision_id)
1712
# XXX: This method should be deprecated in favour of taking in a proper
1713
# new Inventory object.
1714
@needs_tree_write_lock
1715
def set_inventory(self, new_inventory_list):
1716
from bzrlib.inventory import (Inventory,
1721
inv = Inventory(self.get_root_id())
1722
for path, file_id, parent, kind in new_inventory_list:
1723
name = os.path.basename(path)
1726
# fixme, there should be a factory function inv,add_??
1727
if kind == 'directory':
1728
inv.add(InventoryDirectory(file_id, name, parent))
1729
elif kind == 'file':
1730
inv.add(InventoryFile(file_id, name, parent))
1731
elif kind == 'symlink':
1732
inv.add(InventoryLink(file_id, name, parent))
1734
raise errors.BzrError("unknown kind %r" % kind)
1735
self._write_inventory(inv)
1737
@needs_tree_write_lock
1738
def set_root_id(self, file_id):
1739
"""Set the root id for this tree."""
1742
symbol_versioning.warn(symbol_versioning.zero_twelve
1743
% 'WorkingTree.set_root_id with fileid=None',
1747
self._set_root_id(file_id)
1749
def _set_root_id(self, file_id):
1750
"""Set the root id for this tree, in a format specific manner.
1752
:param file_id: The file id to assign to the root. It must not be
1753
present in the current inventory or an error will occur. It must
1754
not be None, but rather a valid file id.
1756
inv = self._inventory
1757
orig_root_id = inv.root.file_id
1758
# TODO: it might be nice to exit early if there was nothing
1759
# to do, saving us from trigger a sync on unlock.
1760
self._inventory_is_modified = True
1761
# we preserve the root inventory entry object, but
1762
# unlinkit from the byid index
1763
del inv._byid[inv.root.file_id]
1764
inv.root.file_id = file_id
1765
# and link it into the index with the new changed id.
1766
inv._byid[inv.root.file_id] = inv.root
1767
# and finally update all children to reference the new id.
1768
# XXX: this should be safe to just look at the root.children
1769
# list, not the WHOLE INVENTORY.
1772
if entry.parent_id == orig_root_id:
1773
entry.parent_id = inv.root.file_id
1776
"""See Branch.unlock.
1778
WorkingTree locking just uses the Branch locking facilities.
1779
This is current because all working trees have an embedded branch
1780
within them. IF in the future, we were to make branch data shareable
1781
between multiple working trees, i.e. via shared storage, then we
1782
would probably want to lock both the local tree, and the branch.
1784
raise NotImplementedError(self.unlock)
1787
"""Update a working tree along its branch.
1789
This will update the branch if its bound too, which means we have
1790
multiple trees involved:
1792
- The new basis tree of the master.
1793
- The old basis tree of the branch.
1794
- The old basis tree of the working tree.
1795
- The current working tree state.
1797
Pathologically, all three may be different, and non-ancestors of each
1798
other. Conceptually we want to:
1800
- Preserve the wt.basis->wt.state changes
1801
- Transform the wt.basis to the new master basis.
1802
- Apply a merge of the old branch basis to get any 'local' changes from
1804
- Restore the wt.basis->wt.state changes.
1806
There isn't a single operation at the moment to do that, so we:
1807
- Merge current state -> basis tree of the master w.r.t. the old tree
1809
- Do a 'normal' merge of the old branch basis if it is relevant.
1811
if self.branch.get_master_branch() is not None:
1813
update_branch = True
1815
self.lock_tree_write()
1816
update_branch = False
1819
old_tip = self.branch.update()
1822
return self._update_tree(old_tip)
1826
@needs_tree_write_lock
1827
def _update_tree(self, old_tip=None):
1828
"""Update a tree to the master branch.
1830
:param old_tip: if supplied, the previous tip revision the branch,
1831
before it was changed to the master branch's tip.
1833
# here if old_tip is not None, it is the old tip of the branch before
1834
# it was updated from the master branch. This should become a pending
1835
# merge in the working tree to preserve the user existing work. we
1836
# cant set that until we update the working trees last revision to be
1837
# one from the new branch, because it will just get absorbed by the
1838
# parent de-duplication logic.
1840
# We MUST save it even if an error occurs, because otherwise the users
1841
# local work is unreferenced and will appear to have been lost.
1845
last_rev = self.get_parent_ids()[0]
1848
if last_rev != self.branch.last_revision():
1849
# merge tree state up to new branch tip.
1850
basis = self.basis_tree()
1853
to_tree = self.branch.basis_tree()
1854
if basis.inventory.root is None and self.inventory.root is None:
1855
self.set_root_id(to_tree.inventory.root.file_id)
1856
result += merge.merge_inner(
1863
# TODO - dedup parents list with things merged by pull ?
1864
# reuse the tree we've updated to to set the basis:
1865
parent_trees = [(self.branch.last_revision(), to_tree)]
1866
merges = self.get_parent_ids()[1:]
1867
# Ideally we ask the tree for the trees here, that way the working
1868
# tree can decide whether to give us teh entire tree or give us a
1869
# lazy initialised tree. dirstate for instance will have the trees
1870
# in ram already, whereas a last-revision + basis-inventory tree
1871
# will not, but also does not need them when setting parents.
1872
for parent in merges:
1873
parent_trees.append(
1874
(parent, self.branch.repository.revision_tree(parent)))
1875
if old_tip is not None:
1876
parent_trees.append(
1877
(old_tip, self.branch.repository.revision_tree(old_tip)))
1878
self.set_parent_trees(parent_trees)
1879
last_rev = parent_trees[0][0]
1881
# the working tree had the same last-revision as the master
1882
# branch did. We may still have pivot local work from the local
1883
# branch into old_tip:
1884
if old_tip is not None:
1885
self.add_parent_tree_id(old_tip)
1886
if old_tip and old_tip != last_rev:
1887
# our last revision was not the prior branch last revision
1888
# and we have converted that last revision to a pending merge.
1889
# base is somewhere between the branch tip now
1890
# and the now pending merge
1892
# Since we just modified the working tree and inventory, flush out
1893
# the current state, before we modify it again.
1894
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
1895
# requires it only because TreeTransform directly munges the
1896
# inventory and calls tree._write_inventory(). Ultimately we
1897
# should be able to remove this extra flush.
1899
from bzrlib.revision import common_ancestor
1901
base_rev_id = common_ancestor(self.branch.last_revision(),
1903
self.branch.repository)
1904
except errors.NoCommonAncestor:
1906
base_tree = self.branch.repository.revision_tree(base_rev_id)
1907
other_tree = self.branch.repository.revision_tree(old_tip)
1908
result += merge.merge_inner(
1915
def _write_hashcache_if_dirty(self):
1916
"""Write out the hashcache if it is dirty."""
1917
if self._hashcache.needs_write:
1919
self._hashcache.write()
1921
if e.errno not in (errno.EPERM, errno.EACCES):
1923
# TODO: jam 20061219 Should this be a warning? A single line
1924
# warning might be sufficient to let the user know what
1926
mutter('Could not write hashcache for %s\nError: %s',
1927
self._hashcache.cache_file_name(), e)
1929
@needs_tree_write_lock
1930
def _write_inventory(self, inv):
1931
"""Write inventory as the current inventory."""
1932
self._set_inventory(inv, dirty=True)
1935
def set_conflicts(self, arg):
1936
raise errors.UnsupportedOperation(self.set_conflicts, self)
1938
def add_conflicts(self, arg):
1939
raise errors.UnsupportedOperation(self.add_conflicts, self)
1942
def conflicts(self):
1943
conflicts = _mod_conflicts.ConflictList()
1944
for conflicted in self._iter_conflicts():
1947
if file_kind(self.abspath(conflicted)) != "file":
1949
except errors.NoSuchFile:
1952
for suffix in ('.THIS', '.OTHER'):
1954
kind = file_kind(self.abspath(conflicted+suffix))
1957
except errors.NoSuchFile:
1961
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1962
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1964
file_id=self.path2id(conflicted)))
1967
def walkdirs(self, prefix=""):
1968
"""Walk the directories of this tree.
1970
This API returns a generator, which is only valid during the current
1971
tree transaction - within a single lock_read or lock_write duration.
1973
If the tree is not locked, it may cause an error to be raised, depending
1974
on the tree implementation.
1976
disk_top = self.abspath(prefix)
1977
if disk_top.endswith('/'):
1978
disk_top = disk_top[:-1]
1979
top_strip_len = len(disk_top) + 1
1980
inventory_iterator = self._walkdirs(prefix)
1981
disk_iterator = osutils.walkdirs(disk_top, prefix)
1983
current_disk = disk_iterator.next()
1984
disk_finished = False
1986
if e.errno != errno.ENOENT:
1989
disk_finished = True
1991
current_inv = inventory_iterator.next()
1992
inv_finished = False
1993
except StopIteration:
1996
while not inv_finished or not disk_finished:
1997
if not disk_finished:
1998
# strip out .bzr dirs
1999
if current_disk[0][1][top_strip_len:] == '':
2000
# osutils.walkdirs can be made nicer -
2001
# yield the path-from-prefix rather than the pathjoined
2003
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2004
if current_disk[1][bzrdir_loc][0] == '.bzr':
2005
# we dont yield the contents of, or, .bzr itself.
2006
del current_disk[1][bzrdir_loc]
2008
# everything is unknown
2011
# everything is missing
2014
direction = cmp(current_inv[0][0], current_disk[0][0])
2016
# disk is before inventory - unknown
2017
dirblock = [(relpath, basename, kind, stat, None, None) for
2018
relpath, basename, kind, stat, top_path in current_disk[1]]
2019
yield (current_disk[0][0], None), dirblock
2021
current_disk = disk_iterator.next()
2022
except StopIteration:
2023
disk_finished = True
2025
# inventory is before disk - missing.
2026
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2027
for relpath, basename, dkind, stat, fileid, kind in
2029
yield (current_inv[0][0], current_inv[0][1]), dirblock
2031
current_inv = inventory_iterator.next()
2032
except StopIteration:
2035
# versioned present directory
2036
# merge the inventory and disk data together
2038
for relpath, subiterator in itertools.groupby(sorted(
2039
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2040
path_elements = list(subiterator)
2041
if len(path_elements) == 2:
2042
inv_row, disk_row = path_elements
2043
# versioned, present file
2044
dirblock.append((inv_row[0],
2045
inv_row[1], disk_row[2],
2046
disk_row[3], inv_row[4],
2048
elif len(path_elements[0]) == 5:
2050
dirblock.append((path_elements[0][0],
2051
path_elements[0][1], path_elements[0][2],
2052
path_elements[0][3], None, None))
2053
elif len(path_elements[0]) == 6:
2054
# versioned, absent file.
2055
dirblock.append((path_elements[0][0],
2056
path_elements[0][1], 'unknown', None,
2057
path_elements[0][4], path_elements[0][5]))
2059
raise NotImplementedError('unreachable code')
2060
yield current_inv[0], dirblock
2062
current_inv = inventory_iterator.next()
2063
except StopIteration:
2066
current_disk = disk_iterator.next()
2067
except StopIteration:
2068
disk_finished = True
2070
def _walkdirs(self, prefix=""):
2071
_directory = 'directory'
2072
# get the root in the inventory
2073
inv = self.inventory
2074
top_id = inv.path2id(prefix)
2078
pending = [(prefix, '', _directory, None, top_id, None)]
2081
currentdir = pending.pop()
2082
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2083
top_id = currentdir[4]
2085
relroot = currentdir[0] + '/'
2088
# FIXME: stash the node in pending
2090
for name, child in entry.sorted_children():
2091
dirblock.append((relroot + name, name, child.kind, None,
2092
child.file_id, child.kind
2094
yield (currentdir[0], entry.file_id), dirblock
2095
# push the user specified dirs from dirblock
2096
for dir in reversed(dirblock):
2097
if dir[2] == _directory:
2101
class WorkingTree2(WorkingTree):
2102
"""This is the Format 2 working tree.
2104
This was the first weave based working tree.
2105
- uses os locks for locking.
2106
- uses the branch last-revision.
2109
def lock_tree_write(self):
2110
"""See WorkingTree.lock_tree_write().
2112
In Format2 WorkingTrees we have a single lock for the branch and tree
2113
so lock_tree_write() degrades to lock_write().
2115
self.branch.lock_write()
2117
return self._control_files.lock_write()
2119
self.branch.unlock()
2123
# we share control files:
2124
if self._control_files._lock_count == 3:
2125
# _inventory_is_modified is always False during a read lock.
2126
if self._inventory_is_modified:
2128
self._write_hashcache_if_dirty()
2130
# reverse order of locking.
2132
return self._control_files.unlock()
2134
self.branch.unlock()
2137
class WorkingTree3(WorkingTree):
2138
"""This is the Format 3 working tree.
2140
This differs from the base WorkingTree by:
2141
- having its own file lock
2142
- having its own last-revision property.
2144
This is new in bzr 0.8
2148
def _last_revision(self):
2149
"""See Mutable.last_revision."""
2151
return osutils.safe_revision_id(
2152
self._control_files.get('last-revision').read())
2153
except errors.NoSuchFile:
2156
def _change_last_revision(self, revision_id):
2157
"""See WorkingTree._change_last_revision."""
2158
if revision_id is None or revision_id == NULL_REVISION:
2160
self._control_files._transport.delete('last-revision')
2161
except errors.NoSuchFile:
2165
self._control_files.put_utf8('last-revision', revision_id)
2168
@needs_tree_write_lock
2169
def set_conflicts(self, conflicts):
2170
self._put_rio('conflicts', conflicts.to_stanzas(),
2173
@needs_tree_write_lock
2174
def add_conflicts(self, new_conflicts):
2175
conflict_set = set(self.conflicts())
2176
conflict_set.update(set(list(new_conflicts)))
2177
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2178
key=_mod_conflicts.Conflict.sort_key)))
2181
def conflicts(self):
2183
confile = self._control_files.get('conflicts')
2184
except errors.NoSuchFile:
2185
return _mod_conflicts.ConflictList()
2187
if confile.next() != CONFLICT_HEADER_1 + '\n':
2188
raise errors.ConflictFormatError()
2189
except StopIteration:
2190
raise errors.ConflictFormatError()
2191
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2194
if self._control_files._lock_count == 1:
2195
# _inventory_is_modified is always False during a read lock.
2196
if self._inventory_is_modified:
2198
self._write_hashcache_if_dirty()
2199
# reverse order of locking.
2201
return self._control_files.unlock()
2203
self.branch.unlock()
2206
def get_conflicted_stem(path):
2207
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2208
if path.endswith(suffix):
2209
return path[:-len(suffix)]
2212
@deprecated_function(zero_eight)
2213
def is_control_file(filename):
2214
"""See WorkingTree.is_control_filename(filename)."""
2215
## FIXME: better check
2216
filename = normpath(filename)
2217
while filename != '':
2218
head, tail = os.path.split(filename)
2219
## mutter('check %r for control file' % ((head, tail),))
2222
if filename == head:
2228
class WorkingTreeFormat(object):
2229
"""An encapsulation of the initialization and open routines for a format.
2231
Formats provide three things:
2232
* An initialization routine,
2236
Formats are placed in an dict by their format string for reference
2237
during workingtree opening. Its not required that these be instances, they
2238
can be classes themselves with class methods - it simply depends on
2239
whether state is needed for a given format or not.
2241
Once a format is deprecated, just deprecate the initialize and open
2242
methods on the format class. Do not deprecate the object, as the
2243
object will be created every time regardless.
2246
_default_format = None
2247
"""The default format used for new trees."""
2250
"""The known formats."""
2253
def find_format(klass, a_bzrdir):
2254
"""Return the format for the working tree object in a_bzrdir."""
2256
transport = a_bzrdir.get_workingtree_transport(None)
2257
format_string = transport.get("format").read()
2258
return klass._formats[format_string]
2259
except errors.NoSuchFile:
2260
raise errors.NoWorkingTree(base=transport.base)
2262
raise errors.UnknownFormatError(format=format_string)
2265
def get_default_format(klass):
2266
"""Return the current default format."""
2267
return klass._default_format
2269
def get_format_string(self):
2270
"""Return the ASCII format string that identifies this format."""
2271
raise NotImplementedError(self.get_format_string)
2273
def get_format_description(self):
2274
"""Return the short description for this format."""
2275
raise NotImplementedError(self.get_format_description)
2277
def is_supported(self):
2278
"""Is this format supported?
2280
Supported formats can be initialized and opened.
2281
Unsupported formats may not support initialization or committing or
2282
some other features depending on the reason for not being supported.
2287
def register_format(klass, format):
2288
klass._formats[format.get_format_string()] = format
2291
def set_default_format(klass, format):
2292
klass._default_format = format
2295
def unregister_format(klass, format):
2296
assert klass._formats[format.get_format_string()] is format
2297
del klass._formats[format.get_format_string()]
2301
class WorkingTreeFormat2(WorkingTreeFormat):
2302
"""The second working tree format.
2304
This format modified the hash cache from the format 1 hash cache.
2307
def get_format_description(self):
2308
"""See WorkingTreeFormat.get_format_description()."""
2309
return "Working tree format 2"
2311
def stub_initialize_remote(self, control_files):
2312
"""As a special workaround create critical control files for a remote working tree
2314
This ensures that it can later be updated and dealt with locally,
2315
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2316
no working tree. (See bug #43064).
2320
xml5.serializer_v5.write_inventory(inv, sio)
2322
control_files.put('inventory', sio)
2324
control_files.put_utf8('pending-merges', '')
2327
def initialize(self, a_bzrdir, revision_id=None):
2328
"""See WorkingTreeFormat.initialize()."""
2329
if not isinstance(a_bzrdir.transport, LocalTransport):
2330
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2331
branch = a_bzrdir.open_branch()
2332
if revision_id is not None:
2333
revision_id = osutils.safe_revision_id(revision_id)
2336
revision_history = branch.revision_history()
2338
position = revision_history.index(revision_id)
2340
raise errors.NoSuchRevision(branch, revision_id)
2341
branch.set_revision_history(revision_history[:position + 1])
2344
revision = branch.last_revision()
2346
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2352
basis_tree = branch.repository.revision_tree(revision)
2353
if basis_tree.inventory.root is not None:
2354
wt.set_root_id(basis_tree.inventory.root.file_id)
2355
# set the parent list and cache the basis tree.
2356
wt.set_parent_trees([(revision, basis_tree)])
2357
transform.build_tree(basis_tree, wt)
2361
super(WorkingTreeFormat2, self).__init__()
2362
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2364
def open(self, a_bzrdir, _found=False):
2365
"""Return the WorkingTree object for a_bzrdir
2367
_found is a private parameter, do not use it. It is used to indicate
2368
if format probing has already been done.
2371
# we are being called directly and must probe.
2372
raise NotImplementedError
2373
if not isinstance(a_bzrdir.transport, LocalTransport):
2374
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2375
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2381
class WorkingTreeFormat3(WorkingTreeFormat):
2382
"""The second working tree format updated to record a format marker.
2385
- exists within a metadir controlling .bzr
2386
- includes an explicit version marker for the workingtree control
2387
files, separate from the BzrDir format
2388
- modifies the hash cache format
2390
- uses a LockDir to guard access for writes.
2393
def get_format_string(self):
2394
"""See WorkingTreeFormat.get_format_string()."""
2395
return "Bazaar-NG Working Tree format 3"
2397
def get_format_description(self):
2398
"""See WorkingTreeFormat.get_format_description()."""
2399
return "Working tree format 3"
2401
_lock_file_name = 'lock'
2402
_lock_class = LockDir
2404
def _open_control_files(self, a_bzrdir):
2405
transport = a_bzrdir.get_workingtree_transport(None)
2406
return LockableFiles(transport, self._lock_file_name,
2409
def initialize(self, a_bzrdir, revision_id=None):
2410
"""See WorkingTreeFormat.initialize().
2412
revision_id allows creating a working tree at a different
2413
revision than the branch is at.
2415
if not isinstance(a_bzrdir.transport, LocalTransport):
2416
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2417
transport = a_bzrdir.get_workingtree_transport(self)
2418
control_files = self._open_control_files(a_bzrdir)
2419
control_files.create_lock()
2420
control_files.lock_write()
2421
control_files.put_utf8('format', self.get_format_string())
2422
branch = a_bzrdir.open_branch()
2423
if revision_id is None:
2424
revision_id = branch.last_revision()
2426
revision_id = osutils.safe_revision_id(revision_id)
2427
# WorkingTree3 can handle an inventory which has a unique root id.
2428
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2429
# those trees. And because there isn't a format bump inbetween, we
2430
# are maintaining compatibility with older clients.
2431
# inv = Inventory(root_id=gen_root_id())
2433
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2439
_control_files=control_files)
2440
wt.lock_tree_write()
2442
basis_tree = branch.repository.revision_tree(revision_id)
2443
# only set an explicit root id if there is one to set.
2444
if basis_tree.inventory.root is not None:
2445
wt.set_root_id(basis_tree.inventory.root.file_id)
2446
if revision_id == NULL_REVISION:
2447
wt.set_parent_trees([])
2449
wt.set_parent_trees([(revision_id, basis_tree)])
2450
transform.build_tree(basis_tree, wt)
2452
# Unlock in this order so that the unlock-triggers-flush in
2453
# WorkingTree is given a chance to fire.
2454
control_files.unlock()
2459
super(WorkingTreeFormat3, self).__init__()
2460
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2462
def open(self, a_bzrdir, _found=False):
2463
"""Return the WorkingTree object for a_bzrdir
2465
_found is a private parameter, do not use it. It is used to indicate
2466
if format probing has already been done.
2469
# we are being called directly and must probe.
2470
raise NotImplementedError
2471
if not isinstance(a_bzrdir.transport, LocalTransport):
2472
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2473
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2475
def _open(self, a_bzrdir, control_files):
2476
"""Open the tree itself.
2478
:param a_bzrdir: the dir for the tree.
2479
:param control_files: the control files for the tree.
2481
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2485
_control_files=control_files)
2488
return self.get_format_string()
2491
__default_format = WorkingTreeFormat3()
2492
WorkingTreeFormat.register_format(__default_format)
2493
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2494
WorkingTreeFormat.set_default_format(__default_format)
2495
# formats which have no format string are not discoverable
2496
# and not independently creatable, so are not registered.
2497
_legacy_formats = [WorkingTreeFormat2(),
2501
class WorkingTreeTestProviderAdapter(object):
2502
"""A tool to generate a suite testing multiple workingtree formats at once.
2504
This is done by copying the test once for each transport and injecting
2505
the transport_server, transport_readonly_server, and workingtree_format
2506
classes into each copy. Each copy is also given a new id() to make it
2510
def __init__(self, transport_server, transport_readonly_server, formats):
2511
self._transport_server = transport_server
2512
self._transport_readonly_server = transport_readonly_server
2513
self._formats = formats
2515
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2516
"""Clone test for adaption."""
2517
new_test = deepcopy(test)
2518
new_test.transport_server = self._transport_server
2519
new_test.transport_readonly_server = self._transport_readonly_server
2520
new_test.bzrdir_format = bzrdir_format
2521
new_test.workingtree_format = workingtree_format
2522
def make_new_test_id():
2523
new_id = "%s(%s)" % (test.id(), variation)
2524
return lambda: new_id
2525
new_test.id = make_new_test_id()
2528
def adapt(self, test):
2529
from bzrlib.tests import TestSuite
2530
result = TestSuite()
2531
for workingtree_format, bzrdir_format in self._formats:
2532
new_test = self._clone_test(
2535
workingtree_format, workingtree_format.__class__.__name__)
2536
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
