/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 bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

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