/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/repository.py

  • Committer: Jelmer Vernooij
  • Date: 2020-01-12 13:56:10 UTC
  • mto: This revision was merged to the branch mainline in revision 7443.
  • Revision ID: jelmer@jelmer.uk-20200112135610-0a9bct6x4cw7he6y
Add strip_segment_parameters function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
from .lazy_import import lazy_import
 
20
lazy_import(globals(), """
 
21
import time
 
22
 
 
23
from breezy import (
 
24
    config,
 
25
    controldir,
 
26
    debug,
 
27
    graph,
 
28
    osutils,
 
29
    revision as _mod_revision,
 
30
    gpg,
 
31
    )
 
32
from breezy.i18n import gettext
 
33
""")
 
34
 
 
35
from . import (
 
36
    errors,
 
37
    registry,
 
38
    ui,
 
39
    )
 
40
from .decorators import only_raises
 
41
from .inter import InterObject
 
42
from .lock import _RelockDebugMixin, LogicalLockResult
 
43
from .sixish import (
 
44
    text_type,
 
45
    viewitems,
 
46
    )
 
47
from .trace import (
 
48
    log_exception_quietly, note, mutter, mutter_callsite, warning)
 
49
 
 
50
 
 
51
# Old formats display a warning, but only once
 
52
_deprecation_warning_done = False
 
53
 
 
54
 
 
55
class IsInWriteGroupError(errors.InternalBzrError):
 
56
 
 
57
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
 
58
 
 
59
    def __init__(self, repo):
 
60
        errors.InternalBzrError.__init__(self, repo=repo)
 
61
 
 
62
 
 
63
class CannotSetRevisionId(errors.BzrError):
 
64
 
 
65
    _fmt = "Repository format does not support setting revision ids."
 
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 will automatically update the branch that is
 
78
    # being committed to
 
79
    updates_branch = False
 
80
 
 
81
    def __init__(self, repository, parents, config_stack, timestamp=None,
 
82
                 timezone=None, committer=None, revprops=None,
 
83
                 revision_id=None, lossy=False):
 
84
        """Initiate a CommitBuilder.
 
85
 
 
86
        :param repository: Repository to commit to.
 
87
        :param parents: Revision ids of the parents of the new revision.
 
88
        :param timestamp: Optional timestamp recorded for commit.
 
89
        :param timezone: Optional timezone for timestamp.
 
90
        :param committer: Optional committer to set for commit.
 
91
        :param revprops: Optional dictionary of revision properties.
 
92
        :param revision_id: Optional revision id.
 
93
        :param lossy: Whether to discard data that can not be natively
 
94
            represented, when pushing to a foreign VCS
 
95
        """
 
96
        self._config_stack = config_stack
 
97
        self._lossy = lossy
 
98
 
 
99
        if committer is None:
 
100
            self._committer = self._config_stack.get('email')
 
101
        elif not isinstance(committer, text_type):
 
102
            self._committer = committer.decode()  # throw if non-ascii
 
103
        else:
 
104
            self._committer = committer
 
105
 
 
106
        self.parents = parents
 
107
        self.repository = repository
 
108
 
 
109
        self._revprops = {}
 
110
        if revprops is not None:
 
111
            self._validate_revprops(revprops)
 
112
            self._revprops.update(revprops)
 
113
 
 
114
        if timestamp is None:
 
115
            timestamp = time.time()
 
116
        # Restrict resolution to 1ms
 
117
        self._timestamp = round(timestamp, 3)
 
118
 
 
119
        if timezone is None:
 
120
            self._timezone = osutils.local_time_offset()
 
121
        else:
 
122
            self._timezone = int(timezone)
 
123
 
 
124
        self._generate_revision_if_needed(revision_id)
 
125
 
 
126
    def any_changes(self):
 
127
        """Return True if any entries were changed.
 
128
 
 
129
        This includes merge-only changes. It is the core for the --unchanged
 
130
        detection in commit.
 
131
 
 
132
        :return: True if any changes have occured.
 
133
        """
 
134
        raise NotImplementedError(self.any_changes)
 
135
 
 
136
    def _validate_unicode_text(self, text, context):
 
137
        """Verify things like commit messages don't have bogus characters."""
 
138
        # TODO(jelmer): Make this repository-format specific
 
139
        if u'\r' in text:
 
140
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
141
 
 
142
    def _validate_revprops(self, revprops):
 
143
        for key, value in viewitems(revprops):
 
144
            # We know that the XML serializers do not round trip '\r'
 
145
            # correctly, so refuse to accept them
 
146
            if not isinstance(value, (text_type, str)):
 
147
                raise ValueError('revision property (%s) is not a valid'
 
148
                                 ' (unicode) string: %r' % (key, value))
 
149
            # TODO(jelmer): Make this repository-format specific
 
150
            self._validate_unicode_text(value,
 
151
                                        'revision property (%s)' % (key,))
 
152
 
 
153
    def commit(self, message):
 
154
        """Make the actual commit.
 
155
 
 
156
        :return: The revision id of the recorded revision.
 
157
        """
 
158
        raise NotImplementedError(self.commit)
 
159
 
 
160
    def abort(self):
 
161
        """Abort the commit that is being built.
 
162
        """
 
163
        raise NotImplementedError(self.abort)
 
164
 
 
165
    def revision_tree(self):
 
166
        """Return the tree that was just committed.
 
167
 
 
168
        After calling commit() this can be called to get a
 
169
        RevisionTree representing the newly committed tree. This is
 
170
        preferred to calling Repository.revision_tree() because that may
 
171
        require deserializing the inventory, while we already have a copy in
 
172
        memory.
 
173
        """
 
174
        raise NotImplementedError(self.revision_tree)
 
175
 
 
176
    def finish_inventory(self):
 
177
        """Tell the builder that the inventory is finished.
 
178
 
 
179
        :return: The inventory id in the repository, which can be used with
 
180
            repository.get_inventory.
 
181
        """
 
182
        raise NotImplementedError(self.finish_inventory)
 
183
 
 
184
    def _generate_revision_if_needed(self, revision_id):
 
185
        """Create a revision id if None was supplied.
 
186
 
 
187
        If the repository can not support user-specified revision ids
 
188
        they should override this function and raise CannotSetRevisionId
 
189
        if _new_revision_id is not None.
 
190
 
 
191
        :raises: CannotSetRevisionId
 
192
        """
 
193
        if not self.repository._format.supports_setting_revision_ids:
 
194
            if revision_id is not None:
 
195
                raise CannotSetRevisionId()
 
196
            return
 
197
        if revision_id is None:
 
198
            self._new_revision_id = self._gen_revision_id()
 
199
            self.random_revid = True
 
200
        else:
 
201
            self._new_revision_id = revision_id
 
202
            self.random_revid = False
 
203
 
 
204
    def record_iter_changes(self, tree, basis_revision_id, iter_changes):
 
205
        """Record a new tree via iter_changes.
 
206
 
 
207
        :param tree: The tree to obtain text contents from for changed objects.
 
208
        :param basis_revision_id: The revision id of the tree the iter_changes
 
209
            has been generated against. Currently assumed to be the same
 
210
            as self.parents[0] - if it is not, errors may occur.
 
211
        :param iter_changes: An iter_changes iterator with the changes to apply
 
212
            to basis_revision_id. The iterator must not include any items with
 
213
            a current kind of None - missing items must be either filtered out
 
214
            or errored-on beefore record_iter_changes sees the item.
 
215
        :return: A generator of (relpath, fs_hash) tuples for use with
 
216
            tree._observed_sha1.
 
217
        """
 
218
        raise NotImplementedError(self.record_iter_changes)
 
219
 
 
220
 
 
221
class RepositoryWriteLockResult(LogicalLockResult):
 
222
    """The result of write locking a repository.
 
223
 
 
224
    :ivar repository_token: The token obtained from the underlying lock, or
 
225
        None.
 
226
    :ivar unlock: A callable which will unlock the lock.
 
227
    """
 
228
 
 
229
    def __init__(self, unlock, repository_token):
 
230
        LogicalLockResult.__init__(self, unlock)
 
231
        self.repository_token = repository_token
 
232
 
 
233
    def __repr__(self):
 
234
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
 
235
                                                      self.unlock)
 
236
 
 
237
 
 
238
class WriteGroup(object):
 
239
    """Context manager that manages a write group.
 
240
 
 
241
    Raising an exception will result in the write group being aborted.
 
242
    """
 
243
 
 
244
    def __init__(self, repository, suppress_errors=False):
 
245
        self.repository = repository
 
246
        self._suppress_errors = suppress_errors
 
247
 
 
248
    def __enter__(self):
 
