~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

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