← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2008-06-06 13:30:30 UTC
  • mto: This revision was merged to the branch mainline in revision 3482.
  • Revision ID: john@arbash-meinel.com-20080606133030-9cnvpyem4mnplg8k
Rename UnicodeFilename => UnicodeFilenameFeature

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from __future__ import absolute_import
 
17
from cStringIO import StringIO
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
20
20
lazy_import(globals(), """
21
 
import itertools
 
21
import re
22
22
import time
23
23
 
24
24
from bzrlib import (
25
 
    config,
26
 
    controldir,
 
25
    bzrdir,
 
26
    check,
27
27
    debug,
 
28
    errors,
28
29
    generate_ids,
 
30
    gpg,
29
31
    graph,
 
32
    lazy_regex,
30
33
    lockable_files,
31
34
    lockdir,
 
35
    lru_cache,
32
36
    osutils,
 
37
    registry,
 
38
    remote,
33
39
    revision as _mod_revision,
34
 
    testament as _mod_testament,
 
40
    symbol_versioning,
 
41
    transactions,
35
42
    tsort,
36
 
    gpg,
 
43
    ui,
37
44
    )
38
45
from bzrlib.bundle import serializer
39
 
from bzrlib.i18n import gettext
 
46
from bzrlib.revisiontree import RevisionTree
 
47
from bzrlib.store.versioned import VersionedFileStore
 
48
from bzrlib.store.text import TextStore
 
49
from bzrlib.testament import Testament
 
50
from bzrlib.util import bencode
40
51
""")
41
52
 
42
 
from bzrlib import (
43
 
    bzrdir,
44
 
    errors,
45
 
    registry,
46
 
    symbol_versioning,
47
 
    ui,
48
 
    )
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
53
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
54
from bzrlib.inter import InterObject
51
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
 
from bzrlib.trace import (
53
 
    log_exception_quietly, note, mutter, mutter_callsite, warning)
 
55
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
56
from bzrlib.symbol_versioning import (
 
57
        deprecated_method,
 
58
        )
 
59
from bzrlib.trace import mutter, mutter_callsite, note, warning
54
60
 
55
61
 
56
62
# Old formats display a warning, but only once
57
63
_deprecation_warning_done = False
58
64
 
59
65
 
60
 
class IsInWriteGroupError(errors.InternalBzrError):
61
 
 
62
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
63
 
 
64
 
    def __init__(self, repo):
65
 
        errors.InternalBzrError.__init__(self, repo=repo)
66
 
 
67
 
 
68
66
class CommitBuilder(object):
69
67
    """Provides an interface to build up a commit.
70
68
 
71
 
    This allows describing a tree to be committed without needing to
 
69
    This allows describing a tree to be committed without needing to 
72
70
    know the internals of the format of the repository.
73
71
    """
74
 
 
 
72
    
75
73
    # all clients should supply tree roots.
76
74
    record_root_entry = True
77
 
    # whether this commit builder supports the record_entry_contents interface
78
 
    supports_record_entry_contents = False
79
 
    # whether this commit builder will automatically update the branch that is
80
 
    # being committed to
81
 
    updates_branch = False
 
75
    # the default CommitBuilder does not manage trees whose root is versioned.
 
76
    _versioned_root = False
82
77
 
83
 
    def __init__(self, repository, parents, config_stack, timestamp=None,
 
78
    def __init__(self, repository, parents, config, timestamp=None,
84
79
                 timezone=None, committer=None, revprops=None,
85
 
                 revision_id=None, lossy=False):
 
80
                 revision_id=None):
86
81
        """Initiate a CommitBuilder.
87
82
 
88
83
        :param repository: Repository to commit to.
89
84
        :param parents: Revision ids of the parents of the new revision.
 
85
        :param config: Configuration to use.
90
86
        :param timestamp: Optional timestamp recorded for commit.
91
87
        :param timezone: Optional timezone for timestamp.
92
88
        :param committer: Optional committer to set for commit.
93
89
        :param revprops: Optional dictionary of revision properties.
94
90
        :param revision_id: Optional revision id.
95
 
        :param lossy: Whether to discard data that can not be natively
96
 
            represented, when pushing to a foreign VCS 
97
91
        """
98
 
        self._config_stack = config_stack
99
 
        self._lossy = lossy
 
92
        self._config = config
100
93
 
101
94
        if committer is None:
102
 
            self._committer = self._config_stack.get('email')
103
 
        elif not isinstance(committer, unicode):
104
 
            self._committer = committer.decode() # throw if non-ascii
 
95
            self._committer = self._config.username()
105
96
        else:
106
97
            self._committer = committer
107
98
 
 
99
        self.new_inventory = Inventory(None)
108
100
        self._new_revision_id = revision_id
109
101
        self.parents = parents
110
102
        self.repository = repository
111
103
 
112
104
        self._revprops = {}
113
105
        if revprops is not None:
114
 
            self._validate_revprops(revprops)
115
106
            self._revprops.update(revprops)
116
107
 
117
108
        if timestamp is None:
125
116
            self._timezone = int(timezone)
126
117
 
127
118
        self._generate_revision_if_needed()
128
 
 
129
 
    def any_changes(self):
130
 
        """Return True if any entries were changed.
131
 
 
132
 
        This includes merge-only changes. It is the core for the --unchanged
133
 
        detection in commit.
134
 
 
135
 
        :return: True if any changes have occured.
136
 
        """
137
 
        raise NotImplementedError(self.any_changes)
138
 
 
139
 
    def _validate_unicode_text(self, text, context):
140
 
        """Verify things like commit messages don't have bogus characters."""
141
 
        if '\r' in text:
142
 
            raise ValueError('Invalid value for %s: %r' % (context, text))
143
 
 
144
 
    def _validate_revprops(self, revprops):
145
 
        for key, value in revprops.iteritems():
146
 
            # We know that the XML serializers do not round trip '\r'
147
 
            # correctly, so refuse to accept them
148
 
            if not isinstance(value, basestring):
149
 
                raise ValueError('revision property (%s) is not a valid'
150
 
                                 ' (unicode) string: %r' % (key, value))
151
 
            self._validate_unicode_text(value,
152
 
                                        'revision property (%s)' % (key,))
 
119
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
153
120
 
154
121
    def commit(self, message):
155
122
        """Make the actual commit.
156
123
 
157
124
        :return: The revision id of the recorded revision.
158
125
        """
159
 
        raise NotImplementedError(self.commit)
 
126
        rev = _mod_revision.Revision(
 
127
                       timestamp=self._timestamp,
 
128
                       timezone=self._timezone,
 
129
                       committer=self._committer,
 
130
                       message=message,
 
131
                       inventory_sha1=self.inv_sha1,
 
132
                       revision_id=self._new_revision_id,
 
133
                       properties=self._revprops)
 
134
        rev.parent_ids = self.parents
 
135
        self.repository.add_revision(self._new_revision_id, rev,
 
136
            self.new_inventory, self._config)
 
137
        self.repository.commit_write_group()
 
138
        return self._new_revision_id
160
139
 
161
140
    def abort(self):
162
141
        """Abort the commit that is being built.
163
142
        """
164
 
        raise NotImplementedError(self.abort)
 
143
        self.repository.abort_write_group()
165
144
 
166
145
    def revision_tree(self):
167
146
        """Return the tree that was just committed.
168
147
 
169
 
        After calling commit() this can be called to get a
170
 
        RevisionTree representing the newly committed tree. This is
171
 
        preferred to calling Repository.revision_tree() because that may
172
 
        require deserializing the inventory, while we already have a copy in
 
148
        After calling commit() this can be called to get a RevisionTree
 
149
        representing the newly committed tree. This is preferred to
 
150
        calling Repository.revision_tree() because that may require
 
151
        deserializing the inventory, while we already have a copy in
173
152
        memory.
174
153
        """
175
 
        raise NotImplementedError(self.revision_tree)
 
154
        return RevisionTree(self.repository, self.new_inventory,
 
155
                            self._new_revision_id)
176
156
 
177
157
    def finish_inventory(self):
178
 
        """Tell the builder that the inventory is finished.
179
 
 
180
 
        :return: The inventory id in the repository, which can be used with
181
 
            repository.get_inventory.
182
 
        """
183
 
        raise NotImplementedError(self.finish_inventory)
 
158
        """Tell the builder that the inventory is finished."""
 
159
        if self.new_inventory.root is None:
 
160
            raise AssertionError('Root entry should be supplied to'
 
161
                ' record_entry_contents, as of bzr 0.10.',
 
162
                 DeprecationWarning, stacklevel=2)
 
163
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
164
        self.new_inventory.revision_id = self._new_revision_id
 
165
        self.inv_sha1 = self.repository.add_inventory(
 
166
            self._new_revision_id,
 
167
            self.new_inventory,
 
168
            self.parents
 
169
            )
184
170
 
185
171
    def _gen_revision_id(self):
186
172
        """Return new revision-id."""
187
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
173
        return generate_ids.gen_revision_id(self._config.username(),
 
174
                                            self._timestamp)
188
175
 
189
176
    def _generate_revision_if_needed(self):
190
177
        """Create a revision id if None was supplied.
191
 
 
 
178
        
192
179
        If the repository can not support user-specified revision ids
193
180
        they should override this function and raise CannotSetRevisionId
194
181
        if _new_revision_id is not None.
201
188
        else:
202
189
            self.random_revid = False
203
190
 
204
 
    def will_record_deletes(self):
205
 
        """Tell the commit builder that deletes are being notified.
206
 
 
207
 
        This enables the accumulation of an inventory delta; for the resulting
208
 
        commit to be valid, deletes against the basis MUST be recorded via
209
 
        builder.record_delete().
210
 
        """
211
 
        raise NotImplementedError(self.will_record_deletes)
212
 
 
213
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes):
214
 
        """Record a new tree via iter_changes.
215
 
 
216
 
        :param tree: The tree to obtain text contents from for changed objects.
217
 
        :param basis_revision_id: The revision id of the tree the iter_changes
218
 
            has been generated against. Currently assumed to be the same
219
 
            as self.parents[0] - if it is not, errors may occur.
220
 
        :param iter_changes: An iter_changes iterator with the changes to apply
221
 
            to basis_revision_id. The iterator must not include any items with
222
 
            a current kind of None - missing items must be either filtered out
223
 
            or errored-on beefore record_iter_changes sees the item.
224
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
225
 
            tree._observed_sha1.
226
 
        """
227
 
        raise NotImplementedError(self.record_iter_changes)
228
 
 
229
 
 
230
 
class RepositoryWriteLockResult(LogicalLockResult):
231
 
    """The result of write locking a repository.
232
 
 
233
 
    :ivar repository_token: The token obtained from the underlying lock, or
234
 
        None.
235
 
    :ivar unlock: A callable which will unlock the lock.
236
 
    """
237
 
 
238
 
    def __init__(self, unlock, repository_token):
239
 
        LogicalLockResult.__init__(self, unlock)
240
 
        self.repository_token = repository_token
241
 
 
242
 
    def __repr__(self):
243
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
244
 
            self.unlock)
 
191
    def _heads(self, file_id, revision_ids):
 
192
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
193
 
 
194
        This can use either a per-file graph or a global revision graph as we
 
195
        have an identity relationship between the two graphs.
 
196
        """
 
197
        return self.__heads(revision_ids)
 
198
 
 
199
    def _check_root(self, ie, parent_invs, tree):
 
200
        """Helper for record_entry_contents.
 
201
 
 
202
        :param ie: An entry being added.
 
203
        :param parent_invs: The inventories of the parent revisions of the
 
204
            commit.
 
205
        :param tree: The tree that is being committed.
 
206
        """
 
207
        # In this revision format, root entries have no knit or weave When
 
208
        # serializing out to disk and back in root.revision is always
 
209
        # _new_revision_id
 
210
        ie.revision = self._new_revision_id
 
211
 
 
212
    def _get_delta(self, ie, basis_inv, path):
 
213
        """Get a delta against the basis inventory for ie."""
 
214
        if ie.file_id not in basis_inv:
 
215
            # add
 
216
            return (None, path, ie.file_id, ie)
 
217
        elif ie != basis_inv[ie.file_id]:
 
218
            # common but altered
 
219
            # TODO: avoid tis id2path call.
 
220
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
221
        else:
 
222
            # common, unaltered
 
223
            return None
 
224
 
 
225
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
226
        content_summary):
 
227
        """Record the content of ie from tree into the commit if needed.
 
228
 
 
229
        Side effect: sets ie.revision when unchanged
 
230
 
 
231
        :param ie: An inventory entry present in the commit.
 
232
        :param parent_invs: The inventories of the parent revisions of the
 
233
            commit.
 
234
        :param path: The path the entry is at in the tree.
 
235
        :param tree: The tree which contains this entry and should be used to 
 
236
            obtain content.
 
237
        :param content_summary: Summary data from the tree about the paths
 
238
            content - stat, length, exec, sha/link target. This is only
 
239
            accessed when the entry has a revision of None - that is when it is
 
240
            a candidate to commit.
 
241
        :return: A tuple (change_delta, version_recorded). change_delta is 
 
242
            an inventory_delta change for this entry against the basis tree of
 
243
            the commit, or None if no change occured against the basis tree.
 
244
            version_recorded is True if a new version of the entry has been
 
245
            recorded. For instance, committing a merge where a file was only
 
246
            changed on the other side will return (delta, False).
 
247
        """
 
248
        if self.new_inventory.root is None:
 
249
            if ie.parent_id is not None:
 
250
                raise errors.RootMissing()
 
251
            self._check_root(ie, parent_invs, tree)
 
252
        if ie.revision is None:
 
253
            kind = content_summary[0]
 
254
        else:
 
255
            # ie is carried over from a prior commit
 
256
            kind = ie.kind
 
257
        # XXX: repository specific check for nested tree support goes here - if
 
258
        # the repo doesn't want nested trees we skip it ?
 
259
        if (kind == 'tree-reference' and
 
260
            not self.repository._format.supports_tree_reference):
 
261
            # mismatch between commit builder logic and repository:
 
262
            # this needs the entry creation pushed down into the builder.
 
263
            raise NotImplementedError('Missing repository subtree support.')
 
264
        self.new_inventory.add(ie)
 
265
 
 
266
        # TODO: slow, take it out of the inner loop.
 
267
        try:
 
268
            basis_inv = parent_invs[0]
 
269
        except IndexError:
 
270
            basis_inv = Inventory(root_id=None)
 
271
 
 
272
        # ie.revision is always None if the InventoryEntry is considered
 
273
        # for committing. We may record the previous parents revision if the
 
274
        # content is actually unchanged against a sole head.
 
275
        if ie.revision is not None:
 
276
            if not self._versioned_root and path == '':
 
277
                # repositories that do not version the root set the root's
 
278
                # revision to the new commit even when no change occurs, and
 
279
                # this masks when a change may have occurred against the basis,
 
280
                # so calculate if one happened.
 
281
                if ie.file_id in basis_inv:
 
282
                    delta = (basis_inv.id2path(ie.file_id), path,
 
283
                        ie.file_id, ie)
 
284
                else:
 
285
                    # add
 
286
                    delta = (None, path, ie.file_id, ie)
 
287
                return delta, False
 
288
            else:
 
289
                # we don't need to commit this, because the caller already
 
290
                # determined that an existing revision of this file is
 
291
                # appropriate.
 
292
                return None, (ie.revision == self._new_revision_id)
 
293
        # XXX: Friction: parent_candidates should return a list not a dict
 
294
        #      so that we don't have to walk the inventories again.
 
295
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
296
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
297
        heads = []
 
298
        for inv in parent_invs:
 
299
            if ie.file_id in inv:
 
300
                old_rev = inv[ie.file_id].revision
 
301
                if old_rev in head_set:
 
302
                    heads.append(inv[ie.file_id].revision)
 
303
                    head_set.remove(inv[ie.file_id].revision)
 
304
 
 
305
        store = False
 
306
        # now we check to see if we need to write a new record to the
 
307
        # file-graph.
 
308
        # We write a new entry unless there is one head to the ancestors, and
 
309
        # the kind-derived content is unchanged.
 
310
 
 
311
        # Cheapest check first: no ancestors, or more the one head in the
 
312
        # ancestors, we write a new node.
 
313
        if len(heads) != 1:
 
314
            store = True
 
315
        if not store:
 
316
            # There is a single head, look it up for comparison
 
317
            parent_entry = parent_candiate_entries[heads[0]]
 
318
            # if the non-content specific data has changed, we'll be writing a
 
319
            # node:
 
320
            if (parent_entry.parent_id != ie.parent_id or
 
321
                parent_entry.name != ie.name):
 
322
                store = True
 
323
        # now we need to do content specific checks:
 
324
        if not store:
 
325
            # if the kind changed the content obviously has
 
326
            if kind != parent_entry.kind:
 
327
                store = True
 
328
        if kind == 'file':
 
329
            if content_summary[2] is None:
 
330
                raise ValueError("Files must not have executable = None")
 
331
            if not store:
 
332
                if (# if the file length changed we have to store:
 
333
                    parent_entry.text_size != content_summary[1] or
 
334
                    # if the exec bit has changed we have to store:
 
335
                    parent_entry.executable != content_summary[2]):
 
336
                    store = True
 
337
                elif parent_entry.text_sha1 == content_summary[3]:
 
338
                    # all meta and content is unchanged (using a hash cache
 
339
                    # hit to check the sha)
 
340
                    ie.revision = parent_entry.revision
 
341
                    ie.text_size = parent_entry.text_size
 
342
                    ie.text_sha1 = parent_entry.text_sha1
 
343
                    ie.executable = parent_entry.executable
 
344
                    return self._get_delta(ie, basis_inv, path), False
 
345
                else:
 
346
                    # Either there is only a hash change(no hash cache entry,
 
347
                    # or same size content change), or there is no change on
 
348
                    # this file at all.
 
349
                    # Provide the parent's hash to the store layer, so that the
 
350
                    # content is unchanged we will not store a new node.
 
351
                    nostore_sha = parent_entry.text_sha1
 
352
            if store:
 
353
                # We want to record a new node regardless of the presence or
 
354
                # absence of a content change in the file.
 
355
                nostore_sha = None
 
356
            ie.executable = content_summary[2]
 
357
            lines = tree.get_file(ie.file_id, path).readlines()
 
358
            try:
 
359
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
360
                    ie.file_id, lines, heads, nostore_sha)
 
361
            except errors.ExistingContent:
 
362
                # Turns out that the file content was unchanged, and we were
 
363
                # only going to store a new node if it was changed. Carry over
 
364
                # the entry.
 
365
                ie.revision = parent_entry.revision
 
366
                ie.text_size = parent_entry.text_size
 
367
                ie.text_sha1 = parent_entry.text_sha1
 
368
                ie.executable = parent_entry.executable
 
369
                return self._get_delta(ie, basis_inv, path), False
 
370
        elif kind == 'directory':
 
371
            if not store:
 
372
                # all data is meta here, nothing specific to directory, so
 
373
                # carry over:
 
374
                ie.revision = parent_entry.revision
 
375
                return self._get_delta(ie, basis_inv, path), False
 
376
            lines = []
 
377
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
378
        elif kind == 'symlink':
 
379
            current_link_target = content_summary[3]
 
380
            if not store:
 
381
                # symlink target is not generic metadata, check if it has
 
382
                # changed.
 
383
                if current_link_target != parent_entry.symlink_target:
 
384
                    store = True
 
385
            if not store:
 
386
                # unchanged, carry over.
 
387
                ie.revision = parent_entry.revision
 
388
                ie.symlink_target = parent_entry.symlink_target
 
389
                return self._get_delta(ie, basis_inv, path), False
 
390
            ie.symlink_target = current_link_target
 
391
            lines = []
 
392
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
393
        elif kind == 'tree-reference':
 
394
            if not store:
 
395
                if content_summary[3] != parent_entry.reference_revision:
 
396
                    store = True
 
397
            if not store:
 
