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,
80
from bzrlib.transport import get_transport
82
from bzrlib.workingtree_4 import WorkingTreeFormat4
85
from bzrlib import symbol_versioning
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
from bzrlib.lockable_files import LockableFiles, TransportLock
89
from bzrlib.lockdir import LockDir
90
import bzrlib.mutabletree
91
from bzrlib.mutabletree import needs_tree_write_lock
92
from bzrlib.osutils import (
104
from bzrlib.trace import mutter, note
105
from bzrlib.transport.local import LocalTransport
106
from bzrlib.progress import DummyProgress, ProgressPhase
107
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
108
from bzrlib.rio import RioReader, rio_file, Stanza
109
from bzrlib.symbol_versioning import (deprecated_passed,
112
DEPRECATED_PARAMETER,
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
@deprecated_function(zero_thirteen)
124
def gen_file_id(name):
125
"""Return new file id for the basename 'name'.
127
Use bzrlib.generate_ids.gen_file_id() instead
129
return generate_ids.gen_file_id(name)
132
@deprecated_function(zero_thirteen)
134
"""Return a new tree-root file id.
136
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
138
return generate_ids.gen_root_id()
141
class TreeEntry(object):
142
"""An entry that implements the minimum interface used by commands.
144
This needs further inspection, it may be better to have
145
InventoryEntries without ids - though that seems wrong. For now,
146
this is a parallel hierarchy to InventoryEntry, and needs to become
147
one of several things: decorates to that hierarchy, children of, or
149
Another note is that these objects are currently only used when there is
150
no InventoryEntry available - i.e. for unversioned objects.
151
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
154
def __eq__(self, other):
155
# yes, this us ugly, TODO: best practice __eq__ style.
156
return (isinstance(other, TreeEntry)
157
and other.__class__ == self.__class__)
159
def kind_character(self):
163
class TreeDirectory(TreeEntry):
164
"""See TreeEntry. This is a directory in a working tree."""
166
def __eq__(self, other):
167
return (isinstance(other, TreeDirectory)
168
and other.__class__ == self.__class__)
170
def kind_character(self):
174
class TreeFile(TreeEntry):
175
"""See TreeEntry. This is a regular file in a working tree."""
177
def __eq__(self, other):
178
return (isinstance(other, TreeFile)
179
and other.__class__ == self.__class__)
181
def kind_character(self):
185
class TreeLink(TreeEntry):
186
"""See TreeEntry. This is a symlink in a working tree."""
188
def __eq__(self, other):
189
return (isinstance(other, TreeLink)
190
and other.__class__ == self.__class__)
192
def kind_character(self):
196
class WorkingTree(bzrlib.mutabletree.MutableTree):
197
"""Working copy tree.
199
The inventory is held in the `Branch` working-inventory, and the
200
files are in a directory on disk.
202
It is possible for a `WorkingTree` to have a filename which is
203
not listed in the Inventory and vice versa.
206
def __init__(self, basedir='.',
207
branch=DEPRECATED_PARAMETER,
213
"""Construct a WorkingTree for basedir.
215
If the branch is not supplied, it is opened automatically.
216
If the branch is supplied, it must be the branch for this basedir.
217
(branch.base is not cross checked, because for remote branches that
218
would be meaningless).
220
self._format = _format
221
self.bzrdir = _bzrdir
223
# not created via open etc.
224
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
225
"Please use bzrdir.open_workingtree or WorkingTree.open().",
228
wt = WorkingTree.open(basedir)
229
self._branch = wt.branch
230
self.basedir = wt.basedir
231
self._control_files = wt._control_files
232
self._hashcache = wt._hashcache
233
self._set_inventory(wt._inventory, dirty=False)
234
self._format = wt._format
235
self.bzrdir = wt.bzrdir
236
assert isinstance(basedir, basestring), \
237
"base directory %r is not a string" % basedir
238
basedir = safe_unicode(basedir)
239
mutter("opening working tree %r", basedir)
240
if deprecated_passed(branch):
242
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
243
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
244
" WorkingTree.open().",
248
self._branch = branch
250
self._branch = self.bzrdir.open_branch()
251
self.basedir = realpath(basedir)
252
# if branch is at our basedir and is a format 6 or less
253
if isinstance(self._format, WorkingTreeFormat2):
254
# share control object
255
self._control_files = self.branch.control_files
257
# assume all other formats have their own control files.
258
assert isinstance(_control_files, LockableFiles), \
259
"_control_files must be a LockableFiles, not %r" \
261
self._control_files = _control_files
262
# update the whole cache up front and write to disk if anything changed;
263
# in the future we might want to do this more selectively
264
# two possible ways offer themselves : in self._unlock, write the cache
265
# if needed, or, when the cache sees a change, append it to the hash
266
# cache file, and have the parser take the most recent entry for a
268
wt_trans = self.bzrdir.get_workingtree_transport(None)
269
cache_filename = wt_trans.local_abspath('stat-cache')
270
self._hashcache = hashcache.HashCache(basedir, cache_filename,
271
self._control_files._file_mode)
274
# is this scan needed ? it makes things kinda slow.
281
if _inventory is None:
282
# This will be acquired on lock_read() or lock_write()
283
self._inventory_is_modified = False
284
self._inventory = None
286
# the caller of __init__ has provided an inventory,
287
# we assume they know what they are doing - as its only
288
# the Format factory and creation methods that are
289
# permitted to do this.
290
self._set_inventory(_inventory, dirty=False)
293
fget=lambda self: self._branch,
294
doc="""The branch this WorkingTree is connected to.
296
This cannot be set - it is reflective of the actual disk structure
297
the working tree has been constructed from.
300
def break_lock(self):
301
"""Break a lock if one is present from another instance.
303
Uses the ui factory to ask for confirmation if the lock may be from
306
This will probe the repository for its lock as well.
308
self._control_files.break_lock()
309
self.branch.break_lock()
311
def requires_rich_root(self):
312
return self._format.requires_rich_root
314
def supports_tree_reference(self):
317
def _set_inventory(self, inv, dirty):
318
"""Set the internal cached inventory.
320
:param inv: The inventory to set.
321
:param dirty: A boolean indicating whether the inventory is the same
322
logical inventory as whats on disk. If True the inventory is not
323
the same and should be written to disk or data will be lost, if
324
False then the inventory is the same as that on disk and any
325
serialisation would be unneeded overhead.
327
assert inv.root is not None
328
self._inventory = inv
329
self._inventory_is_modified = dirty
332
def open(path=None, _unsupported=False):
333
"""Open an existing working tree at path.
337
path = os.path.getcwdu()
338
control = bzrdir.BzrDir.open(path, _unsupported)
339
return control.open_workingtree(_unsupported)
342
def open_containing(path=None):
343
"""Open an existing working tree which has its root about path.
345
This probes for a working tree at path and searches upwards from there.
347
Basically we keep looking up until we find the control directory or
348
run into /. If there isn't one, raises NotBranchError.
349
TODO: give this a new exception.
350
If there is one, it is returned, along with the unused portion of path.
352
:return: The WorkingTree that contains 'path', and the rest of path
355
path = osutils.getcwd()
356
control, relpath = bzrdir.BzrDir.open_containing(path)
358
return control.open_workingtree(), relpath
361
def open_downlevel(path=None):
362
"""Open an unsupported working tree.
364
Only intended for advanced situations like upgrading part of a bzrdir.
366
return WorkingTree.open(path, _unsupported=True)
368
# should be deprecated - this is slow and in any case treating them as a
369
# container is (we now know) bad style -- mbp 20070302
370
## @deprecated_method(zero_fifteen)
372
"""Iterate through file_ids for this tree.
374
file_ids are in a WorkingTree if they are in the working inventory
375
and the working file exists.
377
inv = self._inventory
378
for path, ie in inv.iter_entries():
379
if osutils.lexists(self.abspath(path)):
383
return "<%s of %s>" % (self.__class__.__name__,
384
getattr(self, 'basedir', None))
386
def abspath(self, filename):
387
return pathjoin(self.basedir, filename)
389
def basis_tree(self):
390
"""Return RevisionTree for the current last revision.
392
If the left most parent is a ghost then the returned tree will be an
393
empty tree - one obtained by calling repository.revision_tree(None).
396
revision_id = self.get_parent_ids()[0]
398
# no parents, return an empty revision tree.
399
# in the future this should return the tree for
400
# 'empty:' - the implicit root empty tree.
401
return self.branch.repository.revision_tree(None)
403
return self.revision_tree(revision_id)
404
except errors.NoSuchRevision:
406
# No cached copy available, retrieve from the repository.
407
# FIXME? RBC 20060403 should we cache the inventory locally
410
return self.branch.repository.revision_tree(revision_id)
411
except errors.RevisionNotPresent:
412
# the basis tree *may* be a ghost or a low level error may have
413
# occured. If the revision is present, its a problem, if its not
415
if self.branch.repository.has_revision(revision_id):
417
# the basis tree is a ghost so return an empty tree.
418
return self.branch.repository.revision_tree(None)
421
@deprecated_method(zero_eight)
422
def create(branch, directory):
423
"""Create a workingtree for branch at directory.
425
If existing_directory already exists it must have a .bzr directory.
426
If it does not exist, it will be created.
428
This returns a new WorkingTree object for the new checkout.
430
TODO FIXME RBC 20060124 when we have checkout formats in place this
431
should accept an optional revisionid to checkout [and reject this if
432
checking out into the same dir as a pre-checkout-aware branch format.]
434
XXX: When BzrDir is present, these should be created through that
437
warnings.warn('delete WorkingTree.create', stacklevel=3)
438
transport = get_transport(directory)
439
if branch.bzrdir.root_transport.base == transport.base:
441
return branch.bzrdir.create_workingtree()
442
# different directory,
443
# create a branch reference
444
# and now a working tree.
445
raise NotImplementedError
448
@deprecated_method(zero_eight)
449
def create_standalone(directory):
450
"""Create a checkout and a branch and a repo at directory.
452
Directory must exist and be empty.
454
please use BzrDir.create_standalone_workingtree
456
return bzrdir.BzrDir.create_standalone_workingtree(directory)
458
def relpath(self, path):
459
"""Return the local path portion from a given path.
461
The path may be absolute or relative. If its a relative path it is
462
interpreted relative to the python current working directory.
464
return osutils.relpath(self.basedir, path)
466
def has_filename(self, filename):
467
return osutils.lexists(self.abspath(filename))
469
def get_file(self, file_id):
470
file_id = osutils.safe_file_id(file_id)
471
return self.get_file_byname(self.id2path(file_id))
473
def get_file_text(self, file_id):
474
file_id = osutils.safe_file_id(file_id)
475
return self.get_file(file_id).read()
477
def get_file_byname(self, filename):
478
return file(self.abspath(filename), 'rb')
481
def annotate_iter(self, file_id):
482
"""See Tree.annotate_iter
484
This implementation will use the basis tree implementation if possible.
485
Lines not in the basis are attributed to CURRENT_REVISION
487
If there are pending merges, lines added by those merges will be
488
incorrectly attributed to CURRENT_REVISION (but after committing, the
489
attribution will be correct).
491
file_id = osutils.safe_file_id(file_id)
492
basis = self.basis_tree()
495
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
496
require_versioned=True).next()
497
changed_content, kind = changes[2], changes[6]
498
if not changed_content:
499
return basis.annotate_iter(file_id)
503
if kind[0] != 'file':
506
old_lines = list(basis.annotate_iter(file_id))
508
for tree in self.branch.repository.revision_trees(
509
self.get_parent_ids()[1:]):
510
if file_id not in tree:
512
old.append(list(tree.annotate_iter(file_id)))
513
return annotate.reannotate(old, self.get_file(file_id).readlines(),
518
def get_parent_ids(self):
519
"""See Tree.get_parent_ids.
521
This implementation reads the pending merges list and last_revision
522
value and uses that to decide what the parents list should be.
524
last_rev = self._last_revision()
530
merges_file = self._control_files.get('pending-merges')
531
except errors.NoSuchFile:
534
for l in merges_file.readlines():
535
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
536
parents.append(revision_id)
540
def get_root_id(self):
541
"""Return the id of this trees root"""
542
return self._inventory.root.file_id
544
def _get_store_filename(self, file_id):
545
## XXX: badly named; this is not in the store at all
546
file_id = osutils.safe_file_id(file_id)
547
return self.abspath(self.id2path(file_id))
550
def clone(self, to_bzrdir, revision_id=None, basis=None):
551
"""Duplicate this working tree into to_bzr, including all state.
553
Specifically modified files are kept as modified, but
554
ignored and unknown files are discarded.
556
If you want to make a new line of development, see bzrdir.sprout()
559
If not None, the cloned tree will have its last revision set to
560
revision, and and difference between the source trees last revision
561
and this one merged in.
564
If not None, a closer copy of a tree which may have some files in
565
common, and which file content should be preferentially copied from.
567
# assumes the target bzr dir format is compatible.
568
result = self._format.initialize(to_bzrdir)
569
self.copy_content_into(result, revision_id)
573
def copy_content_into(self, tree, revision_id=None):
574
"""Copy the current content and user files of this tree into tree."""
575
tree.set_root_id(self.get_root_id())
576
if revision_id is None:
577
merge.transform_tree(tree, self)
579
# TODO now merge from tree.last_revision to revision (to preserve
580
# user local changes)
581
merge.transform_tree(tree, self)
582
tree.set_parent_ids([revision_id])
584
def id2abspath(self, file_id):
585
file_id = osutils.safe_file_id(file_id)
586
return self.abspath(self.id2path(file_id))
588
def has_id(self, file_id):
589
# files that have been deleted are excluded
590
file_id = osutils.safe_file_id(file_id)
592
if not inv.has_id(file_id):
594
path = inv.id2path(file_id)
595
return osutils.lexists(self.abspath(path))
597
def has_or_had_id(self, file_id):
598
file_id = osutils.safe_file_id(file_id)
599
if file_id == self.inventory.root.file_id:
601
return self.inventory.has_id(file_id)
603
__contains__ = has_id
605
def get_file_size(self, file_id):
606
file_id = osutils.safe_file_id(file_id)
607
return os.path.getsize(self.id2abspath(file_id))
610
def get_file_sha1(self, file_id, path=None, stat_value=None):
611
file_id = osutils.safe_file_id(file_id)
613
path = self._inventory.id2path(file_id)
614
return self._hashcache.get_sha1(path, stat_value)
616
def get_file_mtime(self, file_id, path=None):
617
file_id = osutils.safe_file_id(file_id)
619
path = self.inventory.id2path(file_id)
620
return os.lstat(self.abspath(path)).st_mtime
622
if not supports_executable():
623
def is_executable(self, file_id, path=None):
624
file_id = osutils.safe_file_id(file_id)
625
return self._inventory[file_id].executable
627
def is_executable(self, file_id, path=None):
629
file_id = osutils.safe_file_id(file_id)
630
path = self.id2path(file_id)
631
mode = os.lstat(self.abspath(path)).st_mode
632
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
634
@needs_tree_write_lock
635
def _add(self, files, ids, kinds):
636
"""See MutableTree._add."""
637
# TODO: Re-adding a file that is removed in the working copy
638
# should probably put it back with the previous ID.
639
# the read and write working inventory should not occur in this
640
# function - they should be part of lock_write and unlock.
641
inv = self.read_working_inventory()
642
for f, file_id, kind in zip(files, ids, kinds):
643
assert kind is not None
645
inv.add_path(f, kind=kind)
647
file_id = osutils.safe_file_id(file_id)
648
inv.add_path(f, kind=kind, file_id=file_id)
649
self._write_inventory(inv)
651
@needs_tree_write_lock
652
def _gather_kinds(self, files, kinds):
653
"""See MutableTree._gather_kinds."""
654
for pos, f in enumerate(files):
655
if kinds[pos] is None:
656
fullpath = normpath(self.abspath(f))
658
kinds[pos] = file_kind(fullpath)
660
if e.errno == errno.ENOENT:
661
raise errors.NoSuchFile(fullpath)
664
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
665
"""Add revision_id as a parent.
667
This is equivalent to retrieving the current list of parent ids
668
and setting the list to its value plus revision_id.
670
:param revision_id: The revision id to add to the parent list. It may
671
be a ghost revision as long as its not the first parent to be added,
672
or the allow_leftmost_as_ghost parameter is set True.
673
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
675
parents = self.get_parent_ids() + [revision_id]
676
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
677
or allow_leftmost_as_ghost)
679
@needs_tree_write_lock
680
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
681
"""Add revision_id, tree tuple as a parent.
683
This is equivalent to retrieving the current list of parent trees
684
and setting the list to its value plus parent_tuple. See also
685
add_parent_tree_id - if you only have a parent id available it will be
686
simpler to use that api. If you have the parent already available, using
687
this api is preferred.
689
:param parent_tuple: The (revision id, tree) to add to the parent list.
690
If the revision_id is a ghost, pass None for the tree.
691
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
693
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
694
if len(parent_ids) > 1:
695
# the leftmost may have already been a ghost, preserve that if it
697
allow_leftmost_as_ghost = True
698
self.set_parent_ids(parent_ids,
699
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
701
@needs_tree_write_lock
702
def add_pending_merge(self, *revision_ids):
703
# TODO: Perhaps should check at this point that the
704
# history of the revision is actually present?
705
parents = self.get_parent_ids()
707
for rev_id in revision_ids:
708
if rev_id in parents:
710
parents.append(rev_id)
713
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
715
@deprecated_method(zero_eleven)
717
def pending_merges(self):
718
"""Return a list of pending merges.
720
These are revisions that have been merged into the working
721
directory but not yet committed.
723
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
724
instead - which is available on all tree objects.
726
return self.get_parent_ids()[1:]
728
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
729
"""Common ghost checking functionality from set_parent_*.
731
This checks that the left hand-parent exists if there are any
734
if len(revision_ids) > 0:
735
leftmost_id = revision_ids[0]
736
if (not allow_leftmost_as_ghost and not
737
self.branch.repository.has_revision(leftmost_id)):
738
raise errors.GhostRevisionUnusableHere(leftmost_id)
740
def _set_merges_from_parent_ids(self, parent_ids):
741
merges = parent_ids[1:]
742
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
744
@needs_tree_write_lock
745
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
746
"""Set the parent ids to revision_ids.
748
See also set_parent_trees. This api will try to retrieve the tree data
749
for each element of revision_ids from the trees repository. If you have
750
tree data already available, it is more efficient to use
751
set_parent_trees rather than set_parent_ids. set_parent_ids is however
752
an easier API to use.
754
:param revision_ids: The revision_ids to set as the parent ids of this
755
working tree. Any of these may be ghosts.
757
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
758
self._check_parents_for_ghosts(revision_ids,
759
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
761
if len(revision_ids) > 0:
762
self.set_last_revision(revision_ids[0])
764
self.set_last_revision(None)
766
self._set_merges_from_parent_ids(revision_ids)
768
@needs_tree_write_lock
769
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
770
"""See MutableTree.set_parent_trees."""
771
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
773
self._check_parents_for_ghosts(parent_ids,
774
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
776
if len(parent_ids) == 0:
777
leftmost_parent_id = None
778
leftmost_parent_tree = None
780
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
782
if self._change_last_revision(leftmost_parent_id):
783
if leftmost_parent_tree is None:
784
# If we don't have a tree, fall back to reading the
785
# parent tree from the repository.
786
self._cache_basis_inventory(leftmost_parent_id)
788
inv = leftmost_parent_tree.inventory
789
xml = self._create_basis_xml_from_inventory(
790
leftmost_parent_id, inv)
791
self._write_basis_inventory(xml)
792
self._set_merges_from_parent_ids(parent_ids)
794
@needs_tree_write_lock
795
def set_pending_merges(self, rev_list):
796
parents = self.get_parent_ids()
797
leftmost = parents[:1]
798
new_parents = leftmost + rev_list
799
self.set_parent_ids(new_parents)
801
@needs_tree_write_lock
802
def set_merge_modified(self, modified_hashes):
804
for file_id, hash in modified_hashes.iteritems():
805
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
806
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
808
def _put_rio(self, filename, stanzas, header):
809
self._must_be_locked()
810
my_file = rio_file(stanzas, header)
811
self._control_files.put(filename, my_file)
813
@needs_write_lock # because merge pulls data into the branch.
814
def merge_from_branch(self, branch, to_revision=None):
815
"""Merge from a branch into this working tree.
817
:param branch: The branch to merge from.
818
:param to_revision: If non-None, the merge will merge to to_revision,
819
but not beyond it. to_revision does not need to be in the history
820
of the branch when it is supplied. If None, to_revision defaults to
821
branch.last_revision().
823
from bzrlib.merge import Merger, Merge3Merger
824
pb = bzrlib.ui.ui_factory.nested_progress_bar()
826
merger = Merger(self.branch, this_tree=self, pb=pb)
827
merger.pp = ProgressPhase("Merge phase", 5, pb)
828
merger.pp.next_phase()
829
# check that there are no
831
merger.check_basis(check_clean=True, require_commits=False)
832
if to_revision is None:
833
to_revision = branch.last_revision()
835
to_revision = osutils.safe_revision_id(to_revision)
836
merger.other_rev_id = to_revision
837
if merger.other_rev_id is None:
838
raise error.NoCommits(branch)
839
self.branch.fetch(branch, last_revision=merger.other_rev_id)
840
merger.other_basis = merger.other_rev_id
841
merger.other_tree = self.branch.repository.revision_tree(
843
merger.other_branch = branch
844
merger.pp.next_phase()
846
if merger.base_rev_id == merger.other_rev_id:
847
raise errors.PointlessMerge
848
merger.backup_files = False
849
merger.merge_type = Merge3Merger
850
merger.set_interesting_files(None)
851
merger.show_base = False
852
merger.reprocess = False
853
conflicts = merger.do_merge()
860
def merge_modified(self):
861
"""Return a dictionary of files modified by a merge.
863
The list is initialized by WorkingTree.set_merge_modified, which is
864
typically called after we make some automatic updates to the tree
867
This returns a map of file_id->sha1, containing only files which are
868
still in the working inventory and have that text hash.
871
hashfile = self._control_files.get('merge-hashes')
872
except errors.NoSuchFile:
876
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
877
raise errors.MergeModifiedFormatError()
878
except StopIteration:
879
raise errors.MergeModifiedFormatError()
880
for s in RioReader(hashfile):
881
# RioReader reads in Unicode, so convert file_ids back to utf8
882
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
883
if file_id not in self.inventory:
885
text_hash = s.get("hash")
886
if text_hash == self.get_file_sha1(file_id):
887
merge_hashes[file_id] = text_hash
891
def mkdir(self, path, file_id=None):
892
"""See MutableTree.mkdir()."""
894
file_id = generate_ids.gen_file_id(os.path.basename(path))
895
os.mkdir(self.abspath(path))
896
self.add(path, file_id, 'directory')
899
def get_symlink_target(self, file_id):
900
file_id = osutils.safe_file_id(file_id)
901
return os.readlink(self.id2abspath(file_id))
904
def subsume(self, other_tree):
905
def add_children(inventory, entry):
906
for child_entry in entry.children.values():
907
inventory._byid[child_entry.file_id] = child_entry
908
if child_entry.kind == 'directory':
909
add_children(inventory, child_entry)
910
if other_tree.get_root_id() == self.get_root_id():
911
raise errors.BadSubsumeSource(self, other_tree,
912
'Trees have the same root')
914
other_tree_path = self.relpath(other_tree.basedir)
915
except errors.PathNotChild:
916
raise errors.BadSubsumeSource(self, other_tree,
917
'Tree is not contained by the other')
918
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
919
if new_root_parent is None:
920
raise errors.BadSubsumeSource(self, other_tree,
921
'Parent directory is not versioned.')
922
# We need to ensure that the result of a fetch will have a
923
# versionedfile for the other_tree root, and only fetching into
924
# RepositoryKnit2 guarantees that.
925
if not self.branch.repository.supports_rich_root():
926
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
927
other_tree.lock_tree_write()
929
new_parents = other_tree.get_parent_ids()
930
other_root = other_tree.inventory.root
931
other_root.parent_id = new_root_parent
932
other_root.name = osutils.basename(other_tree_path)
933
self.inventory.add(other_root)
934
add_children(self.inventory, other_root)
935
self._write_inventory(self.inventory)
936
# normally we don't want to fetch whole repositories, but i think
937
# here we really do want to consolidate the whole thing.
938
for parent_id in other_tree.get_parent_ids():
939
self.branch.fetch(other_tree.branch, parent_id)
940
self.add_parent_tree_id(parent_id)
943
other_tree.bzrdir.retire_bzrdir()
945
@needs_tree_write_lock
946
def extract(self, file_id, format=None):
947
"""Extract a subtree from this tree.
949
A new branch will be created, relative to the path for this tree.
953
segments = osutils.splitpath(path)
954
transport = self.branch.bzrdir.root_transport
955
for name in segments:
956
transport = transport.clone(name)
959
except errors.FileExists:
963
sub_path = self.id2path(file_id)
964
branch_transport = mkdirs(sub_path)
966
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
968
branch_transport.mkdir('.')
969
except errors.FileExists:
971
branch_bzrdir = format.initialize_on_transport(branch_transport)
973
repo = branch_bzrdir.find_repository()
974
except errors.NoRepositoryPresent:
975
repo = branch_bzrdir.create_repository()
976
assert repo.supports_rich_root()
978
if not repo.supports_rich_root():
979
raise errors.RootNotRich()
980
new_branch = branch_bzrdir.create_branch()
981
new_branch.pull(self.branch)
982
for parent_id in self.get_parent_ids():
983
new_branch.fetch(self.branch, parent_id)
984
tree_transport = self.bzrdir.root_transport.clone(sub_path)
985
if tree_transport.base != branch_transport.base:
986
tree_bzrdir = format.initialize_on_transport(tree_transport)
987
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
989
tree_bzrdir = branch_bzrdir
990
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
991
wt.set_parent_ids(self.get_parent_ids())
992
my_inv = self.inventory
993
child_inv = Inventory(root_id=None)
994
new_root = my_inv[file_id]
995
my_inv.remove_recursive_id(file_id)
996
new_root.parent_id = None
997
child_inv.add(new_root)
998
self._write_inventory(my_inv)
999
wt._write_inventory(child_inv)
1002
def _serialize(self, inventory, out_file):
1003
xml5.serializer_v5.write_inventory(self._inventory, out_file)
1005
def _deserialize(selt, in_file):
1006
return xml5.serializer_v5.read_inventory(in_file)
1009
"""Write the in memory inventory to disk."""
1010
# TODO: Maybe this should only write on dirty ?
1011
if self._control_files._lock_mode != 'w':
1012
raise errors.NotWriteLocked(self)
1014
self._serialize(self._inventory, sio)
1016
self._control_files.put('inventory', sio)
1017
self._inventory_is_modified = False
1019
def _kind(self, relpath):
1020
return osutils.file_kind(self.abspath(relpath))
1022
def list_files(self, include_root=False):
1023
"""Recursively list all files as (path, class, kind, id, entry).
1025
Lists, but does not descend into unversioned directories.
1027
This does not include files that have been deleted in this
1030
Skips the control directory.
1032
# list_files is an iterator, so @needs_read_lock doesn't work properly
1033
# with it. So callers should be careful to always read_lock the tree.
1034
if not self.is_locked():
1035
raise errors.ObjectNotLocked(self)
1037
inv = self.inventory
1038
if include_root is True:
1039
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1040
# Convert these into local objects to save lookup times
1041
pathjoin = osutils.pathjoin
1042
file_kind = self._kind
1044
# transport.base ends in a slash, we want the piece
1045
# between the last two slashes
1046
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1048
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1050
# directory file_id, relative path, absolute path, reverse sorted children
1051
children = os.listdir(self.basedir)
1053
# jam 20060527 The kernel sized tree seems equivalent whether we
1054
# use a deque and popleft to keep them sorted, or if we use a plain
1055
# list and just reverse() them.
1056
children = collections.deque(children)
1057
stack = [(inv.root.file_id, u'', self.basedir, children)]
1059
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1062
f = children.popleft()
1063
## TODO: If we find a subdirectory with its own .bzr
1064
## directory, then that is a separate tree and we
1065
## should exclude it.
1067
# the bzrdir for this tree
1068
if transport_base_dir == f:
1071
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1072
# and 'f' doesn't begin with one, we can do a string op, rather
1073
# than the checks of pathjoin(), all relative paths will have an extra slash
1075
fp = from_dir_relpath + '/' + f
1078
fap = from_dir_abspath + '/' + f
1080
f_ie = inv.get_child(from_dir_id, f)
1083
elif self.is_ignored(fp[1:]):
1086
# we may not have found this file, because of a unicode issue
1087
f_norm, can_access = osutils.normalized_filename(f)
1088
if f == f_norm or not can_access:
1089
# No change, so treat this file normally
1092
# this file can be accessed by a normalized path
1093
# check again if it is versioned
1094
# these lines are repeated here for performance
1096
fp = from_dir_relpath + '/' + f
1097
fap = from_dir_abspath + '/' + f
1098
f_ie = inv.get_child(from_dir_id, f)
1101
elif self.is_ignored(fp[1:]):
1108
# make a last minute entry
1110
yield fp[1:], c, fk, f_ie.file_id, f_ie
1113
yield fp[1:], c, fk, None, fk_entries[fk]()
1115
yield fp[1:], c, fk, None, TreeEntry()
1118
if fk != 'directory':
1121
# But do this child first
1122
new_children = os.listdir(fap)
1124
new_children = collections.deque(new_children)
1125
stack.append((f_ie.file_id, fp, fap, new_children))
1126
# Break out of inner loop,
1127
# so that we start outer loop with child
1130
# if we finished all children, pop it off the stack
1133
@needs_tree_write_lock
1134
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1137
to_dir must exist in the inventory.
1139
If to_dir exists and is a directory, the files are moved into
1140
it, keeping their old names.
1142
Note that to_dir is only the last component of the new name;
1143
this doesn't change the directory.
1145
For each entry in from_paths the move mode will be determined
1148
The first mode moves the file in the filesystem and updates the
1149
inventory. The second mode only updates the inventory without
1150
touching the file on the filesystem. This is the new mode introduced
1153
move uses the second mode if 'after == True' and the target is not
1154
versioned but present in the working tree.
1156
move uses the second mode if 'after == False' and the source is
1157
versioned but no longer in the working tree, and the target is not
1158
versioned but present in the working tree.
1160
move uses the first mode if 'after == False' and the source is
1161
versioned and present in the working tree, and the target is not
1162
versioned and not present in the working tree.
1164
Everything else results in an error.
1166
This returns a list of (from_path, to_path) pairs for each
1167
entry that is moved.
1172
# check for deprecated use of signature
1174
to_dir = kwargs.get('to_name', None)
1176
raise TypeError('You must supply a target directory')
1178
symbol_versioning.warn('The parameter to_name was deprecated'
1179
' in version 0.13. Use to_dir instead',
1182
# check destination directory
1183
assert not isinstance(from_paths, basestring)
1184
inv = self.inventory
1185
to_abs = self.abspath(to_dir)
1186
if not isdir(to_abs):
1187
raise errors.BzrMoveFailedError('',to_dir,
1188
errors.NotADirectory(to_abs))
1189
if not self.has_filename(to_dir):
1190
raise errors.BzrMoveFailedError('',to_dir,
1191
errors.NotInWorkingDirectory(to_dir))
1192
to_dir_id = inv.path2id(to_dir)
1193
if to_dir_id is None:
1194
raise errors.BzrMoveFailedError('',to_dir,
1195
errors.NotVersionedError(path=str(to_dir)))
1197
to_dir_ie = inv[to_dir_id]
1198
if to_dir_ie.kind != 'directory':
1199
raise errors.BzrMoveFailedError('',to_dir,
1200
errors.NotADirectory(to_abs))
1202
# create rename entries and tuples
1203
for from_rel in from_paths:
1204
from_tail = splitpath(from_rel)[-1]
1205
from_id = inv.path2id(from_rel)
1207
raise errors.BzrMoveFailedError(from_rel,to_dir,
1208
errors.NotVersionedError(path=str(from_rel)))
1210
from_entry = inv[from_id]
1211
from_parent_id = from_entry.parent_id
1212
to_rel = pathjoin(to_dir, from_tail)
1213
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1215
from_tail=from_tail,
1216
from_parent_id=from_parent_id,
1217
to_rel=to_rel, to_tail=from_tail,
1218
to_parent_id=to_dir_id)
1219
rename_entries.append(rename_entry)
1220
rename_tuples.append((from_rel, to_rel))
1222
# determine which move mode to use. checks also for movability
1223
rename_entries = self._determine_mv_mode(rename_entries, after)
1225
original_modified = self._inventory_is_modified
1228
self._inventory_is_modified = True
1229
self._move(rename_entries)
1231
# restore the inventory on error
1232
self._inventory_is_modified = original_modified
1234
self._write_inventory(inv)
1235
return rename_tuples
1237
def _determine_mv_mode(self, rename_entries, after=False):
1238
"""Determines for each from-to pair if both inventory and working tree
1239
or only the inventory has to be changed.
1241
Also does basic plausability tests.
1243
inv = self.inventory
1245
for rename_entry in rename_entries:
1246
# store to local variables for easier reference
1247
from_rel = rename_entry.from_rel
1248
from_id = rename_entry.from_id
1249
to_rel = rename_entry.to_rel
1250
to_id = inv.path2id(to_rel)
1251
only_change_inv = False
1253
# check the inventory for source and destination
1255
raise errors.BzrMoveFailedError(from_rel,to_rel,
1256
errors.NotVersionedError(path=str(from_rel)))
1257
if to_id is not None:
1258
raise errors.BzrMoveFailedError(from_rel,to_rel,
1259
errors.AlreadyVersionedError(path=str(to_rel)))
1261
# try to determine the mode for rename (only change inv or change
1262
# inv and file system)
1264
if not self.has_filename(to_rel):
1265
raise errors.BzrMoveFailedError(from_id,to_rel,
1266
errors.NoSuchFile(path=str(to_rel),
1267
extra="New file has not been created yet"))
1268
only_change_inv = True
1269
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1270
only_change_inv = True
1271
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1272
only_change_inv = False
1274
# something is wrong, so lets determine what exactly
1275
if not self.has_filename(from_rel) and \
1276
not self.has_filename(to_rel):
1277
raise errors.BzrRenameFailedError(from_rel,to_rel,
1278
errors.PathsDoNotExist(paths=(str(from_rel),
1281
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1282
extra="(Use --after to update the Bazaar id)")
1283
rename_entry.only_change_inv = only_change_inv
1284
return rename_entries
1286
def _move(self, rename_entries):
1287
"""Moves a list of files.
1289
Depending on the value of the flag 'only_change_inv', the
1290
file will be moved on the file system or not.
1292
inv = self.inventory
1295
for entry in rename_entries:
1297
self._move_entry(entry)
1299
self._rollback_move(moved)
1303
def _rollback_move(self, moved):
1304
"""Try to rollback a previous move in case of an filesystem error."""
1305
inv = self.inventory
1308
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1309
entry.to_tail, entry.to_parent_id, entry.from_rel,
1310
entry.from_tail, entry.from_parent_id,
1311
entry.only_change_inv))
1312
except errors.BzrMoveFailedError, e:
1313
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1314
" The working tree is in an inconsistent state."
1315
" Please consider doing a 'bzr revert'."
1316
" Error message is: %s" % e)
1318
def _move_entry(self, entry):
1319
inv = self.inventory
1320
from_rel_abs = self.abspath(entry.from_rel)
1321
to_rel_abs = self.abspath(entry.to_rel)
1322
if from_rel_abs == to_rel_abs:
1323
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1324
"Source and target are identical.")
1326
if not entry.only_change_inv:
1328
osutils.rename(from_rel_abs, to_rel_abs)
1330
raise errors.BzrMoveFailedError(entry.from_rel,
1332
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1334
@needs_tree_write_lock
1335
def rename_one(self, from_rel, to_rel, after=False):
1338
This can change the directory or the filename or both.
1340
rename_one has several 'modes' to work. First, it can rename a physical
1341
file and change the file_id. That is the normal mode. Second, it can
1342
only change the file_id without touching any physical file. This is
1343
the new mode introduced in version 0.15.
1345
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1346
versioned but present in the working tree.
1348
rename_one uses the second mode if 'after == False' and 'from_rel' is
1349
versioned but no longer in the working tree, and 'to_rel' is not
1350
versioned but present in the working tree.
1352
rename_one uses the first mode if 'after == False' and 'from_rel' is
1353
versioned and present in the working tree, and 'to_rel' is not
1354
versioned and not present in the working tree.
1356
Everything else results in an error.
1358
inv = self.inventory
1361
# create rename entries and tuples
1362
from_tail = splitpath(from_rel)[-1]
1363
from_id = inv.path2id(from_rel)
1365
raise errors.BzrRenameFailedError(from_rel,to_rel,
1366
errors.NotVersionedError(path=str(from_rel)))
1367
from_entry = inv[from_id]
1368
from_parent_id = from_entry.parent_id
1369
to_dir, to_tail = os.path.split(to_rel)
1370
to_dir_id = inv.path2id(to_dir)
1371
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1373
from_tail=from_tail,
1374
from_parent_id=from_parent_id,
1375
to_rel=to_rel, to_tail=to_tail,
1376
to_parent_id=to_dir_id)
1377
rename_entries.append(rename_entry)
1379
# determine which move mode to use. checks also for movability
1380
rename_entries = self._determine_mv_mode(rename_entries, after)
1382
# check if the target changed directory and if the target directory is
1384
if to_dir_id is None:
1385
raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
errors.NotVersionedError(path=str(to_dir)))
1388
# all checks done. now we can continue with our actual work
1389
mutter('rename_one:\n'
1394
' to_dir_id {%s}\n',
1395
from_id, from_rel, to_rel, to_dir, to_dir_id)
1397
self._move(rename_entries)
1398
self._write_inventory(inv)
1400
class _RenameEntry(object):
1401
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1402
to_rel, to_tail, to_parent_id, only_change_inv=False):
1403
self.from_rel = from_rel
1404
self.from_id = from_id
1405
self.from_tail = from_tail
1406
self.from_parent_id = from_parent_id
1407
self.to_rel = to_rel
1408
self.to_tail = to_tail
1409
self.to_parent_id = to_parent_id
1410
self.only_change_inv = only_change_inv
1414
"""Return all unknown files.
1416
These are files in the working directory that are not versioned or
1417
control files or ignored.
1419
# force the extras method to be fully executed before returning, to
1420
# prevent race conditions with the lock
1422
[subp for subp in self.extras() if not self.is_ignored(subp)])
1424
@needs_tree_write_lock
1425
def unversion(self, file_ids):
1426
"""Remove the file ids in file_ids from the current versioned set.
1428
When a file_id is unversioned, all of its children are automatically
1431
:param file_ids: The file ids to stop versioning.
1432
:raises: NoSuchId if any fileid is not currently versioned.
1434
for file_id in file_ids:
1435
file_id = osutils.safe_file_id(file_id)
1436
if self._inventory.has_id(file_id):
1437
self._inventory.remove_recursive_id(file_id)
1439
raise errors.NoSuchId(self, file_id)
1441
# in the future this should just set a dirty bit to wait for the
1442
# final unlock. However, until all methods of workingtree start
1443
# with the current in -memory inventory rather than triggering
1444
# a read, it is more complex - we need to teach read_inventory
1445
# to know when to read, and when to not read first... and possibly
1446
# to save first when the in memory one may be corrupted.
1447
# so for now, we just only write it if it is indeed dirty.
1449
self._write_inventory(self._inventory)
1451
@deprecated_method(zero_eight)
1452
def iter_conflicts(self):
1453
"""List all files in the tree that have text or content conflicts.
1454
DEPRECATED. Use conflicts instead."""
1455
return self._iter_conflicts()
1457
def _iter_conflicts(self):
1459
for info in self.list_files():
1461
stem = get_conflicted_stem(path)
1464
if stem not in conflicted:
1465
conflicted.add(stem)
1469
def pull(self, source, overwrite=False, stop_revision=None,
1470
change_reporter=None):
1471
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1474
pp = ProgressPhase("Pull phase", 2, top_pb)
1476
old_revision_info = self.branch.last_revision_info()
1477
basis_tree = self.basis_tree()
1478
count = self.branch.pull(source, overwrite, stop_revision)
1479
new_revision_info = self.branch.last_revision_info()
1480
if new_revision_info != old_revision_info:
1482
repository = self.branch.repository
1483
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1484
basis_tree.lock_read()
1486
new_basis_tree = self.branch.basis_tree()
1493
change_reporter=change_reporter)
1494
if (basis_tree.inventory.root is None and
1495
new_basis_tree.inventory.root is not None):
1496
self.set_root_id(new_basis_tree.inventory.root.file_id)
1500
# TODO - dedup parents list with things merged by pull ?
1501
# reuse the revisiontree we merged against to set the new
1503
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1504
# we have to pull the merge trees out again, because
1505
# merge_inner has set the ids. - this corner is not yet
1506
# layered well enough to prevent double handling.
1507
# XXX TODO: Fix the double handling: telling the tree about
1508
# the already known parent data is wasteful.
1509
merges = self.get_parent_ids()[1:]
1510
parent_trees.extend([
1511
(parent, repository.revision_tree(parent)) for
1513
self.set_parent_trees(parent_trees)
1520
def put_file_bytes_non_atomic(self, file_id, bytes):
1521
"""See MutableTree.put_file_bytes_non_atomic."""
1522
file_id = osutils.safe_file_id(file_id)
1523
stream = file(self.id2abspath(file_id), 'wb')
1528
# TODO: update the hashcache here ?
1531
"""Yield all unversioned files in this WorkingTree.
1533
If there are any unversioned directories then only the directory is
1534
returned, not all its children. But if there are unversioned files
1535
under a versioned subdirectory, they are returned.
1537
Currently returned depth-first, sorted by name within directories.
1538
This is the same order used by 'osutils.walkdirs'.
1540
## TODO: Work from given directory downwards
1541
for path, dir_entry in self.inventory.directories():
1542
# mutter("search for unknowns in %r", path)
1543
dirabs = self.abspath(path)
1544
if not isdir(dirabs):
1545
# e.g. directory deleted
1549
for subf in os.listdir(dirabs):
1552
if subf not in dir_entry.children:
1553
subf_norm, can_access = osutils.normalized_filename(subf)
1554
if subf_norm != subf and can_access:
1555
if subf_norm not in dir_entry.children:
1556
fl.append(subf_norm)
1562
subp = pathjoin(path, subf)
1565
def ignored_files(self):
1566
"""Yield list of PATH, IGNORE_PATTERN"""
1567
for subp in self.extras():
1568
pat = self.is_ignored(subp)
1572
def get_ignore_list(self):
1573
"""Return list of ignore patterns.
1575
Cached in the Tree object after the first call.
1577
ignoreset = getattr(self, '_ignoreset', None)
1578
if ignoreset is not None:
1581
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1582
ignore_globs.update(ignores.get_runtime_ignores())
1583
ignore_globs.update(ignores.get_user_ignores())
1584
if self.has_filename(bzrlib.IGNORE_FILENAME):
1585
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1587
ignore_globs.update(ignores.parse_ignore_file(f))
1590
self._ignoreset = ignore_globs
1593
def _flush_ignore_list_cache(self):
1594
"""Resets the cached ignore list to force a cache rebuild."""
1595
self._ignoreset = None
1596
self._ignoreglobster = None
1598
def is_ignored(self, filename):
1599
r"""Check whether the filename matches an ignore pattern.
1601
Patterns containing '/' or '\' need to match the whole path;
1602
others match against only the last component.
1604
If the file is ignored, returns the pattern which caused it to
1605
be ignored, otherwise None. So this can simply be used as a
1606
boolean if desired."""
1607
if getattr(self, '_ignoreglobster', None) is None:
1608
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1609
return self._ignoreglobster.match(filename)
1611
def kind(self, file_id):
1612
return file_kind(self.id2abspath(file_id))
1614
def _comparison_data(self, entry, path):
1615
abspath = self.abspath(path)
1617
stat_value = os.lstat(abspath)
1619
if getattr(e, 'errno', None) == errno.ENOENT:
1626
mode = stat_value.st_mode
1627
kind = osutils.file_kind_from_stat_mode(mode)
1628
if not supports_executable():
1629
executable = entry.executable
1631
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1632
return kind, executable, stat_value
1634
def _file_size(self, entry, stat_value):
1635
return stat_value.st_size
1637
def last_revision(self):
1638
"""Return the last revision of the branch for this tree.
1640
This format tree does not support a separate marker for last-revision
1641
compared to the branch.
1643
See MutableTree.last_revision
1645
return self._last_revision()
1648
def _last_revision(self):
1649
"""helper for get_parent_ids."""
1650
return self.branch.last_revision()
1652
def is_locked(self):
1653
return self._control_files.is_locked()
1655
def _must_be_locked(self):
1656
if not self.is_locked():
1657
raise errors.ObjectNotLocked(self)
1659
def lock_read(self):
1660
"""See Branch.lock_read, and WorkingTree.unlock."""
1661
if not self.is_locked():
1663
self.branch.lock_read()
1665
return self._control_files.lock_read()
1667
self.branch.unlock()
1670
def lock_tree_write(self):
1671
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1672
if not self.is_locked():
1674
self.branch.lock_read()
1676
return self._control_files.lock_write()
1678
self.branch.unlock()
1681
def lock_write(self):
1682
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1683
if not self.is_locked():
1685
self.branch.lock_write()
1687
return self._control_files.lock_write()
1689
self.branch.unlock()
1692
def get_physical_lock_status(self):
1693
return self._control_files.get_physical_lock_status()
1695
def _basis_inventory_name(self):
1696
return 'basis-inventory-cache'
1698
def _reset_data(self):
1699
"""Reset transient data that cannot be revalidated."""
1700
self._inventory_is_modified = False
1701
result = self._deserialize(self._control_files.get('inventory'))
1702
self._set_inventory(result, dirty=False)
1704
@needs_tree_write_lock
1705
def set_last_revision(self, new_revision):
1706
"""Change the last revision in the working tree."""
1707
new_revision = osutils.safe_revision_id(new_revision)
1708
if self._change_last_revision(new_revision):
1709
self._cache_basis_inventory(new_revision)
1711
def _change_last_revision(self, new_revision):
1712
"""Template method part of set_last_revision to perform the change.
1714
This is used to allow WorkingTree3 instances to not affect branch
1715
when their last revision is set.
1717
if new_revision is None:
1718
self.branch.set_revision_history([])
1721
self.branch.generate_revision_history(new_revision)
1722
except errors.NoSuchRevision:
1723
# not present in the repo - dont try to set it deeper than the tip
1724
self.branch.set_revision_history([new_revision])
1727
def _write_basis_inventory(self, xml):
1728
"""Write the basis inventory XML to the basis-inventory file"""
1729
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1730
path = self._basis_inventory_name()
1732
self._control_files.put(path, sio)
1734
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1735
"""Create the text that will be saved in basis-inventory"""
1736
# TODO: jam 20070209 This should be redundant, as the revision_id
1737
# as all callers should have already converted the revision_id to
1739
inventory.revision_id = osutils.safe_revision_id(revision_id)
1740
return xml7.serializer_v7.write_inventory_to_string(inventory)
1742
def _cache_basis_inventory(self, new_revision):
1743
"""Cache new_revision as the basis inventory."""
1744
# TODO: this should allow the ready-to-use inventory to be passed in,
1745
# as commit already has that ready-to-use [while the format is the
1748
# this double handles the inventory - unpack and repack -
1749
# but is easier to understand. We can/should put a conditional
1750
# in here based on whether the inventory is in the latest format
1751
# - perhaps we should repack all inventories on a repository
1753
# the fast path is to copy the raw xml from the repository. If the
1754
# xml contains 'revision_id="', then we assume the right
1755
# revision_id is set. We must check for this full string, because a
1756
# root node id can legitimately look like 'revision_id' but cannot
1758
xml = self.branch.repository.get_inventory_xml(new_revision)
1759
firstline = xml.split('\n', 1)[0]
1760
if (not 'revision_id="' in firstline or
1761
'format="7"' not in firstline):
1762
inv = self.branch.repository.deserialise_inventory(
1764
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1765
self._write_basis_inventory(xml)
1766
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1769
def read_basis_inventory(self):
1770
"""Read the cached basis inventory."""
1771
path = self._basis_inventory_name()
1772
return self._control_files.get(path).read()
1775
def read_working_inventory(self):
1776
"""Read the working inventory.
1778
:raises errors.InventoryModified: read_working_inventory will fail
1779
when the current in memory inventory has been modified.
1781
# conceptually this should be an implementation detail of the tree.
1782
# XXX: Deprecate this.
1783
# ElementTree does its own conversion from UTF-8, so open in
1785
if self._inventory_is_modified:
1786
raise errors.InventoryModified(self)
1787
result = self._deserialize(self._control_files.get('inventory'))
1788
self._set_inventory(result, dirty=False)
1791
@needs_tree_write_lock
1792
def remove(self, files, verbose=False, to_file=None):
1793
"""Remove nominated files from the working inventory..
1795
This does not remove their text. This does not run on XXX on what? RBC
1797
TODO: Refuse to remove modified files unless --force is given?
1799
TODO: Do something useful with directories.
1801
TODO: Should this remove the text or not? Tough call; not
1802
removing may be useful and the user can just use use rm, and
1803
is the opposite of add. Removing it is consistent with most
1804
other tools. Maybe an option.
1806
## TODO: Normalize names
1807
## TODO: Remove nested loops; better scalability
1808
if isinstance(files, basestring):
1811
inv = self.inventory
1813
# do this before any modifications
1815
fid = inv.path2id(f)
1817
note("%s is not versioned."%f)
1820
# having remove it, it must be either ignored or unknown
1821
if self.is_ignored(f):
1825
textui.show_status(new_status, inv[fid].kind, f,
1829
self._write_inventory(inv)
1831
@needs_tree_write_lock
1832
def revert(self, filenames, old_tree=None, backups=True,
1833
pb=DummyProgress(), report_changes=False):
1834
from bzrlib.conflicts import resolve
1835
if old_tree is None:
1836
old_tree = self.basis_tree()
1837
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1839
if not len(filenames):
1840
self.set_parent_ids(self.get_parent_ids()[:1])
1843
resolve(self, filenames, ignore_misses=True)
1846
def revision_tree(self, revision_id):
1847
"""See Tree.revision_tree.
1849
WorkingTree can supply revision_trees for the basis revision only
1850
because there is only one cached inventory in the bzr directory.
1852
if revision_id == self.last_revision():
1854
xml = self.read_basis_inventory()
1855
except errors.NoSuchFile:
1859
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1860
# dont use the repository revision_tree api because we want
1861
# to supply the inventory.
1862
if inv.revision_id == revision_id:
1863
return revisiontree.RevisionTree(self.branch.repository,
1865
except errors.BadInventoryFormat:
1867
# raise if there was no inventory, or if we read the wrong inventory.
1868
raise errors.NoSuchRevisionInTree(self, revision_id)
1870
# XXX: This method should be deprecated in favour of taking in a proper
1871
# new Inventory object.
1872
@needs_tree_write_lock
1873
def set_inventory(self, new_inventory_list):
1874
from bzrlib.inventory import (Inventory,
1879
inv = Inventory(self.get_root_id())
1880
for path, file_id, parent, kind in new_inventory_list:
1881
name = os.path.basename(path)
1884
# fixme, there should be a factory function inv,add_??
1885
if kind == 'directory':
1886
inv.add(InventoryDirectory(file_id, name, parent))
1887
elif kind == 'file':
1888
inv.add(InventoryFile(file_id, name, parent))
1889
elif kind == 'symlink':
1890
inv.add(InventoryLink(file_id, name, parent))
1892
raise errors.BzrError("unknown kind %r" % kind)
1893
self._write_inventory(inv)
1895
@needs_tree_write_lock
1896
def set_root_id(self, file_id):
1897
"""Set the root id for this tree."""
1900
symbol_versioning.warn(symbol_versioning.zero_twelve
1901
% 'WorkingTree.set_root_id with fileid=None',
1906
file_id = osutils.safe_file_id(file_id)
1907
self._set_root_id(file_id)
1909
def _set_root_id(self, file_id):
1910
"""Set the root id for this tree, in a format specific manner.
1912
:param file_id: The file id to assign to the root. It must not be
1913
present in the current inventory or an error will occur. It must
1914
not be None, but rather a valid file id.
1916
inv = self._inventory
1917
orig_root_id = inv.root.file_id
1918
# TODO: it might be nice to exit early if there was nothing
1919
# to do, saving us from trigger a sync on unlock.
1920
self._inventory_is_modified = True
1921
# we preserve the root inventory entry object, but
1922
# unlinkit from the byid index
1923
del inv._byid[inv.root.file_id]
1924
inv.root.file_id = file_id
1925
# and link it into the index with the new changed id.
1926
inv._byid[inv.root.file_id] = inv.root
1927
# and finally update all children to reference the new id.
1928
# XXX: this should be safe to just look at the root.children
1929
# list, not the WHOLE INVENTORY.
1932
if entry.parent_id == orig_root_id:
1933
entry.parent_id = inv.root.file_id
1936
"""See Branch.unlock.
1938
WorkingTree locking just uses the Branch locking facilities.
1939
This is current because all working trees have an embedded branch
1940
within them. IF in the future, we were to make branch data shareable
1941
between multiple working trees, i.e. via shared storage, then we
1942
would probably want to lock both the local tree, and the branch.
1944
raise NotImplementedError(self.unlock)
1947
"""Update a working tree along its branch.
1949
This will update the branch if its bound too, which means we have
1950
multiple trees involved:
1952
- The new basis tree of the master.
1953
- The old basis tree of the branch.
1954
- The old basis tree of the working tree.
1955
- The current working tree state.
1957
Pathologically, all three may be different, and non-ancestors of each
1958
other. Conceptually we want to:
1960
- Preserve the wt.basis->wt.state changes
1961
- Transform the wt.basis to the new master basis.
1962
- Apply a merge of the old branch basis to get any 'local' changes from
1964
- Restore the wt.basis->wt.state changes.
1966
There isn't a single operation at the moment to do that, so we:
1967
- Merge current state -> basis tree of the master w.r.t. the old tree
1969
- Do a 'normal' merge of the old branch basis if it is relevant.
1971
if self.branch.get_master_branch() is not None:
1973
update_branch = True
1975
self.lock_tree_write()
1976
update_branch = False
1979
old_tip = self.branch.update()
1982
return self._update_tree(old_tip)
1986
@needs_tree_write_lock
1987
def _update_tree(self, old_tip=None):
1988
"""Update a tree to the master branch.
1990
:param old_tip: if supplied, the previous tip revision the branch,
1991
before it was changed to the master branch's tip.
1993
# here if old_tip is not None, it is the old tip of the branch before
1994
# it was updated from the master branch. This should become a pending
1995
# merge in the working tree to preserve the user existing work. we
1996
# cant set that until we update the working trees last revision to be
1997
# one from the new branch, because it will just get absorbed by the
1998
# parent de-duplication logic.
2000
# We MUST save it even if an error occurs, because otherwise the users
2001
# local work is unreferenced and will appear to have been lost.
2005
last_rev = self.get_parent_ids()[0]
2008
if last_rev != self.branch.last_revision():
2009
# merge tree state up to new branch tip.
2010
basis = self.basis_tree()
2013
to_tree = self.branch.basis_tree()
2014
if basis.inventory.root is None:
2015
self.set_root_id(to_tree.inventory.root.file_id)
2017
result += merge.merge_inner(
2024
# TODO - dedup parents list with things merged by pull ?
2025
# reuse the tree we've updated to to set the basis:
2026
parent_trees = [(self.branch.last_revision(), to_tree)]
2027
merges = self.get_parent_ids()[1:]
2028
# Ideally we ask the tree for the trees here, that way the working
2029
# tree can decide whether to give us teh entire tree or give us a
2030
# lazy initialised tree. dirstate for instance will have the trees
2031
# in ram already, whereas a last-revision + basis-inventory tree
2032
# will not, but also does not need them when setting parents.
2033
for parent in merges:
2034
parent_trees.append(
2035
(parent, self.branch.repository.revision_tree(parent)))
2036
if old_tip is not None:
2037
parent_trees.append(
2038
(old_tip, self.branch.repository.revision_tree(old_tip)))
2039
self.set_parent_trees(parent_trees)
2040
last_rev = parent_trees[0][0]
2042
# the working tree had the same last-revision as the master
2043
# branch did. We may still have pivot local work from the local
2044
# branch into old_tip:
2045
if old_tip is not None:
2046
self.add_parent_tree_id(old_tip)
2047
if old_tip and old_tip != last_rev:
2048
# our last revision was not the prior branch last revision
2049
# and we have converted that last revision to a pending merge.
2050
# base is somewhere between the branch tip now
2051
# and the now pending merge
2053
# Since we just modified the working tree and inventory, flush out
2054
# the current state, before we modify it again.
2055
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2056
# requires it only because TreeTransform directly munges the
2057
# inventory and calls tree._write_inventory(). Ultimately we
2058
# should be able to remove this extra flush.
2060
from bzrlib.revision import common_ancestor
2062
base_rev_id = common_ancestor(self.branch.last_revision(),
2064
self.branch.repository)
2065
except errors.NoCommonAncestor:
2067
base_tree = self.branch.repository.revision_tree(base_rev_id)
2068
other_tree = self.branch.repository.revision_tree(old_tip)
2069
result += merge.merge_inner(
2076
def _write_hashcache_if_dirty(self):
2077
"""Write out the hashcache if it is dirty."""
2078
if self._hashcache.needs_write:
2080
self._hashcache.write()
2082
if e.errno not in (errno.EPERM, errno.EACCES):
2084
# TODO: jam 20061219 Should this be a warning? A single line
2085
# warning might be sufficient to let the user know what
2087
mutter('Could not write hashcache for %s\nError: %s',
2088
self._hashcache.cache_file_name(), e)
2090
@needs_tree_write_lock
2091
def _write_inventory(self, inv):
2092
"""Write inventory as the current inventory."""
2093
self._set_inventory(inv, dirty=True)
2096
def set_conflicts(self, arg):
2097
raise errors.UnsupportedOperation(self.set_conflicts, self)
2099
def add_conflicts(self, arg):
2100
raise errors.UnsupportedOperation(self.add_conflicts, self)
2103
def conflicts(self):
2104
conflicts = _mod_conflicts.ConflictList()
2105
for conflicted in self._iter_conflicts():
2108
if file_kind(self.abspath(conflicted)) != "file":
2110
except errors.NoSuchFile:
2113
for suffix in ('.THIS', '.OTHER'):
2115
kind = file_kind(self.abspath(conflicted+suffix))
2118
except errors.NoSuchFile:
2122
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2123
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2125
file_id=self.path2id(conflicted)))
2128
def walkdirs(self, prefix=""):
2129
"""Walk the directories of this tree.
2131
This API returns a generator, which is only valid during the current
2132
tree transaction - within a single lock_read or lock_write duration.
2134
If the tree is not locked, it may cause an error to be raised, depending
2135
on the tree implementation.
2137
disk_top = self.abspath(prefix)
2138
if disk_top.endswith('/'):
2139
disk_top = disk_top[:-1]
2140
top_strip_len = len(disk_top) + 1
2141
inventory_iterator = self._walkdirs(prefix)
2142
disk_iterator = osutils.walkdirs(disk_top, prefix)
2144
current_disk = disk_iterator.next()
2145
disk_finished = False
2147
if e.errno != errno.ENOENT:
2150
disk_finished = True
2152
current_inv = inventory_iterator.next()
2153
inv_finished = False
2154
except StopIteration:
2157
while not inv_finished or not disk_finished:
2158
if not disk_finished:
2159
# strip out .bzr dirs
2160
if current_disk[0][1][top_strip_len:] == '':
2161
# osutils.walkdirs can be made nicer -
2162
# yield the path-from-prefix rather than the pathjoined
2164
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2165
if current_disk[1][bzrdir_loc][0] == '.bzr':
2166
# we dont yield the contents of, or, .bzr itself.
2167
del current_disk[1][bzrdir_loc]
2169
# everything is unknown
2172
# everything is missing
2175
direction = cmp(current_inv[0][0], current_disk[0][0])
2177
# disk is before inventory - unknown
2178
dirblock = [(relpath, basename, kind, stat, None, None) for
2179
relpath, basename, kind, stat, top_path in current_disk[1]]
2180
yield (current_disk[0][0], None), dirblock
2182
current_disk = disk_iterator.next()
2183
except StopIteration:
2184
disk_finished = True
2186
# inventory is before disk - missing.
2187
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2188
for relpath, basename, dkind, stat, fileid, kind in
2190
yield (current_inv[0][0], current_inv[0][1]), dirblock
2192
current_inv = inventory_iterator.next()
2193
except StopIteration:
2196
# versioned present directory
2197
# merge the inventory and disk data together
2199
for relpath, subiterator in itertools.groupby(sorted(
2200
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2201
path_elements = list(subiterator)
2202
if len(path_elements) == 2:
2203
inv_row, disk_row = path_elements
2204
# versioned, present file
2205
dirblock.append((inv_row[0],
2206
inv_row[1], disk_row[2],
2207
disk_row[3], inv_row[4],
2209
elif len(path_elements[0]) == 5:
2211
dirblock.append((path_elements[0][0],
2212
path_elements[0][1], path_elements[0][2],
2213
path_elements[0][3], None, None))
2214
elif len(path_elements[0]) == 6:
2215
# versioned, absent file.
2216
dirblock.append((path_elements[0][0],
2217
path_elements[0][1], 'unknown', None,
2218
path_elements[0][4], path_elements[0][5]))
2220
raise NotImplementedError('unreachable code')
2221
yield current_inv[0], dirblock
2223
current_inv = inventory_iterator.next()
2224
except StopIteration:
2227
current_disk = disk_iterator.next()
2228
except StopIteration:
2229
disk_finished = True
2231
def _walkdirs(self, prefix=""):
2232
_directory = 'directory'
2233
# get the root in the inventory
2234
inv = self.inventory
2235
top_id = inv.path2id(prefix)
2239
pending = [(prefix, '', _directory, None, top_id, None)]
2242
currentdir = pending.pop()
2243
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2244
top_id = currentdir[4]
2246
relroot = currentdir[0] + '/'
2249
# FIXME: stash the node in pending
2251
for name, child in entry.sorted_children():
2252
dirblock.append((relroot + name, name, child.kind, None,
2253
child.file_id, child.kind
2255
yield (currentdir[0], entry.file_id), dirblock
2256
# push the user specified dirs from dirblock
2257
for dir in reversed(dirblock):
2258
if dir[2] == _directory:
2261
@needs_tree_write_lock
2262
def auto_resolve(self):
2263
"""Automatically resolve text conflicts according to contents.
2265
Only text conflicts are auto_resolvable. Files with no conflict markers
2266
are considered 'resolved', because bzr always puts conflict markers
2267
into files that have text conflicts. The corresponding .THIS .BASE and
2268
.OTHER files are deleted, as per 'resolve'.
2269
:return: a tuple of ConflictLists: (un_resolved, resolved).
2271
un_resolved = _mod_conflicts.ConflictList()
2272
resolved = _mod_conflicts.ConflictList()
2273
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2274
for conflict in self.conflicts():
2275
if (conflict.typestring != 'text conflict' or
2276
self.kind(conflict.file_id) != 'file'):
2277
un_resolved.append(conflict)
2279
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2281
for line in my_file:
2282
if conflict_re.search(line):
2283
un_resolved.append(conflict)
2286
resolved.append(conflict)
2289
resolved.remove_files(self)
2290
self.set_conflicts(un_resolved)
2291
return un_resolved, resolved
2293
def _validate(self):
2294
"""Validate internal structures.
2296
This is meant mostly for the test suite. To give it a chance to detect
2297
corruption after actions have occurred. The default implementation is a
2300
:return: None. An exception should be raised if there is an error.
2305
class WorkingTree2(WorkingTree):
2306
"""This is the Format 2 working tree.
2308
This was the first weave based working tree.
2309
- uses os locks for locking.
2310
- uses the branch last-revision.
2313
def __init__(self, *args, **kwargs):
2314
super(WorkingTree2, self).__init__(*args, **kwargs)
2315
# WorkingTree2 has more of a constraint that self._inventory must
2316
# exist. Because this is an older format, we don't mind the overhead
2317
# caused by the extra computation here.
2319
# Newer WorkingTree's should only have self._inventory set when they
2321
if self._inventory is None:
2322
self.read_working_inventory()
2324
def lock_tree_write(self):
2325
"""See WorkingTree.lock_tree_write().
2327
In Format2 WorkingTrees we have a single lock for the branch and tree
2328
so lock_tree_write() degrades to lock_write().
2330
self.branch.lock_write()
2332
return self._control_files.lock_write()
2334
self.branch.unlock()
2338
# we share control files:
2339
if self._control_files._lock_count == 3:
2340
# _inventory_is_modified is always False during a read lock.
2341
if self._inventory_is_modified:
2343
self._write_hashcache_if_dirty()
2345
# reverse order of locking.
2347
return self._control_files.unlock()
2349
self.branch.unlock()
2352
class WorkingTree3(WorkingTree):
2353
"""This is the Format 3 working tree.
2355
This differs from the base WorkingTree by:
2356
- having its own file lock
2357
- having its own last-revision property.
2359
This is new in bzr 0.8
2363
def _last_revision(self):
2364
"""See Mutable.last_revision."""
2366
return osutils.safe_revision_id(
2367
self._control_files.get('last-revision').read())
2368
except errors.NoSuchFile:
2371
def _change_last_revision(self, revision_id):
2372
"""See WorkingTree._change_last_revision."""
2373
if revision_id is None or revision_id == NULL_REVISION:
2375
self._control_files._transport.delete('last-revision')
2376
except errors.NoSuchFile:
2380
self._control_files.put_bytes('last-revision', revision_id)
2383
@needs_tree_write_lock
2384
def set_conflicts(self, conflicts):
2385
self._put_rio('conflicts', conflicts.to_stanzas(),
2388
@needs_tree_write_lock
2389
def add_conflicts(self, new_conflicts):
2390
conflict_set = set(self.conflicts())
2391
conflict_set.update(set(list(new_conflicts)))
2392
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2393
key=_mod_conflicts.Conflict.sort_key)))
2396
def conflicts(self):
2398
confile = self._control_files.get('conflicts')
2399
except errors.NoSuchFile:
2400
return _mod_conflicts.ConflictList()
2402
if confile.next() != CONFLICT_HEADER_1 + '\n':
2403
raise errors.ConflictFormatError()
2404
except StopIteration:
2405
raise errors.ConflictFormatError()
2406
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2409
if self._control_files._lock_count == 1:
2410
# _inventory_is_modified is always False during a read lock.
2411
if self._inventory_is_modified:
2413
self._write_hashcache_if_dirty()
2414
# reverse order of locking.
2416
return self._control_files.unlock()
2418
self.branch.unlock()
2421
def get_conflicted_stem(path):
2422
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2423
if path.endswith(suffix):
2424
return path[:-len(suffix)]
2427
@deprecated_function(zero_eight)
2428
def is_control_file(filename):
2429
"""See WorkingTree.is_control_filename(filename)."""
2430
## FIXME: better check
2431
filename = normpath(filename)
2432
while filename != '':
2433
head, tail = os.path.split(filename)
2434
## mutter('check %r for control file' % ((head, tail),))
2437
if filename == head:
2443
class WorkingTreeFormat(object):
2444
"""An encapsulation of the initialization and open routines for a format.
2446
Formats provide three things:
2447
* An initialization routine,
2451
Formats are placed in an dict by their format string for reference
2452
during workingtree opening. Its not required that these be instances, they
2453
can be classes themselves with class methods - it simply depends on
2454
whether state is needed for a given format or not.
2456
Once a format is deprecated, just deprecate the initialize and open
2457
methods on the format class. Do not deprecate the object, as the
2458
object will be created every time regardless.
2461
_default_format = None
2462
"""The default format used for new trees."""
2465
"""The known formats."""
2467
requires_rich_root = False
2469
upgrade_recommended = False
2472
def find_format(klass, a_bzrdir):
2473
"""Return the format for the working tree object in a_bzrdir."""
2475
transport = a_bzrdir.get_workingtree_transport(None)
2476
format_string = transport.get("format").read()
2477
return klass._formats[format_string]
2478
except errors.NoSuchFile:
2479
raise errors.NoWorkingTree(base=transport.base)
2481
raise errors.UnknownFormatError(format=format_string)
2483
def __eq__(self, other):
2484
return self.__class__ is other.__class__
2486
def __ne__(self, other):
2487
return not (self == other)
2490
def get_default_format(klass):
2491
"""Return the current default format."""
2492
return klass._default_format
2494
def get_format_string(self):
2495
"""Return the ASCII format string that identifies this format."""
2496
raise NotImplementedError(self.get_format_string)
2498
def get_format_description(self):
2499
"""Return the short description for this format."""
2500
raise NotImplementedError(self.get_format_description)
2502
def is_supported(self):
2503
"""Is this format supported?
2505
Supported formats can be initialized and opened.
2506
Unsupported formats may not support initialization or committing or
2507
some other features depending on the reason for not being supported.
2512
def register_format(klass, format):
2513
klass._formats[format.get_format_string()] = format
2516
def set_default_format(klass, format):
2517
klass._default_format = format
2520
def unregister_format(klass, format):
2521
assert klass._formats[format.get_format_string()] is format
2522
del klass._formats[format.get_format_string()]
2525
class WorkingTreeFormat2(WorkingTreeFormat):
2526
"""The second working tree format.
2528
This format modified the hash cache from the format 1 hash cache.
2531
upgrade_recommended = True
2533
def get_format_description(self):
2534
"""See WorkingTreeFormat.get_format_description()."""
2535
return "Working tree format 2"
2537
def stub_initialize_remote(self, control_files):
2538
"""As a special workaround create critical control files for a remote working tree
2540
This ensures that it can later be updated and dealt with locally,
2541
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2542
no working tree. (See bug #43064).
2546
xml5.serializer_v5.write_inventory(inv, sio)
2548
control_files.put('inventory', sio)
2550
control_files.put_bytes('pending-merges', '')
2553
def initialize(self, a_bzrdir, revision_id=None):
2554
"""See WorkingTreeFormat.initialize()."""
2555
if not isinstance(a_bzrdir.transport, LocalTransport):
2556
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2557
branch = a_bzrdir.open_branch()
2558
if revision_id is not None:
2559
revision_id = osutils.safe_revision_id(revision_id)
2562
revision_history = branch.revision_history()
2564
position = revision_history.index(revision_id)
2566
raise errors.NoSuchRevision(branch, revision_id)
2567
branch.set_revision_history(revision_history[:position + 1])
2570
revision = branch.last_revision()
2572
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2578
basis_tree = branch.repository.revision_tree(revision)
2579
if basis_tree.inventory.root is not None:
2580
wt.set_root_id(basis_tree.inventory.root.file_id)
2581
# set the parent list and cache the basis tree.
2582
wt.set_parent_trees([(revision, basis_tree)])
2583
transform.build_tree(basis_tree, wt)
2587
super(WorkingTreeFormat2, self).__init__()
2588
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2590
def open(self, a_bzrdir, _found=False):
2591
"""Return the WorkingTree object for a_bzrdir
2593
_found is a private parameter, do not use it. It is used to indicate
2594
if format probing has already been done.
2597
# we are being called directly and must probe.
2598
raise NotImplementedError
2599
if not isinstance(a_bzrdir.transport, LocalTransport):
2600
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2601
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2607
class WorkingTreeFormat3(WorkingTreeFormat):
2608
"""The second working tree format updated to record a format marker.
2611
- exists within a metadir controlling .bzr
2612
- includes an explicit version marker for the workingtree control
2613
files, separate from the BzrDir format
2614
- modifies the hash cache format
2616
- uses a LockDir to guard access for writes.
2619
upgrade_recommended = True
2621
def get_format_string(self):
2622
"""See WorkingTreeFormat.get_format_string()."""
2623
return "Bazaar-NG Working Tree format 3"
2625
def get_format_description(self):
2626
"""See WorkingTreeFormat.get_format_description()."""
2627
return "Working tree format 3"
2629
_lock_file_name = 'lock'
2630
_lock_class = LockDir
2632
_tree_class = WorkingTree3
2634
def __get_matchingbzrdir(self):
2635
return bzrdir.BzrDirMetaFormat1()
2637
_matchingbzrdir = property(__get_matchingbzrdir)
2639
def _open_control_files(self, a_bzrdir):
2640
transport = a_bzrdir.get_workingtree_transport(None)
2641
return LockableFiles(transport, self._lock_file_name,
2644
def initialize(self, a_bzrdir, revision_id=None):
2645
"""See WorkingTreeFormat.initialize().
2647
revision_id allows creating a working tree at a different
2648
revision than the branch is at.
2650
if not isinstance(a_bzrdir.transport, LocalTransport):
2651
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2652
transport = a_bzrdir.get_workingtree_transport(self)
2653
control_files = self._open_control_files(a_bzrdir)
2654
control_files.create_lock()
2655
control_files.lock_write()
2656
control_files.put_utf8('format', self.get_format_string())
2657
branch = a_bzrdir.open_branch()
2658
if revision_id is None:
2659
revision_id = branch.last_revision()
2661
revision_id = osutils.safe_revision_id(revision_id)
2662
# WorkingTree3 can handle an inventory which has a unique root id.
2663
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2664
# those trees. And because there isn't a format bump inbetween, we
2665
# are maintaining compatibility with older clients.
2666
# inv = Inventory(root_id=gen_root_id())
2667
inv = self._initial_inventory()
2668
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2674
_control_files=control_files)
2675
wt.lock_tree_write()
2677
basis_tree = branch.repository.revision_tree(revision_id)
2678
# only set an explicit root id if there is one to set.
2679
if basis_tree.inventory.root is not None:
2680
wt.set_root_id(basis_tree.inventory.root.file_id)
2681
if revision_id == NULL_REVISION:
2682
wt.set_parent_trees([])
2684
wt.set_parent_trees([(revision_id, basis_tree)])
2685
transform.build_tree(basis_tree, wt)
2687
# Unlock in this order so that the unlock-triggers-flush in
2688
# WorkingTree is given a chance to fire.
2689
control_files.unlock()
2693
def _initial_inventory(self):
2697
super(WorkingTreeFormat3, self).__init__()
2699
def open(self, a_bzrdir, _found=False):
2700
"""Return the WorkingTree object for a_bzrdir
2702
_found is a private parameter, do not use it. It is used to indicate
2703
if format probing has already been done.
2706
# we are being called directly and must probe.
2707
raise NotImplementedError
2708
if not isinstance(a_bzrdir.transport, LocalTransport):
2709
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2710
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2713
def _open(self, a_bzrdir, control_files):
2714
"""Open the tree itself.
2716
:param a_bzrdir: the dir for the tree.
2717
:param control_files: the control files for the tree.
2719
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2723
_control_files=control_files)
2726
return self.get_format_string()
2729
__default_format = WorkingTreeFormat4()
2730
WorkingTreeFormat.register_format(__default_format)
2731
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2732
WorkingTreeFormat.set_default_format(__default_format)
2733
# formats which have no format string are not discoverable
2734
# and not independently creatable, so are not registered.
2735
_legacy_formats = [WorkingTreeFormat2(),
2739
class WorkingTreeTestProviderAdapter(object):
2740
"""A tool to generate a suite testing multiple workingtree formats at once.
2742
This is done by copying the test once for each transport and injecting
2743
the transport_server, transport_readonly_server, and workingtree_format
2744
classes into each copy. Each copy is also given a new id() to make it
2748
def __init__(self, transport_server, transport_readonly_server, formats):
2749
self._transport_server = transport_server
2750
self._transport_readonly_server = transport_readonly_server
2751
self._formats = formats
2753
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2754
"""Clone test for adaption."""
2755
new_test = deepcopy(test)
2756
new_test.transport_server = self._transport_server
2757
new_test.transport_readonly_server = self._transport_readonly_server
2758
new_test.bzrdir_format = bzrdir_format
2759
new_test.workingtree_format = workingtree_format
2760
def make_new_test_id():
2761
new_id = "%s(%s)" % (test.id(), variation)
2762
return lambda: new_id
2763
new_test.id = make_new_test_id()
2766
def adapt(self, test):
2767
from bzrlib.tests import TestSuite
2768
result = TestSuite()
2769
for workingtree_format, bzrdir_format in self._formats:
2770
new_test = self._clone_test(
2773
workingtree_format, workingtree_format.__class__.__name__)
2774
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
