/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: Martin
  • Date: 2017-06-27 00:10:52 UTC
  • mto: This revision was merged to the branch mainline in revision 6721.
  • Revision ID: gzlist@googlemail.com-20170627001052-o70zln144nmwhamo
Switch c_api helpers for _static_tuple_c to capsules

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