398
                # unchanged, carry over.
 
399
                ie.reference_revision = parent_entry.reference_revision
 
400
                ie.revision = parent_entry.revision
 
401
                return self._get_delta(ie, basis_inv, path), False
 
402
            ie.reference_revision = content_summary[3]
 
403
            lines = []
 
404
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
405
        else:
 
406
            raise NotImplementedError('unknown kind')
 
407
        ie.revision = self._new_revision_id
 
408
        return self._get_delta(ie, basis_inv, path), True
 
409
 
 
410
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
411
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
412
            file_id, self.repository.get_transaction())
 
413
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
414
        # than add_lines, and allows committing when a parent is ghosted for
 
415
        # some reason.
 
416
        # Note: as we read the content directly from the tree, we know its not
 
417
        # been turned into unicode or badly split - but a broken tree
 
418
        # implementation could give us bad output from readlines() so this is
 
419
        # not a guarantee of safety. What would be better is always checking
 
420
        # the content during test suite execution. RBC 20070912
 
421
        return versionedfile.add_lines_with_ghosts(
 
422
            self._new_revision_id, parents, new_lines,
 
423
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
424
            check_content=False)[0:2]
 
425
 
 
426
 
 
427
class RootCommitBuilder(CommitBuilder):
 
428
    """This commitbuilder actually records the root id"""
 
429
    
 
430
    # the root entry gets versioned properly by this builder.
 
431
    _versioned_root = True
 
432
 
 
433
    def _check_root(self, ie, parent_invs, tree):
 
434
        """Helper for record_entry_contents.
 
435
 
 
436
        :param ie: An entry being added.
 
437
        :param parent_invs: The inventories of the parent revisions of the
 
438
            commit.
 
439
        :param tree: The tree that is being committed.
 
440
        """
245
441
 
246
442
 
247
443
######################################################################
248
444
# Repositories
249
445
 
250
 
 
251
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
446
class Repository(object):
252
447
    """Repository holding history for one or more branches.
253
448
 
254
449
    The repository holds and retrieves historical information including
255
450
    revisions and file history.  It's normally accessed only by the Branch,
256
451
    which views a particular line of development through that history.
257
452
 
258
 
    See VersionedFileRepository in bzrlib.vf_repository for the
259
 
    base class for most Bazaar repositories.
 
453
    The Repository builds on top of Stores and a Transport, which respectively 
 
454
    describe the disk data format and the way of accessing the (possibly 
 
455
    remote) disk.
 
456
 
 
457
    :ivar _transport: Transport for file access to repository, typically
 
458
        pointing to .bzr/repository.
260
459
    """
261
460
 
262
 
    def abort_write_group(self, suppress_errors=False):
 
461
    # What class to use for a CommitBuilder. Often its simpler to change this
 
462
    # in a Repository class subclass rather than to override
 
463
    # get_commit_builder.
 
464
    _commit_builder_class = CommitBuilder
 
465
    # The search regex used by xml based repositories to determine what things
 
466
    # where changed in a single commit.
 
467
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
468
        r'file_id="(?P<file_id>[^"]+)"'
 
469
        r'.* revision="(?P<revision_id>[^"]+)"'
 
470
        )
 
471
 
 
472
    def abort_write_group(self):
263
473
        """Commit the contents accrued within the current write group.
264
474
 
265
 
        :param suppress_errors: if true, abort_write_group will catch and log
266
 
            unexpected errors that happen during the abort, rather than
267
 
            allowing them to propagate.  Defaults to False.
268
 
 
269
475
        :seealso: start_write_group.
270
476
        """
271
477
        if self._write_group is not self.get_transaction():
272
478
            # has an unlock or relock occured ?
273
 
            if suppress_errors:
274
 
                mutter(
275
 
                '(suppressed) mismatched lock context and write group. %r, %r',
276
 
                self._write_group, self.get_transaction())
277
 
                return
278
 
            raise errors.BzrError(
279
 
                'mismatched lock context and write group. %r, %r' %
280
 
                (self._write_group, self.get_transaction()))
281
 
        try:
282
 
            self._abort_write_group()
283
 
        except Exception, exc:
284
 
            self._write_group = None
285
 
            if not suppress_errors:
286
 
                raise
287
 
            mutter('abort_write_group failed')
288
 
            log_exception_quietly()
289
 
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
479
            raise errors.BzrError('mismatched lock context and write group.')
 
480
        self._abort_write_group()
290
481
        self._write_group = None
291
482
 
292
483
    def _abort_write_group(self):
293
484
        """Template method for per-repository write group cleanup.
294
 
 
295
 
        This is called during abort before the write group is considered to be
 
485
        
 
486
        This is called during abort before the write group is considered to be 
296
487
        finished and should cleanup any internal state accrued during the write
297
488
        group. There is no requirement that data handed to the repository be
298
489
        *not* made available - this is not a rollback - but neither should any
302
493
        attempted.
303
494
        """
304
495
 
305
 
    def add_fallback_repository(self, repository):
306
 
        """Add a repository to use for looking up data not held locally.
307
 
 
308
 
        :param repository: A repository.
309
 
        """
310
 
        raise NotImplementedError(self.add_fallback_repository)
311
 
 
312
 
    def _check_fallback_repository(self, repository):
313
 
        """Check that this repository can fallback to repository safely.
314
 
 
315
 
        Raise an error if not.
316
 
 
317
 
        :param repository: A repository to fallback to.
318
 
        """
319
 
        return InterRepository._assert_same_model(self, repository)
 
496
    def add_inventory(self, revision_id, inv, parents):
 
497
        """Add the inventory inv to the repository as revision_id.
 
498
        
 
499
        :param parents: The revision ids of the parents that revision_id
 
500
                        is known to have and are in the repository already.
 
501
 
 
502
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
503
            repository format specific) of the serialized inventory.
 
504
        """
 
505
        if not self.is_in_write_group():
 
506
            raise AssertionError("%r not in write group" % (self,))
 
507
        _mod_revision.check_not_reserved_id(revision_id)
 
508
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
509
            raise AssertionError(
 
510
                "Mismatch between inventory revision"
 
511
                " id and insertion revid (%r, %r)"
 
512
                % (inv.revision_id, revision_id))
 
513
        if inv.root is None:
 
514
            raise AssertionError()
 
515
        inv_lines = self._serialise_inventory_to_lines(inv)
 
516
        inv_vf = self.get_inventory_weave()
 
517
        return self._inventory_add_lines(inv_vf, revision_id, parents,
 
518
            inv_lines, check_content=False)
 
519
 
 
520
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
 
521
        check_content=True):
 
522
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
523
        final_parents = []
 
524
        for parent in parents:
 
525
            if parent in inv_vf:
 
526
                final_parents.append(parent)
 
527
        return inv_vf.add_lines(revision_id, final_parents, lines,
 
528
            check_content=check_content)[0]
 
529
 
 
530
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
531
        """Add rev to the revision store as revision_id.
 
532
 
 
533
        :param revision_id: the revision id to use.
 
534
        :param rev: The revision object.
 
535
        :param inv: The inventory for the revision. if None, it will be looked
 
536
                    up in the inventory storer
 
537
        :param config: If None no digital signature will be created.
 
538
                       If supplied its signature_needed method will be used
 
539
                       to determine if a signature should be made.
 
540
        """
 
541
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
542
        #       rev.parent_ids?
 
543
        _mod_revision.check_not_reserved_id(revision_id)
 
544
        if config is not None and config.signature_needed():
 
545
            if inv is None:
 
546
                inv = self.get_inventory(revision_id)
 
547
            plaintext = Testament(rev, inv).as_short_text()
 
548
            self.store_revision_signature(
 
549
                gpg.GPGStrategy(config), plaintext, revision_id)
 
550
        inventory_vf = self.get_inventory_weave()
 
551
        if not revision_id in inventory_vf:
 
552
            if inv is None:
 
553
                raise errors.WeaveRevisionNotPresent(revision_id,
 
554
                                                     inventory_vf)
 
555
            else:
 
556
                # yes, this is not suitable for adding with ghosts.
 
557
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
558
                                                        rev.parent_ids)
 
559
        else:
 
560
            rev.inventory_sha1 = inventory_vf.get_sha1s([revision_id])[0]
 
561
        self._revision_store.add_revision(rev, self.get_transaction())
 
562
 
 
563
    def _add_revision_text(self, revision_id, text):
 
564
        revision = self._revision_store._serializer.read_revision_from_string(
 
565
            text)
 
566
        self._revision_store._add_revision(revision, StringIO(text),
 
567
                                           self.get_transaction())
320
568
 
321
569
    def all_revision_ids(self):
322
 
        """Returns a list of all the revision ids in the repository.
 
570
        """Returns a list of all the revision ids in the repository. 
323
571
 
324
 
        This is conceptually deprecated because code should generally work on
325
 
        the graph reachable from a particular revision, and ignore any other
326
 
        revisions that might be present.  There is no direct replacement
327
 
        method.
 
572
        This is deprecated because code should generally work on the graph
 
573
        reachable from a particular revision, and ignore any other revisions
 
574
        that might be present.  There is no direct replacement method.
328
575
        """
329
576
        if 'evil' in debug.debug_flags:
330
577
            mutter_callsite(2, "all_revision_ids is linear with history.")
331
578
        return self._all_revision_ids()
332
579
 
333
580
    def _all_revision_ids(self):
334
 
        """Returns a list of all the revision ids in the repository.
 
581
        """Returns a list of all the revision ids in the repository. 
335
582
 
336
 
        These are in as much topological order as the underlying store can
 
583
        These are in as much topological order as the underlying store can 
337
584
        present.
338
585
        """
339
586
        raise NotImplementedError(self._all_revision_ids)
346
593
        """
347
594
        self.control_files.break_lock()
348
595
 
 
596
    @needs_read_lock
 
597
    def _eliminate_revisions_not_present(self, revision_ids):
 
598
        """Check every revision id in revision_ids to see if we have it.
 
599
 
 
600
        Returns a set of the present revisions.
 
601
        """
 
602
        result = []
 
603
        graph = self.get_graph()
 
604
        parent_map = graph.get_parent_map(revision_ids)
 
605
        # The old API returned a list, should this actually be a set?
 
606
        return parent_map.keys()
 
607
 
349
608
    @staticmethod
350
 
    def create(controldir):
351
 
        """Construct the current default format repository in controldir."""
352
 
        return RepositoryFormat.get_default_format().initialize(controldir)
 
609
    def create(a_bzrdir):
 
610
        """Construct the current default format repository in a_bzrdir."""
 
611
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
353
612
 
354
 
    def __init__(self, _format, controldir, control_files):
 
613
    def __init__(self, _format, a_bzrdir, control_files,
 
614
                 _revision_store, control_store, text_store):
355
615
        """instantiate a Repository.
356
616
 
357
617
        :param _format: The format of the repository on disk.
358
 
        :param controldir: The ControlDir of the repository.
359
 
        :param control_files: Control files to use for locking, etc.
 
618
        :param a_bzrdir: The BzrDir of the repository.
 
619
 
 
620
        In the future we will have a single api for all stores for
 
621
        getting file texts, inventories and revisions, then
 
622
        this construct will accept instances of those things.
360
623
        """
361
 
        # In the future we will have a single api for all stores for
362
 
        # getting file texts, inventories and revisions, then
363
 
        # this construct will accept instances of those things.
364
624
        super(Repository, self).__init__()
365
625
        self._format = _format
366
626
        # the following are part of the public API for Repository:
367
 
        self.bzrdir = controldir
 
627
        self.bzrdir = a_bzrdir
368
628
        self.control_files = control_files
 
629
        self._transport = control_files._transport
 
630
        self.base = self._transport.base
 
631
        self._revision_store = _revision_store
 
632
        # backwards compatibility
 
633
        self.weave_store = text_store
369
634
        # for tests
 
635
        self._reconcile_does_inventory_gc = True
 
636
        self._reconcile_fixes_text_parents = False
 
637
        self._reconcile_backsup_inventory = True
 
638
        # not right yet - should be more semantically clear ? 
 
639
        # 
 
640
        self.control_store = control_store
 
641
        self.control_weaves = control_store
 
642
        # TODO: make sure to construct the right store classes, etc, depending
 
643
        # on whether escaping is required.
 
644
        self._warn_if_deprecated()
370
645
        self._write_group = None
371
 
        # Additional places to query for data.
372
 
        self._fallback_repositories = []
373
 
 
374
 
    @property
375
 
    def user_transport(self):
376
 
        return self.bzrdir.user_transport
377
 
 
378
 
    @property
379
 
    def control_transport(self):
380
 
        return self._transport
381
646
 
382
647
    def __repr__(self):
383
 
        if self._fallback_repositories:
384
 
            return '%s(%r, fallback_repositories=%r)' % (
385
 
                self.__class__.__name__,
386
 
                self.base,
387
 
                self._fallback_repositories)
388
 
        else:
389
 
            return '%s(%r)' % (self.__class__.__name__,
390
 
                               self.base)
391
 
 
392
 
    def _has_same_fallbacks(self, other_repo):
393
 
        """Returns true if the repositories have the same fallbacks."""
394
 
        my_fb = self._fallback_repositories
395
 
        other_fb = other_repo._fallback_repositories
396
 
        if len(my_fb) != len(other_fb):
397
 
            return False
398
 
        for f, g in zip(my_fb, other_fb):
399
 
            if not f.has_same_location(g):
400
 
                return False
401
 
        return True
 
648
        return '%s(%r)' % (self.__class__.__name__,
 
649
                           self.base)
402
650
 
403
651
    def has_same_location(self, other):
404
652
        """Returns a boolean indicating if this repository is at the same
409
657
        """
410
658
        if self.__class__ is not other.__class__:
411
659
            return False
412
 
        return (self.control_url == other.control_url)
 
660
        return (self._transport.base == other._transport.base)
413
661
 
414
662
    def is_in_write_group(self):
415
663
        """Return True if there is an open write group.
431
679
        This causes caching within the repository obejct to start accumlating
432
680
        data during reads, and allows a 'write_group' to be obtained. Write
433
681
        groups must be used for actual data insertion.
434
 
 
435
 
        A token should be passed in if you know that you have locked the object
436
 
        some other way, and need to synchronise this object's state with that
437
 
        fact.
438
 
 
439
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
440
 
 
 
682
        
441
683
        :param token: if this is already locked, then lock_write will fail
442
684
            unless the token matches the existing lock.
443
685
        :returns: a token if this instance supports tokens, otherwise None.
446
688
        :raises MismatchedToken: if the specified token doesn't match the token
447
689
            of the existing lock.
448
690
        :seealso: start_write_group.
449
 
        :return: A RepositoryWriteLockResult.
 
691
 
 
692
        A token should be passed in if you know that you have locked the object
 
693
        some other way, and need to synchronise this object's state with that
 
694
        fact.
 
695
 
 
696
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
450
697
        """
451
 
        locked = self.is_locked()
452
 
        token = self.control_files.lock_write(token=token)
453
 
        if not locked:
454
 
            self._warn_if_deprecated()
455
 
            self._note_lock('w')
456
 
            for repo in self._fallback_repositories:
457
 
                # Writes don't affect fallback repos
458
 
                repo.lock_read()
459
 
            self._refresh_data()
460
 
        return RepositoryWriteLockResult(self.unlock, token)
 
698
        result = self.control_files.lock_write(token=token)
 
699
        self._refresh_data()
 
700
        return result
461
701
 
462
702
    def lock_read(self):
463
 
        """Lock the repository for read operations.
464
 
 
465
 
        :return: An object with an unlock method which will release the lock
466
 
            obtained.
467
 
        """
468
 
        locked = self.is_locked()
469
703
        self.control_files.lock_read()
470
 
        if not locked:
471
 
            self._warn_if_deprecated()
472
 
            self._note_lock('r')
473
 
            for repo in self._fallback_repositories:
474
 
                repo.lock_read()
475
 
            self._refresh_data()
476
 
        return LogicalLockResult(self.unlock)
 
704
        self._refresh_data()
477
705
 
478
706
    def get_physical_lock_status(self):
479
707
        return self.control_files.get_physical_lock_status()
481
709
    def leave_lock_in_place(self):
482
710
        """Tell this repository not to release the physical lock when this
483
711
        object is unlocked.
484
 
 
 
712
        
485
713
        If lock_write doesn't return a token, then this method is not supported.
486
714
        """
487
715
        self.control_files.leave_in_place()
515
743
        if revid and committers:
516
744
            result['committers'] = 0
517
745
        if revid and revid != _mod_revision.NULL_REVISION:
518
 
            graph = self.get_graph()
519
746
            if committers:
520
747
                all_committers = set()
521
 
            revisions = [r for (r, p) in graph.iter_ancestry([revid])
522
 
                        if r != _mod_revision.NULL_REVISION]
523
 
            last_revision = None
 
748
            revisions = self.get_ancestry(revid)
 
749
            # pop the leading None
 
750
            revisions.pop(0)
 
751
            first_revision = None
524
752
            if not committers:
525
753
                # ignore the revisions in the middle - just grab first and last
526
754
                revisions = revisions[0], revisions[-1]
527
755
            for revision in self.get_revisions(revisions):
528
 
                if not last_revision:
529
 
                    last_revision = revision
 
756
                if not first_revision:
 
757
                    first_revision = revision
530
758
                if committers:
531
759
                    all_committers.add(revision.committer)
532
 
            first_revision = revision
 
760
            last_revision = revision
533
761
            if committers:
534
762
                result['committers'] = len(all_committers)
535
763
            result['firstrev'] = (first_revision.timestamp,
536
764
                first_revision.timezone)
537
765
            result['latestrev'] = (last_revision.timestamp,
538
766
                last_revision.timezone)
 
767
 
 
768
        # now gather global repository information
 
769
        if self.bzrdir.root_transport.listable():
 
770
            c, t = self._revision_store.total_size(self.get_transaction())
 
771
            result['revisions'] = c
 
772
            result['size'] = t
539
773
        return result
540
774
 
541
775
    def find_branches(self, using=False):
546
780
        :param using: If True, list only branches using this repository.
547
781
        """
548
782
        if using and not self.is_shared():
549
 
            return self.bzrdir.list_branches()
 
783
            try:
 
784
                return [self.bzrdir.open_branch()]
 
785
            except errors.NotBranchError:
 
786
                return []
550
787
        class Evaluator(object):
551
788
 
552
789
            def __init__(self):
553
790
                self.first_call = True
554
791
 
555
 
            def __call__(self, controldir):
556
 
                # On the first call, the parameter is always the controldir
 
792
            def __call__(self, bzrdir):
 
793
                # On the first call, the parameter is always the bzrdir
557
794
                # containing the current repo.
558
795
                if not self.first_call:
559
796
                    try:
560
 
                        repository = controldir.open_repository()
 
797
                        repository = bzrdir.open_repository()
561
798
                    except errors.NoRepositoryPresent:
562
799
                        pass
563
800
                    else:
564
 
                        return False, ([], repository)
 
801
                        return False, (None, repository)
565
802
                self.first_call = False
566
 
                value = (controldir.list_branches(), None)
 
803
                try:
 
804
                    value = (bzrdir.open_branch(), None)
 
805
                except errors.NotBranchError:
 
806
                    value = (None, None)
567
807
                return True, value
568
808
 
569
 
        ret = []
570
 
        for branches, repository in controldir.ControlDir.find_bzrdirs(
571
 
                self.user_transport, evaluate=Evaluator()):
572
 
            if branches is not None:
573
 
                ret.extend(branches)
 
809
        branches = []
 
810
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
811
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
812
            if branch is not None:
 
813
                branches.append(branch)
574
814
            if not using and repository is not None:
575
 
                ret.extend(repository.find_branches())
576
 
        return ret
 
815
                branches.extend(repository.find_branches())
 
816
        return branches
 
817
 
 
818
    def get_data_stream(self, revision_ids):
 
819
        raise NotImplementedError(self.get_data_stream)
 
