~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 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
 
import unittest
24
23
 
25
24
from bzrlib import (
26
 
    bzrdir,
27
 
    check,
28
 
    errors,
 
25
    config,
 
26
    controldir,
 
27
    debug,
29
28
    generate_ids,
30
 
    gpg,
31
29
    graph,
32
 
    lazy_regex,
33
30
    lockable_files,
34
31
    lockdir,
35
32
    osutils,
 
33
    revision as _mod_revision,
 
34
    testament as _mod_testament,
 
35
    tsort,
 
36
    gpg,
 
37
    )
 
38
from bzrlib.bundle import serializer
 
39
from bzrlib.i18n import gettext
 
40
""")
 
41
 
 
42
from bzrlib import (
 
43
    bzrdir,
 
44
    errors,
36
45
    registry,
37
 
    revision as _mod_revision,
38
46
    symbol_versioning,
39
 
    transactions,
40
47
    ui,
41
48
    )
42
 
from bzrlib.revisiontree import RevisionTree
43
 
from bzrlib.store.versioned import VersionedFileStore
44
 
from bzrlib.store.text import TextStore
45
 
from bzrlib.testament import Testament
46
 
 
47
 
""")
48
 
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.inter import InterObject
51
 
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
52
 
from bzrlib.symbol_versioning import (
53
 
        deprecated_method,
54
 
        zero_nine,
55
 
        )
56
 
from bzrlib.trace import mutter, note, warning
 
51
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.trace import (
 
53
    log_exception_quietly, note, mutter, mutter_callsite, warning)
57
54
 
58
55
 
59
56
# Old formats display a warning, but only once
60
57
_deprecation_warning_done = False
61
58
 
62
59
 
63
 
class Repository(object):
 
60
class IsInWriteGroupError(errors.InternalBzrError):
 
61
 
 
62
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
 
63
 
 
64
    def __init__(self, repo):
 
65
        errors.InternalBzrError.__init__(self, repo=repo)
 
66
 
 
67
 
 
68
class CommitBuilder(object):
 
69
    """Provides an interface to build up a commit.
 
70
 
 
71
    This allows describing a tree to be committed without needing to
 
72
    know the internals of the format of the repository.
 
73
    """
 
74
 
 
75
    # all clients should supply tree roots.
 
76
    record_root_entry = True
 
77
    # whether this commit builder supports the record_entry_contents interface
 
78
    supports_record_entry_contents = False
 
79
    # whether this commit builder will automatically update the branch that is
 
80
    # being committed to
 
81
    updates_branch = False
 
82
 
 
83
    def __init__(self, repository, parents, config_stack, timestamp=None,
 
84
                 timezone=None, committer=None, revprops=None,
 
85
                 revision_id=None, lossy=False):
 
86
        """Initiate a CommitBuilder.
 
87
 
 
88
        :param repository: Repository to commit to.
 
89
        :param parents: Revision ids of the parents of the new revision.
 
90
        :param timestamp: Optional timestamp recorded for commit.
 
91
        :param timezone: Optional timezone for timestamp.
 
92
        :param committer: Optional committer to set for commit.
 
93
        :param revprops: Optional dictionary of revision properties.
 
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 
 
97
        """
 
98
        self._config_stack = config_stack
 
99
        self._lossy = lossy
 
100
 
 
101
        if committer is None:
 
102
            self._committer = self._config_stack.get('email')
 
103
        elif not isinstance(committer, unicode):
 
104
            self._committer = committer.decode() # throw if non-ascii
 
105
        else:
 
106
            self._committer = committer
 
107
 
 
108
        self._new_revision_id = revision_id
 
109
        self.parents = parents
 
110
        self.repository = repository
 
111
 
 
112
        self._revprops = {}
 
113
        if revprops is not None:
 
114
            self._validate_revprops(revprops)
 
115
            self._revprops.update(revprops)
 
116
 
 
117
        if timestamp is None:
 
118
            timestamp = time.time()
 
119
        # Restrict resolution to 1ms
 
120
        self._timestamp = round(timestamp, 3)
 
121
 
 
122
        if timezone is None:
 
123
            self._timezone = osutils.local_time_offset()
 
124
        else:
 
125
            self._timezone = int(timezone)
 
126
 
 
127
        self._generate_revision_if_needed()
 
128
 
 
129
    def any_changes(self):
 
130
        """Return True if any entries were changed.
 
131
 
 
132
        This includes merge-only changes. It is the core for the --unchanged
 
133
        detection in commit.
 
134
 
 
135
        :return: True if any changes have occured.
 
136
        """
 
137
        raise NotImplementedError(self.any_changes)
 
138
 
 
139
    def _validate_unicode_text(self, text, context):
 
140
        """Verify things like commit messages don't have bogus characters."""
 
141
        if '\r' in text:
 
142
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
143
 
 
144
    def _validate_revprops(self, revprops):
 
145
        for key, value in revprops.iteritems():
 
146
            # We know that the XML serializers do not round trip '\r'
 
147
            # correctly, so refuse to accept them
 
148
            if not isinstance(value, basestring):
 
149
                raise ValueError('revision property (%s) is not a valid'
 
150
                                 ' (unicode) string: %r' % (key, value))
 
151
            self._validate_unicode_text(value,
 
152
                                        'revision property (%s)' % (key,))
 
153
 
 
154
    def commit(self, message):
 
155
        """Make the actual commit.
 
156
 
 
157
        :return: The revision id of the recorded revision.
 
158
        """
 
159
        raise NotImplementedError(self.commit)
 
160
 
 
161
    def abort(self):
 
162
        """Abort the commit that is being built.
 
163
        """
 
164
        raise NotImplementedError(self.abort)
 
165
 
 
166
    def revision_tree(self):
 
167
        """Return the tree that was just committed.
 
168
 
 
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
 
173
        memory.
 
174
        """
 
175
        raise NotImplementedError(self.revision_tree)
 
176
 
 
177
    def finish_inventory(self):
 
178
        """Tell the builder that the inventory is finished.
 
179
 
 
180
        :return: The inventory id in the repository, which can be used with
 
181
            repository.get_inventory.
 
182
        """
 
183
        raise NotImplementedError(self.finish_inventory)
 
184
 
 
185
    def _gen_revision_id(self):
 
186
        """Return new revision-id."""
 
187
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
188
 
 
189
    def _generate_revision_if_needed(self):
 
190
        """Create a revision id if None was supplied.
 
191
 
 
192
        If the repository can not support user-specified revision ids
 
193
        they should override this function and raise CannotSetRevisionId
 
194
        if _new_revision_id is not None.
 
195
 
 
196
        :raises: CannotSetRevisionId
 
197
        """
 
198
        if self._new_revision_id is None:
 
199
            self._new_revision_id = self._gen_revision_id()
 
200
            self.random_revid = True
 
201
        else:
 
202
            self.random_revid = False
 
203
 
 
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)
 
245
 
 
246
 
 
247
######################################################################
 
248
# Repositories
 
249
 
 
250
 
 
251
class Repository(_RelockDebugMixin, controldir.ControlComponent):
64
252
    """Repository holding history for one or more branches.
65
253
 
66
254
    The repository holds and retrieves historical information including
67
255
    revisions and file history.  It's normally accessed only by the Branch,
68
256
    which views a particular line of development through that history.
69
257
 
70
 
    The Repository builds on top of Stores and a Transport, which respectively 
71
 
    describe the disk data format and the way of accessing the (possibly 
72
 
    remote) disk.
 
258
    See VersionedFileRepository in bzrlib.vf_repository for the
 
259
    base class for most Bazaar repositories.
73
260
    """
74
261
 
75
 
    _file_ids_altered_regex = lazy_regex.lazy_compile(
76
 
        r'file_id="(?P<file_id>[^"]+)"'
77
 
        r'.*revision="(?P<revision_id>[^"]+)"'
78
 
        )
79
 
 
80
 
    @needs_write_lock
81
 
    def add_inventory(self, revision_id, inv, parents):
82
 
        """Add the inventory inv to the repository as revision_id.
83
 
        
84
 
        :param parents: The revision ids of the parents that revision_id
85
 
                        is known to have and are in the repository already.
86
 
 
87
 
        returns the sha1 of the serialized inventory.
88
 
        """
89
 
        revision_id = osutils.safe_revision_id(revision_id)
90
 
        _mod_revision.check_not_reserved_id(revision_id)
91
 
        assert inv.revision_id is None or inv.revision_id == revision_id, \
92
 
            "Mismatch between inventory revision" \
93
 
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
94
 
        assert inv.root is not None
95
 
        inv_text = self.serialise_inventory(inv)
96
 
        inv_sha1 = osutils.sha_string(inv_text)
97
 
        inv_vf = self.control_weaves.get_weave('inventory',
98
 
                                               self.get_transaction())
99
 
        self._inventory_add_lines(inv_vf, revision_id, parents,
100
 
                                  osutils.split_lines(inv_text))
101
 
        return inv_sha1
102
 
 
103
 
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines):
104
 
        final_parents = []
105
 
        for parent in parents:
106
 
            if parent in inv_vf:
107
 
                final_parents.append(parent)
108
 
 
109
 
        inv_vf.add_lines(revision_id, final_parents, lines)
110
 
 
111
 
    @needs_write_lock
112
 
    def add_revision(self, revision_id, rev, inv=None, config=None):
113
 
        """Add rev to the revision store as revision_id.
114
 
 
115
 
        :param revision_id: the revision id to use.
116
 
        :param rev: The revision object.
117
 
        :param inv: The inventory for the revision. if None, it will be looked
118
 
                    up in the inventory storer
119
 
        :param config: If None no digital signature will be created.
120
 
                       If supplied its signature_needed method will be used
121
 
                       to determine if a signature should be made.
122
 
        """
123
 
        revision_id = osutils.safe_revision_id(revision_id)
124
 
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
125
 
        #       rev.parent_ids?
126
 
        _mod_revision.check_not_reserved_id(revision_id)
127
 
        if config is not None and config.signature_needed():
128
 
            if inv is None:
129
 
                inv = self.get_inventory(revision_id)
130
 
            plaintext = Testament(rev, inv).as_short_text()
131
 
            self.store_revision_signature(
132
 
                gpg.GPGStrategy(config), plaintext, revision_id)
133
 
        if not revision_id in self.get_inventory_weave():
134
 
            if inv is None:
135
 
                raise errors.WeaveRevisionNotPresent(revision_id,
136
 
                                                     self.get_inventory_weave())
137
 
            else:
138
 
                # yes, this is not suitable for adding with ghosts.
139
 
                self.add_inventory(revision_id, inv, rev.parent_ids)
140
 
        self._revision_store.add_revision(rev, self.get_transaction())
141
 
 
142
 
    @needs_read_lock
143
 
    def _all_possible_ids(self):
144
 
        """Return all the possible revisions that we could find."""
145
 
        return self.get_inventory_weave().versions()
 
262
    def abort_write_group(self, suppress_errors=False):
 
263
        """Commit the contents accrued within the current write group.
 
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
 
 
269
        :seealso: start_write_group.
 
270
        """
 
271
        if self._write_group is not self.get_transaction():
 
272
            # has an unlock or relock occured ?
 
273
            if suppress_errors:
 
274
                mutter(
 
275
                '(suppressed) mismatched lock context and write group. %r, %r',
 
276
                self._write_group, self.get_transaction())
 
277
                return
 
278
            raise errors.BzrError(
 
279
                'mismatched lock context and write group. %r, %r' %
 
280
                (self._write_group, self.get_transaction()))
 
281
        try:
 
282
            self._abort_write_group()
 
283
        except Exception, exc:
 
284
            self._write_group = None
 
285
            if not suppress_errors:
 
286
                raise
 
287
            mutter('abort_write_group failed')
 
288
            log_exception_quietly()
 
289
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
290
        self._write_group = None
 
291
 
 
292
    def _abort_write_group(self):
 
293
        """Template method for per-repository write group cleanup.
 
294
 
 
295
        This is called during abort before the write group is considered to be
 
296
        finished and should cleanup any internal state accrued during the write
 
297
        group. There is no requirement that data handed to the repository be
 
298
        *not* made available - this is not a rollback - but neither should any
 
299
        attempt be made to ensure that data added is fully commited. Abort is
 
300
        invoked when an error has occured so futher disk or network operations
 
301
        may not be possible or may error and if possible should not be
 
302
        attempted.
 
303
        """
 
304
 
 
305
    def add_fallback_repository(self, repository):
 
306
        """Add a repository to use for looking up data not held locally.
 
307
 
 
308
        :param repository: A repository.
 
309
        """
 
310
        raise NotImplementedError(self.add_fallback_repository)
 
311
 
 
312
    def _check_fallback_repository(self, repository):
 
313
        """Check that this repository can fallback to repository safely.
 
314
 
 
315
        Raise an error if not.
 
316
 
 
317
        :param repository: A repository to fallback to.
 
318
        """
 
319
        return InterRepository._assert_same_model(self, repository)
146
320
 
147
321
    def all_revision_ids(self):
148
 
        """Returns a list of all the revision ids in the repository. 
 
322
        """Returns a list of all the revision ids in the repository.
149
323
 
150
 
        This is deprecated because code should generally work on the graph
151
 
        reachable from a particular revision, and ignore any other revisions
152
 
        that might be present.  There is no direct replacement method.
 
324
        This is conceptually deprecated because code should generally work on
 
325
        the graph reachable from a particular revision, and ignore any other
 
326
        revisions that might be present.  There is no direct replacement
 
327
        method.
153
328
        """
 
329
        if 'evil' in debug.debug_flags:
 
330
            mutter_callsite(2, "all_revision_ids is linear with history.")
154
331
        return self._all_revision_ids()
155
332
 
156
 
    @needs_read_lock
157
333
    def _all_revision_ids(self):
158
 
        """Returns a list of all the revision ids in the repository. 
 
334
        """Returns a list of all the revision ids in the repository.
159
335
 
160
 
        These are in as much topological order as the underlying store can 
161
 
        present: for weaves ghosts may lead to a lack of correctness until
162
 
        the reweave updates the parents list.
 
336
        These are in as much topological order as the underlying store can
 
337
        present.
163
338
        """
164
 
        if self._revision_store.text_store.listable():
165
 
            return self._revision_store.all_revision_ids(self.get_transaction())
166
 
        result = self._all_possible_ids()
167
 
        # TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
168
 
        #       ids. (It should, since _revision_store's API should change to
169
 
        #       return utf8 revision_ids)
170
 
        return self._eliminate_revisions_not_present(result)
 
339
        raise NotImplementedError(self._all_revision_ids)
171
340
 
172
341
    def break_lock(self):
173
342
        """Break a lock if one is present from another instance.
177
346
        """
178
347
        self.control_files.break_lock()
179
348
 
180
 
    @needs_read_lock
181
 
    def _eliminate_revisions_not_present(self, revision_ids):
182
 
        """Check every revision id in revision_ids to see if we have it.
183
 
 
184
 
        Returns a set of the present revisions.
185
 
        """
186
 
        result = []
187
 
        for id in revision_ids:
188
 
            if self.has_revision(id):
189
 
               result.append(id)
190
 
        return result
