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
return self.get_file_byname(self.id2path(file_id))
457
def get_file_text(self, file_id):
458
return self.get_file(file_id).read()
460
def get_file_byname(self, filename):
461
return file(self.abspath(filename), 'rb')
463
def annotate_iter(self, file_id):
464
"""See Tree.annotate_iter
466
This implementation will use the basis tree implementation if possible.
467
Lines not in the basis are attributed to CURRENT_REVISION
469
If there are pending merges, lines added by those merges will be
470
incorrectly attributed to CURRENT_REVISION (but after committing, the
471
attribution will be correct).
473
basis = self.basis_tree()
474
changes = self._iter_changes(basis, True, [file_id]).next()
475
changed_content, kind = changes[2], changes[6]
476
if not changed_content:
477
return basis.annotate_iter(file_id)
481
if kind[0] != 'file':
484
old_lines = list(basis.annotate_iter(file_id))
486
for tree in self.branch.repository.revision_trees(
487
self.get_parent_ids()[1:]):
488
if file_id not in tree:
490
old.append(list(tree.annotate_iter(file_id)))
491
return annotate.reannotate(old, self.get_file(file_id).readlines(),
494
def get_parent_ids(self):
495
"""See Tree.get_parent_ids.
497
This implementation reads the pending merges list and last_revision
498
value and uses that to decide what the parents list should be.
500
last_rev = self._last_revision()
506
merges_file = self._control_files.get('pending-merges')
507
except errors.NoSuchFile:
510
for l in merges_file.readlines():
511
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
512
parents.append(revision_id)
516
def get_root_id(self):
517
"""Return the id of this trees root"""
518
return self._inventory.root.file_id
520
def _get_store_filename(self, file_id):
521
## XXX: badly named; this is not in the store at all
522
return self.abspath(self.id2path(file_id))
525
def clone(self, to_bzrdir, revision_id=None, basis=None):
526
"""Duplicate this working tree into to_bzr, including all state.
528
Specifically modified files are kept as modified, but
529
ignored and unknown files are discarded.
531
If you want to make a new line of development, see bzrdir.sprout()
534
If not None, the cloned tree will have its last revision set to
535
revision, and and difference between the source trees last revision
536
and this one merged in.
539
If not None, a closer copy of a tree which may have some files in
540
common, and which file content should be preferentially copied from.
542
# assumes the target bzr dir format is compatible.
543
result = self._format.initialize(to_bzrdir)
544
self.copy_content_into(result, revision_id)
548
def copy_content_into(self, tree, revision_id=None):
549
"""Copy the current content and user files of this tree into tree."""
550
tree.set_root_id(self.get_root_id())
551
if revision_id is None:
552
merge.transform_tree(tree, self)
554
# TODO now merge from tree.last_revision to revision (to preserve
555
# user local changes)
556
merge.transform_tree(tree, self)
557
tree.set_parent_ids([revision_id])
559
def id2abspath(self, file_id):
560
return self.abspath(self.id2path(file_id))
562
def has_id(self, file_id):
563
# files that have been deleted are excluded
564
inv = self._inventory
565
if not inv.has_id(file_id):
567
path = inv.id2path(file_id)
568
return osutils.lexists(self.abspath(path))
570
def has_or_had_id(self, file_id):
571
if file_id == self.inventory.root.file_id:
573
return self.inventory.has_id(file_id)
575
__contains__ = has_id
577
def get_file_size(self, file_id):
578
return os.path.getsize(self.id2abspath(file_id))
581
def get_file_sha1(self, file_id, path=None, stat_value=None):
583
path = self._inventory.id2path(file_id)
584
return self._hashcache.get_sha1(path, stat_value)
586
def get_file_mtime(self, file_id, path=None):
588
path = self._inventory.id2path(file_id)
589
return os.lstat(self.abspath(path)).st_mtime
591
if not supports_executable():
592
def is_executable(self, file_id, path=None):
593
return self._inventory[file_id].executable
595
def is_executable(self, file_id, path=None):
597
path = self._inventory.id2path(file_id)
598
mode = os.lstat(self.abspath(path)).st_mode
599
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
602
def _add(self, files, ids, kinds):
603
"""See MutableTree._add."""
604
# TODO: Re-adding a file that is removed in the working copy
605
# should probably put it back with the previous ID.
606
# the read and write working inventory should not occur in this
607
# function - they should be part of lock_write and unlock.
608
inv = self.read_working_inventory()
609
for f, file_id, kind in zip(files, ids, kinds):
610
assert kind is not None
612
inv.add_path(f, kind=kind)
614
inv.add_path(f, kind=kind, file_id=file_id)
615
self._write_inventory(inv)
617
@needs_tree_write_lock
618
def _gather_kinds(self, files, kinds):
619
"""See MutableTree._gather_kinds."""
620
for pos, f in enumerate(files):
621
if kinds[pos] is None:
622
fullpath = normpath(self.abspath(f))
624
kinds[pos] = file_kind(fullpath)
626
if e.errno == errno.ENOENT:
627
raise errors.NoSuchFile(fullpath)
630
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
631
"""Add revision_id as a parent.
633
This is equivalent to retrieving the current list of parent ids
634
and setting the list to its value plus revision_id.
636
:param revision_id: The revision id to add to the parent list. It may
637
be a ghost revision as long as its not the first parent to be added,
638
or the allow_leftmost_as_ghost parameter is set True.
639
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
641
parents = self.get_parent_ids() + [revision_id]
642
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
643
or allow_leftmost_as_ghost)
645
@needs_tree_write_lock
646
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
647
"""Add revision_id, tree tuple as a parent.
649
This is equivalent to retrieving the current list of parent trees
650
and setting the list to its value plus parent_tuple. See also
651
add_parent_tree_id - if you only have a parent id available it will be
652
simpler to use that api. If you have the parent already available, using
653
this api is preferred.
655
:param parent_tuple: The (revision id, tree) to add to the parent list.
656
If the revision_id is a ghost, pass None for the tree.
657
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
659
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
660
if len(parent_ids) > 1:
661
# the leftmost may have already been a ghost, preserve that if it
663
allow_leftmost_as_ghost = True
664
self.set_parent_ids(parent_ids,
665
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
667
@needs_tree_write_lock
668
def add_pending_merge(self, *revision_ids):
669
# TODO: Perhaps should check at this point that the
670
# history of the revision is actually present?
671
parents = self.get_parent_ids()
673
for rev_id in revision_ids:
674
if rev_id in parents:
676
parents.append(rev_id)
679
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
681
@deprecated_method(zero_eleven)
683
def pending_merges(self):
684
"""Return a list of pending merges.
686
These are revisions that have been merged into the working
687
directory but not yet committed.
689
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
690
instead - which is available on all tree objects.
692
return self.get_parent_ids()[1:]
694
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
695
"""Common ghost checking functionality from set_parent_*.
697
This checks that the left hand-parent exists if there are any
700
if len(revision_ids) > 0:
701
leftmost_id = revision_ids[0]
702
if (not allow_leftmost_as_ghost and not
703
self.branch.repository.has_revision(leftmost_id)):
704
raise errors.GhostRevisionUnusableHere(leftmost_id)
706
def _set_merges_from_parent_ids(self, parent_ids):
707
merges = parent_ids[1:]
708
self._control_files.put_utf8('pending-merges', '\n'.join(merges))
710
@needs_tree_write_lock
711
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
712
"""Set the parent ids to revision_ids.
714
See also set_parent_trees. This api will try to retrieve the tree data
715
for each element of revision_ids from the trees repository. If you have
716
tree data already available, it is more efficient to use
717
set_parent_trees rather than set_parent_ids. set_parent_ids is however
718
an easier API to use.
720
:param revision_ids: The revision_ids to set as the parent ids of this
721
working tree. Any of these may be ghosts.
723
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
724
self._check_parents_for_ghosts(revision_ids,
725
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
727
if len(revision_ids) > 0:
728
self.set_last_revision(revision_ids[0])
730
self.set_last_revision(None)
732
self._set_merges_from_parent_ids(revision_ids)
734
@needs_tree_write_lock
735
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
736
"""See MutableTree.set_parent_trees."""
737
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
739
self._check_parents_for_ghosts(parent_ids,
740
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
742
if len(parent_ids) == 0:
743
leftmost_parent_id = None
744
leftmost_parent_tree = None
746
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
748
if self._change_last_revision(leftmost_parent_id):
749
if leftmost_parent_tree is None:
750
# If we don't have a tree, fall back to reading the
751
# parent tree from the repository.
752
self._cache_basis_inventory(leftmost_parent_id)
754
inv = leftmost_parent_tree.inventory
755
xml = self._create_basis_xml_from_inventory(
756
leftmost_parent_id, inv)
757
self._write_basis_inventory(xml)
758
self._set_merges_from_parent_ids(parent_ids)
760
@needs_tree_write_lock
761
def set_pending_merges(self, rev_list):
762
parents = self.get_parent_ids()
763
leftmost = parents[:1]
764
new_parents = leftmost + rev_list
765
self.set_parent_ids(new_parents)
767
@needs_tree_write_lock
768
def set_merge_modified(self, modified_hashes):
770
for file_id, hash in modified_hashes.iteritems():
771
yield Stanza(file_id=file_id, hash=hash)
772
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
774
@needs_tree_write_lock
775
def _put_rio(self, filename, stanzas, header):
776
my_file = rio_file(stanzas, header)
777
self._control_files.put(filename, my_file)
779
@needs_write_lock # because merge pulls data into the branch.
780
def merge_from_branch(self, branch, to_revision=None):
781
"""Merge from a branch into this working tree.
783
:param branch: The branch to merge from.
784
:param to_revision: If non-None, the merge will merge to to_revision,
785
but not beyond it. to_revision does not need to be in the history
786
of the branch when it is supplied. If None, to_revision defaults to
787
branch.last_revision().
789
from bzrlib.merge import Merger, Merge3Merger
790
pb = bzrlib.ui.ui_factory.nested_progress_bar()
792
merger = Merger(self.branch, this_tree=self, pb=pb)
793
merger.pp = ProgressPhase("Merge phase", 5, pb)
794
merger.pp.next_phase()
795
# check that there are no
797
merger.check_basis(check_clean=True, require_commits=False)
798
if to_revision is None:
799
to_revision = branch.last_revision()
801
to_revision = osutils.safe_revision_id(to_revision)
802
merger.other_rev_id = to_revision
803
if merger.other_rev_id is None:
804
raise error.NoCommits(branch)
805
self.branch.fetch(branch, last_revision=merger.other_rev_id)
806
merger.other_basis = merger.other_rev_id
807
merger.other_tree = self.branch.repository.revision_tree(
809
merger.pp.next_phase()
811
if merger.base_rev_id == merger.other_rev_id:
812
raise errors.PointlessMerge
813
merger.backup_files = False
814
merger.merge_type = Merge3Merger
815
merger.set_interesting_files(None)
816
merger.show_base = False
817
merger.reprocess = False
818
conflicts = merger.do_merge()
825
def merge_modified(self):
827
hashfile = self._control_files.get('merge-hashes')
828
except errors.NoSuchFile:
832
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
833
raise errors.MergeModifiedFormatError()
834
except StopIteration:
835
raise errors.MergeModifiedFormatError()
836
for s in RioReader(hashfile):
837
file_id = s.get("file_id")
838
if file_id not in self.inventory:
841
if hash == self.get_file_sha1(file_id):
842
merge_hashes[file_id] = hash
846
def mkdir(self, path, file_id=None):
847
"""See MutableTree.mkdir()."""
849
file_id = generate_ids.gen_file_id(os.path.basename(path))
850
os.mkdir(self.abspath(path))
851
self.add(path, file_id, 'directory')
854
def get_symlink_target(self, file_id):
855
return os.readlink(self.id2abspath(file_id))
857
def file_class(self, filename):
858
if self.path2id(filename):
860
elif self.is_ignored(filename):
866
"""Write the in memory inventory to disk."""
867
# TODO: Maybe this should only write on dirty ?
868
if self._control_files._lock_mode != 'w':
869
raise errors.NotWriteLocked(self)
871
xml5.serializer_v5.write_inventory(self._inventory, sio)
873
self._control_files.put('inventory', sio)
874
self._inventory_is_modified = False
876
def list_files(self, include_root=False):
877
"""Recursively list all files as (path, class, kind, id, entry).
879
Lists, but does not descend into unversioned directories.
881
This does not include files that have been deleted in this
884
Skips the control directory.
886
inv = self._inventory
887
if include_root is True:
888
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
889
# Convert these into local objects to save lookup times
890
pathjoin = osutils.pathjoin
891
file_kind = osutils.file_kind
893
# transport.base ends in a slash, we want the piece
894
# between the last two slashes
895
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
897
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
899
# directory file_id, relative path, absolute path, reverse sorted children
900
children = os.listdir(self.basedir)
902
# jam 20060527 The kernel sized tree seems equivalent whether we
903
# use a deque and popleft to keep them sorted, or if we use a plain
904
# list and just reverse() them.
905
children = collections.deque(children)
906
stack = [(inv.root.file_id, u'', self.basedir, children)]
908
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
911
f = children.popleft()
912
## TODO: If we find a subdirectory with its own .bzr
913
## directory, then that is a separate tree and we
914
## should exclude it.
916
# the bzrdir for this tree
917
if transport_base_dir == f:
920
# we know that from_dir_relpath and from_dir_abspath never end in a slash
921
# and 'f' doesn't begin with one, we can do a string op, rather
922
# than the checks of pathjoin(), all relative paths will have an extra slash
924
fp = from_dir_relpath + '/' + f
927
fap = from_dir_abspath + '/' + f
929
f_ie = inv.get_child(from_dir_id, f)
932
elif self.is_ignored(fp[1:]):
935
# we may not have found this file, because of a unicode issue
936
f_norm, can_access = osutils.normalized_filename(f)
937
if f == f_norm or not can_access:
938
# No change, so treat this file normally
941
# this file can be accessed by a normalized path
942
# check again if it is versioned
943
# these lines are repeated here for performance
945
fp = from_dir_relpath + '/' + f
946
fap = from_dir_abspath + '/' + f
947
f_ie = inv.get_child(from_dir_id, f)
950
elif self.is_ignored(fp[1:]):
959
raise errors.BzrCheckError(
960
"file %r entered as kind %r id %r, now of kind %r"
961
% (fap, f_ie.kind, f_ie.file_id, fk))
963
# make a last minute entry
965
yield fp[1:], c, fk, f_ie.file_id, f_ie
968
yield fp[1:], c, fk, None, fk_entries[fk]()
970
yield fp[1:], c, fk, None, TreeEntry()
973
if fk != 'directory':
976
# But do this child first
977
new_children = os.listdir(fap)
979
new_children = collections.deque(new_children)
980
stack.append((f_ie.file_id, fp, fap, new_children))
981
# Break out of inner loop,
982
# so that we start outer loop with child
985
# if we finished all children, pop it off the stack
988
@needs_tree_write_lock
989
def move(self, from_paths, to_dir=None, after=False, **kwargs):
992
to_dir must exist in the inventory.
994
If to_dir exists and is a directory, the files are moved into
995
it, keeping their old names.
997
Note that to_dir is only the last component of the new name;
998
this doesn't change the directory.
1000
For each entry in from_paths the move mode will be determined
1003
The first mode moves the file in the filesystem and updates the
1004
inventory. The second mode only updates the inventory without
1005
touching the file on the filesystem. This is the new mode introduced
1008
move uses the second mode if 'after == True' and the target is not
1009
versioned but present in the working tree.
1011
move uses the second mode if 'after == False' and the source is
1012
versioned but no longer in the working tree, and the target is not
1013
versioned but present in the working tree.
1015
move uses the first mode if 'after == False' and the source is
1016
versioned and present in the working tree, and the target is not
1017
versioned and not present in the working tree.
1019
Everything else results in an error.
1021
This returns a list of (from_path, to_path) pairs for each
1022
entry that is moved.
1027
# check for deprecated use of signature
1029
to_dir = kwargs.get('to_name', None)
1031
raise TypeError('You must supply a target directory')
1033
symbol_versioning.warn('The parameter to_name was deprecated'
1034
' in version 0.13. Use to_dir instead',
1037
# check destination directory
1038
assert not isinstance(from_paths, basestring)
1039
inv = self.inventory
1040
to_abs = self.abspath(to_dir)
1041
if not isdir(to_abs):
1042
raise errors.BzrMoveFailedError('',to_dir,
1043
errors.NotADirectory(to_abs))
1044
if not self.has_filename(to_dir):
1045
raise errors.BzrMoveFailedError('',to_dir,
1046
errors.NotInWorkingDirectory(to_dir))
1047
to_dir_id = inv.path2id(to_dir)
1048
if to_dir_id is None:
1049
raise errors.BzrMoveFailedError('',to_dir,
1050
errors.NotVersionedError(path=str(to_dir)))
1052
to_dir_ie = inv[to_dir_id]
1053
if to_dir_ie.kind != 'directory':
1054
raise errors.BzrMoveFailedError('',to_dir,
1055
errors.NotADirectory(to_abs))
1057
# create rename entries and tuples
1058
for from_rel in from_paths:
1059
from_tail = splitpath(from_rel)[-1]
1060
from_id = inv.path2id(from_rel)
1062
raise errors.BzrMoveFailedError(from_rel,to_dir,
1063
errors.NotVersionedError(path=str(from_rel)))
1065
from_entry = inv[from_id]
1066
from_parent_id = from_entry.parent_id
1067
to_rel = pathjoin(to_dir, from_tail)
1068
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1070
from_tail=from_tail,
1071
from_parent_id=from_parent_id,
1072
to_rel=to_rel, to_tail=from_tail,
1073
to_parent_id=to_dir_id)
1074
rename_entries.append(rename_entry)
1075
rename_tuples.append((from_rel, to_rel))
1077
# determine which move mode to use. checks also for movability
1078
rename_entries = self._determine_mv_mode(rename_entries, after)
1080
original_modified = self._inventory_is_modified
1083
self._inventory_is_modified = True
1084
self._move(rename_entries)
1086
# restore the inventory on error
1087
self._inventory_is_modified = original_modified
1089
self._write_inventory(inv)
1090
return rename_tuples
1092
def _determine_mv_mode(self, rename_entries, after=False):
1093
"""Determines for each from-to pair if both inventory and working tree
1094
or only the inventory has to be changed.
1096
Also does basic plausability tests.
1098
inv = self.inventory
1100
for rename_entry in rename_entries:
1101
# store to local variables for easier reference
1102
from_rel = rename_entry.from_rel
1103
from_id = rename_entry.from_id
1104
to_rel = rename_entry.to_rel
1105
to_id = inv.path2id(to_rel)
1106
only_change_inv = False
1108
# check the inventory for source and destination
1110
raise errors.BzrMoveFailedError(from_rel,to_rel,
1111
errors.NotVersionedError(path=str(from_rel)))
1112
if to_id is not None:
1113
raise errors.BzrMoveFailedError(from_rel,to_rel,
1114
errors.AlreadyVersionedError(path=str(to_rel)))
1116
# try to determine the mode for rename (only change inv or change
1117
# inv and file system)
1119
if not self.has_filename(to_rel):
1120
raise errors.BzrMoveFailedError(from_id,to_rel,
1121
errors.NoSuchFile(path=str(to_rel),
1122
extra="New file has not been created yet"))
1123
only_change_inv = True
1124
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1125
only_change_inv = True
1126
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1127
only_change_inv = False
1129
# something is wrong, so lets determine what exactly
1130
if not self.has_filename(from_rel) and \
1131
not self.has_filename(to_rel):
1132
raise errors.BzrRenameFailedError(from_rel,to_rel,
1133
errors.PathsDoNotExist(paths=(str(from_rel),
1136
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1137
extra="(Use --after to update the Bazaar id)")
1138
rename_entry.only_change_inv = only_change_inv
1139
return rename_entries
1141
def _move(self, rename_entries):
1142
"""Moves a list of files.
1144
Depending on the value of the flag 'only_change_inv', the
1145
file will be moved on the file system or not.
1147
inv = self.inventory
1150
for entry in rename_entries:
1152
self._move_entry(entry)
1154
self._rollback_move(moved)
1158
def _rollback_move(self, moved):
1159
"""Try to rollback a previous move in case of an filesystem error."""
1160
inv = self.inventory
1163
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1164
entry.to_tail, entry.to_parent_id, entry.from_rel,
1165
entry.from_tail, entry.from_parent_id,
1166
entry.only_change_inv))
1167
except errors.BzrMoveFailedError, e:
1168
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1169
" The working tree is in an inconsistent state."
1170
" Please consider doing a 'bzr revert'."
1171
" Error message is: %s" % e)
1173
def _move_entry(self, entry):
1174
inv = self.inventory
1175
from_rel_abs = self.abspath(entry.from_rel)
1176
to_rel_abs = self.abspath(entry.to_rel)
1177
if from_rel_abs == to_rel_abs:
1178
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1179
"Source and target are identical.")
1181
if not entry.only_change_inv:
1183
osutils.rename(from_rel_abs, to_rel_abs)
1185
raise errors.BzrMoveFailedError(entry.from_rel,
1187
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1189
@needs_tree_write_lock
1190
def rename_one(self, from_rel, to_rel, after=False):
1193
This can change the directory or the filename or both.
1195
rename_one has several 'modes' to work. First, it can rename a physical
1196
file and change the file_id. That is the normal mode. Second, it can
1197
only change the file_id without touching any physical file. This is
1198
the new mode introduced in version 0.15.
1200
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1201
versioned but present in the working tree.
1203
rename_one uses the second mode if 'after == False' and 'from_rel' is
1204
versioned but no longer in the working tree, and 'to_rel' is not
1205
versioned but present in the working tree.
1207
rename_one uses the first mode if 'after == False' and 'from_rel' is
1208
versioned and present in the working tree, and 'to_rel' is not
1209
versioned and not present in the working tree.
1211
Everything else results in an error.
1213
inv = self.inventory
1216
# create rename entries and tuples
1217
from_tail = splitpath(from_rel)[-1]
1218
from_id = inv.path2id(from_rel)
1220
raise errors.BzrRenameFailedError(from_rel,to_rel,
1221
errors.NotVersionedError(path=str(from_rel)))
1222
from_entry = inv[from_id]
1223
from_parent_id = from_entry.parent_id
1224
to_dir, to_tail = os.path.split(to_rel)
1225
to_dir_id = inv.path2id(to_dir)
1226
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1228
from_tail=from_tail,
1229
from_parent_id=from_parent_id,
1230
to_rel=to_rel, to_tail=to_tail,
1231
to_parent_id=to_dir_id)
1232
rename_entries.append(rename_entry)
1234
# determine which move mode to use. checks also for movability
1235
rename_entries = self._determine_mv_mode(rename_entries, after)
1237
# check if the target changed directory and if the target directory is
1239
if to_dir_id is None:
1240
raise errors.BzrMoveFailedError(from_rel,to_rel,
1241
errors.NotVersionedError(path=str(to_dir)))
1243
# all checks done. now we can continue with our actual work
1244
mutter('rename_one:\n'
1249
' to_dir_id {%s}\n',
1250
from_id, from_rel, to_rel, to_dir, to_dir_id)
1252
self._move(rename_entries)
1253
self._write_inventory(inv)
1255
class _RenameEntry(object):
1256
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1257
to_rel, to_tail, to_parent_id, only_change_inv=False):
1258
self.from_rel = from_rel
1259
self.from_id = from_id
1260
self.from_tail = from_tail
1261
self.from_parent_id = from_parent_id
1262
self.to_rel = to_rel
1263
self.to_tail = to_tail
1264
self.to_parent_id = to_parent_id
1265
self.only_change_inv = only_change_inv
1269
"""Return all unknown files.
1271
These are files in the working directory that are not versioned or
1272
control files or ignored.
1274
for subp in self.extras():
1275
if not self.is_ignored(subp):
1278
@needs_tree_write_lock
1279
def unversion(self, file_ids):
1280
"""Remove the file ids in file_ids from the current versioned set.
1282
When a file_id is unversioned, all of its children are automatically
1285
:param file_ids: The file ids to stop versioning.
1286
:raises: NoSuchId if any fileid is not currently versioned.
1288
for file_id in file_ids:
1289
if self._inventory.has_id(file_id):
1290
self._inventory.remove_recursive_id(file_id)
1292
raise errors.NoSuchId(self, file_id)
1294
# in the future this should just set a dirty bit to wait for the
1295
# final unlock. However, until all methods of workingtree start
1296
# with the current in -memory inventory rather than triggering
1297
# a read, it is more complex - we need to teach read_inventory
1298
# to know when to read, and when to not read first... and possibly
1299
# to save first when the in memory one may be corrupted.
1300
# so for now, we just only write it if it is indeed dirty.
1302
self._write_inventory(self._inventory)
1304
@deprecated_method(zero_eight)
1305
def iter_conflicts(self):
1306
"""List all files in the tree that have text or content conflicts.
1307
DEPRECATED. Use conflicts instead."""
1308
return self._iter_conflicts()
1310
def _iter_conflicts(self):
1312
for info in self.list_files():
1314
stem = get_conflicted_stem(path)
1317
if stem not in conflicted:
1318
conflicted.add(stem)
1322
def pull(self, source, overwrite=False, stop_revision=None,
1323
change_reporter=None):
1324
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1327
pp = ProgressPhase("Pull phase", 2, top_pb)
1329
old_revision_info = self.branch.last_revision_info()
1330
basis_tree = self.basis_tree()
1331
count = self.branch.pull(source, overwrite, stop_revision)
1332
new_revision_info = self.branch.last_revision_info()
1333
if new_revision_info != old_revision_info:
1335
repository = self.branch.repository
1336
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1338
new_basis_tree = self.branch.basis_tree()
1345
change_reporter=change_reporter)
1346
if (basis_tree.inventory.root is None and
1347
new_basis_tree.inventory.root is not None):
1348
self.set_root_id(new_basis_tree.inventory.root.file_id)
1351
# TODO - dedup parents list with things merged by pull ?
1352
# reuse the revisiontree we merged against to set the new
1354
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1355
# we have to pull the merge trees out again, because
1356
# merge_inner has set the ids. - this corner is not yet
1357
# layered well enough to prevent double handling.
1358
merges = self.get_parent_ids()[1:]
1359
parent_trees.extend([
1360
(parent, repository.revision_tree(parent)) for
1362
self.set_parent_trees(parent_trees)
1369
def put_file_bytes_non_atomic(self, file_id, bytes):
1370
"""See MutableTree.put_file_bytes_non_atomic."""
1371
stream = file(self.id2abspath(file_id), 'wb')
1376
# TODO: update the hashcache here ?
1379
"""Yield all unknown files in this WorkingTree.
1381
If there are any unknown directories then only the directory is
1382
returned, not all its children. But if there are unknown files
1383
under a versioned subdirectory, they are returned.
1385
Currently returned depth-first, sorted by name within directories.
1387
## TODO: Work from given directory downwards
1388
for path, dir_entry in self.inventory.directories():
1389
# mutter("search for unknowns in %r", path)
1390
dirabs = self.abspath(path)
1391
if not isdir(dirabs):
1392
# e.g. directory deleted
1396
for subf in os.listdir(dirabs):
1399
if subf not in dir_entry.children:
1400
subf_norm, can_access = osutils.normalized_filename(subf)
1401
if subf_norm != subf and can_access:
1402
if subf_norm not in dir_entry.children:
1403
fl.append(subf_norm)
1409
subp = pathjoin(path, subf)
1413
def ignored_files(self):
1414
"""Yield list of PATH, IGNORE_PATTERN"""
1415
for subp in self.extras():
1416
pat = self.is_ignored(subp)
1420
def get_ignore_list(self):
1421
"""Return list of ignore patterns.
1423
Cached in the Tree object after the first call.
1425
ignoreset = getattr(self, '_ignoreset', None)
1426
if ignoreset is not None:
1429
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1430
ignore_globs.update(ignores.get_runtime_ignores())
1431
ignore_globs.update(ignores.get_user_ignores())
1432
if self.has_filename(bzrlib.IGNORE_FILENAME):
1433
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1435
ignore_globs.update(ignores.parse_ignore_file(f))
1438
self._ignoreset = ignore_globs
1441
def _flush_ignore_list_cache(self):
1442
"""Resets the cached ignore list to force a cache rebuild."""
1443
self._ignoreset = None
1444
self._ignoreglobster = None
1446
def is_ignored(self, filename):
1447
r"""Check whether the filename matches an ignore pattern.
1449
Patterns containing '/' or '\' need to match the whole path;
1450
others match against only the last component.
1452
If the file is ignored, returns the pattern which caused it to
1453
be ignored, otherwise None. So this can simply be used as a
1454
boolean if desired."""
1455
if getattr(self, '_ignoreglobster', None) is None:
1456
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1457
return self._ignoreglobster.match(filename)
1459
def kind(self, file_id):
1460
return file_kind(self.id2abspath(file_id))
1462
def _comparison_data(self, entry, path):
1463
abspath = self.abspath(path)
1465
stat_value = os.lstat(abspath)
1467
if getattr(e, 'errno', None) == errno.ENOENT:
1474
mode = stat_value.st_mode
1475
kind = osutils.file_kind_from_stat_mode(mode)
1476
if not supports_executable():
1477
executable = entry.executable
1479
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1480
return kind, executable, stat_value
1482
def _file_size(self, entry, stat_value):
1483
return stat_value.st_size
1485
def last_revision(self):
1486
"""Return the last revision of the branch for this tree.
1488
This format tree does not support a separate marker for last-revision
1489
compared to the branch.
1491
See MutableTree.last_revision
1493
return self._last_revision()
1496
def _last_revision(self):
1497
"""helper for get_parent_ids."""
1498
return self.branch.last_revision()
1500
def is_locked(self):
1501
return self._control_files.is_locked()
1503
def lock_read(self):
1504
"""See Branch.lock_read, and WorkingTree.unlock."""
1505
self.branch.lock_read()
1507
return self._control_files.lock_read()
1509
self.branch.unlock()
1512
def lock_tree_write(self):
1513
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1514
self.branch.lock_read()
1516
return self._control_files.lock_write()
1518
self.branch.unlock()
1521
def lock_write(self):
1522
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1523
self.branch.lock_write()
1525
return self._control_files.lock_write()
1527
self.branch.unlock()
1530
def get_physical_lock_status(self):
1531
return self._control_files.get_physical_lock_status()
1533
def _basis_inventory_name(self):
1534
return 'basis-inventory-cache'
1536
@needs_tree_write_lock
1537
def set_last_revision(self, new_revision):
1538
"""Change the last revision in the working tree."""
1539
new_revision = osutils.safe_revision_id(new_revision)
1540
if self._change_last_revision(new_revision):
1541
self._cache_basis_inventory(new_revision)
1543
def _change_last_revision(self, new_revision):
1544
"""Template method part of set_last_revision to perform the change.
1546
This is used to allow WorkingTree3 instances to not affect branch
1547
when their last revision is set.
1549
if new_revision is None:
1550
self.branch.set_revision_history([])
1553
self.branch.generate_revision_history(new_revision)
1554
except errors.NoSuchRevision:
1555
# not present in the repo - dont try to set it deeper than the tip
1556
self.branch.set_revision_history([new_revision])
1559
def _write_basis_inventory(self, xml):
1560
"""Write the basis inventory XML to the basis-inventory file"""
1561
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1562
path = self._basis_inventory_name()
1564
self._control_files.put(path, sio)
1566
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1567
"""Create the text that will be saved in basis-inventory"""
1568
# TODO: jam 20070209 This should be redundant, as the revision_id
1569
# as all callers should have already converted the revision_id to
1571
inventory.revision_id = osutils.safe_revision_id(revision_id)
1572
return xml6.serializer_v6.write_inventory_to_string(inventory)
1574
def _cache_basis_inventory(self, new_revision):
1575
"""Cache new_revision as the basis inventory."""
1576
# TODO: this should allow the ready-to-use inventory to be passed in,
1577
# as commit already has that ready-to-use [while the format is the
1580
# this double handles the inventory - unpack and repack -
1581
# but is easier to understand. We can/should put a conditional
1582
# in here based on whether the inventory is in the latest format
1583
# - perhaps we should repack all inventories on a repository
1585
# the fast path is to copy the raw xml from the repository. If the
1586
# xml contains 'revision_id="', then we assume the right
1587
# revision_id is set. We must check for this full string, because a
1588
# root node id can legitimately look like 'revision_id' but cannot
1590
xml = self.branch.repository.get_inventory_xml(new_revision)
1591
firstline = xml.split('\n', 1)[0]
1592
if (not 'revision_id="' in firstline or
1593
'format="6"' not in firstline):
1594
inv = self.branch.repository.deserialise_inventory(
1596
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1597
self._write_basis_inventory(xml)
1598
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1601
def read_basis_inventory(self):
1602
"""Read the cached basis inventory."""
1603
path = self._basis_inventory_name()
1604
return self._control_files.get(path).read()
1607
def read_working_inventory(self):
1608
"""Read the working inventory.
1610
:raises errors.InventoryModified: read_working_inventory will fail
1611
when the current in memory inventory has been modified.
1613
# conceptually this should be an implementation detail of the tree.
1614
# XXX: Deprecate this.
1615
# ElementTree does its own conversion from UTF-8, so open in
1617
if self._inventory_is_modified:
1618
raise errors.InventoryModified(self)
1619
result = xml5.serializer_v5.read_inventory(
1620
self._control_files.get('inventory'))
1621
self._set_inventory(result, dirty=False)
1624
@needs_tree_write_lock
1625
def remove(self, files, verbose=False, to_file=None):
1626
"""Remove nominated files from the working inventory..
1628
This does not remove their text. This does not run on XXX on what? RBC
1630
TODO: Refuse to remove modified files unless --force is given?
1632
TODO: Do something useful with directories.
1634
TODO: Should this remove the text or not? Tough call; not
1635
removing may be useful and the user can just use use rm, and
1636
is the opposite of add. Removing it is consistent with most
1637
other tools. Maybe an option.
1639
## TODO: Normalize names
1640
## TODO: Remove nested loops; better scalability
1641
if isinstance(files, basestring):
1644
inv = self.inventory
1646
# do this before any modifications
1648
fid = inv.path2id(f)
1650
note("%s is not versioned."%f)
1653
# having remove it, it must be either ignored or unknown
1654
if self.is_ignored(f):
1658
textui.show_status(new_status, inv[fid].kind, f,
1662
self._write_inventory(inv)
1664
@needs_tree_write_lock
1665
def revert(self, filenames, old_tree=None, backups=True,
1666
pb=DummyProgress(), report_changes=False):
1667
from bzrlib.conflicts import resolve
1668
if old_tree is None:
1669
old_tree = self.basis_tree()
1670
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1672
if not len(filenames):
1673
self.set_parent_ids(self.get_parent_ids()[:1])
1676
resolve(self, filenames, ignore_misses=True)
1679
# XXX: This method should be deprecated in favour of taking in a proper
1680
# new Inventory object.
1681
@needs_tree_write_lock
1682
def set_inventory(self, new_inventory_list):
1683
from bzrlib.inventory import (Inventory,
1688
inv = Inventory(self.get_root_id())
1689
for path, file_id, parent, kind in new_inventory_list:
1690
name = os.path.basename(path)
1693
# fixme, there should be a factory function inv,add_??
1694
if kind == 'directory':
1695
inv.add(InventoryDirectory(file_id, name, parent))
1696
elif kind == 'file':
1697
inv.add(InventoryFile(file_id, name, parent))
1698
elif kind == 'symlink':
1699
inv.add(InventoryLink(file_id, name, parent))
1701
raise errors.BzrError("unknown kind %r" % kind)
1702
self._write_inventory(inv)
1704
@needs_tree_write_lock
1705
def set_root_id(self, file_id):
1706
"""Set the root id for this tree."""
1709
symbol_versioning.warn(symbol_versioning.zero_twelve
1710
% 'WorkingTree.set_root_id with fileid=None',
1714
inv = self._inventory
1715
orig_root_id = inv.root.file_id
1716
# TODO: it might be nice to exit early if there was nothing
1717
# to do, saving us from trigger a sync on unlock.
1718
self._inventory_is_modified = True
1719
# we preserve the root inventory entry object, but
1720
# unlinkit from the byid index
1721
del inv._byid[inv.root.file_id]
1722
inv.root.file_id = file_id
1723
# and link it into the index with the new changed id.
1724
inv._byid[inv.root.file_id] = inv.root
1725
# and finally update all children to reference the new id.
1726
# XXX: this should be safe to just look at the root.children
1727
# list, not the WHOLE INVENTORY.
1730
if entry.parent_id == orig_root_id:
1731
entry.parent_id = inv.root.file_id
1734
"""See Branch.unlock.
1736
WorkingTree locking just uses the Branch locking facilities.
1737
This is current because all working trees have an embedded branch
1738
within them. IF in the future, we were to make branch data shareable
1739
between multiple working trees, i.e. via shared storage, then we
1740
would probably want to lock both the local tree, and the branch.
1742
raise NotImplementedError(self.unlock)
1745
"""Update a working tree along its branch.
1747
This will update the branch if its bound too, which means we have
1748
multiple trees involved:
1750
- The new basis tree of the master.
1751
- The old basis tree of the branch.
1752
- The old basis tree of the working tree.
1753
- The current working tree state.
1755
Pathologically, all three may be different, and non-ancestors of each
1756
other. Conceptually we want to:
1758
- Preserve the wt.basis->wt.state changes
1759
- Transform the wt.basis to the new master basis.
1760
- Apply a merge of the old branch basis to get any 'local' changes from
1762
- Restore the wt.basis->wt.state changes.
1764
There isn't a single operation at the moment to do that, so we:
1765
- Merge current state -> basis tree of the master w.r.t. the old tree
1767
- Do a 'normal' merge of the old branch basis if it is relevant.
1769
if self.branch.get_master_branch() is not None:
1771
update_branch = True
1773
self.lock_tree_write()
1774
update_branch = False
1777
old_tip = self.branch.update()
1780
return self._update_tree(old_tip)
1784
@needs_tree_write_lock
1785
def _update_tree(self, old_tip=None):
1786
"""Update a tree to the master branch.
1788
:param old_tip: if supplied, the previous tip revision the branch,
1789
before it was changed to the master branch's tip.
1791
# here if old_tip is not None, it is the old tip of the branch before
1792
# it was updated from the master branch. This should become a pending
1793
# merge in the working tree to preserve the user existing work. we
1794
# cant set that until we update the working trees last revision to be
1795
# one from the new branch, because it will just get absorbed by the
1796
# parent de-duplication logic.
1798
# We MUST save it even if an error occurs, because otherwise the users
1799
# local work is unreferenced and will appear to have been lost.
1803
last_rev = self.get_parent_ids()[0]
1806
if last_rev != self.branch.last_revision():
1807
# merge tree state up to new branch tip.
1808
basis = self.basis_tree()
1809
to_tree = self.branch.basis_tree()
1810
if basis.inventory.root is None:
1811
self.set_root_id(to_tree.inventory.root.file_id)
1812
result += merge.merge_inner(
1817
# TODO - dedup parents list with things merged by pull ?
1818
# reuse the tree we've updated to to set the basis:
1819
parent_trees = [(self.branch.last_revision(), to_tree)]
1820
merges = self.get_parent_ids()[1:]
1821
# Ideally we ask the tree for the trees here, that way the working
1822
# tree can decide whether to give us teh entire tree or give us a
1823
# lazy initialised tree. dirstate for instance will have the trees
1824
# in ram already, whereas a last-revision + basis-inventory tree
1825
# will not, but also does not need them when setting parents.
1826
for parent in merges:
1827
parent_trees.append(
1828
(parent, self.branch.repository.revision_tree(parent)))
1829
if old_tip is not None:
1830
parent_trees.append(
1831
(old_tip, self.branch.repository.revision_tree(old_tip)))
1832
self.set_parent_trees(parent_trees)
1833
last_rev = parent_trees[0][0]
1835
# the working tree had the same last-revision as the master
1836
# branch did. We may still have pivot local work from the local
1837
# branch into old_tip:
1838
if old_tip is not None:
1839
self.add_parent_tree_id(old_tip)
1840
if old_tip and old_tip != last_rev:
1841
# our last revision was not the prior branch last revision
1842
# and we have converted that last revision to a pending merge.
1843
# base is somewhere between the branch tip now
1844
# and the now pending merge
1845
from bzrlib.revision import common_ancestor
1847
base_rev_id = common_ancestor(self.branch.last_revision(),
1849
self.branch.repository)
1850
except errors.NoCommonAncestor:
1852
base_tree = self.branch.repository.revision_tree(base_rev_id)
1853
other_tree = self.branch.repository.revision_tree(old_tip)
1854
result += merge.merge_inner(
1861
def _write_hashcache_if_dirty(self):
1862
"""Write out the hashcache if it is dirty."""
1863
if self._hashcache.needs_write:
1865
self._hashcache.write()
1867
if e.errno not in (errno.EPERM, errno.EACCES):
1869
# TODO: jam 20061219 Should this be a warning? A single line
1870
# warning might be sufficient to let the user know what
1872
mutter('Could not write hashcache for %s\nError: %s',
1873
self._hashcache.cache_file_name(), e)
1875
@needs_tree_write_lock
1876
def _write_inventory(self, inv):
1877
"""Write inventory as the current inventory."""
1878
self._set_inventory(inv, dirty=True)
1881
def set_conflicts(self, arg):
1882
raise errors.UnsupportedOperation(self.set_conflicts, self)
1884
def add_conflicts(self, arg):
1885
raise errors.UnsupportedOperation(self.add_conflicts, self)
1888
def conflicts(self):
1889
conflicts = _mod_conflicts.ConflictList()
1890
for conflicted in self._iter_conflicts():
1893
if file_kind(self.abspath(conflicted)) != "file":
1895
except errors.NoSuchFile:
1898
for suffix in ('.THIS', '.OTHER'):
1900
kind = file_kind(self.abspath(conflicted+suffix))
1903
except errors.NoSuchFile:
1907
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1908
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1910
file_id=self.path2id(conflicted)))
1914
class WorkingTree2(WorkingTree):
1915
"""This is the Format 2 working tree.
1917
This was the first weave based working tree.
1918
- uses os locks for locking.
1919
- uses the branch last-revision.
1922
def lock_tree_write(self):
1923
"""See WorkingTree.lock_tree_write().
1925
In Format2 WorkingTrees we have a single lock for the branch and tree
1926
so lock_tree_write() degrades to lock_write().
1928
self.branch.lock_write()
1930
return self._control_files.lock_write()
1932
self.branch.unlock()
1936
# we share control files:
1937
if self._control_files._lock_count == 3:
1938
# _inventory_is_modified is always False during a read lock.
1939
if self._inventory_is_modified:
1941
self._write_hashcache_if_dirty()
1943
# reverse order of locking.
1945
return self._control_files.unlock()
1947
self.branch.unlock()
1950
class WorkingTree3(WorkingTree):
1951
"""This is the Format 3 working tree.
1953
This differs from the base WorkingTree by:
1954
- having its own file lock
1955
- having its own last-revision property.
1957
This is new in bzr 0.8
1961
def _last_revision(self):
1962
"""See Mutable.last_revision."""
1964
return osutils.safe_revision_id(
1965
self._control_files.get('last-revision').read())
1966
except errors.NoSuchFile:
1969
def _change_last_revision(self, revision_id):
1970
"""See WorkingTree._change_last_revision."""
1971
if revision_id is None or revision_id == NULL_REVISION:
1973
self._control_files._transport.delete('last-revision')
1974
except errors.NoSuchFile:
1978
self._control_files.put_utf8('last-revision', revision_id)
1981
@needs_tree_write_lock
1982
def set_conflicts(self, conflicts):
1983
self._put_rio('conflicts', conflicts.to_stanzas(),
1986
@needs_tree_write_lock
1987
def add_conflicts(self, new_conflicts):
1988
conflict_set = set(self.conflicts())
1989
conflict_set.update(set(list(new_conflicts)))
1990
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
1991
key=_mod_conflicts.Conflict.sort_key)))
1994
def conflicts(self):
1996
confile = self._control_files.get('conflicts')
1997
except errors.NoSuchFile:
1998
return _mod_conflicts.ConflictList()
2000
if confile.next() != CONFLICT_HEADER_1 + '\n':
2001
raise errors.ConflictFormatError()
2002
except StopIteration:
2003
raise errors.ConflictFormatError()
2004
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2007
if self._control_files._lock_count == 1:
2008
# _inventory_is_modified is always False during a read lock.
2009
if self._inventory_is_modified:
2011
self._write_hashcache_if_dirty()
2012
# reverse order of locking.
2014
return self._control_files.unlock()
2016
self.branch.unlock()
2019
def get_conflicted_stem(path):
2020
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2021
if path.endswith(suffix):
2022
return path[:-len(suffix)]
2024
@deprecated_function(zero_eight)
2025
def is_control_file(filename):
2026
"""See WorkingTree.is_control_filename(filename)."""
2027
## FIXME: better check
2028
filename = normpath(filename)
2029
while filename != '':
2030
head, tail = os.path.split(filename)
2031
## mutter('check %r for control file' % ((head, tail),))
2034
if filename == head:
2040
class WorkingTreeFormat(object):
2041
"""An encapsulation of the initialization and open routines for a format.
2043
Formats provide three things:
2044
* An initialization routine,
2048
Formats are placed in an dict by their format string for reference
2049
during workingtree opening. Its not required that these be instances, they
2050
can be classes themselves with class methods - it simply depends on
2051
whether state is needed for a given format or not.
2053
Once a format is deprecated, just deprecate the initialize and open
2054
methods on the format class. Do not deprecate the object, as the
2055
object will be created every time regardless.
2058
_default_format = None
2059
"""The default format used for new trees."""
2062
"""The known formats."""
2065
def find_format(klass, a_bzrdir):
2066
"""Return the format for the working tree object in a_bzrdir."""
2068
transport = a_bzrdir.get_workingtree_transport(None)
2069
format_string = transport.get("format").read()
2070
return klass._formats[format_string]
2071
except errors.NoSuchFile:
2072
raise errors.NoWorkingTree(base=transport.base)
2074
raise errors.UnknownFormatError(format=format_string)
2077
def get_default_format(klass):
2078
"""Return the current default format."""
2079
return klass._default_format
2081
def get_format_string(self):
2082
"""Return the ASCII format string that identifies this format."""
2083
raise NotImplementedError(self.get_format_string)
2085
def get_format_description(self):
2086
"""Return the short description for this format."""
2087
raise NotImplementedError(self.get_format_description)
2089
def is_supported(self):
2090
"""Is this format supported?
2092
Supported formats can be initialized and opened.
2093
Unsupported formats may not support initialization or committing or
2094
some other features depending on the reason for not being supported.
2099
def register_format(klass, format):
2100
klass._formats[format.get_format_string()] = format
2103
def set_default_format(klass, format):
2104
klass._default_format = format
2107
def unregister_format(klass, format):
2108
assert klass._formats[format.get_format_string()] is format
2109
del klass._formats[format.get_format_string()]
2113
class WorkingTreeFormat2(WorkingTreeFormat):
2114
"""The second working tree format.
2116
This format modified the hash cache from the format 1 hash cache.
2119
def get_format_description(self):
2120
"""See WorkingTreeFormat.get_format_description()."""
2121
return "Working tree format 2"
2123
def stub_initialize_remote(self, control_files):
2124
"""As a special workaround create critical control files for a remote working tree
2126
This ensures that it can later be updated and dealt with locally,
2127
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2128
no working tree. (See bug #43064).
2132
xml5.serializer_v5.write_inventory(inv, sio)
2134
control_files.put('inventory', sio)
2136
control_files.put_utf8('pending-merges', '')
2139
def initialize(self, a_bzrdir, revision_id=None):
2140
"""See WorkingTreeFormat.initialize()."""
2141
if not isinstance(a_bzrdir.transport, LocalTransport):
2142
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2143
branch = a_bzrdir.open_branch()
2144
if revision_id is not None:
2145
revision_id = osutils.safe_revision_id(revision_id)
2148
revision_history = branch.revision_history()
2150
position = revision_history.index(revision_id)
2152
raise errors.NoSuchRevision(branch, revision_id)
2153
branch.set_revision_history(revision_history[:position + 1])
2156
revision = branch.last_revision()
2158
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2164
basis_tree = branch.repository.revision_tree(revision)
2165
if basis_tree.inventory.root is not None:
2166
wt.set_root_id(basis_tree.inventory.root.file_id)
2167
# set the parent list and cache the basis tree.
2168
wt.set_parent_trees([(revision, basis_tree)])
2169
transform.build_tree(basis_tree, wt)
2173
super(WorkingTreeFormat2, self).__init__()
2174
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2176
def open(self, a_bzrdir, _found=False):
2177
"""Return the WorkingTree object for a_bzrdir
2179
_found is a private parameter, do not use it. It is used to indicate
2180
if format probing has already been done.
2183
# we are being called directly and must probe.
2184
raise NotImplementedError
2185
if not isinstance(a_bzrdir.transport, LocalTransport):
2186
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2187
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2193
class WorkingTreeFormat3(WorkingTreeFormat):
2194
"""The second working tree format updated to record a format marker.
2197
- exists within a metadir controlling .bzr
2198
- includes an explicit version marker for the workingtree control
2199
files, separate from the BzrDir format
2200
- modifies the hash cache format
2202
- uses a LockDir to guard access for writes.
2205
def get_format_string(self):
2206
"""See WorkingTreeFormat.get_format_string()."""
2207
return "Bazaar-NG Working Tree format 3"
2209
def get_format_description(self):
2210
"""See WorkingTreeFormat.get_format_description()."""
2211
return "Working tree format 3"
2213
_lock_file_name = 'lock'
2214
_lock_class = LockDir
2216
def _open_control_files(self, a_bzrdir):
2217
transport = a_bzrdir.get_workingtree_transport(None)
2218
return LockableFiles(transport, self._lock_file_name,
2221
def initialize(self, a_bzrdir, revision_id=None):
2222
"""See WorkingTreeFormat.initialize().
2224
revision_id allows creating a working tree at a different
2225
revision than the branch is at.
2227
if not isinstance(a_bzrdir.transport, LocalTransport):
2228
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2229
transport = a_bzrdir.get_workingtree_transport(self)
2230
control_files = self._open_control_files(a_bzrdir)
2231
control_files.create_lock()
2232
control_files.lock_write()
2233
control_files.put_utf8('format', self.get_format_string())
2234
branch = a_bzrdir.open_branch()
2235
if revision_id is None:
2236
revision_id = branch.last_revision()
2238
revision_id = osutils.safe_revision_id(revision_id)
2239
# WorkingTree3 can handle an inventory which has a unique root id.
2240
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2241
# those trees. And because there isn't a format bump inbetween, we
2242
# are maintaining compatibility with older clients.
2243
# inv = Inventory(root_id=gen_root_id())
2245
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2251
_control_files=control_files)
2252
wt.lock_tree_write()
2254
basis_tree = branch.repository.revision_tree(revision_id)
2255
# only set an explicit root id if there is one to set.
2256
if basis_tree.inventory.root is not None:
2257
wt.set_root_id(basis_tree.inventory.root.file_id)
2258
if revision_id == NULL_REVISION:
2259
wt.set_parent_trees([])
2261
wt.set_parent_trees([(revision_id, basis_tree)])
2262
transform.build_tree(basis_tree, wt)
2264
# Unlock in this order so that the unlock-triggers-flush in
2265
# WorkingTree is given a chance to fire.
2266
control_files.unlock()
2271
super(WorkingTreeFormat3, self).__init__()
2272
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2274
def open(self, a_bzrdir, _found=False):
2275
"""Return the WorkingTree object for a_bzrdir
2277
_found is a private parameter, do not use it. It is used to indicate
2278
if format probing has already been done.
2281
# we are being called directly and must probe.
2282
raise NotImplementedError
2283
if not isinstance(a_bzrdir.transport, LocalTransport):
2284
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2285
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2287
def _open(self, a_bzrdir, control_files):
2288
"""Open the tree itself.
2290
:param a_bzrdir: the dir for the tree.
2291
:param control_files: the control files for the tree.
2293
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2297
_control_files=control_files)
2300
return self.get_format_string()
2303
# formats which have no format string are not discoverable
2304
# and not independently creatable, so are not registered.
2305
__default_format = WorkingTreeFormat3()
2306
WorkingTreeFormat.register_format(__default_format)
2307
WorkingTreeFormat.set_default_format(__default_format)
2308
_legacy_formats = [WorkingTreeFormat2(),
2312
class WorkingTreeTestProviderAdapter(object):
2313
"""A tool to generate a suite testing multiple workingtree formats at once.
2315
This is done by copying the test once for each transport and injecting
2316
the transport_server, transport_readonly_server, and workingtree_format
2317
classes into each copy. Each copy is also given a new id() to make it
2321
def __init__(self, transport_server, transport_readonly_server, formats):
2322
self._transport_server = transport_server
2323
self._transport_readonly_server = transport_readonly_server
2324
self._formats = formats
2326
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2327
"""Clone test for adaption."""
2328
new_test = deepcopy(test)
2329
new_test.transport_server = self._transport_server
2330
new_test.transport_readonly_server = self._transport_readonly_server
2331
new_test.bzrdir_format = bzrdir_format
2332
new_test.workingtree_format = workingtree_format
2333
def make_new_test_id():
2334
new_id = "%s(%s)" % (test.id(), variation)
2335
return lambda: new_id
2336
new_test.id = make_new_test_id()
2339
def adapt(self, test):
2340
from bzrlib.tests import TestSuite
2341
result = TestSuite()
2342
for workingtree_format, bzrdir_format in self._formats:
2343
new_test = self._clone_test(
2346
workingtree_format, workingtree_format.__class__.__name__)
2347
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