820
 
 
821
    def get_data_stream_for_search(self, search_result):
 
822
        """Get a data stream that can be inserted to a repository.
 
823
 
 
824
        :param search_result: A bzrlib.graph.SearchResult selecting the
 
825
            revisions to get.
 
826
        :return: A data stream that can be inserted into a repository using
 
827
            insert_data_stream.
 
828
        """
 
829
        raise NotImplementedError(self.get_data_stream_for_search)
 
830
 
 
831
    def insert_data_stream(self, stream):
 
832
        """XXX What does this really do? 
 
833
        
 
834
        Is it a substitute for fetch? 
 
835
        Should it manage its own write group ?
 
836
        """
 
837
        for item_key, bytes in stream:
 
838
            if item_key[0] == 'file':
 
839
                (file_id,) = item_key[1:]
 
840
                knit = self.weave_store.get_weave_or_empty(
 
841
                    file_id, self.get_transaction())
 
842
            elif item_key == ('inventory',):
 
843
                knit = self.get_inventory_weave()
 
844
            elif item_key == ('revisions',):
 
845
                knit = self._revision_store.get_revision_file(
 
846
                    self.get_transaction())
 
847
            elif item_key == ('signatures',):
 
848
                knit = self._revision_store.get_signature_file(
 
849
                    self.get_transaction())
 
850
            else:
 
851
                raise errors.RepositoryDataStreamError(
 
852
                    "Unrecognised data stream key '%s'" % (item_key,))
 
853
            decoded_list = bencode.bdecode(bytes)
 
854
            format = decoded_list.pop(0)
 
855
            data_list = []
 
856
            knit_bytes = ''
 
857
            for version, options, parents, some_bytes in decoded_list:
 
858
                data_list.append((version, options, len(some_bytes), parents))
 
859
                knit_bytes += some_bytes
 
860
            buffer = StringIO(knit_bytes)
 
861
            def reader_func(count):
 
862
                if count is None:
 
863
                    return buffer.read()
 
864
                else:
 
865
                    return buffer.read(count)
 
866
            knit.insert_data_stream(
 
867
                (format, data_list, reader_func))
577
868
 
578
869
    @needs_read_lock
579
 
    def search_missing_revision_ids(self, other,
580
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
581
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
582
 
            limit=None):
 
870
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
583
871
        """Return the revision ids that other has that this does not.
584
 
 
 
872
        
585
873
        These are returned in topological order.
586
874
 
587
875
        revision_id: only return revision ids included by revision_id.
588
876
        """
589
 
        if symbol_versioning.deprecated_passed(revision_id):
590
 
            symbol_versioning.warn(
591
 
                'search_missing_revision_ids(revision_id=...) was '
592
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
593
 
                DeprecationWarning, stacklevel=3)
594
 
            if revision_ids is not None:
595
 
                raise AssertionError(
596
 
                    'revision_ids is mutually exclusive with revision_id')
597
 
            if revision_id is not None:
598
 
                revision_ids = [revision_id]
599
877
        return InterRepository.get(other, self).search_missing_revision_ids(
600
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
601
 
            if_present_ids=if_present_ids, limit=limit)
 
878
            revision_id, find_ghosts)
 
879
 
 
880
    @deprecated_method(symbol_versioning.one_two)
 
881
    @needs_read_lock
 
882
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
883
        """Return the revision ids that other has that this does not.
 
884
        
 
885
        These are returned in topological order.
 
886
 
 
887
        revision_id: only return revision ids included by revision_id.
 
888
        """
 
889
        keys =  self.search_missing_revision_ids(
 
890
            other, revision_id, find_ghosts).get_keys()
 
891
        other.lock_read()
 
892
        try:
 
893
            parents = other.get_graph().get_parent_map(keys)
 
894
        finally:
 
895
            other.unlock()
 
896
        return tsort.topo_sort(parents)
602
897
 
603
898
    @staticmethod
604
899
    def open(base):
607
902
        For instance, if the repository is at URL/.bzr/repository,
608
903
        Repository.open(URL) -> a Repository instance.
609
904
        """
610
 
        control = controldir.ControlDir.open(base)
 
905
        control = bzrdir.BzrDir.open(base)
611
906
        return control.open_repository()
612
907
 
613
908
    def copy_content_into(self, destination, revision_id=None):
614
909
        """Make a complete copy of the content in self into destination.
615
 
 
616
 
        This is a destructive operation! Do not use it on existing
 
910
        
 
911
        This is a destructive operation! Do not use it on existing 
617
912
        repositories.
618
913
        """
619
914
        return InterRepository.get(self, destination).copy_content(revision_id)
622
917
        """Commit the contents accrued within the current write group.
623
918
 
624
919
        :seealso: start_write_group.
625
 
        
626
 
        :return: it may return an opaque hint that can be passed to 'pack'.
627
920
        """
628
921
        if self._write_group is not self.get_transaction():
629
922
            # has an unlock or relock occured ?
630
923
            raise errors.BzrError('mismatched lock context %r and '
631
924
                'write group %r.' %
632
925
                (self.get_transaction(), self._write_group))
633
 
        result = self._commit_write_group()
 
926
        self._commit_write_group()
634
927
        self._write_group = None
635
 
        return result
636
928
 
637
929
    def _commit_write_group(self):
638
930
        """Template method for per-repository write group cleanup.
639
 
 
640
 
        This is called before the write group is considered to be
 
931
        
 
932
        This is called before the write group is considered to be 
641
933
        finished and should ensure that all data handed to the repository
642
 
        for writing during the write group is safely committed (to the
 
934
        for writing during the write group is safely committed (to the 
643
935
        extent possible considering file system caching etc).
644
936
        """
645
937
 
646
 
    def suspend_write_group(self):
647
 
        """Suspend a write group.
648
 
 
649
 
        :raise UnsuspendableWriteGroup: If the write group can not be
650
 
            suspended.
651
 
        :return: List of tokens
652
 
        """
653
 
        raise errors.UnsuspendableWriteGroup(self)
654
 
 
655
 
    def refresh_data(self):
656
 
        """Re-read any data needed to synchronise with disk.
657
 
 
658
 
        This method is intended to be called after another repository instance
659
 
        (such as one used by a smart server) has inserted data into the
660
 
        repository. On all repositories this will work outside of write groups.
661
 
        Some repository formats (pack and newer for bzrlib native formats)
662
 
        support refresh_data inside write groups. If called inside a write
663
 
        group on a repository that does not support refreshing in a write group
664
 
        IsInWriteGroupError will be raised.
665
 
        """
666
 
        self._refresh_data()
667
 
 
668
 
    def resume_write_group(self, tokens):
669
 
        if not self.is_write_locked():
670
 
            raise errors.NotWriteLocked(self)
671
 
        if self._write_group:
672
 
            raise errors.BzrError('already in a write group')
673
 
        self._resume_write_group(tokens)
674
 
        # so we can detect unlock/relock - the write group is now entered.
675
 
        self._write_group = self.get_transaction()
676
 
 
677
 
    def _resume_write_group(self, tokens):
678
 
        raise errors.UnsuspendableWriteGroup(self)
679
 
 
680
 
    def fetch(self, source, revision_id=None, find_ghosts=False):
 
938
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
681
939
        """Fetch the content required to construct revision_id from source.
682
940
 
683
 
        If revision_id is None, then all content is copied.
684
 
 
685
 
        fetch() may not be used when the repository is in a write group -
686
 
        either finish the current write group before using fetch, or use
687
 
        fetch before starting the write group.
688
 
 
 
941
        If revision_id is None all content is copied.
689
942
        :param find_ghosts: Find and copy revisions in the source that are
690
943
            ghosts in the target (and not reachable directly by walking out to
691
944
            the first-present revision in target from revision_id).
692
 
        :param revision_id: If specified, all the content needed for this
693
 
            revision ID will be copied to the target.  Fetch will determine for
694
 
            itself which content needs to be copied.
695
945
        """
696
 
        if self.is_in_write_group():
697
 
            raise errors.InternalBzrError(
698
 
                "May not fetch while in a write group.")
699
946
        # fast path same-url fetch operations
700
 
        # TODO: lift out to somewhere common with RemoteRepository
701
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
702
 
        if (self.has_same_location(source)
703
 
            and self._has_same_fallbacks(source)):
 
947
        if self.has_same_location(source):
704
948
            # check that last_revision is in 'from' and then return a
705
949
            # no-operation.
706
950
            if (revision_id is not None and
708
952
                self.get_revision(revision_id)
709
953
            return 0, []
710
954
        inter = InterRepository.get(source, self)
711
 
        return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
 
955
        try:
 
956
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
957
        except NotImplementedError:
 
958
            raise errors.IncompatibleRepositories(source, self)
712
959
 
713
960
    def create_bundle(self, target, base, fileobj, format=None):
714
961
        return serializer.write_bundle(self, target, base, fileobj, format)
715
962
 
716
 
    def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
 
963
    def get_commit_builder(self, branch, parents, config, timestamp=None,
717
964
                           timezone=None, committer=None, revprops=None,
718
 
                           revision_id=None, lossy=False):
 
965
                           revision_id=None):
719
966
        """Obtain a CommitBuilder for this repository.
720
 
 
 
967
        
721
968
        :param branch: Branch to commit to.
722
969
        :param parents: Revision ids of the parents of the new revision.
723
 
        :param config_stack: Configuration stack to use.
 
970
        :param config: Configuration to use.
724
971
        :param timestamp: Optional timestamp recorded for commit.
725
972
        :param timezone: Optional timezone for timestamp.
726
973
        :param committer: Optional committer to set for commit.
727
974
        :param revprops: Optional dictionary of revision properties.
728
975
        :param revision_id: Optional revision id.
729
 
        :param lossy: Whether to discard data that can not be natively
730
 
            represented, when pushing to a foreign VCS
731
976
        """
732
 
        raise NotImplementedError(self.get_commit_builder)
 
977
        result = self._commit_builder_class(self, parents, config,
 
978
            timestamp, timezone, committer, revprops, revision_id)
 
979
        self.start_write_group()
 
980
        return result
733
981
 
734
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
735
982
    def unlock(self):
736
983
        if (self.control_files._lock_count == 1 and
737
984
            self.control_files._lock_mode == 'w'):
741
988
                raise errors.BzrError(
742
989
                    'Must end write groups before releasing write locks.')
743
990
        self.control_files.unlock()
744
 
        if self.control_files._lock_count == 0:
745
 
            for repo in self._fallback_repositories:
746
 
                repo.unlock()
747
991
 
748
992
    @needs_read_lock
749
 
    def clone(self, controldir, revision_id=None):
750
 
        """Clone this repository into controldir using the current format.
 
993
    def clone(self, a_bzrdir, revision_id=None):
 
994
        """Clone this repository into a_bzrdir using the current format.
751
995
 
752
996
        Currently no check is made that the format of this repository and
753
997
        the bzrdir format are compatible. FIXME RBC 20060201.
756
1000
        """
757
1001
        # TODO: deprecate after 0.16; cloning this with all its settings is
758
1002
        # probably not very useful -- mbp 20070423
759
 
        dest_repo = self._create_sprouting_repo(
760
 
            controldir, shared=self.is_shared())
 
1003
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
761
1004
        self.copy_content_into(dest_repo, revision_id)
762
1005
        return dest_repo
763
1006
 
785
1028
 
786
1029
    def _start_write_group(self):
787
1030
        """Template method for per-repository write group startup.
788
 
 
789
 
        This is called before the write group is considered to be
 
1031
        
 
1032
        This is called before the write group is considered to be 
790
1033
        entered.
791
1034
        """
792
1035
 
818
1061
        """True if this repository has a copy of the revision."""
819
1062
        return revision_id in self.has_revisions((revision_id,))
820
1063
 
821
 
    @needs_read_lock
822
1064
    def has_revisions(self, revision_ids):
823
1065
        """Probe to find out the presence of multiple revisions.
824
1066
 
827
1069
        """
828
1070
        raise NotImplementedError(self.has_revisions)
829
1071
 
 
1072
        return self._revision_store.has_revision_id(revision_id,
 
1073
                                                    self.get_transaction())
 
1074
 
830
1075
    @needs_read_lock
831
1076
    def get_revision(self, revision_id):
832
1077
        """Return the Revision object for a named revision."""
833
1078
        return self.get_revisions([revision_id])[0]
834
1079
 
 
1080
    @needs_read_lock
835
1081
    def get_revision_reconcile(self, revision_id):
836
1082
        """'reconcile' helper routine that allows access to a revision always.
837
 
 
 
1083
        
838
1084
        This variant of get_revision does not cross check the weave graph
839
1085
        against the revision one as get_revision does: but it should only
840
1086
        be used by reconcile, or reconcile-alike commands that are correcting
841
1087
        or testing the revision graph.
842
1088
        """
843
 
        raise NotImplementedError(self.get_revision_reconcile)
 
1089
        return self._get_revisions([revision_id])[0]
844
1090
 
 
1091
    @needs_read_lock
845
1092
    def get_revisions(self, revision_ids):
846
 
        """Get many revisions at once.
847
 
        
848
 
        Repositories that need to check data on every revision read should 
849
 
        subclass this method.
850
 
        """
851
 
        raise NotImplementedError(self.get_revisions)
852
 
 
853
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1093
        """Get many revisions at once."""
 
1094
        return self._get_revisions(revision_ids)
 
1095
 
 
1096
    @needs_read_lock
 
1097
    def _get_revisions(self, revision_ids):
 
1098
        """Core work logic to get many revisions without sanity checks."""
 
1099
        for rev_id in revision_ids:
 
1100
            if not rev_id or not isinstance(rev_id, basestring):
 
1101
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1102
        revs = self._revision_store.get_revisions(revision_ids,
 
1103
                                                  self.get_transaction())
 
1104
        return revs
 
1105
 
 
1106
    @needs_read_lock
 
1107
    def get_revision_xml(self, revision_id):
 
1108
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1109
        #       would have already do it.
 
1110
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1111
        rev = self.get_revision(revision_id)
 
1112
        rev_tmp = StringIO()
 
1113
        # the current serializer..
 
1114
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1115
        rev_tmp.seek(0)
 
1116
        return rev_tmp.getvalue()
 
1117
 
 
1118
    def get_deltas_for_revisions(self, revisions):
854
1119
        """Produce a generator of revision deltas.
855
 
 
 
1120
        
856
1121
        Note that the input is a sequence of REVISIONS, not revision_ids.
857
1122
        Trees will be held in memory until the generator exits.
858
1123
        Each delta is relative to the revision's lefthand predecessor.
859
 
 
860
 
        :param specific_fileids: if not None, the result is filtered
861
 
          so that only those file-ids, their parents and their
862
 
          children are included.
863
1124
        """
864
 
        # Get the revision-ids of interest
865
1125
        required_trees = set()
866
1126
        for revision in revisions:
867
1127
            required_trees.add(revision.revision_id)
868
1128
            required_trees.update(revision.parent_ids[:1])
869
 
 
870
 
        # Get the matching filtered trees. Note that it's more
871
 
        # efficient to pass filtered trees to changes_from() rather
872
 
        # than doing the filtering afterwards. changes_from() could
873
 
        # arguably do the filtering itself but it's path-based, not
874
 
        # file-id based, so filtering before or afterwards is
875
 
        # currently easier.
876
 
        if specific_fileids is None:
877
 
            trees = dict((t.get_revision_id(), t) for
878
 
                t in self.revision_trees(required_trees))
879
 
        else:
880
 
            trees = dict((t.get_revision_id(), t) for
881
 
                t in self._filtered_revision_trees(required_trees,
882
 
                specific_fileids))
883
 
 
884
 
        # Calculate the deltas
 
1129
        trees = dict((t.get_revision_id(), t) for 
 
1130
                     t in self.revision_trees(required_trees))
885
1131
        for revision in revisions:
886
1132
            if not revision.parent_ids:
887
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
1133
                old_tree = self.revision_tree(None)
888
1134
            else:
889
1135
                old_tree = trees[revision.parent_ids[0]]
890
1136
            yield trees[revision.revision_id].changes_from(old_tree)
891
1137
 
892
1138
    @needs_read_lock
893
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1139
    def get_revision_delta(self, revision_id):
894
1140
        """Return the delta for one revision.
895
1141
 
896
1142
        The delta is relative to the left-hand predecessor of the
897
1143
        revision.
898
 
 
899
 
        :param specific_fileids: if not None, the result is filtered
900
 
          so that only those file-ids, their parents and their
901
 
          children are included.
902
1144
        """
903
1145
        r = self.get_revision(revision_id)
904
 
        return list(self.get_deltas_for_revisions([r],
905
 
            specific_fileids=specific_fileids))[0]
 
1146
        return list(self.get_deltas_for_revisions([r]))[0]
906
1147
 
907
1148
    @needs_write_lock
908
1149
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
909
1150
        signature = gpg_strategy.sign(plaintext)
910
1151
        self.add_signature_text(revision_id, signature)
911
1152
 
 
1153
    @needs_write_lock
912
1154
    def add_signature_text(self, revision_id, signature):
913
 
        """Store a signature text for a revision.
914
 
 
915
 
        :param revision_id: Revision id of the revision
916
 
        :param signature: Signature text.
917
 
        """
918
 
        raise NotImplementedError(self.add_signature_text)
919
 
 
920
 
    def _find_parent_ids_of_revisions(self, revision_ids):
921
 
        """Find all parent ids that are mentioned in the revision graph.
922
 
 
923
 
        :return: set of revisions that are parents of revision_ids which are
924
 
            not part of revision_ids themselves
925
 
        """
926
 
        parent_map = self.get_parent_map(revision_ids)
927
 
        parent_ids = set()
928
 
        map(parent_ids.update, parent_map.itervalues())
929
 
        parent_ids.difference_update(revision_ids)
930
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
931
 
        return parent_ids
 
1155
        self._revision_store.add_revision_signature_text(revision_id,
 
1156
                                                         signature,
 
1157
                                                         self.get_transaction())
 
1158
 
 
1159
    def find_text_key_references(self):
 
1160
        """Find the text key references within the repository.
 
1161
 
 
1162
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1163
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1164
        altered it listed explicitly.
 
1165
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1166
            to whether they were referred to by the inventory of the
 
1167
            revision_id that they contain. The inventory texts from all present
 
1168
            revision ids are assessed to generate this report.
 
1169
        """
 
1170
        revision_ids = self.all_revision_ids()
 
1171
        w = self.get_inventory_weave()
 
1172
        pb = ui.ui_factory.nested_progress_bar()
 
1173
        try:
 
1174
            return self._find_text_key_references_from_xml_inventory_lines(
 
1175
                w.iter_lines_added_or_present_in_versions(revision_ids, pb=pb))
 
1176
        finally:
 
1177
            pb.finished()
 
1178
 
 
1179
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1180
        line_iterator):
 
1181
        """Core routine for extracting references to texts from inventories.
 
1182
 
 
1183
        This performs the translation of xml lines to revision ids.
 
1184
 
 
1185
        :param line_iterator: An iterator of lines, origin_version_id
 
1186
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1187
            to whether they were referred to by the inventory of the
 
1188
            revision_id that they contain. Note that if that revision_id was
 
1189
            not part of the line_iterator's output then False will be given -
 
1190
            even though it may actually refer to that key.
 
1191
        """
 
1192
        if not self._serializer.support_altered_by_hack:
 
1193
            raise AssertionError(
 
1194
                "_find_text_key_references_from_xml_inventory_lines only "
 
1195
                "supported for branches which store inventory as unnested xml"
 
1196
                ", not on %r" % self)
 
1197
        result = {}
 
1198
 
 
1199
        # this code needs to read every new line in every inventory for the
 
1200
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
1201
        # not present in one of those inventories is unnecessary but not 
 
1202
        # harmful because we are filtering by the revision id marker in the
 
1203
        # inventory lines : we only select file ids altered in one of those  
 
1204
        # revisions. We don't need to see all lines in the inventory because
 