249
        self.repository.start_write_group()
 
250
        return self
 
251
 
 
252
    def __exit__(self, exc_type, exc_val, exc_tb):
 
253
        if exc_type:
 
254
            self.repository.abort_write_group(self._suppress_errors)
 
255
            return False
 
256
        else:
 
257
            self.repository.commit_write_group()
 
258
 
 
259
 
 
260
######################################################################
 
261
# Repositories
 
262
 
 
263
 
 
264
class Repository(controldir.ControlComponent, _RelockDebugMixin):
 
265
    """Repository holding history for one or more branches.
 
266
 
 
267
    The repository holds and retrieves historical information including
 
268
    revisions and file history.  It's normally accessed only by the Branch,
 
269
    which views a particular line of development through that history.
 
270
 
 
271
    See VersionedFileRepository in breezy.vf_repository for the
 
272
    base class for most Bazaar repositories.
 
273
    """
 
274
 
 
275
    # Does this repository implementation support random access to
 
276
    # items in the tree, or just bulk fetching/pushing of data?
 
277
    supports_random_access = True
 
278
 
 
279
    def abort_write_group(self, suppress_errors=False):
 
280
        """Commit the contents accrued within the current write group.
 
281
 
 
282
        :param suppress_errors: if true, abort_write_group will catch and log
 
283
            unexpected errors that happen during the abort, rather than
 
284
            allowing them to propagate.  Defaults to False.
 
285
 
 
286
        :seealso: start_write_group.
 
287
        """
 
288
        if self._write_group is not self.get_transaction():
 
289
            # has an unlock or relock occured ?
 
290
            if suppress_errors:
 
291
                mutter(
 
292
                    '(suppressed) mismatched lock context and write group. %r, %r',
 
293
                    self._write_group, self.get_transaction())
 
294
                return
 
295
            raise errors.BzrError(
 
296
                'mismatched lock context and write group. %r, %r' %
 
297
                (self._write_group, self.get_transaction()))
 
298
        try:
 
299
            self._abort_write_group()
 
300
        except Exception as exc:
 
301
            self._write_group = None
 
302
            if not suppress_errors:
 
303
                raise
 
304
            mutter('abort_write_group failed')
 
305
            log_exception_quietly()
 
306
            note(gettext('brz: ERROR (ignored): %s'), exc)
 
307
        self._write_group = None
 
308
 
 
309
    def _abort_write_group(self):
 
310
        """Template method for per-repository write group cleanup.
 
311
 
 
312
        This is called during abort before the write group is considered to be
 
313
        finished and should cleanup any internal state accrued during the write
 
314
        group. There is no requirement that data handed to the repository be
 
315
        *not* made available - this is not a rollback - but neither should any
 
316
        attempt be made to ensure that data added is fully commited. Abort is
 
317
        invoked when an error has occured so futher disk or network operations
 
318
        may not be possible or may error and if possible should not be
 
319
        attempted.
 
320
        """
 
321
 
 
322
    def add_fallback_repository(self, repository):
 
323
        """Add a repository to use for looking up data not held locally.
 
324
 
 
325
        :param repository: A repository.
 
326
        """
 
327
        raise NotImplementedError(self.add_fallback_repository)
 
328
 
 
329
    def _check_fallback_repository(self, repository):
 
330
        """Check that this repository can fallback to repository safely.
 
331
 
 
332
        Raise an error if not.
 
333
 
 
334
        :param repository: A repository to fallback to.
 
335
        """
 
336
        return InterRepository._assert_same_model(self, repository)
 
337
 
 
338
    def all_revision_ids(self):
 
339
        """Returns a list of all the revision ids in the repository.
 
340
 
 
341
        This is conceptually deprecated because code should generally work on
 
342
        the graph reachable from a particular revision, and ignore any other
 
343
        revisions that might be present.  There is no direct replacement
 
344
        method.
 
345
        """
 
346
        if 'evil' in debug.debug_flags:
 
347
            mutter_callsite(2, "all_revision_ids is linear with history.")
 
348
        return self._all_revision_ids()
 
349
 
 
350
    def _all_revision_ids(self):
 
351
        """Returns a list of all the revision ids in the repository.
 
352
 
 
353
        These are in as much topological order as the underlying store can
 
354
        present.
 
355
        """
 
356
        raise NotImplementedError(self._all_revision_ids)
 
357
 
 
358
    def break_lock(self):
 
359
        """Break a lock if one is present from another instance.
 
360
 
 
361
        Uses the ui factory to ask for confirmation if the lock may be from
 
362
        an active process.
 
363
        """
 
364
        self.control_files.break_lock()
 
365
 
 
366
    @staticmethod
 
367
    def create(controldir):
 
368
        """Construct the current default format repository in controldir."""
 
369
        return RepositoryFormat.get_default_format().initialize(controldir)
 
370
 
 
371
    def __init__(self, _format, controldir, control_files):
 
372
        """instantiate a Repository.
 
373
 
 
374
        :param _format: The format of the repository on disk.
 
375
        :param controldir: The ControlDir of the repository.
 
376
        :param control_files: Control files to use for locking, etc.
 
377
        """
 
378
        # In the future we will have a single api for all stores for
 
379
        # getting file texts, inventories and revisions, then
 
380
        # this construct will accept instances of those things.
 
381
        super(Repository, self).__init__()
 
382
        self._format = _format
 
383
        # the following are part of the public API for Repository:
 
384
        self.controldir = controldir
 
385
        self.control_files = control_files
 
386
        # for tests
 
387
        self._write_group = None
 
388
        # Additional places to query for data.
 
389
        self._fallback_repositories = []
 
390
 
 
391
    @property
 
392
    def user_transport(self):
 
393
        return self.controldir.user_transport
 
394
 
 
395
    @property
 
396
    def control_transport(self):
 
397
        return self._transport
 
398
 
 
399
    def __repr__(self):
 
400
        if self._fallback_repositories:
 
401
            return '%s(%r, fallback_repositories=%r)' % (
 
402
                self.__class__.__name__,
 
403
                self.base,
 
404
                self._fallback_repositories)
 
405
        else:
 
406
            return '%s(%r)' % (self.__class__.__name__,
 
407
                               self.base)
 
408
 
 
409
    def _has_same_fallbacks(self, other_repo):
 
410
        """Returns true if the repositories have the same fallbacks."""
 
411
        my_fb = self._fallback_repositories
 
412
        other_fb = other_repo._fallback_repositories
 
413
        if len(my_fb) != len(other_fb):
 
414
            return False
 
415
        for f, g in zip(my_fb, other_fb):
 
416
            if not f.has_same_location(g):
 
417
                return False
 
418
        return True
 
419
 
 
420
    def has_same_location(self, other):
 
421
        """Returns a boolean indicating if this repository is at the same
 
422
        location as another repository.
 
423
 
 
424
        This might return False even when two repository objects are accessing
 
425
        the same physical repository via different URLs.
 
426
        """
 
427
        if self.__class__ is not other.__class__:
 
428
            return False
 
429
        return (self.control_url == other.control_url)
 
430
 
 
431
    def is_in_write_group(self):
 
432
        """Return True if there is an open write group.
 
433
 
 
434
        :seealso: start_write_group.
 
435
        """
 
436
        return self._write_group is not None
 
437
 
 
438
    def is_locked(self):
 
439
        return self.control_files.is_locked()
 
440
 
 
441
    def is_write_locked(self):
 
442
        """Return True if this object is write locked."""
 
443
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
444
 
 
445
    def lock_write(self, token=None):
 
446
        """Lock this repository for writing.
 
447
 
 
448
        This causes caching within the repository obejct to start accumlating
 
449
        data during reads, and allows a 'write_group' to be obtained. Write
 
450
        groups must be used for actual data insertion.
 
451
 
 
452
        A token should be passed in if you know that you have locked the object
 
453
        some other way, and need to synchronise this object's state with that
 
454
        fact.
 
455
 
 
456
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
457
 
 
458
        :param token: if this is already locked, then lock_write will fail
 
459
            unless the token matches the existing lock.
 
460
        :returns: a token if this instance supports tokens, otherwise None.
 
461
        :raises TokenLockingNotSupported: when a token is given but this
 
462
            instance doesn't support using token locks.
 
463
        :raises MismatchedToken: if the specified token doesn't match the token
 
464
            of the existing lock.
 
465
        :seealso: start_write_group.
 
466
        :return: A RepositoryWriteLockResult.
 
467
        """
 
468
        locked = self.is_locked()
 
469
        token = self.control_files.lock_write(token=token)
 
470
        if not locked:
 
471
            self._warn_if_deprecated()
 