191
 
 
192
349
    @staticmethod
193
 
    def create(a_bzrdir):
194
 
        """Construct the current default format repository in a_bzrdir."""
195
 
        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)
196
353
 
197
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
354
    def __init__(self, _format, controldir, control_files):
198
355
        """instantiate a Repository.
199
356
 
200
357
        :param _format: The format of the repository on disk.
201
 
        :param a_bzrdir: The BzrDir of the repository.
202
 
 
203
 
        In the future we will have a single api for all stores for
204
 
        getting file texts, inventories and revisions, then
205
 
        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.
206
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.
207
364
        super(Repository, self).__init__()
208
365
        self._format = _format
209
366
        # the following are part of the public API for Repository:
210
 
        self.bzrdir = a_bzrdir
 
367
        self.bzrdir = controldir
211
368
        self.control_files = control_files
212
 
        self._revision_store = _revision_store
213
 
        self.text_store = text_store
214
 
        # backwards compatibility
215
 
        self.weave_store = text_store
216
 
        # not right yet - should be more semantically clear ? 
217
 
        # 
218
 
        self.control_store = control_store
219
 
        self.control_weaves = control_store
220
 
        # TODO: make sure to construct the right store classes, etc, depending
221
 
        # on whether escaping is required.
222
 
        self._warn_if_deprecated()
 
369
        # for tests
 
370
        self._write_group = None
 
371
        # Additional places to query for data.
 
372
        self._fallback_repositories = []
 
373
 
 
374
    @property
 
375
    def user_transport(self):
 
376
        return self.bzrdir.user_transport
 
377
 
 
378
    @property
 
379
    def control_transport(self):
 
380
        return self._transport
223
381
 
224
382
    def __repr__(self):
225
 
        return '%s(%r)' % (self.__class__.__name__, 
226
 
                           self.bzrdir.transport.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
 
402
 
 
403
    def has_same_location(self, other):
 
404
        """Returns a boolean indicating if this repository is at the same
 
405
        location as another repository.
 
406
 
 
407
        This might return False even when two repository objects are accessing
 
408
        the same physical repository via different URLs.
 
409
        """
 
410
        if self.__class__ is not other.__class__:
 
411
            return False
 
412
        return (self.control_url == other.control_url)
 
413
 
 
414
    def is_in_write_group(self):
 
415
        """Return True if there is an open write group.
 
416
 
 
417
        :seealso: start_write_group.
 
418
        """
 
419
        return self._write_group is not None
227
420
 
228
421
    def is_locked(self):
229
422
        return self.control_files.is_locked()
230
423
 
231
 
    def lock_write(self):
232
 
        self.control_files.lock_write()
 
424
    def is_write_locked(self):
 
425
        """Return True if this object is write locked."""
 
426
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
427
 
 
428
    def lock_write(self, token=None):
 
429
        """Lock this repository for writing.
 
430
 
 
431
        This causes caching within the repository obejct to start accumlating
 
432
        data during reads, and allows a 'write_group' to be obtained. Write
 
433
        groups must be used for actual data insertion.
 
434
 
 
435
        A token should be passed in if you know that you have locked the object
 
436
        some other way, and need to synchronise this object's state with that
 
437
        fact.
 
438
 
 
439
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
440
 
 
441
        :param token: if this is already locked, then lock_write will fail
 
442
            unless the token matches the existing lock.
 
443
        :returns: a token if this instance supports tokens, otherwise None.
 
444
        :raises TokenLockingNotSupported: when a token is given but this
 
445
            instance doesn't support using token locks.
 
446
        :raises MismatchedToken: if the specified token doesn't match the token
 
447
            of the existing lock.
 
448
        :seealso: start_write_group.
 
449
        :return: A RepositoryWriteLockResult.
 
450
        """
 
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)
233
461
 
234
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()
235
469
        self.control_files.lock_read()
 
470
        if not locked:
 
471
            self._warn_if_deprecated()
 
472
            self._note_lock('r')
 
473
            for repo in self._fallback_repositories:
 
474
                repo.lock_read()
 
475
            self._refresh_data()
 
476
        return LogicalLockResult(self.unlock)
236
477
 
237
478
    def get_physical_lock_status(self):
238
479
        return self.control_files.get_physical_lock_status()
239
480
 
 
481
    def leave_lock_in_place(self):
 
482
        """Tell this repository not to release the physical lock when this
 
483
        object is unlocked.
 
484
 
 
485
        If lock_write doesn't return a token, then this method is not supported.
 
486
        """
 
487
        self.control_files.leave_in_place()
 
488
 
 
489
    def dont_leave_lock_in_place(self):
 
490
        """Tell this repository to release the physical lock when this
 
491
        object is unlocked, even if it didn't originally acquire it.
 
492
 
 
493
        If lock_write doesn't return a token, then this method is not supported.
 
494
        """
 
495
        self.control_files.dont_leave_in_place()
 
496
 
240
497
    @needs_read_lock
241
498
    def gather_stats(self, revid=None, committers=None):
242
499
        """Gather statistics from a revision id.
258
515
        if revid and committers:
259
516
            result['committers'] = 0
260
517
        if revid and revid != _mod_revision.NULL_REVISION:
 
518
            graph = self.get_graph()
261
519
            if committers:
262
520
                all_committers = set()
263
 
            revisions = self.get_ancestry(revid)
264
 
            # pop the leading None
265
 
            revisions.pop(0)
266
 
            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
267
524
            if not committers:
268
525
                # ignore the revisions in the middle - just grab first and last
269
526
                revisions = revisions[0], revisions[-1]
270
527
            for revision in self.get_revisions(revisions):
271
 
                if not first_revision:
272
 
                    first_revision = revision
 
528
                if not last_revision:
 
529
                    last_revision = revision
273
530
                if committers:
274
531
                    all_committers.add(revision.committer)
275
 
            last_revision = revision
 
532
            first_revision = revision
276
533
            if committers:
277
534
                result['committers'] = len(all_committers)
278
535
            result['firstrev'] = (first_revision.timestamp,
279
536
                first_revision.timezone)
280
537
            result['latestrev'] = (last_revision.timestamp,
281
538
                last_revision.timezone)
282
 
 
283
 
        # now gather global repository information
284
 
        if self.bzrdir.root_transport.listable():
285
 
            c, t = self._revision_store.total_size(self.get_transaction())
286
 
            result['revisions'] = c
287
 
            result['size'] = t
288
539
        return result
289
540
 
 
541
    def find_branches(self, using=False):
 
542
        """Find branches underneath this repository.
 
543
 
 
544
        This will include branches inside other branches.
 
545
 
 
546
        :param using: If True, list only branches using this repository.
 
547
        """
 
548
        if using and not self.is_shared():
 
549
            return self.bzrdir.list_branches()
 
550
        class Evaluator(object):
 
551
 
 
552
            def __init__(self):
 
553
                self.first_call = True
 
554
 
 
555
            def __call__(self, controldir):
 
556
                # On the first call, the parameter is always the controldir
 
557
                # containing the current repo.
 
558
                if not self.first_call:
 
559
                    try:
 
560
                        repository = controldir.open_repository()
 
561
                    except errors.NoRepositoryPresent:
 
562
                        pass
 
563
                    else:
 
564
                        return False, ([], repository)
 
565
                self.first_call = False
 
566
                value = (controldir.list_branches(), None)
 
567
                return True, value
 
568
 
 
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)
 
574
            if not using and repository is not None:
 
575
                ret.extend(repository.find_branches())
 
576
        return ret
 
577
 
290
578
    @needs_read_lock
291
 
    def missing_revision_ids(self, other, revision_id=None):
 
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):
292
583
        """Return the revision ids that other has that this does not.
293
 
        
 
584
 
294
585
        These are returned in topological order.
295
586
 
296
587
        revision_id: only return revision ids included by revision_id.
297
588
        """
298
 
        revision_id = osutils.safe_revision_id(revision_id)
299
 
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
589
        if symbol_versioning.deprecated_passed(revision_id):
 
590
            symbol_versioning.warn(
 
591
                'search_missing_revision_ids(revision_id=...) was '
 
592
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
593
                DeprecationWarning, stacklevel=3)
 
594
            if revision_ids is not None:
 
595
                raise AssertionError(
 
596
                    'revision_ids is mutually exclusive with revision_id')
 
597
            if revision_id is not None:
 
598
                revision_ids = [revision_id]
 
599
        return InterRepository.get(other, self).search_missing_revision_ids(
 
600
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
601
            if_present_ids=if_present_ids, limit=limit)
300
602
 
301
603
    @staticmethod
302
604
    def open(base):
305
607
        For instance, if the repository is at URL/.bzr/repository,
306
608
        Repository.open(URL) -> a Repository instance.
307
609
        """
308
 
        control = bzrdir.BzrDir.open(base)
 
610
        control = controldir.ControlDir.open(base)
309
611
        return control.open_repository()
310
612
 
311
 
    def copy_content_into(self, destination, revision_id=None, basis=None):
 
613
    def copy_content_into(self, destination, revision_id=None):
312
614
        """Make a complete copy of the content in self into destination.
 
615
 
 
616
        This is a destructive operation! Do not use it on existing
 
617
        repositories.
 
618
        """
 
619
        return InterRepository.get(self, destination).copy_content(revision_id)
 
620
 
 
621
    def commit_write_group(self):
 
622
        """Commit the contents accrued within the current write group.
 
623
 
 
624
        :seealso: start_write_group.
313
625
        
314
 
        This is a destructive operation! Do not use it on existing 
315
 
        repositories.
316
 
        """
317
 
        revision_id = osutils.safe_revision_id(revision_id)
318
 
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
319
 
 
320
 
    def fetch(self, source, revision_id=None, pb=None):
 
626
        :return: it may return an opaque hint that can be passed to 'pack'.
 
627
        """
 
628
        if self._write_group is not self.get_transaction():
 
629
            # has an unlock or relock occured ?
 
630
            raise errors.BzrError('mismatched lock context %r and '
 
631
                'write group %r.' %
 
632
                (self.get_transaction(), self._write_group))
 
633
        result = self._commit_write_group()
 
634
        self._write_group = None
 
635
        return result
 
636
 
 
637
    def _commit_write_group(self):
 
638
        """Template method for per-repository write group cleanup.
 
639
 
 
640
        This is called before the write group is considered to be
 
641
        finished and should ensure that all data handed to the repository
 
642
        for writing during the write group is safely committed (to the
 
643
        extent possible considering file system caching etc).
 
644
        """
 
645
 
 
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):
321
681
        """Fetch the content required to construct revision_id from source.
322
682
 
323
 
        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
 
 
689
        :param find_ghosts: Find and copy revisions in the source that are
 
690
            ghosts in the target (and not reachable directly by walking out to
 
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.
324
695
        """
325
 
        revision_id = osutils.safe_revision_id(revision_id)
326
 
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
327
 
                                                       pb=pb)
328
 
 
329
 
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
330
 
                           timezone=None, committer=None, revprops=None, 
331
 
                           revision_id=None):
 
696
        if self.is_in_write_group():
 
697
            raise errors.InternalBzrError(
 
698
                "May not fetch while in a write group.")
 
699
        # fast path same-url fetch operations
 
700
        # TODO: lift out to somewhere common with RemoteRepository
 
701
        # <https://bugs.launchpad.net/bzr/+bug/401646>
 
702
        if (self.has_same_location(source)
 
703
            and self._has_same_fallbacks(source)):
 
704
            # check that last_revision is in 'from' and then return a
 
705
            # no-operation.
 
706
            if (revision_id is not None and
 
707
                not _mod_revision.is_null(revision_id)):
 
708
                self.get_revision(revision_id)
 
709
            return 0, []
 
710
        inter = InterRepository.get(source, self)
 
711
        return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
 
712
 
 
713
    def create_bundle(self, target, base, fileobj, format=None):
 
714
        return serializer.write_bundle(self, target, base, fileobj, format)
 
715
 
 
716
    def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
 
717
                           timezone=None, committer=None, revprops=None,
 
718
                           revision_id=None, lossy=False):
332
719
        """Obtain a CommitBuilder for this repository.
333
 
        
 
720
 
334
721
        :param branch: Branch to commit to.
335
722
        :param parents: Revision ids of the parents of the new revision.
336
 
        :param config: Configuration to use.
 
723
        :param config_stack: Configuration stack to use.
337
724
        :param timestamp: Optional timestamp recorded for commit.
338
725
        :param timezone: Optional timezone for timestamp.
339
726
        :param committer: Optional committer to set for commit.
340
727
        :param revprops: Optional dictionary of revision properties.
341
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
342
731
        """
343
 
        revision_id = osutils.safe_revision_id(revision_id)
344
 
        return _CommitBuilder(self, parents, config, timestamp, timezone,
345
 
                              committer, revprops, revision_id)
 
732
        raise NotImplementedError(self.get_commit_builder)
346
733
 
 
734
    @only_raises(errors.LockNotHeld, errors.LockBroken)
347
735
    def unlock(self):
 
736
        if (self.control_files._lock_count == 1 and
 
737
            self.control_files._lock_mode == 'w'):
 
738
            if self._write_group is not None:
 
739
                self.abort_write_group()
 
740
                self.control_files.unlock()
 
741
                raise errors.BzrError(
 
742
                    'Must end write groups before releasing write locks.')
348
743
        self.control_files.unlock()
 
744
        if self.control_files._lock_count == 0:
 
745
            for repo in self._fallback_repositories:
 
746
                repo.unlock()
349
747
 
350
748
    @needs_read_lock
351
 
    def clone(self, a_bzrdir, revision_id=None, basis=None):
352
 
        """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.
353
751
 
354
752
        Currently no check is made that the format of this repository and
355
753
        the bzrdir format are compatible. FIXME RBC 20060201.
356
754
 
357
755
        :return: The newly created destination repository.
358
756
        """
 
757
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
758
        # probably not very useful -- mbp 20070423
 
759
        dest_repo = self._create_sprouting_repo(
 
760
            controldir, shared=self.is_shared())
 
761
        self.copy_content_into(dest_repo, revision_id)
 
762
        return dest_repo
 
763
 
 
764
    def start_write_group(self):
 
765
        """Start a write group in the repository.
 
766
 
 
767
        Write groups are used by repositories which do not have a 1:1 mapping
 
768
        between file ids and backend store to manage the insertion of data from
 
769
        both fetch and commit operations.
 
770
 
 
771
        A write lock is required around the start_write_group/commit_write_group
 
772
        for the support of lock-requiring repository formats.
 
773
 
 
774
        One can only insert data into a repository inside a write group.
 
775
 
 
776
        :return: None.
 
777
        """
 
778
        if not self.is_write_locked():
 
779
            raise errors.NotWriteLocked(self)
 
780
        if self._write_group:
 
781
            raise errors.BzrError('already in a write group')
 
782
        self._start_write_group()
 
783
        # so we can detect unlock/relock - the write group is now entered.
 
784
        self._write_group = self.get_transaction()
 
785
 
 
786
    def _start_write_group(self):
 
787
        """Template method for per-repository write group startup.
 
788
 
 
789
        This is called before the write group is considered to be
 
790
        entered.
 
791
        """
 