1205
        # only those added in an inventory in rev X can contain a revision=X
 
1206
        # line.
 
1207
        unescape_revid_cache = {}
 
1208
        unescape_fileid_cache = {}
 
1209
 
 
1210
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1211
        # of lines, so it has had a lot of inlining and optimizing done.
 
1212
        # Sorry that it is a little bit messy.
 
1213
        # Move several functions to be local variables, since this is a long
 
1214
        # running loop.
 
1215
        search = self._file_ids_altered_regex.search
 
1216
        unescape = _unescape_xml
 
1217
        setdefault = result.setdefault
 
1218
        for line, version_id in line_iterator:
 
1219
            match = search(line)
 
1220
            if match is None:
 
1221
                continue
 
1222
            # One call to match.group() returning multiple items is quite a
 
1223
            # bit faster than 2 calls to match.group() each returning 1
 
1224
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1225
 
 
1226
            # Inlining the cache lookups helps a lot when you make 170,000
 
1227
            # lines and 350k ids, versus 8.4 unique ids.
 
1228
            # Using a cache helps in 2 ways:
 
1229
            #   1) Avoids unnecessary decoding calls
 
1230
            #   2) Re-uses cached strings, which helps in future set and
 
1231
            #      equality checks.
 
1232
            # (2) is enough that removing encoding entirely along with
 
1233
            # the cache (so we are using plain strings) results in no
 
1234
            # performance improvement.
 
1235
            try:
 
1236
                revision_id = unescape_revid_cache[revision_id]
 
1237
            except KeyError:
 
1238
                unescaped = unescape(revision_id)
 
1239
                unescape_revid_cache[revision_id] = unescaped
 
1240
                revision_id = unescaped
 
1241
 
 
1242
            # Note that unconditionally unescaping means that we deserialise
 
1243
            # every fileid, which for general 'pull' is not great, but we don't
 
1244
            # really want to have some many fulltexts that this matters anyway.
 
1245
            # RBC 20071114.
 
1246
            try:
 
1247
                file_id = unescape_fileid_cache[file_id]
 
1248
            except KeyError:
 
1249
                unescaped = unescape(file_id)
 
1250
                unescape_fileid_cache[file_id] = unescaped
 
1251
                file_id = unescaped
 
1252
 
 
1253
            key = (file_id, revision_id)
 
1254
            setdefault(key, False)
 
1255
            if revision_id == version_id:
 
1256
                result[key] = True
 
1257
        return result
 
1258
 
 
1259
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1260
        revision_ids):
 
1261
        """Helper routine for fileids_altered_by_revision_ids.
 
1262
 
 
1263
        This performs the translation of xml lines to revision ids.
 
1264
 
 
1265
        :param line_iterator: An iterator of lines, origin_version_id
 
1266
        :param revision_ids: The revision ids to filter for. This should be a
 
1267
            set or other type which supports efficient __contains__ lookups, as
 
1268
            the revision id from each parsed line will be looked up in the
 
1269
            revision_ids filter.
 
1270
        :return: a dictionary mapping altered file-ids to an iterable of
 
1271
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1272
        altered it listed explicitly.
 
1273
        """
 
1274
        result = {}
 
1275
        setdefault = result.setdefault
 
1276
        for file_id, revision_id in \
 
1277
            self._find_text_key_references_from_xml_inventory_lines(
 
1278
                line_iterator).iterkeys():
 
1279
            # once data is all ensured-consistent; then this is
 
1280
            # if revision_id == version_id
 
1281
            if revision_id in revision_ids:
 
1282
                setdefault(file_id, set()).add(revision_id)
 
1283
        return result
 
1284
 
 
1285
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
 
1286
        """Find the file ids and versions affected by revisions.
 
1287
 
 
1288
        :param revisions: an iterable containing revision ids.
 
1289
        :param _inv_weave: The inventory weave from this repository or None.
 
1290
            If None, the inventory weave will be opened automatically.
 
1291
        :return: a dictionary mapping altered file-ids to an iterable of
 
1292
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1293
        altered it listed explicitly.
 
1294
        """
 
1295
        selected_revision_ids = set(revision_ids)
 
1296
        w = _inv_weave or self.get_inventory_weave()
 
1297
        pb = ui.ui_factory.nested_progress_bar()
 
1298
        try:
 
1299
            return self._find_file_ids_from_xml_inventory_lines(
 
1300
                w.iter_lines_added_or_present_in_versions(
 
1301
                    selected_revision_ids, pb=pb),
 
1302
                selected_revision_ids)
 
1303
        finally:
 
1304
            pb.finished()
932
1305
 
933
1306
    def iter_files_bytes(self, desired_files):
934
1307
        """Iterate through file versions.
941
1314
        uniquely identify the file version in the caller's context.  (Examples:
942
1315
        an index number or a TreeTransform trans_id.)
943
1316
 
 
1317
        bytes_iterator is an iterable of bytestrings for the file.  The
 
1318
        kind of iterable and length of the bytestrings are unspecified, but for
 
1319
        this implementation, it is a list of lines produced by
 
1320
        VersionedFile.get_lines().
 
1321
 
944
1322
        :param desired_files: a list of (file_id, revision_id, identifier)
945
1323
            triples
946
1324
        """
947
 
        raise NotImplementedError(self.iter_files_bytes)
948
 
 
949
 
    def get_rev_id_for_revno(self, revno, known_pair):
950
 
        """Return the revision id of a revno, given a later (revno, revid)
951
 
        pair in the same history.
952
 
 
953
 
        :return: if found (True, revid).  If the available history ran out
954
 
            before reaching the revno, then this returns
955
 
            (False, (closest_revno, closest_revid)).
956
 
        """
957
 
        known_revno, known_revid = known_pair
958
 
        partial_history = [known_revid]
959
 
        distance_from_known = known_revno - revno
960
 
        if distance_from_known < 0:
961
 
            raise ValueError(
962
 
                'requested revno (%d) is later than given known revno (%d)'
963
 
                % (revno, known_revno))
964
 
        try:
965
 
            _iter_for_revno(
966
 
                self, partial_history, stop_index=distance_from_known)
967
 
        except errors.RevisionNotPresent, err:
968
 
            if err.revision_id == known_revid:
969
 
                # The start revision (known_revid) wasn't found.
970
 
                raise
971
 
            # This is a stacked repository with no fallbacks, or a there's a
972
 
            # left-hand ghost.  Either way, even though the revision named in
973
 
            # the error isn't in this repo, we know it's the next step in this
974
 
            # left-hand history.
975
 
            partial_history.append(err.revision_id)
976
 
        if len(partial_history) <= distance_from_known:
977
 
            # Didn't find enough history to get a revid for the revno.
978
 
            earliest_revno = known_revno - len(partial_history) + 1
979
 
            return (False, (earliest_revno, partial_history[-1]))
980
 
        if len(partial_history) - 1 > distance_from_known:
981
 
            raise AssertionError('_iter_for_revno returned too much history')
982
 
        return (True, partial_history[-1])
983
 
 
 
1325
        transaction = self.get_transaction()
 
1326
        for file_id, revision_id, callable_data in desired_files:
 
1327
            try:
 
1328
                weave = self.weave_store.get_weave(file_id, transaction)
 
1329
            except errors.NoSuchFile:
 
1330
                raise errors.NoSuchIdInRepository(self, file_id)
 
1331
            yield callable_data, weave.get_lines(revision_id)
 
1332
 
 
1333
    def _generate_text_key_index(self, text_key_references=None,
 
1334
        ancestors=None):
 
1335
        """Generate a new text key index for the repository.
 
1336
 
 
1337
        This is an expensive function that will take considerable time to run.
 
1338
 
 
1339
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
1340
            list of parents, also text keys. When a given key has no parents,
 
1341
            the parents list will be [NULL_REVISION].
 
1342
        """
 
1343
        # All revisions, to find inventory parents.
 
1344
        if ancestors is None:
 
1345
            graph = self.get_graph()
 
1346
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
1347
        if text_key_references is None:
 
1348
            text_key_references = self.find_text_key_references()
 
1349
        pb = ui.ui_factory.nested_progress_bar()
 
1350
        try:
 
1351
            return self._do_generate_text_key_index(ancestors,
 
1352
                text_key_references, pb)
 
1353
        finally:
 
1354
            pb.finished()
 
1355
 
 
1356
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
1357
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
1358
        revision_order = tsort.topo_sort(ancestors)
 
1359
        invalid_keys = set()
 
1360
        revision_keys = {}
 
1361
        for revision_id in revision_order:
 
1362
            revision_keys[revision_id] = set()
 
1363
        text_count = len(text_key_references)
 
1364
        # a cache of the text keys to allow reuse; costs a dict of all the
 
1365
        # keys, but saves a 2-tuple for every child of a given key.
 
1366
        text_key_cache = {}
 
1367
        for text_key, valid in text_key_references.iteritems():
 
1368
            if not valid:
 
1369
                invalid_keys.add(text_key)
 
1370
            else:
 
1371
                revision_keys[text_key[1]].add(text_key)
 
1372
            text_key_cache[text_key] = text_key
 
1373
        del text_key_references
 
1374
        text_index = {}
 
1375
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
1376
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1377
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
1378
        # too small for large or very branchy trees. However, for 55K path
 
1379
        # trees, it would be easy to use too much memory trivially. Ideally we
 
1380
        # could gauge this by looking at available real memory etc, but this is
 
1381
        # always a tricky proposition.
 
1382
        inventory_cache = lru_cache.LRUCache(10)
 
1383
        batch_size = 10 # should be ~150MB on a 55K path tree
 
1384
        batch_count = len(revision_order) / batch_size + 1
 
1385
        processed_texts = 0
 
1386
        pb.update("Calculating text parents.", processed_texts, text_count)
 
1387
        for offset in xrange(batch_count):
 
1388
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
1389
                batch_size]
 
1390
            if not to_query:
 
1391
                break
 
1392
            for rev_tree in self.revision_trees(to_query):
 
1393
                revision_id = rev_tree.get_revision_id()
 
1394
                parent_ids = ancestors[revision_id]
 
1395
                for text_key in revision_keys[revision_id]:
 
1396
                    pb.update("Calculating text parents.", processed_texts)
 
1397
                    processed_texts += 1
 
1398
                    candidate_parents = []
 
1399
                    for parent_id in parent_ids:
 
1400
                        parent_text_key = (text_key[0], parent_id)
 
1401
                        try:
 
1402
                            check_parent = parent_text_key not in \
 
1403
                                revision_keys[parent_id]
 
1404
                        except KeyError:
 
1405
                            # the parent parent_id is a ghost:
 
1406
                            check_parent = False
 
1407
                            # truncate the derived graph against this ghost.
 
1408
                            parent_text_key = None
 
1409
                        if check_parent:
 
1410
                            # look at the parent commit details inventories to
 
1411
                            # determine possible candidates in the per file graph.
 
1412
                            # TODO: cache here.
 
1413
                            try:
 
1414
                                inv = inventory_cache[parent_id]
 
1415
                            except KeyError:
 
1416
                                inv = self.revision_tree(parent_id).inventory
 
1417
                                inventory_cache[parent_id] = inv
 
1418
                            parent_entry = inv._byid.get(text_key[0], None)
 
1419
                            if parent_entry is not None:
 
1420
                                parent_text_key = (
 
1421
                                    text_key[0], parent_entry.revision)
 
1422
                            else:
 
1423
                                parent_text_key = None
 
1424
                        if parent_text_key is not None:
 
1425
                            candidate_parents.append(
 
1426
                                text_key_cache[parent_text_key])
 
1427
                    parent_heads = text_graph.heads(candidate_parents)
 
1428
                    new_parents = list(parent_heads)
 
1429
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
1430
                    if new_parents == []:
 
1431
                        new_parents = [NULL_REVISION]
 
1432
                    text_index[text_key] = new_parents
 
1433
 
 
1434
        for text_key in invalid_keys:
 
1435
            text_index[text_key] = [NULL_REVISION]
 
1436
        return text_index
 
1437
 
 
1438
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1439
        """Get an iterable listing the keys of all the data introduced by a set
 
1440
        of revision IDs.
 
1441
 
 
1442
        The keys will be ordered so that the corresponding items can be safely
 
1443
        fetched and inserted in that order.
 
1444
 
 
1445
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
1446
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
1447
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
1448
        """
 
1449
        # XXX: it's a bit weird to control the inventory weave caching in this
 
1450
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
1451
        # maybe this generator should explicitly have the contract that it
 
1452
        # should not be iterated until the previously yielded item has been
 
1453
        # processed?
 
1454
        inv_w = self.get_inventory_weave()
 
1455
 
 
1456
        # file ids that changed
 
1457
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
1458
        count = 0
 
1459
        num_file_ids = len(file_ids)
 
1460
        for file_id, altered_versions in file_ids.iteritems():
 
1461
            if _files_pb is not None:
 
1462
                _files_pb.update("fetch texts", count, num_file_ids)
 
1463
            count += 1
 
1464
            yield ("file", file_id, altered_versions)
 
1465
        # We're done with the files_pb.  Note that it finished by the caller,
 
1466
        # just as it was created by the caller.
 
1467
        del _files_pb
 
1468
 
 
1469
        # inventory
 
1470
        yield ("inventory", None, revision_ids)
 
1471
 
 
1472
        # signatures
 
1473
        revisions_with_signatures = set()
 
1474
        for rev_id in revision_ids:
 
1475
            try:
 
1476
                self.get_signature_text(rev_id)
 
1477
            except errors.NoSuchRevision:
 
1478
                # not signed.
 
1479
                pass
 
1480
            else:
 
1481
                revisions_with_signatures.add(rev_id)
 
1482
        yield ("signatures", None, revisions_with_signatures)
 
1483
 
 
1484
        # revisions
 
1485
        yield ("revisions", None, revision_ids)
 
1486
 
 
1487
    @needs_read_lock
 
1488
    def get_inventory_weave(self):
 
1489
        return self.control_weaves.get_weave('inventory',
 
1490
            self.get_transaction())
 
1491
 
 
1492
    @needs_read_lock
 
1493
    def get_inventory(self, revision_id):
 
1494
        """Get Inventory object by revision id."""
 
1495
        return self.iter_inventories([revision_id]).next()
 
1496
 
 
1497
    def iter_inventories(self, revision_ids):
 
1498
        """Get many inventories by revision_ids.
 
1499
 
 
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
 
1502
        time.
 
1503
 
 
1504
        :return: An iterator of inventories.
 
1505
        """
 