472
            self._note_lock('w')
 
473
            for repo in self._fallback_repositories:
 
474
                # Writes don't affect fallback repos
 
475
                repo.lock_read()
 
476
            self._refresh_data()
 
477
        return RepositoryWriteLockResult(self.unlock, token)
 
478
 
 
479
    def lock_read(self):
 
480
        """Lock the repository for read operations.
 
481
 
 
482
        :return: An object with an unlock method which will release the lock
 
483
            obtained.
 
484
        """
 
485
        locked = self.is_locked()
 
486
        self.control_files.lock_read()
 
487
        if not locked:
 
488
            self._warn_if_deprecated()
 
489
            self._note_lock('r')
 
490
            for repo in self._fallback_repositories:
 
491
                repo.lock_read()
 
492
            self._refresh_data()
 
493
        return LogicalLockResult(self.unlock)
 
494
 
 
495
    def get_physical_lock_status(self):
 
496
        return self.control_files.get_physical_lock_status()
 
497
 
 
498
    def leave_lock_in_place(self):
 
499
        """Tell this repository not to release the physical lock when this
 
500
        object is unlocked.
 
501
 
 
502
        If lock_write doesn't return a token, then this method is not supported.
 
503
        """
 
504
        self.control_files.leave_in_place()
 
505
 
 
506
    def dont_leave_lock_in_place(self):
 
507
        """Tell this repository to release the physical lock when this
 
508
        object is unlocked, even if it didn't originally acquire it.
 
509
 
 
510
        If lock_write doesn't return a token, then this method is not supported.
 
511
        """
 
512
        self.control_files.dont_leave_in_place()
 
513
 
 
514
    def gather_stats(self, revid=None, committers=None):
 
515
        """Gather statistics from a revision id.
 
516
 
 
517
        :param revid: The revision id to gather statistics from, if None, then
 
518
            no revision specific statistics are gathered.
 
519
        :param committers: Optional parameter controlling whether to grab
 
520
            a count of committers from the revision specific statistics.
 
521
        :return: A dictionary of statistics. Currently this contains:
 
522
            committers: The number of committers if requested.
 
523
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
524
                most ancestor of revid, if revid is not the NULL_REVISION.
 
525
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
526
                not the NULL_REVISION.
 
527
            revisions: The total revision count in the repository.
 
528
            size: An estimate disk size of the repository in bytes.
 
529
        """
 
530
        with self.lock_read():
 
531
            result = {}
 
532
            if revid and committers:
 
533
                result['committers'] = 0
 
534
            if revid and revid != _mod_revision.NULL_REVISION:
 
535
                graph = self.get_graph()
 
536
                if committers:
 
537
                    all_committers = set()
 
538
                revisions = [r for (r, p) in graph.iter_ancestry([revid])
 
539
                             if r != _mod_revision.NULL_REVISION]
 
540
                last_revision = None
 
541
                if not committers:
 
542
                    # ignore the revisions in the middle - just grab first and last
 
543
                    revisions = revisions[0], revisions[-1]
 
544
                for revision in self.get_revisions(revisions):
 
545
                    if not last_revision:
 
546
                        last_revision = revision
 
547
                    if committers:
 
548
                        all_committers.add(revision.committer)
 
549
                first_revision = revision
 
550
                if committers:
 
551
                    result['committers'] = len(all_committers)
 
552
                result['firstrev'] = (first_revision.timestamp,
 
553
                                      first_revision.timezone)
 
554
                result['latestrev'] = (last_revision.timestamp,
 
555
                                       last_revision.timezone)
 
556
            return result
 
557
 
 
558
    def find_branches(self, using=False):
 
559
        """Find branches underneath this repository.
 
560
 
 
561
        This will include branches inside other branches.
 
562
 
 
563
        :param using: If True, list only branches using this repository.
 
564
        """
 
565
        if using and not self.is_shared():
 
566
            for branch in self.controldir.list_branches():
 
567
                yield branch
 
568
            return
 
569
 
 
570
        class Evaluator(object):
 
571
 
 
572
            def __init__(self):
 
573
                self.first_call = True
 
574
 
 
575
            def __call__(self, controldir):
 
576
                # On the first call, the parameter is always the controldir
 
577
                # containing the current repo.
 
578
                if not self.first_call:
 
579
                    try:
 
580
                        repository = controldir.open_repository()
 
581
                    except errors.NoRepositoryPresent:
 
582
                        pass
 
583
                    else:
 
584
                        return False, ([], repository)
 
585
                self.first_call = False
 
586
                value = (controldir.list_branches(), None)
 
587
                return True, value
 
588
 
 
589
        for branches, repository in controldir.ControlDir.find_controldirs(
 
590
                self.user_transport, evaluate=Evaluator()):
 
591
            if branches is not None:
 
592
                for branch in branches:
 
593
                    yield branch
 
594
            if not using and repository is not None:
 
595
                for branch in repository.find_branches():
 
596
                    yield branch
 
597
 
 
598
    def search_missing_revision_ids(self, other,
 
599
                                    find_ghosts=True, revision_ids=None, if_present_ids=None,
 
600
                                    limit=None):
 
601
        """Return the revision ids that other has that this does not.
 
602
 
 
603
        These are returned in topological order.
 
604
 
 
605
        revision_ids: only return revision ids included by revision_id.
 
606
        """
 
607
        with self.lock_read():
 
608
            return InterRepository.get(other, self).search_missing_revision_ids(
 
609
                find_ghosts=find_ghosts, revision_ids=revision_ids,
 
610
                if_present_ids=if_present_ids, limit=limit)
 
611
 
 
612
    @staticmethod
 
613
    def open(base):
 
614
        """Open the repository rooted at base.
 
615
 
 
616
        For instance, if the repository is at URL/.bzr/repository,
 
617
        Repository.open(URL) -> a Repository instance.
 
618
        """
 
619
        control = controldir.ControlDir.open(base)
 
620
        return control.open_repository()
 
621
 
 
622
    def copy_content_into(self, destination, revision_id=None):
 
623
        """Make a complete copy of the content in self into destination.
 
624
 
 
625
        This is a destructive operation! Do not use it on existing
 
626
        repositories.
 
627
        """
 
628
        return InterRepository.get(self, destination).copy_content(revision_id)
 
629
 
 
630
    def commit_write_group(self):
 
631
        """Commit the contents accrued within the current write group.
 
632
 
 
633
        :seealso: start_write_group.
 
634
 
 
635
        :return: it may return an opaque hint that can be passed to 'pack'.
 
636
        """
 
637
        if self._write_group is not self.get_transaction():
 
638
            # has an unlock or relock occured ?
 
639
            raise errors.BzrError('mismatched lock context %r and '
 
640
                                  'write group %r.' %
 
641
                                  (self.get_transaction(), self._write_group))
 
642
        result = self._commit_write_group()
 
643
        self._write_group = None
 
644
        return result
 
645
 
 
646
    def _commit_write_group(self):
 
647
        """Template method for per-repository write group cleanup.
 
648
 
 
649
        This is called before the write group is considered to be
 
650
        finished and should ensure that all data handed to the repository
 
651
        for writing during the write group is safely committed (to the
 
652
        extent possible considering file system caching etc).
 
653
        """
 
654
 
 
655
    def suspend_write_group(self):
 
656
        """Suspend a write group.
 
657
 
 
658
        :raise UnsuspendableWriteGroup: If the write group can not be
 
659
            suspended.
 
660
        :return: List of tokens
 
661
        """
 
662
        raise errors.UnsuspendableWriteGroup(self)
 
663
 
 
664
    def refresh_data(self):
 
665
        """Re-read any data needed to synchronise with disk.
 
666
 
 
667
        This method is intended to be called after another repository instance
 
668
        (such as one used by a smart server) has inserted data into the
 
669
        repository. On all repositories this will work outside of write groups.
 
670
        Some repository formats (pack and newer for breezy native formats)
 
671
        support refresh_data inside write groups. If called inside a write
 
672
        group on a repository that does not support refreshing in a write group
 
673
        IsInWriteGroupError will be raised.
 
674
        """
 
675
        self._refresh_data()
 
676
 
 
677
    def resume_write_group(self, tokens):
 
678
        if not self.is_write_locked():
 
679
            raise errors.NotWriteLocked(self)
 
680
        if self._write_group:
 
681
            raise errors.BzrError('already in a write group')
 
682
        self._resume_write_group(tokens)
 
683
        # so we can detect unlock/relock - the write group is now entered.
 
684
        self._write_group = self.get_transaction()
 
685
 
 
686
    def _resume_write_group(self, tokens):
 
687
        raise errors.UnsuspendableWriteGroup(self)
 
