1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""WorkingTree object and friends.
19
A WorkingTree represents the editable working copy of a branch.
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files. The WorkingTree has an inventory
22
which is updated by these operations. A commit produces a
23
new revision based on the workingtree and its inventory.
25
At the moment every WorkingTree has its own branch. Remote
26
WorkingTrees aren't supported.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch. This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory. (Now done? -- mbp 20060309)
39
from cStringIO import StringIO
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
45
from bisect import bisect_left
47
from copy import deepcopy
60
conflicts as _mod_conflicts,
81
from bzrlib.transport import get_transport
83
from bzrlib.workingtree_4 import WorkingTreeFormat4
86
from bzrlib import symbol_versioning
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
89
from bzrlib.lockable_files import LockableFiles, TransportLock
90
from bzrlib.lockdir import LockDir
91
import bzrlib.mutabletree
92
from bzrlib.mutabletree import needs_tree_write_lock
93
from bzrlib.osutils import (
105
from bzrlib.trace import mutter, note
106
from bzrlib.transport.local import LocalTransport
107
from bzrlib.progress import DummyProgress, ProgressPhase
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
from bzrlib.rio import RioReader, rio_file, Stanza
110
from bzrlib.symbol_versioning import (deprecated_passed,
113
DEPRECATED_PARAMETER,
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
123
ERROR_PATH_NOT_FOUND = 3 # WindowsError errno code, equivalent to ENOENT
126
@deprecated_function(zero_thirteen)
127
def gen_file_id(name):
128
"""Return new file id for the basename 'name'.
130
Use bzrlib.generate_ids.gen_file_id() instead
132
return generate_ids.gen_file_id(name)
135
@deprecated_function(zero_thirteen)
137
"""Return a new tree-root file id.
139
This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
141
return generate_ids.gen_root_id()
144
class TreeEntry(object):
145
"""An entry that implements the minimum interface used by commands.
147
This needs further inspection, it may be better to have
148
InventoryEntries without ids - though that seems wrong. For now,
149
this is a parallel hierarchy to InventoryEntry, and needs to become
150
one of several things: decorates to that hierarchy, children of, or
152
Another note is that these objects are currently only used when there is
153
no InventoryEntry available - i.e. for unversioned objects.
154
Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
157
def __eq__(self, other):
158
# yes, this us ugly, TODO: best practice __eq__ style.
159
return (isinstance(other, TreeEntry)
160
and other.__class__ == self.__class__)
162
def kind_character(self):
166
class TreeDirectory(TreeEntry):
167
"""See TreeEntry. This is a directory in a working tree."""
169
def __eq__(self, other):
170
return (isinstance(other, TreeDirectory)
171
and other.__class__ == self.__class__)
173
def kind_character(self):
177
class TreeFile(TreeEntry):
178
"""See TreeEntry. This is a regular file in a working tree."""
180
def __eq__(self, other):
181
return (isinstance(other, TreeFile)
182
and other.__class__ == self.__class__)
184
def kind_character(self):
188
class TreeLink(TreeEntry):
189
"""See TreeEntry. This is a symlink in a working tree."""
191
def __eq__(self, other):
192
return (isinstance(other, TreeLink)
193
and other.__class__ == self.__class__)
195
def kind_character(self):
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
200
"""Working copy tree.
202
The inventory is held in the `Branch` working-inventory, and the
203
files are in a directory on disk.
205
It is possible for a `WorkingTree` to have a filename which is
206
not listed in the Inventory and vice versa.
209
def __init__(self, basedir='.',
210
branch=DEPRECATED_PARAMETER,
216
"""Construct a WorkingTree instance. This is not a public API.
218
:param branch: A branch to override probing for the branch.
220
self._format = _format
221
self.bzrdir = _bzrdir
223
raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
"WorkingTree.open() to obtain a WorkingTree.")
225
assert isinstance(basedir, basestring), \
226
"base directory %r is not a string" % basedir
227
basedir = safe_unicode(basedir)
228
mutter("opening working tree %r", basedir)
229
if deprecated_passed(branch):
230
self._branch = branch
232
self._branch = self.bzrdir.open_branch()
233
self.basedir = realpath(basedir)
234
# if branch is at our basedir and is a format 6 or less
235
if isinstance(self._format, WorkingTreeFormat2):
236
# share control object
237
self._control_files = self.branch.control_files
239
# assume all other formats have their own control files.
240
assert isinstance(_control_files, LockableFiles), \
241
"_control_files must be a LockableFiles, not %r" \
243
self._control_files = _control_files
244
# update the whole cache up front and write to disk if anything changed;
245
# in the future we might want to do this more selectively
246
# two possible ways offer themselves : in self._unlock, write the cache
247
# if needed, or, when the cache sees a change, append it to the hash
248
# cache file, and have the parser take the most recent entry for a
250
wt_trans = self.bzrdir.get_workingtree_transport(None)
251
cache_filename = wt_trans.local_abspath('stat-cache')
252
self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
self._control_files._file_mode)
256
# is this scan needed ? it makes things kinda slow.
263
if _inventory is None:
264
# This will be acquired on lock_read() or lock_write()
265
self._inventory_is_modified = False
266
self._inventory = None
268
# the caller of __init__ has provided an inventory,
269
# we assume they know what they are doing - as its only
270
# the Format factory and creation methods that are
271
# permitted to do this.
272
self._set_inventory(_inventory, dirty=False)
275
fget=lambda self: self._branch,
276
doc="""The branch this WorkingTree is connected to.
278
This cannot be set - it is reflective of the actual disk structure
279
the working tree has been constructed from.
282
def break_lock(self):
283
"""Break a lock if one is present from another instance.
285
Uses the ui factory to ask for confirmation if the lock may be from
288
This will probe the repository for its lock as well.
290
self._control_files.break_lock()
291
self.branch.break_lock()
293
def requires_rich_root(self):
294
return self._format.requires_rich_root
296
def supports_tree_reference(self):
299
def _set_inventory(self, inv, dirty):
300
"""Set the internal cached inventory.
302
:param inv: The inventory to set.
303
:param dirty: A boolean indicating whether the inventory is the same
304
logical inventory as whats on disk. If True the inventory is not
305
the same and should be written to disk or data will be lost, if
306
False then the inventory is the same as that on disk and any
307
serialisation would be unneeded overhead.
309
assert inv.root is not None
310
self._inventory = inv
311
self._inventory_is_modified = dirty
314
def open(path=None, _unsupported=False):
315
"""Open an existing working tree at path.
319
path = os.path.getcwdu()
320
control = bzrdir.BzrDir.open(path, _unsupported)
321
return control.open_workingtree(_unsupported)
324
def open_containing(path=None):
325
"""Open an existing working tree which has its root about path.
327
This probes for a working tree at path and searches upwards from there.
329
Basically we keep looking up until we find the control directory or
330
run into /. If there isn't one, raises NotBranchError.
331
TODO: give this a new exception.
332
If there is one, it is returned, along with the unused portion of path.
334
:return: The WorkingTree that contains 'path', and the rest of path
337
path = osutils.getcwd()
338
control, relpath = bzrdir.BzrDir.open_containing(path)
340
return control.open_workingtree(), relpath
343
def open_downlevel(path=None):
344
"""Open an unsupported working tree.
346
Only intended for advanced situations like upgrading part of a bzrdir.
348
return WorkingTree.open(path, _unsupported=True)
350
# should be deprecated - this is slow and in any case treating them as a
351
# container is (we now know) bad style -- mbp 20070302
352
## @deprecated_method(zero_fifteen)
354
"""Iterate through file_ids for this tree.
356
file_ids are in a WorkingTree if they are in the working inventory
357
and the working file exists.
359
inv = self._inventory
360
for path, ie in inv.iter_entries():
361
if osutils.lexists(self.abspath(path)):
365
return "<%s of %s>" % (self.__class__.__name__,
366
getattr(self, 'basedir', None))
368
def abspath(self, filename):
369
return pathjoin(self.basedir, filename)
371
def basis_tree(self):
372
"""Return RevisionTree for the current last revision.
374
If the left most parent is a ghost then the returned tree will be an
375
empty tree - one obtained by calling repository.revision_tree(None).
378
revision_id = self.get_parent_ids()[0]
380
# no parents, return an empty revision tree.
381
# in the future this should return the tree for
382
# 'empty:' - the implicit root empty tree.
383
return self.branch.repository.revision_tree(None)
385
return self.revision_tree(revision_id)
386
except errors.NoSuchRevision:
388
# No cached copy available, retrieve from the repository.
389
# FIXME? RBC 20060403 should we cache the inventory locally
392
return self.branch.repository.revision_tree(revision_id)
393
except errors.RevisionNotPresent:
394
# the basis tree *may* be a ghost or a low level error may have
395
# occured. If the revision is present, its a problem, if its not
397
if self.branch.repository.has_revision(revision_id):
399
# the basis tree is a ghost so return an empty tree.
400
return self.branch.repository.revision_tree(None)
403
@deprecated_method(zero_eight)
404
def create(branch, directory):
405
"""Create a workingtree for branch at directory.
407
If existing_directory already exists it must have a .bzr directory.
408
If it does not exist, it will be created.
410
This returns a new WorkingTree object for the new checkout.
412
TODO FIXME RBC 20060124 when we have checkout formats in place this
413
should accept an optional revisionid to checkout [and reject this if
414
checking out into the same dir as a pre-checkout-aware branch format.]
416
XXX: When BzrDir is present, these should be created through that
419
warnings.warn('delete WorkingTree.create', stacklevel=3)
420
transport = get_transport(directory)
421
if branch.bzrdir.root_transport.base == transport.base:
423
return branch.bzrdir.create_workingtree()
424
# different directory,
425
# create a branch reference
426
# and now a working tree.
427
raise NotImplementedError
430
@deprecated_method(zero_eight)
431
def create_standalone(directory):
432
"""Create a checkout and a branch and a repo at directory.
434
Directory must exist and be empty.
436
please use BzrDir.create_standalone_workingtree
438
return bzrdir.BzrDir.create_standalone_workingtree(directory)
440
def relpath(self, path):
441
"""Return the local path portion from a given path.
443
The path may be absolute or relative. If its a relative path it is
444
interpreted relative to the python current working directory.
446
return osutils.relpath(self.basedir, path)
448
def has_filename(self, filename):
449
return osutils.lexists(self.abspath(filename))
451
def get_file(self, file_id):
452
file_id = osutils.safe_file_id(file_id)
453
return self.get_file_byname(self.id2path(file_id))
455
def get_file_text(self, file_id):
456
file_id = osutils.safe_file_id(file_id)
457
return self.get_file(file_id).read()
459
def get_file_byname(self, filename):
460
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
file_id = osutils.safe_file_id(file_id)
474
basis = self.basis_tree()
477
changes = self._iter_changes(basis, True, [self.id2path(file_id)],
478
require_versioned=True).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(),
500
def get_parent_ids(self):
501
"""See Tree.get_parent_ids.
503
This implementation reads the pending merges list and last_revision
504
value and uses that to decide what the parents list should be.
506
last_rev = self._last_revision()
512
merges_file = self._control_files.get('pending-merges')
513
except errors.NoSuchFile:
516
for l in merges_file.readlines():
517
revision_id = osutils.safe_revision_id(l.rstrip('\n'))
518
parents.append(revision_id)
522
def get_root_id(self):
523
"""Return the id of this trees root"""
524
return self._inventory.root.file_id
526
def _get_store_filename(self, file_id):
527
## XXX: badly named; this is not in the store at all
528
file_id = osutils.safe_file_id(file_id)
529
return self.abspath(self.id2path(file_id))
532
def clone(self, to_bzrdir, revision_id=None):
533
"""Duplicate this working tree into to_bzr, including all state.
535
Specifically modified files are kept as modified, but
536
ignored and unknown files are discarded.
538
If you want to make a new line of development, see bzrdir.sprout()
541
If not None, the cloned tree will have its last revision set to
542
revision, and and difference between the source trees last revision
543
and this one merged in.
545
# assumes the target bzr dir format is compatible.
546
result = self._format.initialize(to_bzrdir)
547
self.copy_content_into(result, revision_id)
551
def copy_content_into(self, tree, revision_id=None):
552
"""Copy the current content and user files of this tree into tree."""
553
tree.set_root_id(self.get_root_id())
554
if revision_id is None:
555
merge.transform_tree(tree, self)
557
# TODO now merge from tree.last_revision to revision (to preserve
558
# user local changes)
559
merge.transform_tree(tree, self)
560
tree.set_parent_ids([revision_id])
562
def id2abspath(self, file_id):
563
file_id = osutils.safe_file_id(file_id)
564
return self.abspath(self.id2path(file_id))
566
def has_id(self, file_id):
567
# files that have been deleted are excluded
568
file_id = osutils.safe_file_id(file_id)
570
if not inv.has_id(file_id):
572
path = inv.id2path(file_id)
573
return osutils.lexists(self.abspath(path))
575
def has_or_had_id(self, file_id):
576
file_id = osutils.safe_file_id(file_id)
577
if file_id == self.inventory.root.file_id:
579
return self.inventory.has_id(file_id)
581
__contains__ = has_id
583
def get_file_size(self, file_id):
584
file_id = osutils.safe_file_id(file_id)
585
return os.path.getsize(self.id2abspath(file_id))
588
def get_file_sha1(self, file_id, path=None, stat_value=None):
589
file_id = osutils.safe_file_id(file_id)
591
path = self._inventory.id2path(file_id)
592
return self._hashcache.get_sha1(path, stat_value)
594
def get_file_mtime(self, file_id, path=None):
595
file_id = osutils.safe_file_id(file_id)
597
path = self.inventory.id2path(file_id)
598
return os.lstat(self.abspath(path)).st_mtime
600
if not supports_executable():
601
def is_executable(self, file_id, path=None):
602
file_id = osutils.safe_file_id(file_id)
603
return self._inventory[file_id].executable
605
def is_executable(self, file_id, path=None):
607
file_id = osutils.safe_file_id(file_id)
608
path = self.id2path(file_id)
609
mode = os.lstat(self.abspath(path)).st_mode
610
return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
612
@needs_tree_write_lock
613
def _add(self, files, ids, kinds):
614
"""See MutableTree._add."""
615
# TODO: Re-adding a file that is removed in the working copy
616
# should probably put it back with the previous ID.
617
# the read and write working inventory should not occur in this
618
# function - they should be part of lock_write and unlock.
619
inv = self.read_working_inventory()
620
for f, file_id, kind in zip(files, ids, kinds):
621
assert kind is not None
623
inv.add_path(f, kind=kind)
625
file_id = osutils.safe_file_id(file_id)
626
inv.add_path(f, kind=kind, file_id=file_id)
627
self._write_inventory(inv)
629
@needs_tree_write_lock
630
def _gather_kinds(self, files, kinds):
631
"""See MutableTree._gather_kinds."""
632
for pos, f in enumerate(files):
633
if kinds[pos] is None:
634
fullpath = normpath(self.abspath(f))
636
kinds[pos] = file_kind(fullpath)
638
if e.errno == errno.ENOENT:
639
raise errors.NoSuchFile(fullpath)
642
def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
643
"""Add revision_id as a parent.
645
This is equivalent to retrieving the current list of parent ids
646
and setting the list to its value plus revision_id.
648
:param revision_id: The revision id to add to the parent list. It may
649
be a ghost revision as long as its not the first parent to be added,
650
or the allow_leftmost_as_ghost parameter is set True.
651
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
653
parents = self.get_parent_ids() + [revision_id]
654
self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
655
or allow_leftmost_as_ghost)
657
@needs_tree_write_lock
658
def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
659
"""Add revision_id, tree tuple as a parent.
661
This is equivalent to retrieving the current list of parent trees
662
and setting the list to its value plus parent_tuple. See also
663
add_parent_tree_id - if you only have a parent id available it will be
664
simpler to use that api. If you have the parent already available, using
665
this api is preferred.
667
:param parent_tuple: The (revision id, tree) to add to the parent list.
668
If the revision_id is a ghost, pass None for the tree.
669
:param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
671
parent_ids = self.get_parent_ids() + [parent_tuple[0]]
672
if len(parent_ids) > 1:
673
# the leftmost may have already been a ghost, preserve that if it
675
allow_leftmost_as_ghost = True
676
self.set_parent_ids(parent_ids,
677
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
679
@needs_tree_write_lock
680
def add_pending_merge(self, *revision_ids):
681
# TODO: Perhaps should check at this point that the
682
# history of the revision is actually present?
683
parents = self.get_parent_ids()
685
for rev_id in revision_ids:
686
if rev_id in parents:
688
parents.append(rev_id)
691
self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
693
@deprecated_method(zero_eleven)
695
def pending_merges(self):
696
"""Return a list of pending merges.
698
These are revisions that have been merged into the working
699
directory but not yet committed.
701
As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
702
instead - which is available on all tree objects.
704
return self.get_parent_ids()[1:]
706
def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
707
"""Common ghost checking functionality from set_parent_*.
709
This checks that the left hand-parent exists if there are any
712
if len(revision_ids) > 0:
713
leftmost_id = revision_ids[0]
714
if (not allow_leftmost_as_ghost and not
715
self.branch.repository.has_revision(leftmost_id)):
716
raise errors.GhostRevisionUnusableHere(leftmost_id)
718
def _set_merges_from_parent_ids(self, parent_ids):
719
merges = parent_ids[1:]
720
self._control_files.put_bytes('pending-merges', '\n'.join(merges))
722
@needs_tree_write_lock
723
def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
724
"""Set the parent ids to revision_ids.
726
See also set_parent_trees. This api will try to retrieve the tree data
727
for each element of revision_ids from the trees repository. If you have
728
tree data already available, it is more efficient to use
729
set_parent_trees rather than set_parent_ids. set_parent_ids is however
730
an easier API to use.
732
:param revision_ids: The revision_ids to set as the parent ids of this
733
working tree. Any of these may be ghosts.
735
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
736
self._check_parents_for_ghosts(revision_ids,
737
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
739
if len(revision_ids) > 0:
740
self.set_last_revision(revision_ids[0])
742
self.set_last_revision(None)
744
self._set_merges_from_parent_ids(revision_ids)
746
@needs_tree_write_lock
747
def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
748
"""See MutableTree.set_parent_trees."""
749
parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
751
self._check_parents_for_ghosts(parent_ids,
752
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
754
if len(parent_ids) == 0:
755
leftmost_parent_id = None
756
leftmost_parent_tree = None
758
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
760
if self._change_last_revision(leftmost_parent_id):
761
if leftmost_parent_tree is None:
762
# If we don't have a tree, fall back to reading the
763
# parent tree from the repository.
764
self._cache_basis_inventory(leftmost_parent_id)
766
inv = leftmost_parent_tree.inventory
767
xml = self._create_basis_xml_from_inventory(
768
leftmost_parent_id, inv)
769
self._write_basis_inventory(xml)
770
self._set_merges_from_parent_ids(parent_ids)
772
@needs_tree_write_lock
773
def set_pending_merges(self, rev_list):
774
parents = self.get_parent_ids()
775
leftmost = parents[:1]
776
new_parents = leftmost + rev_list
777
self.set_parent_ids(new_parents)
779
@needs_tree_write_lock
780
def set_merge_modified(self, modified_hashes):
782
for file_id, hash in modified_hashes.iteritems():
783
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
784
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
786
def _put_rio(self, filename, stanzas, header):
787
self._must_be_locked()
788
my_file = rio_file(stanzas, header)
789
self._control_files.put(filename, my_file)
791
@needs_write_lock # because merge pulls data into the branch.
792
def merge_from_branch(self, branch, to_revision=None):
793
"""Merge from a branch into this working tree.
795
:param branch: The branch to merge from.
796
:param to_revision: If non-None, the merge will merge to to_revision,
797
but not beyond it. to_revision does not need to be in the history
798
of the branch when it is supplied. If None, to_revision defaults to
799
branch.last_revision().
801
from bzrlib.merge import Merger, Merge3Merger
802
pb = bzrlib.ui.ui_factory.nested_progress_bar()
804
merger = Merger(self.branch, this_tree=self, pb=pb)
805
merger.pp = ProgressPhase("Merge phase", 5, pb)
806
merger.pp.next_phase()
807
# check that there are no
809
merger.check_basis(check_clean=True, require_commits=False)
810
if to_revision is None:
811
to_revision = branch.last_revision()
813
to_revision = osutils.safe_revision_id(to_revision)
814
merger.other_rev_id = to_revision
815
if merger.other_rev_id is None:
816
raise error.NoCommits(branch)
817
self.branch.fetch(branch, last_revision=merger.other_rev_id)
818
merger.other_basis = merger.other_rev_id
819
merger.other_tree = self.branch.repository.revision_tree(
821
merger.other_branch = branch
822
merger.pp.next_phase()
824
if merger.base_rev_id == merger.other_rev_id:
825
raise errors.PointlessMerge
826
merger.backup_files = False
827
merger.merge_type = Merge3Merger
828
merger.set_interesting_files(None)
829
merger.show_base = False
830
merger.reprocess = False
831
conflicts = merger.do_merge()
838
def merge_modified(self):
839
"""Return a dictionary of files modified by a merge.
841
The list is initialized by WorkingTree.set_merge_modified, which is
842
typically called after we make some automatic updates to the tree
845
This returns a map of file_id->sha1, containing only files which are
846
still in the working inventory and have that text hash.
849
hashfile = self._control_files.get('merge-hashes')
850
except errors.NoSuchFile:
854
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
855
raise errors.MergeModifiedFormatError()
856
except StopIteration:
857
raise errors.MergeModifiedFormatError()
858
for s in RioReader(hashfile):
859
# RioReader reads in Unicode, so convert file_ids back to utf8
860
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
861
if file_id not in self.inventory:
863
text_hash = s.get("hash")
864
if text_hash == self.get_file_sha1(file_id):
865
merge_hashes[file_id] = text_hash
869
def mkdir(self, path, file_id=None):
870
"""See MutableTree.mkdir()."""
872
file_id = generate_ids.gen_file_id(os.path.basename(path))
873
os.mkdir(self.abspath(path))
874
self.add(path, file_id, 'directory')
877
def get_symlink_target(self, file_id):
878
file_id = osutils.safe_file_id(file_id)
879
return os.readlink(self.id2abspath(file_id))
882
def subsume(self, other_tree):
883
def add_children(inventory, entry):
884
for child_entry in entry.children.values():
885
inventory._byid[child_entry.file_id] = child_entry
886
if child_entry.kind == 'directory':
887
add_children(inventory, child_entry)
888
if other_tree.get_root_id() == self.get_root_id():
889
raise errors.BadSubsumeSource(self, other_tree,
890
'Trees have the same root')
892
other_tree_path = self.relpath(other_tree.basedir)
893
except errors.PathNotChild:
894
raise errors.BadSubsumeSource(self, other_tree,
895
'Tree is not contained by the other')
896
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
897
if new_root_parent is None:
898
raise errors.BadSubsumeSource(self, other_tree,
899
'Parent directory is not versioned.')
900
# We need to ensure that the result of a fetch will have a
901
# versionedfile for the other_tree root, and only fetching into
902
# RepositoryKnit2 guarantees that.
903
if not self.branch.repository.supports_rich_root():
904
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
905
other_tree.lock_tree_write()
907
new_parents = other_tree.get_parent_ids()
908
other_root = other_tree.inventory.root
909
other_root.parent_id = new_root_parent
910
other_root.name = osutils.basename(other_tree_path)
911
self.inventory.add(other_root)
912
add_children(self.inventory, other_root)
913
self._write_inventory(self.inventory)
914
# normally we don't want to fetch whole repositories, but i think
915
# here we really do want to consolidate the whole thing.
916
for parent_id in other_tree.get_parent_ids():
917
self.branch.fetch(other_tree.branch, parent_id)
918
self.add_parent_tree_id(parent_id)
921
other_tree.bzrdir.retire_bzrdir()
923
@needs_tree_write_lock
924
def extract(self, file_id, format=None):
925
"""Extract a subtree from this tree.
927
A new branch will be created, relative to the path for this tree.
931
segments = osutils.splitpath(path)
932
transport = self.branch.bzrdir.root_transport
933
for name in segments:
934
transport = transport.clone(name)
937
except errors.FileExists:
941
sub_path = self.id2path(file_id)
942
branch_transport = mkdirs(sub_path)
944
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
946
branch_transport.mkdir('.')
947
except errors.FileExists:
949
branch_bzrdir = format.initialize_on_transport(branch_transport)
951
repo = branch_bzrdir.find_repository()
952
except errors.NoRepositoryPresent:
953
repo = branch_bzrdir.create_repository()
954
assert repo.supports_rich_root()
956
if not repo.supports_rich_root():
957
raise errors.RootNotRich()
958
new_branch = branch_bzrdir.create_branch()
959
new_branch.pull(self.branch)
960
for parent_id in self.get_parent_ids():
961
new_branch.fetch(self.branch, parent_id)
962
tree_transport = self.bzrdir.root_transport.clone(sub_path)
963
if tree_transport.base != branch_transport.base:
964
tree_bzrdir = format.initialize_on_transport(tree_transport)
965
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
967
tree_bzrdir = branch_bzrdir
968
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
969
wt.set_parent_ids(self.get_parent_ids())
970
my_inv = self.inventory
971
child_inv = Inventory(root_id=None)
972
new_root = my_inv[file_id]
973
my_inv.remove_recursive_id(file_id)
974
new_root.parent_id = None
975
child_inv.add(new_root)
976
self._write_inventory(my_inv)
977
wt._write_inventory(child_inv)
980
def _serialize(self, inventory, out_file):
981
xml5.serializer_v5.write_inventory(self._inventory, out_file)
983
def _deserialize(selt, in_file):
984
return xml5.serializer_v5.read_inventory(in_file)
987
"""Write the in memory inventory to disk."""
988
# TODO: Maybe this should only write on dirty ?
989
if self._control_files._lock_mode != 'w':
990
raise errors.NotWriteLocked(self)
992
self._serialize(self._inventory, sio)
994
self._control_files.put('inventory', sio)
995
self._inventory_is_modified = False
997
def _kind(self, relpath):
998
return osutils.file_kind(self.abspath(relpath))
1000
def list_files(self, include_root=False):
1001
"""Recursively list all files as (path, class, kind, id, entry).
1003
Lists, but does not descend into unversioned directories.
1005
This does not include files that have been deleted in this
1008
Skips the control directory.
1010
# list_files is an iterator, so @needs_read_lock doesn't work properly
1011
# with it. So callers should be careful to always read_lock the tree.
1012
if not self.is_locked():
1013
raise errors.ObjectNotLocked(self)
1015
inv = self.inventory
1016
if include_root is True:
1017
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1018
# Convert these into local objects to save lookup times
1019
pathjoin = osutils.pathjoin
1020
file_kind = self._kind
1022
# transport.base ends in a slash, we want the piece
1023
# between the last two slashes
1024
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1026
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1028
# directory file_id, relative path, absolute path, reverse sorted children
1029
children = os.listdir(self.basedir)
1031
# jam 20060527 The kernel sized tree seems equivalent whether we
1032
# use a deque and popleft to keep them sorted, or if we use a plain
1033
# list and just reverse() them.
1034
children = collections.deque(children)
1035
stack = [(inv.root.file_id, u'', self.basedir, children)]
1037
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1040
f = children.popleft()
1041
## TODO: If we find a subdirectory with its own .bzr
1042
## directory, then that is a separate tree and we
1043
## should exclude it.
1045
# the bzrdir for this tree
1046
if transport_base_dir == f:
1049
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1050
# and 'f' doesn't begin with one, we can do a string op, rather
1051
# than the checks of pathjoin(), all relative paths will have an extra slash
1053
fp = from_dir_relpath + '/' + f
1056
fap = from_dir_abspath + '/' + f
1058
f_ie = inv.get_child(from_dir_id, f)
1061
elif self.is_ignored(fp[1:]):
1064
# we may not have found this file, because of a unicode issue
1065
f_norm, can_access = osutils.normalized_filename(f)
1066
if f == f_norm or not can_access:
1067
# No change, so treat this file normally
1070
# this file can be accessed by a normalized path
1071
# check again if it is versioned
1072
# these lines are repeated here for performance
1074
fp = from_dir_relpath + '/' + f
1075
fap = from_dir_abspath + '/' + f
1076
f_ie = inv.get_child(from_dir_id, f)
1079
elif self.is_ignored(fp[1:]):
1086
# make a last minute entry
1088
yield fp[1:], c, fk, f_ie.file_id, f_ie
1091
yield fp[1:], c, fk, None, fk_entries[fk]()
1093
yield fp[1:], c, fk, None, TreeEntry()
1096
if fk != 'directory':
1099
# But do this child first
1100
new_children = os.listdir(fap)
1102
new_children = collections.deque(new_children)
1103
stack.append((f_ie.file_id, fp, fap, new_children))
1104
# Break out of inner loop,
1105
# so that we start outer loop with child
1108
# if we finished all children, pop it off the stack
1111
@needs_tree_write_lock
1112
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1115
to_dir must exist in the inventory.
1117
If to_dir exists and is a directory, the files are moved into
1118
it, keeping their old names.
1120
Note that to_dir is only the last component of the new name;
1121
this doesn't change the directory.
1123
For each entry in from_paths the move mode will be determined
1126
The first mode moves the file in the filesystem and updates the
1127
inventory. The second mode only updates the inventory without
1128
touching the file on the filesystem. This is the new mode introduced
1131
move uses the second mode if 'after == True' and the target is not
1132
versioned but present in the working tree.
1134
move uses the second mode if 'after == False' and the source is
1135
versioned but no longer in the working tree, and the target is not
1136
versioned but present in the working tree.
1138
move uses the first mode if 'after == False' and the source is
1139
versioned and present in the working tree, and the target is not
1140
versioned and not present in the working tree.
1142
Everything else results in an error.
1144
This returns a list of (from_path, to_path) pairs for each
1145
entry that is moved.
1150
# check for deprecated use of signature
1152
to_dir = kwargs.get('to_name', None)
1154
raise TypeError('You must supply a target directory')
1156
symbol_versioning.warn('The parameter to_name was deprecated'
1157
' in version 0.13. Use to_dir instead',
1160
# check destination directory
1161
assert not isinstance(from_paths, basestring)
1162
inv = self.inventory
1163
to_abs = self.abspath(to_dir)
1164
if not isdir(to_abs):
1165
raise errors.BzrMoveFailedError('',to_dir,
1166
errors.NotADirectory(to_abs))
1167
if not self.has_filename(to_dir):
1168
raise errors.BzrMoveFailedError('',to_dir,
1169
errors.NotInWorkingDirectory(to_dir))
1170
to_dir_id = inv.path2id(to_dir)
1171
if to_dir_id is None:
1172
raise errors.BzrMoveFailedError('',to_dir,
1173
errors.NotVersionedError(path=str(to_dir)))
1175
to_dir_ie = inv[to_dir_id]
1176
if to_dir_ie.kind != 'directory':
1177
raise errors.BzrMoveFailedError('',to_dir,
1178
errors.NotADirectory(to_abs))
1180
# create rename entries and tuples
1181
for from_rel in from_paths:
1182
from_tail = splitpath(from_rel)[-1]
1183
from_id = inv.path2id(from_rel)
1185
raise errors.BzrMoveFailedError(from_rel,to_dir,
1186
errors.NotVersionedError(path=str(from_rel)))
1188
from_entry = inv[from_id]
1189
from_parent_id = from_entry.parent_id
1190
to_rel = pathjoin(to_dir, from_tail)
1191
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1193
from_tail=from_tail,
1194
from_parent_id=from_parent_id,
1195
to_rel=to_rel, to_tail=from_tail,
1196
to_parent_id=to_dir_id)
1197
rename_entries.append(rename_entry)
1198
rename_tuples.append((from_rel, to_rel))
1200
# determine which move mode to use. checks also for movability
1201
rename_entries = self._determine_mv_mode(rename_entries, after)
1203
original_modified = self._inventory_is_modified
1206
self._inventory_is_modified = True
1207
self._move(rename_entries)
1209
# restore the inventory on error
1210
self._inventory_is_modified = original_modified
1212
self._write_inventory(inv)
1213
return rename_tuples
1215
def _determine_mv_mode(self, rename_entries, after=False):
1216
"""Determines for each from-to pair if both inventory and working tree
1217
or only the inventory has to be changed.
1219
Also does basic plausability tests.
1221
inv = self.inventory
1223
for rename_entry in rename_entries:
1224
# store to local variables for easier reference
1225
from_rel = rename_entry.from_rel
1226
from_id = rename_entry.from_id
1227
to_rel = rename_entry.to_rel
1228
to_id = inv.path2id(to_rel)
1229
only_change_inv = False
1231
# check the inventory for source and destination
1233
raise errors.BzrMoveFailedError(from_rel,to_rel,
1234
errors.NotVersionedError(path=str(from_rel)))
1235
if to_id is not None:
1236
raise errors.BzrMoveFailedError(from_rel,to_rel,
1237
errors.AlreadyVersionedError(path=str(to_rel)))
1239
# try to determine the mode for rename (only change inv or change
1240
# inv and file system)
1242
if not self.has_filename(to_rel):
1243
raise errors.BzrMoveFailedError(from_id,to_rel,
1244
errors.NoSuchFile(path=str(to_rel),
1245
extra="New file has not been created yet"))
1246
only_change_inv = True
1247
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1248
only_change_inv = True
1249
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1250
only_change_inv = False
1252
# something is wrong, so lets determine what exactly
1253
if not self.has_filename(from_rel) and \
1254
not self.has_filename(to_rel):
1255
raise errors.BzrRenameFailedError(from_rel,to_rel,
1256
errors.PathsDoNotExist(paths=(str(from_rel),
1259
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1260
extra="(Use --after to update the Bazaar id)")
1261
rename_entry.only_change_inv = only_change_inv
1262
return rename_entries
1264
def _move(self, rename_entries):
1265
"""Moves a list of files.
1267
Depending on the value of the flag 'only_change_inv', the
1268
file will be moved on the file system or not.
1270
inv = self.inventory
1273
for entry in rename_entries:
1275
self._move_entry(entry)
1277
self._rollback_move(moved)
1281
def _rollback_move(self, moved):
1282
"""Try to rollback a previous move in case of an filesystem error."""
1283
inv = self.inventory
1286
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1287
entry.to_tail, entry.to_parent_id, entry.from_rel,
1288
entry.from_tail, entry.from_parent_id,
1289
entry.only_change_inv))
1290
except errors.BzrMoveFailedError, e:
1291
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1292
" The working tree is in an inconsistent state."
1293
" Please consider doing a 'bzr revert'."
1294
" Error message is: %s" % e)
1296
def _move_entry(self, entry):
1297
inv = self.inventory
1298
from_rel_abs = self.abspath(entry.from_rel)
1299
to_rel_abs = self.abspath(entry.to_rel)
1300
if from_rel_abs == to_rel_abs:
1301
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1302
"Source and target are identical.")
1304
if not entry.only_change_inv:
1306
osutils.rename(from_rel_abs, to_rel_abs)
1308
raise errors.BzrMoveFailedError(entry.from_rel,
1310
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1312
@needs_tree_write_lock
1313
def rename_one(self, from_rel, to_rel, after=False):
1316
This can change the directory or the filename or both.
1318
rename_one has several 'modes' to work. First, it can rename a physical
1319
file and change the file_id. That is the normal mode. Second, it can
1320
only change the file_id without touching any physical file. This is
1321
the new mode introduced in version 0.15.
1323
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1324
versioned but present in the working tree.
1326
rename_one uses the second mode if 'after == False' and 'from_rel' is
1327
versioned but no longer in the working tree, and 'to_rel' is not
1328
versioned but present in the working tree.
1330
rename_one uses the first mode if 'after == False' and 'from_rel' is
1331
versioned and present in the working tree, and 'to_rel' is not
1332
versioned and not present in the working tree.
1334
Everything else results in an error.
1336
inv = self.inventory
1339
# create rename entries and tuples
1340
from_tail = splitpath(from_rel)[-1]
1341
from_id = inv.path2id(from_rel)
1343
raise errors.BzrRenameFailedError(from_rel,to_rel,
1344
errors.NotVersionedError(path=str(from_rel)))
1345
from_entry = inv[from_id]
1346
from_parent_id = from_entry.parent_id
1347
to_dir, to_tail = os.path.split(to_rel)
1348
to_dir_id = inv.path2id(to_dir)
1349
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1351
from_tail=from_tail,
1352
from_parent_id=from_parent_id,
1353
to_rel=to_rel, to_tail=to_tail,
1354
to_parent_id=to_dir_id)
1355
rename_entries.append(rename_entry)
1357
# determine which move mode to use. checks also for movability
1358
rename_entries = self._determine_mv_mode(rename_entries, after)
1360
# check if the target changed directory and if the target directory is
1362
if to_dir_id is None:
1363
raise errors.BzrMoveFailedError(from_rel,to_rel,
1364
errors.NotVersionedError(path=str(to_dir)))
1366
# all checks done. now we can continue with our actual work
1367
mutter('rename_one:\n'
1372
' to_dir_id {%s}\n',
1373
from_id, from_rel, to_rel, to_dir, to_dir_id)
1375
self._move(rename_entries)
1376
self._write_inventory(inv)
1378
class _RenameEntry(object):
1379
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1380
to_rel, to_tail, to_parent_id, only_change_inv=False):
1381
self.from_rel = from_rel
1382
self.from_id = from_id
1383
self.from_tail = from_tail
1384
self.from_parent_id = from_parent_id
1385
self.to_rel = to_rel
1386
self.to_tail = to_tail
1387
self.to_parent_id = to_parent_id
1388
self.only_change_inv = only_change_inv
1392
"""Return all unknown files.
1394
These are files in the working directory that are not versioned or
1395
control files or ignored.
1397
# force the extras method to be fully executed before returning, to
1398
# prevent race conditions with the lock
1400
[subp for subp in self.extras() if not self.is_ignored(subp)])
1402
@needs_tree_write_lock
1403
def unversion(self, file_ids):
1404
"""Remove the file ids in file_ids from the current versioned set.
1406
When a file_id is unversioned, all of its children are automatically
1409
:param file_ids: The file ids to stop versioning.
1410
:raises: NoSuchId if any fileid is not currently versioned.
1412
for file_id in file_ids:
1413
file_id = osutils.safe_file_id(file_id)
1414
if self._inventory.has_id(file_id):
1415
self._inventory.remove_recursive_id(file_id)
1417
raise errors.NoSuchId(self, file_id)
1419
# in the future this should just set a dirty bit to wait for the
1420
# final unlock. However, until all methods of workingtree start
1421
# with the current in -memory inventory rather than triggering
1422
# a read, it is more complex - we need to teach read_inventory
1423
# to know when to read, and when to not read first... and possibly
1424
# to save first when the in memory one may be corrupted.
1425
# so for now, we just only write it if it is indeed dirty.
1427
self._write_inventory(self._inventory)
1429
@deprecated_method(zero_eight)
1430
def iter_conflicts(self):
1431
"""List all files in the tree that have text or content conflicts.
1432
DEPRECATED. Use conflicts instead."""
1433
return self._iter_conflicts()
1435
def _iter_conflicts(self):
1437
for info in self.list_files():
1439
stem = get_conflicted_stem(path)
1442
if stem not in conflicted:
1443
conflicted.add(stem)
1447
def pull(self, source, overwrite=False, stop_revision=None,
1448
change_reporter=None):
1449
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1452
pp = ProgressPhase("Pull phase", 2, top_pb)
1454
old_revision_info = self.branch.last_revision_info()
1455
basis_tree = self.basis_tree()
1456
count = self.branch.pull(source, overwrite, stop_revision)
1457
new_revision_info = self.branch.last_revision_info()
1458
if new_revision_info != old_revision_info:
1460
repository = self.branch.repository
1461
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1462
basis_tree.lock_read()
1464
new_basis_tree = self.branch.basis_tree()
1471
change_reporter=change_reporter)
1472
if (basis_tree.inventory.root is None and
1473
new_basis_tree.inventory.root is not None):
1474
self.set_root_id(new_basis_tree.inventory.root.file_id)
1478
# TODO - dedup parents list with things merged by pull ?
1479
# reuse the revisiontree we merged against to set the new
1481
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1482
# we have to pull the merge trees out again, because
1483
# merge_inner has set the ids. - this corner is not yet
1484
# layered well enough to prevent double handling.
1485
# XXX TODO: Fix the double handling: telling the tree about
1486
# the already known parent data is wasteful.
1487
merges = self.get_parent_ids()[1:]
1488
parent_trees.extend([
1489
(parent, repository.revision_tree(parent)) for
1491
self.set_parent_trees(parent_trees)
1498
def put_file_bytes_non_atomic(self, file_id, bytes):
1499
"""See MutableTree.put_file_bytes_non_atomic."""
1500
file_id = osutils.safe_file_id(file_id)
1501
stream = file(self.id2abspath(file_id), 'wb')
1506
# TODO: update the hashcache here ?
1509
"""Yield all unversioned files in this WorkingTree.
1511
If there are any unversioned directories then only the directory is
1512
returned, not all its children. But if there are unversioned files
1513
under a versioned subdirectory, they are returned.
1515
Currently returned depth-first, sorted by name within directories.
1516
This is the same order used by 'osutils.walkdirs'.
1518
## TODO: Work from given directory downwards
1519
for path, dir_entry in self.inventory.directories():
1520
# mutter("search for unknowns in %r", path)
1521
dirabs = self.abspath(path)
1522
if not isdir(dirabs):
1523
# e.g. directory deleted
1527
for subf in os.listdir(dirabs):
1530
if subf not in dir_entry.children:
1531
subf_norm, can_access = osutils.normalized_filename(subf)
1532
if subf_norm != subf and can_access:
1533
if subf_norm not in dir_entry.children:
1534
fl.append(subf_norm)
1540
subp = pathjoin(path, subf)
1543
def ignored_files(self):
1544
"""Yield list of PATH, IGNORE_PATTERN"""
1545
for subp in self.extras():
1546
pat = self.is_ignored(subp)
1550
def get_ignore_list(self):
1551
"""Return list of ignore patterns.
1553
Cached in the Tree object after the first call.
1555
ignoreset = getattr(self, '_ignoreset', None)
1556
if ignoreset is not None:
1559
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1560
ignore_globs.update(ignores.get_runtime_ignores())
1561
ignore_globs.update(ignores.get_user_ignores())
1562
if self.has_filename(bzrlib.IGNORE_FILENAME):
1563
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1565
ignore_globs.update(ignores.parse_ignore_file(f))
1568
self._ignoreset = ignore_globs
1571
def _flush_ignore_list_cache(self):
1572
"""Resets the cached ignore list to force a cache rebuild."""
1573
self._ignoreset = None
1574
self._ignoreglobster = None
1576
def is_ignored(self, filename):
1577
r"""Check whether the filename matches an ignore pattern.
1579
Patterns containing '/' or '\' need to match the whole path;
1580
others match against only the last component.
1582
If the file is ignored, returns the pattern which caused it to
1583
be ignored, otherwise None. So this can simply be used as a
1584
boolean if desired."""
1585
if getattr(self, '_ignoreglobster', None) is None:
1586
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1587
return self._ignoreglobster.match(filename)
1589
def kind(self, file_id):
1590
return file_kind(self.id2abspath(file_id))
1592
def _comparison_data(self, entry, path):
1593
abspath = self.abspath(path)
1595
stat_value = os.lstat(abspath)
1597
if getattr(e, 'errno', None) == errno.ENOENT:
1604
mode = stat_value.st_mode
1605
kind = osutils.file_kind_from_stat_mode(mode)
1606
if not supports_executable():
1607
executable = entry is not None and entry.executable
1609
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1610
return kind, executable, stat_value
1612
def _file_size(self, entry, stat_value):
1613
return stat_value.st_size
1615
def last_revision(self):
1616
"""Return the last revision of the branch for this tree.
1618
This format tree does not support a separate marker for last-revision
1619
compared to the branch.
1621
See MutableTree.last_revision
1623
return self._last_revision()
1626
def _last_revision(self):
1627
"""helper for get_parent_ids."""
1628
return self.branch.last_revision()
1630
def is_locked(self):
1631
return self._control_files.is_locked()
1633
def _must_be_locked(self):
1634
if not self.is_locked():
1635
raise errors.ObjectNotLocked(self)
1637
def lock_read(self):
1638
"""See Branch.lock_read, and WorkingTree.unlock."""
1639
if not self.is_locked():
1641
self.branch.lock_read()
1643
return self._control_files.lock_read()
1645
self.branch.unlock()
1648
def lock_tree_write(self):
1649
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1650
if not self.is_locked():
1652
self.branch.lock_read()
1654
return self._control_files.lock_write()
1656
self.branch.unlock()
1659
def lock_write(self):
1660
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1661
if not self.is_locked():
1663
self.branch.lock_write()
1665
return self._control_files.lock_write()
1667
self.branch.unlock()
1670
def get_physical_lock_status(self):
1671
return self._control_files.get_physical_lock_status()
1673
def _basis_inventory_name(self):
1674
return 'basis-inventory-cache'
1676
def _reset_data(self):
1677
"""Reset transient data that cannot be revalidated."""
1678
self._inventory_is_modified = False
1679
result = self._deserialize(self._control_files.get('inventory'))
1680
self._set_inventory(result, dirty=False)
1682
@needs_tree_write_lock
1683
def set_last_revision(self, new_revision):
1684
"""Change the last revision in the working tree."""
1685
new_revision = osutils.safe_revision_id(new_revision)
1686
if self._change_last_revision(new_revision):
1687
self._cache_basis_inventory(new_revision)
1689
def _change_last_revision(self, new_revision):
1690
"""Template method part of set_last_revision to perform the change.
1692
This is used to allow WorkingTree3 instances to not affect branch
1693
when their last revision is set.
1695
if new_revision is None:
1696
self.branch.set_revision_history([])
1699
self.branch.generate_revision_history(new_revision)
1700
except errors.NoSuchRevision:
1701
# not present in the repo - dont try to set it deeper than the tip
1702
self.branch.set_revision_history([new_revision])
1705
def _write_basis_inventory(self, xml):
1706
"""Write the basis inventory XML to the basis-inventory file"""
1707
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1708
path = self._basis_inventory_name()
1710
self._control_files.put(path, sio)
1712
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1713
"""Create the text that will be saved in basis-inventory"""
1714
# TODO: jam 20070209 This should be redundant, as the revision_id
1715
# as all callers should have already converted the revision_id to
1717
inventory.revision_id = osutils.safe_revision_id(revision_id)
1718
return xml7.serializer_v7.write_inventory_to_string(inventory)
1720
def _cache_basis_inventory(self, new_revision):
1721
"""Cache new_revision as the basis inventory."""
1722
# TODO: this should allow the ready-to-use inventory to be passed in,
1723
# as commit already has that ready-to-use [while the format is the
1726
# this double handles the inventory - unpack and repack -
1727
# but is easier to understand. We can/should put a conditional
1728
# in here based on whether the inventory is in the latest format
1729
# - perhaps we should repack all inventories on a repository
1731
# the fast path is to copy the raw xml from the repository. If the
1732
# xml contains 'revision_id="', then we assume the right
1733
# revision_id is set. We must check for this full string, because a
1734
# root node id can legitimately look like 'revision_id' but cannot
1736
xml = self.branch.repository.get_inventory_xml(new_revision)
1737
firstline = xml.split('\n', 1)[0]
1738
if (not 'revision_id="' in firstline or
1739
'format="7"' not in firstline):
1740
inv = self.branch.repository.deserialise_inventory(
1742
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1743
self._write_basis_inventory(xml)
1744
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1747
def read_basis_inventory(self):
1748
"""Read the cached basis inventory."""
1749
path = self._basis_inventory_name()
1750
return self._control_files.get(path).read()
1753
def read_working_inventory(self):
1754
"""Read the working inventory.
1756
:raises errors.InventoryModified: read_working_inventory will fail
1757
when the current in memory inventory has been modified.
1759
# conceptually this should be an implementation detail of the tree.
1760
# XXX: Deprecate this.
1761
# ElementTree does its own conversion from UTF-8, so open in
1763
if self._inventory_is_modified:
1764
raise errors.InventoryModified(self)
1765
result = self._deserialize(self._control_files.get('inventory'))
1766
self._set_inventory(result, dirty=False)
1769
@needs_tree_write_lock
1770
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1772
"""Remove nominated files from the working inventor.
1774
:files: File paths relative to the basedir.
1775
:keep_files: If true, the files will also be kept.
1776
:force: Delete files and directories, even if they are changed and
1777
even if the directories are not empty.
1779
## TODO: Normalize names
1781
if isinstance(files, basestring):
1784
inv = self.inventory
1787
unknown_files_in_directory=set()
1789
def recurse_directory_to_add_files(directory):
1790
# recurse directory and add all files
1791
# so we can check if they have changed.
1792
for contained_dir_info in self.walkdirs(directory):
1793
for file_info in contained_dir_info[1]:
1794
if file_info[2] == 'file':
1795
relpath = self.relpath(file_info[0])
1796
if file_info[4]: #is it versioned?
1797
new_files.add(relpath)
1799
unknown_files_in_directory.add(
1800
(relpath, None, file_info[2]))
1802
for filename in files:
1803
# Get file name into canonical form.
1804
filename = self.relpath(self.abspath(filename))
1805
if len(filename) > 0:
1806
new_files.add(filename)
1807
if osutils.isdir(filename) and len(os.listdir(filename)) > 0:
1808
recurse_directory_to_add_files(filename)
1809
files = [f for f in new_files]
1811
# Sort needed to first handle directory content before the directory
1812
files.sort(reverse=True)
1813
if not keep_files and not force:
1814
tree_delta = self.changes_from(self.basis_tree(),
1815
specific_files=files)
1816
for unknown_file in unknown_files_in_directory:
1817
tree_delta.unversioned.extend((unknown_file,))
1818
if bool(tree_delta.modified
1820
or tree_delta.renamed
1821
or tree_delta.kind_changed
1822
or tree_delta.unversioned):
1823
raise errors.BzrRemoveChangedFilesError(tree_delta)
1825
# do this before any modifications
1827
fid = inv.path2id(f)
1830
message="%s is not versioned." % (f,)
1833
# having removed it, it must be either ignored or unknown
1834
if self.is_ignored(f):
1838
textui.show_status(new_status, inv[fid].kind, f,
1842
message="removed %s" % (f,)
1845
abs_path = self.abspath(f)
1846
if osutils.lexists(abs_path):
1847
if (osutils.isdir(abs_path) and
1848
len(os.listdir(abs_path)) > 0):
1849
message="%s is not empty directory "\
1850
"and won't be deleted." % (f,)
1852
osutils.delete_any(abs_path)
1853
message="deleted %s" % (f,)
1854
elif message is not None:
1855
# only care if we haven't done anything yet.
1856
message="%s does not exist." % (f,)
1858
# print only one message (if any) per file.
1859
if message is not None:
1861
self._write_inventory(inv)
1863
@needs_tree_write_lock
1864
def revert(self, filenames, old_tree=None, backups=True,
1865
pb=DummyProgress(), report_changes=False):
1866
from bzrlib.conflicts import resolve
1867
if old_tree is None:
1868
old_tree = self.basis_tree()
1869
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1871
if not len(filenames):
1872
self.set_parent_ids(self.get_parent_ids()[:1])
1875
resolve(self, filenames, ignore_misses=True)
1878
def revision_tree(self, revision_id):
1879
"""See Tree.revision_tree.
1881
WorkingTree can supply revision_trees for the basis revision only
1882
because there is only one cached inventory in the bzr directory.
1884
if revision_id == self.last_revision():
1886
xml = self.read_basis_inventory()
1887
except errors.NoSuchFile:
1891
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1892
# dont use the repository revision_tree api because we want
1893
# to supply the inventory.
1894
if inv.revision_id == revision_id:
1895
return revisiontree.RevisionTree(self.branch.repository,
1897
except errors.BadInventoryFormat:
1899
# raise if there was no inventory, or if we read the wrong inventory.
1900
raise errors.NoSuchRevisionInTree(self, revision_id)
1902
# XXX: This method should be deprecated in favour of taking in a proper
1903
# new Inventory object.
1904
@needs_tree_write_lock
1905
def set_inventory(self, new_inventory_list):
1906
from bzrlib.inventory import (Inventory,
1911
inv = Inventory(self.get_root_id())
1912
for path, file_id, parent, kind in new_inventory_list:
1913
name = os.path.basename(path)
1916
# fixme, there should be a factory function inv,add_??
1917
if kind == 'directory':
1918
inv.add(InventoryDirectory(file_id, name, parent))
1919
elif kind == 'file':
1920
inv.add(InventoryFile(file_id, name, parent))
1921
elif kind == 'symlink':
1922
inv.add(InventoryLink(file_id, name, parent))
1924
raise errors.BzrError("unknown kind %r" % kind)
1925
self._write_inventory(inv)
1927
@needs_tree_write_lock
1928
def set_root_id(self, file_id):
1929
"""Set the root id for this tree."""
1932
symbol_versioning.warn(symbol_versioning.zero_twelve
1933
% 'WorkingTree.set_root_id with fileid=None',
1938
file_id = osutils.safe_file_id(file_id)
1939
self._set_root_id(file_id)
1941
def _set_root_id(self, file_id):
1942
"""Set the root id for this tree, in a format specific manner.
1944
:param file_id: The file id to assign to the root. It must not be
1945
present in the current inventory or an error will occur. It must
1946
not be None, but rather a valid file id.
1948
inv = self._inventory
1949
orig_root_id = inv.root.file_id
1950
# TODO: it might be nice to exit early if there was nothing
1951
# to do, saving us from trigger a sync on unlock.
1952
self._inventory_is_modified = True
1953
# we preserve the root inventory entry object, but
1954
# unlinkit from the byid index
1955
del inv._byid[inv.root.file_id]
1956
inv.root.file_id = file_id
1957
# and link it into the index with the new changed id.
1958
inv._byid[inv.root.file_id] = inv.root
1959
# and finally update all children to reference the new id.
1960
# XXX: this should be safe to just look at the root.children
1961
# list, not the WHOLE INVENTORY.
1964
if entry.parent_id == orig_root_id:
1965
entry.parent_id = inv.root.file_id
1968
"""See Branch.unlock.
1970
WorkingTree locking just uses the Branch locking facilities.
1971
This is current because all working trees have an embedded branch
1972
within them. IF in the future, we were to make branch data shareable
1973
between multiple working trees, i.e. via shared storage, then we
1974
would probably want to lock both the local tree, and the branch.
1976
raise NotImplementedError(self.unlock)
1979
"""Update a working tree along its branch.
1981
This will update the branch if its bound too, which means we have
1982
multiple trees involved:
1984
- The new basis tree of the master.
1985
- The old basis tree of the branch.
1986
- The old basis tree of the working tree.
1987
- The current working tree state.
1989
Pathologically, all three may be different, and non-ancestors of each
1990
other. Conceptually we want to:
1992
- Preserve the wt.basis->wt.state changes
1993
- Transform the wt.basis to the new master basis.
1994
- Apply a merge of the old branch basis to get any 'local' changes from
1996
- Restore the wt.basis->wt.state changes.
1998
There isn't a single operation at the moment to do that, so we:
1999
- Merge current state -> basis tree of the master w.r.t. the old tree
2001
- Do a 'normal' merge of the old branch basis if it is relevant.
2003
if self.branch.get_master_branch() is not None:
2005
update_branch = True
2007
self.lock_tree_write()
2008
update_branch = False
2011
old_tip = self.branch.update()
2014
return self._update_tree(old_tip)
2018
@needs_tree_write_lock
2019
def _update_tree(self, old_tip=None):
2020
"""Update a tree to the master branch.
2022
:param old_tip: if supplied, the previous tip revision the branch,
2023
before it was changed to the master branch's tip.
2025
# here if old_tip is not None, it is the old tip of the branch before
2026
# it was updated from the master branch. This should become a pending
2027
# merge in the working tree to preserve the user existing work. we
2028
# cant set that until we update the working trees last revision to be
2029
# one from the new branch, because it will just get absorbed by the
2030
# parent de-duplication logic.
2032
# We MUST save it even if an error occurs, because otherwise the users
2033
# local work is unreferenced and will appear to have been lost.
2037
last_rev = self.get_parent_ids()[0]
2040
if last_rev != self.branch.last_revision():
2041
# merge tree state up to new branch tip.
2042
basis = self.basis_tree()
2045
to_tree = self.branch.basis_tree()
2046
if basis.inventory.root is None:
2047
self.set_root_id(to_tree.inventory.root.file_id)
2049
result += merge.merge_inner(
2056
# TODO - dedup parents list with things merged by pull ?
2057
# reuse the tree we've updated to to set the basis:
2058
parent_trees = [(self.branch.last_revision(), to_tree)]
2059
merges = self.get_parent_ids()[1:]
2060
# Ideally we ask the tree for the trees here, that way the working
2061
# tree can decide whether to give us teh entire tree or give us a
2062
# lazy initialised tree. dirstate for instance will have the trees
2063
# in ram already, whereas a last-revision + basis-inventory tree
2064
# will not, but also does not need them when setting parents.
2065
for parent in merges:
2066
parent_trees.append(
2067
(parent, self.branch.repository.revision_tree(parent)))
2068
if old_tip is not None:
2069
parent_trees.append(
2070
(old_tip, self.branch.repository.revision_tree(old_tip)))
2071
self.set_parent_trees(parent_trees)
2072
last_rev = parent_trees[0][0]
2074
# the working tree had the same last-revision as the master
2075
# branch did. We may still have pivot local work from the local
2076
# branch into old_tip:
2077
if old_tip is not None:
2078
self.add_parent_tree_id(old_tip)
2079
if old_tip and old_tip != last_rev:
2080
# our last revision was not the prior branch last revision
2081
# and we have converted that last revision to a pending merge.
2082
# base is somewhere between the branch tip now
2083
# and the now pending merge
2085
# Since we just modified the working tree and inventory, flush out
2086
# the current state, before we modify it again.
2087
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2088
# requires it only because TreeTransform directly munges the
2089
# inventory and calls tree._write_inventory(). Ultimately we
2090
# should be able to remove this extra flush.
2092
from bzrlib.revision import common_ancestor
2094
base_rev_id = common_ancestor(self.branch.last_revision(),
2096
self.branch.repository)
2097
except errors.NoCommonAncestor:
2099
base_tree = self.branch.repository.revision_tree(base_rev_id)
2100
other_tree = self.branch.repository.revision_tree(old_tip)
2101
result += merge.merge_inner(
2108
def _write_hashcache_if_dirty(self):
2109
"""Write out the hashcache if it is dirty."""
2110
if self._hashcache.needs_write:
2112
self._hashcache.write()
2114
if e.errno not in (errno.EPERM, errno.EACCES):
2116
# TODO: jam 20061219 Should this be a warning? A single line
2117
# warning might be sufficient to let the user know what
2119
mutter('Could not write hashcache for %s\nError: %s',
2120
self._hashcache.cache_file_name(), e)
2122
@needs_tree_write_lock
2123
def _write_inventory(self, inv):
2124
"""Write inventory as the current inventory."""
2125
self._set_inventory(inv, dirty=True)
2128
def set_conflicts(self, arg):
2129
raise errors.UnsupportedOperation(self.set_conflicts, self)
2131
def add_conflicts(self, arg):
2132
raise errors.UnsupportedOperation(self.add_conflicts, self)
2135
def conflicts(self):
2136
conflicts = _mod_conflicts.ConflictList()
2137
for conflicted in self._iter_conflicts():
2140
if file_kind(self.abspath(conflicted)) != "file":
2142
except errors.NoSuchFile:
2145
for suffix in ('.THIS', '.OTHER'):
2147
kind = file_kind(self.abspath(conflicted+suffix))
2150
except errors.NoSuchFile:
2154
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2155
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2157
file_id=self.path2id(conflicted)))
2160
def walkdirs(self, prefix=""):
2161
"""Walk the directories of this tree.
2163
returns a generator which yields items in the form:
2164
((curren_directory_path, fileid),
2165
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2168
This API returns a generator, which is only valid during the current
2169
tree transaction - within a single lock_read or lock_write duration.
2171
If the tree is not locked, it may cause an error to be raised,
2172
depending on the tree implementation.
2174
disk_top = self.abspath(prefix)
2175
if disk_top.endswith('/'):
2176
disk_top = disk_top[:-1]
2177
top_strip_len = len(disk_top) + 1
2178
inventory_iterator = self._walkdirs(prefix)
2179
disk_iterator = osutils.walkdirs(disk_top, prefix)
2181
current_disk = disk_iterator.next()
2182
disk_finished = False
2184
if not (e.errno == errno.ENOENT or
2185
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2188
disk_finished = True
2190
current_inv = inventory_iterator.next()
2191
inv_finished = False
2192
except StopIteration:
2195
while not inv_finished or not disk_finished:
2196
if not disk_finished:
2197
# strip out .bzr dirs
2198
if current_disk[0][1][top_strip_len:] == '':
2199
# osutils.walkdirs can be made nicer -
2200
# yield the path-from-prefix rather than the pathjoined
2202
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2203
if current_disk[1][bzrdir_loc][0] == '.bzr':
2204
# we dont yield the contents of, or, .bzr itself.
2205
del current_disk[1][bzrdir_loc]
2207
# everything is unknown
2210
# everything is missing
2213
direction = cmp(current_inv[0][0], current_disk[0][0])
2215
# disk is before inventory - unknown
2216
dirblock = [(relpath, basename, kind, stat, None, None) for
2217
relpath, basename, kind, stat, top_path in current_disk[1]]
2218
yield (current_disk[0][0], None), dirblock
2220
current_disk = disk_iterator.next()
2221
except StopIteration:
2222
disk_finished = True
2224
# inventory is before disk - missing.
2225
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2226
for relpath, basename, dkind, stat, fileid, kind in
2228
yield (current_inv[0][0], current_inv[0][1]), dirblock
2230
current_inv = inventory_iterator.next()
2231
except StopIteration:
2234
# versioned present directory
2235
# merge the inventory and disk data together
2237
for relpath, subiterator in itertools.groupby(sorted(
2238
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2239
path_elements = list(subiterator)
2240
if len(path_elements) == 2:
2241
inv_row, disk_row = path_elements
2242
# versioned, present file
2243
dirblock.append((inv_row[0],
2244
inv_row[1], disk_row[2],
2245
disk_row[3], inv_row[4],
2247
elif len(path_elements[0]) == 5:
2249
dirblock.append((path_elements[0][0],
2250
path_elements[0][1], path_elements[0][2],
2251
path_elements[0][3], None, None))
2252
elif len(path_elements[0]) == 6:
2253
# versioned, absent file.
2254
dirblock.append((path_elements[0][0],
2255
path_elements[0][1], 'unknown', None,
2256
path_elements[0][4], path_elements[0][5]))
2258
raise NotImplementedError('unreachable code')
2259
yield current_inv[0], dirblock
2261
current_inv = inventory_iterator.next()
2262
except StopIteration:
2265
current_disk = disk_iterator.next()
2266
except StopIteration:
2267
disk_finished = True
2269
def _walkdirs(self, prefix=""):
2270
"""Walk the directories of this tree.
2272
:prefix: is used as the directrory to start with.
2273
returns a generator which yields items in the form:
2274
((curren_directory_path, fileid),
2275
[(file1_path, file1_name, file1_kind, None, file1_id,
2278
_directory = 'directory'
2279
# get the root in the inventory
2280
inv = self.inventory
2281
top_id = inv.path2id(prefix)
2285
pending = [(prefix, '', _directory, None, top_id, None)]
2288
currentdir = pending.pop()
2289
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2290
top_id = currentdir[4]
2292
relroot = currentdir[0] + '/'
2295
# FIXME: stash the node in pending
2297
for name, child in entry.sorted_children():
2298
dirblock.append((relroot + name, name, child.kind, None,
2299
child.file_id, child.kind
2301
yield (currentdir[0], entry.file_id), dirblock
2302
# push the user specified dirs from dirblock
2303
for dir in reversed(dirblock):
2304
if dir[2] == _directory:
2307
@needs_tree_write_lock
2308
def auto_resolve(self):
2309
"""Automatically resolve text conflicts according to contents.
2311
Only text conflicts are auto_resolvable. Files with no conflict markers
2312
are considered 'resolved', because bzr always puts conflict markers
2313
into files that have text conflicts. The corresponding .THIS .BASE and
2314
.OTHER files are deleted, as per 'resolve'.
2315
:return: a tuple of ConflictLists: (un_resolved, resolved).
2317
un_resolved = _mod_conflicts.ConflictList()
2318
resolved = _mod_conflicts.ConflictList()
2319
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2320
for conflict in self.conflicts():
2321
if (conflict.typestring != 'text conflict' or
2322
self.kind(conflict.file_id) != 'file'):
2323
un_resolved.append(conflict)
2325
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2327
for line in my_file:
2328
if conflict_re.search(line):
2329
un_resolved.append(conflict)
2332
resolved.append(conflict)
2335
resolved.remove_files(self)
2336
self.set_conflicts(un_resolved)
2337
return un_resolved, resolved
2339
def _validate(self):
2340
"""Validate internal structures.
2342
This is meant mostly for the test suite. To give it a chance to detect
2343
corruption after actions have occurred. The default implementation is a
2346
:return: None. An exception should be raised if there is an error.
2351
class WorkingTree2(WorkingTree):
2352
"""This is the Format 2 working tree.
2354
This was the first weave based working tree.
2355
- uses os locks for locking.
2356
- uses the branch last-revision.
2359
def __init__(self, *args, **kwargs):
2360
super(WorkingTree2, self).__init__(*args, **kwargs)
2361
# WorkingTree2 has more of a constraint that self._inventory must
2362
# exist. Because this is an older format, we don't mind the overhead
2363
# caused by the extra computation here.
2365
# Newer WorkingTree's should only have self._inventory set when they
2367
if self._inventory is None:
2368
self.read_working_inventory()
2370
def lock_tree_write(self):
2371
"""See WorkingTree.lock_tree_write().
2373
In Format2 WorkingTrees we have a single lock for the branch and tree
2374
so lock_tree_write() degrades to lock_write().
2376
self.branch.lock_write()
2378
return self._control_files.lock_write()
2380
self.branch.unlock()
2384
# we share control files:
2385
if self._control_files._lock_count == 3:
2386
# _inventory_is_modified is always False during a read lock.
2387
if self._inventory_is_modified:
2389
self._write_hashcache_if_dirty()
2391
# reverse order of locking.
2393
return self._control_files.unlock()
2395
self.branch.unlock()
2398
class WorkingTree3(WorkingTree):
2399
"""This is the Format 3 working tree.
2401
This differs from the base WorkingTree by:
2402
- having its own file lock
2403
- having its own last-revision property.
2405
This is new in bzr 0.8
2409
def _last_revision(self):
2410
"""See Mutable.last_revision."""
2412
return osutils.safe_revision_id(
2413
self._control_files.get('last-revision').read())
2414
except errors.NoSuchFile:
2417
def _change_last_revision(self, revision_id):
2418
"""See WorkingTree._change_last_revision."""
2419
if revision_id is None or revision_id == NULL_REVISION:
2421
self._control_files._transport.delete('last-revision')
2422
except errors.NoSuchFile:
2426
self._control_files.put_bytes('last-revision', revision_id)
2429
@needs_tree_write_lock
2430
def set_conflicts(self, conflicts):
2431
self._put_rio('conflicts', conflicts.to_stanzas(),
2434
@needs_tree_write_lock
2435
def add_conflicts(self, new_conflicts):
2436
conflict_set = set(self.conflicts())
2437
conflict_set.update(set(list(new_conflicts)))
2438
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2439
key=_mod_conflicts.Conflict.sort_key)))
2442
def conflicts(self):
2444
confile = self._control_files.get('conflicts')
2445
except errors.NoSuchFile:
2446
return _mod_conflicts.ConflictList()
2448
if confile.next() != CONFLICT_HEADER_1 + '\n':
2449
raise errors.ConflictFormatError()
2450
except StopIteration:
2451
raise errors.ConflictFormatError()
2452
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2455
if self._control_files._lock_count == 1:
2456
# _inventory_is_modified is always False during a read lock.
2457
if self._inventory_is_modified:
2459
self._write_hashcache_if_dirty()
2460
# reverse order of locking.
2462
return self._control_files.unlock()
2464
self.branch.unlock()
2467
def get_conflicted_stem(path):
2468
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2469
if path.endswith(suffix):
2470
return path[:-len(suffix)]
2473
@deprecated_function(zero_eight)
2474
def is_control_file(filename):
2475
"""See WorkingTree.is_control_filename(filename)."""
2476
## FIXME: better check
2477
filename = normpath(filename)
2478
while filename != '':
2479
head, tail = os.path.split(filename)
2480
## mutter('check %r for control file' % ((head, tail),))
2483
if filename == head:
2489
class WorkingTreeFormat(object):
2490
"""An encapsulation of the initialization and open routines for a format.
2492
Formats provide three things:
2493
* An initialization routine,
2497
Formats are placed in an dict by their format string for reference
2498
during workingtree opening. Its not required that these be instances, they
2499
can be classes themselves with class methods - it simply depends on
2500
whether state is needed for a given format or not.
2502
Once a format is deprecated, just deprecate the initialize and open
2503
methods on the format class. Do not deprecate the object, as the
2504
object will be created every time regardless.
2507
_default_format = None
2508
"""The default format used for new trees."""
2511
"""The known formats."""
2513
requires_rich_root = False
2515
upgrade_recommended = False
2518
def find_format(klass, a_bzrdir):
2519
"""Return the format for the working tree object in a_bzrdir."""
2521
transport = a_bzrdir.get_workingtree_transport(None)
2522
format_string = transport.get("format").read()
2523
return klass._formats[format_string]
2524
except errors.NoSuchFile:
2525
raise errors.NoWorkingTree(base=transport.base)
2527
raise errors.UnknownFormatError(format=format_string)
2529
def __eq__(self, other):
2530
return self.__class__ is other.__class__
2532
def __ne__(self, other):
2533
return not (self == other)
2536
def get_default_format(klass):
2537
"""Return the current default format."""
2538
return klass._default_format
2540
def get_format_string(self):
2541
"""Return the ASCII format string that identifies this format."""
2542
raise NotImplementedError(self.get_format_string)
2544
def get_format_description(self):
2545
"""Return the short description for this format."""
2546
raise NotImplementedError(self.get_format_description)
2548
def is_supported(self):
2549
"""Is this format supported?
2551
Supported formats can be initialized and opened.
2552
Unsupported formats may not support initialization or committing or
2553
some other features depending on the reason for not being supported.
2558
def register_format(klass, format):
2559
klass._formats[format.get_format_string()] = format
2562
def set_default_format(klass, format):
2563
klass._default_format = format
2566
def unregister_format(klass, format):
2567
assert klass._formats[format.get_format_string()] is format
2568
del klass._formats[format.get_format_string()]
2571
class WorkingTreeFormat2(WorkingTreeFormat):
2572
"""The second working tree format.
2574
This format modified the hash cache from the format 1 hash cache.
2577
upgrade_recommended = True
2579
def get_format_description(self):
2580
"""See WorkingTreeFormat.get_format_description()."""
2581
return "Working tree format 2"
2583
def stub_initialize_remote(self, control_files):
2584
"""As a special workaround create critical control files for a remote working tree
2586
This ensures that it can later be updated and dealt with locally,
2587
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2588
no working tree. (See bug #43064).
2592
xml5.serializer_v5.write_inventory(inv, sio)
2594
control_files.put('inventory', sio)
2596
control_files.put_bytes('pending-merges', '')
2599
def initialize(self, a_bzrdir, revision_id=None):
2600
"""See WorkingTreeFormat.initialize()."""
2601
if not isinstance(a_bzrdir.transport, LocalTransport):
2602
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2603
branch = a_bzrdir.open_branch()
2604
if revision_id is not None:
2605
revision_id = osutils.safe_revision_id(revision_id)
2608
revision_history = branch.revision_history()
2610
position = revision_history.index(revision_id)
2612
raise errors.NoSuchRevision(branch, revision_id)
2613
branch.set_revision_history(revision_history[:position + 1])
2616
revision = branch.last_revision()
2618
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2624
basis_tree = branch.repository.revision_tree(revision)
2625
if basis_tree.inventory.root is not None:
2626
wt.set_root_id(basis_tree.inventory.root.file_id)
2627
# set the parent list and cache the basis tree.
2628
wt.set_parent_trees([(revision, basis_tree)])
2629
transform.build_tree(basis_tree, wt)
2633
super(WorkingTreeFormat2, self).__init__()
2634
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2636
def open(self, a_bzrdir, _found=False):
2637
"""Return the WorkingTree object for a_bzrdir
2639
_found is a private parameter, do not use it. It is used to indicate
2640
if format probing has already been done.
2643
# we are being called directly and must probe.
2644
raise NotImplementedError
2645
if not isinstance(a_bzrdir.transport, LocalTransport):
2646
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2647
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2653
class WorkingTreeFormat3(WorkingTreeFormat):
2654
"""The second working tree format updated to record a format marker.
2657
- exists within a metadir controlling .bzr
2658
- includes an explicit version marker for the workingtree control
2659
files, separate from the BzrDir format
2660
- modifies the hash cache format
2662
- uses a LockDir to guard access for writes.
2665
upgrade_recommended = True
2667
def get_format_string(self):
2668
"""See WorkingTreeFormat.get_format_string()."""
2669
return "Bazaar-NG Working Tree format 3"
2671
def get_format_description(self):
2672
"""See WorkingTreeFormat.get_format_description()."""
2673
return "Working tree format 3"
2675
_lock_file_name = 'lock'
2676
_lock_class = LockDir
2678
_tree_class = WorkingTree3
2680
def __get_matchingbzrdir(self):
2681
return bzrdir.BzrDirMetaFormat1()
2683
_matchingbzrdir = property(__get_matchingbzrdir)
2685
def _open_control_files(self, a_bzrdir):
2686
transport = a_bzrdir.get_workingtree_transport(None)
2687
return LockableFiles(transport, self._lock_file_name,
2690
def initialize(self, a_bzrdir, revision_id=None):
2691
"""See WorkingTreeFormat.initialize().
2693
revision_id allows creating a working tree at a different
2694
revision than the branch is at.
2696
if not isinstance(a_bzrdir.transport, LocalTransport):
2697
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2698
transport = a_bzrdir.get_workingtree_transport(self)
2699
control_files = self._open_control_files(a_bzrdir)
2700
control_files.create_lock()
2701
control_files.lock_write()
2702
control_files.put_utf8('format', self.get_format_string())
2703
branch = a_bzrdir.open_branch()
2704
if revision_id is None:
2705
revision_id = branch.last_revision()
2707
revision_id = osutils.safe_revision_id(revision_id)
2708
# WorkingTree3 can handle an inventory which has a unique root id.
2709
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2710
# those trees. And because there isn't a format bump inbetween, we
2711
# are maintaining compatibility with older clients.
2712
# inv = Inventory(root_id=gen_root_id())
2713
inv = self._initial_inventory()
2714
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2720
_control_files=control_files)
2721
wt.lock_tree_write()
2723
basis_tree = branch.repository.revision_tree(revision_id)
2724
# only set an explicit root id if there is one to set.
2725
if basis_tree.inventory.root is not None:
2726
wt.set_root_id(basis_tree.inventory.root.file_id)
2727
if revision_id == NULL_REVISION:
2728
wt.set_parent_trees([])
2730
wt.set_parent_trees([(revision_id, basis_tree)])
2731
transform.build_tree(basis_tree, wt)
2733
# Unlock in this order so that the unlock-triggers-flush in
2734
# WorkingTree is given a chance to fire.
2735
control_files.unlock()
2739
def _initial_inventory(self):
2743
super(WorkingTreeFormat3, self).__init__()
2745
def open(self, a_bzrdir, _found=False):
2746
"""Return the WorkingTree object for a_bzrdir
2748
_found is a private parameter, do not use it. It is used to indicate
2749
if format probing has already been done.
2752
# we are being called directly and must probe.
2753
raise NotImplementedError
2754
if not isinstance(a_bzrdir.transport, LocalTransport):
2755
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2756
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2759
def _open(self, a_bzrdir, control_files):
2760
"""Open the tree itself.
2762
:param a_bzrdir: the dir for the tree.
2763
:param control_files: the control files for the tree.
2765
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2769
_control_files=control_files)
2772
return self.get_format_string()
2775
__default_format = WorkingTreeFormat4()
2776
WorkingTreeFormat.register_format(__default_format)
2777
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2778
WorkingTreeFormat.set_default_format(__default_format)
2779
# formats which have no format string are not discoverable
2780
# and not independently creatable, so are not registered.
2781
_legacy_formats = [WorkingTreeFormat2(),
2785
class WorkingTreeTestProviderAdapter(object):
2786
"""A tool to generate a suite testing multiple workingtree formats at once.
2788
This is done by copying the test once for each transport and injecting
2789
the transport_server, transport_readonly_server, and workingtree_format
2790
classes into each copy. Each copy is also given a new id() to make it
2794
def __init__(self, transport_server, transport_readonly_server, formats):
2795
self._transport_server = transport_server
2796
self._transport_readonly_server = transport_readonly_server
2797
self._formats = formats
2799
def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2800
"""Clone test for adaption."""
2801
new_test = deepcopy(test)
2802
new_test.transport_server = self._transport_server
2803
new_test.transport_readonly_server = self._transport_readonly_server
2804
new_test.bzrdir_format = bzrdir_format
2805
new_test.workingtree_format = workingtree_format
2806
def make_new_test_id():
2807
new_id = "%s(%s)" % (test.id(), variation)
2808
return lambda: new_id
2809
new_test.id = make_new_test_id()
2812
def adapt(self, test):
2813
from bzrlib.tests import TestSuite
2814
result = TestSuite()
2815
for workingtree_format, bzrdir_format in self._formats:
2816
new_test = self._clone_test(
2819
workingtree_format, workingtree_format.__class__.__name__)
2820
result.addTest(new_test)
added
removed
bzrlib/workingtree.py
