1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
42
from bzrlib.lazy_import import lazy_import
43
lazy_import(globals(), """
44
from bisect import bisect_left
46
from copy import deepcopy
59
conflicts as _mod_conflicts,
78
from bzrlib.transport import get_transport
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
from bzrlib import symbol_versioning
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
86
from bzrlib.lockable_files import LockableFiles, TransportLock
87
from bzrlib.lockdir import LockDir
88
import bzrlib.mutabletree
89
from bzrlib.mutabletree import needs_tree_write_lock
90
from bzrlib.osutils import (
102
from bzrlib.trace import mutter, note
103
from bzrlib.transport.local import LocalTransport
104
from bzrlib.progress import DummyProgress, ProgressPhase
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
106
from bzrlib.rio import RioReader, rio_file, Stanza
107
from bzrlib.symbol_versioning import (deprecated_passed,
110
DEPRECATED_PARAMETER,
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
121
@deprecated_function(zero_thirteen)
122
def gen_file_id(name):
123
"""Return new file id for the basename 'name'.
125
Use bzrlib.generate_ids.gen_file_id() instead
127
return generate_ids.gen_file_id(name)
130
@deprecated_function(zero_thirteen)
132
"""Return a new tree-root file id.
134
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
136
return generate_ids.gen_root_id()
139
class TreeEntry(object):
140
"""An entry that implements the minimum interface used by commands.
142
This needs further inspection, it may be better to have
143
InventoryEntries without ids - though that seems wrong. For now,
144
this is a parallel hierarchy to InventoryEntry, and needs to become
145
one of several things: decorates to that hierarchy, children of, or
147
Another note is that these objects are currently only used when there is
148
no InventoryEntry available - i.e. for unversioned objects.
149
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
152
def __eq__(self, other):
153
# yes, this us ugly, TODO: best practice __eq__ style.
154
return (isinstance(other, TreeEntry)
155
and other.__class__ == self.__class__)
157
def kind_character(self):
161
class TreeDirectory(TreeEntry):
162
"""See TreeEntry. This is a directory in a working tree."""
164
def __eq__(self, other):
165
return (isinstance(other, TreeDirectory)
166
and other.__class__ == self.__class__)
168
def kind_character(self):
172
class TreeFile(TreeEntry):
173
"""See TreeEntry. This is a regular file in a working tree."""
175
def __eq__(self, other):
176
return (isinstance(other, TreeFile)
177
and other.__class__ == self.__class__)
179
def kind_character(self):
183
class TreeLink(TreeEntry):
184
"""See TreeEntry. This is a symlink in a working tree."""
186
def __eq__(self, other):
187
return (isinstance(other, TreeLink)
188
and other.__class__ == self.__class__)
190
def kind_character(self):
194
class WorkingTree(bzrlib.mutabletree.MutableTree):
195
"""Working copy tree.
197
The inventory is held in the `Branch` working-inventory, and the
198
files are in a directory on disk.
200
It is possible for a `WorkingTree` to have a filename which is
201
not listed in the Inventory and vice versa.
204
def __init__(self, basedir='.',
205
branch=DEPRECATED_PARAMETER,
211
"""Construct a WorkingTree instance. This is not a public API.
213
:param branch: A branch to override probing for the branch.
215
self._format = _format
216
self.bzrdir = _bzrdir
218
raise errors.BzrError("Please use bzrdir.open_workingtree or "
219
"WorkingTree.open() to obtain a WorkingTree.")
220
assert isinstance(basedir, basestring), \
221
"base directory %r is not a string" % basedir
222
basedir = safe_unicode(basedir)
223
mutter("opening working tree %r", basedir)
224
if deprecated_passed(branch):
225
self._branch = branch
227
self._branch = self.bzrdir.open_branch()
228
self.basedir = realpath(basedir)
229
# if branch is at our basedir and is a format 6 or less
230
if isinstance(self._format, WorkingTreeFormat2):
231
# share control object
232
self._control_files = self.branch.control_files
234
# assume all other formats have their own control files.
235
assert isinstance(_control_files, LockableFiles), \
236
"_control_files must be a LockableFiles, not %r" \
238
self._control_files = _control_files
239
# update the whole cache up front and write to disk if anything changed;
240
# in the future we might want to do this more selectively
241
# two possible ways offer themselves : in self._unlock, write the cache
242
# if needed, or, when the cache sees a change, append it to the hash
243
# cache file, and have the parser take the most recent entry for a
245
wt_trans = self.bzrdir.get_workingtree_transport(None)
246
cache_filename = wt_trans.local_abspath('stat-cache')
247
self._hashcache = hashcache.HashCache(basedir, cache_filename,
248
self._control_files._file_mode)
251
# is this scan needed ? it makes things kinda slow.
258
if _inventory is None:
259
# This will be acquired on lock_read() or lock_write()
260
self._inventory_is_modified = False
261
self._inventory = None
263
# the caller of __init__ has provided an inventory,
264
# we assume they know what they are doing - as its only
265
# the Format factory and creation methods that are
266
# permitted to do this.
267
self._set_inventory(_inventory, dirty=False)
270
fget=lambda self: self._branch,
271
doc="""The branch this WorkingTree is connected to.
273
This cannot be set - it is reflective of the actual disk structure
274
the working tree has been constructed from.
277
def break_lock(self):
278
"""Break a lock if one is present from another instance.
280
Uses the ui factory to ask for confirmation if the lock may be from
283
This will probe the repository for its lock as well.
285
self._control_files.break_lock()
286
self.branch.break_lock()
288
def requires_rich_root(self):
289
return self._format.requires_rich_root
291
def supports_tree_reference(self):
294
def _set_inventory(self, inv, dirty):
295
"""Set the internal cached inventory.
297
:param inv: The inventory to set.
298
:param dirty: A boolean indicating whether the inventory is the same
299
logical inventory as whats on disk. If True the inventory is not
300
the same and should be written to disk or data will be lost, if
301
False then the inventory is the same as that on disk and any
302
serialisation would be unneeded overhead.
304
assert inv.root is not None
305
self._inventory = inv
306
self._inventory_is_modified = dirty
309
def open(path=None, _unsupported=False):
310
"""Open an existing working tree at path.
314
path = os.path.getcwdu()
315
control = bzrdir.BzrDir.open(path, _unsupported)
316
return control.open_workingtree(_unsupported)
319
def open_containing(path=None):
320
"""Open an existing working tree which has its root about path.
322
This probes for a working tree at path and searches upwards from there.
324
Basically we keep looking up until we find the control directory or
325
run into /. If there isn't one, raises NotBranchError.
326
TODO: give this a new exception.
327
If there is one, it is returned, along with the unused portion of path.
329
:return: The WorkingTree that contains 'path', and the rest of path
332
path = osutils.getcwd()
333
control, relpath = bzrdir.BzrDir.open_containing(path)
335
return control.open_workingtree(), relpath
338
def open_downlevel(path=None):
339
"""Open an unsupported working tree.
341
Only intended for advanced situations like upgrading part of a bzrdir.
343
return WorkingTree.open(path, _unsupported=True)
345
# should be deprecated - this is slow and in any case treating them as a
346
# container is (we now know) bad style -- mbp 20070302
347
## @deprecated_method(zero_fifteen)
349
"""Iterate through file_ids for this tree.
351
file_ids are in a WorkingTree if they are in the working inventory
352
and the working file exists.
354
inv = self._inventory
355
for path, ie in inv.iter_entries():
356
if osutils.lexists(self.abspath(path)):
360
return "<%s of %s>" % (self.__class__.__name__,
361
getattr(self, 'basedir', None))
363
def abspath(self, filename):
364
return pathjoin(self.basedir, filename)
366
def basis_tree(self):
367
"""Return RevisionTree for the current last revision.
369
If the left most parent is a ghost then the returned tree will be an
370
empty tree - one obtained by calling repository.revision_tree(None).
373
revision_id = self.get_parent_ids()[0]
375
# no parents, return an empty revision tree.
376
# in the future this should return the tree for
377
# 'empty:' - the implicit root empty tree.
378
return self.branch.repository.revision_tree(None)
380
return self.revision_tree(revision_id)
381
except errors.NoSuchRevision:
383
# No cached copy available, retrieve from the repository.
384
# FIXME? RBC 20060403 should we cache the inventory locally
387
return self.branch.repository.revision_tree(revision_id)
388
except errors.RevisionNotPresent:
389
# the basis tree *may* be a ghost or a low level error may have
390
# occured. If the revision is present, its a problem, if its not
392
if self.branch.repository.has_revision(revision_id):
394
# the basis tree is a ghost so return an empty tree.
395
return self.branch.repository.revision_tree(None)
398
@deprecated_method(zero_eight)
399
def create(branch, directory):
400
"""Create a workingtree for branch at directory.
402
If existing_directory already exists it must have a .bzr directory.
403
If it does not exist, it will be created.
405
This returns a new WorkingTree object for the new checkout.
407
TODO FIXME RBC 20060124 when we have checkout formats in place this
408
should accept an optional revisionid to checkout [and reject this if
409
checking out into the same dir as a pre-checkout-aware branch format.]
411
XXX: When BzrDir is present, these should be created through that
414
warnings.warn('delete WorkingTree.create', stacklevel=3)
415
transport = get_transport(directory)
416
if branch.bzrdir.root_transport.base == transport.base:
418
return branch.bzrdir.create_workingtree()
419
# different directory,
420
# create a branch reference
421
# and now a working tree.
422
raise NotImplementedError
425
@deprecated_method(zero_eight)
426
def create_standalone(directory):
427
"""Create a checkout and a branch and a repo at directory.
429
Directory must exist and be empty.
431
please use BzrDir.create_standalone_workingtree
433
return bzrdir.BzrDir.create_standalone_workingtree(directory)
435
def relpath(self, path):
436
"""Return the local path portion from a given path.
438
The path may be absolute or relative. If its a relative path it is
439
interpreted relative to the python current working directory.
441
return osutils.relpath(self.basedir, path)
443
def has_filename(self, filename):
444
return osutils.lexists(self.abspath(filename))
446
def get_file(self, file_id):
447
file_id = osutils.safe_file_id(file_id)
448
return self.get_file_byname(self.id2path(file_id))
450
def get_file_text(self, file_id):
451
file_id = osutils.safe_file_id(file_id)
452
return self.get_file(file_id).read()
454
def get_file_byname(self, filename):
455
return file(self.abspath(filename), 'rb')
458
def annotate_iter(self, file_id):
459
"""See Tree.annotate_iter
461
This implementation will use the basis tree implementation if possible.
462
Lines not in the basis are attributed to CURRENT_REVISION
464
If there are pending merges, lines added by those merges will be
465
incorrectly attributed to CURRENT_REVISION (but after committing, the
466
attribution will be correct).
468
file_id = osutils.safe_file_id(file_id)
469
basis = self.basis_tree()
472
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
473
require_versioned=True).next()
474
changed_content, kind = changes[2], changes[6]
475
if not changed_content:
476
return basis.annotate_iter(file_id)
480
if kind[0] != 'file':
483
old_lines = list(basis.annotate_iter(file_id))
485
for tree in self.branch.repository.revision_trees(
486
self.get_parent_ids()[1:]):
487
if file_id not in tree:
489
old.append(list(tree.annotate_iter(file_id)))
490
return annotate.reannotate(old, self.get_file(file_id).readlines(),
495
def get_parent_ids(self):
496
"""See Tree.get_parent_ids.
498
This implementation reads the pending merges list and last_revision
499
value and uses that to decide what the parents list should be.
501
last_rev = self._last_revision()
507
merges_file = self._control_files.get('pending-merges')
508
except errors.NoSuchFile:
511
for l in merges_file.readlines():
512
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
513
parents.append(revision_id)
517
def get_root_id(self):
518
"""Return the id of this trees root"""
519
return self._inventory.root.file_id
521
def _get_store_filename(self, file_id):
522
## XXX: badly named; this is not in the store at all
523
file_id = osutils.safe_file_id(file_id)
524
return self.abspath(self.id2path(file_id))
527
def clone(self, to_bzrdir, revision_id=None, basis=None):
528
"""Duplicate this working tree into to_bzr, including all state.
530
Specifically modified files are kept as modified, but
531
ignored and unknown files are discarded.
533
If you want to make a new line of development, see bzrdir.sprout()
536
If not None, the cloned tree will have its last revision set to
537
revision, and and difference between the source trees last revision
538
and this one merged in.
541
If not None, a closer copy of a tree which may have some files in
542
common, and which file content should be preferentially copied from.
544
# assumes the target bzr dir format is compatible.
545
result = self._format.initialize(to_bzrdir)
546
self.copy_content_into(result, revision_id)
550
def copy_content_into(self, tree, revision_id=None):
551
"""Copy the current content and user files of this tree into tree."""
552
tree.set_root_id(self.get_root_id())
553
if revision_id is None:
554
merge.transform_tree(tree, self)
556
# TODO now merge from tree.last_revision to revision (to preserve
557
# user local changes)
558
merge.transform_tree(tree, self)
559
tree.set_parent_ids([revision_id])
561
def id2abspath(self, file_id):
562
file_id = osutils.safe_file_id(file_id)
563
return self.abspath(self.id2path(file_id))
565
def has_id(self, file_id):
566
# files that have been deleted are excluded
567
file_id = osutils.safe_file_id(file_id)
569
if not inv.has_id(file_id):
571
path = inv.id2path(file_id)
572
return osutils.lexists(self.abspath(path))
574
def has_or_had_id(self, file_id):
575
file_id = osutils.safe_file_id(file_id)
576
if file_id == self.inventory.root.file_id:
578
return self.inventory.has_id(file_id)
580
__contains__ = has_id
582
def get_file_size(self, file_id):
583
file_id = osutils.safe_file_id(file_id)
584
return os.path.getsize(self.id2abspath(file_id))
587
def get_file_sha1(self, file_id, path=None, stat_value=None):
588
file_id = osutils.safe_file_id(file_id)
590
path = self._inventory.id2path(file_id)
591
return self._hashcache.get_sha1(path, stat_value)
593
def get_file_mtime(self, file_id, path=None):
594
file_id = osutils.safe_file_id(file_id)
596
path = self.inventory.id2path(file_id)
597
return os.lstat(self.abspath(path)).st_mtime
599
if not supports_executable():
600
def is_executable(self, file_id, path=None):
601
file_id = osutils.safe_file_id(file_id)
602
return self._inventory[file_id].executable
604
def is_executable(self, file_id, path=None):
606
file_id = osutils.safe_file_id(file_id)
607
path = self.id2path(file_id)
608
mode = os.lstat(self.abspath(path)).st_mode
609
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
611
@needs_tree_write_lock
612
def _add(self, files, ids, kinds):
613
"""See MutableTree._add."""
614
# TODO: Re-adding a file that is removed in the working copy
615
# should probably put it back with the previous ID.
616
# the read and write working inventory should not occur in this
617
# function - they should be part of lock_write and unlock.
618
inv = self.read_working_inventory()
619
for f, file_id, kind in zip(files, ids, kinds):
620
assert kind is not None
622
inv.add_path(f, kind=kind)
624
file_id = osutils.safe_file_id(file_id)
625
inv.add_path(f, kind=kind, file_id=file_id)
626
self._write_inventory(inv)
628
@needs_tree_write_lock
629
def _gather_kinds(self, files, kinds):
630
"""See MutableTree._gather_kinds."""
631
for pos, f in enumerate(files):
632
if kinds[pos] is None:
633
fullpath = normpath(self.abspath(f))
635
kinds[pos] = file_kind(fullpath)
637
if e.errno == errno.ENOENT:
638
raise errors.NoSuchFile(fullpath)
641
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
642
"""Add revision_id as a parent.
644
This is equivalent to retrieving the current list of parent ids
645
and setting the list to its value plus revision_id.
647
:param revision_id: The revision id to add to the parent list. It may
648
be a ghost revision as long as its not the first parent to be added,
649
or the allow_leftmost_as_ghost parameter is set True.
650
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
652
parents = self.get_parent_ids() + [revision_id]
653
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
654
or allow_leftmost_as_ghost)
656
@needs_tree_write_lock
657
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
658
"""Add revision_id, tree tuple as a parent.
660
This is equivalent to retrieving the current list of parent trees
661
and setting the list to its value plus parent_tuple. See also
662
add_parent_tree_id - if you only have a parent id available it will be
663
simpler to use that api. If you have the parent already available, using
664
this api is preferred.
666
:param parent_tuple: The (revision id, tree) to add to the parent list.
667
If the revision_id is a ghost, pass None for the tree.
668
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
670
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
671
if len(parent_ids) > 1:
672
# the leftmost may have already been a ghost, preserve that if it
674
allow_leftmost_as_ghost = True
675
self.set_parent_ids(parent_ids,
676
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
678
@needs_tree_write_lock
679
def add_pending_merge(self, *revision_ids):
680
# TODO: Perhaps should check at this point that the
681
# history of the revision is actually present?
682
parents = self.get_parent_ids()
684
for rev_id in revision_ids:
685
if rev_id in parents:
687
parents.append(rev_id)
690
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
692
@deprecated_method(zero_eleven)
694
def pending_merges(self):
695
"""Return a list of pending merges.
697
These are revisions that have been merged into the working
698
directory but not yet committed.
700
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
701
instead - which is available on all tree objects.
703
return self.get_parent_ids()[1:]
705
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
706
"""Common ghost checking functionality from set_parent_*.
708
This checks that the left hand-parent exists if there are any
711
if len(revision_ids) > 0:
712
leftmost_id = revision_ids[0]
713
if (not allow_leftmost_as_ghost and not
714
self.branch.repository.has_revision(leftmost_id)):
715
raise errors.GhostRevisionUnusableHere(leftmost_id)
717
def _set_merges_from_parent_ids(self, parent_ids):
718
merges = parent_ids[1:]
719
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
721
@needs_tree_write_lock
722
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
723
"""Set the parent ids to revision_ids.
725
See also set_parent_trees. This api will try to retrieve the tree data
726
for each element of revision_ids from the trees repository. If you have
727
tree data already available, it is more efficient to use
728
set_parent_trees rather than set_parent_ids. set_parent_ids is however
729
an easier API to use.
731
:param revision_ids: The revision_ids to set as the parent ids of this
732
working tree. Any of these may be ghosts.
734
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
735
self._check_parents_for_ghosts(revision_ids,
736
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
738
if len(revision_ids) > 0:
739
self.set_last_revision(revision_ids[0])
741
self.set_last_revision(None)
743
self._set_merges_from_parent_ids(revision_ids)
745
@needs_tree_write_lock
746
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
747
"""See MutableTree.set_parent_trees."""
748
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
750
self._check_parents_for_ghosts(parent_ids,
751
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
753
if len(parent_ids) == 0:
754
leftmost_parent_id = None
755
leftmost_parent_tree = None
757
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
759
if self._change_last_revision(leftmost_parent_id):
760
if leftmost_parent_tree is None:
761
# If we don't have a tree, fall back to reading the
762
# parent tree from the repository.
763
self._cache_basis_inventory(leftmost_parent_id)
765
inv = leftmost_parent_tree.inventory
766
xml = self._create_basis_xml_from_inventory(
767
leftmost_parent_id, inv)
768
self._write_basis_inventory(xml)
769
self._set_merges_from_parent_ids(parent_ids)
771
@needs_tree_write_lock
772
def set_pending_merges(self, rev_list):
773
parents = self.get_parent_ids()
774
leftmost = parents[:1]
775
new_parents = leftmost + rev_list
776
self.set_parent_ids(new_parents)
778
@needs_tree_write_lock
779
def set_merge_modified(self, modified_hashes):
781
for file_id, hash in modified_hashes.iteritems():
782
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
783
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
785
def _put_rio(self, filename, stanzas, header):
786
self._must_be_locked()
787
my_file = rio_file(stanzas, header)
788
self._control_files.put(filename, my_file)
790
@needs_write_lock # because merge pulls data into the branch.
791
def merge_from_branch(self, branch, to_revision=None):
792
"""Merge from a branch into this working tree.
794
:param branch: The branch to merge from.
795
:param to_revision: If non-None, the merge will merge to to_revision,
796
but not beyond it. to_revision does not need to be in the history
797
of the branch when it is supplied. If None, to_revision defaults to
798
branch.last_revision().
800
from bzrlib.merge import Merger, Merge3Merger
801
pb = bzrlib.ui.ui_factory.nested_progress_bar()
803
merger = Merger(self.branch, this_tree=self, pb=pb)
804
merger.pp = ProgressPhase("Merge phase", 5, pb)
805
merger.pp.next_phase()
806
# check that there are no
808
merger.check_basis(check_clean=True, require_commits=False)
809
if to_revision is None:
810
to_revision = branch.last_revision()
812
to_revision = osutils.safe_revision_id(to_revision)
813
merger.other_rev_id = to_revision
814
if merger.other_rev_id is None:
815
raise error.NoCommits(branch)
816
self.branch.fetch(branch, last_revision=merger.other_rev_id)
817
merger.other_basis = merger.other_rev_id
818
merger.other_tree = self.branch.repository.revision_tree(
820
merger.other_branch = branch
821
merger.pp.next_phase()
823
if merger.base_rev_id == merger.other_rev_id:
824
raise errors.PointlessMerge
825
merger.backup_files = False
826
merger.merge_type = Merge3Merger
827
merger.set_interesting_files(None)
828
merger.show_base = False
829
merger.reprocess = False
830
conflicts = merger.do_merge()
837
def merge_modified(self):
838
"""Return a dictionary of files modified by a merge.
840
The list is initialized by WorkingTree.set_merge_modified, which is
841
typically called after we make some automatic updates to the tree
844
This returns a map of file_id->sha1, containing only files which are
845
still in the working inventory and have that text hash.
848
hashfile = self._control_files.get('merge-hashes')
849
except errors.NoSuchFile:
853
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
854
raise errors.MergeModifiedFormatError()
855
except StopIteration:
856
raise errors.MergeModifiedFormatError()
857
for s in RioReader(hashfile):
858
# RioReader reads in Unicode, so convert file_ids back to utf8
859
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
860
if file_id not in self.inventory:
862
text_hash = s.get("hash")
863
if text_hash == self.get_file_sha1(file_id):
864
merge_hashes[file_id] = text_hash
868
def mkdir(self, path, file_id=None):
869
"""See MutableTree.mkdir()."""
871
file_id = generate_ids.gen_file_id(os.path.basename(path))
872
os.mkdir(self.abspath(path))
873
self.add(path, file_id, 'directory')
876
def get_symlink_target(self, file_id):
877
file_id = osutils.safe_file_id(file_id)
878
return os.readlink(self.id2abspath(file_id))
881
def subsume(self, other_tree):
882
def add_children(inventory, entry):
883
for child_entry in entry.children.values():
884
inventory._byid[child_entry.file_id] = child_entry
885
if child_entry.kind == 'directory':
886
add_children(inventory, child_entry)
887
if other_tree.get_root_id() == self.get_root_id():
888
raise errors.BadSubsumeSource(self, other_tree,
889
'Trees have the same root')
891
other_tree_path = self.relpath(other_tree.basedir)
892
except errors.PathNotChild:
893
raise errors.BadSubsumeSource(self, other_tree,
894
'Tree is not contained by the other')
895
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
896
if new_root_parent is None:
897
raise errors.BadSubsumeSource(self, other_tree,
898
'Parent directory is not versioned.')
899
# We need to ensure that the result of a fetch will have a
900
# versionedfile for the other_tree root, and only fetching into
901
# RepositoryKnit2 guarantees that.
902
if not self.branch.repository.supports_rich_root():
903
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
904
other_tree.lock_tree_write()
906
new_parents = other_tree.get_parent_ids()
907
other_root = other_tree.inventory.root
908
other_root.parent_id = new_root_parent
909
other_root.name = osutils.basename(other_tree_path)
910
self.inventory.add(other_root)
911
add_children(self.inventory, other_root)
912
self._write_inventory(self.inventory)
913
# normally we don't want to fetch whole repositories, but i think
914
# here we really do want to consolidate the whole thing.
915
for parent_id in other_tree.get_parent_ids():
916
self.branch.fetch(other_tree.branch, parent_id)
917
self.add_parent_tree_id(parent_id)
920
other_tree.bzrdir.retire_bzrdir()
922
@needs_tree_write_lock
923
def extract(self, file_id, format=None):
924
"""Extract a subtree from this tree.
926
A new branch will be created, relative to the path for this tree.
930
segments = osutils.splitpath(path)
931
transport = self.branch.bzrdir.root_transport
932
for name in segments:
933
transport = transport.clone(name)
936
except errors.FileExists:
940
sub_path = self.id2path(file_id)
941
branch_transport = mkdirs(sub_path)
943
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
945
branch_transport.mkdir('.')
946
except errors.FileExists:
948
branch_bzrdir = format.initialize_on_transport(branch_transport)
950
repo = branch_bzrdir.find_repository()
951
except errors.NoRepositoryPresent:
952
repo = branch_bzrdir.create_repository()
953
assert repo.supports_rich_root()
955
if not repo.supports_rich_root():
956
raise errors.RootNotRich()
957
new_branch = branch_bzrdir.create_branch()
958
new_branch.pull(self.branch)
959
for parent_id in self.get_parent_ids():
960
new_branch.fetch(self.branch, parent_id)
961
tree_transport = self.bzrdir.root_transport.clone(sub_path)
962
if tree_transport.base != branch_transport.base:
963
tree_bzrdir = format.initialize_on_transport(tree_transport)
964
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
966
tree_bzrdir = branch_bzrdir
967
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
968
wt.set_parent_ids(self.get_parent_ids())
969
my_inv = self.inventory
970
child_inv = Inventory(root_id=None)
971
new_root = my_inv[file_id]
972
my_inv.remove_recursive_id(file_id)
973
new_root.parent_id = None
974
child_inv.add(new_root)
975
self._write_inventory(my_inv)
976
wt._write_inventory(child_inv)
979
def _serialize(self, inventory, out_file):
980
xml5.serializer_v5.write_inventory(self._inventory, out_file)
982
def _deserialize(selt, in_file):
983
return xml5.serializer_v5.read_inventory(in_file)
986
"""Write the in memory inventory to disk."""
987
# TODO: Maybe this should only write on dirty ?
988
if self._control_files._lock_mode != 'w':
989
raise errors.NotWriteLocked(self)
991
self._serialize(self._inventory, sio)
993
self._control_files.put('inventory', sio)
994
self._inventory_is_modified = False
996
def _kind(self, relpath):
997
return osutils.file_kind(self.abspath(relpath))
999
def list_files(self, include_root=False):
1000
"""Recursively list all files as (path, class, kind, id, entry).
1002
Lists, but does not descend into unversioned directories.
1004
This does not include files that have been deleted in this
1007
Skips the control directory.
1009
# list_files is an iterator, so @needs_read_lock doesn't work properly
1010
# with it. So callers should be careful to always read_lock the tree.
1011
if not self.is_locked():
1012
raise errors.ObjectNotLocked(self)
1014
inv = self.inventory
1015
if include_root is True:
1016
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1017
# Convert these into local objects to save lookup times
1018
pathjoin = osutils.pathjoin
1019
file_kind = self._kind
1021
# transport.base ends in a slash, we want the piece
1022
# between the last two slashes
1023
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1025
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1027
# directory file_id, relative path, absolute path, reverse sorted children
1028
children = os.listdir(self.basedir)
1030
# jam 20060527 The kernel sized tree seems equivalent whether we
1031
# use a deque and popleft to keep them sorted, or if we use a plain
1032
# list and just reverse() them.
1033
children = collections.deque(children)
1034
stack = [(inv.root.file_id, u'', self.basedir, children)]
1036
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1039
f = children.popleft()
1040
## TODO: If we find a subdirectory with its own .bzr
1041
## directory, then that is a separate tree and we
1042
## should exclude it.
1044
# the bzrdir for this tree
1045
if transport_base_dir == f:
1048
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1049
# and 'f' doesn't begin with one, we can do a string op, rather
1050
# than the checks of pathjoin(), all relative paths will have an extra slash
1052
fp = from_dir_relpath + '/' + f
1055
fap = from_dir_abspath + '/' + f
1057
f_ie = inv.get_child(from_dir_id, f)
1060
elif self.is_ignored(fp[1:]):
1063
# we may not have found this file, because of a unicode issue
1064
f_norm, can_access = osutils.normalized_filename(f)
1065
if f == f_norm or not can_access:
1066
# No change, so treat this file normally
1069
# this file can be accessed by a normalized path
1070
# check again if it is versioned
1071
# these lines are repeated here for performance
1073
fp = from_dir_relpath + '/' + f
1074
fap = from_dir_abspath + '/' + f
1075
f_ie = inv.get_child(from_dir_id, f)
1078
elif self.is_ignored(fp[1:]):
1085
# make a last minute entry
1087
yield fp[1:], c, fk, f_ie.file_id, f_ie
1090
yield fp[1:], c, fk, None, fk_entries[fk]()
1092
yield fp[1:], c, fk, None, TreeEntry()
1095
if fk != 'directory':
1098
# But do this child first
1099
new_children = os.listdir(fap)
1101
new_children = collections.deque(new_children)
1102
stack.append((f_ie.file_id, fp, fap, new_children))
1103
# Break out of inner loop,
1104
# so that we start outer loop with child
1107
# if we finished all children, pop it off the stack
1110
@needs_tree_write_lock
1111
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1114
to_dir must exist in the inventory.
1116
If to_dir exists and is a directory, the files are moved into
1117
it, keeping their old names.
1119
Note that to_dir is only the last component of the new name;
1120
this doesn't change the directory.
1122
For each entry in from_paths the move mode will be determined
1125
The first mode moves the file in the filesystem and updates the
1126
inventory. The second mode only updates the inventory without
1127
touching the file on the filesystem. This is the new mode introduced
1130
move uses the second mode if 'after == True' and the target is not
1131
versioned but present in the working tree.
1133
move uses the second mode if 'after == False' and the source is
1134
versioned but no longer in the working tree, and the target is not
1135
versioned but present in the working tree.
1137
move uses the first mode if 'after == False' and the source is
1138
versioned and present in the working tree, and the target is not
1139
versioned and not present in the working tree.
1141
Everything else results in an error.
1143
This returns a list of (from_path, to_path) pairs for each
1144
entry that is moved.
1149
# check for deprecated use of signature
1151
to_dir = kwargs.get('to_name', None)
1153
raise TypeError('You must supply a target directory')
1155
symbol_versioning.warn('The parameter to_name was deprecated'
1156
' in version 0.13. Use to_dir instead',
1159
# check destination directory
1160
assert not isinstance(from_paths, basestring)
1161
inv = self.inventory
1162
to_abs = self.abspath(to_dir)
1163
if not isdir(to_abs):
1164
raise errors.BzrMoveFailedError('',to_dir,
1165
errors.NotADirectory(to_abs))
1166
if not self.has_filename(to_dir):
1167
raise errors.BzrMoveFailedError('',to_dir,
1168
errors.NotInWorkingDirectory(to_dir))
1169
to_dir_id = inv.path2id(to_dir)
1170
if to_dir_id is None:
1171
raise errors.BzrMoveFailedError('',to_dir,
1172
errors.NotVersionedError(path=str(to_dir)))
1174
to_dir_ie = inv[to_dir_id]
1175
if to_dir_ie.kind != 'directory':
1176
raise errors.BzrMoveFailedError('',to_dir,
1177
errors.NotADirectory(to_abs))
1179
# create rename entries and tuples
1180
for from_rel in from_paths:
1181
from_tail = splitpath(from_rel)[-1]
1182
from_id = inv.path2id(from_rel)
1184
raise errors.BzrMoveFailedError(from_rel,to_dir,
1185
errors.NotVersionedError(path=str(from_rel)))
1187
from_entry = inv[from_id]
1188
from_parent_id = from_entry.parent_id
1189
to_rel = pathjoin(to_dir, from_tail)
1190
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1192
from_tail=from_tail,
1193
from_parent_id=from_parent_id,
1194
to_rel=to_rel, to_tail=from_tail,
1195
to_parent_id=to_dir_id)
1196
rename_entries.append(rename_entry)
1197
rename_tuples.append((from_rel, to_rel))
1199
# determine which move mode to use. checks also for movability
1200
rename_entries = self._determine_mv_mode(rename_entries, after)
1202
original_modified = self._inventory_is_modified
1205
self._inventory_is_modified = True
1206
self._move(rename_entries)
1208
# restore the inventory on error
1209
self._inventory_is_modified = original_modified
1211
self._write_inventory(inv)
1212
return rename_tuples
1214
def _determine_mv_mode(self, rename_entries, after=False):
1215
"""Determines for each from-to pair if both inventory and working tree
1216
or only the inventory has to be changed.
1218
Also does basic plausability tests.
1220
inv = self.inventory
1222
for rename_entry in rename_entries:
1223
# store to local variables for easier reference
1224
from_rel = rename_entry.from_rel
1225
from_id = rename_entry.from_id
1226
to_rel = rename_entry.to_rel
1227
to_id = inv.path2id(to_rel)
1228
only_change_inv = False
1230
# check the inventory for source and destination
1232
raise errors.BzrMoveFailedError(from_rel,to_rel,
1233
errors.NotVersionedError(path=str(from_rel)))
1234
if to_id is not None:
1235
raise errors.BzrMoveFailedError(from_rel,to_rel,
1236
errors.AlreadyVersionedError(path=str(to_rel)))
1238
# try to determine the mode for rename (only change inv or change
1239
# inv and file system)
1241
if not self.has_filename(to_rel):
1242
raise errors.BzrMoveFailedError(from_id,to_rel,
1243
errors.NoSuchFile(path=str(to_rel),
1244
extra="New file has not been created yet"))
1245
only_change_inv = True
1246
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1247
only_change_inv = True
1248
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1249
only_change_inv = False
1251
# something is wrong, so lets determine what exactly
1252
if not self.has_filename(from_rel) and \
1253
not self.has_filename(to_rel):
1254
raise errors.BzrRenameFailedError(from_rel,to_rel,
1255
errors.PathsDoNotExist(paths=(str(from_rel),
1258
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1259
extra="(Use --after to update the Bazaar id)")
1260
rename_entry.only_change_inv = only_change_inv
1261
return rename_entries
1263
def _move(self, rename_entries):
1264
"""Moves a list of files.
1266
Depending on the value of the flag 'only_change_inv', the
1267
file will be moved on the file system or not.
1269
inv = self.inventory
1272
for entry in rename_entries:
1274
self._move_entry(entry)
1276
self._rollback_move(moved)
1280
def _rollback_move(self, moved):
1281
"""Try to rollback a previous move in case of an filesystem error."""
1282
inv = self.inventory
1285
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1286
entry.to_tail, entry.to_parent_id, entry.from_rel,
1287
entry.from_tail, entry.from_parent_id,
1288
entry.only_change_inv))
1289
except errors.BzrMoveFailedError, e:
1290
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1291
" The working tree is in an inconsistent state."
1292
" Please consider doing a 'bzr revert'."
1293
" Error message is: %s" % e)
1295
def _move_entry(self, entry):
1296
inv = self.inventory
1297
from_rel_abs = self.abspath(entry.from_rel)
1298
to_rel_abs = self.abspath(entry.to_rel)
1299
if from_rel_abs == to_rel_abs:
1300
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1301
"Source and target are identical.")
1303
if not entry.only_change_inv:
1305
osutils.rename(from_rel_abs, to_rel_abs)
1307
raise errors.BzrMoveFailedError(entry.from_rel,
1309
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1311
@needs_tree_write_lock
1312
def rename_one(self, from_rel, to_rel, after=False):
1315
This can change the directory or the filename or both.
1317
rename_one has several 'modes' to work. First, it can rename a physical
1318
file and change the file_id. That is the normal mode. Second, it can
1319
only change the file_id without touching any physical file. This is
1320
the new mode introduced in version 0.15.
1322
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1323
versioned but present in the working tree.
1325
rename_one uses the second mode if 'after == False' and 'from_rel' is
1326
versioned but no longer in the working tree, and 'to_rel' is not
1327
versioned but present in the working tree.
1329
rename_one uses the first mode if 'after == False' and 'from_rel' is
1330
versioned and present in the working tree, and 'to_rel' is not
1331
versioned and not present in the working tree.
1333
Everything else results in an error.
1335
inv = self.inventory
1338
# create rename entries and tuples
1339
from_tail = splitpath(from_rel)[-1]
1340
from_id = inv.path2id(from_rel)
1342
raise errors.BzrRenameFailedError(from_rel,to_rel,
1343
errors.NotVersionedError(path=str(from_rel)))
1344
from_entry = inv[from_id]
1345
from_parent_id = from_entry.parent_id
1346
to_dir, to_tail = os.path.split(to_rel)
1347
to_dir_id = inv.path2id(to_dir)
1348
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1350
from_tail=from_tail,
1351
from_parent_id=from_parent_id,
1352
to_rel=to_rel, to_tail=to_tail,
1353
to_parent_id=to_dir_id)
1354
rename_entries.append(rename_entry)
1356
# determine which move mode to use. checks also for movability
1357
rename_entries = self._determine_mv_mode(rename_entries, after)
1359
# check if the target changed directory and if the target directory is
1361
if to_dir_id is None:
1362
raise errors.BzrMoveFailedError(from_rel,to_rel,
1363
errors.NotVersionedError(path=str(to_dir)))
1365
# all checks done. now we can continue with our actual work
1366
mutter('rename_one:\n'
1371
' to_dir_id {%s}\n',
1372
from_id, from_rel, to_rel, to_dir, to_dir_id)
1374
self._move(rename_entries)
1375
self._write_inventory(inv)
1377
class _RenameEntry(object):
1378
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1379
to_rel, to_tail, to_parent_id, only_change_inv=False):
1380
self.from_rel = from_rel
1381
self.from_id = from_id
1382
self.from_tail = from_tail
1383
self.from_parent_id = from_parent_id
1384
self.to_rel = to_rel
1385
self.to_tail = to_tail
1386
self.to_parent_id = to_parent_id
1387
self.only_change_inv = only_change_inv
1391
"""Return all unknown files.
1393
These are files in the working directory that are not versioned or
1394
control files or ignored.
1396
# force the extras method to be fully executed before returning, to
1397
# prevent race conditions with the lock
1399
[subp for subp in self.extras() if not self.is_ignored(subp)])
1401
@needs_tree_write_lock
1402
def unversion(self, file_ids):
1403
"""Remove the file ids in file_ids from the current versioned set.
1405
When a file_id is unversioned, all of its children are automatically
1408
:param file_ids: The file ids to stop versioning.
1409
:raises: NoSuchId if any fileid is not currently versioned.
1411
for file_id in file_ids:
1412
file_id = osutils.safe_file_id(file_id)
1413
if self._inventory.has_id(file_id):
1414
self._inventory.remove_recursive_id(file_id)
1416
raise errors.NoSuchId(self, file_id)
1418
# in the future this should just set a dirty bit to wait for the
1419
# final unlock. However, until all methods of workingtree start
1420
# with the current in -memory inventory rather than triggering
1421
# a read, it is more complex - we need to teach read_inventory
1422
# to know when to read, and when to not read first... and possibly
1423
# to save first when the in memory one may be corrupted.
1424
# so for now, we just only write it if it is indeed dirty.
1426
self._write_inventory(self._inventory)
1428
@deprecated_method(zero_eight)
1429
def iter_conflicts(self):
1430
"""List all files in the tree that have text or content conflicts.
1431
DEPRECATED. Use conflicts instead."""
1432
return self._iter_conflicts()
1434
def _iter_conflicts(self):
1436
for info in self.list_files():
1438
stem = get_conflicted_stem(path)
1441
if stem not in conflicted:
1442
conflicted.add(stem)
1446
def pull(self, source, overwrite=False, stop_revision=None,
1447
change_reporter=None):
1448
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1451
pp = ProgressPhase("Pull phase", 2, top_pb)
1453
old_revision_info = self.branch.last_revision_info()
1454
basis_tree = self.basis_tree()
1455
count = self.branch.pull(source, overwrite, stop_revision)
1456
new_revision_info = self.branch.last_revision_info()
1457
if new_revision_info != old_revision_info:
1459
repository = self.branch.repository
1460
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1461
basis_tree.lock_read()
1463
new_basis_tree = self.branch.basis_tree()
1470
change_reporter=change_reporter)
1471
if (basis_tree.inventory.root is None and
1472
new_basis_tree.inventory.root is not None):
1473
self.set_root_id(new_basis_tree.inventory.root.file_id)
1477
# TODO - dedup parents list with things merged by pull ?
1478
# reuse the revisiontree we merged against to set the new
1480
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1481
# we have to pull the merge trees out again, because
1482
# merge_inner has set the ids. - this corner is not yet
1483
# layered well enough to prevent double handling.
1484
# XXX TODO: Fix the double handling: telling the tree about
1485
# the already known parent data is wasteful.
1486
merges = self.get_parent_ids()[1:]
1487
parent_trees.extend([
1488
(parent, repository.revision_tree(parent)) for
1490
self.set_parent_trees(parent_trees)
1497
def put_file_bytes_non_atomic(self, file_id, bytes):
1498
"""See MutableTree.put_file_bytes_non_atomic."""
1499
file_id = osutils.safe_file_id(file_id)
1500
stream = file(self.id2abspath(file_id), 'wb')
1505
# TODO: update the hashcache here ?
1508
"""Yield all unversioned files in this WorkingTree.
1510
If there are any unversioned directories then only the directory is
1511
returned, not all its children. But if there are unversioned files
1512
under a versioned subdirectory, they are returned.
1514
Currently returned depth-first, sorted by name within directories.
1515
This is the same order used by 'osutils.walkdirs'.
1517
## TODO: Work from given directory downwards
1518
for path, dir_entry in self.inventory.directories():
1519
# mutter("search for unknowns in %r", path)
1520
dirabs = self.abspath(path)
1521
if not isdir(dirabs):
1522
# e.g. directory deleted
1526
for subf in os.listdir(dirabs):
1529
if subf not in dir_entry.children:
1530
subf_norm, can_access = osutils.normalized_filename(subf)
1531
if subf_norm != subf and can_access:
1532
if subf_norm not in dir_entry.children:
1533
fl.append(subf_norm)
1539
subp = pathjoin(path, subf)
1542
def ignored_files(self):
1543
"""Yield list of PATH, IGNORE_PATTERN"""
1544
for subp in self.extras():
1545
pat = self.is_ignored(subp)
1549
def get_ignore_list(self):
1550
"""Return list of ignore patterns.
1552
Cached in the Tree object after the first call.
1554
ignoreset = getattr(self, '_ignoreset', None)
1555
if ignoreset is not None:
1558
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1559
ignore_globs.update(ignores.get_runtime_ignores())
1560
ignore_globs.update(ignores.get_user_ignores())
1561
if self.has_filename(bzrlib.IGNORE_FILENAME):
1562
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1564
ignore_globs.update(ignores.parse_ignore_file(f))
1567
self._ignoreset = ignore_globs
1570
def _flush_ignore_list_cache(self):
1571
"""Resets the cached ignore list to force a cache rebuild."""
1572
self._ignoreset = None
1573
self._ignoreglobster = None
1575
def is_ignored(self, filename):
1576
r"""Check whether the filename matches an ignore pattern.
1578
Patterns containing '/' or '\' need to match the whole path;
1579
others match against only the last component.
1581
If the file is ignored, returns the pattern which caused it to
1582
be ignored, otherwise None. So this can simply be used as a
1583
boolean if desired."""
1584
if getattr(self, '_ignoreglobster', None) is None:
1585
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1586
return self._ignoreglobster.match(filename)
1588
def kind(self, file_id):
1589
return file_kind(self.id2abspath(file_id))
1591
def _comparison_data(self, entry, path):
1592
abspath = self.abspath(path)
1594
stat_value = os.lstat(abspath)
1596
if getattr(e, 'errno', None) == errno.ENOENT:
1603
mode = stat_value.st_mode
1604
kind = osutils.file_kind_from_stat_mode(mode)
1605
if not supports_executable():
1606
executable = entry.executable
1608
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1609
return kind, executable, stat_value
1611
def _file_size(self, entry, stat_value):
1612
return stat_value.st_size
1614
def last_revision(self):
1615
"""Return the last revision of the branch for this tree.
1617
This format tree does not support a separate marker for last-revision
1618
compared to the branch.
1620
See MutableTree.last_revision
1622
return self._last_revision()
1625
def _last_revision(self):
1626
"""helper for get_parent_ids."""
1627
return self.branch.last_revision()
1629
def is_locked(self):
1630
return self._control_files.is_locked()
1632
def _must_be_locked(self):
1633
if not self.is_locked():
1634
raise errors.ObjectNotLocked(self)
1636
def lock_read(self):
1637
"""See Branch.lock_read, and WorkingTree.unlock."""
1638
if not self.is_locked():
1640
self.branch.lock_read()
1642
return self._control_files.lock_read()
1644
self.branch.unlock()
1647
def lock_tree_write(self):
1648
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1649
if not self.is_locked():
1651
self.branch.lock_read()
1653
return self._control_files.lock_write()
1655
self.branch.unlock()
1658
def lock_write(self):
1659
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1660
if not self.is_locked():
1662
self.branch.lock_write()
1664
return self._control_files.lock_write()
1666
self.branch.unlock()
1669
def get_physical_lock_status(self):
1670
return self._control_files.get_physical_lock_status()
1672
def _basis_inventory_name(self):
1673
return 'basis-inventory-cache'
1675
def _reset_data(self):
1676
"""Reset transient data that cannot be revalidated."""
1677
self._inventory_is_modified = False
1678
result = self._deserialize(self._control_files.get('inventory'))
1679
self._set_inventory(result, dirty=False)
1681
@needs_tree_write_lock
1682
def set_last_revision(self, new_revision):
1683
"""Change the last revision in the working tree."""
1684
new_revision = osutils.safe_revision_id(new_revision)
1685
if self._change_last_revision(new_revision):
1686
self._cache_basis_inventory(new_revision)
1688
def _change_last_revision(self, new_revision):
1689
"""Template method part of set_last_revision to perform the change.
1691
This is used to allow WorkingTree3 instances to not affect branch
1692
when their last revision is set.
1694
if new_revision is None:
1695
self.branch.set_revision_history([])
1698
self.branch.generate_revision_history(new_revision)
1699
except errors.NoSuchRevision:
1700
# not present in the repo - dont try to set it deeper than the tip
1701
self.branch.set_revision_history([new_revision])
1704
def _write_basis_inventory(self, xml):
1705
"""Write the basis inventory XML to the basis-inventory file"""
1706
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1707
path = self._basis_inventory_name()
1709
self._control_files.put(path, sio)
1711
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1712
"""Create the text that will be saved in basis-inventory"""
1713
# TODO: jam 20070209 This should be redundant, as the revision_id
1714
# as all callers should have already converted the revision_id to
1716
inventory.revision_id = osutils.safe_revision_id(revision_id)
1717
return xml7.serializer_v7.write_inventory_to_string(inventory)
1719
def _cache_basis_inventory(self, new_revision):
1720
"""Cache new_revision as the basis inventory."""
1721
# TODO: this should allow the ready-to-use inventory to be passed in,
1722
# as commit already has that ready-to-use [while the format is the
1725
# this double handles the inventory - unpack and repack -
1726
# but is easier to understand. We can/should put a conditional
1727
# in here based on whether the inventory is in the latest format
1728
# - perhaps we should repack all inventories on a repository
1730
# the fast path is to copy the raw xml from the repository. If the
1731
# xml contains 'revision_id="', then we assume the right
1732
# revision_id is set. We must check for this full string, because a
1733
# root node id can legitimately look like 'revision_id' but cannot
1735
xml = self.branch.repository.get_inventory_xml(new_revision)
1736
firstline = xml.split('\n', 1)[0]
1737
if (not 'revision_id="' in firstline or
1738
'format="7"' not in firstline):
1739
inv = self.branch.repository.deserialise_inventory(
1741
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1742
self._write_basis_inventory(xml)
1743
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1746
def read_basis_inventory(self):
1747
"""Read the cached basis inventory."""
1748
path = self._basis_inventory_name()
1749
return self._control_files.get(path).read()
1752
def read_working_inventory(self):
1753
"""Read the working inventory.
1755
:raises errors.InventoryModified: read_working_inventory will fail
1756
when the current in memory inventory has been modified.
1758
# conceptually this should be an implementation detail of the tree.
1759
# XXX: Deprecate this.
1760
# ElementTree does its own conversion from UTF-8, so open in
1762
if self._inventory_is_modified:
1763
raise errors.InventoryModified(self)
1764
result = self._deserialize(self._control_files.get('inventory'))
1765
self._set_inventory(result, dirty=False)
1768
@needs_tree_write_lock
1769
def remove(self, files, verbose=False, to_file=None):
1770
"""Remove nominated files from the working inventory..
1772
This does not remove their text. This does not run on XXX on what? RBC
1774
TODO: Refuse to remove modified files unless --force is given?
1776
TODO: Do something useful with directories.
1778
TODO: Should this remove the text or not? Tough call; not
1779
removing may be useful and the user can just use use rm, and
1780
is the opposite of add. Removing it is consistent with most
1781
other tools. Maybe an option.
1783
## TODO: Normalize names
1784
## TODO: Remove nested loops; better scalability
1785
if isinstance(files, basestring):
1788
inv = self.inventory
1790
# do this before any modifications
1792
fid = inv.path2id(f)
1794
note("%s is not versioned."%f)
1797
# having remove it, it must be either ignored or unknown
1798
if self.is_ignored(f):
1802
textui.show_status(new_status, inv[fid].kind, f,
1806
self._write_inventory(inv)
1808
@needs_tree_write_lock
1809
def revert(self, filenames, old_tree=None, backups=True,
1810
pb=DummyProgress(), report_changes=False):
1811
from bzrlib.conflicts import resolve
1812
if old_tree is None:
1813
old_tree = self.basis_tree()
1814
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1816
if not len(filenames):
1817
self.set_parent_ids(self.get_parent_ids()[:1])
1820
resolve(self, filenames, ignore_misses=True)
1823
def revision_tree(self, revision_id):
1824
"""See Tree.revision_tree.
1826
WorkingTree can supply revision_trees for the basis revision only
1827
because there is only one cached inventory in the bzr directory.
1829
if revision_id == self.last_revision():
1831
xml = self.read_basis_inventory()
1832
except errors.NoSuchFile:
1836
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1837
# dont use the repository revision_tree api because we want
1838
# to supply the inventory.
1839
if inv.revision_id == revision_id:
1840
return revisiontree.RevisionTree(self.branch.repository,
1842
except errors.BadInventoryFormat:
1844
# raise if there was no inventory, or if we read the wrong inventory.
1845
raise errors.NoSuchRevisionInTree(self, revision_id)
1847
# XXX: This method should be deprecated in favour of taking in a proper
1848
# new Inventory object.
1849
@needs_tree_write_lock
1850
def set_inventory(self, new_inventory_list):
1851
from bzrlib.inventory import (Inventory,
1856
inv = Inventory(self.get_root_id())
1857
for path, file_id, parent, kind in new_inventory_list:
1858
name = os.path.basename(path)
1861
# fixme, there should be a factory function inv,add_??
1862
if kind == 'directory':
1863
inv.add(InventoryDirectory(file_id, name, parent))
1864
elif kind == 'file':
1865
inv.add(InventoryFile(file_id, name, parent))
1866
elif kind == 'symlink':
1867
inv.add(InventoryLink(file_id, name, parent))
1869
raise errors.BzrError("unknown kind %r" % kind)
1870
self._write_inventory(inv)
1872
@needs_tree_write_lock
1873
def set_root_id(self, file_id):
1874
"""Set the root id for this tree."""
1877
symbol_versioning.warn(symbol_versioning.zero_twelve
1878
% 'WorkingTree.set_root_id with fileid=None',
1883
file_id = osutils.safe_file_id(file_id)
1884
self._set_root_id(file_id)
1886
def _set_root_id(self, file_id):
1887
"""Set the root id for this tree, in a format specific manner.
1889
:param file_id: The file id to assign to the root. It must not be
1890
present in the current inventory or an error will occur. It must
1891
not be None, but rather a valid file id.
1893
inv = self._inventory
1894
orig_root_id = inv.root.file_id
1895
# TODO: it might be nice to exit early if there was nothing
1896
# to do, saving us from trigger a sync on unlock.
1897
self._inventory_is_modified = True
1898
# we preserve the root inventory entry object, but
1899
# unlinkit from the byid index
1900
del inv._byid[inv.root.file_id]
1901
inv.root.file_id = file_id
1902
# and link it into the index with the new changed id.
1903
inv._byid[inv.root.file_id] = inv.root
1904
# and finally update all children to reference the new id.
1905
# XXX: this should be safe to just look at the root.children
1906
# list, not the WHOLE INVENTORY.
1909
if entry.parent_id == orig_root_id:
1910
entry.parent_id = inv.root.file_id
1913
"""See Branch.unlock.
1915
WorkingTree locking just uses the Branch locking facilities.
1916
This is current because all working trees have an embedded branch
1917
within them. IF in the future, we were to make branch data shareable
1918
between multiple working trees, i.e. via shared storage, then we
1919
would probably want to lock both the local tree, and the branch.
1921
raise NotImplementedError(self.unlock)
1924
"""Update a working tree along its branch.
1926
This will update the branch if its bound too, which means we have
1927
multiple trees involved:
1929
- The new basis tree of the master.
1930
- The old basis tree of the branch.
1931
- The old basis tree of the working tree.
1932
- The current working tree state.
1934
Pathologically, all three may be different, and non-ancestors of each
1935
other. Conceptually we want to:
1937
- Preserve the wt.basis->wt.state changes
1938
- Transform the wt.basis to the new master basis.
1939
- Apply a merge of the old branch basis to get any 'local' changes from
1941
- Restore the wt.basis->wt.state changes.
1943
There isn't a single operation at the moment to do that, so we:
1944
- Merge current state -> basis tree of the master w.r.t. the old tree
1946
- Do a 'normal' merge of the old branch basis if it is relevant.
1948
if self.branch.get_master_branch() is not None:
1950
update_branch = True
1952
self.lock_tree_write()
1953
update_branch = False
1956
old_tip = self.branch.update()
1959
return self._update_tree(old_tip)
1963
@needs_tree_write_lock
1964
def _update_tree(self, old_tip=None):
1965
"""Update a tree to the master branch.
1967
:param old_tip: if supplied, the previous tip revision the branch,
1968
before it was changed to the master branch's tip.
1970
# here if old_tip is not None, it is the old tip of the branch before
1971
# it was updated from the master branch. This should become a pending
1972
# merge in the working tree to preserve the user existing work. we
1973
# cant set that until we update the working trees last revision to be
1974
# one from the new branch, because it will just get absorbed by the
1975
# parent de-duplication logic.
1977
# We MUST save it even if an error occurs, because otherwise the users
1978
# local work is unreferenced and will appear to have been lost.
1982
last_rev = self.get_parent_ids()[0]
1985
if last_rev != self.branch.last_revision():
1986
# merge tree state up to new branch tip.
1987
basis = self.basis_tree()
1990
to_tree = self.branch.basis_tree()
1991
if basis.inventory.root is None:
1992
self.set_root_id(to_tree.inventory.root.file_id)
1994
result += merge.merge_inner(
2001
# TODO - dedup parents list with things merged by pull ?
2002
# reuse the tree we've updated to to set the basis:
2003
parent_trees = [(self.branch.last_revision(), to_tree)]
2004
merges = self.get_parent_ids()[1:]
2005
# Ideally we ask the tree for the trees here, that way the working
2006
# tree can decide whether to give us teh entire tree or give us a
2007
# lazy initialised tree. dirstate for instance will have the trees
2008
# in ram already, whereas a last-revision + basis-inventory tree
2009
# will not, but also does not need them when setting parents.
2010
for parent in merges:
2011
parent_trees.append(
2012
(parent, self.branch.repository.revision_tree(parent)))
2013
if old_tip is not None:
2014
parent_trees.append(
2015
(old_tip, self.branch.repository.revision_tree(old_tip)))
2016
self.set_parent_trees(parent_trees)
2017
last_rev = parent_trees[0][0]
2019
# the working tree had the same last-revision as the master
2020
# branch did. We may still have pivot local work from the local
2021
# branch into old_tip:
2022
if old_tip is not None:
2023
self.add_parent_tree_id(old_tip)
2024
if old_tip and old_tip != last_rev:
2025
# our last revision was not the prior branch last revision
2026
# and we have converted that last revision to a pending merge.
2027
# base is somewhere between the branch tip now
2028
# and the now pending merge
2030
# Since we just modified the working tree and inventory, flush out
2031
# the current state, before we modify it again.
2032
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2033
# requires it only because TreeTransform directly munges the
2034
# inventory and calls tree._write_inventory(). Ultimately we
2035
# should be able to remove this extra flush.
2037
from bzrlib.revision import common_ancestor
2039
base_rev_id = common_ancestor(self.branch.last_revision(),
2041
self.branch.repository)
2042
except errors.NoCommonAncestor:
2044
base_tree = self.branch.repository.revision_tree(base_rev_id)
2045
other_tree = self.branch.repository.revision_tree(old_tip)
2046
result += merge.merge_inner(
2053
def _write_hashcache_if_dirty(self):
2054
"""Write out the hashcache if it is dirty."""
2055
if self._hashcache.needs_write:
2057
self._hashcache.write()
2059
if e.errno not in (errno.EPERM, errno.EACCES):
2061
# TODO: jam 20061219 Should this be a warning? A single line
2062
# warning might be sufficient to let the user know what
2064
mutter('Could not write hashcache for %s\nError: %s',
2065
self._hashcache.cache_file_name(), e)
2067
@needs_tree_write_lock
2068
def _write_inventory(self, inv):
2069
"""Write inventory as the current inventory."""
2070
self._set_inventory(inv, dirty=True)
2073
def set_conflicts(self, arg):
2074
raise errors.UnsupportedOperation(self.set_conflicts, self)
2076
def add_conflicts(self, arg):
2077
raise errors.UnsupportedOperation(self.add_conflicts, self)
2080
def conflicts(self):
2081
conflicts = _mod_conflicts.ConflictList()
2082
for conflicted in self._iter_conflicts():
2085
if file_kind(self.abspath(conflicted)) != "file":
2087
except errors.NoSuchFile:
2090
for suffix in ('.THIS', '.OTHER'):
2092
kind = file_kind(self.abspath(conflicted+suffix))
2095
except errors.NoSuchFile:
2099
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2100
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2102
file_id=self.path2id(conflicted)))
2105
def walkdirs(self, prefix=""):
2106
"""Walk the directories of this tree.
2108
This API returns a generator, which is only valid during the current
2109
tree transaction - within a single lock_read or lock_write duration.
2111
If the tree is not locked, it may cause an error to be raised, depending
2112
on the tree implementation.
2114
disk_top = self.abspath(prefix)
2115
if disk_top.endswith('/'):
2116
disk_top = disk_top[:-1]
2117
top_strip_len = len(disk_top) + 1
2118
inventory_iterator = self._walkdirs(prefix)
2119
disk_iterator = osutils.walkdirs(disk_top, prefix)
2121
current_disk = disk_iterator.next()
2122
disk_finished = False
2124
if e.errno != errno.ENOENT:
2127
disk_finished = True
2129
current_inv = inventory_iterator.next()
2130
inv_finished = False
2131
except StopIteration:
2134
while not inv_finished or not disk_finished:
2135
if not disk_finished:
2136
# strip out .bzr dirs
2137
if current_disk[0][1][top_strip_len:] == '':
2138
# osutils.walkdirs can be made nicer -
2139
# yield the path-from-prefix rather than the pathjoined
2141
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2142
if current_disk[1][bzrdir_loc][0] == '.bzr':
2143
# we dont yield the contents of, or, .bzr itself.
2144
del current_disk[1][bzrdir_loc]
2146
# everything is unknown
2149
# everything is missing
2152
direction = cmp(current_inv[0][0], current_disk[0][0])
2154
# disk is before inventory - unknown
2155
dirblock = [(relpath, basename, kind, stat, None, None) for
2156
relpath, basename, kind, stat, top_path in current_disk[1]]
2157
yield (current_disk[0][0], None), dirblock
2159
current_disk = disk_iterator.next()
2160
except StopIteration:
2161
disk_finished = True
2163
# inventory is before disk - missing.
2164
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2165
for relpath, basename, dkind, stat, fileid, kind in
2167
yield (current_inv[0][0], current_inv[0][1]), dirblock
2169
current_inv = inventory_iterator.next()
2170
except StopIteration:
2173
# versioned present directory
2174
# merge the inventory and disk data together
2176
for relpath, subiterator in itertools.groupby(sorted(
2177
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2178
path_elements = list(subiterator)
2179
if len(path_elements) == 2:
2180
inv_row, disk_row = path_elements
2181
# versioned, present file
2182
dirblock.append((inv_row[0],
2183
inv_row[1], disk_row[2],
2184
disk_row[3], inv_row[4],
2186
elif len(path_elements[0]) == 5:
2188
dirblock.append((path_elements[0][0],
2189
path_elements[0][1], path_elements[0][2],
2190
path_elements[0][3], None, None))
2191
elif len(path_elements[0]) == 6:
2192
# versioned, absent file.
2193
dirblock.append((path_elements[0][0],
2194
path_elements[0][1], 'unknown', None,
2195
path_elements[0][4], path_elements[0][5]))
2197
raise NotImplementedError('unreachable code')
2198
yield current_inv[0], dirblock
2200
current_inv = inventory_iterator.next()
2201
except StopIteration:
2204
current_disk = disk_iterator.next()
2205
except StopIteration:
2206
disk_finished = True
2208
def _walkdirs(self, prefix=""):
2209
_directory = 'directory'
2210
# get the root in the inventory
2211
inv = self.inventory
2212
top_id = inv.path2id(prefix)
2216
pending = [(prefix, '', _directory, None, top_id, None)]
2219
currentdir = pending.pop()
2220
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2221
top_id = currentdir[4]
2223
relroot = currentdir[0] + '/'
2226
# FIXME: stash the node in pending
2228
for name, child in entry.sorted_children():
2229
dirblock.append((relroot + name, name, child.kind, None,
2230
child.file_id, child.kind
2232
yield (currentdir[0], entry.file_id), dirblock
2233
# push the user specified dirs from dirblock
2234
for dir in reversed(dirblock):
2235
if dir[2] == _directory:
2238
@needs_tree_write_lock
2239
def auto_resolve(self):
2240
"""Automatically resolve text conflicts according to contents.
2242
Only text conflicts are auto_resolvable. Files with no conflict markers
2243
are considered 'resolved', because bzr always puts conflict markers
2244
into files that have text conflicts. The corresponding .THIS .BASE and
2245
.OTHER files are deleted, as per 'resolve'.
2246
:return: a tuple of ConflictLists: (un_resolved, resolved).
2248
un_resolved = _mod_conflicts.ConflictList()
2249
resolved = _mod_conflicts.ConflictList()
2250
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2251
for conflict in self.conflicts():
2252
if (conflict.typestring != 'text conflict' or
2253
self.kind(conflict.file_id) != 'file'):
2254
un_resolved.append(conflict)
2256
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2258
for line in my_file:
2259
if conflict_re.search(line):
2260
un_resolved.append(conflict)
2263
resolved.append(conflict)
2266
resolved.remove_files(self)
2267
self.set_conflicts(un_resolved)
2268
return un_resolved, resolved
2271
class WorkingTree2(WorkingTree):
2272
"""This is the Format 2 working tree.
2274
This was the first weave based working tree.
2275
- uses os locks for locking.
2276
- uses the branch last-revision.
2279
def __init__(self, *args, **kwargs):
2280
super(WorkingTree2, self).__init__(*args, **kwargs)
2281
# WorkingTree2 has more of a constraint that self._inventory must
2282
# exist. Because this is an older format, we don't mind the overhead
2283
# caused by the extra computation here.
2285
# Newer WorkingTree's should only have self._inventory set when they
2287
if self._inventory is None:
2288
self.read_working_inventory()
2290
def lock_tree_write(self):
2291
"""See WorkingTree.lock_tree_write().
2293
In Format2 WorkingTrees we have a single lock for the branch and tree
2294
so lock_tree_write() degrades to lock_write().
2296
self.branch.lock_write()
2298
return self._control_files.lock_write()
2300
self.branch.unlock()
2304
# we share control files:
2305
if self._control_files._lock_count == 3:
2306
# _inventory_is_modified is always False during a read lock.
2307
if self._inventory_is_modified:
2309
self._write_hashcache_if_dirty()
2311
# reverse order of locking.
2313
return self._control_files.unlock()
2315
self.branch.unlock()
2318
class WorkingTree3(WorkingTree):
2319
"""This is the Format 3 working tree.
2321
This differs from the base WorkingTree by:
2322
- having its own file lock
2323
- having its own last-revision property.
2325
This is new in bzr 0.8
2329
def _last_revision(self):
2330
"""See Mutable.last_revision."""
2332
return osutils.safe_revision_id(
2333
self._control_files.get('last-revision').read())
2334
except errors.NoSuchFile:
2337
def _change_last_revision(self, revision_id):
2338
"""See WorkingTree._change_last_revision."""
2339
if revision_id is None or revision_id == NULL_REVISION:
2341
self._control_files._transport.delete('last-revision')
2342
except errors.NoSuchFile:
2346
self._control_files.put_bytes('last-revision', revision_id)
2349
@needs_tree_write_lock
2350
def set_conflicts(self, conflicts):
2351
self._put_rio('conflicts', conflicts.to_stanzas(),
2354
@needs_tree_write_lock
2355
def add_conflicts(self, new_conflicts):
2356
conflict_set = set(self.conflicts())
2357
conflict_set.update(set(list(new_conflicts)))
2358
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2359
key=_mod_conflicts.Conflict.sort_key)))
2362
def conflicts(self):
2364
confile = self._control_files.get('conflicts')
2365
except errors.NoSuchFile:
2366
return _mod_conflicts.ConflictList()
2368
if confile.next() != CONFLICT_HEADER_1 + '\n':
2369
raise errors.ConflictFormatError()
2370
except StopIteration:
2371
raise errors.ConflictFormatError()
2372
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2375
if self._control_files._lock_count == 1:
2376
# _inventory_is_modified is always False during a read lock.
2377
if self._inventory_is_modified:
2379
self._write_hashcache_if_dirty()
2380
# reverse order of locking.
2382
return self._control_files.unlock()
2384
self.branch.unlock()
2387
def get_conflicted_stem(path):
2388
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2389
if path.endswith(suffix):
2390
return path[:-len(suffix)]
2393
@deprecated_function(zero_eight)
2394
def is_control_file(filename):
2395
"""See WorkingTree.is_control_filename(filename)."""
2396
## FIXME: better check
2397
filename = normpath(filename)
2398
while filename != '':
2399
head, tail = os.path.split(filename)
2400
## mutter('check %r for control file' % ((head, tail),))
2403
if filename == head:
2409
class WorkingTreeFormat(object):
2410
"""An encapsulation of the initialization and open routines for a format.
2412
Formats provide three things:
2413
* An initialization routine,
2417
Formats are placed in an dict by their format string for reference
2418
during workingtree opening. Its not required that these be instances, they
2419
can be classes themselves with class methods - it simply depends on
2420
whether state is needed for a given format or not.
2422
Once a format is deprecated, just deprecate the initialize and open
2423
methods on the format class. Do not deprecate the object, as the
2424
object will be created every time regardless.
2427
_default_format = None
2428
"""The default format used for new trees."""
2431
"""The known formats."""
2433
requires_rich_root = False
2436
def find_format(klass, a_bzrdir):
2437
"""Return the format for the working tree object in a_bzrdir."""
2439
transport = a_bzrdir.get_workingtree_transport(None)
2440
format_string = transport.get("format").read()
2441
return klass._formats[format_string]
2442
except errors.NoSuchFile:
2443
raise errors.NoWorkingTree(base=transport.base)
2445
raise errors.UnknownFormatError(format=format_string)
2447
def __eq__(self, other):
2448
return self.__class__ is other.__class__
2450
def __ne__(self, other):
2451
return not (self == other)
2454
def get_default_format(klass):
2455
"""Return the current default format."""
2456
return klass._default_format
2458
def get_format_string(self):
2459
"""Return the ASCII format string that identifies this format."""
2460
raise NotImplementedError(self.get_format_string)
2462
def get_format_description(self):
2463
"""Return the short description for this format."""
2464
raise NotImplementedError(self.get_format_description)
2466
def is_supported(self):
2467
"""Is this format supported?
2469
Supported formats can be initialized and opened.
2470
Unsupported formats may not support initialization or committing or
2471
some other features depending on the reason for not being supported.
2476
def register_format(klass, format):
2477
klass._formats[format.get_format_string()] = format
2480
def set_default_format(klass, format):
2481
klass._default_format = format
2484
def unregister_format(klass, format):
2485
assert klass._formats[format.get_format_string()] is format
2486
del klass._formats[format.get_format_string()]
2490
class WorkingTreeFormat2(WorkingTreeFormat):
2491
"""The second working tree format.
2493
This format modified the hash cache from the format 1 hash cache.
2496
def get_format_description(self):
2497
"""See WorkingTreeFormat.get_format_description()."""
2498
return "Working tree format 2"
2500
def stub_initialize_remote(self, control_files):
2501
"""As a special workaround create critical control files for a remote working tree
2503
This ensures that it can later be updated and dealt with locally,
2504
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2505
no working tree. (See bug #43064).
2509
xml5.serializer_v5.write_inventory(inv, sio)
2511
control_files.put('inventory', sio)
2513
control_files.put_bytes('pending-merges', '')
2516
def initialize(self, a_bzrdir, revision_id=None):
2517
"""See WorkingTreeFormat.initialize()."""
2518
if not isinstance(a_bzrdir.transport, LocalTransport):
2519
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2520
branch = a_bzrdir.open_branch()
2521
if revision_id is not None:
2522
revision_id = osutils.safe_revision_id(revision_id)
2525
revision_history = branch.revision_history()
2527
position = revision_history.index(revision_id)
2529
raise errors.NoSuchRevision(branch, revision_id)
2530
branch.set_revision_history(revision_history[:position + 1])
2533
revision = branch.last_revision()
2535
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2541
basis_tree = branch.repository.revision_tree(revision)
2542
if basis_tree.inventory.root is not None:
2543
wt.set_root_id(basis_tree.inventory.root.file_id)
2544
# set the parent list and cache the basis tree.
2545
wt.set_parent_trees([(revision, basis_tree)])
2546
transform.build_tree(basis_tree, wt)
2550
super(WorkingTreeFormat2, self).__init__()
2551
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2553
def open(self, a_bzrdir, _found=False):
2554
"""Return the WorkingTree object for a_bzrdir
2556
_found is a private parameter, do not use it. It is used to indicate
2557
if format probing has already been done.
2560
# we are being called directly and must probe.
2561
raise NotImplementedError
2562
if not isinstance(a_bzrdir.transport, LocalTransport):
2563
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2564
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2570
class WorkingTreeFormat3(WorkingTreeFormat):
2571
"""The second working tree format updated to record a format marker.
2574
- exists within a metadir controlling .bzr
2575
- includes an explicit version marker for the workingtree control
2576
files, separate from the BzrDir format
2577
- modifies the hash cache format
2579
- uses a LockDir to guard access for writes.
2582
def get_format_string(self):
2583
"""See WorkingTreeFormat.get_format_string()."""
2584
return "Bazaar-NG Working Tree format 3"
2586
def get_format_description(self):
2587
"""See WorkingTreeFormat.get_format_description()."""
2588
return "Working tree format 3"
2590
_lock_file_name = 'lock'
2591
_lock_class = LockDir
2593
_tree_class = WorkingTree3
2595
def __get_matchingbzrdir(self):
2596
return bzrdir.BzrDirMetaFormat1()
2598
_matchingbzrdir = property(__get_matchingbzrdir)
2600
def _open_control_files(self, a_bzrdir):
2601
transport = a_bzrdir.get_workingtree_transport(None)
2602
return LockableFiles(transport, self._lock_file_name,
2605
def initialize(self, a_bzrdir, revision_id=None):
2606
"""See WorkingTreeFormat.initialize().
2608
revision_id allows creating a working tree at a different
2609
revision than the branch is at.
2611
if not isinstance(a_bzrdir.transport, LocalTransport):
2612
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2613
transport = a_bzrdir.get_workingtree_transport(self)
2614
control_files = self._open_control_files(a_bzrdir)
2615
control_files.create_lock()
2616
control_files.lock_write()
2617
control_files.put_utf8('format', self.get_format_string())
2618
branch = a_bzrdir.open_branch()
2619
if revision_id is None:
2620
revision_id = branch.last_revision()
2622
revision_id = osutils.safe_revision_id(revision_id)
2623
# WorkingTree3 can handle an inventory which has a unique root id.
2624
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2625
# those trees. And because there isn't a format bump inbetween, we
2626
# are maintaining compatibility with older clients.
2627
# inv = Inventory(root_id=gen_root_id())
2628
inv = self._initial_inventory()
2629
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2635
_control_files=control_files)
2636
wt.lock_tree_write()
2638
basis_tree = branch.repository.revision_tree(revision_id)
2639
# only set an explicit root id if there is one to set.
2640
if basis_tree.inventory.root is not None:
2641
wt.set_root_id(basis_tree.inventory.root.file_id)
2642
if revision_id == NULL_REVISION:
2643
wt.set_parent_trees([])
2645
wt.set_parent_trees([(revision_id, basis_tree)])
2646
transform.build_tree(basis_tree, wt)
2648
# Unlock in this order so that the unlock-triggers-flush in
2649
# WorkingTree is given a chance to fire.
2650
control_files.unlock()
2654
def _initial_inventory(self):
2658
super(WorkingTreeFormat3, self).__init__()
2660
def open(self, a_bzrdir, _found=False):
2661
"""Return the WorkingTree object for a_bzrdir
2663
_found is a private parameter, do not use it. It is used to indicate
2664
if format probing has already been done.
2667
# we are being called directly and must probe.
2668
raise NotImplementedError
2669
if not isinstance(a_bzrdir.transport, LocalTransport):
2670
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2671
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2673
def _open(self, a_bzrdir, control_files):
2674
"""Open the tree itself.
2676
:param a_bzrdir: the dir for the tree.
2677
:param control_files: the control files for the tree.
2679
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2683
_control_files=control_files)
2686
return self.get_format_string()
2689
__default_format = WorkingTreeFormat4()
2690
WorkingTreeFormat.register_format(__default_format)
2691
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2692
WorkingTreeFormat.set_default_format(__default_format)
2693
# formats which have no format string are not discoverable
2694
# and not independently creatable, so are not registered.
2695
_legacy_formats = [WorkingTreeFormat2(),
2699
class WorkingTreeTestProviderAdapter(object):
2700
"""A tool to generate a suite testing multiple workingtree formats at once.
2702
This is done by copying the test once for each transport and injecting
2703
the transport_server, transport_readonly_server, and workingtree_format
2704
classes into each copy. Each copy is also given a new id() to make it
2708
def __init__(self, transport_server, transport_readonly_server, formats):
2709
self._transport_server = transport_server
2710
self._transport_readonly_server = transport_readonly_server
2711
self._formats = formats
2713
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2714
"""Clone test for adaption."""
2715
new_test = deepcopy(test)
2716
new_test.transport_server = self._transport_server
2717
new_test.transport_readonly_server = self._transport_readonly_server
2718
new_test.bzrdir_format = bzrdir_format
2719
new_test.workingtree_format = workingtree_format
2720
def make_new_test_id():
2721
new_id = "%s(%s)" % (test.id(), variation)
2722
return lambda: new_id
2723
new_test.id = make_new_test_id()
2726
def adapt(self, test):
2727
from bzrlib.tests import TestSuite
2728
result = TestSuite()
2729
for workingtree_format, bzrdir_format in self._formats:
2730
new_test = self._clone_test(
2733
workingtree_format, workingtree_format.__class__.__name__)
2734
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