688
 
 
689
    def fetch(self, source, revision_id=None, find_ghosts=False):
 
690
        """Fetch the content required to construct revision_id from source.
 
691
 
 
692
        If revision_id is None, then all content is copied.
 
693
 
 
694
        fetch() may not be used when the repository is in a write group -
 
695
        either finish the current write group before using fetch, or use
 
696
        fetch before starting the write group.
 
697
 
 
698
        :param find_ghosts: Find and copy revisions in the source that are
 
699
            ghosts in the target (and not reachable directly by walking out to
 
700
            the first-present revision in target from revision_id).
 
701
        :param revision_id: If specified, all the content needed for this
 
702
            revision ID will be copied to the target.  Fetch will determine for
 
703
            itself which content needs to be copied.
 
704
        """
 
705
        if self.is_in_write_group():
 
706
            raise errors.InternalBzrError(
 
707
                "May not fetch while in a write group.")
 
708
        # fast path same-url fetch operations
 
709
        # TODO: lift out to somewhere common with RemoteRepository
 
710
        # <https://bugs.launchpad.net/bzr/+bug/401646>
 
711
        if (self.has_same_location(source)
 
712
                and self._has_same_fallbacks(source)):
 
713
            # check that last_revision is in 'from' and then return a
 
714
            # no-operation.
 
715
            if (revision_id is not None and
 
716
                    not _mod_revision.is_null(revision_id)):
 
717
                self.get_revision(revision_id)
 
718
            return 0, []
 
719
        inter = InterRepository.get(source, self)
 
720
        return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
 
721
 
 
722
    def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
 
723
                           timezone=None, committer=None, revprops=None,
 
724
                           revision_id=None, lossy=False):
 
725
        """Obtain a CommitBuilder for this repository.
 
726
 
 
727
        :param branch: Branch to commit to.
 
728
        :param parents: Revision ids of the parents of the new revision.
 
729
        :param config_stack: Configuration stack to use.
 
730
        :param timestamp: Optional timestamp recorded for commit.
 
731
        :param timezone: Optional timezone for timestamp.
 
732
        :param committer: Optional committer to set for commit.
 
733
        :param revprops: Optional dictionary of revision properties.
 
734
        :param revision_id: Optional revision id.
 
735
        :param lossy: Whether to discard data that can not be natively
 
736
            represented, when pushing to a foreign VCS
 
737
        """
 
738
        raise NotImplementedError(self.get_commit_builder)
 
739
 
 
740
    @only_raises(errors.LockNotHeld, errors.LockBroken)
 
741
    def unlock(self):
 
742
        if (self.control_files._lock_count == 1 and
 
743
                self.control_files._lock_mode == 'w'):
 
744
            if self._write_group is not None:
 
745
                self.abort_write_group()
 
746
                self.control_files.unlock()
 
747
                raise errors.BzrError(
 
748
                    'Must end write groups before releasing write locks.')
 
749
        self.control_files.unlock()
 
750
        if self.control_files._lock_count == 0:
 
751
            for repo in self._fallback_repositories:
 
752
                repo.unlock()
 
753
 
 
754
    def clone(self, controldir, revision_id=None):
 
755
        """Clone this repository into controldir using the current format.
 
756
 
 
757
        Currently no check is made that the format of this repository and
 
758
        the bzrdir format are compatible. FIXME RBC 20060201.
 
759
 
 
760
        :return: The newly created destination repository.
 
761
        """
 
762
        with self.lock_read():
 
763
            # TODO: deprecate after 0.16; cloning this with all its settings is
 
764
            # probably not very useful -- mbp 20070423
 
765
            dest_repo = self._create_sprouting_repo(
 
766
                controldir, shared=self.is_shared())
 
767
            self.copy_content_into(dest_repo, revision_id)
 
768
            return dest_repo
 
769
 
 
770
    def start_write_group(self):
 
771
        """Start a write group in the repository.
 
772
 
 
773
        Write groups are used by repositories which do not have a 1:1 mapping
 
774
        between file ids and backend store to manage the insertion of data from
 
775
        both fetch and commit operations.
 
776
 
 
777
        A write lock is required around the
 
778
        start_write_group/commit_write_group for the support of lock-requiring
 
779
        repository formats.
 
780
 
 
781
        One can only insert data into a repository inside a write group.
 
782
 
 
783
        :return: None.
 
784
        """
 
785
        if not self.is_write_locked():
 
786
            raise errors.NotWriteLocked(self)
 
787
        if self._write_group:
 
788
            raise errors.BzrError('already in a write group')
 
789
        self._start_write_group()
 
790
        # so we can detect unlock/relock - the write group is now entered.
 
791
        self._write_group = self.get_transaction()
 
792
 
 
793
    def _start_write_group(self):
 
794
        """Template method for per-repository write group startup.
 
795
 
 
796
        This is called before the write group is considered to be
 
797
        entered.
 
798
        """
 
799
 
 
800
    def sprout(self, to_bzrdir, revision_id=None):
 
801
        """Create a descendent repository for new development.
 
802
 
 
803
        Unlike clone, this does not copy the settings of the repository.
 
804
        """
 
805
        with self.lock_read():
 
806
            dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
807
            dest_repo.fetch(self, revision_id=revision_id)
 
808
            return dest_repo
 
809
 
 
810
    def _create_sprouting_repo(self, a_controldir, shared):
 
811
        if not isinstance(
 
812
                a_controldir._format, self.controldir._format.__class__):
 
813
            # use target default format.
 
814
            dest_repo = a_controldir.create_repository()
 
815
        else:
 
816
            # Most control formats need the repository to be specifically
 
817
            # created, but on some old all-in-one formats it's not needed
 
818
            try:
 
819
                dest_repo = self._format.initialize(
 
820
                    a_controldir, shared=shared)
 
821
            except errors.UninitializableFormat:
 
822
                dest_repo = a_controldir.open_repository()
 
823
        return dest_repo
 
824
 
 
825
    def has_revision(self, revision_id):
 
826
        """True if this repository has a copy of the revision."""
 
827
        with self.lock_read():
 
828
            return revision_id in self.has_revisions((revision_id,))
 
829
 
 
830
    def has_revisions(self, revision_ids):
 
831
        """Probe to find out the presence of multiple revisions.
 
832
 
 
833
        :param revision_ids: An iterable of revision_ids.
 
834
        :return: A set of the revision_ids that were present.
 
835
        """
 
836
        raise NotImplementedError(self.has_revisions)
 
837
 
 
838
    def get_revision(self, revision_id):
 
839
        """Return the Revision object for a named revision."""
 
840
        with self.lock_read():
 
841
            return self.get_revisions([revision_id])[0]
 
842
 
 
843
    def get_revision_reconcile(self, revision_id):
 
844
        """'reconcile' helper routine that allows access to a revision always.
 
845
 
 
846
        This variant of get_revision does not cross check the weave graph
 
847
        against the revision one as get_revision does: but it should only
 
848
        be used by reconcile, or reconcile-alike commands that are correcting
 
849
        or testing the revision graph.
 
850
        """
 
851
        raise NotImplementedError(self.get_revision_reconcile)
 
852
 
 
853
    def get_revisions(self, revision_ids):
 
854
        """Get many revisions at once.
 
855
 
 
856
        Repositories that need to check data on every revision read should
 
857
        subclass this method.
 
858
        """
 
859
        revs = {}
 
860
        for revid, rev in self.iter_revisions(revision_ids):
 
861
            if rev is None:
 
862
                raise errors.NoSuchRevision(self, revid)
 
863
            revs[revid] = rev
 
864
        return [revs[revid] for revid in revision_ids]
 
865
 
 
866
    def iter_revisions(self, revision_ids):
 
867
        """Iterate over revision objects.
 
868
 
 
869
        :param revision_ids: An iterable of revisions to examine. None may be
 
870
            passed to request all revisions known to the repository. Note that
 
871
            not all repositories can find unreferenced revisions; for those
 
872
            repositories only referenced ones will be returned.
 
873
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
874
            those asked for but not available) are returned as (revid, None).
 
875
            N.B.: Revisions are not necessarily yielded in order.
 
876
        """
 
877
        raise NotImplementedError(self.iter_revisions)
 
878
 
 
879
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
880
        """Produce a generator of revision deltas.
 
881
 
 
882
        Note that the input is a sequence of REVISIONS, not revision_ids.
 
883
        Trees will be held in memory until the generator exits.
 
884
        Each delta is relative to the revision's lefthand predecessor.
 
885
 
 
886
        :param specific_fileids: if not None, the result is filtered
 
887
          so that only those file-ids, their parents and their
 
888
          children are included.
 
889
        """
 
