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
@needs_tree_write_lock
788
def _put_rio(self, filename, stanzas, header):
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):
840
hashfile = self._control_files.get('merge-hashes')
841
except errors.NoSuchFile:
845
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
846
raise errors.MergeModifiedFormatError()
847
except StopIteration:
848
raise errors.MergeModifiedFormatError()
849
for s in RioReader(hashfile):
850
file_id = s.get("file_id")
851
if file_id not in self.inventory:
854
if hash == self.get_file_sha1(file_id):
855
merge_hashes[file_id] = hash
859
def mkdir(self, path, file_id=None):
860
"""See MutableTree.mkdir()."""
862
file_id = generate_ids.gen_file_id(os.path.basename(path))
863
os.mkdir(self.abspath(path))
864
self.add(path, file_id, 'directory')
867
def get_symlink_target(self, file_id):
868
return os.readlink(self.id2abspath(file_id))
870
def file_class(self, filename):
871
if self.path2id(filename):
873
elif self.is_ignored(filename):
879
"""Write the in memory inventory to disk."""
880
# TODO: Maybe this should only write on dirty ?
881
if self._control_files._lock_mode != 'w':
882
raise errors.NotWriteLocked(self)
884
xml5.serializer_v5.write_inventory(self._inventory, sio)
886
self._control_files.put('inventory', sio)
887
self._inventory_is_modified = False
889
def list_files(self, include_root=False):
890
"""Recursively list all files as (path, class, kind, id, entry).
892
Lists, but does not descend into unversioned directories.
894
This does not include files that have been deleted in this
897
Skips the control directory.
899
inv = self._inventory
900
if include_root is True:
901
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
902
# Convert these into local objects to save lookup times
903
pathjoin = osutils.pathjoin
904
file_kind = osutils.file_kind
906
# transport.base ends in a slash, we want the piece
907
# between the last two slashes
908
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
910
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
912
# directory file_id, relative path, absolute path, reverse sorted children
913
children = os.listdir(self.basedir)
915
# jam 20060527 The kernel sized tree seems equivalent whether we
916
# use a deque and popleft to keep them sorted, or if we use a plain
917
# list and just reverse() them.
918
children = collections.deque(children)
919
stack = [(inv.root.file_id, u'', self.basedir, children)]
921
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
924
f = children.popleft()
925
## TODO: If we find a subdirectory with its own .bzr
926
## directory, then that is a separate tree and we
927
## should exclude it.
929
# the bzrdir for this tree
930
if transport_base_dir == f:
933
# we know that from_dir_relpath and from_dir_abspath never end in a slash
934
# and 'f' doesn't begin with one, we can do a string op, rather
935
# than the checks of pathjoin(), all relative paths will have an extra slash
937
fp = from_dir_relpath + '/' + f
940
fap = from_dir_abspath + '/' + f
942
f_ie = inv.get_child(from_dir_id, f)
945
elif self.is_ignored(fp[1:]):
948
# we may not have found this file, because of a unicode issue
949
f_norm, can_access = osutils.normalized_filename(f)
950
if f == f_norm or not can_access:
951
# No change, so treat this file normally
954
# this file can be accessed by a normalized path
955
# check again if it is versioned
956
# these lines are repeated here for performance
958
fp = from_dir_relpath + '/' + f
959
fap = from_dir_abspath + '/' + f
960
f_ie = inv.get_child(from_dir_id, f)
963
elif self.is_ignored(fp[1:]):
972
raise errors.BzrCheckError(
973
"file %r entered as kind %r id %r, now of kind %r"
974
% (fap, f_ie.kind, f_ie.file_id, fk))
976
# make a last minute entry
978
yield fp[1:], c, fk, f_ie.file_id, f_ie
981
yield fp[1:], c, fk, None, fk_entries[fk]()
983
yield fp[1:], c, fk, None, TreeEntry()
986
if fk != 'directory':
989
# But do this child first
990
new_children = os.listdir(fap)
992
new_children = collections.deque(new_children)
993
stack.append((f_ie.file_id, fp, fap, new_children))
994
# Break out of inner loop,
995
# so that we start outer loop with child
998
# if we finished all children, pop it off the stack
1001
@needs_tree_write_lock
1002
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1005
to_dir must exist in the inventory.
1007
If to_dir exists and is a directory, the files are moved into
1008
it, keeping their old names.
1010
Note that to_dir is only the last component of the new name;
1011
this doesn't change the directory.
1013
For each entry in from_paths the move mode will be determined
1016
The first mode moves the file in the filesystem and updates the
1017
inventory. The second mode only updates the inventory without
1018
touching the file on the filesystem. This is the new mode introduced
1021
move uses the second mode if 'after == True' and the target is not
1022
versioned but present in the working tree.
1024
move uses the second mode if 'after == False' and the source is
1025
versioned but no longer in the working tree, and the target is not
1026
versioned but present in the working tree.
1028
move uses the first mode if 'after == False' and the source is
1029
versioned and present in the working tree, and the target is not
1030
versioned and not present in the working tree.
1032
Everything else results in an error.
1034
This returns a list of (from_path, to_path) pairs for each
1035
entry that is moved.
1040
# check for deprecated use of signature
1042
to_dir = kwargs.get('to_name', None)
1044
raise TypeError('You must supply a target directory')
1046
symbol_versioning.warn('The parameter to_name was deprecated'
1047
' in version 0.13. Use to_dir instead',
1050
# check destination directory
1051
assert not isinstance(from_paths, basestring)
1052
inv = self.inventory
1053
to_abs = self.abspath(to_dir)
1054
if not isdir(to_abs):
1055
raise errors.BzrMoveFailedError('',to_dir,
1056
errors.NotADirectory(to_abs))
1057
if not self.has_filename(to_dir):
1058
raise errors.BzrMoveFailedError('',to_dir,
1059
errors.NotInWorkingDirectory(to_dir))
1060
to_dir_id = inv.path2id(to_dir)
1061
if to_dir_id is None:
1062
raise errors.BzrMoveFailedError('',to_dir,
1063
errors.NotVersionedError(path=str(to_dir)))
1065
to_dir_ie = inv[to_dir_id]
1066
if to_dir_ie.kind != 'directory':
1067
raise errors.BzrMoveFailedError('',to_dir,
1068
errors.NotADirectory(to_abs))
1070
# create rename entries and tuples
1071
for from_rel in from_paths:
1072
from_tail = splitpath(from_rel)[-1]
1073
from_id = inv.path2id(from_rel)
1075
raise errors.BzrMoveFailedError(from_rel,to_dir,
1076
errors.NotVersionedError(path=str(from_rel)))
1078
from_entry = inv[from_id]
1079
from_parent_id = from_entry.parent_id
1080
to_rel = pathjoin(to_dir, from_tail)
1081
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1083
from_tail=from_tail,
1084
from_parent_id=from_parent_id,
1085
to_rel=to_rel, to_tail=from_tail,
1086
to_parent_id=to_dir_id)
1087
rename_entries.append(rename_entry)
1088
rename_tuples.append((from_rel, to_rel))
1090
# determine which move mode to use. checks also for movability
1091
rename_entries = self._determine_mv_mode(rename_entries, after)
1093
original_modified = self._inventory_is_modified
1096
self._inventory_is_modified = True
1097
self._move(rename_entries)
1099
# restore the inventory on error
1100
self._inventory_is_modified = original_modified
1102
self._write_inventory(inv)
1103
return rename_tuples
1105
def _determine_mv_mode(self, rename_entries, after=False):
1106
"""Determines for each from-to pair if both inventory and working tree
1107
or only the inventory has to be changed.
1109
Also does basic plausability tests.
1111
inv = self.inventory
1113
for rename_entry in rename_entries:
1114
# store to local variables for easier reference
1115
from_rel = rename_entry.from_rel
1116
from_id = rename_entry.from_id
1117
to_rel = rename_entry.to_rel
1118
to_id = inv.path2id(to_rel)
1119
only_change_inv = False
1121
# check the inventory for source and destination
1123
raise errors.BzrMoveFailedError(from_rel,to_rel,
1124
errors.NotVersionedError(path=str(from_rel)))
1125
if to_id is not None:
1126
raise errors.BzrMoveFailedError(from_rel,to_rel,
1127
errors.AlreadyVersionedError(path=str(to_rel)))
1129
# try to determine the mode for rename (only change inv or change
1130
# inv and file system)
1132
if not self.has_filename(to_rel):
1133
raise errors.BzrMoveFailedError(from_id,to_rel,
1134
errors.NoSuchFile(path=str(to_rel),
1135
extra="New file has not been created yet"))
1136
only_change_inv = True
1137
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1138
only_change_inv = True
1139
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1140
only_change_inv = False
1142
# something is wrong, so lets determine what exactly
1143
if not self.has_filename(from_rel) and \
1144
not self.has_filename(to_rel):
1145
raise errors.BzrRenameFailedError(from_rel,to_rel,
1146
errors.PathsDoNotExist(paths=(str(from_rel),
1149
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1150
extra="(Use --after to update the Bazaar id)")
1151
rename_entry.only_change_inv = only_change_inv
1152
return rename_entries
1154
def _move(self, rename_entries):
1155
"""Moves a list of files.
1157
Depending on the value of the flag 'only_change_inv', the
1158
file will be moved on the file system or not.
1160
inv = self.inventory
1163
for entry in rename_entries:
1165
self._move_entry(entry)
1167
self._rollback_move(moved)
1171
def _rollback_move(self, moved):
1172
"""Try to rollback a previous move in case of an filesystem error."""
1173
inv = self.inventory
1176
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1177
entry.to_tail, entry.to_parent_id, entry.from_rel,
1178
entry.from_tail, entry.from_parent_id,
1179
entry.only_change_inv))
1180
except errors.BzrMoveFailedError, e:
1181
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1182
" The working tree is in an inconsistent state."
1183
" Please consider doing a 'bzr revert'."
1184
" Error message is: %s" % e)
1186
def _move_entry(self, entry):
1187
inv = self.inventory
1188
from_rel_abs = self.abspath(entry.from_rel)
1189
to_rel_abs = self.abspath(entry.to_rel)
1190
if from_rel_abs == to_rel_abs:
1191
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1192
"Source and target are identical.")
1194
if not entry.only_change_inv:
1196
osutils.rename(from_rel_abs, to_rel_abs)
1198
raise errors.BzrMoveFailedError(entry.from_rel,
1200
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1202
@needs_tree_write_lock
1203
def rename_one(self, from_rel, to_rel, after=False):
1206
This can change the directory or the filename or both.
1208
rename_one has several 'modes' to work. First, it can rename a physical
1209
file and change the file_id. That is the normal mode. Second, it can
1210
only change the file_id without touching any physical file. This is
1211
the new mode introduced in version 0.15.
1213
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1214
versioned but present in the working tree.
1216
rename_one uses the second mode if 'after == False' and 'from_rel' is
1217
versioned but no longer in the working tree, and 'to_rel' is not
1218
versioned but present in the working tree.
1220
rename_one uses the first mode if 'after == False' and 'from_rel' is
1221
versioned and present in the working tree, and 'to_rel' is not
1222
versioned and not present in the working tree.
1224
Everything else results in an error.
1226
inv = self.inventory
1229
# create rename entries and tuples
1230
from_tail = splitpath(from_rel)[-1]
1231
from_id = inv.path2id(from_rel)
1233
raise errors.BzrRenameFailedError(from_rel,to_rel,
1234
errors.NotVersionedError(path=str(from_rel)))
1235
from_entry = inv[from_id]
1236
from_parent_id = from_entry.parent_id
1237
to_dir, to_tail = os.path.split(to_rel)
1238
to_dir_id = inv.path2id(to_dir)
1239
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1241
from_tail=from_tail,
1242
from_parent_id=from_parent_id,
1243
to_rel=to_rel, to_tail=to_tail,
1244
to_parent_id=to_dir_id)
1245
rename_entries.append(rename_entry)
1247
# determine which move mode to use. checks also for movability
1248
rename_entries = self._determine_mv_mode(rename_entries, after)
1250
# check if the target changed directory and if the target directory is
1252
if to_dir_id is None:
1253
raise errors.BzrMoveFailedError(from_rel,to_rel,
1254
errors.NotVersionedError(path=str(to_dir)))
1256
# all checks done. now we can continue with our actual work
1257
mutter('rename_one:\n'
1262
' to_dir_id {%s}\n',
1263
from_id, from_rel, to_rel, to_dir, to_dir_id)
1265
self._move(rename_entries)
1266
self._write_inventory(inv)
1268
class _RenameEntry(object):
1269
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1270
to_rel, to_tail, to_parent_id, only_change_inv=False):
1271
self.from_rel = from_rel
1272
self.from_id = from_id
1273
self.from_tail = from_tail
1274
self.from_parent_id = from_parent_id
1275
self.to_rel = to_rel
1276
self.to_tail = to_tail
1277
self.to_parent_id = to_parent_id
1278
self.only_change_inv = only_change_inv
1282
"""Return all unknown files.
1284
These are files in the working directory that are not versioned or
1285
control files or ignored.
1287
for subp in self.extras():
1288
if not self.is_ignored(subp):
1291
@needs_tree_write_lock
1292
def unversion(self, file_ids):
1293
"""Remove the file ids in file_ids from the current versioned set.
1295
When a file_id is unversioned, all of its children are automatically
1298
:param file_ids: The file ids to stop versioning.
1299
:raises: NoSuchId if any fileid is not currently versioned.
1301
for file_id in file_ids:
1302
file_id = osutils.safe_file_id(file_id)
1303
if self._inventory.has_id(file_id):
1304
self._inventory.remove_recursive_id(file_id)
1306
raise errors.NoSuchId(self, file_id)
1308
# in the future this should just set a dirty bit to wait for the
1309
# final unlock. However, until all methods of workingtree start
1310
# with the current in -memory inventory rather than triggering
1311
# a read, it is more complex - we need to teach read_inventory
1312
# to know when to read, and when to not read first... and possibly
1313
# to save first when the in memory one may be corrupted.
1314
# so for now, we just only write it if it is indeed dirty.
1316
self._write_inventory(self._inventory)
1318
@deprecated_method(zero_eight)
1319
def iter_conflicts(self):
1320
"""List all files in the tree that have text or content conflicts.
1321
DEPRECATED. Use conflicts instead."""
1322
return self._iter_conflicts()
1324
def _iter_conflicts(self):
1326
for info in self.list_files():
1328
stem = get_conflicted_stem(path)
1331
if stem not in conflicted:
1332
conflicted.add(stem)
1336
def pull(self, source, overwrite=False, stop_revision=None,
1337
change_reporter=None):
1338
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1341
pp = ProgressPhase("Pull phase", 2, top_pb)
1343
old_revision_info = self.branch.last_revision_info()
1344
basis_tree = self.basis_tree()
1345
count = self.branch.pull(source, overwrite, stop_revision)
1346
new_revision_info = self.branch.last_revision_info()
1347
if new_revision_info != old_revision_info:
1349
repository = self.branch.repository
1350
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1352
new_basis_tree = self.branch.basis_tree()
1359
change_reporter=change_reporter)
1360
if (basis_tree.inventory.root is None and
1361
new_basis_tree.inventory.root is not None):
1362
self.set_root_id(new_basis_tree.inventory.root.file_id)
1365
# TODO - dedup parents list with things merged by pull ?
1366
# reuse the revisiontree we merged against to set the new
1368
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1369
# we have to pull the merge trees out again, because
1370
# merge_inner has set the ids. - this corner is not yet
1371
# layered well enough to prevent double handling.
1372
merges = self.get_parent_ids()[1:]
1373
parent_trees.extend([
1374
(parent, repository.revision_tree(parent)) for
1376
self.set_parent_trees(parent_trees)
1383
def put_file_bytes_non_atomic(self, file_id, bytes):
1384
"""See MutableTree.put_file_bytes_non_atomic."""
1385
file_id = osutils.safe_file_id(file_id)
1386
stream = file(self.id2abspath(file_id), 'wb')
1391
# TODO: update the hashcache here ?
1394
"""Yield all unknown files in this WorkingTree.
1396
If there are any unknown directories then only the directory is
1397
returned, not all its children. But if there are unknown files
1398
under a versioned subdirectory, they are returned.
1400
Currently returned depth-first, sorted by name within directories.
1402
## TODO: Work from given directory downwards
1403
for path, dir_entry in self.inventory.directories():
1404
# mutter("search for unknowns in %r", path)
1405
dirabs = self.abspath(path)
1406
if not isdir(dirabs):
1407
# e.g. directory deleted
1411
for subf in os.listdir(dirabs):
1414
if subf not in dir_entry.children:
1415
subf_norm, can_access = osutils.normalized_filename(subf)
1416
if subf_norm != subf and can_access:
1417
if subf_norm not in dir_entry.children:
1418
fl.append(subf_norm)
1424
subp = pathjoin(path, subf)
1428
def ignored_files(self):
1429
"""Yield list of PATH, IGNORE_PATTERN"""
1430
for subp in self.extras():
1431
pat = self.is_ignored(subp)
1435
def get_ignore_list(self):
1436
"""Return list of ignore patterns.
1438
Cached in the Tree object after the first call.
1440
ignoreset = getattr(self, '_ignoreset', None)
1441
if ignoreset is not None:
1444
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1445
ignore_globs.update(ignores.get_runtime_ignores())
1446
ignore_globs.update(ignores.get_user_ignores())
1447
if self.has_filename(bzrlib.IGNORE_FILENAME):
1448
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1450
ignore_globs.update(ignores.parse_ignore_file(f))
1453
self._ignoreset = ignore_globs
1456
def _flush_ignore_list_cache(self):
1457
"""Resets the cached ignore list to force a cache rebuild."""
1458
self._ignoreset = None
1459
self._ignoreglobster = None
1461
def is_ignored(self, filename):
1462
r"""Check whether the filename matches an ignore pattern.
1464
Patterns containing '/' or '\' need to match the whole path;
1465
others match against only the last component.
1467
If the file is ignored, returns the pattern which caused it to
1468
be ignored, otherwise None. So this can simply be used as a
1469
boolean if desired."""
1470
if getattr(self, '_ignoreglobster', None) is None:
1471
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1472
return self._ignoreglobster.match(filename)
1474
def kind(self, file_id):
1475
return file_kind(self.id2abspath(file_id))
1477
def _comparison_data(self, entry, path):
1478
abspath = self.abspath(path)
1480
stat_value = os.lstat(abspath)
1482
if getattr(e, 'errno', None) == errno.ENOENT:
1489
mode = stat_value.st_mode
1490
kind = osutils.file_kind_from_stat_mode(mode)
1491
if not supports_executable():
1492
executable = entry.executable
1494
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1495
return kind, executable, stat_value
1497
def _file_size(self, entry, stat_value):
1498
return stat_value.st_size
1500
def last_revision(self):
1501
"""Return the last revision of the branch for this tree.
1503
This format tree does not support a separate marker for last-revision
1504
compared to the branch.
1506
See MutableTree.last_revision
1508
return self._last_revision()
1511
def _last_revision(self):
1512
"""helper for get_parent_ids."""
1513
return self.branch.last_revision()
1515
def is_locked(self):
1516
return self._control_files.is_locked()
1518
def lock_read(self):
1519
"""See Branch.lock_read, and WorkingTree.unlock."""
1520
self.branch.lock_read()
1522
return self._control_files.lock_read()
1524
self.branch.unlock()
1527
def lock_tree_write(self):
1528
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1529
self.branch.lock_read()
1531
return self._control_files.lock_write()
1533
self.branch.unlock()
1536
def lock_write(self):
1537
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1538
self.branch.lock_write()
1540
return self._control_files.lock_write()
1542
self.branch.unlock()
1545
def get_physical_lock_status(self):
1546
return self._control_files.get_physical_lock_status()
1548
def _basis_inventory_name(self):
1549
return 'basis-inventory-cache'
1551
@needs_tree_write_lock
1552
def set_last_revision(self, new_revision):
1553
"""Change the last revision in the working tree."""
1554
new_revision = osutils.safe_revision_id(new_revision)
1555
if self._change_last_revision(new_revision):
1556
self._cache_basis_inventory(new_revision)
1558
def _change_last_revision(self, new_revision):
1559
"""Template method part of set_last_revision to perform the change.
1561
This is used to allow WorkingTree3 instances to not affect branch
1562
when their last revision is set.
1564
if new_revision is None:
1565
self.branch.set_revision_history([])
1568
self.branch.generate_revision_history(new_revision)
1569
except errors.NoSuchRevision:
1570
# not present in the repo - dont try to set it deeper than the tip
1571
self.branch.set_revision_history([new_revision])
1574
def _write_basis_inventory(self, xml):
1575
"""Write the basis inventory XML to the basis-inventory file"""
1576
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1577
path = self._basis_inventory_name()
1579
self._control_files.put(path, sio)
1581
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1582
"""Create the text that will be saved in basis-inventory"""
1583
# TODO: jam 20070209 This should be redundant, as the revision_id
1584
# as all callers should have already converted the revision_id to
1586
inventory.revision_id = osutils.safe_revision_id(revision_id)
1587
return xml6.serializer_v6.write_inventory_to_string(inventory)
1589
def _cache_basis_inventory(self, new_revision):
1590
"""Cache new_revision as the basis inventory."""
1591
# TODO: this should allow the ready-to-use inventory to be passed in,
1592
# as commit already has that ready-to-use [while the format is the
1595
# this double handles the inventory - unpack and repack -
1596
# but is easier to understand. We can/should put a conditional
1597
# in here based on whether the inventory is in the latest format
1598
# - perhaps we should repack all inventories on a repository
1600
# the fast path is to copy the raw xml from the repository. If the
1601
# xml contains 'revision_id="', then we assume the right
1602
# revision_id is set. We must check for this full string, because a
1603
# root node id can legitimately look like 'revision_id' but cannot
1605
xml = self.branch.repository.get_inventory_xml(new_revision)
1606
firstline = xml.split('\n', 1)[0]
1607
if (not 'revision_id="' in firstline or
1608
'format="6"' not in firstline):
1609
inv = self.branch.repository.deserialise_inventory(
1611
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1612
self._write_basis_inventory(xml)
1613
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1616
def read_basis_inventory(self):
1617
"""Read the cached basis inventory."""
1618
path = self._basis_inventory_name()
1619
return self._control_files.get(path).read()
1622
def read_working_inventory(self):
1623
"""Read the working inventory.
1625
:raises errors.InventoryModified: read_working_inventory will fail
1626
when the current in memory inventory has been modified.
1628
# conceptually this should be an implementation detail of the tree.
1629
# XXX: Deprecate this.
1630
# ElementTree does its own conversion from UTF-8, so open in
1632
if self._inventory_is_modified:
1633
raise errors.InventoryModified(self)
1634
result = xml5.serializer_v5.read_inventory(
1635
self._control_files.get('inventory'))
1636
self._set_inventory(result, dirty=False)
1639
@needs_tree_write_lock
1640
def remove(self, files, verbose=False, to_file=None):
1641
"""Remove nominated files from the working inventory..
1643
This does not remove their text. This does not run on XXX on what? RBC
1645
TODO: Refuse to remove modified files unless --force is given?
1647
TODO: Do something useful with directories.
1649
TODO: Should this remove the text or not? Tough call; not
1650
removing may be useful and the user can just use use rm, and
1651
is the opposite of add. Removing it is consistent with most
1652
other tools. Maybe an option.
1654
## TODO: Normalize names
1655
## TODO: Remove nested loops; better scalability
1656
if isinstance(files, basestring):
1659
inv = self.inventory
1661
# do this before any modifications
1663
fid = inv.path2id(f)
1665
note("%s is not versioned."%f)
1668
# having remove it, it must be either ignored or unknown
1669
if self.is_ignored(f):
1673
textui.show_status(new_status, inv[fid].kind, f,
1677
self._write_inventory(inv)
1679
@needs_tree_write_lock
1680
def revert(self, filenames, old_tree=None, backups=True,
1681
pb=DummyProgress(), report_changes=False):
1682
from bzrlib.conflicts import resolve
1683
if old_tree is None:
1684
old_tree = self.basis_tree()
1685
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1687
if not len(filenames):
1688
self.set_parent_ids(self.get_parent_ids()[:1])
1691
resolve(self, filenames, ignore_misses=True)
1694
# XXX: This method should be deprecated in favour of taking in a proper
1695
# new Inventory object.
1696
@needs_tree_write_lock
1697
def set_inventory(self, new_inventory_list):
1698
from bzrlib.inventory import (Inventory,
1703
inv = Inventory(self.get_root_id())
1704
for path, file_id, parent, kind in new_inventory_list:
1705
name = os.path.basename(path)
1708
# fixme, there should be a factory function inv,add_??
1709
if kind == 'directory':
1710
inv.add(InventoryDirectory(file_id, name, parent))
1711
elif kind == 'file':
1712
inv.add(InventoryFile(file_id, name, parent))
1713
elif kind == 'symlink':
1714
inv.add(InventoryLink(file_id, name, parent))
1716
raise errors.BzrError("unknown kind %r" % kind)
1717
self._write_inventory(inv)
1719
@needs_tree_write_lock
1720
def set_root_id(self, file_id):
1721
"""Set the root id for this tree."""
1724
symbol_versioning.warn(symbol_versioning.zero_twelve
1725
% 'WorkingTree.set_root_id with fileid=None',
1730
file_id = osutils.safe_file_id(file_id)
1731
inv = self._inventory
1732
orig_root_id = inv.root.file_id
1733
# TODO: it might be nice to exit early if there was nothing
1734
# to do, saving us from trigger a sync on unlock.
1735
self._inventory_is_modified = True
1736
# we preserve the root inventory entry object, but
1737
# unlinkit from the byid index
1738
del inv._byid[inv.root.file_id]
1739
inv.root.file_id = file_id
1740
# and link it into the index with the new changed id.
1741
inv._byid[inv.root.file_id] = inv.root
1742
# and finally update all children to reference the new id.
1743
# XXX: this should be safe to just look at the root.children
1744
# list, not the WHOLE INVENTORY.
1747
if entry.parent_id == orig_root_id:
1748
entry.parent_id = inv.root.file_id
1751
"""See Branch.unlock.
1753
WorkingTree locking just uses the Branch locking facilities.
1754
This is current because all working trees have an embedded branch
1755
within them. IF in the future, we were to make branch data shareable
1756
between multiple working trees, i.e. via shared storage, then we
1757
would probably want to lock both the local tree, and the branch.
1759
raise NotImplementedError(self.unlock)
1762
"""Update a working tree along its branch.
1764
This will update the branch if its bound too, which means we have
1765
multiple trees involved:
1767
- The new basis tree of the master.
1768
- The old basis tree of the branch.
1769
- The old basis tree of the working tree.
1770
- The current working tree state.
1772
Pathologically, all three may be different, and non-ancestors of each
1773
other. Conceptually we want to:
1775
- Preserve the wt.basis->wt.state changes
1776
- Transform the wt.basis to the new master basis.
1777
- Apply a merge of the old branch basis to get any 'local' changes from
1779
- Restore the wt.basis->wt.state changes.
1781
There isn't a single operation at the moment to do that, so we:
1782
- Merge current state -> basis tree of the master w.r.t. the old tree
1784
- Do a 'normal' merge of the old branch basis if it is relevant.
1786
if self.branch.get_master_branch() is not None:
1788
update_branch = True
1790
self.lock_tree_write()
1791
update_branch = False
1794
old_tip = self.branch.update()
1797
return self._update_tree(old_tip)
1801
@needs_tree_write_lock
1802
def _update_tree(self, old_tip=None):
1803
"""Update a tree to the master branch.
1805
:param old_tip: if supplied, the previous tip revision the branch,
1806
before it was changed to the master branch's tip.
1808
# here if old_tip is not None, it is the old tip of the branch before
1809
# it was updated from the master branch. This should become a pending
1810
# merge in the working tree to preserve the user existing work. we
1811
# cant set that until we update the working trees last revision to be
1812
# one from the new branch, because it will just get absorbed by the
1813
# parent de-duplication logic.
1815
# We MUST save it even if an error occurs, because otherwise the users
1816
# local work is unreferenced and will appear to have been lost.
1820
last_rev = self.get_parent_ids()[0]
1823
if last_rev != self.branch.last_revision():
1824
# merge tree state up to new branch tip.
1825
basis = self.basis_tree()
1826
to_tree = self.branch.basis_tree()
1827
if basis.inventory.root is None:
1828
self.set_root_id(to_tree.inventory.root.file_id)
1829
result += merge.merge_inner(
1834
# TODO - dedup parents list with things merged by pull ?
1835
# reuse the tree we've updated to to set the basis:
1836
parent_trees = [(self.branch.last_revision(), to_tree)]
1837
merges = self.get_parent_ids()[1:]
1838
# Ideally we ask the tree for the trees here, that way the working
1839
# tree can decide whether to give us teh entire tree or give us a
1840
# lazy initialised tree. dirstate for instance will have the trees
1841
# in ram already, whereas a last-revision + basis-inventory tree
1842
# will not, but also does not need them when setting parents.
1843
for parent in merges:
1844
parent_trees.append(
1845
(parent, self.branch.repository.revision_tree(parent)))
1846
if old_tip is not None:
1847
parent_trees.append(
1848
(old_tip, self.branch.repository.revision_tree(old_tip)))
1849
self.set_parent_trees(parent_trees)
1850
last_rev = parent_trees[0][0]
1852
# the working tree had the same last-revision as the master
1853
# branch did. We may still have pivot local work from the local
1854
# branch into old_tip:
1855
if old_tip is not None:
1856
self.add_parent_tree_id(old_tip)
1857
if old_tip and old_tip != last_rev:
1858
# our last revision was not the prior branch last revision
1859
# and we have converted that last revision to a pending merge.
1860
# base is somewhere between the branch tip now
1861
# and the now pending merge
1862
from bzrlib.revision import common_ancestor
1864
base_rev_id = common_ancestor(self.branch.last_revision(),
1866
self.branch.repository)
1867
except errors.NoCommonAncestor:
1869
base_tree = self.branch.repository.revision_tree(base_rev_id)
1870
other_tree = self.branch.repository.revision_tree(old_tip)
1871
result += merge.merge_inner(
1878
def _write_hashcache_if_dirty(self):
1879
"""Write out the hashcache if it is dirty."""
1880
if self._hashcache.needs_write:
1882
self._hashcache.write()
1884
if e.errno not in (errno.EPERM, errno.EACCES):
1886
# TODO: jam 20061219 Should this be a warning? A single line
1887
# warning might be sufficient to let the user know what
1889
mutter('Could not write hashcache for %s\nError: %s',
1890
self._hashcache.cache_file_name(), e)
1892
@needs_tree_write_lock
1893
def _write_inventory(self, inv):
1894
"""Write inventory as the current inventory."""
1895
self._set_inventory(inv, dirty=True)
1898
def set_conflicts(self, arg):
1899
raise errors.UnsupportedOperation(self.set_conflicts, self)
1901
def add_conflicts(self, arg):
1902
raise errors.UnsupportedOperation(self.add_conflicts, self)
1905
def conflicts(self):
1906
conflicts = _mod_conflicts.ConflictList()
1907
for conflicted in self._iter_conflicts():
1910
if file_kind(self.abspath(conflicted)) != "file":
1912
except errors.NoSuchFile:
1915
for suffix in ('.THIS', '.OTHER'):
1917
kind = file_kind(self.abspath(conflicted+suffix))
1920
except errors.NoSuchFile:
1924
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1925
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1927
file_id=self.path2id(conflicted)))
1931
class WorkingTree2(WorkingTree):
1932
"""This is the Format 2 working tree.
1934
This was the first weave based working tree.
1935
- uses os locks for locking.
1936
- uses the branch last-revision.
1939
def lock_tree_write(self):
1940
"""See WorkingTree.lock_tree_write().
1942
In Format2 WorkingTrees we have a single lock for the branch and tree
1943
so lock_tree_write() degrades to lock_write().
1945
self.branch.lock_write()
1947
return self._control_files.lock_write()
1949
self.branch.unlock()
1953
# we share control files:
1954
if self._control_files._lock_count == 3:
1955
# _inventory_is_modified is always False during a read lock.
1956
if self._inventory_is_modified:
1958
self._write_hashcache_if_dirty()
1960
# reverse order of locking.
1962
return self._control_files.unlock()
1964
self.branch.unlock()
1967
class WorkingTree3(WorkingTree):
1968
"""This is the Format 3 working tree.
1970
This differs from the base WorkingTree by:
1971
- having its own file lock
1972
- having its own last-revision property.
1974
This is new in bzr 0.8
1978
def _last_revision(self):
1979
"""See Mutable.last_revision."""
1981
return osutils.safe_revision_id(
1982
self._control_files.get('last-revision').read())
1983
except errors.NoSuchFile:
1986
def _change_last_revision(self, revision_id):
1987
"""See WorkingTree._change_last_revision."""
1988
if revision_id is None or revision_id == NULL_REVISION:
1990
self._control_files._transport.delete('last-revision')
1991
except errors.NoSuchFile:
1995
self._control_files.put_bytes('last-revision', revision_id)
1998
@needs_tree_write_lock
1999
def set_conflicts(self, conflicts):
2000
self._put_rio('conflicts', conflicts.to_stanzas(),
2003
@needs_tree_write_lock
2004
def add_conflicts(self, new_conflicts):
2005
conflict_set = set(self.conflicts())
2006
conflict_set.update(set(list(new_conflicts)))
2007
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2008
key=_mod_conflicts.Conflict.sort_key)))
2011
def conflicts(self):
2013
confile = self._control_files.get('conflicts')
2014
except errors.NoSuchFile:
2015
return _mod_conflicts.ConflictList()
2017
if confile.next() != CONFLICT_HEADER_1 + '\n':
2018
raise errors.ConflictFormatError()
2019
except StopIteration:
2020
raise errors.ConflictFormatError()
2021
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2024
if self._control_files._lock_count == 1:
2025
# _inventory_is_modified is always False during a read lock.
2026
if self._inventory_is_modified:
2028
self._write_hashcache_if_dirty()
2029
# reverse order of locking.
2031
return self._control_files.unlock()
2033
self.branch.unlock()
2036
def get_conflicted_stem(path):
2037
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2038
if path.endswith(suffix):
2039
return path[:-len(suffix)]
2041
@deprecated_function(zero_eight)
2042
def is_control_file(filename):
2043
"""See WorkingTree.is_control_filename(filename)."""
2044
## FIXME: better check
2045
filename = normpath(filename)
2046
while filename != '':
2047
head, tail = os.path.split(filename)
2048
## mutter('check %r for control file' % ((head, tail),))
2051
if filename == head:
2057
class WorkingTreeFormat(object):
2058
"""An encapsulation of the initialization and open routines for a format.
2060
Formats provide three things:
2061
* An initialization routine,
2065
Formats are placed in an dict by their format string for reference
2066
during workingtree opening. Its not required that these be instances, they
2067
can be classes themselves with class methods - it simply depends on
2068
whether state is needed for a given format or not.
2070
Once a format is deprecated, just deprecate the initialize and open
2071
methods on the format class. Do not deprecate the object, as the
2072
object will be created every time regardless.
2075
_default_format = None
2076
"""The default format used for new trees."""
2079
"""The known formats."""
2082
def find_format(klass, a_bzrdir):
2083
"""Return the format for the working tree object in a_bzrdir."""
2085
transport = a_bzrdir.get_workingtree_transport(None)
2086
format_string = transport.get("format").read()
2087
return klass._formats[format_string]
2088
except errors.NoSuchFile:
2089
raise errors.NoWorkingTree(base=transport.base)
2091
raise errors.UnknownFormatError(format=format_string)
2094
def get_default_format(klass):
2095
"""Return the current default format."""
2096
return klass._default_format
2098
def get_format_string(self):
2099
"""Return the ASCII format string that identifies this format."""
2100
raise NotImplementedError(self.get_format_string)
2102
def get_format_description(self):
2103
"""Return the short description for this format."""
2104
raise NotImplementedError(self.get_format_description)
2106
def is_supported(self):
2107
"""Is this format supported?
2109
Supported formats can be initialized and opened.
2110
Unsupported formats may not support initialization or committing or
2111
some other features depending on the reason for not being supported.
2116
def register_format(klass, format):
2117
klass._formats[format.get_format_string()] = format
2120
def set_default_format(klass, format):
2121
klass._default_format = format
2124
def unregister_format(klass, format):
2125
assert klass._formats[format.get_format_string()] is format
2126
del klass._formats[format.get_format_string()]
2130
class WorkingTreeFormat2(WorkingTreeFormat):
2131
"""The second working tree format.
2133
This format modified the hash cache from the format 1 hash cache.
2136
def get_format_description(self):
2137
"""See WorkingTreeFormat.get_format_description()."""
2138
return "Working tree format 2"
2140
def stub_initialize_remote(self, control_files):
2141
"""As a special workaround create critical control files for a remote working tree
2143
This ensures that it can later be updated and dealt with locally,
2144
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2145
no working tree. (See bug #43064).
2149
xml5.serializer_v5.write_inventory(inv, sio)
2151
control_files.put('inventory', sio)
2153
control_files.put_bytes('pending-merges', '')
2156
def initialize(self, a_bzrdir, revision_id=None):
2157
"""See WorkingTreeFormat.initialize()."""
2158
if not isinstance(a_bzrdir.transport, LocalTransport):
2159
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2160
branch = a_bzrdir.open_branch()
2161
if revision_id is not None:
2162
revision_id = osutils.safe_revision_id(revision_id)
2165
revision_history = branch.revision_history()
2167
position = revision_history.index(revision_id)
2169
raise errors.NoSuchRevision(branch, revision_id)
2170
branch.set_revision_history(revision_history[:position + 1])
2173
revision = branch.last_revision()
2175
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2181
basis_tree = branch.repository.revision_tree(revision)
2182
if basis_tree.inventory.root is not None:
2183
wt.set_root_id(basis_tree.inventory.root.file_id)
2184
# set the parent list and cache the basis tree.
2185
wt.set_parent_trees([(revision, basis_tree)])
2186
transform.build_tree(basis_tree, wt)
2190
super(WorkingTreeFormat2, self).__init__()
2191
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2193
def open(self, a_bzrdir, _found=False):
2194
"""Return the WorkingTree object for a_bzrdir
2196
_found is a private parameter, do not use it. It is used to indicate
2197
if format probing has already been done.
2200
# we are being called directly and must probe.
2201
raise NotImplementedError
2202
if not isinstance(a_bzrdir.transport, LocalTransport):
2203
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2204
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2210
class WorkingTreeFormat3(WorkingTreeFormat):
2211
"""The second working tree format updated to record a format marker.
2214
- exists within a metadir controlling .bzr
2215
- includes an explicit version marker for the workingtree control
2216
files, separate from the BzrDir format
2217
- modifies the hash cache format
2219
- uses a LockDir to guard access for writes.
2222
def get_format_string(self):
2223
"""See WorkingTreeFormat.get_format_string()."""
2224
return "Bazaar-NG Working Tree format 3"
2226
def get_format_description(self):
2227
"""See WorkingTreeFormat.get_format_description()."""
2228
return "Working tree format 3"
2230
_lock_file_name = 'lock'
2231
_lock_class = LockDir
2233
def _open_control_files(self, a_bzrdir):
2234
transport = a_bzrdir.get_workingtree_transport(None)
2235
return LockableFiles(transport, self._lock_file_name,
2238
def initialize(self, a_bzrdir, revision_id=None):
2239
"""See WorkingTreeFormat.initialize().
2241
revision_id allows creating a working tree at a different
2242
revision than the branch is at.
2244
if not isinstance(a_bzrdir.transport, LocalTransport):
2245
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2246
transport = a_bzrdir.get_workingtree_transport(self)
2247
control_files = self._open_control_files(a_bzrdir)
2248
control_files.create_lock()
2249
control_files.lock_write()
2250
control_files.put_utf8('format', self.get_format_string())
2251
branch = a_bzrdir.open_branch()
2252
if revision_id is None:
2253
revision_id = branch.last_revision()
2255
revision_id = osutils.safe_revision_id(revision_id)
2256
# WorkingTree3 can handle an inventory which has a unique root id.
2257
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2258
# those trees. And because there isn't a format bump inbetween, we
2259
# are maintaining compatibility with older clients.
2260
# inv = Inventory(root_id=gen_root_id())
2262
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2268
_control_files=control_files)
2269
wt.lock_tree_write()
2271
basis_tree = branch.repository.revision_tree(revision_id)
2272
# only set an explicit root id if there is one to set.
2273
if basis_tree.inventory.root is not None:
2274
wt.set_root_id(basis_tree.inventory.root.file_id)
2275
if revision_id == NULL_REVISION:
2276
wt.set_parent_trees([])
2278
wt.set_parent_trees([(revision_id, basis_tree)])
2279
transform.build_tree(basis_tree, wt)
2281
# Unlock in this order so that the unlock-triggers-flush in
2282
# WorkingTree is given a chance to fire.
2283
control_files.unlock()
2288
super(WorkingTreeFormat3, self).__init__()
2289
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2291
def open(self, a_bzrdir, _found=False):
2292
"""Return the WorkingTree object for a_bzrdir
2294
_found is a private parameter, do not use it. It is used to indicate
2295
if format probing has already been done.
2298
# we are being called directly and must probe.
2299
raise NotImplementedError
2300
if not isinstance(a_bzrdir.transport, LocalTransport):
2301
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2302
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2304
def _open(self, a_bzrdir, control_files):
2305
"""Open the tree itself.
2307
:param a_bzrdir: the dir for the tree.
2308
:param control_files: the control files for the tree.
2310
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2314
_control_files=control_files)
2317
return self.get_format_string()
2320
# formats which have no format string are not discoverable
2321
# and not independently creatable, so are not registered.
2322
__default_format = WorkingTreeFormat3()
2323
WorkingTreeFormat.register_format(__default_format)
2324
WorkingTreeFormat.set_default_format(__default_format)
2325
_legacy_formats = [WorkingTreeFormat2(),
2329
class WorkingTreeTestProviderAdapter(object):
2330
"""A tool to generate a suite testing multiple workingtree formats at once.
2332
This is done by copying the test once for each transport and injecting
2333
the transport_server, transport_readonly_server, and workingtree_format
2334
classes into each copy. Each copy is also given a new id() to make it
2338
def __init__(self, transport_server, transport_readonly_server, formats):
2339
self._transport_server = transport_server
2340
self._transport_readonly_server = transport_readonly_server
2341
self._formats = formats
2343
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2344
"""Clone test for adaption."""
2345
new_test = deepcopy(test)
2346
new_test.transport_server = self._transport_server
2347
new_test.transport_readonly_server = self._transport_readonly_server
2348
new_test.bzrdir_format = bzrdir_format
2349
new_test.workingtree_format = workingtree_format
2350
def make_new_test_id():
2351
new_id = "%s(%s)" % (test.id(), variation)
2352
return lambda: new_id
2353
new_test.id = make_new_test_id()
2356
def adapt(self, test):
2357
from bzrlib.tests import TestSuite
2358
result = TestSuite()
2359
for workingtree_format, bzrdir_format in self._formats:
2360
new_test = self._clone_test(
2363
workingtree_format, workingtree_format.__class__.__name__)
2364
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
