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 for basedir.
213
If the branch is not supplied, it is opened automatically.
214
If the branch is supplied, it must be the branch for this basedir.
215
(branch.base is not cross checked, because for remote branches that
216
would be meaningless).
218
self._format = _format
219
self.bzrdir = _bzrdir
221
# not created via open etc.
222
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
223
"Please use bzrdir.open_workingtree or WorkingTree.open().",
226
wt = WorkingTree.open(basedir)
227
self._branch = wt.branch
228
self.basedir = wt.basedir
229
self._control_files = wt._control_files
230
self._hashcache = wt._hashcache
231
self._set_inventory(wt._inventory, dirty=False)
232
self._format = wt._format
233
self.bzrdir = wt.bzrdir
234
assert isinstance(basedir, basestring), \
235
"base directory %r is not a string" % basedir
236
basedir = safe_unicode(basedir)
237
mutter("opening working tree %r", basedir)
238
if deprecated_passed(branch):
240
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
241
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
242
" WorkingTree.open().",
246
self._branch = branch
248
self._branch = self.bzrdir.open_branch()
249
self.basedir = realpath(basedir)
250
# if branch is at our basedir and is a format 6 or less
251
if isinstance(self._format, WorkingTreeFormat2):
252
# share control object
253
self._control_files = self.branch.control_files
255
# assume all other formats have their own control files.
256
assert isinstance(_control_files, LockableFiles), \
257
"_control_files must be a LockableFiles, not %r" \
259
self._control_files = _control_files
260
# update the whole cache up front and write to disk if anything changed;
261
# in the future we might want to do this more selectively
262
# two possible ways offer themselves : in self._unlock, write the cache
263
# if needed, or, when the cache sees a change, append it to the hash
264
# cache file, and have the parser take the most recent entry for a
266
wt_trans = self.bzrdir.get_workingtree_transport(None)
267
cache_filename = wt_trans.local_abspath('stat-cache')
268
self._hashcache = hashcache.HashCache(basedir, cache_filename,
269
self._control_files._file_mode)
272
# is this scan needed ? it makes things kinda slow.
279
if _inventory is None:
280
self._inventory_is_modified = False
281
self.read_working_inventory()
283
# the caller of __init__ has provided an inventory,
284
# we assume they know what they are doing - as its only
285
# the Format factory and creation methods that are
286
# permitted to do this.
287
self._set_inventory(_inventory, dirty=False)
290
fget=lambda self: self._branch,
291
doc="""The branch this WorkingTree is connected to.
293
This cannot be set - it is reflective of the actual disk structure
294
the working tree has been constructed from.
297
def break_lock(self):
298
"""Break a lock if one is present from another instance.
300
Uses the ui factory to ask for confirmation if the lock may be from
303
This will probe the repository for its lock as well.
305
self._control_files.break_lock()
306
self.branch.break_lock()
308
def requires_rich_root(self):
309
return self._format.requires_rich_root
311
def supports_tree_reference(self):
314
def _set_inventory(self, inv, dirty):
315
"""Set the internal cached inventory.
317
:param inv: The inventory to set.
318
:param dirty: A boolean indicating whether the inventory is the same
319
logical inventory as whats on disk. If True the inventory is not
320
the same and should be written to disk or data will be lost, if
321
False then the inventory is the same as that on disk and any
322
serialisation would be unneeded overhead.
324
assert inv.root is not None
325
self._inventory = inv
326
self._inventory_is_modified = dirty
329
def open(path=None, _unsupported=False):
330
"""Open an existing working tree at path.
334
path = os.path.getcwdu()
335
control = bzrdir.BzrDir.open(path, _unsupported)
336
return control.open_workingtree(_unsupported)
339
def open_containing(path=None):
340
"""Open an existing working tree which has its root about path.
342
This probes for a working tree at path and searches upwards from there.
344
Basically we keep looking up until we find the control directory or
345
run into /. If there isn't one, raises NotBranchError.
346
TODO: give this a new exception.
347
If there is one, it is returned, along with the unused portion of path.
349
:return: The WorkingTree that contains 'path', and the rest of path
352
path = osutils.getcwd()
353
control, relpath = bzrdir.BzrDir.open_containing(path)
355
return control.open_workingtree(), relpath
358
def open_downlevel(path=None):
359
"""Open an unsupported working tree.
361
Only intended for advanced situations like upgrading part of a bzrdir.
363
return WorkingTree.open(path, _unsupported=True)
365
# should be deprecated - this is slow and in any case treating them as a
366
# container is (we now know) bad style -- mbp 20070302
367
## @deprecated_method(zero_fifteen)
369
"""Iterate through file_ids for this tree.
371
file_ids are in a WorkingTree if they are in the working inventory
372
and the working file exists.
374
inv = self._inventory
375
for path, ie in inv.iter_entries():
376
if osutils.lexists(self.abspath(path)):
380
return "<%s of %s>" % (self.__class__.__name__,
381
getattr(self, 'basedir', None))
383
def abspath(self, filename):
384
return pathjoin(self.basedir, filename)
386
def basis_tree(self):
387
"""Return RevisionTree for the current last revision.
389
If the left most parent is a ghost then the returned tree will be an
390
empty tree - one obtained by calling repository.revision_tree(None).
393
revision_id = self.get_parent_ids()[0]
395
# no parents, return an empty revision tree.
396
# in the future this should return the tree for
397
# 'empty:' - the implicit root empty tree.
398
return self.branch.repository.revision_tree(None)
400
return self.revision_tree(revision_id)
401
except errors.NoSuchRevision:
403
# No cached copy available, retrieve from the repository.
404
# FIXME? RBC 20060403 should we cache the inventory locally
407
return self.branch.repository.revision_tree(revision_id)
408
except errors.RevisionNotPresent:
409
# the basis tree *may* be a ghost or a low level error may have
410
# occured. If the revision is present, its a problem, if its not
412
if self.branch.repository.has_revision(revision_id):
414
# the basis tree is a ghost so return an empty tree.
415
return self.branch.repository.revision_tree(None)
418
@deprecated_method(zero_eight)
419
def create(branch, directory):
420
"""Create a workingtree for branch at directory.
422
If existing_directory already exists it must have a .bzr directory.
423
If it does not exist, it will be created.
425
This returns a new WorkingTree object for the new checkout.
427
TODO FIXME RBC 20060124 when we have checkout formats in place this
428
should accept an optional revisionid to checkout [and reject this if
429
checking out into the same dir as a pre-checkout-aware branch format.]
431
XXX: When BzrDir is present, these should be created through that
434
warnings.warn('delete WorkingTree.create', stacklevel=3)
435
transport = get_transport(directory)
436
if branch.bzrdir.root_transport.base == transport.base:
438
return branch.bzrdir.create_workingtree()
439
# different directory,
440
# create a branch reference
441
# and now a working tree.
442
raise NotImplementedError
445
@deprecated_method(zero_eight)
446
def create_standalone(directory):
447
"""Create a checkout and a branch and a repo at directory.
449
Directory must exist and be empty.
451
please use BzrDir.create_standalone_workingtree
453
return bzrdir.BzrDir.create_standalone_workingtree(directory)
455
def relpath(self, path):
456
"""Return the local path portion from a given path.
458
The path may be absolute or relative. If its a relative path it is
459
interpreted relative to the python current working directory.
461
return osutils.relpath(self.basedir, path)
463
def has_filename(self, filename):
464
return osutils.lexists(self.abspath(filename))
466
def get_file(self, file_id):
467
file_id = osutils.safe_file_id(file_id)
468
return self.get_file_byname(self.id2path(file_id))
470
def get_file_text(self, file_id):
471
file_id = osutils.safe_file_id(file_id)
472
return self.get_file(file_id).read()
474
def get_file_byname(self, filename):
475
return file(self.abspath(filename), 'rb')
478
def annotate_iter(self, file_id):
479
"""See Tree.annotate_iter
481
This implementation will use the basis tree implementation if possible.
482
Lines not in the basis are attributed to CURRENT_REVISION
484
If there are pending merges, lines added by those merges will be
485
incorrectly attributed to CURRENT_REVISION (but after committing, the
486
attribution will be correct).
488
file_id = osutils.safe_file_id(file_id)
489
basis = self.basis_tree()
490
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
491
require_versioned=True).next()
492
changed_content, kind = changes[2], changes[6]
493
if not changed_content:
494
return basis.annotate_iter(file_id)
498
if kind[0] != 'file':
501
old_lines = list(basis.annotate_iter(file_id))
503
for tree in self.branch.repository.revision_trees(
504
self.get_parent_ids()[1:]):
505
if file_id not in tree:
507
old.append(list(tree.annotate_iter(file_id)))
508
return annotate.reannotate(old, self.get_file(file_id).readlines(),
511
def get_parent_ids(self):
512
"""See Tree.get_parent_ids.
514
This implementation reads the pending merges list and last_revision
515
value and uses that to decide what the parents list should be.
517
last_rev = self._last_revision()
523
merges_file = self._control_files.get('pending-merges')
524
except errors.NoSuchFile:
527
for l in merges_file.readlines():
528
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
529
parents.append(revision_id)
533
def get_root_id(self):
534
"""Return the id of this trees root"""
535
return self._inventory.root.file_id
537
def _get_store_filename(self, file_id):
538
## XXX: badly named; this is not in the store at all
539
file_id = osutils.safe_file_id(file_id)
540
return self.abspath(self.id2path(file_id))
543
def clone(self, to_bzrdir, revision_id=None, basis=None):
544
"""Duplicate this working tree into to_bzr, including all state.
546
Specifically modified files are kept as modified, but
547
ignored and unknown files are discarded.
549
If you want to make a new line of development, see bzrdir.sprout()
552
If not None, the cloned tree will have its last revision set to
553
revision, and and difference between the source trees last revision
554
and this one merged in.
557
If not None, a closer copy of a tree which may have some files in
558
common, and which file content should be preferentially copied from.
560
# assumes the target bzr dir format is compatible.
561
result = self._format.initialize(to_bzrdir)
562
self.copy_content_into(result, revision_id)
566
def copy_content_into(self, tree, revision_id=None):
567
"""Copy the current content and user files of this tree into tree."""
568
tree.set_root_id(self.get_root_id())
569
if revision_id is None:
570
merge.transform_tree(tree, self)
572
# TODO now merge from tree.last_revision to revision (to preserve
573
# user local changes)
574
merge.transform_tree(tree, self)
575
tree.set_parent_ids([revision_id])
577
def id2abspath(self, file_id):
578
file_id = osutils.safe_file_id(file_id)
579
return self.abspath(self.id2path(file_id))
581
def has_id(self, file_id):
582
# files that have been deleted are excluded
583
file_id = osutils.safe_file_id(file_id)
585
if not inv.has_id(file_id):
587
path = inv.id2path(file_id)
588
return osutils.lexists(self.abspath(path))
590
def has_or_had_id(self, file_id):
591
file_id = osutils.safe_file_id(file_id)
592
if file_id == self.inventory.root.file_id:
594
return self.inventory.has_id(file_id)
596
__contains__ = has_id
598
def get_file_size(self, file_id):
599
file_id = osutils.safe_file_id(file_id)
600
return os.path.getsize(self.id2abspath(file_id))
603
def get_file_sha1(self, file_id, path=None, stat_value=None):
604
file_id = osutils.safe_file_id(file_id)
606
path = self._inventory.id2path(file_id)
607
return self._hashcache.get_sha1(path, stat_value)
609
def get_file_mtime(self, file_id, path=None):
610
file_id = osutils.safe_file_id(file_id)
612
path = self.inventory.id2path(file_id)
613
return os.lstat(self.abspath(path)).st_mtime
615
if not supports_executable():
616
def is_executable(self, file_id, path=None):
617
file_id = osutils.safe_file_id(file_id)
618
return self._inventory[file_id].executable
620
def is_executable(self, file_id, path=None):
622
file_id = osutils.safe_file_id(file_id)
623
path = self.id2path(file_id)
624
mode = os.lstat(self.abspath(path)).st_mode
625
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
627
@needs_tree_write_lock
628
def _add(self, files, ids, kinds):
629
"""See MutableTree._add."""
630
# TODO: Re-adding a file that is removed in the working copy
631
# should probably put it back with the previous ID.
632
# the read and write working inventory should not occur in this
633
# function - they should be part of lock_write and unlock.
634
inv = self.read_working_inventory()
635
for f, file_id, kind in zip(files, ids, kinds):
636
assert kind is not None
638
inv.add_path(f, kind=kind)
640
file_id = osutils.safe_file_id(file_id)
641
inv.add_path(f, kind=kind, file_id=file_id)
642
self._write_inventory(inv)
644
@needs_tree_write_lock
645
def _gather_kinds(self, files, kinds):
646
"""See MutableTree._gather_kinds."""
647
for pos, f in enumerate(files):
648
if kinds[pos] is None:
649
fullpath = normpath(self.abspath(f))
651
kinds[pos] = file_kind(fullpath)
653
if e.errno == errno.ENOENT:
654
raise errors.NoSuchFile(fullpath)
657
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
658
"""Add revision_id as a parent.
660
This is equivalent to retrieving the current list of parent ids
661
and setting the list to its value plus revision_id.
663
:param revision_id: The revision id to add to the parent list. It may
664
be a ghost revision as long as its not the first parent to be added,
665
or the allow_leftmost_as_ghost parameter is set True.
666
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
668
parents = self.get_parent_ids() + [revision_id]
669
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
670
or allow_leftmost_as_ghost)
672
@needs_tree_write_lock
673
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
674
"""Add revision_id, tree tuple as a parent.
676
This is equivalent to retrieving the current list of parent trees
677
and setting the list to its value plus parent_tuple. See also
678
add_parent_tree_id - if you only have a parent id available it will be
679
simpler to use that api. If you have the parent already available, using
680
this api is preferred.
682
:param parent_tuple: The (revision id, tree) to add to the parent list.
683
If the revision_id is a ghost, pass None for the tree.
684
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
686
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
687
if len(parent_ids) > 1:
688
# the leftmost may have already been a ghost, preserve that if it
690
allow_leftmost_as_ghost = True
691
self.set_parent_ids(parent_ids,
692
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
694
@needs_tree_write_lock
695
def add_pending_merge(self, *revision_ids):
696
# TODO: Perhaps should check at this point that the
697
# history of the revision is actually present?
698
parents = self.get_parent_ids()
700
for rev_id in revision_ids:
701
if rev_id in parents:
703
parents.append(rev_id)
706
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
708
@deprecated_method(zero_eleven)
710
def pending_merges(self):
711
"""Return a list of pending merges.
713
These are revisions that have been merged into the working
714
directory but not yet committed.
716
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
717
instead - which is available on all tree objects.
719
return self.get_parent_ids()[1:]
721
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
722
"""Common ghost checking functionality from set_parent_*.
724
This checks that the left hand-parent exists if there are any
727
if len(revision_ids) > 0:
728
leftmost_id = revision_ids[0]
729
if (not allow_leftmost_as_ghost and not
730
self.branch.repository.has_revision(leftmost_id)):
731
raise errors.GhostRevisionUnusableHere(leftmost_id)
733
def _set_merges_from_parent_ids(self, parent_ids):
734
merges = parent_ids[1:]
735
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
737
@needs_tree_write_lock
738
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
739
"""Set the parent ids to revision_ids.
741
See also set_parent_trees. This api will try to retrieve the tree data
742
for each element of revision_ids from the trees repository. If you have
743
tree data already available, it is more efficient to use
744
set_parent_trees rather than set_parent_ids. set_parent_ids is however
745
an easier API to use.
747
:param revision_ids: The revision_ids to set as the parent ids of this
748
working tree. Any of these may be ghosts.
750
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
751
self._check_parents_for_ghosts(revision_ids,
752
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
754
if len(revision_ids) > 0:
755
self.set_last_revision(revision_ids[0])
757
self.set_last_revision(None)
759
self._set_merges_from_parent_ids(revision_ids)
761
@needs_tree_write_lock
762
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
763
"""See MutableTree.set_parent_trees."""
764
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
766
self._check_parents_for_ghosts(parent_ids,
767
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
769
if len(parent_ids) == 0:
770
leftmost_parent_id = None
771
leftmost_parent_tree = None
773
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
775
if self._change_last_revision(leftmost_parent_id):
776
if leftmost_parent_tree is None:
777
# If we don't have a tree, fall back to reading the
778
# parent tree from the repository.
779
self._cache_basis_inventory(leftmost_parent_id)
781
inv = leftmost_parent_tree.inventory
782
xml = self._create_basis_xml_from_inventory(
783
leftmost_parent_id, inv)
784
self._write_basis_inventory(xml)
785
self._set_merges_from_parent_ids(parent_ids)
787
@needs_tree_write_lock
788
def set_pending_merges(self, rev_list):
789
parents = self.get_parent_ids()
790
leftmost = parents[:1]
791
new_parents = leftmost + rev_list
792
self.set_parent_ids(new_parents)
794
@needs_tree_write_lock
795
def set_merge_modified(self, modified_hashes):
797
for file_id, hash in modified_hashes.iteritems():
798
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
799
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
801
def _put_rio(self, filename, stanzas, header):
802
self._must_be_locked()
803
my_file = rio_file(stanzas, header)
804
self._control_files.put(filename, my_file)
806
@needs_write_lock # because merge pulls data into the branch.
807
def merge_from_branch(self, branch, to_revision=None):
808
"""Merge from a branch into this working tree.
810
:param branch: The branch to merge from.
811
:param to_revision: If non-None, the merge will merge to to_revision,
812
but not beyond it. to_revision does not need to be in the history
813
of the branch when it is supplied. If None, to_revision defaults to
814
branch.last_revision().
816
from bzrlib.merge import Merger, Merge3Merger
817
pb = bzrlib.ui.ui_factory.nested_progress_bar()
819
merger = Merger(self.branch, this_tree=self, pb=pb)
820
merger.pp = ProgressPhase("Merge phase", 5, pb)
821
merger.pp.next_phase()
822
# check that there are no
824
merger.check_basis(check_clean=True, require_commits=False)
825
if to_revision is None:
826
to_revision = branch.last_revision()
828
to_revision = osutils.safe_revision_id(to_revision)
829
merger.other_rev_id = to_revision
830
if merger.other_rev_id is None:
831
raise error.NoCommits(branch)
832
self.branch.fetch(branch, last_revision=merger.other_rev_id)
833
merger.other_basis = merger.other_rev_id
834
merger.other_tree = self.branch.repository.revision_tree(
836
merger.other_branch = branch
837
merger.pp.next_phase()
839
if merger.base_rev_id == merger.other_rev_id:
840
raise errors.PointlessMerge
841
merger.backup_files = False
842
merger.merge_type = Merge3Merger
843
merger.set_interesting_files(None)
844
merger.show_base = False
845
merger.reprocess = False
846
conflicts = merger.do_merge()
853
def merge_modified(self):
854
"""Return a dictionary of files modified by a merge.
856
The list is initialized by WorkingTree.set_merge_modified, which is
857
typically called after we make some automatic updates to the tree
860
This returns a map of file_id->sha1, containing only files which are
861
still in the working inventory and have that text hash.
864
hashfile = self._control_files.get('merge-hashes')
865
except errors.NoSuchFile:
869
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
870
raise errors.MergeModifiedFormatError()
871
except StopIteration:
872
raise errors.MergeModifiedFormatError()
873
for s in RioReader(hashfile):
874
# RioReader reads in Unicode, so convert file_ids back to utf8
875
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
876
if file_id not in self.inventory:
878
text_hash = s.get("hash")
879
if text_hash == self.get_file_sha1(file_id):
880
merge_hashes[file_id] = text_hash
884
def mkdir(self, path, file_id=None):
885
"""See MutableTree.mkdir()."""
887
file_id = generate_ids.gen_file_id(os.path.basename(path))
888
os.mkdir(self.abspath(path))
889
self.add(path, file_id, 'directory')
892
def get_symlink_target(self, file_id):
893
file_id = osutils.safe_file_id(file_id)
894
return os.readlink(self.id2abspath(file_id))
897
def subsume(self, other_tree):
898
def add_children(inventory, entry):
899
for child_entry in entry.children.values():
900
inventory._byid[child_entry.file_id] = child_entry
901
if child_entry.kind == 'directory':
902
add_children(inventory, child_entry)
903
if other_tree.get_root_id() == self.get_root_id():
904
raise errors.BadSubsumeSource(self, other_tree,
905
'Trees have the same root')
907
other_tree_path = self.relpath(other_tree.basedir)
908
except errors.PathNotChild:
909
raise errors.BadSubsumeSource(self, other_tree,
910
'Tree is not contained by the other')
911
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
912
if new_root_parent is None:
913
raise errors.BadSubsumeSource(self, other_tree,
914
'Parent directory is not versioned.')
915
# We need to ensure that the result of a fetch will have a
916
# versionedfile for the other_tree root, and only fetching into
917
# RepositoryKnit2 guarantees that.
918
if not self.branch.repository.supports_rich_root():
919
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
920
other_tree.lock_tree_write()
922
new_parents = other_tree.get_parent_ids()
923
other_root = other_tree.inventory.root
924
other_root.parent_id = new_root_parent
925
other_root.name = osutils.basename(other_tree_path)
926
self.inventory.add(other_root)
927
add_children(self.inventory, other_root)
928
self._write_inventory(self.inventory)
929
# normally we don't want to fetch whole repositories, but i think
930
# here we really do want to consolidate the whole thing.
931
for parent_id in other_tree.get_parent_ids():
932
self.branch.fetch(other_tree.branch, parent_id)
933
self.add_parent_tree_id(parent_id)
936
other_tree.bzrdir.retire_bzrdir()
938
@needs_tree_write_lock
939
def extract(self, file_id, format=None):
940
"""Extract a subtree from this tree.
942
A new branch will be created, relative to the path for this tree.
945
segments = osutils.splitpath(path)
946
transport = self.branch.bzrdir.root_transport
947
for name in segments:
948
transport = transport.clone(name)
951
except errors.FileExists:
955
sub_path = self.id2path(file_id)
956
branch_transport = mkdirs(sub_path)
958
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
960
branch_transport.mkdir('.')
961
except errors.FileExists:
963
branch_bzrdir = format.initialize_on_transport(branch_transport)
965
repo = branch_bzrdir.find_repository()
966
except errors.NoRepositoryPresent:
967
repo = branch_bzrdir.create_repository()
968
assert repo.supports_rich_root()
970
if not repo.supports_rich_root():
971
raise errors.RootNotRich()
972
new_branch = branch_bzrdir.create_branch()
973
new_branch.pull(self.branch)
974
for parent_id in self.get_parent_ids():
975
new_branch.fetch(self.branch, parent_id)
976
tree_transport = self.bzrdir.root_transport.clone(sub_path)
977
if tree_transport.base != branch_transport.base:
978
tree_bzrdir = format.initialize_on_transport(tree_transport)
979
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
981
tree_bzrdir = branch_bzrdir
982
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
983
wt.set_parent_ids(self.get_parent_ids())
984
my_inv = self.inventory
985
child_inv = Inventory(root_id=None)
986
new_root = my_inv[file_id]
987
my_inv.remove_recursive_id(file_id)
988
new_root.parent_id = None
989
child_inv.add(new_root)
990
self._write_inventory(my_inv)
991
wt._write_inventory(child_inv)
994
def _serialize(self, inventory, out_file):
995
xml5.serializer_v5.write_inventory(self._inventory, out_file)
997
def _deserialize(selt, in_file):
998
return xml5.serializer_v5.read_inventory(in_file)
1001
"""Write the in memory inventory to disk."""
1002
# TODO: Maybe this should only write on dirty ?
1003
if self._control_files._lock_mode != 'w':
1004
raise errors.NotWriteLocked(self)
1006
self._serialize(self._inventory, sio)
1008
self._control_files.put('inventory', sio)
1009
self._inventory_is_modified = False
1011
def list_files(self, include_root=False):
1012
"""Recursively list all files as (path, class, kind, id, entry).
1014
Lists, but does not descend into unversioned directories.
1016
This does not include files that have been deleted in this
1019
Skips the control directory.
1021
# list_files is an iterator, so @needs_read_lock doesn't work properly
1022
# with it. So callers should be careful to always read_lock the tree.
1023
if not self.is_locked():
1024
raise errors.ObjectNotLocked(self)
1026
inv = self.inventory
1027
if include_root is True:
1028
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1029
# Convert these into local objects to save lookup times
1030
pathjoin = osutils.pathjoin
1031
file_kind = osutils.file_kind
1033
# transport.base ends in a slash, we want the piece
1034
# between the last two slashes
1035
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1037
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1039
# directory file_id, relative path, absolute path, reverse sorted children
1040
children = os.listdir(self.basedir)
1042
# jam 20060527 The kernel sized tree seems equivalent whether we
1043
# use a deque and popleft to keep them sorted, or if we use a plain
1044
# list and just reverse() them.
1045
children = collections.deque(children)
1046
stack = [(inv.root.file_id, u'', self.basedir, children)]
1048
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1051
f = children.popleft()
1052
## TODO: If we find a subdirectory with its own .bzr
1053
## directory, then that is a separate tree and we
1054
## should exclude it.
1056
# the bzrdir for this tree
1057
if transport_base_dir == f:
1060
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1061
# and 'f' doesn't begin with one, we can do a string op, rather
1062
# than the checks of pathjoin(), all relative paths will have an extra slash
1064
fp = from_dir_relpath + '/' + f
1067
fap = from_dir_abspath + '/' + f
1069
f_ie = inv.get_child(from_dir_id, f)
1072
elif self.is_ignored(fp[1:]):
1075
# we may not have found this file, because of a unicode issue
1076
f_norm, can_access = osutils.normalized_filename(f)
1077
if f == f_norm or not can_access:
1078
# No change, so treat this file normally
1081
# this file can be accessed by a normalized path
1082
# check again if it is versioned
1083
# these lines are repeated here for performance
1085
fp = from_dir_relpath + '/' + f
1086
fap = from_dir_abspath + '/' + f
1087
f_ie = inv.get_child(from_dir_id, f)
1090
elif self.is_ignored(fp[1:]):
1099
raise errors.BzrCheckError(
1100
"file %r entered as kind %r id %r, now of kind %r"
1101
% (fap, f_ie.kind, f_ie.file_id, fk))
1103
# make a last minute entry
1105
yield fp[1:], c, fk, f_ie.file_id, f_ie
1108
yield fp[1:], c, fk, None, fk_entries[fk]()
1110
yield fp[1:], c, fk, None, TreeEntry()
1113
if fk != 'directory':
1116
# But do this child first
1117
new_children = os.listdir(fap)
1119
new_children = collections.deque(new_children)
1120
stack.append((f_ie.file_id, fp, fap, new_children))
1121
# Break out of inner loop,
1122
# so that we start outer loop with child
1125
# if we finished all children, pop it off the stack
1128
@needs_tree_write_lock
1129
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1132
to_dir must exist in the inventory.
1134
If to_dir exists and is a directory, the files are moved into
1135
it, keeping their old names.
1137
Note that to_dir is only the last component of the new name;
1138
this doesn't change the directory.
1140
For each entry in from_paths the move mode will be determined
1143
The first mode moves the file in the filesystem and updates the
1144
inventory. The second mode only updates the inventory without
1145
touching the file on the filesystem. This is the new mode introduced
1148
move uses the second mode if 'after == True' and the target is not
1149
versioned but present in the working tree.
1151
move uses the second mode if 'after == False' and the source is
1152
versioned but no longer in the working tree, and the target is not
1153
versioned but present in the working tree.
1155
move uses the first mode if 'after == False' and the source is
1156
versioned and present in the working tree, and the target is not
1157
versioned and not present in the working tree.
1159
Everything else results in an error.
1161
This returns a list of (from_path, to_path) pairs for each
1162
entry that is moved.
1167
# check for deprecated use of signature
1169
to_dir = kwargs.get('to_name', None)
1171
raise TypeError('You must supply a target directory')
1173
symbol_versioning.warn('The parameter to_name was deprecated'
1174
' in version 0.13. Use to_dir instead',
1177
# check destination directory
1178
assert not isinstance(from_paths, basestring)
1179
inv = self.inventory
1180
to_abs = self.abspath(to_dir)
1181
if not isdir(to_abs):
1182
raise errors.BzrMoveFailedError('',to_dir,
1183
errors.NotADirectory(to_abs))
1184
if not self.has_filename(to_dir):
1185
raise errors.BzrMoveFailedError('',to_dir,
1186
errors.NotInWorkingDirectory(to_dir))
1187
to_dir_id = inv.path2id(to_dir)
1188
if to_dir_id is None:
1189
raise errors.BzrMoveFailedError('',to_dir,
1190
errors.NotVersionedError(path=str(to_dir)))
1192
to_dir_ie = inv[to_dir_id]
1193
if to_dir_ie.kind != 'directory':
1194
raise errors.BzrMoveFailedError('',to_dir,
1195
errors.NotADirectory(to_abs))
1197
# create rename entries and tuples
1198
for from_rel in from_paths:
1199
from_tail = splitpath(from_rel)[-1]
1200
from_id = inv.path2id(from_rel)
1202
raise errors.BzrMoveFailedError(from_rel,to_dir,
1203
errors.NotVersionedError(path=str(from_rel)))
1205
from_entry = inv[from_id]
1206
from_parent_id = from_entry.parent_id
1207
to_rel = pathjoin(to_dir, from_tail)
1208
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1210
from_tail=from_tail,
1211
from_parent_id=from_parent_id,
1212
to_rel=to_rel, to_tail=from_tail,
1213
to_parent_id=to_dir_id)
1214
rename_entries.append(rename_entry)
1215
rename_tuples.append((from_rel, to_rel))
1217
# determine which move mode to use. checks also for movability
1218
rename_entries = self._determine_mv_mode(rename_entries, after)
1220
original_modified = self._inventory_is_modified
1223
self._inventory_is_modified = True
1224
self._move(rename_entries)
1226
# restore the inventory on error
1227
self._inventory_is_modified = original_modified
1229
self._write_inventory(inv)
1230
return rename_tuples
1232
def _determine_mv_mode(self, rename_entries, after=False):
1233
"""Determines for each from-to pair if both inventory and working tree
1234
or only the inventory has to be changed.
1236
Also does basic plausability tests.
1238
inv = self.inventory
1240
for rename_entry in rename_entries:
1241
# store to local variables for easier reference
1242
from_rel = rename_entry.from_rel
1243
from_id = rename_entry.from_id
1244
to_rel = rename_entry.to_rel
1245
to_id = inv.path2id(to_rel)
1246
only_change_inv = False
1248
# check the inventory for source and destination
1250
raise errors.BzrMoveFailedError(from_rel,to_rel,
1251
errors.NotVersionedError(path=str(from_rel)))
1252
if to_id is not None:
1253
raise errors.BzrMoveFailedError(from_rel,to_rel,
1254
errors.AlreadyVersionedError(path=str(to_rel)))
1256
# try to determine the mode for rename (only change inv or change
1257
# inv and file system)
1259
if not self.has_filename(to_rel):
1260
raise errors.BzrMoveFailedError(from_id,to_rel,
1261
errors.NoSuchFile(path=str(to_rel),
1262
extra="New file has not been created yet"))
1263
only_change_inv = True
1264
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1265
only_change_inv = True
1266
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1267
only_change_inv = False
1269
# something is wrong, so lets determine what exactly
1270
if not self.has_filename(from_rel) and \
1271
not self.has_filename(to_rel):
1272
raise errors.BzrRenameFailedError(from_rel,to_rel,
1273
errors.PathsDoNotExist(paths=(str(from_rel),
1276
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1277
extra="(Use --after to update the Bazaar id)")
1278
rename_entry.only_change_inv = only_change_inv
1279
return rename_entries
1281
def _move(self, rename_entries):
1282
"""Moves a list of files.
1284
Depending on the value of the flag 'only_change_inv', the
1285
file will be moved on the file system or not.
1287
inv = self.inventory
1290
for entry in rename_entries:
1292
self._move_entry(entry)
1294
self._rollback_move(moved)
1298
def _rollback_move(self, moved):
1299
"""Try to rollback a previous move in case of an filesystem error."""
1300
inv = self.inventory
1303
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1304
entry.to_tail, entry.to_parent_id, entry.from_rel,
1305
entry.from_tail, entry.from_parent_id,
1306
entry.only_change_inv))
1307
except errors.BzrMoveFailedError, e:
1308
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1309
" The working tree is in an inconsistent state."
1310
" Please consider doing a 'bzr revert'."
1311
" Error message is: %s" % e)
1313
def _move_entry(self, entry):
1314
inv = self.inventory
1315
from_rel_abs = self.abspath(entry.from_rel)
1316
to_rel_abs = self.abspath(entry.to_rel)
1317
if from_rel_abs == to_rel_abs:
1318
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1319
"Source and target are identical.")
1321
if not entry.only_change_inv:
1323
osutils.rename(from_rel_abs, to_rel_abs)
1325
raise errors.BzrMoveFailedError(entry.from_rel,
1327
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1329
@needs_tree_write_lock
1330
def rename_one(self, from_rel, to_rel, after=False):
1333
This can change the directory or the filename or both.
1335
rename_one has several 'modes' to work. First, it can rename a physical
1336
file and change the file_id. That is the normal mode. Second, it can
1337
only change the file_id without touching any physical file. This is
1338
the new mode introduced in version 0.15.
1340
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1341
versioned but present in the working tree.
1343
rename_one uses the second mode if 'after == False' and 'from_rel' is
1344
versioned but no longer in the working tree, and 'to_rel' is not
1345
versioned but present in the working tree.
1347
rename_one uses the first mode if 'after == False' and 'from_rel' is
1348
versioned and present in the working tree, and 'to_rel' is not
1349
versioned and not present in the working tree.
1351
Everything else results in an error.
1353
inv = self.inventory
1356
# create rename entries and tuples
1357
from_tail = splitpath(from_rel)[-1]
1358
from_id = inv.path2id(from_rel)
1360
raise errors.BzrRenameFailedError(from_rel,to_rel,
1361
errors.NotVersionedError(path=str(from_rel)))
1362
from_entry = inv[from_id]
1363
from_parent_id = from_entry.parent_id
1364
to_dir, to_tail = os.path.split(to_rel)
1365
to_dir_id = inv.path2id(to_dir)
1366
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1368
from_tail=from_tail,
1369
from_parent_id=from_parent_id,
1370
to_rel=to_rel, to_tail=to_tail,
1371
to_parent_id=to_dir_id)
1372
rename_entries.append(rename_entry)
1374
# determine which move mode to use. checks also for movability
1375
rename_entries = self._determine_mv_mode(rename_entries, after)
1377
# check if the target changed directory and if the target directory is
1379
if to_dir_id is None:
1380
raise errors.BzrMoveFailedError(from_rel,to_rel,
1381
errors.NotVersionedError(path=str(to_dir)))
1383
# all checks done. now we can continue with our actual work
1384
mutter('rename_one:\n'
1389
' to_dir_id {%s}\n',
1390
from_id, from_rel, to_rel, to_dir, to_dir_id)
1392
self._move(rename_entries)
1393
self._write_inventory(inv)
1395
class _RenameEntry(object):
1396
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1397
to_rel, to_tail, to_parent_id, only_change_inv=False):
1398
self.from_rel = from_rel
1399
self.from_id = from_id
1400
self.from_tail = from_tail
1401
self.from_parent_id = from_parent_id
1402
self.to_rel = to_rel
1403
self.to_tail = to_tail
1404
self.to_parent_id = to_parent_id
1405
self.only_change_inv = only_change_inv
1409
"""Return all unknown files.
1411
These are files in the working directory that are not versioned or
1412
control files or ignored.
1414
# force the extras method to be fully executed before returning, to
1415
# prevent race conditions with the lock
1417
[subp for subp in self.extras() if not self.is_ignored(subp)])
1419
@needs_tree_write_lock
1420
def unversion(self, file_ids):
1421
"""Remove the file ids in file_ids from the current versioned set.
1423
When a file_id is unversioned, all of its children are automatically
1426
:param file_ids: The file ids to stop versioning.
1427
:raises: NoSuchId if any fileid is not currently versioned.
1429
for file_id in file_ids:
1430
file_id = osutils.safe_file_id(file_id)
1431
if self._inventory.has_id(file_id):
1432
self._inventory.remove_recursive_id(file_id)
1434
raise errors.NoSuchId(self, file_id)
1436
# in the future this should just set a dirty bit to wait for the
1437
# final unlock. However, until all methods of workingtree start
1438
# with the current in -memory inventory rather than triggering
1439
# a read, it is more complex - we need to teach read_inventory
1440
# to know when to read, and when to not read first... and possibly
1441
# to save first when the in memory one may be corrupted.
1442
# so for now, we just only write it if it is indeed dirty.
1444
self._write_inventory(self._inventory)
1446
@deprecated_method(zero_eight)
1447
def iter_conflicts(self):
1448
"""List all files in the tree that have text or content conflicts.
1449
DEPRECATED. Use conflicts instead."""
1450
return self._iter_conflicts()
1452
def _iter_conflicts(self):
1454
for info in self.list_files():
1456
stem = get_conflicted_stem(path)
1459
if stem not in conflicted:
1460
conflicted.add(stem)
1464
def pull(self, source, overwrite=False, stop_revision=None,
1465
change_reporter=None):
1466
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1469
pp = ProgressPhase("Pull phase", 2, top_pb)
1471
old_revision_info = self.branch.last_revision_info()
1472
basis_tree = self.basis_tree()
1473
count = self.branch.pull(source, overwrite, stop_revision)
1474
new_revision_info = self.branch.last_revision_info()
1475
if new_revision_info != old_revision_info:
1477
repository = self.branch.repository
1478
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1479
basis_tree.lock_read()
1481
new_basis_tree = self.branch.basis_tree()
1488
change_reporter=change_reporter)
1489
if (basis_tree.inventory.root is None and
1490
new_basis_tree.inventory.root is not None):
1491
self.set_root_id(new_basis_tree.inventory.root.file_id)
1495
# TODO - dedup parents list with things merged by pull ?
1496
# reuse the revisiontree we merged against to set the new
1498
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1499
# we have to pull the merge trees out again, because
1500
# merge_inner has set the ids. - this corner is not yet
1501
# layered well enough to prevent double handling.
1502
# XXX TODO: Fix the double handling: telling the tree about
1503
# the already known parent data is wasteful.
1504
merges = self.get_parent_ids()[1:]
1505
parent_trees.extend([
1506
(parent, repository.revision_tree(parent)) for
1508
self.set_parent_trees(parent_trees)
1515
def put_file_bytes_non_atomic(self, file_id, bytes):
1516
"""See MutableTree.put_file_bytes_non_atomic."""
1517
file_id = osutils.safe_file_id(file_id)
1518
stream = file(self.id2abspath(file_id), 'wb')
1523
# TODO: update the hashcache here ?
1526
"""Yield all unversioned files in this WorkingTree.
1528
If there are any unversioned directories then only the directory is
1529
returned, not all its children. But if there are unversioned files
1530
under a versioned subdirectory, they are returned.
1532
Currently returned depth-first, sorted by name within directories.
1533
This is the same order used by 'osutils.walkdirs'.
1535
## TODO: Work from given directory downwards
1536
for path, dir_entry in self.inventory.directories():
1537
# mutter("search for unknowns in %r", path)
1538
dirabs = self.abspath(path)
1539
if not isdir(dirabs):
1540
# e.g. directory deleted
1544
for subf in os.listdir(dirabs):
1547
if subf not in dir_entry.children:
1548
subf_norm, can_access = osutils.normalized_filename(subf)
1549
if subf_norm != subf and can_access:
1550
if subf_norm not in dir_entry.children:
1551
fl.append(subf_norm)
1557
subp = pathjoin(path, subf)
1560
def ignored_files(self):
1561
"""Yield list of PATH, IGNORE_PATTERN"""
1562
for subp in self.extras():
1563
pat = self.is_ignored(subp)
1567
def get_ignore_list(self):
1568
"""Return list of ignore patterns.
1570
Cached in the Tree object after the first call.
1572
ignoreset = getattr(self, '_ignoreset', None)
1573
if ignoreset is not None:
1576
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1577
ignore_globs.update(ignores.get_runtime_ignores())
1578
ignore_globs.update(ignores.get_user_ignores())
1579
if self.has_filename(bzrlib.IGNORE_FILENAME):
1580
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1582
ignore_globs.update(ignores.parse_ignore_file(f))
1585
self._ignoreset = ignore_globs
1588
def _flush_ignore_list_cache(self):
1589
"""Resets the cached ignore list to force a cache rebuild."""
1590
self._ignoreset = None
1591
self._ignoreglobster = None
1593
def is_ignored(self, filename):
1594
r"""Check whether the filename matches an ignore pattern.
1596
Patterns containing '/' or '\' need to match the whole path;
1597
others match against only the last component.
1599
If the file is ignored, returns the pattern which caused it to
1600
be ignored, otherwise None. So this can simply be used as a
1601
boolean if desired."""
1602
if getattr(self, '_ignoreglobster', None) is None:
1603
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1604
return self._ignoreglobster.match(filename)
1606
def kind(self, file_id):
1607
return file_kind(self.id2abspath(file_id))
1609
def _comparison_data(self, entry, path):
1610
abspath = self.abspath(path)
1612
stat_value = os.lstat(abspath)
1614
if getattr(e, 'errno', None) == errno.ENOENT:
1621
mode = stat_value.st_mode
1622
kind = osutils.file_kind_from_stat_mode(mode)
1623
if not supports_executable():
1624
executable = entry.executable
1626
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1627
return kind, executable, stat_value
1629
def _file_size(self, entry, stat_value):
1630
return stat_value.st_size
1632
def last_revision(self):
1633
"""Return the last revision of the branch for this tree.
1635
This format tree does not support a separate marker for last-revision
1636
compared to the branch.
1638
See MutableTree.last_revision
1640
return self._last_revision()
1643
def _last_revision(self):
1644
"""helper for get_parent_ids."""
1645
return self.branch.last_revision()
1647
def is_locked(self):
1648
return self._control_files.is_locked()
1650
def _must_be_locked(self):
1651
if not self.is_locked():
1652
raise errors.ObjectNotLocked(self)
1654
def lock_read(self):
1655
"""See Branch.lock_read, and WorkingTree.unlock."""
1656
if not self.is_locked():
1658
self.branch.lock_read()
1660
return self._control_files.lock_read()
1662
self.branch.unlock()
1665
def lock_tree_write(self):
1666
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1667
if not self.is_locked():
1669
self.branch.lock_read()
1671
return self._control_files.lock_write()
1673
self.branch.unlock()
1676
def lock_write(self):
1677
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1678
if not self.is_locked():
1680
self.branch.lock_write()
1682
return self._control_files.lock_write()
1684
self.branch.unlock()
1687
def get_physical_lock_status(self):
1688
return self._control_files.get_physical_lock_status()
1690
def _basis_inventory_name(self):
1691
return 'basis-inventory-cache'
1693
def _reset_data(self):
1694
"""Reset transient data that cannot be revalidated."""
1695
self._inventory_is_modified = False
1696
result = self._deserialize(self._control_files.get('inventory'))
1697
self._set_inventory(result, dirty=False)
1699
@needs_tree_write_lock
1700
def set_last_revision(self, new_revision):
1701
"""Change the last revision in the working tree."""
1702
new_revision = osutils.safe_revision_id(new_revision)
1703
if self._change_last_revision(new_revision):
1704
self._cache_basis_inventory(new_revision)
1706
def _change_last_revision(self, new_revision):
1707
"""Template method part of set_last_revision to perform the change.
1709
This is used to allow WorkingTree3 instances to not affect branch
1710
when their last revision is set.
1712
if new_revision is None:
1713
self.branch.set_revision_history([])
1716
self.branch.generate_revision_history(new_revision)
1717
except errors.NoSuchRevision:
1718
# not present in the repo - dont try to set it deeper than the tip
1719
self.branch.set_revision_history([new_revision])
1722
def _write_basis_inventory(self, xml):
1723
"""Write the basis inventory XML to the basis-inventory file"""
1724
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1725
path = self._basis_inventory_name()
1727
self._control_files.put(path, sio)
1729
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1730
"""Create the text that will be saved in basis-inventory"""
1731
# TODO: jam 20070209 This should be redundant, as the revision_id
1732
# as all callers should have already converted the revision_id to
1734
inventory.revision_id = osutils.safe_revision_id(revision_id)
1735
return xml7.serializer_v7.write_inventory_to_string(inventory)
1737
def _cache_basis_inventory(self, new_revision):
1738
"""Cache new_revision as the basis inventory."""
1739
# TODO: this should allow the ready-to-use inventory to be passed in,
1740
# as commit already has that ready-to-use [while the format is the
1743
# this double handles the inventory - unpack and repack -
1744
# but is easier to understand. We can/should put a conditional
1745
# in here based on whether the inventory is in the latest format
1746
# - perhaps we should repack all inventories on a repository
1748
# the fast path is to copy the raw xml from the repository. If the
1749
# xml contains 'revision_id="', then we assume the right
1750
# revision_id is set. We must check for this full string, because a
1751
# root node id can legitimately look like 'revision_id' but cannot
1753
xml = self.branch.repository.get_inventory_xml(new_revision)
1754
firstline = xml.split('\n', 1)[0]
1755
if (not 'revision_id="' in firstline or
1756
'format="7"' not in firstline):
1757
inv = self.branch.repository.deserialise_inventory(
1759
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1760
self._write_basis_inventory(xml)
1761
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1764
def read_basis_inventory(self):
1765
"""Read the cached basis inventory."""
1766
path = self._basis_inventory_name()
1767
return self._control_files.get(path).read()
1770
def read_working_inventory(self):
1771
"""Read the working inventory.
1773
:raises errors.InventoryModified: read_working_inventory will fail
1774
when the current in memory inventory has been modified.
1776
# conceptually this should be an implementation detail of the tree.
1777
# XXX: Deprecate this.
1778
# ElementTree does its own conversion from UTF-8, so open in
1780
if self._inventory_is_modified:
1781
raise errors.InventoryModified(self)
1782
result = self._deserialize(self._control_files.get('inventory'))
1783
self._set_inventory(result, dirty=False)
1786
@needs_tree_write_lock
1787
def remove(self, files, verbose=False, to_file=None):
1788
"""Remove nominated files from the working inventory..
1790
This does not remove their text. This does not run on XXX on what? RBC
1792
TODO: Refuse to remove modified files unless --force is given?
1794
TODO: Do something useful with directories.
1796
TODO: Should this remove the text or not? Tough call; not
1797
removing may be useful and the user can just use use rm, and
1798
is the opposite of add. Removing it is consistent with most
1799
other tools. Maybe an option.
1801
## TODO: Normalize names
1802
## TODO: Remove nested loops; better scalability
1803
if isinstance(files, basestring):
1806
inv = self.inventory
1808
# do this before any modifications
1810
fid = inv.path2id(f)
1812
note("%s is not versioned."%f)
1815
# having remove it, it must be either ignored or unknown
1816
if self.is_ignored(f):
1820
textui.show_status(new_status, inv[fid].kind, f,
1824
self._write_inventory(inv)
1826
@needs_tree_write_lock
1827
def revert(self, filenames, old_tree=None, backups=True,
1828
pb=DummyProgress(), report_changes=False):
1829
from bzrlib.conflicts import resolve
1830
if old_tree is None:
1831
old_tree = self.basis_tree()
1832
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1834
if not len(filenames):
1835
self.set_parent_ids(self.get_parent_ids()[:1])
1838
resolve(self, filenames, ignore_misses=True)
1841
def revision_tree(self, revision_id):
1842
"""See Tree.revision_tree.
1844
WorkingTree can supply revision_trees for the basis revision only
1845
because there is only one cached inventory in the bzr directory.
1847
if revision_id == self.last_revision():
1849
xml = self.read_basis_inventory()
1850
except errors.NoSuchFile:
1854
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1855
# dont use the repository revision_tree api because we want
1856
# to supply the inventory.
1857
if inv.revision_id == revision_id:
1858
return revisiontree.RevisionTree(self.branch.repository,
1860
except errors.BadInventoryFormat:
1862
# raise if there was no inventory, or if we read the wrong inventory.
1863
raise errors.NoSuchRevisionInTree(self, revision_id)
1865
# XXX: This method should be deprecated in favour of taking in a proper
1866
# new Inventory object.
1867
@needs_tree_write_lock
1868
def set_inventory(self, new_inventory_list):
1869
from bzrlib.inventory import (Inventory,
1874
inv = Inventory(self.get_root_id())
1875
for path, file_id, parent, kind in new_inventory_list:
1876
name = os.path.basename(path)
1879
# fixme, there should be a factory function inv,add_??
1880
if kind == 'directory':
1881
inv.add(InventoryDirectory(file_id, name, parent))
1882
elif kind == 'file':
1883
inv.add(InventoryFile(file_id, name, parent))
1884
elif kind == 'symlink':
1885
inv.add(InventoryLink(file_id, name, parent))
1887
raise errors.BzrError("unknown kind %r" % kind)
1888
self._write_inventory(inv)
1890
@needs_tree_write_lock
1891
def set_root_id(self, file_id):
1892
"""Set the root id for this tree."""
1895
symbol_versioning.warn(symbol_versioning.zero_twelve
1896
% 'WorkingTree.set_root_id with fileid=None',
1901
file_id = osutils.safe_file_id(file_id)
1902
self._set_root_id(file_id)
1904
def _set_root_id(self, file_id):
1905
"""Set the root id for this tree, in a format specific manner.
1907
:param file_id: The file id to assign to the root. It must not be
1908
present in the current inventory or an error will occur. It must
1909
not be None, but rather a valid file id.
1911
inv = self._inventory
1912
orig_root_id = inv.root.file_id
1913
# TODO: it might be nice to exit early if there was nothing
1914
# to do, saving us from trigger a sync on unlock.
1915
self._inventory_is_modified = True
1916
# we preserve the root inventory entry object, but
1917
# unlinkit from the byid index
1918
del inv._byid[inv.root.file_id]
1919
inv.root.file_id = file_id
1920
# and link it into the index with the new changed id.
1921
inv._byid[inv.root.file_id] = inv.root
1922
# and finally update all children to reference the new id.
1923
# XXX: this should be safe to just look at the root.children
1924
# list, not the WHOLE INVENTORY.
1927
if entry.parent_id == orig_root_id:
1928
entry.parent_id = inv.root.file_id
1931
"""See Branch.unlock.
1933
WorkingTree locking just uses the Branch locking facilities.
1934
This is current because all working trees have an embedded branch
1935
within them. IF in the future, we were to make branch data shareable
1936
between multiple working trees, i.e. via shared storage, then we
1937
would probably want to lock both the local tree, and the branch.
1939
raise NotImplementedError(self.unlock)
1942
"""Update a working tree along its branch.
1944
This will update the branch if its bound too, which means we have
1945
multiple trees involved:
1947
- The new basis tree of the master.
1948
- The old basis tree of the branch.
1949
- The old basis tree of the working tree.
1950
- The current working tree state.
1952
Pathologically, all three may be different, and non-ancestors of each
1953
other. Conceptually we want to:
1955
- Preserve the wt.basis->wt.state changes
1956
- Transform the wt.basis to the new master basis.
1957
- Apply a merge of the old branch basis to get any 'local' changes from
1959
- Restore the wt.basis->wt.state changes.
1961
There isn't a single operation at the moment to do that, so we:
1962
- Merge current state -> basis tree of the master w.r.t. the old tree
1964
- Do a 'normal' merge of the old branch basis if it is relevant.
1966
if self.branch.get_master_branch() is not None:
1968
update_branch = True
1970
self.lock_tree_write()
1971
update_branch = False
1974
old_tip = self.branch.update()
1977
return self._update_tree(old_tip)
1981
@needs_tree_write_lock
1982
def _update_tree(self, old_tip=None):
1983
"""Update a tree to the master branch.
1985
:param old_tip: if supplied, the previous tip revision the branch,
1986
before it was changed to the master branch's tip.
1988
# here if old_tip is not None, it is the old tip of the branch before
1989
# it was updated from the master branch. This should become a pending
1990
# merge in the working tree to preserve the user existing work. we
1991
# cant set that until we update the working trees last revision to be
1992
# one from the new branch, because it will just get absorbed by the
1993
# parent de-duplication logic.
1995
# We MUST save it even if an error occurs, because otherwise the users
1996
# local work is unreferenced and will appear to have been lost.
2000
last_rev = self.get_parent_ids()[0]
2003
if last_rev != self.branch.last_revision():
2004
# merge tree state up to new branch tip.
2005
basis = self.basis_tree()
2008
to_tree = self.branch.basis_tree()
2009
if basis.inventory.root is None:
2010
self.set_root_id(to_tree.inventory.root.file_id)
2012
result += merge.merge_inner(
2019
# TODO - dedup parents list with things merged by pull ?
2020
# reuse the tree we've updated to to set the basis:
2021
parent_trees = [(self.branch.last_revision(), to_tree)]
2022
merges = self.get_parent_ids()[1:]
2023
# Ideally we ask the tree for the trees here, that way the working
2024
# tree can decide whether to give us teh entire tree or give us a
2025
# lazy initialised tree. dirstate for instance will have the trees
2026
# in ram already, whereas a last-revision + basis-inventory tree
2027
# will not, but also does not need them when setting parents.
2028
for parent in merges:
2029
parent_trees.append(
2030
(parent, self.branch.repository.revision_tree(parent)))
2031
if old_tip is not None:
2032
parent_trees.append(
2033
(old_tip, self.branch.repository.revision_tree(old_tip)))
2034
self.set_parent_trees(parent_trees)
2035
last_rev = parent_trees[0][0]
2037
# the working tree had the same last-revision as the master
2038
# branch did. We may still have pivot local work from the local
2039
# branch into old_tip:
2040
if old_tip is not None:
2041
self.add_parent_tree_id(old_tip)
2042
if old_tip and old_tip != last_rev:
2043
# our last revision was not the prior branch last revision
2044
# and we have converted that last revision to a pending merge.
2045
# base is somewhere between the branch tip now
2046
# and the now pending merge
2048
# Since we just modified the working tree and inventory, flush out
2049
# the current state, before we modify it again.
2050
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2051
# requires it only because TreeTransform directly munges the
2052
# inventory and calls tree._write_inventory(). Ultimately we
2053
# should be able to remove this extra flush.
2055
from bzrlib.revision import common_ancestor
2057
base_rev_id = common_ancestor(self.branch.last_revision(),
2059
self.branch.repository)
2060
except errors.NoCommonAncestor:
2062
base_tree = self.branch.repository.revision_tree(base_rev_id)
2063
other_tree = self.branch.repository.revision_tree(old_tip)
2064
result += merge.merge_inner(
2071
def _write_hashcache_if_dirty(self):
2072
"""Write out the hashcache if it is dirty."""
2073
if self._hashcache.needs_write:
2075
self._hashcache.write()
2077
if e.errno not in (errno.EPERM, errno.EACCES):
2079
# TODO: jam 20061219 Should this be a warning? A single line
2080
# warning might be sufficient to let the user know what
2082
mutter('Could not write hashcache for %s\nError: %s',
2083
self._hashcache.cache_file_name(), e)
2085
@needs_tree_write_lock
2086
def _write_inventory(self, inv):
2087
"""Write inventory as the current inventory."""
2088
self._set_inventory(inv, dirty=True)
2091
def set_conflicts(self, arg):
2092
raise errors.UnsupportedOperation(self.set_conflicts, self)
2094
def add_conflicts(self, arg):
2095
raise errors.UnsupportedOperation(self.add_conflicts, self)
2098
def conflicts(self):
2099
conflicts = _mod_conflicts.ConflictList()
2100
for conflicted in self._iter_conflicts():
2103
if file_kind(self.abspath(conflicted)) != "file":
2105
except errors.NoSuchFile:
2108
for suffix in ('.THIS', '.OTHER'):
2110
kind = file_kind(self.abspath(conflicted+suffix))
2113
except errors.NoSuchFile:
2117
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2118
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2120
file_id=self.path2id(conflicted)))
2123
def walkdirs(self, prefix=""):
2124
"""Walk the directories of this tree.
2126
This API returns a generator, which is only valid during the current
2127
tree transaction - within a single lock_read or lock_write duration.
2129
If the tree is not locked, it may cause an error to be raised, depending
2130
on the tree implementation.
2132
disk_top = self.abspath(prefix)
2133
if disk_top.endswith('/'):
2134
disk_top = disk_top[:-1]
2135
top_strip_len = len(disk_top) + 1
2136
inventory_iterator = self._walkdirs(prefix)
2137
disk_iterator = osutils.walkdirs(disk_top, prefix)
2139
current_disk = disk_iterator.next()
2140
disk_finished = False
2142
if e.errno != errno.ENOENT:
2145
disk_finished = True
2147
current_inv = inventory_iterator.next()
2148
inv_finished = False
2149
except StopIteration:
2152
while not inv_finished or not disk_finished:
2153
if not disk_finished:
2154
# strip out .bzr dirs
2155
if current_disk[0][1][top_strip_len:] == '':
2156
# osutils.walkdirs can be made nicer -
2157
# yield the path-from-prefix rather than the pathjoined
2159
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2160
if current_disk[1][bzrdir_loc][0] == '.bzr':
2161
# we dont yield the contents of, or, .bzr itself.
2162
del current_disk[1][bzrdir_loc]
2164
# everything is unknown
2167
# everything is missing
2170
direction = cmp(current_inv[0][0], current_disk[0][0])
2172
# disk is before inventory - unknown
2173
dirblock = [(relpath, basename, kind, stat, None, None) for
2174
relpath, basename, kind, stat, top_path in current_disk[1]]
2175
yield (current_disk[0][0], None), dirblock
2177
current_disk = disk_iterator.next()
2178
except StopIteration:
2179
disk_finished = True
2181
# inventory is before disk - missing.
2182
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2183
for relpath, basename, dkind, stat, fileid, kind in
2185
yield (current_inv[0][0], current_inv[0][1]), dirblock
2187
current_inv = inventory_iterator.next()
2188
except StopIteration:
2191
# versioned present directory
2192
# merge the inventory and disk data together
2194
for relpath, subiterator in itertools.groupby(sorted(
2195
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2196
path_elements = list(subiterator)
2197
if len(path_elements) == 2:
2198
inv_row, disk_row = path_elements
2199
# versioned, present file
2200
dirblock.append((inv_row[0],
2201
inv_row[1], disk_row[2],
2202
disk_row[3], inv_row[4],
2204
elif len(path_elements[0]) == 5:
2206
dirblock.append((path_elements[0][0],
2207
path_elements[0][1], path_elements[0][2],
2208
path_elements[0][3], None, None))
2209
elif len(path_elements[0]) == 6:
2210
# versioned, absent file.
2211
dirblock.append((path_elements[0][0],
2212
path_elements[0][1], 'unknown', None,
2213
path_elements[0][4], path_elements[0][5]))
2215
raise NotImplementedError('unreachable code')
2216
yield current_inv[0], dirblock
2218
current_inv = inventory_iterator.next()
2219
except StopIteration:
2222
current_disk = disk_iterator.next()
2223
except StopIteration:
2224
disk_finished = True
2226
def _walkdirs(self, prefix=""):
2227
_directory = 'directory'
2228
# get the root in the inventory
2229
inv = self.inventory
2230
top_id = inv.path2id(prefix)
2234
pending = [(prefix, '', _directory, None, top_id, None)]
2237
currentdir = pending.pop()
2238
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2239
top_id = currentdir[4]
2241
relroot = currentdir[0] + '/'
2244
# FIXME: stash the node in pending
2246
for name, child in entry.sorted_children():
2247
dirblock.append((relroot + name, name, child.kind, None,
2248
child.file_id, child.kind
2250
yield (currentdir[0], entry.file_id), dirblock
2251
# push the user specified dirs from dirblock
2252
for dir in reversed(dirblock):
2253
if dir[2] == _directory:
2256
@needs_tree_write_lock
2257
def auto_resolve(self):
2258
"""Automatically resolve text conflicts according to contents.
2260
Only text conflicts are auto_resolvable. Files with no conflict markers
2261
are considered 'resolved', because bzr always puts conflict markers
2262
into files that have text conflicts. The corresponding .THIS .BASE and
2263
.OTHER files are deleted, as per 'resolve'.
2264
:return: a tuple of ConflictLists: (un_resolved, resolved).
2266
un_resolved = _mod_conflicts.ConflictList()
2267
resolved = _mod_conflicts.ConflictList()
2268
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2269
for conflict in self.conflicts():
2270
if (conflict.typestring != 'text conflict' or
2271
self.kind(conflict.file_id) != 'file'):
2272
un_resolved.append(conflict)
2274
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2276
for line in my_file:
2277
if conflict_re.search(line):
2278
un_resolved.append(conflict)
2281
resolved.append(conflict)
2284
resolved.remove_files(self)
2285
self.set_conflicts(un_resolved)
2286
return un_resolved, resolved
2289
class WorkingTree2(WorkingTree):
2290
"""This is the Format 2 working tree.
2292
This was the first weave based working tree.
2293
- uses os locks for locking.
2294
- uses the branch last-revision.
2297
def lock_tree_write(self):
2298
"""See WorkingTree.lock_tree_write().
2300
In Format2 WorkingTrees we have a single lock for the branch and tree
2301
so lock_tree_write() degrades to lock_write().
2303
self.branch.lock_write()
2305
return self._control_files.lock_write()
2307
self.branch.unlock()
2311
# we share control files:
2312
if self._control_files._lock_count == 3:
2313
# _inventory_is_modified is always False during a read lock.
2314
if self._inventory_is_modified:
2316
self._write_hashcache_if_dirty()
2318
# reverse order of locking.
2320
return self._control_files.unlock()
2322
self.branch.unlock()
2325
class WorkingTree3(WorkingTree):
2326
"""This is the Format 3 working tree.
2328
This differs from the base WorkingTree by:
2329
- having its own file lock
2330
- having its own last-revision property.
2332
This is new in bzr 0.8
2336
def _last_revision(self):
2337
"""See Mutable.last_revision."""
2339
return osutils.safe_revision_id(
2340
self._control_files.get('last-revision').read())
2341
except errors.NoSuchFile:
2344
def _change_last_revision(self, revision_id):
2345
"""See WorkingTree._change_last_revision."""
2346
if revision_id is None or revision_id == NULL_REVISION:
2348
self._control_files._transport.delete('last-revision')
2349
except errors.NoSuchFile:
2353
self._control_files.put_bytes('last-revision', revision_id)
2356
@needs_tree_write_lock
2357
def set_conflicts(self, conflicts):
2358
self._put_rio('conflicts', conflicts.to_stanzas(),
2361
@needs_tree_write_lock
2362
def add_conflicts(self, new_conflicts):
2363
conflict_set = set(self.conflicts())
2364
conflict_set.update(set(list(new_conflicts)))
2365
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2366
key=_mod_conflicts.Conflict.sort_key)))
2369
def conflicts(self):
2371
confile = self._control_files.get('conflicts')
2372
except errors.NoSuchFile:
2373
return _mod_conflicts.ConflictList()
2375
if confile.next() != CONFLICT_HEADER_1 + '\n':
2376
raise errors.ConflictFormatError()
2377
except StopIteration:
2378
raise errors.ConflictFormatError()
2379
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2382
if self._control_files._lock_count == 1:
2383
# _inventory_is_modified is always False during a read lock.
2384
if self._inventory_is_modified:
2386
self._write_hashcache_if_dirty()
2387
# reverse order of locking.
2389
return self._control_files.unlock()
2391
self.branch.unlock()
2394
def get_conflicted_stem(path):
2395
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2396
if path.endswith(suffix):
2397
return path[:-len(suffix)]
2400
@deprecated_function(zero_eight)
2401
def is_control_file(filename):
2402
"""See WorkingTree.is_control_filename(filename)."""
2403
## FIXME: better check
2404
filename = normpath(filename)
2405
while filename != '':
2406
head, tail = os.path.split(filename)
2407
## mutter('check %r for control file' % ((head, tail),))
2410
if filename == head:
2416
class WorkingTreeFormat(object):
2417
"""An encapsulation of the initialization and open routines for a format.
2419
Formats provide three things:
2420
* An initialization routine,
2424
Formats are placed in an dict by their format string for reference
2425
during workingtree opening. Its not required that these be instances, they
2426
can be classes themselves with class methods - it simply depends on
2427
whether state is needed for a given format or not.
2429
Once a format is deprecated, just deprecate the initialize and open
2430
methods on the format class. Do not deprecate the object, as the
2431
object will be created every time regardless.
2434
_default_format = None
2435
"""The default format used for new trees."""
2438
"""The known formats."""
2440
requires_rich_root = False
2443
def find_format(klass, a_bzrdir):
2444
"""Return the format for the working tree object in a_bzrdir."""
2446
transport = a_bzrdir.get_workingtree_transport(None)
2447
format_string = transport.get("format").read()
2448
return klass._formats[format_string]
2449
except errors.NoSuchFile:
2450
raise errors.NoWorkingTree(base=transport.base)
2452
raise errors.UnknownFormatError(format=format_string)
2454
def __eq__(self, other):
2455
return self.__class__ is other.__class__
2457
def __ne__(self, other):
2458
return not (self == other)
2461
def get_default_format(klass):
2462
"""Return the current default format."""
2463
return klass._default_format
2465
def get_format_string(self):
2466
"""Return the ASCII format string that identifies this format."""
2467
raise NotImplementedError(self.get_format_string)
2469
def get_format_description(self):
2470
"""Return the short description for this format."""
2471
raise NotImplementedError(self.get_format_description)
2473
def is_supported(self):
2474
"""Is this format supported?
2476
Supported formats can be initialized and opened.
2477
Unsupported formats may not support initialization or committing or
2478
some other features depending on the reason for not being supported.
2483
def register_format(klass, format):
2484
klass._formats[format.get_format_string()] = format
2487
def set_default_format(klass, format):
2488
klass._default_format = format
2491
def unregister_format(klass, format):
2492
assert klass._formats[format.get_format_string()] is format
2493
del klass._formats[format.get_format_string()]
2497
class WorkingTreeFormat2(WorkingTreeFormat):
2498
"""The second working tree format.
2500
This format modified the hash cache from the format 1 hash cache.
2503
def get_format_description(self):
2504
"""See WorkingTreeFormat.get_format_description()."""
2505
return "Working tree format 2"
2507
def stub_initialize_remote(self, control_files):
2508
"""As a special workaround create critical control files for a remote working tree
2510
This ensures that it can later be updated and dealt with locally,
2511
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2512
no working tree. (See bug #43064).
2516
xml5.serializer_v5.write_inventory(inv, sio)
2518
control_files.put('inventory', sio)
2520
control_files.put_bytes('pending-merges', '')
2523
def initialize(self, a_bzrdir, revision_id=None):
2524
"""See WorkingTreeFormat.initialize()."""
2525
if not isinstance(a_bzrdir.transport, LocalTransport):
2526
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2527
branch = a_bzrdir.open_branch()
2528
if revision_id is not None:
2529
revision_id = osutils.safe_revision_id(revision_id)
2532
revision_history = branch.revision_history()
2534
position = revision_history.index(revision_id)
2536
raise errors.NoSuchRevision(branch, revision_id)
2537
branch.set_revision_history(revision_history[:position + 1])
2540
revision = branch.last_revision()
2542
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2548
basis_tree = branch.repository.revision_tree(revision)
2549
if basis_tree.inventory.root is not None:
2550
wt.set_root_id(basis_tree.inventory.root.file_id)
2551
# set the parent list and cache the basis tree.
2552
wt.set_parent_trees([(revision, basis_tree)])
2553
transform.build_tree(basis_tree, wt)
2557
super(WorkingTreeFormat2, self).__init__()
2558
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2560
def open(self, a_bzrdir, _found=False):
2561
"""Return the WorkingTree object for a_bzrdir
2563
_found is a private parameter, do not use it. It is used to indicate
2564
if format probing has already been done.
2567
# we are being called directly and must probe.
2568
raise NotImplementedError
2569
if not isinstance(a_bzrdir.transport, LocalTransport):
2570
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2571
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2577
class WorkingTreeFormat3(WorkingTreeFormat):
2578
"""The second working tree format updated to record a format marker.
2581
- exists within a metadir controlling .bzr
2582
- includes an explicit version marker for the workingtree control
2583
files, separate from the BzrDir format
2584
- modifies the hash cache format
2586
- uses a LockDir to guard access for writes.
2589
def get_format_string(self):
2590
"""See WorkingTreeFormat.get_format_string()."""
2591
return "Bazaar-NG Working Tree format 3"
2593
def get_format_description(self):
2594
"""See WorkingTreeFormat.get_format_description()."""
2595
return "Working tree format 3"
2597
_lock_file_name = 'lock'
2598
_lock_class = LockDir
2600
_tree_class = WorkingTree3
2602
def __get_matchingbzrdir(self):
2603
return bzrdir.BzrDirMetaFormat1()
2605
_matchingbzrdir = property(__get_matchingbzrdir)
2607
def _open_control_files(self, a_bzrdir):
2608
transport = a_bzrdir.get_workingtree_transport(None)
2609
return LockableFiles(transport, self._lock_file_name,
2612
def initialize(self, a_bzrdir, revision_id=None):
2613
"""See WorkingTreeFormat.initialize().
2615
revision_id allows creating a working tree at a different
2616
revision than the branch is at.
2618
if not isinstance(a_bzrdir.transport, LocalTransport):
2619
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2620
transport = a_bzrdir.get_workingtree_transport(self)
2621
control_files = self._open_control_files(a_bzrdir)
2622
control_files.create_lock()
2623
control_files.lock_write()
2624
control_files.put_utf8('format', self.get_format_string())
2625
branch = a_bzrdir.open_branch()
2626
if revision_id is None:
2627
revision_id = branch.last_revision()
2629
revision_id = osutils.safe_revision_id(revision_id)
2630
# WorkingTree3 can handle an inventory which has a unique root id.
2631
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2632
# those trees. And because there isn't a format bump inbetween, we
2633
# are maintaining compatibility with older clients.
2634
# inv = Inventory(root_id=gen_root_id())
2635
inv = self._initial_inventory()
2636
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2642
_control_files=control_files)
2643
wt.lock_tree_write()
2645
basis_tree = branch.repository.revision_tree(revision_id)
2646
# only set an explicit root id if there is one to set.
2647
if basis_tree.inventory.root is not None:
2648
wt.set_root_id(basis_tree.inventory.root.file_id)
2649
if revision_id == NULL_REVISION:
2650
wt.set_parent_trees([])
2652
wt.set_parent_trees([(revision_id, basis_tree)])
2653
transform.build_tree(basis_tree, wt)
2655
# Unlock in this order so that the unlock-triggers-flush in
2656
# WorkingTree is given a chance to fire.
2657
control_files.unlock()
2661
def _initial_inventory(self):
2665
super(WorkingTreeFormat3, self).__init__()
2667
def open(self, a_bzrdir, _found=False):
2668
"""Return the WorkingTree object for a_bzrdir
2670
_found is a private parameter, do not use it. It is used to indicate
2671
if format probing has already been done.
2674
# we are being called directly and must probe.
2675
raise NotImplementedError
2676
if not isinstance(a_bzrdir.transport, LocalTransport):
2677
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2678
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2680
def _open(self, a_bzrdir, control_files):
2681
"""Open the tree itself.
2683
:param a_bzrdir: the dir for the tree.
2684
:param control_files: the control files for the tree.
2686
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2690
_control_files=control_files)
2693
return self.get_format_string()
2696
__default_format = WorkingTreeFormat4()
2697
WorkingTreeFormat.register_format(__default_format)
2698
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2699
WorkingTreeFormat.set_default_format(__default_format)
2700
# formats which have no format string are not discoverable
2701
# and not independently creatable, so are not registered.
2702
_legacy_formats = [WorkingTreeFormat2(),
2706
class WorkingTreeTestProviderAdapter(object):
2707
"""A tool to generate a suite testing multiple workingtree formats at once.
2709
This is done by copying the test once for each transport and injecting
2710
the transport_server, transport_readonly_server, and workingtree_format
2711
classes into each copy. Each copy is also given a new id() to make it
2715
def __init__(self, transport_server, transport_readonly_server, formats):
2716
self._transport_server = transport_server
2717
self._transport_readonly_server = transport_readonly_server
2718
self._formats = formats
2720
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2721
"""Clone test for adaption."""
2722
new_test = deepcopy(test)
2723
new_test.transport_server = self._transport_server
2724
new_test.transport_readonly_server = self._transport_readonly_server
2725
new_test.bzrdir_format = bzrdir_format
2726
new_test.workingtree_format = workingtree_format
2727
def make_new_test_id():
2728
new_id = "%s(%s)" % (test.id(), variation)
2729
return lambda: new_id
2730
new_test.id = make_new_test_id()
2733
def adapt(self, test):
2734
from bzrlib.tests import TestSuite
2735
result = TestSuite()
2736
for workingtree_format, bzrdir_format in self._formats:
2737
new_test = self._clone_test(
2740
workingtree_format, workingtree_format.__class__.__name__)
2741
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