890
        raise NotImplementedError(self.get_deltas_for_revisions)
 
891
 
 
892
    def get_revision_delta(self, revision_id):
 
893
        """Return the delta for one revision.
 
894
 
 
895
        The delta is relative to the left-hand predecessor of the
 
896
        revision.
 
897
        """
 
898
        with self.lock_read():
 
899
            r = self.get_revision(revision_id)
 
900
            return list(self.get_deltas_for_revisions([r]))[0]
 
901
 
 
902
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
903
        raise NotImplementedError(self.store_revision_signature)
 
904
 
 
905
    def add_signature_text(self, revision_id, signature):
 
906
        """Store a signature text for a revision.
 
907
 
 
908
        :param revision_id: Revision id of the revision
 
909
        :param signature: Signature text.
 
910
        """
 
911
        raise NotImplementedError(self.add_signature_text)
 
912
 
 
913
    def iter_files_bytes(self, desired_files):
 
914
        """Iterate through file versions.
 
915
 
 
916
        Files will not necessarily be returned in the order they occur in
 
917
        desired_files.  No specific order is guaranteed.
 
918
 
 
919
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
920
        value supplied by the caller as part of desired_files.  It should
 
921
        uniquely identify the file version in the caller's context.  (Examples:
 
922
        an index number or a TreeTransform trans_id.)
 
923
 
 
924
        :param desired_files: a list of (file_id, revision_id, identifier)
 
925
            triples
 
926
        """
 
927
        raise NotImplementedError(self.iter_files_bytes)
 
928
 
 
929
    def get_rev_id_for_revno(self, revno, known_pair):
 
930
        """Return the revision id of a revno, given a later (revno, revid)
 
931
        pair in the same history.
 
932
 
 
933
        :return: if found (True, revid).  If the available history ran out
 
934
            before reaching the revno, then this returns
 
935
            (False, (closest_revno, closest_revid)).
 
936
        """
 
937
        known_revno, known_revid = known_pair
 
938
        partial_history = [known_revid]
 
939
        distance_from_known = known_revno - revno
 
940
        if distance_from_known < 0:
 
941
            raise errors.RevnoOutOfBounds(revno, (0, known_revno))
 
942
        try:
 
943
            _iter_for_revno(
 
944
                self, partial_history, stop_index=distance_from_known)
 
945
        except errors.RevisionNotPresent as err:
 
946
            if err.revision_id == known_revid:
 
947
                # The start revision (known_revid) wasn't found.
 
948
                raise errors.NoSuchRevision(self, known_revid)
 
949
            # This is a stacked repository with no fallbacks, or a there's a
 
950
            # left-hand ghost.  Either way, even though the revision named in
 
951
            # the error isn't in this repo, we know it's the next step in this
 
952
            # left-hand history.
 
953
            partial_history.append(err.revision_id)
 
954
        if len(partial_history) <= distance_from_known:
 
955
            # Didn't find enough history to get a revid for the revno.
 
956
            earliest_revno = known_revno - len(partial_history) + 1
 
957
            return (False, (earliest_revno, partial_history[-1]))
 
958
        if len(partial_history) - 1 > distance_from_known:
 
959
            raise AssertionError('_iter_for_revno returned too much history')
 
960
        return (True, partial_history[-1])
 
961
 
 
962
    def is_shared(self):
 
963
        """Return True if this repository is flagged as a shared repository."""
 
964
        raise NotImplementedError(self.is_shared)
 
965
 
 
966
    def reconcile(self, other=None, thorough=False):
 
967
        """Reconcile this repository."""
 
968
        raise NotImplementedError(self.reconcile)
 
969
 
 
970
    def _refresh_data(self):
 
971
        """Helper called from lock_* to ensure coherency with disk.
 
972
 
 
973
        The default implementation does nothing; it is however possible
 
974
        for repositories to maintain loaded indices across multiple locks
 
975
        by checking inside their implementation of this method to see
 
976
        whether their indices are still valid. This depends of course on
 
977
        the disk format being validatable in this manner. This method is
 
978
        also called by the refresh_data() public interface to cause a refresh
 
979
        to occur while in a write lock so that data inserted by a smart server
 
980
        push operation is visible on the client's instance of the physical
 
981
        repository.
 
982
        """
 
983
 
 
984
    def revision_tree(self, revision_id):
 
985
        """Return Tree for a revision on this branch.
 
986
 
 
987
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
988
        """
 
989
        raise NotImplementedError(self.revision_tree)
 
990
 
 
991
    def revision_trees(self, revision_ids):
 
992
        """Return Trees for revisions in this repository.
 
993
 
 
994
        :param revision_ids: a sequence of revision-ids;
 
995
          a revision-id may not be None or b'null:'
 
996
        """
 
997
        raise NotImplementedError(self.revision_trees)
 
998
 
 
999
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1000
        """Compress the data within the repository.
 
1001
 
 
1002
        This operation only makes sense for some repository types. For other
 
1003
        types it should be a no-op that just returns.
 
1004
 
 
1005
        This stub method does not require a lock, but subclasses should use
 
1006
        self.write_lock as this is a long running call it's reasonable to
 
1007
        implicitly lock for the user.
 
1008
 
 
1009
        :param hint: If not supplied, the whole repository is packed.
 
1010
            If supplied, the repository may use the hint parameter as a
 
1011
            hint for the parts of the repository to pack. A hint can be
 
1012
            obtained from the result of commit_write_group(). Out of
 
1013
            date hints are simply ignored, because concurrent operations
 
1014
            can obsolete them rapidly.
 
1015
 
 
1016
        :param clean_obsolete_packs: Clean obsolete packs immediately after
 
1017
            the pack operation.
 
1018
        """
 
1019
 
 
1020
    def get_transaction(self):
 
1021
        return self.control_files.get_transaction()
 
1022
 
 
1023
    def get_parent_map(self, revision_ids):
 
1024
        """See graph.StackedParentsProvider.get_parent_map"""
 
1025
        raise NotImplementedError(self.get_parent_map)
 
1026
 
 
1027
    def _get_parent_map_no_fallbacks(self, revision_ids):
 
1028
        """Same as Repository.get_parent_map except doesn't query fallbacks."""
 
1029
        # revisions index works in keys; this just works in revisions
 
1030
        # therefore wrap and unwrap
 
1031
        query_keys = []
 
1032
        result = {}
 
1033
        for revision_id in revision_ids:
 
1034
            if revision_id == _mod_revision.NULL_REVISION:
 
1035
                result[revision_id] = ()
 
1036
            elif revision_id is None:
 
1037
                raise ValueError('get_parent_map(None) is not valid')
 
1038
            else:
 
1039
                query_keys.append((revision_id,))
 
1040
        vf = self.revisions.without_fallbacks()
 
1041
        for (revision_id,), parent_keys in viewitems(
 
1042
                vf.get_parent_map(query_keys)):
 
1043
            if parent_keys:
 
1044
                result[revision_id] = tuple([parent_revid
 
1045
                                             for (parent_revid,) in parent_keys])
 
1046
            else:
 
1047
                result[revision_id] = (_mod_revision.NULL_REVISION,)
 
1048
        return result
 
1049
 
 
1050
    def _make_parents_provider(self):
 
1051
        if not self._format.supports_external_lookups:
 
1052
            return self
 
1053
        return graph.StackedParentsProvider(_LazyListJoin(
 
1054
            [self._make_parents_provider_unstacked()],
 
1055
            self._fallback_repositories))
 
1056
 
 
1057
    def _make_parents_provider_unstacked(self):
 
1058
        return graph.CallableToParentsProviderAdapter(
 
1059
            self._get_parent_map_no_fallbacks)
 
1060
 
 
1061
    def get_known_graph_ancestry(self, revision_ids):
 
1062
        """Return the known graph for a set of revision ids and their ancestors.
 
1063
        """
 
1064
        raise NotImplementedError(self.get_known_graph_ancestry)
 
1065
 
 
1066
    def get_file_graph(self):
 
1067
        """Return the graph walker for files."""
 
1068
        raise NotImplementedError(self.get_file_graph)
 
1069
 
 
1070
    def get_graph(self, other_repository=None):
 
1071
        """Return the graph walker for this repository format"""
 
1072
        parents_provider = self._make_parents_provider()
 
1073
        if (other_repository is not None and
 
1074
                not self.has_same_location(other_repository)):
 
1075
            parents_provider = graph.StackedParentsProvider(
 
1076
                [parents_provider, other_repository._make_parents_provider()])
 
1077
        return graph.Graph(parents_provider)
 
1078
 
 
1079
    def set_make_working_trees(self, new_value):
 
