/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-19 23:18:42 UTC
  • mto: (7490.3.4 work)
  • mto: This revision was merged to the branch mainline in revision 7495.
  • Revision ID: jelmer@jelmer.uk-20200219231842-agwjh2db66cpajqg
Consistent return values.

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