1506
        if ((None in revision_ids)
 
1507
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1508
            raise ValueError('cannot get null revision inventory')
 
1509
        return self._iter_inventories(revision_ids)
 
1510
 
 
1511
    def _iter_inventories(self, revision_ids):
 
1512
        """single-document based inventory iteration."""
 
1513
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
1514
        for text, revision_id in zip(texts, revision_ids):
 
1515
            yield self.deserialise_inventory(revision_id, text)
 
1516
 
 
1517
    def deserialise_inventory(self, revision_id, xml):
 
1518
        """Transform the xml into an inventory object. 
 
1519
 
 
1520
        :param revision_id: The expected revision id of the inventory.
 
1521
        :param xml: A serialised inventory.
 
1522
        """
 
1523
        result = self._serializer.read_inventory_from_string(xml, revision_id)
 
1524
        if result.revision_id != revision_id:
 
1525
            raise AssertionError('revision id mismatch %s != %s' % (
 
1526
                result.revision_id, revision_id))
 
1527
        return result
 
1528
 
 
1529
    def serialise_inventory(self, inv):
 
1530
        return self._serializer.write_inventory_to_string(inv)
 
1531
 
 
1532
    def _serialise_inventory_to_lines(self, inv):
 
1533
        return self._serializer.write_inventory_to_lines(inv)
 
1534
 
 
1535
    def get_serializer_format(self):
 
1536
        return self._serializer.format_num
 
1537
 
 
1538
    @needs_read_lock
 
1539
    def get_inventory_xml(self, revision_id):
 
1540
        """Get inventory XML as a file object."""
 
1541
        try:
 
1542
            iw = self.get_inventory_weave()
 
1543
            return iw.get_text(revision_id)
 
1544
        except IndexError:
 
1545
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
1546
 
 
1547
    @needs_read_lock
 
1548
    def get_inventory_sha1(self, revision_id):
 
1549
        """Return the sha1 hash of the inventory entry
 
1550
        """
 
1551
        return self.get_revision(revision_id).inventory_sha1
 
1552
 
 
1553
    def iter_reverse_revision_history(self, revision_id):
 
1554
        """Iterate backwards through revision ids in the lefthand history
 
1555
 
 
1556
        :param revision_id: The revision id to start with.  All its lefthand
 
1557
            ancestors will be traversed.
 
1558
        """
 
1559
        graph = self.get_graph()
 
1560
        next_id = revision_id
 
1561
        while True:
 
1562
            if next_id in (None, _mod_revision.NULL_REVISION):
 
1563
                return
 
1564
            yield next_id
 
1565
            # Note: The following line may raise KeyError in the event of
 
1566
            # truncated history. We decided not to have a try:except:raise
 
1567
            # RevisionNotPresent here until we see a use for it, because of the
 
1568
            # cost in an inner loop that is by its very nature O(history).
 
1569
            # Robert Collins 20080326
 
1570
            parents = graph.get_parent_map([next_id])[next_id]
 
1571
            if len(parents) == 0:
 
1572
                return
 
1573
            else:
 
1574
                next_id = parents[0]
 
1575
 
 
1576
    @needs_read_lock
 
1577
    def get_revision_inventory(self, revision_id):
 
1578
        """Return inventory of a past revision."""
 
1579
        # TODO: Unify this with get_inventory()
 
1580
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1581
        # must be the same as its revision, so this is trivial.
 
1582
        if revision_id is None:
 
1583
            # This does not make sense: if there is no revision,
 
1584
            # then it is the current tree inventory surely ?!
 
1585
            # and thus get_root_id() is something that looks at the last
 
1586
            # commit on the branch, and the get_root_id is an inventory check.
 
1587
            raise NotImplementedError
 
1588
            # return Inventory(self.get_root_id())
 
1589
        else:
 
1590
            return self.get_inventory(revision_id)
 
1591
 
 
1592
    @needs_read_lock
984
1593
    def is_shared(self):
985
1594
        """Return True if this repository is flagged as a shared repository."""
986
1595
        raise NotImplementedError(self.is_shared)
1000
1609
        for repositories to maintain loaded indices across multiple locks
1001
1610
        by checking inside their implementation of this method to see
1002
1611
        whether their indices are still valid. This depends of course on
1003
 
        the disk format being validatable in this manner. This method is
1004
 
        also called by the refresh_data() public interface to cause a refresh
1005
 
        to occur while in a write lock so that data inserted by a smart server
1006
 
        push operation is visible on the client's instance of the physical
1007
 
        repository.
 
1612
        the disk format being validatable in this manner.
1008
1613
        """
1009
1614
 
1010
1615
    @needs_read_lock
1011
1616
    def revision_tree(self, revision_id):
1012
1617
        """Return Tree for a revision on this branch.
1013
1618
 
1014
 
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
1619
        `revision_id` may be None for the empty tree revision.
1015
1620
        """
1016
 
        raise NotImplementedError(self.revision_tree)
 
1621
        # TODO: refactor this to use an existing revision object
 
1622
        # so we don't need to read it in twice.
 
1623
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1624
            return RevisionTree(self, Inventory(root_id=None), 
 
1625
                                _mod_revision.NULL_REVISION)
 
1626
        else:
 
1627
            inv = self.get_revision_inventory(revision_id)
 
1628
            return RevisionTree(self, inv, revision_id)
1017
1629
 
1018
1630
    def revision_trees(self, revision_ids):
1019
 
        """Return Trees for revisions in this repository.
1020
 
 
1021
 
        :param revision_ids: a sequence of revision-ids;
1022
 
          a revision-id may not be None or 'null:'
 
1631
        """Return Tree for a revision on this branch.
 
1632
 
 
1633
        `revision_id` may not be None or 'null:'"""
 
1634
        inventories = self.iter_inventories(revision_ids)
 
1635
        for inv in inventories:
 
1636
            yield RevisionTree(self, inv, inv.revision_id)
 
1637
 
 
1638
    @needs_read_lock
 
1639
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1640
        """Return a list of revision-ids integrated by a revision.
 
1641
 
 
1642
        The first element of the list is always None, indicating the origin 
 
1643
        revision.  This might change when we have history horizons, or 
 
1644
        perhaps we should have a new API.
 
1645
        
 
1646
        This is topologically sorted.
1023
1647
        """
1024
 
        raise NotImplementedError(self.revision_trees)
 
1648
        if _mod_revision.is_null(revision_id):
 
1649
            return [None]
 
1650
        if not self.has_revision(revision_id):
 
1651
            raise errors.NoSuchRevision(self, revision_id)
 
1652
        w = self.get_inventory_weave()
 
1653
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
1654
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
1025
1655
 
1026
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1656
    def pack(self):
1027
1657
        """Compress the data within the repository.
1028
1658
 
1029
1659
        This operation only makes sense for some repository types. For other
1030
1660
        types it should be a no-op that just returns.
1031
1661
 
1032
1662
        This stub method does not require a lock, but subclasses should use
1033
 
        @needs_write_lock as this is a long running call it's reasonable to
 
1663
        @needs_write_lock as this is a long running call its reasonable to 
1034
1664
        implicitly lock for the user.
1035
 
 
1036
 
        :param hint: If not supplied, the whole repository is packed.
1037
 
            If supplied, the repository may use the hint parameter as a
1038
 
            hint for the parts of the repository to pack. A hint can be
1039
 
            obtained from the result of commit_write_group(). Out of
1040
 
            date hints are simply ignored, because concurrent operations
1041
 
            can obsolete them rapidly.
1042
 
 
1043
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
1044
 
            the pack operation.
1045
 
        """
 
1665
        """
 
1666
 
 
1667
    @needs_read_lock
 
1668
    def print_file(self, file, revision_id):
 
1669
        """Print `file` to stdout.
 
1670
        
 
1671
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1672
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1673
        by creating a new more flexible convenience function.
 
1674
        """
 
1675
        tree = self.revision_tree(revision_id)
 
1676
        # use inventory as it was in that revision
 
1677
        file_id = tree.inventory.path2id(file)
 
1678
        if not file_id:
 
1679
            # TODO: jam 20060427 Write a test for this code path
 
1680
            #       it had a bug in it, and was raising the wrong
 
1681
            #       exception.
 
1682
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1683
        tree.print_file(file_id)
1046
1684
 
1047
1685
    def get_transaction(self):
1048
1686
        return self.control_files.get_transaction()
1049
1687
 
1050
 
    def get_parent_map(self, revision_ids):
1051
 
        """See graph.StackedParentsProvider.get_parent_map"""
1052
 
        raise NotImplementedError(self.get_parent_map)
 
1688
    @deprecated_method(symbol_versioning.one_one)
 
1689
    def get_parents(self, revision_ids):
 
1690
        """See StackedParentsProvider.get_parents"""
 
1691
        parent_map = self.get_parent_map(revision_ids)
 
1692
        return [parent_map.get(r, None) for r in revision_ids]
1053
1693
 
1054
 
    def _get_parent_map_no_fallbacks(self, revision_ids):
1055
 
        """Same as Repository.get_parent_map except doesn't query fallbacks."""
1056
 
        # revisions index works in keys; this just works in revisions
1057
 
        # therefore wrap and unwrap
1058
 
        query_keys = []
1059
 
        result = {}
1060
 
        for revision_id in revision_ids:
 
1694
    def get_parent_map(self, keys):
 
1695
        """See graph._StackedParentsProvider.get_parent_map"""
 
1696
        parent_map = {}
 
1697
        for revision_id in keys:
 
1698
            if revision_id is None:
 
1699
                raise ValueError('get_parent_map(None) is not valid')
1061
1700
            if revision_id == _mod_revision.NULL_REVISION:
1062
 
                result[revision_id] = ()
1063
 
            elif revision_id is None:
1064
 
                raise ValueError('get_parent_map(None) is not valid')
1065
 
            else:
1066
 
                query_keys.append((revision_id ,))
1067
 
        vf = self.revisions.without_fallbacks()
1068
 
        for ((revision_id,), parent_keys) in \
1069
 
                vf.get_parent_map(query_keys).iteritems():
1070
 
            if parent_keys:
1071
 
                result[revision_id] = tuple([parent_revid
1072
 
                    for (parent_revid,) in parent_keys])
1073
 
            else:
1074
 
                result[revision_id] = (_mod_revision.NULL_REVISION,)
1075
 
        return result
 
1701
                parent_map[revision_id] = ()
 
1702
            else:
 
1703
                try:
 
1704
                    parent_id_list = self.get_revision(revision_id).parent_ids
 
1705
                except errors.NoSuchRevision:
 
1706
                    pass
 
1707
                else:
 
1708
                    if len(parent_id_list) == 0:
 
1709
                        parent_ids = (_mod_revision.NULL_REVISION,)
 
1710
                    else:
 
1711
                        parent_ids = tuple(parent_id_list)
 
1712
                    parent_map[revision_id] = parent_ids
 
1713
        return parent_map
1076
1714
 
1077
1715
    def _make_parents_provider(self):
1078
 
        if not self._format.supports_external_lookups:
1079
 
            return self
1080
 
        return graph.StackedParentsProvider(_LazyListJoin(
1081
 
            [self._make_parents_provider_unstacked()],
1082
 
            self._fallback_repositories))
1083
 
 
1084
 
    def _make_parents_provider_unstacked(self):
1085
 
        return graph.CallableToParentsProviderAdapter(
1086
 
            self._get_parent_map_no_fallbacks)
1087
 
 
1088
 
    @needs_read_lock
1089
 
    def get_known_graph_ancestry(self, revision_ids):
1090
 
        """Return the known graph for a set of revision ids and their ancestors.
1091
 
        """
1092
 
        raise NotImplementedError(self.get_known_graph_ancestry)
1093
 
 
1094
 
    def get_file_graph(self):
1095
 
        """Return the graph walker for files."""
1096
 
        raise NotImplementedError(self.get_file_graph)
 
1716
        return self
1097
1717
 
1098
1718
    def get_graph(self, other_repository=None):
1099
1719
        """Return the graph walker for this repository format"""
1100
1720
        parents_provider = self._make_parents_provider()
1101
1721
        if (other_repository is not None and
1102
1722
            not self.has_same_location(other_repository)):
1103
 
            parents_provider = graph.StackedParentsProvider(
 
1723
            parents_provider = graph._StackedParentsProvider(
1104
1724
                [parents_provider, other_repository._make_parents_provider()])
1105
1725
        return graph.Graph(parents_provider)
1106
1726
 
 
1727
    def _get_versioned_file_checker(self):
 
1728
        """Return an object suitable for checking versioned files."""
 
1729
        return _VersionedFileChecker(self)
 
1730
 
 
1731
    def revision_ids_to_search_result(self, result_set):
 
1732
        """Convert a set of revision ids to a graph SearchResult."""
 
1733
        result_parents = set()
 
1734
        for parents in self.get_graph().get_parent_map(
 
1735
            result_set).itervalues():
 
1736
            result_parents.update(parents)
 
1737
        included_keys = result_set.intersection(result_parents)
 
1738
        start_keys = result_set.difference(included_keys)
 
1739
        exclude_keys = result_parents.difference(result_set)
 
1740
        result = graph.SearchResult(start_keys, exclude_keys,
 
1741
            len(result_set), result_set)
 
1742
        return result
 
1743
 
1107
1744
    @needs_write_lock
1108
1745
    def set_make_working_trees(self, new_value):
1109
1746
        """Set the policy flag for making working trees when creating branches.
1115
1752
                          working trees.
1116
1753
        """
1117
1754
        raise NotImplementedError(self.set_make_working_trees)
1118
 
 
 
1755
    
1119
1756
    def make_working_trees(self):
1120
1757
        """Returns the policy for making working trees on new branches."""
1121
1758
        raise NotImplementedError(self.make_working_trees)
1122
1759
 
1123
1760
    @needs_write_lock
1124
1761
    def sign_revision(self, revision_id, gpg_strategy):
1125
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1126
 
        plaintext = testament.as_short_text()
 
1762
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1127
1763
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1128
1764
 
1129
1765
    @needs_read_lock
1130
 
    def verify_revision_signature(self, revision_id, gpg_strategy):
1131
 
        """Verify the signature on a revision.
1132
 
 
1133
 
        :param revision_id: the revision to verify
1134
 
        :gpg_strategy: the GPGStrategy object to used
1135
 
 
1136
 
        :return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1137
 
        """
1138
 
        if not self.has_signature_for_revision_id(revision_id):
1139
 
            return gpg.SIGNATURE_NOT_SIGNED, None
1140
 
        signature = self.get_signature_text(revision_id)
1141
 
 
1142
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1143
 
        plaintext = testament.as_short_text()
1144
 
 
1145
 
        return gpg_strategy.verify(signature, plaintext)
1146
 
 
1147
 
    @needs_read_lock
1148
 
    def verify_revision_signatures(self, revision_ids, gpg_strategy):
1149
 
        """Verify revision signatures for a number of revisions.
1150
 
 
1151
 
        :param revision_id: the revision to verify
1152
 
        :gpg_strategy: the GPGStrategy object to used
1153
 
        :return: Iterator over tuples with revision id, result and keys
1154
 
        """
1155
 
        for revid in revision_ids:
1156
 
            (result, key) = self.verify_revision_signature(revid, gpg_strategy)
1157
 
            yield revid, result, key
1158
 
 
1159
1766
    def has_signature_for_revision_id(self, revision_id):
1160
1767
        """Query for a revision signature for revision_id in the repository."""
1161
 
        raise NotImplementedError(self.has_signature_for_revision_id)
 
1768
        return self._revision_store.has_signature(revision_id,
 
1769
                                                  self.get_transaction())
1162
1770
 
 
1771
    @needs_read_lock
1163
1772
    def get_signature_text(self, revision_id):
1164
1773
        """Return the text for a signature."""
1165
 
        raise NotImplementedError(self.get_signature_text)
 
1774
        return self._revision_store.get_signature_text(revision_id,
 
1775
                                                       self.get_transaction())
1166
1776
 
1167
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1777
    @needs_read_lock
 
1778
    def check(self, revision_ids=None):
1168
1779
        """Check consistency of all history of given revision_ids.
1169
1780
 
1170
1781
        Different repository implementations should override _check().
1171
1782
 
1172
1783
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1173
1784
             will be checked.  Typically the last revision_id of a branch.
1174
 
        :param callback_refs: A dict of check-refs to resolve and callback
1175
 
            the check/_check method on the items listed as wanting the ref.
1176
 
            see bzrlib.check.
1177
 
        :param check_repo: If False do not check the repository contents, just 
1178
 
            calculate the data callback_refs requires and call them back.
1179
1785
        """
1180
 
        return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1181
 
            check_repo=check_repo)
1182
 
 
1183
 
    def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1184
 
        raise NotImplementedError(self.check)
1185
 
 
1186
 
    def _warn_if_deprecated(self, branch=None):
1187
 
        if not self._format.is_deprecated():
1188
 
            return
 
1786
        return self._check(revision_ids)
 
1787
 
 
1788
    def _check(self, revision_ids):
 
1789
        result = check.Check(self)
 
1790
        result.check()
 
1791
        return result
 
1792
 
 
1793
    def _warn_if_deprecated(self):
1189
1794
        global _deprecation_warning_done
1190
1795
        if _deprecation_warning_done:
1191
1796
            return
1192
 
        try:
1193
 
            if branch is None:
1194
 
                conf = config.GlobalStack()
1195
 
            else:
1196
 
                conf = branch.get_config_stack()
1197
 
            if 'format_deprecation' in conf.get('suppress_warnings'):
1198
 
                return
1199
 
            warning("Format %s for %s is deprecated -"
1200
 
                    " please use 'bzr upgrade' to get better performance"
1201
 
                    % (self._format, self.bzrdir.transport.base))
1202
 
        finally:
1203
 
            _deprecation_warning_done = True
 
1797
        _deprecation_warning_done = True
 
1798
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
1799
                % (self._format, self.bzrdir.transport.base))
1204
1800
 
1205
1801
    def supports_rich_root(self):
1206
1802
        return self._format.rich_root_data
1220
1816
                    revision_id.decode('ascii')
1221
1817
                except UnicodeDecodeError:
1222
1818
                    raise errors.NonAsciiRevisionId(method, self)
 
1819
    
 
1820
    def revision_graph_can_have_wrong_parents(self):
 
1821
        """Is it possible for this repository to have a revision graph with
 
1822
        incorrect parents?
 
1823
 
 
1824
        If True, then this repository must also implement
 
1825
        _find_inconsistent_revision_parents so that check and reconcile can
 
1826
        check for inconsistencies before proceeding with other checks that may
 
1827
        depend on the revision index being consistent.
 
1828
        """
 
1829
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
1830
 
 
1831
 
 
1832
# remove these delegates a while after bzr 0.15
 
1833
def __make_delegated(name, from_module):
 
1834
    def _deprecated_repository_forwarder():
 
1835
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
1836
            % (name, from_module),
 
1837
            DeprecationWarning,
 
1838
            stacklevel=2)
 
1839
        m = __import__(from_module, globals(), locals(), [name])
 
1840
        try:
 
1841
            return getattr(m, name)
 
1842
        except AttributeError:
 
1843
            raise AttributeError('module %s has no name %s'
 
1844
                    % (m, name))
 
1845
    globals()[name] = _deprecated_repository_forwarder
 
1846
 
 
1847
for _name in [
 
1848
        'AllInOneRepository',
 
1849
        'WeaveMetaDirRepository',
 
1850
        'PreSplitOutRepositoryFormat',
 
1851
        'RepositoryFormat4',
 
1852
        'RepositoryFormat5',
 
1853
        'RepositoryFormat6',
 
1854
        'RepositoryFormat7',
 
1855
        ]:
 
1856
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
1857
 
 
1858
for _name in [
 
1859
        'KnitRepository',
 
1860
        'RepositoryFormatKnit',
 
1861
        'RepositoryFormatKnit1',
 
1862
        ]:
 
1863
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
1864
 
 
1865
 
 
1866
def install_revision(repository, rev, revision_tree):
 
1867
    """Install all revision data into a repository."""
 
1868
    install_revisions(repository, [(rev, revision_tree, None)])
 
1869
 
 
1870
 
 
1871
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
1872
    """Install all revision data into a repository.
 
1873
 
 
1874
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
1875
    may be None.
 
1876
    """
 
1877
    repository.start_write_group()
 
1878
    try:
 
1879
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
1880
            _install_revision(repository, revision, revision_tree, signature)
 
1881
            if pb is not None:
 
1882
                pb.update('Transferring revisions', n + 1, num_revisions)
 
1883
    except:
 
1884
        repository.abort_write_group()
 
1885
        raise
 
1886
    else:
 
1887
        repository.commit_write_group()
 
1888
 
 
1889
 
 
1890
def _install_revision(repository, rev, revision_tree, signature):
 
1891
    """Install all revision data into a repository."""
 
1892
    present_parents = []
 
1893
    parent_trees = {}
 
1894
    for p_id in rev.parent_ids:
 
1895
        if repository.has_revision(p_id):
 
1896
            present_parents.append(p_id)
 
1897
            parent_trees[p_id] = repository.revision_tree(p_id)
 
1898
        else:
 
1899
            parent_trees[p_id] = repository.revision_tree(None)
 
1900
 
 
1901
    inv = revision_tree.inventory
 
1902
    entries = inv.iter_entries()
 
1903
    # backwards compatibility hack: skip the root id.
 
1904
    if not repository.supports_rich_root():
 
1905
        path, root = entries.next()
 
1906
        if root.revision != rev.revision_id:
 
1907
            raise errors.IncompatibleRevision(repr(repository))
 
1908
    # Add the texts that are not already present
 
1909
    for path, ie in entries:
 
1910
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
1911
                repository.get_transaction())
 
1912
        if ie.revision not in w:
 
1913
            text_parents = []
 
1914
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
1915
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
1916
            # is a latent bug here where the parents may have ancestors of each
 
1917
            # other. RBC, AB
 
1918
            for revision, tree in parent_trees.iteritems():
 
1919
                if ie.file_id not in tree:
 
1920
                    continue
 
1921
                parent_id = tree.inventory[ie.file_id].revision
 
1922
                if parent_id in text_parents:
 
1923
                    continue
 
1924
                text_parents.append(parent_id)
 
1925
                    
 
1926
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
1927
                repository.get_transaction())
 
1928
            lines = revision_tree.get_file(ie.file_id).readlines()
 
1929
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
1930
    try:
 
1931
        # install the inventory
 
1932
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
1933
    except errors.RevisionAlreadyPresent:
 
1934
        pass
 
1935
    if signature is not None:
 
1936
        repository.add_signature_text(rev.revision_id, signature)
 
1937
    repository.add_revision(rev.revision_id, rev, inv)
1223
1938
 
1224
1939
 
1225
1940
class MetaDirRepository(Repository):
1226
1941
    """Repositories in the new meta-dir layout.
1227
 
 
 
1942
    
1228
1943
    :ivar _transport: Transport for access to repository control files,
1229
1944
        typically pointing to .bzr/repository.
1230
1945
    """
1231
1946
 
1232
 
    def __init__(self, _format, a_bzrdir, control_files):
1233
 
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
 
1947
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
1948
        super(MetaDirRepository, self).__init__(_format,
 
1949
                                                a_bzrdir,
 
1950
                                                control_files,
 
1951
                                                _revision_store,
 
1952
                                                control_store,
 
1953
                                                text_store)
1234
1954
        self._transport = control_files._transport
1235
1955
 
 
1956
    @needs_read_lock
1236
1957
    def is_shared(self):
1237
1958
        """Return True if this repository is flagged as a shared repository."""
1238
1959
        return self._transport.has('shared-storage')
1255
1976
        else:
1256
1977
            self._transport.put_bytes('no-working-trees', '',
1257
1978
                mode=self.bzrdir._get_file_mode())
1258
 
 
 
1979
    
1259
1980
    def make_working_trees(self):
1260
1981
        """Returns the policy for making working trees on new branches."""
1261
1982
        return not self._transport.has('no-working-trees')
1262
1983
 
1263
 
    @needs_write_lock
1264
 
    def update_feature_flags(self, updated_flags):
1265
 
        """Update the feature flags for this branch.
1266
 
 
1267
 
        :param updated_flags: Dictionary mapping feature names to necessities
1268
 
            A necessity can be None to indicate the feature should be removed
1269
 
        """
1270
 
        self._format._update_feature_flags(updated_flags)
1271
 
        self.control_transport.put_bytes('format', self._format.as_string())
1272
 
 
1273
 
 
1274
 
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1275
 
    """Repository format registry."""
1276
 
 
1277
 
    def get_default(self):
1278
 
        """Return the current default format."""
1279
 
        return controldir.format_registry.make_bzrdir('default').repository_format
1280
 
 
1281
 
 
1282
 
network_format_registry = registry.FormatRegistry()
1283
 
"""Registry of formats indexed by their network name.
1284
 
 
1285
 
The network name for a repository format is an identifier that can be used when
1286
 
referring to formats with smart server operations. See
1287
 
RepositoryFormat.network_name() for more detail.
1288
 
"""
1289
 
 
1290
 
 
1291
 
format_registry = RepositoryFormatRegistry(network_format_registry)
1292
 
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
 
1984
 
 
1985
class MetaDirVersionedFileRepository(MetaDirRepository):
 
1986
    """Repositories in a meta-dir, that work via versioned file objects."""
 