1080
        """Set the policy flag for making working trees when creating branches.
 
1081
 
 
1082
        This only applies to branches that use this repository.
 
1083
 
 
1084
        The default is 'True'.
 
1085
        :param new_value: True to restore the default, False to disable making
 
1086
                          working trees.
 
1087
        """
 
1088
        raise NotImplementedError(self.set_make_working_trees)
 
1089
 
 
1090
    def make_working_trees(self):
 
1091
        """Returns the policy for making working trees on new branches."""
 
1092
        raise NotImplementedError(self.make_working_trees)
 
1093
 
 
1094
    def sign_revision(self, revision_id, gpg_strategy):
 
1095
        raise NotImplementedError(self.sign_revision)
 
1096
 
 
1097
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
1098
        """Verify the signature on a revision.
 
1099
 
 
1100
        :param revision_id: the revision to verify
 
1101
        :gpg_strategy: the GPGStrategy object to used
 
1102
 
 
1103
        :return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
 
1104
        """
 
1105
        raise NotImplementedError(self.verify_revision_signature)
 
1106
 
 
1107
    def verify_revision_signatures(self, revision_ids, gpg_strategy):
 
1108
        """Verify revision signatures for a number of revisions.
 
1109
 
 
1110
        :param revision_id: the revision to verify
 
1111
        :gpg_strategy: the GPGStrategy object to used
 
1112
        :return: Iterator over tuples with revision id, result and keys
 
1113
        """
 
1114
        with self.lock_read():
 
1115
            for revid in revision_ids:
 
1116
                (result, key) = self.verify_revision_signature(revid, gpg_strategy)
 
1117
                yield revid, result, key
 
1118
 
 
1119
    def has_signature_for_revision_id(self, revision_id):
 
1120
        """Query for a revision signature for revision_id in the repository."""
 
1121
        raise NotImplementedError(self.has_signature_for_revision_id)
 
1122
 
 
1123
    def get_signature_text(self, revision_id):
 
1124
        """Return the text for a signature."""
 
1125
        raise NotImplementedError(self.get_signature_text)
 
1126
 
 
1127
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1128
        """Check consistency of all history of given revision_ids.
 
1129
 
 
1130
        Different repository implementations should override _check().
 
1131
 
 
1132
        :param revision_ids: A non-empty list of revision_ids whose ancestry
 
1133
             will be checked.  Typically the last revision_id of a branch.
 
1134
        :param callback_refs: A dict of check-refs to resolve and callback
 
1135
            the check/_check method on the items listed as wanting the ref.
 
1136
            see breezy.check.
 
1137
        :param check_repo: If False do not check the repository contents, just
 
1138
            calculate the data callback_refs requires and call them back.
 
1139
        """
 
1140
        return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
 
1141
                           check_repo=check_repo)
 
1142
 
 
1143
    def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1144
        raise NotImplementedError(self.check)
 
1145
 
 
1146
    def _warn_if_deprecated(self, branch=None):
 
1147
        if not self._format.is_deprecated():
 
1148
            return
 
1149
        global _deprecation_warning_done
 
1150
        if _deprecation_warning_done:
 
1151
            return
 
1152
        try:
 
1153
            if branch is None:
 
1154
                conf = config.GlobalStack()
 
1155
            else:
 
1156
                conf = branch.get_config_stack()
 
1157
            if 'format_deprecation' in conf.get('suppress_warnings'):
 
1158
                return
 
1159
            warning("Format %s for %s is deprecated -"
 
1160
                    " please use 'brz upgrade' to get better performance"
 
1161
                    % (self._format, self.controldir.transport.base))
 
1162
        finally:
 
1163
            _deprecation_warning_done = True
 
1164
 
 
1165
    def supports_rich_root(self):
 
1166
        return self._format.rich_root_data
 
1167
 
 
1168
    def _check_ascii_revisionid(self, revision_id, method):
 
1169
        """Private helper for ascii-only repositories."""
 
1170
        # weave repositories refuse to store revisionids that are non-ascii.
 
1171
        if revision_id is not None:
 
1172
            # weaves require ascii revision ids.
 
1173
            if isinstance(revision_id, text_type):
 
1174
                try:
 
1175
                    revision_id.encode('ascii')
 
1176
                except UnicodeEncodeError:
 
1177
                    raise errors.NonAsciiRevisionId(method, self)
 
1178
            else:
 
1179
                try:
 
1180
                    revision_id.decode('ascii')
 
1181
                except UnicodeDecodeError:
 
1182
                    raise errors.NonAsciiRevisionId(method, self)
 
1183
 
 
1184
 
 
1185
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
 
1186
    """Repository format registry."""
 
1187
 
 
1188
    def get_default(self):
 
1189
        """Return the current default format."""
 
1190
        return controldir.format_registry.make_controldir('default').repository_format
 
1191
 
 
1192
 
 
1193
network_format_registry = registry.FormatRegistry()
 
1194
"""Registry of formats indexed by their network name.
 
1195
 
 
1196
The network name for a repository format is an identifier that can be used when
 
1197
referring to formats with smart server operations. See
 
1198
RepositoryFormat.network_name() for more detail.
 
1199
"""
 
1200
 
 
1201
 
 
1202
format_registry = RepositoryFormatRegistry(network_format_registry)
 
1203
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
 
1204
 
 
1205
This can contain either format instances themselves, or classes/factories that
 
1206
can be called to obtain one.
 
1207
"""
 
1208
 
 
1209
 
 
1210
#####################################################################
 
1211
# Repository Formats
 
1212
 
 
1213
class RepositoryFormat(controldir.ControlComponentFormat):
 
1214
    """A repository format.
 
1215
 
 
1216
    Formats provide four things:
 
1217
     * An initialization routine to construct repository data on disk.
 
1218
     * a optional format string which is used when the BzrDir supports
 
1219
       versioned children.
 
1220
     * an open routine which returns a Repository instance.
 
1221
     * A network name for referring to the format in smart server RPC
 
1222
       methods.
 
1223
 
 
1224
    There is one and only one Format subclass for each on-disk format. But
 
1225
    there can be one Repository subclass that is used for several different
 
1226
    formats. The _format attribute on a Repository instance can be used to
 
1227
    determine the disk format.
 
1228
 
 
1229
    Formats are placed in a registry by their format string for reference
 
1230
    during opening. These should be subclasses of RepositoryFormat for
 
1231
    consistency.
 
1232
 
 
1233
    Once a format is deprecated, just deprecate the initialize and open
 
1234
    methods on the format class. Do not deprecate the object, as the
 
1235
    object may be created even when a repository instance hasn't been
 
1236
    created.
 
1237
 
 
1238
    Common instance attributes:
 
1239
    _matchingcontroldir - the controldir format that the repository format was
 
1240
    originally written to work with. This can be used if manually
 
1241
    constructing a bzrdir and repository, or more commonly for test suite
 
1242
    parameterization.
 