792
 
 
793
    @needs_read_lock
 
794
    def sprout(self, to_bzrdir, revision_id=None):
 
795
        """Create a descendent repository for new development.
 
796
 
 
797
        Unlike clone, this does not copy the settings of the repository.
 
798
        """
 
799
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
800
        dest_repo.fetch(self, revision_id=revision_id)
 
801
        return dest_repo
 
802
 
 
803
    def _create_sprouting_repo(self, a_bzrdir, shared):
359
804
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
360
805
            # use target default format.
361
806
            dest_repo = a_bzrdir.create_repository()
363
808
            # Most control formats need the repository to be specifically
364
809
            # created, but on some old all-in-one formats it's not needed
365
810
            try:
366
 
                dest_repo = self._format.initialize(a_bzrdir, shared=self.is_shared())
 
811
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
367
812
            except errors.UninitializableFormat:
368
813
                dest_repo = a_bzrdir.open_repository()
369
 
        self.copy_content_into(dest_repo, revision_id, basis)
370
814
        return dest_repo
371
815
 
372
816
    @needs_read_lock
373
817
    def has_revision(self, revision_id):
374
818
        """True if this repository has a copy of the revision."""
375
 
        revision_id = osutils.safe_revision_id(revision_id)
376
 
        return self._revision_store.has_revision_id(revision_id,
377
 
                                                    self.get_transaction())
378
 
 
379
 
    @needs_read_lock
 
819
        return revision_id in self.has_revisions((revision_id,))
 
820
 
 
821
    @needs_read_lock
 
822
    def has_revisions(self, revision_ids):
 
823
        """Probe to find out the presence of multiple revisions.
 
824
 
 
825
        :param revision_ids: An iterable of revision_ids.
 
826
        :return: A set of the revision_ids that were present.
 
827
        """
 
828
        raise NotImplementedError(self.has_revisions)
 
829
 
 
830
    @needs_read_lock
 
831
    def get_revision(self, revision_id):
 
832
        """Return the Revision object for a named revision."""
 
833
        return self.get_revisions([revision_id])[0]
 
834
 
380
835
    def get_revision_reconcile(self, revision_id):
381
836
        """'reconcile' helper routine that allows access to a revision always.
382
 
        
 
837
 
383
838
        This variant of get_revision does not cross check the weave graph
384
839
        against the revision one as get_revision does: but it should only
385
840
        be used by reconcile, or reconcile-alike commands that are correcting
386
841
        or testing the revision graph.
387
842
        """
388
 
        if not revision_id or not isinstance(revision_id, basestring):
389
 
            raise errors.InvalidRevisionId(revision_id=revision_id,
390
 
                                           branch=self)
391
 
        return self.get_revisions([revision_id])[0]
 
843
        raise NotImplementedError(self.get_revision_reconcile)
392
844
 
393
 
    @needs_read_lock
394
845
    def get_revisions(self, revision_ids):
395
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
396
 
        revs = self._revision_store.get_revisions(revision_ids,
397
 
                                                  self.get_transaction())
398
 
        for rev in revs:
399
 
            assert not isinstance(rev.revision_id, unicode)
400
 
            for parent_id in rev.parent_ids:
401
 
                assert not isinstance(parent_id, unicode)
402
 
        return revs
403
 
 
404
 
    @needs_read_lock
405
 
    def get_revision_xml(self, revision_id):
406
 
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
407
 
        #       would have already do it.
408
 
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
409
 
        revision_id = osutils.safe_revision_id(revision_id)
410
 
        rev = self.get_revision(revision_id)
411
 
        rev_tmp = StringIO()
412
 
        # the current serializer..
413
 
        self._revision_store._serializer.write_revision(rev, rev_tmp)
414
 
        rev_tmp.seek(0)
415
 
        return rev_tmp.getvalue()
416
 
 
417
 
    @needs_read_lock
418
 
    def get_revision(self, revision_id):
419
 
        """Return the Revision object for a named revision"""
420
 
        # TODO: jam 20070210 get_revision_reconcile should do this for us
421
 
        revision_id = osutils.safe_revision_id(revision_id)
422
 
        r = self.get_revision_reconcile(revision_id)
423
 
        # weave corruption can lead to absent revision markers that should be
424
 
        # present.
425
 
        # the following test is reasonably cheap (it needs a single weave read)
426
 
        # and the weave is cached in read transactions. In write transactions
427
 
        # it is not cached but typically we only read a small number of
428
 
        # revisions. For knits when they are introduced we will probably want
429
 
        # to ensure that caching write transactions are in use.
430
 
        inv = self.get_inventory_weave()
431
 
        self._check_revision_parents(r, inv)
432
 
        return r
433
 
 
434
 
    @needs_read_lock
435
 
    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):
436
854
        """Produce a generator of revision deltas.
437
 
        
 
855
 
438
856
        Note that the input is a sequence of REVISIONS, not revision_ids.
439
857
        Trees will be held in memory until the generator exits.
440
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.
441
863
        """
 
864
        # Get the revision-ids of interest
442
865
        required_trees = set()
443
866
        for revision in revisions:
444
867
            required_trees.add(revision.revision_id)
445
868
            required_trees.update(revision.parent_ids[:1])
