1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
58
conflicts as _mod_conflicts,
77
from bzrlib.transport import get_transport
79
from bzrlib.workingtree_4 import WorkingTreeFormat4
82
from bzrlib import symbol_versioning
83
from bzrlib.decorators import needs_read_lock, needs_write_lock
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
85
from bzrlib.lockable_files import LockableFiles, TransportLock
86
from bzrlib.lockdir import LockDir
87
import bzrlib.mutabletree
88
from bzrlib.mutabletree import needs_tree_write_lock
89
from bzrlib.osutils import (
101
from bzrlib.trace import mutter, note
102
from bzrlib.transport.local import LocalTransport
103
from bzrlib.progress import DummyProgress, ProgressPhase
104
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
105
from bzrlib.rio import RioReader, rio_file, Stanza
106
from bzrlib.symbol_versioning import (deprecated_passed,
109
DEPRECATED_PARAMETER,
116
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
117
CONFLICT_HEADER_1 = "BZR conflict list format 1"
120
@deprecated_function(zero_thirteen)
121
def gen_file_id(name):
122
"""Return new file id for the basename 'name'.
124
Use bzrlib.generate_ids.gen_file_id() instead
126
return generate_ids.gen_file_id(name)
129
@deprecated_function(zero_thirteen)
131
"""Return a new tree-root file id.
133
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
135
return generate_ids.gen_root_id()
138
class TreeEntry(object):
139
"""An entry that implements the minimum interface used by commands.
141
This needs further inspection, it may be better to have
142
InventoryEntries without ids - though that seems wrong. For now,
143
this is a parallel hierarchy to InventoryEntry, and needs to become
144
one of several things: decorates to that hierarchy, children of, or
146
Another note is that these objects are currently only used when there is
147
no InventoryEntry available - i.e. for unversioned objects.
148
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
151
def __eq__(self, other):
152
# yes, this us ugly, TODO: best practice __eq__ style.
153
return (isinstance(other, TreeEntry)
154
and other.__class__ == self.__class__)
156
def kind_character(self):
160
class TreeDirectory(TreeEntry):
161
"""See TreeEntry. This is a directory in a working tree."""
163
def __eq__(self, other):
164
return (isinstance(other, TreeDirectory)
165
and other.__class__ == self.__class__)
167
def kind_character(self):
171
class TreeFile(TreeEntry):
172
"""See TreeEntry. This is a regular file in a working tree."""
174
def __eq__(self, other):
175
return (isinstance(other, TreeFile)
176
and other.__class__ == self.__class__)
178
def kind_character(self):
182
class TreeLink(TreeEntry):
183
"""See TreeEntry. This is a symlink in a working tree."""
185
def __eq__(self, other):
186
return (isinstance(other, TreeLink)
187
and other.__class__ == self.__class__)
189
def kind_character(self):
193
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
"""Working copy tree.
196
The inventory is held in the `Branch` working-inventory, and the
197
files are in a directory on disk.
199
It is possible for a `WorkingTree` to have a filename which is
200
not listed in the Inventory and vice versa.
203
def __init__(self, basedir='.',
204
branch=DEPRECATED_PARAMETER,
210
"""Construct a WorkingTree for basedir.
212
If the branch is not supplied, it is opened automatically.
213
If the branch is supplied, it must be the branch for this basedir.
214
(branch.base is not cross checked, because for remote branches that
215
would be meaningless).
217
self._format = _format
218
self.bzrdir = _bzrdir
220
# not created via open etc.
221
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
"Please use bzrdir.open_workingtree or WorkingTree.open().",
225
wt = WorkingTree.open(basedir)
226
self._branch = wt.branch
227
self.basedir = wt.basedir
228
self._control_files = wt._control_files
229
self._hashcache = wt._hashcache
230
self._set_inventory(wt._inventory, dirty=False)
231
self._format = wt._format
232
self.bzrdir = wt.bzrdir
233
assert isinstance(basedir, basestring), \
234
"base directory %r is not a string" % basedir
235
basedir = safe_unicode(basedir)
236
mutter("opening working tree %r", basedir)
237
if deprecated_passed(branch):
239
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
240
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
241
" WorkingTree.open().",
245
self._branch = branch
247
self._branch = self.bzrdir.open_branch()
248
self.basedir = realpath(basedir)
249
# if branch is at our basedir and is a format 6 or less
250
if isinstance(self._format, WorkingTreeFormat2):
251
# share control object
252
self._control_files = self.branch.control_files
254
# assume all other formats have their own control files.
255
assert isinstance(_control_files, LockableFiles), \
256
"_control_files must be a LockableFiles, not %r" \
258
self._control_files = _control_files
259
# update the whole cache up front and write to disk if anything changed;
260
# in the future we might want to do this more selectively
261
# two possible ways offer themselves : in self._unlock, write the cache
262
# if needed, or, when the cache sees a change, append it to the hash
263
# cache file, and have the parser take the most recent entry for a
265
wt_trans = self.bzrdir.get_workingtree_transport(None)
266
cache_filename = wt_trans.local_abspath('stat-cache')
267
self._hashcache = hashcache.HashCache(basedir, cache_filename,
268
self._control_files._file_mode)
271
# is this scan needed ? it makes things kinda slow.
278
if _inventory is None:
279
self._inventory_is_modified = False
280
self.read_working_inventory()
282
# the caller of __init__ has provided an inventory,
283
# we assume they know what they are doing - as its only
284
# the Format factory and creation methods that are
285
# permitted to do this.
286
self._set_inventory(_inventory, dirty=False)
289
fget=lambda self: self._branch,
290
doc="""The branch this WorkingTree is connected to.
292
This cannot be set - it is reflective of the actual disk structure
293
the working tree has been constructed from.
296
def break_lock(self):
297
"""Break a lock if one is present from another instance.
299
Uses the ui factory to ask for confirmation if the lock may be from
302
This will probe the repository for its lock as well.
304
self._control_files.break_lock()
305
self.branch.break_lock()
307
def requires_rich_root(self):
308
return self._format.requires_rich_root
310
def supports_tree_reference(self):
311
return getattr(self._format, 'supports_tree_reference', False)
313
def _set_inventory(self, inv, dirty):
314
"""Set the internal cached inventory.
316
:param inv: The inventory to set.
317
:param dirty: A boolean indicating whether the inventory is the same
318
logical inventory as whats on disk. If True the inventory is not
319
the same and should be written to disk or data will be lost, if
320
False then the inventory is the same as that on disk and any
321
serialisation would be unneeded overhead.
323
assert inv.root is not None
324
self._inventory = inv
325
self._inventory_is_modified = dirty
328
def open(path=None, _unsupported=False):
329
"""Open an existing working tree at path.
333
path = os.path.getcwdu()
334
control = bzrdir.BzrDir.open(path, _unsupported)
335
return control.open_workingtree(_unsupported)
338
def open_containing(path=None):
339
"""Open an existing working tree which has its root about path.
341
This probes for a working tree at path and searches upwards from there.
343
Basically we keep looking up until we find the control directory or
344
run into /. If there isn't one, raises NotBranchError.
345
TODO: give this a new exception.
346
If there is one, it is returned, along with the unused portion of path.
348
:return: The WorkingTree that contains 'path', and the rest of path
351
path = osutils.getcwd()
352
control, relpath = bzrdir.BzrDir.open_containing(path)
354
return control.open_workingtree(), relpath
357
def open_downlevel(path=None):
358
"""Open an unsupported working tree.
360
Only intended for advanced situations like upgrading part of a bzrdir.
362
return WorkingTree.open(path, _unsupported=True)
364
# should be deprecated - this is slow and in any case treating them as a
365
# container is (we now know) bad style -- mbp 20070302
366
## @deprecated_method(zero_fifteen)
368
"""Iterate through file_ids for this tree.
370
file_ids are in a WorkingTree if they are in the working inventory
371
and the working file exists.
373
inv = self._inventory
374
for path, ie in inv.iter_entries():
375
if osutils.lexists(self.abspath(path)):
379
return "<%s of %s>" % (self.__class__.__name__,
380
getattr(self, 'basedir', None))
382
def abspath(self, filename):
383
return pathjoin(self.basedir, filename)
385
def basis_tree(self):
386
"""Return RevisionTree for the current last revision.
388
If the left most parent is a ghost then the returned tree will be an
389
empty tree - one obtained by calling repository.revision_tree(None).
392
revision_id = self.get_parent_ids()[0]
394
# no parents, return an empty revision tree.
395
# in the future this should return the tree for
396
# 'empty:' - the implicit root empty tree.
397
return self.branch.repository.revision_tree(None)
399
return self.revision_tree(revision_id)
400
except errors.NoSuchRevision:
402
# No cached copy available, retrieve from the repository.
403
# FIXME? RBC 20060403 should we cache the inventory locally
406
return self.branch.repository.revision_tree(revision_id)
407
except errors.RevisionNotPresent:
408
# the basis tree *may* be a ghost or a low level error may have
409
# occured. If the revision is present, its a problem, if its not
411
if self.branch.repository.has_revision(revision_id):
413
# the basis tree is a ghost so return an empty tree.
414
return self.branch.repository.revision_tree(None)
417
@deprecated_method(zero_eight)
418
def create(branch, directory):
419
"""Create a workingtree for branch at directory.
421
If existing_directory already exists it must have a .bzr directory.
422
If it does not exist, it will be created.
424
This returns a new WorkingTree object for the new checkout.
426
TODO FIXME RBC 20060124 when we have checkout formats in place this
427
should accept an optional revisionid to checkout [and reject this if
428
checking out into the same dir as a pre-checkout-aware branch format.]
430
XXX: When BzrDir is present, these should be created through that
433
warnings.warn('delete WorkingTree.create', stacklevel=3)
434
transport = get_transport(directory)
435
if branch.bzrdir.root_transport.base == transport.base:
437
return branch.bzrdir.create_workingtree()
438
# different directory,
439
# create a branch reference
440
# and now a working tree.
441
raise NotImplementedError
444
@deprecated_method(zero_eight)
445
def create_standalone(directory):
446
"""Create a checkout and a branch and a repo at directory.
448
Directory must exist and be empty.
450
please use BzrDir.create_standalone_workingtree
452
return bzrdir.BzrDir.create_standalone_workingtree(directory)
454
def relpath(self, path):
455
"""Return the local path portion from a given path.
457
The path may be absolute or relative. If its a relative path it is
458
interpreted relative to the python current working directory.
460
return osutils.relpath(self.basedir, path)
462
def has_filename(self, filename):
463
return osutils.lexists(self.abspath(filename))
465
def get_file(self, file_id):
466
file_id = osutils.safe_file_id(file_id)
467
return self.get_file_byname(self.id2path(file_id))
469
def get_file_text(self, file_id):
470
file_id = osutils.safe_file_id(file_id)
471
return self.get_file(file_id).read()
473
def get_file_byname(self, filename):
474
return file(self.abspath(filename), 'rb')
477
def annotate_iter(self, file_id):
478
"""See Tree.annotate_iter
480
This implementation will use the basis tree implementation if possible.
481
Lines not in the basis are attributed to CURRENT_REVISION
483
If there are pending merges, lines added by those merges will be
484
incorrectly attributed to CURRENT_REVISION (but after committing, the
485
attribution will be correct).
487
file_id = osutils.safe_file_id(file_id)
488
basis = self.basis_tree()
489
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
490
require_versioned=True).next()
491
changed_content, kind = changes[2], changes[6]
492
if not changed_content:
493
return basis.annotate_iter(file_id)
497
if kind[0] != 'file':
500
old_lines = list(basis.annotate_iter(file_id))
502
for tree in self.branch.repository.revision_trees(
503
self.get_parent_ids()[1:]):
504
if file_id not in tree:
506
old.append(list(tree.annotate_iter(file_id)))
507
return annotate.reannotate(old, self.get_file(file_id).readlines(),
510
def get_parent_ids(self):
511
"""See Tree.get_parent_ids.
513
This implementation reads the pending merges list and last_revision
514
value and uses that to decide what the parents list should be.
516
last_rev = self._last_revision()
522
merges_file = self._control_files.get('pending-merges')
523
except errors.NoSuchFile:
526
for l in merges_file.readlines():
527
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
528
parents.append(revision_id)
532
def get_root_id(self):
533
"""Return the id of this trees root"""
534
return self._inventory.root.file_id
536
def _get_store_filename(self, file_id):
537
## XXX: badly named; this is not in the store at all
538
file_id = osutils.safe_file_id(file_id)
539
return self.abspath(self.id2path(file_id))
542
def clone(self, to_bzrdir, revision_id=None, basis=None):
543
"""Duplicate this working tree into to_bzr, including all state.
545
Specifically modified files are kept as modified, but
546
ignored and unknown files are discarded.
548
If you want to make a new line of development, see bzrdir.sprout()
551
If not None, the cloned tree will have its last revision set to
552
revision, and and difference between the source trees last revision
553
and this one merged in.
556
If not None, a closer copy of a tree which may have some files in
557
common, and which file content should be preferentially copied from.
559
# assumes the target bzr dir format is compatible.
560
result = self._format.initialize(to_bzrdir)
561
self.copy_content_into(result, revision_id)
565
def copy_content_into(self, tree, revision_id=None):
566
"""Copy the current content and user files of this tree into tree."""
567
tree.set_root_id(self.get_root_id())
568
if revision_id is None:
569
merge.transform_tree(tree, self)
571
# TODO now merge from tree.last_revision to revision (to preserve
572
# user local changes)
573
merge.transform_tree(tree, self)
574
tree.set_parent_ids([revision_id])
576
def id2abspath(self, file_id):
577
file_id = osutils.safe_file_id(file_id)
578
return self.abspath(self.id2path(file_id))
580
def has_id(self, file_id):
581
# files that have been deleted are excluded
582
file_id = osutils.safe_file_id(file_id)
584
if not inv.has_id(file_id):
586
path = inv.id2path(file_id)
587
return osutils.lexists(self.abspath(path))
589
def has_or_had_id(self, file_id):
590
file_id = osutils.safe_file_id(file_id)
591
if file_id == self.inventory.root.file_id:
593
return self.inventory.has_id(file_id)
595
__contains__ = has_id
597
def get_file_size(self, file_id):
598
file_id = osutils.safe_file_id(file_id)
599
return os.path.getsize(self.id2abspath(file_id))
602
def get_file_sha1(self, file_id, path=None, stat_value=None):
603
file_id = osutils.safe_file_id(file_id)
605
path = self._inventory.id2path(file_id)
606
return self._hashcache.get_sha1(path, stat_value)
608
def get_file_mtime(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
611
path = self.inventory.id2path(file_id)
612
return os.lstat(self.abspath(path)).st_mtime
614
if not supports_executable():
615
def is_executable(self, file_id, path=None):
616
file_id = osutils.safe_file_id(file_id)
617
return self._inventory[file_id].executable
619
def is_executable(self, file_id, path=None):
621
file_id = osutils.safe_file_id(file_id)
622
path = self.id2path(file_id)
623
mode = os.lstat(self.abspath(path)).st_mode
624
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
626
@needs_tree_write_lock
627
def _add(self, files, ids, kinds):
628
"""See MutableTree._add."""
629
# TODO: Re-adding a file that is removed in the working copy
630
# should probably put it back with the previous ID.
631
# the read and write working inventory should not occur in this
632
# function - they should be part of lock_write and unlock.
633
inv = self.read_working_inventory()
634
for f, file_id, kind in zip(files, ids, kinds):
635
assert kind is not None
637
inv.add_path(f, kind=kind)
639
file_id = osutils.safe_file_id(file_id)
640
inv.add_path(f, kind=kind, file_id=file_id)
641
self._write_inventory(inv)
643
@needs_tree_write_lock
644
def _gather_kinds(self, files, kinds):
645
"""See MutableTree._gather_kinds."""
646
for pos, f in enumerate(files):
647
if kinds[pos] is None:
648
fullpath = normpath(self.abspath(f))
650
kinds[pos] = file_kind(fullpath)
652
if e.errno == errno.ENOENT:
653
raise errors.NoSuchFile(fullpath)
656
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
657
"""Add revision_id as a parent.
659
This is equivalent to retrieving the current list of parent ids
660
and setting the list to its value plus revision_id.
662
:param revision_id: The revision id to add to the parent list. It may
663
be a ghost revision as long as its not the first parent to be added,
664
or the allow_leftmost_as_ghost parameter is set True.
665
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
667
parents = self.get_parent_ids() + [revision_id]
668
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
669
or allow_leftmost_as_ghost)
671
@needs_tree_write_lock
672
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
673
"""Add revision_id, tree tuple as a parent.
675
This is equivalent to retrieving the current list of parent trees
676
and setting the list to its value plus parent_tuple. See also
677
add_parent_tree_id - if you only have a parent id available it will be
678
simpler to use that api. If you have the parent already available, using
679
this api is preferred.
681
:param parent_tuple: The (revision id, tree) to add to the parent list.
682
If the revision_id is a ghost, pass None for the tree.
683
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
685
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
686
if len(parent_ids) > 1:
687
# the leftmost may have already been a ghost, preserve that if it
689
allow_leftmost_as_ghost = True
690
self.set_parent_ids(parent_ids,
691
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
693
@needs_tree_write_lock
694
def add_pending_merge(self, *revision_ids):
695
# TODO: Perhaps should check at this point that the
696
# history of the revision is actually present?
697
parents = self.get_parent_ids()
699
for rev_id in revision_ids:
700
if rev_id in parents:
702
parents.append(rev_id)
705
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
707
@deprecated_method(zero_eleven)
709
def pending_merges(self):
710
"""Return a list of pending merges.
712
These are revisions that have been merged into the working
713
directory but not yet committed.
715
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
716
instead - which is available on all tree objects.
718
return self.get_parent_ids()[1:]
720
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
721
"""Common ghost checking functionality from set_parent_*.
723
This checks that the left hand-parent exists if there are any
726
if len(revision_ids) > 0:
727
leftmost_id = revision_ids[0]
728
if (not allow_leftmost_as_ghost and not
729
self.branch.repository.has_revision(leftmost_id)):
730
raise errors.GhostRevisionUnusableHere(leftmost_id)
732
def _set_merges_from_parent_ids(self, parent_ids):
733
merges = parent_ids[1:]
734
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
736
@needs_tree_write_lock
737
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
738
"""Set the parent ids to revision_ids.
740
See also set_parent_trees. This api will try to retrieve the tree data
741
for each element of revision_ids from the trees repository. If you have
742
tree data already available, it is more efficient to use
743
set_parent_trees rather than set_parent_ids. set_parent_ids is however
744
an easier API to use.
746
:param revision_ids: The revision_ids to set as the parent ids of this
747
working tree. Any of these may be ghosts.
749
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
750
self._check_parents_for_ghosts(revision_ids,
751
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
753
if len(revision_ids) > 0:
754
self.set_last_revision(revision_ids[0])
756
self.set_last_revision(None)
758
self._set_merges_from_parent_ids(revision_ids)
760
@needs_tree_write_lock
761
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
762
"""See MutableTree.set_parent_trees."""
763
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
765
self._check_parents_for_ghosts(parent_ids,
766
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
768
if len(parent_ids) == 0:
769
leftmost_parent_id = None
770
leftmost_parent_tree = None
772
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
774
if self._change_last_revision(leftmost_parent_id):
775
if leftmost_parent_tree is None:
776
# If we don't have a tree, fall back to reading the
777
# parent tree from the repository.
778
self._cache_basis_inventory(leftmost_parent_id)
780
inv = leftmost_parent_tree.inventory
781
xml = self._create_basis_xml_from_inventory(
782
leftmost_parent_id, inv)
783
self._write_basis_inventory(xml)
784
self._set_merges_from_parent_ids(parent_ids)
786
@needs_tree_write_lock
787
def set_pending_merges(self, rev_list):
788
parents = self.get_parent_ids()
789
leftmost = parents[:1]
790
new_parents = leftmost + rev_list
791
self.set_parent_ids(new_parents)
793
@needs_tree_write_lock
794
def set_merge_modified(self, modified_hashes):
796
for file_id, hash in modified_hashes.iteritems():
797
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
798
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
800
def _put_rio(self, filename, stanzas, header):
801
self._must_be_locked()
802
my_file = rio_file(stanzas, header)
803
self._control_files.put(filename, my_file)
805
@needs_write_lock # because merge pulls data into the branch.
806
def merge_from_branch(self, branch, to_revision=None):
807
"""Merge from a branch into this working tree.
809
:param branch: The branch to merge from.
810
:param to_revision: If non-None, the merge will merge to to_revision,
811
but not beyond it. to_revision does not need to be in the history
812
of the branch when it is supplied. If None, to_revision defaults to
813
branch.last_revision().
815
from bzrlib.merge import Merger, Merge3Merger
816
pb = bzrlib.ui.ui_factory.nested_progress_bar()
818
merger = Merger(self.branch, this_tree=self, pb=pb)
819
merger.pp = ProgressPhase("Merge phase", 5, pb)
820
merger.pp.next_phase()
821
# check that there are no
823
merger.check_basis(check_clean=True, require_commits=False)
824
if to_revision is None:
825
to_revision = branch.last_revision()
827
to_revision = osutils.safe_revision_id(to_revision)
828
merger.other_rev_id = to_revision
829
if merger.other_rev_id is None:
830
raise error.NoCommits(branch)
831
self.branch.fetch(branch, last_revision=merger.other_rev_id)
832
merger.other_basis = merger.other_rev_id
833
merger.other_tree = self.branch.repository.revision_tree(
835
merger.other_branch = branch
836
merger.pp.next_phase()
838
if merger.base_rev_id == merger.other_rev_id:
839
raise errors.PointlessMerge
840
merger.backup_files = False
841
merger.merge_type = Merge3Merger
842
merger.set_interesting_files(None)
843
merger.show_base = False
844
merger.reprocess = False
845
conflicts = merger.do_merge()
852
def merge_modified(self):
853
"""Return a dictionary of files modified by a merge.
855
The list is initialized by WorkingTree.set_merge_modified, which is
856
typically called after we make some automatic updates to the tree
859
This returns a map of file_id->sha1, containing only files which are
860
still in the working inventory and have that text hash.
863
hashfile = self._control_files.get('merge-hashes')
864
except errors.NoSuchFile:
868
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
869
raise errors.MergeModifiedFormatError()
870
except StopIteration:
871
raise errors.MergeModifiedFormatError()
872
for s in RioReader(hashfile):
873
file_id = s.get("file_id")
874
if file_id not in self.inventory:
876
text_hash = s.get("hash")
877
if text_hash == self.get_file_sha1(file_id):
878
merge_hashes[file_id] = text_hash
882
def mkdir(self, path, file_id=None):
883
"""See MutableTree.mkdir()."""
885
file_id = generate_ids.gen_file_id(os.path.basename(path))
886
os.mkdir(self.abspath(path))
887
self.add(path, file_id, 'directory')
890
def get_symlink_target(self, file_id):
891
file_id = osutils.safe_file_id(file_id)
892
return os.readlink(self.id2abspath(file_id))
895
def subsume(self, other_tree):
896
def add_children(inventory, entry):
897
for child_entry in entry.children.values():
898
inventory._byid[child_entry.file_id] = child_entry
899
if child_entry.kind == 'directory':
900
add_children(inventory, child_entry)
901
if other_tree.get_root_id() == self.get_root_id():
902
raise errors.BadSubsumeSource(self, other_tree,
903
'Trees have the same root')
905
other_tree_path = self.relpath(other_tree.basedir)
906
except errors.PathNotChild:
907
raise errors.BadSubsumeSource(self, other_tree,
908
'Tree is not contained by the other')
909
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
910
if new_root_parent is None:
911
raise errors.BadSubsumeSource(self, other_tree,
912
'Parent directory is not versioned.')
913
# We need to ensure that the result of a fetch will have a
914
# versionedfile for the other_tree root, and only fetching into
915
# RepositoryKnit2 guarantees that.
916
if not self.branch.repository.supports_rich_root():
917
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
918
other_tree.lock_tree_write()
920
new_parents = other_tree.get_parent_ids()
921
other_root = other_tree.inventory.root
922
other_root.parent_id = new_root_parent
923
other_root.name = osutils.basename(other_tree_path)
924
self.inventory.add(other_root)
925
add_children(self.inventory, other_root)
926
self._write_inventory(self.inventory)
927
# normally we don't want to fetch whole repositories, but i think
928
# here we really do want to consolidate the whole thing.
929
for parent_id in other_tree.get_parent_ids():
930
self.branch.fetch(other_tree.branch, parent_id)
931
self.add_parent_tree_id(parent_id)
934
other_tree.bzrdir.retire_bzrdir()
936
@needs_tree_write_lock
937
def extract(self, file_id, format=None):
938
"""Extract a subtree from this tree.
940
A new branch will be created, relative to the path for this tree.
943
segments = osutils.splitpath(path)
944
transport = self.branch.bzrdir.root_transport
945
for name in segments:
946
transport = transport.clone(name)
949
except errors.FileExists:
953
sub_path = self.id2path(file_id)
954
branch_transport = mkdirs(sub_path)
956
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
958
branch_transport.mkdir('.')
959
except errors.FileExists:
961
branch_bzrdir = format.initialize_on_transport(branch_transport)
963
repo = branch_bzrdir.find_repository()
964
except errors.NoRepositoryPresent:
965
repo = branch_bzrdir.create_repository()
966
assert repo.supports_rich_root()
968
if not repo.supports_rich_root():
969
raise errors.RootNotRich()
970
new_branch = branch_bzrdir.create_branch()
971
new_branch.pull(self.branch)
972
for parent_id in self.get_parent_ids():
973
new_branch.fetch(self.branch, parent_id)
974
tree_transport = self.bzrdir.root_transport.clone(sub_path)
975
if tree_transport.base != branch_transport.base:
976
tree_bzrdir = format.initialize_on_transport(tree_transport)
977
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
979
tree_bzrdir = branch_bzrdir
980
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
981
wt.set_parent_ids(self.get_parent_ids())
982
my_inv = self.inventory
983
child_inv = Inventory(root_id=None)
984
new_root = my_inv[file_id]
985
my_inv.remove_recursive_id(file_id)
986
new_root.parent_id = None
987
child_inv.add(new_root)
988
self._write_inventory(my_inv)
989
wt._write_inventory(child_inv)
992
def _serialize(self, inventory, out_file):
993
xml5.serializer_v5.write_inventory(self._inventory, out_file)
995
def _deserialize(selt, in_file):
996
return xml5.serializer_v5.read_inventory(in_file)
999
"""Write the in memory inventory to disk."""
1000
# TODO: Maybe this should only write on dirty ?
1001
if self._control_files._lock_mode != 'w':
1002
raise errors.NotWriteLocked(self)
1004
self._serialize(self._inventory, sio)
1006
self._control_files.put('inventory', sio)
1007
self._inventory_is_modified = False
1009
def list_files(self, include_root=False):
1010
"""Recursively list all files as (path, class, kind, id, entry).
1012
Lists, but does not descend into unversioned directories.
1014
This does not include files that have been deleted in this
1017
Skips the control directory.
1019
# list_files is an iterator, so @needs_read_lock doesn't work properly
1020
# with it. So callers should be careful to always read_lock the tree.
1021
if not self.is_locked():
1022
raise errors.ObjectNotLocked(self)
1024
inv = self.inventory
1025
if include_root is True:
1026
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1027
# Convert these into local objects to save lookup times
1028
pathjoin = osutils.pathjoin
1029
file_kind = osutils.file_kind
1031
# transport.base ends in a slash, we want the piece
1032
# between the last two slashes
1033
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1035
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1037
# directory file_id, relative path, absolute path, reverse sorted children
1038
children = os.listdir(self.basedir)
1040
# jam 20060527 The kernel sized tree seems equivalent whether we
1041
# use a deque and popleft to keep them sorted, or if we use a plain
1042
# list and just reverse() them.
1043
children = collections.deque(children)
1044
stack = [(inv.root.file_id, u'', self.basedir, children)]
1046
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1049
f = children.popleft()
1050
## TODO: If we find a subdirectory with its own .bzr
1051
## directory, then that is a separate tree and we
1052
## should exclude it.
1054
# the bzrdir for this tree
1055
if transport_base_dir == f:
1058
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1059
# and 'f' doesn't begin with one, we can do a string op, rather
1060
# than the checks of pathjoin(), all relative paths will have an extra slash
1062
fp = from_dir_relpath + '/' + f
1065
fap = from_dir_abspath + '/' + f
1067
f_ie = inv.get_child(from_dir_id, f)
1070
elif self.is_ignored(fp[1:]):
1073
# we may not have found this file, because of a unicode issue
1074
f_norm, can_access = osutils.normalized_filename(f)
1075
if f == f_norm or not can_access:
1076
# No change, so treat this file normally
1079
# this file can be accessed by a normalized path
1080
# check again if it is versioned
1081
# these lines are repeated here for performance
1083
fp = from_dir_relpath + '/' + f
1084
fap = from_dir_abspath + '/' + f
1085
f_ie = inv.get_child(from_dir_id, f)
1088
elif self.is_ignored(fp[1:]):
1097
raise errors.BzrCheckError(
1098
"file %r entered as kind %r id %r, now of kind %r"
1099
% (fap, f_ie.kind, f_ie.file_id, fk))
1101
# make a last minute entry
1103
yield fp[1:], c, fk, f_ie.file_id, f_ie
1106
yield fp[1:], c, fk, None, fk_entries[fk]()
1108
yield fp[1:], c, fk, None, TreeEntry()
1111
if fk != 'directory':
1114
# But do this child first
1115
new_children = os.listdir(fap)
1117
new_children = collections.deque(new_children)
1118
stack.append((f_ie.file_id, fp, fap, new_children))
1119
# Break out of inner loop,
1120
# so that we start outer loop with child
1123
# if we finished all children, pop it off the stack
1126
@needs_tree_write_lock
1127
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1130
to_dir must exist in the inventory.
1132
If to_dir exists and is a directory, the files are moved into
1133
it, keeping their old names.
1135
Note that to_dir is only the last component of the new name;
1136
this doesn't change the directory.
1138
For each entry in from_paths the move mode will be determined
1141
The first mode moves the file in the filesystem and updates the
1142
inventory. The second mode only updates the inventory without
1143
touching the file on the filesystem. This is the new mode introduced
1146
move uses the second mode if 'after == True' and the target is not
1147
versioned but present in the working tree.
1149
move uses the second mode if 'after == False' and the source is
1150
versioned but no longer in the working tree, and the target is not
1151
versioned but present in the working tree.
1153
move uses the first mode if 'after == False' and the source is
1154
versioned and present in the working tree, and the target is not
1155
versioned and not present in the working tree.
1157
Everything else results in an error.
1159
This returns a list of (from_path, to_path) pairs for each
1160
entry that is moved.
1165
# check for deprecated use of signature
1167
to_dir = kwargs.get('to_name', None)
1169
raise TypeError('You must supply a target directory')
1171
symbol_versioning.warn('The parameter to_name was deprecated'
1172
' in version 0.13. Use to_dir instead',
1175
# check destination directory
1176
assert not isinstance(from_paths, basestring)
1177
inv = self.inventory
1178
to_abs = self.abspath(to_dir)
1179
if not isdir(to_abs):
1180
raise errors.BzrMoveFailedError('',to_dir,
1181
errors.NotADirectory(to_abs))
1182
if not self.has_filename(to_dir):
1183
raise errors.BzrMoveFailedError('',to_dir,
1184
errors.NotInWorkingDirectory(to_dir))
1185
to_dir_id = inv.path2id(to_dir)
1186
if to_dir_id is None:
1187
raise errors.BzrMoveFailedError('',to_dir,
1188
errors.NotVersionedError(path=str(to_dir)))
1190
to_dir_ie = inv[to_dir_id]
1191
if to_dir_ie.kind != 'directory':
1192
raise errors.BzrMoveFailedError('',to_dir,
1193
errors.NotADirectory(to_abs))
1195
# create rename entries and tuples
1196
for from_rel in from_paths:
1197
from_tail = splitpath(from_rel)[-1]
1198
from_id = inv.path2id(from_rel)
1200
raise errors.BzrMoveFailedError(from_rel,to_dir,
1201
errors.NotVersionedError(path=str(from_rel)))
1203
from_entry = inv[from_id]
1204
from_parent_id = from_entry.parent_id
1205
to_rel = pathjoin(to_dir, from_tail)
1206
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1208
from_tail=from_tail,
1209
from_parent_id=from_parent_id,
1210
to_rel=to_rel, to_tail=from_tail,
1211
to_parent_id=to_dir_id)
1212
rename_entries.append(rename_entry)
1213
rename_tuples.append((from_rel, to_rel))
1215
# determine which move mode to use. checks also for movability
1216
rename_entries = self._determine_mv_mode(rename_entries, after)
1218
original_modified = self._inventory_is_modified
1221
self._inventory_is_modified = True
1222
self._move(rename_entries)
1224
# restore the inventory on error
1225
self._inventory_is_modified = original_modified
1227
self._write_inventory(inv)
1228
return rename_tuples
1230
def _determine_mv_mode(self, rename_entries, after=False):
1231
"""Determines for each from-to pair if both inventory and working tree
1232
or only the inventory has to be changed.
1234
Also does basic plausability tests.
1236
inv = self.inventory
1238
for rename_entry in rename_entries:
1239
# store to local variables for easier reference
1240
from_rel = rename_entry.from_rel
1241
from_id = rename_entry.from_id
1242
to_rel = rename_entry.to_rel
1243
to_id = inv.path2id(to_rel)
1244
only_change_inv = False
1246
# check the inventory for source and destination
1248
raise errors.BzrMoveFailedError(from_rel,to_rel,
1249
errors.NotVersionedError(path=str(from_rel)))
1250
if to_id is not None:
1251
raise errors.BzrMoveFailedError(from_rel,to_rel,
1252
errors.AlreadyVersionedError(path=str(to_rel)))
1254
# try to determine the mode for rename (only change inv or change
1255
# inv and file system)
1257
if not self.has_filename(to_rel):
1258
raise errors.BzrMoveFailedError(from_id,to_rel,
1259
errors.NoSuchFile(path=str(to_rel),
1260
extra="New file has not been created yet"))
1261
only_change_inv = True
1262
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1263
only_change_inv = True
1264
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1265
only_change_inv = False
1267
# something is wrong, so lets determine what exactly
1268
if not self.has_filename(from_rel) and \
1269
not self.has_filename(to_rel):
1270
raise errors.BzrRenameFailedError(from_rel,to_rel,
1271
errors.PathsDoNotExist(paths=(str(from_rel),
1274
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1275
extra="(Use --after to update the Bazaar id)")
1276
rename_entry.only_change_inv = only_change_inv
1277
return rename_entries
1279
def _move(self, rename_entries):
1280
"""Moves a list of files.
1282
Depending on the value of the flag 'only_change_inv', the
1283
file will be moved on the file system or not.
1285
inv = self.inventory
1288
for entry in rename_entries:
1290
self._move_entry(entry)
1292
self._rollback_move(moved)
1296
def _rollback_move(self, moved):
1297
"""Try to rollback a previous move in case of an filesystem error."""
1298
inv = self.inventory
1301
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1302
entry.to_tail, entry.to_parent_id, entry.from_rel,
1303
entry.from_tail, entry.from_parent_id,
1304
entry.only_change_inv))
1305
except errors.BzrMoveFailedError, e:
1306
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1307
" The working tree is in an inconsistent state."
1308
" Please consider doing a 'bzr revert'."
1309
" Error message is: %s" % e)
1311
def _move_entry(self, entry):
1312
inv = self.inventory
1313
from_rel_abs = self.abspath(entry.from_rel)
1314
to_rel_abs = self.abspath(entry.to_rel)
1315
if from_rel_abs == to_rel_abs:
1316
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1317
"Source and target are identical.")
1319
if not entry.only_change_inv:
1321
osutils.rename(from_rel_abs, to_rel_abs)
1323
raise errors.BzrMoveFailedError(entry.from_rel,
1325
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1327
@needs_tree_write_lock
1328
def rename_one(self, from_rel, to_rel, after=False):
1331
This can change the directory or the filename or both.
1333
rename_one has several 'modes' to work. First, it can rename a physical
1334
file and change the file_id. That is the normal mode. Second, it can
1335
only change the file_id without touching any physical file. This is
1336
the new mode introduced in version 0.15.
1338
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1339
versioned but present in the working tree.
1341
rename_one uses the second mode if 'after == False' and 'from_rel' is
1342
versioned but no longer in the working tree, and 'to_rel' is not
1343
versioned but present in the working tree.
1345
rename_one uses the first mode if 'after == False' and 'from_rel' is
1346
versioned and present in the working tree, and 'to_rel' is not
1347
versioned and not present in the working tree.
1349
Everything else results in an error.
1351
inv = self.inventory
1354
# create rename entries and tuples
1355
from_tail = splitpath(from_rel)[-1]
1356
from_id = inv.path2id(from_rel)
1358
raise errors.BzrRenameFailedError(from_rel,to_rel,
1359
errors.NotVersionedError(path=str(from_rel)))
1360
from_entry = inv[from_id]
1361
from_parent_id = from_entry.parent_id
1362
to_dir, to_tail = os.path.split(to_rel)
1363
to_dir_id = inv.path2id(to_dir)
1364
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1366
from_tail=from_tail,
1367
from_parent_id=from_parent_id,
1368
to_rel=to_rel, to_tail=to_tail,
1369
to_parent_id=to_dir_id)
1370
rename_entries.append(rename_entry)
1372
# determine which move mode to use. checks also for movability
1373
rename_entries = self._determine_mv_mode(rename_entries, after)
1375
# check if the target changed directory and if the target directory is
1377
if to_dir_id is None:
1378
raise errors.BzrMoveFailedError(from_rel,to_rel,
1379
errors.NotVersionedError(path=str(to_dir)))
1381
# all checks done. now we can continue with our actual work
1382
mutter('rename_one:\n'
1387
' to_dir_id {%s}\n',
1388
from_id, from_rel, to_rel, to_dir, to_dir_id)
1390
self._move(rename_entries)
1391
self._write_inventory(inv)
1393
class _RenameEntry(object):
1394
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1395
to_rel, to_tail, to_parent_id, only_change_inv=False):
1396
self.from_rel = from_rel
1397
self.from_id = from_id
1398
self.from_tail = from_tail
1399
self.from_parent_id = from_parent_id
1400
self.to_rel = to_rel
1401
self.to_tail = to_tail
1402
self.to_parent_id = to_parent_id
1403
self.only_change_inv = only_change_inv
1407
"""Return all unknown files.
1409
These are files in the working directory that are not versioned or
1410
control files or ignored.
1412
# force the extras method to be fully executed before returning, to
1413
# prevent race conditions with the lock
1415
[subp for subp in self.extras() if not self.is_ignored(subp)])
1417
@needs_tree_write_lock
1418
def unversion(self, file_ids):
1419
"""Remove the file ids in file_ids from the current versioned set.
1421
When a file_id is unversioned, all of its children are automatically
1424
:param file_ids: The file ids to stop versioning.
1425
:raises: NoSuchId if any fileid is not currently versioned.
1427
for file_id in file_ids:
1428
file_id = osutils.safe_file_id(file_id)
1429
if self._inventory.has_id(file_id):
1430
self._inventory.remove_recursive_id(file_id)
1432
raise errors.NoSuchId(self, file_id)
1434
# in the future this should just set a dirty bit to wait for the
1435
# final unlock. However, until all methods of workingtree start
1436
# with the current in -memory inventory rather than triggering
1437
# a read, it is more complex - we need to teach read_inventory
1438
# to know when to read, and when to not read first... and possibly
1439
# to save first when the in memory one may be corrupted.
1440
# so for now, we just only write it if it is indeed dirty.
1442
self._write_inventory(self._inventory)
1444
@deprecated_method(zero_eight)
1445
def iter_conflicts(self):
1446
"""List all files in the tree that have text or content conflicts.
1447
DEPRECATED. Use conflicts instead."""
1448
return self._iter_conflicts()
1450
def _iter_conflicts(self):
1452
for info in self.list_files():
1454
stem = get_conflicted_stem(path)
1457
if stem not in conflicted:
1458
conflicted.add(stem)
1462
def pull(self, source, overwrite=False, stop_revision=None,
1463
change_reporter=None):
1464
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1467
pp = ProgressPhase("Pull phase", 2, top_pb)
1469
old_revision_info = self.branch.last_revision_info()
1470
basis_tree = self.basis_tree()
1471
count = self.branch.pull(source, overwrite, stop_revision)
1472
new_revision_info = self.branch.last_revision_info()
1473
if new_revision_info != old_revision_info:
1475
repository = self.branch.repository
1476
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1477
basis_tree.lock_read()
1479
new_basis_tree = self.branch.basis_tree()
1486
change_reporter=change_reporter)
1487
if (basis_tree.inventory.root is None and
1488
new_basis_tree.inventory.root is not None):
1489
self.set_root_id(new_basis_tree.inventory.root.file_id)
1493
# TODO - dedup parents list with things merged by pull ?
1494
# reuse the revisiontree we merged against to set the new
1496
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1497
# we have to pull the merge trees out again, because
1498
# merge_inner has set the ids. - this corner is not yet
1499
# layered well enough to prevent double handling.
1500
# XXX TODO: Fix the double handling: telling the tree about
1501
# the already known parent data is wasteful.
1502
merges = self.get_parent_ids()[1:]
1503
parent_trees.extend([
1504
(parent, repository.revision_tree(parent)) for
1506
self.set_parent_trees(parent_trees)
1513
def put_file_bytes_non_atomic(self, file_id, bytes):
1514
"""See MutableTree.put_file_bytes_non_atomic."""
1515
file_id = osutils.safe_file_id(file_id)
1516
stream = file(self.id2abspath(file_id), 'wb')
1521
# TODO: update the hashcache here ?
1524
"""Yield all unversioned files in this WorkingTree.
1526
If there are any unversioned directories then only the directory is
1527
returned, not all its children. But if there are unversioned files
1528
under a versioned subdirectory, they are returned.
1530
Currently returned depth-first, sorted by name within directories.
1531
This is the same order used by 'osutils.walkdirs'.
1533
## TODO: Work from given directory downwards
1534
for path, dir_entry in self.inventory.directories():
1535
# mutter("search for unknowns in %r", path)
1536
dirabs = self.abspath(path)
1537
if not isdir(dirabs):
1538
# e.g. directory deleted
1542
for subf in os.listdir(dirabs):
1545
if subf not in dir_entry.children:
1546
subf_norm, can_access = osutils.normalized_filename(subf)
1547
if subf_norm != subf and can_access:
1548
if subf_norm not in dir_entry.children:
1549
fl.append(subf_norm)
1555
subp = pathjoin(path, subf)
1558
def ignored_files(self):
1559
"""Yield list of PATH, IGNORE_PATTERN"""
1560
for subp in self.extras():
1561
pat = self.is_ignored(subp)
1565
def get_ignore_list(self):
1566
"""Return list of ignore patterns.
1568
Cached in the Tree object after the first call.
1570
ignoreset = getattr(self, '_ignoreset', None)
1571
if ignoreset is not None:
1574
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1575
ignore_globs.update(ignores.get_runtime_ignores())
1576
ignore_globs.update(ignores.get_user_ignores())
1577
if self.has_filename(bzrlib.IGNORE_FILENAME):
1578
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1580
ignore_globs.update(ignores.parse_ignore_file(f))
1583
self._ignoreset = ignore_globs
1586
def _flush_ignore_list_cache(self):
1587
"""Resets the cached ignore list to force a cache rebuild."""
1588
self._ignoreset = None
1589
self._ignoreglobster = None
1591
def is_ignored(self, filename):
1592
r"""Check whether the filename matches an ignore pattern.
1594
Patterns containing '/' or '\' need to match the whole path;
1595
others match against only the last component.
1597
If the file is ignored, returns the pattern which caused it to
1598
be ignored, otherwise None. So this can simply be used as a
1599
boolean if desired."""
1600
if getattr(self, '_ignoreglobster', None) is None:
1601
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1602
return self._ignoreglobster.match(filename)
1604
def kind(self, file_id):
1605
return file_kind(self.id2abspath(file_id))
1607
def _comparison_data(self, entry, path):
1608
abspath = self.abspath(path)
1610
stat_value = os.lstat(abspath)
1612
if getattr(e, 'errno', None) == errno.ENOENT:
1619
mode = stat_value.st_mode
1620
kind = osutils.file_kind_from_stat_mode(mode)
1621
if not supports_executable():
1622
executable = entry.executable
1624
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1625
return kind, executable, stat_value
1627
def _file_size(self, entry, stat_value):
1628
return stat_value.st_size
1630
def last_revision(self):
1631
"""Return the last revision of the branch for this tree.
1633
This format tree does not support a separate marker for last-revision
1634
compared to the branch.
1636
See MutableTree.last_revision
1638
return self._last_revision()
1641
def _last_revision(self):
1642
"""helper for get_parent_ids."""
1643
return self.branch.last_revision()
1645
def is_locked(self):
1646
return self._control_files.is_locked()
1648
def _must_be_locked(self):
1649
if not self.is_locked():
1650
raise errors.ObjectNotLocked(self)
1652
def lock_read(self):
1653
"""See Branch.lock_read, and WorkingTree.unlock."""
1654
if not self.is_locked():
1656
self.branch.lock_read()
1658
return self._control_files.lock_read()
1660
self.branch.unlock()
1663
def lock_tree_write(self):
1664
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1665
if not self.is_locked():
1667
self.branch.lock_read()
1669
return self._control_files.lock_write()
1671
self.branch.unlock()
1674
def lock_write(self):
1675
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1676
if not self.is_locked():
1678
self.branch.lock_write()
1680
return self._control_files.lock_write()
1682
self.branch.unlock()
1685
def get_physical_lock_status(self):
1686
return self._control_files.get_physical_lock_status()
1688
def _basis_inventory_name(self):
1689
return 'basis-inventory-cache'
1691
def _reset_data(self):
1692
"""Reset transient data that cannot be revalidated."""
1693
self._inventory_is_modified = False
1694
result = self._deserialize(self._control_files.get('inventory'))
1695
self._set_inventory(result, dirty=False)
1697
@needs_tree_write_lock
1698
def set_last_revision(self, new_revision):
1699
"""Change the last revision in the working tree."""
1700
new_revision = osutils.safe_revision_id(new_revision)
1701
if self._change_last_revision(new_revision):
1702
self._cache_basis_inventory(new_revision)
1704
def _change_last_revision(self, new_revision):
1705
"""Template method part of set_last_revision to perform the change.
1707
This is used to allow WorkingTree3 instances to not affect branch
1708
when their last revision is set.
1710
if new_revision is None:
1711
self.branch.set_revision_history([])
1714
self.branch.generate_revision_history(new_revision)
1715
except errors.NoSuchRevision:
1716
# not present in the repo - dont try to set it deeper than the tip
1717
self.branch.set_revision_history([new_revision])
1720
def _write_basis_inventory(self, xml):
1721
"""Write the basis inventory XML to the basis-inventory file"""
1722
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1723
path = self._basis_inventory_name()
1725
self._control_files.put(path, sio)
1727
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1728
"""Create the text that will be saved in basis-inventory"""
1729
# TODO: jam 20070209 This should be redundant, as the revision_id
1730
# as all callers should have already converted the revision_id to
1732
inventory.revision_id = osutils.safe_revision_id(revision_id)
1733
return xml7.serializer_v7.write_inventory_to_string(inventory)
1735
def _cache_basis_inventory(self, new_revision):
1736
"""Cache new_revision as the basis inventory."""
1737
# TODO: this should allow the ready-to-use inventory to be passed in,
1738
# as commit already has that ready-to-use [while the format is the
1741
# this double handles the inventory - unpack and repack -
1742
# but is easier to understand. We can/should put a conditional
1743
# in here based on whether the inventory is in the latest format
1744
# - perhaps we should repack all inventories on a repository
1746
# the fast path is to copy the raw xml from the repository. If the
1747
# xml contains 'revision_id="', then we assume the right
1748
# revision_id is set. We must check for this full string, because a
1749
# root node id can legitimately look like 'revision_id' but cannot
1751
xml = self.branch.repository.get_inventory_xml(new_revision)
1752
firstline = xml.split('\n', 1)[0]
1753
if (not 'revision_id="' in firstline or
1754
'format="7"' not in firstline):
1755
inv = self.branch.repository.deserialise_inventory(
1757
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1758
self._write_basis_inventory(xml)
1759
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1762
def read_basis_inventory(self):
1763
"""Read the cached basis inventory."""
1764
path = self._basis_inventory_name()
1765
return self._control_files.get(path).read()
1768
def read_working_inventory(self):
1769
"""Read the working inventory.
1771
:raises errors.InventoryModified: read_working_inventory will fail
1772
when the current in memory inventory has been modified.
1774
# conceptually this should be an implementation detail of the tree.
1775
# XXX: Deprecate this.
1776
# ElementTree does its own conversion from UTF-8, so open in
1778
if self._inventory_is_modified:
1779
raise errors.InventoryModified(self)
1780
result = self._deserialize(self._control_files.get('inventory'))
1781
self._set_inventory(result, dirty=False)
1784
@needs_tree_write_lock
1785
def remove(self, files, verbose=False, to_file=None):
1786
"""Remove nominated files from the working inventory..
1788
This does not remove their text. This does not run on XXX on what? RBC
1790
TODO: Refuse to remove modified files unless --force is given?
1792
TODO: Do something useful with directories.
1794
TODO: Should this remove the text or not? Tough call; not
1795
removing may be useful and the user can just use use rm, and
1796
is the opposite of add. Removing it is consistent with most
1797
other tools. Maybe an option.
1799
## TODO: Normalize names
1800
## TODO: Remove nested loops; better scalability
1801
if isinstance(files, basestring):
1804
inv = self.inventory
1806
# do this before any modifications
1808
fid = inv.path2id(f)
1810
note("%s is not versioned."%f)
1813
# having remove it, it must be either ignored or unknown
1814
if self.is_ignored(f):
1818
textui.show_status(new_status, inv[fid].kind, f,
1822
self._write_inventory(inv)
1824
@needs_tree_write_lock
1825
def revert(self, filenames, old_tree=None, backups=True,
1826
pb=DummyProgress(), report_changes=False):
1827
from bzrlib.conflicts import resolve
1828
if old_tree is None:
1829
old_tree = self.basis_tree()
1830
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1832
if not len(filenames):
1833
self.set_parent_ids(self.get_parent_ids()[:1])
1836
resolve(self, filenames, ignore_misses=True)
1839
def revision_tree(self, revision_id):
1840
"""See Tree.revision_tree.
1842
WorkingTree can supply revision_trees for the basis revision only
1843
because there is only one cached inventory in the bzr directory.
1845
if revision_id == self.last_revision():
1847
xml = self.read_basis_inventory()
1848
except errors.NoSuchFile:
1852
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1853
# dont use the repository revision_tree api because we want
1854
# to supply the inventory.
1855
if inv.revision_id == revision_id:
1856
return revisiontree.RevisionTree(self.branch.repository,
1858
except errors.BadInventoryFormat:
1860
# raise if there was no inventory, or if we read the wrong inventory.
1861
raise errors.NoSuchRevisionInTree(self, revision_id)
1863
# XXX: This method should be deprecated in favour of taking in a proper
1864
# new Inventory object.
1865
@needs_tree_write_lock
1866
def set_inventory(self, new_inventory_list):
1867
from bzrlib.inventory import (Inventory,
1872
inv = Inventory(self.get_root_id())
1873
for path, file_id, parent, kind in new_inventory_list:
1874
name = os.path.basename(path)
1877
# fixme, there should be a factory function inv,add_??
1878
if kind == 'directory':
1879
inv.add(InventoryDirectory(file_id, name, parent))
1880
elif kind == 'file':
1881
inv.add(InventoryFile(file_id, name, parent))
1882
elif kind == 'symlink':
1883
inv.add(InventoryLink(file_id, name, parent))
1885
raise errors.BzrError("unknown kind %r" % kind)
1886
self._write_inventory(inv)
1888
@needs_tree_write_lock
1889
def set_root_id(self, file_id):
1890
"""Set the root id for this tree."""
1893
symbol_versioning.warn(symbol_versioning.zero_twelve
1894
% 'WorkingTree.set_root_id with fileid=None',
1899
file_id = osutils.safe_file_id(file_id)
1900
self._set_root_id(file_id)
1902
def _set_root_id(self, file_id):
1903
"""Set the root id for this tree, in a format specific manner.
1905
:param file_id: The file id to assign to the root. It must not be
1906
present in the current inventory or an error will occur. It must
1907
not be None, but rather a valid file id.
1909
inv = self._inventory
1910
orig_root_id = inv.root.file_id
1911
# TODO: it might be nice to exit early if there was nothing
1912
# to do, saving us from trigger a sync on unlock.
1913
self._inventory_is_modified = True
1914
# we preserve the root inventory entry object, but
1915
# unlinkit from the byid index
1916
del inv._byid[inv.root.file_id]
1917
inv.root.file_id = file_id
1918
# and link it into the index with the new changed id.
1919
inv._byid[inv.root.file_id] = inv.root
1920
# and finally update all children to reference the new id.
1921
# XXX: this should be safe to just look at the root.children
1922
# list, not the WHOLE INVENTORY.
1925
if entry.parent_id == orig_root_id:
1926
entry.parent_id = inv.root.file_id
1929
"""See Branch.unlock.
1931
WorkingTree locking just uses the Branch locking facilities.
1932
This is current because all working trees have an embedded branch
1933
within them. IF in the future, we were to make branch data shareable
1934
between multiple working trees, i.e. via shared storage, then we
1935
would probably want to lock both the local tree, and the branch.
1937
raise NotImplementedError(self.unlock)
1940
"""Update a working tree along its branch.
1942
This will update the branch if its bound too, which means we have
1943
multiple trees involved:
1945
- The new basis tree of the master.
1946
- The old basis tree of the branch.
1947
- The old basis tree of the working tree.
1948
- The current working tree state.
1950
Pathologically, all three may be different, and non-ancestors of each
1951
other. Conceptually we want to:
1953
- Preserve the wt.basis->wt.state changes
1954
- Transform the wt.basis to the new master basis.
1955
- Apply a merge of the old branch basis to get any 'local' changes from
1957
- Restore the wt.basis->wt.state changes.
1959
There isn't a single operation at the moment to do that, so we:
1960
- Merge current state -> basis tree of the master w.r.t. the old tree
1962
- Do a 'normal' merge of the old branch basis if it is relevant.
1964
if self.branch.get_master_branch() is not None:
1966
update_branch = True
1968
self.lock_tree_write()
1969
update_branch = False
1972
old_tip = self.branch.update()
1975
return self._update_tree(old_tip)
1979
@needs_tree_write_lock
1980
def _update_tree(self, old_tip=None):
1981
"""Update a tree to the master branch.
1983
:param old_tip: if supplied, the previous tip revision the branch,
1984
before it was changed to the master branch's tip.
1986
# here if old_tip is not None, it is the old tip of the branch before
1987
# it was updated from the master branch. This should become a pending
1988
# merge in the working tree to preserve the user existing work. we
1989
# cant set that until we update the working trees last revision to be
1990
# one from the new branch, because it will just get absorbed by the
1991
# parent de-duplication logic.
1993
# We MUST save it even if an error occurs, because otherwise the users
1994
# local work is unreferenced and will appear to have been lost.
1998
last_rev = self.get_parent_ids()[0]
2001
if last_rev != self.branch.last_revision():
2002
# merge tree state up to new branch tip.
2003
basis = self.basis_tree()
2006
to_tree = self.branch.basis_tree()
2007
if basis.inventory.root is None:
2008
self.set_root_id(to_tree.inventory.root.file_id)
2010
result += merge.merge_inner(
2017
# TODO - dedup parents list with things merged by pull ?
2018
# reuse the tree we've updated to to set the basis:
2019
parent_trees = [(self.branch.last_revision(), to_tree)]
2020
merges = self.get_parent_ids()[1:]
2021
# Ideally we ask the tree for the trees here, that way the working
2022
# tree can decide whether to give us teh entire tree or give us a
2023
# lazy initialised tree. dirstate for instance will have the trees
2024
# in ram already, whereas a last-revision + basis-inventory tree
2025
# will not, but also does not need them when setting parents.
2026
for parent in merges:
2027
parent_trees.append(
2028
(parent, self.branch.repository.revision_tree(parent)))
2029
if old_tip is not None:
2030
parent_trees.append(
2031
(old_tip, self.branch.repository.revision_tree(old_tip)))
2032
self.set_parent_trees(parent_trees)
2033
last_rev = parent_trees[0][0]
2035
# the working tree had the same last-revision as the master
2036
# branch did. We may still have pivot local work from the local
2037
# branch into old_tip:
2038
if old_tip is not None:
2039
self.add_parent_tree_id(old_tip)
2040
if old_tip and old_tip != last_rev:
2041
# our last revision was not the prior branch last revision
2042
# and we have converted that last revision to a pending merge.
2043
# base is somewhere between the branch tip now
2044
# and the now pending merge
2046
# Since we just modified the working tree and inventory, flush out
2047
# the current state, before we modify it again.
2048
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2049
# requires it only because TreeTransform directly munges the
2050
# inventory and calls tree._write_inventory(). Ultimately we
2051
# should be able to remove this extra flush.
2053
from bzrlib.revision import common_ancestor
2055
base_rev_id = common_ancestor(self.branch.last_revision(),
2057
self.branch.repository)
2058
except errors.NoCommonAncestor:
2060
base_tree = self.branch.repository.revision_tree(base_rev_id)
2061
other_tree = self.branch.repository.revision_tree(old_tip)
2062
result += merge.merge_inner(
2069
def _write_hashcache_if_dirty(self):
2070
"""Write out the hashcache if it is dirty."""
2071
if self._hashcache.needs_write:
2073
self._hashcache.write()
2075
if e.errno not in (errno.EPERM, errno.EACCES):
2077
# TODO: jam 20061219 Should this be a warning? A single line
2078
# warning might be sufficient to let the user know what
2080
mutter('Could not write hashcache for %s\nError: %s',
2081
self._hashcache.cache_file_name(), e)
2083
@needs_tree_write_lock
2084
def _write_inventory(self, inv):
2085
"""Write inventory as the current inventory."""
2086
self._set_inventory(inv, dirty=True)
2089
def set_conflicts(self, arg):
2090
raise errors.UnsupportedOperation(self.set_conflicts, self)
2092
def add_conflicts(self, arg):
2093
raise errors.UnsupportedOperation(self.add_conflicts, self)
2096
def conflicts(self):
2097
conflicts = _mod_conflicts.ConflictList()
2098
for conflicted in self._iter_conflicts():
2101
if file_kind(self.abspath(conflicted)) != "file":
2103
except errors.NoSuchFile:
2106
for suffix in ('.THIS', '.OTHER'):
2108
kind = file_kind(self.abspath(conflicted+suffix))
2111
except errors.NoSuchFile:
2115
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2116
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2118
file_id=self.path2id(conflicted)))
2121
def walkdirs(self, prefix=""):
2122
"""Walk the directories of this tree.
2124
This API returns a generator, which is only valid during the current
2125
tree transaction - within a single lock_read or lock_write duration.
2127
If the tree is not locked, it may cause an error to be raised, depending
2128
on the tree implementation.
2130
disk_top = self.abspath(prefix)
2131
if disk_top.endswith('/'):
2132
disk_top = disk_top[:-1]
2133
top_strip_len = len(disk_top) + 1
2134
inventory_iterator = self._walkdirs(prefix)
2135
disk_iterator = osutils.walkdirs(disk_top, prefix)
2137
current_disk = disk_iterator.next()
2138
disk_finished = False
2140
if e.errno != errno.ENOENT:
2143
disk_finished = True
2145
current_inv = inventory_iterator.next()
2146
inv_finished = False
2147
except StopIteration:
2150
while not inv_finished or not disk_finished:
2151
if not disk_finished:
2152
# strip out .bzr dirs
2153
if current_disk[0][1][top_strip_len:] == '':
2154
# osutils.walkdirs can be made nicer -
2155
# yield the path-from-prefix rather than the pathjoined
2157
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2158
if current_disk[1][bzrdir_loc][0] == '.bzr':
2159
# we dont yield the contents of, or, .bzr itself.
2160
del current_disk[1][bzrdir_loc]
2162
# everything is unknown
2165
# everything is missing
2168
direction = cmp(current_inv[0][0], current_disk[0][0])
2170
# disk is before inventory - unknown
2171
dirblock = [(relpath, basename, kind, stat, None, None) for
2172
relpath, basename, kind, stat, top_path in current_disk[1]]
2173
yield (current_disk[0][0], None), dirblock
2175
current_disk = disk_iterator.next()
2176
except StopIteration:
2177
disk_finished = True
2179
# inventory is before disk - missing.
2180
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2181
for relpath, basename, dkind, stat, fileid, kind in
2183
yield (current_inv[0][0], current_inv[0][1]), dirblock
2185
current_inv = inventory_iterator.next()
2186
except StopIteration:
2189
# versioned present directory
2190
# merge the inventory and disk data together
2192
for relpath, subiterator in itertools.groupby(sorted(
2193
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2194
path_elements = list(subiterator)
2195
if len(path_elements) == 2:
2196
inv_row, disk_row = path_elements
2197
# versioned, present file
2198
dirblock.append((inv_row[0],
2199
inv_row[1], disk_row[2],
2200
disk_row[3], inv_row[4],
2202
elif len(path_elements[0]) == 5:
2204
dirblock.append((path_elements[0][0],
2205
path_elements[0][1], path_elements[0][2],
2206
path_elements[0][3], None, None))
2207
elif len(path_elements[0]) == 6:
2208
# versioned, absent file.
2209
dirblock.append((path_elements[0][0],
2210
path_elements[0][1], 'unknown', None,
2211
path_elements[0][4], path_elements[0][5]))
2213
raise NotImplementedError('unreachable code')
2214
yield current_inv[0], dirblock
2216
current_inv = inventory_iterator.next()
2217
except StopIteration:
2220
current_disk = disk_iterator.next()
2221
except StopIteration:
2222
disk_finished = True
2224
def _walkdirs(self, prefix=""):
2225
_directory = 'directory'
2226
# get the root in the inventory
2227
inv = self.inventory
2228
top_id = inv.path2id(prefix)
2232
pending = [(prefix, '', _directory, None, top_id, None)]
2235
currentdir = pending.pop()
2236
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2237
top_id = currentdir[4]
2239
relroot = currentdir[0] + '/'
2242
# FIXME: stash the node in pending
2244
for name, child in entry.sorted_children():
2245
dirblock.append((relroot + name, name, child.kind, None,
2246
child.file_id, child.kind
2248
yield (currentdir[0], entry.file_id), dirblock
2249
# push the user specified dirs from dirblock
2250
for dir in reversed(dirblock):
2251
if dir[2] == _directory:
2255
class WorkingTree2(WorkingTree):
2256
"""This is the Format 2 working tree.
2258
This was the first weave based working tree.
2259
- uses os locks for locking.
2260
- uses the branch last-revision.
2263
def lock_tree_write(self):
2264
"""See WorkingTree.lock_tree_write().
2266
In Format2 WorkingTrees we have a single lock for the branch and tree
2267
so lock_tree_write() degrades to lock_write().
2269
self.branch.lock_write()
2271
return self._control_files.lock_write()
2273
self.branch.unlock()
2277
# we share control files:
2278
if self._control_files._lock_count == 3:
2279
# _inventory_is_modified is always False during a read lock.
2280
if self._inventory_is_modified:
2282
self._write_hashcache_if_dirty()
2284
# reverse order of locking.
2286
return self._control_files.unlock()
2288
self.branch.unlock()
2291
class WorkingTree3(WorkingTree):
2292
"""This is the Format 3 working tree.
2294
This differs from the base WorkingTree by:
2295
- having its own file lock
2296
- having its own last-revision property.
2298
This is new in bzr 0.8
2302
def _last_revision(self):
2303
"""See Mutable.last_revision."""
2305
return osutils.safe_revision_id(
2306
self._control_files.get('last-revision').read())
2307
except errors.NoSuchFile:
2310
def _change_last_revision(self, revision_id):
2311
"""See WorkingTree._change_last_revision."""
2312
if revision_id is None or revision_id == NULL_REVISION:
2314
self._control_files._transport.delete('last-revision')
2315
except errors.NoSuchFile:
2319
self._control_files.put_bytes('last-revision', revision_id)
2322
@needs_tree_write_lock
2323
def set_conflicts(self, conflicts):
2324
self._put_rio('conflicts', conflicts.to_stanzas(),
2327
@needs_tree_write_lock
2328
def add_conflicts(self, new_conflicts):
2329
conflict_set = set(self.conflicts())
2330
conflict_set.update(set(list(new_conflicts)))
2331
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2332
key=_mod_conflicts.Conflict.sort_key)))
2335
def conflicts(self):
2337
confile = self._control_files.get('conflicts')
2338
except errors.NoSuchFile:
2339
return _mod_conflicts.ConflictList()
2341
if confile.next() != CONFLICT_HEADER_1 + '\n':
2342
raise errors.ConflictFormatError()
2343
except StopIteration:
2344
raise errors.ConflictFormatError()
2345
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2348
if self._control_files._lock_count == 1:
2349
# _inventory_is_modified is always False during a read lock.
2350
if self._inventory_is_modified:
2352
self._write_hashcache_if_dirty()
2353
# reverse order of locking.
2355
return self._control_files.unlock()
2357
self.branch.unlock()
2360
def get_conflicted_stem(path):
2361
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2362
if path.endswith(suffix):
2363
return path[:-len(suffix)]
2366
@deprecated_function(zero_eight)
2367
def is_control_file(filename):
2368
"""See WorkingTree.is_control_filename(filename)."""
2369
## FIXME: better check
2370
filename = normpath(filename)
2371
while filename != '':
2372
head, tail = os.path.split(filename)
2373
## mutter('check %r for control file' % ((head, tail),))
2376
if filename == head:
2382
class WorkingTreeFormat(object):
2383
"""An encapsulation of the initialization and open routines for a format.
2385
Formats provide three things:
2386
* An initialization routine,
2390
Formats are placed in an dict by their format string for reference
2391
during workingtree opening. Its not required that these be instances, they
2392
can be classes themselves with class methods - it simply depends on
2393
whether state is needed for a given format or not.
2395
Once a format is deprecated, just deprecate the initialize and open
2396
methods on the format class. Do not deprecate the object, as the
2397
object will be created every time regardless.
2400
_default_format = None
2401
"""The default format used for new trees."""
2404
"""The known formats."""
2406
requires_rich_root = False
2409
def find_format(klass, a_bzrdir):
2410
"""Return the format for the working tree object in a_bzrdir."""
2412
transport = a_bzrdir.get_workingtree_transport(None)
2413
format_string = transport.get("format").read()
2414
return klass._formats[format_string]
2415
except errors.NoSuchFile:
2416
raise errors.NoWorkingTree(base=transport.base)
2418
raise errors.UnknownFormatError(format=format_string)
2420
def __eq__(self, other):
2421
return self.__class__ is other.__class__
2423
def __ne__(self, other):
2424
return not (self == other)
2427
def get_default_format(klass):
2428
"""Return the current default format."""
2429
return klass._default_format
2431
def get_format_string(self):
2432
"""Return the ASCII format string that identifies this format."""
2433
raise NotImplementedError(self.get_format_string)
2435
def get_format_description(self):
2436
"""Return the short description for this format."""
2437
raise NotImplementedError(self.get_format_description)
2439
def is_supported(self):
2440
"""Is this format supported?
2442
Supported formats can be initialized and opened.
2443
Unsupported formats may not support initialization or committing or
2444
some other features depending on the reason for not being supported.
2449
def register_format(klass, format):
2450
klass._formats[format.get_format_string()] = format
2453
def set_default_format(klass, format):
2454
klass._default_format = format
2457
def unregister_format(klass, format):
2458
assert klass._formats[format.get_format_string()] is format
2459
del klass._formats[format.get_format_string()]
2463
class WorkingTreeFormat2(WorkingTreeFormat):
2464
"""The second working tree format.
2466
This format modified the hash cache from the format 1 hash cache.
2469
def get_format_description(self):
2470
"""See WorkingTreeFormat.get_format_description()."""
2471
return "Working tree format 2"
2473
def stub_initialize_remote(self, control_files):
2474
"""As a special workaround create critical control files for a remote working tree
2476
This ensures that it can later be updated and dealt with locally,
2477
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2478
no working tree. (See bug #43064).
2482
xml5.serializer_v5.write_inventory(inv, sio)
2484
control_files.put('inventory', sio)
2486
control_files.put_bytes('pending-merges', '')
2489
def initialize(self, a_bzrdir, revision_id=None):
2490
"""See WorkingTreeFormat.initialize()."""
2491
if not isinstance(a_bzrdir.transport, LocalTransport):
2492
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2493
branch = a_bzrdir.open_branch()
2494
if revision_id is not None:
2495
revision_id = osutils.safe_revision_id(revision_id)
2498
revision_history = branch.revision_history()
2500
position = revision_history.index(revision_id)
2502
raise errors.NoSuchRevision(branch, revision_id)
2503
branch.set_revision_history(revision_history[:position + 1])
2506
revision = branch.last_revision()
2508
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2514
basis_tree = branch.repository.revision_tree(revision)
2515
if basis_tree.inventory.root is not None:
2516
wt.set_root_id(basis_tree.inventory.root.file_id)
2517
# set the parent list and cache the basis tree.
2518
wt.set_parent_trees([(revision, basis_tree)])
2519
transform.build_tree(basis_tree, wt)
2523
super(WorkingTreeFormat2, self).__init__()
2524
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2526
def open(self, a_bzrdir, _found=False):
2527
"""Return the WorkingTree object for a_bzrdir
2529
_found is a private parameter, do not use it. It is used to indicate
2530
if format probing has already been done.
2533
# we are being called directly and must probe.
2534
raise NotImplementedError
2535
if not isinstance(a_bzrdir.transport, LocalTransport):
2536
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2537
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2543
class WorkingTreeFormat3(WorkingTreeFormat):
2544
"""The second working tree format updated to record a format marker.
2547
- exists within a metadir controlling .bzr
2548
- includes an explicit version marker for the workingtree control
2549
files, separate from the BzrDir format
2550
- modifies the hash cache format
2552
- uses a LockDir to guard access for writes.
2555
def get_format_string(self):
2556
"""See WorkingTreeFormat.get_format_string()."""
2557
return "Bazaar-NG Working Tree format 3"
2559
def get_format_description(self):
2560
"""See WorkingTreeFormat.get_format_description()."""
2561
return "Working tree format 3"
2563
_lock_file_name = 'lock'
2564
_lock_class = LockDir
2566
_tree_class = WorkingTree3
2568
def __get_matchingbzrdir(self):
2569
return bzrdir.BzrDirMetaFormat1()
2571
_matchingbzrdir = property(__get_matchingbzrdir)
2573
def _open_control_files(self, a_bzrdir):
2574
transport = a_bzrdir.get_workingtree_transport(None)
2575
return LockableFiles(transport, self._lock_file_name,
2578
def initialize(self, a_bzrdir, revision_id=None):
2579
"""See WorkingTreeFormat.initialize().
2581
revision_id allows creating a working tree at a different
2582
revision than the branch is at.
2584
if not isinstance(a_bzrdir.transport, LocalTransport):
2585
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2586
transport = a_bzrdir.get_workingtree_transport(self)
2587
control_files = self._open_control_files(a_bzrdir)
2588
control_files.create_lock()
2589
control_files.lock_write()
2590
control_files.put_utf8('format', self.get_format_string())
2591
branch = a_bzrdir.open_branch()
2592
if revision_id is None:
2593
revision_id = branch.last_revision()
2595
revision_id = osutils.safe_revision_id(revision_id)
2596
# WorkingTree3 can handle an inventory which has a unique root id.
2597
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2598
# those trees. And because there isn't a format bump inbetween, we
2599
# are maintaining compatibility with older clients.
2600
# inv = Inventory(root_id=gen_root_id())
2601
inv = self._initial_inventory()
2602
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2608
_control_files=control_files)
2609
wt.lock_tree_write()
2611
basis_tree = branch.repository.revision_tree(revision_id)
2612
# only set an explicit root id if there is one to set.
2613
if basis_tree.inventory.root is not None:
2614
wt.set_root_id(basis_tree.inventory.root.file_id)
2615
if revision_id == NULL_REVISION:
2616
wt.set_parent_trees([])
2618
wt.set_parent_trees([(revision_id, basis_tree)])
2619
transform.build_tree(basis_tree, wt)
2621
# Unlock in this order so that the unlock-triggers-flush in
2622
# WorkingTree is given a chance to fire.
2623
control_files.unlock()
2627
def _initial_inventory(self):
2631
super(WorkingTreeFormat3, self).__init__()
2633
def open(self, a_bzrdir, _found=False):
2634
"""Return the WorkingTree object for a_bzrdir
2636
_found is a private parameter, do not use it. It is used to indicate
2637
if format probing has already been done.
2640
# we are being called directly and must probe.
2641
raise NotImplementedError
2642
if not isinstance(a_bzrdir.transport, LocalTransport):
2643
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2644
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2646
def _open(self, a_bzrdir, control_files):
2647
"""Open the tree itself.
2649
:param a_bzrdir: the dir for the tree.
2650
:param control_files: the control files for the tree.
2652
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2656
_control_files=control_files)
2659
return self.get_format_string()
2662
__default_format = WorkingTreeFormat4()
2663
WorkingTreeFormat.register_format(__default_format)
2664
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2665
WorkingTreeFormat.set_default_format(__default_format)
2666
# formats which have no format string are not discoverable
2667
# and not independently creatable, so are not registered.
2668
_legacy_formats = [WorkingTreeFormat2(),
2672
class WorkingTreeTestProviderAdapter(object):
2673
"""A tool to generate a suite testing multiple workingtree formats at once.
2675
This is done by copying the test once for each transport and injecting
2676
the transport_server, transport_readonly_server, and workingtree_format
2677
classes into each copy. Each copy is also given a new id() to make it
2681
def __init__(self, transport_server, transport_readonly_server, formats):
2682
self._transport_server = transport_server
2683
self._transport_readonly_server = transport_readonly_server
2684
self._formats = formats
2686
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2687
"""Clone test for adaption."""
2688
new_test = deepcopy(test)
2689
new_test.transport_server = self._transport_server
2690
new_test.transport_readonly_server = self._transport_readonly_server
2691
new_test.bzrdir_format = bzrdir_format
2692
new_test.workingtree_format = workingtree_format
2693
def make_new_test_id():
2694
new_id = "%s(%s)" % (test.id(), variation)
2695
return lambda: new_id
2696
new_test.id = make_new_test_id()
2699
def adapt(self, test):
2700
from bzrlib.tests import TestSuite
2701
result = TestSuite()
2702
for workingtree_format, bzrdir_format in self._formats:
2703
new_test = self._clone_test(
2706
workingtree_format, workingtree_format.__class__.__name__)
2707
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