1243
    """
 
1244
 
 
1245
    # Set to True or False in derived classes. True indicates that the format
 
1246
    # supports ghosts gracefully.
 
1247
    supports_ghosts = None
 
1248
    # Can this repository be given external locations to lookup additional
 
1249
    # data. Set to True or False in derived classes.
 
1250
    supports_external_lookups = None
 
1251
    # Does this format support CHK bytestring lookups. Set to True or False in
 
1252
    # derived classes.
 
1253
    supports_chks = None
 
1254
    # Should fetch trigger a reconcile after the fetch? Only needed for
 
1255
    # some repository formats that can suffer internal inconsistencies.
 
1256
    _fetch_reconcile = False
 
1257
    # Does this format have < O(tree_size) delta generation. Used to hint what
 
1258
    # code path for commit, amongst other things.
 
1259
    fast_deltas = None
 
1260
    # Does doing a pack operation compress data? Useful for the pack UI command
 
1261
    # (so if there is one pack, the operation can still proceed because it may
 
1262
    # help), and for fetching when data won't have come from the same
 
1263
    # compressor.
 
1264
    pack_compresses = False
 
1265
    # Does the repository storage understand references to trees?
 
1266
    supports_tree_reference = None
 
1267
    # Is the format experimental ?
 
1268
    experimental = False
 
1269
    # Does this repository format escape funky characters, or does it create
 
1270
    # files with similar names as the versioned files in its contents on disk
 
1271
    # ?
 
1272
    supports_funky_characters = None
 
1273
    # Does this repository format support leaving locks?
 
1274
    supports_leaving_lock = None
 
1275
    # Does this format support the full VersionedFiles interface?
 
1276
    supports_full_versioned_files = None
 
1277
    # Does this format support signing revision signatures?
 
1278
    supports_revision_signatures = True
 
1279
    # Can the revision graph have incorrect parents?
 
1280
    revision_graph_can_have_wrong_parents = None
 
1281
    # Does this format support setting revision ids?
 
1282
    supports_setting_revision_ids = True
 
1283
    # Does this format support rich root data?
 
1284
    rich_root_data = None
 
1285
    # Does this format support explicitly versioned directories?
 
1286
    supports_versioned_directories = None
 
1287
    # Can other repositories be nested into one of this format?
 
1288
    supports_nesting_repositories = None
 
1289
    # Is it possible for revisions to be present without being referenced
 
1290
    # somewhere ?
 
1291
    supports_unreferenced_revisions = None
 
1292
    # Does this format store the current Branch.nick in a revision when
 
1293
    # creating commits?
 
1294
    supports_storing_branch_nick = True
 
1295
    # Does the format support overriding the transport to use
 
1296
    supports_overriding_transport = True
 
1297
    # Does the format support setting custom revision properties?
 
1298
    supports_custom_revision_properties = True
 
1299
    # Does the format record per-file revision metadata?
 
1300
    records_per_file_revision = True
 
1301
 
 
1302
    def __repr__(self):
 
1303
        return "%s()" % self.__class__.__name__
 
1304
 
 
1305
    def __eq__(self, other):
 
1306
        # format objects are generally stateless
 
1307
        return isinstance(other, self.__class__)
 
1308
 
 
1309
    def __ne__(self, other):
 
1310
        return not self == other
 
1311
 
 
1312
    def get_format_description(self):
 
1313
        """Return the short description for this format."""
 
1314
        raise NotImplementedError(self.get_format_description)
 
1315
 
 
1316
    def initialize(self, controldir, shared=False):
 
1317
        """Initialize a repository of this format in controldir.
 
1318
 
 
1319
        :param controldir: The controldir to put the new repository in it.
 
1320
        :param shared: The repository should be initialized as a sharable one.
 
1321
        :returns: The new repository object.
 
1322
 
 
1323
        This may raise UninitializableFormat if shared repository are not
 
1324
        compatible the controldir.
 
1325
        """
 
1326
        raise NotImplementedError(self.initialize)
 
1327
 
 
1328
    def is_supported(self):
 
1329
        """Is this format supported?
 
1330
 
 
1331
        Supported formats must be initializable and openable.
 
1332
        Unsupported formats may not support initialization or committing or
 
1333
        some other features depending on the reason for not being supported.
 
1334
        """
 
1335
        return True
 
1336
 
 
1337
    def is_deprecated(self):
 
1338
        """Is this format deprecated?
 
1339
 
 
1340
        Deprecated formats may trigger a user-visible warning recommending
 
1341
        the user to upgrade. They are still fully supported.
 
1342
        """
 
1343
        return False
 
1344
 
 
1345
    def network_name(self):
 
1346
        """A simple byte string uniquely identifying this format for RPC calls.
 
1347
 
 
1348
        MetaDir repository formats use their disk format string to identify the
 
1349
        repository over the wire. All in one formats such as bzr < 0.8, and
 
1350
        foreign formats like svn/git and hg should use some marker which is
 
1351
        unique and immutable.
 
1352
        """
 
1353
        raise NotImplementedError(self.network_name)
 
1354
 
 
1355
    def check_conversion_target(self, target_format):
 
1356
        if self.rich_root_data and not target_format.rich_root_data:
 
1357
            raise errors.BadConversionTarget(
 
1358
                'Does not support rich root data.', target_format,
 
1359
                from_format=self)
 
1360
        if (self.supports_tree_reference
 
1361
                and not getattr(target_format, 'supports_tree_reference', False)):
 
1362
            raise errors.BadConversionTarget(
 
1363
                'Does not support nested trees', target_format,
 
1364
                from_format=self)
 
1365
 
 
1366
    def open(self, controldir, _found=False):
 
1367
        """Return an instance of this format for a controldir.
 
1368
 
 
1369
        _found is a private parameter, do not use it.
 
1370
        """
 
1371
        raise NotImplementedError(self.open)
 
1372
 
 
1373
    def _run_post_repo_init_hooks(self, repository, controldir, shared):
 
1374
        from .controldir import ControlDir, RepoInitHookParams
 
1375
        hooks = ControlDir.hooks['post_repo_init']
 
1376
        if not hooks:
 
1377
            return
 
1378
        params = RepoInitHookParams(repository, self, controldir, shared)
 
1379
        for hook in hooks:
 
1380
            hook(params)
 
1381
 
 
1382
 
 
1383
# formats which have no format string are not discoverable or independently
 
1384
# creatable on disk, so are not registered in format_registry.  They're
 
1385
# all in breezy.bzr.knitreponow.  When an instance of one of these is
 
1386
# needed, it's constructed directly by the ControlDir.  Non-native formats where
 
1387
# the repository is not separately opened are similar.
 
1388
 
 
1389
format_registry.register_lazy(
 
1390
    b'Bazaar-NG Knit Repository Format 1',
 
1391
    'breezy.bzr.knitrepo',
 
1392
    'RepositoryFormatKnit1',
 
1393
    )
 
1394
 
 
1395
format_registry.register_lazy(
 
1396
    b'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
1397
    'breezy.bzr.knitrepo',
 
1398
    'RepositoryFormatKnit3',
 
1399
    )
 
1400
 
 
1401
format_registry.register_lazy(
 
1402
    b'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
1403
    'breezy.bzr.knitrepo',
 
1404
    'RepositoryFormatKnit4',
 
1405
    )
 
1406
 
 
1407
# Pack-based formats. There is one format for pre-subtrees, and one for
 
1408
# post-subtrees to allow ease of testing.
 
1409
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
1410
format_registry.register_lazy(
 
1411
    b'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
1412
    'breezy.bzr.knitpack_repo',
 
1413
    'RepositoryFormatKnitPack1',
 
1414
    )
 
1415
format_registry.register_lazy(
 
1416
    b'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
1417
    'breezy.bzr.knitpack_repo',
 
1418
    'RepositoryFormatKnitPack3',
 
1419
    )
 
1420
format_registry.register_lazy(
 
1421
    b'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
1422
    'breezy.bzr.knitpack_repo',
 
1423
    'RepositoryFormatKnitPack4',
 
1424
    )
 
1425
format_registry.register_lazy(
 
1426
    b'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
 
1427
    'breezy.bzr.knitpack_repo',
 
1428
    'RepositoryFormatKnitPack5',
 
1429
    )
 
1430
format_registry.register_lazy(
 
1431
    b'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
 
1432
    'breezy.bzr.knitpack_repo',
 
1433
    'RepositoryFormatKnitPack5RichRoot',
 
1434
    )
 
1435
format_registry.register_lazy(
 
1436
    b'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
 
1437
    'breezy.bzr.knitpack_repo',
 
1438
    'RepositoryFormatKnitPack5RichRootBroken',
 
1439
    )
 
1440
format_registry.register_lazy(
 
1441
    b'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
1442
    'breezy.bzr.knitpack_repo',
 
1443
    'RepositoryFormatKnitPack6',
 
1444
    )
 
1445
format_registry.register_lazy(
 
1446
    b'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
1447
    'breezy.bzr.knitpack_repo',
 
1448
    'RepositoryFormatKnitPack6RichRoot',
 
1449
    )
 
1450
format_registry.register_lazy(
 
1451
    b'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
1452
    'breezy.bzr.groupcompress_repo',
 
1453
    'RepositoryFormat2a',
 
1454
    )
 
1455
 
 
1456
# Development formats.
 
1457
# Check their docstrings to see if/when they are obsolete.
 
1458
format_registry.register_lazy(
 
1459
    (b"Bazaar development format 2 with subtree support "
 
1460
        b"(needs bzr.dev from before 1.8)\n"),
 
1461
    'breezy.bzr.knitpack_repo',
 
1462
    'RepositoryFormatPackDevelopment2Subtree',
 
1463
    )
 
1464
format_registry.register_lazy(
 
1465
    b'Bazaar development format 8\n',
 
1466
    'breezy.bzr.groupcompress_repo',
 
1467
    'RepositoryFormat2aSubtree',
 
1468
    )
 
1469
 
 
1470
 
 
1471
class InterRepository(InterObject):
 
1472
    """This class represents operations taking place between two repositories.
 
1473
 
 
1474
    Its instances have methods like copy_content and fetch, and contain
 
1475
    references to the source and target repositories these operations can be
 
1476
    carried out on.
 
1477
 
 
1478
    Often we will provide convenience methods on 'repository' which carry out
 
