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
file_id = osutils.safe_file_id(file_id)
455
return self.get_file_byname(self.id2path(file_id))
457
def get_file_text(self, file_id):
458
file_id = osutils.safe_file_id(file_id)
459
return self.get_file(file_id).read()
461
def get_file_byname(self, filename):
462
return file(self.abspath(filename), 'rb')
465
def annotate_iter(self, file_id):
466
"""See Tree.annotate_iter
468
This implementation will use the basis tree implementation if possible.
469
Lines not in the basis are attributed to CURRENT_REVISION
471
If there are pending merges, lines added by those merges will be
472
incorrectly attributed to CURRENT_REVISION (but after committing, the
473
attribution will be correct).
475
file_id = osutils.safe_file_id(file_id)
476
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [file_id]).next()
478
changed_content, kind = changes[2], changes[6]
479
if not changed_content:
480
return basis.annotate_iter(file_id)
484
if kind[0] != 'file':
487
old_lines = list(basis.annotate_iter(file_id))
489
for tree in self.branch.repository.revision_trees(
490
self.get_parent_ids()[1:]):
491
if file_id not in tree:
493
old.append(list(tree.annotate_iter(file_id)))
494
return annotate.reannotate(old, self.get_file(file_id).readlines(),
497
def get_parent_ids(self):
498
"""See Tree.get_parent_ids.
500
This implementation reads the pending merges list and last_revision
501
value and uses that to decide what the parents list should be.
503
last_rev = self._last_revision()
509
merges_file = self._control_files.get('pending-merges')
510
except errors.NoSuchFile:
513
for l in merges_file.readlines():
514
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
515
parents.append(revision_id)
519
def get_root_id(self):
520
"""Return the id of this trees root"""
521
return self._inventory.root.file_id
523
def _get_store_filename(self, file_id):
524
## XXX: badly named; this is not in the store at all
525
file_id = osutils.safe_file_id(file_id)
526
return self.abspath(self.id2path(file_id))
529
def clone(self, to_bzrdir, revision_id=None, basis=None):
530
"""Duplicate this working tree into to_bzr, including all state.
532
Specifically modified files are kept as modified, but
533
ignored and unknown files are discarded.
535
If you want to make a new line of development, see bzrdir.sprout()
538
If not None, the cloned tree will have its last revision set to
539
revision, and and difference between the source trees last revision
540
and this one merged in.
543
If not None, a closer copy of a tree which may have some files in
544
common, and which file content should be preferentially copied from.
546
# assumes the target bzr dir format is compatible.
547
result = self._format.initialize(to_bzrdir)
548
self.copy_content_into(result, revision_id)
552
def copy_content_into(self, tree, revision_id=None):
553
"""Copy the current content and user files of this tree into tree."""
554
tree.set_root_id(self.get_root_id())
555
if revision_id is None:
556
merge.transform_tree(tree, self)
558
# TODO now merge from tree.last_revision to revision (to preserve
559
# user local changes)
560
merge.transform_tree(tree, self)
561
tree.set_parent_ids([revision_id])
563
def id2abspath(self, file_id):
564
file_id = osutils.safe_file_id(file_id)
565
return self.abspath(self.id2path(file_id))
567
def has_id(self, file_id):
568
# files that have been deleted are excluded
569
file_id = osutils.safe_file_id(file_id)
571
if not inv.has_id(file_id):
573
path = inv.id2path(file_id)
574
return osutils.lexists(self.abspath(path))
576
def has_or_had_id(self, file_id):
577
file_id = osutils.safe_file_id(file_id)
578
if file_id == self.inventory.root.file_id:
580
return self.inventory.has_id(file_id)
582
__contains__ = has_id
584
def get_file_size(self, file_id):
585
file_id = osutils.safe_file_id(file_id)
586
return os.path.getsize(self.id2abspath(file_id))
589
def get_file_sha1(self, file_id, path=None, stat_value=None):
590
file_id = osutils.safe_file_id(file_id)
592
path = self._inventory.id2path(file_id)
593
return self._hashcache.get_sha1(path, stat_value)
595
def get_file_mtime(self, file_id, path=None):
596
file_id = osutils.safe_file_id(file_id)
598
path = self._inventory.id2path(file_id)
599
return os.lstat(self.abspath(path)).st_mtime
601
if not supports_executable():
602
def is_executable(self, file_id, path=None):
603
file_id = osutils.safe_file_id(file_id)
604
return self._inventory[file_id].executable
606
def is_executable(self, file_id, path=None):
608
file_id = osutils.safe_file_id(file_id)
609
path = self.id2path(file_id)
610
mode = os.lstat(self.abspath(path)).st_mode
611
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
614
def _add(self, files, ids, kinds):
615
"""See MutableTree._add."""
616
# TODO: Re-adding a file that is removed in the working copy
617
# should probably put it back with the previous ID.
618
# the read and write working inventory should not occur in this
619
# function - they should be part of lock_write and unlock.
620
inv = self.read_working_inventory()
621
for f, file_id, kind in zip(files, ids, kinds):
622
assert kind is not None
624
inv.add_path(f, kind=kind)
626
file_id = osutils.safe_file_id(file_id)
627
inv.add_path(f, kind=kind, file_id=file_id)
628
self._write_inventory(inv)
630
@needs_tree_write_lock
631
def _gather_kinds(self, files, kinds):
632
"""See MutableTree._gather_kinds."""
633
for pos, f in enumerate(files):
634
if kinds[pos] is None:
635
fullpath = normpath(self.abspath(f))
637
kinds[pos] = file_kind(fullpath)
639
if e.errno == errno.ENOENT:
640
raise errors.NoSuchFile(fullpath)
643
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
644
"""Add revision_id as a parent.
646
This is equivalent to retrieving the current list of parent ids
647
and setting the list to its value plus revision_id.
649
:param revision_id: The revision id to add to the parent list. It may
650
be a ghost revision as long as its not the first parent to be added,
651
or the allow_leftmost_as_ghost parameter is set True.
652
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
654
parents = self.get_parent_ids() + [revision_id]
655
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
656
or allow_leftmost_as_ghost)
658
@needs_tree_write_lock
659
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
660
"""Add revision_id, tree tuple as a parent.
662
This is equivalent to retrieving the current list of parent trees
663
and setting the list to its value plus parent_tuple. See also
664
add_parent_tree_id - if you only have a parent id available it will be
665
simpler to use that api. If you have the parent already available, using
666
this api is preferred.
668
:param parent_tuple: The (revision id, tree) to add to the parent list.
669
If the revision_id is a ghost, pass None for the tree.
670
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
672
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
673
if len(parent_ids) > 1:
674
# the leftmost may have already been a ghost, preserve that if it
676
allow_leftmost_as_ghost = True
677
self.set_parent_ids(parent_ids,
678
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
680
@needs_tree_write_lock
681
def add_pending_merge(self, *revision_ids):
682
# TODO: Perhaps should check at this point that the
683
# history of the revision is actually present?
684
parents = self.get_parent_ids()
686
for rev_id in revision_ids:
687
if rev_id in parents:
689
parents.append(rev_id)
692
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
694
@deprecated_method(zero_eleven)
696
def pending_merges(self):
697
"""Return a list of pending merges.
699
These are revisions that have been merged into the working
700
directory but not yet committed.
702
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
703
instead - which is available on all tree objects.
705
return self.get_parent_ids()[1:]
707
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
708
"""Common ghost checking functionality from set_parent_*.
710
This checks that the left hand-parent exists if there are any
713
if len(revision_ids) > 0:
714
leftmost_id = revision_ids[0]
715
if (not allow_leftmost_as_ghost and not
716
self.branch.repository.has_revision(leftmost_id)):
717
raise errors.GhostRevisionUnusableHere(leftmost_id)
719
def _set_merges_from_parent_ids(self, parent_ids):
720
merges = parent_ids[1:]
721
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
723
@needs_tree_write_lock
724
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
725
"""Set the parent ids to revision_ids.
727
See also set_parent_trees. This api will try to retrieve the tree data
728
for each element of revision_ids from the trees repository. If you have
729
tree data already available, it is more efficient to use
730
set_parent_trees rather than set_parent_ids. set_parent_ids is however
731
an easier API to use.
733
:param revision_ids: The revision_ids to set as the parent ids of this
734
working tree. Any of these may be ghosts.
736
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
737
self._check_parents_for_ghosts(revision_ids,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
if len(revision_ids) > 0:
741
self.set_last_revision(revision_ids[0])
743
self.set_last_revision(None)
745
self._set_merges_from_parent_ids(revision_ids)
747
@needs_tree_write_lock
748
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
749
"""See MutableTree.set_parent_trees."""
750
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
752
self._check_parents_for_ghosts(parent_ids,
753
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
755
if len(parent_ids) == 0:
756
leftmost_parent_id = None
757
leftmost_parent_tree = None
759
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
761
if self._change_last_revision(leftmost_parent_id):
762
if leftmost_parent_tree is None:
763
# If we don't have a tree, fall back to reading the
764
# parent tree from the repository.
765
self._cache_basis_inventory(leftmost_parent_id)
767
inv = leftmost_parent_tree.inventory
768
xml = self._create_basis_xml_from_inventory(
769
leftmost_parent_id, inv)
770
self._write_basis_inventory(xml)
771
self._set_merges_from_parent_ids(parent_ids)
773
@needs_tree_write_lock
774
def set_pending_merges(self, rev_list):
775
parents = self.get_parent_ids()
776
leftmost = parents[:1]
777
new_parents = leftmost + rev_list
778
self.set_parent_ids(new_parents)
780
@needs_tree_write_lock
781
def set_merge_modified(self, modified_hashes):
783
for file_id, hash in modified_hashes.iteritems():
784
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
785
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
787
@needs_tree_write_lock
788
def _put_rio(self, filename, stanzas, header):
789
my_file = rio_file(stanzas, header)
790
self._control_files.put(filename, my_file)
792
@needs_write_lock # because merge pulls data into the branch.
793
def merge_from_branch(self, branch, to_revision=None):
794
"""Merge from a branch into this working tree.
796
:param branch: The branch to merge from.
797
:param to_revision: If non-None, the merge will merge to to_revision,
798
but not beyond it. to_revision does not need to be in the history
799
of the branch when it is supplied. If None, to_revision defaults to
800
branch.last_revision().
802
from bzrlib.merge import Merger, Merge3Merger
803
pb = bzrlib.ui.ui_factory.nested_progress_bar()
805
merger = Merger(self.branch, this_tree=self, pb=pb)
806
merger.pp = ProgressPhase("Merge phase", 5, pb)
807
merger.pp.next_phase()
808
# check that there are no
810
merger.check_basis(check_clean=True, require_commits=False)
811
if to_revision is None:
812
to_revision = branch.last_revision()
814
to_revision = osutils.safe_revision_id(to_revision)
815
merger.other_rev_id = to_revision
816
if merger.other_rev_id is None:
817
raise error.NoCommits(branch)
818
self.branch.fetch(branch, last_revision=merger.other_rev_id)
819
merger.other_basis = merger.other_rev_id
820
merger.other_tree = self.branch.repository.revision_tree(
822
merger.pp.next_phase()
824
if merger.base_rev_id == merger.other_rev_id:
825
raise errors.PointlessMerge
826
merger.backup_files = False
827
merger.merge_type = Merge3Merger
828
merger.set_interesting_files(None)
829
merger.show_base = False
830
merger.reprocess = False
831
conflicts = merger.do_merge()
838
def merge_modified(self):
840
hashfile = self._control_files.get('merge-hashes')
841
except errors.NoSuchFile:
845
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
846
raise errors.MergeModifiedFormatError()
847
except StopIteration:
848
raise errors.MergeModifiedFormatError()
849
for s in RioReader(hashfile):
850
file_id = s.get("file_id")
851
if file_id not in self.inventory:
854
if hash == self.get_file_sha1(file_id):
855
merge_hashes[file_id] = hash
859
def mkdir(self, path, file_id=None):
860
"""See MutableTree.mkdir()."""
862
file_id = generate_ids.gen_file_id(os.path.basename(path))
863
os.mkdir(self.abspath(path))
864
self.add(path, file_id, 'directory')
867
def get_symlink_target(self, file_id):
868
return os.readlink(self.id2abspath(file_id))
870
def file_class(self, filename):
871
if self.path2id(filename):
873
elif self.is_ignored(filename):
879
"""Write the in memory inventory to disk."""
880
# TODO: Maybe this should only write on dirty ?
881
if self._control_files._lock_mode != 'w':
882
raise errors.NotWriteLocked(self)
884
xml5.serializer_v5.write_inventory(self._inventory, sio)
886
self._control_files.put('inventory', sio)
887
self._inventory_is_modified = False
889
def list_files(self, include_root=False):
890
"""Recursively list all files as (path, class, kind, id, entry).
892
Lists, but does not descend into unversioned directories.
894
This does not include files that have been deleted in this
897
Skips the control directory.
899
# list_files is an iterator, so @needs_read_lock doesn't work properly
900
# with it. So callers should be careful to always read_lock the tree.
901
if not self.is_locked():
902
raise errors.ObjectNotLocked(self)
905
if include_root is True:
906
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
907
# Convert these into local objects to save lookup times
908
pathjoin = osutils.pathjoin
909
file_kind = osutils.file_kind
911
# transport.base ends in a slash, we want the piece
912
# between the last two slashes
913
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
915
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
917
# directory file_id, relative path, absolute path, reverse sorted children
918
children = os.listdir(self.basedir)
920
# jam 20060527 The kernel sized tree seems equivalent whether we
921
# use a deque and popleft to keep them sorted, or if we use a plain
922
# list and just reverse() them.
923
children = collections.deque(children)
924
stack = [(inv.root.file_id, u'', self.basedir, children)]
926
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
929
f = children.popleft()
930
## TODO: If we find a subdirectory with its own .bzr
931
## directory, then that is a separate tree and we
932
## should exclude it.
934
# the bzrdir for this tree
935
if transport_base_dir == f:
938
# we know that from_dir_relpath and from_dir_abspath never end in a slash
939
# and 'f' doesn't begin with one, we can do a string op, rather
940
# than the checks of pathjoin(), all relative paths will have an extra slash
942
fp = from_dir_relpath + '/' + f
945
fap = from_dir_abspath + '/' + f
947
f_ie = inv.get_child(from_dir_id, f)
950
elif self.is_ignored(fp[1:]):
953
# we may not have found this file, because of a unicode issue
954
f_norm, can_access = osutils.normalized_filename(f)
955
if f == f_norm or not can_access:
956
# No change, so treat this file normally
959
# this file can be accessed by a normalized path
960
# check again if it is versioned
961
# these lines are repeated here for performance
963
fp = from_dir_relpath + '/' + f
964
fap = from_dir_abspath + '/' + f
965
f_ie = inv.get_child(from_dir_id, f)
968
elif self.is_ignored(fp[1:]):
977
raise errors.BzrCheckError(
978
"file %r entered as kind %r id %r, now of kind %r"
979
% (fap, f_ie.kind, f_ie.file_id, fk))
981
# make a last minute entry
983
yield fp[1:], c, fk, f_ie.file_id, f_ie
986
yield fp[1:], c, fk, None, fk_entries[fk]()
988
yield fp[1:], c, fk, None, TreeEntry()
991
if fk != 'directory':
994
# But do this child first
995
new_children = os.listdir(fap)
997
new_children = collections.deque(new_children)
998
stack.append((f_ie.file_id, fp, fap, new_children))
999
# Break out of inner loop,
1000
# so that we start outer loop with child
1003
# if we finished all children, pop it off the stack
1006
@needs_tree_write_lock
1007
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1010
to_dir must exist in the inventory.
1012
If to_dir exists and is a directory, the files are moved into
1013
it, keeping their old names.
1015
Note that to_dir is only the last component of the new name;
1016
this doesn't change the directory.
1018
For each entry in from_paths the move mode will be determined
1021
The first mode moves the file in the filesystem and updates the
1022
inventory. The second mode only updates the inventory without
1023
touching the file on the filesystem. This is the new mode introduced
1026
move uses the second mode if 'after == True' and the target is not
1027
versioned but present in the working tree.
1029
move uses the second mode if 'after == False' and the source is
1030
versioned but no longer in the working tree, and the target is not
1031
versioned but present in the working tree.
1033
move uses the first mode if 'after == False' and the source is
1034
versioned and present in the working tree, and the target is not
1035
versioned and not present in the working tree.
1037
Everything else results in an error.
1039
This returns a list of (from_path, to_path) pairs for each
1040
entry that is moved.
1045
# check for deprecated use of signature
1047
to_dir = kwargs.get('to_name', None)
1049
raise TypeError('You must supply a target directory')
1051
symbol_versioning.warn('The parameter to_name was deprecated'
1052
' in version 0.13. Use to_dir instead',
1055
# check destination directory
1056
assert not isinstance(from_paths, basestring)
1057
inv = self.inventory
1058
to_abs = self.abspath(to_dir)
1059
if not isdir(to_abs):
1060
raise errors.BzrMoveFailedError('',to_dir,
1061
errors.NotADirectory(to_abs))
1062
if not self.has_filename(to_dir):
1063
raise errors.BzrMoveFailedError('',to_dir,
1064
errors.NotInWorkingDirectory(to_dir))
1065
to_dir_id = inv.path2id(to_dir)
1066
if to_dir_id is None:
1067
raise errors.BzrMoveFailedError('',to_dir,
1068
errors.NotVersionedError(path=str(to_dir)))
1070
to_dir_ie = inv[to_dir_id]
1071
if to_dir_ie.kind != 'directory':
1072
raise errors.BzrMoveFailedError('',to_dir,
1073
errors.NotADirectory(to_abs))
1075
# create rename entries and tuples
1076
for from_rel in from_paths:
1077
from_tail = splitpath(from_rel)[-1]
1078
from_id = inv.path2id(from_rel)
1080
raise errors.BzrMoveFailedError(from_rel,to_dir,
1081
errors.NotVersionedError(path=str(from_rel)))
1083
from_entry = inv[from_id]
1084
from_parent_id = from_entry.parent_id
1085
to_rel = pathjoin(to_dir, from_tail)
1086
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1088
from_tail=from_tail,
1089
from_parent_id=from_parent_id,
1090
to_rel=to_rel, to_tail=from_tail,
1091
to_parent_id=to_dir_id)
1092
rename_entries.append(rename_entry)
1093
rename_tuples.append((from_rel, to_rel))
1095
# determine which move mode to use. checks also for movability
1096
rename_entries = self._determine_mv_mode(rename_entries, after)
1098
original_modified = self._inventory_is_modified
1101
self._inventory_is_modified = True
1102
self._move(rename_entries)
1104
# restore the inventory on error
1105
self._inventory_is_modified = original_modified
1107
self._write_inventory(inv)
1108
return rename_tuples
1110
def _determine_mv_mode(self, rename_entries, after=False):
1111
"""Determines for each from-to pair if both inventory and working tree
1112
or only the inventory has to be changed.
1114
Also does basic plausability tests.
1116
inv = self.inventory
1118
for rename_entry in rename_entries:
1119
# store to local variables for easier reference
1120
from_rel = rename_entry.from_rel
1121
from_id = rename_entry.from_id
1122
to_rel = rename_entry.to_rel
1123
to_id = inv.path2id(to_rel)
1124
only_change_inv = False
1126
# check the inventory for source and destination
1128
raise errors.BzrMoveFailedError(from_rel,to_rel,
1129
errors.NotVersionedError(path=str(from_rel)))
1130
if to_id is not None:
1131
raise errors.BzrMoveFailedError(from_rel,to_rel,
1132
errors.AlreadyVersionedError(path=str(to_rel)))
1134
# try to determine the mode for rename (only change inv or change
1135
# inv and file system)
1137
if not self.has_filename(to_rel):
1138
raise errors.BzrMoveFailedError(from_id,to_rel,
1139
errors.NoSuchFile(path=str(to_rel),
1140
extra="New file has not been created yet"))
1141
only_change_inv = True
1142
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1143
only_change_inv = True
1144
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1145
only_change_inv = False
1147
# something is wrong, so lets determine what exactly
1148
if not self.has_filename(from_rel) and \
1149
not self.has_filename(to_rel):
1150
raise errors.BzrRenameFailedError(from_rel,to_rel,
1151
errors.PathsDoNotExist(paths=(str(from_rel),
1154
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1155
extra="(Use --after to update the Bazaar id)")
1156
rename_entry.only_change_inv = only_change_inv
1157
return rename_entries
1159
def _move(self, rename_entries):
1160
"""Moves a list of files.
1162
Depending on the value of the flag 'only_change_inv', the
1163
file will be moved on the file system or not.
1165
inv = self.inventory
1168
for entry in rename_entries:
1170
self._move_entry(entry)
1172
self._rollback_move(moved)
1176
def _rollback_move(self, moved):
1177
"""Try to rollback a previous move in case of an filesystem error."""
1178
inv = self.inventory
1181
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1182
entry.to_tail, entry.to_parent_id, entry.from_rel,
1183
entry.from_tail, entry.from_parent_id,
1184
entry.only_change_inv))
1185
except errors.BzrMoveFailedError, e:
1186
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1187
" The working tree is in an inconsistent state."
1188
" Please consider doing a 'bzr revert'."
1189
" Error message is: %s" % e)
1191
def _move_entry(self, entry):
1192
inv = self.inventory
1193
from_rel_abs = self.abspath(entry.from_rel)
1194
to_rel_abs = self.abspath(entry.to_rel)
1195
if from_rel_abs == to_rel_abs:
1196
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1197
"Source and target are identical.")
1199
if not entry.only_change_inv:
1201
osutils.rename(from_rel_abs, to_rel_abs)
1203
raise errors.BzrMoveFailedError(entry.from_rel,
1205
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1207
@needs_tree_write_lock
1208
def rename_one(self, from_rel, to_rel, after=False):
1211
This can change the directory or the filename or both.
1213
rename_one has several 'modes' to work. First, it can rename a physical
1214
file and change the file_id. That is the normal mode. Second, it can
1215
only change the file_id without touching any physical file. This is
1216
the new mode introduced in version 0.15.
1218
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1219
versioned but present in the working tree.
1221
rename_one uses the second mode if 'after == False' and 'from_rel' is
1222
versioned but no longer in the working tree, and 'to_rel' is not
1223
versioned but present in the working tree.
1225
rename_one uses the first mode if 'after == False' and 'from_rel' is
1226
versioned and present in the working tree, and 'to_rel' is not
1227
versioned and not present in the working tree.
1229
Everything else results in an error.
1231
inv = self.inventory
1234
# create rename entries and tuples
1235
from_tail = splitpath(from_rel)[-1]
1236
from_id = inv.path2id(from_rel)
1238
raise errors.BzrRenameFailedError(from_rel,to_rel,
1239
errors.NotVersionedError(path=str(from_rel)))
1240
from_entry = inv[from_id]
1241
from_parent_id = from_entry.parent_id
1242
to_dir, to_tail = os.path.split(to_rel)
1243
to_dir_id = inv.path2id(to_dir)
1244
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1246
from_tail=from_tail,
1247
from_parent_id=from_parent_id,
1248
to_rel=to_rel, to_tail=to_tail,
1249
to_parent_id=to_dir_id)
1250
rename_entries.append(rename_entry)
1252
# determine which move mode to use. checks also for movability
1253
rename_entries = self._determine_mv_mode(rename_entries, after)
1255
# check if the target changed directory and if the target directory is
1257
if to_dir_id is None:
1258
raise errors.BzrMoveFailedError(from_rel,to_rel,
1259
errors.NotVersionedError(path=str(to_dir)))
1261
# all checks done. now we can continue with our actual work
1262
mutter('rename_one:\n'
1267
' to_dir_id {%s}\n',
1268
from_id, from_rel, to_rel, to_dir, to_dir_id)
1270
self._move(rename_entries)
1271
self._write_inventory(inv)
1273
class _RenameEntry(object):
1274
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1275
to_rel, to_tail, to_parent_id, only_change_inv=False):
1276
self.from_rel = from_rel
1277
self.from_id = from_id
1278
self.from_tail = from_tail
1279
self.from_parent_id = from_parent_id
1280
self.to_rel = to_rel
1281
self.to_tail = to_tail
1282
self.to_parent_id = to_parent_id
1283
self.only_change_inv = only_change_inv
1287
"""Return all unknown files.
1289
These are files in the working directory that are not versioned or
1290
control files or ignored.
1292
# force the extras method to be fully executed before returning, to
1293
# prevent race conditions with the lock
1295
[subp for subp in self.extras() if not self.is_ignored(subp)])
1297
@needs_tree_write_lock
1298
def unversion(self, file_ids):
1299
"""Remove the file ids in file_ids from the current versioned set.
1301
When a file_id is unversioned, all of its children are automatically
1304
:param file_ids: The file ids to stop versioning.
1305
:raises: NoSuchId if any fileid is not currently versioned.
1307
for file_id in file_ids:
1308
file_id = osutils.safe_file_id(file_id)
1309
if self._inventory.has_id(file_id):
1310
self._inventory.remove_recursive_id(file_id)
1312
raise errors.NoSuchId(self, file_id)
1314
# in the future this should just set a dirty bit to wait for the
1315
# final unlock. However, until all methods of workingtree start
1316
# with the current in -memory inventory rather than triggering
1317
# a read, it is more complex - we need to teach read_inventory
1318
# to know when to read, and when to not read first... and possibly
1319
# to save first when the in memory one may be corrupted.
1320
# so for now, we just only write it if it is indeed dirty.
1322
self._write_inventory(self._inventory)
1324
@deprecated_method(zero_eight)
1325
def iter_conflicts(self):
1326
"""List all files in the tree that have text or content conflicts.
1327
DEPRECATED. Use conflicts instead."""
1328
return self._iter_conflicts()
1330
def _iter_conflicts(self):
1332
for info in self.list_files():
1334
stem = get_conflicted_stem(path)
1337
if stem not in conflicted:
1338
conflicted.add(stem)
1342
def pull(self, source, overwrite=False, stop_revision=None,
1343
change_reporter=None):
1344
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1347
pp = ProgressPhase("Pull phase", 2, top_pb)
1349
old_revision_info = self.branch.last_revision_info()
1350
basis_tree = self.basis_tree()
1351
count = self.branch.pull(source, overwrite, stop_revision)
1352
new_revision_info = self.branch.last_revision_info()
1353
if new_revision_info != old_revision_info:
1355
repository = self.branch.repository
1356
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1357
basis_tree.lock_read()
1359
new_basis_tree = self.branch.basis_tree()
1366
change_reporter=change_reporter)
1367
if (basis_tree.inventory.root is None and
1368
new_basis_tree.inventory.root is not None):
1369
self.set_root_id(new_basis_tree.inventory.root.file_id)
1373
# TODO - dedup parents list with things merged by pull ?
1374
# reuse the revisiontree we merged against to set the new
1376
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1377
# we have to pull the merge trees out again, because
1378
# merge_inner has set the ids. - this corner is not yet
1379
# layered well enough to prevent double handling.
1380
# XXX TODO: Fix the double handling: telling the tree about
1381
# the already known parent data is wasteful.
1382
merges = self.get_parent_ids()[1:]
1383
parent_trees.extend([
1384
(parent, repository.revision_tree(parent)) for
1386
self.set_parent_trees(parent_trees)
1393
def put_file_bytes_non_atomic(self, file_id, bytes):
1394
"""See MutableTree.put_file_bytes_non_atomic."""
1395
file_id = osutils.safe_file_id(file_id)
1396
stream = file(self.id2abspath(file_id), 'wb')
1401
# TODO: update the hashcache here ?
1404
"""Yield all unknown files in this WorkingTree.
1406
If there are any unknown directories then only the directory is
1407
returned, not all its children. But if there are unknown files
1408
under a versioned subdirectory, they are returned.
1410
Currently returned depth-first, sorted by name within directories.
1412
## TODO: Work from given directory downwards
1413
for path, dir_entry in self.inventory.directories():
1414
# mutter("search for unknowns in %r", path)
1415
dirabs = self.abspath(path)
1416
if not isdir(dirabs):
1417
# e.g. directory deleted
1421
for subf in os.listdir(dirabs):
1424
if subf not in dir_entry.children:
1425
subf_norm, can_access = osutils.normalized_filename(subf)
1426
if subf_norm != subf and can_access:
1427
if subf_norm not in dir_entry.children:
1428
fl.append(subf_norm)
1434
subp = pathjoin(path, subf)
1437
def ignored_files(self):
1438
"""Yield list of PATH, IGNORE_PATTERN"""
1439
for subp in self.extras():
1440
pat = self.is_ignored(subp)
1444
def get_ignore_list(self):
1445
"""Return list of ignore patterns.
1447
Cached in the Tree object after the first call.
1449
ignoreset = getattr(self, '_ignoreset', None)
1450
if ignoreset is not None:
1453
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1454
ignore_globs.update(ignores.get_runtime_ignores())
1455
ignore_globs.update(ignores.get_user_ignores())
1456
if self.has_filename(bzrlib.IGNORE_FILENAME):
1457
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1459
ignore_globs.update(ignores.parse_ignore_file(f))
1462
self._ignoreset = ignore_globs
1465
def _flush_ignore_list_cache(self):
1466
"""Resets the cached ignore list to force a cache rebuild."""
1467
self._ignoreset = None
1468
self._ignoreglobster = None
1470
def is_ignored(self, filename):
1471
r"""Check whether the filename matches an ignore pattern.
1473
Patterns containing '/' or '\' need to match the whole path;
1474
others match against only the last component.
1476
If the file is ignored, returns the pattern which caused it to
1477
be ignored, otherwise None. So this can simply be used as a
1478
boolean if desired."""
1479
if getattr(self, '_ignoreglobster', None) is None:
1480
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1481
return self._ignoreglobster.match(filename)
1483
def kind(self, file_id):
1484
return file_kind(self.id2abspath(file_id))
1486
def _comparison_data(self, entry, path):
1487
abspath = self.abspath(path)
1489
stat_value = os.lstat(abspath)
1491
if getattr(e, 'errno', None) == errno.ENOENT:
1498
mode = stat_value.st_mode
1499
kind = osutils.file_kind_from_stat_mode(mode)
1500
if not supports_executable():
1501
executable = entry.executable
1503
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1504
return kind, executable, stat_value
1506
def _file_size(self, entry, stat_value):
1507
return stat_value.st_size
1509
def last_revision(self):
1510
"""Return the last revision of the branch for this tree.
1512
This format tree does not support a separate marker for last-revision
1513
compared to the branch.
1515
See MutableTree.last_revision
1517
return self._last_revision()
1520
def _last_revision(self):
1521
"""helper for get_parent_ids."""
1522
return self.branch.last_revision()
1524
def is_locked(self):
1525
return self._control_files.is_locked()
1527
def lock_read(self):
1528
"""See Branch.lock_read, and WorkingTree.unlock."""
1529
self.branch.lock_read()
1531
return self._control_files.lock_read()
1533
self.branch.unlock()
1536
def lock_tree_write(self):
1537
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1538
self.branch.lock_read()
1540
return self._control_files.lock_write()
1542
self.branch.unlock()
1545
def lock_write(self):
1546
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1547
self.branch.lock_write()
1549
return self._control_files.lock_write()
1551
self.branch.unlock()
1554
def get_physical_lock_status(self):
1555
return self._control_files.get_physical_lock_status()
1557
def _basis_inventory_name(self):
1558
return 'basis-inventory-cache'
1560
@needs_tree_write_lock
1561
def set_last_revision(self, new_revision):
1562
"""Change the last revision in the working tree."""
1563
new_revision = osutils.safe_revision_id(new_revision)
1564
if self._change_last_revision(new_revision):
1565
self._cache_basis_inventory(new_revision)
1567
def _change_last_revision(self, new_revision):
1568
"""Template method part of set_last_revision to perform the change.
1570
This is used to allow WorkingTree3 instances to not affect branch
1571
when their last revision is set.
1573
if new_revision is None:
1574
self.branch.set_revision_history([])
1577
self.branch.generate_revision_history(new_revision)
1578
except errors.NoSuchRevision:
1579
# not present in the repo - dont try to set it deeper than the tip
1580
self.branch.set_revision_history([new_revision])
1583
def _write_basis_inventory(self, xml):
1584
"""Write the basis inventory XML to the basis-inventory file"""
1585
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1586
path = self._basis_inventory_name()
1588
self._control_files.put(path, sio)
1590
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1591
"""Create the text that will be saved in basis-inventory"""
1592
# TODO: jam 20070209 This should be redundant, as the revision_id
1593
# as all callers should have already converted the revision_id to
1595
inventory.revision_id = osutils.safe_revision_id(revision_id)
1596
return xml6.serializer_v6.write_inventory_to_string(inventory)
1598
def _cache_basis_inventory(self, new_revision):
1599
"""Cache new_revision as the basis inventory."""
1600
# TODO: this should allow the ready-to-use inventory to be passed in,
1601
# as commit already has that ready-to-use [while the format is the
1604
# this double handles the inventory - unpack and repack -
1605
# but is easier to understand. We can/should put a conditional
1606
# in here based on whether the inventory is in the latest format
1607
# - perhaps we should repack all inventories on a repository
1609
# the fast path is to copy the raw xml from the repository. If the
1610
# xml contains 'revision_id="', then we assume the right
1611
# revision_id is set. We must check for this full string, because a
1612
# root node id can legitimately look like 'revision_id' but cannot
1614
xml = self.branch.repository.get_inventory_xml(new_revision)
1615
firstline = xml.split('\n', 1)[0]
1616
if (not 'revision_id="' in firstline or
1617
'format="6"' not in firstline):
1618
inv = self.branch.repository.deserialise_inventory(
1620
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1621
self._write_basis_inventory(xml)
1622
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1625
def read_basis_inventory(self):
1626
"""Read the cached basis inventory."""
1627
path = self._basis_inventory_name()
1628
return self._control_files.get(path).read()
1631
def read_working_inventory(self):
1632
"""Read the working inventory.
1634
:raises errors.InventoryModified: read_working_inventory will fail
1635
when the current in memory inventory has been modified.
1637
# conceptually this should be an implementation detail of the tree.
1638
# XXX: Deprecate this.
1639
# ElementTree does its own conversion from UTF-8, so open in
1641
if self._inventory_is_modified:
1642
raise errors.InventoryModified(self)
1643
result = xml5.serializer_v5.read_inventory(
1644
self._control_files.get('inventory'))
1645
self._set_inventory(result, dirty=False)
1648
@needs_tree_write_lock
1649
def remove(self, files, verbose=False, to_file=None):
1650
"""Remove nominated files from the working inventory..
1652
This does not remove their text. This does not run on XXX on what? RBC
1654
TODO: Refuse to remove modified files unless --force is given?
1656
TODO: Do something useful with directories.
1658
TODO: Should this remove the text or not? Tough call; not
1659
removing may be useful and the user can just use use rm, and
1660
is the opposite of add. Removing it is consistent with most
1661
other tools. Maybe an option.
1663
## TODO: Normalize names
1664
## TODO: Remove nested loops; better scalability
1665
if isinstance(files, basestring):
1668
inv = self.inventory
1670
# do this before any modifications
1672
fid = inv.path2id(f)
1674
note("%s is not versioned."%f)
1677
# having remove it, it must be either ignored or unknown
1678
if self.is_ignored(f):
1682
textui.show_status(new_status, inv[fid].kind, f,
1686
self._write_inventory(inv)
1688
@needs_tree_write_lock
1689
def revert(self, filenames, old_tree=None, backups=True,
1690
pb=DummyProgress(), report_changes=False):
1691
from bzrlib.conflicts import resolve
1692
if old_tree is None:
1693
old_tree = self.basis_tree()
1694
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1696
if not len(filenames):
1697
self.set_parent_ids(self.get_parent_ids()[:1])
1700
resolve(self, filenames, ignore_misses=True)
1703
def revision_tree(self, revision_id):
1704
"""See Tree.revision_tree.
1706
WorkingTree can supply revision_trees for the basis revision only
1707
because there is only one cached inventory in the bzr directory.
1709
if revision_id == self.last_revision():
1711
xml = self.read_basis_inventory()
1712
except errors.NoSuchFile:
1716
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1717
# dont use the repository revision_tree api because we want
1718
# to supply the inventory.
1719
if inv.revision_id == revision_id:
1720
return revisiontree.RevisionTree(self.branch.repository,
1722
except errors.BadInventoryFormat:
1724
# raise if there was no inventory, or if we read the wrong inventory.
1725
raise errors.NoSuchRevisionInTree(self, revision_id)
1727
# XXX: This method should be deprecated in favour of taking in a proper
1728
# new Inventory object.
1729
@needs_tree_write_lock
1730
def set_inventory(self, new_inventory_list):
1731
from bzrlib.inventory import (Inventory,
1736
inv = Inventory(self.get_root_id())
1737
for path, file_id, parent, kind in new_inventory_list:
1738
name = os.path.basename(path)
1741
# fixme, there should be a factory function inv,add_??
1742
if kind == 'directory':
1743
inv.add(InventoryDirectory(file_id, name, parent))
1744
elif kind == 'file':
1745
inv.add(InventoryFile(file_id, name, parent))
1746
elif kind == 'symlink':
1747
inv.add(InventoryLink(file_id, name, parent))
1749
raise errors.BzrError("unknown kind %r" % kind)
1750
self._write_inventory(inv)
1752
@needs_tree_write_lock
1753
def set_root_id(self, file_id):
1754
"""Set the root id for this tree."""
1757
symbol_versioning.warn(symbol_versioning.zero_twelve
1758
% 'WorkingTree.set_root_id with fileid=None',
1763
file_id = osutils.safe_file_id(file_id)
1764
self._set_root_id(file_id)
1766
def _set_root_id(self, file_id):
1767
"""Set the root id for this tree, in a format specific manner.
1769
:param file_id: The file id to assign to the root. It must not be
1770
present in the current inventory or an error will occur. It must
1771
not be None, but rather a valid file id.
1773
inv = self._inventory
1774
orig_root_id = inv.root.file_id
1775
# TODO: it might be nice to exit early if there was nothing
1776
# to do, saving us from trigger a sync on unlock.
1777
self._inventory_is_modified = True
1778
# we preserve the root inventory entry object, but
1779
# unlinkit from the byid index
1780
del inv._byid[inv.root.file_id]
1781
inv.root.file_id = file_id
1782
# and link it into the index with the new changed id.
1783
inv._byid[inv.root.file_id] = inv.root
1784
# and finally update all children to reference the new id.
1785
# XXX: this should be safe to just look at the root.children
1786
# list, not the WHOLE INVENTORY.
1789
if entry.parent_id == orig_root_id:
1790
entry.parent_id = inv.root.file_id
1793
"""See Branch.unlock.
1795
WorkingTree locking just uses the Branch locking facilities.
1796
This is current because all working trees have an embedded branch
1797
within them. IF in the future, we were to make branch data shareable
1798
between multiple working trees, i.e. via shared storage, then we
1799
would probably want to lock both the local tree, and the branch.
1801
raise NotImplementedError(self.unlock)
1804
"""Update a working tree along its branch.
1806
This will update the branch if its bound too, which means we have
1807
multiple trees involved:
1809
- The new basis tree of the master.
1810
- The old basis tree of the branch.
1811
- The old basis tree of the working tree.
1812
- The current working tree state.
1814
Pathologically, all three may be different, and non-ancestors of each
1815
other. Conceptually we want to:
1817
- Preserve the wt.basis->wt.state changes
1818
- Transform the wt.basis to the new master basis.
1819
- Apply a merge of the old branch basis to get any 'local' changes from
1821
- Restore the wt.basis->wt.state changes.
1823
There isn't a single operation at the moment to do that, so we:
1824
- Merge current state -> basis tree of the master w.r.t. the old tree
1826
- Do a 'normal' merge of the old branch basis if it is relevant.
1828
if self.branch.get_master_branch() is not None:
1830
update_branch = True
1832
self.lock_tree_write()
1833
update_branch = False
1836
old_tip = self.branch.update()
1839
return self._update_tree(old_tip)
1843
@needs_tree_write_lock
1844
def _update_tree(self, old_tip=None):
1845
"""Update a tree to the master branch.
1847
:param old_tip: if supplied, the previous tip revision the branch,
1848
before it was changed to the master branch's tip.
1850
# here if old_tip is not None, it is the old tip of the branch before
1851
# it was updated from the master branch. This should become a pending
1852
# merge in the working tree to preserve the user existing work. we
1853
# cant set that until we update the working trees last revision to be
1854
# one from the new branch, because it will just get absorbed by the
1855
# parent de-duplication logic.
1857
# We MUST save it even if an error occurs, because otherwise the users
1858
# local work is unreferenced and will appear to have been lost.
1862
last_rev = self.get_parent_ids()[0]
1865
if last_rev != self.branch.last_revision():
1866
# merge tree state up to new branch tip.
1867
basis = self.basis_tree()
1870
to_tree = self.branch.basis_tree()
1871
if basis.inventory.root is None and self.inventory.root is None:
1872
self.set_root_id(to_tree.inventory.root.file_id)
1873
result += merge.merge_inner(
1880
# TODO - dedup parents list with things merged by pull ?
1881
# reuse the tree we've updated to to set the basis:
1882
parent_trees = [(self.branch.last_revision(), to_tree)]
1883
merges = self.get_parent_ids()[1:]
1884
# Ideally we ask the tree for the trees here, that way the working
1885
# tree can decide whether to give us teh entire tree or give us a
1886
# lazy initialised tree. dirstate for instance will have the trees
1887
# in ram already, whereas a last-revision + basis-inventory tree
1888
# will not, but also does not need them when setting parents.
1889
for parent in merges:
1890
parent_trees.append(
1891
(parent, self.branch.repository.revision_tree(parent)))
1892
if old_tip is not None:
1893
parent_trees.append(
1894
(old_tip, self.branch.repository.revision_tree(old_tip)))
1895
self.set_parent_trees(parent_trees)
1896
last_rev = parent_trees[0][0]
1898
# the working tree had the same last-revision as the master
1899
# branch did. We may still have pivot local work from the local
1900
# branch into old_tip:
1901
if old_tip is not None:
1902
self.add_parent_tree_id(old_tip)
1903
if old_tip and old_tip != last_rev:
1904
# our last revision was not the prior branch last revision
1905
# and we have converted that last revision to a pending merge.
1906
# base is somewhere between the branch tip now
1907
# and the now pending merge
1909
# Since we just modified the working tree and inventory, flush out
1910
# the current state, before we modify it again.
1911
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
1912
# requires it only because TreeTransform directly munges the
1913
# inventory and calls tree._write_inventory(). Ultimately we
1914
# should be able to remove this extra flush.
1916
from bzrlib.revision import common_ancestor
1918
base_rev_id = common_ancestor(self.branch.last_revision(),
1920
self.branch.repository)
1921
except errors.NoCommonAncestor:
1923
base_tree = self.branch.repository.revision_tree(base_rev_id)
1924
other_tree = self.branch.repository.revision_tree(old_tip)
1925
result += merge.merge_inner(
1932
def _write_hashcache_if_dirty(self):
1933
"""Write out the hashcache if it is dirty."""
1934
if self._hashcache.needs_write:
1936
self._hashcache.write()
1938
if e.errno not in (errno.EPERM, errno.EACCES):
1940
# TODO: jam 20061219 Should this be a warning? A single line
1941
# warning might be sufficient to let the user know what
1943
mutter('Could not write hashcache for %s\nError: %s',
1944
self._hashcache.cache_file_name(), e)
1946
@needs_tree_write_lock
1947
def _write_inventory(self, inv):
1948
"""Write inventory as the current inventory."""
1949
self._set_inventory(inv, dirty=True)
1952
def set_conflicts(self, arg):
1953
raise errors.UnsupportedOperation(self.set_conflicts, self)
1955
def add_conflicts(self, arg):
1956
raise errors.UnsupportedOperation(self.add_conflicts, self)
1959
def conflicts(self):
1960
conflicts = _mod_conflicts.ConflictList()
1961
for conflicted in self._iter_conflicts():
1964
if file_kind(self.abspath(conflicted)) != "file":
1966
except errors.NoSuchFile:
1969
for suffix in ('.THIS', '.OTHER'):
1971
kind = file_kind(self.abspath(conflicted+suffix))
1974
except errors.NoSuchFile:
1978
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1979
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1981
file_id=self.path2id(conflicted)))
1984
def walkdirs(self, prefix=""):
1985
"""Walk the directories of this tree.
1987
This API returns a generator, which is only valid during the current
1988
tree transaction - within a single lock_read or lock_write duration.
1990
If the tree is not locked, it may cause an error to be raised, depending
1991
on the tree implementation.
1993
disk_top = self.abspath(prefix)
1994
if disk_top.endswith('/'):
1995
disk_top = disk_top[:-1]
1996
top_strip_len = len(disk_top) + 1
1997
inventory_iterator = self._walkdirs(prefix)
1998
disk_iterator = osutils.walkdirs(disk_top, prefix)
2000
current_disk = disk_iterator.next()
2001
disk_finished = False
2003
if e.errno != errno.ENOENT:
2006
disk_finished = True
2008
current_inv = inventory_iterator.next()
2009
inv_finished = False
2010
except StopIteration:
2013
while not inv_finished or not disk_finished:
2014
if not disk_finished:
2015
# strip out .bzr dirs
2016
if current_disk[0][1][top_strip_len:] == '':
2017
# osutils.walkdirs can be made nicer -
2018
# yield the path-from-prefix rather than the pathjoined
2020
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2021
if current_disk[1][bzrdir_loc][0] == '.bzr':
2022
# we dont yield the contents of, or, .bzr itself.
2023
del current_disk[1][bzrdir_loc]
2025
# everything is unknown
2028
# everything is missing
2031
direction = cmp(current_inv[0][0], current_disk[0][0])
2033
# disk is before inventory - unknown
2034
dirblock = [(relpath, basename, kind, stat, None, None) for
2035
relpath, basename, kind, stat, top_path in current_disk[1]]
2036
yield (current_disk[0][0], None), dirblock
2038
current_disk = disk_iterator.next()
2039
except StopIteration:
2040
disk_finished = True
2042
# inventory is before disk - missing.
2043
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2044
for relpath, basename, dkind, stat, fileid, kind in
2046
yield (current_inv[0][0], current_inv[0][1]), dirblock
2048
current_inv = inventory_iterator.next()
2049
except StopIteration:
2052
# versioned present directory
2053
# merge the inventory and disk data together
2055
for relpath, subiterator in itertools.groupby(sorted(
2056
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2057
path_elements = list(subiterator)
2058
if len(path_elements) == 2:
2059
inv_row, disk_row = path_elements
2060
# versioned, present file
2061
dirblock.append((inv_row[0],
2062
inv_row[1], disk_row[2],
2063
disk_row[3], inv_row[4],
2065
elif len(path_elements[0]) == 5:
2067
dirblock.append((path_elements[0][0],
2068
path_elements[0][1], path_elements[0][2],
2069
path_elements[0][3], None, None))
2070
elif len(path_elements[0]) == 6:
2071
# versioned, absent file.
2072
dirblock.append((path_elements[0][0],
2073
path_elements[0][1], 'unknown', None,
2074
path_elements[0][4], path_elements[0][5]))
2076
raise NotImplementedError('unreachable code')
2077
yield current_inv[0], dirblock
2079
current_inv = inventory_iterator.next()
2080
except StopIteration:
2083
current_disk = disk_iterator.next()
2084
except StopIteration:
2085
disk_finished = True
2087
def _walkdirs(self, prefix=""):
2088
_directory = 'directory'
2089
# get the root in the inventory
2090
inv = self.inventory
2091
top_id = inv.path2id(prefix)
2095
pending = [(prefix, '', _directory, None, top_id, None)]
2098
currentdir = pending.pop()
2099
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2100
top_id = currentdir[4]
2102
relroot = currentdir[0] + '/'
2105
# FIXME: stash the node in pending
2107
for name, child in entry.sorted_children():
2108
dirblock.append((relroot + name, name, child.kind, None,
2109
child.file_id, child.kind
2111
yield (currentdir[0], entry.file_id), dirblock
2112
# push the user specified dirs from dirblock
2113
for dir in reversed(dirblock):
2114
if dir[2] == _directory:
2118
class WorkingTree2(WorkingTree):
2119
"""This is the Format 2 working tree.
2121
This was the first weave based working tree.
2122
- uses os locks for locking.
2123
- uses the branch last-revision.
2126
def lock_tree_write(self):
2127
"""See WorkingTree.lock_tree_write().
2129
In Format2 WorkingTrees we have a single lock for the branch and tree
2130
so lock_tree_write() degrades to lock_write().
2132
self.branch.lock_write()
2134
return self._control_files.lock_write()
2136
self.branch.unlock()
2140
# we share control files:
2141
if self._control_files._lock_count == 3:
2142
# _inventory_is_modified is always False during a read lock.
2143
if self._inventory_is_modified:
2145
self._write_hashcache_if_dirty()
2147
# reverse order of locking.
2149
return self._control_files.unlock()
2151
self.branch.unlock()
2154
class WorkingTree3(WorkingTree):
2155
"""This is the Format 3 working tree.
2157
This differs from the base WorkingTree by:
2158
- having its own file lock
2159
- having its own last-revision property.
2161
This is new in bzr 0.8
2165
def _last_revision(self):
2166
"""See Mutable.last_revision."""
2168
return osutils.safe_revision_id(
2169
self._control_files.get('last-revision').read())
2170
except errors.NoSuchFile:
2173
def _change_last_revision(self, revision_id):
2174
"""See WorkingTree._change_last_revision."""
2175
if revision_id is None or revision_id == NULL_REVISION:
2177
self._control_files._transport.delete('last-revision')
2178
except errors.NoSuchFile:
2182
self._control_files.put_bytes('last-revision', revision_id)
2185
@needs_tree_write_lock
2186
def set_conflicts(self, conflicts):
2187
self._put_rio('conflicts', conflicts.to_stanzas(),
2190
@needs_tree_write_lock
2191
def add_conflicts(self, new_conflicts):
2192
conflict_set = set(self.conflicts())
2193
conflict_set.update(set(list(new_conflicts)))
2194
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2195
key=_mod_conflicts.Conflict.sort_key)))
2198
def conflicts(self):
2200
confile = self._control_files.get('conflicts')
2201
except errors.NoSuchFile:
2202
return _mod_conflicts.ConflictList()
2204
if confile.next() != CONFLICT_HEADER_1 + '\n':
2205
raise errors.ConflictFormatError()
2206
except StopIteration:
2207
raise errors.ConflictFormatError()
2208
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2211
if self._control_files._lock_count == 1:
2212
# _inventory_is_modified is always False during a read lock.
2213
if self._inventory_is_modified:
2215
self._write_hashcache_if_dirty()
2216
# reverse order of locking.
2218
return self._control_files.unlock()
2220
self.branch.unlock()
2223
def get_conflicted_stem(path):
2224
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2225
if path.endswith(suffix):
2226
return path[:-len(suffix)]
2229
@deprecated_function(zero_eight)
2230
def is_control_file(filename):
2231
"""See WorkingTree.is_control_filename(filename)."""
2232
## FIXME: better check
2233
filename = normpath(filename)
2234
while filename != '':
2235
head, tail = os.path.split(filename)
2236
## mutter('check %r for control file' % ((head, tail),))
2239
if filename == head:
2245
class WorkingTreeFormat(object):
2246
"""An encapsulation of the initialization and open routines for a format.
2248
Formats provide three things:
2249
* An initialization routine,
2253
Formats are placed in an dict by their format string for reference
2254
during workingtree opening. Its not required that these be instances, they
2255
can be classes themselves with class methods - it simply depends on
2256
whether state is needed for a given format or not.
2258
Once a format is deprecated, just deprecate the initialize and open
2259
methods on the format class. Do not deprecate the object, as the
2260
object will be created every time regardless.
2263
_default_format = None
2264
"""The default format used for new trees."""
2267
"""The known formats."""
2270
def find_format(klass, a_bzrdir):
2271
"""Return the format for the working tree object in a_bzrdir."""
2273
transport = a_bzrdir.get_workingtree_transport(None)
2274
format_string = transport.get("format").read()
2275
return klass._formats[format_string]
2276
except errors.NoSuchFile:
2277
raise errors.NoWorkingTree(base=transport.base)
2279
raise errors.UnknownFormatError(format=format_string)
2282
def get_default_format(klass):
2283
"""Return the current default format."""
2284
return klass._default_format
2286
def get_format_string(self):
2287
"""Return the ASCII format string that identifies this format."""
2288
raise NotImplementedError(self.get_format_string)
2290
def get_format_description(self):
2291
"""Return the short description for this format."""
2292
raise NotImplementedError(self.get_format_description)
2294
def is_supported(self):
2295
"""Is this format supported?
2297
Supported formats can be initialized and opened.
2298
Unsupported formats may not support initialization or committing or
2299
some other features depending on the reason for not being supported.
2304
def register_format(klass, format):
2305
klass._formats[format.get_format_string()] = format
2308
def set_default_format(klass, format):
2309
klass._default_format = format
2312
def unregister_format(klass, format):
2313
assert klass._formats[format.get_format_string()] is format
2314
del klass._formats[format.get_format_string()]
2318
class WorkingTreeFormat2(WorkingTreeFormat):
2319
"""The second working tree format.
2321
This format modified the hash cache from the format 1 hash cache.
2324
def get_format_description(self):
2325
"""See WorkingTreeFormat.get_format_description()."""
2326
return "Working tree format 2"
2328
def stub_initialize_remote(self, control_files):
2329
"""As a special workaround create critical control files for a remote working tree
2331
This ensures that it can later be updated and dealt with locally,
2332
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2333
no working tree. (See bug #43064).
2337
xml5.serializer_v5.write_inventory(inv, sio)
2339
control_files.put('inventory', sio)
2341
control_files.put_bytes('pending-merges', '')
2344
def initialize(self, a_bzrdir, revision_id=None):
2345
"""See WorkingTreeFormat.initialize()."""
2346
if not isinstance(a_bzrdir.transport, LocalTransport):
2347
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2348
branch = a_bzrdir.open_branch()
2349
if revision_id is not None:
2350
revision_id = osutils.safe_revision_id(revision_id)
2353
revision_history = branch.revision_history()
2355
position = revision_history.index(revision_id)
2357
raise errors.NoSuchRevision(branch, revision_id)
2358
branch.set_revision_history(revision_history[:position + 1])
2361
revision = branch.last_revision()
2363
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2369
basis_tree = branch.repository.revision_tree(revision)
2370
if basis_tree.inventory.root is not None:
2371
wt.set_root_id(basis_tree.inventory.root.file_id)
2372
# set the parent list and cache the basis tree.
2373
wt.set_parent_trees([(revision, basis_tree)])
2374
transform.build_tree(basis_tree, wt)
2378
super(WorkingTreeFormat2, self).__init__()
2379
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2381
def open(self, a_bzrdir, _found=False):
2382
"""Return the WorkingTree object for a_bzrdir
2384
_found is a private parameter, do not use it. It is used to indicate
2385
if format probing has already been done.
2388
# we are being called directly and must probe.
2389
raise NotImplementedError
2390
if not isinstance(a_bzrdir.transport, LocalTransport):
2391
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2392
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2398
class WorkingTreeFormat3(WorkingTreeFormat):
2399
"""The second working tree format updated to record a format marker.
2402
- exists within a metadir controlling .bzr
2403
- includes an explicit version marker for the workingtree control
2404
files, separate from the BzrDir format
2405
- modifies the hash cache format
2407
- uses a LockDir to guard access for writes.
2410
def get_format_string(self):
2411
"""See WorkingTreeFormat.get_format_string()."""
2412
return "Bazaar-NG Working Tree format 3"
2414
def get_format_description(self):
2415
"""See WorkingTreeFormat.get_format_description()."""
2416
return "Working tree format 3"
2418
_lock_file_name = 'lock'
2419
_lock_class = LockDir
2421
def _open_control_files(self, a_bzrdir):
2422
transport = a_bzrdir.get_workingtree_transport(None)
2423
return LockableFiles(transport, self._lock_file_name,
2426
def initialize(self, a_bzrdir, revision_id=None):
2427
"""See WorkingTreeFormat.initialize().
2429
revision_id allows creating a working tree at a different
2430
revision than the branch is at.
2432
if not isinstance(a_bzrdir.transport, LocalTransport):
2433
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2434
transport = a_bzrdir.get_workingtree_transport(self)
2435
control_files = self._open_control_files(a_bzrdir)
2436
control_files.create_lock()
2437
control_files.lock_write()
2438
control_files.put_utf8('format', self.get_format_string())
2439
branch = a_bzrdir.open_branch()
2440
if revision_id is None:
2441
revision_id = branch.last_revision()
2443
revision_id = osutils.safe_revision_id(revision_id)
2444
# WorkingTree3 can handle an inventory which has a unique root id.
2445
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2446
# those trees. And because there isn't a format bump inbetween, we
2447
# are maintaining compatibility with older clients.
2448
# inv = Inventory(root_id=gen_root_id())
2450
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2456
_control_files=control_files)
2457
wt.lock_tree_write()
2459
basis_tree = branch.repository.revision_tree(revision_id)
2460
# only set an explicit root id if there is one to set.
2461
if basis_tree.inventory.root is not None:
2462
wt.set_root_id(basis_tree.inventory.root.file_id)
2463
if revision_id == NULL_REVISION:
2464
wt.set_parent_trees([])
2466
wt.set_parent_trees([(revision_id, basis_tree)])
2467
transform.build_tree(basis_tree, wt)
2469
# Unlock in this order so that the unlock-triggers-flush in
2470
# WorkingTree is given a chance to fire.
2471
control_files.unlock()
2476
super(WorkingTreeFormat3, self).__init__()
2477
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2479
def open(self, a_bzrdir, _found=False):
2480
"""Return the WorkingTree object for a_bzrdir
2482
_found is a private parameter, do not use it. It is used to indicate
2483
if format probing has already been done.
2486
# we are being called directly and must probe.
2487
raise NotImplementedError
2488
if not isinstance(a_bzrdir.transport, LocalTransport):
2489
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2490
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2492
def _open(self, a_bzrdir, control_files):
2493
"""Open the tree itself.
2495
:param a_bzrdir: the dir for the tree.
2496
:param control_files: the control files for the tree.
2498
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2502
_control_files=control_files)
2505
return self.get_format_string()
2508
__default_format = WorkingTreeFormat3()
2509
WorkingTreeFormat.register_format(__default_format)
2510
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2511
WorkingTreeFormat.set_default_format(__default_format)
2512
# formats which have no format string are not discoverable
2513
# and not independently creatable, so are not registered.
2514
_legacy_formats = [WorkingTreeFormat2(),
2518
class WorkingTreeTestProviderAdapter(object):
2519
"""A tool to generate a suite testing multiple workingtree formats at once.
2521
This is done by copying the test once for each transport and injecting
2522
the transport_server, transport_readonly_server, and workingtree_format
2523
classes into each copy. Each copy is also given a new id() to make it
2527
def __init__(self, transport_server, transport_readonly_server, formats):
2528
self._transport_server = transport_server
2529
self._transport_readonly_server = transport_readonly_server
2530
self._formats = formats
2532
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2533
"""Clone test for adaption."""
2534
new_test = deepcopy(test)
2535
new_test.transport_server = self._transport_server
2536
new_test.transport_readonly_server = self._transport_readonly_server
2537
new_test.bzrdir_format = bzrdir_format
2538
new_test.workingtree_format = workingtree_format
2539
def make_new_test_id():
2540
new_id = "%s(%s)" % (test.id(), variation)
2541
return lambda: new_id
2542
new_test.id = make_new_test_id()
2545
def adapt(self, test):
2546
from bzrlib.tests import TestSuite
2547
result = TestSuite()
2548
for workingtree_format, bzrdir_format in self._formats:
2549
new_test = self._clone_test(
2552
workingtree_format, workingtree_format.__class__.__name__)
2553
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
