/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-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

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