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
# This will be acquired on lock_read() or lock_write()
281
self._inventory_is_modified = False
282
self._inventory = None
284
# the caller of __init__ has provided an inventory,
285
# we assume they know what they are doing - as its only
286
# the Format factory and creation methods that are
287
# permitted to do this.
288
self._set_inventory(_inventory, dirty=False)
291
fget=lambda self: self._branch,
292
doc="""The branch this WorkingTree is connected to.
294
This cannot be set - it is reflective of the actual disk structure
295
the working tree has been constructed from.
298
def break_lock(self):
299
"""Break a lock if one is present from another instance.
301
Uses the ui factory to ask for confirmation if the lock may be from
304
This will probe the repository for its lock as well.
306
self._control_files.break_lock()
307
self.branch.break_lock()
309
def requires_rich_root(self):
310
return self._format.requires_rich_root
312
def supports_tree_reference(self):
315
def _set_inventory(self, inv, dirty):
316
"""Set the internal cached inventory.
318
:param inv: The inventory to set.
319
:param dirty: A boolean indicating whether the inventory is the same
320
logical inventory as whats on disk. If True the inventory is not
321
the same and should be written to disk or data will be lost, if
322
False then the inventory is the same as that on disk and any
323
serialisation would be unneeded overhead.
325
assert inv.root is not None
326
self._inventory = inv
327
self._inventory_is_modified = dirty
330
def open(path=None, _unsupported=False):
331
"""Open an existing working tree at path.
335
path = os.path.getcwdu()
336
control = bzrdir.BzrDir.open(path, _unsupported)
337
return control.open_workingtree(_unsupported)
340
def open_containing(path=None):
341
"""Open an existing working tree which has its root about path.
343
This probes for a working tree at path and searches upwards from there.
345
Basically we keep looking up until we find the control directory or
346
run into /. If there isn't one, raises NotBranchError.
347
TODO: give this a new exception.
348
If there is one, it is returned, along with the unused portion of path.
350
:return: The WorkingTree that contains 'path', and the rest of path
353
path = osutils.getcwd()
354
control, relpath = bzrdir.BzrDir.open_containing(path)
356
return control.open_workingtree(), relpath
359
def open_downlevel(path=None):
360
"""Open an unsupported working tree.
362
Only intended for advanced situations like upgrading part of a bzrdir.
364
return WorkingTree.open(path, _unsupported=True)
366
# should be deprecated - this is slow and in any case treating them as a
367
# container is (we now know) bad style -- mbp 20070302
368
## @deprecated_method(zero_fifteen)
370
"""Iterate through file_ids for this tree.
372
file_ids are in a WorkingTree if they are in the working inventory
373
and the working file exists.
375
inv = self._inventory
376
for path, ie in inv.iter_entries():
377
if osutils.lexists(self.abspath(path)):
381
return "<%s of %s>" % (self.__class__.__name__,
382
getattr(self, 'basedir', None))
384
def abspath(self, filename):
385
return pathjoin(self.basedir, filename)
387
def basis_tree(self):
388
"""Return RevisionTree for the current last revision.
390
If the left most parent is a ghost then the returned tree will be an
391
empty tree - one obtained by calling repository.revision_tree(None).
394
revision_id = self.get_parent_ids()[0]
396
# no parents, return an empty revision tree.
397
# in the future this should return the tree for
398
# 'empty:' - the implicit root empty tree.
399
return self.branch.repository.revision_tree(None)
401
return self.revision_tree(revision_id)
402
except errors.NoSuchRevision:
404
# No cached copy available, retrieve from the repository.
405
# FIXME? RBC 20060403 should we cache the inventory locally
408
return self.branch.repository.revision_tree(revision_id)
409
except errors.RevisionNotPresent:
410
# the basis tree *may* be a ghost or a low level error may have
411
# occured. If the revision is present, its a problem, if its not
413
if self.branch.repository.has_revision(revision_id):
415
# the basis tree is a ghost so return an empty tree.
416
return self.branch.repository.revision_tree(None)
419
@deprecated_method(zero_eight)
420
def create(branch, directory):
421
"""Create a workingtree for branch at directory.
423
If existing_directory already exists it must have a .bzr directory.
424
If it does not exist, it will be created.
426
This returns a new WorkingTree object for the new checkout.
428
TODO FIXME RBC 20060124 when we have checkout formats in place this
429
should accept an optional revisionid to checkout [and reject this if
430
checking out into the same dir as a pre-checkout-aware branch format.]
432
XXX: When BzrDir is present, these should be created through that
435
warnings.warn('delete WorkingTree.create', stacklevel=3)
436
transport = get_transport(directory)
437
if branch.bzrdir.root_transport.base == transport.base:
439
return branch.bzrdir.create_workingtree()
440
# different directory,
441
# create a branch reference
442
# and now a working tree.
443
raise NotImplementedError
446
@deprecated_method(zero_eight)
447
def create_standalone(directory):
448
"""Create a checkout and a branch and a repo at directory.
450
Directory must exist and be empty.
452
please use BzrDir.create_standalone_workingtree
454
return bzrdir.BzrDir.create_standalone_workingtree(directory)
456
def relpath(self, path):
457
"""Return the local path portion from a given path.
459
The path may be absolute or relative. If its a relative path it is
460
interpreted relative to the python current working directory.
462
return osutils.relpath(self.basedir, path)
464
def has_filename(self, filename):
465
return osutils.lexists(self.abspath(filename))
467
def get_file(self, file_id):
468
file_id = osutils.safe_file_id(file_id)
469
return self.get_file_byname(self.id2path(file_id))
471
def get_file_text(self, file_id):
472
file_id = osutils.safe_file_id(file_id)
473
return self.get_file(file_id).read()
475
def get_file_byname(self, filename):
476
return file(self.abspath(filename), 'rb')
479
def annotate_iter(self, file_id):
480
"""See Tree.annotate_iter
482
This implementation will use the basis tree implementation if possible.
483
Lines not in the basis are attributed to CURRENT_REVISION
485
If there are pending merges, lines added by those merges will be
486
incorrectly attributed to CURRENT_REVISION (but after committing, the
487
attribution will be correct).
489
file_id = osutils.safe_file_id(file_id)
490
basis = self.basis_tree()
493
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
494
require_versioned=True).next()
495
changed_content, kind = changes[2], changes[6]
496
if not changed_content:
497
return basis.annotate_iter(file_id)
501
if kind[0] != 'file':
504
old_lines = list(basis.annotate_iter(file_id))
506
for tree in self.branch.repository.revision_trees(
507
self.get_parent_ids()[1:]):
508
if file_id not in tree:
510
old.append(list(tree.annotate_iter(file_id)))
511
return annotate.reannotate(old, self.get_file(file_id).readlines(),
516
def get_parent_ids(self):
517
"""See Tree.get_parent_ids.
519
This implementation reads the pending merges list and last_revision
520
value and uses that to decide what the parents list should be.
522
last_rev = self._last_revision()
528
merges_file = self._control_files.get('pending-merges')
529
except errors.NoSuchFile:
532
for l in merges_file.readlines():
533
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
534
parents.append(revision_id)
538
def get_root_id(self):
539
"""Return the id of this trees root"""
540
return self._inventory.root.file_id
542
def _get_store_filename(self, file_id):
543
## XXX: badly named; this is not in the store at all
544
file_id = osutils.safe_file_id(file_id)
545
return self.abspath(self.id2path(file_id))
548
def clone(self, to_bzrdir, revision_id=None, basis=None):
549
"""Duplicate this working tree into to_bzr, including all state.
551
Specifically modified files are kept as modified, but
552
ignored and unknown files are discarded.
554
If you want to make a new line of development, see bzrdir.sprout()
557
If not None, the cloned tree will have its last revision set to
558
revision, and and difference between the source trees last revision
559
and this one merged in.
562
If not None, a closer copy of a tree which may have some files in
563
common, and which file content should be preferentially copied from.
565
# assumes the target bzr dir format is compatible.
566
result = self._format.initialize(to_bzrdir)
567
self.copy_content_into(result, revision_id)
571
def copy_content_into(self, tree, revision_id=None):
572
"""Copy the current content and user files of this tree into tree."""
573
tree.set_root_id(self.get_root_id())
574
if revision_id is None:
575
merge.transform_tree(tree, self)
577
# TODO now merge from tree.last_revision to revision (to preserve
578
# user local changes)
579
merge.transform_tree(tree, self)
580
tree.set_parent_ids([revision_id])
582
def id2abspath(self, file_id):
583
file_id = osutils.safe_file_id(file_id)
584
return self.abspath(self.id2path(file_id))
586
def has_id(self, file_id):
587
# files that have been deleted are excluded
588
file_id = osutils.safe_file_id(file_id)
590
if not inv.has_id(file_id):
592
path = inv.id2path(file_id)
593
return osutils.lexists(self.abspath(path))
595
def has_or_had_id(self, file_id):
596
file_id = osutils.safe_file_id(file_id)
597
if file_id == self.inventory.root.file_id:
599
return self.inventory.has_id(file_id)
601
__contains__ = has_id
603
def get_file_size(self, file_id):
604
file_id = osutils.safe_file_id(file_id)
605
return os.path.getsize(self.id2abspath(file_id))
608
def get_file_sha1(self, file_id, path=None, stat_value=None):
609
file_id = osutils.safe_file_id(file_id)
611
path = self._inventory.id2path(file_id)
612
return self._hashcache.get_sha1(path, stat_value)
614
def get_file_mtime(self, file_id, path=None):
615
file_id = osutils.safe_file_id(file_id)
617
path = self.inventory.id2path(file_id)
618
return os.lstat(self.abspath(path)).st_mtime
620
if not supports_executable():
621
def is_executable(self, file_id, path=None):
622
file_id = osutils.safe_file_id(file_id)
623
return self._inventory[file_id].executable
625
def is_executable(self, file_id, path=None):
627
file_id = osutils.safe_file_id(file_id)
628
path = self.id2path(file_id)
629
mode = os.lstat(self.abspath(path)).st_mode
630
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
632
@needs_tree_write_lock
633
def _add(self, files, ids, kinds):
634
"""See MutableTree._add."""
635
# TODO: Re-adding a file that is removed in the working copy
636
# should probably put it back with the previous ID.
637
# the read and write working inventory should not occur in this
638
# function - they should be part of lock_write and unlock.
639
inv = self.read_working_inventory()
640
for f, file_id, kind in zip(files, ids, kinds):
641
assert kind is not None
643
inv.add_path(f, kind=kind)
645
file_id = osutils.safe_file_id(file_id)
646
inv.add_path(f, kind=kind, file_id=file_id)
647
self._write_inventory(inv)
649
@needs_tree_write_lock
650
def _gather_kinds(self, files, kinds):
651
"""See MutableTree._gather_kinds."""
652
for pos, f in enumerate(files):
653
if kinds[pos] is None:
654
fullpath = normpath(self.abspath(f))
656
kinds[pos] = file_kind(fullpath)
658
if e.errno == errno.ENOENT:
659
raise errors.NoSuchFile(fullpath)
662
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
663
"""Add revision_id as a parent.
665
This is equivalent to retrieving the current list of parent ids
666
and setting the list to its value plus revision_id.
668
:param revision_id: The revision id to add to the parent list. It may
669
be a ghost revision as long as its not the first parent to be added,
670
or the allow_leftmost_as_ghost parameter is set True.
671
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
673
parents = self.get_parent_ids() + [revision_id]
674
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
675
or allow_leftmost_as_ghost)
677
@needs_tree_write_lock
678
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
679
"""Add revision_id, tree tuple as a parent.
681
This is equivalent to retrieving the current list of parent trees
682
and setting the list to its value plus parent_tuple. See also
683
add_parent_tree_id - if you only have a parent id available it will be
684
simpler to use that api. If you have the parent already available, using
685
this api is preferred.
687
:param parent_tuple: The (revision id, tree) to add to the parent list.
688
If the revision_id is a ghost, pass None for the tree.
689
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
691
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
692
if len(parent_ids) > 1:
693
# the leftmost may have already been a ghost, preserve that if it
695
allow_leftmost_as_ghost = True
696
self.set_parent_ids(parent_ids,
697
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
699
@needs_tree_write_lock
700
def add_pending_merge(self, *revision_ids):
701
# TODO: Perhaps should check at this point that the
702
# history of the revision is actually present?
703
parents = self.get_parent_ids()
705
for rev_id in revision_ids:
706
if rev_id in parents:
708
parents.append(rev_id)
711
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
713
@deprecated_method(zero_eleven)
715
def pending_merges(self):
716
"""Return a list of pending merges.
718
These are revisions that have been merged into the working
719
directory but not yet committed.
721
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
722
instead - which is available on all tree objects.
724
return self.get_parent_ids()[1:]
726
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
727
"""Common ghost checking functionality from set_parent_*.
729
This checks that the left hand-parent exists if there are any
732
if len(revision_ids) > 0:
733
leftmost_id = revision_ids[0]
734
if (not allow_leftmost_as_ghost and not
735
self.branch.repository.has_revision(leftmost_id)):
736
raise errors.GhostRevisionUnusableHere(leftmost_id)
738
def _set_merges_from_parent_ids(self, parent_ids):
739
merges = parent_ids[1:]
740
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
742
@needs_tree_write_lock
743
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
744
"""Set the parent ids to revision_ids.
746
See also set_parent_trees. This api will try to retrieve the tree data
747
for each element of revision_ids from the trees repository. If you have
748
tree data already available, it is more efficient to use
749
set_parent_trees rather than set_parent_ids. set_parent_ids is however
750
an easier API to use.
752
:param revision_ids: The revision_ids to set as the parent ids of this
753
working tree. Any of these may be ghosts.
755
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
756
self._check_parents_for_ghosts(revision_ids,
757
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
759
if len(revision_ids) > 0:
760
self.set_last_revision(revision_ids[0])
762
self.set_last_revision(None)
764
self._set_merges_from_parent_ids(revision_ids)
766
@needs_tree_write_lock
767
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
768
"""See MutableTree.set_parent_trees."""
769
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
771
self._check_parents_for_ghosts(parent_ids,
772
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
774
if len(parent_ids) == 0:
775
leftmost_parent_id = None
776
leftmost_parent_tree = None
778
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
780
if self._change_last_revision(leftmost_parent_id):
781
if leftmost_parent_tree is None:
782
# If we don't have a tree, fall back to reading the
783
# parent tree from the repository.
784
self._cache_basis_inventory(leftmost_parent_id)
786
inv = leftmost_parent_tree.inventory
787
xml = self._create_basis_xml_from_inventory(
788
leftmost_parent_id, inv)
789
self._write_basis_inventory(xml)
790
self._set_merges_from_parent_ids(parent_ids)
792
@needs_tree_write_lock
793
def set_pending_merges(self, rev_list):
794
parents = self.get_parent_ids()
795
leftmost = parents[:1]
796
new_parents = leftmost + rev_list
797
self.set_parent_ids(new_parents)
799
@needs_tree_write_lock
800
def set_merge_modified(self, modified_hashes):
802
for file_id, hash in modified_hashes.iteritems():
803
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
804
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
806
def _put_rio(self, filename, stanzas, header):
807
self._must_be_locked()
808
my_file = rio_file(stanzas, header)
809
self._control_files.put(filename, my_file)
811
@needs_write_lock # because merge pulls data into the branch.
812
def merge_from_branch(self, branch, to_revision=None):
813
"""Merge from a branch into this working tree.
815
:param branch: The branch to merge from.
816
:param to_revision: If non-None, the merge will merge to to_revision,
817
but not beyond it. to_revision does not need to be in the history
818
of the branch when it is supplied. If None, to_revision defaults to
819
branch.last_revision().
821
from bzrlib.merge import Merger, Merge3Merger
822
pb = bzrlib.ui.ui_factory.nested_progress_bar()
824
merger = Merger(self.branch, this_tree=self, pb=pb)
825
merger.pp = ProgressPhase("Merge phase", 5, pb)
826
merger.pp.next_phase()
827
# check that there are no
829
merger.check_basis(check_clean=True, require_commits=False)
830
if to_revision is None:
831
to_revision = branch.last_revision()
833
to_revision = osutils.safe_revision_id(to_revision)
834
merger.other_rev_id = to_revision
835
if merger.other_rev_id is None:
836
raise error.NoCommits(branch)
837
self.branch.fetch(branch, last_revision=merger.other_rev_id)
838
merger.other_basis = merger.other_rev_id
839
merger.other_tree = self.branch.repository.revision_tree(
841
merger.other_branch = branch
842
merger.pp.next_phase()
844
if merger.base_rev_id == merger.other_rev_id:
845
raise errors.PointlessMerge
846
merger.backup_files = False
847
merger.merge_type = Merge3Merger
848
merger.set_interesting_files(None)
849
merger.show_base = False
850
merger.reprocess = False
851
conflicts = merger.do_merge()
858
def merge_modified(self):
859
"""Return a dictionary of files modified by a merge.
861
The list is initialized by WorkingTree.set_merge_modified, which is
862
typically called after we make some automatic updates to the tree
865
This returns a map of file_id->sha1, containing only files which are
866
still in the working inventory and have that text hash.
869
hashfile = self._control_files.get('merge-hashes')
870
except errors.NoSuchFile:
874
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
875
raise errors.MergeModifiedFormatError()
876
except StopIteration:
877
raise errors.MergeModifiedFormatError()
878
for s in RioReader(hashfile):
879
# RioReader reads in Unicode, so convert file_ids back to utf8
880
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
881
if file_id not in self.inventory:
883
text_hash = s.get("hash")
884
if text_hash == self.get_file_sha1(file_id):
885
merge_hashes[file_id] = text_hash
889
def mkdir(self, path, file_id=None):
890
"""See MutableTree.mkdir()."""
892
file_id = generate_ids.gen_file_id(os.path.basename(path))
893
os.mkdir(self.abspath(path))
894
self.add(path, file_id, 'directory')
897
def get_symlink_target(self, file_id):
898
file_id = osutils.safe_file_id(file_id)
899
return os.readlink(self.id2abspath(file_id))
902
def subsume(self, other_tree):
903
def add_children(inventory, entry):
904
for child_entry in entry.children.values():
905
inventory._byid[child_entry.file_id] = child_entry
906
if child_entry.kind == 'directory':
907
add_children(inventory, child_entry)
908
if other_tree.get_root_id() == self.get_root_id():
909
raise errors.BadSubsumeSource(self, other_tree,
910
'Trees have the same root')
912
other_tree_path = self.relpath(other_tree.basedir)
913
except errors.PathNotChild:
914
raise errors.BadSubsumeSource(self, other_tree,
915
'Tree is not contained by the other')
916
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
917
if new_root_parent is None:
918
raise errors.BadSubsumeSource(self, other_tree,
919
'Parent directory is not versioned.')
920
# We need to ensure that the result of a fetch will have a
921
# versionedfile for the other_tree root, and only fetching into
922
# RepositoryKnit2 guarantees that.
923
if not self.branch.repository.supports_rich_root():
924
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
925
other_tree.lock_tree_write()
927
new_parents = other_tree.get_parent_ids()
928
other_root = other_tree.inventory.root
929
other_root.parent_id = new_root_parent
930
other_root.name = osutils.basename(other_tree_path)
931
self.inventory.add(other_root)
932
add_children(self.inventory, other_root)
933
self._write_inventory(self.inventory)
934
# normally we don't want to fetch whole repositories, but i think
935
# here we really do want to consolidate the whole thing.
936
for parent_id in other_tree.get_parent_ids():
937
self.branch.fetch(other_tree.branch, parent_id)
938
self.add_parent_tree_id(parent_id)
941
other_tree.bzrdir.retire_bzrdir()
943
@needs_tree_write_lock
944
def extract(self, file_id, format=None):
945
"""Extract a subtree from this tree.
947
A new branch will be created, relative to the path for this tree.
951
segments = osutils.splitpath(path)
952
transport = self.branch.bzrdir.root_transport
953
for name in segments:
954
transport = transport.clone(name)
957
except errors.FileExists:
961
sub_path = self.id2path(file_id)
962
branch_transport = mkdirs(sub_path)
964
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
966
branch_transport.mkdir('.')
967
except errors.FileExists:
969
branch_bzrdir = format.initialize_on_transport(branch_transport)
971
repo = branch_bzrdir.find_repository()
972
except errors.NoRepositoryPresent:
973
repo = branch_bzrdir.create_repository()
974
assert repo.supports_rich_root()
976
if not repo.supports_rich_root():
977
raise errors.RootNotRich()
978
new_branch = branch_bzrdir.create_branch()
979
new_branch.pull(self.branch)
980
for parent_id in self.get_parent_ids():
981
new_branch.fetch(self.branch, parent_id)
982
tree_transport = self.bzrdir.root_transport.clone(sub_path)
983
if tree_transport.base != branch_transport.base:
984
tree_bzrdir = format.initialize_on_transport(tree_transport)
985
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
987
tree_bzrdir = branch_bzrdir
988
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
989
wt.set_parent_ids(self.get_parent_ids())
990
my_inv = self.inventory
991
child_inv = Inventory(root_id=None)
992
new_root = my_inv[file_id]
993
my_inv.remove_recursive_id(file_id)
994
new_root.parent_id = None
995
child_inv.add(new_root)
996
self._write_inventory(my_inv)
997
wt._write_inventory(child_inv)
1000
def _serialize(self, inventory, out_file):
1001
xml5.serializer_v5.write_inventory(self._inventory, out_file)
1003
def _deserialize(selt, in_file):
1004
return xml5.serializer_v5.read_inventory(in_file)
1007
"""Write the in memory inventory to disk."""
1008
# TODO: Maybe this should only write on dirty ?
1009
if self._control_files._lock_mode != 'w':
1010
raise errors.NotWriteLocked(self)
1012
self._serialize(self._inventory, sio)
1014
self._control_files.put('inventory', sio)
1015
self._inventory_is_modified = False
1017
def _kind(self, relpath):
1018
return osutils.file_kind(self.abspath(relpath))
1020
def list_files(self, include_root=False):
1021
"""Recursively list all files as (path, class, kind, id, entry).
1023
Lists, but does not descend into unversioned directories.
1025
This does not include files that have been deleted in this
1028
Skips the control directory.
1030
# list_files is an iterator, so @needs_read_lock doesn't work properly
1031
# with it. So callers should be careful to always read_lock the tree.
1032
if not self.is_locked():
1033
raise errors.ObjectNotLocked(self)
1035
inv = self.inventory
1036
if include_root is True:
1037
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1038
# Convert these into local objects to save lookup times
1039
pathjoin = osutils.pathjoin
1040
file_kind = self._kind
1042
# transport.base ends in a slash, we want the piece
1043
# between the last two slashes
1044
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1046
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1048
# directory file_id, relative path, absolute path, reverse sorted children
1049
children = os.listdir(self.basedir)
1051
# jam 20060527 The kernel sized tree seems equivalent whether we
1052
# use a deque and popleft to keep them sorted, or if we use a plain
1053
# list and just reverse() them.
1054
children = collections.deque(children)
1055
stack = [(inv.root.file_id, u'', self.basedir, children)]
1057
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1060
f = children.popleft()
1061
## TODO: If we find a subdirectory with its own .bzr
1062
## directory, then that is a separate tree and we
1063
## should exclude it.
1065
# the bzrdir for this tree
1066
if transport_base_dir == f:
1069
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1070
# and 'f' doesn't begin with one, we can do a string op, rather
1071
# than the checks of pathjoin(), all relative paths will have an extra slash
1073
fp = from_dir_relpath + '/' + f
1076
fap = from_dir_abspath + '/' + f
1078
f_ie = inv.get_child(from_dir_id, f)
1081
elif self.is_ignored(fp[1:]):
1084
# we may not have found this file, because of a unicode issue
1085
f_norm, can_access = osutils.normalized_filename(f)
1086
if f == f_norm or not can_access:
1087
# No change, so treat this file normally
1090
# this file can be accessed by a normalized path
1091
# check again if it is versioned
1092
# these lines are repeated here for performance
1094
fp = from_dir_relpath + '/' + f
1095
fap = from_dir_abspath + '/' + f
1096
f_ie = inv.get_child(from_dir_id, f)
1099
elif self.is_ignored(fp[1:]):
1106
# make a last minute entry
1108
yield fp[1:], c, fk, f_ie.file_id, f_ie
1111
yield fp[1:], c, fk, None, fk_entries[fk]()
1113
yield fp[1:], c, fk, None, TreeEntry()
1116
if fk != 'directory':
1119
# But do this child first
1120
new_children = os.listdir(fap)
1122
new_children = collections.deque(new_children)
1123
stack.append((f_ie.file_id, fp, fap, new_children))
1124
# Break out of inner loop,
1125
# so that we start outer loop with child
1128
# if we finished all children, pop it off the stack
1131
@needs_tree_write_lock
1132
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1135
to_dir must exist in the inventory.
1137
If to_dir exists and is a directory, the files are moved into
1138
it, keeping their old names.
1140
Note that to_dir is only the last component of the new name;
1141
this doesn't change the directory.
1143
For each entry in from_paths the move mode will be determined
1146
The first mode moves the file in the filesystem and updates the
1147
inventory. The second mode only updates the inventory without
1148
touching the file on the filesystem. This is the new mode introduced
1151
move uses the second mode if 'after == True' and the target is not
1152
versioned but present in the working tree.
1154
move uses the second mode if 'after == False' and the source is
1155
versioned but no longer in the working tree, and the target is not
1156
versioned but present in the working tree.
1158
move uses the first mode if 'after == False' and the source is
1159
versioned and present in the working tree, and the target is not
1160
versioned and not present in the working tree.
1162
Everything else results in an error.
1164
This returns a list of (from_path, to_path) pairs for each
1165
entry that is moved.
1170
# check for deprecated use of signature
1172
to_dir = kwargs.get('to_name', None)
1174
raise TypeError('You must supply a target directory')
1176
symbol_versioning.warn('The parameter to_name was deprecated'
1177
' in version 0.13. Use to_dir instead',
1180
# check destination directory
1181
assert not isinstance(from_paths, basestring)
1182
inv = self.inventory
1183
to_abs = self.abspath(to_dir)
1184
if not isdir(to_abs):
1185
raise errors.BzrMoveFailedError('',to_dir,
1186
errors.NotADirectory(to_abs))
1187
if not self.has_filename(to_dir):
1188
raise errors.BzrMoveFailedError('',to_dir,
1189
errors.NotInWorkingDirectory(to_dir))
1190
to_dir_id = inv.path2id(to_dir)
1191
if to_dir_id is None:
1192
raise errors.BzrMoveFailedError('',to_dir,
1193
errors.NotVersionedError(path=str(to_dir)))
1195
to_dir_ie = inv[to_dir_id]
1196
if to_dir_ie.kind != 'directory':
1197
raise errors.BzrMoveFailedError('',to_dir,
1198
errors.NotADirectory(to_abs))
1200
# create rename entries and tuples
1201
for from_rel in from_paths:
1202
from_tail = splitpath(from_rel)[-1]
1203
from_id = inv.path2id(from_rel)
1205
raise errors.BzrMoveFailedError(from_rel,to_dir,
1206
errors.NotVersionedError(path=str(from_rel)))
1208
from_entry = inv[from_id]
1209
from_parent_id = from_entry.parent_id
1210
to_rel = pathjoin(to_dir, from_tail)
1211
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1213
from_tail=from_tail,
1214
from_parent_id=from_parent_id,
1215
to_rel=to_rel, to_tail=from_tail,
1216
to_parent_id=to_dir_id)
1217
rename_entries.append(rename_entry)
1218
rename_tuples.append((from_rel, to_rel))
1220
# determine which move mode to use. checks also for movability
1221
rename_entries = self._determine_mv_mode(rename_entries, after)
1223
original_modified = self._inventory_is_modified
1226
self._inventory_is_modified = True
1227
self._move(rename_entries)
1229
# restore the inventory on error
1230
self._inventory_is_modified = original_modified
1232
self._write_inventory(inv)
1233
return rename_tuples
1235
def _determine_mv_mode(self, rename_entries, after=False):
1236
"""Determines for each from-to pair if both inventory and working tree
1237
or only the inventory has to be changed.
1239
Also does basic plausability tests.
1241
inv = self.inventory
1243
for rename_entry in rename_entries:
1244
# store to local variables for easier reference
1245
from_rel = rename_entry.from_rel
1246
from_id = rename_entry.from_id
1247
to_rel = rename_entry.to_rel
1248
to_id = inv.path2id(to_rel)
1249
only_change_inv = False
1251
# check the inventory for source and destination
1253
raise errors.BzrMoveFailedError(from_rel,to_rel,
1254
errors.NotVersionedError(path=str(from_rel)))
1255
if to_id is not None:
1256
raise errors.BzrMoveFailedError(from_rel,to_rel,
1257
errors.AlreadyVersionedError(path=str(to_rel)))
1259
# try to determine the mode for rename (only change inv or change
1260
# inv and file system)
1262
if not self.has_filename(to_rel):
1263
raise errors.BzrMoveFailedError(from_id,to_rel,
1264
errors.NoSuchFile(path=str(to_rel),
1265
extra="New file has not been created yet"))
1266
only_change_inv = True
1267
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1268
only_change_inv = True
1269
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1270
only_change_inv = False
1272
# something is wrong, so lets determine what exactly
1273
if not self.has_filename(from_rel) and \
1274
not self.has_filename(to_rel):
1275
raise errors.BzrRenameFailedError(from_rel,to_rel,
1276
errors.PathsDoNotExist(paths=(str(from_rel),
1279
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1280
extra="(Use --after to update the Bazaar id)")
1281
rename_entry.only_change_inv = only_change_inv
1282
return rename_entries
1284
def _move(self, rename_entries):
1285
"""Moves a list of files.
1287
Depending on the value of the flag 'only_change_inv', the
1288
file will be moved on the file system or not.
1290
inv = self.inventory
1293
for entry in rename_entries:
1295
self._move_entry(entry)
1297
self._rollback_move(moved)
1301
def _rollback_move(self, moved):
1302
"""Try to rollback a previous move in case of an filesystem error."""
1303
inv = self.inventory
1306
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1307
entry.to_tail, entry.to_parent_id, entry.from_rel,
1308
entry.from_tail, entry.from_parent_id,
1309
entry.only_change_inv))
1310
except errors.BzrMoveFailedError, e:
1311
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1312
" The working tree is in an inconsistent state."
1313
" Please consider doing a 'bzr revert'."
1314
" Error message is: %s" % e)
1316
def _move_entry(self, entry):
1317
inv = self.inventory
1318
from_rel_abs = self.abspath(entry.from_rel)
1319
to_rel_abs = self.abspath(entry.to_rel)
1320
if from_rel_abs == to_rel_abs:
1321
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1322
"Source and target are identical.")
1324
if not entry.only_change_inv:
1326
osutils.rename(from_rel_abs, to_rel_abs)
1328
raise errors.BzrMoveFailedError(entry.from_rel,
1330
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1332
@needs_tree_write_lock
1333
def rename_one(self, from_rel, to_rel, after=False):
1336
This can change the directory or the filename or both.
1338
rename_one has several 'modes' to work. First, it can rename a physical
1339
file and change the file_id. That is the normal mode. Second, it can
1340
only change the file_id without touching any physical file. This is
1341
the new mode introduced in version 0.15.
1343
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1344
versioned but present in the working tree.
1346
rename_one uses the second mode if 'after == False' and 'from_rel' is
1347
versioned but no longer in the working tree, and 'to_rel' is not
1348
versioned but present in the working tree.
1350
rename_one uses the first mode if 'after == False' and 'from_rel' is
1351
versioned and present in the working tree, and 'to_rel' is not
1352
versioned and not present in the working tree.
1354
Everything else results in an error.
1356
inv = self.inventory
1359
# create rename entries and tuples
1360
from_tail = splitpath(from_rel)[-1]
1361
from_id = inv.path2id(from_rel)
1363
raise errors.BzrRenameFailedError(from_rel,to_rel,
1364
errors.NotVersionedError(path=str(from_rel)))
1365
from_entry = inv[from_id]
1366
from_parent_id = from_entry.parent_id
1367
to_dir, to_tail = os.path.split(to_rel)
1368
to_dir_id = inv.path2id(to_dir)
1369
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1371
from_tail=from_tail,
1372
from_parent_id=from_parent_id,
1373
to_rel=to_rel, to_tail=to_tail,
1374
to_parent_id=to_dir_id)
1375
rename_entries.append(rename_entry)
1377
# determine which move mode to use. checks also for movability
1378
rename_entries = self._determine_mv_mode(rename_entries, after)
1380
# check if the target changed directory and if the target directory is
1382
if to_dir_id is None:
1383
raise errors.BzrMoveFailedError(from_rel,to_rel,
1384
errors.NotVersionedError(path=str(to_dir)))
1386
# all checks done. now we can continue with our actual work
1387
mutter('rename_one:\n'
1392
' to_dir_id {%s}\n',
1393
from_id, from_rel, to_rel, to_dir, to_dir_id)
1395
self._move(rename_entries)
1396
self._write_inventory(inv)
1398
class _RenameEntry(object):
1399
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1400
to_rel, to_tail, to_parent_id, only_change_inv=False):
1401
self.from_rel = from_rel
1402
self.from_id = from_id
1403
self.from_tail = from_tail
1404
self.from_parent_id = from_parent_id
1405
self.to_rel = to_rel
1406
self.to_tail = to_tail
1407
self.to_parent_id = to_parent_id
1408
self.only_change_inv = only_change_inv
1412
"""Return all unknown files.
1414
These are files in the working directory that are not versioned or
1415
control files or ignored.
1417
# force the extras method to be fully executed before returning, to
1418
# prevent race conditions with the lock
1420
[subp for subp in self.extras() if not self.is_ignored(subp)])
1422
@needs_tree_write_lock
1423
def unversion(self, file_ids):
1424
"""Remove the file ids in file_ids from the current versioned set.
1426
When a file_id is unversioned, all of its children are automatically
1429
:param file_ids: The file ids to stop versioning.
1430
:raises: NoSuchId if any fileid is not currently versioned.
1432
for file_id in file_ids:
1433
file_id = osutils.safe_file_id(file_id)
1434
if self._inventory.has_id(file_id):
1435
self._inventory.remove_recursive_id(file_id)
1437
raise errors.NoSuchId(self, file_id)
1439
# in the future this should just set a dirty bit to wait for the
1440
# final unlock. However, until all methods of workingtree start
1441
# with the current in -memory inventory rather than triggering
1442
# a read, it is more complex - we need to teach read_inventory
1443
# to know when to read, and when to not read first... and possibly
1444
# to save first when the in memory one may be corrupted.
1445
# so for now, we just only write it if it is indeed dirty.
1447
self._write_inventory(self._inventory)
1449
@deprecated_method(zero_eight)
1450
def iter_conflicts(self):
1451
"""List all files in the tree that have text or content conflicts.
1452
DEPRECATED. Use conflicts instead."""
1453
return self._iter_conflicts()
1455
def _iter_conflicts(self):
1457
for info in self.list_files():
1459
stem = get_conflicted_stem(path)
1462
if stem not in conflicted:
1463
conflicted.add(stem)
1467
def pull(self, source, overwrite=False, stop_revision=None,
1468
change_reporter=None):
1469
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1472
pp = ProgressPhase("Pull phase", 2, top_pb)
1474
old_revision_info = self.branch.last_revision_info()
1475
basis_tree = self.basis_tree()
1476
count = self.branch.pull(source, overwrite, stop_revision)
1477
new_revision_info = self.branch.last_revision_info()
1478
if new_revision_info != old_revision_info:
1480
repository = self.branch.repository
1481
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1482
basis_tree.lock_read()
1484
new_basis_tree = self.branch.basis_tree()
1491
change_reporter=change_reporter)
1492
if (basis_tree.inventory.root is None and
1493
new_basis_tree.inventory.root is not None):
1494
self.set_root_id(new_basis_tree.inventory.root.file_id)
1498
# TODO - dedup parents list with things merged by pull ?
1499
# reuse the revisiontree we merged against to set the new
1501
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1502
# we have to pull the merge trees out again, because
1503
# merge_inner has set the ids. - this corner is not yet
1504
# layered well enough to prevent double handling.
1505
# XXX TODO: Fix the double handling: telling the tree about
1506
# the already known parent data is wasteful.
1507
merges = self.get_parent_ids()[1:]
1508
parent_trees.extend([
1509
(parent, repository.revision_tree(parent)) for
1511
self.set_parent_trees(parent_trees)
1518
def put_file_bytes_non_atomic(self, file_id, bytes):
1519
"""See MutableTree.put_file_bytes_non_atomic."""
1520
file_id = osutils.safe_file_id(file_id)
1521
stream = file(self.id2abspath(file_id), 'wb')
1526
# TODO: update the hashcache here ?
1529
"""Yield all unversioned files in this WorkingTree.
1531
If there are any unversioned directories then only the directory is
1532
returned, not all its children. But if there are unversioned files
1533
under a versioned subdirectory, they are returned.
1535
Currently returned depth-first, sorted by name within directories.
1536
This is the same order used by 'osutils.walkdirs'.
1538
## TODO: Work from given directory downwards
1539
for path, dir_entry in self.inventory.directories():
1540
# mutter("search for unknowns in %r", path)
1541
dirabs = self.abspath(path)
1542
if not isdir(dirabs):
1543
# e.g. directory deleted
1547
for subf in os.listdir(dirabs):
1550
if subf not in dir_entry.children:
1551
subf_norm, can_access = osutils.normalized_filename(subf)
1552
if subf_norm != subf and can_access:
1553
if subf_norm not in dir_entry.children:
1554
fl.append(subf_norm)
1560
subp = pathjoin(path, subf)
1563
def ignored_files(self):
1564
"""Yield list of PATH, IGNORE_PATTERN"""
1565
for subp in self.extras():
1566
pat = self.is_ignored(subp)
1570
def get_ignore_list(self):
1571
"""Return list of ignore patterns.
1573
Cached in the Tree object after the first call.
1575
ignoreset = getattr(self, '_ignoreset', None)
1576
if ignoreset is not None:
1579
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1580
ignore_globs.update(ignores.get_runtime_ignores())
1581
ignore_globs.update(ignores.get_user_ignores())
1582
if self.has_filename(bzrlib.IGNORE_FILENAME):
1583
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1585
ignore_globs.update(ignores.parse_ignore_file(f))
1588
self._ignoreset = ignore_globs
1591
def _flush_ignore_list_cache(self):
1592
"""Resets the cached ignore list to force a cache rebuild."""
1593
self._ignoreset = None
1594
self._ignoreglobster = None
1596
def is_ignored(self, filename):
1597
r"""Check whether the filename matches an ignore pattern.
1599
Patterns containing '/' or '\' need to match the whole path;
1600
others match against only the last component.
1602
If the file is ignored, returns the pattern which caused it to
1603
be ignored, otherwise None. So this can simply be used as a
1604
boolean if desired."""
1605
if getattr(self, '_ignoreglobster', None) is None:
1606
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1607
return self._ignoreglobster.match(filename)
1609
def kind(self, file_id):
1610
return file_kind(self.id2abspath(file_id))
1612
def _comparison_data(self, entry, path):
1613
abspath = self.abspath(path)
1615
stat_value = os.lstat(abspath)
1617
if getattr(e, 'errno', None) == errno.ENOENT:
1624
mode = stat_value.st_mode
1625
kind = osutils.file_kind_from_stat_mode(mode)
1626
if not supports_executable():
1627
executable = entry.executable
1629
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1630
return kind, executable, stat_value
1632
def _file_size(self, entry, stat_value):
1633
return stat_value.st_size
1635
def last_revision(self):
1636
"""Return the last revision of the branch for this tree.
1638
This format tree does not support a separate marker for last-revision
1639
compared to the branch.
1641
See MutableTree.last_revision
1643
return self._last_revision()
1646
def _last_revision(self):
1647
"""helper for get_parent_ids."""
1648
return self.branch.last_revision()
1650
def is_locked(self):
1651
return self._control_files.is_locked()
1653
def _must_be_locked(self):
1654
if not self.is_locked():
1655
raise errors.ObjectNotLocked(self)
1657
def lock_read(self):
1658
"""See Branch.lock_read, and WorkingTree.unlock."""
1659
if not self.is_locked():
1661
self.branch.lock_read()
1663
return self._control_files.lock_read()
1665
self.branch.unlock()
1668
def lock_tree_write(self):
1669
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1670
if not self.is_locked():
1672
self.branch.lock_read()
1674
return self._control_files.lock_write()
1676
self.branch.unlock()
1679
def lock_write(self):
1680
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1681
if not self.is_locked():
1683
self.branch.lock_write()
1685
return self._control_files.lock_write()
1687
self.branch.unlock()
1690
def get_physical_lock_status(self):
1691
return self._control_files.get_physical_lock_status()
1693
def _basis_inventory_name(self):
1694
return 'basis-inventory-cache'
1696
def _reset_data(self):
1697
"""Reset transient data that cannot be revalidated."""
1698
self._inventory_is_modified = False
1699
result = self._deserialize(self._control_files.get('inventory'))
1700
self._set_inventory(result, dirty=False)
1702
@needs_tree_write_lock
1703
def set_last_revision(self, new_revision):
1704
"""Change the last revision in the working tree."""
1705
new_revision = osutils.safe_revision_id(new_revision)
1706
if self._change_last_revision(new_revision):
1707
self._cache_basis_inventory(new_revision)
1709
def _change_last_revision(self, new_revision):
1710
"""Template method part of set_last_revision to perform the change.
1712
This is used to allow WorkingTree3 instances to not affect branch
1713
when their last revision is set.
1715
if new_revision is None:
1716
self.branch.set_revision_history([])
1719
self.branch.generate_revision_history(new_revision)
1720
except errors.NoSuchRevision:
1721
# not present in the repo - dont try to set it deeper than the tip
1722
self.branch.set_revision_history([new_revision])
1725
def _write_basis_inventory(self, xml):
1726
"""Write the basis inventory XML to the basis-inventory file"""
1727
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1728
path = self._basis_inventory_name()
1730
self._control_files.put(path, sio)
1732
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1733
"""Create the text that will be saved in basis-inventory"""
1734
# TODO: jam 20070209 This should be redundant, as the revision_id
1735
# as all callers should have already converted the revision_id to
1737
inventory.revision_id = osutils.safe_revision_id(revision_id)
1738
return xml7.serializer_v7.write_inventory_to_string(inventory)
1740
def _cache_basis_inventory(self, new_revision):
1741
"""Cache new_revision as the basis inventory."""
1742
# TODO: this should allow the ready-to-use inventory to be passed in,
1743
# as commit already has that ready-to-use [while the format is the
1746
# this double handles the inventory - unpack and repack -
1747
# but is easier to understand. We can/should put a conditional
1748
# in here based on whether the inventory is in the latest format
1749
# - perhaps we should repack all inventories on a repository
1751
# the fast path is to copy the raw xml from the repository. If the
1752
# xml contains 'revision_id="', then we assume the right
1753
# revision_id is set. We must check for this full string, because a
1754
# root node id can legitimately look like 'revision_id' but cannot
1756
xml = self.branch.repository.get_inventory_xml(new_revision)
1757
firstline = xml.split('\n', 1)[0]
1758
if (not 'revision_id="' in firstline or
1759
'format="7"' not in firstline):
1760
inv = self.branch.repository.deserialise_inventory(
1762
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1763
self._write_basis_inventory(xml)
1764
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1767
def read_basis_inventory(self):
1768
"""Read the cached basis inventory."""
1769
path = self._basis_inventory_name()
1770
return self._control_files.get(path).read()
1773
def read_working_inventory(self):
1774
"""Read the working inventory.
1776
:raises errors.InventoryModified: read_working_inventory will fail
1777
when the current in memory inventory has been modified.
1779
# conceptually this should be an implementation detail of the tree.
1780
# XXX: Deprecate this.
1781
# ElementTree does its own conversion from UTF-8, so open in
1783
if self._inventory_is_modified:
1784
raise errors.InventoryModified(self)
1785
result = self._deserialize(self._control_files.get('inventory'))
1786
self._set_inventory(result, dirty=False)
1789
@needs_tree_write_lock
1790
def remove(self, files, verbose=False, to_file=None):
1791
"""Remove nominated files from the working inventory..
1793
This does not remove their text. This does not run on XXX on what? RBC
1795
TODO: Refuse to remove modified files unless --force is given?
1797
TODO: Do something useful with directories.
1799
TODO: Should this remove the text or not? Tough call; not
1800
removing may be useful and the user can just use use rm, and
1801
is the opposite of add. Removing it is consistent with most
1802
other tools. Maybe an option.
1804
## TODO: Normalize names
1805
## TODO: Remove nested loops; better scalability
1806
if isinstance(files, basestring):
1809
inv = self.inventory
1811
# do this before any modifications
1813
fid = inv.path2id(f)
1815
note("%s is not versioned."%f)
1818
# having remove it, it must be either ignored or unknown
1819
if self.is_ignored(f):
1823
textui.show_status(new_status, inv[fid].kind, f,
1827
self._write_inventory(inv)
1829
@needs_tree_write_lock
1830
def revert(self, filenames, old_tree=None, backups=True,
1831
pb=DummyProgress(), report_changes=False):
1832
from bzrlib.conflicts import resolve
1833
if old_tree is None:
1834
old_tree = self.basis_tree()
1835
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1837
if not len(filenames):
1838
self.set_parent_ids(self.get_parent_ids()[:1])
1841
resolve(self, filenames, ignore_misses=True)
1844
def revision_tree(self, revision_id):
1845
"""See Tree.revision_tree.
1847
WorkingTree can supply revision_trees for the basis revision only
1848
because there is only one cached inventory in the bzr directory.
1850
if revision_id == self.last_revision():
1852
xml = self.read_basis_inventory()
1853
except errors.NoSuchFile:
1857
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1858
# dont use the repository revision_tree api because we want
1859
# to supply the inventory.
1860
if inv.revision_id == revision_id:
1861
return revisiontree.RevisionTree(self.branch.repository,
1863
except errors.BadInventoryFormat:
1865
# raise if there was no inventory, or if we read the wrong inventory.
1866
raise errors.NoSuchRevisionInTree(self, revision_id)
1868
# XXX: This method should be deprecated in favour of taking in a proper
1869
# new Inventory object.
1870
@needs_tree_write_lock
1871
def set_inventory(self, new_inventory_list):
1872
from bzrlib.inventory import (Inventory,
1877
inv = Inventory(self.get_root_id())
1878
for path, file_id, parent, kind in new_inventory_list:
1879
name = os.path.basename(path)
1882
# fixme, there should be a factory function inv,add_??
1883
if kind == 'directory':
1884
inv.add(InventoryDirectory(file_id, name, parent))
1885
elif kind == 'file':
1886
inv.add(InventoryFile(file_id, name, parent))
1887
elif kind == 'symlink':
1888
inv.add(InventoryLink(file_id, name, parent))
1890
raise errors.BzrError("unknown kind %r" % kind)
1891
self._write_inventory(inv)
1893
@needs_tree_write_lock
1894
def set_root_id(self, file_id):
1895
"""Set the root id for this tree."""
1898
symbol_versioning.warn(symbol_versioning.zero_twelve
1899
% 'WorkingTree.set_root_id with fileid=None',
1904
file_id = osutils.safe_file_id(file_id)
1905
self._set_root_id(file_id)
1907
def _set_root_id(self, file_id):
1908
"""Set the root id for this tree, in a format specific manner.
1910
:param file_id: The file id to assign to the root. It must not be
1911
present in the current inventory or an error will occur. It must
1912
not be None, but rather a valid file id.
1914
inv = self._inventory
1915
orig_root_id = inv.root.file_id
1916
# TODO: it might be nice to exit early if there was nothing
1917
# to do, saving us from trigger a sync on unlock.
1918
self._inventory_is_modified = True
1919
# we preserve the root inventory entry object, but
1920
# unlinkit from the byid index
1921
del inv._byid[inv.root.file_id]
1922
inv.root.file_id = file_id
1923
# and link it into the index with the new changed id.
1924
inv._byid[inv.root.file_id] = inv.root
1925
# and finally update all children to reference the new id.
1926
# XXX: this should be safe to just look at the root.children
1927
# list, not the WHOLE INVENTORY.
1930
if entry.parent_id == orig_root_id:
1931
entry.parent_id = inv.root.file_id
1934
"""See Branch.unlock.
1936
WorkingTree locking just uses the Branch locking facilities.
1937
This is current because all working trees have an embedded branch
1938
within them. IF in the future, we were to make branch data shareable
1939
between multiple working trees, i.e. via shared storage, then we
1940
would probably want to lock both the local tree, and the branch.
1942
raise NotImplementedError(self.unlock)
1945
"""Update a working tree along its branch.
1947
This will update the branch if its bound too, which means we have
1948
multiple trees involved:
1950
- The new basis tree of the master.
1951
- The old basis tree of the branch.
1952
- The old basis tree of the working tree.
1953
- The current working tree state.
1955
Pathologically, all three may be different, and non-ancestors of each
1956
other. Conceptually we want to:
1958
- Preserve the wt.basis->wt.state changes
1959
- Transform the wt.basis to the new master basis.
1960
- Apply a merge of the old branch basis to get any 'local' changes from
1962
- Restore the wt.basis->wt.state changes.
1964
There isn't a single operation at the moment to do that, so we:
1965
- Merge current state -> basis tree of the master w.r.t. the old tree
1967
- Do a 'normal' merge of the old branch basis if it is relevant.
1969
if self.branch.get_master_branch() is not None:
1971
update_branch = True
1973
self.lock_tree_write()
1974
update_branch = False
1977
old_tip = self.branch.update()
1980
return self._update_tree(old_tip)
1984
@needs_tree_write_lock
1985
def _update_tree(self, old_tip=None):
1986
"""Update a tree to the master branch.
1988
:param old_tip: if supplied, the previous tip revision the branch,
1989
before it was changed to the master branch's tip.
1991
# here if old_tip is not None, it is the old tip of the branch before
1992
# it was updated from the master branch. This should become a pending
1993
# merge in the working tree to preserve the user existing work. we
1994
# cant set that until we update the working trees last revision to be
1995
# one from the new branch, because it will just get absorbed by the
1996
# parent de-duplication logic.
1998
# We MUST save it even if an error occurs, because otherwise the users
1999
# local work is unreferenced and will appear to have been lost.
2003
last_rev = self.get_parent_ids()[0]
2006
if last_rev != self.branch.last_revision():
2007
# merge tree state up to new branch tip.
2008
basis = self.basis_tree()
2011
to_tree = self.branch.basis_tree()
2012
if basis.inventory.root is None:
2013
self.set_root_id(to_tree.inventory.root.file_id)
2015
result += merge.merge_inner(
2022
# TODO - dedup parents list with things merged by pull ?
2023
# reuse the tree we've updated to to set the basis:
2024
parent_trees = [(self.branch.last_revision(), to_tree)]
2025
merges = self.get_parent_ids()[1:]
2026
# Ideally we ask the tree for the trees here, that way the working
2027
# tree can decide whether to give us teh entire tree or give us a
2028
# lazy initialised tree. dirstate for instance will have the trees
2029
# in ram already, whereas a last-revision + basis-inventory tree
2030
# will not, but also does not need them when setting parents.
2031
for parent in merges:
2032
parent_trees.append(
2033
(parent, self.branch.repository.revision_tree(parent)))
2034
if old_tip is not None:
2035
parent_trees.append(
2036
(old_tip, self.branch.repository.revision_tree(old_tip)))
2037
self.set_parent_trees(parent_trees)
2038
last_rev = parent_trees[0][0]
2040
# the working tree had the same last-revision as the master
2041
# branch did. We may still have pivot local work from the local
2042
# branch into old_tip:
2043
if old_tip is not None:
2044
self.add_parent_tree_id(old_tip)
2045
if old_tip and old_tip != last_rev:
2046
# our last revision was not the prior branch last revision
2047
# and we have converted that last revision to a pending merge.
2048
# base is somewhere between the branch tip now
2049
# and the now pending merge
2051
# Since we just modified the working tree and inventory, flush out
2052
# the current state, before we modify it again.
2053
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2054
# requires it only because TreeTransform directly munges the
2055
# inventory and calls tree._write_inventory(). Ultimately we
2056
# should be able to remove this extra flush.
2058
from bzrlib.revision import common_ancestor
2060
base_rev_id = common_ancestor(self.branch.last_revision(),
2062
self.branch.repository)
2063
except errors.NoCommonAncestor:
2065
base_tree = self.branch.repository.revision_tree(base_rev_id)
2066
other_tree = self.branch.repository.revision_tree(old_tip)
2067
result += merge.merge_inner(
2074
def _write_hashcache_if_dirty(self):
2075
"""Write out the hashcache if it is dirty."""
2076
if self._hashcache.needs_write:
2078
self._hashcache.write()
2080
if e.errno not in (errno.EPERM, errno.EACCES):
2082
# TODO: jam 20061219 Should this be a warning? A single line
2083
# warning might be sufficient to let the user know what
2085
mutter('Could not write hashcache for %s\nError: %s',
2086
self._hashcache.cache_file_name(), e)
2088
@needs_tree_write_lock
2089
def _write_inventory(self, inv):
2090
"""Write inventory as the current inventory."""
2091
self._set_inventory(inv, dirty=True)
2094
def set_conflicts(self, arg):
2095
raise errors.UnsupportedOperation(self.set_conflicts, self)
2097
def add_conflicts(self, arg):
2098
raise errors.UnsupportedOperation(self.add_conflicts, self)
2101
def conflicts(self):
2102
conflicts = _mod_conflicts.ConflictList()
2103
for conflicted in self._iter_conflicts():
2106
if file_kind(self.abspath(conflicted)) != "file":
2108
except errors.NoSuchFile:
2111
for suffix in ('.THIS', '.OTHER'):
2113
kind = file_kind(self.abspath(conflicted+suffix))
2116
except errors.NoSuchFile:
2120
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2121
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2123
file_id=self.path2id(conflicted)))
2126
def walkdirs(self, prefix=""):
2127
"""Walk the directories of this tree.
2129
This API returns a generator, which is only valid during the current
2130
tree transaction - within a single lock_read or lock_write duration.
2132
If the tree is not locked, it may cause an error to be raised, depending
2133
on the tree implementation.
2135
disk_top = self.abspath(prefix)
2136
if disk_top.endswith('/'):
2137
disk_top = disk_top[:-1]
2138
top_strip_len = len(disk_top) + 1
2139
inventory_iterator = self._walkdirs(prefix)
2140
disk_iterator = osutils.walkdirs(disk_top, prefix)
2142
current_disk = disk_iterator.next()
2143
disk_finished = False
2145
if e.errno != errno.ENOENT:
2148
disk_finished = True
2150
current_inv = inventory_iterator.next()
2151
inv_finished = False
2152
except StopIteration:
2155
while not inv_finished or not disk_finished:
2156
if not disk_finished:
2157
# strip out .bzr dirs
2158
if current_disk[0][1][top_strip_len:] == '':
2159
# osutils.walkdirs can be made nicer -
2160
# yield the path-from-prefix rather than the pathjoined
2162
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2163
if current_disk[1][bzrdir_loc][0] == '.bzr':
2164
# we dont yield the contents of, or, .bzr itself.
2165
del current_disk[1][bzrdir_loc]
2167
# everything is unknown
2170
# everything is missing
2173
direction = cmp(current_inv[0][0], current_disk[0][0])
2175
# disk is before inventory - unknown
2176
dirblock = [(relpath, basename, kind, stat, None, None) for
2177
relpath, basename, kind, stat, top_path in current_disk[1]]
2178
yield (current_disk[0][0], None), dirblock
2180
current_disk = disk_iterator.next()
2181
except StopIteration:
2182
disk_finished = True
2184
# inventory is before disk - missing.
2185
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2186
for relpath, basename, dkind, stat, fileid, kind in
2188
yield (current_inv[0][0], current_inv[0][1]), dirblock
2190
current_inv = inventory_iterator.next()
2191
except StopIteration:
2194
# versioned present directory
2195
# merge the inventory and disk data together
2197
for relpath, subiterator in itertools.groupby(sorted(
2198
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2199
path_elements = list(subiterator)
2200
if len(path_elements) == 2:
2201
inv_row, disk_row = path_elements
2202
# versioned, present file
2203
dirblock.append((inv_row[0],
2204
inv_row[1], disk_row[2],
2205
disk_row[3], inv_row[4],
2207
elif len(path_elements[0]) == 5:
2209
dirblock.append((path_elements[0][0],
2210
path_elements[0][1], path_elements[0][2],
2211
path_elements[0][3], None, None))
2212
elif len(path_elements[0]) == 6:
2213
# versioned, absent file.
2214
dirblock.append((path_elements[0][0],
2215
path_elements[0][1], 'unknown', None,
2216
path_elements[0][4], path_elements[0][5]))
2218
raise NotImplementedError('unreachable code')
2219
yield current_inv[0], dirblock
2221
current_inv = inventory_iterator.next()
2222
except StopIteration:
2225
current_disk = disk_iterator.next()
2226
except StopIteration:
2227
disk_finished = True
2229
def _walkdirs(self, prefix=""):
2230
_directory = 'directory'
2231
# get the root in the inventory
2232
inv = self.inventory
2233
top_id = inv.path2id(prefix)
2237
pending = [(prefix, '', _directory, None, top_id, None)]
2240
currentdir = pending.pop()
2241
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2242
top_id = currentdir[4]
2244
relroot = currentdir[0] + '/'
2247
# FIXME: stash the node in pending
2249
for name, child in entry.sorted_children():
2250
dirblock.append((relroot + name, name, child.kind, None,
2251
child.file_id, child.kind
2253
yield (currentdir[0], entry.file_id), dirblock
2254
# push the user specified dirs from dirblock
2255
for dir in reversed(dirblock):
2256
if dir[2] == _directory:
2259
@needs_tree_write_lock
2260
def auto_resolve(self):
2261
"""Automatically resolve text conflicts according to contents.
2263
Only text conflicts are auto_resolvable. Files with no conflict markers
2264
are considered 'resolved', because bzr always puts conflict markers
2265
into files that have text conflicts. The corresponding .THIS .BASE and
2266
.OTHER files are deleted, as per 'resolve'.
2267
:return: a tuple of ConflictLists: (un_resolved, resolved).
2269
un_resolved = _mod_conflicts.ConflictList()
2270
resolved = _mod_conflicts.ConflictList()
2271
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2272
for conflict in self.conflicts():
2273
if (conflict.typestring != 'text conflict' or
2274
self.kind(conflict.file_id) != 'file'):
2275
un_resolved.append(conflict)
2277
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2279
for line in my_file:
2280
if conflict_re.search(line):
2281
un_resolved.append(conflict)
2284
resolved.append(conflict)
2287
resolved.remove_files(self)
2288
self.set_conflicts(un_resolved)
2289
return un_resolved, resolved
2292
class WorkingTree2(WorkingTree):
2293
"""This is the Format 2 working tree.
2295
This was the first weave based working tree.
2296
- uses os locks for locking.
2297
- uses the branch last-revision.
2300
def __init__(self, *args, **kwargs):
2301
super(WorkingTree2, self).__init__(*args, **kwargs)
2302
# WorkingTree2 has more of a constraint that self._inventory must
2303
# exist. Because this is an older format, we don't mind the overhead
2304
# caused by the extra computation here.
2306
# Newer WorkingTree's should only have self._inventory set when they
2308
if self._inventory is None:
2309
self.read_working_inventory()
2311
def lock_tree_write(self):
2312
"""See WorkingTree.lock_tree_write().
2314
In Format2 WorkingTrees we have a single lock for the branch and tree
2315
so lock_tree_write() degrades to lock_write().
2317
self.branch.lock_write()
2319
return self._control_files.lock_write()
2321
self.branch.unlock()
2325
# we share control files:
2326
if self._control_files._lock_count == 3:
2327
# _inventory_is_modified is always False during a read lock.
2328
if self._inventory_is_modified:
2330
self._write_hashcache_if_dirty()
2332
# reverse order of locking.
2334
return self._control_files.unlock()
2336
self.branch.unlock()
2339
class WorkingTree3(WorkingTree):
2340
"""This is the Format 3 working tree.
2342
This differs from the base WorkingTree by:
2343
- having its own file lock
2344
- having its own last-revision property.
2346
This is new in bzr 0.8
2350
def _last_revision(self):
2351
"""See Mutable.last_revision."""
2353
return osutils.safe_revision_id(
2354
self._control_files.get('last-revision').read())
2355
except errors.NoSuchFile:
2358
def _change_last_revision(self, revision_id):
2359
"""See WorkingTree._change_last_revision."""
2360
if revision_id is None or revision_id == NULL_REVISION:
2362
self._control_files._transport.delete('last-revision')
2363
except errors.NoSuchFile:
2367
self._control_files.put_bytes('last-revision', revision_id)
2370
@needs_tree_write_lock
2371
def set_conflicts(self, conflicts):
2372
self._put_rio('conflicts', conflicts.to_stanzas(),
2375
@needs_tree_write_lock
2376
def add_conflicts(self, new_conflicts):
2377
conflict_set = set(self.conflicts())
2378
conflict_set.update(set(list(new_conflicts)))
2379
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2380
key=_mod_conflicts.Conflict.sort_key)))
2383
def conflicts(self):
2385
confile = self._control_files.get('conflicts')
2386
except errors.NoSuchFile:
2387
return _mod_conflicts.ConflictList()
2389
if confile.next() != CONFLICT_HEADER_1 + '\n':
2390
raise errors.ConflictFormatError()
2391
except StopIteration:
2392
raise errors.ConflictFormatError()
2393
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2396
if self._control_files._lock_count == 1:
2397
# _inventory_is_modified is always False during a read lock.
2398
if self._inventory_is_modified:
2400
self._write_hashcache_if_dirty()
2401
# reverse order of locking.
2403
return self._control_files.unlock()
2405
self.branch.unlock()
2408
def get_conflicted_stem(path):
2409
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2410
if path.endswith(suffix):
2411
return path[:-len(suffix)]
2414
@deprecated_function(zero_eight)
2415
def is_control_file(filename):
2416
"""See WorkingTree.is_control_filename(filename)."""
2417
## FIXME: better check
2418
filename = normpath(filename)
2419
while filename != '':
2420
head, tail = os.path.split(filename)
2421
## mutter('check %r for control file' % ((head, tail),))
2424
if filename == head:
2430
class WorkingTreeFormat(object):
2431
"""An encapsulation of the initialization and open routines for a format.
2433
Formats provide three things:
2434
* An initialization routine,
2438
Formats are placed in an dict by their format string for reference
2439
during workingtree opening. Its not required that these be instances, they
2440
can be classes themselves with class methods - it simply depends on
2441
whether state is needed for a given format or not.
2443
Once a format is deprecated, just deprecate the initialize and open
2444
methods on the format class. Do not deprecate the object, as the
2445
object will be created every time regardless.
2448
_default_format = None
2449
"""The default format used for new trees."""
2452
"""The known formats."""
2454
requires_rich_root = False
2457
def find_format(klass, a_bzrdir):
2458
"""Return the format for the working tree object in a_bzrdir."""
2460
transport = a_bzrdir.get_workingtree_transport(None)
2461
format_string = transport.get("format").read()
2462
return klass._formats[format_string]
2463
except errors.NoSuchFile:
2464
raise errors.NoWorkingTree(base=transport.base)
2466
raise errors.UnknownFormatError(format=format_string)
2468
def __eq__(self, other):
2469
return self.__class__ is other.__class__
2471
def __ne__(self, other):
2472
return not (self == other)
2475
def get_default_format(klass):
2476
"""Return the current default format."""
2477
return klass._default_format
2479
def get_format_string(self):
2480
"""Return the ASCII format string that identifies this format."""
2481
raise NotImplementedError(self.get_format_string)
2483
def get_format_description(self):
2484
"""Return the short description for this format."""
2485
raise NotImplementedError(self.get_format_description)
2487
def is_supported(self):
2488
"""Is this format supported?
2490
Supported formats can be initialized and opened.
2491
Unsupported formats may not support initialization or committing or
2492
some other features depending on the reason for not being supported.
2497
def register_format(klass, format):
2498
klass._formats[format.get_format_string()] = format
2501
def set_default_format(klass, format):
2502
klass._default_format = format
2505
def unregister_format(klass, format):
2506
assert klass._formats[format.get_format_string()] is format
2507
del klass._formats[format.get_format_string()]
2511
class WorkingTreeFormat2(WorkingTreeFormat):
2512
"""The second working tree format.
2514
This format modified the hash cache from the format 1 hash cache.
2517
def get_format_description(self):
2518
"""See WorkingTreeFormat.get_format_description()."""
2519
return "Working tree format 2"
2521
def stub_initialize_remote(self, control_files):
2522
"""As a special workaround create critical control files for a remote working tree
2524
This ensures that it can later be updated and dealt with locally,
2525
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2526
no working tree. (See bug #43064).
2530
xml5.serializer_v5.write_inventory(inv, sio)
2532
control_files.put('inventory', sio)
2534
control_files.put_bytes('pending-merges', '')
2537
def initialize(self, a_bzrdir, revision_id=None):
2538
"""See WorkingTreeFormat.initialize()."""
2539
if not isinstance(a_bzrdir.transport, LocalTransport):
2540
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2541
branch = a_bzrdir.open_branch()
2542
if revision_id is not None:
2543
revision_id = osutils.safe_revision_id(revision_id)
2546
revision_history = branch.revision_history()
2548
position = revision_history.index(revision_id)
2550
raise errors.NoSuchRevision(branch, revision_id)
2551
branch.set_revision_history(revision_history[:position + 1])
2554
revision = branch.last_revision()
2556
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2562
basis_tree = branch.repository.revision_tree(revision)
2563
if basis_tree.inventory.root is not None:
2564
wt.set_root_id(basis_tree.inventory.root.file_id)
2565
# set the parent list and cache the basis tree.
2566
wt.set_parent_trees([(revision, basis_tree)])
2567
transform.build_tree(basis_tree, wt)
2571
super(WorkingTreeFormat2, self).__init__()
2572
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2574
def open(self, a_bzrdir, _found=False):
2575
"""Return the WorkingTree object for a_bzrdir
2577
_found is a private parameter, do not use it. It is used to indicate
2578
if format probing has already been done.
2581
# we are being called directly and must probe.
2582
raise NotImplementedError
2583
if not isinstance(a_bzrdir.transport, LocalTransport):
2584
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2585
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2591
class WorkingTreeFormat3(WorkingTreeFormat):
2592
"""The second working tree format updated to record a format marker.
2595
- exists within a metadir controlling .bzr
2596
- includes an explicit version marker for the workingtree control
2597
files, separate from the BzrDir format
2598
- modifies the hash cache format
2600
- uses a LockDir to guard access for writes.
2603
def get_format_string(self):
2604
"""See WorkingTreeFormat.get_format_string()."""
2605
return "Bazaar-NG Working Tree format 3"
2607
def get_format_description(self):
2608
"""See WorkingTreeFormat.get_format_description()."""
2609
return "Working tree format 3"
2611
_lock_file_name = 'lock'
2612
_lock_class = LockDir
2614
_tree_class = WorkingTree3
2616
def __get_matchingbzrdir(self):
2617
return bzrdir.BzrDirMetaFormat1()
2619
_matchingbzrdir = property(__get_matchingbzrdir)
2621
def _open_control_files(self, a_bzrdir):
2622
transport = a_bzrdir.get_workingtree_transport(None)
2623
return LockableFiles(transport, self._lock_file_name,
2626
def initialize(self, a_bzrdir, revision_id=None):
2627
"""See WorkingTreeFormat.initialize().
2629
revision_id allows creating a working tree at a different
2630
revision than the branch is at.
2632
if not isinstance(a_bzrdir.transport, LocalTransport):
2633
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2634
transport = a_bzrdir.get_workingtree_transport(self)
2635
control_files = self._open_control_files(a_bzrdir)
2636
control_files.create_lock()
2637
control_files.lock_write()
2638
control_files.put_utf8('format', self.get_format_string())
2639
branch = a_bzrdir.open_branch()
2640
if revision_id is None:
2641
revision_id = branch.last_revision()
2643
revision_id = osutils.safe_revision_id(revision_id)
2644
# WorkingTree3 can handle an inventory which has a unique root id.
2645
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2646
# those trees. And because there isn't a format bump inbetween, we
2647
# are maintaining compatibility with older clients.
2648
# inv = Inventory(root_id=gen_root_id())
2649
inv = self._initial_inventory()
2650
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2656
_control_files=control_files)
2657
wt.lock_tree_write()
2659
basis_tree = branch.repository.revision_tree(revision_id)
2660
# only set an explicit root id if there is one to set.
2661
if basis_tree.inventory.root is not None:
2662
wt.set_root_id(basis_tree.inventory.root.file_id)
2663
if revision_id == NULL_REVISION:
2664
wt.set_parent_trees([])
2666
wt.set_parent_trees([(revision_id, basis_tree)])
2667
transform.build_tree(basis_tree, wt)
2669
# Unlock in this order so that the unlock-triggers-flush in
2670
# WorkingTree is given a chance to fire.
2671
control_files.unlock()
2675
def _initial_inventory(self):
2679
super(WorkingTreeFormat3, self).__init__()
2681
def open(self, a_bzrdir, _found=False):
2682
"""Return the WorkingTree object for a_bzrdir
2684
_found is a private parameter, do not use it. It is used to indicate
2685
if format probing has already been done.
2688
# we are being called directly and must probe.
2689
raise NotImplementedError
2690
if not isinstance(a_bzrdir.transport, LocalTransport):
2691
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2692
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2694
def _open(self, a_bzrdir, control_files):
2695
"""Open the tree itself.
2697
:param a_bzrdir: the dir for the tree.
2698
:param control_files: the control files for the tree.
2700
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2704
_control_files=control_files)
2707
return self.get_format_string()
2710
__default_format = WorkingTreeFormat4()
2711
WorkingTreeFormat.register_format(__default_format)
2712
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2713
WorkingTreeFormat.set_default_format(__default_format)
2714
# formats which have no format string are not discoverable
2715
# and not independently creatable, so are not registered.
2716
_legacy_formats = [WorkingTreeFormat2(),
2720
class WorkingTreeTestProviderAdapter(object):
2721
"""A tool to generate a suite testing multiple workingtree formats at once.
2723
This is done by copying the test once for each transport and injecting
2724
the transport_server, transport_readonly_server, and workingtree_format
2725
classes into each copy. Each copy is also given a new id() to make it
2729
def __init__(self, transport_server, transport_readonly_server, formats):
2730
self._transport_server = transport_server
2731
self._transport_readonly_server = transport_readonly_server
2732
self._formats = formats
2734
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2735
"""Clone test for adaption."""
2736
new_test = deepcopy(test)
2737
new_test.transport_server = self._transport_server
2738
new_test.transport_readonly_server = self._transport_readonly_server
2739
new_test.bzrdir_format = bzrdir_format
2740
new_test.workingtree_format = workingtree_format
2741
def make_new_test_id():
2742
new_id = "%s(%s)" % (test.id(), variation)
2743
return lambda: new_id
2744
new_test.id = make_new_test_id()
2747
def adapt(self, test):
2748
from bzrlib.tests import TestSuite
2749
result = TestSuite()
2750
for workingtree_format, bzrdir_format in self._formats:
2751
new_test = self._clone_test(
2754
workingtree_format, workingtree_format.__class__.__name__)
2755
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