1987
 
 
1988
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
1989
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
1990
            control_files, _revision_store, control_store, text_store)
 
1991
        _revision_store.get_scope = self.get_transaction
 
1992
        control_store.get_scope = self.get_transaction
 
1993
        text_store.get_scope = self.get_transaction
 
1994
 
 
1995
 
 
1996
class RepositoryFormatRegistry(registry.Registry):
 
1997
    """Registry of RepositoryFormats."""
 
1998
 
 
1999
    def get(self, format_string):
 
2000
        r = registry.Registry.get(self, format_string)
 
2001
        if callable(r):
 
2002
            r = r()
 
2003
        return r
 
2004
    
 
2005
 
 
2006
format_registry = RepositoryFormatRegistry()
 
2007
"""Registry of formats, indexed by their identifying format string.
1293
2008
 
1294
2009
This can contain either format instances themselves, or classes/factories that
1295
2010
can be called to obtain one.
1299
2014
#####################################################################
1300
2015
# Repository Formats
1301
2016
 
1302
 
class RepositoryFormat(controldir.ControlComponentFormat):
 
2017
class RepositoryFormat(object):
1303
2018
    """A repository format.
1304
2019
 
1305
 
    Formats provide four things:
 
2020
    Formats provide three things:
1306
2021
     * An initialization routine to construct repository data on disk.
1307
 
     * a optional format string which is used when the BzrDir supports
1308
 
       versioned children.
 
2022
     * a format string which is used when the BzrDir supports versioned
 
2023
       children.
1309
2024
     * an open routine which returns a Repository instance.
1310
 
     * A network name for referring to the format in smart server RPC
1311
 
       methods.
1312
2025
 
1313
2026
    There is one and only one Format subclass for each on-disk format. But
1314
2027
    there can be one Repository subclass that is used for several different
1315
2028
    formats. The _format attribute on a Repository instance can be used to
1316
2029
    determine the disk format.
1317
2030
 
1318
 
    Formats are placed in a registry by their format string for reference
1319
 
    during opening. These should be subclasses of RepositoryFormat for
1320
 
    consistency.
 
2031
    Formats are placed in an dict by their format string for reference 
 
2032
    during opening. These should be subclasses of RepositoryFormat
 
2033
    for consistency.
1321
2034
 
1322
2035
    Once a format is deprecated, just deprecate the initialize and open
1323
 
    methods on the format class. Do not deprecate the object, as the
1324
 
    object may be created even when a repository instance hasn't been
1325
 
    created.
 
2036
    methods on the format class. Do not deprecate the object, as the 
 
2037
    object will be created every system load.
1326
2038
 
1327
2039
    Common instance attributes:
1328
 
    _matchingbzrdir - the controldir format that the repository format was
 
2040
    _matchingbzrdir - the bzrdir format that the repository format was
1329
2041
    originally written to work with. This can be used if manually
1330
2042
    constructing a bzrdir and repository, or more commonly for test suite
1331
2043
    parameterization.
1337
2049
    # Can this repository be given external locations to lookup additional
1338
2050
    # data. Set to True or False in derived classes.
1339
2051
    supports_external_lookups = None
1340
 
    # Does this format support CHK bytestring lookups. Set to True or False in
1341
 
    # derived classes.
1342
 
    supports_chks = None
1343
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
1344
 
    # some repository formats that can suffer internal inconsistencies.
1345
 
    _fetch_reconcile = False
1346
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
1347
 
    # code path for commit, amongst other things.
1348
 
    fast_deltas = None
1349
 
    # Does doing a pack operation compress data? Useful for the pack UI command
1350
 
    # (so if there is one pack, the operation can still proceed because it may
1351
 
    # help), and for fetching when data won't have come from the same
1352
 
    # compressor.
1353
 
    pack_compresses = False
1354
 
    # Does the repository storage understand references to trees?
1355
 
    supports_tree_reference = None
1356
 
    # Is the format experimental ?
1357
 
    experimental = False
1358
 
    # Does this repository format escape funky characters, or does it create
1359
 
    # files with similar names as the versioned files in its contents on disk
1360
 
    # ?
1361
 
    supports_funky_characters = None
1362
 
    # Does this repository format support leaving locks?
1363
 
    supports_leaving_lock = None
1364
 
    # Does this format support the full VersionedFiles interface?
1365
 
    supports_full_versioned_files = None
1366
 
    # Does this format support signing revision signatures?
1367
 
    supports_revision_signatures = True
1368
 
    # Can the revision graph have incorrect parents?
1369
 
    revision_graph_can_have_wrong_parents = None
1370
 
    # Does this format support rich root data?
1371
 
    rich_root_data = None
1372
 
    # Does this format support explicitly versioned directories?
1373
 
    supports_versioned_directories = None
1374
 
    # Can other repositories be nested into one of this format?
1375
 
    supports_nesting_repositories = None
1376
 
    # Is it possible for revisions to be present without being referenced
1377
 
    # somewhere ?
1378
 
    supports_unreferenced_revisions = None
1379
2052
 
1380
 
    def __repr__(self):
1381
 
        return "%s()" % self.__class__.__name__
 
2053
    def __str__(self):
 
2054
        return "<%s>" % self.__class__.__name__
1382
2055
 
1383
2056
    def __eq__(self, other):
1384
2057
        # format objects are generally stateless
1387
2060
    def __ne__(self, other):
1388
2061
        return not self == other
1389
2062
 
 
2063
    @classmethod
 
2064
    def find_format(klass, a_bzrdir):
 
2065
        """Return the format for the repository object in a_bzrdir.
 
2066
        
 
2067
        This is used by bzr native formats that have a "format" file in
 
2068
        the repository.  Other methods may be used by different types of 
 
2069
        control directory.
 
2070
        """
 
2071
        try:
 
2072
            transport = a_bzrdir.get_repository_transport(None)
 
2073
            format_string = transport.get("format").read()
 
2074
            return format_registry.get(format_string)
 
2075
        except errors.NoSuchFile:
 
2076
            raise errors.NoRepositoryPresent(a_bzrdir)
 
2077
        except KeyError:
 
2078
            raise errors.UnknownFormatError(format=format_string,
 
2079
                                            kind='repository')
 
2080
 
 
2081
    @classmethod
 
2082
    def register_format(klass, format):
 
2083
        format_registry.register(format.get_format_string(), format)
 
2084
 
 
2085
    @classmethod
 
2086
    def unregister_format(klass, format):
 
2087
        format_registry.remove(format.get_format_string())
 
2088
    
 
2089
    @classmethod
 
2090
    def get_default_format(klass):
 
2091
        """Return the current default format."""
 
2092
        from bzrlib import bzrdir
 
2093
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
2094
 
 
2095
    def _get_control_store(self, repo_transport, control_files):
 
2096
        """Return the control store for this repository."""
 
2097
        raise NotImplementedError(self._get_control_store)
 
2098
 
 
2099
    def get_format_string(self):
 
2100
        """Return the ASCII format string that identifies this format.
 
2101
        
 
2102
        Note that in pre format ?? repositories the format string is 
 
2103
        not permitted nor written to disk.
 
2104
        """
 
2105
        raise NotImplementedError(self.get_format_string)
 
2106
 
1390
2107
    def get_format_description(self):
1391
2108
        """Return the short description for this format."""
1392
2109
        raise NotImplementedError(self.get_format_description)
1393
2110
 
1394
 
    def initialize(self, controldir, shared=False):
1395
 
        """Initialize a repository of this format in controldir.
1396
 
 
1397
 
        :param controldir: The controldir to put the new repository in it.
 
2111
    def _get_revision_store(self, repo_transport, control_files):
 
2112
        """Return the revision store object for this a_bzrdir."""
 
2113
        raise NotImplementedError(self._get_revision_store)
 
2114
 
 
2115
    def _get_text_rev_store(self,
 
2116
                            transport,
 
2117
                            control_files,
 
2118
                            name,
 
2119
                            compressed=True,
 
2120
                            prefixed=False,
 
2121
                            serializer=None):
 
2122
        """Common logic for getting a revision store for a repository.
 
2123
        
 
2124
        see self._get_revision_store for the subclass-overridable method to 
 
2125
        get the store for a repository.
 
2126
        """
 
2127
        from bzrlib.store.revision.text import TextRevisionStore
 
2128
        dir_mode = control_files._dir_mode
 
2129
        file_mode = control_files._file_mode
 
2130
        text_store = TextStore(transport.clone(name),
 
2131
                              prefixed=prefixed,
 
2132
                              compressed=compressed,
 
2133
                              dir_mode=dir_mode,
 
2134
                              file_mode=file_mode)
 
2135
        _revision_store = TextRevisionStore(text_store, serializer)
 
2136
        return _revision_store
 
2137
 
 
2138
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2139
    # use weaves or knits -- mbp 20070207
 
2140
    def _get_versioned_file_store(self,
 
2141
                                  name,
 
2142
                                  transport,
 
2143
                                  control_files,
 
2144
                                  prefixed=True,
 
2145
                                  versionedfile_class=None,
 
2146
                                  versionedfile_kwargs={},
 
2147
                                  escaped=False):
 
2148
        if versionedfile_class is None:
 
2149
            versionedfile_class = self._versionedfile_class
 
2150
        weave_transport = control_files._transport.clone(name)
 
2151
        dir_mode = control_files._dir_mode
 
2152
        file_mode = control_files._file_mode
 
2153
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
2154
                                  dir_mode=dir_mode,
 
2155
                                  file_mode=file_mode,
 
2156
                                  versionedfile_class=versionedfile_class,
 
2157
                                  versionedfile_kwargs=versionedfile_kwargs,
 
2158
                                  escaped=escaped)
 
2159
 
 
2160
    def initialize(self, a_bzrdir, shared=False):
 
2161
        """Initialize a repository of this format in a_bzrdir.
 
2162
 
 
2163
        :param a_bzrdir: The bzrdir to put the new repository in it.
1398
2164
        :param shared: The repository should be initialized as a sharable one.
1399
2165
        :returns: The new repository object.
1400
 
 
 
2166
        
1401
2167
        This may raise UninitializableFormat if shared repository are not
1402
 
        compatible the controldir.
 
2168
        compatible the a_bzrdir.
1403
2169
        """
1404
2170
        raise NotImplementedError(self.initialize)
1405
2171
 
1407
2173
        """Is this format supported?
1408
2174
 
1409
2175
        Supported formats must be initializable and openable.
1410
 
        Unsupported formats may not support initialization or committing or
 
2176
        Unsupported formats may not support initialization or committing or 
1411
2177
        some other features depending on the reason for not being supported.
1412
2178
        """
1413
2179
        return True
1414
2180
 
1415
 
    def is_deprecated(self):
1416
 
        """Is this format deprecated?
1417
 
 
1418
 
        Deprecated formats may trigger a user-visible warning recommending
1419
 
        the user to upgrade. They are still fully supported.
1420
 
        """
1421
 
        return False
1422
 
 
1423
 
    def network_name(self):
1424
 
        """A simple byte string uniquely identifying this format for RPC calls.
1425
 
 
1426
 
        MetaDir repository formats use their disk format string to identify the
1427
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1428
 
        foreign formats like svn/git and hg should use some marker which is
1429
 
        unique and immutable.
1430
 
        """
1431
 
        raise NotImplementedError(self.network_name)
1432
 
 
1433
2181
    def check_conversion_target(self, target_format):
1434
 
        if self.rich_root_data and not target_format.rich_root_data:
1435
 
            raise errors.BadConversionTarget(
1436
 
                'Does not support rich root data.', target_format,
1437
 
                from_format=self)
1438
 
        if (self.supports_tree_reference and 
1439
 
            not getattr(target_format, 'supports_tree_reference', False)):
1440
 
            raise errors.BadConversionTarget(
1441
 
                'Does not support nested trees', target_format,
1442
 
                from_format=self)
1443
 
 
1444
 
    def open(self, controldir, _found=False):
1445
 
        """Return an instance of this format for a controldir.
1446
 
 
 
2182
        raise NotImplementedError(self.check_conversion_target)
 
2183
 
 
2184
    def open(self, a_bzrdir, _found=False):
 
2185
        """Return an instance of this format for the bzrdir a_bzrdir.
 
2186
        
1447
2187
        _found is a private parameter, do not use it.
1448
2188
        """
1449
2189
        raise NotImplementedError(self.open)
1450
2190
 
1451
 
    def _run_post_repo_init_hooks(self, repository, controldir, shared):
1452
 
        from bzrlib.controldir import ControlDir, RepoInitHookParams
1453
 
        hooks = ControlDir.hooks['post_repo_init']
1454
 
        if not hooks:
1455
 
            return
1456
 
        params = RepoInitHookParams(repository, self, controldir, shared)
1457
 
        for hook in hooks:
1458
 
            hook(params)
1459
 
 
1460
 
 
1461
 
class RepositoryFormatMetaDir(bzrdir.BzrFormat, RepositoryFormat):
 
2191
 
 
2192
class MetaDirRepositoryFormat(RepositoryFormat):
1462
2193
    """Common base class for the new repositories using the metadir layout."""
1463
2194
 
1464
2195
    rich_root_data = False
1465
2196
    supports_tree_reference = False
1466
2197
    supports_external_lookups = False
1467
 
    supports_leaving_lock = True
1468
 
    supports_nesting_repositories = True
1469
 
 
1470
 
    @property
1471
 
    def _matchingbzrdir(self):
1472
 
        matching = bzrdir.BzrDirMetaFormat1()
1473
 
        matching.repository_format = self
1474
 
        return matching
 
2198
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1475
2199
 
1476
2200
    def __init__(self):
1477
 
        RepositoryFormat.__init__(self)
1478
 
        bzrdir.BzrFormat.__init__(self)
 
2201
        super(MetaDirRepositoryFormat, self).__init__()
1479
2202
 
1480
2203
    def _create_control_files(self, a_bzrdir):
1481
2204
        """Create the required files and the initial control_files object."""
1505
2228
        finally:
1506
2229
            control_files.unlock()
1507
2230
 
1508
 
    @classmethod
1509
 
    def find_format(klass, a_bzrdir):
1510
 
        """Return the format for the repository object in a_bzrdir.
1511
 
 
1512
 
        This is used by bzr native formats that have a "format" file in
1513
 
        the repository.  Other methods may be used by different types of
1514
 
        control directory.
1515
 
        """
1516
 
        try:
1517
 
            transport = a_bzrdir.get_repository_transport(None)
1518
 
            format_string = transport.get_bytes("format")
1519
 
        except errors.NoSuchFile:
1520
 
            raise errors.NoRepositoryPresent(a_bzrdir)
1521
 
        return klass._find_format(format_registry, 'repository', format_string)
1522
 
 
1523
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1524
 
            basedir=None):
1525
 
        RepositoryFormat.check_support_status(self,
1526
 
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1527
 
            basedir=basedir)
1528
 
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1529
 
            recommend_upgrade=recommend_upgrade, basedir=basedir)
1530
 
 
1531
 
 
1532
 
# formats which have no format string are not discoverable or independently
1533
 
# creatable on disk, so are not registered in format_registry.  They're
1534
 
# all in bzrlib.repofmt.knitreponow.  When an instance of one of these is
1535
 
# needed, it's constructed directly by the ControlDir.  Non-native formats where
 
2231
 
 
2232
# formats which have no format string are not discoverable
 
2233
# and not independently creatable, so are not registered.  They're 
 
2234
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
2235
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1536
2236
# the repository is not separately opened are similar.
1537
2237
 
1538
2238
format_registry.register_lazy(
 
2239
    'Bazaar-NG Repository format 7',
 
2240
    'bzrlib.repofmt.weaverepo',
 
2241
    'RepositoryFormat7'
 
2242
    )
 