446
 
        trees = dict((t.get_revision_id(), t) for 
447
 
                     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
448
885
        for revision in revisions:
449
886
            if not revision.parent_ids:
450
 
                old_tree = self.revision_tree(None)
 
887
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
451
888
            else:
452
889
                old_tree = trees[revision.parent_ids[0]]
453
890
            yield trees[revision.revision_id].changes_from(old_tree)
454
891
 
455
892
    @needs_read_lock
456
 
    def get_revision_delta(self, revision_id):
 
893
    def get_revision_delta(self, revision_id, specific_fileids=None):
457
894
        """Return the delta for one revision.
458
895
 
459
896
        The delta is relative to the left-hand predecessor of the
460
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.
461
902
        """
462
903
        r = self.get_revision(revision_id)
463
 
        return list(self.get_deltas_for_revisions([r]))[0]
464
 
 
465
 
    def _check_revision_parents(self, revision, inventory):
466
 
        """Private to Repository and Fetch.
467
 
        
468
 
        This checks the parentage of revision in an inventory weave for 
469
 
        consistency and is only applicable to inventory-weave-for-ancestry
470
 
        using repository formats & fetchers.
471
 
        """
472
 
        weave_parents = inventory.get_parents(revision.revision_id)
473
 
        weave_names = inventory.versions()
474
 
        for parent_id in revision.parent_ids:
475
 
            if parent_id in weave_names:
476
 
                # this parent must not be a ghost.
477
 
                if not parent_id in weave_parents:
478
 
                    # but it is a ghost
479
 
                    raise errors.CorruptRepository(self)
 
904
        return list(self.get_deltas_for_revisions([r],
 
905
            specific_fileids=specific_fileids))[0]
480
906
 
481
907
    @needs_write_lock
482
908
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
483
 
        revision_id = osutils.safe_revision_id(revision_id)
484
909
        signature = gpg_strategy.sign(plaintext)
485
 
        self._revision_store.add_revision_signature_text(revision_id,
486
 
                                                         signature,
487
 
                                                         self.get_transaction())
488
 
 
489
 
    def fileids_altered_by_revision_ids(self, revision_ids):
490
 
        """Find the file ids and versions affected by revisions.
491
 
 
492
 
        :param revisions: an iterable containing revision ids.
493
 
        :return: a dictionary mapping altered file-ids to an iterable of
494
 
        revision_ids. Each altered file-ids has the exact revision_ids that
495
 
        altered it listed explicitly.
496
 
        """
497
 
        assert self._serializer.support_altered_by_hack, \
498
 
            ("fileids_altered_by_revision_ids only supported for branches " 
499
 
             "which store inventory as unnested xml, not on %r" % self)
500
 
        selected_revision_ids = set(osutils.safe_revision_id(r)
501
 
                                    for r in revision_ids)
502
 
        w = self.get_inventory_weave()
503
 
        result = {}
504
 
 
505
 
        # this code needs to read every new line in every inventory for the
506
 
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
507
 
        # not present in one of those inventories is unnecessary but not 
508
 
        # harmful because we are filtering by the revision id marker in the
509
 
        # inventory lines : we only select file ids altered in one of those  
510
 
        # revisions. We don't need to see all lines in the inventory because
511
 
        # only those added in an inventory in rev X can contain a revision=X
512
 
        # line.
513
 
        unescape_revid_cache = {}
514
 
        unescape_fileid_cache = {}
515
 
 
516
 
        # jam 20061218 In a big fetch, this handles hundreds of thousands
517
 
        # of lines, so it has had a lot of inlining and optimizing done.
518
 
        # Sorry that it is a little bit messy.
519
 
        # Move several functions to be local variables, since this is a long
520
 
        # running loop.
521
 
        search = self._file_ids_altered_regex.search
522
 
        unescape = _unescape_xml
523
 
        setdefault = result.setdefault
524
 
        pb = ui.ui_factory.nested_progress_bar()
525
 
        try:
526
 
            for line in w.iter_lines_added_or_present_in_versions(
527
 
                                        selected_revision_ids, pb=pb):
528
 
                match = search(line)
529
 
                if match is None:
530
 
                    continue
531
 
                # One call to match.group() returning multiple items is quite a
532
 
                # bit faster than 2 calls to match.group() each returning 1
533
 
                file_id, revision_id = match.group('file_id', 'revision_id')
534
 
 
535
 
                # Inlining the cache lookups helps a lot when you make 170,000
536
 
                # lines and 350k ids, versus 8.4 unique ids.
537
 
                # Using a cache helps in 2 ways:
538
 
                #   1) Avoids unnecessary decoding calls
539
 
                #   2) Re-uses cached strings, which helps in future set and
540
 
                #      equality checks.
541
 
                # (2) is enough that removing encoding entirely along with
542
 
                # the cache (so we are using plain strings) results in no
543
 
                # performance improvement.
544
 
                try:
545
 
                    revision_id = unescape_revid_cache[revision_id]
546
 
                except KeyError:
547
 
                    unescaped = unescape(revision_id)
548
 
                    unescape_revid_cache[revision_id] = unescaped
549
 
                    revision_id = unescaped
550
 
 
551
 
                if revision_id in selected_revision_ids:
552
 
                    try:
553
 
                        file_id = unescape_fileid_cache[file_id]
554
 
                    except KeyError:
555
 
                        unescaped = unescape(file_id)
556
 
                        unescape_fileid_cache[file_id] = unescaped
557
 
                        file_id = unescaped
558
 
                    setdefault(file_id, set()).add(revision_id)
559
 
        finally:
560
 
            pb.finished()
561
 
        return result
562
 
 
563
 
    @needs_read_lock
564
 
    def get_inventory_weave(self):
565
 
        return self.control_weaves.get_weave('inventory',
566
 
            self.get_transaction())
567
 
 
568
 
    @needs_read_lock
569
 
    def get_inventory(self, revision_id):
570
 
        """Get Inventory object by hash."""
571
 
        # TODO: jam 20070210 Technically we don't need to sanitize, since all
572
 
        #       called functions must sanitize.
573
 
        revision_id = osutils.safe_revision_id(revision_id)
574
 
        return self.deserialise_inventory(
575
 
            revision_id, self.get_inventory_xml(revision_id))
576
 
 
577
 
    def deserialise_inventory(self, revision_id, xml):
578
 
        """Transform the xml into an inventory object. 
579
 
 
580
 
        :param revision_id: The expected revision id of the inventory.
581
 
        :param xml: A serialised inventory.
582
 
        """
583
 
        revision_id = osutils.safe_revision_id(revision_id)
584
 
        result = self._serializer.read_inventory_from_string(xml)
585
 
        result.root.revision = revision_id
586
 
        return result
587
 
 
588
 
    def serialise_inventory(self, inv):
589
 
        return self._serializer.write_inventory_to_string(inv)
590
 
 
591
 
    @needs_read_lock
592
 
    def get_inventory_xml(self, revision_id):
593
 
        """Get inventory XML as a file object."""
594
 
        revision_id = osutils.safe_revision_id(revision_id)
595
 
        try:
596
 
            assert isinstance(revision_id, str), type(revision_id)
597
 
            iw = self.get_inventory_weave()
598
 
            return iw.get_text(revision_id)
599
 
        except IndexError:
600
 
            raise errors.HistoryMissing(self, 'inventory', revision_id)
601
 
 
602
 
    @needs_read_lock
603
 
    def get_inventory_sha1(self, revision_id):
604
 
        """Return the sha1 hash of the inventory entry
605
 
        """
606
 
        # TODO: jam 20070210 Shouldn't this be deprecated / removed?
607
 
        revision_id = osutils.safe_revision_id(revision_id)
608
 
        return self.get_revision(revision_id).inventory_sha1
609
 
 
610
 
    @needs_read_lock
611
 
    def get_revision_graph(self, revision_id=None):
612
 
        """Return a dictionary containing the revision graph.
613
 
        
614
 
        :param revision_id: The revision_id to get a graph from. If None, then
615
 
        the entire revision graph is returned. This is a deprecated mode of
616
 
        operation and will be removed in the future.
617
 
        :return: a dictionary of revision_id->revision_parents_list.
618
 
        """
619
 
        # special case NULL_REVISION
620
 
        if revision_id == _mod_revision.NULL_REVISION:
621
 
            return {}
622
 
        revision_id = osutils.safe_revision_id(revision_id)
623
 
        a_weave = self.get_inventory_weave()
624
 
        all_revisions = self._eliminate_revisions_not_present(
625
 
                                a_weave.versions())
626
 
        entire_graph = dict([(node, a_weave.get_parents(node)) for 
627
 
                             node in all_revisions])
628
 
        if revision_id is None:
629
 
            return entire_graph
630
 
        elif revision_id not in entire_graph:
631
 
            raise errors.NoSuchRevision(self, revision_id)
632
 
        else:
633
 
            # add what can be reached from revision_id
634
 
            result = {}
635
 
            pending = set([revision_id])
636
 
            while len(pending) > 0:
637
 
                node = pending.pop()
638
 
                result[node] = entire_graph[node]
639
 
                for revision_id in result[node]:
640
 
                    if revision_id not in result:
641
 
                        pending.add(revision_id)
642
 
            return result
643
 
 
644
 
    @needs_read_lock
645
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
646
 
        """Return a graph of the revisions with ghosts marked as applicable.
647
 
 
648
 
        :param revision_ids: an iterable of revisions to graph or None for all.
649
 
        :return: a Graph object with the graph reachable from revision_ids.
650
 
        """
651
 
        result = graph.Graph()
652
 
        if not revision_ids:
653
 
            pending = set(self.all_revision_ids())
654
 
            required = set([])
655
 
        else:
656
 
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
657
 
            # special case NULL_REVISION
658
 
            if _mod_revision.NULL_REVISION in pending:
659
 
                pending.remove(_mod_revision.NULL_REVISION)
660
 
            required = set(pending)
661
 
        done = set([])
662
 
        while len(pending):
663
 
            revision_id = pending.pop()
664
 
            try:
665
 
                rev = self.get_revision(revision_id)
666
 
            except errors.NoSuchRevision:
667
 
                if revision_id in required:
668
 
                    raise
669
 
                # a ghost
670
 
                result.add_ghost(revision_id)
671
 
                continue
672
 
            for parent_id in rev.parent_ids:
673
 
                # is this queued or done ?
674
 
                if (parent_id not in pending and
675
 
                    parent_id not in done):
676
 
                    # no, queue it.
677
 
                    pending.add(parent_id)
678
 
            result.add_node(revision_id, rev.parent_ids)
679
 
            done.add(revision_id)
680
 
        return result
681
 
 
682
 
    def _get_history_vf(self):
683
 
        """Get a versionedfile whose history graph reflects all revisions.
684
 
 
685
 
        For weave repositories, this is the inventory weave.
686
 
        """
687
 
        return self.get_inventory_weave()
688
 
 
689
 
    def iter_reverse_revision_history(self, revision_id):
690
 
        """Iterate backwards through revision ids in the lefthand history
691
 
 
692
 
        :param revision_id: The revision id to start with.  All its lefthand
693
 
            ancestors will be traversed.
694
 
        """
695
 
        revision_id = osutils.safe_revision_id(revision_id)
696
 
        if revision_id in (None, _mod_revision.NULL_REVISION):
697
 
            return
698
 
        next_id = revision_id
699
 
        versionedfile = self._get_history_vf()
700
 
        while True:
701
 
            yield next_id
702
 
            parents = versionedfile.get_parents(next_id)
703
 
            if len(parents) == 0:
704
 
                return
705
 
            else:
706
 
                next_id = parents[0]
707
 
 
708
 
    @needs_read_lock
709
 
    def get_revision_inventory(self, revision_id):
710
 
        """Return inventory of a past revision."""
711
 
        # TODO: Unify this with get_inventory()
712
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
713
 
        # must be the same as its revision, so this is trivial.
714
 
        if revision_id is None:
715
 
            # This does not make sense: if there is no revision,
716
 
            # then it is the current tree inventory surely ?!
717
 
            # and thus get_root_id() is something that looks at the last
718
 
            # commit on the branch, and the get_root_id is an inventory check.
719
 
            raise NotImplementedError
720
 
            # return Inventory(self.get_root_id())
721
 
        else:
722
 
            return self.get_inventory(revision_id)
723
 
 
724
 
    @needs_read_lock
 
910
        self.add_signature_text(revision_id, signature)
 
911
 
 
912
    def add_signature_text(self, revision_id, signature):
 
913
        """Store a signature text for a revision.
 
914
 
 
915
        :param revision_id: Revision id of the revision
 
916
        :param signature: Signature text.
 
917
        """
 
918
        raise NotImplementedError(self.add_signature_text)
 
919
 
 
920
    def _find_parent_ids_of_revisions(self, revision_ids):
 
921
        """Find all parent ids that are mentioned in the revision graph.
 
922
 
 
923
        :return: set of revisions that are parents of revision_ids which are
 
924
            not part of revision_ids themselves
 
925
        """
 
926
        parent_map = self.get_parent_map(revision_ids)
 
927
        parent_ids = set()
 
928
        map(parent_ids.update, parent_map.itervalues())
 
929
        parent_ids.difference_update(revision_ids)
 
930
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
931
        return parent_ids
 
932
 
 
933
    def iter_files_bytes(self, desired_files):
 
934
        """Iterate through file versions.
 
935
 
 
936
        Files will not necessarily be returned in the order they occur in
 
937
        desired_files.  No specific order is guaranteed.
 
938
 
 
939
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
940
        value supplied by the caller as part of desired_files.  It should
 
941
        uniquely identify the file version in the caller's context.  (Examples:
 
942
        an index number or a TreeTransform trans_id.)
 
943
 
 
944
        :param desired_files: a list of (file_id, revision_id, identifier)
 
945
            triples
 
946
        """
 
947
        raise NotImplementedError(self.iter_files_bytes)
 
948
 
 
949
    def get_rev_id_for_revno(self, revno, known_pair):
 
950
        """Return the revision id of a revno, given a later (revno, revid)
 
951
        pair in the same history.
 
952
 
 
953
        :return: if found (True, revid).  If the available history ran out
 
954
            before reaching the revno, then this returns
 
955
            (False, (closest_revno, closest_revid)).
 
956
        """
 
957
        known_revno, known_revid = known_pair
 
958
        partial_history = [known_revid]
 
959
        distance_from_known = known_revno - revno
 
960
        if distance_from_known < 0:
 
961
            raise ValueError(
 
962
                'requested revno (%d) is later than given known revno (%d)'
 
963
                % (revno, known_revno))
 
964
        try:
 
965
            _iter_for_revno(
 
966
                self, partial_history, stop_index=distance_from_known)
 
967
        except errors.RevisionNotPresent, err:
 
968
            if err.revision_id == known_revid:
 
969
                # The start revision (known_revid) wasn't found.
 
970
                raise
 
971
            # This is a stacked repository with no fallbacks, or a there's a
 
972
            # left-hand ghost.  Either way, even though the revision named in
 
973
            # the error isn't in this repo, we know it's the next step in this
 
974
            # left-hand history.
 
975
            partial_history.append(err.revision_id)
 
976
        if len(partial_history) <= distance_from_known:
 
977
            # Didn't find enough history to get a revid for the revno.
 
978
            earliest_revno = known_revno - len(partial_history) + 1
 
979
            return (False, (earliest_revno, partial_history[-1]))
 
980
        if len(partial_history) - 1 > distance_from_known:
 
981
            raise AssertionError('_iter_for_revno returned too much history')
 
982
        return (True, partial_history[-1])
 
983
 
725
984
    def is_shared(self):
726
985
        """Return True if this repository is flagged as a shared repository."""
727
986
        raise NotImplementedError(self.is_shared)
733
992
        reconciler = RepoReconciler(self, thorough=thorough)
734
993
        reconciler.reconcile()
735
994
        return reconciler
736
 
    
 
995
 
 
996
    def _refresh_data(self):
 
997
        """Helper called from lock_* to ensure coherency with disk.
 
998
 
 
999
        The default implementation does nothing; it is however possible
 
1000
        for repositories to maintain loaded indices across multiple locks
 
1001
        by checking inside their implementation of this method to see
 
1002
        whether their indices are still valid. This depends of course on
 
1003
        the disk format being validatable in this manner. This method is
 
1004
        also called by the refresh_data() public interface to cause a refresh
 
1005
        to occur while in a write lock so that data inserted by a smart server
 
1006
        push operation is visible on the client's instance of the physical
 
1007
        repository.
 
1008
        """
 
1009
 
737
1010
    @needs_read_lock
738
1011
    def revision_tree(self, revision_id):
739
1012
        """Return Tree for a revision on this branch.
740
1013
 
741
 
        `revision_id` may be None for the empty tree revision.
 
1014
        `revision_id` may be NULL_REVISION for the empty tree revision.
742
1015
        """
743
 
        # TODO: refactor this to use an existing revision object
744
 
        # so we don't need to read it in twice.
745
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
746
 
            return RevisionTree(self, Inventory(root_id=None), 
747
 
                                _mod_revision.NULL_REVISION)
748
 
        else:
749
 
            revision_id = osutils.safe_revision_id(revision_id)
750
 
            inv = self.get_revision_inventory(revision_id)
751
 
            return RevisionTree(self, inv, revision_id)
 
1016
        raise NotImplementedError(self.revision_tree)
752
1017
 
753
 
    @needs_read_lock
754
1018
    def revision_trees(self, revision_ids):
755
 
        """Return Tree for a revision on this branch.
756
 
 
757
 
        `revision_id` may not be None or 'null:'"""
758
 
        assert None not in revision_ids
759
 
        assert _mod_revision.NULL_REVISION not in revision_ids
760
 
        texts = self.get_inventory_weave().get_texts(revision_ids)
761
 
        for text, revision_id in zip(texts, revision_ids):
762
 
            inv = self.deserialise_inventory(revision_id, text)
763
 
            yield RevisionTree(self, inv, revision_id)
764
 
 
765
 
    @needs_read_lock
766
 
    def get_ancestry(self, revision_id):
767
 
        """Return a list of revision-ids integrated by a revision.
768
 
 
769
 
        The first element of the list is always None, indicating the origin 
770
 
        revision.  This might change when we have history horizons, or 
771
 
        perhaps we should have a new API.
772
 
        
773
 
        This is topologically sorted.
774
 
        """
775
 
        if revision_id is None:
776
 
            return [None]
777
 
        revision_id = osutils.safe_revision_id(revision_id)
778
 
        if not self.has_revision(revision_id):
779
 
            raise errors.NoSuchRevision(self, revision_id)
780
 
        w = self.get_inventory_weave()
781
 
        candidates = w.get_ancestry(revision_id)
782
 
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
783
 
 
784
 
    @needs_read_lock
785
 
    def print_file(self, file, revision_id):
786
 
        """Print `file` to stdout.
787
 
        
788
 
        FIXME RBC 20060125 as John Meinel points out this is a bad api
789
 
        - it writes to stdout, it assumes that that is valid etc. Fix
790
 
        by creating a new more flexible convenience function.
791
 
        """
792
 
        revision_id = osutils.safe_revision_id(revision_id)
793
 
        tree = self.revision_tree(revision_id)
794
 
        # use inventory as it was in that revision
795
 
        file_id = tree.inventory.path2id(file)
796
 
        if not file_id:
797
 
            # TODO: jam 20060427 Write a test for this code path
798
 
            #       it had a bug in it, and was raising the wrong
799
 
            #       exception.
800
 
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
801
 
        tree.print_file(file_id)
 
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:'
 
1023
        """
 
1024
        raise NotImplementedError(self.revision_trees)
 
1025
 
 
1026
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1027
        """Compress the data within the repository.
 
1028
 
 
1029
        This operation only makes sense for some repository types. For other
 
1030
        types it should be a no-op that just returns.
 
1031
 
 
1032
        This stub method does not require a lock, but subclasses should use
 
1033
        @needs_write_lock as this is a long running call it's reasonable to
 
1034
        implicitly lock for the user.
 
1035
 
 
1036
        :param hint: If not supplied, the whole repository is packed.
 
1037
            If supplied, the repository may use the hint parameter as a
 
1038
            hint for the parts of the repository to pack. A hint can be
 
1039
            obtained from the result of commit_write_group(). Out of
 
1040
            date hints are simply ignored, because concurrent operations
 
1041
            can obsolete them rapidly.
 
1042
 
 
1043
        :param clean_obsolete_packs: Clean obsolete packs immediately after
 
1044
            the pack operation.
 
1045
        """
802
1046
 
803
1047
    def get_transaction(self):
804
1048
        return self.control_files.get_transaction()
805
1049
 
806
 
    def revision_parents(self, revision_id):
807
 
        revision_id = osutils.safe_revision_id(revision_id)
808
 
        return self.get_inventory_weave().parent_names(revision_id)
 
1050
    def get_parent_map(self, revision_ids):
 
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."""
 
1056
        # revisions index works in keys; this just works in revisions
 
1057
        # therefore wrap and unwrap
 
1058
        query_keys = []
 
1059
        result = {}
 
1060
        for revision_id in revision_ids:
 
1061
            if revision_id == _mod_revision.NULL_REVISION:
 
1062
                result[revision_id] = ()
 
1063
            elif revision_id is None:
 
1064
                raise ValueError('get_parent_map(None) is not valid')
 
1065
            else:
 
1066
                query_keys.append((revision_id ,))
 
1067
        vf = self.revisions.without_fallbacks()
 
1068
        for ((revision_id,), parent_keys) in \
 
1069
                vf.get_parent_map(query_keys).iteritems():
 
1070
            if parent_keys:
 
1071
                result[revision_id] = tuple([parent_revid
 
1072
                    for (parent_revid,) in parent_keys])
 
1073
            else:
 
1074
                result[revision_id] = (_mod_revision.NULL_REVISION,)
 
1075
        return result
 
1076
 
 
1077
    def _make_parents_provider(self):
 
1078
        if not self._format.supports_external_lookups:
 
1079
            return self
 
1080
        return graph.StackedParentsProvider(_LazyListJoin(
 
1081
            [self._make_parents_provider_unstacked()],
 
1082
            self._fallback_repositories))
 
1083
 
 
1084
    def _make_parents_provider_unstacked(self):
 
1085
        return graph.CallableToParentsProviderAdapter(
 
1086
            self._get_parent_map_no_fallbacks)
 
1087
 
 
1088
    @needs_read_lock
 
1089
    def get_known_graph_ancestry(self, revision_ids):
 
1090
        """Return the known graph for a set of revision ids and their ancestors.
 
1091
        """
 
1092
        raise NotImplementedError(self.get_known_graph_ancestry)
 
1093
 
 
1094
    def get_file_graph(self):
 
1095
        """Return the graph walker for files."""
 
1096
        raise NotImplementedError(self.get_file_graph)
 
1097
 
 
1098
    def get_graph(self, other_repository=None):
 
1099
        """Return the graph walker for this repository format"""
 
1100
        parents_provider = self._make_parents_provider()
 
1101
        if (other_repository is not None and
 
1102
            not self.has_same_location(other_repository)):
 
1103
            parents_provider = graph.StackedParentsProvider(
 
1104
                [parents_provider, other_repository._make_parents_provider()])
 
1105
        return graph.Graph(parents_provider)
809
1106
 
810
1107
    @needs_write_lock
811
1108
    def set_make_working_trees(self, new_value):
818
1115
                          working trees.
819
1116
        """
820
1117
        raise NotImplementedError(self.set_make_working_trees)
821
 
    
 
1118
 
822
1119
    def make_working_trees(self):
823
1120
        """Returns the policy for making working trees on new branches."""
824
1121
        raise NotImplementedError(self.make_working_trees)
825
1122
 
826
1123
    @needs_write_lock
827
1124
    def sign_revision(self, revision_id, gpg_strategy):
828
 
        revision_id = osutils.safe_revision_id(revision_id)
829
 
        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()
830
1127
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
831
1128
 
832
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
 
833
1159
    def has_signature_for_revision_id(self, revision_id):
834
1160
        """Query for a revision signature for revision_id in the repository."""
835
 
        revision_id = osutils.safe_revision_id(revision_id)
836
 
        return self._revision_store.has_signature(revision_id,
837
 
                                                  self.get_transaction())
 
1161
        raise NotImplementedError(self.has_signature_for_revision_id)
838
1162
 
839
 
    @needs_read_lock
840
1163
    def get_signature_text(self, revision_id):
841
1164
        """Return the text for a signature."""
842
 
        revision_id = osutils.safe_revision_id(revision_id)
843
 
        return self._revision_store.get_signature_text(revision_id,
844
 
                                                       self.get_transaction())
 
1165
        raise NotImplementedError(self.get_signature_text)
845
1166
 
846
 
    @needs_read_lock
847
 
    def check(self, revision_ids):
 
1167
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
848
1168
        """Check consistency of all history of given revision_ids.
849
1169
 
850
1170
        Different repository implementations should override _check().
851
1171
 
852
1172
        :param revision_ids: A non-empty list of revision_ids whose ancestry
853
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.
854
1179
        """
855
 
        if not revision_ids:
856
 
            raise ValueError("revision_ids must be non-empty in %s.check" 
857
 
                    % (self,))
858
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
859
 
        return self._check(revision_ids)
860
 
 
861
 
    def _check(self, revision_ids):
862
 
        result = check.Check(self)
863
 
        result.check()
864
 
        return result
865
 
 
866
 
    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
867
1189
        global _deprecation_warning_done
868
1190
        if _deprecation_warning_done:
869
1191
            return
870
 
        _deprecation_warning_done = True
871
 
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
872
 
                % (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
873
1204
 
874
1205
    def supports_rich_root(self):
875
1206
        return self._format.rich_root_data
891
1222
                    raise errors.NonAsciiRevisionId(method, self)
892
1223
 
893
1224
 
894
 
 
895
 
# remove these delegates a while after bzr 0.15
896
 
def __make_delegated(name, from_module):
897
 
    def _deprecated_repository_forwarder():
898
 
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
899
 
            % (name, from_module),
900
 
            DeprecationWarning,
901
 
            stacklevel=2)
902
 
        m = __import__(from_module, globals(), locals(), [name])
903
 
        try:
904
 
            return getattr(m, name)
905
 
        except AttributeError:
906
 
            raise AttributeError('module %s has no name %s'
907
 
                    % (m, name))
908
 
    globals()[name] = _deprecated_repository_forwarder
909
 
 
910
 
for _name in [
911
 
        'AllInOneRepository',
912
 
        'WeaveMetaDirRepository',
913
 
        'PreSplitOutRepositoryFormat',
914
 
        'RepositoryFormat4',
915
 
        'RepositoryFormat5',
916
 
        'RepositoryFormat6',
917
 
        'RepositoryFormat7',
918
 
        ]:
919
 
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
920
 
 
921
 
for _name in [
922
 
        'KnitRepository',
923
 
        'KnitRepository2',
924
 
        'RepositoryFormatKnit',
925
 
        'RepositoryFormatKnit1',
926
 
        'RepositoryFormatKnit2',
927
 
        ]:
928
 
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
929
 
 
930
 
 
931
 
def install_revision(repository, rev, revision_tree):
932
 
    """Install all revision data into a repository."""
933
 
    present_parents = []
934
 
    parent_trees = {}
935
 
    for p_id in rev.parent_ids:
936
 
        if repository.has_revision(p_id):
937
 
            present_parents.append(p_id)
938
 
            parent_trees[p_id] = repository.revision_tree(p_id)
939
 
        else:
940
 
            parent_trees[p_id] = repository.revision_tree(None)
941
 
 
942
 
    inv = revision_tree.inventory
943
 
    entries = inv.iter_entries()
944
 
    # backwards compatability hack: skip the root id.
945
 
    if not repository.supports_rich_root():
946
 
        path, root = entries.next()
947
 
        if root.revision != rev.revision_id:
948
 
            raise errors.IncompatibleRevision(repr(repository))
949
 
    # Add the texts that are not already present
950
 
    for path, ie in entries:
951
 
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
952
 
                repository.get_transaction())
953
 
        if ie.revision not in w:
954
 
            text_parents = []
955
 
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
956
 
            # with InventoryEntry.find_previous_heads(). if it is, then there
957
 
            # is a latent bug here where the parents may have ancestors of each
958
 
            # other. RBC, AB
959
 
            for revision, tree in parent_trees.iteritems():
960
 
                if ie.file_id not in tree:
961
 
                    continue
962
 
                parent_id = tree.inventory[ie.file_id].revision
963
 
                if parent_id in text_parents:
964
 
                    continue
965
 
                text_parents.append(parent_id)
966
 
                    
967
 
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
968
 
                repository.get_transaction())
969
 
            lines = revision_tree.get_file(ie.file_id).readlines()
970
 
            vfile.add_lines(rev.revision_id, text_parents, lines)
971
 
    try:
972
 
        # install the inventory
973
 
        repository.add_inventory(rev.revision_id, inv, present_parents)
974
 
    except errors.RevisionAlreadyPresent:
975
 
        pass
976
 
    repository.add_revision(rev.revision_id, rev, inv)
977
 
 
978
 
 
979
1225
class MetaDirRepository(Repository):
980
 
    """Repositories in the new meta-dir layout."""
981
 
 
982
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
983
 
        super(MetaDirRepository, self).__init__(_format,
984
 
                                                a_bzrdir,
985
 
                                                control_files,
986
 
                                                _revision_store,
987
 
                                                control_store,
988
 
                                                text_store)
989
 
        dir_mode = self.control_files._dir_mode
990
 
        file_mode = self.control_files._file_mode
991
 
 
992
 
    @needs_read_lock
 
1226
    """Repositories in the new meta-dir layout.
 
1227
 
 
1228
    :ivar _transport: Transport for access to repository control files,
 
1229
        typically pointing to .bzr/repository.
 
1230
    """
 
1231
 
 
1232
    def __init__(self, _format, a_bzrdir, control_files):
 
1233
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
 
1234
        self._transport = control_files._transport
 
1235
 
993
1236
    def is_shared(self):
994
1237
        """Return True if this repository is flagged as a shared repository."""
995
 
        return self.control_files._transport.has('shared-storage')
 
1238
        return self._transport.has('shared-storage')
996
1239
 
997
1240
    @needs_write_lock
998
1241
    def set_make_working_trees(self, new_value):
1006
1249
        """
1007
1250
        if new_value:
1008
1251
            try:
1009
 
                self.control_files._transport.delete('no-working-trees')
 
1252
                self._transport.delete('no-working-trees')
1010
1253
            except errors.NoSuchFile:
1011
1254
                pass
1012
1255
        else:
1013
 
            self.control_files.put_utf8('no-working-trees', '')
1014
 
    
 
1256
            self._transport.put_bytes('no-working-trees', '',
 
1257
                mode=self.bzrdir._get_file_mode())
 
1258
 
1015
1259
    def make_working_trees(self):
1016
1260
        """Returns the policy for making working trees on new branches."""
1017
 
        return not self.control_files._transport.has('no-working-trees')
1018
 
 
1019
 
 
1020
 
class RepositoryFormatRegistry(registry.Registry):
1021
 
    """Registry of RepositoryFormats.
1022
 
    """
1023
 
 
1024
 
    def get(self, format_string):
1025
 
        r = registry.Registry.get(self, format_string)
1026
 
        if callable(r):
1027
 
            r = r()
1028
 
        return r
1029
 
    
1030
 
 
1031
 
format_registry = RepositoryFormatRegistry()
1032
 
"""Registry of formats, indexed by their identifying format string.
 
1261
        return not self._transport.has('no-working-trees')
 
1262
 
 
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.
1033
1293
 
1034
1294
This can contain either format instances themselves, or classes/factories that
1035
1295
can be called to obtain one.
1036
1296
"""
1037
1297
 
1038
1298
 
1039
 
class RepositoryFormat(object):
 
1299
#####################################################################
 
1300
# Repository Formats
 
1301
 
 
1302
class RepositoryFormat(controldir.ControlComponentFormat):
1040
1303
    """A repository format.
1041
1304
 
1042
 
    Formats provide three things:
 
1305
    Formats provide four things:
1043
1306
     * An initialization routine to construct repository data on disk.
1044
 
     * a format string which is used when the BzrDir supports versioned
1045
 
       children.
 
1307
     * a optional format string which is used when the BzrDir supports
 
1308
       versioned children.
1046
1309
     * an open routine which returns a Repository instance.
1047
 
 
1048
 
    Formats are placed in an dict by their format string for reference 
1049
 
    during opening. These should be subclasses of RepositoryFormat
1050
 
    for consistency.
 
1310
     * A network name for referring to the format in smart server RPC
 
1311
       methods.
 
1312
 
 
1313
    There is one and only one Format subclass for each on-disk format. But
 
1314
    there can be one Repository subclass that is used for several different
 
1315
    formats. The _format attribute on a Repository instance can be used to
 
1316
    determine the disk format.
 
1317
 
 
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.
1051
1321
 
1052
1322
    Once a format is deprecated, just deprecate the initialize and open
1053
 
    methods on the format class. Do not deprecate the object, as the 
1054
 
    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.
1055
1326
 
1056
1327
    Common instance attributes:
1057
 
    _matchingbzrdir - the bzrdir format that the repository format was
 
1328
    _matchingbzrdir - the controldir format that the repository format was
1058
1329
    originally written to work with. This can be used if manually
1059
1330
    constructing a bzrdir and repository, or more commonly for test suite
1060
 
    parameterisation.
 
1331
    parameterization.
1061
1332
    """
1062
1333
 
1063
 
    def __str__(self):
1064
 
        return "<%s>" % self.__class__.__name__
 
1334
    # Set to True or False in derived classes. True indicates that the format
 
1335
    # supports ghosts gracefully.
 
1336
    supports_ghosts = None
 
1337
    # Can this repository be given external locations to lookup additional
 
1338
    # data. Set to True or False in derived classes.
 
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
 
1379
 
 
1380
    def __repr__(self):
 
1381
        return "%s()" % self.__class__.__name__
1065
1382
 
1066
1383
    def __eq__(self, other):
1067
1384
        # format objects are generally stateless
1068
1385
        return isinstance(other, self.__class__)
1069
1386
 
1070
 
    @classmethod
1071
 
    def find_format(klass, a_bzrdir):
1072
 
        """Return the format for the repository object in a_bzrdir.
1073
 
        
1074
 
        This is used by bzr native formats that have a "format" file in
1075
 
        the repository.  Other methods may be used by different types of 
1076
 
        control directory.
1077
 
        """
1078
 
        try:
1079
 
            transport = a_bzrdir.get_repository_transport(None)
1080
 
            format_string = transport.get("format").read()
1081
 
            return format_registry.get(format_string)
1082
 
        except errors.NoSuchFile:
1083
 
            raise errors.NoRepositoryPresent(a_bzrdir)
1084
 
        except KeyError:
1085
 
            raise errors.UnknownFormatError(format=format_string)
1086
 
 
1087
 
    @classmethod
1088
 
    def register_format(klass, format):
1089
 
        format_registry.register(format.get_format_string(), format)
1090
 
 
1091
 
    @classmethod
1092
 
    def unregister_format(klass, format):
1093
 
        format_registry.remove(format.get_format_string())
1094
 
    
1095
 
    @classmethod
1096
 
    def get_default_format(klass):
1097
 
        """Return the current default format."""
1098
 
        from bzrlib import bzrdir
1099
 
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1100
 
 
1101
 
    def _get_control_store(self, repo_transport, control_files):
1102
 
        """Return the control store for this repository."""
1103
 
        raise NotImplementedError(self._get_control_store)
1104
 
 
1105
 
    def get_format_string(self):
1106
 
        """Return the ASCII format string that identifies this format.
1107
 
        
1108
 
        Note that in pre format ?? repositories the format string is 
1109
 
        not permitted nor written to disk.
1110
 
        """
1111
 
        raise NotImplementedError(self.get_format_string)
 
1387
    def __ne__(self, other):
 
1388
        return not self == other
1112
1389
 
1113
1390
    def get_format_description(self):
1114
1391
        """Return the short description for this format."""
1115
1392
        raise NotImplementedError(self.get_format_description)
1116
1393
 
1117
 
    def _get_revision_store(self, repo_transport, control_files):
1118
 
        """Return the revision store object for this a_bzrdir."""
1119
 
        raise NotImplementedError(self._get_revision_store)
1120
 
 
1121
 
    def _get_text_rev_store(self,
1122
 
                            transport,
1123
 
                            control_files,
1124
 
                            name,
1125
 
                            compressed=True,
1126
 
                            prefixed=False,
1127
 
                            serializer=None):
1128
 
        """Common logic for getting a revision store for a repository.
1129
 
        
1130
 
        see self._get_revision_store for the subclass-overridable method to 
1131
 
        get the store for a repository.
1132
 
        """
1133
 
        from bzrlib.store.revision.text import TextRevisionStore
1134
 
        dir_mode = control_files._dir_mode
1135
 
        file_mode = control_files._file_mode
1136
 
        text_store =TextStore(transport.clone(name),
1137
 
                              prefixed=prefixed,
1138
 
                              compressed=compressed,
1139
 
                              dir_mode=dir_mode,
1140
 
                              file_mode=file_mode)
1141
 
        _revision_store = TextRevisionStore(text_store, serializer)
1142
 
        return _revision_store
1143
 
 
1144
 
    # TODO: this shouldn't be in the base class, it's specific to things that
1145
 
    # use weaves or knits -- mbp 20070207
1146
 
    def _get_versioned_file_store(self,
1147
 
                                  name,
1148
 
                                  transport,
1149
 
                                  control_files,
1150
 
                                  prefixed=True,
1151
 
                                  versionedfile_class=None,
1152
 
                                  versionedfile_kwargs={},
1153
 
                                  escaped=False):
1154
 
        if versionedfile_class is None:
1155
 
            versionedfile_class = self._versionedfile_class
1156
 
        weave_transport = control_files._transport.clone(name)
1157
 
        dir_mode = control_files._dir_mode
1158
 
        file_mode = control_files._file_mode
1159
 
        return VersionedFileStore(weave_transport, prefixed=prefixed,
1160
 
                                  dir_mode=dir_mode,
1161
 
                                  file_mode=file_mode,
1162
 
                                  versionedfile_class=versionedfile_class,
1163
 
                                  versionedfile_kwargs=versionedfile_kwargs,
1164
 
                                  escaped=escaped)
1165
 
 
1166
 
    def initialize(self, a_bzrdir, shared=False):
1167
 
        """Initialize a repository of this format in a_bzrdir.
1168
 
 
1169
 
        :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.
1170
1398
        :param shared: The repository should be initialized as a sharable one.
 
1399
        :returns: The new repository object.
1171
1400
 
1172
1401
        This may raise UninitializableFormat if shared repository are not
1173
 
        compatible the a_bzrdir.
 
1402
        compatible the controldir.
1174
1403
        """
 
1404
        raise NotImplementedError(self.initialize)
1175
1405
 
1176
1406
    def is_supported(self):
1177
1407
        """Is this format supported?
1178
1408
 
1179
1409
        Supported formats must be initializable and openable.
1180
 
        Unsupported formats may not support initialization or committing or 
 
1410
        Unsupported formats may not support initialization or committing or
1181
1411
        some other features depending on the reason for not being supported.
1182
1412
        """
1183
1413
        return True
1184
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
 
1185
1433
    def check_conversion_target(self, target_format):
1186
 
        raise NotImplementedError(self.check_conversion_target)
1187
 
 
1188
 
    def open(self, a_bzrdir, _found=False):
1189
 
        """Return an instance of this format for the bzrdir a_bzrdir.
1190
 
        
 
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
 
1191
1447
        _found is a private parameter, do not use it.
1192
1448
        """
1193
1449
        raise NotImplementedError(self.open)
1194
1450
 
1195
 
 
1196
 
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):
1197
1462
    """Common base class for the new repositories using the metadir layout."""
