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
55
conflicts as _mod_conflicts,
70
from bzrlib.transport import get_transport
74
from bzrlib import symbol_versioning
75
from bzrlib.decorators import needs_read_lock, needs_write_lock
76
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
77
from bzrlib.lockable_files import LockableFiles, TransportLock
78
from bzrlib.lockdir import LockDir
79
import bzrlib.mutabletree
80
from bzrlib.mutabletree import needs_tree_write_lock
81
from bzrlib.osutils import (
93
from bzrlib.trace import mutter, note
94
from bzrlib.transport.local import LocalTransport
96
from bzrlib.progress import DummyProgress, ProgressPhase
97
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
98
import bzrlib.revisiontree
99
from bzrlib.rio import RioReader, rio_file, Stanza
100
from bzrlib.symbol_versioning import (deprecated_passed,
103
DEPRECATED_PARAMETER,
110
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
111
CONFLICT_HEADER_1 = "BZR conflict list format 1"
114
@deprecated_function(zero_thirteen)
115
def gen_file_id(name):
116
"""Return new file id for the basename 'name'.
118
Use bzrlib.generate_ids.gen_file_id() instead
120
return generate_ids.gen_file_id(name)
123
@deprecated_function(zero_thirteen)
125
"""Return a new tree-root file id.
127
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
129
return generate_ids.gen_root_id()
132
class TreeEntry(object):
133
"""An entry that implements the minimum interface used by commands.
135
This needs further inspection, it may be better to have
136
InventoryEntries without ids - though that seems wrong. For now,
137
this is a parallel hierarchy to InventoryEntry, and needs to become
138
one of several things: decorates to that hierarchy, children of, or
140
Another note is that these objects are currently only used when there is
141
no InventoryEntry available - i.e. for unversioned objects.
142
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
145
def __eq__(self, other):
146
# yes, this us ugly, TODO: best practice __eq__ style.
147
return (isinstance(other, TreeEntry)
148
and other.__class__ == self.__class__)
150
def kind_character(self):
154
class TreeDirectory(TreeEntry):
155
"""See TreeEntry. This is a directory in a working tree."""
157
def __eq__(self, other):
158
return (isinstance(other, TreeDirectory)
159
and other.__class__ == self.__class__)
161
def kind_character(self):
165
class TreeFile(TreeEntry):
166
"""See TreeEntry. This is a regular file in a working tree."""
168
def __eq__(self, other):
169
return (isinstance(other, TreeFile)
170
and other.__class__ == self.__class__)
172
def kind_character(self):
176
class TreeLink(TreeEntry):
177
"""See TreeEntry. This is a symlink in a working tree."""
179
def __eq__(self, other):
180
return (isinstance(other, TreeLink)
181
and other.__class__ == self.__class__)
183
def kind_character(self):
187
class WorkingTree(bzrlib.mutabletree.MutableTree):
188
"""Working copy tree.
190
The inventory is held in the `Branch` working-inventory, and the
191
files are in a directory on disk.
193
It is possible for a `WorkingTree` to have a filename which is
194
not listed in the Inventory and vice versa.
197
def __init__(self, basedir='.',
198
branch=DEPRECATED_PARAMETER,
204
"""Construct a WorkingTree for basedir.
206
If the branch is not supplied, it is opened automatically.
207
If the branch is supplied, it must be the branch for this basedir.
208
(branch.base is not cross checked, because for remote branches that
209
would be meaningless).
211
self._format = _format
212
self.bzrdir = _bzrdir
214
# not created via open etc.
215
warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
216
"Please use bzrdir.open_workingtree or WorkingTree.open().",
219
wt = WorkingTree.open(basedir)
220
self._branch = wt.branch
221
self.basedir = wt.basedir
222
self._control_files = wt._control_files
223
self._hashcache = wt._hashcache
224
self._set_inventory(wt._inventory, dirty=False)
225
self._format = wt._format
226
self.bzrdir = wt.bzrdir
227
assert isinstance(basedir, basestring), \
228
"base directory %r is not a string" % basedir
229
basedir = safe_unicode(basedir)
230
mutter("opening working tree %r", basedir)
231
if deprecated_passed(branch):
233
warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
234
" as of bzr 0.8. Please use bzrdir.open_workingtree() or"
235
" WorkingTree.open().",
239
self._branch = branch
241
self._branch = self.bzrdir.open_branch()
242
self.basedir = realpath(basedir)
243
# if branch is at our basedir and is a format 6 or less
244
if isinstance(self._format, WorkingTreeFormat2):
245
# share control object
246
self._control_files = self.branch.control_files
248
# assume all other formats have their own control files.
249
assert isinstance(_control_files, LockableFiles), \
250
"_control_files must be a LockableFiles, not %r" \
252
self._control_files = _control_files
253
# update the whole cache up front and write to disk if anything changed;
254
# in the future we might want to do this more selectively
255
# two possible ways offer themselves : in self._unlock, write the cache
256
# if needed, or, when the cache sees a change, append it to the hash
257
# cache file, and have the parser take the most recent entry for a
259
wt_trans = self.bzrdir.get_workingtree_transport(None)
260
cache_filename = wt_trans.local_abspath('stat-cache')
261
self._hashcache = hashcache.HashCache(basedir, cache_filename,
262
self._control_files._file_mode)
265
# is this scan needed ? it makes things kinda slow.
272
if _inventory is None:
273
self._inventory_is_modified = False
274
self.read_working_inventory()
276
# the caller of __init__ has provided an inventory,
277
# we assume they know what they are doing - as its only
278
# the Format factory and creation methods that are
279
# permitted to do this.
280
self._set_inventory(_inventory, dirty=False)
283
fget=lambda self: self._branch,
284
doc="""The branch this WorkingTree is connected to.
286
This cannot be set - it is reflective of the actual disk structure
287
the working tree has been constructed from.
290
def break_lock(self):
291
"""Break a lock if one is present from another instance.
293
Uses the ui factory to ask for confirmation if the lock may be from
296
This will probe the repository for its lock as well.
298
self._control_files.break_lock()
299
self.branch.break_lock()
301
def _set_inventory(self, inv, dirty):
302
"""Set the internal cached inventory.
304
:param inv: The inventory to set.
305
:param dirty: A boolean indicating whether the inventory is the same
306
logical inventory as whats on disk. If True the inventory is not
307
the same and should be written to disk or data will be lost, if
308
False then the inventory is the same as that on disk and any
309
serialisation would be unneeded overhead.
311
assert inv.root is not None
312
self._inventory = inv
313
self._inventory_is_modified = dirty
316
def open(path=None, _unsupported=False):
317
"""Open an existing working tree at path.
321
path = os.path.getcwdu()
322
control = bzrdir.BzrDir.open(path, _unsupported)
323
return control.open_workingtree(_unsupported)
326
def open_containing(path=None):
327
"""Open an existing working tree which has its root about path.
329
This probes for a working tree at path and searches upwards from there.
331
Basically we keep looking up until we find the control directory or
332
run into /. If there isn't one, raises NotBranchError.
333
TODO: give this a new exception.
334
If there is one, it is returned, along with the unused portion of path.
336
:return: The WorkingTree that contains 'path', and the rest of path
339
path = osutils.getcwd()
340
control, relpath = bzrdir.BzrDir.open_containing(path)
342
return control.open_workingtree(), relpath
345
def open_downlevel(path=None):
346
"""Open an unsupported working tree.
348
Only intended for advanced situations like upgrading part of a bzrdir.
350
return WorkingTree.open(path, _unsupported=True)
353
"""Iterate through file_ids for this tree.
355
file_ids are in a WorkingTree if they are in the working inventory
356
and the working file exists.
358
inv = self._inventory
359
for path, ie in inv.iter_entries():
360
if osutils.lexists(self.abspath(path)):
364
return "<%s of %s>" % (self.__class__.__name__,
365
getattr(self, 'basedir', None))
367
def abspath(self, filename):
368
return pathjoin(self.basedir, filename)
370
def basis_tree(self):
371
"""Return RevisionTree for the current last revision.
373
If the left most parent is a ghost then the returned tree will be an
374
empty tree - one obtained by calling repository.revision_tree(None).
377
revision_id = self.get_parent_ids()[0]
379
# no parents, return an empty revision tree.
380
# in the future this should return the tree for
381
# 'empty:' - the implicit root empty tree.
382
return self.branch.repository.revision_tree(None)
385
xml = self.read_basis_inventory()
386
inv = xml6.serializer_v6.read_inventory_from_string(xml)
387
if inv is not None and inv.revision_id == revision_id:
388
return bzrlib.revisiontree.RevisionTree(
389
self.branch.repository, inv, revision_id)
390
except (errors.NoSuchFile, errors.BadInventoryFormat):
392
# No cached copy available, retrieve from the repository.
393
# FIXME? RBC 20060403 should we cache the inventory locally
396
return self.branch.repository.revision_tree(revision_id)
397
except errors.RevisionNotPresent:
398
# the basis tree *may* be a ghost or a low level error may have
399
# occured. If the revision is present, its a problem, if its not
401
if self.branch.repository.has_revision(revision_id):
403
# the basis tree is a ghost so return an empty tree.
404
return self.branch.repository.revision_tree(None)
407
@deprecated_method(zero_eight)
408
def create(branch, directory):
409
"""Create a workingtree for branch at directory.
411
If existing_directory already exists it must have a .bzr directory.
412
If it does not exist, it will be created.
414
This returns a new WorkingTree object for the new checkout.
416
TODO FIXME RBC 20060124 when we have checkout formats in place this
417
should accept an optional revisionid to checkout [and reject this if
418
checking out into the same dir as a pre-checkout-aware branch format.]
420
XXX: When BzrDir is present, these should be created through that
423
warnings.warn('delete WorkingTree.create', stacklevel=3)
424
transport = get_transport(directory)
425
if branch.bzrdir.root_transport.base == transport.base:
427
return branch.bzrdir.create_workingtree()
428
# different directory,
429
# create a branch reference
430
# and now a working tree.
431
raise NotImplementedError
434
@deprecated_method(zero_eight)
435
def create_standalone(directory):
436
"""Create a checkout and a branch and a repo at directory.
438
Directory must exist and be empty.
440
please use BzrDir.create_standalone_workingtree
442
return bzrdir.BzrDir.create_standalone_workingtree(directory)
444
def relpath(self, path):
445
"""Return the local path portion from a given path.
447
The path may be absolute or relative. If its a relative path it is
448
interpreted relative to the python current working directory.
450
return osutils.relpath(self.basedir, path)
452
def has_filename(self, filename):
453
return osutils.lexists(self.abspath(filename))
455
def get_file(self, file_id):
456
file_id = osutils.safe_file_id(file_id)
457
return self.get_file_byname(self.id2path(file_id))
459
def get_file_text(self, file_id):
460
file_id = osutils.safe_file_id(file_id)
461
return self.get_file(file_id).read()
463
def get_file_byname(self, filename):
464
return file(self.abspath(filename), 'rb')
466
def annotate_iter(self, file_id):
467
"""See Tree.annotate_iter
469
This implementation will use the basis tree implementation if possible.
470
Lines not in the basis are attributed to CURRENT_REVISION
472
If there are pending merges, lines added by those merges will be
473
incorrectly attributed to CURRENT_REVISION (but after committing, the
474
attribution will be correct).
476
file_id = osutils.safe_file_id(file_id)
477
basis = self.basis_tree()
478
changes = self._iter_changes(basis, True, [file_id]).next()
479
changed_content, kind = changes[2], changes[6]
480
if not changed_content:
481
return basis.annotate_iter(file_id)
485
if kind[0] != 'file':
488
old_lines = list(basis.annotate_iter(file_id))
490
for tree in self.branch.repository.revision_trees(
491
self.get_parent_ids()[1:]):
492
if file_id not in tree:
494
old.append(list(tree.annotate_iter(file_id)))
495
return annotate.reannotate(old, self.get_file(file_id).readlines(),
498
def get_parent_ids(self):
499
"""See Tree.get_parent_ids.
501
This implementation reads the pending merges list and last_revision
502
value and uses that to decide what the parents list should be.
504
last_rev = self._last_revision()
510
merges_file = self._control_files.get('pending-merges')
511
except errors.NoSuchFile:
514
for l in merges_file.readlines():
515
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
516
parents.append(revision_id)
520
def get_root_id(self):
521
"""Return the id of this trees root"""
522
return self._inventory.root.file_id
524
def _get_store_filename(self, file_id):
525
## XXX: badly named; this is not in the store at all
526
file_id = osutils.safe_file_id(file_id)
527
return self.abspath(self.id2path(file_id))
530
def clone(self, to_bzrdir, revision_id=None, basis=None):
531
"""Duplicate this working tree into to_bzr, including all state.
533
Specifically modified files are kept as modified, but
534
ignored and unknown files are discarded.
536
If you want to make a new line of development, see bzrdir.sprout()
539
If not None, the cloned tree will have its last revision set to
540
revision, and and difference between the source trees last revision
541
and this one merged in.
544
If not None, a closer copy of a tree which may have some files in
545
common, and which file content should be preferentially copied from.
547
# assumes the target bzr dir format is compatible.
548
result = self._format.initialize(to_bzrdir)
549
self.copy_content_into(result, revision_id)
553
def copy_content_into(self, tree, revision_id=None):
554
"""Copy the current content and user files of this tree into tree."""
555
tree.set_root_id(self.get_root_id())
556
if revision_id is None:
557
merge.transform_tree(tree, self)
559
# TODO now merge from tree.last_revision to revision (to preserve
560
# user local changes)
561
merge.transform_tree(tree, self)
562
tree.set_parent_ids([revision_id])
564
def id2abspath(self, file_id):
565
file_id = osutils.safe_file_id(file_id)
566
return self.abspath(self.id2path(file_id))
568
def has_id(self, file_id):
569
# files that have been deleted are excluded
570
file_id = osutils.safe_file_id(file_id)
571
inv = self._inventory
572
if not inv.has_id(file_id):
574
path = inv.id2path(file_id)
575
return osutils.lexists(self.abspath(path))
577
def has_or_had_id(self, file_id):
578
file_id = osutils.safe_file_id(file_id)
579
if file_id == self.inventory.root.file_id:
581
return self.inventory.has_id(file_id)
583
__contains__ = has_id
585
def get_file_size(self, file_id):
586
file_id = osutils.safe_file_id(file_id)
587
return os.path.getsize(self.id2abspath(file_id))
590
def get_file_sha1(self, file_id, path=None, stat_value=None):
591
file_id = osutils.safe_file_id(file_id)
593
path = self._inventory.id2path(file_id)
594
return self._hashcache.get_sha1(path, stat_value)
596
def get_file_mtime(self, file_id, path=None):
597
file_id = osutils.safe_file_id(file_id)
599
path = self._inventory.id2path(file_id)
600
return os.lstat(self.abspath(path)).st_mtime
602
if not supports_executable():
603
def is_executable(self, file_id, path=None):
604
file_id = osutils.safe_file_id(file_id)
605
return self._inventory[file_id].executable
607
def is_executable(self, file_id, path=None):
609
file_id = osutils.safe_file_id(file_id)
610
path = self._inventory.id2path(file_id)
611
mode = os.lstat(self.abspath(path)).st_mode
612
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
615
def _add(self, files, ids, kinds):
616
"""See MutableTree._add."""
617
# TODO: Re-adding a file that is removed in the working copy
618
# should probably put it back with the previous ID.
619
# the read and write working inventory should not occur in this
620
# function - they should be part of lock_write and unlock.
621
inv = self.read_working_inventory()
622
for f, file_id, kind in zip(files, ids, kinds):
623
assert kind is not None
625
inv.add_path(f, kind=kind)
627
file_id = osutils.safe_file_id(file_id)
628
inv.add_path(f, kind=kind, file_id=file_id)
629
self._write_inventory(inv)
631
@needs_tree_write_lock
632
def _gather_kinds(self, files, kinds):
633
"""See MutableTree._gather_kinds."""
634
for pos, f in enumerate(files):
635
if kinds[pos] is None:
636
fullpath = normpath(self.abspath(f))
638
kinds[pos] = file_kind(fullpath)
640
if e.errno == errno.ENOENT:
641
raise errors.NoSuchFile(fullpath)
644
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
645
"""Add revision_id as a parent.
647
This is equivalent to retrieving the current list of parent ids
648
and setting the list to its value plus revision_id.
650
:param revision_id: The revision id to add to the parent list. It may
651
be a ghost revision as long as its not the first parent to be added,
652
or the allow_leftmost_as_ghost parameter is set True.
653
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
655
parents = self.get_parent_ids() + [revision_id]
656
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
657
or allow_leftmost_as_ghost)
659
@needs_tree_write_lock
660
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
661
"""Add revision_id, tree tuple as a parent.
663
This is equivalent to retrieving the current list of parent trees
664
and setting the list to its value plus parent_tuple. See also
665
add_parent_tree_id - if you only have a parent id available it will be
666
simpler to use that api. If you have the parent already available, using
667
this api is preferred.
669
:param parent_tuple: The (revision id, tree) to add to the parent list.
670
If the revision_id is a ghost, pass None for the tree.
671
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
673
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
674
if len(parent_ids) > 1:
675
# the leftmost may have already been a ghost, preserve that if it
677
allow_leftmost_as_ghost = True
678
self.set_parent_ids(parent_ids,
679
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
681
@needs_tree_write_lock
682
def add_pending_merge(self, *revision_ids):
683
# TODO: Perhaps should check at this point that the
684
# history of the revision is actually present?
685
parents = self.get_parent_ids()
687
for rev_id in revision_ids:
688
if rev_id in parents:
690
parents.append(rev_id)
693
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
695
@deprecated_method(zero_eleven)
697
def pending_merges(self):
698
"""Return a list of pending merges.
700
These are revisions that have been merged into the working
701
directory but not yet committed.
703
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
704
instead - which is available on all tree objects.
706
return self.get_parent_ids()[1:]
708
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
709
"""Common ghost checking functionality from set_parent_*.
711
This checks that the left hand-parent exists if there are any
714
if len(revision_ids) > 0:
715
leftmost_id = revision_ids[0]
716
if (not allow_leftmost_as_ghost and not
717
self.branch.repository.has_revision(leftmost_id)):
718
raise errors.GhostRevisionUnusableHere(leftmost_id)
720
def _set_merges_from_parent_ids(self, parent_ids):
721
merges = parent_ids[1:]
722
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
724
@needs_tree_write_lock
725
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
726
"""Set the parent ids to revision_ids.
728
See also set_parent_trees. This api will try to retrieve the tree data
729
for each element of revision_ids from the trees repository. If you have
730
tree data already available, it is more efficient to use
731
set_parent_trees rather than set_parent_ids. set_parent_ids is however
732
an easier API to use.
734
:param revision_ids: The revision_ids to set as the parent ids of this
735
working tree. Any of these may be ghosts.
737
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
738
self._check_parents_for_ghosts(revision_ids,
739
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
741
if len(revision_ids) > 0:
742
self.set_last_revision(revision_ids[0])
744
self.set_last_revision(None)
746
self._set_merges_from_parent_ids(revision_ids)
748
@needs_tree_write_lock
749
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
750
"""See MutableTree.set_parent_trees."""
751
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
753
self._check_parents_for_ghosts(parent_ids,
754
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
756
if len(parent_ids) == 0:
757
leftmost_parent_id = None
758
leftmost_parent_tree = None
760
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
762
if self._change_last_revision(leftmost_parent_id):
763
if leftmost_parent_tree is None:
764
# If we don't have a tree, fall back to reading the
765
# parent tree from the repository.
766
self._cache_basis_inventory(leftmost_parent_id)
768
inv = leftmost_parent_tree.inventory
769
xml = self._create_basis_xml_from_inventory(
770
leftmost_parent_id, inv)
771
self._write_basis_inventory(xml)
772
self._set_merges_from_parent_ids(parent_ids)
774
@needs_tree_write_lock
775
def set_pending_merges(self, rev_list):
776
parents = self.get_parent_ids()
777
leftmost = parents[:1]
778
new_parents = leftmost + rev_list
779
self.set_parent_ids(new_parents)
781
@needs_tree_write_lock
782
def set_merge_modified(self, modified_hashes):
784
for file_id, hash in modified_hashes.iteritems():
785
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
786
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
788
def _put_rio(self, filename, stanzas, header):
789
self._must_be_locked()
790
my_file = rio_file(stanzas, header)
791
self._control_files.put(filename, my_file)
793
@needs_write_lock # because merge pulls data into the branch.
794
def merge_from_branch(self, branch, to_revision=None):
795
"""Merge from a branch into this working tree.
797
:param branch: The branch to merge from.
798
:param to_revision: If non-None, the merge will merge to to_revision,
799
but not beyond it. to_revision does not need to be in the history
800
of the branch when it is supplied. If None, to_revision defaults to
801
branch.last_revision().
803
from bzrlib.merge import Merger, Merge3Merger
804
pb = bzrlib.ui.ui_factory.nested_progress_bar()
806
merger = Merger(self.branch, this_tree=self, pb=pb)
807
merger.pp = ProgressPhase("Merge phase", 5, pb)
808
merger.pp.next_phase()
809
# check that there are no
811
merger.check_basis(check_clean=True, require_commits=False)
812
if to_revision is None:
813
to_revision = branch.last_revision()
815
to_revision = osutils.safe_revision_id(to_revision)
816
merger.other_rev_id = to_revision
817
if merger.other_rev_id is None:
818
raise error.NoCommits(branch)
819
self.branch.fetch(branch, last_revision=merger.other_rev_id)
820
merger.other_basis = merger.other_rev_id
821
merger.other_tree = self.branch.repository.revision_tree(
823
merger.pp.next_phase()
825
if merger.base_rev_id == merger.other_rev_id:
826
raise errors.PointlessMerge
827
merger.backup_files = False
828
merger.merge_type = Merge3Merger
829
merger.set_interesting_files(None)
830
merger.show_base = False
831
merger.reprocess = False
832
conflicts = merger.do_merge()
839
def merge_modified(self):
840
"""Return a dictionary of files modified by a merge.
842
The list is initialized by WorkingTree.set_merge_modified, which is
843
typically called after we make some automatic updates to the tree
846
This returns a map of file_id->sha1, containing only files which are
847
still in the working inventory and have that text hash.
850
hashfile = self._control_files.get('merge-hashes')
851
except errors.NoSuchFile:
855
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
856
raise errors.MergeModifiedFormatError()
857
except StopIteration:
858
raise errors.MergeModifiedFormatError()
859
for s in RioReader(hashfile):
860
# RioReader reads in Unicode, so convert file_ids back to utf8
861
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
862
if file_id not in self.inventory:
864
text_hash = s.get("hash")
865
if text_hash == self.get_file_sha1(file_id):
866
merge_hashes[file_id] = text_hash
870
def mkdir(self, path, file_id=None):
871
"""See MutableTree.mkdir()."""
873
file_id = generate_ids.gen_file_id(os.path.basename(path))
874
os.mkdir(self.abspath(path))
875
self.add(path, file_id, 'directory')
878
def get_symlink_target(self, file_id):
879
return os.readlink(self.id2abspath(file_id))
881
def file_class(self, filename):
882
if self.path2id(filename):
884
elif self.is_ignored(filename):
890
"""Write the in memory inventory to disk."""
891
# TODO: Maybe this should only write on dirty ?
892
if self._control_files._lock_mode != 'w':
893
raise errors.NotWriteLocked(self)
895
xml5.serializer_v5.write_inventory(self._inventory, sio)
897
self._control_files.put('inventory', sio)
898
self._inventory_is_modified = False
900
def list_files(self, include_root=False):
901
"""Recursively list all files as (path, class, kind, id, entry).
903
Lists, but does not descend into unversioned directories.
905
This does not include files that have been deleted in this
908
Skips the control directory.
910
inv = self._inventory
911
if include_root is True:
912
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
913
# Convert these into local objects to save lookup times
914
pathjoin = osutils.pathjoin
915
file_kind = osutils.file_kind
917
# transport.base ends in a slash, we want the piece
918
# between the last two slashes
919
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
921
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
923
# directory file_id, relative path, absolute path, reverse sorted children
924
children = os.listdir(self.basedir)
926
# jam 20060527 The kernel sized tree seems equivalent whether we
927
# use a deque and popleft to keep them sorted, or if we use a plain
928
# list and just reverse() them.
929
children = collections.deque(children)
930
stack = [(inv.root.file_id, u'', self.basedir, children)]
932
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
935
f = children.popleft()
936
## TODO: If we find a subdirectory with its own .bzr
937
## directory, then that is a separate tree and we
938
## should exclude it.
940
# the bzrdir for this tree
941
if transport_base_dir == f:
944
# we know that from_dir_relpath and from_dir_abspath never end in a slash
945
# and 'f' doesn't begin with one, we can do a string op, rather
946
# than the checks of pathjoin(), all relative paths will have an extra slash
948
fp = from_dir_relpath + '/' + f
951
fap = from_dir_abspath + '/' + f
953
f_ie = inv.get_child(from_dir_id, f)
956
elif self.is_ignored(fp[1:]):
959
# we may not have found this file, because of a unicode issue
960
f_norm, can_access = osutils.normalized_filename(f)
961
if f == f_norm or not can_access:
962
# No change, so treat this file normally
965
# this file can be accessed by a normalized path
966
# check again if it is versioned
967
# these lines are repeated here for performance
969
fp = from_dir_relpath + '/' + f
970
fap = from_dir_abspath + '/' + f
971
f_ie = inv.get_child(from_dir_id, f)
974
elif self.is_ignored(fp[1:]):
983
raise errors.BzrCheckError(
984
"file %r entered as kind %r id %r, now of kind %r"
985
% (fap, f_ie.kind, f_ie.file_id, fk))
987
# make a last minute entry
989
yield fp[1:], c, fk, f_ie.file_id, f_ie
992
yield fp[1:], c, fk, None, fk_entries[fk]()
994
yield fp[1:], c, fk, None, TreeEntry()
997
if fk != 'directory':
1000
# But do this child first
1001
new_children = os.listdir(fap)
1003
new_children = collections.deque(new_children)
1004
stack.append((f_ie.file_id, fp, fap, new_children))
1005
# Break out of inner loop,
1006
# so that we start outer loop with child
1009
# if we finished all children, pop it off the stack
1012
@needs_tree_write_lock
1013
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1016
to_dir must exist in the inventory.
1018
If to_dir exists and is a directory, the files are moved into
1019
it, keeping their old names.
1021
Note that to_dir is only the last component of the new name;
1022
this doesn't change the directory.
1024
For each entry in from_paths the move mode will be determined
1027
The first mode moves the file in the filesystem and updates the
1028
inventory. The second mode only updates the inventory without
1029
touching the file on the filesystem. This is the new mode introduced
1032
move uses the second mode if 'after == True' and the target is not
1033
versioned but present in the working tree.
1035
move uses the second mode if 'after == False' and the source is
1036
versioned but no longer in the working tree, and the target is not
1037
versioned but present in the working tree.
1039
move uses the first mode if 'after == False' and the source is
1040
versioned and present in the working tree, and the target is not
1041
versioned and not present in the working tree.
1043
Everything else results in an error.
1045
This returns a list of (from_path, to_path) pairs for each
1046
entry that is moved.
1051
# check for deprecated use of signature
1053
to_dir = kwargs.get('to_name', None)
1055
raise TypeError('You must supply a target directory')
1057
symbol_versioning.warn('The parameter to_name was deprecated'
1058
' in version 0.13. Use to_dir instead',
1061
# check destination directory
1062
assert not isinstance(from_paths, basestring)
1063
inv = self.inventory
1064
to_abs = self.abspath(to_dir)
1065
if not isdir(to_abs):
1066
raise errors.BzrMoveFailedError('',to_dir,
1067
errors.NotADirectory(to_abs))
1068
if not self.has_filename(to_dir):
1069
raise errors.BzrMoveFailedError('',to_dir,
1070
errors.NotInWorkingDirectory(to_dir))
1071
to_dir_id = inv.path2id(to_dir)
1072
if to_dir_id is None:
1073
raise errors.BzrMoveFailedError('',to_dir,
1074
errors.NotVersionedError(path=str(to_dir)))
1076
to_dir_ie = inv[to_dir_id]
1077
if to_dir_ie.kind != 'directory':
1078
raise errors.BzrMoveFailedError('',to_dir,
1079
errors.NotADirectory(to_abs))
1081
# create rename entries and tuples
1082
for from_rel in from_paths:
1083
from_tail = splitpath(from_rel)[-1]
1084
from_id = inv.path2id(from_rel)
1086
raise errors.BzrMoveFailedError(from_rel,to_dir,
1087
errors.NotVersionedError(path=str(from_rel)))
1089
from_entry = inv[from_id]
1090
from_parent_id = from_entry.parent_id
1091
to_rel = pathjoin(to_dir, from_tail)
1092
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1094
from_tail=from_tail,
1095
from_parent_id=from_parent_id,
1096
to_rel=to_rel, to_tail=from_tail,
1097
to_parent_id=to_dir_id)
1098
rename_entries.append(rename_entry)
1099
rename_tuples.append((from_rel, to_rel))
1101
# determine which move mode to use. checks also for movability
1102
rename_entries = self._determine_mv_mode(rename_entries, after)
1104
original_modified = self._inventory_is_modified
1107
self._inventory_is_modified = True
1108
self._move(rename_entries)
1110
# restore the inventory on error
1111
self._inventory_is_modified = original_modified
1113
self._write_inventory(inv)
1114
return rename_tuples
1116
def _determine_mv_mode(self, rename_entries, after=False):
1117
"""Determines for each from-to pair if both inventory and working tree
1118
or only the inventory has to be changed.
1120
Also does basic plausability tests.
1122
inv = self.inventory
1124
for rename_entry in rename_entries:
1125
# store to local variables for easier reference
1126
from_rel = rename_entry.from_rel
1127
from_id = rename_entry.from_id
1128
to_rel = rename_entry.to_rel
1129
to_id = inv.path2id(to_rel)
1130
only_change_inv = False
1132
# check the inventory for source and destination
1134
raise errors.BzrMoveFailedError(from_rel,to_rel,
1135
errors.NotVersionedError(path=str(from_rel)))
1136
if to_id is not None:
1137
raise errors.BzrMoveFailedError(from_rel,to_rel,
1138
errors.AlreadyVersionedError(path=str(to_rel)))
1140
# try to determine the mode for rename (only change inv or change
1141
# inv and file system)
1143
if not self.has_filename(to_rel):
1144
raise errors.BzrMoveFailedError(from_id,to_rel,
1145
errors.NoSuchFile(path=str(to_rel),
1146
extra="New file has not been created yet"))
1147
only_change_inv = True
1148
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1149
only_change_inv = True
1150
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1151
only_change_inv = False
1153
# something is wrong, so lets determine what exactly
1154
if not self.has_filename(from_rel) and \
1155
not self.has_filename(to_rel):
1156
raise errors.BzrRenameFailedError(from_rel,to_rel,
1157
errors.PathsDoNotExist(paths=(str(from_rel),
1160
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1161
extra="(Use --after to update the Bazaar id)")
1162
rename_entry.only_change_inv = only_change_inv
1163
return rename_entries
1165
def _move(self, rename_entries):
1166
"""Moves a list of files.
1168
Depending on the value of the flag 'only_change_inv', the
1169
file will be moved on the file system or not.
1171
inv = self.inventory
1174
for entry in rename_entries:
1176
self._move_entry(entry)
1178
self._rollback_move(moved)
1182
def _rollback_move(self, moved):
1183
"""Try to rollback a previous move in case of an filesystem error."""
1184
inv = self.inventory
1187
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1188
entry.to_tail, entry.to_parent_id, entry.from_rel,
1189
entry.from_tail, entry.from_parent_id,
1190
entry.only_change_inv))
1191
except errors.BzrMoveFailedError, e:
1192
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1193
" The working tree is in an inconsistent state."
1194
" Please consider doing a 'bzr revert'."
1195
" Error message is: %s" % e)
1197
def _move_entry(self, entry):
1198
inv = self.inventory
1199
from_rel_abs = self.abspath(entry.from_rel)
1200
to_rel_abs = self.abspath(entry.to_rel)
1201
if from_rel_abs == to_rel_abs:
1202
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1203
"Source and target are identical.")
1205
if not entry.only_change_inv:
1207
osutils.rename(from_rel_abs, to_rel_abs)
1209
raise errors.BzrMoveFailedError(entry.from_rel,
1211
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1213
@needs_tree_write_lock
1214
def rename_one(self, from_rel, to_rel, after=False):
1217
This can change the directory or the filename or both.
1219
rename_one has several 'modes' to work. First, it can rename a physical
1220
file and change the file_id. That is the normal mode. Second, it can
1221
only change the file_id without touching any physical file. This is
1222
the new mode introduced in version 0.15.
1224
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1225
versioned but present in the working tree.
1227
rename_one uses the second mode if 'after == False' and 'from_rel' is
1228
versioned but no longer in the working tree, and 'to_rel' is not
1229
versioned but present in the working tree.
1231
rename_one uses the first mode if 'after == False' and 'from_rel' is
1232
versioned and present in the working tree, and 'to_rel' is not
1233
versioned and not present in the working tree.
1235
Everything else results in an error.
1237
inv = self.inventory
1240
# create rename entries and tuples
1241
from_tail = splitpath(from_rel)[-1]
1242
from_id = inv.path2id(from_rel)
1244
raise errors.BzrRenameFailedError(from_rel,to_rel,
1245
errors.NotVersionedError(path=str(from_rel)))
1246
from_entry = inv[from_id]
1247
from_parent_id = from_entry.parent_id
1248
to_dir, to_tail = os.path.split(to_rel)
1249
to_dir_id = inv.path2id(to_dir)
1250
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1252
from_tail=from_tail,
1253
from_parent_id=from_parent_id,
1254
to_rel=to_rel, to_tail=to_tail,
1255
to_parent_id=to_dir_id)
1256
rename_entries.append(rename_entry)
1258
# determine which move mode to use. checks also for movability
1259
rename_entries = self._determine_mv_mode(rename_entries, after)
1261
# check if the target changed directory and if the target directory is
1263
if to_dir_id is None:
1264
raise errors.BzrMoveFailedError(from_rel,to_rel,
1265
errors.NotVersionedError(path=str(to_dir)))
1267
# all checks done. now we can continue with our actual work
1268
mutter('rename_one:\n'
1273
' to_dir_id {%s}\n',
1274
from_id, from_rel, to_rel, to_dir, to_dir_id)
1276
self._move(rename_entries)
1277
self._write_inventory(inv)
1279
class _RenameEntry(object):
1280
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1281
to_rel, to_tail, to_parent_id, only_change_inv=False):
1282
self.from_rel = from_rel
1283
self.from_id = from_id
1284
self.from_tail = from_tail
1285
self.from_parent_id = from_parent_id
1286
self.to_rel = to_rel
1287
self.to_tail = to_tail
1288
self.to_parent_id = to_parent_id
1289
self.only_change_inv = only_change_inv
1293
"""Return all unknown files.
1295
These are files in the working directory that are not versioned or
1296
control files or ignored.
1298
for subp in self.extras():
1299
if not self.is_ignored(subp):
1302
@needs_tree_write_lock
1303
def unversion(self, file_ids):
1304
"""Remove the file ids in file_ids from the current versioned set.
1306
When a file_id is unversioned, all of its children are automatically
1309
:param file_ids: The file ids to stop versioning.
1310
:raises: NoSuchId if any fileid is not currently versioned.
1312
for file_id in file_ids:
1313
file_id = osutils.safe_file_id(file_id)
1314
if self._inventory.has_id(file_id):
1315
self._inventory.remove_recursive_id(file_id)
1317
raise errors.NoSuchId(self, file_id)
1319
# in the future this should just set a dirty bit to wait for the
1320
# final unlock. However, until all methods of workingtree start
1321
# with the current in -memory inventory rather than triggering
1322
# a read, it is more complex - we need to teach read_inventory
1323
# to know when to read, and when to not read first... and possibly
1324
# to save first when the in memory one may be corrupted.
1325
# so for now, we just only write it if it is indeed dirty.
1327
self._write_inventory(self._inventory)
1329
@deprecated_method(zero_eight)
1330
def iter_conflicts(self):
1331
"""List all files in the tree that have text or content conflicts.
1332
DEPRECATED. Use conflicts instead."""
1333
return self._iter_conflicts()
1335
def _iter_conflicts(self):
1337
for info in self.list_files():
1339
stem = get_conflicted_stem(path)
1342
if stem not in conflicted:
1343
conflicted.add(stem)
1347
def pull(self, source, overwrite=False, stop_revision=None,
1348
change_reporter=None):
1349
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1352
pp = ProgressPhase("Pull phase", 2, top_pb)
1354
old_revision_info = self.branch.last_revision_info()
1355
basis_tree = self.basis_tree()
1356
count = self.branch.pull(source, overwrite, stop_revision)
1357
new_revision_info = self.branch.last_revision_info()
1358
if new_revision_info != old_revision_info:
1360
repository = self.branch.repository
1361
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1363
new_basis_tree = self.branch.basis_tree()
1370
change_reporter=change_reporter)
1371
if (basis_tree.inventory.root is None and
1372
new_basis_tree.inventory.root is not None):
1373
self.set_root_id(new_basis_tree.inventory.root.file_id)
1376
# TODO - dedup parents list with things merged by pull ?
1377
# reuse the revisiontree we merged against to set the new
1379
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1380
# we have to pull the merge trees out again, because
1381
# merge_inner has set the ids. - this corner is not yet
1382
# layered well enough to prevent double handling.
1383
merges = self.get_parent_ids()[1:]
1384
parent_trees.extend([
1385
(parent, repository.revision_tree(parent)) for
1387
self.set_parent_trees(parent_trees)
1394
def put_file_bytes_non_atomic(self, file_id, bytes):
1395
"""See MutableTree.put_file_bytes_non_atomic."""
1396
file_id = osutils.safe_file_id(file_id)
1397
stream = file(self.id2abspath(file_id), 'wb')
1402
# TODO: update the hashcache here ?
1405
"""Yield all unknown files in this WorkingTree.
1407
If there are any unknown directories then only the directory is
1408
returned, not all its children. But if there are unknown files
1409
under a versioned subdirectory, they are returned.
1411
Currently returned depth-first, sorted by name within directories.
1413
## TODO: Work from given directory downwards
1414
for path, dir_entry in self.inventory.directories():
1415
# mutter("search for unknowns in %r", path)
1416
dirabs = self.abspath(path)
1417
if not isdir(dirabs):
1418
# e.g. directory deleted
1422
for subf in os.listdir(dirabs):
1425
if subf not in dir_entry.children:
1426
subf_norm, can_access = osutils.normalized_filename(subf)
1427
if subf_norm != subf and can_access:
1428
if subf_norm not in dir_entry.children:
1429
fl.append(subf_norm)
1435
subp = pathjoin(path, subf)
1439
def ignored_files(self):
1440
"""Yield list of PATH, IGNORE_PATTERN"""
1441
for subp in self.extras():
1442
pat = self.is_ignored(subp)
1446
def get_ignore_list(self):
1447
"""Return list of ignore patterns.
1449
Cached in the Tree object after the first call.
1451
ignoreset = getattr(self, '_ignoreset', None)
1452
if ignoreset is not None:
1455
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1456
ignore_globs.update(ignores.get_runtime_ignores())
1457
ignore_globs.update(ignores.get_user_ignores())
1458
if self.has_filename(bzrlib.IGNORE_FILENAME):
1459
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1461
ignore_globs.update(ignores.parse_ignore_file(f))
1464
self._ignoreset = ignore_globs
1467
def _flush_ignore_list_cache(self):
1468
"""Resets the cached ignore list to force a cache rebuild."""
1469
self._ignoreset = None
1470
self._ignoreglobster = None
1472
def is_ignored(self, filename):
1473
r"""Check whether the filename matches an ignore pattern.
1475
Patterns containing '/' or '\' need to match the whole path;
1476
others match against only the last component.
1478
If the file is ignored, returns the pattern which caused it to
1479
be ignored, otherwise None. So this can simply be used as a
1480
boolean if desired."""
1481
if getattr(self, '_ignoreglobster', None) is None:
1482
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1483
return self._ignoreglobster.match(filename)
1485
def kind(self, file_id):
1486
return file_kind(self.id2abspath(file_id))
1488
def _comparison_data(self, entry, path):
1489
abspath = self.abspath(path)
1491
stat_value = os.lstat(abspath)
1493
if getattr(e, 'errno', None) == errno.ENOENT:
1500
mode = stat_value.st_mode
1501
kind = osutils.file_kind_from_stat_mode(mode)
1502
if not supports_executable():
1503
executable = entry.executable
1505
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1506
return kind, executable, stat_value
1508
def _file_size(self, entry, stat_value):
1509
return stat_value.st_size
1511
def last_revision(self):
1512
"""Return the last revision of the branch for this tree.
1514
This format tree does not support a separate marker for last-revision
1515
compared to the branch.
1517
See MutableTree.last_revision
1519
return self._last_revision()
1522
def _last_revision(self):
1523
"""helper for get_parent_ids."""
1524
return self.branch.last_revision()
1526
def is_locked(self):
1527
return self._control_files.is_locked()
1529
def _must_be_locked(self):
1530
if not self.is_locked():
1531
raise errors.ObjectNotLocked(self)
1533
def lock_read(self):
1534
"""See Branch.lock_read, and WorkingTree.unlock."""
1535
self.branch.lock_read()
1537
return self._control_files.lock_read()
1539
self.branch.unlock()
1542
def lock_tree_write(self):
1543
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1544
self.branch.lock_read()
1546
return self._control_files.lock_write()
1548
self.branch.unlock()
1551
def lock_write(self):
1552
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1553
self.branch.lock_write()
1555
return self._control_files.lock_write()
1557
self.branch.unlock()
1560
def get_physical_lock_status(self):
1561
return self._control_files.get_physical_lock_status()
1563
def _basis_inventory_name(self):
1564
return 'basis-inventory-cache'
1566
@needs_tree_write_lock
1567
def set_last_revision(self, new_revision):
1568
"""Change the last revision in the working tree."""
1569
new_revision = osutils.safe_revision_id(new_revision)
1570
if self._change_last_revision(new_revision):
1571
self._cache_basis_inventory(new_revision)
1573
def _change_last_revision(self, new_revision):
1574
"""Template method part of set_last_revision to perform the change.
1576
This is used to allow WorkingTree3 instances to not affect branch
1577
when their last revision is set.
1579
if new_revision is None:
1580
self.branch.set_revision_history([])
1583
self.branch.generate_revision_history(new_revision)
1584
except errors.NoSuchRevision:
1585
# not present in the repo - dont try to set it deeper than the tip
1586
self.branch.set_revision_history([new_revision])
1589
def _write_basis_inventory(self, xml):
1590
"""Write the basis inventory XML to the basis-inventory file"""
1591
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1592
path = self._basis_inventory_name()
1594
self._control_files.put(path, sio)
1596
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1597
"""Create the text that will be saved in basis-inventory"""
1598
# TODO: jam 20070209 This should be redundant, as the revision_id
1599
# as all callers should have already converted the revision_id to
1601
inventory.revision_id = osutils.safe_revision_id(revision_id)
1602
return xml6.serializer_v6.write_inventory_to_string(inventory)
1604
def _cache_basis_inventory(self, new_revision):
1605
"""Cache new_revision as the basis inventory."""
1606
# TODO: this should allow the ready-to-use inventory to be passed in,
1607
# as commit already has that ready-to-use [while the format is the
1610
# this double handles the inventory - unpack and repack -
1611
# but is easier to understand. We can/should put a conditional
1612
# in here based on whether the inventory is in the latest format
1613
# - perhaps we should repack all inventories on a repository
1615
# the fast path is to copy the raw xml from the repository. If the
1616
# xml contains 'revision_id="', then we assume the right
1617
# revision_id is set. We must check for this full string, because a
1618
# root node id can legitimately look like 'revision_id' but cannot
1620
xml = self.branch.repository.get_inventory_xml(new_revision)
1621
firstline = xml.split('\n', 1)[0]
1622
if (not 'revision_id="' in firstline or
1623
'format="6"' not in firstline):
1624
inv = self.branch.repository.deserialise_inventory(
1626
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1627
self._write_basis_inventory(xml)
1628
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1631
def read_basis_inventory(self):
1632
"""Read the cached basis inventory."""
1633
path = self._basis_inventory_name()
1634
return self._control_files.get(path).read()
1637
def read_working_inventory(self):
1638
"""Read the working inventory.
1640
:raises errors.InventoryModified: read_working_inventory will fail
1641
when the current in memory inventory has been modified.
1643
# conceptually this should be an implementation detail of the tree.
1644
# XXX: Deprecate this.
1645
# ElementTree does its own conversion from UTF-8, so open in
1647
if self._inventory_is_modified:
1648
raise errors.InventoryModified(self)
1649
result = xml5.serializer_v5.read_inventory(
1650
self._control_files.get('inventory'))
1651
self._set_inventory(result, dirty=False)
1654
@needs_tree_write_lock
1655
def remove(self, files, verbose=False, to_file=None):
1656
"""Remove nominated files from the working inventory..
1658
This does not remove their text. This does not run on XXX on what? RBC
1660
TODO: Refuse to remove modified files unless --force is given?
1662
TODO: Do something useful with directories.
1664
TODO: Should this remove the text or not? Tough call; not
1665
removing may be useful and the user can just use use rm, and
1666
is the opposite of add. Removing it is consistent with most
1667
other tools. Maybe an option.
1669
## TODO: Normalize names
1670
## TODO: Remove nested loops; better scalability
1671
if isinstance(files, basestring):
1674
inv = self.inventory
1676
# do this before any modifications
1678
fid = inv.path2id(f)
1680
note("%s is not versioned."%f)
1683
# having remove it, it must be either ignored or unknown
1684
if self.is_ignored(f):
1688
textui.show_status(new_status, inv[fid].kind, f,
1692
self._write_inventory(inv)
1694
@needs_tree_write_lock
1695
def revert(self, filenames, old_tree=None, backups=True,
1696
pb=DummyProgress(), report_changes=False):
1697
from bzrlib.conflicts import resolve
1698
if old_tree is None:
1699
old_tree = self.basis_tree()
1700
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1702
if not len(filenames):
1703
self.set_parent_ids(self.get_parent_ids()[:1])
1706
resolve(self, filenames, ignore_misses=True)
1709
# XXX: This method should be deprecated in favour of taking in a proper
1710
# new Inventory object.
1711
@needs_tree_write_lock
1712
def set_inventory(self, new_inventory_list):
1713
from bzrlib.inventory import (Inventory,
1718
inv = Inventory(self.get_root_id())
1719
for path, file_id, parent, kind in new_inventory_list:
1720
name = os.path.basename(path)
1723
# fixme, there should be a factory function inv,add_??
1724
if kind == 'directory':
1725
inv.add(InventoryDirectory(file_id, name, parent))
1726
elif kind == 'file':
1727
inv.add(InventoryFile(file_id, name, parent))
1728
elif kind == 'symlink':
1729
inv.add(InventoryLink(file_id, name, parent))
1731
raise errors.BzrError("unknown kind %r" % kind)
1732
self._write_inventory(inv)
1734
@needs_tree_write_lock
1735
def set_root_id(self, file_id):
1736
"""Set the root id for this tree."""
1739
symbol_versioning.warn(symbol_versioning.zero_twelve
1740
% 'WorkingTree.set_root_id with fileid=None',
1745
file_id = osutils.safe_file_id(file_id)
1746
inv = self._inventory
1747
orig_root_id = inv.root.file_id
1748
# TODO: it might be nice to exit early if there was nothing
1749
# to do, saving us from trigger a sync on unlock.
1750
self._inventory_is_modified = True
1751
# we preserve the root inventory entry object, but
1752
# unlinkit from the byid index
1753
del inv._byid[inv.root.file_id]
1754
inv.root.file_id = file_id
1755
# and link it into the index with the new changed id.
1756
inv._byid[inv.root.file_id] = inv.root
1757
# and finally update all children to reference the new id.
1758
# XXX: this should be safe to just look at the root.children
1759
# list, not the WHOLE INVENTORY.
1762
if entry.parent_id == orig_root_id:
1763
entry.parent_id = inv.root.file_id
1766
"""See Branch.unlock.
1768
WorkingTree locking just uses the Branch locking facilities.
1769
This is current because all working trees have an embedded branch
1770
within them. IF in the future, we were to make branch data shareable
1771
between multiple working trees, i.e. via shared storage, then we
1772
would probably want to lock both the local tree, and the branch.
1774
raise NotImplementedError(self.unlock)
1777
"""Update a working tree along its branch.
1779
This will update the branch if its bound too, which means we have
1780
multiple trees involved:
1782
- The new basis tree of the master.
1783
- The old basis tree of the branch.
1784
- The old basis tree of the working tree.
1785
- The current working tree state.
1787
Pathologically, all three may be different, and non-ancestors of each
1788
other. Conceptually we want to:
1790
- Preserve the wt.basis->wt.state changes
1791
- Transform the wt.basis to the new master basis.
1792
- Apply a merge of the old branch basis to get any 'local' changes from
1794
- Restore the wt.basis->wt.state changes.
1796
There isn't a single operation at the moment to do that, so we:
1797
- Merge current state -> basis tree of the master w.r.t. the old tree
1799
- Do a 'normal' merge of the old branch basis if it is relevant.
1801
if self.branch.get_master_branch() is not None:
1803
update_branch = True
1805
self.lock_tree_write()
1806
update_branch = False
1809
old_tip = self.branch.update()
1812
return self._update_tree(old_tip)
1816
@needs_tree_write_lock
1817
def _update_tree(self, old_tip=None):
1818
"""Update a tree to the master branch.
1820
:param old_tip: if supplied, the previous tip revision the branch,
1821
before it was changed to the master branch's tip.
1823
# here if old_tip is not None, it is the old tip of the branch before
1824
# it was updated from the master branch. This should become a pending
1825
# merge in the working tree to preserve the user existing work. we
1826
# cant set that until we update the working trees last revision to be
1827
# one from the new branch, because it will just get absorbed by the
1828
# parent de-duplication logic.
1830
# We MUST save it even if an error occurs, because otherwise the users
1831
# local work is unreferenced and will appear to have been lost.
1835
last_rev = self.get_parent_ids()[0]
1838
if last_rev != self.branch.last_revision():
1839
# merge tree state up to new branch tip.
1840
basis = self.basis_tree()
1841
to_tree = self.branch.basis_tree()
1842
if basis.inventory.root is None:
1843
self.set_root_id(to_tree.inventory.root.file_id)
1844
result += merge.merge_inner(
1849
# TODO - dedup parents list with things merged by pull ?
1850
# reuse the tree we've updated to to set the basis:
1851
parent_trees = [(self.branch.last_revision(), to_tree)]
1852
merges = self.get_parent_ids()[1:]
1853
# Ideally we ask the tree for the trees here, that way the working
1854
# tree can decide whether to give us teh entire tree or give us a
1855
# lazy initialised tree. dirstate for instance will have the trees
1856
# in ram already, whereas a last-revision + basis-inventory tree
1857
# will not, but also does not need them when setting parents.
1858
for parent in merges:
1859
parent_trees.append(
1860
(parent, self.branch.repository.revision_tree(parent)))
1861
if old_tip is not None:
1862
parent_trees.append(
1863
(old_tip, self.branch.repository.revision_tree(old_tip)))
1864
self.set_parent_trees(parent_trees)
1865
last_rev = parent_trees[0][0]
1867
# the working tree had the same last-revision as the master
1868
# branch did. We may still have pivot local work from the local
1869
# branch into old_tip:
1870
if old_tip is not None:
1871
self.add_parent_tree_id(old_tip)
1872
if old_tip and old_tip != last_rev:
1873
# our last revision was not the prior branch last revision
1874
# and we have converted that last revision to a pending merge.
1875
# base is somewhere between the branch tip now
1876
# and the now pending merge
1877
from bzrlib.revision import common_ancestor
1879
base_rev_id = common_ancestor(self.branch.last_revision(),
1881
self.branch.repository)
1882
except errors.NoCommonAncestor:
1884
base_tree = self.branch.repository.revision_tree(base_rev_id)
1885
other_tree = self.branch.repository.revision_tree(old_tip)
1886
result += merge.merge_inner(
1893
def _write_hashcache_if_dirty(self):
1894
"""Write out the hashcache if it is dirty."""
1895
if self._hashcache.needs_write:
1897
self._hashcache.write()
1899
if e.errno not in (errno.EPERM, errno.EACCES):
1901
# TODO: jam 20061219 Should this be a warning? A single line
1902
# warning might be sufficient to let the user know what
1904
mutter('Could not write hashcache for %s\nError: %s',
1905
self._hashcache.cache_file_name(), e)
1907
@needs_tree_write_lock
1908
def _write_inventory(self, inv):
1909
"""Write inventory as the current inventory."""
1910
self._set_inventory(inv, dirty=True)
1913
def set_conflicts(self, arg):
1914
raise errors.UnsupportedOperation(self.set_conflicts, self)
1916
def add_conflicts(self, arg):
1917
raise errors.UnsupportedOperation(self.add_conflicts, self)
1920
def conflicts(self):
1921
conflicts = _mod_conflicts.ConflictList()
1922
for conflicted in self._iter_conflicts():
1925
if file_kind(self.abspath(conflicted)) != "file":
1927
except errors.NoSuchFile:
1930
for suffix in ('.THIS', '.OTHER'):
1932
kind = file_kind(self.abspath(conflicted+suffix))
1935
except errors.NoSuchFile:
1939
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1940
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
1942
file_id=self.path2id(conflicted)))
1945
@needs_tree_write_lock
1946
def auto_resolve(self):
1947
"""Automatically resolve text conflicts according to contents.
1949
Only text conflicts are auto_resolvable. Files with no conflict markers
1950
are considered 'resolved', because bzr always puts conflict markers
1951
into files that have text conflicts. The corresponding .THIS .BASE and
1952
.OTHER files are deleted, as per 'resolve'.
1953
:return: a tuple of ConflictLists: (un_resolved, resolved).
1955
un_resolved = _mod_conflicts.ConflictList()
1956
resolved = _mod_conflicts.ConflictList()
1957
conflict_re = re.compile('^(<{7}|={7}|>{7})')
1958
for conflict in self.conflicts():
1959
if (conflict.typestring != 'text conflict' or
1960
self.kind(conflict.file_id) != 'file'):
1961
un_resolved.append(conflict)
1963
my_file = open(self.id2abspath(conflict.file_id), 'rb')
1965
for line in my_file:
1966
if conflict_re.search(line):
1967
un_resolved.append(conflict)
1970
resolved.append(conflict)
1973
resolved.remove_files(self)
1974
self.set_conflicts(un_resolved)
1975
return un_resolved, resolved
1978
class WorkingTree2(WorkingTree):
1979
"""This is the Format 2 working tree.
1981
This was the first weave based working tree.
1982
- uses os locks for locking.
1983
- uses the branch last-revision.
1986
def lock_tree_write(self):
1987
"""See WorkingTree.lock_tree_write().
1989
In Format2 WorkingTrees we have a single lock for the branch and tree
1990
so lock_tree_write() degrades to lock_write().
1992
self.branch.lock_write()
1994
return self._control_files.lock_write()
1996
self.branch.unlock()
2000
# we share control files:
2001
if self._control_files._lock_count == 3:
2002
# _inventory_is_modified is always False during a read lock.
2003
if self._inventory_is_modified:
2005
self._write_hashcache_if_dirty()
2007
# reverse order of locking.
2009
return self._control_files.unlock()
2011
self.branch.unlock()
2014
class WorkingTree3(WorkingTree):
2015
"""This is the Format 3 working tree.
2017
This differs from the base WorkingTree by:
2018
- having its own file lock
2019
- having its own last-revision property.
2021
This is new in bzr 0.8
2025
def _last_revision(self):
2026
"""See Mutable.last_revision."""
2028
return osutils.safe_revision_id(
2029
self._control_files.get('last-revision').read())
2030
except errors.NoSuchFile:
2033
def _change_last_revision(self, revision_id):
2034
"""See WorkingTree._change_last_revision."""
2035
if revision_id is None or revision_id == NULL_REVISION:
2037
self._control_files._transport.delete('last-revision')
2038
except errors.NoSuchFile:
2042
self._control_files.put_bytes('last-revision', revision_id)
2045
@needs_tree_write_lock
2046
def set_conflicts(self, conflicts):
2047
self._put_rio('conflicts', conflicts.to_stanzas(),
2050
@needs_tree_write_lock
2051
def add_conflicts(self, new_conflicts):
2052
conflict_set = set(self.conflicts())
2053
conflict_set.update(set(list(new_conflicts)))
2054
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2055
key=_mod_conflicts.Conflict.sort_key)))
2058
def conflicts(self):
2060
confile = self._control_files.get('conflicts')
2061
except errors.NoSuchFile:
2062
return _mod_conflicts.ConflictList()
2064
if confile.next() != CONFLICT_HEADER_1 + '\n':
2065
raise errors.ConflictFormatError()
2066
except StopIteration:
2067
raise errors.ConflictFormatError()
2068
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2071
if self._control_files._lock_count == 1:
2072
# _inventory_is_modified is always False during a read lock.
2073
if self._inventory_is_modified:
2075
self._write_hashcache_if_dirty()
2076
# reverse order of locking.
2078
return self._control_files.unlock()
2080
self.branch.unlock()
2083
def get_conflicted_stem(path):
2084
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2085
if path.endswith(suffix):
2086
return path[:-len(suffix)]
2088
@deprecated_function(zero_eight)
2089
def is_control_file(filename):
2090
"""See WorkingTree.is_control_filename(filename)."""
2091
## FIXME: better check
2092
filename = normpath(filename)
2093
while filename != '':
2094
head, tail = os.path.split(filename)
2095
## mutter('check %r for control file' % ((head, tail),))
2098
if filename == head:
2104
class WorkingTreeFormat(object):
2105
"""An encapsulation of the initialization and open routines for a format.
2107
Formats provide three things:
2108
* An initialization routine,
2112
Formats are placed in an dict by their format string for reference
2113
during workingtree opening. Its not required that these be instances, they
2114
can be classes themselves with class methods - it simply depends on
2115
whether state is needed for a given format or not.
2117
Once a format is deprecated, just deprecate the initialize and open
2118
methods on the format class. Do not deprecate the object, as the
2119
object will be created every time regardless.
2122
_default_format = None
2123
"""The default format used for new trees."""
2126
"""The known formats."""
2129
def find_format(klass, a_bzrdir):
2130
"""Return the format for the working tree object in a_bzrdir."""
2132
transport = a_bzrdir.get_workingtree_transport(None)
2133
format_string = transport.get("format").read()
2134
return klass._formats[format_string]
2135
except errors.NoSuchFile:
2136
raise errors.NoWorkingTree(base=transport.base)
2138
raise errors.UnknownFormatError(format=format_string)
2141
def get_default_format(klass):
2142
"""Return the current default format."""
2143
return klass._default_format
2145
def get_format_string(self):
2146
"""Return the ASCII format string that identifies this format."""
2147
raise NotImplementedError(self.get_format_string)
2149
def get_format_description(self):
2150
"""Return the short description for this format."""
2151
raise NotImplementedError(self.get_format_description)
2153
def is_supported(self):
2154
"""Is this format supported?
2156
Supported formats can be initialized and opened.
2157
Unsupported formats may not support initialization or committing or
2158
some other features depending on the reason for not being supported.
2163
def register_format(klass, format):
2164
klass._formats[format.get_format_string()] = format
2167
def set_default_format(klass, format):
2168
klass._default_format = format
2171
def unregister_format(klass, format):
2172
assert klass._formats[format.get_format_string()] is format
2173
del klass._formats[format.get_format_string()]
2177
class WorkingTreeFormat2(WorkingTreeFormat):
2178
"""The second working tree format.
2180
This format modified the hash cache from the format 1 hash cache.
2183
def get_format_description(self):
2184
"""See WorkingTreeFormat.get_format_description()."""
2185
return "Working tree format 2"
2187
def stub_initialize_remote(self, control_files):
2188
"""As a special workaround create critical control files for a remote working tree
2190
This ensures that it can later be updated and dealt with locally,
2191
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2192
no working tree. (See bug #43064).
2196
xml5.serializer_v5.write_inventory(inv, sio)
2198
control_files.put('inventory', sio)
2200
control_files.put_bytes('pending-merges', '')
2203
def initialize(self, a_bzrdir, revision_id=None):
2204
"""See WorkingTreeFormat.initialize()."""
2205
if not isinstance(a_bzrdir.transport, LocalTransport):
2206
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2207
branch = a_bzrdir.open_branch()
2208
if revision_id is not None:
2209
revision_id = osutils.safe_revision_id(revision_id)
2212
revision_history = branch.revision_history()
2214
position = revision_history.index(revision_id)
2216
raise errors.NoSuchRevision(branch, revision_id)
2217
branch.set_revision_history(revision_history[:position + 1])
2220
revision = branch.last_revision()
2222
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2228
basis_tree = branch.repository.revision_tree(revision)
2229
if basis_tree.inventory.root is not None:
2230
wt.set_root_id(basis_tree.inventory.root.file_id)
2231
# set the parent list and cache the basis tree.
2232
wt.set_parent_trees([(revision, basis_tree)])
2233
transform.build_tree(basis_tree, wt)
2237
super(WorkingTreeFormat2, self).__init__()
2238
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2240
def open(self, a_bzrdir, _found=False):
2241
"""Return the WorkingTree object for a_bzrdir
2243
_found is a private parameter, do not use it. It is used to indicate
2244
if format probing has already been done.
2247
# we are being called directly and must probe.
2248
raise NotImplementedError
2249
if not isinstance(a_bzrdir.transport, LocalTransport):
2250
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2251
return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2257
class WorkingTreeFormat3(WorkingTreeFormat):
2258
"""The second working tree format updated to record a format marker.
2261
- exists within a metadir controlling .bzr
2262
- includes an explicit version marker for the workingtree control
2263
files, separate from the BzrDir format
2264
- modifies the hash cache format
2266
- uses a LockDir to guard access for writes.
2269
def get_format_string(self):
2270
"""See WorkingTreeFormat.get_format_string()."""
2271
return "Bazaar-NG Working Tree format 3"
2273
def get_format_description(self):
2274
"""See WorkingTreeFormat.get_format_description()."""
2275
return "Working tree format 3"
2277
_lock_file_name = 'lock'
2278
_lock_class = LockDir
2280
def _open_control_files(self, a_bzrdir):
2281
transport = a_bzrdir.get_workingtree_transport(None)
2282
return LockableFiles(transport, self._lock_file_name,
2285
def initialize(self, a_bzrdir, revision_id=None):
2286
"""See WorkingTreeFormat.initialize().
2288
revision_id allows creating a working tree at a different
2289
revision than the branch is at.
2291
if not isinstance(a_bzrdir.transport, LocalTransport):
2292
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2293
transport = a_bzrdir.get_workingtree_transport(self)
2294
control_files = self._open_control_files(a_bzrdir)
2295
control_files.create_lock()
2296
control_files.lock_write()
2297
control_files.put_utf8('format', self.get_format_string())
2298
branch = a_bzrdir.open_branch()
2299
if revision_id is None:
2300
revision_id = branch.last_revision()
2302
revision_id = osutils.safe_revision_id(revision_id)
2303
# WorkingTree3 can handle an inventory which has a unique root id.
2304
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2305
# those trees. And because there isn't a format bump inbetween, we
2306
# are maintaining compatibility with older clients.
2307
# inv = Inventory(root_id=gen_root_id())
2309
wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2315
_control_files=control_files)
2316
wt.lock_tree_write()
2318
basis_tree = branch.repository.revision_tree(revision_id)
2319
# only set an explicit root id if there is one to set.
2320
if basis_tree.inventory.root is not None:
2321
wt.set_root_id(basis_tree.inventory.root.file_id)
2322
if revision_id == NULL_REVISION:
2323
wt.set_parent_trees([])
2325
wt.set_parent_trees([(revision_id, basis_tree)])
2326
transform.build_tree(basis_tree, wt)
2328
# Unlock in this order so that the unlock-triggers-flush in
2329
# WorkingTree is given a chance to fire.
2330
control_files.unlock()
2335
super(WorkingTreeFormat3, self).__init__()
2336
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2338
def open(self, a_bzrdir, _found=False):
2339
"""Return the WorkingTree object for a_bzrdir
2341
_found is a private parameter, do not use it. It is used to indicate
2342
if format probing has already been done.
2345
# we are being called directly and must probe.
2346
raise NotImplementedError
2347
if not isinstance(a_bzrdir.transport, LocalTransport):
2348
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2349
return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2351
def _open(self, a_bzrdir, control_files):
2352
"""Open the tree itself.
2354
:param a_bzrdir: the dir for the tree.
2355
:param control_files: the control files for the tree.
2357
return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2361
_control_files=control_files)
2364
return self.get_format_string()
2367
# formats which have no format string are not discoverable
2368
# and not independently creatable, so are not registered.
2369
__default_format = WorkingTreeFormat3()
2370
WorkingTreeFormat.register_format(__default_format)
2371
WorkingTreeFormat.set_default_format(__default_format)
2372
_legacy_formats = [WorkingTreeFormat2(),
2376
class WorkingTreeTestProviderAdapter(object):
2377
"""A tool to generate a suite testing multiple workingtree formats at once.
2379
This is done by copying the test once for each transport and injecting
2380
the transport_server, transport_readonly_server, and workingtree_format
2381
classes into each copy. Each copy is also given a new id() to make it
2385
def __init__(self, transport_server, transport_readonly_server, formats):
2386
self._transport_server = transport_server
2387
self._transport_readonly_server = transport_readonly_server
2388
self._formats = formats
2390
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2391
"""Clone test for adaption."""
2392
new_test = deepcopy(test)
2393
new_test.transport_server = self._transport_server
2394
new_test.transport_readonly_server = self._transport_readonly_server
2395
new_test.bzrdir_format = bzrdir_format
2396
new_test.workingtree_format = workingtree_format
2397
def make_new_test_id():
2398
new_id = "%s(%s)" % (test.id(), variation)
2399
return lambda: new_id
2400
new_test.id = make_new_test_id()
2403
def adapt(self, test):
2404
from bzrlib.tests import TestSuite
2405
result = TestSuite()
2406
for workingtree_format, bzrdir_format in self._formats:
2407
new_test = self._clone_test(
2410
workingtree_format, workingtree_format.__class__.__name__)
2411
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
