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
59
conflicts as _mod_conflicts,
68
revision as _mod_revision,
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 = _mod_revision.ensure_null(self._last_revision())
507
if _mod_revision.NULL_REVISION == last_rev:
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.
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._inventory_is_modified = True
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)
738
for revision_id in revision_ids:
739
_mod_revision.check_not_reserved_id(revision_id)
741
if len(revision_ids) > 0:
742
self.set_last_revision(revision_ids[0])
744
self.set_last_revision(_mod_revision.NULL_REVISION)
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]
752
for revision_id in parent_ids:
753
_mod_revision.check_not_reserved_id(revision_id)
755
self._check_parents_for_ghosts(parent_ids,
756
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
758
if len(parent_ids) == 0:
759
leftmost_parent_id = _mod_revision.NULL_REVISION
760
leftmost_parent_tree = None
762
leftmost_parent_id, leftmost_parent_tree = parents_list[0]
764
if self._change_last_revision(leftmost_parent_id):
765
if leftmost_parent_tree is None:
766
# If we don't have a tree, fall back to reading the
767
# parent tree from the repository.
768
self._cache_basis_inventory(leftmost_parent_id)
770
inv = leftmost_parent_tree.inventory
771
xml = self._create_basis_xml_from_inventory(
772
leftmost_parent_id, inv)
773
self._write_basis_inventory(xml)
774
self._set_merges_from_parent_ids(parent_ids)
776
@needs_tree_write_lock
777
def set_pending_merges(self, rev_list):
778
parents = self.get_parent_ids()
779
leftmost = parents[:1]
780
new_parents = leftmost + rev_list
781
self.set_parent_ids(new_parents)
783
@needs_tree_write_lock
784
def set_merge_modified(self, modified_hashes):
786
for file_id, hash in modified_hashes.iteritems():
787
yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
788
self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
790
def _put_rio(self, filename, stanzas, header):
791
self._must_be_locked()
792
my_file = rio_file(stanzas, header)
793
self._control_files.put(filename, my_file)
795
@needs_write_lock # because merge pulls data into the branch.
796
def merge_from_branch(self, branch, to_revision=None):
797
"""Merge from a branch into this working tree.
799
:param branch: The branch to merge from.
800
:param to_revision: If non-None, the merge will merge to to_revision,
801
but not beyond it. to_revision does not need to be in the history
802
of the branch when it is supplied. If None, to_revision defaults to
803
branch.last_revision().
805
from bzrlib.merge import Merger, Merge3Merger
806
pb = bzrlib.ui.ui_factory.nested_progress_bar()
808
merger = Merger(self.branch, this_tree=self, pb=pb)
809
merger.pp = ProgressPhase("Merge phase", 5, pb)
810
merger.pp.next_phase()
811
# check that there are no
813
merger.check_basis(check_clean=True, require_commits=False)
814
if to_revision is None:
815
to_revision = _mod_revision.ensure_null(branch.last_revision())
817
to_revision = osutils.safe_revision_id(to_revision)
818
merger.other_rev_id = to_revision
819
if _mod_revision.is_null(merger.other_rev_id):
820
raise errors.NoCommits(branch)
821
self.branch.fetch(branch, last_revision=merger.other_rev_id)
822
merger.other_basis = merger.other_rev_id
823
merger.other_tree = self.branch.repository.revision_tree(
825
merger.other_branch = branch
826
merger.pp.next_phase()
828
if merger.base_rev_id == merger.other_rev_id:
829
raise errors.PointlessMerge
830
merger.backup_files = False
831
merger.merge_type = Merge3Merger
832
merger.set_interesting_files(None)
833
merger.show_base = False
834
merger.reprocess = False
835
conflicts = merger.do_merge()
842
def merge_modified(self):
843
"""Return a dictionary of files modified by a merge.
845
The list is initialized by WorkingTree.set_merge_modified, which is
846
typically called after we make some automatic updates to the tree
849
This returns a map of file_id->sha1, containing only files which are
850
still in the working inventory and have that text hash.
853
hashfile = self._control_files.get('merge-hashes')
854
except errors.NoSuchFile:
858
if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
859
raise errors.MergeModifiedFormatError()
860
except StopIteration:
861
raise errors.MergeModifiedFormatError()
862
for s in RioReader(hashfile):
863
# RioReader reads in Unicode, so convert file_ids back to utf8
864
file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
865
if file_id not in self.inventory:
867
text_hash = s.get("hash")
868
if text_hash == self.get_file_sha1(file_id):
869
merge_hashes[file_id] = text_hash
873
def mkdir(self, path, file_id=None):
874
"""See MutableTree.mkdir()."""
876
file_id = generate_ids.gen_file_id(os.path.basename(path))
877
os.mkdir(self.abspath(path))
878
self.add(path, file_id, 'directory')
881
def get_symlink_target(self, file_id):
882
file_id = osutils.safe_file_id(file_id)
883
return os.readlink(self.id2abspath(file_id))
886
def subsume(self, other_tree):
887
def add_children(inventory, entry):
888
for child_entry in entry.children.values():
889
inventory._byid[child_entry.file_id] = child_entry
890
if child_entry.kind == 'directory':
891
add_children(inventory, child_entry)
892
if other_tree.get_root_id() == self.get_root_id():
893
raise errors.BadSubsumeSource(self, other_tree,
894
'Trees have the same root')
896
other_tree_path = self.relpath(other_tree.basedir)
897
except errors.PathNotChild:
898
raise errors.BadSubsumeSource(self, other_tree,
899
'Tree is not contained by the other')
900
new_root_parent = self.path2id(osutils.dirname(other_tree_path))
901
if new_root_parent is None:
902
raise errors.BadSubsumeSource(self, other_tree,
903
'Parent directory is not versioned.')
904
# We need to ensure that the result of a fetch will have a
905
# versionedfile for the other_tree root, and only fetching into
906
# RepositoryKnit2 guarantees that.
907
if not self.branch.repository.supports_rich_root():
908
raise errors.SubsumeTargetNeedsUpgrade(other_tree)
909
other_tree.lock_tree_write()
911
new_parents = other_tree.get_parent_ids()
912
other_root = other_tree.inventory.root
913
other_root.parent_id = new_root_parent
914
other_root.name = osutils.basename(other_tree_path)
915
self.inventory.add(other_root)
916
add_children(self.inventory, other_root)
917
self._write_inventory(self.inventory)
918
# normally we don't want to fetch whole repositories, but i think
919
# here we really do want to consolidate the whole thing.
920
for parent_id in other_tree.get_parent_ids():
921
self.branch.fetch(other_tree.branch, parent_id)
922
self.add_parent_tree_id(parent_id)
925
other_tree.bzrdir.retire_bzrdir()
927
@needs_tree_write_lock
928
def extract(self, file_id, format=None):
929
"""Extract a subtree from this tree.
931
A new branch will be created, relative to the path for this tree.
935
segments = osutils.splitpath(path)
936
transport = self.branch.bzrdir.root_transport
937
for name in segments:
938
transport = transport.clone(name)
939
transport.ensure_base()
942
sub_path = self.id2path(file_id)
943
branch_transport = mkdirs(sub_path)
945
format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
946
branch_transport.ensure_base()
947
branch_bzrdir = format.initialize_on_transport(branch_transport)
949
repo = branch_bzrdir.find_repository()
950
except errors.NoRepositoryPresent:
951
repo = branch_bzrdir.create_repository()
952
assert repo.supports_rich_root()
954
if not repo.supports_rich_root():
955
raise errors.RootNotRich()
956
new_branch = branch_bzrdir.create_branch()
957
new_branch.pull(self.branch)
958
for parent_id in self.get_parent_ids():
959
new_branch.fetch(self.branch, parent_id)
960
tree_transport = self.bzrdir.root_transport.clone(sub_path)
961
if tree_transport.base != branch_transport.base:
962
tree_bzrdir = format.initialize_on_transport(tree_transport)
963
branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
965
tree_bzrdir = branch_bzrdir
966
wt = tree_bzrdir.create_workingtree(NULL_REVISION)
967
wt.set_parent_ids(self.get_parent_ids())
968
my_inv = self.inventory
969
child_inv = Inventory(root_id=None)
970
new_root = my_inv[file_id]
971
my_inv.remove_recursive_id(file_id)
972
new_root.parent_id = None
973
child_inv.add(new_root)
974
self._write_inventory(my_inv)
975
wt._write_inventory(child_inv)
978
def _serialize(self, inventory, out_file):
979
xml5.serializer_v5.write_inventory(self._inventory, out_file)
981
def _deserialize(selt, in_file):
982
return xml5.serializer_v5.read_inventory(in_file)
985
"""Write the in memory inventory to disk."""
986
# TODO: Maybe this should only write on dirty ?
987
if self._control_files._lock_mode != 'w':
988
raise errors.NotWriteLocked(self)
990
self._serialize(self._inventory, sio)
992
self._control_files.put('inventory', sio)
993
self._inventory_is_modified = False
995
def _kind(self, relpath):
996
return osutils.file_kind(self.abspath(relpath))
998
def list_files(self, include_root=False):
999
"""Recursively list all files as (path, class, kind, id, entry).
1001
Lists, but does not descend into unversioned directories.
1003
This does not include files that have been deleted in this
1006
Skips the control directory.
1008
# list_files is an iterator, so @needs_read_lock doesn't work properly
1009
# with it. So callers should be careful to always read_lock the tree.
1010
if not self.is_locked():
1011
raise errors.ObjectNotLocked(self)
1013
inv = self.inventory
1014
if include_root is True:
1015
yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1016
# Convert these into local objects to save lookup times
1017
pathjoin = osutils.pathjoin
1018
file_kind = self._kind
1020
# transport.base ends in a slash, we want the piece
1021
# between the last two slashes
1022
transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1024
fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1026
# directory file_id, relative path, absolute path, reverse sorted children
1027
children = os.listdir(self.basedir)
1029
# jam 20060527 The kernel sized tree seems equivalent whether we
1030
# use a deque and popleft to keep them sorted, or if we use a plain
1031
# list and just reverse() them.
1032
children = collections.deque(children)
1033
stack = [(inv.root.file_id, u'', self.basedir, children)]
1035
from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1038
f = children.popleft()
1039
## TODO: If we find a subdirectory with its own .bzr
1040
## directory, then that is a separate tree and we
1041
## should exclude it.
1043
# the bzrdir for this tree
1044
if transport_base_dir == f:
1047
# we know that from_dir_relpath and from_dir_abspath never end in a slash
1048
# and 'f' doesn't begin with one, we can do a string op, rather
1049
# than the checks of pathjoin(), all relative paths will have an extra slash
1051
fp = from_dir_relpath + '/' + f
1054
fap = from_dir_abspath + '/' + f
1056
f_ie = inv.get_child(from_dir_id, f)
1059
elif self.is_ignored(fp[1:]):
1062
# we may not have found this file, because of a unicode issue
1063
f_norm, can_access = osutils.normalized_filename(f)
1064
if f == f_norm or not can_access:
1065
# No change, so treat this file normally
1068
# this file can be accessed by a normalized path
1069
# check again if it is versioned
1070
# these lines are repeated here for performance
1072
fp = from_dir_relpath + '/' + f
1073
fap = from_dir_abspath + '/' + f
1074
f_ie = inv.get_child(from_dir_id, f)
1077
elif self.is_ignored(fp[1:]):
1084
# make a last minute entry
1086
yield fp[1:], c, fk, f_ie.file_id, f_ie
1089
yield fp[1:], c, fk, None, fk_entries[fk]()
1091
yield fp[1:], c, fk, None, TreeEntry()
1094
if fk != 'directory':
1097
# But do this child first
1098
new_children = os.listdir(fap)
1100
new_children = collections.deque(new_children)
1101
stack.append((f_ie.file_id, fp, fap, new_children))
1102
# Break out of inner loop,
1103
# so that we start outer loop with child
1106
# if we finished all children, pop it off the stack
1109
@needs_tree_write_lock
1110
def move(self, from_paths, to_dir=None, after=False, **kwargs):
1113
to_dir must exist in the inventory.
1115
If to_dir exists and is a directory, the files are moved into
1116
it, keeping their old names.
1118
Note that to_dir is only the last component of the new name;
1119
this doesn't change the directory.
1121
For each entry in from_paths the move mode will be determined
1124
The first mode moves the file in the filesystem and updates the
1125
inventory. The second mode only updates the inventory without
1126
touching the file on the filesystem. This is the new mode introduced
1129
move uses the second mode if 'after == True' and the target is not
1130
versioned but present in the working tree.
1132
move uses the second mode if 'after == False' and the source is
1133
versioned but no longer in the working tree, and the target is not
1134
versioned but present in the working tree.
1136
move uses the first mode if 'after == False' and the source is
1137
versioned and present in the working tree, and the target is not
1138
versioned and not present in the working tree.
1140
Everything else results in an error.
1142
This returns a list of (from_path, to_path) pairs for each
1143
entry that is moved.
1148
# check for deprecated use of signature
1150
to_dir = kwargs.get('to_name', None)
1152
raise TypeError('You must supply a target directory')
1154
symbol_versioning.warn('The parameter to_name was deprecated'
1155
' in version 0.13. Use to_dir instead',
1158
# check destination directory
1159
assert not isinstance(from_paths, basestring)
1160
inv = self.inventory
1161
to_abs = self.abspath(to_dir)
1162
if not isdir(to_abs):
1163
raise errors.BzrMoveFailedError('',to_dir,
1164
errors.NotADirectory(to_abs))
1165
if not self.has_filename(to_dir):
1166
raise errors.BzrMoveFailedError('',to_dir,
1167
errors.NotInWorkingDirectory(to_dir))
1168
to_dir_id = inv.path2id(to_dir)
1169
if to_dir_id is None:
1170
raise errors.BzrMoveFailedError('',to_dir,
1171
errors.NotVersionedError(path=str(to_dir)))
1173
to_dir_ie = inv[to_dir_id]
1174
if to_dir_ie.kind != 'directory':
1175
raise errors.BzrMoveFailedError('',to_dir,
1176
errors.NotADirectory(to_abs))
1178
# create rename entries and tuples
1179
for from_rel in from_paths:
1180
from_tail = splitpath(from_rel)[-1]
1181
from_id = inv.path2id(from_rel)
1183
raise errors.BzrMoveFailedError(from_rel,to_dir,
1184
errors.NotVersionedError(path=str(from_rel)))
1186
from_entry = inv[from_id]
1187
from_parent_id = from_entry.parent_id
1188
to_rel = pathjoin(to_dir, from_tail)
1189
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1191
from_tail=from_tail,
1192
from_parent_id=from_parent_id,
1193
to_rel=to_rel, to_tail=from_tail,
1194
to_parent_id=to_dir_id)
1195
rename_entries.append(rename_entry)
1196
rename_tuples.append((from_rel, to_rel))
1198
# determine which move mode to use. checks also for movability
1199
rename_entries = self._determine_mv_mode(rename_entries, after)
1201
original_modified = self._inventory_is_modified
1204
self._inventory_is_modified = True
1205
self._move(rename_entries)
1207
# restore the inventory on error
1208
self._inventory_is_modified = original_modified
1210
self._write_inventory(inv)
1211
return rename_tuples
1213
def _determine_mv_mode(self, rename_entries, after=False):
1214
"""Determines for each from-to pair if both inventory and working tree
1215
or only the inventory has to be changed.
1217
Also does basic plausability tests.
1219
inv = self.inventory
1221
for rename_entry in rename_entries:
1222
# store to local variables for easier reference
1223
from_rel = rename_entry.from_rel
1224
from_id = rename_entry.from_id
1225
to_rel = rename_entry.to_rel
1226
to_id = inv.path2id(to_rel)
1227
only_change_inv = False
1229
# check the inventory for source and destination
1231
raise errors.BzrMoveFailedError(from_rel,to_rel,
1232
errors.NotVersionedError(path=str(from_rel)))
1233
if to_id is not None:
1234
raise errors.BzrMoveFailedError(from_rel,to_rel,
1235
errors.AlreadyVersionedError(path=str(to_rel)))
1237
# try to determine the mode for rename (only change inv or change
1238
# inv and file system)
1240
if not self.has_filename(to_rel):
1241
raise errors.BzrMoveFailedError(from_id,to_rel,
1242
errors.NoSuchFile(path=str(to_rel),
1243
extra="New file has not been created yet"))
1244
only_change_inv = True
1245
elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1246
only_change_inv = True
1247
elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1248
only_change_inv = False
1250
# something is wrong, so lets determine what exactly
1251
if not self.has_filename(from_rel) and \
1252
not self.has_filename(to_rel):
1253
raise errors.BzrRenameFailedError(from_rel,to_rel,
1254
errors.PathsDoNotExist(paths=(str(from_rel),
1257
raise errors.RenameFailedFilesExist(from_rel, to_rel,
1258
extra="(Use --after to update the Bazaar id)")
1259
rename_entry.only_change_inv = only_change_inv
1260
return rename_entries
1262
def _move(self, rename_entries):
1263
"""Moves a list of files.
1265
Depending on the value of the flag 'only_change_inv', the
1266
file will be moved on the file system or not.
1268
inv = self.inventory
1271
for entry in rename_entries:
1273
self._move_entry(entry)
1275
self._rollback_move(moved)
1279
def _rollback_move(self, moved):
1280
"""Try to rollback a previous move in case of an filesystem error."""
1281
inv = self.inventory
1284
self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1285
entry.to_tail, entry.to_parent_id, entry.from_rel,
1286
entry.from_tail, entry.from_parent_id,
1287
entry.only_change_inv))
1288
except errors.BzrMoveFailedError, e:
1289
raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1290
" The working tree is in an inconsistent state."
1291
" Please consider doing a 'bzr revert'."
1292
" Error message is: %s" % e)
1294
def _move_entry(self, entry):
1295
inv = self.inventory
1296
from_rel_abs = self.abspath(entry.from_rel)
1297
to_rel_abs = self.abspath(entry.to_rel)
1298
if from_rel_abs == to_rel_abs:
1299
raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1300
"Source and target are identical.")
1302
if not entry.only_change_inv:
1304
osutils.rename(from_rel_abs, to_rel_abs)
1306
raise errors.BzrMoveFailedError(entry.from_rel,
1308
inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1310
@needs_tree_write_lock
1311
def rename_one(self, from_rel, to_rel, after=False):
1314
This can change the directory or the filename or both.
1316
rename_one has several 'modes' to work. First, it can rename a physical
1317
file and change the file_id. That is the normal mode. Second, it can
1318
only change the file_id without touching any physical file. This is
1319
the new mode introduced in version 0.15.
1321
rename_one uses the second mode if 'after == True' and 'to_rel' is not
1322
versioned but present in the working tree.
1324
rename_one uses the second mode if 'after == False' and 'from_rel' is
1325
versioned but no longer in the working tree, and 'to_rel' is not
1326
versioned but present in the working tree.
1328
rename_one uses the first mode if 'after == False' and 'from_rel' is
1329
versioned and present in the working tree, and 'to_rel' is not
1330
versioned and not present in the working tree.
1332
Everything else results in an error.
1334
inv = self.inventory
1337
# create rename entries and tuples
1338
from_tail = splitpath(from_rel)[-1]
1339
from_id = inv.path2id(from_rel)
1341
raise errors.BzrRenameFailedError(from_rel,to_rel,
1342
errors.NotVersionedError(path=str(from_rel)))
1343
from_entry = inv[from_id]
1344
from_parent_id = from_entry.parent_id
1345
to_dir, to_tail = os.path.split(to_rel)
1346
to_dir_id = inv.path2id(to_dir)
1347
rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1349
from_tail=from_tail,
1350
from_parent_id=from_parent_id,
1351
to_rel=to_rel, to_tail=to_tail,
1352
to_parent_id=to_dir_id)
1353
rename_entries.append(rename_entry)
1355
# determine which move mode to use. checks also for movability
1356
rename_entries = self._determine_mv_mode(rename_entries, after)
1358
# check if the target changed directory and if the target directory is
1360
if to_dir_id is None:
1361
raise errors.BzrMoveFailedError(from_rel,to_rel,
1362
errors.NotVersionedError(path=str(to_dir)))
1364
# all checks done. now we can continue with our actual work
1365
mutter('rename_one:\n'
1370
' to_dir_id {%s}\n',
1371
from_id, from_rel, to_rel, to_dir, to_dir_id)
1373
self._move(rename_entries)
1374
self._write_inventory(inv)
1376
class _RenameEntry(object):
1377
def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1378
to_rel, to_tail, to_parent_id, only_change_inv=False):
1379
self.from_rel = from_rel
1380
self.from_id = from_id
1381
self.from_tail = from_tail
1382
self.from_parent_id = from_parent_id
1383
self.to_rel = to_rel
1384
self.to_tail = to_tail
1385
self.to_parent_id = to_parent_id
1386
self.only_change_inv = only_change_inv
1390
"""Return all unknown files.
1392
These are files in the working directory that are not versioned or
1393
control files or ignored.
1395
# force the extras method to be fully executed before returning, to
1396
# prevent race conditions with the lock
1398
[subp for subp in self.extras() if not self.is_ignored(subp)])
1400
@needs_tree_write_lock
1401
def unversion(self, file_ids):
1402
"""Remove the file ids in file_ids from the current versioned set.
1404
When a file_id is unversioned, all of its children are automatically
1407
:param file_ids: The file ids to stop versioning.
1408
:raises: NoSuchId if any fileid is not currently versioned.
1410
for file_id in file_ids:
1411
file_id = osutils.safe_file_id(file_id)
1412
if self._inventory.has_id(file_id):
1413
self._inventory.remove_recursive_id(file_id)
1415
raise errors.NoSuchId(self, file_id)
1417
# in the future this should just set a dirty bit to wait for the
1418
# final unlock. However, until all methods of workingtree start
1419
# with the current in -memory inventory rather than triggering
1420
# a read, it is more complex - we need to teach read_inventory
1421
# to know when to read, and when to not read first... and possibly
1422
# to save first when the in memory one may be corrupted.
1423
# so for now, we just only write it if it is indeed dirty.
1425
self._write_inventory(self._inventory)
1427
@deprecated_method(zero_eight)
1428
def iter_conflicts(self):
1429
"""List all files in the tree that have text or content conflicts.
1430
DEPRECATED. Use conflicts instead."""
1431
return self._iter_conflicts()
1433
def _iter_conflicts(self):
1435
for info in self.list_files():
1437
stem = get_conflicted_stem(path)
1440
if stem not in conflicted:
1441
conflicted.add(stem)
1445
def pull(self, source, overwrite=False, stop_revision=None,
1446
change_reporter=None):
1447
top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1450
pp = ProgressPhase("Pull phase", 2, top_pb)
1452
old_revision_info = self.branch.last_revision_info()
1453
basis_tree = self.basis_tree()
1454
count = self.branch.pull(source, overwrite, stop_revision)
1455
new_revision_info = self.branch.last_revision_info()
1456
if new_revision_info != old_revision_info:
1458
repository = self.branch.repository
1459
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1460
basis_tree.lock_read()
1462
new_basis_tree = self.branch.basis_tree()
1469
change_reporter=change_reporter)
1470
if (basis_tree.inventory.root is None and
1471
new_basis_tree.inventory.root is not None):
1472
self.set_root_id(new_basis_tree.inventory.root.file_id)
1476
# TODO - dedup parents list with things merged by pull ?
1477
# reuse the revisiontree we merged against to set the new
1479
parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1480
# we have to pull the merge trees out again, because
1481
# merge_inner has set the ids. - this corner is not yet
1482
# layered well enough to prevent double handling.
1483
# XXX TODO: Fix the double handling: telling the tree about
1484
# the already known parent data is wasteful.
1485
merges = self.get_parent_ids()[1:]
1486
parent_trees.extend([
1487
(parent, repository.revision_tree(parent)) for
1489
self.set_parent_trees(parent_trees)
1496
def put_file_bytes_non_atomic(self, file_id, bytes):
1497
"""See MutableTree.put_file_bytes_non_atomic."""
1498
file_id = osutils.safe_file_id(file_id)
1499
stream = file(self.id2abspath(file_id), 'wb')
1504
# TODO: update the hashcache here ?
1507
"""Yield all unversioned files in this WorkingTree.
1509
If there are any unversioned directories then only the directory is
1510
returned, not all its children. But if there are unversioned files
1511
under a versioned subdirectory, they are returned.
1513
Currently returned depth-first, sorted by name within directories.
1514
This is the same order used by 'osutils.walkdirs'.
1516
## TODO: Work from given directory downwards
1517
for path, dir_entry in self.inventory.directories():
1518
# mutter("search for unknowns in %r", path)
1519
dirabs = self.abspath(path)
1520
if not isdir(dirabs):
1521
# e.g. directory deleted
1525
for subf in os.listdir(dirabs):
1528
if subf not in dir_entry.children:
1529
subf_norm, can_access = osutils.normalized_filename(subf)
1530
if subf_norm != subf and can_access:
1531
if subf_norm not in dir_entry.children:
1532
fl.append(subf_norm)
1538
subp = pathjoin(path, subf)
1541
def ignored_files(self):
1542
"""Yield list of PATH, IGNORE_PATTERN"""
1543
for subp in self.extras():
1544
pat = self.is_ignored(subp)
1548
def get_ignore_list(self):
1549
"""Return list of ignore patterns.
1551
Cached in the Tree object after the first call.
1553
ignoreset = getattr(self, '_ignoreset', None)
1554
if ignoreset is not None:
1557
ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1558
ignore_globs.update(ignores.get_runtime_ignores())
1559
ignore_globs.update(ignores.get_user_ignores())
1560
if self.has_filename(bzrlib.IGNORE_FILENAME):
1561
f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1563
ignore_globs.update(ignores.parse_ignore_file(f))
1566
self._ignoreset = ignore_globs
1569
def _flush_ignore_list_cache(self):
1570
"""Resets the cached ignore list to force a cache rebuild."""
1571
self._ignoreset = None
1572
self._ignoreglobster = None
1574
def is_ignored(self, filename):
1575
r"""Check whether the filename matches an ignore pattern.
1577
Patterns containing '/' or '\' need to match the whole path;
1578
others match against only the last component.
1580
If the file is ignored, returns the pattern which caused it to
1581
be ignored, otherwise None. So this can simply be used as a
1582
boolean if desired."""
1583
if getattr(self, '_ignoreglobster', None) is None:
1584
self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1585
return self._ignoreglobster.match(filename)
1587
def kind(self, file_id):
1588
return file_kind(self.id2abspath(file_id))
1590
def _comparison_data(self, entry, path):
1591
abspath = self.abspath(path)
1593
stat_value = os.lstat(abspath)
1595
if getattr(e, 'errno', None) == errno.ENOENT:
1602
mode = stat_value.st_mode
1603
kind = osutils.file_kind_from_stat_mode(mode)
1604
if not supports_executable():
1605
executable = entry is not None and entry.executable
1607
executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1608
return kind, executable, stat_value
1610
def _file_size(self, entry, stat_value):
1611
return stat_value.st_size
1613
def last_revision(self):
1614
"""Return the last revision of the branch for this tree.
1616
This format tree does not support a separate marker for last-revision
1617
compared to the branch.
1619
See MutableTree.last_revision
1621
return self._last_revision()
1624
def _last_revision(self):
1625
"""helper for get_parent_ids."""
1626
return self.branch.last_revision()
1628
def is_locked(self):
1629
return self._control_files.is_locked()
1631
def _must_be_locked(self):
1632
if not self.is_locked():
1633
raise errors.ObjectNotLocked(self)
1635
def lock_read(self):
1636
"""See Branch.lock_read, and WorkingTree.unlock."""
1637
if not self.is_locked():
1639
self.branch.lock_read()
1641
return self._control_files.lock_read()
1643
self.branch.unlock()
1646
def lock_tree_write(self):
1647
"""See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1648
if not self.is_locked():
1650
self.branch.lock_read()
1652
return self._control_files.lock_write()
1654
self.branch.unlock()
1657
def lock_write(self):
1658
"""See MutableTree.lock_write, and WorkingTree.unlock."""
1659
if not self.is_locked():
1661
self.branch.lock_write()
1663
return self._control_files.lock_write()
1665
self.branch.unlock()
1668
def get_physical_lock_status(self):
1669
return self._control_files.get_physical_lock_status()
1671
def _basis_inventory_name(self):
1672
return 'basis-inventory-cache'
1674
def _reset_data(self):
1675
"""Reset transient data that cannot be revalidated."""
1676
self._inventory_is_modified = False
1677
result = self._deserialize(self._control_files.get('inventory'))
1678
self._set_inventory(result, dirty=False)
1680
@needs_tree_write_lock
1681
def set_last_revision(self, new_revision):
1682
"""Change the last revision in the working tree."""
1683
new_revision = osutils.safe_revision_id(new_revision)
1684
if self._change_last_revision(new_revision):
1685
self._cache_basis_inventory(new_revision)
1687
def _change_last_revision(self, new_revision):
1688
"""Template method part of set_last_revision to perform the change.
1690
This is used to allow WorkingTree3 instances to not affect branch
1691
when their last revision is set.
1693
if _mod_revision.is_null(new_revision):
1694
self.branch.set_revision_history([])
1697
self.branch.generate_revision_history(new_revision)
1698
except errors.NoSuchRevision:
1699
# not present in the repo - dont try to set it deeper than the tip
1700
self.branch.set_revision_history([new_revision])
1703
def _write_basis_inventory(self, xml):
1704
"""Write the basis inventory XML to the basis-inventory file"""
1705
assert isinstance(xml, str), 'serialised xml must be bytestring.'
1706
path = self._basis_inventory_name()
1708
self._control_files.put(path, sio)
1710
def _create_basis_xml_from_inventory(self, revision_id, inventory):
1711
"""Create the text that will be saved in basis-inventory"""
1712
# TODO: jam 20070209 This should be redundant, as the revision_id
1713
# as all callers should have already converted the revision_id to
1715
inventory.revision_id = osutils.safe_revision_id(revision_id)
1716
return xml7.serializer_v7.write_inventory_to_string(inventory)
1718
def _cache_basis_inventory(self, new_revision):
1719
"""Cache new_revision as the basis inventory."""
1720
# TODO: this should allow the ready-to-use inventory to be passed in,
1721
# as commit already has that ready-to-use [while the format is the
1724
# this double handles the inventory - unpack and repack -
1725
# but is easier to understand. We can/should put a conditional
1726
# in here based on whether the inventory is in the latest format
1727
# - perhaps we should repack all inventories on a repository
1729
# the fast path is to copy the raw xml from the repository. If the
1730
# xml contains 'revision_id="', then we assume the right
1731
# revision_id is set. We must check for this full string, because a
1732
# root node id can legitimately look like 'revision_id' but cannot
1734
xml = self.branch.repository.get_inventory_xml(new_revision)
1735
firstline = xml.split('\n', 1)[0]
1736
if (not 'revision_id="' in firstline or
1737
'format="7"' not in firstline):
1738
inv = self.branch.repository.deserialise_inventory(
1740
xml = self._create_basis_xml_from_inventory(new_revision, inv)
1741
self._write_basis_inventory(xml)
1742
except (errors.NoSuchRevision, errors.RevisionNotPresent):
1745
def read_basis_inventory(self):
1746
"""Read the cached basis inventory."""
1747
path = self._basis_inventory_name()
1748
return self._control_files.get(path).read()
1751
def read_working_inventory(self):
1752
"""Read the working inventory.
1754
:raises errors.InventoryModified: read_working_inventory will fail
1755
when the current in memory inventory has been modified.
1757
# conceptually this should be an implementation detail of the tree.
1758
# XXX: Deprecate this.
1759
# ElementTree does its own conversion from UTF-8, so open in
1761
if self._inventory_is_modified:
1762
raise errors.InventoryModified(self)
1763
result = self._deserialize(self._control_files.get('inventory'))
1764
self._set_inventory(result, dirty=False)
1767
@needs_tree_write_lock
1768
def remove(self, files, verbose=False, to_file=None, keep_files=True,
1770
"""Remove nominated files from the working inventory.
1772
:files: File paths relative to the basedir.
1773
:keep_files: If true, the files will also be kept.
1774
:force: Delete files and directories, even if they are changed and
1775
even if the directories are not empty.
1777
## TODO: Normalize names
1779
if isinstance(files, basestring):
1785
unknown_files_in_directory=set()
1787
def recurse_directory_to_add_files(directory):
1788
# recurse directory and add all files
1789
# so we can check if they have changed.
1790
for parent_info, file_infos in\
1791
osutils.walkdirs(self.abspath(directory),
1793
for relpath, basename, kind, lstat, abspath in file_infos:
1795
if self.path2id(relpath): #is it versioned?
1796
new_files.add(relpath)
1798
unknown_files_in_directory.add(
1799
(relpath, None, kind))
1801
for filename in files:
1802
# Get file name into canonical form.
1803
abspath = self.abspath(filename)
1804
filename = self.relpath(abspath)
1805
if len(filename) > 0:
1806
new_files.add(filename)
1807
if osutils.isdir(abspath):
1808
recurse_directory_to_add_files(filename)
1809
files = [f for f in new_files]
1812
return # nothing to do
1814
# Sort needed to first handle directory content before the directory
1815
files.sort(reverse=True)
1816
if not keep_files and not force:
1817
has_changed_files = len(unknown_files_in_directory) > 0
1818
if not has_changed_files:
1819
for (file_id, path, content_change, versioned, parent_id, name,
1820
kind, executable) in self._iter_changes(self.basis_tree(),
1821
include_unchanged=True, require_versioned=False,
1822
want_unversioned=True, specific_files=files):
1823
# check if it's unknown OR changed but not deleted:
1824
if (versioned == (False, False)
1825
or (content_change and kind[1] != None)):
1826
has_changed_files = True
1829
if has_changed_files:
1830
# make delta to show ALL applicable changes in error message.
1831
tree_delta = self.changes_from(self.basis_tree(),
1832
specific_files=files)
1833
for unknown_file in unknown_files_in_directory:
1834
tree_delta.unversioned.extend((unknown_file,))
1835
raise errors.BzrRemoveChangedFilesError(tree_delta)
1837
# do this before any modifications
1839
fid = self.path2id(f)
1842
message="%s is not versioned." % (f,)
1845
# having removed it, it must be either ignored or unknown
1846
if self.is_ignored(f):
1850
textui.show_status(new_status, self.kind(fid), f,
1853
inv_delta.append((f, None, fid, None))
1854
message="removed %s" % (f,)
1857
abs_path = self.abspath(f)
1858
if osutils.lexists(abs_path):
1859
if (osutils.isdir(abs_path) and
1860
len(os.listdir(abs_path)) > 0):
1861
message="%s is not empty directory "\
1862
"and won't be deleted." % (f,)
1864
osutils.delete_any(abs_path)
1865
message="deleted %s" % (f,)
1866
elif message is not None:
1867
# only care if we haven't done anything yet.
1868
message="%s does not exist." % (f,)
1870
# print only one message (if any) per file.
1871
if message is not None:
1873
self.apply_inventory_delta(inv_delta)
1875
@needs_tree_write_lock
1876
def revert(self, filenames, old_tree=None, backups=True,
1877
pb=DummyProgress(), report_changes=False):
1878
from bzrlib.conflicts import resolve
1879
if old_tree is None:
1880
old_tree = self.basis_tree()
1881
conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1883
if not len(filenames):
1884
self.set_parent_ids(self.get_parent_ids()[:1])
1887
resolve(self, filenames, ignore_misses=True)
1890
def revision_tree(self, revision_id):
1891
"""See Tree.revision_tree.
1893
WorkingTree can supply revision_trees for the basis revision only
1894
because there is only one cached inventory in the bzr directory.
1896
if revision_id == self.last_revision():
1898
xml = self.read_basis_inventory()
1899
except errors.NoSuchFile:
1903
inv = xml7.serializer_v7.read_inventory_from_string(xml)
1904
# dont use the repository revision_tree api because we want
1905
# to supply the inventory.
1906
if inv.revision_id == revision_id:
1907
return revisiontree.RevisionTree(self.branch.repository,
1909
except errors.BadInventoryFormat:
1911
# raise if there was no inventory, or if we read the wrong inventory.
1912
raise errors.NoSuchRevisionInTree(self, revision_id)
1914
# XXX: This method should be deprecated in favour of taking in a proper
1915
# new Inventory object.
1916
@needs_tree_write_lock
1917
def set_inventory(self, new_inventory_list):
1918
from bzrlib.inventory import (Inventory,
1923
inv = Inventory(self.get_root_id())
1924
for path, file_id, parent, kind in new_inventory_list:
1925
name = os.path.basename(path)
1928
# fixme, there should be a factory function inv,add_??
1929
if kind == 'directory':
1930
inv.add(InventoryDirectory(file_id, name, parent))
1931
elif kind == 'file':
1932
inv.add(InventoryFile(file_id, name, parent))
1933
elif kind == 'symlink':
1934
inv.add(InventoryLink(file_id, name, parent))
1936
raise errors.BzrError("unknown kind %r" % kind)
1937
self._write_inventory(inv)
1939
@needs_tree_write_lock
1940
def set_root_id(self, file_id):
1941
"""Set the root id for this tree."""
1944
symbol_versioning.warn(symbol_versioning.zero_twelve
1945
% 'WorkingTree.set_root_id with fileid=None',
1950
file_id = osutils.safe_file_id(file_id)
1951
self._set_root_id(file_id)
1953
def _set_root_id(self, file_id):
1954
"""Set the root id for this tree, in a format specific manner.
1956
:param file_id: The file id to assign to the root. It must not be
1957
present in the current inventory or an error will occur. It must
1958
not be None, but rather a valid file id.
1960
inv = self._inventory
1961
orig_root_id = inv.root.file_id
1962
# TODO: it might be nice to exit early if there was nothing
1963
# to do, saving us from trigger a sync on unlock.
1964
self._inventory_is_modified = True
1965
# we preserve the root inventory entry object, but
1966
# unlinkit from the byid index
1967
del inv._byid[inv.root.file_id]
1968
inv.root.file_id = file_id
1969
# and link it into the index with the new changed id.
1970
inv._byid[inv.root.file_id] = inv.root
1971
# and finally update all children to reference the new id.
1972
# XXX: this should be safe to just look at the root.children
1973
# list, not the WHOLE INVENTORY.
1976
if entry.parent_id == orig_root_id:
1977
entry.parent_id = inv.root.file_id
1980
"""See Branch.unlock.
1982
WorkingTree locking just uses the Branch locking facilities.
1983
This is current because all working trees have an embedded branch
1984
within them. IF in the future, we were to make branch data shareable
1985
between multiple working trees, i.e. via shared storage, then we
1986
would probably want to lock both the local tree, and the branch.
1988
raise NotImplementedError(self.unlock)
1990
def update(self, change_reporter=None):
1991
"""Update a working tree along its branch.
1993
This will update the branch if its bound too, which means we have
1994
multiple trees involved:
1996
- The new basis tree of the master.
1997
- The old basis tree of the branch.
1998
- The old basis tree of the working tree.
1999
- The current working tree state.
2001
Pathologically, all three may be different, and non-ancestors of each
2002
other. Conceptually we want to:
2004
- Preserve the wt.basis->wt.state changes
2005
- Transform the wt.basis to the new master basis.
2006
- Apply a merge of the old branch basis to get any 'local' changes from
2008
- Restore the wt.basis->wt.state changes.
2010
There isn't a single operation at the moment to do that, so we:
2011
- Merge current state -> basis tree of the master w.r.t. the old tree
2013
- Do a 'normal' merge of the old branch basis if it is relevant.
2015
if self.branch.get_master_branch() is not None:
2017
update_branch = True
2019
self.lock_tree_write()
2020
update_branch = False
2023
old_tip = self.branch.update()
2026
return self._update_tree(old_tip, change_reporter)
2030
@needs_tree_write_lock
2031
def _update_tree(self, old_tip=None, change_reporter=None):
2032
"""Update a tree to the master branch.
2034
:param old_tip: if supplied, the previous tip revision the branch,
2035
before it was changed to the master branch's tip.
2037
# here if old_tip is not None, it is the old tip of the branch before
2038
# it was updated from the master branch. This should become a pending
2039
# merge in the working tree to preserve the user existing work. we
2040
# cant set that until we update the working trees last revision to be
2041
# one from the new branch, because it will just get absorbed by the
2042
# parent de-duplication logic.
2044
# We MUST save it even if an error occurs, because otherwise the users
2045
# local work is unreferenced and will appear to have been lost.
2049
last_rev = self.get_parent_ids()[0]
2051
last_rev = _mod_revision.NULL_REVISION
2052
if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2053
# merge tree state up to new branch tip.
2054
basis = self.basis_tree()
2057
to_tree = self.branch.basis_tree()
2058
if basis.inventory.root is None:
2059
self.set_root_id(to_tree.inventory.root.file_id)
2061
result += merge.merge_inner(
2066
change_reporter=change_reporter)
2069
# TODO - dedup parents list with things merged by pull ?
2070
# reuse the tree we've updated to to set the basis:
2071
parent_trees = [(self.branch.last_revision(), to_tree)]
2072
merges = self.get_parent_ids()[1:]
2073
# Ideally we ask the tree for the trees here, that way the working
2074
# tree can decide whether to give us teh entire tree or give us a
2075
# lazy initialised tree. dirstate for instance will have the trees
2076
# in ram already, whereas a last-revision + basis-inventory tree
2077
# will not, but also does not need them when setting parents.
2078
for parent in merges:
2079
parent_trees.append(
2080
(parent, self.branch.repository.revision_tree(parent)))
2081
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2082
parent_trees.append(
2083
(old_tip, self.branch.repository.revision_tree(old_tip)))
2084
self.set_parent_trees(parent_trees)
2085
last_rev = parent_trees[0][0]
2087
# the working tree had the same last-revision as the master
2088
# branch did. We may still have pivot local work from the local
2089
# branch into old_tip:
2090
if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2091
self.add_parent_tree_id(old_tip)
2092
if (old_tip is not None and not _mod_revision.is_null(old_tip)
2093
and old_tip != last_rev):
2094
# our last revision was not the prior branch last revision
2095
# and we have converted that last revision to a pending merge.
2096
# base is somewhere between the branch tip now
2097
# and the now pending merge
2099
# Since we just modified the working tree and inventory, flush out
2100
# the current state, before we modify it again.
2101
# TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2102
# requires it only because TreeTransform directly munges the
2103
# inventory and calls tree._write_inventory(). Ultimately we
2104
# should be able to remove this extra flush.
2106
graph = self.branch.repository.get_graph()
2107
base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2109
base_tree = self.branch.repository.revision_tree(base_rev_id)
2110
other_tree = self.branch.repository.revision_tree(old_tip)
2111
result += merge.merge_inner(
2116
change_reporter=change_reporter)
2119
def _write_hashcache_if_dirty(self):
2120
"""Write out the hashcache if it is dirty."""
2121
if self._hashcache.needs_write:
2123
self._hashcache.write()
2125
if e.errno not in (errno.EPERM, errno.EACCES):
2127
# TODO: jam 20061219 Should this be a warning? A single line
2128
# warning might be sufficient to let the user know what
2130
mutter('Could not write hashcache for %s\nError: %s',
2131
self._hashcache.cache_file_name(), e)
2133
@needs_tree_write_lock
2134
def _write_inventory(self, inv):
2135
"""Write inventory as the current inventory."""
2136
self._set_inventory(inv, dirty=True)
2139
def set_conflicts(self, arg):
2140
raise errors.UnsupportedOperation(self.set_conflicts, self)
2142
def add_conflicts(self, arg):
2143
raise errors.UnsupportedOperation(self.add_conflicts, self)
2146
def conflicts(self):
2147
conflicts = _mod_conflicts.ConflictList()
2148
for conflicted in self._iter_conflicts():
2151
if file_kind(self.abspath(conflicted)) != "file":
2153
except errors.NoSuchFile:
2156
for suffix in ('.THIS', '.OTHER'):
2158
kind = file_kind(self.abspath(conflicted+suffix))
2161
except errors.NoSuchFile:
2165
ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2166
conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2168
file_id=self.path2id(conflicted)))
2171
def walkdirs(self, prefix=""):
2172
"""Walk the directories of this tree.
2174
returns a generator which yields items in the form:
2175
((curren_directory_path, fileid),
2176
[(file1_path, file1_name, file1_kind, (lstat), file1_id,
2179
This API returns a generator, which is only valid during the current
2180
tree transaction - within a single lock_read or lock_write duration.
2182
If the tree is not locked, it may cause an error to be raised,
2183
depending on the tree implementation.
2185
disk_top = self.abspath(prefix)
2186
if disk_top.endswith('/'):
2187
disk_top = disk_top[:-1]
2188
top_strip_len = len(disk_top) + 1
2189
inventory_iterator = self._walkdirs(prefix)
2190
disk_iterator = osutils.walkdirs(disk_top, prefix)
2192
current_disk = disk_iterator.next()
2193
disk_finished = False
2195
if not (e.errno == errno.ENOENT or
2196
(sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2199
disk_finished = True
2201
current_inv = inventory_iterator.next()
2202
inv_finished = False
2203
except StopIteration:
2206
while not inv_finished or not disk_finished:
2207
if not disk_finished:
2208
# strip out .bzr dirs
2209
if current_disk[0][1][top_strip_len:] == '':
2210
# osutils.walkdirs can be made nicer -
2211
# yield the path-from-prefix rather than the pathjoined
2213
bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2214
if current_disk[1][bzrdir_loc][0] == '.bzr':
2215
# we dont yield the contents of, or, .bzr itself.
2216
del current_disk[1][bzrdir_loc]
2218
# everything is unknown
2221
# everything is missing
2224
direction = cmp(current_inv[0][0], current_disk[0][0])
2226
# disk is before inventory - unknown
2227
dirblock = [(relpath, basename, kind, stat, None, None) for
2228
relpath, basename, kind, stat, top_path in current_disk[1]]
2229
yield (current_disk[0][0], None), dirblock
2231
current_disk = disk_iterator.next()
2232
except StopIteration:
2233
disk_finished = True
2235
# inventory is before disk - missing.
2236
dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2237
for relpath, basename, dkind, stat, fileid, kind in
2239
yield (current_inv[0][0], current_inv[0][1]), dirblock
2241
current_inv = inventory_iterator.next()
2242
except StopIteration:
2245
# versioned present directory
2246
# merge the inventory and disk data together
2248
for relpath, subiterator in itertools.groupby(sorted(
2249
current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2250
path_elements = list(subiterator)
2251
if len(path_elements) == 2:
2252
inv_row, disk_row = path_elements
2253
# versioned, present file
2254
dirblock.append((inv_row[0],
2255
inv_row[1], disk_row[2],
2256
disk_row[3], inv_row[4],
2258
elif len(path_elements[0]) == 5:
2260
dirblock.append((path_elements[0][0],
2261
path_elements[0][1], path_elements[0][2],
2262
path_elements[0][3], None, None))
2263
elif len(path_elements[0]) == 6:
2264
# versioned, absent file.
2265
dirblock.append((path_elements[0][0],
2266
path_elements[0][1], 'unknown', None,
2267
path_elements[0][4], path_elements[0][5]))
2269
raise NotImplementedError('unreachable code')
2270
yield current_inv[0], dirblock
2272
current_inv = inventory_iterator.next()
2273
except StopIteration:
2276
current_disk = disk_iterator.next()
2277
except StopIteration:
2278
disk_finished = True
2280
def _walkdirs(self, prefix=""):
2281
"""Walk the directories of this tree.
2283
:prefix: is used as the directrory to start with.
2284
returns a generator which yields items in the form:
2285
((curren_directory_path, fileid),
2286
[(file1_path, file1_name, file1_kind, None, file1_id,
2289
_directory = 'directory'
2290
# get the root in the inventory
2291
inv = self.inventory
2292
top_id = inv.path2id(prefix)
2296
pending = [(prefix, '', _directory, None, top_id, None)]
2299
currentdir = pending.pop()
2300
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2301
top_id = currentdir[4]
2303
relroot = currentdir[0] + '/'
2306
# FIXME: stash the node in pending
2308
for name, child in entry.sorted_children():
2309
dirblock.append((relroot + name, name, child.kind, None,
2310
child.file_id, child.kind
2312
yield (currentdir[0], entry.file_id), dirblock
2313
# push the user specified dirs from dirblock
2314
for dir in reversed(dirblock):
2315
if dir[2] == _directory:
2318
@needs_tree_write_lock
2319
def auto_resolve(self):
2320
"""Automatically resolve text conflicts according to contents.
2322
Only text conflicts are auto_resolvable. Files with no conflict markers
2323
are considered 'resolved', because bzr always puts conflict markers
2324
into files that have text conflicts. The corresponding .THIS .BASE and
2325
.OTHER files are deleted, as per 'resolve'.
2326
:return: a tuple of ConflictLists: (un_resolved, resolved).
2328
un_resolved = _mod_conflicts.ConflictList()
2329
resolved = _mod_conflicts.ConflictList()
2330
conflict_re = re.compile('^(<{7}|={7}|>{7})')
2331
for conflict in self.conflicts():
2332
if (conflict.typestring != 'text conflict' or
2333
self.kind(conflict.file_id) != 'file'):
2334
un_resolved.append(conflict)
2336
my_file = open(self.id2abspath(conflict.file_id), 'rb')
2338
for line in my_file:
2339
if conflict_re.search(line):
2340
un_resolved.append(conflict)
2343
resolved.append(conflict)
2346
resolved.remove_files(self)
2347
self.set_conflicts(un_resolved)
2348
return un_resolved, resolved
2350
def _validate(self):
2351
"""Validate internal structures.
2353
This is meant mostly for the test suite. To give it a chance to detect
2354
corruption after actions have occurred. The default implementation is a
2357
:return: None. An exception should be raised if there is an error.
2362
class WorkingTree2(WorkingTree):
2363
"""This is the Format 2 working tree.
2365
This was the first weave based working tree.
2366
- uses os locks for locking.
2367
- uses the branch last-revision.
2370
def __init__(self, *args, **kwargs):
2371
super(WorkingTree2, self).__init__(*args, **kwargs)
2372
# WorkingTree2 has more of a constraint that self._inventory must
2373
# exist. Because this is an older format, we don't mind the overhead
2374
# caused by the extra computation here.
2376
# Newer WorkingTree's should only have self._inventory set when they
2378
if self._inventory is None:
2379
self.read_working_inventory()
2381
def lock_tree_write(self):
2382
"""See WorkingTree.lock_tree_write().
2384
In Format2 WorkingTrees we have a single lock for the branch and tree
2385
so lock_tree_write() degrades to lock_write().
2387
self.branch.lock_write()
2389
return self._control_files.lock_write()
2391
self.branch.unlock()
2395
# we share control files:
2396
if self._control_files._lock_count == 3:
2397
# _inventory_is_modified is always False during a read lock.
2398
if self._inventory_is_modified:
2400
self._write_hashcache_if_dirty()
2402
# reverse order of locking.
2404
return self._control_files.unlock()
2406
self.branch.unlock()
2409
class WorkingTree3(WorkingTree):
2410
"""This is the Format 3 working tree.
2412
This differs from the base WorkingTree by:
2413
- having its own file lock
2414
- having its own last-revision property.
2416
This is new in bzr 0.8
2420
def _last_revision(self):
2421
"""See Mutable.last_revision."""
2423
return osutils.safe_revision_id(
2424
self._control_files.get('last-revision').read())
2425
except errors.NoSuchFile:
2428
def _change_last_revision(self, revision_id):
2429
"""See WorkingTree._change_last_revision."""
2430
if revision_id is None or revision_id == NULL_REVISION:
2432
self._control_files._transport.delete('last-revision')
2433
except errors.NoSuchFile:
2437
self._control_files.put_bytes('last-revision', revision_id)
2440
@needs_tree_write_lock
2441
def set_conflicts(self, conflicts):
2442
self._put_rio('conflicts', conflicts.to_stanzas(),
2445
@needs_tree_write_lock
2446
def add_conflicts(self, new_conflicts):
2447
conflict_set = set(self.conflicts())
2448
conflict_set.update(set(list(new_conflicts)))
2449
self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2450
key=_mod_conflicts.Conflict.sort_key)))
2453
def conflicts(self):
2455
confile = self._control_files.get('conflicts')
2456
except errors.NoSuchFile:
2457
return _mod_conflicts.ConflictList()
2459
if confile.next() != CONFLICT_HEADER_1 + '\n':
2460
raise errors.ConflictFormatError()
2461
except StopIteration:
2462
raise errors.ConflictFormatError()
2463
return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2466
if self._control_files._lock_count == 1:
2467
# _inventory_is_modified is always False during a read lock.
2468
if self._inventory_is_modified:
2470
self._write_hashcache_if_dirty()
2471
# reverse order of locking.
2473
return self._control_files.unlock()
2475
self.branch.unlock()
2478
def get_conflicted_stem(path):
2479
for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2480
if path.endswith(suffix):
2481
return path[:-len(suffix)]
2484
@deprecated_function(zero_eight)
2485
def is_control_file(filename):
2486
"""See WorkingTree.is_control_filename(filename)."""
2487
## FIXME: better check
2488
filename = normpath(filename)
2489
while filename != '':
2490
head, tail = os.path.split(filename)
2491
## mutter('check %r for control file' % ((head, tail),))
2494
if filename == head:
2500
class WorkingTreeFormat(object):
2501
"""An encapsulation of the initialization and open routines for a format.
2503
Formats provide three things:
2504
* An initialization routine,
2508
Formats are placed in an dict by their format string for reference
2509
during workingtree opening. Its not required that these be instances, they
2510
can be classes themselves with class methods - it simply depends on
2511
whether state is needed for a given format or not.
2513
Once a format is deprecated, just deprecate the initialize and open
2514
methods on the format class. Do not deprecate the object, as the
2515
object will be created every time regardless.
2518
_default_format = None
2519
"""The default format used for new trees."""
2522
"""The known formats."""
2524
requires_rich_root = False
2526
upgrade_recommended = False
2529
def find_format(klass, a_bzrdir):
2530
"""Return the format for the working tree object in a_bzrdir."""
2532
transport = a_bzrdir.get_workingtree_transport(None)
2533
format_string = transport.get("format").read()
2534
return klass._formats[format_string]
2535
except errors.NoSuchFile:
2536
raise errors.NoWorkingTree(base=transport.base)
2538
raise errors.UnknownFormatError(format=format_string)
2540
def __eq__(self, other):
2541
return self.__class__ is other.__class__
2543
def __ne__(self, other):
2544
return not (self == other)
2547
def get_default_format(klass):
2548
"""Return the current default format."""
2549
return klass._default_format
2551
def get_format_string(self):
2552
"""Return the ASCII format string that identifies this format."""
2553
raise NotImplementedError(self.get_format_string)
2555
def get_format_description(self):
2556
"""Return the short description for this format."""
2557
raise NotImplementedError(self.get_format_description)
2559
def is_supported(self):
2560
"""Is this format supported?
2562
Supported formats can be initialized and opened.
2563
Unsupported formats may not support initialization or committing or
2564
some other features depending on the reason for not being supported.
2569
def register_format(klass, format):
2570
klass._formats[format.get_format_string()] = format
2573
def set_default_format(klass, format):
2574
klass._default_format = format
2577
def unregister_format(klass, format):
2578
assert klass._formats[format.get_format_string()] is format
2579
del klass._formats[format.get_format_string()]
2582
class WorkingTreeFormat2(WorkingTreeFormat):
2583
"""The second working tree format.
2585
This format modified the hash cache from the format 1 hash cache.
2588
upgrade_recommended = True
2590
def get_format_description(self):
2591
"""See WorkingTreeFormat.get_format_description()."""
2592
return "Working tree format 2"
2594
def stub_initialize_remote(self, control_files):
2595
"""As a special workaround create critical control files for a remote working tree
2597
This ensures that it can later be updated and dealt with locally,
2598
since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2599
no working tree. (See bug #43064).
2603
xml5.serializer_v5.write_inventory(inv, sio)
2605
control_files.put('inventory', sio)
2607
control_files.put_bytes('pending-merges', '')
2610
def initialize(self, a_bzrdir, revision_id=None):
2611
"""See WorkingTreeFormat.initialize()."""
2612
if not isinstance(a_bzrdir.transport, LocalTransport):
2613
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2614
branch = a_bzrdir.open_branch()
2615
if revision_id is None:
2616
revision_id = _mod_revision.ensure_null(branch.last_revision())
2618
revision_id = osutils.safe_revision_id(revision_id)
2621
branch.generate_revision_history(revision_id)
2625
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2631
basis_tree = branch.repository.revision_tree(revision_id)
2632
if basis_tree.inventory.root is not None:
2633
wt.set_root_id(basis_tree.inventory.root.file_id)
2634
# set the parent list and cache the basis tree.
2635
if _mod_revision.is_null(revision_id):
2638
parent_trees = [(revision_id, basis_tree)]
2639
wt.set_parent_trees(parent_trees)
2640
transform.build_tree(basis_tree, wt)
2644
super(WorkingTreeFormat2, self).__init__()
2645
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2647
def open(self, a_bzrdir, _found=False):
2648
"""Return the WorkingTree object for a_bzrdir
2650
_found is a private parameter, do not use it. It is used to indicate
2651
if format probing has already been done.
2654
# we are being called directly and must probe.
2655
raise NotImplementedError
2656
if not isinstance(a_bzrdir.transport, LocalTransport):
2657
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2658
wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2664
class WorkingTreeFormat3(WorkingTreeFormat):
2665
"""The second working tree format updated to record a format marker.
2668
- exists within a metadir controlling .bzr
2669
- includes an explicit version marker for the workingtree control
2670
files, separate from the BzrDir format
2671
- modifies the hash cache format
2673
- uses a LockDir to guard access for writes.
2676
upgrade_recommended = True
2678
def get_format_string(self):
2679
"""See WorkingTreeFormat.get_format_string()."""
2680
return "Bazaar-NG Working Tree format 3"
2682
def get_format_description(self):
2683
"""See WorkingTreeFormat.get_format_description()."""
2684
return "Working tree format 3"
2686
_lock_file_name = 'lock'
2687
_lock_class = LockDir
2689
_tree_class = WorkingTree3
2691
def __get_matchingbzrdir(self):
2692
return bzrdir.BzrDirMetaFormat1()
2694
_matchingbzrdir = property(__get_matchingbzrdir)
2696
def _open_control_files(self, a_bzrdir):
2697
transport = a_bzrdir.get_workingtree_transport(None)
2698
return LockableFiles(transport, self._lock_file_name,
2701
def initialize(self, a_bzrdir, revision_id=None):
2702
"""See WorkingTreeFormat.initialize().
2704
revision_id allows creating a working tree at a different
2705
revision than the branch is at.
2707
if not isinstance(a_bzrdir.transport, LocalTransport):
2708
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2709
transport = a_bzrdir.get_workingtree_transport(self)
2710
control_files = self._open_control_files(a_bzrdir)
2711
control_files.create_lock()
2712
control_files.lock_write()
2713
control_files.put_utf8('format', self.get_format_string())
2714
branch = a_bzrdir.open_branch()
2715
if revision_id is None:
2716
revision_id = _mod_revision.ensure_null(branch.last_revision())
2718
revision_id = osutils.safe_revision_id(revision_id)
2719
# WorkingTree3 can handle an inventory which has a unique root id.
2720
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2721
# those trees. And because there isn't a format bump inbetween, we
2722
# are maintaining compatibility with older clients.
2723
# inv = Inventory(root_id=gen_root_id())
2724
inv = self._initial_inventory()
2725
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2731
_control_files=control_files)
2732
wt.lock_tree_write()
2734
basis_tree = branch.repository.revision_tree(revision_id)
2735
# only set an explicit root id if there is one to set.
2736
if basis_tree.inventory.root is not None:
2737
wt.set_root_id(basis_tree.inventory.root.file_id)
2738
if revision_id == NULL_REVISION:
2739
wt.set_parent_trees([])
2741
wt.set_parent_trees([(revision_id, basis_tree)])
2742
transform.build_tree(basis_tree, wt)
2744
# Unlock in this order so that the unlock-triggers-flush in
2745
# WorkingTree is given a chance to fire.
2746
control_files.unlock()
2750
def _initial_inventory(self):
2754
super(WorkingTreeFormat3, self).__init__()
2756
def open(self, a_bzrdir, _found=False):
2757
"""Return the WorkingTree object for a_bzrdir
2759
_found is a private parameter, do not use it. It is used to indicate
2760
if format probing has already been done.
2763
# we are being called directly and must probe.
2764
raise NotImplementedError
2765
if not isinstance(a_bzrdir.transport, LocalTransport):
2766
raise errors.NotLocalUrl(a_bzrdir.transport.base)
2767
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2770
def _open(self, a_bzrdir, control_files):
2771
"""Open the tree itself.
2773
:param a_bzrdir: the dir for the tree.
2774
:param control_files: the control files for the tree.
2776
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2780
_control_files=control_files)
2783
return self.get_format_string()
2786
__default_format = WorkingTreeFormat4()
2787
WorkingTreeFormat.register_format(__default_format)
2788
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2789
WorkingTreeFormat.set_default_format(__default_format)
2790
# formats which have no format string are not discoverable
2791
# and not independently creatable, so are not registered.
2792
_legacy_formats = [WorkingTreeFormat2(),
added
removed
bzrlib/workingtree.py