1198
1463
 
1199
1464
    rich_root_data = False
1200
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1465
    supports_tree_reference = False
 
1466
    supports_external_lookups = False
 
1467
    supports_leaving_lock = True
 
1468
    supports_nesting_repositories = True
 
1469
 
 
1470
    @property
 
1471
    def _matchingbzrdir(self):
 
1472
        matching = bzrdir.BzrDirMetaFormat1()
 
1473
        matching.repository_format = self
 
1474
        return matching
1201
1475
 
1202
1476
    def __init__(self):
1203
 
        super(MetaDirRepositoryFormat, self).__init__()
 
1477
        RepositoryFormat.__init__(self)
 
1478
        bzrdir.BzrFormat.__init__(self)
1204
1479
 
1205
1480
    def _create_control_files(self, a_bzrdir):
1206
1481
        """Create the required files and the initial control_files object."""
1216
1491
        """Upload the initial blank content."""
1217
1492
        control_files = self._create_control_files(a_bzrdir)
1218
1493
        control_files.lock_write()
 
1494
        transport = control_files._transport
 
1495
        if shared == True:
 
1496
            utf8_files += [('shared-storage', '')]
1219
1497
        try:
1220
 
            control_files._transport.mkdir_multi(dirs,
1221
 
                    mode=control_files._dir_mode)
