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
59
conflicts as _mod_conflicts,
78
from bzrlib.transport import get_transport
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
from bzrlib import symbol_versioning
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
86
from bzrlib.lockable_files import LockableFiles, TransportLock
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib.osutils import (
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
@deprecated_function(zero_thirteen)
122
def gen_file_id(name):
123
"""Return new file id for the basename 'name'.
125
Use bzrlib.generate_ids.gen_file_id() instead
127
return generate_ids.gen_file_id(name)
130
@deprecated_function(zero_thirteen)
132
"""Return a new tree-root file id.
134
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
136
return generate_ids.gen_root_id()
139
class TreeEntry(object):
140
"""An entry that implements the minimum interface used by commands.
142
This needs further inspection, it may be better to have
143
InventoryEntries without ids - though that seems wrong. For now,
144
this is a parallel hierarchy to InventoryEntry, and needs to become
145
one of several things: decorates to that hierarchy, children of, or
147
Another note is that these objects are currently only used when there is
148
no InventoryEntry available - i.e. for unversioned objects.
149
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
152
def __eq__(self, other):
153
# yes, this us ugly, TODO: best practice __eq__ style.
154
return (isinstance(other, TreeEntry)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class TreeDirectory(TreeEntry):
162
"""See TreeEntry. This is a directory in a working tree."""
164
def __eq__(self, other):
165
return (isinstance(other, TreeDirectory)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeFile(TreeEntry):
173
"""See TreeEntry. This is a regular file in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeFile)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeLink(TreeEntry):
184
"""See TreeEntry. This is a symlink in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeLink)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class WorkingTree(bzrlib.mutabletree.MutableTree):
195
"""Working copy tree.
197
The inventory is held in the `Branch` working-inventory, and the
198
files are in a directory on disk.
200
It is possible for a `WorkingTree` to have a filename which is
201
not listed in the Inventory and vice versa.
204
def __init__(self, basedir='.',
205
branch=DEPRECATED_PARAMETER,
211
"""Construct a WorkingTree instance. This is not a public API.
213
:param branch: A branch to override probing for the branch.
215
self._format = _format
216
self.bzrdir = _bzrdir
218
raise errors.BzrError("Please use bzrdir.open_workingtree or "
219
"WorkingTree.open() to obtain a WorkingTree.")
220
assert isinstance(basedir, basestring), \
221
"base directory %r is not a string" % basedir
222
basedir = safe_unicode(basedir)
223
mutter("opening working tree %r", basedir)
224
if deprecated_passed(branch):
225
self._branch = branch
227
self._branch = self.bzrdir.open_branch()
228
self.basedir = realpath(basedir)
229
# if branch is at our basedir and is a format 6 or less
230
if isinstance(self._format, WorkingTreeFormat2):
231
# share control object
232
self._control_files = self.branch.control_files
234
# assume all other formats have their own control files.
235
assert isinstance(_control_files, LockableFiles), \
236
"_control_files must be a LockableFiles, not %r" \
238
self._control_files = _control_files
239
# update the whole cache up front and write to disk if anything changed;
240
# in the future we might want to do this more selectively
241
# two possible ways offer themselves : in self._unlock, write the cache
242
# if needed, or, when the cache sees a change, append it to the hash
243
# cache file, and have the parser take the most recent entry for a
245
wt_trans = self.bzrdir.get_workingtree_transport(None)
246
cache_filename = wt_trans.local_abspath('stat-cache')
247
self._hashcache = hashcache.HashCache(basedir, cache_filename,
248
self._control_files._file_mode)
251
# is this scan needed ? it makes things kinda slow.
258
if _inventory is None:
259
self._inventory_is_modified = False
260
self.read_working_inventory()
262
# the caller of __init__ has provided an inventory,
263
# we assume they know what they are doing - as its only
264
# the Format factory and creation methods that are
265
# permitted to do this.
266
self._set_inventory(_inventory, dirty=False)
269
fget=lambda self: self._branch,
270
doc="""The branch this WorkingTree is connected to.
272
This cannot be set - it is reflective of the actual disk structure
273
the working tree has been constructed from.
276
def break_lock(self):
277
"""Break a lock if one is present from another instance.
279
Uses the ui factory to ask for confirmation if the lock may be from
282
This will probe the repository for its lock as well.
284
self._control_files.break_lock()
285
self.branch.break_lock()
287
def requires_rich_root(self):
288
return self._format.requires_rich_root
290
def supports_tree_reference(self):
293
def _set_inventory(self, inv, dirty):
294
"""Set the internal cached inventory.
296
:param inv: The inventory to set.
297
:param dirty: A boolean indicating whether the inventory is the same
298
logical inventory as whats on disk. If True the inventory is not
299
the same and should be written to disk or data will be lost, if
300
False then the inventory is the same as that on disk and any
301
serialisation would be unneeded overhead.
303
assert inv.root is not None
304
self._inventory = inv
305
self._inventory_is_modified = dirty
308
def open(path=None, _unsupported=False):
309
"""Open an existing working tree at path.
313
path = os.path.getcwdu()
314
control = bzrdir.BzrDir.open(path, _unsupported)
315
return control.open_workingtree(_unsupported)
318
def open_containing(path=None):
319
"""Open an existing working tree which has its root about path.
321
This probes for a working tree at path and searches upwards from there.
323
Basically we keep looking up until we find the control directory or
324
run into /. If there isn't one, raises NotBranchError.
325
TODO: give this a new exception.
326
If there is one, it is returned, along with the unused portion of path.
328
:return: The WorkingTree that contains 'path', and the rest of path
331
path = osutils.getcwd()
332
control, relpath = bzrdir.BzrDir.open_containing(path)
334
return control.open_workingtree(), relpath
337
def open_downlevel(path=None):
338
"""Open an unsupported working tree.
340
Only intended for advanced situations like upgrading part of a bzrdir.
342
return WorkingTree.open(path, _unsupported=True)
344
# should be deprecated - this is slow and in any case treating them as a
345
# container is (we now know) bad style -- mbp 20070302
346
## @deprecated_method(zero_fifteen)
348
"""Iterate through file_ids for this tree.
350
file_ids are in a WorkingTree if they are in the working inventory
351
and the working file exists.
353
inv = self._inventory
354
for path, ie in inv.iter_entries():
355
if osutils.lexists(self.abspath(path)):
359
return "<%s of %s>" % (self.__class__.__name__,
360
getattr(self, 'basedir', None))
362
def abspath(self, filename):
363
return pathjoin(self.basedir, filename)
365
def basis_tree(self):
366
"""Return RevisionTree for the current last revision.
368
If the left most parent is a ghost then the returned tree will be an
369
empty tree - one obtained by calling repository.revision_tree(None).
372
revision_id = self.get_parent_ids()[0]
374
# no parents, return an empty revision tree.
375
# in the future this should return the tree for
376
# 'empty:' - the implicit root empty tree.
377
return self.branch.repository.revision_tree(None)
379
return self.revision_tree(revision_id)
380
except errors.NoSuchRevision:
382
# No cached copy available, retrieve from the repository.
383
# FIXME? RBC 20060403 should we cache the inventory locally
386
return self.branch.repository.revision_tree(revision_id)
387
except errors.RevisionNotPresent:
388
# the basis tree *may* be a ghost or a low level error may have
389
# occured. If the revision is present, its a problem, if its not
391
if self.branch.repository.has_revision(revision_id):
393
# the basis tree is a ghost so return an empty tree.
394
return self.branch.repository.revision_tree(None)
397
@deprecated_method(zero_eight)
398
def create(branch, directory):
399
"""Create a workingtree for branch at directory.
401
If existing_directory already exists it must have a .bzr directory.
402
If it does not exist, it will be created.
404
This returns a new WorkingTree object for the new checkout.
406
TODO FIXME RBC 20060124 when we have checkout formats in place this
407
should accept an optional revisionid to checkout [and reject this if
408
checking out into the same dir as a pre-checkout-aware branch format.]
410
XXX: When BzrDir is present, these should be created through that
413
warnings.warn('delete WorkingTree.create', stacklevel=3)
414
transport = get_transport(directory)
415
if branch.bzrdir.root_transport.base == transport.base:
417
return branch.bzrdir.create_workingtree()
418
# different directory,
419
# create a branch reference
420
# and now a working tree.
421
raise NotImplementedError
424
@deprecated_method(zero_eight)
425
def create_standalone(directory):
426
"""Create a checkout and a branch and a repo at directory.
428
Directory must exist and be empty.
430
please use BzrDir.create_standalone_workingtree
432
return bzrdir.BzrDir.create_standalone_workingtree(directory)
434
def relpath(self, path):
435
"""Return the local path portion from a given path.
437
The path may be absolute or relative. If its a relative path it is
438
interpreted relative to the python current working directory.
440
return osutils.relpath(self.basedir, path)
442
def has_filename(self, filename):
443
return osutils.lexists(self.abspath(filename))
445
def get_file(self, file_id):
446
file_id = osutils.safe_file_id(file_id)
447
return self.get_file_byname(self.id2path(file_id))
449
def get_file_text(self, file_id):
450
file_id = osutils.safe_file_id(file_id)
451
return self.get_file(file_id).read()
453
def get_file_byname(self, filename):
454
return file(self.abspath(filename), 'rb')
457
def annotate_iter(self, file_id):
458
"""See Tree.annotate_iter
460
This implementation will use the basis tree implementation if possible.
461
Lines not in the basis are attributed to CURRENT_REVISION
463
If there are pending merges, lines added by those merges will be
464
incorrectly attributed to CURRENT_REVISION (but after committing, the
465
attribution will be correct).
467
file_id = osutils.safe_file_id(file_id)
468
basis = self.basis_tree()
471
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
472
require_versioned=True).next()
473
changed_content, kind = changes[2], changes[6]
474
if not changed_content:
475
return basis.annotate_iter(file_id)
479
if kind[0] != 'file':
482
old_lines = list(basis.annotate_iter(file_id))
484
for tree in self.branch.repository.revision_trees(
485
self.get_parent_ids()[1:]):
486
if file_id not in tree:
488
old.append(list(tree.annotate_iter(file_id)))
489
return annotate.reannotate(old, self.get_file(file_id).readlines(),
494
def get_parent_ids(self):
495
"""See Tree.get_parent_ids.
497
This implementation reads the pending merges list and last_revision
498
value and uses that to decide what the parents list should be.
500
last_rev = self._last_revision()
506
merges_file = self._control_files.get('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
512
parents.append(revision_id)
516
def get_root_id(self):
517
"""Return the id of this trees root"""
518
return self._inventory.root.file_id
520
def _get_store_filename(self, file_id):
521
## XXX: badly named; this is not in the store at all
522
file_id = osutils.safe_file_id(file_id)
523
return self.abspath(self.id2path(file_id))
526
def clone(self, to_bzrdir, revision_id=None, basis=None):
527
"""Duplicate this working tree into to_bzr, including all state.
529
Specifically modified files are kept as modified, but
530
ignored and unknown files are discarded.
532
If you want to make a new line of development, see bzrdir.sprout()
535
If not None, the cloned tree will have its last revision set to
536
revision, and and difference between the source trees last revision
537
and this one merged in.
540
If not None, a closer copy of a tree which may have some files in
541
common, and which file content should be preferentially copied from.
543
# assumes the target bzr dir format is compatible.
544
result = self._format.initialize(to_bzrdir)
545
self.copy_content_into(result, revision_id)
549
def copy_content_into(self, tree, revision_id=None):
550
"""Copy the current content and user files of this tree into tree."""
551
tree.set_root_id(self.get_root_id())
552
if revision_id is None:
553
merge.transform_tree(tree, self)
555
# TODO now merge from tree.last_revision to revision (to preserve
556
# user local changes)
557
merge.transform_tree(tree, self)
558
tree.set_parent_ids([revision_id])
560
def id2abspath(self, file_id):
561
file_id = osutils.safe_file_id(file_id)
562
return self.abspath(self.id2path(file_id))
564
def has_id(self, file_id):
565
# files that have been deleted are excluded
566
file_id = osutils.safe_file_id(file_id)
568
if not inv.has_id(file_id):
570
path = inv.id2path(file_id)
571
return osutils.lexists(self.abspath(path))
573
def has_or_had_id(self, file_id):
574
file_id = osutils.safe_file_id(file_id)
575
if file_id == self.inventory.root.file_id:
577
return self.inventory.has_id(file_id)
579
__contains__ = has_id
581
def get_file_size(self, file_id):
582
file_id = osutils.safe_file_id(file_id)
583
return os.path.getsize(self.id2abspath(file_id))
586
def get_file_sha1(self, file_id, path=None, stat_value=None):
587
file_id = osutils.safe_file_id(file_id)
589
path = self._inventory.id2path(file_id)
590
return self._hashcache.get_sha1(path, stat_value)
592
def get_file_mtime(self, file_id, path=None):
593
file_id = osutils.safe_file_id(file_id)
595
path = self.inventory.id2path(file_id)
596
return os.lstat(self.abspath(path)).st_mtime
598
if not supports_executable():
599
def is_executable(self, file_id, path=None):
600
file_id = osutils.safe_file_id(file_id)
601
return self._inventory[file_id].executable
603
def is_executable(self, file_id, path=None):
605
file_id = osutils.safe_file_id(file_id)
606
path = self.id2path(file_id)
607
mode = os.lstat(self.abspath(path)).st_mode
608
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
610
@needs_tree_write_lock
611
def _add(self, files, ids, kinds):
612
"""See MutableTree._add."""
613
# TODO: Re-adding a file that is removed in the working copy
614
# should probably put it back with the previous ID.
615
# the read and write working inventory should not occur in this
616
# function - they should be part of lock_write and unlock.
617
inv = self.read_working_inventory()
618
for f, file_id, kind in zip(files, ids, kinds):
619
assert kind is not None
621
inv.add_path(f, kind=kind)
623
file_id = osutils.safe_file_id(file_id)
624
inv.add_path(f, kind=kind, file_id=file_id)
625
self._write_inventory(inv)
627
@needs_tree_write_lock
628
def _gather_kinds(self, files, kinds):
629
"""See MutableTree._gather_kinds."""
630
for pos, f in enumerate(files):
631
if kinds[pos] is None:
632
fullpath = normpath(self.abspath(f))
634
kinds[pos] = file_kind(fullpath)
636
if e.errno == errno.ENOENT:
637
raise errors.NoSuchFile(fullpath)
640
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
641
"""Add revision_id as a parent.
643
This is equivalent to retrieving the current list of parent ids
644
and setting the list to its value plus revision_id.
646
:param revision_id: The revision id to add to the parent list. It may
647
be a ghost revision as long as its not the first parent to be added,
648
or the allow_leftmost_as_ghost parameter is set True.
649
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
651
parents = self.get_parent_ids() + [revision_id]
652
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
653
or allow_leftmost_as_ghost)
655
@needs_tree_write_lock
656
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
657
"""Add revision_id, tree tuple as a parent.
659
This is equivalent to retrieving the current list of parent trees
660
and setting the list to its value plus parent_tuple. See also
661
add_parent_tree_id - if you only have a parent id available it will be
662
simpler to use that api. If you have the parent already available, using
663
this api is preferred.
665
:param parent_tuple: The (revision id, tree) to add to the parent list.
666
If the revision_id is a ghost, pass None for the tree.
667
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
669
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
670
if len(parent_ids) > 1:
671
# the leftmost may have already been a ghost, preserve that if it
673
allow_leftmost_as_ghost = True
674
self.set_parent_ids(parent_ids,
675
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
677
@needs_tree_write_lock
678
def add_pending_merge(self, *revision_ids):
679
# TODO: Perhaps should check at this point that the
680
# history of the revision is actually present?
681
parents = self.get_parent_ids()
683
for rev_id in revision_ids:
684
if rev_id in parents:
686
parents.append(rev_id)
689
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
691
@deprecated_method(zero_eleven)
693
def pending_merges(self):
694
"""Return a list of pending merges.
696
These are revisions that have been merged into the working
697
directory but not yet committed.
699
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
700
instead - which is available on all tree objects.
702
return self.get_parent_ids()[1:]
704
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
705
"""Common ghost checking functionality from set_parent_*.
707
This checks that the left hand-parent exists if there are any
710
if len(revision_ids) > 0:
711
leftmost_id = revision_ids[0]
712
if (not allow_leftmost_as_ghost and not
713
self.branch.repository.has_revision(leftmost_id)):
714
raise errors.GhostRevisionUnusableHere(leftmost_id)
716
def _set_merges_from_parent_ids(self, parent_ids):
717
merges = parent_ids[1:]
718
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
720
@needs_tree_write_lock
721
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
722
"""Set the parent ids to revision_ids.
724
See also set_parent_trees. This api will try to retrieve the tree data
725
for each element of revision_ids from the trees repository. If you have
726
tree data already available, it is more efficient to use
727
set_parent_trees rather than set_parent_ids. set_parent_ids is however
728
an easier API to use.
730
:param revision_ids: The revision_ids to set as the parent ids of this
731
working tree. Any of these may be ghosts.
733
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
734
self._check_parents_for_ghosts(revision_ids,
735
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
737
if len(revision_ids) > 0:
738
self.set_last_revision(revision_ids[0])
740
self.set_last_revision(None)
742
self._set_merges_from_parent_ids(revision_ids)
744
@needs_tree_write_lock
745
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
746
"""See MutableTree.set_parent_trees."""
747
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
749
self._check_parents_for_ghosts(parent_ids,
750
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
752
if len(parent_ids) == 0:
753
leftmost_parent_id = None
754
leftmost_parent_tree = None
756
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
758
if self._change_last_revision(leftmost_parent_id):
759
if leftmost_parent_tree is None:
760
# If we don't have a tree, fall back to reading the
761
# parent tree from the repository.
762
self._cache_basis_inventory(leftmost_parent_id)
764
inv = leftmost_parent_tree.inventory
765
xml = self._create_basis_xml_from_inventory(
766
leftmost_parent_id, inv)
767
self._write_basis_inventory(xml)
768
self._set_merges_from_parent_ids(parent_ids)
770
@needs_tree_write_lock
771
def set_pending_merges(self, rev_list):
772
parents = self.get_parent_ids()
773
leftmost = parents[:1]
774
new_parents = leftmost + rev_list
775
self.set_parent_ids(new_parents)
777
@needs_tree_write_lock
778
def set_merge_modified(self, modified_hashes):
780
for file_id, hash in modified_hashes.iteritems():
781
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
782
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
784
def _put_rio(self, filename, stanzas, header):
785
self._must_be_locked()
786
my_file = rio_file(stanzas, header)
787
self._control_files.put(filename, my_file)
789
@needs_write_lock # because merge pulls data into the branch.
790
def merge_from_branch(self, branch, to_revision=None):
791
"""Merge from a branch into this working tree.
793
:param branch: The branch to merge from.
794
:param to_revision: If non-None, the merge will merge to to_revision,
795
but not beyond it. to_revision does not need to be in the history
796
of the branch when it is supplied. If None, to_revision defaults to
797
branch.last_revision().
799
from bzrlib.merge import Merger, Merge3Merger
800
pb = bzrlib.ui.ui_factory.nested_progress_bar()
802
merger = Merger(self.branch, this_tree=self, pb=pb)
803
merger.pp = ProgressPhase("Merge phase", 5, pb)
804
merger.pp.next_phase()
805
# check that there are no
807
merger.check_basis(check_clean=True, require_commits=False)
808
if to_revision is None:
809
to_revision = branch.last_revision()
811
to_revision = osutils.safe_revision_id(to_revision)
812
merger.other_rev_id = to_revision
813
if merger.other_rev_id is None:
814
raise error.NoCommits(branch)
815
self.branch.fetch(branch, last_revision=merger.other_rev_id)
816
merger.other_basis = merger.other_rev_id
817
merger.other_tree = self.branch.repository.revision_tree(
819
merger.other_branch = branch
820
merger.pp.next_phase()
822
if merger.base_rev_id == merger.other_rev_id:
823
raise errors.PointlessMerge
824
merger.backup_files = False
825
merger.merge_type = Merge3Merger
826
merger.set_interesting_files(None)
827
merger.show_base = False
828
merger.reprocess = False
829
conflicts = merger.do_merge()
836
def merge_modified(self):
837
"""Return a dictionary of files modified by a merge.
839
The list is initialized by WorkingTree.set_merge_modified, which is
840
typically called after we make some automatic updates to the tree
843
This returns a map of file_id->sha1, containing only files which are
844
still in the working inventory and have that text hash.
847
hashfile = self._control_files.get('merge-hashes')
848
except errors.NoSuchFile:
852
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
853
raise errors.MergeModifiedFormatError()
854
except StopIteration:
855
raise errors.MergeModifiedFormatError()
856
for s in RioReader(hashfile):
857
# RioReader reads in Unicode, so convert file_ids back to utf8
858
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
859
if file_id not in self.inventory:
861
text_hash = s.get("hash")
862
if text_hash == self.get_file_sha1(file_id):
863
merge_hashes[file_id] = text_hash
867
def mkdir(self, path, file_id=None):
868
"""See MutableTree.mkdir()."""
870
file_id = generate_ids.gen_file_id(os.path.basename(path))
871
os.mkdir(self.abspath(path))
872
self.add(path, file_id, 'directory')
875
def get_symlink_target(self, file_id):
876
file_id = osutils.safe_file_id(file_id)
877
return os.readlink(self.id2abspath(file_id))
880
def subsume(self, other_tree):
881
def add_children(inventory, entry):
882
for child_entry in entry.children.values():
883
inventory._byid[child_entry.file_id] = child_entry
884
if child_entry.kind == 'directory':
885
add_children(inventory, child_entry)
886
if other_tree.get_root_id() == self.get_root_id():
887
raise errors.BadSubsumeSource(self, other_tree,
888
'Trees have the same root')
890
other_tree_path = self.relpath(other_tree.basedir)
891
except errors.PathNotChild:
892
raise errors.BadSubsumeSource(self, other_tree,
893
'Tree is not contained by the other')
894
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
895
if new_root_parent is None:
896
raise errors.BadSubsumeSource(self, other_tree,
897
'Parent directory is not versioned.')
898
# We need to ensure that the result of a fetch will have a
899
# versionedfile for the other_tree root, and only fetching into
900
# RepositoryKnit2 guarantees that.
901
if not self.branch.repository.supports_rich_root():
902
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
903
other_tree.lock_tree_write()
905
new_parents = other_tree.get_parent_ids()
906
other_root = other_tree.inventory.root
907
other_root.parent_id = new_root_parent
908
other_root.name = osutils.basename(other_tree_path)
909
self.inventory.add(other_root)
910
add_children(self.inventory, other_root)
911
self._write_inventory(self.inventory)
912
# normally we don't want to fetch whole repositories, but i think
913
# here we really do want to consolidate the whole thing.
914
for parent_id in other_tree.get_parent_ids():
915
self.branch.fetch(other_tree.branch, parent_id)
916
self.add_parent_tree_id(parent_id)
919
other_tree.bzrdir.retire_bzrdir()
921
@needs_tree_write_lock
922
def extract(self, file_id, format=None):
923
"""Extract a subtree from this tree.
925
A new branch will be created, relative to the path for this tree.
929
segments = osutils.splitpath(path)
930
transport = self.branch.bzrdir.root_transport
931
for name in segments:
932
transport = transport.clone(name)
935
except errors.FileExists:
939
sub_path = self.id2path(file_id)
940
branch_transport = mkdirs(sub_path)
942
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
944
branch_transport.mkdir('.')
945
except errors.FileExists:
947
branch_bzrdir = format.initialize_on_transport(branch_transport)
949
repo = branch_bzrdir.find_repository()
950
except errors.NoRepositoryPresent:
951
repo = branch_bzrdir.create_repository()
952
assert repo.supports_rich_root()
954
if not repo.supports_rich_root():
955
raise errors.RootNotRich()
956
new_branch = branch_bzrdir.create_branch()
957
new_branch.pull(self.branch)
958
for parent_id in self.get_parent_ids():
959
new_branch.fetch(self.branch, parent_id)
960
tree_transport = self.bzrdir.root_transport.clone(sub_path)
961
if tree_transport.base != branch_transport.base:
962
tree_bzrdir = format.initialize_on_transport(tree_transport)
963
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
965
tree_bzrdir = branch_bzrdir
966
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
967
wt.set_parent_ids(self.get_parent_ids())
968
my_inv = self.inventory
969
child_inv = Inventory(root_id=None)
970
new_root = my_inv[file_id]
971
my_inv.remove_recursive_id(file_id)
972
new_root.parent_id = None
973
child_inv.add(new_root)
974
self._write_inventory(my_inv)
975
wt._write_inventory(child_inv)
978
def _serialize(self, inventory, out_file):
979
xml5.serializer_v5.write_inventory(self._inventory, out_file)
981
def _deserialize(selt, in_file):
982
return xml5.serializer_v5.read_inventory(in_file)
985
"""Write the in memory inventory to disk."""
986
# TODO: Maybe this should only write on dirty ?
987
if self._control_files._lock_mode != 'w':
988
raise errors.NotWriteLocked(self)
990
self._serialize(self._inventory, sio)
992
self._control_files.put('inventory', sio)
993
self._inventory_is_modified = False
995
def _kind(self, relpath):
996
return osutils.file_kind(self.abspath(relpath))
998
def list_files(self, include_root=False):
999
"""Recursively list all files as (path, class, kind, id, entry).
1001
Lists, but does not descend into unversioned directories.
1003
This does not include files that have been deleted in this
1006
Skips the control directory.
1008
# list_files is an iterator, so @needs_read_lock doesn't work properly
1009
# with it. So callers should be careful to always read_lock the tree.
1010
if not self.is_locked():
1011
raise errors.ObjectNotLocked(self)
1013
inv = self.inventory
1014
if include_root is True:
1015
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1016
# Convert these into local objects to save lookup times
1017
pathjoin = osutils.pathjoin
1018
file_kind = self._kind
1020
# transport.base ends in a slash, we want the piece
1021
# between the last two slashes
1022
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1024
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1026
# directory file_id, relative path, absolute path, reverse sorted children
1027
children = os.listdir(self.basedir)
1029
# jam 20060527 The kernel sized tree seems equivalent whether we
1030
# use a deque and popleft to keep them sorted, or if we use a plain
1031
# list and just reverse() them.
1032
children = collections.deque(children)
1033
stack = [(inv.root.file_id, u'', self.basedir, children)]
1035
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1038
f = children.popleft()
1039
## TODO: If we find a subdirectory with its own .bzr
1040
## directory, then that is a separate tree and we
1041
## should exclude it.
1043
# the bzrdir for this tree
1044
if transport_base_dir == f:
1047
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1048
# and 'f' doesn't begin with one, we can do a string op, rather
1049
# than the checks of pathjoin(), all relative paths will have an extra slash
1051
fp = from_dir_relpath + '/' + f
1054
fap = from_dir_abspath + '/' + f
1056
f_ie = inv.get_child(from_dir_id, f)
1059
elif self.is_ignored(fp[1:]):
1062
# we may not have found this file, because of a unicode issue
1063
f_norm, can_access = osutils.normalized_filename(f)
1064
if f == f_norm or not can_access:
1065
# No change, so treat this file normally
1068
# this file can be accessed by a normalized path
1069
# check again if it is versioned
1070
# these lines are repeated here for performance
1072
fp = from_dir_relpath + '/' + f
1073
fap = from_dir_abspath + '/' + f
1074
f_ie = inv.get_child(from_dir_id, f)
1077
elif self.is_ignored(fp[1:]):
1084
# make a last minute entry
1086
yield fp[1:], c, fk, f_ie.file_id, f_ie
1089
yield fp[1:], c, fk, None, fk_entries[fk]()
1091
yield fp[1:], c, fk, None, TreeEntry()
1094
if fk != 'directory':
1097
# But do this child first
1098
new_children = os.listdir(fap)
1100
new_children = collections.deque(new_children)
1101
stack.append((f_ie.file_id, fp, fap, new_children))
1102
# Break out of inner loop,
1103
# so that we start outer loop with child
1106
# if we finished all children, pop it off the stack
1109
@needs_tree_write_lock
1110
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1113
to_dir must exist in the inventory.
1115
If to_dir exists and is a directory, the files are moved into
1116
it, keeping their old names.
1118
Note that to_dir is only the last component of the new name;
1119
this doesn't change the directory.
1121
For each entry in from_paths the move mode will be determined
1124
The first mode moves the file in the filesystem and updates the
1125
inventory. The second mode only updates the inventory without
1126
touching the file on the filesystem. This is the new mode introduced
1129
move uses the second mode if 'after == True' and the target is not
1130
versioned but present in the working tree.
1132
move uses the second mode if 'after == False' and the source is
1133
versioned but no longer in the working tree, and the target is not
1134
versioned but present in the working tree.
1136
move uses the first mode if 'after == False' and the source is
1137
versioned and present in the working tree, and the target is not
1138
versioned and not present in the working tree.
1140
Everything else results in an error.
1142
This returns a list of (from_path, to_path) pairs for each
1143
entry that is moved.
1148
# check for deprecated use of signature
1150
to_dir = kwargs.get('to_name', None)
1152
raise TypeError('You must supply a target directory')
1154
symbol_versioning.warn('The parameter to_name was deprecated'
1155
' in version 0.13. Use to_dir instead',
1158
# check destination directory
1159
assert not isinstance(from_paths, basestring)
1160
inv = self.inventory
1161
to_abs = self.abspath(to_dir)
1162
if not isdir(to_abs):
1163
raise errors.BzrMoveFailedError('',to_dir,
1164
errors.NotADirectory(to_abs))
1165
if not self.has_filename(to_dir):
1166
raise errors.BzrMoveFailedError('',to_dir,
1167
errors.NotInWorkingDirectory(to_dir))
1168
to_dir_id = inv.path2id(to_dir)
1169
if to_dir_id is None:
1170
raise errors.BzrMoveFailedError('',to_dir,
1171
errors.NotVersionedError(path=str(to_dir)))
1173
to_dir_ie = inv[to_dir_id]
1174
if to_dir_ie.kind != 'directory':
1175
raise errors.BzrMoveFailedError('',to_dir,
1176
errors.NotADirectory(to_abs))
1178
# create rename entries and tuples
1179
for from_rel in from_paths:
1180
from_tail = splitpath(from_rel)[-1]
1181
from_id = inv.path2id(from_rel)
1183
raise errors.BzrMoveFailedError(from_rel,to_dir,
1184
errors.NotVersionedError(path=str(from_rel)))
1186
from_entry = inv[from_id]
1187
from_parent_id = from_entry.parent_id
1188
to_rel = pathjoin(to_dir, from_tail)
1189
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1191
from_tail=from_tail,
1192
from_parent_id=from_parent_id,
1193
to_rel=to_rel, to_tail=from_tail,
1194
to_parent_id=to_dir_id)
1195
rename_entries.append(rename_entry)
1196
rename_tuples.append((from_rel, to_rel))
1198
# determine which move mode to use. checks also for movability
1199
rename_entries = self._determine_mv_mode(rename_entries, after)
1201
original_modified = self._inventory_is_modified
1204
self._inventory_is_modified = True
1205
self._move(rename_entries)
1207
# restore the inventory on error
1208
self._inventory_is_modified = original_modified
1210
self._write_inventory(inv)
1211
return rename_tuples
1213
def _determine_mv_mode(self, rename_entries, after=False):
1214
"""Determines for each from-to pair if both inventory and working tree
1215
or only the inventory has to be changed.
1217
Also does basic plausability tests.
1219
inv = self.inventory
1221
for rename_entry in rename_entries:
1222
# store to local variables for easier reference
1223
from_rel = rename_entry.from_rel
1224
from_id = rename_entry.from_id
1225
to_rel = rename_entry.to_rel
1226
to_id = inv.path2id(to_rel)
1227
only_change_inv = False
1229
# check the inventory for source and destination
1231
raise errors.BzrMoveFailedError(from_rel,to_rel,
1232
errors.NotVersionedError(path=str(from_rel)))
1233
if to_id is not None:
1234
raise errors.BzrMoveFailedError(from_rel,to_rel,
1235
errors.AlreadyVersionedError(path=str(to_rel)))
1237
# try to determine the mode for rename (only change inv or change
1238
# inv and file system)
1240
if not self.has_filename(to_rel):
1241
raise errors.BzrMoveFailedError(from_id,to_rel,
1242
errors.NoSuchFile(path=str(to_rel),
1243
extra="New file has not been created yet"))
1244
only_change_inv = True
1245
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1246
only_change_inv = True
1247
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1248
only_change_inv = False
1250
# something is wrong, so lets determine what exactly
1251
if not self.has_filename(from_rel) and \
1252
not self.has_filename(to_rel):
1253
raise errors.BzrRenameFailedError(from_rel,to_rel,
1254
errors.PathsDoNotExist(paths=(str(from_rel),
1257
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1258
extra="(Use --after to update the Bazaar id)")
1259
rename_entry.only_change_inv = only_change_inv
1260
return rename_entries
1262
def _move(self, rename_entries):
1263
"""Moves a list of files.
1265
Depending on the value of the flag 'only_change_inv', the
1266
file will be moved on the file system or not.
1268
inv = self.inventory
1271
for entry in rename_entries:
1273
self._move_entry(entry)
1275
self._rollback_move(moved)
1279
def _rollback_move(self, moved):
1280
"""Try to rollback a previous move in case of an filesystem error."""
1281
inv = self.inventory
1284
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1285
entry.to_tail, entry.to_parent_id, entry.from_rel,
1286
entry.from_tail, entry.from_parent_id,
1287
entry.only_change_inv))
1288
except errors.BzrMoveFailedError, e:
1289
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1290
" The working tree is in an inconsistent state."
1291
" Please consider doing a 'bzr revert'."
1292
" Error message is: %s" % e)
1294
def _move_entry(self, entry):
1295
inv = self.inventory
1296
from_rel_abs = self.abspath(entry.from_rel)
1297
to_rel_abs = self.abspath(entry.to_rel)
1298
if from_rel_abs == to_rel_abs:
1299
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1300
"Source and target are identical.")
1302
if not entry.only_change_inv:
1304
osutils.rename(from_rel_abs, to_rel_abs)
1306
raise errors.BzrMoveFailedError(entry.from_rel,
1308
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1310
@needs_tree_write_lock
1311
def rename_one(self, from_rel, to_rel, after=False):
1314
This can change the directory or the filename or both.
1316
rename_one has several 'modes' to work. First, it can rename a physical
1317
file and change the file_id. That is the normal mode. Second, it can
1318
only change the file_id without touching any physical file. This is
1319
the new mode introduced in version 0.15.
1321
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1322
versioned but present in the working tree.
1324
rename_one uses the second mode if 'after == False' and 'from_rel' is
1325
versioned but no longer in the working tree, and 'to_rel' is not
1326
versioned but present in the working tree.
1328
rename_one uses the first mode if 'after == False' and 'from_rel' is
1329
versioned and present in the working tree, and 'to_rel' is not
1330
versioned and not present in the working tree.
1332
Everything else results in an error.
1334
inv = self.inventory
1337
# create rename entries and tuples
1338
from_tail = splitpath(from_rel)[-1]
1339
from_id = inv.path2id(from_rel)
1341
raise errors.BzrRenameFailedError(from_rel,to_rel,
1342
errors.NotVersionedError(path=str(from_rel)))
1343
from_entry = inv[from_id]
1344
from_parent_id = from_entry.parent_id
1345
to_dir, to_tail = os.path.split(to_rel)
1346
to_dir_id = inv.path2id(to_dir)
1347
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1349
from_tail=from_tail,
1350
from_parent_id=from_parent_id,
1351
to_rel=to_rel, to_tail=to_tail,
1352
to_parent_id=to_dir_id)
1353
rename_entries.append(rename_entry)
1355
# determine which move mode to use. checks also for movability
1356
rename_entries = self._determine_mv_mode(rename_entries, after)
1358
# check if the target changed directory and if the target directory is
1360
if to_dir_id is None:
1361
raise errors.BzrMoveFailedError(from_rel,to_rel,
1362
errors.NotVersionedError(path=str(to_dir)))
1364
# all checks done. now we can continue with our actual work
1365
mutter('rename_one:\n'
1370
' to_dir_id {%s}\n',
1371
from_id, from_rel, to_rel, to_dir, to_dir_id)
1373
self._move(rename_entries)
1374
self._write_inventory(inv)
1376
class _RenameEntry(object):
1377
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1378
to_rel, to_tail, to_parent_id, only_change_inv=False):
1379
self.from_rel = from_rel
1380
self.from_id = from_id
1381
self.from_tail = from_tail
1382
self.from_parent_id = from_parent_id
1383
self.to_rel = to_rel
1384
self.to_tail = to_tail
1385
self.to_parent_id = to_parent_id
1386
self.only_change_inv = only_change_inv
1390
"""Return all unknown files.
1392
These are files in the working directory that are not versioned or
1393
control files or ignored.
1395
# force the extras method to be fully executed before returning, to
1396
# prevent race conditions with the lock
1398
[subp for subp in self.extras() if not self.is_ignored(subp)])
1400
@needs_tree_write_lock
1401
def unversion(self, file_ids):
1402
"""Remove the file ids in file_ids from the current versioned set.
1404
When a file_id is unversioned, all of its children are automatically
1407
:param file_ids: The file ids to stop versioning.
1408
:raises: NoSuchId if any fileid is not currently versioned.
1410
for file_id in file_ids:
1411
file_id = osutils.safe_file_id(file_id)
1412
if self._inventory.has_id(file_id):
1413
self._inventory.remove_recursive_id(file_id)
1415
raise errors.NoSuchId(self, file_id)
1417
# in the future this should just set a dirty bit to wait for the
1418
# final unlock. However, until all methods of workingtree start
1419
# with the current in -memory inventory rather than triggering
1420
# a read, it is more complex - we need to teach read_inventory
1421
# to know when to read, and when to not read first... and possibly
1422
# to save first when the in memory one may be corrupted.
1423
# so for now, we just only write it if it is indeed dirty.
1425
self._write_inventory(self._inventory)
1427
@deprecated_method(zero_eight)
1428
def iter_conflicts(self):
1429
"""List all files in the tree that have text or content conflicts.
1430
DEPRECATED. Use conflicts instead."""
1431
return self._iter_conflicts()
1433
def _iter_conflicts(self):
1435
for info in self.list_files():
1437
stem = get_conflicted_stem(path)
1440
if stem not in conflicted:
1441
conflicted.add(stem)
1445
def pull(self, source, overwrite=False, stop_revision=None,
1446
change_reporter=None):
1447
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1450
pp = ProgressPhase("Pull phase", 2, top_pb)
1452
old_revision_info = self.branch.last_revision_info()
1453
basis_tree = self.basis_tree()
1454
count = self.branch.pull(source, overwrite, stop_revision)
1455
new_revision_info = self.branch.last_revision_info()
1456
if new_revision_info != old_revision_info:
1458
repository = self.branch.repository
1459
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1460
basis_tree.lock_read()
1462
new_basis_tree = self.branch.basis_tree()
1469
change_reporter=change_reporter)
1470
if (basis_tree.inventory.root is None and
1471
new_basis_tree.inventory.root is not None):
1472
self.set_root_id(new_basis_tree.inventory.root.file_id)
1476
# TODO - dedup parents list with things merged by pull ?
1477
# reuse the revisiontree we merged against to set the new
1479
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1480
# we have to pull the merge trees out again, because
1481
# merge_inner has set the ids. - this corner is not yet
1482
# layered well enough to prevent double handling.
1483
# XXX TODO: Fix the double handling: telling the tree about
1484
# the already known parent data is wasteful.
1485
merges = self.get_parent_ids()[1:]
1486
parent_trees.extend([
1487
(parent, repository.revision_tree(parent)) for
1489
self.set_parent_trees(parent_trees)
1496
def put_file_bytes_non_atomic(self, file_id, bytes):
1497
"""See MutableTree.put_file_bytes_non_atomic."""
1498
file_id = osutils.safe_file_id(file_id)
1499
stream = file(self.id2abspath(file_id), 'wb')
1504
# TODO: update the hashcache here ?
1507
"""Yield all unversioned files in this WorkingTree.
1509
If there are any unversioned directories then only the directory is
1510
returned, not all its children. But if there are unversioned files
1511
under a versioned subdirectory, they are returned.
1513
Currently returned depth-first, sorted by name within directories.
1514
This is the same order used by 'osutils.walkdirs'.
1516
## TODO: Work from given directory downwards
1517
for path, dir_entry in self.inventory.directories():
1518
# mutter("search for unknowns in %r", path)
1519
dirabs = self.abspath(path)
1520
if not isdir(dirabs):
1521
# e.g. directory deleted
1525
for subf in os.listdir(dirabs):
1528
if subf not in dir_entry.children:
1529
subf_norm, can_access = osutils.normalized_filename(subf)
1530
if subf_norm != subf and can_access:
1531
if subf_norm not in dir_entry.children:
1532
fl.append(subf_norm)
1538
subp = pathjoin(path, subf)
1541
def ignored_files(self):
1542
"""Yield list of PATH, IGNORE_PATTERN"""
1543
for subp in self.extras():
1544
pat = self.is_ignored(subp)
1548
def get_ignore_list(self):
1549
"""Return list of ignore patterns.
1551
Cached in the Tree object after the first call.
1553
ignoreset = getattr(self, '_ignoreset', None)
1554
if ignoreset is not None:
1557
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1558
ignore_globs.update(ignores.get_runtime_ignores())
1559
ignore_globs.update(ignores.get_user_ignores())
1560
if self.has_filename(bzrlib.IGNORE_FILENAME):
1561
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1563
ignore_globs.update(ignores.parse_ignore_file(f))
1566
self._ignoreset = ignore_globs
1569
def _flush_ignore_list_cache(self):
1570
"""Resets the cached ignore list to force a cache rebuild."""
1571
self._ignoreset = None
1572
self._ignoreglobster = None
1574
def is_ignored(self, filename):
1575
r"""Check whether the filename matches an ignore pattern.
1577
Patterns containing '/' or '\' need to match the whole path;
1578
others match against only the last component.
1580
If the file is ignored, returns the pattern which caused it to
1581
be ignored, otherwise None. So this can simply be used as a
1582
boolean if desired."""
1583
if getattr(self, '_ignoreglobster', None) is None:
1584
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1585
return self._ignoreglobster.match(filename)
1587
def kind(self, file_id):
1588
return file_kind(self.id2abspath(file_id))
1590
def _comparison_data(self, entry, path):
1591
abspath = self.abspath(path)
1593
stat_value = os.lstat(abspath)
1595
if getattr(e, 'errno', None) == errno.ENOENT:
1602
mode = stat_value.st_mode
1603
kind = osutils.file_kind_from_stat_mode(mode)
1604
if not supports_executable():
1605
executable = entry.executable
1607
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1608
return kind, executable, stat_value
1610
def _file_size(self, entry, stat_value):
1611
return stat_value.st_size
1613
def last_revision(self):
1614
"""Return the last revision of the branch for this tree.
1616
This format tree does not support a separate marker for last-revision
1617
compared to the branch.
1619
See MutableTree.last_revision
1621
return self._last_revision()
1624
def _last_revision(self):
1625
"""helper for get_parent_ids."""
1626
return self.branch.last_revision()
1628
def is_locked(self):
1629
return self._control_files.is_locked()
1631
def _must_be_locked(self):
1632
if not self.is_locked():
1633
raise errors.ObjectNotLocked(self)
1635
def lock_read(self):
1636
"""See Branch.lock_read, and WorkingTree.unlock."""
1637
if not self.is_locked():
1639
self.branch.lock_read()
1641
return self._control_files.lock_read()
1643
self.branch.unlock()
1646
def lock_tree_write(self):
1647
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1648
if not self.is_locked():
1650
self.branch.lock_read()
1652
return self._control_files.lock_write()
1654
self.branch.unlock()
1657
def lock_write(self):
1658
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1659
if not self.is_locked():
1661
self.branch.lock_write()
1663
return self._control_files.lock_write()
1665
self.branch.unlock()
1668
def get_physical_lock_status(self):
1669
return self._control_files.get_physical_lock_status()
1671
def _basis_inventory_name(self):
1672
return 'basis-inventory-cache'
1674
def _reset_data(self):
1675
"""Reset transient data that cannot be revalidated."""
1676
self._inventory_is_modified = False
1677
result = self._deserialize(self._control_files.get('inventory'))
1678
self._set_inventory(result, dirty=False)
1680
@needs_tree_write_lock
1681
def set_last_revision(self, new_revision):
1682
"""Change the last revision in the working tree."""
1683
new_revision = osutils.safe_revision_id(new_revision)
1684
if self._change_last_revision(new_revision):
1685
self._cache_basis_inventory(new_revision)
1687
def _change_last_revision(self, new_revision):
1688
"""Template method part of set_last_revision to perform the change.
1690
This is used to allow WorkingTree3 instances to not affect branch
1691
when their last revision is set.
1693
if new_revision is None:
1694
self.branch.set_revision_history([])
1697
self.branch.generate_revision_history(new_revision)
1698
except errors.NoSuchRevision:
1699
# not present in the repo - dont try to set it deeper than the tip
1700
self.branch.set_revision_history([new_revision])
1703
def _write_basis_inventory(self, xml):
1704
"""Write the basis inventory XML to the basis-inventory file"""
1705
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1706
path = self._basis_inventory_name()
1708
self._control_files.put(path, sio)
1710
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1711
"""Create the text that will be saved in basis-inventory"""
1712
# TODO: jam 20070209 This should be redundant, as the revision_id
1713
# as all callers should have already converted the revision_id to
1715
inventory.revision_id = osutils.safe_revision_id(revision_id)
1716
return xml7.serializer_v7.write_inventory_to_string(inventory)
1718
def _cache_basis_inventory(self, new_revision):
1719
"""Cache new_revision as the basis inventory."""
1720
# TODO: this should allow the ready-to-use inventory to be passed in,
1721
# as commit already has that ready-to-use [while the format is the
1724
# this double handles the inventory - unpack and repack -
1725
# but is easier to understand. We can/should put a conditional
1726
# in here based on whether the inventory is in the latest format
1727
# - perhaps we should repack all inventories on a repository
1729
# the fast path is to copy the raw xml from the repository. If the
1730
# xml contains 'revision_id="', then we assume the right
1731
# revision_id is set. We must check for this full string, because a
1732
# root node id can legitimately look like 'revision_id' but cannot
1734
xml = self.branch.repository.get_inventory_xml(new_revision)
1735
firstline = xml.split('\n', 1)[0]
1736
if (not 'revision_id="' in firstline or
1737
'format="7"' not in firstline):
1738
inv = self.branch.repository.deserialise_inventory(
1740
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1741
self._write_basis_inventory(xml)
1742
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1745
def read_basis_inventory(self):
1746
"""Read the cached basis inventory."""
1747
path = self._basis_inventory_name()
1748
return self._control_files.get(path).read()
1751
def read_working_inventory(self):
1752
"""Read the working inventory.
1754
:raises errors.InventoryModified: read_working_inventory will fail
1755
when the current in memory inventory has been modified.
1757
# conceptually this should be an implementation detail of the tree.
1758
# XXX: Deprecate this.
1759
# ElementTree does its own conversion from UTF-8, so open in
1761
if self._inventory_is_modified:
1762
raise errors.InventoryModified(self)
1763
result = self._deserialize(self._control_files.get('inventory'))
1764
self._set_inventory(result, dirty=False)
1767
@needs_tree_write_lock
1768
def remove(self, files, verbose=False, to_file=None):
1769
"""Remove nominated files from the working inventory..
1771
This does not remove their text. This does not run on XXX on what? RBC
1773
TODO: Refuse to remove modified files unless --force is given?
1775
TODO: Do something useful with directories.
1777
TODO: Should this remove the text or not? Tough call; not
1778
removing may be useful and the user can just use use rm, and
1779
is the opposite of add. Removing it is consistent with most
1780
other tools. Maybe an option.
1782
## TODO: Normalize names
1783
## TODO: Remove nested loops; better scalability
1784
if isinstance(files, basestring):
1787
inv = self.inventory
1789
# do this before any modifications
1791
fid = inv.path2id(f)
1793
note("%s is not versioned."%f)
1796
# having remove it, it must be either ignored or unknown
1797
if self.is_ignored(f):
1801
textui.show_status(new_status, inv[fid].kind, f,
1805
self._write_inventory(inv)
1807
@needs_tree_write_lock
1808
def revert(self, filenames, old_tree=None, backups=True,
1809
pb=DummyProgress(), report_changes=False):
1810
from bzrlib.conflicts import resolve
1811
if old_tree is None:
1812
old_tree = self.basis_tree()
1813
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1815
if not len(filenames):
1816
self.set_parent_ids(self.get_parent_ids()[:1])
1819
resolve(self, filenames, ignore_misses=True)
1822
def revision_tree(self, revision_id):
1823
"""See Tree.revision_tree.
1825
WorkingTree can supply revision_trees for the basis revision only
1826
because there is only one cached inventory in the bzr directory.
1828
if revision_id == self.last_revision():
1830
xml = self.read_basis_inventory()
1831
except errors.NoSuchFile:
1835
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1836
# dont use the repository revision_tree api because we want
1837
# to supply the inventory.
1838
if inv.revision_id == revision_id:
1839
return revisiontree.RevisionTree(self.branch.repository,
1841
except errors.BadInventoryFormat:
1843
# raise if there was no inventory, or if we read the wrong inventory.
1844
raise errors.NoSuchRevisionInTree(self, revision_id)
1846
# XXX: This method should be deprecated in favour of taking in a proper
1847
# new Inventory object.
1848
@needs_tree_write_lock
1849
def set_inventory(self, new_inventory_list):
1850
from bzrlib.inventory import (Inventory,
1855
inv = Inventory(self.get_root_id())
1856
for path, file_id, parent, kind in new_inventory_list:
1857
name = os.path.basename(path)
1860
# fixme, there should be a factory function inv,add_??
1861
if kind == 'directory':
1862
inv.add(InventoryDirectory(file_id, name, parent))
1863
elif kind == 'file':
1864
inv.add(InventoryFile(file_id, name, parent))
1865
elif kind == 'symlink':
1866
inv.add(InventoryLink(file_id, name, parent))
1868
raise errors.BzrError("unknown kind %r" % kind)
1869
self._write_inventory(inv)
1871
@needs_tree_write_lock
1872
def set_root_id(self, file_id):
1873
"""Set the root id for this tree."""
1876
symbol_versioning.warn(symbol_versioning.zero_twelve
1877
% 'WorkingTree.set_root_id with fileid=None',
1882
file_id = osutils.safe_file_id(file_id)
1883
self._set_root_id(file_id)
1885
def _set_root_id(self, file_id):
1886
"""Set the root id for this tree, in a format specific manner.
1888
:param file_id: The file id to assign to the root. It must not be
1889
present in the current inventory or an error will occur. It must
1890
not be None, but rather a valid file id.
1892
inv = self._inventory
1893
orig_root_id = inv.root.file_id
1894
# TODO: it might be nice to exit early if there was nothing
1895
# to do, saving us from trigger a sync on unlock.
1896
self._inventory_is_modified = True
1897
# we preserve the root inventory entry object, but
1898
# unlinkit from the byid index
1899
del inv._byid[inv.root.file_id]
1900
inv.root.file_id = file_id
1901
# and link it into the index with the new changed id.
1902
inv._byid[inv.root.file_id] = inv.root
1903
# and finally update all children to reference the new id.
1904
# XXX: this should be safe to just look at the root.children
1905
# list, not the WHOLE INVENTORY.
1908
if entry.parent_id == orig_root_id:
1909
entry.parent_id = inv.root.file_id
1912
"""See Branch.unlock.
1914
WorkingTree locking just uses the Branch locking facilities.
1915
This is current because all working trees have an embedded branch
1916
within them. IF in the future, we were to make branch data shareable
1917
between multiple working trees, i.e. via shared storage, then we
1918
would probably want to lock both the local tree, and the branch.
1920
raise NotImplementedError(self.unlock)
1923
"""Update a working tree along its branch.
1925
This will update the branch if its bound too, which means we have
1926
multiple trees involved:
1928
- The new basis tree of the master.
1929
- The old basis tree of the branch.
1930
- The old basis tree of the working tree.
1931
- The current working tree state.
1933
Pathologically, all three may be different, and non-ancestors of each
1934
other. Conceptually we want to:
1936
- Preserve the wt.basis->wt.state changes
1937
- Transform the wt.basis to the new master basis.
1938
- Apply a merge of the old branch basis to get any 'local' changes from
1940
- Restore the wt.basis->wt.state changes.
1942
There isn't a single operation at the moment to do that, so we:
1943
- Merge current state -> basis tree of the master w.r.t. the old tree
1945
- Do a 'normal' merge of the old branch basis if it is relevant.
1947
if self.branch.get_master_branch() is not None:
1949
update_branch = True
1951
self.lock_tree_write()
1952
update_branch = False
1955
old_tip = self.branch.update()
1958
return self._update_tree(old_tip)
1962
@needs_tree_write_lock
1963
def _update_tree(self, old_tip=None):
1964
"""Update a tree to the master branch.
1966
:param old_tip: if supplied, the previous tip revision the branch,
1967
before it was changed to the master branch's tip.
1969
# here if old_tip is not None, it is the old tip of the branch before
1970
# it was updated from the master branch. This should become a pending
1971
# merge in the working tree to preserve the user existing work. we
1972
# cant set that until we update the working trees last revision to be
1973
# one from the new branch, because it will just get absorbed by the
1974
# parent de-duplication logic.
1976
# We MUST save it even if an error occurs, because otherwise the users
1977
# local work is unreferenced and will appear to have been lost.
1981
last_rev = self.get_parent_ids()[0]
1984
if last_rev != self.branch.last_revision():
1985
# merge tree state up to new branch tip.
1986
basis = self.basis_tree()
1989
to_tree = self.branch.basis_tree()
1990
if basis.inventory.root is None:
1991
self.set_root_id(to_tree.inventory.root.file_id)
1993
result += merge.merge_inner(
2000
# TODO - dedup parents list with things merged by pull ?
2001
# reuse the tree we've updated to to set the basis:
2002
parent_trees = [(self.branch.last_revision(), to_tree)]
2003
merges = self.get_parent_ids()[1:]
2004
# Ideally we ask the tree for the trees here, that way the working
2005
# tree can decide whether to give us teh entire tree or give us a
2006
# lazy initialised tree. dirstate for instance will have the trees
2007
# in ram already, whereas a last-revision + basis-inventory tree
2008
# will not, but also does not need them when setting parents.
2009
for parent in merges:
2010
parent_trees.append(
2011
(parent, self.branch.repository.revision_tree(parent)))
2012
if old_tip is not None:
2013
parent_trees.append(
2014
(old_tip, self.branch.repository.revision_tree(old_tip)))
2015
self.set_parent_trees(parent_trees)
2016
last_rev = parent_trees[0][0]
2018
# the working tree had the same last-revision as the master
2019
# branch did. We may still have pivot local work from the local
2020
# branch into old_tip:
2021
if old_tip is not None:
2022
self.add_parent_tree_id(old_tip)
2023
if old_tip and old_tip != last_rev:
2024
# our last revision was not the prior branch last revision
2025
# and we have converted that last revision to a pending merge.
2026
# base is somewhere between the branch tip now
2027
# and the now pending merge
2029
# Since we just modified the working tree and inventory, flush out
2030
# the current state, before we modify it again.
2031
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2032
# requires it only because TreeTransform directly munges the
2033
# inventory and calls tree._write_inventory(). Ultimately we
2034
# should be able to remove this extra flush.
2036
from bzrlib.revision import common_ancestor
2038
base_rev_id = common_ancestor(self.branch.last_revision(),
2040
self.branch.repository)
2041
except errors.NoCommonAncestor:
2043
base_tree = self.branch.repository.revision_tree(base_rev_id)
2044
other_tree = self.branch.repository.revision_tree(old_tip)
2045
result += merge.merge_inner(
2052
def _write_hashcache_if_dirty(self):
2053
"""Write out the hashcache if it is dirty."""
2054
if self._hashcache.needs_write:
2056
self._hashcache.write()
2058
if e.errno not in (errno.EPERM, errno.EACCES):
2060
# TODO: jam 20061219 Should this be a warning? A single line
2061
# warning might be sufficient to let the user know what
2063
mutter('Could not write hashcache for %s\nError: %s',
2064
self._hashcache.cache_file_name(), e)
2066
@needs_tree_write_lock
2067
def _write_inventory(self, inv):
2068
"""Write inventory as the current inventory."""
2069
self._set_inventory(inv, dirty=True)
2072
def set_conflicts(self, arg):
2073
raise errors.UnsupportedOperation(self.set_conflicts, self)
2075
def add_conflicts(self, arg):
2076
raise errors.UnsupportedOperation(self.add_conflicts, self)
2079
def conflicts(self):
2080
conflicts = _mod_conflicts.ConflictList()
2081
for conflicted in self._iter_conflicts():
2084
if file_kind(self.abspath(conflicted)) != "file":
2086
except errors.NoSuchFile:
2089
for suffix in ('.THIS', '.OTHER'):
2091
kind = file_kind(self.abspath(conflicted+suffix))
2094
except errors.NoSuchFile:
2098
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2099
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2101
file_id=self.path2id(conflicted)))
2104
def walkdirs(self, prefix=""):
2105
"""Walk the directories of this tree.
2107
This API returns a generator, which is only valid during the current
2108
tree transaction - within a single lock_read or lock_write duration.
2110
If the tree is not locked, it may cause an error to be raised, depending
2111
on the tree implementation.
2113
disk_top = self.abspath(prefix)
2114
if disk_top.endswith('/'):
2115
disk_top = disk_top[:-1]
2116
top_strip_len = len(disk_top) + 1
2117
inventory_iterator = self._walkdirs(prefix)
2118
disk_iterator = osutils.walkdirs(disk_top, prefix)
2120
current_disk = disk_iterator.next()
2121
disk_finished = False
2123
if e.errno != errno.ENOENT:
2126
disk_finished = True
2128
current_inv = inventory_iterator.next()
2129
inv_finished = False
2130
except StopIteration:
2133
while not inv_finished or not disk_finished:
2134
if not disk_finished:
2135
# strip out .bzr dirs
2136
if current_disk[0][1][top_strip_len:] == '':
2137
# osutils.walkdirs can be made nicer -
2138
# yield the path-from-prefix rather than the pathjoined
2140
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2141
if current_disk[1][bzrdir_loc][0] == '.bzr':
2142
# we dont yield the contents of, or, .bzr itself.
2143
del current_disk[1][bzrdir_loc]
2145
# everything is unknown
2148
# everything is missing
2151
direction = cmp(current_inv[0][0], current_disk[0][0])
2153
# disk is before inventory - unknown
2154
dirblock = [(relpath, basename, kind, stat, None, None) for
2155
relpath, basename, kind, stat, top_path in current_disk[1]]
2156
yield (current_disk[0][0], None), dirblock
2158
current_disk = disk_iterator.next()
2159
except StopIteration:
2160
disk_finished = True
2162
# inventory is before disk - missing.
2163
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2164
for relpath, basename, dkind, stat, fileid, kind in
2166
yield (current_inv[0][0], current_inv[0][1]), dirblock
2168
current_inv = inventory_iterator.next()
2169
except StopIteration:
2172
# versioned present directory
2173
# merge the inventory and disk data together
2175
for relpath, subiterator in itertools.groupby(sorted(
2176
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2177
path_elements = list(subiterator)
2178
if len(path_elements) == 2:
2179
inv_row, disk_row = path_elements
2180
# versioned, present file
2181
dirblock.append((inv_row[0],
2182
inv_row[1], disk_row[2],
2183
disk_row[3], inv_row[4],
2185
elif len(path_elements[0]) == 5:
2187
dirblock.append((path_elements[0][0],
2188
path_elements[0][1], path_elements[0][2],
2189
path_elements[0][3], None, None))
2190
elif len(path_elements[0]) == 6:
2191
# versioned, absent file.
2192
dirblock.append((path_elements[0][0],
2193
path_elements[0][1], 'unknown', None,
2194
path_elements[0][4], path_elements[0][5]))
2196
raise NotImplementedError('unreachable code')
2197
yield current_inv[0], dirblock
2199
current_inv = inventory_iterator.next()
2200
except StopIteration:
2203
current_disk = disk_iterator.next()
2204
except StopIteration:
2205
disk_finished = True
2207
def _walkdirs(self, prefix=""):
2208
_directory = 'directory'
2209
# get the root in the inventory
2210
inv = self.inventory
2211
top_id = inv.path2id(prefix)
2215
pending = [(prefix, '', _directory, None, top_id, None)]
2218
currentdir = pending.pop()
2219
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2220
top_id = currentdir[4]
2222
relroot = currentdir[0] + '/'
2225
# FIXME: stash the node in pending
2227
for name, child in entry.sorted_children():
2228
dirblock.append((relroot + name, name, child.kind, None,
2229
child.file_id, child.kind
2231
yield (currentdir[0], entry.file_id), dirblock
2232
# push the user specified dirs from dirblock
2233
for dir in reversed(dirblock):
2234
if dir[2] == _directory:
2237
@needs_tree_write_lock
2238
def auto_resolve(self):
2239
"""Automatically resolve text conflicts according to contents.
2241
Only text conflicts are auto_resolvable. Files with no conflict markers
2242
are considered 'resolved', because bzr always puts conflict markers
2243
into files that have text conflicts. The corresponding .THIS .BASE and
2244
.OTHER files are deleted, as per 'resolve'.
2245
:return: a tuple of ConflictLists: (un_resolved, resolved).
2247
un_resolved = _mod_conflicts.ConflictList()
2248
resolved = _mod_conflicts.ConflictList()
2249
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2250
for conflict in self.conflicts():
2251
if (conflict.typestring != 'text conflict' or
2252
self.kind(conflict.file_id) != 'file'):
2253
un_resolved.append(conflict)
2255
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2257
for line in my_file:
2258
if conflict_re.search(line):
2259
un_resolved.append(conflict)
2262
resolved.append(conflict)
2265
resolved.remove_files(self)
2266
self.set_conflicts(un_resolved)
2267
return un_resolved, resolved
2270
class WorkingTree2(WorkingTree):
2271
"""This is the Format 2 working tree.
2273
This was the first weave based working tree.
2274
- uses os locks for locking.
2275
- uses the branch last-revision.
2278
def lock_tree_write(self):
2279
"""See WorkingTree.lock_tree_write().
2281
In Format2 WorkingTrees we have a single lock for the branch and tree
2282
so lock_tree_write() degrades to lock_write().
2284
self.branch.lock_write()
2286
return self._control_files.lock_write()
2288
self.branch.unlock()
2292
# we share control files:
2293
if self._control_files._lock_count == 3:
2294
# _inventory_is_modified is always False during a read lock.
2295
if self._inventory_is_modified:
2297
self._write_hashcache_if_dirty()
2299
# reverse order of locking.
2301
return self._control_files.unlock()
2303
self.branch.unlock()
2306
class WorkingTree3(WorkingTree):
2307
"""This is the Format 3 working tree.
2309
This differs from the base WorkingTree by:
2310
- having its own file lock
2311
- having its own last-revision property.
2313
This is new in bzr 0.8
2317
def _last_revision(self):
2318
"""See Mutable.last_revision."""
2320
return osutils.safe_revision_id(
2321
self._control_files.get('last-revision').read())
2322
except errors.NoSuchFile:
2325
def _change_last_revision(self, revision_id):
2326
"""See WorkingTree._change_last_revision."""
2327
if revision_id is None or revision_id == NULL_REVISION:
2329
self._control_files._transport.delete('last-revision')
2330
except errors.NoSuchFile:
2334
self._control_files.put_bytes('last-revision', revision_id)
2337
@needs_tree_write_lock
2338
def set_conflicts(self, conflicts):
2339
self._put_rio('conflicts', conflicts.to_stanzas(),
2342
@needs_tree_write_lock
2343
def add_conflicts(self, new_conflicts):
2344
conflict_set = set(self.conflicts())
2345
conflict_set.update(set(list(new_conflicts)))
2346
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2347
key=_mod_conflicts.Conflict.sort_key)))
2350
def conflicts(self):
2352
confile = self._control_files.get('conflicts')
2353
except errors.NoSuchFile:
2354
return _mod_conflicts.ConflictList()
2356
if confile.next() != CONFLICT_HEADER_1 + '\n':
2357
raise errors.ConflictFormatError()
2358
except StopIteration:
2359
raise errors.ConflictFormatError()
2360
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2363
if self._control_files._lock_count == 1:
2364
# _inventory_is_modified is always False during a read lock.
2365
if self._inventory_is_modified:
2367
self._write_hashcache_if_dirty()
2368
# reverse order of locking.
2370
return self._control_files.unlock()
2372
self.branch.unlock()
2375
def get_conflicted_stem(path):
2376
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2377
if path.endswith(suffix):
2378
return path[:-len(suffix)]
2381
@deprecated_function(zero_eight)
2382
def is_control_file(filename):
2383
"""See WorkingTree.is_control_filename(filename)."""
2384
## FIXME: better check
2385
filename = normpath(filename)
2386
while filename != '':
2387
head, tail = os.path.split(filename)
2388
## mutter('check %r for control file' % ((head, tail),))
2391
if filename == head:
2397
class WorkingTreeFormat(object):
2398
"""An encapsulation of the initialization and open routines for a format.
2400
Formats provide three things:
2401
* An initialization routine,
2405
Formats are placed in an dict by their format string for reference
2406
during workingtree opening. Its not required that these be instances, they
2407
can be classes themselves with class methods - it simply depends on
2408
whether state is needed for a given format or not.
2410
Once a format is deprecated, just deprecate the initialize and open
2411
methods on the format class. Do not deprecate the object, as the
2412
object will be created every time regardless.
2415
_default_format = None
2416
"""The default format used for new trees."""
2419
"""The known formats."""
2421
requires_rich_root = False
2424
def find_format(klass, a_bzrdir):
2425
"""Return the format for the working tree object in a_bzrdir."""
2427
transport = a_bzrdir.get_workingtree_transport(None)
2428
format_string = transport.get("format").read()
2429
return klass._formats[format_string]
2430
except errors.NoSuchFile:
2431
raise errors.NoWorkingTree(base=transport.base)
2433
raise errors.UnknownFormatError(format=format_string)
2435
def __eq__(self, other):
2436
return self.__class__ is other.__class__
2438
def __ne__(self, other):
2439
return not (self == other)
2442
def get_default_format(klass):
2443
"""Return the current default format."""
2444
return klass._default_format
2446
def get_format_string(self):
2447
"""Return the ASCII format string that identifies this format."""
2448
raise NotImplementedError(self.get_format_string)
2450
def get_format_description(self):
2451
"""Return the short description for this format."""
2452
raise NotImplementedError(self.get_format_description)
2454
def is_supported(self):
2455
"""Is this format supported?
2457
Supported formats can be initialized and opened.
2458
Unsupported formats may not support initialization or committing or
2459
some other features depending on the reason for not being supported.
2464
def register_format(klass, format):
2465
klass._formats[format.get_format_string()] = format
2468
def set_default_format(klass, format):
2469
klass._default_format = format
2472
def unregister_format(klass, format):
2473
assert klass._formats[format.get_format_string()] is format
2474
del klass._formats[format.get_format_string()]
2478
class WorkingTreeFormat2(WorkingTreeFormat):
2479
"""The second working tree format.
2481
This format modified the hash cache from the format 1 hash cache.
2484
def get_format_description(self):
2485
"""See WorkingTreeFormat.get_format_description()."""
2486
return "Working tree format 2"
2488
def stub_initialize_remote(self, control_files):
2489
"""As a special workaround create critical control files for a remote working tree
2491
This ensures that it can later be updated and dealt with locally,
2492
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2493
no working tree. (See bug #43064).
2497
xml5.serializer_v5.write_inventory(inv, sio)
2499
control_files.put('inventory', sio)
2501
control_files.put_bytes('pending-merges', '')
2504
def initialize(self, a_bzrdir, revision_id=None):
2505
"""See WorkingTreeFormat.initialize()."""
2506
if not isinstance(a_bzrdir.transport, LocalTransport):
2507
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2508
branch = a_bzrdir.open_branch()
2509
if revision_id is not None:
2510
revision_id = osutils.safe_revision_id(revision_id)
2513
revision_history = branch.revision_history()
2515
position = revision_history.index(revision_id)
2517
raise errors.NoSuchRevision(branch, revision_id)
2518
branch.set_revision_history(revision_history[:position + 1])
2521
revision = branch.last_revision()
2523
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2529
basis_tree = branch.repository.revision_tree(revision)
2530
if basis_tree.inventory.root is not None:
2531
wt.set_root_id(basis_tree.inventory.root.file_id)
2532
# set the parent list and cache the basis tree.
2533
wt.set_parent_trees([(revision, basis_tree)])
2534
transform.build_tree(basis_tree, wt)
2538
super(WorkingTreeFormat2, self).__init__()
2539
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2541
def open(self, a_bzrdir, _found=False):
2542
"""Return the WorkingTree object for a_bzrdir
2544
_found is a private parameter, do not use it. It is used to indicate
2545
if format probing has already been done.
2548
# we are being called directly and must probe.
2549
raise NotImplementedError
2550
if not isinstance(a_bzrdir.transport, LocalTransport):
2551
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2552
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2558
class WorkingTreeFormat3(WorkingTreeFormat):
2559
"""The second working tree format updated to record a format marker.
2562
- exists within a metadir controlling .bzr
2563
- includes an explicit version marker for the workingtree control
2564
files, separate from the BzrDir format
2565
- modifies the hash cache format
2567
- uses a LockDir to guard access for writes.
2570
def get_format_string(self):
2571
"""See WorkingTreeFormat.get_format_string()."""
2572
return "Bazaar-NG Working Tree format 3"
2574
def get_format_description(self):
2575
"""See WorkingTreeFormat.get_format_description()."""
2576
return "Working tree format 3"
2578
_lock_file_name = 'lock'
2579
_lock_class = LockDir
2581
_tree_class = WorkingTree3
2583
def __get_matchingbzrdir(self):
2584
return bzrdir.BzrDirMetaFormat1()
2586
_matchingbzrdir = property(__get_matchingbzrdir)
2588
def _open_control_files(self, a_bzrdir):
2589
transport = a_bzrdir.get_workingtree_transport(None)
2590
return LockableFiles(transport, self._lock_file_name,
2593
def initialize(self, a_bzrdir, revision_id=None):
2594
"""See WorkingTreeFormat.initialize().
2596
revision_id allows creating a working tree at a different
2597
revision than the branch is at.
2599
if not isinstance(a_bzrdir.transport, LocalTransport):
2600
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2601
transport = a_bzrdir.get_workingtree_transport(self)
2602
control_files = self._open_control_files(a_bzrdir)
2603
control_files.create_lock()
2604
control_files.lock_write()
2605
control_files.put_utf8('format', self.get_format_string())
2606
branch = a_bzrdir.open_branch()
2607
if revision_id is None:
2608
revision_id = branch.last_revision()
2610
revision_id = osutils.safe_revision_id(revision_id)
2611
# WorkingTree3 can handle an inventory which has a unique root id.
2612
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2613
# those trees. And because there isn't a format bump inbetween, we
2614
# are maintaining compatibility with older clients.
2615
# inv = Inventory(root_id=gen_root_id())
2616
inv = self._initial_inventory()
2617
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2623
_control_files=control_files)
2624
wt.lock_tree_write()
2626
basis_tree = branch.repository.revision_tree(revision_id)
2627
# only set an explicit root id if there is one to set.
2628
if basis_tree.inventory.root is not None:
2629
wt.set_root_id(basis_tree.inventory.root.file_id)
2630
if revision_id == NULL_REVISION:
2631
wt.set_parent_trees([])
2633
wt.set_parent_trees([(revision_id, basis_tree)])
2634
transform.build_tree(basis_tree, wt)
2636
# Unlock in this order so that the unlock-triggers-flush in
2637
# WorkingTree is given a chance to fire.
2638
control_files.unlock()
2642
def _initial_inventory(self):
2646
super(WorkingTreeFormat3, self).__init__()
2648
def open(self, a_bzrdir, _found=False):
2649
"""Return the WorkingTree object for a_bzrdir
2651
_found is a private parameter, do not use it. It is used to indicate
2652
if format probing has already been done.
2655
# we are being called directly and must probe.
2656
raise NotImplementedError
2657
if not isinstance(a_bzrdir.transport, LocalTransport):
2658
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2659
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2661
def _open(self, a_bzrdir, control_files):
2662
"""Open the tree itself.
2664
:param a_bzrdir: the dir for the tree.
2665
:param control_files: the control files for the tree.
2667
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2671
_control_files=control_files)
2674
return self.get_format_string()
2677
__default_format = WorkingTreeFormat4()
2678
WorkingTreeFormat.register_format(__default_format)
2679
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2680
WorkingTreeFormat.set_default_format(__default_format)
2681
# formats which have no format string are not discoverable
2682
# and not independently creatable, so are not registered.
2683
_legacy_formats = [WorkingTreeFormat2(),
2687
class WorkingTreeTestProviderAdapter(object):
2688
"""A tool to generate a suite testing multiple workingtree formats at once.
2690
This is done by copying the test once for each transport and injecting
2691
the transport_server, transport_readonly_server, and workingtree_format
2692
classes into each copy. Each copy is also given a new id() to make it
2696
def __init__(self, transport_server, transport_readonly_server, formats):
2697
self._transport_server = transport_server
2698
self._transport_readonly_server = transport_readonly_server
2699
self._formats = formats
2701
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2702
"""Clone test for adaption."""
2703
new_test = deepcopy(test)
2704
new_test.transport_server = self._transport_server
2705
new_test.transport_readonly_server = self._transport_readonly_server
2706
new_test.bzrdir_format = bzrdir_format
2707
new_test.workingtree_format = workingtree_format
2708
def make_new_test_id():
2709
new_id = "%s(%s)" % (test.id(), variation)
2710
return lambda: new_id
2711
new_test.id = make_new_test_id()
2714
def adapt(self, test):
2715
from bzrlib.tests import TestSuite
2716
result = TestSuite()
2717
for workingtree_format, bzrdir_format in self._formats:
2718
new_test = self._clone_test(
2721
workingtree_format, workingtree_format.__class__.__name__)
2722
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
