1
# Copyright (C) 2005, 2006 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(), """
45
from copy import deepcopy
54
conflicts as _mod_conflicts,
69
from bzrlib.transport import get_transport
73
from bzrlib import symbol_versioning
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
75
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
76
from bzrlib.lockable_files import LockableFiles, TransportLock
77
from bzrlib.lockdir import LockDir
78
import bzrlib.mutabletree
79
from bzrlib.mutabletree import needs_tree_write_lock
80
from bzrlib.osutils import (
92
from bzrlib.trace import mutter, note
93
from bzrlib.transport.local import LocalTransport
95
from bzrlib.progress import DummyProgress, ProgressPhase
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
97
import bzrlib.revisiontree
98
from bzrlib.rio import RioReader, rio_file, Stanza
99
from bzrlib.symbol_versioning import (deprecated_passed,
102
DEPRECATED_PARAMETER,
109
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
113
@deprecated_function(zero_thirteen)
114
def gen_file_id(name):
115
"""Return new file id for the basename 'name'.
117
Use bzrlib.generate_ids.gen_file_id() instead
119
return generate_ids.gen_file_id(name)
122
@deprecated_function(zero_thirteen)
124
"""Return a new tree-root file id.
126
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
128
return generate_ids.gen_root_id()
131
class TreeEntry(object):
132
"""An entry that implements the minimum interface used by commands.
134
This needs further inspection, it may be better to have
135
InventoryEntries without ids - though that seems wrong. For now,
136
this is a parallel hierarchy to InventoryEntry, and needs to become
137
one of several things: decorates to that hierarchy, children of, or
139
Another note is that these objects are currently only used when there is
140
no InventoryEntry available - i.e. for unversioned objects.
141
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
144
def __eq__(self, other):
145
# yes, this us ugly, TODO: best practice __eq__ style.
146
return (isinstance(other, TreeEntry)
147
and other.__class__ == self.__class__)
149
def kind_character(self):
153
class TreeDirectory(TreeEntry):
154
"""See TreeEntry. This is a directory in a working tree."""
156
def __eq__(self, other):
157
return (isinstance(other, TreeDirectory)
158
and other.__class__ == self.__class__)
160
def kind_character(self):
164
class TreeFile(TreeEntry):
165
"""See TreeEntry. This is a regular file in a working tree."""
167
def __eq__(self, other):
168
return (isinstance(other, TreeFile)
169
and other.__class__ == self.__class__)
171
def kind_character(self):
175
class TreeLink(TreeEntry):
176
"""See TreeEntry. This is a symlink in a working tree."""
178
def __eq__(self, other):
179
return (isinstance(other, TreeLink)
180
and other.__class__ == self.__class__)
182
def kind_character(self):
186
class WorkingTree(bzrlib.mutabletree.MutableTree):
187
"""Working copy tree.
189
The inventory is held in the `Branch` working-inventory, and the
190
files are in a directory on disk.
192
It is possible for a `WorkingTree` to have a filename which is
193
not listed in the Inventory and vice versa.
196
def __init__(self, basedir='.',
197
branch=DEPRECATED_PARAMETER,
203
"""Construct a WorkingTree for basedir.
205
If the branch is not supplied, it is opened automatically.
206
If the branch is supplied, it must be the branch for this basedir.
207
(branch.base is not cross checked, because for remote branches that
208
would be meaningless).
210
self._format = _format
211
self.bzrdir = _bzrdir
213
# not created via open etc.
214
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
215
"Please use bzrdir.open_workingtree or WorkingTree.open().",
218
wt = WorkingTree.open(basedir)
219
self._branch = wt.branch
220
self.basedir = wt.basedir
221
self._control_files = wt._control_files
222
self._hashcache = wt._hashcache
223
self._set_inventory(wt._inventory, dirty=False)
224
self._format = wt._format
225
self.bzrdir = wt.bzrdir
226
assert isinstance(basedir, basestring), \
227
"base directory %r is not a string" % basedir
228
basedir = safe_unicode(basedir)
229
mutter("opening working tree %r", basedir)
230
if deprecated_passed(branch):
232
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
233
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
234
" WorkingTree.open().",
238
self._branch = branch
240
self._branch = self.bzrdir.open_branch()
241
self.basedir = realpath(basedir)
242
# if branch is at our basedir and is a format 6 or less
243
if isinstance(self._format, WorkingTreeFormat2):
244
# share control object
245
self._control_files = self.branch.control_files
247
# assume all other formats have their own control files.
248
assert isinstance(_control_files, LockableFiles), \
249
"_control_files must be a LockableFiles, not %r" \
251
self._control_files = _control_files
252
# update the whole cache up front and write to disk if anything changed;
253
# in the future we might want to do this more selectively
254
# two possible ways offer themselves : in self._unlock, write the cache
255
# if needed, or, when the cache sees a change, append it to the hash
256
# cache file, and have the parser take the most recent entry for a
258
wt_trans = self.bzrdir.get_workingtree_transport(None)
259
cache_filename = wt_trans.local_abspath('stat-cache')
260
self._hashcache = hashcache.HashCache(basedir, cache_filename,
261
self._control_files._file_mode)
264
# is this scan needed ? it makes things kinda slow.
271
if _inventory is None:
272
self._inventory_is_modified = False
273
self.read_working_inventory()
275
# the caller of __init__ has provided an inventory,
276
# we assume they know what they are doing - as its only
277
# the Format factory and creation methods that are
278
# permitted to do this.
279
self._set_inventory(_inventory, dirty=False)
282
fget=lambda self: self._branch,
283
doc="""The branch this WorkingTree is connected to.
285
This cannot be set - it is reflective of the actual disk structure
286
the working tree has been constructed from.
289
def break_lock(self):
290
"""Break a lock if one is present from another instance.
292
Uses the ui factory to ask for confirmation if the lock may be from
295
This will probe the repository for its lock as well.
297
self._control_files.break_lock()
298
self.branch.break_lock()
300
def _set_inventory(self, inv, dirty):
301
"""Set the internal cached inventory.
303
:param inv: The inventory to set.
304
:param dirty: A boolean indicating whether the inventory is the same
305
logical inventory as whats on disk. If True the inventory is not
306
the same and should be written to disk or data will be lost, if
307
False then the inventory is the same as that on disk and any
308
serialisation would be unneeded overhead.
310
assert inv.root is not None
311
self._inventory = inv
312
self._inventory_is_modified = dirty
315
def open(path=None, _unsupported=False):
316
"""Open an existing working tree at path.
320
path = os.path.getcwdu()
321
control = bzrdir.BzrDir.open(path, _unsupported)
322
return control.open_workingtree(_unsupported)
325
def open_containing(path=None):
326
"""Open an existing working tree which has its root about path.
328
This probes for a working tree at path and searches upwards from there.
330
Basically we keep looking up until we find the control directory or
331
run into /. If there isn't one, raises NotBranchError.
332
TODO: give this a new exception.
333
If there is one, it is returned, along with the unused portion of path.
335
:return: The WorkingTree that contains 'path', and the rest of path
338
path = osutils.getcwd()
339
control, relpath = bzrdir.BzrDir.open_containing(path)
341
return control.open_workingtree(), relpath
344
def open_downlevel(path=None):
345
"""Open an unsupported working tree.
347
Only intended for advanced situations like upgrading part of a bzrdir.
349
return WorkingTree.open(path, _unsupported=True)
352
"""Iterate through file_ids for this tree.
354
file_ids are in a WorkingTree if they are in the working inventory
355
and the working file exists.
357
inv = self._inventory
358
for path, ie in inv.iter_entries():
359
if osutils.lexists(self.abspath(path)):
363
return "<%s of %s>" % (self.__class__.__name__,
364
getattr(self, 'basedir', None))
366
def abspath(self, filename):
367
return pathjoin(self.basedir, filename)
369
def basis_tree(self):
370
"""Return RevisionTree for the current last revision.
372
If the left most parent is a ghost then the returned tree will be an
373
empty tree - one obtained by calling repository.revision_tree(None).
376
revision_id = self.get_parent_ids()[0]
378
# no parents, return an empty revision tree.
379
# in the future this should return the tree for
380
# 'empty:' - the implicit root empty tree.
381
return self.branch.repository.revision_tree(None)
384
xml = self.read_basis_inventory()
385
inv = xml6.serializer_v6.read_inventory_from_string(xml)
386
if inv is not None and inv.revision_id == revision_id:
387
return bzrlib.revisiontree.RevisionTree(
388
self.branch.repository, inv, revision_id)
389
except (errors.NoSuchFile, errors.BadInventoryFormat):
391
# No cached copy available, retrieve from the repository.
392
# FIXME? RBC 20060403 should we cache the inventory locally
395
return self.branch.repository.revision_tree(revision_id)
396
except errors.RevisionNotPresent:
397
# the basis tree *may* be a ghost or a low level error may have
398
# occured. If the revision is present, its a problem, if its not
400
if self.branch.repository.has_revision(revision_id):
402
# the basis tree is a ghost so return an empty tree.
403
return self.branch.repository.revision_tree(None)
406
@deprecated_method(zero_eight)
407
def create(branch, directory):
408
"""Create a workingtree for branch at directory.
410
If existing_directory already exists it must have a .bzr directory.
411
If it does not exist, it will be created.
413
This returns a new WorkingTree object for the new checkout.
415
TODO FIXME RBC 20060124 when we have checkout formats in place this
416
should accept an optional revisionid to checkout [and reject this if
417
checking out into the same dir as a pre-checkout-aware branch format.]
419
XXX: When BzrDir is present, these should be created through that
422
warnings.warn('delete WorkingTree.create', stacklevel=3)
423
transport = get_transport(directory)
424
if branch.bzrdir.root_transport.base == transport.base:
426
return branch.bzrdir.create_workingtree()
427
# different directory,
428
# create a branch reference
429
# and now a working tree.
430
raise NotImplementedError
433
@deprecated_method(zero_eight)
434
def create_standalone(directory):
435
"""Create a checkout and a branch and a repo at directory.
437
Directory must exist and be empty.
439
please use BzrDir.create_standalone_workingtree
441
return bzrdir.BzrDir.create_standalone_workingtree(directory)
443
def relpath(self, path):
444
"""Return the local path portion from a given path.
446
The path may be absolute or relative. If its a relative path it is
447
interpreted relative to the python current working directory.
449
return osutils.relpath(self.basedir, path)
451
def has_filename(self, filename):
452
return osutils.lexists(self.abspath(filename))
454
def get_file(self, file_id):
455
file_id = osutils.safe_file_id(file_id)
456
return self.get_file_byname(self.id2path(file_id))
458
def get_file_text(self, file_id):
459
file_id = osutils.safe_file_id(file_id)
460
return self.get_file(file_id).read()
462
def get_file_byname(self, filename):
463
return file(self.abspath(filename), 'rb')
465
def annotate_iter(self, file_id):
466
"""See Tree.annotate_iter
468
This implementation will use the basis tree implementation if possible.
469
Lines not in the basis are attributed to CURRENT_REVISION
471
If there are pending merges, lines added by those merges will be
472
incorrectly attributed to CURRENT_REVISION (but after committing, the
473
attribution will be correct).
475
file_id = osutils.safe_file_id(file_id)
476
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [file_id]).next()
478
changed_content, kind = changes[2], changes[6]
479
if not changed_content:
480
return basis.annotate_iter(file_id)
484
if kind[0] != 'file':
487
old_lines = list(basis.annotate_iter(file_id))
489
for tree in self.branch.repository.revision_trees(
490
self.get_parent_ids()[1:]):
491
if file_id not in tree:
493
old.append(list(tree.annotate_iter(file_id)))
494
return annotate.reannotate(old, self.get_file(file_id).readlines(),
497
def get_parent_ids(self):
498
"""See Tree.get_parent_ids.
500
This implementation reads the pending merges list and last_revision
501
value and uses that to decide what the parents list should be.
503
last_rev = self._last_revision()
509
merges_file = self._control_files.get('pending-merges')
510
except errors.NoSuchFile:
513
for l in merges_file.readlines():
514
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
515
parents.append(revision_id)
519
def get_root_id(self):
520
"""Return the id of this trees root"""
521
return self._inventory.root.file_id
523
def _get_store_filename(self, file_id):
524
## XXX: badly named; this is not in the store at all
525
file_id = osutils.safe_file_id(file_id)
526
return self.abspath(self.id2path(file_id))
529
def clone(self, to_bzrdir, revision_id=None, basis=None):
530
"""Duplicate this working tree into to_bzr, including all state.
532
Specifically modified files are kept as modified, but
533
ignored and unknown files are discarded.
535
If you want to make a new line of development, see bzrdir.sprout()
538
If not None, the cloned tree will have its last revision set to
539
revision, and and difference between the source trees last revision
540
and this one merged in.
543
If not None, a closer copy of a tree which may have some files in
544
common, and which file content should be preferentially copied from.
546
# assumes the target bzr dir format is compatible.
547
result = self._format.initialize(to_bzrdir)
548
self.copy_content_into(result, revision_id)
552
def copy_content_into(self, tree, revision_id=None):
553
"""Copy the current content and user files of this tree into tree."""
554
tree.set_root_id(self.get_root_id())
555
if revision_id is None:
556
merge.transform_tree(tree, self)
558
# TODO now merge from tree.last_revision to revision (to preserve
559
# user local changes)
560
merge.transform_tree(tree, self)
561
tree.set_parent_ids([revision_id])
563
def id2abspath(self, file_id):
564
file_id = osutils.safe_file_id(file_id)
565
return self.abspath(self.id2path(file_id))
567
def has_id(self, file_id):
568
# files that have been deleted are excluded
569
file_id = osutils.safe_file_id(file_id)
570
inv = self._inventory
571
if not inv.has_id(file_id):
573
path = inv.id2path(file_id)
574
return osutils.lexists(self.abspath(path))
576
def has_or_had_id(self, file_id):
577
file_id = osutils.safe_file_id(file_id)
578
if file_id == self.inventory.root.file_id:
580
return self.inventory.has_id(file_id)
582
__contains__ = has_id
584
def get_file_size(self, file_id):
585
file_id = osutils.safe_file_id(file_id)
586
return os.path.getsize(self.id2abspath(file_id))
589
def get_file_sha1(self, file_id, path=None, stat_value=None):
590
file_id = osutils.safe_file_id(file_id)
592
path = self._inventory.id2path(file_id)
593
return self._hashcache.get_sha1(path, stat_value)
595
def get_file_mtime(self, file_id, path=None):
596
file_id = osutils.safe_file_id(file_id)
598
path = self._inventory.id2path(file_id)
599
return os.lstat(self.abspath(path)).st_mtime
601
if not supports_executable():
602
def is_executable(self, file_id, path=None):
603
file_id = osutils.safe_file_id(file_id)
604
return self._inventory[file_id].executable
606
def is_executable(self, file_id, path=None):
608
file_id = osutils.safe_file_id(file_id)
609
path = self._inventory.id2path(file_id)
610
mode = os.lstat(self.abspath(path)).st_mode
611
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
614
def _add(self, files, ids, kinds):
615
"""See MutableTree._add."""
616
# TODO: Re-adding a file that is removed in the working copy
617
# should probably put it back with the previous ID.
618
# the read and write working inventory should not occur in this
619
# function - they should be part of lock_write and unlock.
620
inv = self.read_working_inventory()
621
for f, file_id, kind in zip(files, ids, kinds):
622
assert kind is not None
624
inv.add_path(f, kind=kind)
626
file_id = osutils.safe_file_id(file_id)
627
inv.add_path(f, kind=kind, file_id=file_id)
628
self._write_inventory(inv)
630
@needs_tree_write_lock
631
def _gather_kinds(self, files, kinds):
632
"""See MutableTree._gather_kinds."""
633
for pos, f in enumerate(files):
634
if kinds[pos] is None:
635
fullpath = normpath(self.abspath(f))
637
kinds[pos] = file_kind(fullpath)
639
if e.errno == errno.ENOENT:
640
raise errors.NoSuchFile(fullpath)
643
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
644
"""Add revision_id as a parent.
646
This is equivalent to retrieving the current list of parent ids
647
and setting the list to its value plus revision_id.
649
:param revision_id: The revision id to add to the parent list. It may
650
be a ghost revision as long as its not the first parent to be added,
651
or the allow_leftmost_as_ghost parameter is set True.
652
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
654
parents = self.get_parent_ids() + [revision_id]
655
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
656
or allow_leftmost_as_ghost)
658
@needs_tree_write_lock
659
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
660
"""Add revision_id, tree tuple as a parent.
662
This is equivalent to retrieving the current list of parent trees
663
and setting the list to its value plus parent_tuple. See also
664
add_parent_tree_id - if you only have a parent id available it will be
665
simpler to use that api. If you have the parent already available, using
666
this api is preferred.
668
:param parent_tuple: The (revision id, tree) to add to the parent list.
669
If the revision_id is a ghost, pass None for the tree.
670
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
672
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
673
if len(parent_ids) > 1:
674
# the leftmost may have already been a ghost, preserve that if it
676
allow_leftmost_as_ghost = True
677
self.set_parent_ids(parent_ids,
678
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
680
@needs_tree_write_lock
681
def add_pending_merge(self, *revision_ids):
682
# TODO: Perhaps should check at this point that the
683
# history of the revision is actually present?
684
parents = self.get_parent_ids()
686
for rev_id in revision_ids:
687
if rev_id in parents:
689
parents.append(rev_id)
692
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
694
@deprecated_method(zero_eleven)
696
def pending_merges(self):
697
"""Return a list of pending merges.
699
These are revisions that have been merged into the working
700
directory but not yet committed.
702
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
703
instead - which is available on all tree objects.
705
return self.get_parent_ids()[1:]
707
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
708
"""Common ghost checking functionality from set_parent_*.
710
This checks that the left hand-parent exists if there are any
713
if len(revision_ids) > 0:
714
leftmost_id = revision_ids[0]
715
if (not allow_leftmost_as_ghost and not
716
self.branch.repository.has_revision(leftmost_id)):
717
raise errors.GhostRevisionUnusableHere(leftmost_id)
719
def _set_merges_from_parent_ids(self, parent_ids):
720
merges = parent_ids[1:]
721
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
723
@needs_tree_write_lock
724
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
725
"""Set the parent ids to revision_ids.
727
See also set_parent_trees. This api will try to retrieve the tree data
728
for each element of revision_ids from the trees repository. If you have
729
tree data already available, it is more efficient to use
730
set_parent_trees rather than set_parent_ids. set_parent_ids is however
731
an easier API to use.
733
:param revision_ids: The revision_ids to set as the parent ids of this
734
working tree. Any of these may be ghosts.
736
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
737
self._check_parents_for_ghosts(revision_ids,
738
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
740
if len(revision_ids) > 0:
741
self.set_last_revision(revision_ids[0])
743
self.set_last_revision(None)
745
self._set_merges_from_parent_ids(revision_ids)
747
@needs_tree_write_lock
748
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
749
"""See MutableTree.set_parent_trees."""
750
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
752
self._check_parents_for_ghosts(parent_ids,
753
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
755
if len(parent_ids) == 0:
756
leftmost_parent_id = None
757
leftmost_parent_tree = None
759
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
761
if self._change_last_revision(leftmost_parent_id):
762
if leftmost_parent_tree is None:
763
# If we don't have a tree, fall back to reading the
764
# parent tree from the repository.
765
self._cache_basis_inventory(leftmost_parent_id)
767
inv = leftmost_parent_tree.inventory
768
xml = self._create_basis_xml_from_inventory(
769
leftmost_parent_id, inv)
770
self._write_basis_inventory(xml)
771
self._set_merges_from_parent_ids(parent_ids)
773
@needs_tree_write_lock
774
def set_pending_merges(self, rev_list):
775
parents = self.get_parent_ids()
776
leftmost = parents[:1]
777
new_parents = leftmost + rev_list
778
self.set_parent_ids(new_parents)
780
@needs_tree_write_lock
781
def set_merge_modified(self, modified_hashes):
783
for file_id, hash in modified_hashes.iteritems():
784
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
785
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
787
def _put_rio(self, filename, stanzas, header):
788
self._must_be_locked()
789
my_file = rio_file(stanzas, header)
790
self._control_files.put(filename, my_file)
792
@needs_write_lock # because merge pulls data into the branch.
793
def merge_from_branch(self, branch, to_revision=None):
794
"""Merge from a branch into this working tree.
796
:param branch: The branch to merge from.
797
:param to_revision: If non-None, the merge will merge to to_revision,
798
but not beyond it. to_revision does not need to be in the history
799
of the branch when it is supplied. If None, to_revision defaults to
800
branch.last_revision().
802
from bzrlib.merge import Merger, Merge3Merger
803
pb = bzrlib.ui.ui_factory.nested_progress_bar()
805
merger = Merger(self.branch, this_tree=self, pb=pb)
806
merger.pp = ProgressPhase("Merge phase", 5, pb)
807
merger.pp.next_phase()
808
# check that there are no
810
merger.check_basis(check_clean=True, require_commits=False)
811
if to_revision is None:
812
to_revision = branch.last_revision()
814
to_revision = osutils.safe_revision_id(to_revision)
815
merger.other_rev_id = to_revision
816
if merger.other_rev_id is None:
817
raise error.NoCommits(branch)
818
self.branch.fetch(branch, last_revision=merger.other_rev_id)
819
merger.other_basis = merger.other_rev_id
820
merger.other_tree = self.branch.repository.revision_tree(
822
merger.pp.next_phase()
824
if merger.base_rev_id == merger.other_rev_id:
825
raise errors.PointlessMerge
826
merger.backup_files = False
827
merger.merge_type = Merge3Merger
828
merger.set_interesting_files(None)
829
merger.show_base = False
830
merger.reprocess = False
831
conflicts = merger.do_merge()
838
def merge_modified(self):
839
"""Return a dictionary of files modified by a merge.
841
The list is initialized by WorkingTree.set_merge_modified, which is
842
typically called after we make some automatic updates to the tree
845
This returns a map of file_id->sha1, containing only files which are
846
still in the working inventory and have that text hash.
849
hashfile = self._control_files.get('merge-hashes')
850
except errors.NoSuchFile:
854
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
855
raise errors.MergeModifiedFormatError()
856
except StopIteration:
857
raise errors.MergeModifiedFormatError()
858
for s in RioReader(hashfile):
859
file_id = s.get("file_id")
860
if file_id not in self.inventory:
862
text_hash = s.get("hash")
863
if text_hash == self.get_file_sha1(file_id):
864
merge_hashes[file_id] = text_hash
868
def mkdir(self, path, file_id=None):
869
"""See MutableTree.mkdir()."""
871
file_id = generate_ids.gen_file_id(os.path.basename(path))
872
os.mkdir(self.abspath(path))
873
self.add(path, file_id, 'directory')
876
def get_symlink_target(self, file_id):
877
return os.readlink(self.id2abspath(file_id))
879
def file_class(self, filename):
880
if self.path2id(filename):
882
elif self.is_ignored(filename):
888
"""Write the in memory inventory to disk."""
889
# TODO: Maybe this should only write on dirty ?
890
if self._control_files._lock_mode != 'w':
891
raise errors.NotWriteLocked(self)
893
xml5.serializer_v5.write_inventory(self._inventory, sio)
895
self._control_files.put('inventory', sio)
896
self._inventory_is_modified = False
898
def list_files(self, include_root=False):
899
"""Recursively list all files as (path, class, kind, id, entry).
901
Lists, but does not descend into unversioned directories.
903
This does not include files that have been deleted in this
906
Skips the control directory.
908
inv = self._inventory
909
if include_root is True:
910
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
911
# Convert these into local objects to save lookup times
912
pathjoin = osutils.pathjoin
913
file_kind = osutils.file_kind
915
# transport.base ends in a slash, we want the piece
916
# between the last two slashes
917
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
919
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
921
# directory file_id, relative path, absolute path, reverse sorted children
922
children = os.listdir(self.basedir)
924
# jam 20060527 The kernel sized tree seems equivalent whether we
925
# use a deque and popleft to keep them sorted, or if we use a plain
926
# list and just reverse() them.
927
children = collections.deque(children)
928
stack = [(inv.root.file_id, u'', self.basedir, children)]
930
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
933
f = children.popleft()
934
## TODO: If we find a subdirectory with its own .bzr
935
## directory, then that is a separate tree and we
936
## should exclude it.
938
# the bzrdir for this tree
939
if transport_base_dir == f:
942
# we know that from_dir_relpath and from_dir_abspath never end in a slash
943
# and 'f' doesn't begin with one, we can do a string op, rather
944
# than the checks of pathjoin(), all relative paths will have an extra slash
946
fp = from_dir_relpath + '/' + f
949
fap = from_dir_abspath + '/' + f
951
f_ie = inv.get_child(from_dir_id, f)
954
elif self.is_ignored(fp[1:]):
957
# we may not have found this file, because of a unicode issue
958
f_norm, can_access = osutils.normalized_filename(f)
959
if f == f_norm or not can_access:
960
# No change, so treat this file normally
963
# this file can be accessed by a normalized path
964
# check again if it is versioned
965
# these lines are repeated here for performance
967
fp = from_dir_relpath + '/' + f
968
fap = from_dir_abspath + '/' + f
969
f_ie = inv.get_child(from_dir_id, f)
972
elif self.is_ignored(fp[1:]):
981
raise errors.BzrCheckError(
982
"file %r entered as kind %r id %r, now of kind %r"
983
% (fap, f_ie.kind, f_ie.file_id, fk))
985
# make a last minute entry
987
yield fp[1:], c, fk, f_ie.file_id, f_ie
990
yield fp[1:], c, fk, None, fk_entries[fk]()
992
yield fp[1:], c, fk, None, TreeEntry()
995
if fk != 'directory':
998
# But do this child first
999
new_children = os.listdir(fap)
1001
new_children = collections.deque(new_children)
1002
stack.append((f_ie.file_id, fp, fap, new_children))
1003
# Break out of inner loop,
1004
# so that we start outer loop with child
1007
# if we finished all children, pop it off the stack
1010
@needs_tree_write_lock
1011
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1014
to_dir must exist in the inventory.
1016
If to_dir exists and is a directory, the files are moved into
1017
it, keeping their old names.
1019
Note that to_dir is only the last component of the new name;
1020
this doesn't change the directory.
1022
For each entry in from_paths the move mode will be determined
1025
The first mode moves the file in the filesystem and updates the
1026
inventory. The second mode only updates the inventory without
1027
touching the file on the filesystem. This is the new mode introduced
1030
move uses the second mode if 'after == True' and the target is not
1031
versioned but present in the working tree.
1033
move uses the second mode if 'after == False' and the source is
1034
versioned but no longer in the working tree, and the target is not
1035
versioned but present in the working tree.
1037
move uses the first mode if 'after == False' and the source is
1038
versioned and present in the working tree, and the target is not
1039
versioned and not present in the working tree.
1041
Everything else results in an error.
1043
This returns a list of (from_path, to_path) pairs for each
1044
entry that is moved.
1049
# check for deprecated use of signature
1051
to_dir = kwargs.get('to_name', None)
1053
raise TypeError('You must supply a target directory')
1055
symbol_versioning.warn('The parameter to_name was deprecated'
1056
' in version 0.13. Use to_dir instead',
1059
# check destination directory
1060
assert not isinstance(from_paths, basestring)
1061
inv = self.inventory
1062
to_abs = self.abspath(to_dir)
1063
if not isdir(to_abs):
1064
raise errors.BzrMoveFailedError('',to_dir,
1065
errors.NotADirectory(to_abs))
1066
if not self.has_filename(to_dir):
1067
raise errors.BzrMoveFailedError('',to_dir,
1068
errors.NotInWorkingDirectory(to_dir))
1069
to_dir_id = inv.path2id(to_dir)
1070
if to_dir_id is None:
1071
raise errors.BzrMoveFailedError('',to_dir,
1072
errors.NotVersionedError(path=str(to_dir)))
1074
to_dir_ie = inv[to_dir_id]
1075
if to_dir_ie.kind != 'directory':
1076
raise errors.BzrMoveFailedError('',to_dir,
1077
errors.NotADirectory(to_abs))
1079
# create rename entries and tuples
1080
for from_rel in from_paths:
1081
from_tail = splitpath(from_rel)[-1]
1082
from_id = inv.path2id(from_rel)
1084
raise errors.BzrMoveFailedError(from_rel,to_dir,
1085
errors.NotVersionedError(path=str(from_rel)))
1087
from_entry = inv[from_id]
1088
from_parent_id = from_entry.parent_id
1089
to_rel = pathjoin(to_dir, from_tail)
1090
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1092
from_tail=from_tail,
1093
from_parent_id=from_parent_id,
1094
to_rel=to_rel, to_tail=from_tail,
1095
to_parent_id=to_dir_id)
1096
rename_entries.append(rename_entry)
1097
rename_tuples.append((from_rel, to_rel))
1099
# determine which move mode to use. checks also for movability
1100
rename_entries = self._determine_mv_mode(rename_entries, after)
1102
original_modified = self._inventory_is_modified
1105
self._inventory_is_modified = True
1106
self._move(rename_entries)
1108
# restore the inventory on error
1109
self._inventory_is_modified = original_modified
1111
self._write_inventory(inv)
1112
return rename_tuples
1114
def _determine_mv_mode(self, rename_entries, after=False):
1115
"""Determines for each from-to pair if both inventory and working tree
1116
or only the inventory has to be changed.
1118
Also does basic plausability tests.
1120
inv = self.inventory
1122
for rename_entry in rename_entries:
1123
# store to local variables for easier reference
1124
from_rel = rename_entry.from_rel
1125
from_id = rename_entry.from_id
1126
to_rel = rename_entry.to_rel
1127
to_id = inv.path2id(to_rel)
1128
only_change_inv = False
1130
# check the inventory for source and destination
1132
raise errors.BzrMoveFailedError(from_rel,to_rel,
1133
errors.NotVersionedError(path=str(from_rel)))
1134
if to_id is not None:
1135
raise errors.BzrMoveFailedError(from_rel,to_rel,
1136
errors.AlreadyVersionedError(path=str(to_rel)))
1138
# try to determine the mode for rename (only change inv or change
1139
# inv and file system)
1141
if not self.has_filename(to_rel):
1142
raise errors.BzrMoveFailedError(from_id,to_rel,
1143
errors.NoSuchFile(path=str(to_rel),
1144
extra="New file has not been created yet"))
1145
only_change_inv = True
1146
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1147
only_change_inv = True
1148
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1149
only_change_inv = False
1151
# something is wrong, so lets determine what exactly
1152
if not self.has_filename(from_rel) and \
1153
not self.has_filename(to_rel):
1154
raise errors.BzrRenameFailedError(from_rel,to_rel,
1155
errors.PathsDoNotExist(paths=(str(from_rel),
1158
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1159
extra="(Use --after to update the Bazaar id)")
1160
rename_entry.only_change_inv = only_change_inv
1161
return rename_entries
1163
def _move(self, rename_entries):
1164
"""Moves a list of files.
1166
Depending on the value of the flag 'only_change_inv', the
1167
file will be moved on the file system or not.
1169
inv = self.inventory
1172
for entry in rename_entries:
1174
self._move_entry(entry)
1176
self._rollback_move(moved)
1180
def _rollback_move(self, moved):
1181
"""Try to rollback a previous move in case of an filesystem error."""
1182
inv = self.inventory
1185
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1186
entry.to_tail, entry.to_parent_id, entry.from_rel,
1187
entry.from_tail, entry.from_parent_id,
1188
entry.only_change_inv))
1189
except errors.BzrMoveFailedError, e:
1190
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1191
" The working tree is in an inconsistent state."
1192
" Please consider doing a 'bzr revert'."
1193
" Error message is: %s" % e)
1195
def _move_entry(self, entry):
1196
inv = self.inventory
1197
from_rel_abs = self.abspath(entry.from_rel)
1198
to_rel_abs = self.abspath(entry.to_rel)
1199
if from_rel_abs == to_rel_abs:
1200
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1201
"Source and target are identical.")
1203
if not entry.only_change_inv:
1205
osutils.rename(from_rel_abs, to_rel_abs)
1207
raise errors.BzrMoveFailedError(entry.from_rel,
1209
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1211
@needs_tree_write_lock
1212
def rename_one(self, from_rel, to_rel, after=False):
1215
This can change the directory or the filename or both.
1217
rename_one has several 'modes' to work. First, it can rename a physical
1218
file and change the file_id. That is the normal mode. Second, it can
1219
only change the file_id without touching any physical file. This is
1220
the new mode introduced in version 0.15.
1222
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1223
versioned but present in the working tree.
1225
rename_one uses the second mode if 'after == False' and 'from_rel' is
1226
versioned but no longer in the working tree, and 'to_rel' is not
1227
versioned but present in the working tree.
1229
rename_one uses the first mode if 'after == False' and 'from_rel' is
1230
versioned and present in the working tree, and 'to_rel' is not
1231
versioned and not present in the working tree.
1233
Everything else results in an error.
1235
inv = self.inventory
1238
# create rename entries and tuples
1239
from_tail = splitpath(from_rel)[-1]
1240
from_id = inv.path2id(from_rel)
1242
raise errors.BzrRenameFailedError(from_rel,to_rel,
1243
errors.NotVersionedError(path=str(from_rel)))
1244
from_entry = inv[from_id]
1245
from_parent_id = from_entry.parent_id
1246
to_dir, to_tail = os.path.split(to_rel)
1247
to_dir_id = inv.path2id(to_dir)
1248
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1250
from_tail=from_tail,
1251
from_parent_id=from_parent_id,
1252
to_rel=to_rel, to_tail=to_tail,
1253
to_parent_id=to_dir_id)
1254
rename_entries.append(rename_entry)
1256
# determine which move mode to use. checks also for movability
1257
rename_entries = self._determine_mv_mode(rename_entries, after)
1259
# check if the target changed directory and if the target directory is
1261
if to_dir_id is None:
1262
raise errors.BzrMoveFailedError(from_rel,to_rel,
1263
errors.NotVersionedError(path=str(to_dir)))
1265
# all checks done. now we can continue with our actual work
1266
mutter('rename_one:\n'
1271
' to_dir_id {%s}\n',
1272
from_id, from_rel, to_rel, to_dir, to_dir_id)
1274
self._move(rename_entries)
1275
self._write_inventory(inv)
1277
class _RenameEntry(object):
1278
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1279
to_rel, to_tail, to_parent_id, only_change_inv=False):
1280
self.from_rel = from_rel
1281
self.from_id = from_id
1282
self.from_tail = from_tail
1283
self.from_parent_id = from_parent_id
1284
self.to_rel = to_rel
1285
self.to_tail = to_tail
1286
self.to_parent_id = to_parent_id
1287
self.only_change_inv = only_change_inv
1291
"""Return all unknown files.
1293
These are files in the working directory that are not versioned or
1294
control files or ignored.
1296
for subp in self.extras():
1297
if not self.is_ignored(subp):
1300
@needs_tree_write_lock
1301
def unversion(self, file_ids):
1302
"""Remove the file ids in file_ids from the current versioned set.
1304
When a file_id is unversioned, all of its children are automatically
1307
:param file_ids: The file ids to stop versioning.
1308
:raises: NoSuchId if any fileid is not currently versioned.
1310
for file_id in file_ids:
1311
file_id = osutils.safe_file_id(file_id)
1312
if self._inventory.has_id(file_id):
1313
self._inventory.remove_recursive_id(file_id)
1315
raise errors.NoSuchId(self, file_id)
1317
# in the future this should just set a dirty bit to wait for the
1318
# final unlock. However, until all methods of workingtree start
1319
# with the current in -memory inventory rather than triggering
1320
# a read, it is more complex - we need to teach read_inventory
1321
# to know when to read, and when to not read first... and possibly
1322
# to save first when the in memory one may be corrupted.
1323
# so for now, we just only write it if it is indeed dirty.
1325
self._write_inventory(self._inventory)
1327
@deprecated_method(zero_eight)
1328
def iter_conflicts(self):
1329
"""List all files in the tree that have text or content conflicts.
1330
DEPRECATED. Use conflicts instead."""
1331
return self._iter_conflicts()
1333
def _iter_conflicts(self):
1335
for info in self.list_files():
1337
stem = get_conflicted_stem(path)
1340
if stem not in conflicted:
1341
conflicted.add(stem)
1345
def pull(self, source, overwrite=False, stop_revision=None,
1346
change_reporter=None):
1347
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1350
pp = ProgressPhase("Pull phase", 2, top_pb)
1352
old_revision_info = self.branch.last_revision_info()
1353
basis_tree = self.basis_tree()
1354
count = self.branch.pull(source, overwrite, stop_revision)
1355
new_revision_info = self.branch.last_revision_info()
1356
if new_revision_info != old_revision_info:
1358
repository = self.branch.repository
1359
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1361
new_basis_tree = self.branch.basis_tree()
1368
change_reporter=change_reporter)
1369
if (basis_tree.inventory.root is None and
1370
new_basis_tree.inventory.root is not None):
1371
self.set_root_id(new_basis_tree.inventory.root.file_id)
1374
# TODO - dedup parents list with things merged by pull ?
1375
# reuse the revisiontree we merged against to set the new
1377
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1378
# we have to pull the merge trees out again, because
1379
# merge_inner has set the ids. - this corner is not yet
1380
# layered well enough to prevent double handling.
1381
merges = self.get_parent_ids()[1:]
1382
parent_trees.extend([
1383
(parent, repository.revision_tree(parent)) for
1385
self.set_parent_trees(parent_trees)
1392
def put_file_bytes_non_atomic(self, file_id, bytes):
1393
"""See MutableTree.put_file_bytes_non_atomic."""
1394
file_id = osutils.safe_file_id(file_id)
1395
stream = file(self.id2abspath(file_id), 'wb')
1400
# TODO: update the hashcache here ?
1403
"""Yield all unknown files in this WorkingTree.
1405
If there are any unknown directories then only the directory is
1406
returned, not all its children. But if there are unknown files
1407
under a versioned subdirectory, they are returned.
1409
Currently returned depth-first, sorted by name within directories.
1411
## TODO: Work from given directory downwards
1412
for path, dir_entry in self.inventory.directories():
1413
# mutter("search for unknowns in %r", path)
1414
dirabs = self.abspath(path)
1415
if not isdir(dirabs):
1416
# e.g. directory deleted
1420
for subf in os.listdir(dirabs):
1423
if subf not in dir_entry.children:
1424
subf_norm, can_access = osutils.normalized_filename(subf)
1425
if subf_norm != subf and can_access:
1426
if subf_norm not in dir_entry.children:
1427
fl.append(subf_norm)
1433
subp = pathjoin(path, subf)
1437
def ignored_files(self):
1438
"""Yield list of PATH, IGNORE_PATTERN"""
1439
for subp in self.extras():
1440
pat = self.is_ignored(subp)
1444
def get_ignore_list(self):
1445
"""Return list of ignore patterns.
1447
Cached in the Tree object after the first call.
1449
ignoreset = getattr(self, '_ignoreset', None)
1450
if ignoreset is not None:
1453
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1454
ignore_globs.update(ignores.get_runtime_ignores())
1455
ignore_globs.update(ignores.get_user_ignores())
1456
if self.has_filename(bzrlib.IGNORE_FILENAME):
1457
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1459
ignore_globs.update(ignores.parse_ignore_file(f))
1462
self._ignoreset = ignore_globs
1465
def _flush_ignore_list_cache(self):
1466
"""Resets the cached ignore list to force a cache rebuild."""
1467
self._ignoreset = None
1468
self._ignoreglobster = None
1470
def is_ignored(self, filename):
1471
r"""Check whether the filename matches an ignore pattern.
1473
Patterns containing '/' or '\' need to match the whole path;
1474
others match against only the last component.
1476
If the file is ignored, returns the pattern which caused it to
1477
be ignored, otherwise None. So this can simply be used as a
1478
boolean if desired."""
1479
if getattr(self, '_ignoreglobster', None) is None:
1480
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1481
return self._ignoreglobster.match(filename)
1483
def kind(self, file_id):
1484
return file_kind(self.id2abspath(file_id))
1486
def _comparison_data(self, entry, path):
1487
abspath = self.abspath(path)
1489
stat_value = os.lstat(abspath)
1491
if getattr(e, 'errno', None) == errno.ENOENT:
1498
mode = stat_value.st_mode
1499
kind = osutils.file_kind_from_stat_mode(mode)
1500
if not supports_executable():
1501
executable = entry.executable
1503
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1504
return kind, executable, stat_value
1506
def _file_size(self, entry, stat_value):
1507
return stat_value.st_size
1509
def last_revision(self):
1510
"""Return the last revision of the branch for this tree.
1512
This format tree does not support a separate marker for last-revision
1513
compared to the branch.
1515
See MutableTree.last_revision
1517
return self._last_revision()
1520
def _last_revision(self):
1521
"""helper for get_parent_ids."""
1522
return self.branch.last_revision()
1524
def is_locked(self):
1525
return self._control_files.is_locked()
1527
def _must_be_locked(self):
1528
if not self.is_locked():
1529
raise errors.ObjectNotLocked(self)
1531
def lock_read(self):
1532
"""See Branch.lock_read, and WorkingTree.unlock."""
1533
self.branch.lock_read()
1535
return self._control_files.lock_read()
1537
self.branch.unlock()
1540
def lock_tree_write(self):
1541
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1542
self.branch.lock_read()
1544
return self._control_files.lock_write()
1546
self.branch.unlock()
1549
def lock_write(self):
1550
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1551
self.branch.lock_write()
1553
return self._control_files.lock_write()
1555
self.branch.unlock()
1558
def get_physical_lock_status(self):
1559
return self._control_files.get_physical_lock_status()
1561
def _basis_inventory_name(self):
1562
return 'basis-inventory-cache'
1564
@needs_tree_write_lock
1565
def set_last_revision(self, new_revision):
1566
"""Change the last revision in the working tree."""
1567
new_revision = osutils.safe_revision_id(new_revision)
1568
if self._change_last_revision(new_revision):
1569
self._cache_basis_inventory(new_revision)
1571
def _change_last_revision(self, new_revision):
1572
"""Template method part of set_last_revision to perform the change.
1574
This is used to allow WorkingTree3 instances to not affect branch
1575
when their last revision is set.
1577
if new_revision is None:
1578
self.branch.set_revision_history([])
1581
self.branch.generate_revision_history(new_revision)
1582
except errors.NoSuchRevision:
1583
# not present in the repo - dont try to set it deeper than the tip
1584
self.branch.set_revision_history([new_revision])
1587
def _write_basis_inventory(self, xml):
1588
"""Write the basis inventory XML to the basis-inventory file"""
1589
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1590
path = self._basis_inventory_name()
1592
self._control_files.put(path, sio)
1594
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1595
"""Create the text that will be saved in basis-inventory"""
1596
# TODO: jam 20070209 This should be redundant, as the revision_id
1597
# as all callers should have already converted the revision_id to
1599
inventory.revision_id = osutils.safe_revision_id(revision_id)
1600
return xml6.serializer_v6.write_inventory_to_string(inventory)
1602
def _cache_basis_inventory(self, new_revision):
1603
"""Cache new_revision as the basis inventory."""
1604
# TODO: this should allow the ready-to-use inventory to be passed in,
1605
# as commit already has that ready-to-use [while the format is the
1608
# this double handles the inventory - unpack and repack -
1609
# but is easier to understand. We can/should put a conditional
1610
# in here based on whether the inventory is in the latest format
1611
# - perhaps we should repack all inventories on a repository
1613
# the fast path is to copy the raw xml from the repository. If the
1614
# xml contains 'revision_id="', then we assume the right
1615
# revision_id is set. We must check for this full string, because a
1616
# root node id can legitimately look like 'revision_id' but cannot
1618
xml = self.branch.repository.get_inventory_xml(new_revision)
1619
firstline = xml.split('\n', 1)[0]
1620
if (not 'revision_id="' in firstline or
1621
'format="6"' not in firstline):
1622
inv = self.branch.repository.deserialise_inventory(
1624
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1625
self._write_basis_inventory(xml)
1626
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1629
def read_basis_inventory(self):
1630
"""Read the cached basis inventory."""
1631
path = self._basis_inventory_name()
1632
return self._control_files.get(path).read()
1635
def read_working_inventory(self):
1636
"""Read the working inventory.
1638
:raises errors.InventoryModified: read_working_inventory will fail
1639
when the current in memory inventory has been modified.
1641
# conceptually this should be an implementation detail of the tree.
1642
# XXX: Deprecate this.
1643
# ElementTree does its own conversion from UTF-8, so open in
1645
if self._inventory_is_modified:
1646
raise errors.InventoryModified(self)
1647
result = xml5.serializer_v5.read_inventory(
1648
self._control_files.get('inventory'))
1649
self._set_inventory(result, dirty=False)
1652
@needs_tree_write_lock
1653
def remove(self, files, verbose=False, to_file=None):
1654
"""Remove nominated files from the working inventory..
1656
This does not remove their text. This does not run on XXX on what? RBC
1658
TODO: Refuse to remove modified files unless --force is given?
1660
TODO: Do something useful with directories.
1662
TODO: Should this remove the text or not? Tough call; not
1663
removing may be useful and the user can just use use rm, and
1664
is the opposite of add. Removing it is consistent with most
1665
other tools. Maybe an option.
1667
## TODO: Normalize names
1668
## TODO: Remove nested loops; better scalability
1669
if isinstance(files, basestring):
1672
inv = self.inventory
1674
# do this before any modifications
1676
fid = inv.path2id(f)
1678
note("%s is not versioned."%f)
1681
# having remove it, it must be either ignored or unknown
1682
if self.is_ignored(f):
1686
textui.show_status(new_status, inv[fid].kind, f,
1690
self._write_inventory(inv)
1692
@needs_tree_write_lock
1693
def revert(self, filenames, old_tree=None, backups=True,
1694
pb=DummyProgress(), report_changes=False):
1695
from bzrlib.conflicts import resolve
1696
if old_tree is None:
1697
old_tree = self.basis_tree()
1698
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1700
if not len(filenames):
1701
self.set_parent_ids(self.get_parent_ids()[:1])
1704
resolve(self, filenames, ignore_misses=True)
1707
# XXX: This method should be deprecated in favour of taking in a proper
1708
# new Inventory object.
1709
@needs_tree_write_lock
1710
def set_inventory(self, new_inventory_list):
1711
from bzrlib.inventory import (Inventory,
1716
inv = Inventory(self.get_root_id())
1717
for path, file_id, parent, kind in new_inventory_list:
1718
name = os.path.basename(path)
1721
# fixme, there should be a factory function inv,add_??
1722
if kind == 'directory':
1723
inv.add(InventoryDirectory(file_id, name, parent))
1724
elif kind == 'file':
1725
inv.add(InventoryFile(file_id, name, parent))
1726
elif kind == 'symlink':
1727
inv.add(InventoryLink(file_id, name, parent))
1729
raise errors.BzrError("unknown kind %r" % kind)
1730
self._write_inventory(inv)
1732
@needs_tree_write_lock
1733
def set_root_id(self, file_id):
1734
"""Set the root id for this tree."""
1737
symbol_versioning.warn(symbol_versioning.zero_twelve
1738
% 'WorkingTree.set_root_id with fileid=None',
1743
file_id = osutils.safe_file_id(file_id)
1744
inv = self._inventory
1745
orig_root_id = inv.root.file_id
1746
# TODO: it might be nice to exit early if there was nothing
1747
# to do, saving us from trigger a sync on unlock.
1748
self._inventory_is_modified = True
1749
# we preserve the root inventory entry object, but
1750
# unlinkit from the byid index
1751
del inv._byid[inv.root.file_id]
1752
inv.root.file_id = file_id
1753
# and link it into the index with the new changed id.
1754
inv._byid[inv.root.file_id] = inv.root
1755
# and finally update all children to reference the new id.
1756
# XXX: this should be safe to just look at the root.children
1757
# list, not the WHOLE INVENTORY.
1760
if entry.parent_id == orig_root_id:
1761
entry.parent_id = inv.root.file_id
1764
"""See Branch.unlock.
1766
WorkingTree locking just uses the Branch locking facilities.
1767
This is current because all working trees have an embedded branch
1768
within them. IF in the future, we were to make branch data shareable
1769
between multiple working trees, i.e. via shared storage, then we
1770
would probably want to lock both the local tree, and the branch.
1772
raise NotImplementedError(self.unlock)
1775
"""Update a working tree along its branch.
1777
This will update the branch if its bound too, which means we have
1778
multiple trees involved:
1780
- The new basis tree of the master.
1781
- The old basis tree of the branch.
1782
- The old basis tree of the working tree.
1783
- The current working tree state.
1785
Pathologically, all three may be different, and non-ancestors of each
1786
other. Conceptually we want to:
1788
- Preserve the wt.basis->wt.state changes
1789
- Transform the wt.basis to the new master basis.
1790
- Apply a merge of the old branch basis to get any 'local' changes from
1792
- Restore the wt.basis->wt.state changes.
1794
There isn't a single operation at the moment to do that, so we:
1795
- Merge current state -> basis tree of the master w.r.t. the old tree
1797
- Do a 'normal' merge of the old branch basis if it is relevant.
1799
if self.branch.get_master_branch() is not None:
1801
update_branch = True
1803
self.lock_tree_write()
1804
update_branch = False
1807
old_tip = self.branch.update()
1810
return self._update_tree(old_tip)
1814
@needs_tree_write_lock
1815
def _update_tree(self, old_tip=None):
1816
"""Update a tree to the master branch.
1818
:param old_tip: if supplied, the previous tip revision the branch,
1819
before it was changed to the master branch's tip.
1821
# here if old_tip is not None, it is the old tip of the branch before
1822
# it was updated from the master branch. This should become a pending
1823
# merge in the working tree to preserve the user existing work. we
1824
# cant set that until we update the working trees last revision to be
1825
# one from the new branch, because it will just get absorbed by the
1826
# parent de-duplication logic.
1828
# We MUST save it even if an error occurs, because otherwise the users
1829
# local work is unreferenced and will appear to have been lost.
1833
last_rev = self.get_parent_ids()[0]
1836
if last_rev != self.branch.last_revision():
1837
# merge tree state up to new branch tip.
1838
basis = self.basis_tree()
1839
to_tree = self.branch.basis_tree()
1840
if basis.inventory.root is None:
1841
self.set_root_id(to_tree.inventory.root.file_id)
1842
result += merge.merge_inner(
1847
# TODO - dedup parents list with things merged by pull ?
1848
# reuse the tree we've updated to to set the basis:
1849
parent_trees = [(self.branch.last_revision(), to_tree)]
1850
merges = self.get_parent_ids()[1:]
1851
# Ideally we ask the tree for the trees here, that way the working
1852
# tree can decide whether to give us teh entire tree or give us a
1853
# lazy initialised tree. dirstate for instance will have the trees
1854
# in ram already, whereas a last-revision + basis-inventory tree
1855
# will not, but also does not need them when setting parents.
1856
for parent in merges:
1857
parent_trees.append(
1858
(parent, self.branch.repository.revision_tree(parent)))
1859
if old_tip is not None:
1860
parent_trees.append(
1861
(old_tip, self.branch.repository.revision_tree(old_tip)))
1862
self.set_parent_trees(parent_trees)
1863
last_rev = parent_trees[0][0]
1865
# the working tree had the same last-revision as the master
1866
# branch did. We may still have pivot local work from the local
1867
# branch into old_tip:
1868
if old_tip is not None:
1869
self.add_parent_tree_id(old_tip)
1870
if old_tip and old_tip != last_rev:
1871
# our last revision was not the prior branch last revision
1872
# and we have converted that last revision to a pending merge.
1873
# base is somewhere between the branch tip now
1874
# and the now pending merge
1875
from bzrlib.revision import common_ancestor
1877
base_rev_id = common_ancestor(self.branch.last_revision(),
1879
self.branch.repository)
1880
except errors.NoCommonAncestor:
1882
base_tree = self.branch.repository.revision_tree(base_rev_id)
1883
other_tree = self.branch.repository.revision_tree(old_tip)
1884
result += merge.merge_inner(
1891
def _write_hashcache_if_dirty(self):
1892
"""Write out the hashcache if it is dirty."""
1893
if self._hashcache.needs_write:
1895
self._hashcache.write()
1897
if e.errno not in (errno.EPERM, errno.EACCES):
1899
# TODO: jam 20061219 Should this be a warning? A single line
1900
# warning might be sufficient to let the user know what
1902
mutter('Could not write hashcache for %s\nError: %s',
1903
self._hashcache.cache_file_name(), e)
1905
@needs_tree_write_lock
1906
def _write_inventory(self, inv):
1907
"""Write inventory as the current inventory."""
1908
self._set_inventory(inv, dirty=True)
1911
def set_conflicts(self, arg):
1912
raise errors.UnsupportedOperation(self.set_conflicts, self)
1914
def add_conflicts(self, arg):
1915
raise errors.UnsupportedOperation(self.add_conflicts, self)
1918
def conflicts(self):
1919
conflicts = _mod_conflicts.ConflictList()
1920
for conflicted in self._iter_conflicts():
1923
if file_kind(self.abspath(conflicted)) != "file":
1925
except errors.NoSuchFile:
1928
for suffix in ('.THIS', '.OTHER'):
1930
kind = file_kind(self.abspath(conflicted+suffix))
1933
except errors.NoSuchFile:
1937
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1938
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1940
file_id=self.path2id(conflicted)))
1944
class WorkingTree2(WorkingTree):
1945
"""This is the Format 2 working tree.
1947
This was the first weave based working tree.
1948
- uses os locks for locking.
1949
- uses the branch last-revision.
1952
def lock_tree_write(self):
1953
"""See WorkingTree.lock_tree_write().
1955
In Format2 WorkingTrees we have a single lock for the branch and tree
1956
so lock_tree_write() degrades to lock_write().
1958
self.branch.lock_write()
1960
return self._control_files.lock_write()
1962
self.branch.unlock()
1966
# we share control files:
1967
if self._control_files._lock_count == 3:
1968
# _inventory_is_modified is always False during a read lock.
1969
if self._inventory_is_modified:
1971
self._write_hashcache_if_dirty()
1973
# reverse order of locking.
1975
return self._control_files.unlock()
1977
self.branch.unlock()
1980
class WorkingTree3(WorkingTree):
1981
"""This is the Format 3 working tree.
1983
This differs from the base WorkingTree by:
1984
- having its own file lock
1985
- having its own last-revision property.
1987
This is new in bzr 0.8
1991
def _last_revision(self):
1992
"""See Mutable.last_revision."""
1994
return osutils.safe_revision_id(
1995
self._control_files.get('last-revision').read())
1996
except errors.NoSuchFile:
1999
def _change_last_revision(self, revision_id):
2000
"""See WorkingTree._change_last_revision."""
2001
if revision_id is None or revision_id == NULL_REVISION:
2003
self._control_files._transport.delete('last-revision')
2004
except errors.NoSuchFile:
2008
self._control_files.put_bytes('last-revision', revision_id)
2011
@needs_tree_write_lock
2012
def set_conflicts(self, conflicts):
2013
self._put_rio('conflicts', conflicts.to_stanzas(),
2016
@needs_tree_write_lock
2017
def add_conflicts(self, new_conflicts):
2018
conflict_set = set(self.conflicts())
2019
conflict_set.update(set(list(new_conflicts)))
2020
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2021
key=_mod_conflicts.Conflict.sort_key)))
2024
def conflicts(self):
2026
confile = self._control_files.get('conflicts')
2027
except errors.NoSuchFile:
2028
return _mod_conflicts.ConflictList()
2030
if confile.next() != CONFLICT_HEADER_1 + '\n':
2031
raise errors.ConflictFormatError()
2032
except StopIteration:
2033
raise errors.ConflictFormatError()
2034
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2037
if self._control_files._lock_count == 1:
2038
# _inventory_is_modified is always False during a read lock.
2039
if self._inventory_is_modified:
2041
self._write_hashcache_if_dirty()
2042
# reverse order of locking.
2044
return self._control_files.unlock()
2046
self.branch.unlock()
2049
def get_conflicted_stem(path):
2050
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2051
if path.endswith(suffix):
2052
return path[:-len(suffix)]
2054
@deprecated_function(zero_eight)
2055
def is_control_file(filename):
2056
"""See WorkingTree.is_control_filename(filename)."""
2057
## FIXME: better check
2058
filename = normpath(filename)
2059
while filename != '':
2060
head, tail = os.path.split(filename)
2061
## mutter('check %r for control file' % ((head, tail),))
2064
if filename == head:
2070
class WorkingTreeFormat(object):
2071
"""An encapsulation of the initialization and open routines for a format.
2073
Formats provide three things:
2074
* An initialization routine,
2078
Formats are placed in an dict by their format string for reference
2079
during workingtree opening. Its not required that these be instances, they
2080
can be classes themselves with class methods - it simply depends on
2081
whether state is needed for a given format or not.
2083
Once a format is deprecated, just deprecate the initialize and open
2084
methods on the format class. Do not deprecate the object, as the
2085
object will be created every time regardless.
2088
_default_format = None
2089
"""The default format used for new trees."""
2092
"""The known formats."""
2095
def find_format(klass, a_bzrdir):
2096
"""Return the format for the working tree object in a_bzrdir."""
2098
transport = a_bzrdir.get_workingtree_transport(None)
2099
format_string = transport.get("format").read()
2100
return klass._formats[format_string]
2101
except errors.NoSuchFile:
2102
raise errors.NoWorkingTree(base=transport.base)
2104
raise errors.UnknownFormatError(format=format_string)
2107
def get_default_format(klass):
2108
"""Return the current default format."""
2109
return klass._default_format
2111
def get_format_string(self):
2112
"""Return the ASCII format string that identifies this format."""
2113
raise NotImplementedError(self.get_format_string)
2115
def get_format_description(self):
2116
"""Return the short description for this format."""
2117
raise NotImplementedError(self.get_format_description)
2119
def is_supported(self):
2120
"""Is this format supported?
2122
Supported formats can be initialized and opened.
2123
Unsupported formats may not support initialization or committing or
2124
some other features depending on the reason for not being supported.
2129
def register_format(klass, format):
2130
klass._formats[format.get_format_string()] = format
2133
def set_default_format(klass, format):
2134
klass._default_format = format
2137
def unregister_format(klass, format):
2138
assert klass._formats[format.get_format_string()] is format
2139
del klass._formats[format.get_format_string()]
2143
class WorkingTreeFormat2(WorkingTreeFormat):
2144
"""The second working tree format.
2146
This format modified the hash cache from the format 1 hash cache.
2149
def get_format_description(self):
2150
"""See WorkingTreeFormat.get_format_description()."""
2151
return "Working tree format 2"
2153
def stub_initialize_remote(self, control_files):
2154
"""As a special workaround create critical control files for a remote working tree
2156
This ensures that it can later be updated and dealt with locally,
2157
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2158
no working tree. (See bug #43064).
2162
xml5.serializer_v5.write_inventory(inv, sio)
2164
control_files.put('inventory', sio)
2166
control_files.put_bytes('pending-merges', '')
2169
def initialize(self, a_bzrdir, revision_id=None):
2170
"""See WorkingTreeFormat.initialize()."""
2171
if not isinstance(a_bzrdir.transport, LocalTransport):
2172
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2173
branch = a_bzrdir.open_branch()
2174
if revision_id is not None:
2175
revision_id = osutils.safe_revision_id(revision_id)
2178
revision_history = branch.revision_history()
2180
position = revision_history.index(revision_id)
2182
raise errors.NoSuchRevision(branch, revision_id)
2183
branch.set_revision_history(revision_history[:position + 1])
2186
revision = branch.last_revision()
2188
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2194
basis_tree = branch.repository.revision_tree(revision)
2195
if basis_tree.inventory.root is not None:
2196
wt.set_root_id(basis_tree.inventory.root.file_id)
2197
# set the parent list and cache the basis tree.
2198
wt.set_parent_trees([(revision, basis_tree)])
2199
transform.build_tree(basis_tree, wt)
2203
super(WorkingTreeFormat2, self).__init__()
2204
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2206
def open(self, a_bzrdir, _found=False):
2207
"""Return the WorkingTree object for a_bzrdir
2209
_found is a private parameter, do not use it. It is used to indicate
2210
if format probing has already been done.
2213
# we are being called directly and must probe.
2214
raise NotImplementedError
2215
if not isinstance(a_bzrdir.transport, LocalTransport):
2216
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2217
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2223
class WorkingTreeFormat3(WorkingTreeFormat):
2224
"""The second working tree format updated to record a format marker.
2227
- exists within a metadir controlling .bzr
2228
- includes an explicit version marker for the workingtree control
2229
files, separate from the BzrDir format
2230
- modifies the hash cache format
2232
- uses a LockDir to guard access for writes.
2235
def get_format_string(self):
2236
"""See WorkingTreeFormat.get_format_string()."""
2237
return "Bazaar-NG Working Tree format 3"
2239
def get_format_description(self):
2240
"""See WorkingTreeFormat.get_format_description()."""
2241
return "Working tree format 3"
2243
_lock_file_name = 'lock'
2244
_lock_class = LockDir
2246
def _open_control_files(self, a_bzrdir):
2247
transport = a_bzrdir.get_workingtree_transport(None)
2248
return LockableFiles(transport, self._lock_file_name,
2251
def initialize(self, a_bzrdir, revision_id=None):
2252
"""See WorkingTreeFormat.initialize().
2254
revision_id allows creating a working tree at a different
2255
revision than the branch is at.
2257
if not isinstance(a_bzrdir.transport, LocalTransport):
2258
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2259
transport = a_bzrdir.get_workingtree_transport(self)
2260
control_files = self._open_control_files(a_bzrdir)
2261
control_files.create_lock()
2262
control_files.lock_write()
2263
control_files.put_utf8('format', self.get_format_string())
2264
branch = a_bzrdir.open_branch()
2265
if revision_id is None:
2266
revision_id = branch.last_revision()
2268
revision_id = osutils.safe_revision_id(revision_id)
2269
# WorkingTree3 can handle an inventory which has a unique root id.
2270
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2271
# those trees. And because there isn't a format bump inbetween, we
2272
# are maintaining compatibility with older clients.
2273
# inv = Inventory(root_id=gen_root_id())
2275
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2281
_control_files=control_files)
2282
wt.lock_tree_write()
2284
basis_tree = branch.repository.revision_tree(revision_id)
2285
# only set an explicit root id if there is one to set.
2286
if basis_tree.inventory.root is not None:
2287
wt.set_root_id(basis_tree.inventory.root.file_id)
2288
if revision_id == NULL_REVISION:
2289
wt.set_parent_trees([])
2291
wt.set_parent_trees([(revision_id, basis_tree)])
2292
transform.build_tree(basis_tree, wt)
2294
# Unlock in this order so that the unlock-triggers-flush in
2295
# WorkingTree is given a chance to fire.
2296
control_files.unlock()
2301
super(WorkingTreeFormat3, self).__init__()
2302
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2304
def open(self, a_bzrdir, _found=False):
2305
"""Return the WorkingTree object for a_bzrdir
2307
_found is a private parameter, do not use it. It is used to indicate
2308
if format probing has already been done.
2311
# we are being called directly and must probe.
2312
raise NotImplementedError
2313
if not isinstance(a_bzrdir.transport, LocalTransport):
2314
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2315
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2317
def _open(self, a_bzrdir, control_files):
2318
"""Open the tree itself.
2320
:param a_bzrdir: the dir for the tree.
2321
:param control_files: the control files for the tree.
2323
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2327
_control_files=control_files)
2330
return self.get_format_string()
2333
# formats which have no format string are not discoverable
2334
# and not independently creatable, so are not registered.
2335
__default_format = WorkingTreeFormat3()
2336
WorkingTreeFormat.register_format(__default_format)
2337
WorkingTreeFormat.set_default_format(__default_format)
2338
_legacy_formats = [WorkingTreeFormat2(),
2342
class WorkingTreeTestProviderAdapter(object):
2343
"""A tool to generate a suite testing multiple workingtree formats at once.
2345
This is done by copying the test once for each transport and injecting
2346
the transport_server, transport_readonly_server, and workingtree_format
2347
classes into each copy. Each copy is also given a new id() to make it
2351
def __init__(self, transport_server, transport_readonly_server, formats):
2352
self._transport_server = transport_server
2353
self._transport_readonly_server = transport_readonly_server
2354
self._formats = formats
2356
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2357
"""Clone test for adaption."""
2358
new_test = deepcopy(test)
2359
new_test.transport_server = self._transport_server
2360
new_test.transport_readonly_server = self._transport_readonly_server
2361
new_test.bzrdir_format = bzrdir_format
2362
new_test.workingtree_format = workingtree_format
2363
def make_new_test_id():
2364
new_id = "%s(%s)" % (test.id(), variation)
2365
return lambda: new_id
2366
new_test.id = make_new_test_id()
2369
def adapt(self, test):
2370
from bzrlib.tests import TestSuite
2371
result = TestSuite()
2372
for workingtree_format, bzrdir_format in self._formats:
2373
new_test = self._clone_test(
2376
workingtree_format, workingtree_format.__class__.__name__)
2377
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