1222
 
            for file, content in files:
1223
 
                control_files.put(file, content)
1224
 
            for file, content in utf8_files:
1225
 
                control_files.put_utf8(file, content)
1226
 
            if shared == True:
1227
 
                control_files.put_utf8('shared-storage', '')
 
1498
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
 
1499
            for (filename, content_stream) in files:
 
1500
                transport.put_file(filename, content_stream,
 
1501
                    mode=a_bzrdir._get_file_mode())
 
1502
            for (filename, content_bytes) in utf8_files:
 
1503
                transport.put_bytes_non_atomic(filename, content_bytes,
 
1504
                    mode=a_bzrdir._get_file_mode())
1228
1505
        finally:
1229
1506
            control_files.unlock()
1230
1507
 
1231
 
 
1232
 
# formats which have no format string are not discoverable
1233
 
# and not independently creatable, so are not registered.  They're 
1234
 
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
1235
 
# 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
1236
1536
# the repository is not separately opened are similar.
1237
1537
 
1238
1538
format_registry.register_lazy(
1239
 
    'Bazaar-NG Repository format 7',
1240
 
    'bzrlib.repofmt.weaverepo',
1241
 
    'RepositoryFormat7'
1242
 
    )
1243
 
# KEEP in sync with bzrdir.format_registry default, which controls the overall
1244
 
# default control directory format
1245
 
 
1246
 
format_registry.register_lazy(
1247
1539
    'Bazaar-NG Knit Repository Format 1',
1248
1540
    'bzrlib.repofmt.knitrepo',
1249
1541
    'RepositoryFormatKnit1',
1250
1542
    )
1251
 
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
1252
 
 
1253
 
