/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: 2018-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

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