1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
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, [self.id2path(file_id)],
478
require_versioned=True).next()
479
changed_content, kind = changes[2], changes[6]
480
if not changed_content:
481
return basis.annotate_iter(file_id)
485
if kind[0] != 'file':
488
old_lines = list(basis.annotate_iter(file_id))
490
for tree in self.branch.repository.revision_trees(
491
self.get_parent_ids()[1:]):
492
if file_id not in tree:
494
old.append(list(tree.annotate_iter(file_id)))
495
return annotate.reannotate(old, self.get_file(file_id).readlines(),
498
def get_parent_ids(self):
499
"""See Tree.get_parent_ids.
501
This implementation reads the pending merges list and last_revision
502
value and uses that to decide what the parents list should be.
504
last_rev = self._last_revision()
510
merges_file = self._control_files.get('pending-merges')
511
except errors.NoSuchFile:
514
for l in merges_file.readlines():
515
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
516
parents.append(revision_id)
520
def get_root_id(self):
521
"""Return the id of this trees root"""
522
return self._inventory.root.file_id
524
def _get_store_filename(self, file_id):
525
## XXX: badly named; this is not in the store at all
526
file_id = osutils.safe_file_id(file_id)
527
return self.abspath(self.id2path(file_id))
530
def clone(self, to_bzrdir, revision_id=None, basis=None):
531
"""Duplicate this working tree into to_bzr, including all state.
533
Specifically modified files are kept as modified, but
534
ignored and unknown files are discarded.
536
If you want to make a new line of development, see bzrdir.sprout()
539
If not None, the cloned tree will have its last revision set to
540
revision, and and difference between the source trees last revision
541
and this one merged in.
544
If not None, a closer copy of a tree which may have some files in
545
common, and which file content should be preferentially copied from.
547
# assumes the target bzr dir format is compatible.
548
result = self._format.initialize(to_bzrdir)
549
self.copy_content_into(result, revision_id)
553
def copy_content_into(self, tree, revision_id=None):
554
"""Copy the current content and user files of this tree into tree."""
555
tree.set_root_id(self.get_root_id())
556
if revision_id is None:
557
merge.transform_tree(tree, self)
559
# TODO now merge from tree.last_revision to revision (to preserve
560
# user local changes)
561
merge.transform_tree(tree, self)
562
tree.set_parent_ids([revision_id])
564
def id2abspath(self, file_id):
565
file_id = osutils.safe_file_id(file_id)
566
return self.abspath(self.id2path(file_id))
568
def has_id(self, file_id):
569
# files that have been deleted are excluded
570
file_id = osutils.safe_file_id(file_id)
572
if not inv.has_id(file_id):
574
path = inv.id2path(file_id)
575
return osutils.lexists(self.abspath(path))
577
def has_or_had_id(self, file_id):
578
file_id = osutils.safe_file_id(file_id)
579
if file_id == self.inventory.root.file_id:
581
return self.inventory.has_id(file_id)
583
__contains__ = has_id
585
def get_file_size(self, file_id):
586
file_id = osutils.safe_file_id(file_id)
587
return os.path.getsize(self.id2abspath(file_id))
590
def get_file_sha1(self, file_id, path=None, stat_value=None):
591
file_id = osutils.safe_file_id(file_id)
593
path = self._inventory.id2path(file_id)
594
return self._hashcache.get_sha1(path, stat_value)
596
def get_file_mtime(self, file_id, path=None):
597
file_id = osutils.safe_file_id(file_id)
599
path = self.inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
if not supports_executable():
603
def is_executable(self, file_id, path=None):
604
file_id = osutils.safe_file_id(file_id)
605
return self._inventory[file_id].executable
607
def is_executable(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
610
path = self.id2path(file_id)
611
mode = os.lstat(self.abspath(path)).st_mode
612
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
614
@needs_tree_write_lock
615
def _add(self, files, ids, kinds):
616
"""See MutableTree._add."""
617
# TODO: Re-adding a file that is removed in the working copy
618
# should probably put it back with the previous ID.
619
# the read and write working inventory should not occur in this
620
# function - they should be part of lock_write and unlock.
621
inv = self.read_working_inventory()
622
for f, file_id, kind in zip(files, ids, kinds):
623
assert kind is not None
625
inv.add_path(f, kind=kind)
627
file_id = osutils.safe_file_id(file_id)
628
inv.add_path(f, kind=kind, file_id=file_id)
629
self._write_inventory(inv)
631
@needs_tree_write_lock
632
def _gather_kinds(self, files, kinds):
633
"""See MutableTree._gather_kinds."""
634
for pos, f in enumerate(files):
635
if kinds[pos] is None:
636
fullpath = normpath(self.abspath(f))
638
kinds[pos] = file_kind(fullpath)
640
if e.errno == errno.ENOENT:
641
raise errors.NoSuchFile(fullpath)
644
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
645
"""Add revision_id as a parent.
647
This is equivalent to retrieving the current list of parent ids
648
and setting the list to its value plus revision_id.
650
:param revision_id: The revision id to add to the parent list. It may
651
be a ghost revision as long as its not the first parent to be added,
652
or the allow_leftmost_as_ghost parameter is set True.
653
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
655
parents = self.get_parent_ids() + [revision_id]
656
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
657
or allow_leftmost_as_ghost)
659
@needs_tree_write_lock
660
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
661
"""Add revision_id, tree tuple as a parent.
663
This is equivalent to retrieving the current list of parent trees
664
and setting the list to its value plus parent_tuple. See also
665
add_parent_tree_id - if you only have a parent id available it will be
666
simpler to use that api. If you have the parent already available, using
667
this api is preferred.
669
:param parent_tuple: The (revision id, tree) to add to the parent list.
670
If the revision_id is a ghost, pass None for the tree.
671
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
673
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
674
if len(parent_ids) > 1:
675
# the leftmost may have already been a ghost, preserve that if it
677
allow_leftmost_as_ghost = True
678
self.set_parent_ids(parent_ids,
679
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
681
@needs_tree_write_lock
682
def add_pending_merge(self, *revision_ids):
683
# TODO: Perhaps should check at this point that the
684
# history of the revision is actually present?
685
parents = self.get_parent_ids()
687
for rev_id in revision_ids:
688
if rev_id in parents:
690
parents.append(rev_id)
693
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
695
@deprecated_method(zero_eleven)
697
def pending_merges(self):
698
"""Return a list of pending merges.
700
These are revisions that have been merged into the working
701
directory but not yet committed.
703
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
704
instead - which is available on all tree objects.
706
return self.get_parent_ids()[1:]
708
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
709
"""Common ghost checking functionality from set_parent_*.
711
This checks that the left hand-parent exists if there are any
714
if len(revision_ids) > 0:
715
leftmost_id = revision_ids[0]
716
if (not allow_leftmost_as_ghost and not
717
self.branch.repository.has_revision(leftmost_id)):
718
raise errors.GhostRevisionUnusableHere(leftmost_id)
720
def _set_merges_from_parent_ids(self, parent_ids):
721
merges = parent_ids[1:]
722
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
724
@needs_tree_write_lock
725
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
726
"""Set the parent ids to revision_ids.
728
See also set_parent_trees. This api will try to retrieve the tree data
729
for each element of revision_ids from the trees repository. If you have
730
tree data already available, it is more efficient to use
731
set_parent_trees rather than set_parent_ids. set_parent_ids is however
732
an easier API to use.
734
:param revision_ids: The revision_ids to set as the parent ids of this
735
working tree. Any of these may be ghosts.
737
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
738
self._check_parents_for_ghosts(revision_ids,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
741
if len(revision_ids) > 0:
742
self.set_last_revision(revision_ids[0])
744
self.set_last_revision(None)
746
self._set_merges_from_parent_ids(revision_ids)
748
@needs_tree_write_lock
749
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
750
"""See MutableTree.set_parent_trees."""
751
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
753
self._check_parents_for_ghosts(parent_ids,
754
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
756
if len(parent_ids) == 0:
757
leftmost_parent_id = None
758
leftmost_parent_tree = None
760
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
762
if self._change_last_revision(leftmost_parent_id):
763
if leftmost_parent_tree is None:
764
# If we don't have a tree, fall back to reading the
765
# parent tree from the repository.
766
self._cache_basis_inventory(leftmost_parent_id)
768
inv = leftmost_parent_tree.inventory
769
xml = self._create_basis_xml_from_inventory(
770
leftmost_parent_id, inv)
771
self._write_basis_inventory(xml)
772
self._set_merges_from_parent_ids(parent_ids)
774
@needs_tree_write_lock
775
def set_pending_merges(self, rev_list):
776
parents = self.get_parent_ids()
777
leftmost = parents[:1]
778
new_parents = leftmost + rev_list
779
self.set_parent_ids(new_parents)
781
@needs_tree_write_lock
782
def set_merge_modified(self, modified_hashes):
784
for file_id, hash in modified_hashes.iteritems():
785
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
786
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
788
@needs_tree_write_lock
789
def _put_rio(self, filename, stanzas, header):
790
my_file = rio_file(stanzas, header)
791
self._control_files.put(filename, my_file)
793
@needs_write_lock # because merge pulls data into the branch.
794
def merge_from_branch(self, branch, to_revision=None):
795
"""Merge from a branch into this working tree.
797
:param branch: The branch to merge from.
798
:param to_revision: If non-None, the merge will merge to to_revision,
799
but not beyond it. to_revision does not need to be in the history
800
of the branch when it is supplied. If None, to_revision defaults to
801
branch.last_revision().
803
from bzrlib.merge import Merger, Merge3Merger
804
pb = bzrlib.ui.ui_factory.nested_progress_bar()
806
merger = Merger(self.branch, this_tree=self, pb=pb)
807
merger.pp = ProgressPhase("Merge phase", 5, pb)
808
merger.pp.next_phase()
809
# check that there are no
811
merger.check_basis(check_clean=True, require_commits=False)
812
if to_revision is None:
813
to_revision = branch.last_revision()
815
to_revision = osutils.safe_revision_id(to_revision)
816
merger.other_rev_id = to_revision
817
if merger.other_rev_id is None:
818
raise error.NoCommits(branch)
819
self.branch.fetch(branch, last_revision=merger.other_rev_id)
820
merger.other_basis = merger.other_rev_id
821
merger.other_tree = self.branch.repository.revision_tree(
823
merger.pp.next_phase()
825
if merger.base_rev_id == merger.other_rev_id:
826
raise errors.PointlessMerge
827
merger.backup_files = False
828
merger.merge_type = Merge3Merger
829
merger.set_interesting_files(None)
830
merger.show_base = False
831
merger.reprocess = False
832
conflicts = merger.do_merge()
839
def merge_modified(self):
841
hashfile = self._control_files.get('merge-hashes')
842
except errors.NoSuchFile:
846
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
847
raise errors.MergeModifiedFormatError()
848
except StopIteration:
849
raise errors.MergeModifiedFormatError()
850
for s in RioReader(hashfile):
851
file_id = s.get("file_id")
852
if file_id not in self.inventory:
855
if hash == self.get_file_sha1(file_id):
856
merge_hashes[file_id] = hash
860
def mkdir(self, path, file_id=None):
861
"""See MutableTree.mkdir()."""
863
file_id = generate_ids.gen_file_id(os.path.basename(path))
864
os.mkdir(self.abspath(path))
865
self.add(path, file_id, 'directory')
868
def get_symlink_target(self, file_id):
869
return os.readlink(self.id2abspath(file_id))
871
def file_class(self, filename):
872
if self.path2id(filename):
874
elif self.is_ignored(filename):
880
"""Write the in memory inventory to disk."""
881
# TODO: Maybe this should only write on dirty ?
882
if self._control_files._lock_mode != 'w':
883
raise errors.NotWriteLocked(self)
885
xml5.serializer_v5.write_inventory(self._inventory, sio)
887
self._control_files.put('inventory', sio)
888
self._inventory_is_modified = False
890
def list_files(self, include_root=False):
891
"""Recursively list all files as (path, class, kind, id, entry).
893
Lists, but does not descend into unversioned directories.
895
This does not include files that have been deleted in this
898
Skips the control directory.
900
# list_files is an iterator, so @needs_read_lock doesn't work properly
901
# with it. So callers should be careful to always read_lock the tree.
902
if not self.is_locked():
903
raise errors.ObjectNotLocked(self)
906
if include_root is True:
907
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
908
# Convert these into local objects to save lookup times
909
pathjoin = osutils.pathjoin
910
file_kind = osutils.file_kind
912
# transport.base ends in a slash, we want the piece
913
# between the last two slashes
914
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
916
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
918
# directory file_id, relative path, absolute path, reverse sorted children
919
children = os.listdir(self.basedir)
921
# jam 20060527 The kernel sized tree seems equivalent whether we
922
# use a deque and popleft to keep them sorted, or if we use a plain
923
# list and just reverse() them.
924
children = collections.deque(children)
925
stack = [(inv.root.file_id, u'', self.basedir, children)]
927
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
930
f = children.popleft()
931
## TODO: If we find a subdirectory with its own .bzr
932
## directory, then that is a separate tree and we
933
## should exclude it.
935
# the bzrdir for this tree
936
if transport_base_dir == f:
939
# we know that from_dir_relpath and from_dir_abspath never end in a slash
940
# and 'f' doesn't begin with one, we can do a string op, rather
941
# than the checks of pathjoin(), all relative paths will have an extra slash
943
fp = from_dir_relpath + '/' + f
946
fap = from_dir_abspath + '/' + f
948
f_ie = inv.get_child(from_dir_id, f)
951
elif self.is_ignored(fp[1:]):
954
# we may not have found this file, because of a unicode issue
955
f_norm, can_access = osutils.normalized_filename(f)
956
if f == f_norm or not can_access:
957
# No change, so treat this file normally
960
# this file can be accessed by a normalized path
961
# check again if it is versioned
962
# these lines are repeated here for performance
964
fp = from_dir_relpath + '/' + f
965
fap = from_dir_abspath + '/' + f
966
f_ie = inv.get_child(from_dir_id, f)
969
elif self.is_ignored(fp[1:]):
978
raise errors.BzrCheckError(
979
"file %r entered as kind %r id %r, now of kind %r"
980
% (fap, f_ie.kind, f_ie.file_id, fk))
982
# make a last minute entry
984
yield fp[1:], c, fk, f_ie.file_id, f_ie
987
yield fp[1:], c, fk, None, fk_entries[fk]()
989
yield fp[1:], c, fk, None, TreeEntry()
992
if fk != 'directory':
995
# But do this child first
996
new_children = os.listdir(fap)
998
new_children = collections.deque(new_children)
999
stack.append((f_ie.file_id, fp, fap, new_children))
1000
# Break out of inner loop,
1001
# so that we start outer loop with child
1004
# if we finished all children, pop it off the stack
1007
@needs_tree_write_lock
1008
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1011
to_dir must exist in the inventory.
1013
If to_dir exists and is a directory, the files are moved into
1014
it, keeping their old names.
1016
Note that to_dir is only the last component of the new name;
1017
this doesn't change the directory.
1019
For each entry in from_paths the move mode will be determined
1022
The first mode moves the file in the filesystem and updates the
1023
inventory. The second mode only updates the inventory without
1024
touching the file on the filesystem. This is the new mode introduced
1027
move uses the second mode if 'after == True' and the target is not
1028
versioned but present in the working tree.
1030
move uses the second mode if 'after == False' and the source is
1031
versioned but no longer in the working tree, and the target is not
1032
versioned but present in the working tree.
1034
move uses the first mode if 'after == False' and the source is
1035
versioned and present in the working tree, and the target is not
1036
versioned and not present in the working tree.
1038
Everything else results in an error.
1040
This returns a list of (from_path, to_path) pairs for each
1041
entry that is moved.
1046
# check for deprecated use of signature
1048
to_dir = kwargs.get('to_name', None)
1050
raise TypeError('You must supply a target directory')
1052
symbol_versioning.warn('The parameter to_name was deprecated'
1053
' in version 0.13. Use to_dir instead',
1056
# check destination directory
1057
assert not isinstance(from_paths, basestring)
1058
inv = self.inventory
1059
to_abs = self.abspath(to_dir)
1060
if not isdir(to_abs):
1061
raise errors.BzrMoveFailedError('',to_dir,
1062
errors.NotADirectory(to_abs))
1063
if not self.has_filename(to_dir):
1064
raise errors.BzrMoveFailedError('',to_dir,
1065
errors.NotInWorkingDirectory(to_dir))
1066
to_dir_id = inv.path2id(to_dir)
1067
if to_dir_id is None:
1068
raise errors.BzrMoveFailedError('',to_dir,
1069
errors.NotVersionedError(path=str(to_dir)))
1071
to_dir_ie = inv[to_dir_id]
1072
if to_dir_ie.kind != 'directory':
1073
raise errors.BzrMoveFailedError('',to_dir,
1074
errors.NotADirectory(to_abs))
1076
# create rename entries and tuples
1077
for from_rel in from_paths:
1078
from_tail = splitpath(from_rel)[-1]
1079
from_id = inv.path2id(from_rel)
1081
raise errors.BzrMoveFailedError(from_rel,to_dir,
1082
errors.NotVersionedError(path=str(from_rel)))
1084
from_entry = inv[from_id]
1085
from_parent_id = from_entry.parent_id
1086
to_rel = pathjoin(to_dir, from_tail)
1087
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1089
from_tail=from_tail,
1090
from_parent_id=from_parent_id,
1091
to_rel=to_rel, to_tail=from_tail,
1092
to_parent_id=to_dir_id)
1093
rename_entries.append(rename_entry)
1094
rename_tuples.append((from_rel, to_rel))
1096
# determine which move mode to use. checks also for movability
1097
rename_entries = self._determine_mv_mode(rename_entries, after)
1099
original_modified = self._inventory_is_modified
1102
self._inventory_is_modified = True
1103
self._move(rename_entries)
1105
# restore the inventory on error
1106
self._inventory_is_modified = original_modified
1108
self._write_inventory(inv)
1109
return rename_tuples
1111
def _determine_mv_mode(self, rename_entries, after=False):
1112
"""Determines for each from-to pair if both inventory and working tree
1113
or only the inventory has to be changed.
1115
Also does basic plausability tests.
1117
inv = self.inventory
1119
for rename_entry in rename_entries:
1120
# store to local variables for easier reference
1121
from_rel = rename_entry.from_rel
1122
from_id = rename_entry.from_id
1123
to_rel = rename_entry.to_rel
1124
to_id = inv.path2id(to_rel)
1125
only_change_inv = False
1127
# check the inventory for source and destination
1129
raise errors.BzrMoveFailedError(from_rel,to_rel,
1130
errors.NotVersionedError(path=str(from_rel)))
1131
if to_id is not None:
1132
raise errors.BzrMoveFailedError(from_rel,to_rel,
1133
errors.AlreadyVersionedError(path=str(to_rel)))
1135
# try to determine the mode for rename (only change inv or change
1136
# inv and file system)
1138
if not self.has_filename(to_rel):
1139
raise errors.BzrMoveFailedError(from_id,to_rel,
1140
errors.NoSuchFile(path=str(to_rel),
1141
extra="New file has not been created yet"))
1142
only_change_inv = True
1143
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1144
only_change_inv = True
1145
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1146
only_change_inv = False
1148
# something is wrong, so lets determine what exactly
1149
if not self.has_filename(from_rel) and \
1150
not self.has_filename(to_rel):
1151
raise errors.BzrRenameFailedError(from_rel,to_rel,
1152
errors.PathsDoNotExist(paths=(str(from_rel),
1155
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1156
extra="(Use --after to update the Bazaar id)")
1157
rename_entry.only_change_inv = only_change_inv
1158
return rename_entries
1160
def _move(self, rename_entries):
1161
"""Moves a list of files.
1163
Depending on the value of the flag 'only_change_inv', the
1164
file will be moved on the file system or not.
1166
inv = self.inventory
1169
for entry in rename_entries:
1171
self._move_entry(entry)
1173
self._rollback_move(moved)
1177
def _rollback_move(self, moved):
1178
"""Try to rollback a previous move in case of an filesystem error."""
1179
inv = self.inventory
1182
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1183
entry.to_tail, entry.to_parent_id, entry.from_rel,
1184
entry.from_tail, entry.from_parent_id,
1185
entry.only_change_inv))
1186
except errors.BzrMoveFailedError, e:
1187
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1188
" The working tree is in an inconsistent state."
1189
" Please consider doing a 'bzr revert'."
1190
" Error message is: %s" % e)
1192
def _move_entry(self, entry):
1193
inv = self.inventory
1194
from_rel_abs = self.abspath(entry.from_rel)
1195
to_rel_abs = self.abspath(entry.to_rel)
1196
if from_rel_abs == to_rel_abs:
1197
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1198
"Source and target are identical.")
1200
if not entry.only_change_inv:
1202
osutils.rename(from_rel_abs, to_rel_abs)
1204
raise errors.BzrMoveFailedError(entry.from_rel,
1206
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1208
@needs_tree_write_lock
1209
def rename_one(self, from_rel, to_rel, after=False):
1212
This can change the directory or the filename or both.
1214
rename_one has several 'modes' to work. First, it can rename a physical
1215
file and change the file_id. That is the normal mode. Second, it can
1216
only change the file_id without touching any physical file. This is
1217
the new mode introduced in version 0.15.
1219
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1220
versioned but present in the working tree.
1222
rename_one uses the second mode if 'after == False' and 'from_rel' is
1223
versioned but no longer in the working tree, and 'to_rel' is not
1224
versioned but present in the working tree.
1226
rename_one uses the first mode if 'after == False' and 'from_rel' is
1227
versioned and present in the working tree, and 'to_rel' is not
1228
versioned and not present in the working tree.
1230
Everything else results in an error.
1232
inv = self.inventory
1235
# create rename entries and tuples
1236
from_tail = splitpath(from_rel)[-1]
1237
from_id = inv.path2id(from_rel)
1239
raise errors.BzrRenameFailedError(from_rel,to_rel,
1240
errors.NotVersionedError(path=str(from_rel)))
1241
from_entry = inv[from_id]
1242
from_parent_id = from_entry.parent_id
1243
to_dir, to_tail = os.path.split(to_rel)
1244
to_dir_id = inv.path2id(to_dir)
1245
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1247
from_tail=from_tail,
1248
from_parent_id=from_parent_id,
1249
to_rel=to_rel, to_tail=to_tail,
1250
to_parent_id=to_dir_id)
1251
rename_entries.append(rename_entry)
1253
# determine which move mode to use. checks also for movability
1254
rename_entries = self._determine_mv_mode(rename_entries, after)
1256
# check if the target changed directory and if the target directory is
1258
if to_dir_id is None:
1259
raise errors.BzrMoveFailedError(from_rel,to_rel,
1260
errors.NotVersionedError(path=str(to_dir)))
1262
# all checks done. now we can continue with our actual work
1263
mutter('rename_one:\n'
1268
' to_dir_id {%s}\n',
1269
from_id, from_rel, to_rel, to_dir, to_dir_id)
1271
self._move(rename_entries)
1272
self._write_inventory(inv)
1274
class _RenameEntry(object):
1275
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1276
to_rel, to_tail, to_parent_id, only_change_inv=False):
1277
self.from_rel = from_rel
1278
self.from_id = from_id
1279
self.from_tail = from_tail
1280
self.from_parent_id = from_parent_id
1281
self.to_rel = to_rel
1282
self.to_tail = to_tail
1283
self.to_parent_id = to_parent_id
1284
self.only_change_inv = only_change_inv
1288
"""Return all unknown files.
1290
These are files in the working directory that are not versioned or
1291
control files or ignored.
1293
# force the extras method to be fully executed before returning, to
1294
# prevent race conditions with the lock
1296
[subp for subp in self.extras() if not self.is_ignored(subp)])
1298
@needs_tree_write_lock
1299
def unversion(self, file_ids):
1300
"""Remove the file ids in file_ids from the current versioned set.
1302
When a file_id is unversioned, all of its children are automatically
1305
:param file_ids: The file ids to stop versioning.
1306
:raises: NoSuchId if any fileid is not currently versioned.
1308
for file_id in file_ids:
1309
file_id = osutils.safe_file_id(file_id)
1310
if self._inventory.has_id(file_id):
1311
self._inventory.remove_recursive_id(file_id)
1313
raise errors.NoSuchId(self, file_id)
1315
# in the future this should just set a dirty bit to wait for the
1316
# final unlock. However, until all methods of workingtree start
1317
# with the current in -memory inventory rather than triggering
1318
# a read, it is more complex - we need to teach read_inventory
1319
# to know when to read, and when to not read first... and possibly
1320
# to save first when the in memory one may be corrupted.
1321
# so for now, we just only write it if it is indeed dirty.
1323
self._write_inventory(self._inventory)
1325
@deprecated_method(zero_eight)
1326
def iter_conflicts(self):
1327
"""List all files in the tree that have text or content conflicts.
1328
DEPRECATED. Use conflicts instead."""
1329
return self._iter_conflicts()
1331
def _iter_conflicts(self):
1333
for info in self.list_files():
1335
stem = get_conflicted_stem(path)
1338
if stem not in conflicted:
1339
conflicted.add(stem)
1343
def pull(self, source, overwrite=False, stop_revision=None,
1344
change_reporter=None):
1345
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1348
pp = ProgressPhase("Pull phase", 2, top_pb)
1350
old_revision_info = self.branch.last_revision_info()
1351
basis_tree = self.basis_tree()
1352
count = self.branch.pull(source, overwrite, stop_revision)
1353
new_revision_info = self.branch.last_revision_info()
1354
if new_revision_info != old_revision_info:
1356
repository = self.branch.repository
1357
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1358
basis_tree.lock_read()
1360
new_basis_tree = self.branch.basis_tree()
1367
change_reporter=change_reporter)
1368
if (basis_tree.inventory.root is None and
1369
new_basis_tree.inventory.root is not None):
1370
self.set_root_id(new_basis_tree.inventory.root.file_id)
1374
# TODO - dedup parents list with things merged by pull ?
1375
# reuse the revisiontree we merged against to set the new
1377
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1378
# we have to pull the merge trees out again, because
1379
# merge_inner has set the ids. - this corner is not yet
1380
# layered well enough to prevent double handling.
1381
# XXX TODO: Fix the double handling: telling the tree about
1382
# the already known parent data is wasteful.
1383
merges = self.get_parent_ids()[1:]
1384
parent_trees.extend([
1385
(parent, repository.revision_tree(parent)) for
1387
self.set_parent_trees(parent_trees)
1394
def put_file_bytes_non_atomic(self, file_id, bytes):
1395
"""See MutableTree.put_file_bytes_non_atomic."""
1396
file_id = osutils.safe_file_id(file_id)
1397
stream = file(self.id2abspath(file_id), 'wb')
1402
# TODO: update the hashcache here ?
1405
"""Yield all unversioned files in this WorkingTree.
1407
If there are any unversioned directories then only the directory is
1408
returned, not all its children. But if there are unversioned files
1409
under a versioned subdirectory, they are returned.
1411
Currently returned depth-first, sorted by name within directories.
1412
This is the same order used by 'osutils.walkdirs'.
1414
## TODO: Work from given directory downwards
1415
for path, dir_entry in self.inventory.directories():
1416
# mutter("search for unknowns in %r", path)
1417
dirabs = self.abspath(path)
1418
if not isdir(dirabs):
1419
# e.g. directory deleted
1423
for subf in os.listdir(dirabs):
1426
if subf not in dir_entry.children:
1427
subf_norm, can_access = osutils.normalized_filename(subf)
1428
if subf_norm != subf and can_access:
1429
if subf_norm not in dir_entry.children:
1430
fl.append(subf_norm)
1436
subp = pathjoin(path, subf)
1439
def ignored_files(self):
1440
"""Yield list of PATH, IGNORE_PATTERN"""
1441
for subp in self.extras():
1442
pat = self.is_ignored(subp)
1446
def get_ignore_list(self):
1447
"""Return list of ignore patterns.
1449
Cached in the Tree object after the first call.
1451
ignoreset = getattr(self, '_ignoreset', None)
1452
if ignoreset is not None:
1455
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1456
ignore_globs.update(ignores.get_runtime_ignores())
1457
ignore_globs.update(ignores.get_user_ignores())
1458
if self.has_filename(bzrlib.IGNORE_FILENAME):
1459
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1461
ignore_globs.update(ignores.parse_ignore_file(f))
1464
self._ignoreset = ignore_globs
1467
def _flush_ignore_list_cache(self):
1468
"""Resets the cached ignore list to force a cache rebuild."""
1469
self._ignoreset = None
1470
self._ignoreglobster = None
1472
def is_ignored(self, filename):
1473
r"""Check whether the filename matches an ignore pattern.
1475
Patterns containing '/' or '\' need to match the whole path;
1476
others match against only the last component.
1478
If the file is ignored, returns the pattern which caused it to
1479
be ignored, otherwise None. So this can simply be used as a
1480
boolean if desired."""
1481
if getattr(self, '_ignoreglobster', None) is None:
1482
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1483
return self._ignoreglobster.match(filename)
1485
def kind(self, file_id):
1486
return file_kind(self.id2abspath(file_id))
1488
def _comparison_data(self, entry, path):
1489
abspath = self.abspath(path)
1491
stat_value = os.lstat(abspath)
1493
if getattr(e, 'errno', None) == errno.ENOENT:
1500
mode = stat_value.st_mode
1501
kind = osutils.file_kind_from_stat_mode(mode)
1502
if not supports_executable():
1503
executable = entry.executable
1505
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1506
return kind, executable, stat_value
1508
def _file_size(self, entry, stat_value):
1509
return stat_value.st_size
1511
def last_revision(self):
1512
"""Return the last revision of the branch for this tree.
1514
This format tree does not support a separate marker for last-revision
1515
compared to the branch.
1517
See MutableTree.last_revision
1519
return self._last_revision()
1522
def _last_revision(self):
1523
"""helper for get_parent_ids."""
1524
return self.branch.last_revision()
1526
def is_locked(self):
1527
return self._control_files.is_locked()
1529
def lock_read(self):
1530
"""See Branch.lock_read, and WorkingTree.unlock."""
1531
self.branch.lock_read()
1533
return self._control_files.lock_read()
1535
self.branch.unlock()
1538
def lock_tree_write(self):
1539
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1540
self.branch.lock_read()
1542
return self._control_files.lock_write()
1544
self.branch.unlock()
1547
def lock_write(self):
1548
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1549
self.branch.lock_write()
1551
return self._control_files.lock_write()
1553
self.branch.unlock()
1556
def get_physical_lock_status(self):
1557
return self._control_files.get_physical_lock_status()
1559
def _basis_inventory_name(self):
1560
return 'basis-inventory-cache'
1562
@needs_tree_write_lock
1563
def set_last_revision(self, new_revision):
1564
"""Change the last revision in the working tree."""
1565
new_revision = osutils.safe_revision_id(new_revision)
1566
if self._change_last_revision(new_revision):
1567
self._cache_basis_inventory(new_revision)
1569
def _change_last_revision(self, new_revision):
1570
"""Template method part of set_last_revision to perform the change.
1572
This is used to allow WorkingTree3 instances to not affect branch
1573
when their last revision is set.
1575
if new_revision is None:
1576
self.branch.set_revision_history([])
1579
self.branch.generate_revision_history(new_revision)
1580
except errors.NoSuchRevision:
1581
# not present in the repo - dont try to set it deeper than the tip
1582
self.branch.set_revision_history([new_revision])
1585
def _write_basis_inventory(self, xml):
1586
"""Write the basis inventory XML to the basis-inventory file"""
1587
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1588
path = self._basis_inventory_name()
1590
self._control_files.put(path, sio)
1592
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1593
"""Create the text that will be saved in basis-inventory"""
1594
# TODO: jam 20070209 This should be redundant, as the revision_id
1595
# as all callers should have already converted the revision_id to
1597
inventory.revision_id = osutils.safe_revision_id(revision_id)
1598
return xml6.serializer_v6.write_inventory_to_string(inventory)
1600
def _cache_basis_inventory(self, new_revision):
1601
"""Cache new_revision as the basis inventory."""
1602
# TODO: this should allow the ready-to-use inventory to be passed in,
1603
# as commit already has that ready-to-use [while the format is the
1606
# this double handles the inventory - unpack and repack -
1607
# but is easier to understand. We can/should put a conditional
1608
# in here based on whether the inventory is in the latest format
1609
# - perhaps we should repack all inventories on a repository
1611
# the fast path is to copy the raw xml from the repository. If the
1612
# xml contains 'revision_id="', then we assume the right
1613
# revision_id is set. We must check for this full string, because a
1614
# root node id can legitimately look like 'revision_id' but cannot
1616
xml = self.branch.repository.get_inventory_xml(new_revision)
1617
firstline = xml.split('\n', 1)[0]
1618
if (not 'revision_id="' in firstline or
1619
'format="6"' not in firstline):
1620
inv = self.branch.repository.deserialise_inventory(
1622
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1623
self._write_basis_inventory(xml)
1624
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1627
def read_basis_inventory(self):
1628
"""Read the cached basis inventory."""
1629
path = self._basis_inventory_name()
1630
return self._control_files.get(path).read()
1633
def read_working_inventory(self):
1634
"""Read the working inventory.
1636
:raises errors.InventoryModified: read_working_inventory will fail
1637
when the current in memory inventory has been modified.
1639
# conceptually this should be an implementation detail of the tree.
1640
# XXX: Deprecate this.
1641
# ElementTree does its own conversion from UTF-8, so open in
1643
if self._inventory_is_modified:
1644
raise errors.InventoryModified(self)
1645
result = xml5.serializer_v5.read_inventory(
1646
self._control_files.get('inventory'))
1647
self._set_inventory(result, dirty=False)
1650
@needs_tree_write_lock
1651
def remove(self, files, verbose=False, to_file=None):
1652
"""Remove nominated files from the working inventory..
1654
This does not remove their text. This does not run on XXX on what? RBC
1656
TODO: Refuse to remove modified files unless --force is given?
1658
TODO: Do something useful with directories.
1660
TODO: Should this remove the text or not? Tough call; not
1661
removing may be useful and the user can just use use rm, and
1662
is the opposite of add. Removing it is consistent with most
1663
other tools. Maybe an option.
1665
## TODO: Normalize names
1666
## TODO: Remove nested loops; better scalability
1667
if isinstance(files, basestring):
1670
inv = self.inventory
1672
# do this before any modifications
1674
fid = inv.path2id(f)
1676
note("%s is not versioned."%f)
1679
# having remove it, it must be either ignored or unknown
1680
if self.is_ignored(f):
1684
textui.show_status(new_status, inv[fid].kind, f,
1688
self._write_inventory(inv)
1690
@needs_tree_write_lock
1691
def revert(self, filenames, old_tree=None, backups=True,
1692
pb=DummyProgress(), report_changes=False):
1693
from bzrlib.conflicts import resolve
1694
if old_tree is None:
1695
old_tree = self.basis_tree()
1696
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1698
if not len(filenames):
1699
self.set_parent_ids(self.get_parent_ids()[:1])
1702
resolve(self, filenames, ignore_misses=True)
1705
def revision_tree(self, revision_id):
1706
"""See Tree.revision_tree.
1708
WorkingTree can supply revision_trees for the basis revision only
1709
because there is only one cached inventory in the bzr directory.
1711
if revision_id == self.last_revision():
1713
xml = self.read_basis_inventory()
1714
except errors.NoSuchFile:
1718
inv = xml6.serializer_v6.read_inventory_from_string(xml)
1719
# dont use the repository revision_tree api because we want
1720
# to supply the inventory.
1721
if inv.revision_id == revision_id:
1722
return revisiontree.RevisionTree(self.branch.repository,
1724
except errors.BadInventoryFormat:
1726
# raise if there was no inventory, or if we read the wrong inventory.
1727
raise errors.NoSuchRevisionInTree(self, revision_id)
1729
# XXX: This method should be deprecated in favour of taking in a proper
1730
# new Inventory object.
1731
@needs_tree_write_lock
1732
def set_inventory(self, new_inventory_list):
1733
from bzrlib.inventory import (Inventory,
1738
inv = Inventory(self.get_root_id())
1739
for path, file_id, parent, kind in new_inventory_list:
1740
name = os.path.basename(path)
1743
# fixme, there should be a factory function inv,add_??
1744
if kind == 'directory':
1745
inv.add(InventoryDirectory(file_id, name, parent))
1746
elif kind == 'file':
1747
inv.add(InventoryFile(file_id, name, parent))
1748
elif kind == 'symlink':
1749
inv.add(InventoryLink(file_id, name, parent))
1751
raise errors.BzrError("unknown kind %r" % kind)
1752
self._write_inventory(inv)
1754
@needs_tree_write_lock
1755
def set_root_id(self, file_id):
1756
"""Set the root id for this tree."""
1759
symbol_versioning.warn(symbol_versioning.zero_twelve
1760
% 'WorkingTree.set_root_id with fileid=None',
1765
file_id = osutils.safe_file_id(file_id)
1766
self._set_root_id(file_id)
1768
def _set_root_id(self, file_id):
1769
"""Set the root id for this tree, in a format specific manner.
1771
:param file_id: The file id to assign to the root. It must not be
1772
present in the current inventory or an error will occur. It must
1773
not be None, but rather a valid file id.
1775
inv = self._inventory
1776
orig_root_id = inv.root.file_id
1777
# TODO: it might be nice to exit early if there was nothing
1778
# to do, saving us from trigger a sync on unlock.
1779
self._inventory_is_modified = True
1780
# we preserve the root inventory entry object, but
1781
# unlinkit from the byid index
1782
del inv._byid[inv.root.file_id]
1783
inv.root.file_id = file_id
1784
# and link it into the index with the new changed id.
1785
inv._byid[inv.root.file_id] = inv.root
1786
# and finally update all children to reference the new id.
1787
# XXX: this should be safe to just look at the root.children
1788
# list, not the WHOLE INVENTORY.
1791
if entry.parent_id == orig_root_id:
1792
entry.parent_id = inv.root.file_id
1795
"""See Branch.unlock.
1797
WorkingTree locking just uses the Branch locking facilities.
1798
This is current because all working trees have an embedded branch
1799
within them. IF in the future, we were to make branch data shareable
1800
between multiple working trees, i.e. via shared storage, then we
1801
would probably want to lock both the local tree, and the branch.
1803
raise NotImplementedError(self.unlock)
1806
"""Update a working tree along its branch.
1808
This will update the branch if its bound too, which means we have
1809
multiple trees involved:
1811
- The new basis tree of the master.
1812
- The old basis tree of the branch.
1813
- The old basis tree of the working tree.
1814
- The current working tree state.
1816
Pathologically, all three may be different, and non-ancestors of each
1817
other. Conceptually we want to:
1819
- Preserve the wt.basis->wt.state changes
1820
- Transform the wt.basis to the new master basis.
1821
- Apply a merge of the old branch basis to get any 'local' changes from
1823
- Restore the wt.basis->wt.state changes.
1825
There isn't a single operation at the moment to do that, so we:
1826
- Merge current state -> basis tree of the master w.r.t. the old tree
1828
- Do a 'normal' merge of the old branch basis if it is relevant.
1830
if self.branch.get_master_branch() is not None:
1832
update_branch = True
1834
self.lock_tree_write()
1835
update_branch = False
1838
old_tip = self.branch.update()
1841
return self._update_tree(old_tip)
1845
@needs_tree_write_lock
1846
def _update_tree(self, old_tip=None):
1847
"""Update a tree to the master branch.
1849
:param old_tip: if supplied, the previous tip revision the branch,
1850
before it was changed to the master branch's tip.
1852
# here if old_tip is not None, it is the old tip of the branch before
1853
# it was updated from the master branch. This should become a pending
1854
# merge in the working tree to preserve the user existing work. we
1855
# cant set that until we update the working trees last revision to be
1856
# one from the new branch, because it will just get absorbed by the
1857
# parent de-duplication logic.
1859
# We MUST save it even if an error occurs, because otherwise the users
1860
# local work is unreferenced and will appear to have been lost.
1864
last_rev = self.get_parent_ids()[0]
1867
if last_rev != self.branch.last_revision():
1868
# merge tree state up to new branch tip.
1869
basis = self.basis_tree()
1872
to_tree = self.branch.basis_tree()
1873
if basis.inventory.root is None and self.inventory.root is None:
1874
self.set_root_id(to_tree.inventory.root.file_id)
1875
result += merge.merge_inner(
1882
# TODO - dedup parents list with things merged by pull ?
1883
# reuse the tree we've updated to to set the basis:
1884
parent_trees = [(self.branch.last_revision(), to_tree)]
1885
merges = self.get_parent_ids()[1:]
1886
# Ideally we ask the tree for the trees here, that way the working
1887
# tree can decide whether to give us teh entire tree or give us a
1888
# lazy initialised tree. dirstate for instance will have the trees
1889
# in ram already, whereas a last-revision + basis-inventory tree
1890
# will not, but also does not need them when setting parents.
1891
for parent in merges:
1892
parent_trees.append(
1893
(parent, self.branch.repository.revision_tree(parent)))
1894
if old_tip is not None:
1895
parent_trees.append(
1896
(old_tip, self.branch.repository.revision_tree(old_tip)))
1897
self.set_parent_trees(parent_trees)
1898
last_rev = parent_trees[0][0]
1900
# the working tree had the same last-revision as the master
1901
# branch did. We may still have pivot local work from the local
1902
# branch into old_tip:
1903
if old_tip is not None:
1904
self.add_parent_tree_id(old_tip)
1905
if old_tip and old_tip != last_rev:
1906
# our last revision was not the prior branch last revision
1907
# and we have converted that last revision to a pending merge.
1908
# base is somewhere between the branch tip now
1909
# and the now pending merge
1911
# Since we just modified the working tree and inventory, flush out
1912
# the current state, before we modify it again.
1913
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
1914
# requires it only because TreeTransform directly munges the
1915
# inventory and calls tree._write_inventory(). Ultimately we
1916
# should be able to remove this extra flush.
1918
from bzrlib.revision import common_ancestor
1920
base_rev_id = common_ancestor(self.branch.last_revision(),
1922
self.branch.repository)
1923
except errors.NoCommonAncestor:
1925
base_tree = self.branch.repository.revision_tree(base_rev_id)
1926
other_tree = self.branch.repository.revision_tree(old_tip)
1927
result += merge.merge_inner(
1934
def _write_hashcache_if_dirty(self):
1935
"""Write out the hashcache if it is dirty."""
1936
if self._hashcache.needs_write:
1938
self._hashcache.write()
1940
if e.errno not in (errno.EPERM, errno.EACCES):
1942
# TODO: jam 20061219 Should this be a warning? A single line
1943
# warning might be sufficient to let the user know what
1945
mutter('Could not write hashcache for %s\nError: %s',
1946
self._hashcache.cache_file_name(), e)
1948
@needs_tree_write_lock
1949
def _write_inventory(self, inv):
1950
"""Write inventory as the current inventory."""
1951
self._set_inventory(inv, dirty=True)
1954
def set_conflicts(self, arg):
1955
raise errors.UnsupportedOperation(self.set_conflicts, self)
1957
def add_conflicts(self, arg):
1958
raise errors.UnsupportedOperation(self.add_conflicts, self)
1961
def conflicts(self):
1962
conflicts = _mod_conflicts.ConflictList()
1963
for conflicted in self._iter_conflicts():
1966
if file_kind(self.abspath(conflicted)) != "file":
1968
except errors.NoSuchFile:
1971
for suffix in ('.THIS', '.OTHER'):
1973
kind = file_kind(self.abspath(conflicted+suffix))
1976
except errors.NoSuchFile:
1980
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1981
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1983
file_id=self.path2id(conflicted)))
1986
def walkdirs(self, prefix=""):
1987
"""Walk the directories of this tree.
1989
This API returns a generator, which is only valid during the current
1990
tree transaction - within a single lock_read or lock_write duration.
1992
If the tree is not locked, it may cause an error to be raised, depending
1993
on the tree implementation.
1995
disk_top = self.abspath(prefix)
1996
if disk_top.endswith('/'):
1997
disk_top = disk_top[:-1]
1998
top_strip_len = len(disk_top) + 1
1999
inventory_iterator = self._walkdirs(prefix)
2000
disk_iterator = osutils.walkdirs(disk_top, prefix)
2002
current_disk = disk_iterator.next()
2003
disk_finished = False
2005
if e.errno != errno.ENOENT:
2008
disk_finished = True
2010
current_inv = inventory_iterator.next()
2011
inv_finished = False
2012
except StopIteration:
2015
while not inv_finished or not disk_finished:
2016
if not disk_finished:
2017
# strip out .bzr dirs
2018
if current_disk[0][1][top_strip_len:] == '':
2019
# osutils.walkdirs can be made nicer -
2020
# yield the path-from-prefix rather than the pathjoined
2022
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2023
if current_disk[1][bzrdir_loc][0] == '.bzr':
2024
# we dont yield the contents of, or, .bzr itself.
2025
del current_disk[1][bzrdir_loc]
2027
# everything is unknown
2030
# everything is missing
2033
direction = cmp(current_inv[0][0], current_disk[0][0])
2035
# disk is before inventory - unknown
2036
dirblock = [(relpath, basename, kind, stat, None, None) for
2037
relpath, basename, kind, stat, top_path in current_disk[1]]
2038
yield (current_disk[0][0], None), dirblock
2040
current_disk = disk_iterator.next()
2041
except StopIteration:
2042
disk_finished = True
2044
# inventory is before disk - missing.
2045
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2046
for relpath, basename, dkind, stat, fileid, kind in
2048
yield (current_inv[0][0], current_inv[0][1]), dirblock
2050
current_inv = inventory_iterator.next()
2051
except StopIteration:
2054
# versioned present directory
2055
# merge the inventory and disk data together
2057
for relpath, subiterator in itertools.groupby(sorted(
2058
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2059
path_elements = list(subiterator)
2060
if len(path_elements) == 2:
2061
inv_row, disk_row = path_elements
2062
# versioned, present file
2063
dirblock.append((inv_row[0],
2064
inv_row[1], disk_row[2],
2065
disk_row[3], inv_row[4],
2067
elif len(path_elements[0]) == 5:
2069
dirblock.append((path_elements[0][0],
2070
path_elements[0][1], path_elements[0][2],
2071
path_elements[0][3], None, None))
2072
elif len(path_elements[0]) == 6:
2073
# versioned, absent file.
2074
dirblock.append((path_elements[0][0],
2075
path_elements[0][1], 'unknown', None,
2076
path_elements[0][4], path_elements[0][5]))
2078
raise NotImplementedError('unreachable code')
2079
yield current_inv[0], dirblock
2081
current_inv = inventory_iterator.next()
2082
except StopIteration:
2085
current_disk = disk_iterator.next()
2086
except StopIteration:
2087
disk_finished = True
2089
def _walkdirs(self, prefix=""):
2090
_directory = 'directory'
2091
# get the root in the inventory
2092
inv = self.inventory
2093
top_id = inv.path2id(prefix)
2097
pending = [(prefix, '', _directory, None, top_id, None)]
2100
currentdir = pending.pop()
2101
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2102
top_id = currentdir[4]
2104
relroot = currentdir[0] + '/'
2107
# FIXME: stash the node in pending
2109
for name, child in entry.sorted_children():
2110
dirblock.append((relroot + name, name, child.kind, None,
2111
child.file_id, child.kind
2113
yield (currentdir[0], entry.file_id), dirblock
2114
# push the user specified dirs from dirblock
2115
for dir in reversed(dirblock):
2116
if dir[2] == _directory:
2120
class WorkingTree2(WorkingTree):
2121
"""This is the Format 2 working tree.
2123
This was the first weave based working tree.
2124
- uses os locks for locking.
2125
- uses the branch last-revision.
2128
def lock_tree_write(self):
2129
"""See WorkingTree.lock_tree_write().
2131
In Format2 WorkingTrees we have a single lock for the branch and tree
2132
so lock_tree_write() degrades to lock_write().
2134
self.branch.lock_write()
2136
return self._control_files.lock_write()
2138
self.branch.unlock()
2142
# we share control files:
2143
if self._control_files._lock_count == 3:
2144
# _inventory_is_modified is always False during a read lock.
2145
if self._inventory_is_modified:
2147
self._write_hashcache_if_dirty()
2149
# reverse order of locking.
2151
return self._control_files.unlock()
2153
self.branch.unlock()
2156
class WorkingTree3(WorkingTree):
2157
"""This is the Format 3 working tree.
2159
This differs from the base WorkingTree by:
2160
- having its own file lock
2161
- having its own last-revision property.
2163
This is new in bzr 0.8
2167
def _last_revision(self):
2168
"""See Mutable.last_revision."""
2170
return osutils.safe_revision_id(
2171
self._control_files.get('last-revision').read())
2172
except errors.NoSuchFile:
2175
def _change_last_revision(self, revision_id):
2176
"""See WorkingTree._change_last_revision."""
2177
if revision_id is None or revision_id == NULL_REVISION:
2179
self._control_files._transport.delete('last-revision')
2180
except errors.NoSuchFile:
2184
self._control_files.put_bytes('last-revision', revision_id)
2187
@needs_tree_write_lock
2188
def set_conflicts(self, conflicts):
2189
self._put_rio('conflicts', conflicts.to_stanzas(),
2192
@needs_tree_write_lock
2193
def add_conflicts(self, new_conflicts):
2194
conflict_set = set(self.conflicts())
2195
conflict_set.update(set(list(new_conflicts)))
2196
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2197
key=_mod_conflicts.Conflict.sort_key)))
2200
def conflicts(self):
2202
confile = self._control_files.get('conflicts')
2203
except errors.NoSuchFile:
2204
return _mod_conflicts.ConflictList()
2206
if confile.next() != CONFLICT_HEADER_1 + '\n':
2207
raise errors.ConflictFormatError()
2208
except StopIteration:
2209
raise errors.ConflictFormatError()
2210
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2213
if self._control_files._lock_count == 1:
2214
# _inventory_is_modified is always False during a read lock.
2215
if self._inventory_is_modified:
2217
self._write_hashcache_if_dirty()
2218
# reverse order of locking.
2220
return self._control_files.unlock()
2222
self.branch.unlock()
2225
def get_conflicted_stem(path):
2226
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2227
if path.endswith(suffix):
2228
return path[:-len(suffix)]
2231
@deprecated_function(zero_eight)
2232
def is_control_file(filename):
2233
"""See WorkingTree.is_control_filename(filename)."""
2234
## FIXME: better check
2235
filename = normpath(filename)
2236
while filename != '':
2237
head, tail = os.path.split(filename)
2238
## mutter('check %r for control file' % ((head, tail),))
2241
if filename == head:
2247
class WorkingTreeFormat(object):
2248
"""An encapsulation of the initialization and open routines for a format.
2250
Formats provide three things:
2251
* An initialization routine,
2255
Formats are placed in an dict by their format string for reference
2256
during workingtree opening. Its not required that these be instances, they
2257
can be classes themselves with class methods - it simply depends on
2258
whether state is needed for a given format or not.
2260
Once a format is deprecated, just deprecate the initialize and open
2261
methods on the format class. Do not deprecate the object, as the
2262
object will be created every time regardless.
2265
_default_format = None
2266
"""The default format used for new trees."""
2269
"""The known formats."""
2272
def find_format(klass, a_bzrdir):
2273
"""Return the format for the working tree object in a_bzrdir."""
2275
transport = a_bzrdir.get_workingtree_transport(None)
2276
format_string = transport.get("format").read()
2277
return klass._formats[format_string]
2278
except errors.NoSuchFile:
2279
raise errors.NoWorkingTree(base=transport.base)
2281
raise errors.UnknownFormatError(format=format_string)
2284
def get_default_format(klass):
2285
"""Return the current default format."""
2286
return klass._default_format
2288
def get_format_string(self):
2289
"""Return the ASCII format string that identifies this format."""
2290
raise NotImplementedError(self.get_format_string)
2292
def get_format_description(self):
2293
"""Return the short description for this format."""
2294
raise NotImplementedError(self.get_format_description)
2296
def is_supported(self):
2297
"""Is this format supported?
2299
Supported formats can be initialized and opened.
2300
Unsupported formats may not support initialization or committing or
2301
some other features depending on the reason for not being supported.
2306
def register_format(klass, format):
2307
klass._formats[format.get_format_string()] = format
2310
def set_default_format(klass, format):
2311
klass._default_format = format
2314
def unregister_format(klass, format):
2315
assert klass._formats[format.get_format_string()] is format
2316
del klass._formats[format.get_format_string()]
2320
class WorkingTreeFormat2(WorkingTreeFormat):
2321
"""The second working tree format.
2323
This format modified the hash cache from the format 1 hash cache.
2326
def get_format_description(self):
2327
"""See WorkingTreeFormat.get_format_description()."""
2328
return "Working tree format 2"
2330
def stub_initialize_remote(self, control_files):
2331
"""As a special workaround create critical control files for a remote working tree
2333
This ensures that it can later be updated and dealt with locally,
2334
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2335
no working tree. (See bug #43064).
2339
xml5.serializer_v5.write_inventory(inv, sio)
2341
control_files.put('inventory', sio)
2343
control_files.put_bytes('pending-merges', '')
2346
def initialize(self, a_bzrdir, revision_id=None):
2347
"""See WorkingTreeFormat.initialize()."""
2348
if not isinstance(a_bzrdir.transport, LocalTransport):
2349
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2350
branch = a_bzrdir.open_branch()
2351
if revision_id is not None:
2352
revision_id = osutils.safe_revision_id(revision_id)
2355
revision_history = branch.revision_history()
2357
position = revision_history.index(revision_id)
2359
raise errors.NoSuchRevision(branch, revision_id)
2360
branch.set_revision_history(revision_history[:position + 1])
2363
revision = branch.last_revision()
2365
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2371
basis_tree = branch.repository.revision_tree(revision)
2372
if basis_tree.inventory.root is not None:
2373
wt.set_root_id(basis_tree.inventory.root.file_id)
2374
# set the parent list and cache the basis tree.
2375
wt.set_parent_trees([(revision, basis_tree)])
2376
transform.build_tree(basis_tree, wt)
2380
super(WorkingTreeFormat2, self).__init__()
2381
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2383
def open(self, a_bzrdir, _found=False):
2384
"""Return the WorkingTree object for a_bzrdir
2386
_found is a private parameter, do not use it. It is used to indicate
2387
if format probing has already been done.
2390
# we are being called directly and must probe.
2391
raise NotImplementedError
2392
if not isinstance(a_bzrdir.transport, LocalTransport):
2393
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2394
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2400
class WorkingTreeFormat3(WorkingTreeFormat):
2401
"""The second working tree format updated to record a format marker.
2404
- exists within a metadir controlling .bzr
2405
- includes an explicit version marker for the workingtree control
2406
files, separate from the BzrDir format
2407
- modifies the hash cache format
2409
- uses a LockDir to guard access for writes.
2412
def get_format_string(self):
2413
"""See WorkingTreeFormat.get_format_string()."""
2414
return "Bazaar-NG Working Tree format 3"
2416
def get_format_description(self):
2417
"""See WorkingTreeFormat.get_format_description()."""
2418
return "Working tree format 3"
2420
_lock_file_name = 'lock'
2421
_lock_class = LockDir
2423
def _open_control_files(self, a_bzrdir):
2424
transport = a_bzrdir.get_workingtree_transport(None)
2425
return LockableFiles(transport, self._lock_file_name,
2428
def initialize(self, a_bzrdir, revision_id=None):
2429
"""See WorkingTreeFormat.initialize().
2431
revision_id allows creating a working tree at a different
2432
revision than the branch is at.
2434
if not isinstance(a_bzrdir.transport, LocalTransport):
2435
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2436
transport = a_bzrdir.get_workingtree_transport(self)
2437
control_files = self._open_control_files(a_bzrdir)
2438
control_files.create_lock()
2439
control_files.lock_write()
2440
control_files.put_utf8('format', self.get_format_string())
2441
branch = a_bzrdir.open_branch()
2442
if revision_id is None:
2443
revision_id = branch.last_revision()
2445
revision_id = osutils.safe_revision_id(revision_id)
2446
# WorkingTree3 can handle an inventory which has a unique root id.
2447
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2448
# those trees. And because there isn't a format bump inbetween, we
2449
# are maintaining compatibility with older clients.
2450
# inv = Inventory(root_id=gen_root_id())
2452
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2458
_control_files=control_files)
2459
wt.lock_tree_write()
2461
basis_tree = branch.repository.revision_tree(revision_id)
2462
# only set an explicit root id if there is one to set.
2463
if basis_tree.inventory.root is not None:
2464
wt.set_root_id(basis_tree.inventory.root.file_id)
2465
if revision_id == NULL_REVISION:
2466
wt.set_parent_trees([])
2468
wt.set_parent_trees([(revision_id, basis_tree)])
2469
transform.build_tree(basis_tree, wt)
2471
# Unlock in this order so that the unlock-triggers-flush in
2472
# WorkingTree is given a chance to fire.
2473
control_files.unlock()
2478
super(WorkingTreeFormat3, self).__init__()
2479
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2481
def open(self, a_bzrdir, _found=False):
2482
"""Return the WorkingTree object for a_bzrdir
2484
_found is a private parameter, do not use it. It is used to indicate
2485
if format probing has already been done.
2488
# we are being called directly and must probe.
2489
raise NotImplementedError
2490
if not isinstance(a_bzrdir.transport, LocalTransport):
2491
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2492
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2494
def _open(self, a_bzrdir, control_files):
2495
"""Open the tree itself.
2497
:param a_bzrdir: the dir for the tree.
2498
:param control_files: the control files for the tree.
2500
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2504
_control_files=control_files)
2507
return self.get_format_string()
2510
__default_format = WorkingTreeFormat4()
2511
WorkingTreeFormat.register_format(__default_format)
2512
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2513
WorkingTreeFormat.set_default_format(__default_format)
2514
# formats which have no format string are not discoverable
2515
# and not independently creatable, so are not registered.
2516
_legacy_formats = [WorkingTreeFormat2(),
2520
class WorkingTreeTestProviderAdapter(object):
2521
"""A tool to generate a suite testing multiple workingtree formats at once.
2523
This is done by copying the test once for each transport and injecting
2524
the transport_server, transport_readonly_server, and workingtree_format
2525
classes into each copy. Each copy is also given a new id() to make it
2529
def __init__(self, transport_server, transport_readonly_server, formats):
2530
self._transport_server = transport_server
2531
self._transport_readonly_server = transport_readonly_server
2532
self._formats = formats
2534
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2535
"""Clone test for adaption."""
2536
new_test = deepcopy(test)
2537
new_test.transport_server = self._transport_server
2538
new_test.transport_readonly_server = self._transport_readonly_server
2539
new_test.bzrdir_format = bzrdir_format
2540
new_test.workingtree_format = workingtree_format
2541
def make_new_test_id():
2542
new_id = "%s(%s)" % (test.id(), variation)
2543
return lambda: new_id
2544
new_test.id = make_new_test_id()
2547
def adapt(self, test):
2548
from bzrlib.tests import TestSuite
2549
result = TestSuite()
2550
for workingtree_format, bzrdir_format in self._formats:
2551
new_test = self._clone_test(
2554
workingtree_format, workingtree_format.__class__.__name__)
2555
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