2243
 
 
2244
format_registry.register_lazy(
1539
2245
    'Bazaar-NG Knit Repository Format 1',
1540
2246
    'bzrlib.repofmt.knitrepo',
1541
2247
    'RepositoryFormatKnit1',
1558
2264
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1559
2265
format_registry.register_lazy(
1560
2266
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1561
 
    'bzrlib.repofmt.knitpack_repo',
 
2267
    'bzrlib.repofmt.pack_repo',
1562
2268
    'RepositoryFormatKnitPack1',
1563
2269
    )
1564
2270
format_registry.register_lazy(
1565
2271
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1566
 
    'bzrlib.repofmt.knitpack_repo',
 
2272
    'bzrlib.repofmt.pack_repo',
1567
2273
    'RepositoryFormatKnitPack3',
1568
2274
    )
1569
2275
format_registry.register_lazy(
1570
2276
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1571
 
    'bzrlib.repofmt.knitpack_repo',
 
2277
    'bzrlib.repofmt.pack_repo',
1572
2278
    'RepositoryFormatKnitPack4',
1573
2279
    )
1574
 
format_registry.register_lazy(
1575
 
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1576
 
    'bzrlib.repofmt.knitpack_repo',
1577
 
    'RepositoryFormatKnitPack5',
1578
 
    )
1579
 
format_registry.register_lazy(
1580
 
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1581
 
    'bzrlib.repofmt.knitpack_repo',
1582
 
    'RepositoryFormatKnitPack5RichRoot',
1583
 
    )
1584
 
format_registry.register_lazy(
1585
 
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1586
 
    'bzrlib.repofmt.knitpack_repo',
1587
 
    'RepositoryFormatKnitPack5RichRootBroken',
1588
 
    )
1589
 
format_registry.register_lazy(
1590
 
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1591
 
    'bzrlib.repofmt.knitpack_repo',
1592
 
    'RepositoryFormatKnitPack6',
1593
 
    )
1594
 
format_registry.register_lazy(
1595
 
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1596
 
    'bzrlib.repofmt.knitpack_repo',
1597
 
    'RepositoryFormatKnitPack6RichRoot',
1598
 
    )
1599
 
format_registry.register_lazy(
1600
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1601
 
    'bzrlib.repofmt.groupcompress_repo',
1602
 
    'RepositoryFormat2a',
1603
 
    )
1604
 
 
1605
 
# Development formats.
1606
 
# Check their docstrings to see if/when they are obsolete.
1607
 
format_registry.register_lazy(
1608
 
    ("Bazaar development format 2 with subtree support "
1609
 
        "(needs bzr.dev from before 1.8)\n"),
1610
 
    'bzrlib.repofmt.knitpack_repo',
1611
 
    'RepositoryFormatPackDevelopment2Subtree',
1612
 
    )
1613
 
format_registry.register_lazy(
1614
 
    'Bazaar development format 8\n',
1615
 
    'bzrlib.repofmt.groupcompress_repo',
1616
 
    'RepositoryFormat2aSubtree',
1617
 
    )
 
2280
# Development formats. 
 
2281
# 1.2->1.3
 
2282
# development 0 - stub to introduce development versioning scheme.
 
2283
format_registry.register_lazy(
 
2284
    "Bazaar development format 0 (needs bzr.dev from before 1.3)\n",
 
2285
    'bzrlib.repofmt.pack_repo',
 
2286
    'RepositoryFormatPackDevelopment0',
 
2287
    )
 
2288
format_registry.register_lazy(
 
2289
    ("Bazaar development format 0 with subtree support "
 
2290
        "(needs bzr.dev from before 1.3)\n"),
 
2291
    'bzrlib.repofmt.pack_repo',
 
2292
    'RepositoryFormatPackDevelopment0Subtree',
 
2293
    )
 
2294
# 1.3->1.4 go below here
1618
2295
 
1619
2296
 
1620
2297
class InterRepository(InterObject):
1621
2298
    """This class represents operations taking place between two repositories.
1622
2299
 
1623
2300
    Its instances have methods like copy_content and fetch, and contain
1624
 
    references to the source and target repositories these operations can be
 
2301
    references to the source and target repositories these operations can be 
1625
2302
    carried out on.
1626
2303
 
1627
2304
    Often we will provide convenience methods on 'repository' which carry out
1632
2309
    _optimisers = []
1633
2310
    """The available optimised InterRepository types."""
1634
2311
 
1635
 
    @needs_write_lock
1636
2312
    def copy_content(self, revision_id=None):
1637
 
        """Make a complete copy of the content in self into destination.
1638
 
 
1639
 
        This is a destructive operation! Do not use it on existing
1640
 
        repositories.
1641
 
 
1642
 
        :param revision_id: Only copy the content needed to construct
1643
 
                            revision_id and its parents.
1644
 
        """
1645
 
        try:
1646
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1647
 
        except NotImplementedError:
1648
 
            pass
1649
 
        self.target.fetch(self.source, revision_id=revision_id)
1650
 
 
1651
 
    @needs_write_lock
1652
 
    def fetch(self, revision_id=None, find_ghosts=False):
 
2313
        raise NotImplementedError(self.copy_content)
 
2314
 
 
2315
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1653
2316
        """Fetch the content required to construct revision_id.
1654
2317
 
1655
2318
        The content is copied from self.source to self.target.
1656
2319
 
1657
2320
        :param revision_id: if None all content is copied, if NULL_REVISION no
1658
2321
                            content is copied.
1659
 
        :return: None.
 
2322
        :param pb: optional progress bar to use for progress reports. If not
 
2323
                   provided a default one will be created.
 
2324
 
 
2325
        Returns the copied revision count and the failed revisions in a tuple:
 
2326
        (copied, failures).
1660
2327
        """
1661
2328
        raise NotImplementedError(self.fetch)
1662
2329
 
1663
 
    @needs_read_lock
1664
 
    def search_missing_revision_ids(self,
1665
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1666
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
1667
 
            limit=None):
1668
 
        """Return the revision ids that source has that target does not.
1669
 
 
1670
 
        :param revision_id: only return revision ids included by this
1671
 
            revision_id.
1672
 
        :param revision_ids: return revision ids included by these
1673
 
            revision_ids.  NoSuchRevision will be raised if any of these
1674
 
            revisions are not present.
1675
 
        :param if_present_ids: like revision_ids, but will not cause
1676
 
            NoSuchRevision if any of these are absent, instead they will simply
1677
 
            not be in the result.  This is useful for e.g. finding revisions
1678
 
            to fetch for tags, which may reference absent revisions.
1679
 
        :param find_ghosts: If True find missing revisions in deep history
1680
 
            rather than just finding the surface difference.
1681
 
        :param limit: Maximum number of revisions to return, topologically
1682
 
            ordered
 
2330
    def _walk_to_common_revisions(self, revision_ids):
 
2331
        """Walk out from revision_ids in source to revisions target has.
 
2332
 
 
2333
        :param revision_ids: The start point for the search.
 
2334
        :return: A set of revision ids.
 
2335
        """
 
2336
        target_graph = self.target.get_graph()
 
2337
        revision_ids = frozenset(revision_ids)
 
2338
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2339
            return graph.SearchResult(revision_ids, set(), 0, set())
 
2340
        missing_revs = set()
 
2341
        source_graph = self.source.get_graph()
 
2342
        # ensure we don't pay silly lookup costs.
 
2343
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
2344
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
2345
        while True:
 
2346
            try:
 
2347
                next_revs, ghosts = searcher.next_with_ghosts()
 
2348
            except StopIteration:
 
2349
                break
 
2350
            if revision_ids.intersection(ghosts):
 
2351
                absent_ids = set(revision_ids.intersection(ghosts))
 
2352
                # If all absent_ids are present in target, no error is needed.
 
2353
                absent_ids.difference_update(
 
2354
                    set(target_graph.get_parent_map(absent_ids)))
 
2355
                if absent_ids:
 
2356
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
 
2357
            # we don't care about other ghosts as we can't fetch them and
 
2358
            # haven't been asked to.
 
2359
            next_revs = set(next_revs)
 
2360
            # we always have NULL_REVISION present.
 
2361
            have_revs = set(target_graph.get_parent_map(next_revs)).union(null_set)
 
2362
            missing_revs.update(next_revs - have_revs)
 
2363
            searcher.stop_searching_any(have_revs)
 
2364
        return searcher.get_result()
 
2365
   
 
2366
    @deprecated_method(symbol_versioning.one_two)
 
2367
    @needs_read_lock
 
2368
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2369
        """Return the revision ids that source has that target does not.
 
2370
        
 
2371
        These are returned in topological order.
 
2372
 
 
2373
        :param revision_id: only return revision ids included by this
 
2374
                            revision_id.
 
2375
        :param find_ghosts: If True find missing revisions in deep history
 
2376
            rather than just finding the surface difference.
 
2377
        """
 
2378
        return list(self.search_missing_revision_ids(
 
2379
            revision_id, find_ghosts).get_keys())
 
2380
 
 
2381
    @needs_read_lock
 
2382
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2383
        """Return the revision ids that source has that target does not.
 
2384
        
 
2385
        :param revision_id: only return revision ids included by this
 
2386
                            revision_id.
 
2387
        :param find_ghosts: If True find missing revisions in deep history
 
2388
            rather than just finding the surface difference.
1683
2389
        :return: A bzrlib.graph.SearchResult.
1684
2390
        """
1685
 
        raise NotImplementedError(self.search_missing_revision_ids)
 
2391
        # stop searching at found target revisions.
 
2392
        if not find_ghosts and revision_id is not None:
 
2393
            return self._walk_to_common_revisions([revision_id])
 
2394
        # generic, possibly worst case, slow code path.
 
2395
        target_ids = set(self.target.all_revision_ids())
 
2396
        if revision_id is not None:
 
2397
            source_ids = self.source.get_ancestry(revision_id)
 
2398
            if source_ids[0] is not None:
 
2399
                raise AssertionError()
 
2400
            source_ids.pop(0)
 
2401
        else:
 
2402
            source_ids = self.source.all_revision_ids()
 
2403
        result_set = set(source_ids).difference(target_ids)
 
2404
        return self.source.revision_ids_to_search_result(result_set)
1686
2405
 
1687
2406
    @staticmethod
1688
2407
    def _same_model(source, target):
1689
 
        """True if source and target have the same data representation.
1690
 
 
1691
 
        Note: this is always called on the base class; overriding it in a
1692
 
        subclass will have no effect.
1693
 
        """
1694
 
        try:
1695
 
            InterRepository._assert_same_model(source, target)
1696
 
            return True
1697
 
        except errors.IncompatibleRepositories, e:
 
2408
        """True if source and target have the same data representation."""
 
2409
        if source.supports_rich_root() != target.supports_rich_root():
1698
2410
            return False
1699
 
 
1700
 
    @staticmethod
1701
 
    def _assert_same_model(source, target):
1702
 
        """Raise an exception if two repositories do not use the same model.
1703
 
        """
1704
 
        if source.supports_rich_root() != target.supports_rich_root():
1705
 
            raise errors.IncompatibleRepositories(source, target,
1706
 
                "different rich-root support")
1707
2411
        if source._serializer != target._serializer:
1708
 
            raise errors.IncompatibleRepositories(source, target,
1709
 
                "different serializers")
 
2412
            return False
 
2413
        return True
 
2414
 
 
2415
 
 
2416
class InterSameDataRepository(InterRepository):
 
2417
    """Code for converting between repositories that represent the same data.
 
2418
    
 
2419
    Data format and model must match for this to work.
 
2420
    """
 
2421
 
 
2422
    @classmethod
 
2423
    def _get_repo_format_to_test(self):
 
2424
        """Repository format for testing with.
 
2425
        
 
2426
        InterSameData can pull from subtree to subtree and from non-subtree to
 
2427
        non-subtree, so we test this with the richest repository format.
 
2428
        """
 
2429
        from bzrlib.repofmt import knitrepo
 
2430
        return knitrepo.RepositoryFormatKnit3()
 
2431
 
 
2432
    @staticmethod
 
2433
    def is_compatible(source, target):
 
2434
        return InterRepository._same_model(source, target)
 
2435
 
 
2436
    @needs_write_lock
 
2437
    def copy_content(self, revision_id=None):
 
2438
        """Make a complete copy of the content in self into destination.
 
2439
 
 
2440
        This copies both the repository's revision data, and configuration information
 
2441
        such as the make_working_trees setting.
 
2442
        
 
2443
        This is a destructive operation! Do not use it on existing 
 
2444
        repositories.
 
2445
 
 
2446
        :param revision_id: Only copy the content needed to construct
 
2447
                            revision_id and its parents.
 
2448
        """
 
2449
        try:
 
2450
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2451
        except NotImplementedError:
 
2452
            pass
 
2453
        # but don't bother fetching if we have the needed data now.
 
2454
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2455
            self.target.has_revision(revision_id)):
 
2456
            return
 
2457
        self.target.fetch(self.source, revision_id=revision_id)
 
2458
 
 
2459
    @needs_write_lock
 
2460
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2461
        """See InterRepository.fetch()."""
 
2462
        from bzrlib.fetch import GenericRepoFetcher
 
2463
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2464
               self.source, self.source._format, self.target,
 
2465
               self.target._format)
 
2466
        f = GenericRepoFetcher(to_repository=self.target,
 
2467
                               from_repository=self.source,
 
2468
                               last_revision=revision_id,
 
2469
                               pb=pb, find_ghosts=find_ghosts)
 
2470
        return f.count_copied, f.failed_revisions
 
2471
 
 
2472
 
 
2473
class InterWeaveRepo(InterSameDataRepository):
 
2474
    """Optimised code paths between Weave based repositories.
 
2475
    
 
2476
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
2477
    implemented lazy inter-object optimisation.
 
2478
    """
 
2479
 
 
2480
    @classmethod
 
2481
    def _get_repo_format_to_test(self):
 
2482
        from bzrlib.repofmt import weaverepo
 
2483
        return weaverepo.RepositoryFormat7()
 
2484
 
 
2485
    @staticmethod
 
2486
    def is_compatible(source, target):
 
2487
        """Be compatible with known Weave formats.
 
2488
        
 
2489
        We don't test for the stores being of specific types because that
 
2490
        could lead to confusing results, and there is no need to be 
 
2491
        overly general.
 
2492
        """
 
2493
        from bzrlib.repofmt.weaverepo import (
 
2494
                RepositoryFormat5,
 
2495
                RepositoryFormat6,
 
2496
                RepositoryFormat7,
 
2497
                )
 
2498
        try:
 
2499
            return (isinstance(source._format, (RepositoryFormat5,
 
2500
                                                RepositoryFormat6,
 
2501
                                                RepositoryFormat7)) and
 
2502
                    isinstance(target._format, (RepositoryFormat5,
 
2503
                                                RepositoryFormat6,
 
2504
                                                RepositoryFormat7)))
 
2505
        except AttributeError:
 
2506
            return False
 
2507
    
 
2508
    @needs_write_lock
 
2509
    def copy_content(self, revision_id=None):
 
2510
        """See InterRepository.copy_content()."""
 
2511
        # weave specific optimised path:
 
2512
        try:
 
2513
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2514
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
2515
            pass
 
2516
        # FIXME do not peek!
 
2517
        if self.source._transport.listable():
 
2518
            pb = ui.ui_factory.nested_progress_bar()
 
2519
            try:
 
2520
                self.target.weave_store.copy_all_ids(
 
2521
                    self.source.weave_store,
 
2522
                    pb=pb,
 
2523
                    from_transaction=self.source.get_transaction(),
 
2524
                    to_transaction=self.target.get_transaction())
 
2525
                pb.update('copying inventory', 0, 1)
 
2526
                self.target.control_weaves.copy_multi(
 
2527
                    self.source.control_weaves, ['inventory'],
 
2528
                    from_transaction=self.source.get_transaction(),
 
2529
                    to_transaction=self.target.get_transaction())
 
2530
                self.target._revision_store.text_store.copy_all_ids(
 
2531
                    self.source._revision_store.text_store,
 
2532
                    pb=pb)
 
2533
            finally:
 
2534
                pb.finished()
 
2535
        else:
 
2536
            self.target.fetch(self.source, revision_id=revision_id)
 
2537
 
 
2538
    @needs_write_lock
 
2539
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2540
        """See InterRepository.fetch()."""
 
2541
        from bzrlib.fetch import GenericRepoFetcher
 
2542
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2543
               self.source, self.source._format, self.target, self.target._format)
 
2544
        f = GenericRepoFetcher(to_repository=self.target,
 
2545
                               from_repository=self.source,
 
2546
                               last_revision=revision_id,
 
2547
                               pb=pb, find_ghosts=find_ghosts)
 
2548
        return f.count_copied, f.failed_revisions
 
2549
 
 
2550
    @needs_read_lock
 
2551
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2552
        """See InterRepository.missing_revision_ids()."""
 
2553
        # we want all revisions to satisfy revision_id in source.
 
2554
        # but we don't want to stat every file here and there.
 
2555
        # we want then, all revisions other needs to satisfy revision_id 
 
2556
        # checked, but not those that we have locally.
 
2557
        # so the first thing is to get a subset of the revisions to 
 
2558
        # satisfy revision_id in source, and then eliminate those that
 
2559
        # we do already have. 
 
2560
        # this is slow on high latency connection to self, but as as this
 
2561
        # disk format scales terribly for push anyway due to rewriting 
 
2562
        # inventory.weave, this is considered acceptable.
 
2563
        # - RBC 20060209
 
2564
        if revision_id is not None:
 
2565
            source_ids = self.source.get_ancestry(revision_id)
 
2566
            if source_ids[0] is not None:
 
2567
                raise AssertionError()
 
2568
            source_ids.pop(0)
 
2569
        else:
 
2570
            source_ids = self.source._all_possible_ids()
 
2571
        source_ids_set = set(source_ids)
 
2572
        # source_ids is the worst possible case we may need to pull.
 
2573
        # now we want to filter source_ids against what we actually
 
2574
        # have in target, but don't try to check for existence where we know
 
2575
        # we do not have a revision as that would be pointless.
 
2576
        target_ids = set(self.target._all_possible_ids())
 
2577
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
2578
        actually_present_revisions = set(
 
2579
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2580
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2581
        if revision_id is not None:
 
2582
            # we used get_ancestry to determine source_ids then we are assured all
 
2583
            # revisions referenced are present as they are installed in topological order.
 
2584
            # and the tip revision was validated by get_ancestry.
 
2585
            result_set = required_revisions
 
2586
        else:
 
2587
            # if we just grabbed the possibly available ids, then 
 
2588
            # we only have an estimate of whats available and need to validate
 
2589
            # that against the revision records.
 
2590
            result_set = set(
 
2591
                self.source._eliminate_revisions_not_present(required_revisions))
 
2592
        return self.source.revision_ids_to_search_result(result_set)
 
2593
 
 
2594
 
 
2595
class InterKnitRepo(InterSameDataRepository):
 
2596
    """Optimised code paths between Knit based repositories."""
 
2597
 
 
2598
    @classmethod
 
2599
    def _get_repo_format_to_test(self):
 
2600
        from bzrlib.repofmt import knitrepo
 
2601
        return knitrepo.RepositoryFormatKnit1()
 
2602
 
 
2603
    @staticmethod
 
2604
    def is_compatible(source, target):
 
2605
        """Be compatible with known Knit formats.
 
2606
        
 
2607
        We don't test for the stores being of specific types because that
 
2608
        could lead to confusing results, and there is no need to be 
 
2609
        overly general.
 
2610
        """
 
2611
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
2612
        try:
 
2613
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
2614
                isinstance(target._format, RepositoryFormatKnit))
 
2615
        except AttributeError:
 
2616
            return False
 
2617
        return are_knits and InterRepository._same_model(source, target)
 
2618
 
 
2619
    @needs_write_lock
 
2620
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2621
        """See InterRepository.fetch()."""
 
2622
        from bzrlib.fetch import KnitRepoFetcher
 
2623
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2624
               self.source, self.source._format, self.target, self.target._format)
 
2625
        f = KnitRepoFetcher(to_repository=self.target,
 
2626
                            from_repository=self.source,
 
2627
                            last_revision=revision_id,
 
2628
                            pb=pb, find_ghosts=find_ghosts)
 
2629
        return f.count_copied, f.failed_revisions
 
2630
 
 
2631
    @needs_read_lock
 
2632
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2633
        """See InterRepository.missing_revision_ids()."""
 
2634
        if revision_id is not None:
 
2635
            source_ids = self.source.get_ancestry(revision_id)
 
2636
            if source_ids[0] is not None:
 
2637
                raise AssertionError()
 
2638
            source_ids.pop(0)
 
2639
        else:
 
2640
            source_ids = self.source.all_revision_ids()
 
2641
        source_ids_set = set(source_ids)
 
2642
        # source_ids is the worst possible case we may need to pull.
 
2643
        # now we want to filter source_ids against what we actually
 
2644
        # have in target, but don't try to check for existence where we know
 
2645
        # we do not have a revision as that would be pointless.
 
2646
        target_ids = set(self.target.all_revision_ids())
 
2647
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
2648
        actually_present_revisions = set(
 
2649
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2650
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2651
        if revision_id is not None:
 
2652
            # we used get_ancestry to determine source_ids then we are assured all
 
2653
            # revisions referenced are present as they are installed in topological order.
 
2654
            # and the tip revision was validated by get_ancestry.
 
2655
            result_set = required_revisions
 
2656
        else:
 
2657
            # if we just grabbed the possibly available ids, then 
 
2658
            # we only have an estimate of whats available and need to validate
 
2659
            # that against the revision records.
 
2660
            result_set = set(
 
2661
                self.source._eliminate_revisions_not_present(required_revisions))
 
2662
        return self.source.revision_ids_to_search_result(result_set)
 
2663
 
 
2664
 
 
2665
class InterPackRepo(InterSameDataRepository):
 
2666
    """Optimised code paths between Pack based repositories."""
 
2667
 
 
2668
    @classmethod
 
2669
    def _get_repo_format_to_test(self):
 
2670
        from bzrlib.repofmt import pack_repo
 
2671
        return pack_repo.RepositoryFormatKnitPack1()
 
2672
 
 
2673
    @staticmethod
 
2674
    def is_compatible(source, target):
 
2675
        """Be compatible with known Pack formats.
 
2676
        
 
2677
        We don't test for the stores being of specific types because that
 
2678
        could lead to confusing results, and there is no need to be 
 
2679
        overly general.
 
2680
        """
 
2681
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2682
        try:
 
2683
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2684
                isinstance(target._format, RepositoryFormatPack))
 
2685
        except AttributeError:
 
2686
            return False
 
2687
        return are_packs and InterRepository._same_model(source, target)
 
2688
 
 
2689
    @needs_write_lock
 
2690
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2691
        """See InterRepository.fetch()."""
 
2692
        from bzrlib.repofmt.pack_repo import Packer
 
2693
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2694
               self.source, self.source._format, self.target, self.target._format)
 
2695
        self.count_copied = 0
 
2696
        if revision_id is None:
 
2697
            # TODO:
 
2698
            # everything to do - use pack logic
 
2699
            # to fetch from all packs to one without
 
2700
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2701
            # till then:
 
2702
            revision_ids = self.source.all_revision_ids()
 
2703
            revision_keys = [(revid,) for revid in revision_ids]
 
2704
            index = self.target._pack_collection.revision_index.combined_index
 
2705
            present_revision_ids = set(item[1][0] for item in
 
2706
                index.iter_entries(revision_keys))
 
2707
            revision_ids = set(revision_ids) - present_revision_ids
 
2708
            # implementing the TODO will involve:
 
2709
            # - detecting when all of a pack is selected
 
2710
            # - avoiding as much as possible pre-selection, so the
 
2711
            # more-core routines such as create_pack_from_packs can filter in
 
2712
            # a just-in-time fashion. (though having a HEADS list on a
 
2713
            # repository might make this a lot easier, because we could
 
2714
            # sensibly detect 'new revisions' without doing a full index scan.
 
2715
        elif _mod_revision.is_null(revision_id):
 
2716
            # nothing to do:
 
2717
            return (0, [])
 
2718
        else:
 