1479
    operations with another repository - they will always forward to
 
1480
    InterRepository.get(other).method_name(parameters).
 
1481
    """
 
1482
 
 
1483
    _optimisers = []
 
1484
    """The available optimised InterRepository types."""
 
1485
 
 
1486
    def copy_content(self, revision_id=None):
 
1487
        """Make a complete copy of the content in self into destination.
 
1488
 
 
1489
        This is a destructive operation! Do not use it on existing
 
1490
        repositories.
 
1491
 
 
1492
        :param revision_id: Only copy the content needed to construct
 
1493
                            revision_id and its parents.
 
1494
        """
 
1495
        with self.lock_write():
 
1496
            try:
 
1497
                self.target.set_make_working_trees(
 
1498
                    self.source.make_working_trees())
 
1499
            except NotImplementedError:
 
1500
                pass
 
1501
            self.target.fetch(self.source, revision_id=revision_id)
 
1502
 
 
1503
    def fetch(self, revision_id=None, find_ghosts=False):
 
1504
        """Fetch the content required to construct revision_id.
 
1505
 
 
1506
        The content is copied from self.source to self.target.
 
1507
 
 
1508
        :param revision_id: if None all content is copied, if NULL_REVISION no
 
1509
                            content is copied.
 
1510
        :return: None.
 
1511
        """
 
1512
        raise NotImplementedError(self.fetch)
 
1513
 
 
1514
    def search_missing_revision_ids(
 
1515
            self, find_ghosts=True, revision_ids=None, if_present_ids=None,
 
1516
            limit=None):
 
1517
        """Return the revision ids that source has that target does not.
 
1518
 
 
1519
        :param revision_ids: return revision ids included by these
 
1520
            revision_ids.  NoSuchRevision will be raised if any of these
 
1521
            revisions are not present.
 
1522
        :param if_present_ids: like revision_ids, but will not cause
 
1523
            NoSuchRevision if any of these are absent, instead they will simply
 
1524
            not be in the result.  This is useful for e.g. finding revisions
 
1525
            to fetch for tags, which may reference absent revisions.
 
1526
        :param find_ghosts: If True find missing revisions in deep history
 
1527
            rather than just finding the surface difference.
 
1528
        :param limit: Maximum number of revisions to return, topologically
 
1529
            ordered
 
1530
        :return: A breezy.graph.SearchResult.
 
1531
        """
 
1532
        raise NotImplementedError(self.search_missing_revision_ids)
 
1533
 
 
1534
    @staticmethod
 
1535
    def _same_model(source, target):
 
1536
        """True if source and target have the same data representation.
 
1537
 
 
1538
        Note: this is always called on the base class; overriding it in a
 
1539
        subclass will have no effect.
 
1540
        """
 
1541
        try:
 
1542
            InterRepository._assert_same_model(source, target)
 
1543
            return True
 
1544
        except errors.IncompatibleRepositories as e:
 
1545
            return False
 
1546
 
 
1547
    @staticmethod
 
1548
    def _assert_same_model(source, target):
 
1549
        """Raise an exception if two repositories do not use the same model.
 
1550
        """
 
1551
        if source.supports_rich_root() != target.supports_rich_root():
 
1552
            raise errors.IncompatibleRepositories(source, target,
 
1553
                                                  "different rich-root support")
 
1554
        if source._serializer != target._serializer:
 
1555
            raise errors.IncompatibleRepositories(source, target,
 
1556
                                                  "different serializers")
 
1557
 
 
1558
 
 
1559
class CopyConverter(object):
 
1560
    """A repository conversion tool which just performs a copy of the content.
 
1561
 
 
1562
    This is slow but quite reliable.
 
1563
    """
 
1564
 
 
1565
    def __init__(self, target_format):
 
1566
        """Create a CopyConverter.
 
1567
 
 
1568
        :param target_format: The format the resulting repository should be.
 
1569
        """
 
1570
        self.target_format = target_format
 
1571
 
 
1572
    def convert(self, repo, pb):
 
1573
        """Perform the conversion of to_convert, giving feedback via pb.
 
1574
 
 
1575
        :param to_convert: The disk object to convert.
 
1576
        :param pb: a progress bar to use for progress information.
 
1577
        """
 
1578
        with ui.ui_factory.nested_progress_bar() as pb:
 
1579
            self.count = 0
 
1580
            self.total = 4
 
1581
            # this is only useful with metadir layouts - separated repo content.
 
1582
            # trigger an assertion if not such
 
1583
            repo._format.get_format_string()
 
1584
            self.repo_dir = repo.controldir
 
1585
            pb.update(gettext('Moving repository to repository.backup'))
 
1586
            self.repo_dir.transport.move('repository', 'repository.backup')
 
1587
            backup_transport = self.repo_dir.transport.clone(
 
1588
                'repository.backup')
 
1589
            repo._format.check_conversion_target(self.target_format)
 
1590
            self.source_repo = repo._format.open(self.repo_dir,
 
1591
                                                 _found=True,
 
1592
                                                 _override_transport=backup_transport)
 
1593
            pb.update(gettext('Creating new repository'))
 
1594
            converted = self.target_format.initialize(self.repo_dir,
 
1595
                                                      self.source_repo.is_shared())
 
1596
            with converted.lock_write():
 
1597
                pb.update(gettext('Copying content'))
 
1598
                self.source_repo.copy_content_into(converted)
 
1599
            pb.update(gettext('Deleting old repository content'))
 
1600
            self.repo_dir.transport.delete_tree('repository.backup')
 
1601
            ui.ui_factory.note(gettext('repository converted'))
 
1602
 
 
1603
 
 
1604
def _strip_NULL_ghosts(revision_graph):
 
1605
    """Also don't use this. more compatibility code for unmigrated clients."""
 
1606
    # Filter ghosts, and null:
 
1607
    if _mod_revision.NULL_REVISION in revision_graph:
 
1608
        del revision_graph[_mod_revision.NULL_REVISION]
 
1609
    for key, parents in viewitems(revision_graph):
 
1610
        revision_graph[key] = tuple(parent for parent in parents if parent
 
1611
                                    in revision_graph)
 
1612
    return revision_graph
 
1613
 
 
1614
 
 
1615
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
1616
                    stop_revision=None):
 
1617
    """Extend the partial history to include a given index
 
1618
 
 
1619
    If a stop_index is supplied, stop when that index has been reached.
 
1620
    If a stop_revision is supplied, stop when that revision is
 
1621
    encountered.  Otherwise, stop when the beginning of history is
 
1622
    reached.
 
1623
 
 
1624
    :param stop_index: The index which should be present.  When it is
 
1625
        present, history extension will stop.
 
1626
    :param stop_revision: The revision id which should be present.  When
 
1627
        it is encountered, history extension will stop.
 
1628
    """
 
1629
    start_revision = partial_history_cache[-1]
 
1630
    graph = repo.get_graph()
 
1631
    iterator = graph.iter_lefthand_ancestry(start_revision,
 
1632
                                            (_mod_revision.NULL_REVISION,))
 
1633
    try:
 
1634
        # skip the last revision in the list
 
1635
        next(iterator)
 
1636
        while True:
 
1637
            if (stop_index is not None and
 
1638
                    len(partial_history_cache) > stop_index):
 
1639
                break
 
1640
            if partial_history_cache[-1] == stop_revision:
 
1641
                break
 
1642
            revision_id = next(iterator)
 
1643
            partial_history_cache.append(revision_id)
 
1644
    except StopIteration:
 
1645
        # No more history
 
1646
        return
 
1647
 
 
1648
 
 
1649
class _LazyListJoin(object):
 
1650
    """An iterable yielding the contents of many lists as one list.
 
1651
 
 
1652
    Each iterator made from this will reflect the current contents of the lists
 
1653
    at the time the iterator is made.
 
1654
 
 
1655
    This is used by Repository's _make_parents_provider implementation so that
 
1656
    it is safe to do::
 
1657
 
 
1658
      pp = repo._make_parents_provider()      # uses a list of fallback repos
 
1659
      pp.add_fallback_repository(other_repo)  # appends to that list
 
1660
      result = pp.get_parent_map(...)
 
1661
      # The result will include revs from other_repo
 
1662
    """
 
1663
 
 
1664
    def __init__(self, *list_parts):
 
1665
        self.list_parts = list_parts
 
1666
 
 
1667
    def __iter__(self):
 
1668
        full_list = []
 
1669
        for list_part in self.list_parts:
 
1670
            full_list.extend(list_part)
 
1671
        return iter(full_list)
 
1672
 
 
1673
    def __repr__(self):
 
1674
        return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
 
1675
                              self.list_parts)