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
from cStringIO import StringIO
 
 
19
from bzrlib.lazy_import import lazy_import
 
 
20
lazy_import(globals(), """
 
 
40
    revision as _mod_revision,
 
 
46
from bzrlib.bundle import serializer
 
 
47
from bzrlib.revisiontree import RevisionTree
 
 
48
from bzrlib.store.versioned import VersionedFileStore
 
 
49
from bzrlib.store.text import TextStore
 
 
50
from bzrlib.testament import Testament
 
 
51
from bzrlib.util import bencode
 
 
54
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
55
from bzrlib.inter import InterObject
 
 
56
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
 
57
from bzrlib.symbol_versioning import (
 
 
60
from bzrlib.trace import mutter, mutter_callsite, note, warning
 
 
63
# Old formats display a warning, but only once
 
 
64
_deprecation_warning_done = False
 
 
67
class CommitBuilder(object):
 
 
68
    """Provides an interface to build up a commit.
 
 
70
    This allows describing a tree to be committed without needing to 
 
 
71
    know the internals of the format of the repository.
 
 
74
    # all clients should supply tree roots.
 
 
75
    record_root_entry = True
 
 
76
    # the default CommitBuilder does not manage trees whose root is versioned.
 
 
77
    _versioned_root = False
 
 
79
    def __init__(self, repository, parents, config, timestamp=None,
 
 
80
                 timezone=None, committer=None, revprops=None,
 
 
82
        """Initiate a CommitBuilder.
 
 
84
        :param repository: Repository to commit to.
 
 
85
        :param parents: Revision ids of the parents of the new revision.
 
 
86
        :param config: Configuration to use.
 
 
87
        :param timestamp: Optional timestamp recorded for commit.
 
 
88
        :param timezone: Optional timezone for timestamp.
 
 
89
        :param committer: Optional committer to set for commit.
 
 
90
        :param revprops: Optional dictionary of revision properties.
 
 
91
        :param revision_id: Optional revision id.
 
 
96
            self._committer = self._config.username()
 
 
98
            assert isinstance(committer, basestring), type(committer)
 
 
99
            self._committer = committer
 
 
101
        self.new_inventory = Inventory(None)
 
 
102
        self._new_revision_id = revision_id
 
 
103
        self.parents = parents
 
 
104
        self.repository = repository
 
 
107
        if revprops is not None:
 
 
108
            self._revprops.update(revprops)
 
 
110
        if timestamp is None:
 
 
111
            timestamp = time.time()
 
 
112
        # Restrict resolution to 1ms
 
 
113
        self._timestamp = round(timestamp, 3)
 
 
116
            self._timezone = osutils.local_time_offset()
 
 
118
            self._timezone = int(timezone)
 
 
120
        self._generate_revision_if_needed()
 
 
121
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
 
123
    def commit(self, message):
 
 
124
        """Make the actual commit.
 
 
126
        :return: The revision id of the recorded revision.
 
 
128
        rev = _mod_revision.Revision(
 
 
129
                       timestamp=self._timestamp,
 
 
130
                       timezone=self._timezone,
 
 
131
                       committer=self._committer,
 
 
133
                       inventory_sha1=self.inv_sha1,
 
 
134
                       revision_id=self._new_revision_id,
 
 
135
                       properties=self._revprops)
 
 
136
        rev.parent_ids = self.parents
 
 
137
        self.repository.add_revision(self._new_revision_id, rev,
 
 
138
            self.new_inventory, self._config)
 
 
139
        self.repository.commit_write_group()
 
 
140
        return self._new_revision_id
 
 
143
        """Abort the commit that is being built.
 
 
145
        self.repository.abort_write_group()
 
 
147
    def revision_tree(self):
 
 
148
        """Return the tree that was just committed.
 
 
150
        After calling commit() this can be called to get a RevisionTree
 
 
151
        representing the newly committed tree. This is preferred to
 
 
152
        calling Repository.revision_tree() because that may require
 
 
153
        deserializing the inventory, while we already have a copy in
 
 
156
        return RevisionTree(self.repository, self.new_inventory,
 
 
157
                            self._new_revision_id)
 
 
159
    def finish_inventory(self):
 
 
160
        """Tell the builder that the inventory is finished."""
 
 
161
        if self.new_inventory.root is None:
 
 
162
            raise AssertionError('Root entry should be supplied to'
 
 
163
                ' record_entry_contents, as of bzr 0.10.',
 
 
164
                 DeprecationWarning, stacklevel=2)
 
 
165
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
 
166
        self.new_inventory.revision_id = self._new_revision_id
 
 
167
        self.inv_sha1 = self.repository.add_inventory(
 
 
168
            self._new_revision_id,
 
 
173
    def _gen_revision_id(self):
 
 
174
        """Return new revision-id."""
 
 
175
        return generate_ids.gen_revision_id(self._config.username(),
 
 
178
    def _generate_revision_if_needed(self):
 
 
179
        """Create a revision id if None was supplied.
 
 
181
        If the repository can not support user-specified revision ids
 
 
182
        they should override this function and raise CannotSetRevisionId
 
 
183
        if _new_revision_id is not None.
 
 
185
        :raises: CannotSetRevisionId
 
 
187
        if self._new_revision_id is None:
 
 
188
            self._new_revision_id = self._gen_revision_id()
 
 
189
            self.random_revid = True
 
 
191
            self.random_revid = False
 
 
193
    def _heads(self, file_id, revision_ids):
 
 
194
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
 
196
        This can use either a per-file graph or a global revision graph as we
 
 
197
        have an identity relationship between the two graphs.
 
 
199
        return self.__heads(revision_ids)
 
 
201
    def _check_root(self, ie, parent_invs, tree):
 
 
202
        """Helper for record_entry_contents.
 
 
204
        :param ie: An entry being added.
 
 
205
        :param parent_invs: The inventories of the parent revisions of the
 
 
207
        :param tree: The tree that is being committed.
 
 
209
        # In this revision format, root entries have no knit or weave When
 
 
210
        # serializing out to disk and back in root.revision is always
 
 
212
        ie.revision = self._new_revision_id
 
 
214
    def _get_delta(self, ie, basis_inv, path):
 
 
215
        """Get a delta against the basis inventory for ie."""
 
 
216
        if ie.file_id not in basis_inv:
 
 
218
            return (None, path, ie.file_id, ie)
 
 
219
        elif ie != basis_inv[ie.file_id]:
 
 
221
            # TODO: avoid tis id2path call.
 
 
222
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
 
227
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
 
229
        """Record the content of ie from tree into the commit if needed.
 
 
231
        Side effect: sets ie.revision when unchanged
 
 
233
        :param ie: An inventory entry present in the commit.
 
 
234
        :param parent_invs: The inventories of the parent revisions of the
 
 
236
        :param path: The path the entry is at in the tree.
 
 
237
        :param tree: The tree which contains this entry and should be used to 
 
 
239
        :param content_summary: Summary data from the tree about the paths
 
 
240
            content - stat, length, exec, sha/link target. This is only
 
 
241
            accessed when the entry has a revision of None - that is when it is
 
 
242
            a candidate to commit.
 
 
243
        :return: A tuple (change_delta, version_recorded). change_delta is 
 
 
244
            an inventory_delta change for this entry against the basis tree of
 
 
245
            the commit, or None if no change occured against the basis tree.
 
 
246
            version_recorded is True if a new version of the entry has been
 
 
247
            recorded. For instance, committing a merge where a file was only
 
 
248
            changed on the other side will return (delta, False).
 
 
250
        if self.new_inventory.root is None:
 
 
251
            if ie.parent_id is not None:
 
 
252
                raise errors.RootMissing()
 
 
253
            self._check_root(ie, parent_invs, tree)
 
 
254
        if ie.revision is None:
 
 
255
            kind = content_summary[0]
 
 
257
            # ie is carried over from a prior commit
 
 
259
        # XXX: repository specific check for nested tree support goes here - if
 
 
260
        # the repo doesn't want nested trees we skip it ?
 
 
261
        if (kind == 'tree-reference' and
 
 
262
            not self.repository._format.supports_tree_reference):
 
 
263
            # mismatch between commit builder logic and repository:
 
 
264
            # this needs the entry creation pushed down into the builder.
 
 
265
            raise NotImplementedError('Missing repository subtree support.')
 
 
266
        self.new_inventory.add(ie)
 
 
268
        # TODO: slow, take it out of the inner loop.
 
 
270
            basis_inv = parent_invs[0]
 
 
272
            basis_inv = Inventory(root_id=None)
 
 
274
        # ie.revision is always None if the InventoryEntry is considered
 
 
275
        # for committing. We may record the previous parents revision if the
 
 
276
        # content is actually unchanged against a sole head.
 
 
277
        if ie.revision is not None:
 
 
278
            if not self._versioned_root and path == '':
 
 
279
                # repositories that do not version the root set the root's
 
 
280
                # revision to the new commit even when no change occurs, and
 
 
281
                # this masks when a change may have occurred against the basis,
 
 
282
                # so calculate if one happened.
 
 
283
                if ie.file_id in basis_inv:
 
 
284
                    delta = (basis_inv.id2path(ie.file_id), path,
 
 
288
                    delta = (None, path, ie.file_id, ie)
 
 
291
                # we don't need to commit this, because the caller already
 
 
292
                # determined that an existing revision of this file is
 
 
294
                return None, (ie.revision == self._new_revision_id)
 
 
295
        # XXX: Friction: parent_candidates should return a list not a dict
 
 
296
        #      so that we don't have to walk the inventories again.
 
 
297
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
 
298
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
 
300
        for inv in parent_invs:
 
 
301
            if ie.file_id in inv:
 
 
302
                old_rev = inv[ie.file_id].revision
 
 
303
                if old_rev in head_set:
 
 
304
                    heads.append(inv[ie.file_id].revision)
 
 
305
                    head_set.remove(inv[ie.file_id].revision)
 
 
308
        # now we check to see if we need to write a new record to the
 
 
310
        # We write a new entry unless there is one head to the ancestors, and
 
 
311
        # the kind-derived content is unchanged.
 
 
313
        # Cheapest check first: no ancestors, or more the one head in the
 
 
314
        # ancestors, we write a new node.
 
 
318
            # There is a single head, look it up for comparison
 
 
319
            parent_entry = parent_candiate_entries[heads[0]]
 
 
320
            # if the non-content specific data has changed, we'll be writing a
 
 
322
            if (parent_entry.parent_id != ie.parent_id or
 
 
323
                parent_entry.name != ie.name):
 
 
325
        # now we need to do content specific checks:
 
 
327
            # if the kind changed the content obviously has
 
 
328
            if kind != parent_entry.kind:
 
 
331
            assert content_summary[2] is not None, \
 
 
332
                "Files must not have executable = None"
 
 
334
                if (# if the file length changed we have to store:
 
 
335
                    parent_entry.text_size != content_summary[1] or
 
 
336
                    # if the exec bit has changed we have to store:
 
 
337
                    parent_entry.executable != content_summary[2]):
 
 
339
                elif parent_entry.text_sha1 == content_summary[3]:
 
 
340
                    # all meta and content is unchanged (using a hash cache
 
 
341
                    # hit to check the sha)
 
 
342
                    ie.revision = parent_entry.revision
 
 
343
                    ie.text_size = parent_entry.text_size
 
 
344
                    ie.text_sha1 = parent_entry.text_sha1
 
 
345
                    ie.executable = parent_entry.executable
 
 
346
                    return self._get_delta(ie, basis_inv, path), False
 
 
348
                    # Either there is only a hash change(no hash cache entry,
 
 
349
                    # or same size content change), or there is no change on
 
 
351
                    # Provide the parent's hash to the store layer, so that the
 
 
352
                    # content is unchanged we will not store a new node.
 
 
353
                    nostore_sha = parent_entry.text_sha1
 
 
355
                # We want to record a new node regardless of the presence or
 
 
356
                # absence of a content change in the file.
 
 
358
            ie.executable = content_summary[2]
 
 
359
            lines = tree.get_file(ie.file_id, path).readlines()
 
 
361
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
 
362
                    ie.file_id, lines, heads, nostore_sha)
 
 
363
            except errors.ExistingContent:
 
 
364
                # Turns out that the file content was unchanged, and we were
 
 
365
                # only going to store a new node if it was changed. Carry over
 
 
367
                ie.revision = parent_entry.revision
 
 
368
                ie.text_size = parent_entry.text_size
 
 
369
                ie.text_sha1 = parent_entry.text_sha1
 
 
370
                ie.executable = parent_entry.executable
 
 
371
                return self._get_delta(ie, basis_inv, path), False
 
 
372
        elif kind == 'directory':
 
 
374
                # all data is meta here, nothing specific to directory, so
 
 
376
                ie.revision = parent_entry.revision
 
 
377
                return self._get_delta(ie, basis_inv, path), False
 
 
379
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
 
380
        elif kind == 'symlink':
 
 
381
            current_link_target = content_summary[3]
 
 
383
                # symlink target is not generic metadata, check if it has
 
 
385
                if current_link_target != parent_entry.symlink_target:
 
 
388
                # unchanged, carry over.
 
 
389
                ie.revision = parent_entry.revision
 
 
390
                ie.symlink_target = parent_entry.symlink_target
 
 
391
                return self._get_delta(ie, basis_inv, path), False
 
 
392
            ie.symlink_target = current_link_target
 
 
394
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
 
395
        elif kind == 'tree-reference':
 
 
397
                if content_summary[3] != parent_entry.reference_revision:
 
 
400
                # unchanged, carry over.
 
 
401
                ie.reference_revision = parent_entry.reference_revision
 
 
402
                ie.revision = parent_entry.revision
 
 
403
                return self._get_delta(ie, basis_inv, path), False
 
 
404
            ie.reference_revision = content_summary[3]
 
 
406
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
 
408
            raise NotImplementedError('unknown kind')
 
 
409
        ie.revision = self._new_revision_id
 
 
410
        return self._get_delta(ie, basis_inv, path), True
 
 
412
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
 
413
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
 
414
            file_id, self.repository.get_transaction())
 
 
415
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
 
416
        # than add_lines, and allows committing when a parent is ghosted for
 
 
418
        # Note: as we read the content directly from the tree, we know its not
 
 
419
        # been turned into unicode or badly split - but a broken tree
 
 
420
        # implementation could give us bad output from readlines() so this is
 
 
421
        # not a guarantee of safety. What would be better is always checking
 
 
422
        # the content during test suite execution. RBC 20070912
 
 
424
            return versionedfile.add_lines_with_ghosts(
 
 
425
                self._new_revision_id, parents, new_lines,
 
 
426
                nostore_sha=nostore_sha, random_id=self.random_revid,
 
 
427
                check_content=False)[0:2]
 
 
429
            versionedfile.clear_cache()
 
 
432
class RootCommitBuilder(CommitBuilder):
 
 
433
    """This commitbuilder actually records the root id"""
 
 
435
    # the root entry gets versioned properly by this builder.
 
 
436
    _versioned_root = True
 
 
438
    def _check_root(self, ie, parent_invs, tree):
 
 
439
        """Helper for record_entry_contents.
 
 
441
        :param ie: An entry being added.
 
 
442
        :param parent_invs: The inventories of the parent revisions of the
 
 
444
        :param tree: The tree that is being committed.
 
 
448
######################################################################
 
 
451
class Repository(object):
 
 
452
    """Repository holding history for one or more branches.
 
 
454
    The repository holds and retrieves historical information including
 
 
455
    revisions and file history.  It's normally accessed only by the Branch,
 
 
456
    which views a particular line of development through that history.
 
 
458
    The Repository builds on top of Stores and a Transport, which respectively 
 
 
459
    describe the disk data format and the way of accessing the (possibly 
 
 
463
    # What class to use for a CommitBuilder. Often its simpler to change this
 
 
464
    # in a Repository class subclass rather than to override
 
 
465
    # get_commit_builder.
 
 
466
    _commit_builder_class = CommitBuilder
 
 
467
    # The search regex used by xml based repositories to determine what things
 
 
468
    # where changed in a single commit.
 
 
469
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
 
470
        r'file_id="(?P<file_id>[^"]+)"'
 
 
471
        r'.* revision="(?P<revision_id>[^"]+)"'
 
 
474
    def abort_write_group(self):
 
 
475
        """Commit the contents accrued within the current write group.
 
 
477
        :seealso: start_write_group.
 
 
479
        if self._write_group is not self.get_transaction():
 
 
480
            # has an unlock or relock occured ?
 
 
481
            raise errors.BzrError('mismatched lock context and write group.')
 
 
482
        self._abort_write_group()
 
 
483
        self._write_group = None
 
 
485
    def _abort_write_group(self):
 
 
486
        """Template method for per-repository write group cleanup.
 
 
488
        This is called during abort before the write group is considered to be 
 
 
489
        finished and should cleanup any internal state accrued during the write
 
 
490
        group. There is no requirement that data handed to the repository be
 
 
491
        *not* made available - this is not a rollback - but neither should any
 
 
492
        attempt be made to ensure that data added is fully commited. Abort is
 
 
493
        invoked when an error has occured so futher disk or network operations
 
 
494
        may not be possible or may error and if possible should not be
 
 
498
    def add_inventory(self, revision_id, inv, parents):
 
 
499
        """Add the inventory inv to the repository as revision_id.
 
 
501
        :param parents: The revision ids of the parents that revision_id
 
 
502
                        is known to have and are in the repository already.
 
 
504
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
 
505
            repository format specific) of the serialized inventory.
 
 
507
        assert self.is_in_write_group()
 
 
508
        _mod_revision.check_not_reserved_id(revision_id)
 
 
509
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
 
510
            "Mismatch between inventory revision" \
 
 
511
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
 
512
        assert inv.root is not None
 
 
513
        inv_lines = self._serialise_inventory_to_lines(inv)
 
 
514
        inv_vf = self.get_inventory_weave()
 
 
515
        return self._inventory_add_lines(inv_vf, revision_id, parents,
 
 
516
            inv_lines, check_content=False)
 
 
518
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
 
 
520
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
 
522
        for parent in parents:
 
 
524
                final_parents.append(parent)
 
 
525
        return inv_vf.add_lines(revision_id, final_parents, lines,
 
 
526
            check_content=check_content)[0]
 
 
528
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
 
529
        """Add rev to the revision store as revision_id.
 
 
531
        :param revision_id: the revision id to use.
 
 
532
        :param rev: The revision object.
 
 
533
        :param inv: The inventory for the revision. if None, it will be looked
 
 
534
                    up in the inventory storer
 
 
535
        :param config: If None no digital signature will be created.
 
 
536
                       If supplied its signature_needed method will be used
 
 
537
                       to determine if a signature should be made.
 
 
539
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
 
541
        _mod_revision.check_not_reserved_id(revision_id)
 
 
542
        if config is not None and config.signature_needed():
 
 
544
                inv = self.get_inventory(revision_id)
 
 
545
            plaintext = Testament(rev, inv).as_short_text()
 
 
546
            self.store_revision_signature(
 
 
547
                gpg.GPGStrategy(config), plaintext, revision_id)
 
 
548
        if not revision_id in self.get_inventory_weave():
 
 
550
                raise errors.WeaveRevisionNotPresent(revision_id,
 
 
551
                                                     self.get_inventory_weave())
 
 
553
                # yes, this is not suitable for adding with ghosts.
 
 
554
                self.add_inventory(revision_id, inv, rev.parent_ids)
 
 
555
        self._revision_store.add_revision(rev, self.get_transaction())
 
 
557
    def _add_revision_text(self, revision_id, text):
 
 
558
        revision = self._revision_store._serializer.read_revision_from_string(
 
 
560
        self._revision_store._add_revision(revision, StringIO(text),
 
 
561
                                           self.get_transaction())
 
 
563
    def all_revision_ids(self):
 
 
564
        """Returns a list of all the revision ids in the repository. 
 
 
566
        This is deprecated because code should generally work on the graph
 
 
567
        reachable from a particular revision, and ignore any other revisions
 
 
568
        that might be present.  There is no direct replacement method.
 
 
570
        if 'evil' in debug.debug_flags:
 
 
571
            mutter_callsite(2, "all_revision_ids is linear with history.")
 
 
572
        return self._all_revision_ids()
 
 
574
    def _all_revision_ids(self):
 
 
575
        """Returns a list of all the revision ids in the repository. 
 
 
577
        These are in as much topological order as the underlying store can 
 
 
580
        raise NotImplementedError(self._all_revision_ids)
 
 
582
    def break_lock(self):
 
 
583
        """Break a lock if one is present from another instance.
 
 
585
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
588
        self.control_files.break_lock()
 
 
591
    def _eliminate_revisions_not_present(self, revision_ids):
 
 
592
        """Check every revision id in revision_ids to see if we have it.
 
 
594
        Returns a set of the present revisions.
 
 
597
        for id in revision_ids:
 
 
598
            if self.has_revision(id):
 
 
603
    def create(a_bzrdir):
 
 
604
        """Construct the current default format repository in a_bzrdir."""
 
 
605
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
 
 
607
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
 
608
        """instantiate a Repository.
 
 
610
        :param _format: The format of the repository on disk.
 
 
611
        :param a_bzrdir: The BzrDir of the repository.
 
 
613
        In the future we will have a single api for all stores for
 
 
614
        getting file texts, inventories and revisions, then
 
 
615
        this construct will accept instances of those things.
 
 
617
        super(Repository, self).__init__()
 
 
618
        self._format = _format
 
 
619
        # the following are part of the public API for Repository:
 
 
620
        self.bzrdir = a_bzrdir
 
 
621
        self.control_files = control_files
 
 
622
        self._revision_store = _revision_store
 
 
623
        # backwards compatibility
 
 
624
        self.weave_store = text_store
 
 
626
        self._reconcile_does_inventory_gc = True
 
 
627
        self._reconcile_fixes_text_parents = False
 
 
628
        self._reconcile_backsup_inventory = True
 
 
629
        # not right yet - should be more semantically clear ? 
 
 
631
        self.control_store = control_store
 
 
632
        self.control_weaves = control_store
 
 
633
        # TODO: make sure to construct the right store classes, etc, depending
 
 
634
        # on whether escaping is required.
 
 
635
        self._warn_if_deprecated()
 
 
636
        self._write_group = None
 
 
637
        self.base = control_files._transport.base
 
 
640
        return '%s(%r)' % (self.__class__.__name__,
 
 
643
    def has_same_location(self, other):
 
 
644
        """Returns a boolean indicating if this repository is at the same
 
 
645
        location as another repository.
 
 
647
        This might return False even when two repository objects are accessing
 
 
648
        the same physical repository via different URLs.
 
 
650
        if self.__class__ is not other.__class__:
 
 
652
        return (self.control_files._transport.base ==
 
 
653
                other.control_files._transport.base)
 
 
655
    def is_in_write_group(self):
 
 
656
        """Return True if there is an open write group.
 
 
658
        :seealso: start_write_group.
 
 
660
        return self._write_group is not None
 
 
663
        return self.control_files.is_locked()
 
 
665
    def is_write_locked(self):
 
 
666
        """Return True if this object is write locked."""
 
 
667
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
 
669
    def lock_write(self, token=None):
 
 
670
        """Lock this repository for writing.
 
 
672
        This causes caching within the repository obejct to start accumlating
 
 
673
        data during reads, and allows a 'write_group' to be obtained. Write
 
 
674
        groups must be used for actual data insertion.
 
 
676
        :param token: if this is already locked, then lock_write will fail
 
 
677
            unless the token matches the existing lock.
 
 
678
        :returns: a token if this instance supports tokens, otherwise None.
 
 
679
        :raises TokenLockingNotSupported: when a token is given but this
 
 
680
            instance doesn't support using token locks.
 
 
681
        :raises MismatchedToken: if the specified token doesn't match the token
 
 
682
            of the existing lock.
 
 
683
        :seealso: start_write_group.
 
 
685
        A token should be passed in if you know that you have locked the object
 
 
686
        some other way, and need to synchronise this object's state with that
 
 
689
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
 
691
        result = self.control_files.lock_write(token=token)
 
 
696
        self.control_files.lock_read()
 
 
699
    def get_physical_lock_status(self):
 
 
700
        return self.control_files.get_physical_lock_status()
 
 
702
    def leave_lock_in_place(self):
 
 
703
        """Tell this repository not to release the physical lock when this
 
 
706
        If lock_write doesn't return a token, then this method is not supported.
 
 
708
        self.control_files.leave_in_place()
 
 
710
    def dont_leave_lock_in_place(self):
 
 
711
        """Tell this repository to release the physical lock when this
 
 
712
        object is unlocked, even if it didn't originally acquire it.
 
 
714
        If lock_write doesn't return a token, then this method is not supported.
 
 
716
        self.control_files.dont_leave_in_place()
 
 
719
    def gather_stats(self, revid=None, committers=None):
 
 
720
        """Gather statistics from a revision id.
 
 
722
        :param revid: The revision id to gather statistics from, if None, then
 
 
723
            no revision specific statistics are gathered.
 
 
724
        :param committers: Optional parameter controlling whether to grab
 
 
725
            a count of committers from the revision specific statistics.
 
 
726
        :return: A dictionary of statistics. Currently this contains:
 
 
727
            committers: The number of committers if requested.
 
 
728
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
 
729
                most ancestor of revid, if revid is not the NULL_REVISION.
 
 
730
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
 
731
                not the NULL_REVISION.
 
 
732
            revisions: The total revision count in the repository.
 
 
733
            size: An estimate disk size of the repository in bytes.
 
 
736
        if revid and committers:
 
 
737
            result['committers'] = 0
 
 
738
        if revid and revid != _mod_revision.NULL_REVISION:
 
 
740
                all_committers = set()
 
 
741
            revisions = self.get_ancestry(revid)
 
 
742
            # pop the leading None
 
 
744
            first_revision = None
 
 
746
                # ignore the revisions in the middle - just grab first and last
 
 
747
                revisions = revisions[0], revisions[-1]
 
 
748
            for revision in self.get_revisions(revisions):
 
 
749
                if not first_revision:
 
 
750
                    first_revision = revision
 
 
752
                    all_committers.add(revision.committer)
 
 
753
            last_revision = revision
 
 
755
                result['committers'] = len(all_committers)
 
 
756
            result['firstrev'] = (first_revision.timestamp,
 
 
757
                first_revision.timezone)
 
 
758
            result['latestrev'] = (last_revision.timestamp,
 
 
759
                last_revision.timezone)
 
 
761
        # now gather global repository information
 
 
762
        if self.bzrdir.root_transport.listable():
 
 
763
            c, t = self._revision_store.total_size(self.get_transaction())
 
 
764
            result['revisions'] = c
 
 
768
    def find_branches(self, using=False):
 
 
769
        """Find branches underneath this repository.
 
 
771
        This will include branches inside other branches.
 
 
773
        :param using: If True, list only branches using this repository.
 
 
775
        if using and not self.is_shared():
 
 
777
                return [self.bzrdir.open_branch()]
 
 
778
            except errors.NotBranchError:
 
 
780
        class Evaluator(object):
 
 
783
                self.first_call = True
 
 
785
            def __call__(self, bzrdir):
 
 
786
                # On the first call, the parameter is always the bzrdir
 
 
787
                # containing the current repo.
 
 
788
                if not self.first_call:
 
 
790
                        repository = bzrdir.open_repository()
 
 
791
                    except errors.NoRepositoryPresent:
 
 
794
                        return False, (None, repository)
 
 
795
                self.first_call = False
 
 
797
                    value = (bzrdir.open_branch(), None)
 
 
798
                except errors.NotBranchError:
 
 
803
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
 
804
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
 
805
            if branch is not None:
 
 
806
                branches.append(branch)
 
 
807
            if not using and repository is not None:
 
 
808
                branches.extend(repository.find_branches())
 
 
811
    def get_data_stream(self, revision_ids):
 
 
812
        raise NotImplementedError(self.get_data_stream)
 
 
814
    def get_data_stream_for_search(self, search_result):
 
 
815
        """Get a data stream that can be inserted to a repository.
 
 
817
        :param search_result: A bzrlib.graph.SearchResult selecting the
 
 
819
        :return: A data stream that can be inserted into a repository using
 
 
822
        raise NotImplementedError(self.get_data_stream_for_search)
 
 
824
    def insert_data_stream(self, stream):
 
 
825
        """XXX What does this really do? 
 
 
827
        Is it a substitute for fetch? 
 
 
828
        Should it manage its own write group ?
 
 
830
        for item_key, bytes in stream:
 
 
831
            if item_key[0] == 'file':
 
 
832
                (file_id,) = item_key[1:]
 
 
833
                knit = self.weave_store.get_weave_or_empty(
 
 
834
                    file_id, self.get_transaction())
 
 
835
            elif item_key == ('inventory',):
 
 
836
                knit = self.get_inventory_weave()
 
 
837
            elif item_key == ('revisions',):
 
 
838
                knit = self._revision_store.get_revision_file(
 
 
839
                    self.get_transaction())
 
 
840
            elif item_key == ('signatures',):
 
 
841
                knit = self._revision_store.get_signature_file(
 
 
842
                    self.get_transaction())
 
 
844
                raise errors.RepositoryDataStreamError(
 
 
845
                    "Unrecognised data stream key '%s'" % (item_key,))
 
 
846
            decoded_list = bencode.bdecode(bytes)
 
 
847
            format = decoded_list.pop(0)
 
 
850
            for version, options, parents, some_bytes in decoded_list:
 
 
851
                data_list.append((version, options, len(some_bytes), parents))
 
 
852
                knit_bytes += some_bytes
 
 
853
            buffer = StringIO(knit_bytes)
 
 
854
            def reader_func(count):
 
 
858
                    return buffer.read(count)
 
 
859
            knit.insert_data_stream(
 
 
860
                (format, data_list, reader_func))
 
 
863
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
 
864
        """Return the revision ids that other has that this does not.
 
 
866
        These are returned in topological order.
 
 
868
        revision_id: only return revision ids included by revision_id.
 
 
870
        return InterRepository.get(other, self).search_missing_revision_ids(
 
 
871
            revision_id, find_ghosts)
 
 
873
    @deprecated_method(symbol_versioning.one_two)
 
 
875
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
 
876
        """Return the revision ids that other has that this does not.
 
 
878
        These are returned in topological order.
 
 
880
        revision_id: only return revision ids included by revision_id.
 
 
882
        keys =  self.search_missing_revision_ids(
 
 
883
            other, revision_id, find_ghosts).get_keys()
 
 
886
            parents = other.get_graph().get_parent_map(keys)
 
 
889
        return tsort.topo_sort(parents)
 
 
893
        """Open the repository rooted at base.
 
 
895
        For instance, if the repository is at URL/.bzr/repository,
 
 
896
        Repository.open(URL) -> a Repository instance.
 
 
898
        control = bzrdir.BzrDir.open(base)
 
 
899
        return control.open_repository()
 
 
901
    def copy_content_into(self, destination, revision_id=None):
 
 
902
        """Make a complete copy of the content in self into destination.
 
 
904
        This is a destructive operation! Do not use it on existing 
 
 
907
        return InterRepository.get(self, destination).copy_content(revision_id)
 
 
909
    def commit_write_group(self):
 
 
910
        """Commit the contents accrued within the current write group.
 
 
912
        :seealso: start_write_group.
 
 
914
        if self._write_group is not self.get_transaction():
 
 
915
            # has an unlock or relock occured ?
 
 
916
            raise errors.BzrError('mismatched lock context %r and '
 
 
918
                (self.get_transaction(), self._write_group))
 
 
919
        self._commit_write_group()
 
 
920
        self._write_group = None
 
 
922
    def _commit_write_group(self):
 
 
923
        """Template method for per-repository write group cleanup.
 
 
925
        This is called before the write group is considered to be 
 
 
926
        finished and should ensure that all data handed to the repository
 
 
927
        for writing during the write group is safely committed (to the 
 
 
928
        extent possible considering file system caching etc).
 
 
931
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
 
932
        """Fetch the content required to construct revision_id from source.
 
 
934
        If revision_id is None all content is copied.
 
 
935
        :param find_ghosts: Find and copy revisions in the source that are
 
 
936
            ghosts in the target (and not reachable directly by walking out to
 
 
937
            the first-present revision in target from revision_id).
 
 
939
        # fast path same-url fetch operations
 
 
940
        if self.has_same_location(source):
 
 
941
            # check that last_revision is in 'from' and then return a
 
 
943
            if (revision_id is not None and
 
 
944
                not _mod_revision.is_null(revision_id)):
 
 
945
                self.get_revision(revision_id)
 
 
947
        inter = InterRepository.get(source, self)
 
 
949
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
 
950
        except NotImplementedError:
 
 
951
            raise errors.IncompatibleRepositories(source, self)
 
 
953
    def create_bundle(self, target, base, fileobj, format=None):
 
 
954
        return serializer.write_bundle(self, target, base, fileobj, format)
 
 
956
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
 
957
                           timezone=None, committer=None, revprops=None,
 
 
959
        """Obtain a CommitBuilder for this repository.
 
 
961
        :param branch: Branch to commit to.
 
 
962
        :param parents: Revision ids of the parents of the new revision.
 
 
963
        :param config: Configuration to use.
 
 
964
        :param timestamp: Optional timestamp recorded for commit.
 
 
965
        :param timezone: Optional timezone for timestamp.
 
 
966
        :param committer: Optional committer to set for commit.
 
 
967
        :param revprops: Optional dictionary of revision properties.
 
 
968
        :param revision_id: Optional revision id.
 
 
970
        result = self._commit_builder_class(self, parents, config,
 
 
971
            timestamp, timezone, committer, revprops, revision_id)
 
 
972
        self.start_write_group()
 
 
976
        if (self.control_files._lock_count == 1 and
 
 
977
            self.control_files._lock_mode == 'w'):
 
 
978
            if self._write_group is not None:
 
 
979
                self.abort_write_group()
 
 
980
                self.control_files.unlock()
 
 
981
                raise errors.BzrError(
 
 
982
                    'Must end write groups before releasing write locks.')
 
 
983
        self.control_files.unlock()
 
 
986
    def clone(self, a_bzrdir, revision_id=None):
 
 
987
        """Clone this repository into a_bzrdir using the current format.
 
 
989
        Currently no check is made that the format of this repository and
 
 
990
        the bzrdir format are compatible. FIXME RBC 20060201.
 
 
992
        :return: The newly created destination repository.
 
 
994
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
 
995
        # probably not very useful -- mbp 20070423
 
 
996
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
 
997
        self.copy_content_into(dest_repo, revision_id)
 
 
1000
    def start_write_group(self):
 
 
1001
        """Start a write group in the repository.
 
 
1003
        Write groups are used by repositories which do not have a 1:1 mapping
 
 
1004
        between file ids and backend store to manage the insertion of data from
 
 
1005
        both fetch and commit operations.
 
 
1007
        A write lock is required around the start_write_group/commit_write_group
 
 
1008
        for the support of lock-requiring repository formats.
 
 
1010
        One can only insert data into a repository inside a write group.
 
 
1014
        if not self.is_write_locked():
 
 
1015
            raise errors.NotWriteLocked(self)
 
 
1016
        if self._write_group:
 
 
1017
            raise errors.BzrError('already in a write group')
 
 
1018
        self._start_write_group()
 
 
1019
        # so we can detect unlock/relock - the write group is now entered.
 
 
1020
        self._write_group = self.get_transaction()
 
 
1022
    def _start_write_group(self):
 
 
1023
        """Template method for per-repository write group startup.
 
 
1025
        This is called before the write group is considered to be 
 
 
1030
    def sprout(self, to_bzrdir, revision_id=None):
 
 
1031
        """Create a descendent repository for new development.
 
 
1033
        Unlike clone, this does not copy the settings of the repository.
 
 
1035
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
 
1036
        dest_repo.fetch(self, revision_id=revision_id)
 
 
1039
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
 
1040
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
 
1041
            # use target default format.
 
 
1042
            dest_repo = a_bzrdir.create_repository()
 
 
1044
            # Most control formats need the repository to be specifically
 
 
1045
            # created, but on some old all-in-one formats it's not needed
 
 
1047
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
 
1048
            except errors.UninitializableFormat:
 
 
1049
                dest_repo = a_bzrdir.open_repository()
 
 
1053
    def has_revision(self, revision_id):
 
 
1054
        """True if this repository has a copy of the revision."""
 
 
1055
        return revision_id in self.has_revisions((revision_id,))
 
 
1057
    def has_revisions(self, revision_ids):
 
 
1058
        """Probe to find out the presence of multiple revisions.
 
 
1060
        :param revision_ids: An iterable of revision_ids.
 
 
1061
        :return: A set of the revision_ids that were present.
 
 
1063
        raise NotImplementedError(self.has_revisions)
 
 
1065
        return self._revision_store.has_revision_id(revision_id,
 
 
1066
                                                    self.get_transaction())
 
 
1069
    def get_revision(self, revision_id):
 
 
1070
        """Return the Revision object for a named revision."""
 
 
1071
        return self.get_revisions([revision_id])[0]
 
 
1074
    def get_revision_reconcile(self, revision_id):
 
 
1075
        """'reconcile' helper routine that allows access to a revision always.
 
 
1077
        This variant of get_revision does not cross check the weave graph
 
 
1078
        against the revision one as get_revision does: but it should only
 
 
1079
        be used by reconcile, or reconcile-alike commands that are correcting
 
 
1080
        or testing the revision graph.
 
 
1082
        return self._get_revisions([revision_id])[0]
 
 
1085
    def get_revisions(self, revision_ids):
 
 
1086
        """Get many revisions at once."""
 
 
1087
        return self._get_revisions(revision_ids)
 
 
1090
    def _get_revisions(self, revision_ids):
 
 
1091
        """Core work logic to get many revisions without sanity checks."""
 
 
1092
        for rev_id in revision_ids:
 
 
1093
            if not rev_id or not isinstance(rev_id, basestring):
 
 
1094
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
 
1095
        revs = self._revision_store.get_revisions(revision_ids,
 
 
1096
                                                  self.get_transaction())
 
 
1098
            assert not isinstance(rev.revision_id, unicode)
 
 
1099
            for parent_id in rev.parent_ids:
 
 
1100
                assert not isinstance(parent_id, unicode)
 
 
1104
    def get_revision_xml(self, revision_id):
 
 
1105
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
 
1106
        #       would have already do it.
 
 
1107
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
 
1108
        rev = self.get_revision(revision_id)
 
 
1109
        rev_tmp = StringIO()
 
 
1110
        # the current serializer..
 
 
1111
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
 
1113
        return rev_tmp.getvalue()
 
 
1116
    def get_deltas_for_revisions(self, revisions):
 
 
1117
        """Produce a generator of revision deltas.
 
 
1119
        Note that the input is a sequence of REVISIONS, not revision_ids.
 
 
1120
        Trees will be held in memory until the generator exits.
 
 
1121
        Each delta is relative to the revision's lefthand predecessor.
 
 
1123
        required_trees = set()
 
 
1124
        for revision in revisions:
 
 
1125
            required_trees.add(revision.revision_id)
 
 
1126
            required_trees.update(revision.parent_ids[:1])
 
 
1127
        trees = dict((t.get_revision_id(), t) for 
 
 
1128
                     t in self.revision_trees(required_trees))
 
 
1129
        for revision in revisions:
 
 
1130
            if not revision.parent_ids:
 
 
1131
                old_tree = self.revision_tree(None)
 
 
1133
                old_tree = trees[revision.parent_ids[0]]
 
 
1134
            yield trees[revision.revision_id].changes_from(old_tree)
 
 
1137
    def get_revision_delta(self, revision_id):
 
 
1138
        """Return the delta for one revision.
 
 
1140
        The delta is relative to the left-hand predecessor of the
 
 
1143
        r = self.get_revision(revision_id)
 
 
1144
        return list(self.get_deltas_for_revisions([r]))[0]
 
 
1147
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
 
1148
        signature = gpg_strategy.sign(plaintext)
 
 
1149
        self.add_signature_text(revision_id, signature)
 
 
1152
    def add_signature_text(self, revision_id, signature):
 
 
1153
        self._revision_store.add_revision_signature_text(revision_id,
 
 
1155
                                                         self.get_transaction())
 
 
1157
    def find_text_key_references(self):
 
 
1158
        """Find the text key references within the repository.
 
 
1160
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
 
1161
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
1162
        altered it listed explicitly.
 
 
1163
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
 
1164
            to whether they were referred to by the inventory of the
 
 
1165
            revision_id that they contain. The inventory texts from all present
 
 
1166
            revision ids are assessed to generate this report.
 
 
1168
        revision_ids = self.all_revision_ids()
 
 
1169
        w = self.get_inventory_weave()
 
 
1170
        pb = ui.ui_factory.nested_progress_bar()
 
 
1172
            return self._find_text_key_references_from_xml_inventory_lines(
 
 
1173
                w.iter_lines_added_or_present_in_versions(revision_ids, pb=pb))
 
 
1177
    def _find_text_key_references_from_xml_inventory_lines(self,
 
 
1179
        """Core routine for extracting references to texts from inventories.
 
 
1181
        This performs the translation of xml lines to revision ids.
 
 
1183
        :param line_iterator: An iterator of lines, origin_version_id
 
 
1184
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
 
1185
            to whether they were referred to by the inventory of the
 
 
1186
            revision_id that they contain. Note that if that revision_id was
 
 
1187
            not part of the line_iterator's output then False will be given -
 
 
1188
            even though it may actually refer to that key.
 
 
1190
        if not self._serializer.support_altered_by_hack:
 
 
1191
            raise AssertionError(
 
 
1192
                "_find_text_key_references_from_xml_inventory_lines only "
 
 
1193
                "supported for branches which store inventory as unnested xml"
 
 
1194
                ", not on %r" % self)
 
 
1197
        # this code needs to read every new line in every inventory for the
 
 
1198
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
 
1199
        # not present in one of those inventories is unnecessary but not 
 
 
1200
        # harmful because we are filtering by the revision id marker in the
 
 
1201
        # inventory lines : we only select file ids altered in one of those  
 
 
1202
        # revisions. We don't need to see all lines in the inventory because
 
 
1203
        # only those added in an inventory in rev X can contain a revision=X
 
 
1205
        unescape_revid_cache = {}
 
 
1206
        unescape_fileid_cache = {}
 
 
1208
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
 
1209
        # of lines, so it has had a lot of inlining and optimizing done.
 
 
1210
        # Sorry that it is a little bit messy.
 
 
1211
        # Move several functions to be local variables, since this is a long
 
 
1213
        search = self._file_ids_altered_regex.search
 
 
1214
        unescape = _unescape_xml
 
 
1215
        setdefault = result.setdefault
 
 
1216
        for line, version_id in line_iterator:
 
 
1217
            match = search(line)
 
 
1220
            # One call to match.group() returning multiple items is quite a
 
 
1221
            # bit faster than 2 calls to match.group() each returning 1
 
 
1222
            file_id, revision_id = match.group('file_id', 'revision_id')
 
 
1224
            # Inlining the cache lookups helps a lot when you make 170,000
 
 
1225
            # lines and 350k ids, versus 8.4 unique ids.
 
 
1226
            # Using a cache helps in 2 ways:
 
 
1227
            #   1) Avoids unnecessary decoding calls
 
 
1228
            #   2) Re-uses cached strings, which helps in future set and
 
 
1230
            # (2) is enough that removing encoding entirely along with
 
 
1231
            # the cache (so we are using plain strings) results in no
 
 
1232
            # performance improvement.
 
 
1234
                revision_id = unescape_revid_cache[revision_id]
 
 
1236
                unescaped = unescape(revision_id)
 
 
1237
                unescape_revid_cache[revision_id] = unescaped
 
 
1238
                revision_id = unescaped
 
 
1240
            # Note that unconditionally unescaping means that we deserialise
 
 
1241
            # every fileid, which for general 'pull' is not great, but we don't
 
 
1242
            # really want to have some many fulltexts that this matters anyway.
 
 
1245
                file_id = unescape_fileid_cache[file_id]
 
 
1247
                unescaped = unescape(file_id)
 
 
1248
                unescape_fileid_cache[file_id] = unescaped
 
 
1251
            key = (file_id, revision_id)
 
 
1252
            setdefault(key, False)
 
 
1253
            if revision_id == version_id:
 
 
1257
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
 
1259
        """Helper routine for fileids_altered_by_revision_ids.
 
 
1261
        This performs the translation of xml lines to revision ids.
 
 
1263
        :param line_iterator: An iterator of lines, origin_version_id
 
 
1264
        :param revision_ids: The revision ids to filter for. This should be a
 
 
1265
            set or other type which supports efficient __contains__ lookups, as
 
 
1266
            the revision id from each parsed line will be looked up in the
 
 
1267
            revision_ids filter.
 
 
1268
        :return: a dictionary mapping altered file-ids to an iterable of
 
 
1269
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
1270
        altered it listed explicitly.
 
 
1273
        setdefault = result.setdefault
 
 
1274
        for file_id, revision_id in \
 
 
1275
            self._find_text_key_references_from_xml_inventory_lines(
 
 
1276
                line_iterator).iterkeys():
 
 
1277
            # once data is all ensured-consistent; then this is
 
 
1278
            # if revision_id == version_id
 
 
1279
            if revision_id in revision_ids:
 
 
1280
                setdefault(file_id, set()).add(revision_id)
 
 
1283
    def fileids_altered_by_revision_ids(self, revision_ids):
 
 
1284
        """Find the file ids and versions affected by revisions.
 
 
1286
        :param revisions: an iterable containing revision ids.
 
 
1287
        :return: a dictionary mapping altered file-ids to an iterable of
 
 
1288
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
1289
        altered it listed explicitly.
 
 
1291
        selected_revision_ids = set(revision_ids)
 
 
1292
        w = self.get_inventory_weave()
 
 
1293
        pb = ui.ui_factory.nested_progress_bar()
 
 
1295
            return self._find_file_ids_from_xml_inventory_lines(
 
 
1296
                w.iter_lines_added_or_present_in_versions(
 
 
1297
                    selected_revision_ids, pb=pb),
 
 
1298
                selected_revision_ids)
 
 
1302
    def iter_files_bytes(self, desired_files):
 
 
1303
        """Iterate through file versions.
 
 
1305
        Files will not necessarily be returned in the order they occur in
 
 
1306
        desired_files.  No specific order is guaranteed.
 
 
1308
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
1309
        value supplied by the caller as part of desired_files.  It should
 
 
1310
        uniquely identify the file version in the caller's context.  (Examples:
 
 
1311
        an index number or a TreeTransform trans_id.)
 
 
1313
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
1314
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
1315
        this implementation, it is a list of lines produced by
 
 
1316
        VersionedFile.get_lines().
 
 
1318
        :param desired_files: a list of (file_id, revision_id, identifier)
 
 
1321
        transaction = self.get_transaction()
 
 
1322
        for file_id, revision_id, callable_data in desired_files:
 
 
1324
                weave = self.weave_store.get_weave(file_id, transaction)
 
 
1325
            except errors.NoSuchFile:
 
 
1326
                raise errors.NoSuchIdInRepository(self, file_id)
 
 
1327
            yield callable_data, weave.get_lines(revision_id)
 
 
1329
    def _generate_text_key_index(self, text_key_references=None,
 
 
1331
        """Generate a new text key index for the repository.
 
 
1333
        This is an expensive function that will take considerable time to run.
 
 
1335
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
 
1336
            list of parents, also text keys. When a given key has no parents,
 
 
1337
            the parents list will be [NULL_REVISION].
 
 
1339
        # All revisions, to find inventory parents.
 
 
1340
        if ancestors is None:
 
 
1341
            revision_graph = self.get_revision_graph_with_ghosts()
 
 
1342
            ancestors = revision_graph.get_ancestors()
 
 
1343
        if text_key_references is None:
 
 
1344
            text_key_references = self.find_text_key_references()
 
 
1345
        pb = ui.ui_factory.nested_progress_bar()
 
 
1347
            return self._do_generate_text_key_index(ancestors,
 
 
1348
                text_key_references, pb)
 
 
1352
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
 
1353
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
 
1354
        revision_order = tsort.topo_sort(ancestors)
 
 
1355
        invalid_keys = set()
 
 
1357
        for revision_id in revision_order:
 
 
1358
            revision_keys[revision_id] = set()
 
 
1359
        text_count = len(text_key_references)
 
 
1360
        # a cache of the text keys to allow reuse; costs a dict of all the
 
 
1361
        # keys, but saves a 2-tuple for every child of a given key.
 
 
1363
        for text_key, valid in text_key_references.iteritems():
 
 
1365
                invalid_keys.add(text_key)
 
 
1367
                revision_keys[text_key[1]].add(text_key)
 
 
1368
            text_key_cache[text_key] = text_key
 
 
1369
        del text_key_references
 
 
1371
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
 
1372
        NULL_REVISION = _mod_revision.NULL_REVISION
 
 
1373
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
 
1374
        # too small for large or very branchy trees. However, for 55K path
 
 
1375
        # trees, it would be easy to use too much memory trivially. Ideally we
 
 
1376
        # could gauge this by looking at available real memory etc, but this is
 
 
1377
        # always a tricky proposition.
 
 
1378
        inventory_cache = lru_cache.LRUCache(10)
 
 
1379
        batch_size = 10 # should be ~150MB on a 55K path tree
 
 
1380
        batch_count = len(revision_order) / batch_size + 1
 
 
1382
        pb.update("Calculating text parents.", processed_texts, text_count)
 
 
1383
        for offset in xrange(batch_count):
 
 
1384
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
 
1388
            for rev_tree in self.revision_trees(to_query):
 
 
1389
                revision_id = rev_tree.get_revision_id()
 
 
1390
                parent_ids = ancestors[revision_id]
 
 
1391
                for text_key in revision_keys[revision_id]:
 
 
1392
                    pb.update("Calculating text parents.", processed_texts)
 
 
1393
                    processed_texts += 1
 
 
1394
                    candidate_parents = []
 
 
1395
                    for parent_id in parent_ids:
 
 
1396
                        parent_text_key = (text_key[0], parent_id)
 
 
1398
                            check_parent = parent_text_key not in \
 
 
1399
                                revision_keys[parent_id]
 
 
1401
                            # the parent parent_id is a ghost:
 
 
1402
                            check_parent = False
 
 
1403
                            # truncate the derived graph against this ghost.
 
 
1404
                            parent_text_key = None
 
 
1406
                            # look at the parent commit details inventories to
 
 
1407
                            # determine possible candidates in the per file graph.
 
 
1410
                                inv = inventory_cache[parent_id]
 
 
1412
                                inv = self.revision_tree(parent_id).inventory
 
 
1413
                                inventory_cache[parent_id] = inv
 
 
1414
                            parent_entry = inv._byid.get(text_key[0], None)
 
 
1415
                            if parent_entry is not None:
 
 
1417
                                    text_key[0], parent_entry.revision)
 
 
1419
                                parent_text_key = None
 
 
1420
                        if parent_text_key is not None:
 
 
1421
                            candidate_parents.append(
 
 
1422
                                text_key_cache[parent_text_key])
 
 
1423
                    parent_heads = text_graph.heads(candidate_parents)
 
 
1424
                    new_parents = list(parent_heads)
 
 
1425
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
 
1426
                    if new_parents == []:
 
 
1427
                        new_parents = [NULL_REVISION]
 
 
1428
                    text_index[text_key] = new_parents
 
 
1430
        for text_key in invalid_keys:
 
 
1431
            text_index[text_key] = [NULL_REVISION]
 
 
1434
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
 
1435
        """Get an iterable listing the keys of all the data introduced by a set
 
 
1438
        The keys will be ordered so that the corresponding items can be safely
 
 
1439
        fetched and inserted in that order.
 
 
1441
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
 
1442
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
 
1443
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
 
1445
        # XXX: it's a bit weird to control the inventory weave caching in this
 
 
1446
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
 
1447
        # maybe this generator should explicitly have the contract that it
 
 
1448
        # should not be iterated until the previously yielded item has been
 
 
1451
        inv_w = self.get_inventory_weave()
 
 
1452
        inv_w.enable_cache()
 
 
1454
        # file ids that changed
 
 
1455
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
 
 
1457
        num_file_ids = len(file_ids)
 
 
1458
        for file_id, altered_versions in file_ids.iteritems():
 
 
1459
            if _files_pb is not None:
 
 
1460
                _files_pb.update("fetch texts", count, num_file_ids)
 
 
1462
            yield ("file", file_id, altered_versions)
 
 
1463
        # We're done with the files_pb.  Note that it finished by the caller,
 
 
1464
        # just as it was created by the caller.
 
 
1468
        yield ("inventory", None, revision_ids)
 
 
1472
        revisions_with_signatures = set()
 
 
1473
        for rev_id in revision_ids:
 
 
1475
                self.get_signature_text(rev_id)
 
 
1476
            except errors.NoSuchRevision:
 
 
1480
                revisions_with_signatures.add(rev_id)
 
 
1482
        yield ("signatures", None, revisions_with_signatures)
 
 
1485
        yield ("revisions", None, revision_ids)
 
 
1488
    def get_inventory_weave(self):
 
 
1489
        return self.control_weaves.get_weave('inventory',
 
 
1490
            self.get_transaction())
 
 
1493
    def get_inventory(self, revision_id):
 
 
1494
        """Get Inventory object by revision id."""
 
 
1495
        return self.iter_inventories([revision_id]).next()
 
 
1497
    def iter_inventories(self, revision_ids):
 
 
1498
        """Get many inventories by revision_ids.
 
 
1500
        This will buffer some or all of the texts used in constructing the
 
 
1501
        inventories in memory, but will only parse a single inventory at a
 
 
1504
        :return: An iterator of inventories.
 
 
1506
        assert None not in revision_ids
 
 
1507
        assert _mod_revision.NULL_REVISION not in revision_ids
 
 
1508
        return self._iter_inventories(revision_ids)
 
 
1510
    def _iter_inventories(self, revision_ids):
 
 
1511
        """single-document based inventory iteration."""
 
 
1512
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
 
1513
        for text, revision_id in zip(texts, revision_ids):
 
 
1514
            yield self.deserialise_inventory(revision_id, text)
 
 
1516
    def deserialise_inventory(self, revision_id, xml):
 
 
1517
        """Transform the xml into an inventory object. 
 
 
1519
        :param revision_id: The expected revision id of the inventory.
 
 
1520
        :param xml: A serialised inventory.
 
 
1522
        result = self._serializer.read_inventory_from_string(xml, revision_id)
 
 
1523
        if result.revision_id != revision_id:
 
 
1524
            raise AssertionError('revision id mismatch %s != %s' % (
 
 
1525
                result.revision_id, revision_id))
 
 
1528
    def serialise_inventory(self, inv):
 
 
1529
        return self._serializer.write_inventory_to_string(inv)
 
 
1531
    def _serialise_inventory_to_lines(self, inv):
 
 
1532
        return self._serializer.write_inventory_to_lines(inv)
 
 
1534
    def get_serializer_format(self):
 
 
1535
        return self._serializer.format_num
 
 
1538
    def get_inventory_xml(self, revision_id):
 
 
1539
        """Get inventory XML as a file object."""
 
 
1541
            assert isinstance(revision_id, str), type(revision_id)
 
 
1542
            iw = self.get_inventory_weave()
 
 
1543
            return iw.get_text(revision_id)
 
 
1545
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
 
1548
    def get_inventory_sha1(self, revision_id):
 
 
1549
        """Return the sha1 hash of the inventory entry
 
 
1551
        return self.get_revision(revision_id).inventory_sha1
 
 
1554
    def get_revision_graph(self, revision_id=None):
 
 
1555
        """Return a dictionary containing the revision graph.
 
 
1557
        NB: This method should not be used as it accesses the entire graph all
 
 
1558
        at once, which is much more data than most operations should require.
 
 
1560
        :param revision_id: The revision_id to get a graph from. If None, then
 
 
1561
        the entire revision graph is returned. This is a deprecated mode of
 
 
1562
        operation and will be removed in the future.
 
 
1563
        :return: a dictionary of revision_id->revision_parents_list.
 
 
1565
        raise NotImplementedError(self.get_revision_graph)
 
 
1568
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
 
1569
        """Return a graph of the revisions with ghosts marked as applicable.
 
 
1571
        :param revision_ids: an iterable of revisions to graph or None for all.
 
 
1572
        :return: a Graph object with the graph reachable from revision_ids.
 
 
1574
        if 'evil' in debug.debug_flags:
 
 
1576
                "get_revision_graph_with_ghosts scales with size of history.")
 
 
1577
        result = deprecated_graph.Graph()
 
 
1578
        if not revision_ids:
 
 
1579
            pending = set(self.all_revision_ids())
 
 
1582
            pending = set(revision_ids)
 
 
1583
            # special case NULL_REVISION
 
 
1584
            if _mod_revision.NULL_REVISION in pending:
 
 
1585
                pending.remove(_mod_revision.NULL_REVISION)
 
 
1586
            required = set(pending)
 
 
1589
            revision_id = pending.pop()
 
 
1591
                rev = self.get_revision(revision_id)
 
 
1592
            except errors.NoSuchRevision:
 
 
1593
                if revision_id in required:
 
 
1596
                result.add_ghost(revision_id)
 
 
1598
            for parent_id in rev.parent_ids:
 
 
1599
                # is this queued or done ?
 
 
1600
                if (parent_id not in pending and
 
 
1601
                    parent_id not in done):
 
 
1603
                    pending.add(parent_id)
 
 
1604
            result.add_node(revision_id, rev.parent_ids)
 
 
1605
            done.add(revision_id)
 
 
1608
    def _get_history_vf(self):
 
 
1609
        """Get a versionedfile whose history graph reflects all revisions.
 
 
1611
        For weave repositories, this is the inventory weave.
 
 
1613
        return self.get_inventory_weave()
 
 
1615
    def iter_reverse_revision_history(self, revision_id):
 
 
1616
        """Iterate backwards through revision ids in the lefthand history
 
 
1618
        :param revision_id: The revision id to start with.  All its lefthand
 
 
1619
            ancestors will be traversed.
 
 
1621
        if revision_id in (None, _mod_revision.NULL_REVISION):
 
 
1623
        next_id = revision_id
 
 
1624
        versionedfile = self._get_history_vf()
 
 
1627
            parents = versionedfile.get_parents(next_id)
 
 
1628
            if len(parents) == 0:
 
 
1631
                next_id = parents[0]
 
 
1634
    def get_revision_inventory(self, revision_id):
 
 
1635
        """Return inventory of a past revision."""
 
 
1636
        # TODO: Unify this with get_inventory()
 
 
1637
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
 
1638
        # must be the same as its revision, so this is trivial.
 
 
1639
        if revision_id is None:
 
 
1640
            # This does not make sense: if there is no revision,
 
 
1641
            # then it is the current tree inventory surely ?!
 
 
1642
            # and thus get_root_id() is something that looks at the last
 
 
1643
            # commit on the branch, and the get_root_id is an inventory check.
 
 
1644
            raise NotImplementedError
 
 
1645
            # return Inventory(self.get_root_id())
 
 
1647
            return self.get_inventory(revision_id)
 
 
1650
    def is_shared(self):
 
 
1651
        """Return True if this repository is flagged as a shared repository."""
 
 
1652
        raise NotImplementedError(self.is_shared)
 
 
1655
    def reconcile(self, other=None, thorough=False):
 
 
1656
        """Reconcile this repository."""
 
 
1657
        from bzrlib.reconcile import RepoReconciler
 
 
1658
        reconciler = RepoReconciler(self, thorough=thorough)
 
 
1659
        reconciler.reconcile()
 
 
1662
    def _refresh_data(self):
 
 
1663
        """Helper called from lock_* to ensure coherency with disk.
 
 
1665
        The default implementation does nothing; it is however possible
 
 
1666
        for repositories to maintain loaded indices across multiple locks
 
 
1667
        by checking inside their implementation of this method to see
 
 
1668
        whether their indices are still valid. This depends of course on
 
 
1669
        the disk format being validatable in this manner.
 
 
1673
    def revision_tree(self, revision_id):
 
 
1674
        """Return Tree for a revision on this branch.
 
 
1676
        `revision_id` may be None for the empty tree revision.
 
 
1678
        # TODO: refactor this to use an existing revision object
 
 
1679
        # so we don't need to read it in twice.
 
 
1680
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
 
1681
            return RevisionTree(self, Inventory(root_id=None), 
 
 
1682
                                _mod_revision.NULL_REVISION)
 
 
1684
            inv = self.get_revision_inventory(revision_id)
 
 
1685
            return RevisionTree(self, inv, revision_id)
 
 
1688
    def revision_trees(self, revision_ids):
 
 
1689
        """Return Tree for a revision on this branch.
 
 
1691
        `revision_id` may not be None or 'null:'"""
 
 
1692
        inventories = self.iter_inventories(revision_ids)
 
 
1693
        for inv in inventories:
 
 
1694
            yield RevisionTree(self, inv, inv.revision_id)
 
 
1697
    def get_ancestry(self, revision_id, topo_sorted=True):
 
 
1698
        """Return a list of revision-ids integrated by a revision.
 
 
1700
        The first element of the list is always None, indicating the origin 
 
 
1701
        revision.  This might change when we have history horizons, or 
 
 
1702
        perhaps we should have a new API.
 
 
1704
        This is topologically sorted.
 
 
1706
        if _mod_revision.is_null(revision_id):
 
 
1708
        if not self.has_revision(revision_id):
 
 
1709
            raise errors.NoSuchRevision(self, revision_id)
 
 
1710
        w = self.get_inventory_weave()
 
 
1711
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
 
1712
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
 
1715
        """Compress the data within the repository.
 
 
1717
        This operation only makes sense for some repository types. For other
 
 
1718
        types it should be a no-op that just returns.
 
 
1720
        This stub method does not require a lock, but subclasses should use
 
 
1721
        @needs_write_lock as this is a long running call its reasonable to 
 
 
1722
        implicitly lock for the user.
 
 
1726
    def print_file(self, file, revision_id):
 
 
1727
        """Print `file` to stdout.
 
 
1729
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
 
1730
        - it writes to stdout, it assumes that that is valid etc. Fix
 
 
1731
        by creating a new more flexible convenience function.
 
 
1733
        tree = self.revision_tree(revision_id)
 
 
1734
        # use inventory as it was in that revision
 
 
1735
        file_id = tree.inventory.path2id(file)
 
 
1737
            # TODO: jam 20060427 Write a test for this code path
 
 
1738
            #       it had a bug in it, and was raising the wrong
 
 
1740
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
 
1741
        tree.print_file(file_id)
 
 
1743
    def get_transaction(self):
 
 
1744
        return self.control_files.get_transaction()
 
 
1746
    def revision_parents(self, revision_id):
 
 
1747
        return self.get_inventory_weave().parent_names(revision_id)
 
 
1749
    @deprecated_method(symbol_versioning.one_one)
 
 
1750
    def get_parents(self, revision_ids):
 
 
1751
        """See StackedParentsProvider.get_parents"""
 
 
1752
        parent_map = self.get_parent_map(revision_ids)
 
 
1753
        return [parent_map.get(r, None) for r in revision_ids]
 
 
1755
    def get_parent_map(self, keys):
 
 
1756
        """See graph._StackedParentsProvider.get_parent_map"""
 
 
1758
        for revision_id in keys:
 
 
1759
            if revision_id == _mod_revision.NULL_REVISION:
 
 
1760
                parent_map[revision_id] = ()
 
 
1763
                    parent_id_list = self.get_revision(revision_id).parent_ids
 
 
1764
                except errors.NoSuchRevision:
 
 
1767
                    if len(parent_id_list) == 0:
 
 
1768
                        parent_ids = (_mod_revision.NULL_REVISION,)
 
 
1770
                        parent_ids = tuple(parent_id_list)
 
 
1771
                    parent_map[revision_id] = parent_ids
 
 
1774
    def _make_parents_provider(self):
 
 
1777
    def get_graph(self, other_repository=None):
 
 
1778
        """Return the graph walker for this repository format"""
 
 
1779
        parents_provider = self._make_parents_provider()
 
 
1780
        if (other_repository is not None and
 
 
1781
            not self.has_same_location(other_repository)):
 
 
1782
            parents_provider = graph._StackedParentsProvider(
 
 
1783
                [parents_provider, other_repository._make_parents_provider()])
 
 
1784
        return graph.Graph(parents_provider)
 
 
1786
    def _get_versioned_file_checker(self):
 
 
1787
        """Return an object suitable for checking versioned files."""
 
 
1788
        return _VersionedFileChecker(self)
 
 
1790
    def revision_ids_to_search_result(self, result_set):
 
 
1791
        """Convert a set of revision ids to a graph SearchResult."""
 
 
1792
        result_parents = set()
 
 
1793
        for parents in self.get_graph().get_parent_map(
 
 
1794
            result_set).itervalues():
 
 
1795
            result_parents.update(parents)
 
 
1796
        included_keys = result_set.intersection(result_parents)
 
 
1797
        start_keys = result_set.difference(included_keys)
 
 
1798
        exclude_keys = result_parents.difference(result_set)
 
 
1799
        result = graph.SearchResult(start_keys, exclude_keys,
 
 
1800
            len(result_set), result_set)
 
 
1804
    def set_make_working_trees(self, new_value):
 
 
1805
        """Set the policy flag for making working trees when creating branches.
 
 
1807
        This only applies to branches that use this repository.
 
 
1809
        The default is 'True'.
 
 
1810
        :param new_value: True to restore the default, False to disable making
 
 
1813
        raise NotImplementedError(self.set_make_working_trees)
 
 
1815
    def make_working_trees(self):
 
 
1816
        """Returns the policy for making working trees on new branches."""
 
 
1817
        raise NotImplementedError(self.make_working_trees)
 
 
1820
    def sign_revision(self, revision_id, gpg_strategy):
 
 
1821
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
 
1822
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
 
1825
    def has_signature_for_revision_id(self, revision_id):
 
 
1826
        """Query for a revision signature for revision_id in the repository."""
 
 
1827
        return self._revision_store.has_signature(revision_id,
 
 
1828
                                                  self.get_transaction())
 
 
1831
    def get_signature_text(self, revision_id):
 
 
1832
        """Return the text for a signature."""
 
 
1833
        return self._revision_store.get_signature_text(revision_id,
 
 
1834
                                                       self.get_transaction())
 
 
1837
    def check(self, revision_ids=None):
 
 
1838
        """Check consistency of all history of given revision_ids.
 
 
1840
        Different repository implementations should override _check().
 
 
1842
        :param revision_ids: A non-empty list of revision_ids whose ancestry
 
 
1843
             will be checked.  Typically the last revision_id of a branch.
 
 
1845
        return self._check(revision_ids)
 
 
1847
    def _check(self, revision_ids):
 
 
1848
        result = check.Check(self)
 
 
1852
    def _warn_if_deprecated(self):
 
 
1853
        global _deprecation_warning_done
 
 
1854
        if _deprecation_warning_done:
 
 
1856
        _deprecation_warning_done = True
 
 
1857
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
 
1858
                % (self._format, self.bzrdir.transport.base))
 
 
1860
    def supports_rich_root(self):
 
 
1861
        return self._format.rich_root_data
 
 
1863
    def _check_ascii_revisionid(self, revision_id, method):
 
 
1864
        """Private helper for ascii-only repositories."""
 
 
1865
        # weave repositories refuse to store revisionids that are non-ascii.
 
 
1866
        if revision_id is not None:
 
 
1867
            # weaves require ascii revision ids.
 
 
1868
            if isinstance(revision_id, unicode):
 
 
1870
                    revision_id.encode('ascii')
 
 
1871
                except UnicodeEncodeError:
 
 
1872
                    raise errors.NonAsciiRevisionId(method, self)
 
 
1875
                    revision_id.decode('ascii')
 
 
1876
                except UnicodeDecodeError:
 
 
1877
                    raise errors.NonAsciiRevisionId(method, self)
 
 
1879
    def revision_graph_can_have_wrong_parents(self):
 
 
1880
        """Is it possible for this repository to have a revision graph with
 
 
1883
        If True, then this repository must also implement
 
 
1884
        _find_inconsistent_revision_parents so that check and reconcile can
 
 
1885
        check for inconsistencies before proceeding with other checks that may
 
 
1886
        depend on the revision index being consistent.
 
 
1888
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
 
1891
# remove these delegates a while after bzr 0.15
 
 
1892
def __make_delegated(name, from_module):
 
 
1893
    def _deprecated_repository_forwarder():
 
 
1894
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
 
1895
            % (name, from_module),
 
 
1898
        m = __import__(from_module, globals(), locals(), [name])
 
 
1900
            return getattr(m, name)
 
 
1901
        except AttributeError:
 
 
1902
            raise AttributeError('module %s has no name %s'
 
 
1904
    globals()[name] = _deprecated_repository_forwarder
 
 
1907
        'AllInOneRepository',
 
 
1908
        'WeaveMetaDirRepository',
 
 
1909
        'PreSplitOutRepositoryFormat',
 
 
1910
        'RepositoryFormat4',
 
 
1911
        'RepositoryFormat5',
 
 
1912
        'RepositoryFormat6',
 
 
1913
        'RepositoryFormat7',
 
 
1915
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
 
1919
        'RepositoryFormatKnit',
 
 
1920
        'RepositoryFormatKnit1',
 
 
1922
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
 
1925
def install_revision(repository, rev, revision_tree):
 
 
1926
    """Install all revision data into a repository."""
 
 
1927
    install_revisions(repository, [(rev, revision_tree, None)])
 
 
1930
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
 
1931
    """Install all revision data into a repository.
 
 
1933
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
 
1936
    repository.start_write_group()
 
 
1938
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
 
1939
            _install_revision(repository, revision, revision_tree, signature)
 
 
1941
                pb.update('Transferring revisions', n + 1, num_revisions)
 
 
1943
        repository.abort_write_group()
 
 
1946
        repository.commit_write_group()
 
 
1949
def _install_revision(repository, rev, revision_tree, signature):
 
 
1950
    """Install all revision data into a repository."""
 
 
1951
    present_parents = []
 
 
1953
    for p_id in rev.parent_ids:
 
 
1954
        if repository.has_revision(p_id):
 
 
1955
            present_parents.append(p_id)
 
 
1956
            parent_trees[p_id] = repository.revision_tree(p_id)
 
 
1958
            parent_trees[p_id] = repository.revision_tree(None)
 
 
1960
    inv = revision_tree.inventory
 
 
1961
    entries = inv.iter_entries()
 
 
1962
    # backwards compatibility hack: skip the root id.
 
 
1963
    if not repository.supports_rich_root():
 
 
1964
        path, root = entries.next()
 
 
1965
        if root.revision != rev.revision_id:
 
 
1966
            raise errors.IncompatibleRevision(repr(repository))
 
 
1967
    # Add the texts that are not already present
 
 
1968
    for path, ie in entries:
 
 
1969
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
 
1970
                repository.get_transaction())
 
 
1971
        if ie.revision not in w:
 
 
1973
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
 
1974
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
 
1975
            # is a latent bug here where the parents may have ancestors of each
 
 
1977
            for revision, tree in parent_trees.iteritems():
 
 
1978
                if ie.file_id not in tree:
 
 
1980
                parent_id = tree.inventory[ie.file_id].revision
 
 
1981
                if parent_id in text_parents:
 
 
1983
                text_parents.append(parent_id)
 
 
1985
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
 
1986
                repository.get_transaction())
 
 
1987
            lines = revision_tree.get_file(ie.file_id).readlines()
 
 
1988
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
 
1990
        # install the inventory
 
 
1991
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
 
1992
    except errors.RevisionAlreadyPresent:
 
 
1994
    if signature is not None:
 
 
1995
        repository.add_signature_text(rev.revision_id, signature)
 
 
1996
    repository.add_revision(rev.revision_id, rev, inv)
 
 
1999
class MetaDirRepository(Repository):
 
 
2000
    """Repositories in the new meta-dir layout."""
 
 
2002
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
 
2003
        super(MetaDirRepository, self).__init__(_format,
 
 
2009
        dir_mode = self.control_files._dir_mode
 
 
2010
        file_mode = self.control_files._file_mode
 
 
2013
    def is_shared(self):
 
 
2014
        """Return True if this repository is flagged as a shared repository."""
 
 
2015
        return self.control_files._transport.has('shared-storage')
 
 
2018
    def set_make_working_trees(self, new_value):
 
 
2019
        """Set the policy flag for making working trees when creating branches.
 
 
2021
        This only applies to branches that use this repository.
 
 
2023
        The default is 'True'.
 
 
2024
        :param new_value: True to restore the default, False to disable making
 
 
2029
                self.control_files._transport.delete('no-working-trees')
 
 
2030
            except errors.NoSuchFile:
 
 
2033
            self.control_files.put_utf8('no-working-trees', '')
 
 
2035
    def make_working_trees(self):
 
 
2036
        """Returns the policy for making working trees on new branches."""
 
 
2037
        return not self.control_files._transport.has('no-working-trees')
 
 
2040
class RepositoryFormatRegistry(registry.Registry):
 
 
2041
    """Registry of RepositoryFormats."""
 
 
2043
    def get(self, format_string):
 
 
2044
        r = registry.Registry.get(self, format_string)
 
 
2050
format_registry = RepositoryFormatRegistry()
 
 
2051
"""Registry of formats, indexed by their identifying format string.
 
 
2053
This can contain either format instances themselves, or classes/factories that
 
 
2054
can be called to obtain one.
 
 
2058
#####################################################################
 
 
2059
# Repository Formats
 
 
2061
class RepositoryFormat(object):
 
 
2062
    """A repository format.
 
 
2064
    Formats provide three things:
 
 
2065
     * An initialization routine to construct repository data on disk.
 
 
2066
     * a format string which is used when the BzrDir supports versioned
 
 
2068
     * an open routine which returns a Repository instance.
 
 
2070
    There is one and only one Format subclass for each on-disk format. But
 
 
2071
    there can be one Repository subclass that is used for several different
 
 
2072
    formats. The _format attribute on a Repository instance can be used to
 
 
2073
    determine the disk format.
 
 
2075
    Formats are placed in an dict by their format string for reference 
 
 
2076
    during opening. These should be subclasses of RepositoryFormat
 
 
2079
    Once a format is deprecated, just deprecate the initialize and open
 
 
2080
    methods on the format class. Do not deprecate the object, as the 
 
 
2081
    object will be created every system load.
 
 
2083
    Common instance attributes:
 
 
2084
    _matchingbzrdir - the bzrdir format that the repository format was
 
 
2085
    originally written to work with. This can be used if manually
 
 
2086
    constructing a bzrdir and repository, or more commonly for test suite
 
 
2090
    # Set to True or False in derived classes. True indicates that the format
 
 
2091
    # supports ghosts gracefully.
 
 
2092
    supports_ghosts = None
 
 
2095
        return "<%s>" % self.__class__.__name__
 
 
2097
    def __eq__(self, other):
 
 
2098
        # format objects are generally stateless
 
 
2099
        return isinstance(other, self.__class__)
 
 
2101
    def __ne__(self, other):
 
 
2102
        return not self == other
 
 
2105
    def find_format(klass, a_bzrdir):
 
 
2106
        """Return the format for the repository object in a_bzrdir.
 
 
2108
        This is used by bzr native formats that have a "format" file in
 
 
2109
        the repository.  Other methods may be used by different types of 
 
 
2113
            transport = a_bzrdir.get_repository_transport(None)
 
 
2114
            format_string = transport.get("format").read()
 
 
2115
            return format_registry.get(format_string)
 
 
2116
        except errors.NoSuchFile:
 
 
2117
            raise errors.NoRepositoryPresent(a_bzrdir)
 
 
2119
            raise errors.UnknownFormatError(format=format_string)
 
 
2122
    def register_format(klass, format):
 
 
2123
        format_registry.register(format.get_format_string(), format)
 
 
2126
    def unregister_format(klass, format):
 
 
2127
        format_registry.remove(format.get_format_string())
 
 
2130
    def get_default_format(klass):
 
 
2131
        """Return the current default format."""
 
 
2132
        from bzrlib import bzrdir
 
 
2133
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
 
2135
    def _get_control_store(self, repo_transport, control_files):
 
 
2136
        """Return the control store for this repository."""
 
 
2137
        raise NotImplementedError(self._get_control_store)
 
 
2139
    def get_format_string(self):
 
 
2140
        """Return the ASCII format string that identifies this format.
 
 
2142
        Note that in pre format ?? repositories the format string is 
 
 
2143
        not permitted nor written to disk.
 
 
2145
        raise NotImplementedError(self.get_format_string)
 
 
2147
    def get_format_description(self):
 
 
2148
        """Return the short description for this format."""
 
 
2149
        raise NotImplementedError(self.get_format_description)
 
 
2151
    def _get_revision_store(self, repo_transport, control_files):
 
 
2152
        """Return the revision store object for this a_bzrdir."""
 
 
2153
        raise NotImplementedError(self._get_revision_store)
 
 
2155
    def _get_text_rev_store(self,
 
 
2162
        """Common logic for getting a revision store for a repository.
 
 
2164
        see self._get_revision_store for the subclass-overridable method to 
 
 
2165
        get the store for a repository.
 
 
2167
        from bzrlib.store.revision.text import TextRevisionStore
 
 
2168
        dir_mode = control_files._dir_mode
 
 
2169
        file_mode = control_files._file_mode
 
 
2170
        text_store = TextStore(transport.clone(name),
 
 
2172
                              compressed=compressed,
 
 
2174
                              file_mode=file_mode)
 
 
2175
        _revision_store = TextRevisionStore(text_store, serializer)
 
 
2176
        return _revision_store
 
 
2178
    # TODO: this shouldn't be in the base class, it's specific to things that
 
 
2179
    # use weaves or knits -- mbp 20070207
 
 
2180
    def _get_versioned_file_store(self,
 
 
2185
                                  versionedfile_class=None,
 
 
2186
                                  versionedfile_kwargs={},
 
 
2188
        if versionedfile_class is None:
 
 
2189
            versionedfile_class = self._versionedfile_class
 
 
2190
        weave_transport = control_files._transport.clone(name)
 
 
2191
        dir_mode = control_files._dir_mode
 
 
2192
        file_mode = control_files._file_mode
 
 
2193
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
 
2195
                                  file_mode=file_mode,
 
 
2196
                                  versionedfile_class=versionedfile_class,
 
 
2197
                                  versionedfile_kwargs=versionedfile_kwargs,
 
 
2200
    def initialize(self, a_bzrdir, shared=False):
 
 
2201
        """Initialize a repository of this format in a_bzrdir.
 
 
2203
        :param a_bzrdir: The bzrdir to put the new repository in it.
 
 
2204
        :param shared: The repository should be initialized as a sharable one.
 
 
2205
        :returns: The new repository object.
 
 
2207
        This may raise UninitializableFormat if shared repository are not
 
 
2208
        compatible the a_bzrdir.
 
 
2210
        raise NotImplementedError(self.initialize)
 
 
2212
    def is_supported(self):
 
 
2213
        """Is this format supported?
 
 
2215
        Supported formats must be initializable and openable.
 
 
2216
        Unsupported formats may not support initialization or committing or 
 
 
2217
        some other features depending on the reason for not being supported.
 
 
2221
    def check_conversion_target(self, target_format):
 
 
2222
        raise NotImplementedError(self.check_conversion_target)
 
 
2224
    def open(self, a_bzrdir, _found=False):
 
 
2225
        """Return an instance of this format for the bzrdir a_bzrdir.
 
 
2227
        _found is a private parameter, do not use it.
 
 
2229
        raise NotImplementedError(self.open)
 
 
2232
class MetaDirRepositoryFormat(RepositoryFormat):
 
 
2233
    """Common base class for the new repositories using the metadir layout."""
 
 
2235
    rich_root_data = False
 
 
2236
    supports_tree_reference = False
 
 
2237
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
2240
        super(MetaDirRepositoryFormat, self).__init__()
 
 
2242
    def _create_control_files(self, a_bzrdir):
 
 
2243
        """Create the required files and the initial control_files object."""
 
 
2244
        # FIXME: RBC 20060125 don't peek under the covers
 
 
2245
        # NB: no need to escape relative paths that are url safe.
 
 
2246
        repository_transport = a_bzrdir.get_repository_transport(self)
 
 
2247
        control_files = lockable_files.LockableFiles(repository_transport,
 
 
2248
                                'lock', lockdir.LockDir)
 
 
2249
        control_files.create_lock()
 
 
2250
        return control_files
 
 
2252
    def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
 
 
2253
        """Upload the initial blank content."""
 
 
2254
        control_files = self._create_control_files(a_bzrdir)
 
 
2255
        control_files.lock_write()
 
 
2257
            control_files._transport.mkdir_multi(dirs,
 
 
2258
                    mode=control_files._dir_mode)
 
 
2259
            for file, content in files:
 
 
2260
                control_files.put(file, content)
 
 
2261
            for file, content in utf8_files:
 
 
2262
                control_files.put_utf8(file, content)
 
 
2264
                control_files.put_utf8('shared-storage', '')
 
 
2266
            control_files.unlock()
 
 
2269
# formats which have no format string are not discoverable
 
 
2270
# and not independently creatable, so are not registered.  They're 
 
 
2271
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
 
2272
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
 
2273
# the repository is not separately opened are similar.
 
 
2275
format_registry.register_lazy(
 
 
2276
    'Bazaar-NG Repository format 7',
 
 
2277
    'bzrlib.repofmt.weaverepo',
 
 
2281
format_registry.register_lazy(
 
 
2282
    'Bazaar-NG Knit Repository Format 1',
 
 
2283
    'bzrlib.repofmt.knitrepo',
 
 
2284
    'RepositoryFormatKnit1',
 
 
2287
format_registry.register_lazy(
 
 
2288
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
 
2289
    'bzrlib.repofmt.knitrepo',
 
 
2290
    'RepositoryFormatKnit3',
 
 
2293
format_registry.register_lazy(
 
 
2294
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
 
2295
    'bzrlib.repofmt.knitrepo',
 
 
2296
    'RepositoryFormatKnit4',
 
 
2299
# Pack-based formats. There is one format for pre-subtrees, and one for
 
 
2300
# post-subtrees to allow ease of testing.
 
 
2301
# NOTE: These are experimental in 0.92.
 
 
2302
format_registry.register_lazy(
 
 
2303
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
 
2304
    'bzrlib.repofmt.pack_repo',
 
 
2305
    'RepositoryFormatKnitPack1',
 
 
2307
format_registry.register_lazy(
 
 
2308
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
 
2309
    'bzrlib.repofmt.pack_repo',
 
 
2310
    'RepositoryFormatKnitPack3',
 
 
2312
format_registry.register_lazy(
 
 
2313
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
 
2314
    'bzrlib.repofmt.pack_repo',
 
 
2315
    'RepositoryFormatKnitPack4',
 
 
2319
class InterRepository(InterObject):
 
 
2320
    """This class represents operations taking place between two repositories.
 
 
2322
    Its instances have methods like copy_content and fetch, and contain
 
 
2323
    references to the source and target repositories these operations can be 
 
 
2326
    Often we will provide convenience methods on 'repository' which carry out
 
 
2327
    operations with another repository - they will always forward to
 
 
2328
    InterRepository.get(other).method_name(parameters).
 
 
2332
    """The available optimised InterRepository types."""
 
 
2334
    def copy_content(self, revision_id=None):
 
 
2335
        raise NotImplementedError(self.copy_content)
 
 
2337
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2338
        """Fetch the content required to construct revision_id.
 
 
2340
        The content is copied from self.source to self.target.
 
 
2342
        :param revision_id: if None all content is copied, if NULL_REVISION no
 
 
2344
        :param pb: optional progress bar to use for progress reports. If not
 
 
2345
                   provided a default one will be created.
 
 
2347
        Returns the copied revision count and the failed revisions in a tuple:
 
 
2350
        raise NotImplementedError(self.fetch)
 
 
2352
    def _walk_to_common_revisions(self, revision_ids):
 
 
2353
        """Walk out from revision_ids in source to revisions target has.
 
 
2355
        :param revision_ids: The start point for the search.
 
 
2356
        :return: A set of revision ids.
 
 
2358
        graph = self.source.get_graph()
 
 
2359
        missing_revs = set()
 
 
2360
        # ensure we don't pay silly lookup costs.
 
 
2361
        revision_ids = frozenset(revision_ids)
 
 
2362
        searcher = graph._make_breadth_first_searcher(revision_ids)
 
 
2363
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
 
2366
                next_revs, ghosts = searcher.next_with_ghosts()
 
 
2367
            except StopIteration:
 
 
2369
            if revision_ids.intersection(ghosts):
 
 
2370
                absent_ids = set(revision_ids.intersection(ghosts))
 
 
2371
                # If all absent_ids are present in target, no error is needed.
 
 
2372
                absent_ids.difference_update(
 
 
2373
                    self.target.has_revisions(absent_ids))
 
 
2375
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
 
 
2376
            # we don't care about other ghosts as we can't fetch them and
 
 
2377
            # haven't been asked to.
 
 
2378
            next_revs = set(next_revs)
 
 
2379
            # we always have NULL_REVISION present.
 
 
2380
            have_revs = self.target.has_revisions(next_revs).union(null_set)
 
 
2381
            missing_revs.update(next_revs - have_revs)
 
 
2382
            searcher.stop_searching_any(have_revs)
 
 
2383
        return searcher.get_result()
 
 
2385
    @deprecated_method(symbol_versioning.one_two)
 
 
2387
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
 
2388
        """Return the revision ids that source has that target does not.
 
 
2390
        These are returned in topological order.
 
 
2392
        :param revision_id: only return revision ids included by this
 
 
2394
        :param find_ghosts: If True find missing revisions in deep history
 
 
2395
            rather than just finding the surface difference.
 
 
2397
        return list(self.search_missing_revision_ids(
 
 
2398
            revision_id, find_ghosts).get_keys())
 
 
2401
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
 
2402
        """Return the revision ids that source has that target does not.
 
 
2404
        :param revision_id: only return revision ids included by this
 
 
2406
        :param find_ghosts: If True find missing revisions in deep history
 
 
2407
            rather than just finding the surface difference.
 
 
2408
        :return: A bzrlib.graph.SearchResult.
 
 
2410
        # stop searching at found target revisions.
 
 
2411
        if not find_ghosts and revision_id is not None:
 
 
2412
            return self._walk_to_common_revisions([revision_id])
 
 
2413
        # generic, possibly worst case, slow code path.
 
 
2414
        target_ids = set(self.target.all_revision_ids())
 
 
2415
        if revision_id is not None:
 
 
2416
            source_ids = self.source.get_ancestry(revision_id)
 
 
2417
            assert source_ids[0] is None
 
 
2420
            source_ids = self.source.all_revision_ids()
 
 
2421
        result_set = set(source_ids).difference(target_ids)
 
 
2422
        return self.source.revision_ids_to_search_result(result_set)
 
 
2425
    def _same_model(source, target):
 
 
2426
        """True if source and target have the same data representation."""
 
 
2427
        if source.supports_rich_root() != target.supports_rich_root():
 
 
2429
        if source._serializer != target._serializer:
 
 
2434
class InterSameDataRepository(InterRepository):
 
 
2435
    """Code for converting between repositories that represent the same data.
 
 
2437
    Data format and model must match for this to work.
 
 
2441
    def _get_repo_format_to_test(self):
 
 
2442
        """Repository format for testing with.
 
 
2444
        InterSameData can pull from subtree to subtree and from non-subtree to
 
 
2445
        non-subtree, so we test this with the richest repository format.
 
 
2447
        from bzrlib.repofmt import knitrepo
 
 
2448
        return knitrepo.RepositoryFormatKnit3()
 
 
2451
    def is_compatible(source, target):
 
 
2452
        return InterRepository._same_model(source, target)
 
 
2455
    def copy_content(self, revision_id=None):
 
 
2456
        """Make a complete copy of the content in self into destination.
 
 
2458
        This copies both the repository's revision data, and configuration information
 
 
2459
        such as the make_working_trees setting.
 
 
2461
        This is a destructive operation! Do not use it on existing 
 
 
2464
        :param revision_id: Only copy the content needed to construct
 
 
2465
                            revision_id and its parents.
 
 
2468
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2469
        except NotImplementedError:
 
 
2471
        # but don't bother fetching if we have the needed data now.
 
 
2472
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
 
2473
            self.target.has_revision(revision_id)):
 
 
2475
        self.target.fetch(self.source, revision_id=revision_id)
 
 
2478
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2479
        """See InterRepository.fetch()."""
 
 
2480
        from bzrlib.fetch import GenericRepoFetcher
 
 
2481
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2482
               self.source, self.source._format, self.target,
 
 
2483
               self.target._format)
 
 
2484
        f = GenericRepoFetcher(to_repository=self.target,
 
 
2485
                               from_repository=self.source,
 
 
2486
                               last_revision=revision_id,
 
 
2487
                               pb=pb, find_ghosts=find_ghosts)
 
 
2488
        return f.count_copied, f.failed_revisions
 
 
2491
class InterWeaveRepo(InterSameDataRepository):
 
 
2492
    """Optimised code paths between Weave based repositories.
 
 
2494
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
 
2495
    implemented lazy inter-object optimisation.
 
 
2499
    def _get_repo_format_to_test(self):
 
 
2500
        from bzrlib.repofmt import weaverepo
 
 
2501
        return weaverepo.RepositoryFormat7()
 
 
2504
    def is_compatible(source, target):
 
 
2505
        """Be compatible with known Weave formats.
 
 
2507
        We don't test for the stores being of specific types because that
 
 
2508
        could lead to confusing results, and there is no need to be 
 
 
2511
        from bzrlib.repofmt.weaverepo import (
 
 
2517
            return (isinstance(source._format, (RepositoryFormat5,
 
 
2519
                                                RepositoryFormat7)) and
 
 
2520
                    isinstance(target._format, (RepositoryFormat5,
 
 
2522
                                                RepositoryFormat7)))
 
 
2523
        except AttributeError:
 
 
2527
    def copy_content(self, revision_id=None):
 
 
2528
        """See InterRepository.copy_content()."""
 
 
2529
        # weave specific optimised path:
 
 
2531
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2532
        except NotImplementedError:
 
 
2534
        # FIXME do not peek!
 
 
2535
        if self.source.control_files._transport.listable():
 
 
2536
            pb = ui.ui_factory.nested_progress_bar()
 
 
2538
                self.target.weave_store.copy_all_ids(
 
 
2539
                    self.source.weave_store,
 
 
2541
                    from_transaction=self.source.get_transaction(),
 
 
2542
                    to_transaction=self.target.get_transaction())
 
 
2543
                pb.update('copying inventory', 0, 1)
 
 
2544
                self.target.control_weaves.copy_multi(
 
 
2545
                    self.source.control_weaves, ['inventory'],
 
 
2546
                    from_transaction=self.source.get_transaction(),
 
 
2547
                    to_transaction=self.target.get_transaction())
 
 
2548
                self.target._revision_store.text_store.copy_all_ids(
 
 
2549
                    self.source._revision_store.text_store,
 
 
2554
            self.target.fetch(self.source, revision_id=revision_id)
 
 
2557
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2558
        """See InterRepository.fetch()."""
 
 
2559
        from bzrlib.fetch import GenericRepoFetcher
 
 
2560
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2561
               self.source, self.source._format, self.target, self.target._format)
 
 
2562
        f = GenericRepoFetcher(to_repository=self.target,
 
 
2563
                               from_repository=self.source,
 
 
2564
                               last_revision=revision_id,
 
 
2565
                               pb=pb, find_ghosts=find_ghosts)
 
 
2566
        return f.count_copied, f.failed_revisions
 
 
2569
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
 
2570
        """See InterRepository.missing_revision_ids()."""
 
 
2571
        # we want all revisions to satisfy revision_id in source.
 
 
2572
        # but we don't want to stat every file here and there.
 
 
2573
        # we want then, all revisions other needs to satisfy revision_id 
 
 
2574
        # checked, but not those that we have locally.
 
 
2575
        # so the first thing is to get a subset of the revisions to 
 
 
2576
        # satisfy revision_id in source, and then eliminate those that
 
 
2577
        # we do already have. 
 
 
2578
        # this is slow on high latency connection to self, but as as this
 
 
2579
        # disk format scales terribly for push anyway due to rewriting 
 
 
2580
        # inventory.weave, this is considered acceptable.
 
 
2582
        if revision_id is not None:
 
 
2583
            source_ids = self.source.get_ancestry(revision_id)
 
 
2584
            assert source_ids[0] is None
 
 
2587
            source_ids = self.source._all_possible_ids()
 
 
2588
        source_ids_set = set(source_ids)
 
 
2589
        # source_ids is the worst possible case we may need to pull.
 
 
2590
        # now we want to filter source_ids against what we actually
 
 
2591
        # have in target, but don't try to check for existence where we know
 
 
2592
        # we do not have a revision as that would be pointless.
 
 
2593
        target_ids = set(self.target._all_possible_ids())
 
 
2594
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
 
2595
        actually_present_revisions = set(
 
 
2596
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
 
2597
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
 
2598
        if revision_id is not None:
 
 
2599
            # we used get_ancestry to determine source_ids then we are assured all
 
 
2600
            # revisions referenced are present as they are installed in topological order.
 
 
2601
            # and the tip revision was validated by get_ancestry.
 
 
2602
            result_set = required_revisions
 
 
2604
            # if we just grabbed the possibly available ids, then 
 
 
2605
            # we only have an estimate of whats available and need to validate
 
 
2606
            # that against the revision records.
 
 
2608
                self.source._eliminate_revisions_not_present(required_revisions))
 
 
2609
        return self.source.revision_ids_to_search_result(result_set)
 
 
2612
class InterKnitRepo(InterSameDataRepository):
 
 
2613
    """Optimised code paths between Knit based repositories."""
 
 
2616
    def _get_repo_format_to_test(self):
 
 
2617
        from bzrlib.repofmt import knitrepo
 
 
2618
        return knitrepo.RepositoryFormatKnit1()
 
 
2621
    def is_compatible(source, target):
 
 
2622
        """Be compatible with known Knit formats.
 
 
2624
        We don't test for the stores being of specific types because that
 
 
2625
        could lead to confusing results, and there is no need to be 
 
 
2628
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
 
2630
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
 
2631
                isinstance(target._format, RepositoryFormatKnit))
 
 
2632
        except AttributeError:
 
 
2634
        return are_knits and InterRepository._same_model(source, target)
 
 
2637
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2638
        """See InterRepository.fetch()."""
 
 
2639
        from bzrlib.fetch import KnitRepoFetcher
 
 
2640
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2641
               self.source, self.source._format, self.target, self.target._format)
 
 
2642
        f = KnitRepoFetcher(to_repository=self.target,
 
 
2643
                            from_repository=self.source,
 
 
2644
                            last_revision=revision_id,
 
 
2645
                            pb=pb, find_ghosts=find_ghosts)
 
 
2646
        return f.count_copied, f.failed_revisions
 
 
2649
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
 
2650
        """See InterRepository.missing_revision_ids()."""
 
 
2651
        if revision_id is not None:
 
 
2652
            source_ids = self.source.get_ancestry(revision_id)
 
 
2653
            assert source_ids[0] is None
 
 
2656
            source_ids = self.source.all_revision_ids()
 
 
2657
        source_ids_set = set(source_ids)
 
 
2658
        # source_ids is the worst possible case we may need to pull.
 
 
2659
        # now we want to filter source_ids against what we actually
 
 
2660
        # have in target, but don't try to check for existence where we know
 
 
2661
        # we do not have a revision as that would be pointless.
 
 
2662
        target_ids = set(self.target.all_revision_ids())
 
 
2663
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
 
2664
        actually_present_revisions = set(
 
 
2665
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
 
2666
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
 
2667
        if revision_id is not None:
 
 
2668
            # we used get_ancestry to determine source_ids then we are assured all
 
 
2669
            # revisions referenced are present as they are installed in topological order.
 
 
2670
            # and the tip revision was validated by get_ancestry.
 
 
2671
            result_set = required_revisions
 
 
2673
            # if we just grabbed the possibly available ids, then 
 
 
2674
            # we only have an estimate of whats available and need to validate
 
 
2675
            # that against the revision records.
 
 
2677
                self.source._eliminate_revisions_not_present(required_revisions))
 
 
2678
        return self.source.revision_ids_to_search_result(result_set)
 
 
2681
class InterPackRepo(InterSameDataRepository):
 
 
2682
    """Optimised code paths between Pack based repositories."""
 
 
2685
    def _get_repo_format_to_test(self):
 
 
2686
        from bzrlib.repofmt import pack_repo
 
 
2687
        return pack_repo.RepositoryFormatKnitPack1()
 
 
2690
    def is_compatible(source, target):
 
 
2691
        """Be compatible with known Pack formats.
 
 
2693
        We don't test for the stores being of specific types because that
 
 
2694
        could lead to confusing results, and there is no need to be 
 
 
2697
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
 
2699
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
 
2700
                isinstance(target._format, RepositoryFormatPack))
 
 
2701
        except AttributeError:
 
 
2703
        return are_packs and InterRepository._same_model(source, target)
 
 
2706
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2707
        """See InterRepository.fetch()."""
 
 
2708
        from bzrlib.repofmt.pack_repo import Packer
 
 
2709
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2710
               self.source, self.source._format, self.target, self.target._format)
 
 
2711
        self.count_copied = 0
 
 
2712
        if revision_id is None:
 
 
2714
            # everything to do - use pack logic
 
 
2715
            # to fetch from all packs to one without
 
 
2716
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
 
2718
            revision_ids = self.source.all_revision_ids()
 
 
2719
            # implementing the TODO will involve:
 
 
2720
            # - detecting when all of a pack is selected
 
 
2721
            # - avoiding as much as possible pre-selection, so the
 
 
2722
            # more-core routines such as create_pack_from_packs can filter in
 
 
2723
            # a just-in-time fashion. (though having a HEADS list on a
 
 
2724
            # repository might make this a lot easier, because we could
 
 
2725
            # sensibly detect 'new revisions' without doing a full index scan.
 
 
2726
        elif _mod_revision.is_null(revision_id):
 
 
2731
                revision_ids = self.search_missing_revision_ids(revision_id,
 
 
2732
                    find_ghosts=find_ghosts).get_keys()
 
 
2733
            except errors.NoSuchRevision:
 
 
2734
                raise errors.InstallFailed([revision_id])
 
 
2735
        packs = self.source._pack_collection.all_packs()
 
 
2736
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
 
2737
            revision_ids).pack()
 
 
2738
        if pack is not None:
 
 
2739
            self.target._pack_collection._save_pack_names()
 
 
2740
            # Trigger an autopack. This may duplicate effort as we've just done
 
 
2741
            # a pack creation, but for now it is simpler to think about as
 
 
2742
            # 'upload data, then repack if needed'.
 
 
2743
            self.target._pack_collection.autopack()
 
 
2744
            return (pack.get_revision_count(), [])
 
 
2749
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
 
2750
        """See InterRepository.missing_revision_ids().
 
 
2752
        :param find_ghosts: Find ghosts throughout the ancestry of
 
 
2755
        if not find_ghosts and revision_id is not None:
 
 
2756
            return self._walk_to_common_revisions([revision_id])
 
 
2757
        elif revision_id is not None:
 
 
2758
            source_ids = self.source.get_ancestry(revision_id)
 
 
2759
            assert source_ids[0] is None
 
 
2762
            source_ids = self.source.all_revision_ids()
 
 
2763
        # source_ids is the worst possible case we may need to pull.
 
 
2764
        # now we want to filter source_ids against what we actually
 
 
2765
        # have in target, but don't try to check for existence where we know
 
 
2766
        # we do not have a revision as that would be pointless.
 
 
2767
        target_ids = set(self.target.all_revision_ids())
 
 
2768
        result_set = set(source_ids).difference(target_ids)
 
 
2769
        return self.source.revision_ids_to_search_result(result_set)
 
 
2772
class InterModel1and2(InterRepository):
 
 
2775
    def _get_repo_format_to_test(self):
 
 
2779
    def is_compatible(source, target):
 
 
2780
        if not source.supports_rich_root() and target.supports_rich_root():
 
 
2786
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2787
        """See InterRepository.fetch()."""
 
 
2788
        from bzrlib.fetch import Model1toKnit2Fetcher
 
 
2789
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
 
2790
                                 from_repository=self.source,
 
 
2791
                                 last_revision=revision_id,
 
 
2792
                                 pb=pb, find_ghosts=find_ghosts)
 
 
2793
        return f.count_copied, f.failed_revisions
 
 
2796
    def copy_content(self, revision_id=None):
 
 
2797
        """Make a complete copy of the content in self into destination.
 
 
2799
        This is a destructive operation! Do not use it on existing 
 
 
2802
        :param revision_id: Only copy the content needed to construct
 
 
2803
                            revision_id and its parents.
 
 
2806
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2807
        except NotImplementedError:
 
 
2809
        # but don't bother fetching if we have the needed data now.
 
 
2810
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
 
2811
            self.target.has_revision(revision_id)):
 
 
2813
        self.target.fetch(self.source, revision_id=revision_id)
 
 
2816
class InterKnit1and2(InterKnitRepo):
 
 
2819
    def _get_repo_format_to_test(self):
 
 
2823
    def is_compatible(source, target):
 
 
2824
        """Be compatible with Knit1 source and Knit3 target"""
 
 
2825
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
 
2827
            from bzrlib.repofmt.knitrepo import (RepositoryFormatKnit1,
 
 
2828
                RepositoryFormatKnit3)
 
 
2829
            from bzrlib.repofmt.pack_repo import (RepositoryFormatKnitPack1,
 
 
2830
                RepositoryFormatKnitPack3)
 
 
2831
            return (isinstance(source._format,
 
 
2832
                    (RepositoryFormatKnit1, RepositoryFormatKnitPack1)) and
 
 
2833
                isinstance(target._format,
 
 
2834
                    (RepositoryFormatKnit3, RepositoryFormatKnitPack3))
 
 
2836
        except AttributeError:
 
 
2840
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2841
        """See InterRepository.fetch()."""
 
 
2842
        from bzrlib.fetch import Knit1to2Fetcher
 
 
2843
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2844
               self.source, self.source._format, self.target, 
 
 
2845
               self.target._format)
 
 
2846
        f = Knit1to2Fetcher(to_repository=self.target,
 
 
2847
                            from_repository=self.source,
 
 
2848
                            last_revision=revision_id,
 
 
2849
                            pb=pb, find_ghosts=find_ghosts)
 
 
2850
        return f.count_copied, f.failed_revisions
 
 
2853
class InterDifferingSerializer(InterKnitRepo):
 
 
2856
    def _get_repo_format_to_test(self):
 
 
2860
    def is_compatible(source, target):
 
 
2861
        """Be compatible with Knit2 source and Knit3 target"""
 
 
2862
        if source.supports_rich_root() != target.supports_rich_root():
 
 
2864
        # Ideally, we'd support fetching if the source had no tree references
 
 
2865
        # even if it supported them...
 
 
2866
        if (getattr(source, '_format.supports_tree_reference', False) and
 
 
2867
            not getattr(target, '_format.supports_tree_reference', False)):
 
 
2872
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2873
        """See InterRepository.fetch()."""
 
 
2874
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
 
2875
            revision_id, find_ghosts=find_ghosts).get_keys()
 
 
2876
        revision_ids = tsort.topo_sort(
 
 
2877
            self.source.get_graph().get_parent_map(revision_ids))
 
 
2878
        def revisions_iterator():
 
 
2879
            for current_revision_id in revision_ids:
 
 
2880
                revision = self.source.get_revision(current_revision_id)
 
 
2881
                tree = self.source.revision_tree(current_revision_id)
 
 
2883
                    signature = self.source.get_signature_text(
 
 
2884
                        current_revision_id)
 
 
2885
                except errors.NoSuchRevision:
 
 
2887
                yield revision, tree, signature
 
 
2889
            my_pb = ui.ui_factory.nested_progress_bar()
 
 
2894
            install_revisions(self.target, revisions_iterator(),
 
 
2895
                              len(revision_ids), pb)
 
 
2897
            if my_pb is not None:
 
 
2899
        return len(revision_ids), 0
 
 
2902
class InterRemoteToOther(InterRepository):
 
 
2904
    def __init__(self, source, target):
 
 
2905
        InterRepository.__init__(self, source, target)
 
 
2906
        self._real_inter = None
 
 
2909
    def is_compatible(source, target):
 
 
2910
        if not isinstance(source, remote.RemoteRepository):
 
 
2912
        # Is source's model compatible with target's model?
 
 
2913
        source._ensure_real()
 
 
2914
        real_source = source._real_repository
 
 
2915
        assert not isinstance(real_source, remote.RemoteRepository), (
 
 
2916
            "We don't support remote repos backed by remote repos yet.")
 
 
2917
        return InterRepository._same_model(real_source, target)
 
 
2920
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2921
        """See InterRepository.fetch()."""
 
 
2922
        from bzrlib.fetch import RemoteToOtherFetcher
 
 
2923
        mutter("Using fetch logic to copy between %s(remote) and %s(%s)",
 
 
2924
               self.source, self.target, self.target._format)
 
 
2925
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2926
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2927
        f = RemoteToOtherFetcher(to_repository=self.target,
 
 
2928
                                 from_repository=self.source,
 
 
2929
                                 last_revision=revision_id,
 
 
2930
                                 pb=pb, find_ghosts=find_ghosts)
 
 
2931
        return f.count_copied, f.failed_revisions
 
 
2934
    def _get_repo_format_to_test(self):
 
 
2938
class InterOtherToRemote(InterRepository):
 
 
2940
    def __init__(self, source, target):
 
 
2941
        InterRepository.__init__(self, source, target)
 
 
2942
        self._real_inter = None
 
 
2945
    def is_compatible(source, target):
 
 
2946
        if isinstance(target, remote.RemoteRepository):
 
 
2950
    def _ensure_real_inter(self):
 
 
2951
        if self._real_inter is None:
 
 
2952
            self.target._ensure_real()
 
 
2953
            real_target = self.target._real_repository
 
 
2954
            self._real_inter = InterRepository.get(self.source, real_target)
 
 
2956
    def copy_content(self, revision_id=None):
 
 
2957
        self._ensure_real_inter()
 
 
2958
        self._real_inter.copy_content(revision_id=revision_id)
 
 
2960
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
 
2961
        self._ensure_real_inter()
 
 
2962
        self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
 
2963
            find_ghosts=find_ghosts)
 
 
2966
    def _get_repo_format_to_test(self):
 
 
2970
InterRepository.register_optimiser(InterDifferingSerializer)
 
 
2971
InterRepository.register_optimiser(InterSameDataRepository)
 
 
2972
InterRepository.register_optimiser(InterWeaveRepo)
 
 
2973
InterRepository.register_optimiser(InterKnitRepo)
 
 
2974
InterRepository.register_optimiser(InterModel1and2)
 
 
2975
InterRepository.register_optimiser(InterKnit1and2)
 
 
2976
InterRepository.register_optimiser(InterPackRepo)
 
 
2977
InterRepository.register_optimiser(InterRemoteToOther)
 
 
2978
InterRepository.register_optimiser(InterOtherToRemote)
 
 
2981
class CopyConverter(object):
 
 
2982
    """A repository conversion tool which just performs a copy of the content.
 
 
2984
    This is slow but quite reliable.
 
 
2987
    def __init__(self, target_format):
 
 
2988
        """Create a CopyConverter.
 
 
2990
        :param target_format: The format the resulting repository should be.
 
 
2992
        self.target_format = target_format
 
 
2994
    def convert(self, repo, pb):
 
 
2995
        """Perform the conversion of to_convert, giving feedback via pb.
 
 
2997
        :param to_convert: The disk object to convert.
 
 
2998
        :param pb: a progress bar to use for progress information.
 
 
3003
        # this is only useful with metadir layouts - separated repo content.
 
 
3004
        # trigger an assertion if not such
 
 
3005
        repo._format.get_format_string()
 
 
3006
        self.repo_dir = repo.bzrdir
 
 
3007
        self.step('Moving repository to repository.backup')
 
 
3008
        self.repo_dir.transport.move('repository', 'repository.backup')
 
 
3009
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
 
3010
        repo._format.check_conversion_target(self.target_format)
 
 
3011
        self.source_repo = repo._format.open(self.repo_dir,
 
 
3013
            _override_transport=backup_transport)
 
 
3014
        self.step('Creating new repository')
 
 
3015
        converted = self.target_format.initialize(self.repo_dir,
 
 
3016
                                                  self.source_repo.is_shared())
 
 
3017
        converted.lock_write()
 
 
3019
            self.step('Copying content into repository.')
 
 
3020
            self.source_repo.copy_content_into(converted)
 
 
3023
        self.step('Deleting old repository content.')
 
 
3024
        self.repo_dir.transport.delete_tree('repository.backup')
 
 
3025
        self.pb.note('repository converted')
 
 
3027
    def step(self, message):
 
 
3028
        """Update the pb by a step."""
 
 
3030
        self.pb.update(message, self.count, self.total)
 
 
3042
def _unescaper(match, _map=_unescape_map):
 
 
3043
    code = match.group(1)
 
 
3047
        if not code.startswith('#'):
 
 
3049
        return unichr(int(code[1:])).encode('utf8')
 
 
3055
def _unescape_xml(data):
 
 
3056
    """Unescape predefined XML entities in a string of data."""
 
 
3058
    if _unescape_re is None:
 
 
3059
        _unescape_re = re.compile('\&([^;]*);')
 
 
3060
    return _unescape_re.sub(_unescaper, data)
 
 
3063
class _VersionedFileChecker(object):
 
 
3065
    def __init__(self, repository):
 
 
3066
        self.repository = repository
 
 
3067
        self.text_index = self.repository._generate_text_key_index()
 
 
3069
    def calculate_file_version_parents(self, revision_id, file_id):
 
 
3070
        """Calculate the correct parents for a file version according to
 
 
3073
        parent_keys = self.text_index[(file_id, revision_id)]
 
 
3074
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
 
3076
        # strip the file_id, for the weave api
 
 
3077
        return tuple([revision_id for file_id, revision_id in parent_keys])
 
 
3079
    def check_file_version_parents(self, weave, file_id):
 
 
3080
        """Check the parents stored in a versioned file are correct.
 
 
3082
        It also detects file versions that are not referenced by their
 
 
3083
        corresponding revision's inventory.
 
 
3085
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
 
3086
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
 
3087
            correct_parents)} for each revision_id where the stored parents
 
 
3088
            are not correct.  dangling_file_versions is a set of (file_id,
 
 
3089
            revision_id) tuples for versions that are present in this versioned
 
 
3090
            file, but not used by the corresponding inventory.
 
 
3093
        unused_versions = set()
 
 
3094
        for num, revision_id in enumerate(weave.versions()):
 
 
3096
                correct_parents = self.calculate_file_version_parents(
 
 
3097
                    revision_id, file_id)
 
 
3099
                # The version is not part of the used keys.
 
 
3100
                unused_versions.add(revision_id)
 
 
3103
                    knit_parents = tuple(weave.get_parents(revision_id))
 
 
3104
                except errors.RevisionNotPresent:
 
 
3106
                if correct_parents != knit_parents:
 
 
3107
                    wrong_parents[revision_id] = (knit_parents, correct_parents)
 
 
3108
        return wrong_parents, unused_versions