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()
492
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
493
require_versioned=True).next()
494
changed_content, kind = changes[2], changes[6]
495
if not changed_content:
496
return basis.annotate_iter(file_id)
500
if kind[0] != 'file':
503
old_lines = list(basis.annotate_iter(file_id))
505
for tree in self.branch.repository.revision_trees(
506
self.get_parent_ids()[1:]):
507
if file_id not in tree:
509
old.append(list(tree.annotate_iter(file_id)))
510
return annotate.reannotate(old, self.get_file(file_id).readlines(),
515
def get_parent_ids(self):
516
"""See Tree.get_parent_ids.
518
This implementation reads the pending merges list and last_revision
519
value and uses that to decide what the parents list should be.
521
last_rev = self._last_revision()
527
merges_file = self._control_files.get('pending-merges')
528
except errors.NoSuchFile:
531
for l in merges_file.readlines():
532
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
533
parents.append(revision_id)
537
def get_root_id(self):
538
"""Return the id of this trees root"""
539
return self._inventory.root.file_id
541
def _get_store_filename(self, file_id):
542
## XXX: badly named; this is not in the store at all
543
file_id = osutils.safe_file_id(file_id)
544
return self.abspath(self.id2path(file_id))
547
def clone(self, to_bzrdir, revision_id=None, basis=None):
548
"""Duplicate this working tree into to_bzr, including all state.
550
Specifically modified files are kept as modified, but
551
ignored and unknown files are discarded.
553
If you want to make a new line of development, see bzrdir.sprout()
556
If not None, the cloned tree will have its last revision set to
557
revision, and and difference between the source trees last revision
558
and this one merged in.
561
If not None, a closer copy of a tree which may have some files in
562
common, and which file content should be preferentially copied from.
564
# assumes the target bzr dir format is compatible.
565
result = self._format.initialize(to_bzrdir)
566
self.copy_content_into(result, revision_id)
570
def copy_content_into(self, tree, revision_id=None):
571
"""Copy the current content and user files of this tree into tree."""
572
tree.set_root_id(self.get_root_id())
573
if revision_id is None:
574
merge.transform_tree(tree, self)
576
# TODO now merge from tree.last_revision to revision (to preserve
577
# user local changes)
578
merge.transform_tree(tree, self)
579
tree.set_parent_ids([revision_id])
581
def id2abspath(self, file_id):
582
file_id = osutils.safe_file_id(file_id)
583
return self.abspath(self.id2path(file_id))
585
def has_id(self, file_id):
586
# files that have been deleted are excluded
587
file_id = osutils.safe_file_id(file_id)
589
if not inv.has_id(file_id):
591
path = inv.id2path(file_id)
592
return osutils.lexists(self.abspath(path))
594
def has_or_had_id(self, file_id):
595
file_id = osutils.safe_file_id(file_id)
596
if file_id == self.inventory.root.file_id:
598
return self.inventory.has_id(file_id)
600
__contains__ = has_id
602
def get_file_size(self, file_id):
603
file_id = osutils.safe_file_id(file_id)
604
return os.path.getsize(self.id2abspath(file_id))
607
def get_file_sha1(self, file_id, path=None, stat_value=None):
608
file_id = osutils.safe_file_id(file_id)
610
path = self._inventory.id2path(file_id)
611
return self._hashcache.get_sha1(path, stat_value)
613
def get_file_mtime(self, file_id, path=None):
614
file_id = osutils.safe_file_id(file_id)
616
path = self.inventory.id2path(file_id)
617
return os.lstat(self.abspath(path)).st_mtime
619
if not supports_executable():
620
def is_executable(self, file_id, path=None):
621
file_id = osutils.safe_file_id(file_id)
622
return self._inventory[file_id].executable
624
def is_executable(self, file_id, path=None):
626
file_id = osutils.safe_file_id(file_id)
627
path = self.id2path(file_id)
628
mode = os.lstat(self.abspath(path)).st_mode
629
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
631
@needs_tree_write_lock
632
def _add(self, files, ids, kinds):
633
"""See MutableTree._add."""
634
# TODO: Re-adding a file that is removed in the working copy
635
# should probably put it back with the previous ID.
636
# the read and write working inventory should not occur in this
637
# function - they should be part of lock_write and unlock.
638
inv = self.read_working_inventory()
639
for f, file_id, kind in zip(files, ids, kinds):
640
assert kind is not None
642
inv.add_path(f, kind=kind)
644
file_id = osutils.safe_file_id(file_id)
645
inv.add_path(f, kind=kind, file_id=file_id)
646
self._write_inventory(inv)
648
@needs_tree_write_lock
649
def _gather_kinds(self, files, kinds):
650
"""See MutableTree._gather_kinds."""
651
for pos, f in enumerate(files):
652
if kinds[pos] is None:
653
fullpath = normpath(self.abspath(f))
655
kinds[pos] = file_kind(fullpath)
657
if e.errno == errno.ENOENT:
658
raise errors.NoSuchFile(fullpath)
661
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
662
"""Add revision_id as a parent.
664
This is equivalent to retrieving the current list of parent ids
665
and setting the list to its value plus revision_id.
667
:param revision_id: The revision id to add to the parent list. It may
668
be a ghost revision as long as its not the first parent to be added,
669
or the allow_leftmost_as_ghost parameter is set True.
670
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
672
parents = self.get_parent_ids() + [revision_id]
673
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
674
or allow_leftmost_as_ghost)
676
@needs_tree_write_lock
677
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
678
"""Add revision_id, tree tuple as a parent.
680
This is equivalent to retrieving the current list of parent trees
681
and setting the list to its value plus parent_tuple. See also
682
add_parent_tree_id - if you only have a parent id available it will be
683
simpler to use that api. If you have the parent already available, using
684
this api is preferred.
686
:param parent_tuple: The (revision id, tree) to add to the parent list.
687
If the revision_id is a ghost, pass None for the tree.
688
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
690
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
691
if len(parent_ids) > 1:
692
# the leftmost may have already been a ghost, preserve that if it
694
allow_leftmost_as_ghost = True
695
self.set_parent_ids(parent_ids,
696
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
698
@needs_tree_write_lock
699
def add_pending_merge(self, *revision_ids):
700
# TODO: Perhaps should check at this point that the
701
# history of the revision is actually present?
702
parents = self.get_parent_ids()
704
for rev_id in revision_ids:
705
if rev_id in parents:
707
parents.append(rev_id)
710
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
712
@deprecated_method(zero_eleven)
714
def pending_merges(self):
715
"""Return a list of pending merges.
717
These are revisions that have been merged into the working
718
directory but not yet committed.
720
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
721
instead - which is available on all tree objects.
723
return self.get_parent_ids()[1:]
725
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
726
"""Common ghost checking functionality from set_parent_*.
728
This checks that the left hand-parent exists if there are any
731
if len(revision_ids) > 0:
732
leftmost_id = revision_ids[0]
733
if (not allow_leftmost_as_ghost and not
734
self.branch.repository.has_revision(leftmost_id)):
735
raise errors.GhostRevisionUnusableHere(leftmost_id)
737
def _set_merges_from_parent_ids(self, parent_ids):
738
merges = parent_ids[1:]
739
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
741
@needs_tree_write_lock
742
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
743
"""Set the parent ids to revision_ids.
745
See also set_parent_trees. This api will try to retrieve the tree data
746
for each element of revision_ids from the trees repository. If you have
747
tree data already available, it is more efficient to use
748
set_parent_trees rather than set_parent_ids. set_parent_ids is however
749
an easier API to use.
751
:param revision_ids: The revision_ids to set as the parent ids of this
752
working tree. Any of these may be ghosts.
754
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
755
self._check_parents_for_ghosts(revision_ids,
756
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
758
if len(revision_ids) > 0:
759
self.set_last_revision(revision_ids[0])
761
self.set_last_revision(None)
763
self._set_merges_from_parent_ids(revision_ids)
765
@needs_tree_write_lock
766
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
767
"""See MutableTree.set_parent_trees."""
768
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
770
self._check_parents_for_ghosts(parent_ids,
771
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
773
if len(parent_ids) == 0:
774
leftmost_parent_id = None
775
leftmost_parent_tree = None
777
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
779
if self._change_last_revision(leftmost_parent_id):
780
if leftmost_parent_tree is None:
781
# If we don't have a tree, fall back to reading the
782
# parent tree from the repository.
783
self._cache_basis_inventory(leftmost_parent_id)
785
inv = leftmost_parent_tree.inventory
786
xml = self._create_basis_xml_from_inventory(
787
leftmost_parent_id, inv)
788
self._write_basis_inventory(xml)
789
self._set_merges_from_parent_ids(parent_ids)
791
@needs_tree_write_lock
792
def set_pending_merges(self, rev_list):
793
parents = self.get_parent_ids()
794
leftmost = parents[:1]
795
new_parents = leftmost + rev_list
796
self.set_parent_ids(new_parents)
798
@needs_tree_write_lock
799
def set_merge_modified(self, modified_hashes):
801
for file_id, hash in modified_hashes.iteritems():
802
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
803
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
805
def _put_rio(self, filename, stanzas, header):
806
self._must_be_locked()
807
my_file = rio_file(stanzas, header)
808
self._control_files.put(filename, my_file)
810
@needs_write_lock # because merge pulls data into the branch.
811
def merge_from_branch(self, branch, to_revision=None):
812
"""Merge from a branch into this working tree.
814
:param branch: The branch to merge from.
815
:param to_revision: If non-None, the merge will merge to to_revision,
816
but not beyond it. to_revision does not need to be in the history
817
of the branch when it is supplied. If None, to_revision defaults to
818
branch.last_revision().
820
from bzrlib.merge import Merger, Merge3Merger
821
pb = bzrlib.ui.ui_factory.nested_progress_bar()
823
merger = Merger(self.branch, this_tree=self, pb=pb)
824
merger.pp = ProgressPhase("Merge phase", 5, pb)
825
merger.pp.next_phase()
826
# check that there are no
828
merger.check_basis(check_clean=True, require_commits=False)
829
if to_revision is None:
830
to_revision = branch.last_revision()
832
to_revision = osutils.safe_revision_id(to_revision)
833
merger.other_rev_id = to_revision
834
if merger.other_rev_id is None:
835
raise error.NoCommits(branch)
836
self.branch.fetch(branch, last_revision=merger.other_rev_id)
837
merger.other_basis = merger.other_rev_id
838
merger.other_tree = self.branch.repository.revision_tree(
840
merger.other_branch = branch
841
merger.pp.next_phase()
843
if merger.base_rev_id == merger.other_rev_id:
844
raise errors.PointlessMerge
845
merger.backup_files = False
846
merger.merge_type = Merge3Merger
847
merger.set_interesting_files(None)
848
merger.show_base = False
849
merger.reprocess = False
850
conflicts = merger.do_merge()
857
def merge_modified(self):
858
"""Return a dictionary of files modified by a merge.
860
The list is initialized by WorkingTree.set_merge_modified, which is
861
typically called after we make some automatic updates to the tree
864
This returns a map of file_id->sha1, containing only files which are
865
still in the working inventory and have that text hash.
868
hashfile = self._control_files.get('merge-hashes')
869
except errors.NoSuchFile:
873
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
874
raise errors.MergeModifiedFormatError()
875
except StopIteration:
876
raise errors.MergeModifiedFormatError()
877
for s in RioReader(hashfile):
878
# RioReader reads in Unicode, so convert file_ids back to utf8
879
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
880
if file_id not in self.inventory:
882
text_hash = s.get("hash")
883
if text_hash == self.get_file_sha1(file_id):
884
merge_hashes[file_id] = text_hash
888
def mkdir(self, path, file_id=None):
889
"""See MutableTree.mkdir()."""
891
file_id = generate_ids.gen_file_id(os.path.basename(path))
892
os.mkdir(self.abspath(path))
893
self.add(path, file_id, 'directory')
896
def get_symlink_target(self, file_id):
897
file_id = osutils.safe_file_id(file_id)
898
return os.readlink(self.id2abspath(file_id))
901
def subsume(self, other_tree):
902
def add_children(inventory, entry):
903
for child_entry in entry.children.values():
904
inventory._byid[child_entry.file_id] = child_entry
905
if child_entry.kind == 'directory':
906
add_children(inventory, child_entry)
907
if other_tree.get_root_id() == self.get_root_id():
908
raise errors.BadSubsumeSource(self, other_tree,
909
'Trees have the same root')
911
other_tree_path = self.relpath(other_tree.basedir)
912
except errors.PathNotChild:
913
raise errors.BadSubsumeSource(self, other_tree,
914
'Tree is not contained by the other')
915
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
916
if new_root_parent is None:
917
raise errors.BadSubsumeSource(self, other_tree,
918
'Parent directory is not versioned.')
919
# We need to ensure that the result of a fetch will have a
920
# versionedfile for the other_tree root, and only fetching into
921
# RepositoryKnit2 guarantees that.
922
if not self.branch.repository.supports_rich_root():
923
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
924
other_tree.lock_tree_write()
926
new_parents = other_tree.get_parent_ids()
927
other_root = other_tree.inventory.root
928
other_root.parent_id = new_root_parent
929
other_root.name = osutils.basename(other_tree_path)
930
self.inventory.add(other_root)
931
add_children(self.inventory, other_root)
932
self._write_inventory(self.inventory)
933
# normally we don't want to fetch whole repositories, but i think
934
# here we really do want to consolidate the whole thing.
935
for parent_id in other_tree.get_parent_ids():
936
self.branch.fetch(other_tree.branch, parent_id)
937
self.add_parent_tree_id(parent_id)
940
other_tree.bzrdir.retire_bzrdir()
942
@needs_tree_write_lock
943
def extract(self, file_id, format=None):
944
"""Extract a subtree from this tree.
946
A new branch will be created, relative to the path for this tree.
950
segments = osutils.splitpath(path)
951
transport = self.branch.bzrdir.root_transport
952
for name in segments:
953
transport = transport.clone(name)
956
except errors.FileExists:
960
sub_path = self.id2path(file_id)
961
branch_transport = mkdirs(sub_path)
963
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
965
branch_transport.mkdir('.')
966
except errors.FileExists:
968
branch_bzrdir = format.initialize_on_transport(branch_transport)
970
repo = branch_bzrdir.find_repository()
971
except errors.NoRepositoryPresent:
972
repo = branch_bzrdir.create_repository()
973
assert repo.supports_rich_root()
975
if not repo.supports_rich_root():
976
raise errors.RootNotRich()
977
new_branch = branch_bzrdir.create_branch()
978
new_branch.pull(self.branch)
979
for parent_id in self.get_parent_ids():
980
new_branch.fetch(self.branch, parent_id)
981
tree_transport = self.bzrdir.root_transport.clone(sub_path)
982
if tree_transport.base != branch_transport.base:
983
tree_bzrdir = format.initialize_on_transport(tree_transport)
984
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
986
tree_bzrdir = branch_bzrdir
987
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
988
wt.set_parent_ids(self.get_parent_ids())
989
my_inv = self.inventory
990
child_inv = Inventory(root_id=None)
991
new_root = my_inv[file_id]
992
my_inv.remove_recursive_id(file_id)
993
new_root.parent_id = None
994
child_inv.add(new_root)
995
self._write_inventory(my_inv)
996
wt._write_inventory(child_inv)
999
def _serialize(self, inventory, out_file):
1000
xml5.serializer_v5.write_inventory(self._inventory, out_file)
1002
def _deserialize(selt, in_file):
1003
return xml5.serializer_v5.read_inventory(in_file)
1006
"""Write the in memory inventory to disk."""
1007
# TODO: Maybe this should only write on dirty ?
1008
if self._control_files._lock_mode != 'w':
1009
raise errors.NotWriteLocked(self)
1011
self._serialize(self._inventory, sio)
1013
self._control_files.put('inventory', sio)
1014
self._inventory_is_modified = False
1016
def _kind(self, relpath):
1017
return osutils.file_kind(self.abspath(relpath))
1019
def list_files(self, include_root=False):
1020
"""Recursively list all files as (path, class, kind, id, entry).
1022
Lists, but does not descend into unversioned directories.
1024
This does not include files that have been deleted in this
1027
Skips the control directory.
1029
# list_files is an iterator, so @needs_read_lock doesn't work properly
1030
# with it. So callers should be careful to always read_lock the tree.
1031
if not self.is_locked():
1032
raise errors.ObjectNotLocked(self)
1034
inv = self.inventory
1035
if include_root is True:
1036
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1037
# Convert these into local objects to save lookup times
1038
pathjoin = osutils.pathjoin
1039
file_kind = self._kind
1041
# transport.base ends in a slash, we want the piece
1042
# between the last two slashes
1043
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1045
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1047
# directory file_id, relative path, absolute path, reverse sorted children
1048
children = os.listdir(self.basedir)
1050
# jam 20060527 The kernel sized tree seems equivalent whether we
1051
# use a deque and popleft to keep them sorted, or if we use a plain
1052
# list and just reverse() them.
1053
children = collections.deque(children)
1054
stack = [(inv.root.file_id, u'', self.basedir, children)]
1056
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1059
f = children.popleft()
1060
## TODO: If we find a subdirectory with its own .bzr
1061
## directory, then that is a separate tree and we
1062
## should exclude it.
1064
# the bzrdir for this tree
1065
if transport_base_dir == f:
1068
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1069
# and 'f' doesn't begin with one, we can do a string op, rather
1070
# than the checks of pathjoin(), all relative paths will have an extra slash
1072
fp = from_dir_relpath + '/' + f
1075
fap = from_dir_abspath + '/' + f
1077
f_ie = inv.get_child(from_dir_id, f)
1080
elif self.is_ignored(fp[1:]):
1083
# we may not have found this file, because of a unicode issue
1084
f_norm, can_access = osutils.normalized_filename(f)
1085
if f == f_norm or not can_access:
1086
# No change, so treat this file normally
1089
# this file can be accessed by a normalized path
1090
# check again if it is versioned
1091
# these lines are repeated here for performance
1093
fp = from_dir_relpath + '/' + f
1094
fap = from_dir_abspath + '/' + f
1095
f_ie = inv.get_child(from_dir_id, f)
1098
elif self.is_ignored(fp[1:]):
1105
# make a last minute entry
1107
yield fp[1:], c, fk, f_ie.file_id, f_ie
1110
yield fp[1:], c, fk, None, fk_entries[fk]()
1112
yield fp[1:], c, fk, None, TreeEntry()
1115
if fk != 'directory':
1118
# But do this child first
1119
new_children = os.listdir(fap)
1121
new_children = collections.deque(new_children)
1122
stack.append((f_ie.file_id, fp, fap, new_children))
1123
# Break out of inner loop,
1124
# so that we start outer loop with child
1127
# if we finished all children, pop it off the stack
1130
@needs_tree_write_lock
1131
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1134
to_dir must exist in the inventory.
1136
If to_dir exists and is a directory, the files are moved into
1137
it, keeping their old names.
1139
Note that to_dir is only the last component of the new name;
1140
this doesn't change the directory.
1142
For each entry in from_paths the move mode will be determined
1145
The first mode moves the file in the filesystem and updates the
1146
inventory. The second mode only updates the inventory without
1147
touching the file on the filesystem. This is the new mode introduced
1150
move uses the second mode if 'after == True' and the target is not
1151
versioned but present in the working tree.
1153
move uses the second mode if 'after == False' and the source is
1154
versioned but no longer in the working tree, and the target is not
1155
versioned but present in the working tree.
1157
move uses the first mode if 'after == False' and the source is
1158
versioned and present in the working tree, and the target is not
1159
versioned and not present in the working tree.
1161
Everything else results in an error.
1163
This returns a list of (from_path, to_path) pairs for each
1164
entry that is moved.
1169
# check for deprecated use of signature
1171
to_dir = kwargs.get('to_name', None)
1173
raise TypeError('You must supply a target directory')
1175
symbol_versioning.warn('The parameter to_name was deprecated'
1176
' in version 0.13. Use to_dir instead',
1179
# check destination directory
1180
assert not isinstance(from_paths, basestring)
1181
inv = self.inventory
1182
to_abs = self.abspath(to_dir)
1183
if not isdir(to_abs):
1184
raise errors.BzrMoveFailedError('',to_dir,
1185
errors.NotADirectory(to_abs))
1186
if not self.has_filename(to_dir):
1187
raise errors.BzrMoveFailedError('',to_dir,
1188
errors.NotInWorkingDirectory(to_dir))
1189
to_dir_id = inv.path2id(to_dir)
1190
if to_dir_id is None:
1191
raise errors.BzrMoveFailedError('',to_dir,
1192
errors.NotVersionedError(path=str(to_dir)))
1194
to_dir_ie = inv[to_dir_id]
1195
if to_dir_ie.kind != 'directory':
1196
raise errors.BzrMoveFailedError('',to_dir,
1197
errors.NotADirectory(to_abs))
1199
# create rename entries and tuples
1200
for from_rel in from_paths:
1201
from_tail = splitpath(from_rel)[-1]
1202
from_id = inv.path2id(from_rel)
1204
raise errors.BzrMoveFailedError(from_rel,to_dir,
1205
errors.NotVersionedError(path=str(from_rel)))
1207
from_entry = inv[from_id]
1208
from_parent_id = from_entry.parent_id
1209
to_rel = pathjoin(to_dir, from_tail)
1210
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1212
from_tail=from_tail,
1213
from_parent_id=from_parent_id,
1214
to_rel=to_rel, to_tail=from_tail,
1215
to_parent_id=to_dir_id)
1216
rename_entries.append(rename_entry)
1217
rename_tuples.append((from_rel, to_rel))
1219
# determine which move mode to use. checks also for movability
1220
rename_entries = self._determine_mv_mode(rename_entries, after)
1222
original_modified = self._inventory_is_modified
1225
self._inventory_is_modified = True
1226
self._move(rename_entries)
1228
# restore the inventory on error
1229
self._inventory_is_modified = original_modified
1231
self._write_inventory(inv)
1232
return rename_tuples
1234
def _determine_mv_mode(self, rename_entries, after=False):
1235
"""Determines for each from-to pair if both inventory and working tree
1236
or only the inventory has to be changed.
1238
Also does basic plausability tests.
1240
inv = self.inventory
1242
for rename_entry in rename_entries:
1243
# store to local variables for easier reference
1244
from_rel = rename_entry.from_rel
1245
from_id = rename_entry.from_id
1246
to_rel = rename_entry.to_rel
1247
to_id = inv.path2id(to_rel)
1248
only_change_inv = False
1250
# check the inventory for source and destination
1252
raise errors.BzrMoveFailedError(from_rel,to_rel,
1253
errors.NotVersionedError(path=str(from_rel)))
1254
if to_id is not None:
1255
raise errors.BzrMoveFailedError(from_rel,to_rel,
1256
errors.AlreadyVersionedError(path=str(to_rel)))
1258
# try to determine the mode for rename (only change inv or change
1259
# inv and file system)
1261
if not self.has_filename(to_rel):
1262
raise errors.BzrMoveFailedError(from_id,to_rel,
1263
errors.NoSuchFile(path=str(to_rel),
1264
extra="New file has not been created yet"))
1265
only_change_inv = True
1266
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1267
only_change_inv = True
1268
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1269
only_change_inv = False
1271
# something is wrong, so lets determine what exactly
1272
if not self.has_filename(from_rel) and \
1273
not self.has_filename(to_rel):
1274
raise errors.BzrRenameFailedError(from_rel,to_rel,
1275
errors.PathsDoNotExist(paths=(str(from_rel),
1278
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1279
extra="(Use --after to update the Bazaar id)")
1280
rename_entry.only_change_inv = only_change_inv
1281
return rename_entries
1283
def _move(self, rename_entries):
1284
"""Moves a list of files.
1286
Depending on the value of the flag 'only_change_inv', the
1287
file will be moved on the file system or not.
1289
inv = self.inventory
1292
for entry in rename_entries:
1294
self._move_entry(entry)
1296
self._rollback_move(moved)
1300
def _rollback_move(self, moved):
1301
"""Try to rollback a previous move in case of an filesystem error."""
1302
inv = self.inventory
1305
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1306
entry.to_tail, entry.to_parent_id, entry.from_rel,
1307
entry.from_tail, entry.from_parent_id,
1308
entry.only_change_inv))
1309
except errors.BzrMoveFailedError, e:
1310
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1311
" The working tree is in an inconsistent state."
1312
" Please consider doing a 'bzr revert'."
1313
" Error message is: %s" % e)
1315
def _move_entry(self, entry):
1316
inv = self.inventory
1317
from_rel_abs = self.abspath(entry.from_rel)
1318
to_rel_abs = self.abspath(entry.to_rel)
1319
if from_rel_abs == to_rel_abs:
1320
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1321
"Source and target are identical.")
1323
if not entry.only_change_inv:
1325
osutils.rename(from_rel_abs, to_rel_abs)
1327
raise errors.BzrMoveFailedError(entry.from_rel,
1329
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1331
@needs_tree_write_lock
1332
def rename_one(self, from_rel, to_rel, after=False):
1335
This can change the directory or the filename or both.
1337
rename_one has several 'modes' to work. First, it can rename a physical
1338
file and change the file_id. That is the normal mode. Second, it can
1339
only change the file_id without touching any physical file. This is
1340
the new mode introduced in version 0.15.
1342
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1343
versioned but present in the working tree.
1345
rename_one uses the second mode if 'after == False' and 'from_rel' is
1346
versioned but no longer in the working tree, and 'to_rel' is not
1347
versioned but present in the working tree.
1349
rename_one uses the first mode if 'after == False' and 'from_rel' is
1350
versioned and present in the working tree, and 'to_rel' is not
1351
versioned and not present in the working tree.
1353
Everything else results in an error.
1355
inv = self.inventory
1358
# create rename entries and tuples
1359
from_tail = splitpath(from_rel)[-1]
1360
from_id = inv.path2id(from_rel)
1362
raise errors.BzrRenameFailedError(from_rel,to_rel,
1363
errors.NotVersionedError(path=str(from_rel)))
1364
from_entry = inv[from_id]
1365
from_parent_id = from_entry.parent_id
1366
to_dir, to_tail = os.path.split(to_rel)
1367
to_dir_id = inv.path2id(to_dir)
1368
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1370
from_tail=from_tail,
1371
from_parent_id=from_parent_id,
1372
to_rel=to_rel, to_tail=to_tail,
1373
to_parent_id=to_dir_id)
1374
rename_entries.append(rename_entry)
1376
# determine which move mode to use. checks also for movability
1377
rename_entries = self._determine_mv_mode(rename_entries, after)
1379
# check if the target changed directory and if the target directory is
1381
if to_dir_id is None:
1382
raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
errors.NotVersionedError(path=str(to_dir)))
1385
# all checks done. now we can continue with our actual work
1386
mutter('rename_one:\n'
1391
' to_dir_id {%s}\n',
1392
from_id, from_rel, to_rel, to_dir, to_dir_id)
1394
self._move(rename_entries)
1395
self._write_inventory(inv)
1397
class _RenameEntry(object):
1398
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1399
to_rel, to_tail, to_parent_id, only_change_inv=False):
1400
self.from_rel = from_rel
1401
self.from_id = from_id
1402
self.from_tail = from_tail
1403
self.from_parent_id = from_parent_id
1404
self.to_rel = to_rel
1405
self.to_tail = to_tail
1406
self.to_parent_id = to_parent_id
1407
self.only_change_inv = only_change_inv
1411
"""Return all unknown files.
1413
These are files in the working directory that are not versioned or
1414
control files or ignored.
1416
# force the extras method to be fully executed before returning, to
1417
# prevent race conditions with the lock
1419
[subp for subp in self.extras() if not self.is_ignored(subp)])
1421
@needs_tree_write_lock
1422
def unversion(self, file_ids):
1423
"""Remove the file ids in file_ids from the current versioned set.
1425
When a file_id is unversioned, all of its children are automatically
1428
:param file_ids: The file ids to stop versioning.
1429
:raises: NoSuchId if any fileid is not currently versioned.
1431
for file_id in file_ids:
1432
file_id = osutils.safe_file_id(file_id)
1433
if self._inventory.has_id(file_id):
1434
self._inventory.remove_recursive_id(file_id)
1436
raise errors.NoSuchId(self, file_id)
1438
# in the future this should just set a dirty bit to wait for the
1439
# final unlock. However, until all methods of workingtree start
1440
# with the current in -memory inventory rather than triggering
1441
# a read, it is more complex - we need to teach read_inventory
1442
# to know when to read, and when to not read first... and possibly
1443
# to save first when the in memory one may be corrupted.
1444
# so for now, we just only write it if it is indeed dirty.
1446
self._write_inventory(self._inventory)
1448
@deprecated_method(zero_eight)
1449
def iter_conflicts(self):
1450
"""List all files in the tree that have text or content conflicts.
1451
DEPRECATED. Use conflicts instead."""
1452
return self._iter_conflicts()
1454
def _iter_conflicts(self):
1456
for info in self.list_files():
1458
stem = get_conflicted_stem(path)
1461
if stem not in conflicted:
1462
conflicted.add(stem)
1466
def pull(self, source, overwrite=False, stop_revision=None,
1467
change_reporter=None):
1468
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1471
pp = ProgressPhase("Pull phase", 2, top_pb)
1473
old_revision_info = self.branch.last_revision_info()
1474
basis_tree = self.basis_tree()
1475
count = self.branch.pull(source, overwrite, stop_revision)
1476
new_revision_info = self.branch.last_revision_info()
1477
if new_revision_info != old_revision_info:
1479
repository = self.branch.repository
1480
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1481
basis_tree.lock_read()
1483
new_basis_tree = self.branch.basis_tree()
1490
change_reporter=change_reporter)
1491
if (basis_tree.inventory.root is None and
1492
new_basis_tree.inventory.root is not None):
1493
self.set_root_id(new_basis_tree.inventory.root.file_id)
1497
# TODO - dedup parents list with things merged by pull ?
1498
# reuse the revisiontree we merged against to set the new
1500
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1501
# we have to pull the merge trees out again, because
1502
# merge_inner has set the ids. - this corner is not yet
1503
# layered well enough to prevent double handling.
1504
# XXX TODO: Fix the double handling: telling the tree about
1505
# the already known parent data is wasteful.
1506
merges = self.get_parent_ids()[1:]
1507
parent_trees.extend([
1508
(parent, repository.revision_tree(parent)) for
1510
self.set_parent_trees(parent_trees)
1517
def put_file_bytes_non_atomic(self, file_id, bytes):
1518
"""See MutableTree.put_file_bytes_non_atomic."""
1519
file_id = osutils.safe_file_id(file_id)
1520
stream = file(self.id2abspath(file_id), 'wb')
1525
# TODO: update the hashcache here ?
1528
"""Yield all unversioned files in this WorkingTree.
1530
If there are any unversioned directories then only the directory is
1531
returned, not all its children. But if there are unversioned files
1532
under a versioned subdirectory, they are returned.
1534
Currently returned depth-first, sorted by name within directories.
1535
This is the same order used by 'osutils.walkdirs'.
1537
## TODO: Work from given directory downwards
1538
for path, dir_entry in self.inventory.directories():
1539
# mutter("search for unknowns in %r", path)
1540
dirabs = self.abspath(path)
1541
if not isdir(dirabs):
1542
# e.g. directory deleted
1546
for subf in os.listdir(dirabs):
1549
if subf not in dir_entry.children:
1550
subf_norm, can_access = osutils.normalized_filename(subf)
1551
if subf_norm != subf and can_access:
1552
if subf_norm not in dir_entry.children:
1553
fl.append(subf_norm)
1559
subp = pathjoin(path, subf)
1562
def ignored_files(self):
1563
"""Yield list of PATH, IGNORE_PATTERN"""
1564
for subp in self.extras():
1565
pat = self.is_ignored(subp)
1569
def get_ignore_list(self):
1570
"""Return list of ignore patterns.
1572
Cached in the Tree object after the first call.
1574
ignoreset = getattr(self, '_ignoreset', None)
1575
if ignoreset is not None:
1578
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1579
ignore_globs.update(ignores.get_runtime_ignores())
1580
ignore_globs.update(ignores.get_user_ignores())
1581
if self.has_filename(bzrlib.IGNORE_FILENAME):
1582
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1584
ignore_globs.update(ignores.parse_ignore_file(f))
1587
self._ignoreset = ignore_globs
1590
def _flush_ignore_list_cache(self):
1591
"""Resets the cached ignore list to force a cache rebuild."""
1592
self._ignoreset = None
1593
self._ignoreglobster = None
1595
def is_ignored(self, filename):
1596
r"""Check whether the filename matches an ignore pattern.
1598
Patterns containing '/' or '\' need to match the whole path;
1599
others match against only the last component.
1601
If the file is ignored, returns the pattern which caused it to
1602
be ignored, otherwise None. So this can simply be used as a
1603
boolean if desired."""
1604
if getattr(self, '_ignoreglobster', None) is None:
1605
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1606
return self._ignoreglobster.match(filename)
1608
def kind(self, file_id):
1609
return file_kind(self.id2abspath(file_id))
1611
def _comparison_data(self, entry, path):
1612
abspath = self.abspath(path)
1614
stat_value = os.lstat(abspath)
1616
if getattr(e, 'errno', None) == errno.ENOENT:
1623
mode = stat_value.st_mode
1624
kind = osutils.file_kind_from_stat_mode(mode)
1625
if not supports_executable():
1626
executable = entry.executable
1628
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1629
return kind, executable, stat_value
1631
def _file_size(self, entry, stat_value):
1632
return stat_value.st_size
1634
def last_revision(self):
1635
"""Return the last revision of the branch for this tree.
1637
This format tree does not support a separate marker for last-revision
1638
compared to the branch.
1640
See MutableTree.last_revision
1642
return self._last_revision()
1645
def _last_revision(self):
1646
"""helper for get_parent_ids."""
1647
return self.branch.last_revision()
1649
def is_locked(self):
1650
return self._control_files.is_locked()
1652
def _must_be_locked(self):
1653
if not self.is_locked():
1654
raise errors.ObjectNotLocked(self)
1656
def lock_read(self):
1657
"""See Branch.lock_read, and WorkingTree.unlock."""
1658
if not self.is_locked():
1660
self.branch.lock_read()
1662
return self._control_files.lock_read()
1664
self.branch.unlock()
1667
def lock_tree_write(self):
1668
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1669
if not self.is_locked():
1671
self.branch.lock_read()
1673
return self._control_files.lock_write()
1675
self.branch.unlock()
1678
def lock_write(self):
1679
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1680
if not self.is_locked():
1682
self.branch.lock_write()
1684
return self._control_files.lock_write()
1686
self.branch.unlock()
1689
def get_physical_lock_status(self):
1690
return self._control_files.get_physical_lock_status()
1692
def _basis_inventory_name(self):
1693
return 'basis-inventory-cache'
1695
def _reset_data(self):
1696
"""Reset transient data that cannot be revalidated."""
1697
self._inventory_is_modified = False
1698
result = self._deserialize(self._control_files.get('inventory'))
1699
self._set_inventory(result, dirty=False)
1701
@needs_tree_write_lock
1702
def set_last_revision(self, new_revision):
1703
"""Change the last revision in the working tree."""
1704
new_revision = osutils.safe_revision_id(new_revision)
1705
if self._change_last_revision(new_revision):
1706
self._cache_basis_inventory(new_revision)
1708
def _change_last_revision(self, new_revision):
1709
"""Template method part of set_last_revision to perform the change.
1711
This is used to allow WorkingTree3 instances to not affect branch
1712
when their last revision is set.
1714
if new_revision is None:
1715
self.branch.set_revision_history([])
1718
self.branch.generate_revision_history(new_revision)
1719
except errors.NoSuchRevision:
1720
# not present in the repo - dont try to set it deeper than the tip
1721
self.branch.set_revision_history([new_revision])
1724
def _write_basis_inventory(self, xml):
1725
"""Write the basis inventory XML to the basis-inventory file"""
1726
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1727
path = self._basis_inventory_name()
1729
self._control_files.put(path, sio)
1731
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1732
"""Create the text that will be saved in basis-inventory"""
1733
# TODO: jam 20070209 This should be redundant, as the revision_id
1734
# as all callers should have already converted the revision_id to
1736
inventory.revision_id = osutils.safe_revision_id(revision_id)
1737
return xml7.serializer_v7.write_inventory_to_string(inventory)
1739
def _cache_basis_inventory(self, new_revision):
1740
"""Cache new_revision as the basis inventory."""
1741
# TODO: this should allow the ready-to-use inventory to be passed in,
1742
# as commit already has that ready-to-use [while the format is the
1745
# this double handles the inventory - unpack and repack -
1746
# but is easier to understand. We can/should put a conditional
1747
# in here based on whether the inventory is in the latest format
1748
# - perhaps we should repack all inventories on a repository
1750
# the fast path is to copy the raw xml from the repository. If the
1751
# xml contains 'revision_id="', then we assume the right
1752
# revision_id is set. We must check for this full string, because a
1753
# root node id can legitimately look like 'revision_id' but cannot
1755
xml = self.branch.repository.get_inventory_xml(new_revision)
1756
firstline = xml.split('\n', 1)[0]
1757
if (not 'revision_id="' in firstline or
1758
'format="7"' not in firstline):
1759
inv = self.branch.repository.deserialise_inventory(
1761
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1762
self._write_basis_inventory(xml)
1763
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1766
def read_basis_inventory(self):
1767
"""Read the cached basis inventory."""
1768
path = self._basis_inventory_name()
1769
return self._control_files.get(path).read()
1772
def read_working_inventory(self):
1773
"""Read the working inventory.
1775
:raises errors.InventoryModified: read_working_inventory will fail
1776
when the current in memory inventory has been modified.
1778
# conceptually this should be an implementation detail of the tree.
1779
# XXX: Deprecate this.
1780
# ElementTree does its own conversion from UTF-8, so open in
1782
if self._inventory_is_modified:
1783
raise errors.InventoryModified(self)
1784
result = self._deserialize(self._control_files.get('inventory'))
1785
self._set_inventory(result, dirty=False)
1788
@needs_tree_write_lock
1789
def remove(self, files, verbose=False, to_file=None):
1790
"""Remove nominated files from the working inventory..
1792
This does not remove their text. This does not run on XXX on what? RBC
1794
TODO: Refuse to remove modified files unless --force is given?
1796
TODO: Do something useful with directories.
1798
TODO: Should this remove the text or not? Tough call; not
1799
removing may be useful and the user can just use use rm, and
1800
is the opposite of add. Removing it is consistent with most
1801
other tools. Maybe an option.
1803
## TODO: Normalize names
1804
## TODO: Remove nested loops; better scalability
1805
if isinstance(files, basestring):
1808
inv = self.inventory
1810
# do this before any modifications
1812
fid = inv.path2id(f)
1814
note("%s is not versioned."%f)
1817
# having remove it, it must be either ignored or unknown
1818
if self.is_ignored(f):
1822
textui.show_status(new_status, inv[fid].kind, f,
1826
self._write_inventory(inv)
1828
@needs_tree_write_lock
1829
def revert(self, filenames, old_tree=None, backups=True,
1830
pb=DummyProgress(), report_changes=False):
1831
from bzrlib.conflicts import resolve
1832
if old_tree is None:
1833
old_tree = self.basis_tree()
1834
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1836
if not len(filenames):
1837
self.set_parent_ids(self.get_parent_ids()[:1])
1840
resolve(self, filenames, ignore_misses=True)
1843
def revision_tree(self, revision_id):
1844
"""See Tree.revision_tree.
1846
WorkingTree can supply revision_trees for the basis revision only
1847
because there is only one cached inventory in the bzr directory.
1849
if revision_id == self.last_revision():
1851
xml = self.read_basis_inventory()
1852
except errors.NoSuchFile:
1856
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1857
# dont use the repository revision_tree api because we want
1858
# to supply the inventory.
1859
if inv.revision_id == revision_id:
1860
return revisiontree.RevisionTree(self.branch.repository,
1862
except errors.BadInventoryFormat:
1864
# raise if there was no inventory, or if we read the wrong inventory.
1865
raise errors.NoSuchRevisionInTree(self, revision_id)
1867
# XXX: This method should be deprecated in favour of taking in a proper
1868
# new Inventory object.
1869
@needs_tree_write_lock
1870
def set_inventory(self, new_inventory_list):
1871
from bzrlib.inventory import (Inventory,
1876
inv = Inventory(self.get_root_id())
1877
for path, file_id, parent, kind in new_inventory_list:
1878
name = os.path.basename(path)
1881
# fixme, there should be a factory function inv,add_??
1882
if kind == 'directory':
1883
inv.add(InventoryDirectory(file_id, name, parent))
1884
elif kind == 'file':
1885
inv.add(InventoryFile(file_id, name, parent))
1886
elif kind == 'symlink':
1887
inv.add(InventoryLink(file_id, name, parent))
1889
raise errors.BzrError("unknown kind %r" % kind)
1890
self._write_inventory(inv)
1892
@needs_tree_write_lock
1893
def set_root_id(self, file_id):
1894
"""Set the root id for this tree."""
1897
symbol_versioning.warn(symbol_versioning.zero_twelve
1898
% 'WorkingTree.set_root_id with fileid=None',
1903
file_id = osutils.safe_file_id(file_id)
1904
self._set_root_id(file_id)
1906
def _set_root_id(self, file_id):
1907
"""Set the root id for this tree, in a format specific manner.
1909
:param file_id: The file id to assign to the root. It must not be
1910
present in the current inventory or an error will occur. It must
1911
not be None, but rather a valid file id.
1913
inv = self._inventory
1914
orig_root_id = inv.root.file_id
1915
# TODO: it might be nice to exit early if there was nothing
1916
# to do, saving us from trigger a sync on unlock.
1917
self._inventory_is_modified = True
1918
# we preserve the root inventory entry object, but
1919
# unlinkit from the byid index
1920
del inv._byid[inv.root.file_id]
1921
inv.root.file_id = file_id
1922
# and link it into the index with the new changed id.
1923
inv._byid[inv.root.file_id] = inv.root
1924
# and finally update all children to reference the new id.
1925
# XXX: this should be safe to just look at the root.children
1926
# list, not the WHOLE INVENTORY.
1929
if entry.parent_id == orig_root_id:
1930
entry.parent_id = inv.root.file_id
1933
"""See Branch.unlock.
1935
WorkingTree locking just uses the Branch locking facilities.
1936
This is current because all working trees have an embedded branch
1937
within them. IF in the future, we were to make branch data shareable
1938
between multiple working trees, i.e. via shared storage, then we
1939
would probably want to lock both the local tree, and the branch.
1941
raise NotImplementedError(self.unlock)
1944
"""Update a working tree along its branch.
1946
This will update the branch if its bound too, which means we have
1947
multiple trees involved:
1949
- The new basis tree of the master.
1950
- The old basis tree of the branch.
1951
- The old basis tree of the working tree.
1952
- The current working tree state.
1954
Pathologically, all three may be different, and non-ancestors of each
1955
other. Conceptually we want to:
1957
- Preserve the wt.basis->wt.state changes
1958
- Transform the wt.basis to the new master basis.
1959
- Apply a merge of the old branch basis to get any 'local' changes from
1961
- Restore the wt.basis->wt.state changes.
1963
There isn't a single operation at the moment to do that, so we:
1964
- Merge current state -> basis tree of the master w.r.t. the old tree
1966
- Do a 'normal' merge of the old branch basis if it is relevant.
1968
if self.branch.get_master_branch() is not None:
1970
update_branch = True
1972
self.lock_tree_write()
1973
update_branch = False
1976
old_tip = self.branch.update()
1979
return self._update_tree(old_tip)
1983
@needs_tree_write_lock
1984
def _update_tree(self, old_tip=None):
1985
"""Update a tree to the master branch.
1987
:param old_tip: if supplied, the previous tip revision the branch,
1988
before it was changed to the master branch's tip.
1990
# here if old_tip is not None, it is the old tip of the branch before
1991
# it was updated from the master branch. This should become a pending
1992
# merge in the working tree to preserve the user existing work. we
1993
# cant set that until we update the working trees last revision to be
1994
# one from the new branch, because it will just get absorbed by the
1995
# parent de-duplication logic.
1997
# We MUST save it even if an error occurs, because otherwise the users
1998
# local work is unreferenced and will appear to have been lost.
2002
last_rev = self.get_parent_ids()[0]
2005
if last_rev != self.branch.last_revision():
2006
# merge tree state up to new branch tip.
2007
basis = self.basis_tree()
2010
to_tree = self.branch.basis_tree()
2011
if basis.inventory.root is None:
2012
self.set_root_id(to_tree.inventory.root.file_id)
2014
result += merge.merge_inner(
2021
# TODO - dedup parents list with things merged by pull ?
2022
# reuse the tree we've updated to to set the basis:
2023
parent_trees = [(self.branch.last_revision(), to_tree)]
2024
merges = self.get_parent_ids()[1:]
2025
# Ideally we ask the tree for the trees here, that way the working
2026
# tree can decide whether to give us teh entire tree or give us a
2027
# lazy initialised tree. dirstate for instance will have the trees
2028
# in ram already, whereas a last-revision + basis-inventory tree
2029
# will not, but also does not need them when setting parents.
2030
for parent in merges:
2031
parent_trees.append(
2032
(parent, self.branch.repository.revision_tree(parent)))
2033
if old_tip is not None:
2034
parent_trees.append(
2035
(old_tip, self.branch.repository.revision_tree(old_tip)))
2036
self.set_parent_trees(parent_trees)
2037
last_rev = parent_trees[0][0]
2039
# the working tree had the same last-revision as the master
2040
# branch did. We may still have pivot local work from the local
2041
# branch into old_tip:
2042
if old_tip is not None:
2043
self.add_parent_tree_id(old_tip)
2044
if old_tip and old_tip != last_rev:
2045
# our last revision was not the prior branch last revision
2046
# and we have converted that last revision to a pending merge.
2047
# base is somewhere between the branch tip now
2048
# and the now pending merge
2050
# Since we just modified the working tree and inventory, flush out
2051
# the current state, before we modify it again.
2052
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2053
# requires it only because TreeTransform directly munges the
2054
# inventory and calls tree._write_inventory(). Ultimately we
2055
# should be able to remove this extra flush.
2057
from bzrlib.revision import common_ancestor
2059
base_rev_id = common_ancestor(self.branch.last_revision(),
2061
self.branch.repository)
2062
except errors.NoCommonAncestor:
2064
base_tree = self.branch.repository.revision_tree(base_rev_id)
2065
other_tree = self.branch.repository.revision_tree(old_tip)
2066
result += merge.merge_inner(
2073
def _write_hashcache_if_dirty(self):
2074
"""Write out the hashcache if it is dirty."""
2075
if self._hashcache.needs_write:
2077
self._hashcache.write()
2079
if e.errno not in (errno.EPERM, errno.EACCES):
2081
# TODO: jam 20061219 Should this be a warning? A single line
2082
# warning might be sufficient to let the user know what
2084
mutter('Could not write hashcache for %s\nError: %s',
2085
self._hashcache.cache_file_name(), e)
2087
@needs_tree_write_lock
2088
def _write_inventory(self, inv):
2089
"""Write inventory as the current inventory."""
2090
self._set_inventory(inv, dirty=True)
2093
def set_conflicts(self, arg):
2094
raise errors.UnsupportedOperation(self.set_conflicts, self)
2096
def add_conflicts(self, arg):
2097
raise errors.UnsupportedOperation(self.add_conflicts, self)
2100
def conflicts(self):
2101
conflicts = _mod_conflicts.ConflictList()
2102
for conflicted in self._iter_conflicts():
2105
if file_kind(self.abspath(conflicted)) != "file":
2107
except errors.NoSuchFile:
2110
for suffix in ('.THIS', '.OTHER'):
2112
kind = file_kind(self.abspath(conflicted+suffix))
2115
except errors.NoSuchFile:
2119
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2120
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2122
file_id=self.path2id(conflicted)))
2125
def walkdirs(self, prefix=""):
2126
"""Walk the directories of this tree.
2128
This API returns a generator, which is only valid during the current
2129
tree transaction - within a single lock_read or lock_write duration.
2131
If the tree is not locked, it may cause an error to be raised, depending
2132
on the tree implementation.
2134
disk_top = self.abspath(prefix)
2135
if disk_top.endswith('/'):
2136
disk_top = disk_top[:-1]
2137
top_strip_len = len(disk_top) + 1
2138
inventory_iterator = self._walkdirs(prefix)
2139
disk_iterator = osutils.walkdirs(disk_top, prefix)
2141
current_disk = disk_iterator.next()
2142
disk_finished = False
2144
if e.errno != errno.ENOENT:
2147
disk_finished = True
2149
current_inv = inventory_iterator.next()
2150
inv_finished = False
2151
except StopIteration:
2154
while not inv_finished or not disk_finished:
2155
if not disk_finished:
2156
# strip out .bzr dirs
2157
if current_disk[0][1][top_strip_len:] == '':
2158
# osutils.walkdirs can be made nicer -
2159
# yield the path-from-prefix rather than the pathjoined
2161
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2162
if current_disk[1][bzrdir_loc][0] == '.bzr':
2163
# we dont yield the contents of, or, .bzr itself.
2164
del current_disk[1][bzrdir_loc]
2166
# everything is unknown
2169
# everything is missing
2172
direction = cmp(current_inv[0][0], current_disk[0][0])
2174
# disk is before inventory - unknown
2175
dirblock = [(relpath, basename, kind, stat, None, None) for
2176
relpath, basename, kind, stat, top_path in current_disk[1]]
2177
yield (current_disk[0][0], None), dirblock
2179
current_disk = disk_iterator.next()
2180
except StopIteration:
2181
disk_finished = True
2183
# inventory is before disk - missing.
2184
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2185
for relpath, basename, dkind, stat, fileid, kind in
2187
yield (current_inv[0][0], current_inv[0][1]), dirblock
2189
current_inv = inventory_iterator.next()
2190
except StopIteration:
2193
# versioned present directory
2194
# merge the inventory and disk data together
2196
for relpath, subiterator in itertools.groupby(sorted(
2197
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2198
path_elements = list(subiterator)
2199
if len(path_elements) == 2:
2200
inv_row, disk_row = path_elements
2201
# versioned, present file
2202
dirblock.append((inv_row[0],
2203
inv_row[1], disk_row[2],
2204
disk_row[3], inv_row[4],
2206
elif len(path_elements[0]) == 5:
2208
dirblock.append((path_elements[0][0],
2209
path_elements[0][1], path_elements[0][2],
2210
path_elements[0][3], None, None))
2211
elif len(path_elements[0]) == 6:
2212
# versioned, absent file.
2213
dirblock.append((path_elements[0][0],
2214
path_elements[0][1], 'unknown', None,
2215
path_elements[0][4], path_elements[0][5]))
2217
raise NotImplementedError('unreachable code')
2218
yield current_inv[0], dirblock
2220
current_inv = inventory_iterator.next()
2221
except StopIteration:
2224
current_disk = disk_iterator.next()
2225
except StopIteration:
2226
disk_finished = True
2228
def _walkdirs(self, prefix=""):
2229
_directory = 'directory'
2230
# get the root in the inventory
2231
inv = self.inventory
2232
top_id = inv.path2id(prefix)
2236
pending = [(prefix, '', _directory, None, top_id, None)]
2239
currentdir = pending.pop()
2240
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2241
top_id = currentdir[4]
2243
relroot = currentdir[0] + '/'
2246
# FIXME: stash the node in pending
2248
for name, child in entry.sorted_children():
2249
dirblock.append((relroot + name, name, child.kind, None,
2250
child.file_id, child.kind
2252
yield (currentdir[0], entry.file_id), dirblock
2253
# push the user specified dirs from dirblock
2254
for dir in reversed(dirblock):
2255
if dir[2] == _directory:
2258
@needs_tree_write_lock
2259
def auto_resolve(self):
2260
"""Automatically resolve text conflicts according to contents.
2262
Only text conflicts are auto_resolvable. Files with no conflict markers
2263
are considered 'resolved', because bzr always puts conflict markers
2264
into files that have text conflicts. The corresponding .THIS .BASE and
2265
.OTHER files are deleted, as per 'resolve'.
2266
:return: a tuple of ConflictLists: (un_resolved, resolved).
2268
un_resolved = _mod_conflicts.ConflictList()
2269
resolved = _mod_conflicts.ConflictList()
2270
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2271
for conflict in self.conflicts():
2272
if (conflict.typestring != 'text conflict' or
2273
self.kind(conflict.file_id) != 'file'):
2274
un_resolved.append(conflict)
2276
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2278
for line in my_file:
2279
if conflict_re.search(line):
2280
un_resolved.append(conflict)
2283
resolved.append(conflict)
2286
resolved.remove_files(self)
2287
self.set_conflicts(un_resolved)
2288
return un_resolved, resolved
2291
class WorkingTree2(WorkingTree):
2292
"""This is the Format 2 working tree.
2294
This was the first weave based working tree.
2295
- uses os locks for locking.
2296
- uses the branch last-revision.
2299
def lock_tree_write(self):
2300
"""See WorkingTree.lock_tree_write().
2302
In Format2 WorkingTrees we have a single lock for the branch and tree
2303
so lock_tree_write() degrades to lock_write().
2305
self.branch.lock_write()
2307
return self._control_files.lock_write()
2309
self.branch.unlock()
2313
# we share control files:
2314
if self._control_files._lock_count == 3:
2315
# _inventory_is_modified is always False during a read lock.
2316
if self._inventory_is_modified:
2318
self._write_hashcache_if_dirty()
2320
# reverse order of locking.
2322
return self._control_files.unlock()
2324
self.branch.unlock()
2327
class WorkingTree3(WorkingTree):
2328
"""This is the Format 3 working tree.
2330
This differs from the base WorkingTree by:
2331
- having its own file lock
2332
- having its own last-revision property.
2334
This is new in bzr 0.8
2338
def _last_revision(self):
2339
"""See Mutable.last_revision."""
2341
return osutils.safe_revision_id(
2342
self._control_files.get('last-revision').read())
2343
except errors.NoSuchFile:
2346
def _change_last_revision(self, revision_id):
2347
"""See WorkingTree._change_last_revision."""
2348
if revision_id is None or revision_id == NULL_REVISION:
2350
self._control_files._transport.delete('last-revision')
2351
except errors.NoSuchFile:
2355
self._control_files.put_bytes('last-revision', revision_id)
2358
@needs_tree_write_lock
2359
def set_conflicts(self, conflicts):
2360
self._put_rio('conflicts', conflicts.to_stanzas(),
2363
@needs_tree_write_lock
2364
def add_conflicts(self, new_conflicts):
2365
conflict_set = set(self.conflicts())
2366
conflict_set.update(set(list(new_conflicts)))
2367
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2368
key=_mod_conflicts.Conflict.sort_key)))
2371
def conflicts(self):
2373
confile = self._control_files.get('conflicts')
2374
except errors.NoSuchFile:
2375
return _mod_conflicts.ConflictList()
2377
if confile.next() != CONFLICT_HEADER_1 + '\n':
2378
raise errors.ConflictFormatError()
2379
except StopIteration:
2380
raise errors.ConflictFormatError()
2381
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2384
if self._control_files._lock_count == 1:
2385
# _inventory_is_modified is always False during a read lock.
2386
if self._inventory_is_modified:
2388
self._write_hashcache_if_dirty()
2389
# reverse order of locking.
2391
return self._control_files.unlock()
2393
self.branch.unlock()
2396
def get_conflicted_stem(path):
2397
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2398
if path.endswith(suffix):
2399
return path[:-len(suffix)]
2402
@deprecated_function(zero_eight)
2403
def is_control_file(filename):
2404
"""See WorkingTree.is_control_filename(filename)."""
2405
## FIXME: better check
2406
filename = normpath(filename)
2407
while filename != '':
2408
head, tail = os.path.split(filename)
2409
## mutter('check %r for control file' % ((head, tail),))
2412
if filename == head:
2418
class WorkingTreeFormat(object):
2419
"""An encapsulation of the initialization and open routines for a format.
2421
Formats provide three things:
2422
* An initialization routine,
2426
Formats are placed in an dict by their format string for reference
2427
during workingtree opening. Its not required that these be instances, they
2428
can be classes themselves with class methods - it simply depends on
2429
whether state is needed for a given format or not.
2431
Once a format is deprecated, just deprecate the initialize and open
2432
methods on the format class. Do not deprecate the object, as the
2433
object will be created every time regardless.
2436
_default_format = None
2437
"""The default format used for new trees."""
2440
"""The known formats."""
2442
requires_rich_root = False
2445
def find_format(klass, a_bzrdir):
2446
"""Return the format for the working tree object in a_bzrdir."""
2448
transport = a_bzrdir.get_workingtree_transport(None)
2449
format_string = transport.get("format").read()
2450
return klass._formats[format_string]
2451
except errors.NoSuchFile:
2452
raise errors.NoWorkingTree(base=transport.base)
2454
raise errors.UnknownFormatError(format=format_string)
2456
def __eq__(self, other):
2457
return self.__class__ is other.__class__
2459
def __ne__(self, other):
2460
return not (self == other)
2463
def get_default_format(klass):
2464
"""Return the current default format."""
2465
return klass._default_format
2467
def get_format_string(self):
2468
"""Return the ASCII format string that identifies this format."""
2469
raise NotImplementedError(self.get_format_string)
2471
def get_format_description(self):
2472
"""Return the short description for this format."""
2473
raise NotImplementedError(self.get_format_description)
2475
def is_supported(self):
2476
"""Is this format supported?
2478
Supported formats can be initialized and opened.
2479
Unsupported formats may not support initialization or committing or
2480
some other features depending on the reason for not being supported.
2485
def register_format(klass, format):
2486
klass._formats[format.get_format_string()] = format
2489
def set_default_format(klass, format):
2490
klass._default_format = format
2493
def unregister_format(klass, format):
2494
assert klass._formats[format.get_format_string()] is format
2495
del klass._formats[format.get_format_string()]
2499
class WorkingTreeFormat2(WorkingTreeFormat):
2500
"""The second working tree format.
2502
This format modified the hash cache from the format 1 hash cache.
2505
def get_format_description(self):
2506
"""See WorkingTreeFormat.get_format_description()."""
2507
return "Working tree format 2"
2509
def stub_initialize_remote(self, control_files):
2510
"""As a special workaround create critical control files for a remote working tree
2512
This ensures that it can later be updated and dealt with locally,
2513
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2514
no working tree. (See bug #43064).
2518
xml5.serializer_v5.write_inventory(inv, sio)
2520
control_files.put('inventory', sio)
2522
control_files.put_bytes('pending-merges', '')
2525
def initialize(self, a_bzrdir, revision_id=None):
2526
"""See WorkingTreeFormat.initialize()."""
2527
if not isinstance(a_bzrdir.transport, LocalTransport):
2528
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2529
branch = a_bzrdir.open_branch()
2530
if revision_id is not None:
2531
revision_id = osutils.safe_revision_id(revision_id)
2534
revision_history = branch.revision_history()
2536
position = revision_history.index(revision_id)
2538
raise errors.NoSuchRevision(branch, revision_id)
2539
branch.set_revision_history(revision_history[:position + 1])
2542
revision = branch.last_revision()
2544
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2550
basis_tree = branch.repository.revision_tree(revision)
2551
if basis_tree.inventory.root is not None:
2552
wt.set_root_id(basis_tree.inventory.root.file_id)
2553
# set the parent list and cache the basis tree.
2554
wt.set_parent_trees([(revision, basis_tree)])
2555
transform.build_tree(basis_tree, wt)
2559
super(WorkingTreeFormat2, self).__init__()
2560
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2562
def open(self, a_bzrdir, _found=False):
2563
"""Return the WorkingTree object for a_bzrdir
2565
_found is a private parameter, do not use it. It is used to indicate
2566
if format probing has already been done.
2569
# we are being called directly and must probe.
2570
raise NotImplementedError
2571
if not isinstance(a_bzrdir.transport, LocalTransport):
2572
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2573
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2579
class WorkingTreeFormat3(WorkingTreeFormat):
2580
"""The second working tree format updated to record a format marker.
2583
- exists within a metadir controlling .bzr
2584
- includes an explicit version marker for the workingtree control
2585
files, separate from the BzrDir format
2586
- modifies the hash cache format
2588
- uses a LockDir to guard access for writes.
2591
def get_format_string(self):
2592
"""See WorkingTreeFormat.get_format_string()."""
2593
return "Bazaar-NG Working Tree format 3"
2595
def get_format_description(self):
2596
"""See WorkingTreeFormat.get_format_description()."""
2597
return "Working tree format 3"
2599
_lock_file_name = 'lock'
2600
_lock_class = LockDir
2602
_tree_class = WorkingTree3
2604
def __get_matchingbzrdir(self):
2605
return bzrdir.BzrDirMetaFormat1()
2607
_matchingbzrdir = property(__get_matchingbzrdir)
2609
def _open_control_files(self, a_bzrdir):
2610
transport = a_bzrdir.get_workingtree_transport(None)
2611
return LockableFiles(transport, self._lock_file_name,
2614
def initialize(self, a_bzrdir, revision_id=None):
2615
"""See WorkingTreeFormat.initialize().
2617
revision_id allows creating a working tree at a different
2618
revision than the branch is at.
2620
if not isinstance(a_bzrdir.transport, LocalTransport):
2621
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2622
transport = a_bzrdir.get_workingtree_transport(self)
2623
control_files = self._open_control_files(a_bzrdir)
2624
control_files.create_lock()
2625
control_files.lock_write()
2626
control_files.put_utf8('format', self.get_format_string())
2627
branch = a_bzrdir.open_branch()
2628
if revision_id is None:
2629
revision_id = branch.last_revision()
2631
revision_id = osutils.safe_revision_id(revision_id)
2632
# WorkingTree3 can handle an inventory which has a unique root id.
2633
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2634
# those trees. And because there isn't a format bump inbetween, we
2635
# are maintaining compatibility with older clients.
2636
# inv = Inventory(root_id=gen_root_id())
2637
inv = self._initial_inventory()
2638
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2644
_control_files=control_files)
2645
wt.lock_tree_write()
2647
basis_tree = branch.repository.revision_tree(revision_id)
2648
# only set an explicit root id if there is one to set.
2649
if basis_tree.inventory.root is not None:
2650
wt.set_root_id(basis_tree.inventory.root.file_id)
2651
if revision_id == NULL_REVISION:
2652
wt.set_parent_trees([])
2654
wt.set_parent_trees([(revision_id, basis_tree)])
2655
transform.build_tree(basis_tree, wt)
2657
# Unlock in this order so that the unlock-triggers-flush in
2658
# WorkingTree is given a chance to fire.
2659
control_files.unlock()
2663
def _initial_inventory(self):
2667
super(WorkingTreeFormat3, self).__init__()
2669
def open(self, a_bzrdir, _found=False):
2670
"""Return the WorkingTree object for a_bzrdir
2672
_found is a private parameter, do not use it. It is used to indicate
2673
if format probing has already been done.
2676
# we are being called directly and must probe.
2677
raise NotImplementedError
2678
if not isinstance(a_bzrdir.transport, LocalTransport):
2679
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2680
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2682
def _open(self, a_bzrdir, control_files):
2683
"""Open the tree itself.
2685
:param a_bzrdir: the dir for the tree.
2686
:param control_files: the control files for the tree.
2688
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2692
_control_files=control_files)
2695
return self.get_format_string()
2698
__default_format = WorkingTreeFormat4()
2699
WorkingTreeFormat.register_format(__default_format)
2700
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2701
WorkingTreeFormat.set_default_format(__default_format)
2702
# formats which have no format string are not discoverable
2703
# and not independently creatable, so are not registered.
2704
_legacy_formats = [WorkingTreeFormat2(),
2708
class WorkingTreeTestProviderAdapter(object):
2709
"""A tool to generate a suite testing multiple workingtree formats at once.
2711
This is done by copying the test once for each transport and injecting
2712
the transport_server, transport_readonly_server, and workingtree_format
2713
classes into each copy. Each copy is also given a new id() to make it
2717
def __init__(self, transport_server, transport_readonly_server, formats):
2718
self._transport_server = transport_server
2719
self._transport_readonly_server = transport_readonly_server
2720
self._formats = formats
2722
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2723
"""Clone test for adaption."""
2724
new_test = deepcopy(test)
2725
new_test.transport_server = self._transport_server
2726
new_test.transport_readonly_server = self._transport_readonly_server
2727
new_test.bzrdir_format = bzrdir_format
2728
new_test.workingtree_format = workingtree_format
2729
def make_new_test_id():
2730
new_id = "%s(%s)" % (test.id(), variation)
2731
return lambda: new_id
2732
new_test.id = make_new_test_id()
2735
def adapt(self, test):
2736
from bzrlib.tests import TestSuite
2737
result = TestSuite()
2738
for workingtree_format, bzrdir_format in self._formats:
2739
new_test = self._clone_test(
2742
workingtree_format, workingtree_format.__class__.__name__)
2743
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