2719
            try:
 
2720
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2721
                    find_ghosts=find_ghosts).get_keys()
 
2722
            except errors.NoSuchRevision:
 
2723
                raise errors.InstallFailed([revision_id])
 
2724
            if len(revision_ids) == 0:
 
2725
                return (0, [])
 
2726
        packs = self.source._pack_collection.all_packs()
 
2727
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
2728
            revision_ids).pack()
 
2729
        if pack is not None:
 
2730
            self.target._pack_collection._save_pack_names()
 
2731
            # Trigger an autopack. This may duplicate effort as we've just done
 
2732
            # a pack creation, but for now it is simpler to think about as
 
2733
            # 'upload data, then repack if needed'.
 
2734
            self.target._pack_collection.autopack()
 
2735
            return (pack.get_revision_count(), [])
 
2736
        else:
 
2737
            return (0, [])
 
2738
 
 
2739
    @needs_read_lock
 
2740
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2741
        """See InterRepository.missing_revision_ids().
 
2742
        
 
2743
        :param find_ghosts: Find ghosts throughout the ancestry of
 
2744
            revision_id.
 
2745
        """
 
2746
        if not find_ghosts and revision_id is not None:
 
2747
            return self._walk_to_common_revisions([revision_id])
 
2748
        elif revision_id is not None:
 
2749
            source_ids = self.source.get_ancestry(revision_id)
 
2750
            if source_ids[0] is not None:
 
2751
                raise AssertionError()
 
2752
            source_ids.pop(0)
 
2753
        else:
 
2754
            source_ids = self.source.all_revision_ids()
 
2755
        # source_ids is the worst possible case we may need to pull.
 
2756
        # now we want to filter source_ids against what we actually
 
2757
        # have in target, but don't try to check for existence where we know
 
2758
        # we do not have a revision as that would be pointless.
 
2759
        target_ids = set(self.target.all_revision_ids())
 
2760
        result_set = set(source_ids).difference(target_ids)
 
2761
        return self.source.revision_ids_to_search_result(result_set)
 
2762
 
 
2763
 
 
2764
class InterModel1and2(InterRepository):
 
2765
 
 
2766
    @classmethod
 
2767
    def _get_repo_format_to_test(self):
 
2768
        return None
 
2769
 
 
2770
    @staticmethod
 
2771
    def is_compatible(source, target):
 
2772
        if not source.supports_rich_root() and target.supports_rich_root():
 
2773
            return True
 
2774
        else:
 
2775
            return False
 
2776
 
 
2777
    @needs_write_lock
 
2778
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2779
        """See InterRepository.fetch()."""
 
2780
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2781
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2782
                                 from_repository=self.source,
 
2783
                                 last_revision=revision_id,
 
2784
                                 pb=pb, find_ghosts=find_ghosts)
 
2785
        return f.count_copied, f.failed_revisions
 
2786
 
 
2787
    @needs_write_lock
 
2788
    def copy_content(self, revision_id=None):
 
2789
        """Make a complete copy of the content in self into destination.
 
2790
        
 
2791
        This is a destructive operation! Do not use it on existing 
 
2792
        repositories.
 
2793
 
 
2794
        :param revision_id: Only copy the content needed to construct
 
2795
                            revision_id and its parents.
 
2796
        """
 
2797
        try:
 
2798
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2799
        except NotImplementedError:
 
2800
            pass
 
2801
        # but don't bother fetching if we have the needed data now.
 
2802
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2803
            self.target.has_revision(revision_id)):
 
2804
            return
 
2805
        self.target.fetch(self.source, revision_id=revision_id)
 
2806
 
 
2807
 
 
2808
class InterKnit1and2(InterKnitRepo):
 
2809
 
 
2810
    @classmethod
 
2811
    def _get_repo_format_to_test(self):
 
2812
        return None
 
2813
 
 
2814
    @staticmethod
 
2815
    def is_compatible(source, target):
 
2816
        """Be compatible with Knit1 source and Knit3 target"""
 
2817
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
2818
        try:
 
2819
            from bzrlib.repofmt.knitrepo import (RepositoryFormatKnit1,
 
2820
                RepositoryFormatKnit3)
 
2821
            from bzrlib.repofmt.pack_repo import (
 
2822
                RepositoryFormatKnitPack1,
 
2823
                RepositoryFormatKnitPack3,
 
2824
                RepositoryFormatPackDevelopment0,
 
2825
                RepositoryFormatPackDevelopment0Subtree,
 
2826
                )
 
2827
            nosubtrees = (
 
2828
                RepositoryFormatKnit1,
 
2829
                RepositoryFormatKnitPack1,
 
2830
                RepositoryFormatPackDevelopment0,
 
2831
                )
 
2832
            subtrees = (
 
2833
                RepositoryFormatKnit3,
 
2834
                RepositoryFormatKnitPack3,
 
2835
                RepositoryFormatPackDevelopment0Subtree,
 
2836
                )
 
2837
            return (isinstance(source._format, nosubtrees) and
 
2838
                isinstance(target._format, subtrees))
 
2839
        except AttributeError:
 
2840
            return False
 
2841
 
 
2842
    @needs_write_lock
 
2843
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2844
        """See InterRepository.fetch()."""
 
2845
        from bzrlib.fetch import Knit1to2Fetcher
 
2846
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2847
               self.source, self.source._format, self.target, 
 
2848
               self.target._format)
 
2849
        f = Knit1to2Fetcher(to_repository=self.target,
 
2850
                            from_repository=self.source,
 
2851
                            last_revision=revision_id,
 
2852
                            pb=pb, find_ghosts=find_ghosts)
 
2853
        return f.count_copied, f.failed_revisions
 
2854
 
 
2855
 
 
2856
class InterDifferingSerializer(InterKnitRepo):
 
2857
 
 
2858
    @classmethod
 
2859
    def _get_repo_format_to_test(self):
 
2860
        return None
 
2861
 
 
2862
    @staticmethod
 
2863
    def is_compatible(source, target):
 
2864
        """Be compatible with Knit2 source and Knit3 target"""
 
2865
        if source.supports_rich_root() != target.supports_rich_root():
 
2866
            return False
 
2867
        # Ideally, we'd support fetching if the source had no tree references
 
2868
        # even if it supported them...
 
2869
        if (getattr(source, '_format.supports_tree_reference', False) and
 
2870
            not getattr(target, '_format.supports_tree_reference', False)):
 
2871
            return False
 
2872
        return True
 
2873
 
 
2874
    @needs_write_lock
 
2875
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2876
        """See InterRepository.fetch()."""
 
2877
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
2878
            revision_id, find_ghosts=find_ghosts).get_keys()
 
2879
        revision_ids = tsort.topo_sort(
 
2880
            self.source.get_graph().get_parent_map(revision_ids))
 
2881
        def revisions_iterator():
 
2882
            for current_revision_id in revision_ids:
 
2883
                revision = self.source.get_revision(current_revision_id)
 
2884
                tree = self.source.revision_tree(current_revision_id)
 
2885
                try:
 
2886
                    signature = self.source.get_signature_text(
 
2887
                        current_revision_id)
 
2888
                except errors.NoSuchRevision:
 
2889
                    signature = None
 
2890
                yield revision, tree, signature
 
2891
        if pb is None:
 
2892
            my_pb = ui.ui_factory.nested_progress_bar()
 
2893
            pb = my_pb
 
2894
        else:
 
2895
            my_pb = None
 
2896
        try:
 
2897
            install_revisions(self.target, revisions_iterator(),
 
2898
                              len(revision_ids), pb)
 
2899
        finally:
 
2900
            if my_pb is not None:
 
2901
                my_pb.finished()
 
2902
        return len(revision_ids), 0
 
2903
 
 
2904
 
 
2905
class InterRemoteToOther(InterRepository):
 
2906
 
 
2907
    def __init__(self, source, target):
 
2908
        InterRepository.__init__(self, source, target)
 
2909
        self._real_inter = None
 
2910
 
 
2911
    @staticmethod
 
2912
    def is_compatible(source, target):
 
2913
        if not isinstance(source, remote.RemoteRepository):
 
2914
            return False
 
2915
        # Is source's model compatible with target's model?
 
2916
        source._ensure_real()
 
2917
        real_source = source._real_repository
 
2918
        if isinstance(real_source, remote.RemoteRepository):
 
2919
            raise NotImplementedError(
 
2920
                "We don't support remote repos backed by remote repos yet.")
 
2921
        return InterRepository._same_model(real_source, target)
 
2922
 
 
2923
    @needs_write_lock
 
2924
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2925
        """See InterRepository.fetch()."""
 
2926
        from bzrlib.fetch import RemoteToOtherFetcher
 
2927
        mutter("Using fetch logic to copy between %s(remote) and %s(%s)",
 
2928
               self.source, self.target, self.target._format)
 
2929
        # TODO: jam 20070210 This should be an assert, not a translate
 
2930
        revision_id = osutils.safe_revision_id(revision_id)
 
2931
        f = RemoteToOtherFetcher(to_repository=self.target,
 
2932
                                 from_repository=self.source,
 
2933
                                 last_revision=revision_id,
 
2934
                                 pb=pb, find_ghosts=find_ghosts)
 
2935
        return f.count_copied, f.failed_revisions
 
2936
 
 
2937
    @classmethod
 
2938
    def _get_repo_format_to_test(self):
 
2939
        return None
 
2940
 
 
2941
 
 
2942
class InterOtherToRemote(InterRepository):
 
2943
 
 
2944
    def __init__(self, source, target):
 
2945
        InterRepository.__init__(self, source, target)
 
2946
        self._real_inter = None
 
2947
 
 
2948
    @staticmethod
 
2949
    def is_compatible(source, target):
 
2950
        if isinstance(target, remote.RemoteRepository):
 
2951
            return True
 
2952
        return False
 
2953
 
 
2954
    def _ensure_real_inter(self):
 
2955
        if self._real_inter is None:
 
2956
            self.target._ensure_real()
 
2957
            real_target = self.target._real_repository
 
2958
            self._real_inter = InterRepository.get(self.source, real_target)
 
2959
    
 
2960
    def copy_content(self, revision_id=None):
 
2961
        self._ensure_real_inter()
 
2962
        self._real_inter.copy_content(revision_id=revision_id)
 
2963
 
 
2964
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2965
        self._ensure_real_inter()
 
2966
        self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
2967
            find_ghosts=find_ghosts)
 
2968
 
 
2969
    @classmethod
 
2970
    def _get_repo_format_to_test(self):
 
2971
        return None
 
2972
 
 
2973
 
 
2974
InterRepository.register_optimiser(InterDifferingSerializer)
 
2975
InterRepository.register_optimiser(InterSameDataRepository)
 
2976
InterRepository.register_optimiser(InterWeaveRepo)
 
2977
InterRepository.register_optimiser(InterKnitRepo)
 
2978
InterRepository.register_optimiser(InterModel1and2)
 
2979
InterRepository.register_optimiser(InterKnit1and2)
 
2980
InterRepository.register_optimiser(InterPackRepo)
 
2981
InterRepository.register_optimiser(InterRemoteToOther)
 
2982
InterRepository.register_optimiser(InterOtherToRemote)
1710
2983
 
1711
2984
 
1712
2985
class CopyConverter(object):
1713
2986
    """A repository conversion tool which just performs a copy of the content.
1714
 
 
 
2987
    
1715
2988
    This is slow but quite reliable.
1716
2989
    """
1717
2990
 
1721
2994
        :param target_format: The format the resulting repository should be.
1722
2995
        """
1723
2996
        self.target_format = target_format
1724
 
 
 
2997
        
1725
2998
    def convert(self, repo, pb):
1726
2999
        """Perform the conversion of to_convert, giving feedback via pb.
1727
3000
 
1728
3001
        :param to_convert: The disk object to convert.
1729
3002
        :param pb: a progress bar to use for progress information.
1730
3003
        """
1731
 
        pb = ui.ui_factory.nested_progress_bar()
 
3004
        self.pb = pb
1732
3005
        self.count = 0
1733
3006
        self.total = 4
1734
3007
        # this is only useful with metadir layouts - separated repo content.
1735
3008
        # trigger an assertion if not such
1736
3009
        repo._format.get_format_string()
1737
3010
        self.repo_dir = repo.bzrdir
1738
 
        pb.update(gettext('Moving repository to repository.backup'))
 
3011
        self.step('Moving repository to repository.backup')
1739
3012
        self.repo_dir.transport.move('repository', 'repository.backup')
1740
3013
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1741
3014
        repo._format.check_conversion_target(self.target_format)
1742
3015
        self.source_repo = repo._format.open(self.repo_dir,
1743
3016
            _found=True,
1744
3017
            _override_transport=backup_transport)
1745
 
        pb.update(gettext('Creating new repository'))
 
3018
        self.step('Creating new repository')
1746
3019
        converted = self.target_format.initialize(self.repo_dir,
1747
3020
                                                  self.source_repo.is_shared())
1748
3021
        converted.lock_write()
1749
3022
        try:
1750
 
            pb.update(gettext('Copying content'))
 
3023
            self.step('Copying content into repository.')
1751
3024
            self.source_repo.copy_content_into(converted)
1752
3025
        finally:
1753
3026
            converted.unlock()
1754
 
        pb.update(gettext('Deleting old repository content'))
 
3027
        self.step('Deleting old repository content.')
1755
3028
        self.repo_dir.transport.delete_tree('repository.backup')
1756
 
        ui.ui_factory.note(gettext('repository converted'))
1757
 
        pb.finished()
 
3029
        self.pb.note('repository converted')
 
3030
 
 
3031
    def step(self, message):
 
3032
        """Update the pb by a step."""
 
3033
        self.count +=1
 
3034
        self.pb.update(message, self.count, self.total)
 
3035
 
 
3036
 
 
3037
_unescape_map = {
 
3038
    'apos':"'",
 
3039
    'quot':'"',
 
3040
    'amp':'&',
 
3041
    'lt':'<',
 
3042
    'gt':'>'
 
3043
}
 
3044
 
 
3045
 
 
3046
def _unescaper(match, _map=_unescape_map):
 
3047
    code = match.group(1)
 
3048
    try:
 
3049
        return _map[code]
 
3050
    except KeyError:
 
3051
        if not code.startswith('#'):
 
3052
            raise
 
3053
        return unichr(int(code[1:])).encode('utf8')
 
3054
 
 
3055
 
 
3056
_unescape_re = None
 
3057
 
 
3058
 
 
3059
def _unescape_xml(data):
 
3060
    """Unescape predefined XML entities in a string of data."""
 
3061
    global _unescape_re
 
3062
    if _unescape_re is None:
 
3063
        _unescape_re = re.compile('\&([^;]*);')
 
3064
    return _unescape_re.sub(_unescaper, data)
 
3065
 
 
3066
 
 
3067
class _VersionedFileChecker(object):
 
3068
 
 
3069
    def __init__(self, repository):
 
3070
        self.repository = repository
 
3071
        self.text_index = self.repository._generate_text_key_index()
 
3072
    
 
3073
    def calculate_file_version_parents(self, revision_id, file_id):
 
3074
        """Calculate the correct parents for a file version according to
 
3075
        the inventories.
 
3076
        """
 
3077
        parent_keys = self.text_index[(file_id, revision_id)]
 
3078
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3079
            return ()
 
3080
        # strip the file_id, for the weave api
 
3081
        return tuple([revision_id for file_id, revision_id in parent_keys])
 
3082
 
 
3083
    def check_file_version_parents(self, weave, file_id):
 
3084
        """Check the parents stored in a versioned file are correct.
 
3085
 
 
3086
        It also detects file versions that are not referenced by their
 
3087
        corresponding revision's inventory.
 
3088
 
 
3089
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3090
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3091
            correct_parents)} for each revision_id where the stored parents
 
3092
            are not correct.  dangling_file_versions is a set of (file_id,
 
3093
            revision_id) tuples for versions that are present in this versioned
 
3094
            file, but not used by the corresponding inventory.
 
3095
        """
 
3096
        wrong_parents = {}
 
3097
        unused_versions = set()
 
3098
        versions = weave.versions()
 
3099
        parent_map = weave.get_parent_map(versions)
 
3100
        for num, revision_id in enumerate(versions):
 
3101
            try:
 
3102
                correct_parents = self.calculate_file_version_parents(
 
3103
                    revision_id, file_id)
 
3104
            except KeyError:
 
3105
                # The version is not part of the used keys.
 
3106
                unused_versions.add(revision_id)
 
3107
            else:
 
3108
                try:
 
3109
                    knit_parents = tuple(parent_map[revision_id])
 
3110
                except errors.RevisionNotPresent:
 
3111
                    knit_parents = None
 
3112
                if correct_parents != knit_parents:
 
3113
                    wrong_parents[revision_id] = (knit_parents, correct_parents)
 
3114
        return wrong_parents, unused_versions
 
3115
 
 
3116
 
 
3117
def _old_get_graph(repository, revision_id):
 
3118
    """DO NOT USE. That is all. I'm serious."""
 
3119
    graph = repository.get_graph()
 
3120
    revision_graph = dict(((key, value) for key, value in
 
3121
        graph.iter_ancestry([revision_id]) if value is not None))
 
3122
    return _strip_NULL_ghosts(revision_graph)
1758
3123
 
1759
3124
 
1760
3125
def _strip_NULL_ghosts(revision_graph):
1766
3131
        revision_graph[key] = tuple(parent for parent in parents if parent
1767
3132
            in revision_graph)
1768
3133
    return revision_graph
1769
 
 
1770
 
 
1771
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1772
 
                    stop_revision=None):
1773
 
    """Extend the partial history to include a given index
1774
 
 
1775
 
    If a stop_index is supplied, stop when that index has been reached.
1776
 
    If a stop_revision is supplied, stop when that revision is
1777
 
    encountered.  Otherwise, stop when the beginning of history is
1778
 
    reached.
1779
 
 
1780
 
    :param stop_index: The index which should be present.  When it is
1781
 
        present, history extension will stop.
1782
 
    :param stop_revision: The revision id which should be present.  When
1783
 
        it is encountered, history extension will stop.
1784
 
    """
1785
 
    start_revision = partial_history_cache[-1]
1786
 
    graph = repo.get_graph()
1787
 
    iterator = graph.iter_lefthand_ancestry(start_revision,
1788
 
        (_mod_revision.NULL_REVISION,))
1789
 
    try:
1790
 
        # skip the last revision in the list
1791
 
        iterator.next()
1792
 
        while True:
1793
 
            if (stop_index is not None and
1794
 
                len(partial_history_cache) > stop_index):
1795
 
                break
1796
 
            if partial_history_cache[-1] == stop_revision:
1797
 
                break
1798
 
            revision_id = iterator.next()
1799
 
            partial_history_cache.append(revision_id)
1800
 
    except StopIteration:
1801
 
        # No more history
1802
 
        return
1803
 
 
1804
 
 
1805
 
class _LazyListJoin(object):
1806
 
    """An iterable yielding the contents of many lists as one list.
1807
 
 
1808
 
    Each iterator made from this will reflect the current contents of the lists
1809
 
    at the time the iterator is made.
1810
 
    
1811
 
    This is used by Repository's _make_parents_provider implementation so that
1812
 
    it is safe to do::
1813
 
 
1814
 
      pp = repo._make_parents_provider()      # uses a list of fallback repos
1815
 
      pp.add_fallback_repository(other_repo)  # appends to that list
1816
 
      result = pp.get_parent_map(...)
1817
 
      # The result will include revs from other_repo
1818
 
    """
1819
 
 
1820
 
    def __init__(self, *list_parts):
1821
 
        self.list_parts = list_parts
1822
 
 
1823
 
    def __iter__(self):
1824
 
        full_list = []
1825
 
        for list_part in self.list_parts:
1826
 
            full_list.extend(list_part)
1827
 
        return iter(full_list)
1828
 
 
1829
 
    def __repr__(self):
1830
 
        return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
1831
 
                              self.list_parts)