1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
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, [file_id]).next()
487
changed_content, kind = changes[2], changes[6]
488
if not changed_content:
489
return basis.annotate_iter(file_id)
493
if kind[0] != 'file':
496
old_lines = list(basis.annotate_iter(file_id))
498
for tree in self.branch.repository.revision_trees(
499
self.get_parent_ids()[1:]):
500
if file_id not in tree:
502
old.append(list(tree.annotate_iter(file_id)))
503
return annotate.reannotate(old, self.get_file(file_id).readlines(),
506
def get_parent_ids(self):
507
"""See Tree.get_parent_ids.
509
This implementation reads the pending merges list and last_revision
510
value and uses that to decide what the parents list should be.
512
last_rev = self._last_revision()
518
merges_file = self._control_files.get('pending-merges')
519
except errors.NoSuchFile:
522
for l in merges_file.readlines():
523
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
524
parents.append(revision_id)
528
def get_root_id(self):
529
"""Return the id of this trees root"""
530
return self._inventory.root.file_id
532
def _get_store_filename(self, file_id):
533
## XXX: badly named; this is not in the store at all
534
file_id = osutils.safe_file_id(file_id)
535
return self.abspath(self.id2path(file_id))
538
def clone(self, to_bzrdir, revision_id=None, basis=None):
539
"""Duplicate this working tree into to_bzr, including all state.
541
Specifically modified files are kept as modified, but
542
ignored and unknown files are discarded.
544
If you want to make a new line of development, see bzrdir.sprout()
547
If not None, the cloned tree will have its last revision set to
548
revision, and and difference between the source trees last revision
549
and this one merged in.
552
If not None, a closer copy of a tree which may have some files in
553
common, and which file content should be preferentially copied from.
555
# assumes the target bzr dir format is compatible.
556
result = self._format.initialize(to_bzrdir)
557
self.copy_content_into(result, revision_id)
561
def copy_content_into(self, tree, revision_id=None):
562
"""Copy the current content and user files of this tree into tree."""
563
tree.set_root_id(self.get_root_id())
564
if revision_id is None:
565
merge.transform_tree(tree, self)
567
# TODO now merge from tree.last_revision to revision (to preserve
568
# user local changes)
569
merge.transform_tree(tree, self)
570
tree.set_parent_ids([revision_id])
572
def id2abspath(self, file_id):
573
file_id = osutils.safe_file_id(file_id)
574
return self.abspath(self.id2path(file_id))
576
def has_id(self, file_id):
577
# files that have been deleted are excluded
578
file_id = osutils.safe_file_id(file_id)
580
if not inv.has_id(file_id):
582
path = inv.id2path(file_id)
583
return osutils.lexists(self.abspath(path))
585
def has_or_had_id(self, file_id):
586
file_id = osutils.safe_file_id(file_id)
587
if file_id == self.inventory.root.file_id:
589
return self.inventory.has_id(file_id)
591
__contains__ = has_id
593
def get_file_size(self, file_id):
594
file_id = osutils.safe_file_id(file_id)
595
return os.path.getsize(self.id2abspath(file_id))
598
def get_file_sha1(self, file_id, path=None, stat_value=None):
599
file_id = osutils.safe_file_id(file_id)
601
path = self._inventory.id2path(file_id)
602
return self._hashcache.get_sha1(path, stat_value)
604
def get_file_mtime(self, file_id, path=None):
605
file_id = osutils.safe_file_id(file_id)
607
path = self._inventory.id2path(file_id)
608
return os.lstat(self.abspath(path)).st_mtime
610
if not supports_executable():
611
def is_executable(self, file_id, path=None):
612
file_id = osutils.safe_file_id(file_id)
613
return self._inventory[file_id].executable
615
def is_executable(self, file_id, path=None):
617
file_id = osutils.safe_file_id(file_id)
618
path = self.id2path(file_id)
619
mode = os.lstat(self.abspath(path)).st_mode
620
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
623
def _add(self, files, ids, kinds):
624
"""See MutableTree._add."""
625
# TODO: Re-adding a file that is removed in the working copy
626
# should probably put it back with the previous ID.
627
# the read and write working inventory should not occur in this
628
# function - they should be part of lock_write and unlock.
629
inv = self.read_working_inventory()
630
for f, file_id, kind in zip(files, ids, kinds):
631
assert kind is not None
633
inv.add_path(f, kind=kind)
635
file_id = osutils.safe_file_id(file_id)
636
inv.add_path(f, kind=kind, file_id=file_id)
637
self._write_inventory(inv)
639
@needs_tree_write_lock
640
def _gather_kinds(self, files, kinds):
641
"""See MutableTree._gather_kinds."""
642
for pos, f in enumerate(files):
643
if kinds[pos] is None:
644
fullpath = normpath(self.abspath(f))
646
kinds[pos] = file_kind(fullpath)
648
if e.errno == errno.ENOENT:
649
raise errors.NoSuchFile(fullpath)
652
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
653
"""Add revision_id as a parent.
655
This is equivalent to retrieving the current list of parent ids
656
and setting the list to its value plus revision_id.
658
:param revision_id: The revision id to add to the parent list. It may
659
be a ghost revision as long as its not the first parent to be added,
660
or the allow_leftmost_as_ghost parameter is set True.
661
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
663
parents = self.get_parent_ids() + [revision_id]
664
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
665
or allow_leftmost_as_ghost)
667
@needs_tree_write_lock
668
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
669
"""Add revision_id, tree tuple as a parent.
671
This is equivalent to retrieving the current list of parent trees
672
and setting the list to its value plus parent_tuple. See also
673
add_parent_tree_id - if you only have a parent id available it will be
674
simpler to use that api. If you have the parent already available, using
675
this api is preferred.
677
:param parent_tuple: The (revision id, tree) to add to the parent list.
678
If the revision_id is a ghost, pass None for the tree.
679
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
681
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
682
if len(parent_ids) > 1:
683
# the leftmost may have already been a ghost, preserve that if it
685
allow_leftmost_as_ghost = True
686
self.set_parent_ids(parent_ids,
687
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
689
@needs_tree_write_lock
690
def add_pending_merge(self, *revision_ids):
691
# TODO: Perhaps should check at this point that the
692
# history of the revision is actually present?
693
parents = self.get_parent_ids()
695
for rev_id in revision_ids:
696
if rev_id in parents:
698
parents.append(rev_id)
701
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
703
@deprecated_method(zero_eleven)
705
def pending_merges(self):
706
"""Return a list of pending merges.
708
These are revisions that have been merged into the working
709
directory but not yet committed.
711
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
712
instead - which is available on all tree objects.
714
return self.get_parent_ids()[1:]
716
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
717
"""Common ghost checking functionality from set_parent_*.
719
This checks that the left hand-parent exists if there are any
722
if len(revision_ids) > 0:
723
leftmost_id = revision_ids[0]
724
if (not allow_leftmost_as_ghost and not
725
self.branch.repository.has_revision(leftmost_id)):
726
raise errors.GhostRevisionUnusableHere(leftmost_id)
728
def _set_merges_from_parent_ids(self, parent_ids):
729
merges = parent_ids[1:]
730
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
732
@needs_tree_write_lock
733
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
734
"""Set the parent ids to revision_ids.
736
See also set_parent_trees. This api will try to retrieve the tree data
737
for each element of revision_ids from the trees repository. If you have
738
tree data already available, it is more efficient to use
739
set_parent_trees rather than set_parent_ids. set_parent_ids is however
740
an easier API to use.
742
:param revision_ids: The revision_ids to set as the parent ids of this
743
working tree. Any of these may be ghosts.
745
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
746
self._check_parents_for_ghosts(revision_ids,
747
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
749
if len(revision_ids) > 0:
750
self.set_last_revision(revision_ids[0])
752
self.set_last_revision(None)
754
self._set_merges_from_parent_ids(revision_ids)
756
@needs_tree_write_lock
757
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
758
"""See MutableTree.set_parent_trees."""
759
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
761
self._check_parents_for_ghosts(parent_ids,
762
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
764
if len(parent_ids) == 0:
765
leftmost_parent_id = None
766
leftmost_parent_tree = None
768
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
770
if self._change_last_revision(leftmost_parent_id):
771
if leftmost_parent_tree is None:
772
# If we don't have a tree, fall back to reading the
773
# parent tree from the repository.
774
self._cache_basis_inventory(leftmost_parent_id)
776
inv = leftmost_parent_tree.inventory
777
xml = self._create_basis_xml_from_inventory(
778
leftmost_parent_id, inv)
779
self._write_basis_inventory(xml)
780
self._set_merges_from_parent_ids(parent_ids)
782
@needs_tree_write_lock
783
def set_pending_merges(self, rev_list):
784
parents = self.get_parent_ids()
785
leftmost = parents[:1]
786
new_parents = leftmost + rev_list
787
self.set_parent_ids(new_parents)
789
@needs_tree_write_lock
790
def set_merge_modified(self, modified_hashes):
792
for file_id, hash in modified_hashes.iteritems():
793
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
794
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
796
@needs_tree_write_lock
797
def _put_rio(self, filename, stanzas, header):
798
my_file = rio_file(stanzas, header)
799
self._control_files.put(filename, my_file)
801
@needs_write_lock # because merge pulls data into the branch.
802
def merge_from_branch(self, branch, to_revision=None):
803
"""Merge from a branch into this working tree.
805
:param branch: The branch to merge from.
806
:param to_revision: If non-None, the merge will merge to to_revision,
807
but not beyond it. to_revision does not need to be in the history
808
of the branch when it is supplied. If None, to_revision defaults to
809
branch.last_revision().
811
from bzrlib.merge import Merger, Merge3Merger
812
pb = bzrlib.ui.ui_factory.nested_progress_bar()
814
merger = Merger(self.branch, this_tree=self, pb=pb)
815
merger.pp = ProgressPhase("Merge phase", 5, pb)
816
merger.pp.next_phase()
817
# check that there are no
819
merger.check_basis(check_clean=True, require_commits=False)
820
if to_revision is None:
821
to_revision = branch.last_revision()
823
to_revision = osutils.safe_revision_id(to_revision)
824
merger.other_rev_id = to_revision
825
if merger.other_rev_id is None:
826
raise error.NoCommits(branch)
827
self.branch.fetch(branch, last_revision=merger.other_rev_id)
828
merger.other_basis = merger.other_rev_id
829
merger.other_tree = self.branch.repository.revision_tree(
831
merger.other_branch = branch
832
merger.pp.next_phase()
834
if merger.base_rev_id == merger.other_rev_id:
835
raise errors.PointlessMerge
836
merger.backup_files = False
837
merger.merge_type = Merge3Merger
838
merger.set_interesting_files(None)
839
merger.show_base = False
840
merger.reprocess = False
841
conflicts = merger.do_merge()
848
def subsume(self, other_tree):
849
def add_children(inventory, entry):
850
for child_entry in entry.children.values():
851
inventory._byid[child_entry.file_id] = child_entry
852
if child_entry.kind == 'directory':
853
add_children(inventory, child_entry)
854
if other_tree.get_root_id() == self.get_root_id():
855
raise errors.BadSubsumeSource(self, other_tree,
856
'Trees have the same root')
858
other_tree_path = self.relpath(other_tree.basedir)
859
except errors.PathNotChild:
860
raise errors.BadSubsumeSource(self, other_tree,
861
'Tree is not contained by the other')
862
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
863
if new_root_parent is None:
864
raise errors.BadSubsumeSource(self, other_tree,
865
'Parent directory is not versioned.')
866
# We need to ensure that the result of a fetch will have a
867
# versionedfile for the other_tree root, and only fetching into
868
# RepositoryKnit2 guarantees that.
869
if not self.branch.repository.supports_rich_root():
870
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
871
other_tree.lock_tree_write()
873
for parent_id in other_tree.get_parent_ids():
874
self.branch.fetch(other_tree.branch, parent_id)
875
self.add_parent_tree_id(parent_id)
876
other_root = other_tree.inventory.root
877
other_root.parent_id = new_root_parent
878
other_root.name = osutils.basename(other_tree_path)
879
self.inventory.add(other_root)
880
add_children(self.inventory, other_root)
881
self._write_inventory(self.inventory)
884
other_tree.bzrdir.destroy_workingtree_metadata()
886
@needs_tree_write_lock
887
def extract(self, file_id, format=None):
888
"""Extract a subtree from this tree.
890
A new branch will be created, relative to the path for this tree.
893
segments = osutils.splitpath(path)
894
transport = self.branch.bzrdir.root_transport
895
for name in segments:
896
transport = transport.clone(name)
899
except errors.FileExists:
903
sub_path = self.id2path(file_id)
904
branch_transport = mkdirs(sub_path)
906
format = bzrdir.format_registry.make_bzrdir('experimental-knit2')
908
branch_transport.mkdir('.')
909
except errors.FileExists:
911
branch_bzrdir = format.initialize_on_transport(branch_transport)
913
repo = branch_bzrdir.find_repository()
914
except errors.NoRepositoryPresent:
915
repo = branch_bzrdir.create_repository()
916
assert repo.supports_rich_root()
918
if not repo.supports_rich_root():
919
raise errors.RootNotRich()
920
new_branch = branch_bzrdir.create_branch()
921
new_branch.pull(self.branch)
922
for parent_id in self.get_parent_ids():
923
new_branch.fetch(self.branch, parent_id)
924
tree_transport = self.bzrdir.root_transport.clone(sub_path)
925
if tree_transport.base != branch_transport.base:
926
tree_bzrdir = format.initialize_on_transport(tree_transport)
927
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
929
tree_bzrdir = branch_bzrdir
930
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
931
wt.set_parent_ids(self.get_parent_ids())
932
my_inv = self.inventory
933
child_inv = Inventory(root_id=None)
934
new_root = my_inv[file_id]
935
my_inv.remove_recursive_id(file_id)
936
new_root.parent_id = None
937
child_inv.add(new_root)
938
self._write_inventory(my_inv)
939
wt._write_inventory(child_inv)
943
def merge_modified(self):
945
hashfile = self._control_files.get('merge-hashes')
946
except errors.NoSuchFile:
950
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
951
raise errors.MergeModifiedFormatError()
952
except StopIteration:
953
raise errors.MergeModifiedFormatError()
954
for s in RioReader(hashfile):
955
file_id = s.get("file_id")
956
if file_id not in self.inventory:
959
if hash == self.get_file_sha1(file_id):
960
merge_hashes[file_id] = hash
964
def mkdir(self, path, file_id=None):
965
"""See MutableTree.mkdir()."""
967
file_id = generate_ids.gen_file_id(os.path.basename(path))
968
os.mkdir(self.abspath(path))
969
self.add(path, file_id, 'directory')
972
def get_symlink_target(self, file_id):
973
return os.readlink(self.id2abspath(file_id))
975
def file_class(self, filename):
976
if self.path2id(filename):
978
elif self.is_ignored(filename):
984
"""Write the in memory inventory to disk."""
985
# TODO: Maybe this should only write on dirty ?
986
if self._control_files._lock_mode != 'w':
987
raise errors.NotWriteLocked(self)
989
self._serialize(self._inventory, sio)
991
self._control_files.put('inventory', sio)
992
self._inventory_is_modified = False
994
def _serialize(self, inventory, out_file):
995
xml5.serializer_v5.write_inventory(self._inventory, out_file)
997
def _deserialize(selt, in_file):
998
return xml5.serializer_v5.read_inventory(in_file)
1000
def list_files(self, include_root=False):
1001
"""Recursively list all files as (path, class, kind, id, entry).
1003
Lists, but does not descend into unversioned directories.
1005
This does not include files that have been deleted in this
1008
Skips the control directory.
1010
# list_files is an iterator, so @needs_read_lock doesn't work properly
1011
# with it. So callers should be careful to always read_lock the tree.
1012
if not self.is_locked():
1013
raise errors.ObjectNotLocked(self)
1015
inv = self.inventory
1016
if include_root is True:
1017
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1018
# Convert these into local objects to save lookup times
1019
pathjoin = osutils.pathjoin
1020
file_kind = osutils.file_kind
1022
# transport.base ends in a slash, we want the piece
1023
# between the last two slashes
1024
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1026
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1028
# directory file_id, relative path, absolute path, reverse sorted children
1029
children = os.listdir(self.basedir)
1031
# jam 20060527 The kernel sized tree seems equivalent whether we
1032
# use a deque and popleft to keep them sorted, or if we use a plain
1033
# list and just reverse() them.
1034
children = collections.deque(children)
1035
stack = [(inv.root.file_id, u'', self.basedir, children)]
1037
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1040
f = children.popleft()
1041
## TODO: If we find a subdirectory with its own .bzr
1042
## directory, then that is a separate tree and we
1043
## should exclude it.
1045
# the bzrdir for this tree
1046
if transport_base_dir == f:
1049
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1050
# and 'f' doesn't begin with one, we can do a string op, rather
1051
# than the checks of pathjoin(), all relative paths will have an extra slash
1053
fp = from_dir_relpath + '/' + f
1056
fap = from_dir_abspath + '/' + f
1058
f_ie = inv.get_child(from_dir_id, f)
1061
elif self.is_ignored(fp[1:]):
1064
# we may not have found this file, because of a unicode issue
1065
f_norm, can_access = osutils.normalized_filename(f)
1066
if f == f_norm or not can_access:
1067
# No change, so treat this file normally
1070
# this file can be accessed by a normalized path
1071
# check again if it is versioned
1072
# these lines are repeated here for performance
1074
fp = from_dir_relpath + '/' + f
1075
fap = from_dir_abspath + '/' + f
1076
f_ie = inv.get_child(from_dir_id, f)
1079
elif self.is_ignored(fp[1:]):
1088
raise errors.BzrCheckError(
1089
"file %r entered as kind %r id %r, now of kind %r"
1090
% (fap, f_ie.kind, f_ie.file_id, fk))
1092
# make a last minute entry
1094
yield fp[1:], c, fk, f_ie.file_id, f_ie
1097
yield fp[1:], c, fk, None, fk_entries[fk]()
1099
yield fp[1:], c, fk, None, TreeEntry()
1102
if fk != 'directory':
1105
# But do this child first
1106
new_children = os.listdir(fap)
1108
new_children = collections.deque(new_children)
1109
stack.append((f_ie.file_id, fp, fap, new_children))
1110
# Break out of inner loop,
1111
# so that we start outer loop with child
1114
# if we finished all children, pop it off the stack
1117
@needs_tree_write_lock
1118
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1121
to_dir must exist in the inventory.
1123
If to_dir exists and is a directory, the files are moved into
1124
it, keeping their old names.
1126
Note that to_dir is only the last component of the new name;
1127
this doesn't change the directory.
1129
For each entry in from_paths the move mode will be determined
1132
The first mode moves the file in the filesystem and updates the
1133
inventory. The second mode only updates the inventory without
1134
touching the file on the filesystem. This is the new mode introduced
1137
move uses the second mode if 'after == True' and the target is not
1138
versioned but present in the working tree.
1140
move uses the second mode if 'after == False' and the source is
1141
versioned but no longer in the working tree, and the target is not
1142
versioned but present in the working tree.
1144
move uses the first mode if 'after == False' and the source is
1145
versioned and present in the working tree, and the target is not
1146
versioned and not present in the working tree.
1148
Everything else results in an error.
1150
This returns a list of (from_path, to_path) pairs for each
1151
entry that is moved.
1156
# check for deprecated use of signature
1158
to_dir = kwargs.get('to_name', None)
1160
raise TypeError('You must supply a target directory')
1162
symbol_versioning.warn('The parameter to_name was deprecated'
1163
' in version 0.13. Use to_dir instead',
1166
# check destination directory
1167
assert not isinstance(from_paths, basestring)
1168
inv = self.inventory
1169
to_abs = self.abspath(to_dir)
1170
if not isdir(to_abs):
1171
raise errors.BzrMoveFailedError('',to_dir,
1172
errors.NotADirectory(to_abs))
1173
if not self.has_filename(to_dir):
1174
raise errors.BzrMoveFailedError('',to_dir,
1175
errors.NotInWorkingDirectory(to_dir))
1176
to_dir_id = inv.path2id(to_dir)
1177
if to_dir_id is None:
1178
raise errors.BzrMoveFailedError('',to_dir,
1179
errors.NotVersionedError(path=str(to_dir)))
1181
to_dir_ie = inv[to_dir_id]
1182
if to_dir_ie.kind != 'directory':
1183
raise errors.BzrMoveFailedError('',to_dir,
1184
errors.NotADirectory(to_abs))
1186
# create rename entries and tuples
1187
for from_rel in from_paths:
1188
from_tail = splitpath(from_rel)[-1]
1189
from_id = inv.path2id(from_rel)
1191
raise errors.BzrMoveFailedError(from_rel,to_dir,
1192
errors.NotVersionedError(path=str(from_rel)))
1194
from_entry = inv[from_id]
1195
from_parent_id = from_entry.parent_id
1196
to_rel = pathjoin(to_dir, from_tail)
1197
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1199
from_tail=from_tail,
1200
from_parent_id=from_parent_id,
1201
to_rel=to_rel, to_tail=from_tail,
1202
to_parent_id=to_dir_id)
1203
rename_entries.append(rename_entry)
1204
rename_tuples.append((from_rel, to_rel))
1206
# determine which move mode to use. checks also for movability
1207
rename_entries = self._determine_mv_mode(rename_entries, after)
1209
original_modified = self._inventory_is_modified
1212
self._inventory_is_modified = True
1213
self._move(rename_entries)
1215
# restore the inventory on error
1216
self._inventory_is_modified = original_modified
1218
self._write_inventory(inv)
1219
return rename_tuples
1221
def _determine_mv_mode(self, rename_entries, after=False):
1222
"""Determines for each from-to pair if both inventory and working tree
1223
or only the inventory has to be changed.
1225
Also does basic plausability tests.
1227
inv = self.inventory
1229
for rename_entry in rename_entries:
1230
# store to local variables for easier reference
1231
from_rel = rename_entry.from_rel
1232
from_id = rename_entry.from_id
1233
to_rel = rename_entry.to_rel
1234
to_id = inv.path2id(to_rel)
1235
only_change_inv = False
1237
# check the inventory for source and destination
1239
raise errors.BzrMoveFailedError(from_rel,to_rel,
1240
errors.NotVersionedError(path=str(from_rel)))
1241
if to_id is not None:
1242
raise errors.BzrMoveFailedError(from_rel,to_rel,
1243
errors.AlreadyVersionedError(path=str(to_rel)))
1245
# try to determine the mode for rename (only change inv or change
1246
# inv and file system)
1248
if not self.has_filename(to_rel):
1249
raise errors.BzrMoveFailedError(from_id,to_rel,
1250
errors.NoSuchFile(path=str(to_rel),
1251
extra="New file has not been created yet"))
1252
only_change_inv = True
1253
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1254
only_change_inv = True
1255
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1256
only_change_inv = False
1258
# something is wrong, so lets determine what exactly
1259
if not self.has_filename(from_rel) and \
1260
not self.has_filename(to_rel):
1261
raise errors.BzrRenameFailedError(from_rel,to_rel,
1262
errors.PathsDoNotExist(paths=(str(from_rel),
1265
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1266
extra="(Use --after to update the Bazaar id)")
1267
rename_entry.only_change_inv = only_change_inv
1268
return rename_entries
1270
def _move(self, rename_entries):
1271
"""Moves a list of files.
1273
Depending on the value of the flag 'only_change_inv', the
1274
file will be moved on the file system or not.
1276
inv = self.inventory
1279
for entry in rename_entries:
1281
self._move_entry(entry)
1283
self._rollback_move(moved)
1287
def _rollback_move(self, moved):
1288
"""Try to rollback a previous move in case of an filesystem error."""
1289
inv = self.inventory
1292
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1293
entry.to_tail, entry.to_parent_id, entry.from_rel,
1294
entry.from_tail, entry.from_parent_id,
1295
entry.only_change_inv))
1296
except errors.BzrMoveFailedError, e:
1297
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1298
" The working tree is in an inconsistent state."
1299
" Please consider doing a 'bzr revert'."
1300
" Error message is: %s" % e)
1302
def _move_entry(self, entry):
1303
inv = self.inventory
1304
from_rel_abs = self.abspath(entry.from_rel)
1305
to_rel_abs = self.abspath(entry.to_rel)
1306
if from_rel_abs == to_rel_abs:
1307
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1308
"Source and target are identical.")
1310
if not entry.only_change_inv:
1312
osutils.rename(from_rel_abs, to_rel_abs)
1314
raise errors.BzrMoveFailedError(entry.from_rel,
1316
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1318
@needs_tree_write_lock
1319
def rename_one(self, from_rel, to_rel, after=False):
1322
This can change the directory or the filename or both.
1324
rename_one has several 'modes' to work. First, it can rename a physical
1325
file and change the file_id. That is the normal mode. Second, it can
1326
only change the file_id without touching any physical file. This is
1327
the new mode introduced in version 0.15.
1329
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1330
versioned but present in the working tree.
1332
rename_one uses the second mode if 'after == False' and 'from_rel' is
1333
versioned but no longer in the working tree, and 'to_rel' is not
1334
versioned but present in the working tree.
1336
rename_one uses the first mode if 'after == False' and 'from_rel' is
1337
versioned and present in the working tree, and 'to_rel' is not
1338
versioned and not present in the working tree.
1340
Everything else results in an error.
1342
inv = self.inventory
1345
# create rename entries and tuples
1346
from_tail = splitpath(from_rel)[-1]
1347
from_id = inv.path2id(from_rel)
1349
raise errors.BzrRenameFailedError(from_rel,to_rel,
1350
errors.NotVersionedError(path=str(from_rel)))
1351
from_entry = inv[from_id]
1352
from_parent_id = from_entry.parent_id
1353
to_dir, to_tail = os.path.split(to_rel)
1354
to_dir_id = inv.path2id(to_dir)
1355
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1357
from_tail=from_tail,
1358
from_parent_id=from_parent_id,
1359
to_rel=to_rel, to_tail=to_tail,
1360
to_parent_id=to_dir_id)
1361
rename_entries.append(rename_entry)
1363
# determine which move mode to use. checks also for movability
1364
rename_entries = self._determine_mv_mode(rename_entries, after)
1366
# check if the target changed directory and if the target directory is
1368
if to_dir_id is None:
1369
raise errors.BzrMoveFailedError(from_rel,to_rel,
1370
errors.NotVersionedError(path=str(to_dir)))
1372
# all checks done. now we can continue with our actual work
1373
mutter('rename_one:\n'
1378
' to_dir_id {%s}\n',
1379
from_id, from_rel, to_rel, to_dir, to_dir_id)
1381
self._move(rename_entries)
1382
self._write_inventory(inv)
1384
class _RenameEntry(object):
1385
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1386
to_rel, to_tail, to_parent_id, only_change_inv=False):
1387
self.from_rel = from_rel
1388
self.from_id = from_id
1389
self.from_tail = from_tail
1390
self.from_parent_id = from_parent_id
1391
self.to_rel = to_rel
1392
self.to_tail = to_tail
1393
self.to_parent_id = to_parent_id
1394
self.only_change_inv = only_change_inv
1398
"""Return all unknown files.
1400
These are files in the working directory that are not versioned or
1401
control files or ignored.
1403
# force the extras method to be fully executed before returning, to
1404
# prevent race conditions with the lock
1406
[subp for subp in self.extras() if not self.is_ignored(subp)])
1408
@needs_tree_write_lock
1409
def unversion(self, file_ids):
1410
"""Remove the file ids in file_ids from the current versioned set.
1412
When a file_id is unversioned, all of its children are automatically
1415
:param file_ids: The file ids to stop versioning.
1416
:raises: NoSuchId if any fileid is not currently versioned.
1418
for file_id in file_ids:
1419
file_id = osutils.safe_file_id(file_id)
1420
if self._inventory.has_id(file_id):
1421
self._inventory.remove_recursive_id(file_id)
1423
raise errors.NoSuchId(self, file_id)
1425
# in the future this should just set a dirty bit to wait for the
1426
# final unlock. However, until all methods of workingtree start
1427
# with the current in -memory inventory rather than triggering
1428
# a read, it is more complex - we need to teach read_inventory
1429
# to know when to read, and when to not read first... and possibly
1430
# to save first when the in memory one may be corrupted.
1431
# so for now, we just only write it if it is indeed dirty.
1433
self._write_inventory(self._inventory)
1435
@deprecated_method(zero_eight)
1436
def iter_conflicts(self):
1437
"""List all files in the tree that have text or content conflicts.
1438
DEPRECATED. Use conflicts instead."""
1439
return self._iter_conflicts()
1441
def _iter_conflicts(self):
1443
for info in self.list_files():
1445
stem = get_conflicted_stem(path)
1448
if stem not in conflicted:
1449
conflicted.add(stem)
1453
def pull(self, source, overwrite=False, stop_revision=None,
1454
change_reporter=None):
1455
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1458
pp = ProgressPhase("Pull phase", 2, top_pb)
1460
old_revision_info = self.branch.last_revision_info()
1461
basis_tree = self.basis_tree()
1462
count = self.branch.pull(source, overwrite, stop_revision)
1463
new_revision_info = self.branch.last_revision_info()
1464
if new_revision_info != old_revision_info:
1466
repository = self.branch.repository
1467
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1468
basis_tree.lock_read()
1470
new_basis_tree = self.branch.basis_tree()
1477
change_reporter=change_reporter)
1478
if (basis_tree.inventory.root is None and
1479
new_basis_tree.inventory.root is not None):
1480
self.set_root_id(new_basis_tree.inventory.root.file_id)
1484
# TODO - dedup parents list with things merged by pull ?
1485
# reuse the revisiontree we merged against to set the new
1487
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1488
# we have to pull the merge trees out again, because
1489
# merge_inner has set the ids. - this corner is not yet
1490
# layered well enough to prevent double handling.
1491
# XXX TODO: Fix the double handling: telling the tree about
1492
# the already known parent data is wasteful.
1493
merges = self.get_parent_ids()[1:]
1494
parent_trees.extend([
1495
(parent, repository.revision_tree(parent)) for
1497
self.set_parent_trees(parent_trees)
1504
def put_file_bytes_non_atomic(self, file_id, bytes):
1505
"""See MutableTree.put_file_bytes_non_atomic."""
1506
file_id = osutils.safe_file_id(file_id)
1507
stream = file(self.id2abspath(file_id), 'wb')
1512
# TODO: update the hashcache here ?
1515
"""Yield all unknown files in this WorkingTree.
1517
If there are any unknown directories then only the directory is
1518
returned, not all its children. But if there are unknown files
1519
under a versioned subdirectory, they are returned.
1521
Currently returned depth-first, sorted by name within directories.
1523
## TODO: Work from given directory downwards
1524
for path, dir_entry in self.inventory.directories():
1525
# mutter("search for unknowns in %r", path)
1526
dirabs = self.abspath(path)
1527
if not isdir(dirabs):
1528
# e.g. directory deleted
1532
for subf in os.listdir(dirabs):
1535
if subf not in dir_entry.children:
1536
subf_norm, can_access = osutils.normalized_filename(subf)
1537
if subf_norm != subf and can_access:
1538
if subf_norm not in dir_entry.children:
1539
fl.append(subf_norm)
1545
subp = pathjoin(path, subf)
1548
def ignored_files(self):
1549
"""Yield list of PATH, IGNORE_PATTERN"""
1550
for subp in self.extras():
1551
pat = self.is_ignored(subp)
1555
def get_ignore_list(self):
1556
"""Return list of ignore patterns.
1558
Cached in the Tree object after the first call.
1560
ignoreset = getattr(self, '_ignoreset', None)
1561
if ignoreset is not None:
1564
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1565
ignore_globs.update(ignores.get_runtime_ignores())
1566
ignore_globs.update(ignores.get_user_ignores())
1567
if self.has_filename(bzrlib.IGNORE_FILENAME):
1568
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1570
ignore_globs.update(ignores.parse_ignore_file(f))
1573
self._ignoreset = ignore_globs
1576
def _flush_ignore_list_cache(self):
1577
"""Resets the cached ignore list to force a cache rebuild."""
1578
self._ignoreset = None
1579
self._ignoreglobster = None
1581
def is_ignored(self, filename):
1582
r"""Check whether the filename matches an ignore pattern.
1584
Patterns containing '/' or '\' need to match the whole path;
1585
others match against only the last component.
1587
If the file is ignored, returns the pattern which caused it to
1588
be ignored, otherwise None. So this can simply be used as a
1589
boolean if desired."""
1590
if getattr(self, '_ignoreglobster', None) is None:
1591
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1592
return self._ignoreglobster.match(filename)
1594
def kind(self, file_id):
1595
return file_kind(self.id2abspath(file_id))
1597
def _comparison_data(self, entry, path):
1598
abspath = self.abspath(path)
1600
stat_value = os.lstat(abspath)
1602
if getattr(e, 'errno', None) == errno.ENOENT:
1609
mode = stat_value.st_mode
1610
kind = osutils.file_kind_from_stat_mode(mode)
1611
if not supports_executable():
1612
executable = entry.executable
1614
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1615
return kind, executable, stat_value
1617
def _file_size(self, entry, stat_value):
1618
return stat_value.st_size
1620
def last_revision(self):
1621
"""Return the last revision of the branch for this tree.
1623
This format tree does not support a separate marker for last-revision
1624
compared to the branch.
1626
See MutableTree.last_revision
1628
return self._last_revision()
1631
def _last_revision(self):
1632
"""helper for get_parent_ids."""
1633
return self.branch.last_revision()
1635
def is_locked(self):
1636
return self._control_files.is_locked()
1638
def lock_read(self):
1639
"""See Branch.lock_read, and WorkingTree.unlock."""
1640
self.branch.lock_read()
1642
return self._control_files.lock_read()
1644
self.branch.unlock()
1647
def lock_tree_write(self):
1648
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1649
self.branch.lock_read()
1651
return self._control_files.lock_write()
1653
self.branch.unlock()
1656
def lock_write(self):
1657
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1658
self.branch.lock_write()
1660
return self._control_files.lock_write()
1662
self.branch.unlock()
1665
def get_physical_lock_status(self):
1666
return self._control_files.get_physical_lock_status()
1668
def _basis_inventory_name(self):
1669
return 'basis-inventory-cache'
1671
@needs_tree_write_lock
1672
def set_last_revision(self, new_revision):
1673
"""Change the last revision in the working tree."""
1674
new_revision = osutils.safe_revision_id(new_revision)
1675
if self._change_last_revision(new_revision):
1676
self._cache_basis_inventory(new_revision)
1678
def _change_last_revision(self, new_revision):
1679
"""Template method part of set_last_revision to perform the change.
1681
This is used to allow WorkingTree3 instances to not affect branch
1682
when their last revision is set.
1684
if new_revision is None:
1685
self.branch.set_revision_history([])
1688
self.branch.generate_revision_history(new_revision)
1689
except errors.NoSuchRevision:
1690
# not present in the repo - dont try to set it deeper than the tip
1691
self.branch.set_revision_history([new_revision])
1694
def _write_basis_inventory(self, xml):
1695
"""Write the basis inventory XML to the basis-inventory file"""
1696
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1697
path = self._basis_inventory_name()
1699
self._control_files.put(path, sio)
1701
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1702
"""Create the text that will be saved in basis-inventory"""
1703
# TODO: jam 20070209 This should be redundant, as the revision_id
1704
# as all callers should have already converted the revision_id to
1706
inventory.revision_id = osutils.safe_revision_id(revision_id)
1707
return xml7.serializer_v7.write_inventory_to_string(inventory)
1709
def _cache_basis_inventory(self, new_revision):
1710
"""Cache new_revision as the basis inventory."""
1711
# TODO: this should allow the ready-to-use inventory to be passed in,
1712
# as commit already has that ready-to-use [while the format is the
1715
# this double handles the inventory - unpack and repack -
1716
# but is easier to understand. We can/should put a conditional
1717
# in here based on whether the inventory is in the latest format
1718
# - perhaps we should repack all inventories on a repository
1720
# the fast path is to copy the raw xml from the repository. If the
1721
# xml contains 'revision_id="', then we assume the right
1722
# revision_id is set. We must check for this full string, because a
1723
# root node id can legitimately look like 'revision_id' but cannot
1725
xml = self.branch.repository.get_inventory_xml(new_revision)
1726
firstline = xml.split('\n', 1)[0]
1727
if (not 'revision_id="' in firstline or
1728
'format="7"' not in firstline):
1729
inv = self.branch.repository.deserialise_inventory(
1731
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1732
self._write_basis_inventory(xml)
1733
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1736
def read_basis_inventory(self):
1737
"""Read the cached basis inventory."""
1738
path = self._basis_inventory_name()
1739
return self._control_files.get(path).read()
1742
def read_working_inventory(self):
1743
"""Read the working inventory.
1745
:raises errors.InventoryModified: read_working_inventory will fail
1746
when the current in memory inventory has been modified.
1748
# conceptually this should be an implementation detail of the tree.
1749
# XXX: Deprecate this.
1750
# ElementTree does its own conversion from UTF-8, so open in
1752
if self._inventory_is_modified:
1753
raise errors.InventoryModified(self)
1754
result = self._deserialize(self._control_files.get('inventory'))
1755
self._set_inventory(result, dirty=False)
1758
@needs_tree_write_lock
1759
def remove(self, files, verbose=False, to_file=None):
1760
"""Remove nominated files from the working inventory..
1762
This does not remove their text. This does not run on XXX on what? RBC
1764
TODO: Refuse to remove modified files unless --force is given?
1766
TODO: Do something useful with directories.
1768
TODO: Should this remove the text or not? Tough call; not
1769
removing may be useful and the user can just use use rm, and
1770
is the opposite of add. Removing it is consistent with most
1771
other tools. Maybe an option.
1773
## TODO: Normalize names
1774
## TODO: Remove nested loops; better scalability
1775
if isinstance(files, basestring):
1778
inv = self.inventory
1780
# do this before any modifications
1782
fid = inv.path2id(f)
1784
note("%s is not versioned."%f)
1787
# having remove it, it must be either ignored or unknown
1788
if self.is_ignored(f):
1792
textui.show_status(new_status, inv[fid].kind, f,
1796
self._write_inventory(inv)
1798
@needs_tree_write_lock
1799
def revert(self, filenames, old_tree=None, backups=True,
1800
pb=DummyProgress(), report_changes=False):
1801
from bzrlib.conflicts import resolve
1802
if old_tree is None:
1803
old_tree = self.basis_tree()
1804
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1806
if not len(filenames):
1807
self.set_parent_ids(self.get_parent_ids()[:1])
1810
resolve(self, filenames, ignore_misses=True)
1813
def revision_tree(self, revision_id):
1814
"""See Tree.revision_tree.
1816
WorkingTree can supply revision_trees for the basis revision only
1817
because there is only one cached inventory in the bzr directory.
1819
if revision_id == self.last_revision():
1821
xml = self.read_basis_inventory()
1822
except errors.NoSuchFile:
1826
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1827
# dont use the repository revision_tree api because we want
1828
# to supply the inventory.
1829
if inv.revision_id == revision_id:
1830
return revisiontree.RevisionTree(self.branch.repository,
1832
except errors.BadInventoryFormat:
1834
# raise if there was no inventory, or if we read the wrong inventory.
1835
raise errors.NoSuchRevisionInTree(self, revision_id)
1837
# XXX: This method should be deprecated in favour of taking in a proper
1838
# new Inventory object.
1839
@needs_tree_write_lock
1840
def set_inventory(self, new_inventory_list):
1841
from bzrlib.inventory import (Inventory,
1846
inv = Inventory(self.get_root_id())
1847
for path, file_id, parent, kind in new_inventory_list:
1848
name = os.path.basename(path)
1851
# fixme, there should be a factory function inv,add_??
1852
if kind == 'directory':
1853
inv.add(InventoryDirectory(file_id, name, parent))
1854
elif kind == 'file':
1855
inv.add(InventoryFile(file_id, name, parent))
1856
elif kind == 'symlink':
1857
inv.add(InventoryLink(file_id, name, parent))
1859
raise errors.BzrError("unknown kind %r" % kind)
1860
self._write_inventory(inv)
1862
@needs_tree_write_lock
1863
def set_root_id(self, file_id):
1864
"""Set the root id for this tree."""
1867
symbol_versioning.warn(symbol_versioning.zero_twelve
1868
% 'WorkingTree.set_root_id with fileid=None',
1873
file_id = osutils.safe_file_id(file_id)
1874
self._set_root_id(file_id)
1876
def _set_root_id(self, file_id):
1877
"""Set the root id for this tree, in a format specific manner.
1879
:param file_id: The file id to assign to the root. It must not be
1880
present in the current inventory or an error will occur. It must
1881
not be None, but rather a valid file id.
1883
inv = self._inventory
1884
orig_root_id = inv.root.file_id
1885
# TODO: it might be nice to exit early if there was nothing
1886
# to do, saving us from trigger a sync on unlock.
1887
self._inventory_is_modified = True
1888
# we preserve the root inventory entry object, but
1889
# unlinkit from the byid index
1890
del inv._byid[inv.root.file_id]
1891
inv.root.file_id = file_id
1892
# and link it into the index with the new changed id.
1893
inv._byid[inv.root.file_id] = inv.root
1894
# and finally update all children to reference the new id.
1895
# XXX: this should be safe to just look at the root.children
1896
# list, not the WHOLE INVENTORY.
1899
if entry.parent_id == orig_root_id:
1900
entry.parent_id = inv.root.file_id
1903
"""See Branch.unlock.
1905
WorkingTree locking just uses the Branch locking facilities.
1906
This is current because all working trees have an embedded branch
1907
within them. IF in the future, we were to make branch data shareable
1908
between multiple working trees, i.e. via shared storage, then we
1909
would probably want to lock both the local tree, and the branch.
1911
raise NotImplementedError(self.unlock)
1914
"""Update a working tree along its branch.
1916
This will update the branch if its bound too, which means we have
1917
multiple trees involved:
1919
- The new basis tree of the master.
1920
- The old basis tree of the branch.
1921
- The old basis tree of the working tree.
1922
- The current working tree state.
1924
Pathologically, all three may be different, and non-ancestors of each
1925
other. Conceptually we want to:
1927
- Preserve the wt.basis->wt.state changes
1928
- Transform the wt.basis to the new master basis.
1929
- Apply a merge of the old branch basis to get any 'local' changes from
1931
- Restore the wt.basis->wt.state changes.
1933
There isn't a single operation at the moment to do that, so we:
1934
- Merge current state -> basis tree of the master w.r.t. the old tree
1936
- Do a 'normal' merge of the old branch basis if it is relevant.
1938
if self.branch.get_master_branch() is not None:
1940
update_branch = True
1942
self.lock_tree_write()
1943
update_branch = False
1946
old_tip = self.branch.update()
1949
return self._update_tree(old_tip)
1953
@needs_tree_write_lock
1954
def _update_tree(self, old_tip=None):
1955
"""Update a tree to the master branch.
1957
:param old_tip: if supplied, the previous tip revision the branch,
1958
before it was changed to the master branch's tip.
1960
# here if old_tip is not None, it is the old tip of the branch before
1961
# it was updated from the master branch. This should become a pending
1962
# merge in the working tree to preserve the user existing work. we
1963
# cant set that until we update the working trees last revision to be
1964
# one from the new branch, because it will just get absorbed by the
1965
# parent de-duplication logic.
1967
# We MUST save it even if an error occurs, because otherwise the users
1968
# local work is unreferenced and will appear to have been lost.
1972
last_rev = self.get_parent_ids()[0]
1975
if last_rev != self.branch.last_revision():
1976
# merge tree state up to new branch tip.
1977
basis = self.basis_tree()
1980
to_tree = self.branch.basis_tree()
1981
if basis.inventory.root is None:
1982
self.set_root_id(to_tree.inventory.root.file_id)
1984
result += merge.merge_inner(
1991
# TODO - dedup parents list with things merged by pull ?
1992
# reuse the tree we've updated to to set the basis:
1993
parent_trees = [(self.branch.last_revision(), to_tree)]
1994
merges = self.get_parent_ids()[1:]
1995
# Ideally we ask the tree for the trees here, that way the working
1996
# tree can decide whether to give us teh entire tree or give us a
1997
# lazy initialised tree. dirstate for instance will have the trees
1998
# in ram already, whereas a last-revision + basis-inventory tree
1999
# will not, but also does not need them when setting parents.
2000
for parent in merges:
2001
parent_trees.append(
2002
(parent, self.branch.repository.revision_tree(parent)))
2003
if old_tip is not None:
2004
parent_trees.append(
2005
(old_tip, self.branch.repository.revision_tree(old_tip)))
2006
self.set_parent_trees(parent_trees)
2007
last_rev = parent_trees[0][0]
2009
# the working tree had the same last-revision as the master
2010
# branch did. We may still have pivot local work from the local
2011
# branch into old_tip:
2012
if old_tip is not None:
2013
self.add_parent_tree_id(old_tip)
2014
if old_tip and old_tip != last_rev:
2015
# our last revision was not the prior branch last revision
2016
# and we have converted that last revision to a pending merge.
2017
# base is somewhere between the branch tip now
2018
# and the now pending merge
2020
# Since we just modified the working tree and inventory, flush out
2021
# the current state, before we modify it again.
2022
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2023
# requires it only because TreeTransform directly munges the
2024
# inventory and calls tree._write_inventory(). Ultimately we
2025
# should be able to remove this extra flush.
2027
from bzrlib.revision import common_ancestor
2029
base_rev_id = common_ancestor(self.branch.last_revision(),
2031
self.branch.repository)
2032
except errors.NoCommonAncestor:
2034
base_tree = self.branch.repository.revision_tree(base_rev_id)
2035
other_tree = self.branch.repository.revision_tree(old_tip)
2036
result += merge.merge_inner(
2043
def _write_hashcache_if_dirty(self):
2044
"""Write out the hashcache if it is dirty."""
2045
if self._hashcache.needs_write:
2047
self._hashcache.write()
2049
if e.errno not in (errno.EPERM, errno.EACCES):
2051
# TODO: jam 20061219 Should this be a warning? A single line
2052
# warning might be sufficient to let the user know what
2054
mutter('Could not write hashcache for %s\nError: %s',
2055
self._hashcache.cache_file_name(), e)
2057
@needs_tree_write_lock
2058
def _write_inventory(self, inv):
2059
"""Write inventory as the current inventory."""
2060
self._set_inventory(inv, dirty=True)
2063
def set_conflicts(self, arg):
2064
raise errors.UnsupportedOperation(self.set_conflicts, self)
2066
def add_conflicts(self, arg):
2067
raise errors.UnsupportedOperation(self.add_conflicts, self)
2070
def conflicts(self):
2071
conflicts = _mod_conflicts.ConflictList()
2072
for conflicted in self._iter_conflicts():
2075
if file_kind(self.abspath(conflicted)) != "file":
2077
except errors.NoSuchFile:
2080
for suffix in ('.THIS', '.OTHER'):
2082
kind = file_kind(self.abspath(conflicted+suffix))
2085
except errors.NoSuchFile:
2089
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2090
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2092
file_id=self.path2id(conflicted)))
2095
def walkdirs(self, prefix=""):
2096
"""Walk the directories of this tree.
2098
This API returns a generator, which is only valid during the current
2099
tree transaction - within a single lock_read or lock_write duration.
2101
If the tree is not locked, it may cause an error to be raised, depending
2102
on the tree implementation.
2104
disk_top = self.abspath(prefix)
2105
if disk_top.endswith('/'):
2106
disk_top = disk_top[:-1]
2107
top_strip_len = len(disk_top) + 1
2108
inventory_iterator = self._walkdirs(prefix)
2109
disk_iterator = osutils.walkdirs(disk_top, prefix)
2111
current_disk = disk_iterator.next()
2112
disk_finished = False
2114
if e.errno != errno.ENOENT:
2117
disk_finished = True
2119
current_inv = inventory_iterator.next()
2120
inv_finished = False
2121
except StopIteration:
2124
while not inv_finished or not disk_finished:
2125
if not disk_finished:
2126
# strip out .bzr dirs
2127
if current_disk[0][1][top_strip_len:] == '':
2128
# osutils.walkdirs can be made nicer -
2129
# yield the path-from-prefix rather than the pathjoined
2131
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2132
if current_disk[1][bzrdir_loc][0] == '.bzr':
2133
# we dont yield the contents of, or, .bzr itself.
2134
del current_disk[1][bzrdir_loc]
2136
# everything is unknown
2139
# everything is missing
2142
direction = cmp(current_inv[0][0], current_disk[0][0])
2144
# disk is before inventory - unknown
2145
dirblock = [(relpath, basename, kind, stat, None, None) for
2146
relpath, basename, kind, stat, top_path in current_disk[1]]
2147
yield (current_disk[0][0], None), dirblock
2149
current_disk = disk_iterator.next()
2150
except StopIteration:
2151
disk_finished = True
2153
# inventory is before disk - missing.
2154
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2155
for relpath, basename, dkind, stat, fileid, kind in
2157
yield (current_inv[0][0], current_inv[0][1]), dirblock
2159
current_inv = inventory_iterator.next()
2160
except StopIteration:
2163
# versioned present directory
2164
# merge the inventory and disk data together
2166
for relpath, subiterator in itertools.groupby(sorted(
2167
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2168
path_elements = list(subiterator)
2169
if len(path_elements) == 2:
2170
inv_row, disk_row = path_elements
2171
# versioned, present file
2172
dirblock.append((inv_row[0],
2173
inv_row[1], disk_row[2],
2174
disk_row[3], inv_row[4],
2176
elif len(path_elements[0]) == 5:
2178
dirblock.append((path_elements[0][0],
2179
path_elements[0][1], path_elements[0][2],
2180
path_elements[0][3], None, None))
2181
elif len(path_elements[0]) == 6:
2182
# versioned, absent file.
2183
dirblock.append((path_elements[0][0],
2184
path_elements[0][1], 'unknown', None,
2185
path_elements[0][4], path_elements[0][5]))
2187
raise NotImplementedError('unreachable code')
2188
yield current_inv[0], dirblock
2190
current_inv = inventory_iterator.next()
2191
except StopIteration:
2194
current_disk = disk_iterator.next()
2195
except StopIteration:
2196
disk_finished = True
2198
def _walkdirs(self, prefix=""):
2199
_directory = 'directory'
2200
# get the root in the inventory
2201
inv = self.inventory
2202
top_id = inv.path2id(prefix)
2206
pending = [(prefix, '', _directory, None, top_id, None)]
2209
currentdir = pending.pop()
2210
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2211
top_id = currentdir[4]
2213
relroot = currentdir[0] + '/'
2216
# FIXME: stash the node in pending
2218
for name, child in entry.sorted_children():
2219
dirblock.append((relroot + name, name, child.kind, None,
2220
child.file_id, child.kind
2222
yield (currentdir[0], entry.file_id), dirblock
2223
# push the user specified dirs from dirblock
2224
for dir in reversed(dirblock):
2225
if dir[2] == _directory:
2229
class WorkingTree2(WorkingTree):
2230
"""This is the Format 2 working tree.
2232
This was the first weave based working tree.
2233
- uses os locks for locking.
2234
- uses the branch last-revision.
2237
def lock_tree_write(self):
2238
"""See WorkingTree.lock_tree_write().
2240
In Format2 WorkingTrees we have a single lock for the branch and tree
2241
so lock_tree_write() degrades to lock_write().
2243
self.branch.lock_write()
2245
return self._control_files.lock_write()
2247
self.branch.unlock()
2251
# we share control files:
2252
if self._control_files._lock_count == 3:
2253
# _inventory_is_modified is always False during a read lock.
2254
if self._inventory_is_modified:
2256
self._write_hashcache_if_dirty()
2258
# reverse order of locking.
2260
return self._control_files.unlock()
2262
self.branch.unlock()
2265
class WorkingTree3(WorkingTree):
2266
"""This is the Format 3 working tree.
2268
This differs from the base WorkingTree by:
2269
- having its own file lock
2270
- having its own last-revision property.
2272
This is new in bzr 0.8
2276
def _last_revision(self):
2277
"""See Mutable.last_revision."""
2279
return osutils.safe_revision_id(
2280
self._control_files.get('last-revision').read())
2281
except errors.NoSuchFile:
2284
def _change_last_revision(self, revision_id):
2285
"""See WorkingTree._change_last_revision."""
2286
if revision_id is None or revision_id == NULL_REVISION:
2288
self._control_files._transport.delete('last-revision')
2289
except errors.NoSuchFile:
2293
self._control_files.put_bytes('last-revision', revision_id)
2296
@needs_tree_write_lock
2297
def set_conflicts(self, conflicts):
2298
self._put_rio('conflicts', conflicts.to_stanzas(),
2301
@needs_tree_write_lock
2302
def add_conflicts(self, new_conflicts):
2303
conflict_set = set(self.conflicts())
2304
conflict_set.update(set(list(new_conflicts)))
2305
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2306
key=_mod_conflicts.Conflict.sort_key)))
2309
def conflicts(self):
2311
confile = self._control_files.get('conflicts')
2312
except errors.NoSuchFile:
2313
return _mod_conflicts.ConflictList()
2315
if confile.next() != CONFLICT_HEADER_1 + '\n':
2316
raise errors.ConflictFormatError()
2317
except StopIteration:
2318
raise errors.ConflictFormatError()
2319
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2322
if self._control_files._lock_count == 1:
2323
# _inventory_is_modified is always False during a read lock.
2324
if self._inventory_is_modified:
2326
self._write_hashcache_if_dirty()
2327
# reverse order of locking.
2329
return self._control_files.unlock()
2331
self.branch.unlock()
2334
class WorkingTreeAB1(WorkingTree3):
2336
def _serialize(self, inventory, out_file):
2337
xml7.serializer_v7.write_inventory(self._inventory, out_file)
2339
def _deserialize(selt, in_file):
2340
return xml7.serializer_v7.read_inventory(in_file)
2342
def _comparison_data(self, entry, path):
2343
kind, executable, stat_value = \
2344
WorkingTree3._comparison_data(self, entry, path)
2345
if kind == 'directory' and entry.kind == 'tree-reference':
2346
kind = 'tree-reference'
2347
return kind, executable, stat_value
2349
def kind(self, file_id):
2350
kind = WorkingTree3.kind(self, file_id)
2351
if kind == 'directory':
2352
entry = self.inventory[file_id]
2353
if entry.kind == 'tree-reference':
2354
kind = 'tree-reference'
2357
def add_reference(self, sub_tree):
2358
return self._add_reference(sub_tree)
2360
def get_nested_tree(self, entry, path=None):
2362
path = self.id2path(entry.file_id)
2363
return WorkingTree.open(self.abspath(path))
2365
def get_reference_revision(self, entry, path=None):
2366
return self.get_nested_tree(entry, path).last_revision()
2369
def get_conflicted_stem(path):
2370
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2371
if path.endswith(suffix):
2372
return path[:-len(suffix)]
2375
@deprecated_function(zero_eight)
2376
def is_control_file(filename):
2377
"""See WorkingTree.is_control_filename(filename)."""
2378
## FIXME: better check
2379
filename = normpath(filename)
2380
while filename != '':
2381
head, tail = os.path.split(filename)
2382
## mutter('check %r for control file' % ((head, tail),))
2385
if filename == head:
2391
class WorkingTreeFormat(object):
2392
"""An encapsulation of the initialization and open routines for a format.
2394
Formats provide three things:
2395
* An initialization routine,
2399
Formats are placed in an dict by their format string for reference
2400
during workingtree opening. Its not required that these be instances, they
2401
can be classes themselves with class methods - it simply depends on
2402
whether state is needed for a given format or not.
2404
Once a format is deprecated, just deprecate the initialize and open
2405
methods on the format class. Do not deprecate the object, as the
2406
object will be created every time regardless.
2409
_default_format = None
2410
"""The default format used for new trees."""
2413
"""The known formats."""
2415
requires_rich_root = False
2418
def find_format(klass, a_bzrdir):
2419
"""Return the format for the working tree object in a_bzrdir."""
2421
transport = a_bzrdir.get_workingtree_transport(None)
2422
format_string = transport.get("format").read()
2423
return klass._formats[format_string]
2424
except errors.NoSuchFile:
2425
raise errors.NoWorkingTree(base=transport.base)
2427
raise errors.UnknownFormatError(format=format_string)
2429
def __eq__(self, other):
2430
return self.__class__ is other.__class__
2432
def __ne__(self, other):
2433
return not (self == other)
2436
def get_default_format(klass):
2437
"""Return the current default format."""
2438
return klass._default_format
2440
def get_format_string(self):
2441
"""Return the ASCII format string that identifies this format."""
2442
raise NotImplementedError(self.get_format_string)
2444
def get_format_description(self):
2445
"""Return the short description for this format."""
2446
raise NotImplementedError(self.get_format_description)
2448
def is_supported(self):
2449
"""Is this format supported?
2451
Supported formats can be initialized and opened.
2452
Unsupported formats may not support initialization or committing or
2453
some other features depending on the reason for not being supported.
2458
def register_format(klass, format):
2459
klass._formats[format.get_format_string()] = format
2462
def set_default_format(klass, format):
2463
klass._default_format = format
2466
def unregister_format(klass, format):
2467
assert klass._formats[format.get_format_string()] is format
2468
del klass._formats[format.get_format_string()]
2472
class WorkingTreeFormat2(WorkingTreeFormat):
2473
"""The second working tree format.
2475
This format modified the hash cache from the format 1 hash cache.
2478
def get_format_description(self):
2479
"""See WorkingTreeFormat.get_format_description()."""
2480
return "Working tree format 2"
2482
def stub_initialize_remote(self, control_files):
2483
"""As a special workaround create critical control files for a remote working tree
2485
This ensures that it can later be updated and dealt with locally,
2486
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2487
no working tree. (See bug #43064).
2491
xml5.serializer_v5.write_inventory(inv, sio)
2493
control_files.put('inventory', sio)
2495
control_files.put_bytes('pending-merges', '')
2498
def initialize(self, a_bzrdir, revision_id=None):
2499
"""See WorkingTreeFormat.initialize()."""
2500
if not isinstance(a_bzrdir.transport, LocalTransport):
2501
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2502
branch = a_bzrdir.open_branch()
2503
if revision_id is not None:
2504
revision_id = osutils.safe_revision_id(revision_id)
2507
revision_history = branch.revision_history()
2509
position = revision_history.index(revision_id)
2511
raise errors.NoSuchRevision(branch, revision_id)
2512
branch.set_revision_history(revision_history[:position + 1])
2515
revision = branch.last_revision()
2517
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2523
basis_tree = branch.repository.revision_tree(revision)
2524
if basis_tree.inventory.root is not None:
2525
wt.set_root_id(basis_tree.inventory.root.file_id)
2526
# set the parent list and cache the basis tree.
2527
wt.set_parent_trees([(revision, basis_tree)])
2528
transform.build_tree(basis_tree, wt)
2532
super(WorkingTreeFormat2, self).__init__()
2533
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2535
def open(self, a_bzrdir, _found=False):
2536
"""Return the WorkingTree object for a_bzrdir
2538
_found is a private parameter, do not use it. It is used to indicate
2539
if format probing has already been done.
2542
# we are being called directly and must probe.
2543
raise NotImplementedError
2544
if not isinstance(a_bzrdir.transport, LocalTransport):
2545
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2546
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2552
class WorkingTreeFormat3(WorkingTreeFormat):
2553
"""The second working tree format updated to record a format marker.
2556
- exists within a metadir controlling .bzr
2557
- includes an explicit version marker for the workingtree control
2558
files, separate from the BzrDir format
2559
- modifies the hash cache format
2561
- uses a LockDir to guard access for writes.
2564
def get_format_string(self):
2565
"""See WorkingTreeFormat.get_format_string()."""
2566
return "Bazaar-NG Working Tree format 3"
2568
def get_format_description(self):
2569
"""See WorkingTreeFormat.get_format_description()."""
2570
return "Working tree format 3"
2572
_lock_file_name = 'lock'
2573
_lock_class = LockDir
2574
_tree_class = WorkingTree3
2576
def __get_matchingbzrdir(self):
2577
return bzrdir.BzrDirMetaFormat1()
2579
_matchingbzrdir = property(__get_matchingbzrdir)
2581
def _open_control_files(self, a_bzrdir):
2582
transport = a_bzrdir.get_workingtree_transport(None)
2583
return LockableFiles(transport, self._lock_file_name,
2586
def initialize(self, a_bzrdir, revision_id=None):
2587
"""See WorkingTreeFormat.initialize().
2589
revision_id allows creating a working tree at a different
2590
revision than the branch is at.
2592
if not isinstance(a_bzrdir.transport, LocalTransport):
2593
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2594
transport = a_bzrdir.get_workingtree_transport(self)
2595
control_files = self._open_control_files(a_bzrdir)
2596
control_files.create_lock()
2597
control_files.lock_write()
2598
control_files.put_utf8('format', self.get_format_string())
2599
branch = a_bzrdir.open_branch()
2600
if revision_id is None:
2601
revision_id = branch.last_revision()
2603
revision_id = osutils.safe_revision_id(revision_id)
2604
# WorkingTree3 can handle an inventory which has a unique root id.
2605
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2606
# those trees. And because there isn't a format bump inbetween, we
2607
# are maintaining compatibility with older clients.
2608
# inv = Inventory(root_id=gen_root_id())
2609
inv = self._initial_inventory()
2610
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2616
_control_files=control_files)
2617
wt.lock_tree_write()
2619
basis_tree = branch.repository.revision_tree(revision_id)
2620
# only set an explicit root id if there is one to set.
2621
if basis_tree.inventory.root is not None:
2622
wt.set_root_id(basis_tree.inventory.root.file_id)
2623
if revision_id == NULL_REVISION:
2624
wt.set_parent_trees([])
2626
wt.set_parent_trees([(revision_id, basis_tree)])
2627
transform.build_tree(basis_tree, wt)
2629
# Unlock in this order so that the unlock-triggers-flush in
2630
# WorkingTree is given a chance to fire.
2631
control_files.unlock()
2635
def _initial_inventory(self):
2639
super(WorkingTreeFormat3, self).__init__()
2641
def open(self, a_bzrdir, _found=False):
2642
"""Return the WorkingTree object for a_bzrdir
2644
_found is a private parameter, do not use it. It is used to indicate
2645
if format probing has already been done.
2648
# we are being called directly and must probe.
2649
raise NotImplementedError
2650
if not isinstance(a_bzrdir.transport, LocalTransport):
2651
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2652
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2654
def _open(self, a_bzrdir, control_files):
2655
"""Open the tree itself.
2657
:param a_bzrdir: the dir for the tree.
2658
:param control_files: the control files for the tree.
2660
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2664
_control_files=control_files)
2667
return self.get_format_string()
2670
class WorkingTreeFormatAB1(WorkingTreeFormat3):
2672
"""Working tree format that supports unique roots and nested trees"""
2674
_tree_class = WorkingTreeAB1
2676
requires_rich_root = True
2678
supports_tree_reference = True
2681
WorkingTreeFormat3.__init__(self)
2683
def __get_matchingbzrdir(self):
2684
return bzrdir.format_registry.make_bzrdir('experimental-knit3')
2686
_matchingbzrdir = property(__get_matchingbzrdir)
2688
def get_format_string(self):
2689
"""See WorkingTreeFormat.get_format_string()."""
2690
return "Bazaar-NG Working Tree format AB1"
2692
def get_format_description(self):
2693
"""See WorkingTreeFormat.get_format_description()."""
2694
return "Working tree format 4"
2696
def _initial_inventory(self):
2697
return Inventory(root_id=generate_ids.gen_root_id())
2699
# formats which have no format string are not discoverable
2700
# and not independently creatable, so are not registered.
2701
__default_format = WorkingTreeFormat3()
2702
WorkingTreeFormat.register_format(__default_format)
2703
WorkingTreeFormat.register_format(WorkingTreeFormat4())
2704
WorkingTreeFormat.register_format(WorkingTreeFormatAB1())
2705
WorkingTreeFormat.set_default_format(__default_format)
2706
# formats which have no format string are not discoverable
2707
# and not independently creatable, so are not registered.
2708
_legacy_formats = [WorkingTreeFormat2(),
2712
class WorkingTreeTestProviderAdapter(object):
2713
"""A tool to generate a suite testing multiple workingtree formats at once.
2715
This is done by copying the test once for each transport and injecting
2716
the transport_server, transport_readonly_server, and workingtree_format
2717
classes into each copy. Each copy is also given a new id() to make it
2721
def __init__(self, transport_server, transport_readonly_server, formats):
2722
self._transport_server = transport_server
2723
self._transport_readonly_server = transport_readonly_server
2724
self._formats = formats
2726
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2727
"""Clone test for adaption."""
2728
new_test = deepcopy(test)
2729
new_test.transport_server = self._transport_server
2730
new_test.transport_readonly_server = self._transport_readonly_server
2731
new_test.bzrdir_format = bzrdir_format
2732
new_test.workingtree_format = workingtree_format
2733
def make_new_test_id():
2734
new_id = "%s(%s)" % (test.id(), variation)
2735
return lambda: new_id
2736
new_test.id = make_new_test_id()
2739
def adapt(self, test):
2740
from bzrlib.tests import TestSuite
2741
result = TestSuite()
2742
for workingtree_format, bzrdir_format in self._formats:
2743
new_test = self._clone_test(
2746
workingtree_format, workingtree_format.__class__.__name__)
2747
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