format_registry.register_lazy(
1254
 
    'Bazaar Knit Repository Format 2\n',
1255
 
    'bzrlib.repofmt.knitrepo',
1256
 
    'RepositoryFormatKnit2',
 
1543
 
 
1544
format_registry.register_lazy(
 
1545
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
1546
    'bzrlib.repofmt.knitrepo',
 
1547
    'RepositoryFormatKnit3',
 
1548
    )
 
1549
 
 
1550
format_registry.register_lazy(
 
1551
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
1552
    'bzrlib.repofmt.knitrepo',
 
1553
    'RepositoryFormatKnit4',
 
1554
    )
 
1555
 
 
1556
# Pack-based formats. There is one format for pre-subtrees, and one for
 
1557
# post-subtrees to allow ease of testing.
 
1558
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
1559
format_registry.register_lazy(
 
1560
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
1561
    'bzrlib.repofmt.knitpack_repo',
 
1562
    'RepositoryFormatKnitPack1',
 
1563
    )
 
1564
format_registry.register_lazy(
 
1565
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
1566
    'bzrlib.repofmt.knitpack_repo',
 
1567
    'RepositoryFormatKnitPack3',
 
1568
    )
 
1569
format_registry.register_lazy(
 
1570
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
1571
    'bzrlib.repofmt.knitpack_repo',
 
1572
    'RepositoryFormatKnitPack4',
 
1573
    )
 
1574
format_registry.register_lazy(
 
1575
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
 
1576
    'bzrlib.repofmt.knitpack_repo',
 
1577
    'RepositoryFormatKnitPack5',
 
1578
    )
 
1579
format_registry.register_lazy(
 
1580
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
 
1581
    'bzrlib.repofmt.knitpack_repo',
 
1582
    'RepositoryFormatKnitPack5RichRoot',
 
1583
    )
 
1584
format_registry.register_lazy(
 
1585
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
 
1586
    'bzrlib.repofmt.knitpack_repo',
 
1587
    'RepositoryFormatKnitPack5RichRootBroken',
 
1588
    )
 
1589
format_registry.register_lazy(
 
1590
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
1591
    'bzrlib.repofmt.knitpack_repo',
 
1592
    'RepositoryFormatKnitPack6',
 
1593
    )
 
1594
format_registry.register_lazy(
 
1595
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
1596
    'bzrlib.repofmt.knitpack_repo',
 
1597
    'RepositoryFormatKnitPack6RichRoot',
 
1598
    )
 
1599
format_registry.register_lazy(
 
1600
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
1601
    'bzrlib.repofmt.groupcompress_repo',
 
1602
    'RepositoryFormat2a',
 
1603
    )
 
1604
 
 
1605
# Development formats.
 
1606
# Check their docstrings to see if/when they are obsolete.
 
1607
format_registry.register_lazy(
 
1608
    ("Bazaar development format 2 with subtree support "
 
1609
        "(needs bzr.dev from before 1.8)\n"),
 
1610
    'bzrlib.repofmt.knitpack_repo',
 
1611
    'RepositoryFormatPackDevelopment2Subtree',
 
1612
    )
 
1613
format_registry.register_lazy(
 
1614
    'Bazaar development format 8\n',
 
1615
    'bzrlib.repofmt.groupcompress_repo',
 
1616
    'RepositoryFormat2aSubtree',
1257
1617
    )
1258
1618
 
1259
1619
 
1261
1621
    """This class represents operations taking place between two repositories.
1262
1622
 
1263
1623
    Its instances have methods like copy_content and fetch, and contain
1264
 
    references to the source and target repositories these operations can be 
 
1624
    references to the source and target repositories these operations can be
1265
1625
    carried out on.
1266
1626
 
1267
1627
    Often we will provide convenience methods on 'repository' which carry out
1272
1632
    _optimisers = []
1273
1633
    """The available optimised InterRepository types."""
1274
1634
 
1275
 
    def copy_content(self, revision_id=None, basis=None):
1276
 
        raise NotImplementedError(self.copy_content)
1277
 
 
1278
 
    def fetch(self, revision_id=None, pb=None):
 
1635
    @needs_write_lock
 
1636
    def copy_content(self, revision_id=None):
 
1637
        """Make a complete copy of the content in self into destination.
 
1638
 
 
1639
        This is a destructive operation! Do not use it on existing
 
1640
        repositories.
 
1641
 
 
1642
        :param revision_id: Only copy the content needed to construct
 
1643
                            revision_id and its parents.
 
1644
        """
 
1645
        try:
 
1646
            self.target.set_make_working_trees(self.source.make_working_trees())
 
1647
        except NotImplementedError:
 
1648
            pass
 
1649
        self.target.fetch(self.source, revision_id=revision_id)
 
1650
 
 
1651
    @needs_write_lock
 
1652
    def fetch(self, revision_id=None, find_ghosts=False):
1279
1653
        """Fetch the content required to construct revision_id.
1280
1654
 
1281
1655
        The content is copied from self.source to self.target.
1282
1656
 
1283
1657
        :param revision_id: if None all content is copied, if NULL_REVISION no
1284
1658
                            content is copied.
1285
 
        :param pb: optional progress bar to use for progress reports. If not
1286
 
                   provided a default one will be created.
1287
 
 
1288
 
        Returns the copied revision count and the failed revisions in a tuple:
1289
 
        (copied, failures).
 
1659
        :return: None.
1290
1660
        """
1291
1661
        raise NotImplementedError(self.fetch)
1292
 
   
 
1662
 
1293
1663
    @needs_read_lock
1294
 
    def missing_revision_ids(self, revision_id=None):
 
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):
1295
1668
        """Return the revision ids that source has that target does not.
1296
 
        
1297
 
        These are returned in topological order.
1298
1669
 
1299
1670
        :param revision_id: only return revision ids included by this
1300
 
                            revision_id.
1301
 
        """
1302
 
        # generic, possibly worst case, slow code path.
1303
 
        target_ids = set(self.target.all_revision_ids())
1304
 
        if revision_id is not None:
1305
 
            # TODO: jam 20070210 InterRepository is internal enough that it
1306
 
            #       should assume revision_ids are already utf-8
1307
 
            revision_id = osutils.safe_revision_id(revision_id)
1308
 
            source_ids = self.source.get_ancestry(revision_id)
1309
 
            assert source_ids[0] is None
1310
 
            source_ids.pop(0)
1311
 
        else:
1312
 
            source_ids = self.source.all_revision_ids()
1313
 
        result_set = set(source_ids).difference(target_ids)
1314
 
        # this may look like a no-op: its not. It preserves the ordering
1315
 
        # other_ids had while only returning the members from other_ids
1316
 
        # that we've decided we need.
1317
 
        return [rev_id for rev_id in source_ids if rev_id in result_set]
1318
 
 
1319
 
 
1320
 
class InterSameDataRepository(InterRepository):
1321
 
    """Code for converting between repositories that represent the same data.
1322
 
    
1323
 
    Data format and model must match for this to work.
1324
 
    """
1325
 
 
1326
 
    @classmethod
1327
 
    def _get_repo_format_to_test(self):
1328
 
        """Repository format for testing with."""
1329
 
        return RepositoryFormat.get_default_format()
1330
 
 
1331
 
    @staticmethod
1332
 
    def is_compatible(source, target):
1333
 
        if not isinstance(source, Repository):
1334
 
            return False
1335
 
        if not isinstance(target, Repository):
1336
 
            return False
1337
 
        if source._format.rich_root_data == target._format.rich_root_data:
1338
 
            return True
1339
 
        else:
1340
 
            return False
1341
 
 
1342
 
    @needs_write_lock
1343
 
    def copy_content(self, revision_id=None, basis=None):
1344
 
        """Make a complete copy of the content in self into destination.
1345
 
        
1346
 
        This is a destructive operation! Do not use it on existing 
1347
 
        repositories.
1348
 
 
1349
 
        :param revision_id: Only copy the content needed to construct
1350
 
                            revision_id and its parents.
1351
 
        :param basis: Copy the needed data preferentially from basis.
1352
 
        """
1353
 
        try:
1354
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1355
 
        except NotImplementedError:
1356
 
            pass
1357
 
        # TODO: jam 20070210 This is fairly internal, so we should probably
1358
 
        #       just assert that revision_id is not unicode.
1359
 
        revision_id = osutils.safe_revision_id(revision_id)
1360
 
        # grab the basis available data
1361
 
        if basis is not None:
1362
 
            self.target.fetch(basis, revision_id=revision_id)
1363
 
        # but don't bother fetching if we have the needed data now.
1364
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1365
 
            self.target.has_revision(revision_id)):
1366
 
            return
1367
 
        self.target.fetch(self.source, revision_id=revision_id)
1368
 
 
1369
 
    @needs_write_lock
1370
 
    def fetch(self, revision_id=None, pb=None):
1371
 
        """See InterRepository.fetch()."""
1372
 
        from bzrlib.fetch import GenericRepoFetcher
1373
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1374
 
               self.source, self.source._format, self.target, 
1375
 
               self.target._format)
1376
 
        # TODO: jam 20070210 This should be an assert, not a translate
1377
 
        revision_id = osutils.safe_revision_id(revision_id)
1378
 
        f = GenericRepoFetcher(to_repository=self.target,
1379
 
                               from_repository=self.source,
1380
 
                               last_revision=revision_id,
1381
 
                               pb=pb)
1382
 
        return f.count_copied, f.failed_revisions
1383
 
 
1384
 
 
1385
 
class InterWeaveRepo(InterSameDataRepository):
1386
 
    """Optimised code paths between Weave based repositories."""
1387
 
 
1388
 
    @classmethod
1389
 
    def _get_repo_format_to_test(self):
1390
 
        from bzrlib.repofmt import weaverepo
1391
 
        return weaverepo.RepositoryFormat7()
1392
 
 
1393
 
    @staticmethod
1394
 
    def is_compatible(source, target):
1395
 
        """Be compatible with known Weave formats.
1396
 
        
1397
 
        We don't test for the stores being of specific types because that
1398
 
        could lead to confusing results, and there is no need to be 
1399
 
        overly general.
1400
 
        """
1401
 
        from bzrlib.repofmt.weaverepo import (
1402
 
                RepositoryFormat5,
1403
 
                RepositoryFormat6,
1404
 
                RepositoryFormat7,
1405
 
                )
1406
 
        try:
1407
 
            return (isinstance(source._format, (RepositoryFormat5,
1408
 
                                                RepositoryFormat6,
1409
 
                                                RepositoryFormat7)) and
1410
 
                    isinstance(target._format, (RepositoryFormat5,
1411
 
                                                RepositoryFormat6,
1412
 
                                                RepositoryFormat7)))
1413
 
        except AttributeError:
1414
 
            return False
1415
 
    
1416
 
    @needs_write_lock
1417
 
    def copy_content(self, revision_id=None, basis=None):
1418
 
        """See InterRepository.copy_content()."""
1419
 
        # weave specific optimised path:
1420
 
        # TODO: jam 20070210 Internal, should be an assert, not translate
1421
 
        revision_id = osutils.safe_revision_id(revision_id)
1422
 
        if basis is not None:
1423
 
            # copy the basis in, then fetch remaining data.
1424
 
            basis.copy_content_into(self.target, revision_id)
1425
 
            # the basis copy_content_into could miss-set this.
1426
 
            try:
1427
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1428
 
            except NotImplementedError:
1429
 
                pass
1430
 
            self.target.fetch(self.source, revision_id=revision_id)
1431
 
        else:
1432
 
            try:
1433
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1434
 
            except NotImplementedError:
1435
 
                pass
1436
 
            # FIXME do not peek!
1437
 
            if self.source.control_files._transport.listable():
1438
 
                pb = ui.ui_factory.nested_progress_bar()
1439
 
                try:
1440
 
                    self.target.weave_store.copy_all_ids(
1441
 
                        self.source.weave_store,
1442
 
                        pb=pb,
1443
 
                        from_transaction=self.source.get_transaction(),
1444
 
                        to_transaction=self.target.get_transaction())
1445
 
                    pb.update('copying inventory', 0, 1)
1446
 
                    self.target.control_weaves.copy_multi(
1447
 
                        self.source.control_weaves, ['inventory'],
1448
 
                        from_transaction=self.source.get_transaction(),
1449
 
                        to_transaction=self.target.get_transaction())
1450
 
                    self.target._revision_store.text_store.copy_all_ids(
1451
 
                        self.source._revision_store.text_store,
1452
 
                        pb=pb)
1453
 
                finally:
1454
 
                    pb.finished()
1455
 
            else:
1456
 
                self.target.fetch(self.source, revision_id=revision_id)
1457
 
 
1458
 
    @needs_write_lock
1459
 
    def fetch(self, revision_id=None, pb=None):
1460
 
        """See InterRepository.fetch()."""
1461
 
        from bzrlib.fetch import GenericRepoFetcher
1462
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1463
 
               self.source, self.source._format, self.target, self.target._format)
1464
 
        # TODO: jam 20070210 This should be an assert, not a translate
1465
 
        revision_id = osutils.safe_revision_id(revision_id)
1466
 
        f = GenericRepoFetcher(to_repository=self.target,
1467
 
                               from_repository=self.source,
1468
 
                               last_revision=revision_id,
1469
 
                               pb=pb)
1470
 
        return f.count_copied, f.failed_revisions
1471
 
 
1472
 
    @needs_read_lock
1473
 
    def missing_revision_ids(self, revision_id=None):
1474
 
        """See InterRepository.missing_revision_ids()."""
1475
 
        # we want all revisions to satisfy revision_id in source.
1476
 
        # but we don't want to stat every file here and there.
1477
 
        # we want then, all revisions other needs to satisfy revision_id 
1478
 
        # checked, but not those that we have locally.
1479
 
        # so the first thing is to get a subset of the revisions to 
1480
 
        # satisfy revision_id in source, and then eliminate those that
1481
 
        # we do already have. 
1482
 
        # this is slow on high latency connection to self, but as as this
1483
 
        # disk format scales terribly for push anyway due to rewriting 
1484
 
        # inventory.weave, this is considered acceptable.
1485
 
        # - RBC 20060209
1486
 
        if revision_id is not None:
1487
 
            source_ids = self.source.get_ancestry(revision_id)
1488
 
            assert source_ids[0] is None
1489
 
            source_ids.pop(0)
1490
 
        else:
1491
 
            source_ids = self.source._all_possible_ids()
1492
 
        source_ids_set = set(source_ids)
1493
 
        # source_ids is the worst possible case we may need to pull.
1494
 
        # now we want to filter source_ids against what we actually
1495
 
        # have in target, but don't try to check for existence where we know
1496
 
        # we do not have a revision as that would be pointless.
1497
 
        target_ids = set(self.target._all_possible_ids())
1498
 
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1499
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1500
 
        required_revisions = source_ids_set.difference(actually_present_revisions)
1501
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1502
 
        if revision_id is not None:
1503
 
            # we used get_ancestry to determine source_ids then we are assured all
1504
 
            # revisions referenced are present as they are installed in topological order.
1505
 
            # and the tip revision was validated by get_ancestry.
1506
 
            return required_topo_revisions
1507
 
        else:
1508
 
            # if we just grabbed the possibly available ids, then 
1509
 
            # we only have an estimate of whats available and need to validate
1510
 
            # that against the revision records.
1511
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1512
 
 
1513
 
 
1514
 
class InterKnitRepo(InterSameDataRepository):
1515
 
    """Optimised code paths between Knit based repositories."""
1516
 
 
1517
 
    @classmethod
1518
 
    def _get_repo_format_to_test(self):
1519
 
        from bzrlib.repofmt import knitrepo
1520
 
        return knitrepo.RepositoryFormatKnit1()
1521
 
 
1522
 
    @staticmethod
1523
 
    def is_compatible(source, target):
1524
 
        """Be compatible with known Knit formats.
1525
 
        
1526
 
        We don't test for the stores being of specific types because that
1527
 
        could lead to confusing results, and there is no need to be 
1528
 
        overly general.
1529
 
        """
1530
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1
1531
 
        try:
1532
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1533
 
                    isinstance(target._format, (RepositoryFormatKnit1)))
1534
 
        except AttributeError:
1535
 
            return False
1536
 
 
1537
 
    @needs_write_lock
1538
 
    def fetch(self, revision_id=None, pb=None):
1539
 
        """See InterRepository.fetch()."""
1540
 
        from bzrlib.fetch import KnitRepoFetcher
1541
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1542
 
               self.source, self.source._format, self.target, self.target._format)
1543
 
        # TODO: jam 20070210 This should be an assert, not a translate
1544
 
        revision_id = osutils.safe_revision_id(revision_id)
1545
 
        f = KnitRepoFetcher(to_repository=self.target,
1546
 
                            from_repository=self.source,
1547
 
                            last_revision=revision_id,
1548
 
                            pb=pb)
1549
 
        return f.count_copied, f.failed_revisions
1550
 
 
1551
 
    @needs_read_lock
1552
 
    def missing_revision_ids(self, revision_id=None):
1553
 
        """See InterRepository.missing_revision_ids()."""
1554
 
        if revision_id is not None:
1555
 
            source_ids = self.source.get_ancestry(revision_id)
1556
 
            assert source_ids[0] is None
1557
 
            source_ids.pop(0)
1558
 
        else:
1559
 
            source_ids = self.source._all_possible_ids()
1560
 
        source_ids_set = set(source_ids)
1561
 
        # source_ids is the worst possible case we may need to pull.
1562
 
        # now we want to filter source_ids against what we actually
1563
 
        # have in target, but don't try to check for existence where we know
1564
 
        # we do not have a revision as that would be pointless.
1565
 
        target_ids = set(self.target._all_possible_ids())
1566
 
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1567
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1568
 
        required_revisions = source_ids_set.difference(actually_present_revisions)
1569
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1570
 
        if revision_id is not None:
1571
 
            # we used get_ancestry to determine source_ids then we are assured all
1572
 
            # revisions referenced are present as they are installed in topological order.
1573
 
            # and the tip revision was validated by get_ancestry.
1574
 
            return required_topo_revisions
1575
 
        else:
1576
 
            # if we just grabbed the possibly available ids, then 
1577
 
            # we only have an estimate of whats available and need to validate
1578
 
            # that against the revision records.
1579
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1580
 
 
1581
 
 
1582
 
class InterModel1and2(InterRepository):
1583
 
 
1584
 
    @classmethod
1585
 
    def _get_repo_format_to_test(self):
1586
 
        return None
1587
 
 
1588
 
    @staticmethod
1589
 
    def is_compatible(source, target):
1590
 
        if not isinstance(source, Repository):
1591
 
            return False
1592
 
        if not isinstance(target, Repository):
1593
 
            return False
1594
 
        if not source._format.rich_root_data and target._format.rich_root_data:
1595
 
            return True
1596
 
        else:
1597
 
            return False
1598
 
 
1599
 
    @needs_write_lock
1600
 
    def fetch(self, revision_id=None, pb=None):
1601
 
        """See InterRepository.fetch()."""
1602
 
        from bzrlib.fetch import Model1toKnit2Fetcher
1603
 
        # TODO: jam 20070210 This should be an assert, not a translate
1604
 
        revision_id = osutils.safe_revision_id(revision_id)
1605
 
        f = Model1toKnit2Fetcher(to_repository=self.target,
1606
 
                                 from_repository=self.source,
1607
 
                                 last_revision=revision_id,
1608
 
                                 pb=pb)
1609
 
        return f.count_copied, f.failed_revisions
1610
 
 
1611
 
    @needs_write_lock
1612
 
    def copy_content(self, revision_id=None, basis=None):
1613
 
        """Make a complete copy of the content in self into destination.
1614
 
        
1615
 
        This is a destructive operation! Do not use it on existing 
1616
 
        repositories.
1617
 
 
1618
 
        :param revision_id: Only copy the content needed to construct
1619
 
                            revision_id and its parents.
1620
 
        :param basis: Copy the needed data preferentially from basis.
1621
 
        """
1622
 
        try:
1623
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1624
 
        except NotImplementedError:
1625
 
            pass
1626
 
        # TODO: jam 20070210 Internal, assert, don't translate
1627
 
        revision_id = osutils.safe_revision_id(revision_id)
1628
 
        # grab the basis available data
1629
 
        if basis is not None:
1630
 
            self.target.fetch(basis, revision_id=revision_id)
1631
 
        # but don't bother fetching if we have the needed data now.
1632
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1633
 
            self.target.has_revision(revision_id)):
1634
 
            return
1635
 
        self.target.fetch(self.source, revision_id=revision_id)
1636
 
 
1637
 
 
1638
 
class InterKnit1and2(InterKnitRepo):
1639
 
 
1640
 
    @classmethod
1641
 
    def _get_repo_format_to_test(self):
1642
 
        return None
1643
 
 
1644
 
    @staticmethod
1645
 
    def is_compatible(source, target):
1646
 
        """Be compatible with Knit1 source and Knit2 target"""
1647
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit2
1648
 
        try:
1649
 
            from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
1650
 
                    RepositoryFormatKnit2
1651
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1652
 
                    isinstance(target._format, (RepositoryFormatKnit2)))
1653
 
        except AttributeError:
1654
 
            return False
1655
 
 
1656
 
    @needs_write_lock
1657
 
    def fetch(self, revision_id=None, pb=None):
1658
 
        """See InterRepository.fetch()."""
1659
 
        from bzrlib.fetch import Knit1to2Fetcher
1660
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1661
 
               self.source, self.source._format, self.target, 
1662
 
               self.target._format)
1663
 
        # TODO: jam 20070210 This should be an assert, not a translate
1664
 
        revision_id = osutils.safe_revision_id(revision_id)
1665
 
        f = Knit1to2Fetcher(to_repository=self.target,
1666
 
                            from_repository=self.source,
1667
 
                            last_revision=revision_id,
1668
 
                            pb=pb)
1669
 
        return f.count_copied, f.failed_revisions
1670
 
 
1671
 
 
1672
 
InterRepository.register_optimiser(InterSameDataRepository)
1673
 
InterRepository.register_optimiser(InterWeaveRepo)
1674
 
InterRepository.register_optimiser(InterKnitRepo)
1675
 
InterRepository.register_optimiser(InterModel1and2)
1676
 
InterRepository.register_optimiser(InterKnit1and2)
1677
 
 
1678
 
 
1679
 
class RepositoryTestProviderAdapter(object):
1680
 
    """A tool to generate a suite testing multiple repository formats at once.
1681
 
 
1682
 
    This is done by copying the test once for each transport and injecting
1683
 
    the transport_server, transport_readonly_server, and bzrdir_format and
1684
 
    repository_format classes into each copy. Each copy is also given a new id()
1685
 
    to make it easy to identify.
1686
 
    """
1687
 
 
1688
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1689
 
        self._transport_server = transport_server
1690
 
        self._transport_readonly_server = transport_readonly_server
1691
 
        self._formats = formats
1692
 
    
1693
 
    def adapt(self, test):
1694
 
        result = unittest.TestSuite()
1695
 
        for repository_format, bzrdir_format in self._formats:
1696
 
            from copy import deepcopy
1697
 
            new_test = deepcopy(test)
1698
 
            new_test.transport_server = self._transport_server
1699
 
            new_test.transport_readonly_server = self._transport_readonly_server
1700
 
            new_test.bzrdir_format = bzrdir_format
1701
 
            new_test.repository_format = repository_format
1702
 
            def make_new_test_id():
1703
 
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
1704
 
                return lambda: new_id
1705
 
            new_test.id = make_new_test_id()
1706
 
            result.addTest(new_test)
1707
 
        return result
1708
 
 
1709
 
 
1710
 
class InterRepositoryTestProviderAdapter(object):
1711
 
    """A tool to generate a suite testing multiple inter repository formats.
1712
 
 
1713
 
    This is done by copying the test once for each interrepo provider and injecting
1714
 
    the transport_server, transport_readonly_server, repository_format and 
1715
 
    repository_to_format classes into each copy.
1716
 
    Each copy is also given a new id() to make it easy to identify.
1717
 
    """
1718
 
 
1719
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1720
 
        self._transport_server = transport_server
1721
 
        self._transport_readonly_server = transport_readonly_server
1722
 
        self._formats = formats
1723
 
    
1724
 
    def adapt(self, test):
1725
 
        result = unittest.TestSuite()
1726
 
        for interrepo_class, repository_format, repository_format_to in self._formats:
1727
 
            from copy import deepcopy
1728
 
            new_test = deepcopy(test)
1729
 
            new_test.transport_server = self._transport_server
1730
 
            new_test.transport_readonly_server = self._transport_readonly_server
1731
 
            new_test.interrepo_class = interrepo_class
1732
 
            new_test.repository_format = repository_format
1733
 
            new_test.repository_format_to = repository_format_to
1734
 
            def make_new_test_id():
1735
 
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
1736
 
                return lambda: new_id
1737
 
            new_test.id = make_new_test_id()
1738
 
            result.addTest(new_test)
1739
 
        return result
1740
 
 
1741
 
    @staticmethod
1742
 
    def default_test_list():
1743
 
        """Generate the default list of interrepo permutations to test."""
1744
 
        from bzrlib.repofmt import knitrepo, weaverepo
1745
 
        result = []
1746
 
        # test the default InterRepository between format 6 and the current 
1747
 
        # default format.
1748
 
        # XXX: robertc 20060220 reinstate this when there are two supported
1749
 
        # formats which do not have an optimal code path between them.
1750
 
        #result.append((InterRepository,
1751
 
        #               RepositoryFormat6(),
1752
 
        #               RepositoryFormatKnit1()))
1753
 
        for optimiser_class in InterRepository._optimisers:
1754
 
            format_to_test = optimiser_class._get_repo_format_to_test()
1755
 
            if format_to_test is not None:
1756
 
                result.append((optimiser_class,
1757
 
                               format_to_test, format_to_test))
1758
 
        # if there are specific combinations we want to use, we can add them 
1759
 
        # here.
1760
 
        result.append((InterModel1and2,
1761
 
                       weaverepo.RepositoryFormat5(),
1762
 
                       knitrepo.RepositoryFormatKnit2()))
1763
 
        result.append((InterKnit1and2,
1764
 
                       knitrepo.RepositoryFormatKnit1(),
1765
 
                       knitrepo.RepositoryFormatKnit2()))
1766
 
        return result
 
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
 
1683
        :return: A bzrlib.graph.SearchResult.
 
1684
        """
 
1685
        raise NotImplementedError(self.search_missing_revision_ids)
 
1686
 
 
1687
    @staticmethod
 
1688
    def _same_model(source, target):
 
1689
        """True if source and target have the same data representation.
 
1690
 
 
1691
        Note: this is always called on the base class; overriding it in a
 
1692
        subclass will have no effect.
 
1693
        """
 
1694
        try:
 
1695
            InterRepository._assert_same_model(source, target)
 
1696
            return True
 
1697
        except errors.IncompatibleRepositories, e:
 
1698
            return False
 
1699
 
 
1700
    @staticmethod
 
1701
    def _assert_same_model(source, target):
 
1702
        """Raise an exception if two repositories do not use the same model.
 
1703
        """
 
1704
        if source.supports_rich_root() != target.supports_rich_root():
 
1705
            raise errors.IncompatibleRepositories(source, target,
 
1706
                "different rich-root support")
 
1707
        if source._serializer != target._serializer:
 
1708
            raise errors.IncompatibleRepositories(source, target,
 
1709
                "different serializers")
1767
1710
 
1768
1711
 
1769
1712
class CopyConverter(object):
1770
1713
    """A repository conversion tool which just performs a copy of the content.
1771
 
    
 
1714
 
1772
1715
    This is slow but quite reliable.
1773
1716
    """
1774
1717
 
1778
1721
        :param target_format: The format the resulting repository should be.
1779
1722
        """
1780
1723
        self.target_format = target_format
1781
 
        
 
1724
 
1782
1725
    def convert(self, repo, pb):
1783
1726
        """Perform the conversion of to_convert, giving feedback via pb.
1784
1727
 
1785
1728
        :param to_convert: The disk object to convert.
1786
1729
        :param pb: a progress bar to use for progress information.
1787
1730
        """
1788
 
        self.pb = pb
 
1731
        pb = ui.ui_factory.nested_progress_bar()
1789
1732
        self.count = 0
1790
1733
        self.total = 4
1791
1734
        # this is only useful with metadir layouts - separated repo content.
1792
1735
        # trigger an assertion if not such
1793
1736
        repo._format.get_format_string()
1794
1737
        self.repo_dir = repo.bzrdir
1795
 
        self.step('Moving repository to repository.backup')
 
1738
        pb.update(gettext('Moving repository to repository.backup'))
1796
1739
        self.repo_dir.transport.move('repository', 'repository.backup')
1797
1740
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1798
1741
        repo._format.check_conversion_target(self.target_format)
1799
1742
        self.source_repo = repo._format.open(self.repo_dir,
1800
1743
            _found=True,
1801
1744
            _override_transport=backup_transport)
1802
 
        self.step('Creating new repository')
 
1745
        pb.update(gettext('Creating new repository'))
1803
1746
        converted = self.target_format.initialize(self.repo_dir,
1804
1747
                                                  self.source_repo.is_shared())
1805
1748
        converted.lock_write()
1806
1749
        try:
1807
 
            self.step('Copying content into repository.')
 
1750
            pb.update(gettext('Copying content'))
1808
1751
            self.source_repo.copy_content_into(converted)
1809
1752
        finally:
1810
1753
            converted.unlock()
1811
 
        self.step('Deleting old repository content.')
 
1754
        pb.update(gettext('Deleting old repository content'))
1812
1755
        self.repo_dir.transport.delete_tree('repository.backup')
1813
 
        self.pb.note('repository converted')
1814
 
 
1815
 
    def step(self, message):
1816
 
        """Update the pb by a step."""
1817
 
        self.count +=1
1818
 
        self.pb.update(message, self.count, self.total)
1819
 
 
1820
 
 
1821
 
class CommitBuilder(object):
1822
 
    """Provides an interface to build up a commit.
1823
 
 
1824
 
    This allows describing a tree to be committed without needing to 
1825
 
    know the internals of the format of the repository.
1826
 
    """
1827
 
    
1828
 
    record_root_entry = False
1829
 
    def __init__(self, repository, parents, config, timestamp=None, 
1830
 
                 timezone=None, committer=None, revprops=None, 
1831
 
                 revision_id=None):
1832
 
        """Initiate a CommitBuilder.
1833
 
 
1834
 
        :param repository: Repository to commit to.
1835
 
        :param parents: Revision ids of the parents of the new revision.
1836
 
        :param config: Configuration to use.
1837
 
        :param timestamp: Optional timestamp recorded for commit.
1838
 
        :param timezone: Optional timezone for timestamp.
1839
 
        :param committer: Optional committer to set for commit.
1840
 
        :param revprops: Optional dictionary of revision properties.
1841
 
        :param revision_id: Optional revision id.
1842
 
        """
1843
 
        self._config = config
1844
 
 
1845
 
        if committer is None:
1846
 
            self._committer = self._config.username()
1847
 
        else:
1848
 
            assert isinstance(committer, basestring), type(committer)
1849
 
            self._committer = committer
1850
 
 
1851
 
        self.new_inventory = Inventory(None)
1852
 
        self._new_revision_id = osutils.safe_revision_id(revision_id)
1853
 
        self.parents = parents
1854
 
        self.repository = repository
1855
 
 
1856
 
        self._revprops = {}
1857
 
        if revprops is not None:
1858
 
            self._revprops.update(revprops)
1859
 
 
1860
 
        if timestamp is None:
1861
 
            timestamp = time.time()
1862
 
        # Restrict resolution to 1ms
1863
 
        self._timestamp = round(timestamp, 3)
1864
 
 
1865
 
        if timezone is None:
1866
 
            self._timezone = osutils.local_time_offset()
1867
 
        else:
1868
 
            self._timezone = int(timezone)
1869
 
 
1870
 
        self._generate_revision_if_needed()
1871
 
 
1872
 
    def commit(self, message):
1873
 
        """Make the actual commit.
1874
 
 
1875
 
        :return: The revision id of the recorded revision.
1876
 
        """
1877
 
        rev = _mod_revision.Revision(
1878
 
                       timestamp=self._timestamp,
1879
 
                       timezone=self._timezone,
1880
 
                       committer=self._committer,
1881
 
                       message=message,
1882
 
                       inventory_sha1=self.inv_sha1,
1883
 
                       revision_id=self._new_revision_id,
1884
 
                       properties=self._revprops)
1885
 
        rev.parent_ids = self.parents
1886
 
        self.repository.add_revision(self._new_revision_id, rev, 
1887
 
            self.new_inventory, self._config)
1888
 
        return self._new_revision_id
1889
 
 
1890
 
    def revision_tree(self):
1891
 
        """Return the tree that was just committed.
1892
 
 
1893
 
        After calling commit() this can be called to get a RevisionTree
1894
 
        representing the newly committed tree. This is preferred to
1895
 
        calling Repository.revision_tree() because that may require
1896
 
        deserializing the inventory, while we already have a copy in
1897
 
        memory.
1898
 
        """
1899
 
        return RevisionTree(self.repository, self.new_inventory,
1900
 
                            self._new_revision_id)
1901
 
 
1902
 
    def finish_inventory(self):
1903
 
        """Tell the builder that the inventory is finished."""
1904
 
        if self.new_inventory.root is None:
1905
 
            symbol_versioning.warn('Root entry should be supplied to'
1906
 
                ' record_entry_contents, as of bzr 0.10.',
1907
 
                 DeprecationWarning, stacklevel=2)
1908
 
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
1909
 
        self.new_inventory.revision_id = self._new_revision_id
1910
 
        self.inv_sha1 = self.repository.add_inventory(
1911
 
            self._new_revision_id,
1912
 
            self.new_inventory,
1913
 
            self.parents
1914
 
            )
1915
 
 
1916
 
    def _gen_revision_id(self):
1917
 
        """Return new revision-id."""
1918
 
        return generate_ids.gen_revision_id(self._config.username(),
1919
 
                                            self._timestamp)
1920
 
 
1921
 
    def _generate_revision_if_needed(self):
1922
 
        """Create a revision id if None was supplied.
1923
 
        
1924
 
        If the repository can not support user-specified revision ids
1925
 
        they should override this function and raise CannotSetRevisionId
1926
 
        if _new_revision_id is not None.
1927
 
 
1928
 
        :raises: CannotSetRevisionId
1929
 
        """
1930
 
        if self._new_revision_id is None:
1931
 
            self._new_revision_id = self._gen_revision_id()
1932
 
 
1933
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
1934
 
        """Record the content of ie from tree into the commit if needed.
1935
 
 
1936
 
        Side effect: sets ie.revision when unchanged
1937
 
 
1938
 
        :param ie: An inventory entry present in the commit.
1939
 
        :param parent_invs: The inventories of the parent revisions of the
1940
 
            commit.
1941
 
        :param path: The path the entry is at in the tree.
1942
 
        :param tree: The tree which contains this entry and should be used to 
1943
 
        obtain content.
1944
 
        """
1945
 
        if self.new_inventory.root is None and ie.parent_id is not None:
1946
 
            symbol_versioning.warn('Root entry should be supplied to'
1947
 
                ' record_entry_contents, as of bzr 0.10.',
1948
 
                 DeprecationWarning, stacklevel=2)
1949
 
            self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
1950
 
                                       '', tree)
1951
 
        self.new_inventory.add(ie)
1952
 
 
1953
 
        # ie.revision is always None if the InventoryEntry is considered
1954
 
        # for committing. ie.snapshot will record the correct revision 
1955
 
        # which may be the sole parent if it is untouched.
1956
 
        if ie.revision is not None:
1957
 
            return
1958
 
 
1959
 
        # In this revision format, root entries have no knit or weave
1960
 
        if ie is self.new_inventory.root:
1961
 
            # When serializing out to disk and back in
1962
 
            # root.revision is always _new_revision_id
1963
 
            ie.revision = self._new_revision_id
1964
 
            return
1965
 
        previous_entries = ie.find_previous_heads(
1966
 
            parent_invs,
1967
 
            self.repository.weave_store,
1968
 
            self.repository.get_transaction())
1969
 
        # we are creating a new revision for ie in the history store
1970
 
        # and inventory.
1971
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
1972
 
 
1973
 
    def modified_directory(self, file_id, file_parents):
1974
 
        """Record the presence of a symbolic link.
1975
 
 
1976
 
        :param file_id: The file_id of the link to record.
1977
 
        :param file_parents: The per-file parent revision ids.
1978
 
        """
1979
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
1980
 
    
1981
 
    def modified_file_text(self, file_id, file_parents,
1982
 
                           get_content_byte_lines, text_sha1=None,
1983
 
                           text_size=None):
1984
 
        """Record the text of file file_id
1985
 
 
1986
 
        :param file_id: The file_id of the file to record the text of.
1987
 
        :param file_parents: The per-file parent revision ids.
1988
 
        :param get_content_byte_lines: A callable which will return the byte
1989
 
            lines for the file.
1990
 
        :param text_sha1: Optional SHA1 of the file contents.
1991
 
        :param text_size: Optional size of the file contents.
1992
 
        """
1993
 
        # mutter('storing text of file {%s} in revision {%s} into %r',
1994
 
        #        file_id, self._new_revision_id, self.repository.weave_store)
1995
 
        # special case to avoid diffing on renames or 
1996
 
        # reparenting
1997
 
        if (len(file_parents) == 1
1998
 
            and text_sha1 == file_parents.values()[0].text_sha1
1999
 
            and text_size == file_parents.values()[0].text_size):
2000
 
            previous_ie = file_parents.values()[0]
2001
 
            versionedfile = self.repository.weave_store.get_weave(file_id, 
2002
 
                self.repository.get_transaction())
2003
 
            versionedfile.clone_text(self._new_revision_id, 
2004
 
                previous_ie.revision, file_parents.keys())
2005
 
            return text_sha1, text_size
2006
 
        else:
2007
 
            new_lines = get_content_byte_lines()
2008
 
            # TODO: Rather than invoking sha_strings here, _add_text_to_weave
2009
 
            # should return the SHA1 and size
2010
 
            self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2011
 
            return osutils.sha_strings(new_lines), \
2012
 
                sum(map(len, new_lines))
2013
 
 
2014
 
    def modified_link(self, file_id, file_parents, link_target):
2015
 
        """Record the presence of a symbolic link.
2016
 
 
2017
 
        :param file_id: The file_id of the link to record.
2018
 
        :param file_parents: The per-file parent revision ids.
2019
 
        :param link_target: Target location of this link.
2020
 
        """
2021
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2022
 
 
2023
 
    def _add_text_to_weave(self, file_id, new_lines, parents):
2024
 
        versionedfile = self.repository.weave_store.get_weave_or_empty(
2025
 
            file_id, self.repository.get_transaction())
2026
 
        versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2027
 
        versionedfile.clear_cache()
2028
 
 
2029
 
 
2030
 
class _CommitBuilder(CommitBuilder):
2031
 
    """Temporary class so old CommitBuilders are detected properly
2032
 
    
2033
 
    Note: CommitBuilder works whether or not root entry is recorded.
2034
 
    """
2035
 
 
2036
 
    record_root_entry = True
2037
 
 
2038
 
 
2039
 
class RootCommitBuilder(CommitBuilder):
2040
 
    """This commitbuilder actually records the root id"""
2041
 
    
2042
 
    record_root_entry = True
2043
 
 
2044
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2045
 
        """Record the content of ie from tree into the commit if needed.
2046
 
 
2047
 
        Side effect: sets ie.revision when unchanged
2048
 
 
2049
 
        :param ie: An inventory entry present in the commit.
2050
 
        :param parent_invs: The inventories of the parent revisions of the
2051
 
            commit.
2052
 
        :param path: The path the entry is at in the tree.
2053
 
        :param tree: The tree which contains this entry and should be used to 
2054
 
        obtain content.
2055
 
        """
2056
 
        assert self.new_inventory.root is not None or ie.parent_id is None
2057
 
        self.new_inventory.add(ie)
2058
 
 
2059
 
        # ie.revision is always None if the InventoryEntry is considered
2060
 
        # for committing. ie.snapshot will record the correct revision 
2061
 
        # which may be the sole parent if it is untouched.
2062
 
        if ie.revision is not None:
2063
 
            return
2064
 
 
2065
 
        previous_entries = ie.find_previous_heads(
2066
 
            parent_invs,
2067
 
            self.repository.weave_store,
2068
 
            self.repository.get_transaction())
2069
 
        # we are creating a new revision for ie in the history store
2070
 
        # and inventory.
2071
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2072
 
 
2073
 
 
2074
 
_unescape_map = {
2075
 
    'apos':"'",
2076
 
    'quot':'"',
2077
 
    'amp':'&',
2078
 
    'lt':'<',
2079
 
    'gt':'>'
2080
 
}
2081
 
 
2082
 
 
2083
 
def _unescaper(match, _map=_unescape_map):
2084
 
    code = match.group(1)
 
1756
        ui.ui_factory.note(gettext('repository converted'))
 
1757
        pb.finished()
 
1758
 
 
1759
 
 
1760
def _strip_NULL_ghosts(revision_graph):
 
1761
    """Also don't use this. more compatibility code for unmigrated clients."""
 
1762
    # Filter ghosts, and null:
 
1763
    if _mod_revision.NULL_REVISION in revision_graph:
 
1764
        del revision_graph[_mod_revision.NULL_REVISION]
 
1765
    for key, parents in revision_graph.items():
 
1766
        revision_graph[key] = tuple(parent for parent in parents if parent
 
1767
            in revision_graph)
 
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,))
2085
1789
    try:
2086
 
        return _map[code]
2087
 
    except KeyError:
2088
 
        if not code.startswith('#'):
2089
 
            raise
2090
 
        return unichr(int(code[1:])).encode('utf8')
2091
 
 
2092
 
 
2093
 
_unescape_re = None
2094
 
 
2095
 
 
2096
 
def _unescape_xml(data):
2097
 
    """Unescape predefined XML entities in a string of data."""
2098
 
    global _unescape_re
2099
 
    if _unescape_re is None:
2100
 
        _unescape_re = re.compile('\&([^;]*);')
2101
 
    return _unescape_re.sub(_unescaper, data)
 
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)