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
58
conflicts as _mod_conflicts,
77
from bzrlib.transport import get_transport
79
from bzrlib.workingtree_4 import WorkingTreeFormat4
82
from bzrlib import symbol_versioning
83
from bzrlib.decorators import needs_read_lock, needs_write_lock
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
85
from bzrlib.lockable_files import LockableFiles, TransportLock
86
from bzrlib.lockdir import LockDir
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
103
from bzrlib.progress import DummyProgress, ProgressPhase
104
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
105
from bzrlib.rio import RioReader, rio_file, Stanza
106
from bzrlib.symbol_versioning import (deprecated_passed,
109
DEPRECATED_PARAMETER,
116
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
117
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
@deprecated_function(zero_thirteen)
121
def gen_file_id(name):
122
"""Return new file id for the basename 'name'.
124
Use bzrlib.generate_ids.gen_file_id() instead
126
return generate_ids.gen_file_id(name)
129
@deprecated_function(zero_thirteen)
131
"""Return a new tree-root file id.
133
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
135
return generate_ids.gen_root_id()
138
class TreeEntry(object):
139
"""An entry that implements the minimum interface used by commands.
141
This needs further inspection, it may be better to have
142
InventoryEntries without ids - though that seems wrong. For now,
143
this is a parallel hierarchy to InventoryEntry, and needs to become
144
one of several things: decorates to that hierarchy, children of, or
146
Another note is that these objects are currently only used when there is
147
no InventoryEntry available - i.e. for unversioned objects.
148
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
151
def __eq__(self, other):
152
# yes, this us ugly, TODO: best practice __eq__ style.
153
return (isinstance(other, TreeEntry)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeDirectory(TreeEntry):
161
"""See TreeEntry. This is a directory in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeDirectory)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
171
class TreeFile(TreeEntry):
172
"""See TreeEntry. This is a regular file in a working tree."""
174
def __eq__(self, other):
175
return (isinstance(other, TreeFile)
176
and other.__class__ == self.__class__)
178
def kind_character(self):
182
class TreeLink(TreeEntry):
183
"""See TreeEntry. This is a symlink in a working tree."""
185
def __eq__(self, other):
186
return (isinstance(other, TreeLink)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
193
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
"""Working copy tree.
196
The inventory is held in the `Branch` working-inventory, and the
197
files are in a directory on disk.
199
It is possible for a `WorkingTree` to have a filename which is
200
not listed in the Inventory and vice versa.
203
def __init__(self, basedir='.',
204
branch=DEPRECATED_PARAMETER,
210
"""Construct a WorkingTree for basedir.
212
If the branch is not supplied, it is opened automatically.
213
If the branch is supplied, it must be the branch for this basedir.
214
(branch.base is not cross checked, because for remote branches that
215
would be meaningless).
217
self._format = _format
218
self.bzrdir = _bzrdir
220
# not created via open etc.
221
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
"Please use bzrdir.open_workingtree or WorkingTree.open().",
225
wt = WorkingTree.open(basedir)
226
self._branch = wt.branch
227
self.basedir = wt.basedir
228
self._control_files = wt._control_files
229
self._hashcache = wt._hashcache
230
self._set_inventory(wt._inventory, dirty=False)
231
self._format = wt._format
232
self.bzrdir = wt.bzrdir
233
assert isinstance(basedir, basestring), \
234
"base directory %r is not a string" % basedir
235
basedir = safe_unicode(basedir)
236
mutter("opening working tree %r", basedir)
237
if deprecated_passed(branch):
239
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
240
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
241
" WorkingTree.open().",
245
self._branch = branch
247
self._branch = self.bzrdir.open_branch()
248
self.basedir = realpath(basedir)
249
# if branch is at our basedir and is a format 6 or less
250
if isinstance(self._format, WorkingTreeFormat2):
251
# share control object
252
self._control_files = self.branch.control_files
254
# assume all other formats have their own control files.
255
assert isinstance(_control_files, LockableFiles), \
256
"_control_files must be a LockableFiles, not %r" \
258
self._control_files = _control_files
259
# update the whole cache up front and write to disk if anything changed;
260
# in the future we might want to do this more selectively
261
# two possible ways offer themselves : in self._unlock, write the cache
262
# if needed, or, when the cache sees a change, append it to the hash
263
# cache file, and have the parser take the most recent entry for a
265
wt_trans = self.bzrdir.get_workingtree_transport(None)
266
cache_filename = wt_trans.local_abspath('stat-cache')
267
self._hashcache = hashcache.HashCache(basedir, cache_filename,
268
self._control_files._file_mode)
271
# is this scan needed ? it makes things kinda slow.
278
if _inventory is None:
279
self._inventory_is_modified = False
280
self.read_working_inventory()
282
# the caller of __init__ has provided an inventory,
283
# we assume they know what they are doing - as its only
284
# the Format factory and creation methods that are
285
# permitted to do this.
286
self._set_inventory(_inventory, dirty=False)
289
fget=lambda self: self._branch,
290
doc="""The branch this WorkingTree is connected to.
292
This cannot be set - it is reflective of the actual disk structure
293
the working tree has been constructed from.
296
def break_lock(self):
297
"""Break a lock if one is present from another instance.
299
Uses the ui factory to ask for confirmation if the lock may be from
302
This will probe the repository for its lock as well.
304
self._control_files.break_lock()
305
self.branch.break_lock()
307
def requires_rich_root(self):
308
return self._format.requires_rich_root
310
def supports_tree_reference(self):
311
return getattr(self._format, 'supports_tree_reference', False)
313
def _set_inventory(self, inv, dirty):
314
"""Set the internal cached inventory.
316
:param inv: The inventory to set.
317
:param dirty: A boolean indicating whether the inventory is the same
318
logical inventory as whats on disk. If True the inventory is not
319
the same and should be written to disk or data will be lost, if
320
False then the inventory is the same as that on disk and any
321
serialisation would be unneeded overhead.
323
assert inv.root is not None
324
self._inventory = inv
325
self._inventory_is_modified = dirty
328
def open(path=None, _unsupported=False):
329
"""Open an existing working tree at path.
333
path = os.path.getcwdu()
334
control = bzrdir.BzrDir.open(path, _unsupported)
335
return control.open_workingtree(_unsupported)
338
def open_containing(path=None):
339
"""Open an existing working tree which has its root about path.
341
This probes for a working tree at path and searches upwards from there.
343
Basically we keep looking up until we find the control directory or
344
run into /. If there isn't one, raises NotBranchError.
345
TODO: give this a new exception.
346
If there is one, it is returned, along with the unused portion of path.
348
:return: The WorkingTree that contains 'path', and the rest of path
351
path = osutils.getcwd()
352
control, relpath = bzrdir.BzrDir.open_containing(path)
354
return control.open_workingtree(), relpath
357
def open_downlevel(path=None):
358
"""Open an unsupported working tree.
360
Only intended for advanced situations like upgrading part of a bzrdir.
362
return WorkingTree.open(path, _unsupported=True)
365
"""Iterate through file_ids for this tree.
367
file_ids are in a WorkingTree if they are in the working inventory
368
and the working file exists.
370
inv = self._inventory
371
for path, ie in inv.iter_entries():
372
if osutils.lexists(self.abspath(path)):
376
return "<%s of %s>" % (self.__class__.__name__,
377
getattr(self, 'basedir', None))
379
def abspath(self, filename):
380
return pathjoin(self.basedir, filename)
382
def basis_tree(self):
383
"""Return RevisionTree for the current last revision.
385
If the left most parent is a ghost then the returned tree will be an
386
empty tree - one obtained by calling repository.revision_tree(None).
389
revision_id = self.get_parent_ids()[0]
391
# no parents, return an empty revision tree.
392
# in the future this should return the tree for
393
# 'empty:' - the implicit root empty tree.
394
return self.branch.repository.revision_tree(None)
396
return self.revision_tree(revision_id)
397
except errors.NoSuchRevision:
399
# No cached copy available, retrieve from the repository.
400
# FIXME? RBC 20060403 should we cache the inventory locally
403
return self.branch.repository.revision_tree(revision_id)
404
except errors.RevisionNotPresent:
405
# the basis tree *may* be a ghost or a low level error may have
406
# occured. If the revision is present, its a problem, if its not
408
if self.branch.repository.has_revision(revision_id):
410
# the basis tree is a ghost so return an empty tree.
411
return self.branch.repository.revision_tree(None)
414
@deprecated_method(zero_eight)
415
def create(branch, directory):
416
"""Create a workingtree for branch at directory.
418
If existing_directory already exists it must have a .bzr directory.
419
If it does not exist, it will be created.
421
This returns a new WorkingTree object for the new checkout.
423
TODO FIXME RBC 20060124 when we have checkout formats in place this
424
should accept an optional revisionid to checkout [and reject this if
425
checking out into the same dir as a pre-checkout-aware branch format.]
427
XXX: When BzrDir is present, these should be created through that
430
warnings.warn('delete WorkingTree.create', stacklevel=3)
431
transport = get_transport(directory)
432
if branch.bzrdir.root_transport.base == transport.base:
434
return branch.bzrdir.create_workingtree()
435
# different directory,
436
# create a branch reference
437
# and now a working tree.
438
raise NotImplementedError
441
@deprecated_method(zero_eight)
442
def create_standalone(directory):
443
"""Create a checkout and a branch and a repo at directory.
445
Directory must exist and be empty.
447
please use BzrDir.create_standalone_workingtree
449
return bzrdir.BzrDir.create_standalone_workingtree(directory)
451
def relpath(self, path):
452
"""Return the local path portion from a given path.
454
The path may be absolute or relative. If its a relative path it is
455
interpreted relative to the python current working directory.
457
return osutils.relpath(self.basedir, path)
459
def has_filename(self, filename):
460
return osutils.lexists(self.abspath(filename))
462
def get_file(self, file_id):
463
file_id = osutils.safe_file_id(file_id)
464
return self.get_file_byname(self.id2path(file_id))
466
def get_file_text(self, file_id):
467
file_id = osutils.safe_file_id(file_id)
468
return self.get_file(file_id).read()
470
def get_file_byname(self, filename):
471
return file(self.abspath(filename), 'rb')
474
def annotate_iter(self, file_id):
475
"""See Tree.annotate_iter
477
This implementation will use the basis tree implementation if possible.
478
Lines not in the basis are attributed to CURRENT_REVISION
480
If there are pending merges, lines added by those merges will be
481
incorrectly attributed to CURRENT_REVISION (but after committing, the
482
attribution will be correct).
484
file_id = osutils.safe_file_id(file_id)
485
basis = self.basis_tree()
486
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
487
require_versioned=True).next()
488
changed_content, kind = changes[2], changes[6]
489
if not changed_content:
490
return basis.annotate_iter(file_id)
494
if kind[0] != 'file':
497
old_lines = list(basis.annotate_iter(file_id))
499
for tree in self.branch.repository.revision_trees(
500
self.get_parent_ids()[1:]):
501
if file_id not in tree:
503
old.append(list(tree.annotate_iter(file_id)))
504
return annotate.reannotate(old, self.get_file(file_id).readlines(),
507
def get_parent_ids(self):
508
"""See Tree.get_parent_ids.
510
This implementation reads the pending merges list and last_revision
511
value and uses that to decide what the parents list should be.
513
last_rev = self._last_revision()
519
merges_file = self._control_files.get('pending-merges')
520
except errors.NoSuchFile:
523
for l in merges_file.readlines():
524
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
525
parents.append(revision_id)
529
def get_root_id(self):
530
"""Return the id of this trees root"""
531
return self._inventory.root.file_id
533
def _get_store_filename(self, file_id):
534
## XXX: badly named; this is not in the store at all
535
file_id = osutils.safe_file_id(file_id)
536
return self.abspath(self.id2path(file_id))
539
def clone(self, to_bzrdir, revision_id=None, basis=None):
540
"""Duplicate this working tree into to_bzr, including all state.
542
Specifically modified files are kept as modified, but
543
ignored and unknown files are discarded.
545
If you want to make a new line of development, see bzrdir.sprout()
548
If not None, the cloned tree will have its last revision set to
549
revision, and and difference between the source trees last revision
550
and this one merged in.
553
If not None, a closer copy of a tree which may have some files in
554
common, and which file content should be preferentially copied from.
556
# assumes the target bzr dir format is compatible.
557
result = self._format.initialize(to_bzrdir)
558
self.copy_content_into(result, revision_id)
562
def copy_content_into(self, tree, revision_id=None):
563
"""Copy the current content and user files of this tree into tree."""
564
tree.set_root_id(self.get_root_id())
565
if revision_id is None:
566
merge.transform_tree(tree, self)
568
# TODO now merge from tree.last_revision to revision (to preserve
569
# user local changes)
570
merge.transform_tree(tree, self)
571
tree.set_parent_ids([revision_id])
573
def id2abspath(self, file_id):
574
file_id = osutils.safe_file_id(file_id)
575
return self.abspath(self.id2path(file_id))
577
def has_id(self, file_id):
578
# files that have been deleted are excluded
579
file_id = osutils.safe_file_id(file_id)
581
if not inv.has_id(file_id):
583
path = inv.id2path(file_id)
584
return osutils.lexists(self.abspath(path))
586
def has_or_had_id(self, file_id):
587
file_id = osutils.safe_file_id(file_id)
588
if file_id == self.inventory.root.file_id:
590
return self.inventory.has_id(file_id)
592
__contains__ = has_id
594
def get_file_size(self, file_id):
595
file_id = osutils.safe_file_id(file_id)
596
return os.path.getsize(self.id2abspath(file_id))
599
def get_file_sha1(self, file_id, path=None, stat_value=None):
600
file_id = osutils.safe_file_id(file_id)
602
path = self._inventory.id2path(file_id)
603
return self._hashcache.get_sha1(path, stat_value)
605
def get_file_mtime(self, file_id, path=None):
606
file_id = osutils.safe_file_id(file_id)
608
path = self._inventory.id2path(file_id)
609
return os.lstat(self.abspath(path)).st_mtime
611
if not supports_executable():
612
def is_executable(self, file_id, path=None):
613
file_id = osutils.safe_file_id(file_id)
614
return self._inventory[file_id].executable
616
def is_executable(self, file_id, path=None):
618
file_id = osutils.safe_file_id(file_id)
619
path = self.id2path(file_id)
620
mode = os.lstat(self.abspath(path)).st_mode
621
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
624
def _add(self, files, ids, kinds):
625
"""See MutableTree._add."""
626
# TODO: Re-adding a file that is removed in the working copy
627
# should probably put it back with the previous ID.
628
# the read and write working inventory should not occur in this
629
# function - they should be part of lock_write and unlock.
630
inv = self.read_working_inventory()
631
for f, file_id, kind in zip(files, ids, kinds):
632
assert kind is not None
634
inv.add_path(f, kind=kind)
636
file_id = osutils.safe_file_id(file_id)
637
inv.add_path(f, kind=kind, file_id=file_id)
638
self._write_inventory(inv)
640
@needs_tree_write_lock
641
def _gather_kinds(self, files, kinds):
642
"""See MutableTree._gather_kinds."""
643
for pos, f in enumerate(files):
644
if kinds[pos] is None:
645
fullpath = normpath(self.abspath(f))
647
kinds[pos] = file_kind(fullpath)
649
if e.errno == errno.ENOENT:
650
raise errors.NoSuchFile(fullpath)
653
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
654
"""Add revision_id as a parent.
656
This is equivalent to retrieving the current list of parent ids
657
and setting the list to its value plus revision_id.
659
:param revision_id: The revision id to add to the parent list. It may
660
be a ghost revision as long as its not the first parent to be added,
661
or the allow_leftmost_as_ghost parameter is set True.
662
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
664
parents = self.get_parent_ids() + [revision_id]
665
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
666
or allow_leftmost_as_ghost)
668
@needs_tree_write_lock
669
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
670
"""Add revision_id, tree tuple as a parent.
672
This is equivalent to retrieving the current list of parent trees
673
and setting the list to its value plus parent_tuple. See also
674
add_parent_tree_id - if you only have a parent id available it will be
675
simpler to use that api. If you have the parent already available, using
676
this api is preferred.
678
:param parent_tuple: The (revision id, tree) to add to the parent list.
679
If the revision_id is a ghost, pass None for the tree.
680
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
682
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
683
if len(parent_ids) > 1:
684
# the leftmost may have already been a ghost, preserve that if it
686
allow_leftmost_as_ghost = True
687
self.set_parent_ids(parent_ids,
688
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
690
@needs_tree_write_lock
691
def add_pending_merge(self, *revision_ids):
692
# TODO: Perhaps should check at this point that the
693
# history of the revision is actually present?
694
parents = self.get_parent_ids()
696
for rev_id in revision_ids:
697
if rev_id in parents:
699
parents.append(rev_id)
702
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
704
@deprecated_method(zero_eleven)
706
def pending_merges(self):
707
"""Return a list of pending merges.
709
These are revisions that have been merged into the working
710
directory but not yet committed.
712
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
713
instead - which is available on all tree objects.
715
return self.get_parent_ids()[1:]
717
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
718
"""Common ghost checking functionality from set_parent_*.
720
This checks that the left hand-parent exists if there are any
723
if len(revision_ids) > 0:
724
leftmost_id = revision_ids[0]
725
if (not allow_leftmost_as_ghost and not
726
self.branch.repository.has_revision(leftmost_id)):
727
raise errors.GhostRevisionUnusableHere(leftmost_id)
729
def _set_merges_from_parent_ids(self, parent_ids):
730
merges = parent_ids[1:]
731
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
733
@needs_tree_write_lock
734
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
735
"""Set the parent ids to revision_ids.
737
See also set_parent_trees. This api will try to retrieve the tree data
738
for each element of revision_ids from the trees repository. If you have
739
tree data already available, it is more efficient to use
740
set_parent_trees rather than set_parent_ids. set_parent_ids is however
741
an easier API to use.
743
:param revision_ids: The revision_ids to set as the parent ids of this
744
working tree. Any of these may be ghosts.
746
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
747
self._check_parents_for_ghosts(revision_ids,
748
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
750
if len(revision_ids) > 0:
751
self.set_last_revision(revision_ids[0])
753
self.set_last_revision(None)
755
self._set_merges_from_parent_ids(revision_ids)
757
@needs_tree_write_lock
758
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
759
"""See MutableTree.set_parent_trees."""
760
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
762
self._check_parents_for_ghosts(parent_ids,
763
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
765
if len(parent_ids) == 0:
766
leftmost_parent_id = None
767
leftmost_parent_tree = None
769
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
771
if self._change_last_revision(leftmost_parent_id):
772
if leftmost_parent_tree is None:
773
# If we don't have a tree, fall back to reading the
774
# parent tree from the repository.
775
self._cache_basis_inventory(leftmost_parent_id)
777
inv = leftmost_parent_tree.inventory
778
xml = self._create_basis_xml_from_inventory(
779
leftmost_parent_id, inv)
780
self._write_basis_inventory(xml)
781
self._set_merges_from_parent_ids(parent_ids)
783
@needs_tree_write_lock
784
def set_pending_merges(self, rev_list):
785
parents = self.get_parent_ids()
786
leftmost = parents[:1]
787
new_parents = leftmost + rev_list
788
self.set_parent_ids(new_parents)
790
@needs_tree_write_lock
791
def set_merge_modified(self, modified_hashes):
793
for file_id, hash in modified_hashes.iteritems():
794
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
795
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
797
@needs_tree_write_lock
798
def _put_rio(self, filename, stanzas, header):
799
my_file = rio_file(stanzas, header)
800
self._control_files.put(filename, my_file)
802
@needs_write_lock # because merge pulls data into the branch.
803
def merge_from_branch(self, branch, to_revision=None):
804
"""Merge from a branch into this working tree.
806
:param branch: The branch to merge from.
807
:param to_revision: If non-None, the merge will merge to to_revision,
808
but not beyond it. to_revision does not need to be in the history
809
of the branch when it is supplied. If None, to_revision defaults to
810
branch.last_revision().
812
from bzrlib.merge import Merger, Merge3Merger
813
pb = bzrlib.ui.ui_factory.nested_progress_bar()
815
merger = Merger(self.branch, this_tree=self, pb=pb)
816
merger.pp = ProgressPhase("Merge phase", 5, pb)
817
merger.pp.next_phase()
818
# check that there are no
820
merger.check_basis(check_clean=True, require_commits=False)
821
if to_revision is None:
822
to_revision = branch.last_revision()
824
to_revision = osutils.safe_revision_id(to_revision)
825
merger.other_rev_id = to_revision
826
if merger.other_rev_id is None:
827
raise error.NoCommits(branch)
828
self.branch.fetch(branch, last_revision=merger.other_rev_id)
829
merger.other_basis = merger.other_rev_id
830
merger.other_tree = self.branch.repository.revision_tree(
832
merger.other_branch = branch
833
merger.pp.next_phase()
835
if merger.base_rev_id == merger.other_rev_id:
836
raise errors.PointlessMerge
837
merger.backup_files = False
838
merger.merge_type = Merge3Merger
839
merger.set_interesting_files(None)
840
merger.show_base = False
841
merger.reprocess = False
842
conflicts = merger.do_merge()
849
def subsume(self, other_tree):
850
def add_children(inventory, entry):
851
for child_entry in entry.children.values():
852
inventory._byid[child_entry.file_id] = child_entry
853
if child_entry.kind == 'directory':
854
add_children(inventory, child_entry)
855
if other_tree.get_root_id() == self.get_root_id():
856
raise errors.BadSubsumeSource(self, other_tree,
857
'Trees have the same root')
859
other_tree_path = self.relpath(other_tree.basedir)
860
except errors.PathNotChild:
861
raise errors.BadSubsumeSource(self, other_tree,
862
'Tree is not contained by the other')
863
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
864
if new_root_parent is None:
865
raise errors.BadSubsumeSource(self, other_tree,
866
'Parent directory is not versioned.')
867
# We need to ensure that the result of a fetch will have a
868
# versionedfile for the other_tree root, and only fetching into
869
# RepositoryKnit2 guarantees that.
870
if not self.branch.repository.supports_rich_root():
871
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
872
other_tree.lock_tree_write()
874
for parent_id in other_tree.get_parent_ids():
875
self.branch.fetch(other_tree.branch, parent_id)
876
self.add_parent_tree_id(parent_id)
877
other_root = other_tree.inventory.root
878
other_root.parent_id = new_root_parent
879
other_root.name = osutils.basename(other_tree_path)
880
self.inventory.add(other_root)
881
add_children(self.inventory, other_root)
882
self._write_inventory(self.inventory)
885
other_tree.bzrdir.destroy_workingtree_metadata()
887
@needs_tree_write_lock
888
def extract(self, file_id, format=None):
889
"""Extract a subtree from this tree.
891
A new branch will be created, relative to the path for this tree.
894
segments = osutils.splitpath(path)
895
transport = self.branch.bzrdir.root_transport
896
for name in segments:
897
transport = transport.clone(name)
900
except errors.FileExists:
904
sub_path = self.id2path(file_id)
905
branch_transport = mkdirs(sub_path)
907
format = bzrdir.format_registry.make_bzrdir('experimental-knit2')
909
branch_transport.mkdir('.')
910
except errors.FileExists:
912
branch_bzrdir = format.initialize_on_transport(branch_transport)
914
repo = branch_bzrdir.find_repository()
915
except errors.NoRepositoryPresent:
916
repo = branch_bzrdir.create_repository()
917
assert repo.supports_rich_root()
919
if not repo.supports_rich_root():
920
raise errors.RootNotRich()
921
new_branch = branch_bzrdir.create_branch()
922
new_branch.pull(self.branch)
923
for parent_id in self.get_parent_ids():
924
new_branch.fetch(self.branch, parent_id)
925
tree_transport = self.bzrdir.root_transport.clone(sub_path)
926
if tree_transport.base != branch_transport.base:
927
tree_bzrdir = format.initialize_on_transport(tree_transport)
928
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
930
tree_bzrdir = branch_bzrdir
931
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
932
wt.set_parent_ids(self.get_parent_ids())
933
my_inv = self.inventory
934
child_inv = Inventory(root_id=None)
935
new_root = my_inv[file_id]
936
my_inv.remove_recursive_id(file_id)
937
new_root.parent_id = None
938
child_inv.add(new_root)
939
self._write_inventory(my_inv)
940
wt._write_inventory(child_inv)
943
def _serialize(self, inventory, out_file):
944
xml5.serializer_v5.write_inventory(self._inventory, out_file)
946
def _deserialize(selt, in_file):
947
return xml5.serializer_v5.read_inventory(in_file)
950
"""Write the in memory inventory to disk."""
951
# TODO: Maybe this should only write on dirty ?
952
if self._control_files._lock_mode != 'w':
953
raise errors.NotWriteLocked(self)
955
self._serialize(self._inventory, sio)
957
self._control_files.put('inventory', sio)
958
self._inventory_is_modified = False
960
def list_files(self, include_root=False):
961
"""Recursively list all files as (path, class, kind, id, entry).
963
Lists, but does not descend into unversioned directories.
965
This does not include files that have been deleted in this
968
Skips the control directory.
970
# list_files is an iterator, so @needs_read_lock doesn't work properly
971
# with it. So callers should be careful to always read_lock the tree.
972
if not self.is_locked():
973
raise errors.ObjectNotLocked(self)
976
if include_root is True:
977
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
978
# Convert these into local objects to save lookup times
979
pathjoin = osutils.pathjoin
980
file_kind = osutils.file_kind
982
# transport.base ends in a slash, we want the piece
983
# between the last two slashes
984
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
986
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
988
# directory file_id, relative path, absolute path, reverse sorted children
989
children = os.listdir(self.basedir)
991
# jam 20060527 The kernel sized tree seems equivalent whether we
992
# use a deque and popleft to keep them sorted, or if we use a plain
993
# list and just reverse() them.
994
children = collections.deque(children)
995
stack = [(inv.root.file_id, u'', self.basedir, children)]
997
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1000
f = children.popleft()
1001
## TODO: If we find a subdirectory with its own .bzr
1002
## directory, then that is a separate tree and we
1003
## should exclude it.
1005
# the bzrdir for this tree
1006
if transport_base_dir == f:
1009
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1010
# and 'f' doesn't begin with one, we can do a string op, rather
1011
# than the checks of pathjoin(), all relative paths will have an extra slash
1013
fp = from_dir_relpath + '/' + f
1016
fap = from_dir_abspath + '/' + f
1018
f_ie = inv.get_child(from_dir_id, f)
1021
elif self.is_ignored(fp[1:]):
1024
# we may not have found this file, because of a unicode issue
1025
f_norm, can_access = osutils.normalized_filename(f)
1026
if f == f_norm or not can_access:
1027
# No change, so treat this file normally
1030
# this file can be accessed by a normalized path
1031
# check again if it is versioned
1032
# these lines are repeated here for performance
1034
fp = from_dir_relpath + '/' + f
1035
fap = from_dir_abspath + '/' + f
1036
f_ie = inv.get_child(from_dir_id, f)
1039
elif self.is_ignored(fp[1:]):
1048
raise errors.BzrCheckError(
1049
"file %r entered as kind %r id %r, now of kind %r"
1050
% (fap, f_ie.kind, f_ie.file_id, fk))
1052
# make a last minute entry
1054
yield fp[1:], c, fk, f_ie.file_id, f_ie
1057
yield fp[1:], c, fk, None, fk_entries[fk]()
1059
yield fp[1:], c, fk, None, TreeEntry()
1062
if fk != 'directory':
1065
# But do this child first
1066
new_children = os.listdir(fap)
1068
new_children = collections.deque(new_children)
1069
stack.append((f_ie.file_id, fp, fap, new_children))
1070
# Break out of inner loop,
1071
# so that we start outer loop with child
1074
# if we finished all children, pop it off the stack
1077
@needs_tree_write_lock
1078
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1081
to_dir must exist in the inventory.
1083
If to_dir exists and is a directory, the files are moved into
1084
it, keeping their old names.
1086
Note that to_dir is only the last component of the new name;
1087
this doesn't change the directory.
1089
For each entry in from_paths the move mode will be determined
1092
The first mode moves the file in the filesystem and updates the
1093
inventory. The second mode only updates the inventory without
1094
touching the file on the filesystem. This is the new mode introduced
1097
move uses the second mode if 'after == True' and the target is not
1098
versioned but present in the working tree.
1100
move uses the second mode if 'after == False' and the source is
1101
versioned but no longer in the working tree, and the target is not
1102
versioned but present in the working tree.
1104
move uses the first mode if 'after == False' and the source is
1105
versioned and present in the working tree, and the target is not
1106
versioned and not present in the working tree.
1108
Everything else results in an error.
1110
This returns a list of (from_path, to_path) pairs for each
1111
entry that is moved.
1116
# check for deprecated use of signature
1118
to_dir = kwargs.get('to_name', None)
1120
raise TypeError('You must supply a target directory')
1122
symbol_versioning.warn('The parameter to_name was deprecated'
1123
' in version 0.13. Use to_dir instead',
1126
# check destination directory
1127
assert not isinstance(from_paths, basestring)
1128
inv = self.inventory
1129
to_abs = self.abspath(to_dir)
1130
if not isdir(to_abs):
1131
raise errors.BzrMoveFailedError('',to_dir,
1132
errors.NotADirectory(to_abs))
1133
if not self.has_filename(to_dir):
1134
raise errors.BzrMoveFailedError('',to_dir,
1135
errors.NotInWorkingDirectory(to_dir))
1136
to_dir_id = inv.path2id(to_dir)
1137
if to_dir_id is None:
1138
raise errors.BzrMoveFailedError('',to_dir,
1139
errors.NotVersionedError(path=str(to_dir)))
1141
to_dir_ie = inv[to_dir_id]
1142
if to_dir_ie.kind != 'directory':
1143
raise errors.BzrMoveFailedError('',to_dir,
1144
errors.NotADirectory(to_abs))
1146
# create rename entries and tuples
1147
for from_rel in from_paths:
1148
from_tail = splitpath(from_rel)[-1]
1149
from_id = inv.path2id(from_rel)
1151
raise errors.BzrMoveFailedError(from_rel,to_dir,
1152
errors.NotVersionedError(path=str(from_rel)))
1154
from_entry = inv[from_id]
1155
from_parent_id = from_entry.parent_id
1156
to_rel = pathjoin(to_dir, from_tail)
1157
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1159
from_tail=from_tail,
1160
from_parent_id=from_parent_id,
1161
to_rel=to_rel, to_tail=from_tail,
1162
to_parent_id=to_dir_id)
1163
rename_entries.append(rename_entry)
1164
rename_tuples.append((from_rel, to_rel))
1166
# determine which move mode to use. checks also for movability
1167
rename_entries = self._determine_mv_mode(rename_entries, after)
1169
original_modified = self._inventory_is_modified
1172
self._inventory_is_modified = True
1173
self._move(rename_entries)
1175
# restore the inventory on error
1176
self._inventory_is_modified = original_modified
1178
self._write_inventory(inv)
1179
return rename_tuples
1181
def _determine_mv_mode(self, rename_entries, after=False):
1182
"""Determines for each from-to pair if both inventory and working tree
1183
or only the inventory has to be changed.
1185
Also does basic plausability tests.
1187
inv = self.inventory
1189
for rename_entry in rename_entries:
1190
# store to local variables for easier reference
1191
from_rel = rename_entry.from_rel
1192
from_id = rename_entry.from_id
1193
to_rel = rename_entry.to_rel
1194
to_id = inv.path2id(to_rel)
1195
only_change_inv = False
1197
# check the inventory for source and destination
1199
raise errors.BzrMoveFailedError(from_rel,to_rel,
1200
errors.NotVersionedError(path=str(from_rel)))
1201
if to_id is not None:
1202
raise errors.BzrMoveFailedError(from_rel,to_rel,
1203
errors.AlreadyVersionedError(path=str(to_rel)))
1205
# try to determine the mode for rename (only change inv or change
1206
# inv and file system)
1208
if not self.has_filename(to_rel):
1209
raise errors.BzrMoveFailedError(from_id,to_rel,
1210
errors.NoSuchFile(path=str(to_rel),
1211
extra="New file has not been created yet"))
1212
only_change_inv = True
1213
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1214
only_change_inv = True
1215
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1216
only_change_inv = False
1218
# something is wrong, so lets determine what exactly
1219
if not self.has_filename(from_rel) and \
1220
not self.has_filename(to_rel):
1221
raise errors.BzrRenameFailedError(from_rel,to_rel,
1222
errors.PathsDoNotExist(paths=(str(from_rel),
1225
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1226
extra="(Use --after to update the Bazaar id)")
1227
rename_entry.only_change_inv = only_change_inv
1228
return rename_entries
1230
def _move(self, rename_entries):
1231
"""Moves a list of files.
1233
Depending on the value of the flag 'only_change_inv', the
1234
file will be moved on the file system or not.
1236
inv = self.inventory
1239
for entry in rename_entries:
1241
self._move_entry(entry)
1243
self._rollback_move(moved)
1247
def _rollback_move(self, moved):
1248
"""Try to rollback a previous move in case of an filesystem error."""
1249
inv = self.inventory
1252
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1253
entry.to_tail, entry.to_parent_id, entry.from_rel,
1254
entry.from_tail, entry.from_parent_id,
1255
entry.only_change_inv))
1256
except errors.BzrMoveFailedError, e:
1257
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1258
" The working tree is in an inconsistent state."
1259
" Please consider doing a 'bzr revert'."
1260
" Error message is: %s" % e)
1262
def _move_entry(self, entry):
1263
inv = self.inventory
1264
from_rel_abs = self.abspath(entry.from_rel)
1265
to_rel_abs = self.abspath(entry.to_rel)
1266
if from_rel_abs == to_rel_abs:
1267
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1268
"Source and target are identical.")
1270
if not entry.only_change_inv:
1272
osutils.rename(from_rel_abs, to_rel_abs)
1274
raise errors.BzrMoveFailedError(entry.from_rel,
1276
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1278
@needs_tree_write_lock
1279
def rename_one(self, from_rel, to_rel, after=False):
1282
This can change the directory or the filename or both.
1284
rename_one has several 'modes' to work. First, it can rename a physical
1285
file and change the file_id. That is the normal mode. Second, it can
1286
only change the file_id without touching any physical file. This is
1287
the new mode introduced in version 0.15.
1289
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1290
versioned but present in the working tree.
1292
rename_one uses the second mode if 'after == False' and 'from_rel' is
1293
versioned but no longer in the working tree, and 'to_rel' is not
1294
versioned but present in the working tree.
1296
rename_one uses the first mode if 'after == False' and 'from_rel' is
1297
versioned and present in the working tree, and 'to_rel' is not
1298
versioned and not present in the working tree.
1300
Everything else results in an error.
1302
inv = self.inventory
1305
# create rename entries and tuples
1306
from_tail = splitpath(from_rel)[-1]
1307
from_id = inv.path2id(from_rel)
1309
raise errors.BzrRenameFailedError(from_rel,to_rel,
1310
errors.NotVersionedError(path=str(from_rel)))
1311
from_entry = inv[from_id]
1312
from_parent_id = from_entry.parent_id
1313
to_dir, to_tail = os.path.split(to_rel)
1314
to_dir_id = inv.path2id(to_dir)
1315
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1317
from_tail=from_tail,
1318
from_parent_id=from_parent_id,
1319
to_rel=to_rel, to_tail=to_tail,
1320
to_parent_id=to_dir_id)
1321
rename_entries.append(rename_entry)
1323
# determine which move mode to use. checks also for movability
1324
rename_entries = self._determine_mv_mode(rename_entries, after)
1326
# check if the target changed directory and if the target directory is
1328
if to_dir_id is None:
1329
raise errors.BzrMoveFailedError(from_rel,to_rel,
1330
errors.NotVersionedError(path=str(to_dir)))
1332
# all checks done. now we can continue with our actual work
1333
mutter('rename_one:\n'
1338
' to_dir_id {%s}\n',
1339
from_id, from_rel, to_rel, to_dir, to_dir_id)
1341
self._move(rename_entries)
1342
self._write_inventory(inv)
1344
class _RenameEntry(object):
1345
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1346
to_rel, to_tail, to_parent_id, only_change_inv=False):
1347
self.from_rel = from_rel
1348
self.from_id = from_id
1349
self.from_tail = from_tail
1350
self.from_parent_id = from_parent_id
1351
self.to_rel = to_rel
1352
self.to_tail = to_tail
1353
self.to_parent_id = to_parent_id
1354
self.only_change_inv = only_change_inv
1358
"""Return all unknown files.
1360
These are files in the working directory that are not versioned or
1361
control files or ignored.
1363
# force the extras method to be fully executed before returning, to
1364
# prevent race conditions with the lock
1366
[subp for subp in self.extras() if not self.is_ignored(subp)])
1368
@needs_tree_write_lock
1369
def unversion(self, file_ids):
1370
"""Remove the file ids in file_ids from the current versioned set.
1372
When a file_id is unversioned, all of its children are automatically
1375
:param file_ids: The file ids to stop versioning.
1376
:raises: NoSuchId if any fileid is not currently versioned.
1378
for file_id in file_ids:
1379
file_id = osutils.safe_file_id(file_id)
1380
if self._inventory.has_id(file_id):
1381
self._inventory.remove_recursive_id(file_id)
1383
raise errors.NoSuchId(self, file_id)
1385
# in the future this should just set a dirty bit to wait for the
1386
# final unlock. However, until all methods of workingtree start
1387
# with the current in -memory inventory rather than triggering
1388
# a read, it is more complex - we need to teach read_inventory
1389
# to know when to read, and when to not read first... and possibly
1390
# to save first when the in memory one may be corrupted.
1391
# so for now, we just only write it if it is indeed dirty.
1393
self._write_inventory(self._inventory)
1395
@deprecated_method(zero_eight)
1396
def iter_conflicts(self):
1397
"""List all files in the tree that have text or content conflicts.
1398
DEPRECATED. Use conflicts instead."""
1399
return self._iter_conflicts()
1401
def _iter_conflicts(self):
1403
for info in self.list_files():
1405
stem = get_conflicted_stem(path)
1408
if stem not in conflicted:
1409
conflicted.add(stem)
1413
def pull(self, source, overwrite=False, stop_revision=None,
1414
change_reporter=None):
1415
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1418
pp = ProgressPhase("Pull phase", 2, top_pb)
1420
old_revision_info = self.branch.last_revision_info()
1421
basis_tree = self.basis_tree()
1422
count = self.branch.pull(source, overwrite, stop_revision)
1423
new_revision_info = self.branch.last_revision_info()
1424
if new_revision_info != old_revision_info:
1426
repository = self.branch.repository
1427
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1428
basis_tree.lock_read()
1430
new_basis_tree = self.branch.basis_tree()
1437
change_reporter=change_reporter)
1438
if (basis_tree.inventory.root is None and
1439
new_basis_tree.inventory.root is not None):
1440
self.set_root_id(new_basis_tree.inventory.root.file_id)
1444
# TODO - dedup parents list with things merged by pull ?
1445
# reuse the revisiontree we merged against to set the new
1447
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1448
# we have to pull the merge trees out again, because
1449
# merge_inner has set the ids. - this corner is not yet
1450
# layered well enough to prevent double handling.
1451
# XXX TODO: Fix the double handling: telling the tree about
1452
# the already known parent data is wasteful.
1453
merges = self.get_parent_ids()[1:]
1454
parent_trees.extend([
1455
(parent, repository.revision_tree(parent)) for
1457
self.set_parent_trees(parent_trees)
1464
def put_file_bytes_non_atomic(self, file_id, bytes):
1465
"""See MutableTree.put_file_bytes_non_atomic."""
1466
file_id = osutils.safe_file_id(file_id)
1467
stream = file(self.id2abspath(file_id), 'wb')
1472
# TODO: update the hashcache here ?
1475
"""Yield all unknown files in this WorkingTree.
1477
If there are any unknown directories then only the directory is
1478
returned, not all its children. But if there are unknown files
1479
under a versioned subdirectory, they are returned.
1481
Currently returned depth-first, sorted by name within directories.
1483
## TODO: Work from given directory downwards
1484
for path, dir_entry in self.inventory.directories():
1485
# mutter("search for unknowns in %r", path)
1486
dirabs = self.abspath(path)
1487
if not isdir(dirabs):
1488
# e.g. directory deleted
1492
for subf in os.listdir(dirabs):
1495
if subf not in dir_entry.children:
1496
subf_norm, can_access = osutils.normalized_filename(subf)
1497
if subf_norm != subf and can_access:
1498
if subf_norm not in dir_entry.children:
1499
fl.append(subf_norm)
1505
subp = pathjoin(path, subf)
1508
def ignored_files(self):
1509
"""Yield list of PATH, IGNORE_PATTERN"""
1510
for subp in self.extras():
1511
pat = self.is_ignored(subp)
1515
def get_ignore_list(self):
1516
"""Return list of ignore patterns.
1518
Cached in the Tree object after the first call.
1520
ignoreset = getattr(self, '_ignoreset', None)
1521
if ignoreset is not None:
1524
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1525
ignore_globs.update(ignores.get_runtime_ignores())
1526
ignore_globs.update(ignores.get_user_ignores())
1527
if self.has_filename(bzrlib.IGNORE_FILENAME):
1528
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1530
ignore_globs.update(ignores.parse_ignore_file(f))
1533
self._ignoreset = ignore_globs
1536
def _flush_ignore_list_cache(self):
1537
"""Resets the cached ignore list to force a cache rebuild."""
1538
self._ignoreset = None
1539
self._ignoreglobster = None
1541
def is_ignored(self, filename):
1542
r"""Check whether the filename matches an ignore pattern.
1544
Patterns containing '/' or '\' need to match the whole path;
1545
others match against only the last component.
1547
If the file is ignored, returns the pattern which caused it to
1548
be ignored, otherwise None. So this can simply be used as a
1549
boolean if desired."""
1550
if getattr(self, '_ignoreglobster', None) is None:
1551
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1552
return self._ignoreglobster.match(filename)
1554
def kind(self, file_id):
1555
return file_kind(self.id2abspath(file_id))
1557
def _comparison_data(self, entry, path):
1558
abspath = self.abspath(path)
1560
stat_value = os.lstat(abspath)
1562
if getattr(e, 'errno', None) == errno.ENOENT:
1569
mode = stat_value.st_mode
1570
kind = osutils.file_kind_from_stat_mode(mode)
1571
if not supports_executable():
1572
executable = entry.executable
1574
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1575
return kind, executable, stat_value
1577
def _file_size(self, entry, stat_value):
1578
return stat_value.st_size
1580
def last_revision(self):
1581
"""Return the last revision of the branch for this tree.
1583
This format tree does not support a separate marker for last-revision
1584
compared to the branch.
1586
See MutableTree.last_revision
1588
return self._last_revision()
1591
def _last_revision(self):
1592
"""helper for get_parent_ids."""
1593
return self.branch.last_revision()
1595
def is_locked(self):
1596
return self._control_files.is_locked()
1598
def lock_read(self):
1599
"""See Branch.lock_read, and WorkingTree.unlock."""
1600
self.branch.lock_read()
1602
return self._control_files.lock_read()
1604
self.branch.unlock()
1607
def lock_tree_write(self):
1608
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1609
self.branch.lock_read()
1611
return self._control_files.lock_write()
1613
self.branch.unlock()
1616
def lock_write(self):
1617
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1618
self.branch.lock_write()
1620
return self._control_files.lock_write()
1622
self.branch.unlock()
1625
def get_physical_lock_status(self):
1626
return self._control_files.get_physical_lock_status()
1628
def _basis_inventory_name(self):
1629
return 'basis-inventory-cache'
1631
@needs_tree_write_lock
1632
def set_last_revision(self, new_revision):
1633
"""Change the last revision in the working tree."""
1634
new_revision = osutils.safe_revision_id(new_revision)
1635
if self._change_last_revision(new_revision):
1636
self._cache_basis_inventory(new_revision)
1638
def _change_last_revision(self, new_revision):
1639
"""Template method part of set_last_revision to perform the change.
1641
This is used to allow WorkingTree3 instances to not affect branch
1642
when their last revision is set.
1644
if new_revision is None:
1645
self.branch.set_revision_history([])
1648
self.branch.generate_revision_history(new_revision)
1649
except errors.NoSuchRevision:
1650
# not present in the repo - dont try to set it deeper than the tip
1651
self.branch.set_revision_history([new_revision])
1654
def _write_basis_inventory(self, xml):
1655
"""Write the basis inventory XML to the basis-inventory file"""
1656
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1657
path = self._basis_inventory_name()
1659
self._control_files.put(path, sio)
1661
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1662
"""Create the text that will be saved in basis-inventory"""
1663
# TODO: jam 20070209 This should be redundant, as the revision_id
1664
# as all callers should have already converted the revision_id to
1666
inventory.revision_id = osutils.safe_revision_id(revision_id)
1667
return xml7.serializer_v7.write_inventory_to_string(inventory)
1669
def _cache_basis_inventory(self, new_revision):
1670
"""Cache new_revision as the basis inventory."""
1671
# TODO: this should allow the ready-to-use inventory to be passed in,
1672
# as commit already has that ready-to-use [while the format is the
1675
# this double handles the inventory - unpack and repack -
1676
# but is easier to understand. We can/should put a conditional
1677
# in here based on whether the inventory is in the latest format
1678
# - perhaps we should repack all inventories on a repository
1680
# the fast path is to copy the raw xml from the repository. If the
1681
# xml contains 'revision_id="', then we assume the right
1682
# revision_id is set. We must check for this full string, because a
1683
# root node id can legitimately look like 'revision_id' but cannot
1685
xml = self.branch.repository.get_inventory_xml(new_revision)
1686
firstline = xml.split('\n', 1)[0]
1687
if (not 'revision_id="' in firstline or
1688
'format="7"' not in firstline):
1689
inv = self.branch.repository.deserialise_inventory(
1691
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1692
self._write_basis_inventory(xml)
1693
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1696
def read_basis_inventory(self):
1697
"""Read the cached basis inventory."""
1698
path = self._basis_inventory_name()
1699
return self._control_files.get(path).read()
1702
def read_working_inventory(self):
1703
"""Read the working inventory.
1705
:raises errors.InventoryModified: read_working_inventory will fail
1706
when the current in memory inventory has been modified.
1708
# conceptually this should be an implementation detail of the tree.
1709
# XXX: Deprecate this.
1710
# ElementTree does its own conversion from UTF-8, so open in
1712
if self._inventory_is_modified:
1713
raise errors.InventoryModified(self)
1714
result = self._deserialize(self._control_files.get('inventory'))
1715
self._set_inventory(result, dirty=False)
1718
@needs_tree_write_lock
1719
def remove(self, files, verbose=False, to_file=None):
1720
"""Remove nominated files from the working inventory..
1722
This does not remove their text. This does not run on XXX on what? RBC
1724
TODO: Refuse to remove modified files unless --force is given?
1726
TODO: Do something useful with directories.
1728
TODO: Should this remove the text or not? Tough call; not
1729
removing may be useful and the user can just use use rm, and
1730
is the opposite of add. Removing it is consistent with most
1731
other tools. Maybe an option.
1733
## TODO: Normalize names
1734
## TODO: Remove nested loops; better scalability
1735
if isinstance(files, basestring):
1738
inv = self.inventory
1740
# do this before any modifications
1742
fid = inv.path2id(f)
1744
note("%s is not versioned."%f)
1747
# having remove it, it must be either ignored or unknown
1748
if self.is_ignored(f):
1752
textui.show_status(new_status, inv[fid].kind, f,
1756
self._write_inventory(inv)
1758
@needs_tree_write_lock
1759
def revert(self, filenames, old_tree=None, backups=True,
1760
pb=DummyProgress(), report_changes=False):
1761
from bzrlib.conflicts import resolve
1762
if old_tree is None:
1763
old_tree = self.basis_tree()
1764
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1766
if not len(filenames):
1767
self.set_parent_ids(self.get_parent_ids()[:1])
1770
resolve(self, filenames, ignore_misses=True)
1773
def revision_tree(self, revision_id):
1774
"""See Tree.revision_tree.
1776
WorkingTree can supply revision_trees for the basis revision only
1777
because there is only one cached inventory in the bzr directory.
1779
if revision_id == self.last_revision():
1781
xml = self.read_basis_inventory()
1782
except errors.NoSuchFile:
1786
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1787
# dont use the repository revision_tree api because we want
1788
# to supply the inventory.
1789
if inv.revision_id == revision_id:
1790
return revisiontree.RevisionTree(self.branch.repository,
1792
except errors.BadInventoryFormat:
1794
# raise if there was no inventory, or if we read the wrong inventory.
1795
raise errors.NoSuchRevisionInTree(self, revision_id)
1797
# XXX: This method should be deprecated in favour of taking in a proper
1798
# new Inventory object.
1799
@needs_tree_write_lock
1800
def set_inventory(self, new_inventory_list):
1801
from bzrlib.inventory import (Inventory,
1806
inv = Inventory(self.get_root_id())
1807
for path, file_id, parent, kind in new_inventory_list:
1808
name = os.path.basename(path)
1811
# fixme, there should be a factory function inv,add_??
1812
if kind == 'directory':
1813
inv.add(InventoryDirectory(file_id, name, parent))
1814
elif kind == 'file':
1815
inv.add(InventoryFile(file_id, name, parent))
1816
elif kind == 'symlink':
1817
inv.add(InventoryLink(file_id, name, parent))
1819
raise errors.BzrError("unknown kind %r" % kind)
1820
self._write_inventory(inv)
1822
@needs_tree_write_lock
1823
def set_root_id(self, file_id):
1824
"""Set the root id for this tree."""
1827
symbol_versioning.warn(symbol_versioning.zero_twelve
1828
% 'WorkingTree.set_root_id with fileid=None',
1833
file_id = osutils.safe_file_id(file_id)
1834
self._set_root_id(file_id)
1836
def _set_root_id(self, file_id):
1837
"""Set the root id for this tree, in a format specific manner.
1839
:param file_id: The file id to assign to the root. It must not be
1840
present in the current inventory or an error will occur. It must
1841
not be None, but rather a valid file id.
1843
inv = self._inventory
1844
orig_root_id = inv.root.file_id
1845
# TODO: it might be nice to exit early if there was nothing
1846
# to do, saving us from trigger a sync on unlock.
1847
self._inventory_is_modified = True
1848
# we preserve the root inventory entry object, but
1849
# unlinkit from the byid index
1850
del inv._byid[inv.root.file_id]
1851
inv.root.file_id = file_id
1852
# and link it into the index with the new changed id.
1853
inv._byid[inv.root.file_id] = inv.root
1854
# and finally update all children to reference the new id.
1855
# XXX: this should be safe to just look at the root.children
1856
# list, not the WHOLE INVENTORY.
1859
if entry.parent_id == orig_root_id:
1860
entry.parent_id = inv.root.file_id
1863
"""See Branch.unlock.
1865
WorkingTree locking just uses the Branch locking facilities.
1866
This is current because all working trees have an embedded branch
1867
within them. IF in the future, we were to make branch data shareable
1868
between multiple working trees, i.e. via shared storage, then we
1869
would probably want to lock both the local tree, and the branch.
1871
raise NotImplementedError(self.unlock)
1874
"""Update a working tree along its branch.
1876
This will update the branch if its bound too, which means we have
1877
multiple trees involved:
1879
- The new basis tree of the master.
1880
- The old basis tree of the branch.
1881
- The old basis tree of the working tree.
1882
- The current working tree state.
1884
Pathologically, all three may be different, and non-ancestors of each
1885
other. Conceptually we want to:
1887
- Preserve the wt.basis->wt.state changes
1888
- Transform the wt.basis to the new master basis.
1889
- Apply a merge of the old branch basis to get any 'local' changes from
1891
- Restore the wt.basis->wt.state changes.
1893
There isn't a single operation at the moment to do that, so we:
1894
- Merge current state -> basis tree of the master w.r.t. the old tree
1896
- Do a 'normal' merge of the old branch basis if it is relevant.
1898
if self.branch.get_master_branch() is not None:
1900
update_branch = True
1902
self.lock_tree_write()
1903
update_branch = False
1906
old_tip = self.branch.update()
1909
return self._update_tree(old_tip)
1913
@needs_tree_write_lock
1914
def _update_tree(self, old_tip=None):
1915
"""Update a tree to the master branch.
1917
:param old_tip: if supplied, the previous tip revision the branch,
1918
before it was changed to the master branch's tip.
1920
# here if old_tip is not None, it is the old tip of the branch before
1921
# it was updated from the master branch. This should become a pending
1922
# merge in the working tree to preserve the user existing work. we
1923
# cant set that until we update the working trees last revision to be
1924
# one from the new branch, because it will just get absorbed by the
1925
# parent de-duplication logic.
1927
# We MUST save it even if an error occurs, because otherwise the users
1928
# local work is unreferenced and will appear to have been lost.
1932
last_rev = self.get_parent_ids()[0]
1935
if last_rev != self.branch.last_revision():
1936
# merge tree state up to new branch tip.
1937
basis = self.basis_tree()
1940
to_tree = self.branch.basis_tree()
1941
if basis.inventory.root is None:
1942
self.set_root_id(to_tree.inventory.root.file_id)
1944
result += merge.merge_inner(
1951
# TODO - dedup parents list with things merged by pull ?
1952
# reuse the tree we've updated to to set the basis:
1953
parent_trees = [(self.branch.last_revision(), to_tree)]
1954
merges = self.get_parent_ids()[1:]
1955
# Ideally we ask the tree for the trees here, that way the working
1956
# tree can decide whether to give us teh entire tree or give us a
1957
# lazy initialised tree. dirstate for instance will have the trees
1958
# in ram already, whereas a last-revision + basis-inventory tree
1959
# will not, but also does not need them when setting parents.
1960
for parent in merges:
1961
parent_trees.append(
1962
(parent, self.branch.repository.revision_tree(parent)))
1963
if old_tip is not None:
1964
parent_trees.append(
1965
(old_tip, self.branch.repository.revision_tree(old_tip)))
1966
self.set_parent_trees(parent_trees)
1967
last_rev = parent_trees[0][0]
1969
# the working tree had the same last-revision as the master
1970
# branch did. We may still have pivot local work from the local
1971
# branch into old_tip:
1972
if old_tip is not None:
1973
self.add_parent_tree_id(old_tip)
1974
if old_tip and old_tip != last_rev:
1975
# our last revision was not the prior branch last revision
1976
# and we have converted that last revision to a pending merge.
1977
# base is somewhere between the branch tip now
1978
# and the now pending merge
1980
# Since we just modified the working tree and inventory, flush out
1981
# the current state, before we modify it again.
1982
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
1983
# requires it only because TreeTransform directly munges the
1984
# inventory and calls tree._write_inventory(). Ultimately we
1985
# should be able to remove this extra flush.
1987
from bzrlib.revision import common_ancestor
1989
base_rev_id = common_ancestor(self.branch.last_revision(),
1991
self.branch.repository)
1992
except errors.NoCommonAncestor:
1994
base_tree = self.branch.repository.revision_tree(base_rev_id)
1995
other_tree = self.branch.repository.revision_tree(old_tip)
1996
result += merge.merge_inner(
2003
def _write_hashcache_if_dirty(self):
2004
"""Write out the hashcache if it is dirty."""
2005
if self._hashcache.needs_write:
2007
self._hashcache.write()
2009
if e.errno not in (errno.EPERM, errno.EACCES):
2011
# TODO: jam 20061219 Should this be a warning? A single line
2012
# warning might be sufficient to let the user know what
2014
mutter('Could not write hashcache for %s\nError: %s',
2015
self._hashcache.cache_file_name(), e)
2017
@needs_tree_write_lock
2018
def _write_inventory(self, inv):
2019
"""Write inventory as the current inventory."""
2020
self._set_inventory(inv, dirty=True)
2023
def set_conflicts(self, arg):
2024
raise errors.UnsupportedOperation(self.set_conflicts, self)
2026
def add_conflicts(self, arg):
2027
raise errors.UnsupportedOperation(self.add_conflicts, self)
2030
def conflicts(self):
2031
conflicts = _mod_conflicts.ConflictList()
2032
for conflicted in self._iter_conflicts():
2035
if file_kind(self.abspath(conflicted)) != "file":
2037
except errors.NoSuchFile:
2040
for suffix in ('.THIS', '.OTHER'):
2042
kind = file_kind(self.abspath(conflicted+suffix))
2045
except errors.NoSuchFile:
2049
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2050
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2052
file_id=self.path2id(conflicted)))
2055
def walkdirs(self, prefix=""):
2056
"""Walk the directories of this tree.
2058
This API returns a generator, which is only valid during the current
2059
tree transaction - within a single lock_read or lock_write duration.
2061
If the tree is not locked, it may cause an error to be raised, depending
2062
on the tree implementation.
2064
disk_top = self.abspath(prefix)
2065
if disk_top.endswith('/'):
2066
disk_top = disk_top[:-1]
2067
top_strip_len = len(disk_top) + 1
2068
inventory_iterator = self._walkdirs(prefix)
2069
disk_iterator = osutils.walkdirs(disk_top, prefix)
2071
current_disk = disk_iterator.next()
2072
disk_finished = False
2074
if e.errno != errno.ENOENT:
2077
disk_finished = True
2079
current_inv = inventory_iterator.next()
2080
inv_finished = False
2081
except StopIteration:
2084
while not inv_finished or not disk_finished:
2085
if not disk_finished:
2086
# strip out .bzr dirs
2087
if current_disk[0][1][top_strip_len:] == '':
2088
# osutils.walkdirs can be made nicer -
2089
# yield the path-from-prefix rather than the pathjoined
2091
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2092
if current_disk[1][bzrdir_loc][0] == '.bzr':
2093
# we dont yield the contents of, or, .bzr itself.
2094
del current_disk[1][bzrdir_loc]
2096
# everything is unknown
2099
# everything is missing
2102
direction = cmp(current_inv[0][0], current_disk[0][0])
2104
# disk is before inventory - unknown
2105
dirblock = [(relpath, basename, kind, stat, None, None) for
2106
relpath, basename, kind, stat, top_path in current_disk[1]]
2107
yield (current_disk[0][0], None), dirblock
2109
current_disk = disk_iterator.next()
2110
except StopIteration:
2111
disk_finished = True
2113
# inventory is before disk - missing.
2114
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2115
for relpath, basename, dkind, stat, fileid, kind in
2117
yield (current_inv[0][0], current_inv[0][1]), dirblock
2119
current_inv = inventory_iterator.next()
2120
except StopIteration:
2123
# versioned present directory
2124
# merge the inventory and disk data together
2126
for relpath, subiterator in itertools.groupby(sorted(
2127
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2128
path_elements = list(subiterator)
2129
if len(path_elements) == 2:
2130
inv_row, disk_row = path_elements
2131
# versioned, present file
2132
dirblock.append((inv_row[0],
2133
inv_row[1], disk_row[2],
2134
disk_row[3], inv_row[4],
2136
elif len(path_elements[0]) == 5:
2138
dirblock.append((path_elements[0][0],
2139
path_elements[0][1], path_elements[0][2],
2140
path_elements[0][3], None, None))
2141
elif len(path_elements[0]) == 6:
2142
# versioned, absent file.
2143
dirblock.append((path_elements[0][0],
2144
path_elements[0][1], 'unknown', None,
2145
path_elements[0][4], path_elements[0][5]))
2147
raise NotImplementedError('unreachable code')
2148
yield current_inv[0], dirblock
2150
current_inv = inventory_iterator.next()
2151
except StopIteration:
2154
current_disk = disk_iterator.next()
2155
except StopIteration:
2156
disk_finished = True
2158
def _walkdirs(self, prefix=""):
2159
_directory = 'directory'
2160
# get the root in the inventory
2161
inv = self.inventory
2162
top_id = inv.path2id(prefix)
2166
pending = [(prefix, '', _directory, None, top_id, None)]
2169
currentdir = pending.pop()
2170
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2171
top_id = currentdir[4]
2173
relroot = currentdir[0] + '/'
2176
# FIXME: stash the node in pending
2178
for name, child in entry.sorted_children():
2179
dirblock.append((relroot + name, name, child.kind, None,
2180
child.file_id, child.kind
2182
yield (currentdir[0], entry.file_id), dirblock
2183
# push the user specified dirs from dirblock
2184
for dir in reversed(dirblock):
2185
if dir[2] == _directory:
2189
class WorkingTree2(WorkingTree):
2190
"""This is the Format 2 working tree.
2192
This was the first weave based working tree.
2193
- uses os locks for locking.
2194
- uses the branch last-revision.
2197
def lock_tree_write(self):
2198
"""See WorkingTree.lock_tree_write().
2200
In Format2 WorkingTrees we have a single lock for the branch and tree
2201
so lock_tree_write() degrades to lock_write().
2203
self.branch.lock_write()
2205
return self._control_files.lock_write()
2207
self.branch.unlock()
2211
# we share control files:
2212
if self._control_files._lock_count == 3:
2213
# _inventory_is_modified is always False during a read lock.
2214
if self._inventory_is_modified:
2216
self._write_hashcache_if_dirty()
2218
# reverse order of locking.
2220
return self._control_files.unlock()
2222
self.branch.unlock()
2225
class WorkingTree3(WorkingTree):
2226
"""This is the Format 3 working tree.
2228
This differs from the base WorkingTree by:
2229
- having its own file lock
2230
- having its own last-revision property.
2232
This is new in bzr 0.8
2236
def _last_revision(self):
2237
"""See Mutable.last_revision."""
2239
return osutils.safe_revision_id(
2240
self._control_files.get('last-revision').read())
2241
except errors.NoSuchFile:
2244
def _change_last_revision(self, revision_id):
2245
"""See WorkingTree._change_last_revision."""
2246
if revision_id is None or revision_id == NULL_REVISION:
2248
self._control_files._transport.delete('last-revision')
2249
except errors.NoSuchFile:
2253
self._control_files.put_bytes('last-revision', revision_id)
2256
@needs_tree_write_lock
2257
def set_conflicts(self, conflicts):
2258
self._put_rio('conflicts', conflicts.to_stanzas(),
2261
@needs_tree_write_lock
2262
def add_conflicts(self, new_conflicts):
2263
conflict_set = set(self.conflicts())
2264
conflict_set.update(set(list(new_conflicts)))
2265
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2266
key=_mod_conflicts.Conflict.sort_key)))
2269
def conflicts(self):
2271
confile = self._control_files.get('conflicts')
2272
except errors.NoSuchFile:
2273
return _mod_conflicts.ConflictList()
2275
if confile.next() != CONFLICT_HEADER_1 + '\n':
2276
raise errors.ConflictFormatError()
2277
except StopIteration:
2278
raise errors.ConflictFormatError()
2279
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2282
if self._control_files._lock_count == 1:
2283
# _inventory_is_modified is always False during a read lock.
2284
if self._inventory_is_modified:
2286
self._write_hashcache_if_dirty()
2287
# reverse order of locking.
2289
return self._control_files.unlock()
2291
self.branch.unlock()
2294
class WorkingTreeAB1(WorkingTree3):
2296
def _serialize(self, inventory, out_file):
2297
xml7.serializer_v7.write_inventory(self._inventory, out_file)
2299
def _deserialize(selt, in_file):
2300
return xml7.serializer_v7.read_inventory(in_file)
2302
def _comparison_data(self, entry, path):
2303
kind, executable, stat_value = \
2304
WorkingTree3._comparison_data(self, entry, path)
2305
if kind == 'directory' and entry.kind == 'tree-reference':
2306
kind = 'tree-reference'
2307
return kind, executable, stat_value
2309
def kind(self, file_id):
2310
kind = WorkingTree3.kind(self, file_id)
2311
if kind == 'directory':
2312
entry = self.inventory[file_id]
2313
if entry.kind == 'tree-reference':
2314
kind = 'tree-reference'
2317
def add_reference(self, sub_tree):
2318
return self._add_reference(sub_tree)
2320
def get_nested_tree(self, entry, path=None):
2322
path = self.id2path(entry.file_id)
2323
return WorkingTree.open(self.abspath(path))
2325
def get_reference_revision(self, entry, path=None):
2326
return self.get_nested_tree(entry, path).last_revision()
2329
def get_conflicted_stem(path):
2330
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2331
if path.endswith(suffix):
2332
return path[:-len(suffix)]
2335
@deprecated_function(zero_eight)
2336
def is_control_file(filename):
2337
"""See WorkingTree.is_control_filename(filename)."""
2338
## FIXME: better check
2339
filename = normpath(filename)
2340
while filename != '':
2341
head, tail = os.path.split(filename)
2342
## mutter('check %r for control file' % ((head, tail),))
2345
if filename == head:
2351
class WorkingTreeFormat(object):
2352
"""An encapsulation of the initialization and open routines for a format.
2354
Formats provide three things:
2355
* An initialization routine,
2359
Formats are placed in an dict by their format string for reference
2360
during workingtree opening. Its not required that these be instances, they
2361
can be classes themselves with class methods - it simply depends on
2362
whether state is needed for a given format or not.
2364
Once a format is deprecated, just deprecate the initialize and open
2365
methods on the format class. Do not deprecate the object, as the
2366
object will be created every time regardless.
2369
_default_format = None
2370
"""The default format used for new trees."""
2373
"""The known formats."""
2375
requires_rich_root = False
2378
def find_format(klass, a_bzrdir):
2379
"""Return the format for the working tree object in a_bzrdir."""
2381
transport = a_bzrdir.get_workingtree_transport(None)
2382
format_string = transport.get("format").read()
2383
return klass._formats[format_string]
2384
except errors.NoSuchFile:
2385
raise errors.NoWorkingTree(base=transport.base)
2387
raise errors.UnknownFormatError(format=format_string)
2389
def __eq__(self, other):
2390
return self.__class__ is other.__class__
2392
def __ne__(self, other):
2393
return not (self == other)
2396
def get_default_format(klass):
2397
"""Return the current default format."""
2398
return klass._default_format
2400
def get_format_string(self):
2401
"""Return the ASCII format string that identifies this format."""
2402
raise NotImplementedError(self.get_format_string)
2404
def get_format_description(self):
2405
"""Return the short description for this format."""
2406
raise NotImplementedError(self.get_format_description)
2408
def is_supported(self):
2409
"""Is this format supported?
2411
Supported formats can be initialized and opened.
2412
Unsupported formats may not support initialization or committing or
2413
some other features depending on the reason for not being supported.
2418
def register_format(klass, format):
2419
klass._formats[format.get_format_string()] = format
2422
def set_default_format(klass, format):
2423
klass._default_format = format
2426
def unregister_format(klass, format):
2427
assert klass._formats[format.get_format_string()] is format
2428
del klass._formats[format.get_format_string()]
2432
class WorkingTreeFormat2(WorkingTreeFormat):
2433
"""The second working tree format.
2435
This format modified the hash cache from the format 1 hash cache.
2438
def get_format_description(self):
2439
"""See WorkingTreeFormat.get_format_description()."""
2440
return "Working tree format 2"
2442
def stub_initialize_remote(self, control_files):
2443
"""As a special workaround create critical control files for a remote working tree
2445
This ensures that it can later be updated and dealt with locally,
2446
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2447
no working tree. (See bug #43064).
2451
xml5.serializer_v5.write_inventory(inv, sio)
2453
control_files.put('inventory', sio)
2455
control_files.put_bytes('pending-merges', '')
2458
def initialize(self, a_bzrdir, revision_id=None):
2459
"""See WorkingTreeFormat.initialize()."""
2460
if not isinstance(a_bzrdir.transport, LocalTransport):
2461
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2462
branch = a_bzrdir.open_branch()
2463
if revision_id is not None:
2464
revision_id = osutils.safe_revision_id(revision_id)
2467
revision_history = branch.revision_history()
2469
position = revision_history.index(revision_id)
2471
raise errors.NoSuchRevision(branch, revision_id)
2472
branch.set_revision_history(revision_history[:position + 1])
2475
revision = branch.last_revision()
2477
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2483
basis_tree = branch.repository.revision_tree(revision)
2484
if basis_tree.inventory.root is not None:
2485
wt.set_root_id(basis_tree.inventory.root.file_id)
2486
# set the parent list and cache the basis tree.
2487
wt.set_parent_trees([(revision, basis_tree)])
2488
transform.build_tree(basis_tree, wt)
2492
super(WorkingTreeFormat2, self).__init__()
2493
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2495
def open(self, a_bzrdir, _found=False):
2496
"""Return the WorkingTree object for a_bzrdir
2498
_found is a private parameter, do not use it. It is used to indicate
2499
if format probing has already been done.
2502
# we are being called directly and must probe.
2503
raise NotImplementedError
2504
if not isinstance(a_bzrdir.transport, LocalTransport):
2505
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2506
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2512
class WorkingTreeFormat3(WorkingTreeFormat):
2513
"""The second working tree format updated to record a format marker.
2516
- exists within a metadir controlling .bzr
2517
- includes an explicit version marker for the workingtree control
2518
files, separate from the BzrDir format
2519
- modifies the hash cache format
2521
- uses a LockDir to guard access for writes.
2524
def get_format_string(self):
2525
"""See WorkingTreeFormat.get_format_string()."""
2526
return "Bazaar-NG Working Tree format 3"
2528
def get_format_description(self):
2529
"""See WorkingTreeFormat.get_format_description()."""
2530
return "Working tree format 3"
2532
_lock_file_name = 'lock'
2533
_lock_class = LockDir
2535
_tree_class = WorkingTree3
2537
def __get_matchingbzrdir(self):
2538
return bzrdir.BzrDirMetaFormat1()
2540
_matchingbzrdir = property(__get_matchingbzrdir)
2542
def _open_control_files(self, a_bzrdir):
2543
transport = a_bzrdir.get_workingtree_transport(None)
2544
return LockableFiles(transport, self._lock_file_name,
2547
def initialize(self, a_bzrdir, revision_id=None):
2548
"""See WorkingTreeFormat.initialize().
2550
revision_id allows creating a working tree at a different
2551
revision than the branch is at.
2553
if not isinstance(a_bzrdir.transport, LocalTransport):
2554
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2555
transport = a_bzrdir.get_workingtree_transport(self)
2556
control_files = self._open_control_files(a_bzrdir)
2557
control_files.create_lock()
2558
control_files.lock_write()
2559
control_files.put_utf8('format', self.get_format_string())
2560
branch = a_bzrdir.open_branch()
2561
if revision_id is None:
2562
revision_id = branch.last_revision()
2564
revision_id = osutils.safe_revision_id(revision_id)
2565
# WorkingTree3 can handle an inventory which has a unique root id.
2566
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2567
# those trees. And because there isn't a format bump inbetween, we
2568
# are maintaining compatibility with older clients.
2569
# inv = Inventory(root_id=gen_root_id())
2570
inv = self._initial_inventory()
2571
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2577
_control_files=control_files)
2578
wt.lock_tree_write()
2580
basis_tree = branch.repository.revision_tree(revision_id)
2581
# only set an explicit root id if there is one to set.
2582
if basis_tree.inventory.root is not None:
2583
wt.set_root_id(basis_tree.inventory.root.file_id)
2584
if revision_id == NULL_REVISION:
2585
wt.set_parent_trees([])
2587
wt.set_parent_trees([(revision_id, basis_tree)])
2588
transform.build_tree(basis_tree, wt)
2590
# Unlock in this order so that the unlock-triggers-flush in
2591
# WorkingTree is given a chance to fire.
2592
control_files.unlock()
2596
def _initial_inventory(self):
2600
super(WorkingTreeFormat3, self).__init__()
2602
def open(self, a_bzrdir, _found=False):
2603
"""Return the WorkingTree object for a_bzrdir
2605
_found is a private parameter, do not use it. It is used to indicate
2606
if format probing has already been done.
2609
# we are being called directly and must probe.
2610
raise NotImplementedError
2611
if not isinstance(a_bzrdir.transport, LocalTransport):
2612
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2613
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2615
def _open(self, a_bzrdir, control_files):
2616
"""Open the tree itself.
2618
:param a_bzrdir: the dir for the tree.
2619
:param control_files: the control files for the tree.
2621
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2625
_control_files=control_files)
2628
return self.get_format_string()
2631
class WorkingTreeFormatAB1(WorkingTreeFormat3):
2632
"""Working tree format that supports unique roots and nested trees"""
2634
_tree_class = WorkingTreeAB1
2636
requires_rich_root = True
2638
supports_tree_reference = True
2641
WorkingTreeFormat3.__init__(self)
2643
def __get_matchingbzrdir(self):
2644
return bzrdir.format_registry.make_bzrdir('experimental-knit3')
2646
_matchingbzrdir = property(__get_matchingbzrdir)
2648
def get_format_string(self):
2649
"""See WorkingTreeFormat.get_format_string()."""
2650
return "Bazaar-NG Working Tree format AB1"
2652
def get_format_description(self):
2653
"""See WorkingTreeFormat.get_format_description()."""
2654
return "Working tree format 4"
2656
def _initial_inventory(self):
2657
return Inventory(root_id=generate_ids.gen_root_id())
2659
# formats which have no format string are not discoverable
2660
# and not independently creatable, so are not registered.
2661
__default_format = WorkingTreeFormat3()
2662
WorkingTreeFormat.register_format(__default_format)
2663
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2664
WorkingTreeFormat.register_format(WorkingTreeFormatAB1())
2665
WorkingTreeFormat.set_default_format(__default_format)
2666
# formats which have no format string are not discoverable
2667
# and not independently creatable, so are not registered.
2668
_legacy_formats = [WorkingTreeFormat2(),
2672
class WorkingTreeTestProviderAdapter(object):
2673
"""A tool to generate a suite testing multiple workingtree formats at once.
2675
This is done by copying the test once for each transport and injecting
2676
the transport_server, transport_readonly_server, and workingtree_format
2677
classes into each copy. Each copy is also given a new id() to make it
2681
def __init__(self, transport_server, transport_readonly_server, formats):
2682
self._transport_server = transport_server
2683
self._transport_readonly_server = transport_readonly_server
2684
self._formats = formats
2686
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2687
"""Clone test for adaption."""
2688
new_test = deepcopy(test)
2689
new_test.transport_server = self._transport_server
2690
new_test.transport_readonly_server = self._transport_readonly_server
2691
new_test.bzrdir_format = bzrdir_format
2692
new_test.workingtree_format = workingtree_format
2693
def make_new_test_id():
2694
new_id = "%s(%s)" % (test.id(), variation)
2695
return lambda: new_id
2696
new_test.id = make_new_test_id()
2699
def adapt(self, test):
2700
from bzrlib.tests import TestSuite
2701
result = TestSuite()
2702
for workingtree_format, bzrdir_format in self._formats:
2703
new_test = self._clone_test(
2706
workingtree_format, workingtree_format.__class__.__name__)
2707
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
