← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from binascii import hexlify
18
 
from copy import deepcopy
19
 
from cStringIO import StringIO
 
17
from bzrlib.lazy_import import lazy_import
 
18
lazy_import(globals(), """
 
19
import cStringIO
20
20
import re
21
21
import time
22
 
from unittest import TestSuite
23
 
 
24
 
import bzrlib.bzrdir as bzrdir
 
22
 
 
23
from bzrlib import (
 
24
    bzrdir,
 
25
    check,
 
26
    debug,
 
27
    errors,
 
28
    fifo_cache,
 
29
    generate_ids,
 
30
    gpg,
 
31
    graph,
 
32
    lazy_regex,
 
33
    lockable_files,
 
34
    lockdir,
 
35
    lru_cache,
 
36
    osutils,
 
37
    remote,
 
38
    revision as _mod_revision,
 
39
    symbol_versioning,
 
40
    tsort,
 
41
    ui,
 
42
    versionedfile,
 
43
    )
 
44
from bzrlib.bundle import serializer
 
45
from bzrlib.revisiontree import RevisionTree
 
46
from bzrlib.store.versioned import VersionedFileStore
 
47
from bzrlib.testament import Testament
 
48
""")
 
49
 
 
50
from bzrlib import registry
25
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
26
 
import bzrlib.errors as errors
27
 
from bzrlib.errors import InvalidRevisionId
28
 
import bzrlib.gpg as gpg
29
 
from bzrlib.graph import Graph
30
52
from bzrlib.inter import InterObject
31
 
from bzrlib.inventory import Inventory
32
 
from bzrlib.knit import KnitVersionedFile, KnitPlainFactory
33
 
from bzrlib.lockable_files import LockableFiles, TransportLock
34
 
from bzrlib.lockdir import LockDir
35
 
from bzrlib.osutils import (safe_unicode, rand_bytes, compact_date, 
36
 
                            local_time_offset)
37
 
from bzrlib.revision import NULL_REVISION, Revision
38
 
from bzrlib.store.versioned import VersionedFileStore, WeaveStore
39
 
from bzrlib.store.text import TextStore
40
 
from bzrlib.symbol_versioning import *
41
 
from bzrlib.trace import mutter, note
42
 
from bzrlib.tree import RevisionTree
43
 
from bzrlib.tsort import topo_sort
44
 
from bzrlib.testament import Testament
45
 
from bzrlib.tree import EmptyTree
46
 
import bzrlib.ui
47
 
from bzrlib.weave import WeaveFile
48
 
import bzrlib.xml5
49
 
 
 
53
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
54
from bzrlib.symbol_versioning import (
 
55
        deprecated_method,
 
56
        one_one,
 
57
        one_two,
 
58
        one_six,
 
59
        )
 
60
from bzrlib.trace import (
 
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
 
62
 
 
63
 
 
64
# Old formats display a warning, but only once
 
65
_deprecation_warning_done = False
 
66
 
 
67
 
 
68
class CommitBuilder(object):
 
69
    """Provides an interface to build up a commit.
 
70
 
 
71
    This allows describing a tree to be committed without needing to
 
72
    know the internals of the format of the repository.
 
73
    """
 
74
 
 
75
    # all clients should supply tree roots.
 
76
    record_root_entry = True
 
77
    # the default CommitBuilder does not manage trees whose root is versioned.
 
78
    _versioned_root = False
 
79
 
 
80
    def __init__(self, repository, parents, config, timestamp=None,
 
81
                 timezone=None, committer=None, revprops=None,
 
82
                 revision_id=None):
 
83
        """Initiate a CommitBuilder.
 
84
 
 
85
        :param repository: Repository to commit to.
 
86
        :param parents: Revision ids of the parents of the new revision.
 
87
        :param config: Configuration to use.
 
88
        :param timestamp: Optional timestamp recorded for commit.
 
89
        :param timezone: Optional timezone for timestamp.
 
90
        :param committer: Optional committer to set for commit.
 
91
        :param revprops: Optional dictionary of revision properties.
 
92
        :param revision_id: Optional revision id.
 
93
        """
 
94
        self._config = config
 
95
 
 
96
        if committer is None:
 
97
            self._committer = self._config.username()
 
98
        else:
 
99
            self._committer = committer
 
100
 
 
101
        self.new_inventory = Inventory(None)
 
102
        self._new_revision_id = revision_id
 
103
        self.parents = parents
 
104
        self.repository = repository
 
105
 
 
106
        self._revprops = {}
 
107
        if revprops is not None:
 
108
            self._validate_revprops(revprops)
 
109
            self._revprops.update(revprops)
 
110
 
 
111
        if timestamp is None:
 
112
            timestamp = time.time()
 
113
        # Restrict resolution to 1ms
 
114
        self._timestamp = round(timestamp, 3)
 
115
 
 
116
        if timezone is None:
 
117
            self._timezone = osutils.local_time_offset()
 
118
        else:
 
119
            self._timezone = int(timezone)
 
120
 
 
121
        self._generate_revision_if_needed()
 
122
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
123
        self._basis_delta = []
 
124
        # API compatibility, older code that used CommitBuilder did not call
 
125
        # .record_delete(), which means the delta that is computed would not be
 
126
        # valid. Callers that will call record_delete() should call
 
127
        # .will_record_deletes() to indicate that.
 
128
        self._recording_deletes = False
 
129
 
 
130
    def _validate_unicode_text(self, text, context):
 
131
        """Verify things like commit messages don't have bogus characters."""
 
132
        if '\r' in text:
 
133
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
134
 
 
135
    def _validate_revprops(self, revprops):
 
136
        for key, value in revprops.iteritems():
 
137
            # We know that the XML serializers do not round trip '\r'
 
138
            # correctly, so refuse to accept them
 
139
            if not isinstance(value, basestring):
 
140
                raise ValueError('revision property (%s) is not a valid'
 
141
                                 ' (unicode) string: %r' % (key, value))
 
142
            self._validate_unicode_text(value,
 
143
                                        'revision property (%s)' % (key,))
 
144
 
 
145
    def commit(self, message):
 
146
        """Make the actual commit.
 
147
 
 
148
        :return: The revision id of the recorded revision.
 
149
        """
 
150
        self._validate_unicode_text(message, 'commit message')
 
151
        rev = _mod_revision.Revision(
 
152
                       timestamp=self._timestamp,
 
153
                       timezone=self._timezone,
 
154
                       committer=self._committer,
 
155
                       message=message,
 
156
                       inventory_sha1=self.inv_sha1,
 
157
                       revision_id=self._new_revision_id,
 
158
                       properties=self._revprops)
 
159
        rev.parent_ids = self.parents
 
160
        self.repository.add_revision(self._new_revision_id, rev,
 
161
            self.new_inventory, self._config)
 
162
        self.repository.commit_write_group()
 
163
        return self._new_revision_id
 
164
 
 
165
    def abort(self):
 
166
        """Abort the commit that is being built.
 
167
        """
 
168
        self.repository.abort_write_group()
 
169
 
 
170
    def revision_tree(self):
 
171
        """Return the tree that was just committed.
 
172
 
 
173
        After calling commit() this can be called to get a RevisionTree
 
174
        representing the newly committed tree. This is preferred to
 
175
        calling Repository.revision_tree() because that may require
 
176
        deserializing the inventory, while we already have a copy in
 
177
        memory.
 
178
        """
 
179
        return RevisionTree(self.repository, self.new_inventory,
 
180
                            self._new_revision_id)
 
181
 
 
182
    def finish_inventory(self):
 
183
        """Tell the builder that the inventory is finished."""
 
184
        if self.new_inventory.root is None:
 
185
            raise AssertionError('Root entry should be supplied to'
 
186
                ' record_entry_contents, as of bzr 0.10.')
 
187
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
188
        self.new_inventory.revision_id = self._new_revision_id
 
189
        self.inv_sha1 = self.repository.add_inventory(
 
190
            self._new_revision_id,
 
191
            self.new_inventory,
 
192
            self.parents
 
193
            )
 
194
 
 
195
    def _gen_revision_id(self):
 
196
        """Return new revision-id."""
 
197
        return generate_ids.gen_revision_id(self._config.username(),
 
198
                                            self._timestamp)
 
199
 
 
200
    def _generate_revision_if_needed(self):
 
201
        """Create a revision id if None was supplied.
 
202
        
 
203
        If the repository can not support user-specified revision ids
 
204
        they should override this function and raise CannotSetRevisionId
 
205
        if _new_revision_id is not None.
 
206
 
 
207
        :raises: CannotSetRevisionId
 
208
        """
 
209
        if self._new_revision_id is None:
 
210
            self._new_revision_id = self._gen_revision_id()
 
211
            self.random_revid = True
 
212
        else:
 
213
            self.random_revid = False
 
214
 
 
215
    def _heads(self, file_id, revision_ids):
 
216
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
217
 
 
218
        This can use either a per-file graph or a global revision graph as we
 
219
        have an identity relationship between the two graphs.
 
220
        """
 
221
        return self.__heads(revision_ids)
 
222
 
 
223
    def _check_root(self, ie, parent_invs, tree):
 
224
        """Helper for record_entry_contents.
 
225
 
 
226
        :param ie: An entry being added.
 
227
        :param parent_invs: The inventories of the parent revisions of the
 
228
            commit.
 
229
        :param tree: The tree that is being committed.
 
230
        """
 
231
        # In this revision format, root entries have no knit or weave When
 
232
        # serializing out to disk and back in root.revision is always
 
233
        # _new_revision_id
 
234
        ie.revision = self._new_revision_id
 
235
 
 
236
    def _get_delta(self, ie, basis_inv, path):
 
237
        """Get a delta against the basis inventory for ie."""
 
238
        if ie.file_id not in basis_inv:
 
239
            # add
 
240
            result = (None, path, ie.file_id, ie)
 
241
            self._basis_delta.append(result)
 
242
            return result
 
243
        elif ie != basis_inv[ie.file_id]:
 
244
            # common but altered
 
245
            # TODO: avoid tis id2path call.
 
246
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
247
            self._basis_delta.append(result)
 
248
            return result
 
249
        else:
 
250
            # common, unaltered
 
251
            return None
 
252
 
 
253
    def get_basis_delta(self):
 
254
        """Return the complete inventory delta versus the basis inventory.
 
255
 
 
256
        This has been built up with the calls to record_delete and
 
257
        record_entry_contents. The client must have already called
 
258
        will_record_deletes() to indicate that they will be generating a
 
259
        complete delta.
 
260
 
 
261
        :return: An inventory delta, suitable for use with apply_delta, or
 
262
            Repository.add_inventory_by_delta, etc.
 
263
        """
 
264
        if not self._recording_deletes:
 
265
            raise AssertionError("recording deletes not activated.")
 
266
        return self._basis_delta
 
267
 
 
268
    def record_delete(self, path, file_id):
 
269
        """Record that a delete occured against a basis tree.
 
270
 
 
271
        This is an optional API - when used it adds items to the basis_delta
 
272
        being accumulated by the commit builder. It cannot be called unless the
 
273
        method will_record_deletes() has been called to inform the builder that
 
274
        a delta is being supplied.
 
275
 
 
276
        :param path: The path of the thing deleted.
 
277
        :param file_id: The file id that was deleted.
 
278
        """
 
279
        if not self._recording_deletes:
 
280
            raise AssertionError("recording deletes not activated.")
 
281
        delta = (path, None, file_id, None)
 
282
        self._basis_delta.append(delta)
 
283
        return delta
 
284
 
 
285
    def will_record_deletes(self):
 
286
        """Tell the commit builder that deletes are being notified.
 
287
 
 
288
        This enables the accumulation of an inventory delta; for the resulting
 
289
        commit to be valid, deletes against the basis MUST be recorded via
 
290
        builder.record_delete().
 
291
        """
 
292
        self._recording_deletes = True
 
293
 
 
294
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
295
        content_summary):
 
296
        """Record the content of ie from tree into the commit if needed.
 
297
 
 
298
        Side effect: sets ie.revision when unchanged
 
299
 
 
300
        :param ie: An inventory entry present in the commit.
 
301
        :param parent_invs: The inventories of the parent revisions of the
 
302
            commit.
 
303
        :param path: The path the entry is at in the tree.
 
304
        :param tree: The tree which contains this entry and should be used to 
 
305
            obtain content.
 
306
        :param content_summary: Summary data from the tree about the paths
 
307
            content - stat, length, exec, sha/link target. This is only
 
308
            accessed when the entry has a revision of None - that is when it is
 
309
            a candidate to commit.
 
310
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
311
            change_delta is an inventory_delta change for this entry against
 
312
            the basis tree of the commit, or None if no change occured against
 
313
            the basis tree.
 
314
            version_recorded is True if a new version of the entry has been
 
315
            recorded. For instance, committing a merge where a file was only
 
316
            changed on the other side will return (delta, False).
 
317
            fs_hash is either None, or the hash details for the path (currently
 
318
            a tuple of the contents sha1 and the statvalue returned by
 
319
            tree.get_file_with_stat()).
 
320
        """
 
321
        if self.new_inventory.root is None:
 
322
            if ie.parent_id is not None:
 
323
                raise errors.RootMissing()
 
324
            self._check_root(ie, parent_invs, tree)
 
325
        if ie.revision is None:
 
326
            kind = content_summary[0]
 
327
        else:
 
328
            # ie is carried over from a prior commit
 
329
            kind = ie.kind
 
330
        # XXX: repository specific check for nested tree support goes here - if
 
331
        # the repo doesn't want nested trees we skip it ?
 
332
        if (kind == 'tree-reference' and
 
333
            not self.repository._format.supports_tree_reference):
 
334
            # mismatch between commit builder logic and repository:
 
335
            # this needs the entry creation pushed down into the builder.
 
336
            raise NotImplementedError('Missing repository subtree support.')
 
337
        self.new_inventory.add(ie)
 
338
 
 
339
        # TODO: slow, take it out of the inner loop.
 
340
        try:
 
341
            basis_inv = parent_invs[0]
 
342
        except IndexError:
 
343
            basis_inv = Inventory(root_id=None)
 
344
 
 
345
        # ie.revision is always None if the InventoryEntry is considered
 
346
        # for committing. We may record the previous parents revision if the
 
347
        # content is actually unchanged against a sole head.
 
348
        if ie.revision is not None:
 
349
            if not self._versioned_root and path == '':
 
350
                # repositories that do not version the root set the root's
 
351
                # revision to the new commit even when no change occurs (more
 
352
                # specifically, they do not record a revision on the root; and
 
353
                # the rev id is assigned to the root during deserialisation -
 
354
                # this masks when a change may have occurred against the basis.
 
355
                # To match this we always issue a delta, because the revision
 
356
                # of the root will always be changing.
 
357
                if ie.file_id in basis_inv:
 
358
                    delta = (basis_inv.id2path(ie.file_id), path,
 
359
                        ie.file_id, ie)
 
360
                else:
 
361
                    # add
 
362
                    delta = (None, path, ie.file_id, ie)
 
363
                self._basis_delta.append(delta)
 
364
                return delta, False, None
 
365
            else:
 
366
                # we don't need to commit this, because the caller already
 
367
                # determined that an existing revision of this file is
 
368
                # appropriate. If its not being considered for committing then
 
369
                # it and all its parents to the root must be unaltered so
 
370
                # no-change against the basis.
 
371
                if ie.revision == self._new_revision_id:
 
372
                    raise AssertionError("Impossible situation, a skipped "
 
373
                        "inventory entry (%r) claims to be modified in this "
 
374
                        "commit (%r).", (ie, self._new_revision_id))
 
375
                return None, False, None
 
376
        # XXX: Friction: parent_candidates should return a list not a dict
 
377
        #      so that we don't have to walk the inventories again.
 
378
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
379
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
380
        heads = []
 
381
        for inv in parent_invs:
 
382
            if ie.file_id in inv:
 
383
                old_rev = inv[ie.file_id].revision
 
384
                if old_rev in head_set:
 
385
                    heads.append(inv[ie.file_id].revision)
 
386
                    head_set.remove(inv[ie.file_id].revision)
 
387
 
 
388
        store = False
 
389
        # now we check to see if we need to write a new record to the
 
390
        # file-graph.
 
391
        # We write a new entry unless there is one head to the ancestors, and
 
392
        # the kind-derived content is unchanged.
 
393
 
 
394
        # Cheapest check first: no ancestors, or more the one head in the
 
395
        # ancestors, we write a new node.
 
396
        if len(heads) != 1:
 
397
            store = True
 
398
        if not store:
 
399
            # There is a single head, look it up for comparison
 
400
            parent_entry = parent_candiate_entries[heads[0]]
 
401
            # if the non-content specific data has changed, we'll be writing a
 
402
            # node:
 
403
            if (parent_entry.parent_id != ie.parent_id or
 
404
                parent_entry.name != ie.name):
 
405
                store = True
 
406
        # now we need to do content specific checks:
 
407
        if not store:
 
408
            # if the kind changed the content obviously has
 
409
            if kind != parent_entry.kind:
 
410
                store = True
 
411
        # Stat cache fingerprint feedback for the caller - None as we usually
 
412
        # don't generate one.
 
413
        fingerprint = None
 
414
        if kind == 'file':
 
415
            if content_summary[2] is None:
 
416
                raise ValueError("Files must not have executable = None")
 
417
            if not store:
 
418
                if (# if the file length changed we have to store:
 
419
                    parent_entry.text_size != content_summary[1] or
 
420
                    # if the exec bit has changed we have to store:
 
421
                    parent_entry.executable != content_summary[2]):
 
422
                    store = True
 
423
                elif parent_entry.text_sha1 == content_summary[3]:
 
424
                    # all meta and content is unchanged (using a hash cache
 
425
                    # hit to check the sha)
 
426
                    ie.revision = parent_entry.revision
 
427
                    ie.text_size = parent_entry.text_size
 
428
                    ie.text_sha1 = parent_entry.text_sha1
 
429
                    ie.executable = parent_entry.executable
 
430
                    return self._get_delta(ie, basis_inv, path), False, None
 
431
                else:
 
432
                    # Either there is only a hash change(no hash cache entry,
 
433
                    # or same size content change), or there is no change on
 
434
                    # this file at all.
 
435
                    # Provide the parent's hash to the store layer, so that the
 
436
                    # content is unchanged we will not store a new node.
 
437
                    nostore_sha = parent_entry.text_sha1
 
438
            if store:
 
439
                # We want to record a new node regardless of the presence or
 
440
                # absence of a content change in the file.
 
441
                nostore_sha = None
 
442
            ie.executable = content_summary[2]
 
443
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
444
            try:
 
445
                lines = file_obj.readlines()
 
446
            finally:
 
447
                file_obj.close()
 
448
            try:
 
449
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
450
                    ie.file_id, lines, heads, nostore_sha)
 
451
                # Let the caller know we generated a stat fingerprint.
 
452
                fingerprint = (ie.text_sha1, stat_value)
 
453
            except errors.ExistingContent:
 
454
                # Turns out that the file content was unchanged, and we were
 
455
                # only going to store a new node if it was changed. Carry over
 
456
                # the entry.
 
457
                ie.revision = parent_entry.revision
 
458
                ie.text_size = parent_entry.text_size
 
459
                ie.text_sha1 = parent_entry.text_sha1
 
460
                ie.executable = parent_entry.executable
 
461
                return self._get_delta(ie, basis_inv, path), False, None
 
462
        elif kind == 'directory':
 
463
            if not store:
 
464
                # all data is meta here, nothing specific to directory, so
 
465
                # carry over:
 
466
                ie.revision = parent_entry.revision
 
467
                return self._get_delta(ie, basis_inv, path), False, None
 
468
            lines = []
 
469
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
470
        elif kind == 'symlink':
 
471
            current_link_target = content_summary[3]
 
472
            if not store:
 
473
                # symlink target is not generic metadata, check if it has
 
474
                # changed.
 
475
                if current_link_target != parent_entry.symlink_target:
 
476
                    store = True
 
477
            if not store:
 
478
                # unchanged, carry over.
 
479
                ie.revision = parent_entry.revision
 
480
                ie.symlink_target = parent_entry.symlink_target
 
481
                return self._get_delta(ie, basis_inv, path), False, None
 
482
            ie.symlink_target = current_link_target
 
483
            lines = []
 
484
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
485
        elif kind == 'tree-reference':
 
486
            if not store:
 
487
                if content_summary[3] != parent_entry.reference_revision:
 
488
                    store = True
 
489
            if not store:
 
490
                # unchanged, carry over.
 
491
                ie.reference_revision = parent_entry.reference_revision
 
492
                ie.revision = parent_entry.revision
 
493
                return self._get_delta(ie, basis_inv, path), False, None
 
494
            ie.reference_revision = content_summary[3]
 
495
            lines = []
 
496
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
497
        else:
 
498
            raise NotImplementedError('unknown kind')
 
499
        ie.revision = self._new_revision_id
 
500
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
501
 
 
502
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
503
        # Note: as we read the content directly from the tree, we know its not
 
504
        # been turned into unicode or badly split - but a broken tree
 
505
        # implementation could give us bad output from readlines() so this is
 
506
        # not a guarantee of safety. What would be better is always checking
 
507
        # the content during test suite execution. RBC 20070912
 
508
        parent_keys = tuple((file_id, parent) for parent in parents)
 
509
        return self.repository.texts.add_lines(
 
510
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
511
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
512
            check_content=False)[0:2]
 
513
 
 
514
 
 
515
class RootCommitBuilder(CommitBuilder):
 
516
    """This commitbuilder actually records the root id"""
 
517
    
 
518
    # the root entry gets versioned properly by this builder.
 
519
    _versioned_root = True
 
520
 
 
521
    def _check_root(self, ie, parent_invs, tree):
 
522
        """Helper for record_entry_contents.
 
523
 
 
524
        :param ie: An entry being added.
 
525
        :param parent_invs: The inventories of the parent revisions of the
 
526
            commit.
 
527
        :param tree: The tree that is being committed.
 
528
        """
 
529
 
 
530
 
 
531
######################################################################
 
532
# Repositories
50
533
 
51
534
class Repository(object):
52
535
    """Repository holding history for one or more branches.
55
538
    revisions and file history.  It's normally accessed only by the Branch,
56
539
    which views a particular line of development through that history.
57
540
 
58
 
    The Repository builds on top of Stores and a Transport, which respectively 
59
 
    describe the disk data format and the way of accessing the (possibly 
 
541
    The Repository builds on top of some byte storage facilies (the revisions,
 
542
    signatures, inventories and texts attributes) and a Transport, which
 
543
    respectively provide byte storage and a means to access the (possibly
60
544
    remote) disk.
 
545
 
 
546
    The byte storage facilities are addressed via tuples, which we refer to
 
547
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
548
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
549
    (file_id, revision_id). We use this interface because it allows low
 
550
    friction with the underlying code that implements disk indices, network
 
551
    encoding and other parts of bzrlib.
 
552
 
 
553
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
 
554
        the serialised revisions for the repository. This can be used to obtain
 
555
        revision graph information or to access raw serialised revisions.
 
556
        The result of trying to insert data into the repository via this store
 
557
        is undefined: it should be considered read-only except for implementors
 
558
        of repositories.
 
559
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
560
        the serialised signatures for the repository. This can be used to
 
561
        obtain access to raw serialised signatures.  The result of trying to
 
562
        insert data into the repository via this store is undefined: it should
 
563
        be considered read-only except for implementors of repositories.
 
564
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
565
        the serialised inventories for the repository. This can be used to
 
566
        obtain unserialised inventories.  The result of trying to insert data
 
567
        into the repository via this store is undefined: it should be
 
568
        considered read-only except for implementors of repositories.
 
569
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
570
        texts of files and directories for the repository. This can be used to
 
571
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
572
        is usually a better interface for accessing file texts.
 
573
        The result of trying to insert data into the repository via this store
 
574
        is undefined: it should be considered read-only except for implementors
 
575
        of repositories.
 
576
    :ivar _transport: Transport for file access to repository, typically
 
577
        pointing to .bzr/repository.
61
578
    """
62
579
 
63
 
    @needs_write_lock
64
 
    def add_inventory(self, revid, inv, parents):
65
 
        """Add the inventory inv to the repository as revid.
66
 
        
67
 
        :param parents: The revision ids of the parents that revid
 
580
    # What class to use for a CommitBuilder. Often its simpler to change this
 
581
    # in a Repository class subclass rather than to override
 
582
    # get_commit_builder.
 
583
    _commit_builder_class = CommitBuilder
 
584
    # The search regex used by xml based repositories to determine what things
 
585
    # where changed in a single commit.
 
586
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
587
        r'file_id="(?P<file_id>[^"]+)"'
 
588
        r'.* revision="(?P<revision_id>[^"]+)"'
 
589
        )
 
590
 
 
591
    def abort_write_group(self, suppress_errors=False):
 
592
        """Commit the contents accrued within the current write group.
 
593
 
 
594
        :param suppress_errors: if true, abort_write_group will catch and log
 
595
            unexpected errors that happen during the abort, rather than
 
596
            allowing them to propagate.  Defaults to False.
 
597
 
 
598
        :seealso: start_write_group.
 
599
        """
 
600
        if self._write_group is not self.get_transaction():
 
601
            # has an unlock or relock occured ?
 
602
            raise errors.BzrError('mismatched lock context and write group.')
 
603
        try:
 
604
            self._abort_write_group()
 
605
        except Exception, exc:
 
606
            self._write_group = None
 
607
            if not suppress_errors:
 
608
                raise
 
609
            mutter('abort_write_group failed')
 
610
            log_exception_quietly()
 
611
            note('bzr: ERROR (ignored): %s', exc)
 
612
        self._write_group = None
 
613
 
 
614
    def _abort_write_group(self):
 
615
        """Template method for per-repository write group cleanup.
 
616
        
 
617
        This is called during abort before the write group is considered to be 
 
618
        finished and should cleanup any internal state accrued during the write
 
619
        group. There is no requirement that data handed to the repository be
 
620
        *not* made available - this is not a rollback - but neither should any
 
621
        attempt be made to ensure that data added is fully commited. Abort is
 
622
        invoked when an error has occured so futher disk or network operations
 
623
        may not be possible or may error and if possible should not be
 
624
        attempted.
 
625
        """
 
626
 
 
627
    def add_fallback_repository(self, repository):
 
628
        """Add a repository to use for looking up data not held locally.
 
629
        
 
630
        :param repository: A repository.
 
631
        """
 
632
        if not self._format.supports_external_lookups:
 
633
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
634
        self._check_fallback_repository(repository)
 
635
        self._fallback_repositories.append(repository)
 
636
        self.texts.add_fallback_versioned_files(repository.texts)
 
637
        self.inventories.add_fallback_versioned_files(repository.inventories)
 
638
        self.revisions.add_fallback_versioned_files(repository.revisions)
 
639
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
640
        self._fetch_order = 'topological'
 
641
 
 
642
    def _check_fallback_repository(self, repository):
 
643
        """Check that this repository can fallback to repository safely.
 
644
 
 
645
        Raise an error if not.
 
646
        
 
647
        :param repository: A repository to fallback to.
 
648
        """
 
649
        return InterRepository._assert_same_model(self, repository)
 
650
 
 
651
    def add_inventory(self, revision_id, inv, parents):
 
652
        """Add the inventory inv to the repository as revision_id.
 
653
        
 
654
        :param parents: The revision ids of the parents that revision_id
68
655
                        is known to have and are in the repository already.
69
656
 
70
 
        returns the sha1 of the serialized inventory.
71
 
        """
72
 
        assert inv.revision_id is None or inv.revision_id == revid, \
73
 
            "Mismatch between inventory revision" \
74
 
            " id and insertion revid (%r, %r)" % (inv.revision_id, revid)
75
 
        inv_text = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
76
 
        inv_sha1 = bzrlib.osutils.sha_string(inv_text)
77
 
        inv_vf = self.control_weaves.get_weave('inventory',
78
 
                                               self.get_transaction())
79
 
        self._inventory_add_lines(inv_vf, revid, parents, bzrlib.osutils.split_lines(inv_text))
80
 
        return inv_sha1
81
 
 
82
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
83
 
        final_parents = []
84
 
        for parent in parents:
85
 
            if parent in inv_vf:
86
 
                final_parents.append(parent)
87
 
 
88
 
        inv_vf.add_lines(revid, final_parents, lines)
89
 
 
90
 
    @needs_write_lock
91
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
92
 
        """Add rev to the revision store as rev_id.
93
 
 
94
 
        :param rev_id: the revision id to use.
 
657
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
658
            repository format specific) of the serialized inventory.
 
659
        """
 
660
        if not self.is_in_write_group():
 
661
            raise AssertionError("%r not in write group" % (self,))
 
662
        _mod_revision.check_not_reserved_id(revision_id)
 
663
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
664
            raise AssertionError(
 
665
                "Mismatch between inventory revision"
 
666
                " id and insertion revid (%r, %r)"
 
667
                % (inv.revision_id, revision_id))
 
668
        if inv.root is None:
 
669
            raise AssertionError()
 
670
        inv_lines = self._serialise_inventory_to_lines(inv)
 
671
        return self._inventory_add_lines(revision_id, parents,
 
672
            inv_lines, check_content=False)
 
673
 
 
674
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
675
                               parents):
 
676
        """Add a new inventory expressed as a delta against another revision.
 
677
 
 
678
        :param basis_revision_id: The inventory id the delta was created
 
679
            against. (This does not have to be a direct parent.)
 
680
        :param delta: The inventory delta (see Inventory.apply_delta for
 
681
            details).
 
682
        :param new_revision_id: The revision id that the inventory is being
 
683
            added for.
 
684
        :param parents: The revision ids of the parents that revision_id is
 
685
            known to have and are in the repository already. These are supplied
 
686
            for repositories that depend on the inventory graph for revision
 
687
            graph access, as well as for those that pun ancestry with delta
 
688
            compression.
 
689
 
 
690
        :returns: (validator, new_inv)
 
691
            The validator(which is a sha1 digest, though what is sha'd is
 
692
            repository format specific) of the serialized inventory, and the
 
693
            resulting inventory.
 
694
        """
 
695
        if not self.is_in_write_group():
 
696
            raise AssertionError("%r not in write group" % (self,))
 
697
        _mod_revision.check_not_reserved_id(new_revision_id)
 
698
        basis_tree = self.revision_tree(basis_revision_id)
 
699
        basis_tree.lock_read()
 
700
        try:
 
701
            # Note that this mutates the inventory of basis_tree, which not all
 
702
            # inventory implementations may support: A better idiom would be to
 
703
            # return a new inventory, but as there is no revision tree cache in
 
704
            # repository this is safe for now - RBC 20081013
 
705
            basis_inv = basis_tree.inventory
 
706
            basis_inv.apply_delta(delta)
 
707
            basis_inv.revision_id = new_revision_id
 
708
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
709
                    basis_inv)
 
710
        finally:
 
711
            basis_tree.unlock()
 
712
 
 
713
    def _inventory_add_lines(self, revision_id, parents, lines,
 
714
        check_content=True):
 
715
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
716
        parents = [(parent,) for parent in parents]
 
717
        return self.inventories.add_lines((revision_id,), parents, lines,
 
718
            check_content=check_content)[0]
 
719
 
 
720
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
721
        """Add rev to the revision store as revision_id.
 
722
 
 
723
        :param revision_id: the revision id to use.
95
724
        :param rev: The revision object.
96
725
        :param inv: The inventory for the revision. if None, it will be looked
97
726
                    up in the inventory storer
99
728
                       If supplied its signature_needed method will be used
100
729
                       to determine if a signature should be made.
101
730
        """
 
731
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
732
        #       rev.parent_ids?
 
733
        _mod_revision.check_not_reserved_id(revision_id)
102
734
        if config is not None and config.signature_needed():
103
735
            if inv is None:
104
 
                inv = self.get_inventory(rev_id)
 
736
                inv = self.get_inventory(revision_id)
105
737
            plaintext = Testament(rev, inv).as_short_text()
106
738
            self.store_revision_signature(
107
 
                gpg.GPGStrategy(config), plaintext, rev_id)
108
 
        if not rev_id in self.get_inventory_weave():
 
739
                gpg.GPGStrategy(config), plaintext, revision_id)
 
740
        # check inventory present
 
741
        if not self.inventories.get_parent_map([(revision_id,)]):
109
742
            if inv is None:
110
 
                raise errors.WeaveRevisionNotPresent(rev_id,
111
 
                                                     self.get_inventory_weave())
 
743
                raise errors.WeaveRevisionNotPresent(revision_id,
 
744
                                                     self.inventories)
112
745
            else:
113
746
                # yes, this is not suitable for adding with ghosts.
114
 
                self.add_inventory(rev_id, inv, rev.parent_ids)
115
 
        self._revision_store.add_revision(rev, self.get_transaction())
116
 
 
117
 
    @needs_read_lock
118
 
    def _all_possible_ids(self):
119
 
        """Return all the possible revisions that we could find."""
120
 
        return self.get_inventory_weave().versions()
121
 
 
122
 
    @deprecated_method(zero_nine)
 
747
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
748
                                                        rev.parent_ids)
 
749
        else:
 
750
            key = (revision_id,)
 
751
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
752
        self._add_revision(rev)
 
753
 
 
754
    def _add_revision(self, revision):
 
755
        text = self._serializer.write_revision_to_string(revision)
 
756
        key = (revision.revision_id,)
 
757
        parents = tuple((parent,) for parent in revision.parent_ids)
 
758
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
 
759
 
123
760
    def all_revision_ids(self):
124
761
        """Returns a list of all the revision ids in the repository. 
125
762
 
126
 
        This is deprecated because code should generally work on the graph
127
 
        reachable from a particular revision, and ignore any other revisions
128
 
        that might be present.  There is no direct replacement method.
 
763
        This is conceptually deprecated because code should generally work on
 
764
        the graph reachable from a particular revision, and ignore any other
 
765
        revisions that might be present.  There is no direct replacement
 
766
        method.
129
767
        """
 
768
        if 'evil' in debug.debug_flags:
 
769
            mutter_callsite(2, "all_revision_ids is linear with history.")
130
770
        return self._all_revision_ids()
131
771
 
132
 
    @needs_read_lock
133
772
    def _all_revision_ids(self):
134
773
        """Returns a list of all the revision ids in the repository. 
135
774
 
136
775
        These are in as much topological order as the underlying store can 
137
 
        present: for weaves ghosts may lead to a lack of correctness until
138
 
        the reweave updates the parents list.
 
776
        present.
139
777
        """
140
 
        if self._revision_store.text_store.listable():
141
 
            return self._revision_store.all_revision_ids(self.get_transaction())
142
 
        result = self._all_possible_ids()
143
 
        return self._eliminate_revisions_not_present(result)
 
778
        raise NotImplementedError(self._all_revision_ids)
144
779
 
145
780
    def break_lock(self):
146
781
        """Break a lock if one is present from another instance.
157
792
        Returns a set of the present revisions.
158
793
        """
159
794
        result = []
160
 
        for id in revision_ids:
161
 
            if self.has_revision(id):
162
 
               result.append(id)
163
 
        return result
 
795
        graph = self.get_graph()
 
796
        parent_map = graph.get_parent_map(revision_ids)
 
797
        # The old API returned a list, should this actually be a set?
 
798
        return parent_map.keys()
164
799
 
165
800
    @staticmethod
166
801
    def create(a_bzrdir):
167
802
        """Construct the current default format repository in a_bzrdir."""
168
803
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
169
804
 
170
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
805
    def __init__(self, _format, a_bzrdir, control_files):
171
806
        """instantiate a Repository.
172
807
 
173
808
        :param _format: The format of the repository on disk.
182
817
        # the following are part of the public API for Repository:
183
818
        self.bzrdir = a_bzrdir
184
819
        self.control_files = control_files
185
 
        self._revision_store = _revision_store
186
 
        self.text_store = text_store
187
 
        # backwards compatibility
188
 
        self.weave_store = text_store
 
820
        self._transport = control_files._transport
 
821
        self.base = self._transport.base
 
822
        # for tests
 
823
        self._reconcile_does_inventory_gc = True
 
824
        self._reconcile_fixes_text_parents = False
 
825
        self._reconcile_backsup_inventory = True
189
826
        # not right yet - should be more semantically clear ? 
190
827
        # 
191
 
        self.control_store = control_store
192
 
        self.control_weaves = control_store
193
828
        # TODO: make sure to construct the right store classes, etc, depending
194
829
        # on whether escaping is required.
 
830
        self._warn_if_deprecated()
 
831
        self._write_group = None
 
832
        # Additional places to query for data.
 
833
        self._fallback_repositories = []
 
834
        # What order should fetch operations request streams in?
 
835
        # The default is unordered as that is the cheapest for an origin to
 
836
        # provide.
 
837
        self._fetch_order = 'unordered'
 
838
        # Does this repository use deltas that can be fetched as-deltas ?
 
839
        # (E.g. knits, where the knit deltas can be transplanted intact.
 
840
        # We default to False, which will ensure that enough data to get
 
841
        # a full text out of any fetch stream will be grabbed.
 
842
        self._fetch_uses_deltas = False
 
843
        # Should fetch trigger a reconcile after the fetch? Only needed for
 
844
        # some repository formats that can suffer internal inconsistencies.
 
845
        self._fetch_reconcile = False
 
846
        # An InventoryEntry cache, used during deserialization
 
847
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
195
848
 
196
849
    def __repr__(self):
197
 
        return '%s(%r)' % (self.__class__.__name__, 
198
 
                           self.bzrdir.transport.base)
 
850
        return '%s(%r)' % (self.__class__.__name__,
 
851
                           self.base)
 
852
 
 
853
    def has_same_location(self, other):
 
854
        """Returns a boolean indicating if this repository is at the same
 
855
        location as another repository.
 
856
 
 
857
        This might return False even when two repository objects are accessing
 
858
        the same physical repository via different URLs.
 
859
        """
 
860
        if self.__class__ is not other.__class__:
 
861
            return False
 
862
        return (self._transport.base == other._transport.base)
 
863
 
 
864
    def is_in_write_group(self):
 
865
        """Return True if there is an open write group.
 
866
 
 
867
        :seealso: start_write_group.
 
868
        """
 
869
        return self._write_group is not None
199
870
 
200
871
    def is_locked(self):
201
872
        return self.control_files.is_locked()
202
873
 
203
 
    def lock_write(self):
204
 
        self.control_files.lock_write()
 
874
    def is_write_locked(self):
 
875
        """Return True if this object is write locked."""
 
876
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
877
 
 
878
    def lock_write(self, token=None):
 
879
        """Lock this repository for writing.
 
880
 
 
881
        This causes caching within the repository obejct to start accumlating
 
882
        data during reads, and allows a 'write_group' to be obtained. Write
 
883
        groups must be used for actual data insertion.
 
884
        
 
885
        :param token: if this is already locked, then lock_write will fail
 
886
            unless the token matches the existing lock.
 
887
        :returns: a token if this instance supports tokens, otherwise None.
 
888
        :raises TokenLockingNotSupported: when a token is given but this
 
889
            instance doesn't support using token locks.
 
890
        :raises MismatchedToken: if the specified token doesn't match the token
 
891
            of the existing lock.
 
892
        :seealso: start_write_group.
 
893
 
 
894
        A token should be passed in if you know that you have locked the object
 
895
        some other way, and need to synchronise this object's state with that
 
896
        fact.
 
897
 
 
898
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
899
        """
 
900
        result = self.control_files.lock_write(token=token)
 
901
        for repo in self._fallback_repositories:
 
902
            # Writes don't affect fallback repos
 
903
            repo.lock_read()
 
904
        self._refresh_data()
 
905
        return result
205
906
 
206
907
    def lock_read(self):
207
908
        self.control_files.lock_read()
 
909
        for repo in self._fallback_repositories:
 
910
            repo.lock_read()
 
911
        self._refresh_data()
208
912
 
209
913
    def get_physical_lock_status(self):
210
914
        return self.control_files.get_physical_lock_status()
211
915
 
212
 
    @needs_read_lock
213
 
    def missing_revision_ids(self, other, revision_id=None):
214
 
        """Return the revision ids that other has that this does not.
215
 
        
216
 
        These are returned in topological order.
217
 
 
218
 
        revision_id: only return revision ids included by revision_id.
219
 
        """
220
 
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
916
    def leave_lock_in_place(self):
 
917
        """Tell this repository not to release the physical lock when this
 
918
        object is unlocked.
 
919
        
 
920
        If lock_write doesn't return a token, then this method is not supported.
 
921
        """
 
922
        self.control_files.leave_in_place()
 
923
 
 
924
    def dont_leave_lock_in_place(self):
 
925
        """Tell this repository to release the physical lock when this
 
926
        object is unlocked, even if it didn't originally acquire it.
 
927
 
 
928
        If lock_write doesn't return a token, then this method is not supported.
 
929
        """
 
930
        self.control_files.dont_leave_in_place()
 
931
 
 
932
    @needs_read_lock
 
933
    def gather_stats(self, revid=None, committers=None):
 
934
        """Gather statistics from a revision id.
 
935
 
 
936
        :param revid: The revision id to gather statistics from, if None, then
 
937
            no revision specific statistics are gathered.
 
938
        :param committers: Optional parameter controlling whether to grab
 
939
            a count of committers from the revision specific statistics.
 
940
        :return: A dictionary of statistics. Currently this contains:
 
941
            committers: The number of committers if requested.
 
942
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
943
                most ancestor of revid, if revid is not the NULL_REVISION.
 
944
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
945
                not the NULL_REVISION.
 
946
            revisions: The total revision count in the repository.
 
947
            size: An estimate disk size of the repository in bytes.
 
948
        """
 
949
        result = {}
 
950
        if revid and committers:
 
951
            result['committers'] = 0
 
952
        if revid and revid != _mod_revision.NULL_REVISION:
 
953
            if committers:
 
954
                all_committers = set()
 
955
            revisions = self.get_ancestry(revid)
 
956
            # pop the leading None
 
957
            revisions.pop(0)
 
958
            first_revision = None
 
959
            if not committers:
 
960
                # ignore the revisions in the middle - just grab first and last
 
961
                revisions = revisions[0], revisions[-1]
 
962
            for revision in self.get_revisions(revisions):
 
963
                if not first_revision:
 
964
                    first_revision = revision
 
965
                if committers:
 
966
                    all_committers.add(revision.committer)
 
967
            last_revision = revision
 
968
            if committers:
 
969
                result['committers'] = len(all_committers)
 
970
            result['firstrev'] = (first_revision.timestamp,
 
971
                first_revision.timezone)
 
972
            result['latestrev'] = (last_revision.timestamp,
 
973
                last_revision.timezone)
 
974
 
 
975
        # now gather global repository information
 
976
        # XXX: This is available for many repos regardless of listability.
 
977
        if self.bzrdir.root_transport.listable():
 
978
            # XXX: do we want to __define len__() ?
 
979
            # Maybe the versionedfiles object should provide a different
 
980
            # method to get the number of keys.
 
981
            result['revisions'] = len(self.revisions.keys())
 
982
            # result['size'] = t
 
983
        return result
 
984
 
 
985
    def find_branches(self, using=False):
 
986
        """Find branches underneath this repository.
 
987
 
 
988
        This will include branches inside other branches.
 
989
 
 
990
        :param using: If True, list only branches using this repository.
 
991
        """
 
992
        if using and not self.is_shared():
 
993
            try:
 
994
                return [self.bzrdir.open_branch()]
 
995
            except errors.NotBranchError:
 
996
                return []
 
997
        class Evaluator(object):
 
998
 
 
999
            def __init__(self):
 
1000
                self.first_call = True
 
1001
 
 
1002
            def __call__(self, bzrdir):
 
1003
                # On the first call, the parameter is always the bzrdir
 
1004
                # containing the current repo.
 
1005
                if not self.first_call:
 
1006
                    try:
 
1007
                        repository = bzrdir.open_repository()
 
1008
                    except errors.NoRepositoryPresent:
 
1009
                        pass
 
1010
                    else:
 
1011
                        return False, (None, repository)
 
1012
                self.first_call = False
 
1013
                try:
 
1014
                    value = (bzrdir.open_branch(), None)
 
1015
                except errors.NotBranchError:
 
1016
                    value = (None, None)
 
1017
                return True, value
 
1018
 
 
1019
        branches = []
 
1020
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1021
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1022
            if branch is not None:
 
1023
                branches.append(branch)
 
1024
            if not using and repository is not None:
 
1025
                branches.extend(repository.find_branches())
 
1026
        return branches
 
1027
 
 
1028
    @needs_read_lock
 
1029
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1030
        """Return the revision ids that other has that this does not.
 
1031
        
 
1032
        These are returned in topological order.
 
1033
 
 
1034
        revision_id: only return revision ids included by revision_id.
 
1035
        """
 
1036
        return InterRepository.get(other, self).search_missing_revision_ids(
 
1037
            revision_id, find_ghosts)
 
1038
 
 
1039
    @deprecated_method(one_two)
 
1040
    @needs_read_lock
 
1041
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1042
        """Return the revision ids that other has that this does not.
 
1043
        
 
1044
        These are returned in topological order.
 
1045
 
 
1046
        revision_id: only return revision ids included by revision_id.
 
1047
        """
 
1048
        keys =  self.search_missing_revision_ids(
 
1049
            other, revision_id, find_ghosts).get_keys()
 
1050
        other.lock_read()
 
1051
        try:
 
1052
            parents = other.get_graph().get_parent_map(keys)
 
1053
        finally:
 
1054
            other.unlock()
 
1055
        return tsort.topo_sort(parents)
221
1056
 
222
1057
    @staticmethod
223
1058
    def open(base):
226
1061
        For instance, if the repository is at URL/.bzr/repository,
227
1062
        Repository.open(URL) -> a Repository instance.
228
1063
        """
229
 
        control = bzrlib.bzrdir.BzrDir.open(base)
 
1064
        control = bzrdir.BzrDir.open(base)
230
1065
        return control.open_repository()
231
1066
 
232
 
    def copy_content_into(self, destination, revision_id=None, basis=None):
 
1067
    def copy_content_into(self, destination, revision_id=None):
233
1068
        """Make a complete copy of the content in self into destination.
234
1069
        
235
1070
        This is a destructive operation! Do not use it on existing 
236
1071
        repositories.
237
1072
        """
238
 
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
239
 
 
240
 
    def fetch(self, source, revision_id=None, pb=None):
 
1073
        return InterRepository.get(self, destination).copy_content(revision_id)
 
1074
 
 
1075
    def commit_write_group(self):
 
1076
        """Commit the contents accrued within the current write group.
 
1077
 
 
1078
        :seealso: start_write_group.
 
1079
        """
 
1080
        if self._write_group is not self.get_transaction():
 
1081
            # has an unlock or relock occured ?
 
1082
            raise errors.BzrError('mismatched lock context %r and '
 
1083
                'write group %r.' %
 
1084
                (self.get_transaction(), self._write_group))
 
1085
        self._commit_write_group()
 
1086
        self._write_group = None
 
1087
 
 
1088
    def _commit_write_group(self):
 
1089
        """Template method for per-repository write group cleanup.
 
1090
        
 
1091
        This is called before the write group is considered to be 
 
1092
        finished and should ensure that all data handed to the repository
 
1093
        for writing during the write group is safely committed (to the 
 
1094
        extent possible considering file system caching etc).
 
1095
        """
 
1096
 
 
1097
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
241
1098
        """Fetch the content required to construct revision_id from source.
242
1099
 
243
1100
        If revision_id is None all content is copied.
 
1101
        :param find_ghosts: Find and copy revisions in the source that are
 
1102
            ghosts in the target (and not reachable directly by walking out to
 
1103
            the first-present revision in target from revision_id).
244
1104
        """
245
 
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
246
 
                                                       pb=pb)
247
 
 
248
 
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
249
 
                           timezone=None, committer=None, revprops=None, 
 
1105
        # fast path same-url fetch operations
 
1106
        if self.has_same_location(source):
 
1107
            # check that last_revision is in 'from' and then return a
 
1108
            # no-operation.
 
1109
            if (revision_id is not None and
 
1110
                not _mod_revision.is_null(revision_id)):
 
1111
                self.get_revision(revision_id)
 
1112
            return 0, []
 
1113
        # if there is no specific appropriate InterRepository, this will get
 
1114
        # the InterRepository base class, which raises an
 
1115
        # IncompatibleRepositories when asked to fetch.
 
1116
        inter = InterRepository.get(source, self)
 
1117
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1118
            find_ghosts=find_ghosts)
 
1119
 
 
1120
    def create_bundle(self, target, base, fileobj, format=None):
 
1121
        return serializer.write_bundle(self, target, base, fileobj, format)
 
1122
 
 
1123
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
1124
                           timezone=None, committer=None, revprops=None,
250
1125
                           revision_id=None):
251
1126
        """Obtain a CommitBuilder for this repository.
252
1127
        
259
1134
        :param revprops: Optional dictionary of revision properties.
260
1135
        :param revision_id: Optional revision id.
261
1136
        """
262
 
        return CommitBuilder(self, parents, config, timestamp, timezone,
263
 
                             committer, revprops, revision_id)
 
1137
        result = self._commit_builder_class(self, parents, config,
 
1138
            timestamp, timezone, committer, revprops, revision_id)
 
1139
        self.start_write_group()
 
1140
        return result
264
1141
 
265
1142
    def unlock(self):
 
1143
        if (self.control_files._lock_count == 1 and
 
1144
            self.control_files._lock_mode == 'w'):
 
1145
            if self._write_group is not None:
 
1146
                self.abort_write_group()
 
1147
                self.control_files.unlock()
 
1148
                raise errors.BzrError(
 
1149
                    'Must end write groups before releasing write locks.')
266
1150
        self.control_files.unlock()
 
1151
        if self.control_files._lock_count == 0:
 
1152
            self._inventory_entry_cache.clear()
 
1153
        for repo in self._fallback_repositories:
 
1154
            repo.unlock()
267
1155
 
268
1156
    @needs_read_lock
269
 
    def clone(self, a_bzrdir, revision_id=None, basis=None):
 
1157
    def clone(self, a_bzrdir, revision_id=None):
270
1158
        """Clone this repository into a_bzrdir using the current format.
271
1159
 
272
1160
        Currently no check is made that the format of this repository and
273
1161
        the bzrdir format are compatible. FIXME RBC 20060201.
274
 
        """
 
1162
 
 
1163
        :return: The newly created destination repository.
 
1164
        """
 
1165
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
1166
        # probably not very useful -- mbp 20070423
 
1167
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
1168
        self.copy_content_into(dest_repo, revision_id)
 
1169
        return dest_repo
 
1170
 
 
1171
    def start_write_group(self):
 
1172
        """Start a write group in the repository.
 
1173
 
 
1174
        Write groups are used by repositories which do not have a 1:1 mapping
 
1175
        between file ids and backend store to manage the insertion of data from
 
1176
        both fetch and commit operations.
 
1177
 
 
1178
        A write lock is required around the start_write_group/commit_write_group
 
1179
        for the support of lock-requiring repository formats.
 
1180
 
 
1181
        One can only insert data into a repository inside a write group.
 
1182
 
 
1183
        :return: None.
 
1184
        """
 
1185
        if not self.is_write_locked():
 
1186
            raise errors.NotWriteLocked(self)
 
1187
        if self._write_group:
 
1188
            raise errors.BzrError('already in a write group')
 
1189
        self._start_write_group()
 
1190
        # so we can detect unlock/relock - the write group is now entered.
 
1191
        self._write_group = self.get_transaction()
 
1192
 
 
1193
    def _start_write_group(self):
 
1194
        """Template method for per-repository write group startup.
 
1195
        
 
1196
        This is called before the write group is considered to be 
 
1197
        entered.
 
1198
        """
 
1199
 
 
1200
    @needs_read_lock
 
1201
    def sprout(self, to_bzrdir, revision_id=None):
 
1202
        """Create a descendent repository for new development.
 
1203
 
 
1204
        Unlike clone, this does not copy the settings of the repository.
 
1205
        """
 
1206
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
1207
        dest_repo.fetch(self, revision_id=revision_id)
 
1208
        return dest_repo
 
1209
 
 
1210
    def _create_sprouting_repo(self, a_bzrdir, shared):
275
1211
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
276
1212
            # use target default format.
277
 
            result = a_bzrdir.create_repository()
278
 
        # FIXME RBC 20060209 split out the repository type to avoid this check ?
279
 
        elif isinstance(a_bzrdir._format,
280
 
                      (bzrlib.bzrdir.BzrDirFormat4,
281
 
                       bzrlib.bzrdir.BzrDirFormat5,
282
 
                       bzrlib.bzrdir.BzrDirFormat6)):
283
 
            result = a_bzrdir.open_repository()
 
1213
            dest_repo = a_bzrdir.create_repository()
284
1214
        else:
285
 
            result = self._format.initialize(a_bzrdir, shared=self.is_shared())
286
 
        self.copy_content_into(result, revision_id, basis)
287
 
        return result
 
1215
            # Most control formats need the repository to be specifically
 
1216
            # created, but on some old all-in-one formats it's not needed
 
1217
            try:
 
1218
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1219
            except errors.UninitializableFormat:
 
1220
                dest_repo = a_bzrdir.open_repository()
 
1221
        return dest_repo
288
1222
 
289
1223
    @needs_read_lock
290
1224
    def has_revision(self, revision_id):
291
1225
        """True if this repository has a copy of the revision."""
292
 
        return self._revision_store.has_revision_id(revision_id,
293
 
                                                    self.get_transaction())
 
1226
        return revision_id in self.has_revisions((revision_id,))
 
1227
 
 
1228
    @needs_read_lock
 
1229
    def has_revisions(self, revision_ids):
 
1230
        """Probe to find out the presence of multiple revisions.
 
1231
 
 
1232
        :param revision_ids: An iterable of revision_ids.
 
1233
        :return: A set of the revision_ids that were present.
 
1234
        """
 
1235
        parent_map = self.revisions.get_parent_map(
 
1236
            [(rev_id,) for rev_id in revision_ids])
 
1237
        result = set()
 
1238
        if _mod_revision.NULL_REVISION in revision_ids:
 
1239
            result.add(_mod_revision.NULL_REVISION)
 
1240
        result.update([key[0] for key in parent_map])
 
1241
        return result
 
1242
 
 
1243
    @needs_read_lock
 
1244
    def get_revision(self, revision_id):
 
1245
        """Return the Revision object for a named revision."""
 
1246
        return self.get_revisions([revision_id])[0]
294
1247
 
295
1248
    @needs_read_lock
296
1249
    def get_revision_reconcile(self, revision_id):
301
1254
        be used by reconcile, or reconcile-alike commands that are correcting
302
1255
        or testing the revision graph.
303
1256
        """
304
 
        if not revision_id or not isinstance(revision_id, basestring):
305
 
            raise InvalidRevisionId(revision_id=revision_id, branch=self)
306
 
        return self._revision_store.get_revision(revision_id,
307
 
                                                 self.get_transaction())
 
1257
        return self._get_revisions([revision_id])[0]
 
1258
 
 
1259
    @needs_read_lock
 
1260
    def get_revisions(self, revision_ids):
 
1261
        """Get many revisions at once."""
 
1262
        return self._get_revisions(revision_ids)
 
1263
 
 
1264
    @needs_read_lock
 
1265
    def _get_revisions(self, revision_ids):
 
1266
        """Core work logic to get many revisions without sanity checks."""
 
1267
        for rev_id in revision_ids:
 
1268
            if not rev_id or not isinstance(rev_id, basestring):
 
1269
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1270
        keys = [(key,) for key in revision_ids]
 
1271
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
 
1272
        revs = {}
 
1273
        for record in stream:
 
1274
            if record.storage_kind == 'absent':
 
1275
                raise errors.NoSuchRevision(self, record.key[0])
 
1276
            text = record.get_bytes_as('fulltext')
 
1277
            rev = self._serializer.read_revision_from_string(text)
 
1278
            revs[record.key[0]] = rev
 
1279
        return [revs[revid] for revid in revision_ids]
308
1280
 
309
1281
    @needs_read_lock
310
1282
    def get_revision_xml(self, revision_id):
311
 
        rev = self.get_revision(revision_id) 
312
 
        rev_tmp = StringIO()
 
1283
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1284
        #       would have already do it.
 
1285
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1286
        rev = self.get_revision(revision_id)
 
1287
        rev_tmp = cStringIO.StringIO()
313
1288
        # the current serializer..
314
 
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1289
        self._serializer.write_revision(rev, rev_tmp)
315
1290
        rev_tmp.seek(0)
316
1291
        return rev_tmp.getvalue()
317
1292
 
 
1293
    def get_deltas_for_revisions(self, revisions):
 
1294
        """Produce a generator of revision deltas.
 
1295
        
 
1296
        Note that the input is a sequence of REVISIONS, not revision_ids.
 
1297
        Trees will be held in memory until the generator exits.
 
1298
        Each delta is relative to the revision's lefthand predecessor.
 
1299
        """
 
1300
        required_trees = set()
 
1301
        for revision in revisions:
 
1302
            required_trees.add(revision.revision_id)
 
1303
            required_trees.update(revision.parent_ids[:1])
 
1304
        trees = dict((t.get_revision_id(), t) for 
 
1305
                     t in self.revision_trees(required_trees))
 
1306
        for revision in revisions:
 
1307
            if not revision.parent_ids:
 
1308
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
1309
            else:
 
1310
                old_tree = trees[revision.parent_ids[0]]
 
1311
            yield trees[revision.revision_id].changes_from(old_tree)
 
1312
 
318
1313
    @needs_read_lock
319
 
    def get_revision(self, revision_id):
320
 
        """Return the Revision object for a named revision"""
321
 
        r = self.get_revision_reconcile(revision_id)
322
 
        # weave corruption can lead to absent revision markers that should be
323
 
        # present.
324
 
        # the following test is reasonably cheap (it needs a single weave read)
325
 
        # and the weave is cached in read transactions. In write transactions
326
 
        # it is not cached but typically we only read a small number of
327
 
        # revisions. For knits when they are introduced we will probably want
328
 
        # to ensure that caching write transactions are in use.
329
 
        inv = self.get_inventory_weave()
330
 
        self._check_revision_parents(r, inv)
331
 
        return r
 
1314
    def get_revision_delta(self, revision_id):
 
1315
        """Return the delta for one revision.
332
1316
 
333
 
    def _check_revision_parents(self, revision, inventory):
334
 
        """Private to Repository and Fetch.
335
 
        
336
 
        This checks the parentage of revision in an inventory weave for 
337
 
        consistency and is only applicable to inventory-weave-for-ancestry
338
 
        using repository formats & fetchers.
 
1317
        The delta is relative to the left-hand predecessor of the
 
1318
        revision.
339
1319
        """
340
 
        weave_parents = inventory.get_parents(revision.revision_id)
341
 
        weave_names = inventory.versions()
342
 
        for parent_id in revision.parent_ids:
343
 
            if parent_id in weave_names:
344
 
                # this parent must not be a ghost.
345
 
                if not parent_id in weave_parents:
346
 
                    # but it is a ghost
347
 
                    raise errors.CorruptRepository(self)
 
1320
        r = self.get_revision(revision_id)
 
1321
        return list(self.get_deltas_for_revisions([r]))[0]
348
1322
 
349
1323
    @needs_write_lock
350
1324
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
351
1325
        signature = gpg_strategy.sign(plaintext)
352
 
        self._revision_store.add_revision_signature_text(revision_id,
353
 
                                                         signature,
354
 
                                                         self.get_transaction())
355
 
 
356
 
    def fileids_altered_by_revision_ids(self, revision_ids):
357
 
        """Find the file ids and versions affected by revisions.
358
 
 
359
 
        :param revisions: an iterable containing revision ids.
360
 
        :return: a dictionary mapping altered file-ids to an iterable of
 
1326
        self.add_signature_text(revision_id, signature)
 
1327
 
 
1328
    @needs_write_lock
 
1329
    def add_signature_text(self, revision_id, signature):
 
1330
        self.signatures.add_lines((revision_id,), (),
 
1331
            osutils.split_lines(signature))
 
1332
 
 
1333
    def find_text_key_references(self):
 
1334
        """Find the text key references within the repository.
 
1335
 
 
1336
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
361
1337
        revision_ids. Each altered file-ids has the exact revision_ids that
362
1338
        altered it listed explicitly.
363
 
        """
364
 
        assert isinstance(self._format, (RepositoryFormat5,
365
 
                                         RepositoryFormat6,
366
 
                                         RepositoryFormat7,
367
 
                                         RepositoryFormatKnit1)), \
368
 
            ("fileids_altered_by_revision_ids only supported for branches " 
369
 
             "which store inventory as unnested xml, not on %r" % self)
370
 
        selected_revision_ids = set(revision_ids)
371
 
        w = self.get_inventory_weave()
 
1339
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1340
            to whether they were referred to by the inventory of the
 
1341
            revision_id that they contain. The inventory texts from all present
 
1342
            revision ids are assessed to generate this report.
 
1343
        """
 
1344
        revision_keys = self.revisions.keys()
 
1345
        w = self.inventories
 
1346
        pb = ui.ui_factory.nested_progress_bar()
 
1347
        try:
 
1348
            return self._find_text_key_references_from_xml_inventory_lines(
 
1349
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1350
        finally:
 
1351
            pb.finished()
 
1352
 
 
1353
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1354
        line_iterator):
 
1355
        """Core routine for extracting references to texts from inventories.
 
1356
 
 
1357
        This performs the translation of xml lines to revision ids.
 
1358
 
 
1359
        :param line_iterator: An iterator of lines, origin_version_id
 
1360
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1361
            to whether they were referred to by the inventory of the
 
1362
            revision_id that they contain. Note that if that revision_id was
 
1363
            not part of the line_iterator's output then False will be given -
 
1364
            even though it may actually refer to that key.
 
1365
        """
 
1366
        if not self._serializer.support_altered_by_hack:
 
1367
            raise AssertionError(
 
1368
                "_find_text_key_references_from_xml_inventory_lines only "
 
1369
                "supported for branches which store inventory as unnested xml"
 
1370
                ", not on %r" % self)
372
1371
        result = {}
373
1372
 
374
1373
        # this code needs to read every new line in every inventory for the
379
1378
        # revisions. We don't need to see all lines in the inventory because
380
1379
        # only those added in an inventory in rev X can contain a revision=X
381
1380
        # line.
382
 
        for line in w.iter_lines_added_or_present_in_versions(selected_revision_ids):
383
 
            start = line.find('file_id="')+9
384
 
            if start < 9: continue
385
 
            end = line.find('"', start)
386
 
            assert end>= 0
387
 
            file_id = _unescape_xml(line[start:end])
388
 
 
389
 
            start = line.find('revision="')+10
390
 
            if start < 10: continue
391
 
            end = line.find('"', start)
392
 
            assert end>= 0
393
 
            revision_id = _unescape_xml(line[start:end])
394
 
            if revision_id in selected_revision_ids:
395
 
                result.setdefault(file_id, set()).add(revision_id)
396
 
        return result
397
 
 
398
 
    @needs_read_lock
399
 
    def get_inventory_weave(self):
400
 
        return self.control_weaves.get_weave('inventory',
401
 
            self.get_transaction())
 
1381
        unescape_revid_cache = {}
 
1382
        unescape_fileid_cache = {}
 
1383
 
 
1384
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1385
        # of lines, so it has had a lot of inlining and optimizing done.
 
1386
        # Sorry that it is a little bit messy.
 
1387
        # Move several functions to be local variables, since this is a long
 
1388
        # running loop.
 
1389
        search = self._file_ids_altered_regex.search
 
1390
        unescape = _unescape_xml
 
1391
        setdefault = result.setdefault
 
1392
        for line, line_key in line_iterator:
 
1393
            match = search(line)
 
1394
            if match is None:
 
1395
                continue
 
1396
            # One call to match.group() returning multiple items is quite a
 
1397
            # bit faster than 2 calls to match.group() each returning 1
 
1398
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1399
 
 
1400
            # Inlining the cache lookups helps a lot when you make 170,000
 
1401
            # lines and 350k ids, versus 8.4 unique ids.
 
1402
            # Using a cache helps in 2 ways:
 
1403
            #   1) Avoids unnecessary decoding calls
 
1404
            #   2) Re-uses cached strings, which helps in future set and
 
1405
            #      equality checks.
 
1406
            # (2) is enough that removing encoding entirely along with
 
1407
            # the cache (so we are using plain strings) results in no
 
1408
            # performance improvement.
 
1409
            try:
 
1410
                revision_id = unescape_revid_cache[revision_id]
 
1411
            except KeyError:
 
1412
                unescaped = unescape(revision_id)
 
1413
                unescape_revid_cache[revision_id] = unescaped
 
1414
                revision_id = unescaped
 
1415
 
 
1416
            # Note that unconditionally unescaping means that we deserialise
 
1417
            # every fileid, which for general 'pull' is not great, but we don't
 
1418
            # really want to have some many fulltexts that this matters anyway.
 
1419
            # RBC 20071114.
 
1420
            try:
 
1421
                file_id = unescape_fileid_cache[file_id]
 
1422
            except KeyError:
 
1423
                unescaped = unescape(file_id)
 
1424
                unescape_fileid_cache[file_id] = unescaped
 
1425
                file_id = unescaped
 
1426
 
 
1427
            key = (file_id, revision_id)
 
1428
            setdefault(key, False)
 
1429
            if revision_id == line_key[-1]:
 
1430
                result[key] = True
 
1431
        return result
 
1432
 
 
1433
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1434
        revision_ids):
 
1435
        """Helper routine for fileids_altered_by_revision_ids.
 
1436
 
 
1437
        This performs the translation of xml lines to revision ids.
 
1438
 
 
1439
        :param line_iterator: An iterator of lines, origin_version_id
 
1440
        :param revision_ids: The revision ids to filter for. This should be a
 
1441
            set or other type which supports efficient __contains__ lookups, as
 
1442
            the revision id from each parsed line will be looked up in the
 
1443
            revision_ids filter.
 
1444
        :return: a dictionary mapping altered file-ids to an iterable of
 
1445
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1446
        altered it listed explicitly.
 
1447
        """
 
1448
        result = {}
 
1449
        setdefault = result.setdefault
 
1450
        for key in \
 
1451
            self._find_text_key_references_from_xml_inventory_lines(
 
1452
                line_iterator).iterkeys():
 
1453
            # once data is all ensured-consistent; then this is
 
1454
            # if revision_id == version_id
 
1455
            if key[-1:] in revision_ids:
 
1456
                setdefault(key[0], set()).add(key[-1])
 
1457
        return result
 
1458
 
 
1459
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
 
1460
        """Find the file ids and versions affected by revisions.
 
1461
 
 
1462
        :param revisions: an iterable containing revision ids.
 
1463
        :param _inv_weave: The inventory weave from this repository or None.
 
1464
            If None, the inventory weave will be opened automatically.
 
1465
        :return: a dictionary mapping altered file-ids to an iterable of
 
1466
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1467
        altered it listed explicitly.
 
1468
        """
 
1469
        selected_keys = set((revid,) for revid in revision_ids)
 
1470
        w = _inv_weave or self.inventories
 
1471
        pb = ui.ui_factory.nested_progress_bar()
 
1472
        try:
 
1473
            return self._find_file_ids_from_xml_inventory_lines(
 
1474
                w.iter_lines_added_or_present_in_keys(
 
1475
                    selected_keys, pb=pb),
 
1476
                selected_keys)
 
1477
        finally:
 
1478
            pb.finished()
 
1479
 
 
1480
    def iter_files_bytes(self, desired_files):
 
1481
        """Iterate through file versions.
 
1482
 
 
1483
        Files will not necessarily be returned in the order they occur in
 
1484
        desired_files.  No specific order is guaranteed.
 
1485
 
 
1486
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
1487
        value supplied by the caller as part of desired_files.  It should
 
1488
        uniquely identify the file version in the caller's context.  (Examples:
 
1489
        an index number or a TreeTransform trans_id.)
 
1490
 
 
1491
        bytes_iterator is an iterable of bytestrings for the file.  The
 
1492
        kind of iterable and length of the bytestrings are unspecified, but for
 
1493
        this implementation, it is a list of bytes produced by
 
1494
        VersionedFile.get_record_stream().
 
1495
 
 
1496
        :param desired_files: a list of (file_id, revision_id, identifier)
 
1497
            triples
 
1498
        """
 
1499
        text_keys = {}
 
1500
        for file_id, revision_id, callable_data in desired_files:
 
1501
            text_keys[(file_id, revision_id)] = callable_data
 
1502
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
 
1503
            if record.storage_kind == 'absent':
 
1504
                raise errors.RevisionNotPresent(record.key, self)
 
1505
            yield text_keys[record.key], record.get_bytes_as('fulltext')
 
1506
 
 
1507
    def _generate_text_key_index(self, text_key_references=None,
 
1508
        ancestors=None):
 
1509
        """Generate a new text key index for the repository.
 
1510
 
 
1511
        This is an expensive function that will take considerable time to run.
 
1512
 
 
1513
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
1514
            list of parents, also text keys. When a given key has no parents,
 
1515
            the parents list will be [NULL_REVISION].
 
1516
        """
 
1517
        # All revisions, to find inventory parents.
 
1518
        if ancestors is None:
 
1519
            graph = self.get_graph()
 
1520
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
1521
        if text_key_references is None:
 
1522
            text_key_references = self.find_text_key_references()
 
1523
        pb = ui.ui_factory.nested_progress_bar()
 
1524
        try:
 
1525
            return self._do_generate_text_key_index(ancestors,
 
1526
                text_key_references, pb)
 
1527
        finally:
 
1528
            pb.finished()
 
1529
 
 
1530
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
1531
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
1532
        revision_order = tsort.topo_sort(ancestors)
 
1533
        invalid_keys = set()
 
1534
        revision_keys = {}
 
1535
        for revision_id in revision_order:
 
1536
            revision_keys[revision_id] = set()
 
1537
        text_count = len(text_key_references)
 
1538
        # a cache of the text keys to allow reuse; costs a dict of all the
 
1539
        # keys, but saves a 2-tuple for every child of a given key.
 
1540
        text_key_cache = {}
 
1541
        for text_key, valid in text_key_references.iteritems():
 
1542
            if not valid:
 
1543
                invalid_keys.add(text_key)
 
1544
            else:
 
1545
                revision_keys[text_key[1]].add(text_key)
 
1546
            text_key_cache[text_key] = text_key
 
1547
        del text_key_references
 
1548
        text_index = {}
 
1549
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
1550
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1551
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
1552
        # too small for large or very branchy trees. However, for 55K path
 
1553
        # trees, it would be easy to use too much memory trivially. Ideally we
 
1554
        # could gauge this by looking at available real memory etc, but this is
 
1555
        # always a tricky proposition.
 
1556
        inventory_cache = lru_cache.LRUCache(10)
 
1557
        batch_size = 10 # should be ~150MB on a 55K path tree
 
1558
        batch_count = len(revision_order) / batch_size + 1
 
1559
        processed_texts = 0
 
1560
        pb.update("Calculating text parents.", processed_texts, text_count)
 
1561
        for offset in xrange(batch_count):
 
1562
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
1563
                batch_size]
 
1564
            if not to_query:
 
1565
                break
 
1566
            for rev_tree in self.revision_trees(to_query):
 
1567
                revision_id = rev_tree.get_revision_id()
 
1568
                parent_ids = ancestors[revision_id]
 
1569
                for text_key in revision_keys[revision_id]:
 
1570
                    pb.update("Calculating text parents.", processed_texts)
 
1571
                    processed_texts += 1
 
1572
                    candidate_parents = []
 
1573
                    for parent_id in parent_ids:
 
1574
                        parent_text_key = (text_key[0], parent_id)
 
1575
                        try:
 
1576
                            check_parent = parent_text_key not in \
 
1577
                                revision_keys[parent_id]
 
1578
                        except KeyError:
 
1579
                            # the parent parent_id is a ghost:
 
1580
                            check_parent = False
 
1581
                            # truncate the derived graph against this ghost.
 
1582
                            parent_text_key = None
 
1583
                        if check_parent:
 
1584
                            # look at the parent commit details inventories to
 
1585
                            # determine possible candidates in the per file graph.
 
1586
                            # TODO: cache here.
 
1587
                            try:
 
1588
                                inv = inventory_cache[parent_id]
 
1589
                            except KeyError:
 
1590
                                inv = self.revision_tree(parent_id).inventory
 
1591
                                inventory_cache[parent_id] = inv
 
1592
                            parent_entry = inv._byid.get(text_key[0], None)
 
1593
                            if parent_entry is not None:
 
1594
                                parent_text_key = (
 
1595
                                    text_key[0], parent_entry.revision)
 
1596
                            else:
 
1597
                                parent_text_key = None
 
1598
                        if parent_text_key is not None:
 
1599
                            candidate_parents.append(
 
1600
                                text_key_cache[parent_text_key])
 
1601
                    parent_heads = text_graph.heads(candidate_parents)
 
1602
                    new_parents = list(parent_heads)
 
1603
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
1604
                    if new_parents == []:
 
1605
                        new_parents = [NULL_REVISION]
 
1606
                    text_index[text_key] = new_parents
 
1607
 
 
1608
        for text_key in invalid_keys:
 
1609
            text_index[text_key] = [NULL_REVISION]
 
1610
        return text_index
 
1611
 
 
1612
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1613
        """Get an iterable listing the keys of all the data introduced by a set
 
1614
        of revision IDs.
 
1615
 
 
1616
        The keys will be ordered so that the corresponding items can be safely
 
1617
        fetched and inserted in that order.
 
1618
 
 
1619
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
1620
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
1621
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
1622
        """
 
1623
        # XXX: it's a bit weird to control the inventory weave caching in this
 
1624
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
1625
        # maybe this generator should explicitly have the contract that it
 
1626
        # should not be iterated until the previously yielded item has been
 
1627
        # processed?
 
1628
        inv_w = self.inventories
 
1629
 
 
1630
        # file ids that changed
 
1631
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
1632
        count = 0
 
1633
        num_file_ids = len(file_ids)
 
1634
        for file_id, altered_versions in file_ids.iteritems():
 
1635
            if _files_pb is not None:
 
1636
                _files_pb.update("fetch texts", count, num_file_ids)
 
1637
            count += 1
 
1638
            yield ("file", file_id, altered_versions)
 
1639
        # We're done with the files_pb.  Note that it finished by the caller,
 
1640
        # just as it was created by the caller.
 
1641
        del _files_pb
 
1642
 
 
1643
        # inventory
 
1644
        yield ("inventory", None, revision_ids)
 
1645
 
 
1646
        # signatures
 
1647
        # XXX: Note ATM no callers actually pay attention to this return
 
1648
        #      instead they just use the list of revision ids and ignore
 
1649
        #      missing sigs. Consider removing this work entirely
 
1650
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
1651
            [(r,) for r in revision_ids]))
 
1652
        revisions_with_signatures = set(
 
1653
            [r for (r,) in revisions_with_signatures])
 
1654
        revisions_with_signatures.intersection_update(revision_ids)
 
1655
        yield ("signatures", None, revisions_with_signatures)
 
1656
 
 
1657
        # revisions
 
1658
        yield ("revisions", None, revision_ids)
402
1659
 
403
1660
    @needs_read_lock
404
1661
    def get_inventory(self, revision_id):
405
 
        """Get Inventory object by hash."""
406
 
        return self.deserialise_inventory(
407
 
            revision_id, self.get_inventory_xml(revision_id))
 
1662
        """Get Inventory object by revision id."""
 
1663
        return self.iter_inventories([revision_id]).next()
 
1664
 
 
1665
    def iter_inventories(self, revision_ids):
 
1666
        """Get many inventories by revision_ids.
 
1667
 
 
1668
        This will buffer some or all of the texts used in constructing the
 
1669
        inventories in memory, but will only parse a single inventory at a
 
1670
        time.
 
1671
 
 
1672
        :return: An iterator of inventories.
 
1673
        """
 
1674
        if ((None in revision_ids)
 
1675
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1676
            raise ValueError('cannot get null revision inventory')
 
1677
        return self._iter_inventories(revision_ids)
 
1678
 
 
1679
    def _iter_inventories(self, revision_ids):
 
1680
        """single-document based inventory iteration."""
 
1681
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
1682
            yield self.deserialise_inventory(revision_id, text)
 
1683
 
 
1684
    def _iter_inventory_xmls(self, revision_ids):
 
1685
        keys = [(revision_id,) for revision_id in revision_ids]
 
1686
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1687
        text_chunks = {}
 
1688
        for record in stream:
 
1689
            if record.storage_kind != 'absent':
 
1690
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
1691
            else:
 
1692
                raise errors.NoSuchRevision(self, record.key)
 
1693
        for key in keys:
 
1694
            chunks = text_chunks.pop(key)
 
1695
            yield ''.join(chunks), key[-1]
408
1696
 
409
1697
    def deserialise_inventory(self, revision_id, xml):
410
1698
        """Transform the xml into an inventory object. 
412
1700
        :param revision_id: The expected revision id of the inventory.
413
1701
        :param xml: A serialised inventory.
414
1702
        """
415
 
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
1703
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
1704
                    entry_cache=self._inventory_entry_cache)
 
1705
        if result.revision_id != revision_id:
 
1706
            raise AssertionError('revision id mismatch %s != %s' % (
 
1707
                result.revision_id, revision_id))
 
1708
        return result
 
1709
 
 
1710
    def serialise_inventory(self, inv):
 
1711
        return self._serializer.write_inventory_to_string(inv)
 
1712
 
 
1713
    def _serialise_inventory_to_lines(self, inv):
 
1714
        return self._serializer.write_inventory_to_lines(inv)
 
1715
 
 
1716
    def get_serializer_format(self):
 
1717
        return self._serializer.format_num
416
1718
 
417
1719
    @needs_read_lock
418
1720
    def get_inventory_xml(self, revision_id):
419
1721
        """Get inventory XML as a file object."""
 
1722
        texts = self._iter_inventory_xmls([revision_id])
420
1723
        try:
421
 
            assert isinstance(revision_id, basestring), type(revision_id)
422
 
            iw = self.get_inventory_weave()
423
 
            return iw.get_text(revision_id)
424
 
        except IndexError:
425
 
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
1724
            text, revision_id = texts.next()
 
1725
        except StopIteration:
 
1726
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
1727
        return text
426
1728
 
427
1729
    @needs_read_lock
428
1730
    def get_inventory_sha1(self, revision_id):
430
1732
        """
431
1733
        return self.get_revision(revision_id).inventory_sha1
432
1734
 
433
 
    @needs_read_lock
434
 
    def get_revision_graph(self, revision_id=None):
435
 
        """Return a dictionary containing the revision graph.
436
 
        
437
 
        :return: a dictionary of revision_id->revision_parents_list.
438
 
        """
439
 
        weave = self.get_inventory_weave()
440
 
        all_revisions = self._eliminate_revisions_not_present(weave.versions())
441
 
        entire_graph = dict([(node, weave.get_parents(node)) for 
442
 
                             node in all_revisions])
443
 
        if revision_id is None:
444
 
            return entire_graph
445
 
        elif revision_id not in entire_graph:
446
 
            raise errors.NoSuchRevision(self, revision_id)
447
 
        else:
448
 
            # add what can be reached from revision_id
449
 
            result = {}
450
 
            pending = set([revision_id])
451
 
            while len(pending) > 0:
452
 
                node = pending.pop()
453
 
                result[node] = entire_graph[node]
454
 
                for revision_id in result[node]:
455
 
                    if revision_id not in result:
456
 
                        pending.add(revision_id)
457
 
            return result
458
 
 
459
 
    @needs_read_lock
460
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
461
 
        """Return a graph of the revisions with ghosts marked as applicable.
462
 
 
463
 
        :param revision_ids: an iterable of revisions to graph or None for all.
464
 
        :return: a Graph object with the graph reachable from revision_ids.
465
 
        """
466
 
        result = Graph()
467
 
        if not revision_ids:
468
 
            pending = set(self.all_revision_ids())
469
 
            required = set([])
470
 
        else:
471
 
            pending = set(revision_ids)
472
 
            required = set(revision_ids)
473
 
        done = set([])
474
 
        while len(pending):
475
 
            revision_id = pending.pop()
476
 
            try:
477
 
                rev = self.get_revision(revision_id)
478
 
            except errors.NoSuchRevision:
479
 
                if revision_id in required:
480
 
                    raise
481
 
                # a ghost
482
 
                result.add_ghost(revision_id)
483
 
                continue
484
 
            for parent_id in rev.parent_ids:
485
 
                # is this queued or done ?
486
 
                if (parent_id not in pending and
487
 
                    parent_id not in done):
488
 
                    # no, queue it.
489
 
                    pending.add(parent_id)
490
 
            result.add_node(revision_id, rev.parent_ids)
491
 
            done.add(revision_id)
492
 
        return result
 
1735
    def iter_reverse_revision_history(self, revision_id):
 
1736
        """Iterate backwards through revision ids in the lefthand history
 
1737
 
 
1738
        :param revision_id: The revision id to start with.  All its lefthand
 
1739
            ancestors will be traversed.
 
1740
        """
 
1741
        graph = self.get_graph()
 
1742
        next_id = revision_id
 
1743
        while True:
 
1744
            if next_id in (None, _mod_revision.NULL_REVISION):
 
1745
                return
 
1746
            yield next_id
 
1747
            # Note: The following line may raise KeyError in the event of
 
1748
            # truncated history. We decided not to have a try:except:raise
 
1749
            # RevisionNotPresent here until we see a use for it, because of the
 
1750
            # cost in an inner loop that is by its very nature O(history).
 
1751
            # Robert Collins 20080326
 
1752
            parents = graph.get_parent_map([next_id])[next_id]
 
1753
            if len(parents) == 0:
 
1754
                return
 
1755
            else:
 
1756
                next_id = parents[0]
493
1757
 
494
1758
    @needs_read_lock
495
1759
    def get_revision_inventory(self, revision_id):
507
1771
        else:
508
1772
            return self.get_inventory(revision_id)
509
1773
 
510
 
    @needs_read_lock
511
1774
    def is_shared(self):
512
1775
        """Return True if this repository is flagged as a shared repository."""
513
1776
        raise NotImplementedError(self.is_shared)
519
1782
        reconciler = RepoReconciler(self, thorough=thorough)
520
1783
        reconciler.reconcile()
521
1784
        return reconciler
522
 
    
 
1785
 
 
1786
    def _refresh_data(self):
 
1787
        """Helper called from lock_* to ensure coherency with disk.
 
1788
 
 
1789
        The default implementation does nothing; it is however possible
 
1790
        for repositories to maintain loaded indices across multiple locks
 
1791
        by checking inside their implementation of this method to see
 
1792
        whether their indices are still valid. This depends of course on
 
1793
        the disk format being validatable in this manner.
 
1794
        """
 
1795
 
523
1796
    @needs_read_lock
524
1797
    def revision_tree(self, revision_id):
525
1798
        """Return Tree for a revision on this branch.
526
1799
 
527
 
        `revision_id` may be None for the null revision, in which case
528
 
        an `EmptyTree` is returned."""
 
1800
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
1801
        """
 
1802
        revision_id = _mod_revision.ensure_null(revision_id)
529
1803
        # TODO: refactor this to use an existing revision object
530
1804
        # so we don't need to read it in twice.
531
 
        if revision_id is None or revision_id == NULL_REVISION:
532
 
            return EmptyTree()
 
1805
        if revision_id == _mod_revision.NULL_REVISION:
 
1806
            return RevisionTree(self, Inventory(root_id=None), 
 
1807
                                _mod_revision.NULL_REVISION)
533
1808
        else:
534
1809
            inv = self.get_revision_inventory(revision_id)
535
1810
            return RevisionTree(self, inv, revision_id)
536
1811
 
 
1812
    def revision_trees(self, revision_ids):
 
1813
        """Return Tree for a revision on this branch.
 
1814
 
 
1815
        `revision_id` may not be None or 'null:'"""
 
1816
        inventories = self.iter_inventories(revision_ids)
 
1817
        for inv in inventories:
 
1818
            yield RevisionTree(self, inv, inv.revision_id)
 
1819
 
537
1820
    @needs_read_lock
538
 
    def get_ancestry(self, revision_id):
 
1821
    def get_ancestry(self, revision_id, topo_sorted=True):
539
1822
        """Return a list of revision-ids integrated by a revision.
540
1823
 
541
1824
        The first element of the list is always None, indicating the origin 
544
1827
        
545
1828
        This is topologically sorted.
546
1829
        """
547
 
        if revision_id is None:
 
1830
        if _mod_revision.is_null(revision_id):
548
1831
            return [None]
549
1832
        if not self.has_revision(revision_id):
550
1833
            raise errors.NoSuchRevision(self, revision_id)
551
 
        w = self.get_inventory_weave()
552
 
        candidates = w.get_ancestry(revision_id)
553
 
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
1834
        graph = self.get_graph()
 
1835
        keys = set()
 
1836
        search = graph._make_breadth_first_searcher([revision_id])
 
1837
        while True:
 
1838
            try:
 
1839
                found, ghosts = search.next_with_ghosts()
 
1840
            except StopIteration:
 
1841
                break
 
1842
            keys.update(found)
 
1843
        if _mod_revision.NULL_REVISION in keys:
 
1844
            keys.remove(_mod_revision.NULL_REVISION)
 
1845
        if topo_sorted:
 
1846
            parent_map = graph.get_parent_map(keys)
 
1847
            keys = tsort.topo_sort(parent_map)
 
1848
        return [None] + list(keys)
 
1849
 
 
1850
    def pack(self):
 
1851
        """Compress the data within the repository.
 
1852
 
 
1853
        This operation only makes sense for some repository types. For other
 
1854
        types it should be a no-op that just returns.
 
1855
 
 
1856
        This stub method does not require a lock, but subclasses should use
 
1857
        @needs_write_lock as this is a long running call its reasonable to 
 
1858
        implicitly lock for the user.
 
1859
        """
554
1860
 
555
1861
    @needs_read_lock
 
1862
    @deprecated_method(one_six)
556
1863
    def print_file(self, file, revision_id):
557
1864
        """Print `file` to stdout.
558
1865
        
573
1880
    def get_transaction(self):
574
1881
        return self.control_files.get_transaction()
575
1882
 
576
 
    def revision_parents(self, revid):
577
 
        return self.get_inventory_weave().parent_names(revid)
 
1883
    @deprecated_method(one_one)
 
1884
    def get_parents(self, revision_ids):
 
1885
        """See StackedParentsProvider.get_parents"""
 
1886
        parent_map = self.get_parent_map(revision_ids)
 
1887
        return [parent_map.get(r, None) for r in revision_ids]
 
1888
 
 
1889
    def get_parent_map(self, revision_ids):
 
1890
        """See graph._StackedParentsProvider.get_parent_map"""
 
1891
        # revisions index works in keys; this just works in revisions
 
1892
        # therefore wrap and unwrap
 
1893
        query_keys = []
 
1894
        result = {}
 
1895
        for revision_id in revision_ids:
 
1896
            if revision_id == _mod_revision.NULL_REVISION:
 
1897
                result[revision_id] = ()
 
1898
            elif revision_id is None:
 
1899
                raise ValueError('get_parent_map(None) is not valid')
 
1900
            else:
 
1901
                query_keys.append((revision_id ,))
 
1902
        for ((revision_id,), parent_keys) in \
 
1903
                self.revisions.get_parent_map(query_keys).iteritems():
 
1904
            if parent_keys:
 
1905
                result[revision_id] = tuple(parent_revid
 
1906
                    for (parent_revid,) in parent_keys)
 
1907
            else:
 
1908
                result[revision_id] = (_mod_revision.NULL_REVISION,)
 
1909
        return result
 
1910
 
 
1911
    def _make_parents_provider(self):
 
1912
        return self
 
1913
 
 
1914
    def get_graph(self, other_repository=None):
 
1915
        """Return the graph walker for this repository format"""
 
1916
        parents_provider = self._make_parents_provider()
 
1917
        if (other_repository is not None and
 
1918
            not self.has_same_location(other_repository)):
 
1919
            parents_provider = graph._StackedParentsProvider(
 
1920
                [parents_provider, other_repository._make_parents_provider()])
 
1921
        return graph.Graph(parents_provider)
 
1922
 
 
1923
    def _get_versioned_file_checker(self):
 
1924
        """Return an object suitable for checking versioned files."""
 
1925
        return _VersionedFileChecker(self)
 
1926
 
 
1927
    def revision_ids_to_search_result(self, result_set):
 
1928
        """Convert a set of revision ids to a graph SearchResult."""
 
1929
        result_parents = set()
 
1930
        for parents in self.get_graph().get_parent_map(
 
1931
            result_set).itervalues():
 
1932
            result_parents.update(parents)
 
1933
        included_keys = result_set.intersection(result_parents)
 
1934
        start_keys = result_set.difference(included_keys)
 
1935
        exclude_keys = result_parents.difference(result_set)
 
1936
        result = graph.SearchResult(start_keys, exclude_keys,
 
1937
            len(result_set), result_set)
 
1938
        return result
578
1939
 
579
1940
    @needs_write_lock
580
1941
    def set_make_working_trees(self, new_value):
600
1961
    @needs_read_lock
601
1962
    def has_signature_for_revision_id(self, revision_id):
602
1963
        """Query for a revision signature for revision_id in the repository."""
603
 
        return self._revision_store.has_signature(revision_id,
604
 
                                                  self.get_transaction())
 
1964
        if not self.has_revision(revision_id):
 
1965
            raise errors.NoSuchRevision(self, revision_id)
 
1966
        sig_present = (1 == len(
 
1967
            self.signatures.get_parent_map([(revision_id,)])))
 
1968
        return sig_present
605
1969
 
606
1970
    @needs_read_lock
607
1971
    def get_signature_text(self, revision_id):
608
1972
        """Return the text for a signature."""
609
 
        return self._revision_store.get_signature_text(revision_id,
610
 
                                                       self.get_transaction())
 
1973
        stream = self.signatures.get_record_stream([(revision_id,)],
 
1974
            'unordered', True)
 
1975
        record = stream.next()
 
1976
        if record.storage_kind == 'absent':
 
1977
            raise errors.NoSuchRevision(self, revision_id)
 
1978
        return record.get_bytes_as('fulltext')
611
1979
 
612
1980
    @needs_read_lock
613
 
    def check(self, revision_ids):
 
1981
    def check(self, revision_ids=None):
614
1982
        """Check consistency of all history of given revision_ids.
615
1983
 
616
1984
        Different repository implementations should override _check().
618
1986
        :param revision_ids: A non-empty list of revision_ids whose ancestry
619
1987
             will be checked.  Typically the last revision_id of a branch.
620
1988
        """
621
 
        if not revision_ids:
622
 
            raise ValueError("revision_ids must be non-empty in %s.check" 
623
 
                    % (self,))
624
1989
        return self._check(revision_ids)
625
1990
 
626
1991
    def _check(self, revision_ids):
627
 
        result = bzrlib.check.Check(self)
 
1992
        result = check.Check(self)
628
1993
        result.check()
629
1994
        return result
630
1995
 
631
 
 
632
 
class AllInOneRepository(Repository):
633
 
    """Legacy support - the repository behaviour for all-in-one branches."""
634
 
 
635
 
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
636
 
        # we reuse one control files instance.
637
 
        dir_mode = a_bzrdir._control_files._dir_mode
638
 
        file_mode = a_bzrdir._control_files._file_mode
639
 
 
640
 
        def get_store(name, compressed=True, prefixed=False):
641
 
            # FIXME: This approach of assuming stores are all entirely compressed
642
 
            # or entirely uncompressed is tidy, but breaks upgrade from 
643
 
            # some existing branches where there's a mixture; we probably 
644
 
            # still want the option to look for both.
645
 
            relpath = a_bzrdir._control_files._escape(name)
646
 
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
647
 
                              prefixed=prefixed, compressed=compressed,
648
 
                              dir_mode=dir_mode,
649
 
                              file_mode=file_mode)
650
 
            #if self._transport.should_cache():
651
 
            #    cache_path = os.path.join(self.cache_root, name)
652
 
            #    os.mkdir(cache_path)
653
 
            #    store = bzrlib.store.CachedStore(store, cache_path)
654
 
            return store
655
 
 
656
 
        # not broken out yet because the controlweaves|inventory_store
657
 
        # and text_store | weave_store bits are still different.
658
 
        if isinstance(_format, RepositoryFormat4):
659
 
            # cannot remove these - there is still no consistent api 
660
 
            # which allows access to this old info.
661
 
            self.inventory_store = get_store('inventory-store')
662
 
            text_store = get_store('text-store')
663
 
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
664
 
 
665
 
    @needs_read_lock
666
 
    def is_shared(self):
667
 
        """AllInOne repositories cannot be shared."""
668
 
        return False
669
 
 
670
 
    @needs_write_lock
671
 
    def set_make_working_trees(self, new_value):
672
 
        """Set the policy flag for making working trees when creating branches.
673
 
 
674
 
        This only applies to branches that use this repository.
675
 
 
676
 
        The default is 'True'.
677
 
        :param new_value: True to restore the default, False to disable making
678
 
                          working trees.
 
1996
    def _warn_if_deprecated(self):
 
1997
        global _deprecation_warning_done
 
1998
        if _deprecation_warning_done:
 
1999
            return
 
2000
        _deprecation_warning_done = True
 
2001
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2002
                % (self._format, self.bzrdir.transport.base))
 
2003
 
 
2004
    def supports_rich_root(self):
 
2005
        return self._format.rich_root_data
 
2006
 
 
2007
    def _check_ascii_revisionid(self, revision_id, method):
 
2008
        """Private helper for ascii-only repositories."""
 
2009
        # weave repositories refuse to store revisionids that are non-ascii.
 
2010
        if revision_id is not None:
 
2011
            # weaves require ascii revision ids.
 
2012
            if isinstance(revision_id, unicode):
 
2013
                try:
 
2014
                    revision_id.encode('ascii')
 
2015
                except UnicodeEncodeError:
 
2016
                    raise errors.NonAsciiRevisionId(method, self)
 
2017
            else:
 
2018
                try:
 
2019
                    revision_id.decode('ascii')
 
2020
                except UnicodeDecodeError:
 
2021
                    raise errors.NonAsciiRevisionId(method, self)
 
2022
    
 
2023
    def revision_graph_can_have_wrong_parents(self):
 
2024
        """Is it possible for this repository to have a revision graph with
 
2025
        incorrect parents?
 
2026
 
 
2027
        If True, then this repository must also implement
 
2028
        _find_inconsistent_revision_parents so that check and reconcile can
 
2029
        check for inconsistencies before proceeding with other checks that may
 
2030
        depend on the revision index being consistent.
679
2031
        """
680
 
        raise NotImplementedError(self.set_make_working_trees)
681
 
    
682
 
    def make_working_trees(self):
683
 
        """Returns the policy for making working trees on new branches."""
684
 
        return True
 
2032
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
2033
 
 
2034
 
 
2035
# remove these delegates a while after bzr 0.15
 
2036
def __make_delegated(name, from_module):
 
2037
    def _deprecated_repository_forwarder():
 
2038
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
2039
            % (name, from_module),
 
2040
            DeprecationWarning,
 
2041
            stacklevel=2)
 
2042
        m = __import__(from_module, globals(), locals(), [name])
 
2043
        try:
 
2044
            return getattr(m, name)
 
2045
        except AttributeError:
 
2046
            raise AttributeError('module %s has no name %s'
 
2047
                    % (m, name))
 
2048
    globals()[name] = _deprecated_repository_forwarder
 
2049
 
 
2050
for _name in [
 
2051
        'AllInOneRepository',
 
2052
        'WeaveMetaDirRepository',
 
2053
        'PreSplitOutRepositoryFormat',
 
2054
        'RepositoryFormat4',
 
2055
        'RepositoryFormat5',
 
2056
        'RepositoryFormat6',
 
2057
        'RepositoryFormat7',
 
2058
        ]:
 
2059
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
2060
 
 
2061
for _name in [
 
2062
        'KnitRepository',
 
2063
        'RepositoryFormatKnit',
 
2064
        'RepositoryFormatKnit1',
 
2065
        ]:
 
2066
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
685
2067
 
686
2068
 
687
2069
def install_revision(repository, rev, revision_tree):
688
2070
    """Install all revision data into a repository."""
 
2071
    install_revisions(repository, [(rev, revision_tree, None)])
 
2072
 
 
2073
 
 
2074
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
2075
    """Install all revision data into a repository.
 
2076
 
 
2077
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
2078
    may be None.
 
2079
    """
 
2080
    repository.start_write_group()
 
2081
    try:
 
2082
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
2083
            _install_revision(repository, revision, revision_tree, signature)
 
2084
            if pb is not None:
 
2085
                pb.update('Transferring revisions', n + 1, num_revisions)
 
2086
    except:
 
2087
        repository.abort_write_group()
 
2088
        raise
 
2089
    else:
 
2090
        repository.commit_write_group()
 
2091
 
 
2092
 
 
2093
def _install_revision(repository, rev, revision_tree, signature):
 
2094
    """Install all revision data into a repository."""
689
2095
    present_parents = []
690
2096
    parent_trees = {}
691
2097
    for p_id in rev.parent_ids:
693
2099
            present_parents.append(p_id)
694
2100
            parent_trees[p_id] = repository.revision_tree(p_id)
695
2101
        else:
696
 
            parent_trees[p_id] = EmptyTree()
 
2102
            parent_trees[p_id] = repository.revision_tree(
 
2103
                                     _mod_revision.NULL_REVISION)
697
2104
 
698
2105
    inv = revision_tree.inventory
699
 
    
 
2106
    entries = inv.iter_entries()
 
2107
    # backwards compatibility hack: skip the root id.
 
2108
    if not repository.supports_rich_root():
 
2109
        path, root = entries.next()
 
2110
        if root.revision != rev.revision_id:
 
2111
            raise errors.IncompatibleRevision(repr(repository))
 
2112
    text_keys = {}
 
2113
    for path, ie in entries:
 
2114
        text_keys[(ie.file_id, ie.revision)] = ie
 
2115
    text_parent_map = repository.texts.get_parent_map(text_keys)
 
2116
    missing_texts = set(text_keys) - set(text_parent_map)
700
2117
    # Add the texts that are not already present
701
 
    for path, ie in inv.iter_entries():
702
 
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
703
 
                repository.get_transaction())
704
 
        if ie.revision not in w:
705
 
            text_parents = []
706
 
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
707
 
            # with InventoryEntry.find_previous_heads(). if it is, then there
708
 
            # is a latent bug here where the parents may have ancestors of each
709
 
            # other. RBC, AB
710
 
            for revision, tree in parent_trees.iteritems():
711
 
                if ie.file_id not in tree:
712
 
                    continue
713
 
                parent_id = tree.inventory[ie.file_id].revision
714
 
                if parent_id in text_parents:
715
 
                    continue
716
 
                text_parents.append(parent_id)
717
 
                    
718
 
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
719
 
                repository.get_transaction())
720
 
            lines = revision_tree.get_file(ie.file_id).readlines()
721
 
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
2118
    for text_key in missing_texts:
 
2119
        ie = text_keys[text_key]
 
2120
        text_parents = []
 
2121
        # FIXME: TODO: The following loop overlaps/duplicates that done by
 
2122
        # commit to determine parents. There is a latent/real bug here where
 
2123
        # the parents inserted are not those commit would do - in particular
 
2124
        # they are not filtered by heads(). RBC, AB
 
2125
        for revision, tree in parent_trees.iteritems():
 
2126
            if ie.file_id not in tree:
 
2127
                continue
 
2128
            parent_id = tree.inventory[ie.file_id].revision
 
2129
            if parent_id in text_parents:
 
2130
                continue
 
2131
            text_parents.append((ie.file_id, parent_id))
 
2132
        lines = revision_tree.get_file(ie.file_id).readlines()
 
2133
        repository.texts.add_lines(text_key, text_parents, lines)
722
2134
    try:
723
2135
        # install the inventory
724
2136
        repository.add_inventory(rev.revision_id, inv, present_parents)
725
2137
    except errors.RevisionAlreadyPresent:
726
2138
        pass
 
2139
    if signature is not None:
 
2140
        repository.add_signature_text(rev.revision_id, signature)
727
2141
    repository.add_revision(rev.revision_id, rev, inv)
728
2142
 
729
2143
 
730
2144
class MetaDirRepository(Repository):
731
 
    """Repositories in the new meta-dir layout."""
732
 
 
733
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
734
 
        super(MetaDirRepository, self).__init__(_format,
735
 
                                                a_bzrdir,
736
 
                                                control_files,
737
 
                                                _revision_store,
738
 
                                                control_store,
739
 
                                                text_store)
740
 
 
741
 
        dir_mode = self.control_files._dir_mode
742
 
        file_mode = self.control_files._file_mode
743
 
 
744
 
    @needs_read_lock
 
2145
    """Repositories in the new meta-dir layout.
 
2146
    
 
2147
    :ivar _transport: Transport for access to repository control files,
 
2148
        typically pointing to .bzr/repository.
 
2149
    """
 
2150
 
 
2151
    def __init__(self, _format, a_bzrdir, control_files):
 
2152
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
 
2153
        self._transport = control_files._transport
 
2154
 
745
2155
    def is_shared(self):
746
2156
        """Return True if this repository is flagged as a shared repository."""
747
 
        return self.control_files._transport.has('shared-storage')
 
2157
        return self._transport.has('shared-storage')
748
2158
 
749
2159
    @needs_write_lock
750
2160
    def set_make_working_trees(self, new_value):
758
2168
        """
759
2169
        if new_value:
760
2170
            try:
761
 
                self.control_files._transport.delete('no-working-trees')
 
2171
                self._transport.delete('no-working-trees')
762
2172
            except errors.NoSuchFile:
763
2173
                pass
764
2174
        else:
765
 
            self.control_files.put_utf8('no-working-trees', '')
 
2175
            self._transport.put_bytes('no-working-trees', '',
 
2176
                mode=self.bzrdir._get_file_mode())
766
2177
    
767
2178
    def make_working_trees(self):
768
2179
        """Returns the policy for making working trees on new branches."""
769
 
        return not self.control_files._transport.has('no-working-trees')
770
 
 
771
 
 
772
 
class KnitRepository(MetaDirRepository):
773
 
    """Knit format repository."""
774
 
 
775
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
776
 
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
777
 
 
778
 
    @needs_read_lock
779
 
    def _all_revision_ids(self):
780
 
        """See Repository.all_revision_ids()."""
781
 
        # Knits get the revision graph from the index of the revision knit, so
782
 
        # it's always possible even if they're on an unlistable transport.
783
 
        return self._revision_store.all_revision_ids(self.get_transaction())
784
 
 
785
 
    def fileid_involved_between_revs(self, from_revid, to_revid):
786
 
        """Find file_id(s) which are involved in the changes between revisions.
787
 
 
788
 
        This determines the set of revisions which are involved, and then
789
 
        finds all file ids affected by those revisions.
790
 
        """
791
 
        vf = self._get_revision_vf()
792
 
        from_set = set(vf.get_ancestry(from_revid))
793
 
        to_set = set(vf.get_ancestry(to_revid))
794
 
        changed = to_set.difference(from_set)
795
 
        return self._fileid_involved_by_set(changed)
796
 
 
797
 
    def fileid_involved(self, last_revid=None):
798
 
        """Find all file_ids modified in the ancestry of last_revid.
799
 
 
800
 
        :param last_revid: If None, last_revision() will be used.
801
 
        """
802
 
        if not last_revid:
803
 
            changed = set(self.all_revision_ids())
804
 
        else:
805
 
            changed = set(self.get_ancestry(last_revid))
806
 
        if None in changed:
807
 
            changed.remove(None)
808
 
        return self._fileid_involved_by_set(changed)
809
 
 
810
 
    @needs_read_lock
811
 
    def get_ancestry(self, revision_id):
812
 
        """Return a list of revision-ids integrated by a revision.
813
 
        
814
 
        This is topologically sorted.
815
 
        """
816
 
        if revision_id is None:
817
 
            return [None]
818
 
        vf = self._get_revision_vf()
819
 
        try:
820
 
            return [None] + vf.get_ancestry(revision_id)
821
 
        except errors.RevisionNotPresent:
822
 
            raise errors.NoSuchRevision(self, revision_id)
823
 
 
824
 
    @needs_read_lock
825
 
    def get_revision(self, revision_id):
826
 
        """Return the Revision object for a named revision"""
827
 
        return self.get_revision_reconcile(revision_id)
828
 
 
829
 
    @needs_read_lock
830
 
    def get_revision_graph(self, revision_id=None):
831
 
        """Return a dictionary containing the revision graph.
832
 
        
833
 
        :return: a dictionary of revision_id->revision_parents_list.
834
 
        """
835
 
        weave = self._get_revision_vf()
836
 
        entire_graph = weave.get_graph()
837
 
        if revision_id is None:
838
 
            return weave.get_graph()
839
 
        elif revision_id not in weave:
840
 
            raise errors.NoSuchRevision(self, revision_id)
841
 
        else:
842
 
            # add what can be reached from revision_id
843
 
            result = {}
844
 
            pending = set([revision_id])
845
 
            while len(pending) > 0:
846
 
                node = pending.pop()
847
 
                result[node] = weave.get_parents(node)
848
 
                for revision_id in result[node]:
849
 
                    if revision_id not in result:
850
 
                        pending.add(revision_id)
851
 
            return result
852
 
 
853
 
    @needs_read_lock
854
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
855
 
        """Return a graph of the revisions with ghosts marked as applicable.
856
 
 
857
 
        :param revision_ids: an iterable of revisions to graph or None for all.
858
 
        :return: a Graph object with the graph reachable from revision_ids.
859
 
        """
860
 
        result = Graph()
861
 
        vf = self._get_revision_vf()
862
 
        versions = set(vf.versions())
863
 
        if not revision_ids:
864
 
            pending = set(self.all_revision_ids())
865
 
            required = set([])
866
 
        else:
867
 
            pending = set(revision_ids)
868
 
            required = set(revision_ids)
869
 
        done = set([])
870
 
        while len(pending):
871
 
            revision_id = pending.pop()
872
 
            if not revision_id in versions:
873
 
                if revision_id in required:
874
 
                    raise errors.NoSuchRevision(self, revision_id)
875
 
                # a ghost
876
 
                result.add_ghost(revision_id)
877
 
                # mark it as done so we don't try for it again.
878
 
                done.add(revision_id)
879
 
                continue
880
 
            parent_ids = vf.get_parents_with_ghosts(revision_id)
881
 
            for parent_id in parent_ids:
882
 
                # is this queued or done ?
883
 
                if (parent_id not in pending and
884
 
                    parent_id not in done):
885
 
                    # no, queue it.
886
 
                    pending.add(parent_id)
887
 
            result.add_node(revision_id, parent_ids)
888
 
            done.add(revision_id)
889
 
        return result
890
 
 
891
 
    def _get_revision_vf(self):
892
 
        """:return: a versioned file containing the revisions."""
893
 
        vf = self._revision_store.get_revision_file(self.get_transaction())
894
 
        return vf
895
 
 
896
 
    @needs_write_lock
897
 
    def reconcile(self, other=None, thorough=False):
898
 
        """Reconcile this repository."""
899
 
        from bzrlib.reconcile import KnitReconciler
900
 
        reconciler = KnitReconciler(self, thorough=thorough)
901
 
        reconciler.reconcile()
902
 
        return reconciler
 
2180
        return not self._transport.has('no-working-trees')
 
2181
 
 
2182
 
 
2183
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2184
    """Repositories in a meta-dir, that work via versioned file objects."""
 
2185
 
 
2186
    def __init__(self, _format, a_bzrdir, control_files):
 
2187
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2188
            control_files)
 
2189
 
 
2190
 
 
2191
class RepositoryFormatRegistry(registry.Registry):
 
2192
    """Registry of RepositoryFormats."""
 
2193
 
 
2194
    def get(self, format_string):
 
2195
        r = registry.Registry.get(self, format_string)
 
2196
        if callable(r):
 
2197
            r = r()
 
2198
        return r
903
2199
    
904
 
    def revision_parents(self, revid):
905
 
        return self._get_revision_vf().get_parents(rev_id)
 
2200
 
 
2201
format_registry = RepositoryFormatRegistry()
 
2202
"""Registry of formats, indexed by their identifying format string.
 
2203
 
 
2204
This can contain either format instances themselves, or classes/factories that
 
2205
can be called to obtain one.
 
2206
"""
 
2207
 
 
2208
 
 
2209
#####################################################################
 
2210
# Repository Formats
906
2211
 
907
2212
class RepositoryFormat(object):
908
2213
    """A repository format.
913
2218
       children.
914
2219
     * an open routine which returns a Repository instance.
915
2220
 
 
2221
    There is one and only one Format subclass for each on-disk format. But
 
2222
    there can be one Repository subclass that is used for several different
 
2223
    formats. The _format attribute on a Repository instance can be used to
 
2224
    determine the disk format.
 
2225
 
916
2226
    Formats are placed in an dict by their format string for reference 
917
2227
    during opening. These should be subclasses of RepositoryFormat
918
2228
    for consistency.
925
2235
    _matchingbzrdir - the bzrdir format that the repository format was
926
2236
    originally written to work with. This can be used if manually
927
2237
    constructing a bzrdir and repository, or more commonly for test suite
928
 
    parameterisation.
 
2238
    parameterization.
929
2239
    """
930
2240
 
931
 
    _default_format = None
932
 
    """The default format used for new repositories."""
933
 
 
934
 
    _formats = {}
935
 
    """The known formats."""
 
2241
    # Set to True or False in derived classes. True indicates that the format
 
2242
    # supports ghosts gracefully.
 
2243
    supports_ghosts = None
 
2244
    # Can this repository be given external locations to lookup additional
 
2245
    # data. Set to True or False in derived classes.
 
2246
    supports_external_lookups = None
 
2247
 
 
2248
    def __str__(self):
 
2249
        return "<%s>" % self.__class__.__name__
 
2250
 
 
2251
    def __eq__(self, other):
 
2252
        # format objects are generally stateless
 
2253
        return isinstance(other, self.__class__)
 
2254
 
 
2255
    def __ne__(self, other):
 
2256
        return not self == other
936
2257
 
937
2258
    @classmethod
938
2259
    def find_format(klass, a_bzrdir):
939
 
        """Return the format for the repository object in a_bzrdir."""
 
2260
        """Return the format for the repository object in a_bzrdir.
 
2261
        
 
2262
        This is used by bzr native formats that have a "format" file in
 
2263
        the repository.  Other methods may be used by different types of 
 
2264
        control directory.
 
2265
        """
940
2266
        try:
941
2267
            transport = a_bzrdir.get_repository_transport(None)
942
2268
            format_string = transport.get("format").read()
943
 
            return klass._formats[format_string]
 
2269
            return format_registry.get(format_string)
944
2270
        except errors.NoSuchFile:
945
2271
            raise errors.NoRepositoryPresent(a_bzrdir)
946
2272
        except KeyError:
947
 
            raise errors.UnknownFormatError(format_string)
948
 
 
949
 
    def _get_control_store(self, repo_transport, control_files):
950
 
        """Return the control store for this repository."""
951
 
        raise NotImplementedError(self._get_control_store)
 
2273
            raise errors.UnknownFormatError(format=format_string,
 
2274
                                            kind='repository')
 
2275
 
 
2276
    @classmethod
 
2277
    def register_format(klass, format):
 
2278
        format_registry.register(format.get_format_string(), format)
 
2279
 
 
2280
    @classmethod
 
2281
    def unregister_format(klass, format):
 
2282
        format_registry.remove(format.get_format_string())
952
2283
    
953
2284
    @classmethod
954
2285
    def get_default_format(klass):
955
2286
        """Return the current default format."""
956
 
        return klass._default_format
 
2287
        from bzrlib import bzrdir
 
2288
        return bzrdir.format_registry.make_bzrdir('default').repository_format
957
2289
 
958
2290
    def get_format_string(self):
959
2291
        """Return the ASCII format string that identifies this format.
967
2299
        """Return the short description for this format."""
968
2300
        raise NotImplementedError(self.get_format_description)
969
2301
 
970
 
    def _get_revision_store(self, repo_transport, control_files):
971
 
        """Return the revision store object for this a_bzrdir."""
972
 
        raise NotImplementedError(self._get_revision_store)
973
 
 
974
 
    def _get_text_rev_store(self,
975
 
                            transport,
976
 
                            control_files,
977
 
                            name,
978
 
                            compressed=True,
979
 
                            prefixed=False,
980
 
                            serializer=None):
981
 
        """Common logic for getting a revision store for a repository.
982
 
        
983
 
        see self._get_revision_store for the subclass-overridable method to 
984
 
        get the store for a repository.
985
 
        """
986
 
        from bzrlib.store.revision.text import TextRevisionStore
987
 
        dir_mode = control_files._dir_mode
988
 
        file_mode = control_files._file_mode
989
 
        text_store =TextStore(transport.clone(name),
990
 
                              prefixed=prefixed,
991
 
                              compressed=compressed,
992
 
                              dir_mode=dir_mode,
993
 
                              file_mode=file_mode)
994
 
        _revision_store = TextRevisionStore(text_store, serializer)
995
 
        return _revision_store
996
 
 
 
2302
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2303
    # use weaves or knits -- mbp 20070207
997
2304
    def _get_versioned_file_store(self,
998
2305
                                  name,
999
2306
                                  transport,
1000
2307
                                  control_files,
1001
2308
                                  prefixed=True,
1002
 
                                  versionedfile_class=WeaveFile,
 
2309
                                  versionedfile_class=None,
 
2310
                                  versionedfile_kwargs={},
1003
2311
                                  escaped=False):
 
2312
        if versionedfile_class is None:
 
2313
            versionedfile_class = self._versionedfile_class
1004
2314
        weave_transport = control_files._transport.clone(name)
1005
2315
        dir_mode = control_files._dir_mode
1006
2316
        file_mode = control_files._file_mode
1008
2318
                                  dir_mode=dir_mode,
1009
2319
                                  file_mode=file_mode,
1010
2320
                                  versionedfile_class=versionedfile_class,
 
2321
                                  versionedfile_kwargs=versionedfile_kwargs,
1011
2322
                                  escaped=escaped)
1012
2323
 
1013
2324
    def initialize(self, a_bzrdir, shared=False):
1015
2326
 
1016
2327
        :param a_bzrdir: The bzrdir to put the new repository in it.
1017
2328
        :param shared: The repository should be initialized as a sharable one.
1018
 
 
 
2329
        :returns: The new repository object.
 
2330
        
1019
2331
        This may raise UninitializableFormat if shared repository are not
1020
2332
        compatible the a_bzrdir.
1021
2333
        """
 
2334
        raise NotImplementedError(self.initialize)
1022
2335
 
1023
2336
    def is_supported(self):
1024
2337
        """Is this format supported?
1029
2342
        """
1030
2343
        return True
1031
2344
 
 
2345
    def check_conversion_target(self, target_format):
 
2346
        raise NotImplementedError(self.check_conversion_target)
 
2347
 
1032
2348
    def open(self, a_bzrdir, _found=False):
1033
2349
        """Return an instance of this format for the bzrdir a_bzrdir.
1034
2350
        
1036
2352
        """
1037
2353
        raise NotImplementedError(self.open)
1038
2354
 
1039
 
    @classmethod
1040
 
    def register_format(klass, format):
1041
 
        klass._formats[format.get_format_string()] = format
1042
 
 
1043
 
    @classmethod
1044
 
    def set_default_format(klass, format):
1045
 
        klass._default_format = format
1046
 
 
1047
 
    @classmethod
1048
 
    def unregister_format(klass, format):
1049
 
        assert klass._formats[format.get_format_string()] is format
1050
 
        del klass._formats[format.get_format_string()]
1051
 
 
1052
 
 
1053
 
class PreSplitOutRepositoryFormat(RepositoryFormat):
1054
 
    """Base class for the pre split out repository formats."""
1055
 
 
1056
 
    def initialize(self, a_bzrdir, shared=False, _internal=False):
1057
 
        """Create a weave repository.
1058
 
        
1059
 
        TODO: when creating split out bzr branch formats, move this to a common
1060
 
        base for Format5, Format6. or something like that.
1061
 
        """
1062
 
        from bzrlib.weavefile import write_weave_v5
1063
 
        from bzrlib.weave import Weave
1064
 
 
1065
 
        if shared:
1066
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
1067
 
 
1068
 
        if not _internal:
1069
 
            # always initialized when the bzrdir is.
1070
 
            return self.open(a_bzrdir, _found=True)
1071
 
        
1072
 
        # Create an empty weave
1073
 
        sio = StringIO()
1074
 
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
1075
 
        empty_weave = sio.getvalue()
1076
 
 
1077
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1078
 
        dirs = ['revision-store', 'weaves']
1079
 
        files = [('inventory.weave', StringIO(empty_weave)),
1080
 
                 ]
1081
 
        
1082
 
        # FIXME: RBC 20060125 don't peek under the covers
1083
 
        # NB: no need to escape relative paths that are url safe.
1084
 
        control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
1085
 
                                      TransportLock)
1086
 
        control_files.create_lock()
1087
 
        control_files.lock_write()
1088
 
        control_files._transport.mkdir_multi(dirs,
1089
 
                mode=control_files._dir_mode)
1090
 
        try:
1091
 
            for file, content in files:
1092
 
                control_files.put(file, content)
1093
 
        finally:
1094
 
            control_files.unlock()
1095
 
        return self.open(a_bzrdir, _found=True)
1096
 
 
1097
 
    def _get_control_store(self, repo_transport, control_files):
1098
 
        """Return the control store for this repository."""
1099
 
        return self._get_versioned_file_store('',
1100
 
                                              repo_transport,
1101
 
                                              control_files,
1102
 
                                              prefixed=False)
1103
 
 
1104
 
    def _get_text_store(self, transport, control_files):
1105
 
        """Get a store for file texts for this format."""
1106
 
        raise NotImplementedError(self._get_text_store)
1107
 
 
1108
 
    def open(self, a_bzrdir, _found=False):
1109
 
        """See RepositoryFormat.open()."""
1110
 
        if not _found:
1111
 
            # we are being called directly and must probe.
1112
 
            raise NotImplementedError
1113
 
 
1114
 
        repo_transport = a_bzrdir.get_repository_transport(None)
1115
 
        control_files = a_bzrdir._control_files
1116
 
        text_store = self._get_text_store(repo_transport, control_files)
1117
 
        control_store = self._get_control_store(repo_transport, control_files)
1118
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1119
 
        return AllInOneRepository(_format=self,
1120
 
                                  a_bzrdir=a_bzrdir,
1121
 
                                  _revision_store=_revision_store,
1122
 
                                  control_store=control_store,
1123
 
                                  text_store=text_store)
1124
 
 
1125
 
 
1126
 
class RepositoryFormat4(PreSplitOutRepositoryFormat):
1127
 
    """Bzr repository format 4.
1128
 
 
1129
 
    This repository format has:
1130
 
     - flat stores
1131
 
     - TextStores for texts, inventories,revisions.
1132
 
 
1133
 
    This format is deprecated: it indexes texts using a text id which is
1134
 
    removed in format 5; initialization and write support for this format
1135
 
    has been removed.
1136
 
    """
1137
 
 
1138
 
    def __init__(self):
1139
 
        super(RepositoryFormat4, self).__init__()
1140
 
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat4()
1141
 
 
1142
 
    def get_format_description(self):
1143
 
        """See RepositoryFormat.get_format_description()."""
1144
 
        return "Repository format 4"
1145
 
 
1146
 
    def initialize(self, url, shared=False, _internal=False):
1147
 
        """Format 4 branches cannot be created."""
1148
 
        raise errors.UninitializableFormat(self)
1149
 
 
1150
 
    def is_supported(self):
1151
 
        """Format 4 is not supported.
1152
 
 
1153
 
        It is not supported because the model changed from 4 to 5 and the
1154
 
        conversion logic is expensive - so doing it on the fly was not 
1155
 
        feasible.
1156
 
        """
1157
 
        return False
1158
 
 
1159
 
    def _get_control_store(self, repo_transport, control_files):
1160
 
        """Format 4 repositories have no formal control store at this point.
1161
 
        
1162
 
        This will cause any control-file-needing apis to fail - this is desired.
1163
 
        """
1164
 
        return None
1165
 
    
1166
 
    def _get_revision_store(self, repo_transport, control_files):
1167
 
        """See RepositoryFormat._get_revision_store()."""
1168
 
        from bzrlib.xml4 import serializer_v4
1169
 
        return self._get_text_rev_store(repo_transport,
1170
 
                                        control_files,
1171
 
                                        'revision-store',
1172
 
                                        serializer=serializer_v4)
1173
 
 
1174
 
    def _get_text_store(self, transport, control_files):
1175
 
        """See RepositoryFormat._get_text_store()."""
1176
 
 
1177
 
 
1178
 
class RepositoryFormat5(PreSplitOutRepositoryFormat):
1179
 
    """Bzr control format 5.
1180
 
 
1181
 
    This repository format has:
1182
 
     - weaves for file texts and inventory
1183
 
     - flat stores
1184
 
     - TextStores for revisions and signatures.
1185
 
    """
1186
 
 
1187
 
    def __init__(self):
1188
 
        super(RepositoryFormat5, self).__init__()
1189
 
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat5()
1190
 
 
1191
 
    def get_format_description(self):
1192
 
        """See RepositoryFormat.get_format_description()."""
1193
 
        return "Weave repository format 5"
1194
 
 
1195
 
    def _get_revision_store(self, repo_transport, control_files):
1196
 
        """See RepositoryFormat._get_revision_store()."""
1197
 
        """Return the revision store object for this a_bzrdir."""
1198
 
        return self._get_text_rev_store(repo_transport,
1199
 
                                        control_files,
1200
 
                                        'revision-store',
1201
 
                                        compressed=False)
1202
 
 
1203
 
    def _get_text_store(self, transport, control_files):
1204
 
        """See RepositoryFormat._get_text_store()."""
1205
 
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
1206
 
 
1207
 
 
1208
 
class RepositoryFormat6(PreSplitOutRepositoryFormat):
1209
 
    """Bzr control format 6.
1210
 
 
1211
 
    This repository format has:
1212
 
     - weaves for file texts and inventory
1213
 
     - hash subdirectory based stores.
1214
 
     - TextStores for revisions and signatures.
1215
 
    """
1216
 
 
1217
 
    def __init__(self):
1218
 
        super(RepositoryFormat6, self).__init__()
1219
 
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat6()
1220
 
 
1221
 
    def get_format_description(self):
1222
 
        """See RepositoryFormat.get_format_description()."""
1223
 
        return "Weave repository format 6"
1224
 
 
1225
 
    def _get_revision_store(self, repo_transport, control_files):
1226
 
        """See RepositoryFormat._get_revision_store()."""
1227
 
        return self._get_text_rev_store(repo_transport,
1228
 
                                        control_files,
1229
 
                                        'revision-store',
1230
 
                                        compressed=False,
1231
 
                                        prefixed=True)
1232
 
 
1233
 
    def _get_text_store(self, transport, control_files):
1234
 
        """See RepositoryFormat._get_text_store()."""
1235
 
        return self._get_versioned_file_store('weaves', transport, control_files)
1236
 
 
1237
2355
 
1238
2356
class MetaDirRepositoryFormat(RepositoryFormat):
1239
2357
    """Common base class for the new repositories using the metadir layout."""
1240
2358
 
 
2359
    rich_root_data = False
 
2360
    supports_tree_reference = False
 
2361
    supports_external_lookups = False
 
2362
 
 
2363
    @property
 
2364
    def _matchingbzrdir(self):
 
2365
        matching = bzrdir.BzrDirMetaFormat1()
 
2366
        matching.repository_format = self
 
2367
        return matching
 
2368
 
1241
2369
    def __init__(self):
1242
2370
        super(MetaDirRepositoryFormat, self).__init__()
1243
 
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirMetaFormat1()
1244
2371
 
1245
2372
    def _create_control_files(self, a_bzrdir):
1246
2373
        """Create the required files and the initial control_files object."""
1247
2374
        # FIXME: RBC 20060125 don't peek under the covers
1248
2375
        # NB: no need to escape relative paths that are url safe.
1249
2376
        repository_transport = a_bzrdir.get_repository_transport(self)
1250
 
        control_files = LockableFiles(repository_transport, 'lock', LockDir)
 
2377
        control_files = lockable_files.LockableFiles(repository_transport,
 
2378
                                'lock', lockdir.LockDir)
1251
2379
        control_files.create_lock()
1252
2380
        return control_files
1253
2381
 
1255
2383
        """Upload the initial blank content."""
1256
2384
        control_files = self._create_control_files(a_bzrdir)
1257
2385
        control_files.lock_write()
 
2386
        transport = control_files._transport
 
2387
        if shared == True:
 
2388
            utf8_files += [('shared-storage', '')]
1258
2389
        try:
1259
 
            control_files._transport.mkdir_multi(dirs,
1260
 
                    mode=control_files._dir_mode)
1261
 
            for file, content in files:
1262
 
                control_files.put(file, content)
1263
 
            for file, content in utf8_files:
1264
 
                control_files.put_utf8(file, content)
1265
 
            if shared == True:
1266
 
                control_files.put_utf8('shared-storage', '')
 
2390
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
 
2391
            for (filename, content_stream) in files:
 
2392
                transport.put_file(filename, content_stream,
 
2393
                    mode=a_bzrdir._get_file_mode())
 
2394
            for (filename, content_bytes) in utf8_files:
 
2395
                transport.put_bytes_non_atomic(filename, content_bytes,
 
2396
                    mode=a_bzrdir._get_file_mode())
1267
2397
        finally:
1268
2398
            control_files.unlock()
1269
2399
 
1270
2400
 
1271
 
class RepositoryFormat7(MetaDirRepositoryFormat):
1272
 
    """Bzr repository 7.
1273
 
 
1274
 
    This repository format has:
1275
 
     - weaves for file texts and inventory
1276
 
     - hash subdirectory based stores.
1277
 
     - TextStores for revisions and signatures.
1278
 
     - a format marker of its own
1279
 
     - an optional 'shared-storage' flag
1280
 
     - an optional 'no-working-trees' flag
1281
 
    """
1282
 
 
1283
 
    def _get_control_store(self, repo_transport, control_files):
1284
 
        """Return the control store for this repository."""
1285
 
        return self._get_versioned_file_store('',
1286
 
                                              repo_transport,
1287
 
                                              control_files,
1288
 
                                              prefixed=False)
1289
 
 
1290
 
    def get_format_string(self):
1291
 
        """See RepositoryFormat.get_format_string()."""
1292
 
        return "Bazaar-NG Repository format 7"
1293
 
 
1294
 
    def get_format_description(self):
1295
 
        """See RepositoryFormat.get_format_description()."""
1296
 
        return "Weave repository format 7"
1297
 
 
1298
 
    def _get_revision_store(self, repo_transport, control_files):
1299
 
        """See RepositoryFormat._get_revision_store()."""
1300
 
        return self._get_text_rev_store(repo_transport,
1301
 
                                        control_files,
1302
 
                                        'revision-store',
1303
 
                                        compressed=False,
1304
 
                                        prefixed=True,
1305
 
                                        )
1306
 
 
1307
 
    def _get_text_store(self, transport, control_files):
1308
 
        """See RepositoryFormat._get_text_store()."""
1309
 
        return self._get_versioned_file_store('weaves',
1310
 
                                              transport,
1311
 
                                              control_files)
1312
 
 
1313
 
    def initialize(self, a_bzrdir, shared=False):
1314
 
        """Create a weave repository.
1315
 
 
1316
 
        :param shared: If true the repository will be initialized as a shared
1317
 
                       repository.
1318
 
        """
1319
 
        from bzrlib.weavefile import write_weave_v5
1320
 
        from bzrlib.weave import Weave
1321
 
 
1322
 
        # Create an empty weave
1323
 
        sio = StringIO()
1324
 
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
1325
 
        empty_weave = sio.getvalue()
1326
 
 
1327
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1328
 
        dirs = ['revision-store', 'weaves']
1329
 
        files = [('inventory.weave', StringIO(empty_weave)), 
1330
 
                 ]
1331
 
        utf8_files = [('format', self.get_format_string())]
1332
 
 
1333
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1334
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1335
 
 
1336
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1337
 
        """See RepositoryFormat.open().
1338
 
        
1339
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1340
 
                                    repository at a slightly different url
1341
 
                                    than normal. I.e. during 'upgrade'.
1342
 
        """
1343
 
        if not _found:
1344
 
            format = RepositoryFormat.find_format(a_bzrdir)
1345
 
            assert format.__class__ ==  self.__class__
1346
 
        if _override_transport is not None:
1347
 
            repo_transport = _override_transport
1348
 
        else:
1349
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1350
 
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
1351
 
        text_store = self._get_text_store(repo_transport, control_files)
1352
 
        control_store = self._get_control_store(repo_transport, control_files)
1353
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1354
 
        return MetaDirRepository(_format=self,
1355
 
                                 a_bzrdir=a_bzrdir,
1356
 
                                 control_files=control_files,
1357
 
                                 _revision_store=_revision_store,
1358
 
                                 control_store=control_store,
1359
 
                                 text_store=text_store)
1360
 
 
1361
 
 
1362
 
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
1363
 
    """Bzr repository knit format 1.
1364
 
 
1365
 
    This repository format has:
1366
 
     - knits for file texts and inventory
1367
 
     - hash subdirectory based stores.
1368
 
     - knits for revisions and signatures
1369
 
     - TextStores for revisions and signatures.
1370
 
     - a format marker of its own
1371
 
     - an optional 'shared-storage' flag
1372
 
     - an optional 'no-working-trees' flag
1373
 
     - a LockDir lock
1374
 
 
1375
 
    This format was introduced in bzr 0.8.
1376
 
    """
1377
 
 
1378
 
    def _get_control_store(self, repo_transport, control_files):
1379
 
        """Return the control store for this repository."""
1380
 
        return VersionedFileStore(
1381
 
            repo_transport,
1382
 
            prefixed=False,
1383
 
            file_mode=control_files._file_mode,
1384
 
            versionedfile_class=KnitVersionedFile,
1385
 
            versionedfile_kwargs={'factory':KnitPlainFactory()},
1386
 
            )
1387
 
 
1388
 
    def get_format_string(self):
1389
 
        """See RepositoryFormat.get_format_string()."""
1390
 
        return "Bazaar-NG Knit Repository Format 1"
1391
 
 
1392
 
    def get_format_description(self):
1393
 
        """See RepositoryFormat.get_format_description()."""
1394
 
        return "Knit repository format 1"
1395
 
 
1396
 
    def _get_revision_store(self, repo_transport, control_files):
1397
 
        """See RepositoryFormat._get_revision_store()."""
1398
 
        from bzrlib.store.revision.knit import KnitRevisionStore
1399
 
        versioned_file_store = VersionedFileStore(
1400
 
            repo_transport,
1401
 
            file_mode=control_files._file_mode,
1402
 
            prefixed=False,
1403
 
            precious=True,
1404
 
            versionedfile_class=KnitVersionedFile,
1405
 
            versionedfile_kwargs={'delta':False, 'factory':KnitPlainFactory()},
1406
 
            escaped=True,
1407
 
            )
1408
 
        return KnitRevisionStore(versioned_file_store)
1409
 
 
1410
 
    def _get_text_store(self, transport, control_files):
1411
 
        """See RepositoryFormat._get_text_store()."""
1412
 
        return self._get_versioned_file_store('knits',
1413
 
                                              transport,
1414
 
                                              control_files,
1415
 
                                              versionedfile_class=KnitVersionedFile,
1416
 
                                              escaped=True)
1417
 
 
1418
 
    def initialize(self, a_bzrdir, shared=False):
1419
 
        """Create a knit format 1 repository.
1420
 
 
1421
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
1422
 
            be initialized.
1423
 
        :param shared: If true the repository will be initialized as a shared
1424
 
                       repository.
1425
 
        """
1426
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1427
 
        dirs = ['revision-store', 'knits']
1428
 
        files = []
1429
 
        utf8_files = [('format', self.get_format_string())]
1430
 
        
1431
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1432
 
        repo_transport = a_bzrdir.get_repository_transport(None)
1433
 
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
1434
 
        control_store = self._get_control_store(repo_transport, control_files)
1435
 
        transaction = bzrlib.transactions.WriteTransaction()
1436
 
        # trigger a write of the inventory store.
1437
 
        control_store.get_weave_or_empty('inventory', transaction)
1438
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1439
 
        _revision_store.has_revision_id('A', transaction)
1440
 
        _revision_store.get_signature_file(transaction)
1441
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1442
 
 
1443
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1444
 
        """See RepositoryFormat.open().
1445
 
        
1446
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1447
 
                                    repository at a slightly different url
1448
 
                                    than normal. I.e. during 'upgrade'.
1449
 
        """
1450
 
        if not _found:
1451
 
            format = RepositoryFormat.find_format(a_bzrdir)
1452
 
            assert format.__class__ ==  self.__class__
1453
 
        if _override_transport is not None:
1454
 
            repo_transport = _override_transport
1455
 
        else:
1456
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1457
 
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
1458
 
        text_store = self._get_text_store(repo_transport, control_files)
1459
 
        control_store = self._get_control_store(repo_transport, control_files)
1460
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1461
 
        return KnitRepository(_format=self,
1462
 
                              a_bzrdir=a_bzrdir,
1463
 
                              control_files=control_files,
1464
 
                              _revision_store=_revision_store,
1465
 
                              control_store=control_store,
1466
 
                              text_store=text_store)
1467
 
 
1468
 
 
1469
2401
# formats which have no format string are not discoverable
1470
 
# and not independently creatable, so are not registered.
1471
 
RepositoryFormat.register_format(RepositoryFormat7())
1472
 
_default_format = RepositoryFormatKnit1()
1473
 
RepositoryFormat.register_format(_default_format)
1474
 
RepositoryFormat.set_default_format(_default_format)
1475
 
_legacy_formats = [RepositoryFormat4(),
1476
 
                   RepositoryFormat5(),
1477
 
                   RepositoryFormat6()]
 
2402
# and not independently creatable, so are not registered.  They're 
 
2403
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
2404
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
2405
# the repository is not separately opened are similar.
 
2406
 
 
2407
format_registry.register_lazy(
 
2408
    'Bazaar-NG Repository format 7',
 
2409
    'bzrlib.repofmt.weaverepo',
 
2410
    'RepositoryFormat7'
 
2411
    )
 
2412
 
 
2413
format_registry.register_lazy(
 
2414
    'Bazaar-NG Knit Repository Format 1',
 
2415
    'bzrlib.repofmt.knitrepo',
 
2416
    'RepositoryFormatKnit1',
 
2417
    )
 
2418
 
 
2419
format_registry.register_lazy(
 
2420
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
2421
    'bzrlib.repofmt.knitrepo',
 
2422
    'RepositoryFormatKnit3',
 
2423
    )
 
2424
 
 
2425
format_registry.register_lazy(
 
2426
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
2427
    'bzrlib.repofmt.knitrepo',
 
2428
    'RepositoryFormatKnit4',
 
2429
    )
 
2430
 
 
2431
# Pack-based formats. There is one format for pre-subtrees, and one for
 
2432
# post-subtrees to allow ease of testing.
 
2433
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
2434
format_registry.register_lazy(
 
2435
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
2436
    'bzrlib.repofmt.pack_repo',
 
2437
    'RepositoryFormatKnitPack1',
 
2438
    )
 
2439
format_registry.register_lazy(
 
2440
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
2441
    'bzrlib.repofmt.pack_repo',
 
2442
    'RepositoryFormatKnitPack3',
 
2443
    )
 
2444
format_registry.register_lazy(
 
2445
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
2446
    'bzrlib.repofmt.pack_repo',
 
2447
    'RepositoryFormatKnitPack4',
 
2448
    )
 
2449
format_registry.register_lazy(
 
2450
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
 
2451
    'bzrlib.repofmt.pack_repo',
 
2452
    'RepositoryFormatKnitPack5',
 
2453
    )
 
2454
format_registry.register_lazy(
 
2455
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
 
2456
    'bzrlib.repofmt.pack_repo',
 
2457
    'RepositoryFormatKnitPack5RichRoot',
 
2458
    )
 
2459
format_registry.register_lazy(
 
2460
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
 
2461
    'bzrlib.repofmt.pack_repo',
 
2462
    'RepositoryFormatKnitPack5RichRootBroken',
 
2463
    )
 
2464
format_registry.register_lazy(
 
2465
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
2466
    'bzrlib.repofmt.pack_repo',
 
2467
    'RepositoryFormatKnitPack6',
 
2468
    )
 
2469
format_registry.register_lazy(
 
2470
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
2471
    'bzrlib.repofmt.pack_repo',
 
2472
    'RepositoryFormatKnitPack6RichRoot',
 
2473
    )
 
2474
 
 
2475
# Development formats. 
 
2476
# 1.7->1.8 go below here
 
2477
format_registry.register_lazy(
 
2478
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2479
    'bzrlib.repofmt.pack_repo',
 
2480
    'RepositoryFormatPackDevelopment2',
 
2481
    )
 
2482
format_registry.register_lazy(
 
2483
    ("Bazaar development format 2 with subtree support "
 
2484
        "(needs bzr.dev from before 1.8)\n"),
 
2485
    'bzrlib.repofmt.pack_repo',
 
2486
    'RepositoryFormatPackDevelopment2Subtree',
 
2487
    )
1478
2488
 
1479
2489
 
1480
2490
class InterRepository(InterObject):
1489
2499
    InterRepository.get(other).method_name(parameters).
1490
2500
    """
1491
2501
 
1492
 
    _optimisers = set()
 
2502
    _walk_to_common_revisions_batch_size = 1
 
2503
    _optimisers = []
1493
2504
    """The available optimised InterRepository types."""
1494
2505
 
1495
 
    @needs_write_lock
1496
 
    def copy_content(self, revision_id=None, basis=None):
1497
 
        """Make a complete copy of the content in self into destination.
1498
 
        
1499
 
        This is a destructive operation! Do not use it on existing 
1500
 
        repositories.
1501
 
 
1502
 
        :param revision_id: Only copy the content needed to construct
1503
 
                            revision_id and its parents.
1504
 
        :param basis: Copy the needed data preferentially from basis.
1505
 
        """
1506
 
        try:
1507
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1508
 
        except NotImplementedError:
1509
 
            pass
1510
 
        # grab the basis available data
1511
 
        if basis is not None:
1512
 
            self.target.fetch(basis, revision_id=revision_id)
1513
 
        # but don't bother fetching if we have the needed data now.
1514
 
        if (revision_id not in (None, NULL_REVISION) and 
1515
 
            self.target.has_revision(revision_id)):
1516
 
            return
1517
 
        self.target.fetch(self.source, revision_id=revision_id)
1518
 
 
1519
 
    def _double_lock(self, lock_source, lock_target):
1520
 
        """Take out too locks, rolling back the first if the second throws."""
1521
 
        lock_source()
1522
 
        try:
1523
 
            lock_target()
1524
 
        except Exception:
1525
 
            # we want to ensure that we don't leave source locked by mistake.
1526
 
            # and any error on target should not confuse source.
1527
 
            self.source.unlock()
1528
 
            raise
1529
 
 
1530
 
    @needs_write_lock
1531
 
    def fetch(self, revision_id=None, pb=None):
 
2506
    def __init__(self, source, target):
 
2507
        InterObject.__init__(self, source, target)
 
2508
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2509
        # provide a faster implementation.
 
2510
        self.target_get_graph = self.target.get_graph
 
2511
        self.target_get_parent_map = self.target.get_parent_map
 
2512
 
 
2513
    def copy_content(self, revision_id=None):
 
2514
        raise NotImplementedError(self.copy_content)
 
2515
 
 
2516
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1532
2517
        """Fetch the content required to construct revision_id.
1533
2518
 
1534
 
        The content is copied from source to target.
 
2519
        The content is copied from self.source to self.target.
1535
2520
 
1536
2521
        :param revision_id: if None all content is copied, if NULL_REVISION no
1537
2522
                            content is copied.
1538
2523
        :param pb: optional progress bar to use for progress reports. If not
1539
2524
                   provided a default one will be created.
1540
2525
 
1541
 
        Returns the copied revision count and the failed revisions in a tuple:
1542
 
        (copied, failures).
1543
 
        """
1544
 
        from bzrlib.fetch import GenericRepoFetcher
1545
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1546
 
               self.source, self.source._format, self.target, self.target._format)
1547
 
        f = GenericRepoFetcher(to_repository=self.target,
1548
 
                               from_repository=self.source,
1549
 
                               last_revision=revision_id,
1550
 
                               pb=pb)
1551
 
        return f.count_copied, f.failed_revisions
1552
 
 
1553
 
    def lock_read(self):
1554
 
        """Take out a logical read lock.
1555
 
 
1556
 
        This will lock the source branch and the target branch. The source gets
1557
 
        a read lock and the target a read lock.
1558
 
        """
1559
 
        self._double_lock(self.source.lock_read, self.target.lock_read)
1560
 
 
1561
 
    def lock_write(self):
1562
 
        """Take out a logical write lock.
1563
 
 
1564
 
        This will lock the source branch and the target branch. The source gets
1565
 
        a read lock and the target a write lock.
1566
 
        """
1567
 
        self._double_lock(self.source.lock_read, self.target.lock_write)
1568
 
 
 
2526
        :returns: (copied_revision_count, failures).
 
2527
        """
 
2528
        # Normally we should find a specific InterRepository subclass to do
 
2529
        # the fetch; if nothing else then at least InterSameDataRepository.
 
2530
        # If none of them is suitable it looks like fetching is not possible;
 
2531
        # we try to give a good message why.  _assert_same_model will probably
 
2532
        # give a helpful message; otherwise a generic one.
 
2533
        self._assert_same_model(self.source, self.target)
 
2534
        raise errors.IncompatibleRepositories(self.source, self.target,
 
2535
            "no suitableInterRepository found")
 
2536
 
 
2537
    def _walk_to_common_revisions(self, revision_ids):
 
2538
        """Walk out from revision_ids in source to revisions target has.
 
2539
 
 
2540
        :param revision_ids: The start point for the search.
 
2541
        :return: A set of revision ids.
 
2542
        """
 
2543
        target_graph = self.target_get_graph()
 
2544
        revision_ids = frozenset(revision_ids)
 
2545
        # Fast path for the case where all the revisions are already in the
 
2546
        # target repo.
 
2547
        # (Although this does incur an extra round trip for the
 
2548
        # fairly common case where the target doesn't already have the revision
 
2549
        # we're pushing.)
 
2550
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2551
            return graph.SearchResult(revision_ids, set(), 0, set())
 
2552
        missing_revs = set()
 
2553
        source_graph = self.source.get_graph()
 
2554
        # ensure we don't pay silly lookup costs.
 
2555
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
2556
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
2557
        searcher_exhausted = False
 
2558
        while True:
 
2559
            next_revs = set()
 
2560
            ghosts = set()
 
2561
            # Iterate the searcher until we have enough next_revs
 
2562
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
2563
                try:
 
2564
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
2565
                    next_revs.update(next_revs_part)
 
2566
                    ghosts.update(ghosts_part)
 
2567
                except StopIteration:
 
2568
                    searcher_exhausted = True
 
2569
                    break
 
2570
            # If there are ghosts in the source graph, and the caller asked for
 
2571
            # them, make sure that they are present in the target.
 
2572
            # We don't care about other ghosts as we can't fetch them and
 
2573
            # haven't been asked to.
 
2574
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
2575
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
2576
            if revs_to_get:
 
2577
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
2578
                # we always have NULL_REVISION present.
 
2579
                have_revs = have_revs.union(null_set)
 
2580
                # Check if the target is missing any ghosts we need.
 
2581
                ghosts_to_check.difference_update(have_revs)
 
2582
                if ghosts_to_check:
 
2583
                    # One of the caller's revision_ids is a ghost in both the
 
2584
                    # source and the target.
 
2585
                    raise errors.NoSuchRevision(
 
2586
                        self.source, ghosts_to_check.pop())
 
2587
                missing_revs.update(next_revs - have_revs)
 
2588
                # Because we may have walked past the original stop point, make
 
2589
                # sure everything is stopped
 
2590
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
2591
                searcher.stop_searching_any(stop_revs)
 
2592
            if searcher_exhausted:
 
2593
                break
 
2594
        return searcher.get_result()
 
2595
 
 
2596
    @deprecated_method(one_two)
1569
2597
    @needs_read_lock
1570
 
    def missing_revision_ids(self, revision_id=None):
 
2598
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
1571
2599
        """Return the revision ids that source has that target does not.
1572
2600
        
1573
2601
        These are returned in topological order.
1574
2602
 
1575
2603
        :param revision_id: only return revision ids included by this
1576
2604
                            revision_id.
1577
 
        """
 
2605
        :param find_ghosts: If True find missing revisions in deep history
 
2606
            rather than just finding the surface difference.
 
2607
        """
 
2608
        return list(self.search_missing_revision_ids(
 
2609
            revision_id, find_ghosts).get_keys())
 
2610
 
 
2611
    @needs_read_lock
 
2612
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2613
        """Return the revision ids that source has that target does not.
 
2614
        
 
2615
        :param revision_id: only return revision ids included by this
 
2616
                            revision_id.
 
2617
        :param find_ghosts: If True find missing revisions in deep history
 
2618
            rather than just finding the surface difference.
 
2619
        :return: A bzrlib.graph.SearchResult.
 
2620
        """
 
2621
        # stop searching at found target revisions.
 
2622
        if not find_ghosts and revision_id is not None:
 
2623
            return self._walk_to_common_revisions([revision_id])
1578
2624
        # generic, possibly worst case, slow code path.
1579
2625
        target_ids = set(self.target.all_revision_ids())
1580
2626
        if revision_id is not None:
1581
2627
            source_ids = self.source.get_ancestry(revision_id)
1582
 
            assert source_ids[0] == None
 
2628
            if source_ids[0] is not None:
 
2629
                raise AssertionError()
1583
2630
            source_ids.pop(0)
1584
2631
        else:
1585
2632
            source_ids = self.source.all_revision_ids()
1586
2633
        result_set = set(source_ids).difference(target_ids)
1587
 
        # this may look like a no-op: its not. It preserves the ordering
1588
 
        # other_ids had while only returning the members from other_ids
1589
 
        # that we've decided we need.
1590
 
        return [rev_id for rev_id in source_ids if rev_id in result_set]
1591
 
 
1592
 
    def unlock(self):
1593
 
        """Release the locks on source and target."""
1594
 
        try:
1595
 
            self.target.unlock()
1596
 
        finally:
1597
 
            self.source.unlock()
1598
 
 
1599
 
 
1600
 
class InterWeaveRepo(InterRepository):
1601
 
    """Optimised code paths between Weave based repositories."""
1602
 
 
1603
 
    _matching_repo_format = RepositoryFormat7()
1604
 
    """Repository format for testing with."""
 
2634
        return self.source.revision_ids_to_search_result(result_set)
 
2635
 
 
2636
    @staticmethod
 
2637
    def _same_model(source, target):
 
2638
        """True if source and target have the same data representation.
 
2639
        
 
2640
        Note: this is always called on the base class; overriding it in a
 
2641
        subclass will have no effect.
 
2642
        """
 
2643
        try:
 
2644
            InterRepository._assert_same_model(source, target)
 
2645
            return True
 
2646
        except errors.IncompatibleRepositories, e:
 
2647
            return False
 
2648
 
 
2649
    @staticmethod
 
2650
    def _assert_same_model(source, target):
 
2651
        """Raise an exception if two repositories do not use the same model.
 
2652
        """
 
2653
        if source.supports_rich_root() != target.supports_rich_root():
 
2654
            raise errors.IncompatibleRepositories(source, target,
 
2655
                "different rich-root support")
 
2656
        if source._serializer != target._serializer:
 
2657
            raise errors.IncompatibleRepositories(source, target,
 
2658
                "different serializers")
 
2659
 
 
2660
 
 
2661
class InterSameDataRepository(InterRepository):
 
2662
    """Code for converting between repositories that represent the same data.
 
2663
    
 
2664
    Data format and model must match for this to work.
 
2665
    """
 
2666
 
 
2667
    @classmethod
 
2668
    def _get_repo_format_to_test(self):
 
2669
        """Repository format for testing with.
 
2670
        
 
2671
        InterSameData can pull from subtree to subtree and from non-subtree to
 
2672
        non-subtree, so we test this with the richest repository format.
 
2673
        """
 
2674
        from bzrlib.repofmt import knitrepo
 
2675
        return knitrepo.RepositoryFormatKnit3()
 
2676
 
 
2677
    @staticmethod
 
2678
    def is_compatible(source, target):
 
2679
        return InterRepository._same_model(source, target)
 
2680
 
 
2681
    @needs_write_lock
 
2682
    def copy_content(self, revision_id=None):
 
2683
        """Make a complete copy of the content in self into destination.
 
2684
 
 
2685
        This copies both the repository's revision data, and configuration information
 
2686
        such as the make_working_trees setting.
 
2687
        
 
2688
        This is a destructive operation! Do not use it on existing 
 
2689
        repositories.
 
2690
 
 
2691
        :param revision_id: Only copy the content needed to construct
 
2692
                            revision_id and its parents.
 
2693
        """
 
2694
        try:
 
2695
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2696
        except NotImplementedError:
 
2697
            pass
 
2698
        # but don't bother fetching if we have the needed data now.
 
2699
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2700
            self.target.has_revision(revision_id)):
 
2701
            return
 
2702
        self.target.fetch(self.source, revision_id=revision_id)
 
2703
 
 
2704
    @needs_write_lock
 
2705
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2706
        """See InterRepository.fetch()."""
 
2707
        from bzrlib.fetch import RepoFetcher
 
2708
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2709
               self.source, self.source._format, self.target,
 
2710
               self.target._format)
 
2711
        f = RepoFetcher(to_repository=self.target,
 
2712
                               from_repository=self.source,
 
2713
                               last_revision=revision_id,
 
2714
                               pb=pb, find_ghosts=find_ghosts)
 
2715
        return f.count_copied, f.failed_revisions
 
2716
 
 
2717
 
 
2718
class InterWeaveRepo(InterSameDataRepository):
 
2719
    """Optimised code paths between Weave based repositories.
 
2720
    
 
2721
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
2722
    implemented lazy inter-object optimisation.
 
2723
    """
 
2724
 
 
2725
    @classmethod
 
2726
    def _get_repo_format_to_test(self):
 
2727
        from bzrlib.repofmt import weaverepo
 
2728
        return weaverepo.RepositoryFormat7()
1605
2729
 
1606
2730
    @staticmethod
1607
2731
    def is_compatible(source, target):
1611
2735
        could lead to confusing results, and there is no need to be 
1612
2736
        overly general.
1613
2737
        """
 
2738
        from bzrlib.repofmt.weaverepo import (
 
2739
                RepositoryFormat5,
 
2740
                RepositoryFormat6,
 
2741
                RepositoryFormat7,
 
2742
                )
1614
2743
        try:
1615
2744
            return (isinstance(source._format, (RepositoryFormat5,
1616
2745
                                                RepositoryFormat6,
1622
2751
            return False
1623
2752
    
1624
2753
    @needs_write_lock
1625
 
    def copy_content(self, revision_id=None, basis=None):
 
2754
    def copy_content(self, revision_id=None):
1626
2755
        """See InterRepository.copy_content()."""
1627
2756
        # weave specific optimised path:
1628
 
        if basis is not None:
1629
 
            # copy the basis in, then fetch remaining data.
1630
 
            basis.copy_content_into(self.target, revision_id)
1631
 
            # the basis copy_content_into could miss-set this.
 
2757
        try:
 
2758
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2759
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
2760
            pass
 
2761
        # FIXME do not peek!
 
2762
        if self.source._transport.listable():
 
2763
            pb = ui.ui_factory.nested_progress_bar()
1632
2764
            try:
1633
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1634
 
            except NotImplementedError:
1635
 
                pass
 
2765
                self.target.texts.insert_record_stream(
 
2766
                    self.source.texts.get_record_stream(
 
2767
                        self.source.texts.keys(), 'topological', False))
 
2768
                pb.update('copying inventory', 0, 1)
 
2769
                self.target.inventories.insert_record_stream(
 
2770
                    self.source.inventories.get_record_stream(
 
2771
                        self.source.inventories.keys(), 'topological', False))
 
2772
                self.target.signatures.insert_record_stream(
 
2773
                    self.source.signatures.get_record_stream(
 
2774
                        self.source.signatures.keys(),
 
2775
                        'unordered', True))
 
2776
                self.target.revisions.insert_record_stream(
 
2777
                    self.source.revisions.get_record_stream(
 
2778
                        self.source.revisions.keys(),
 
2779
                        'topological', True))
 
2780
            finally:
 
2781
                pb.finished()
 
2782
        else:
1636
2783
            self.target.fetch(self.source, revision_id=revision_id)
1637
 
        else:
1638
 
            try:
1639
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1640
 
            except NotImplementedError:
1641
 
                pass
1642
 
            # FIXME do not peek!
1643
 
            if self.source.control_files._transport.listable():
1644
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1645
 
                try:
1646
 
                    self.target.weave_store.copy_all_ids(
1647
 
                        self.source.weave_store,
1648
 
                        pb=pb,
1649
 
                        from_transaction=self.source.get_transaction(),
1650
 
                        to_transaction=self.target.get_transaction())
1651
 
                    pb.update('copying inventory', 0, 1)
1652
 
                    self.target.control_weaves.copy_multi(
1653
 
                        self.source.control_weaves, ['inventory'],
1654
 
                        from_transaction=self.source.get_transaction(),
1655
 
                        to_transaction=self.target.get_transaction())
1656
 
                    self.target._revision_store.text_store.copy_all_ids(
1657
 
                        self.source._revision_store.text_store,
1658
 
                        pb=pb)
1659
 
                finally:
1660
 
                    pb.finished()
1661
 
            else:
1662
 
                self.target.fetch(self.source, revision_id=revision_id)
1663
2784
 
1664
2785
    @needs_write_lock
1665
 
    def fetch(self, revision_id=None, pb=None):
 
2786
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1666
2787
        """See InterRepository.fetch()."""
1667
 
        from bzrlib.fetch import GenericRepoFetcher
 
2788
        from bzrlib.fetch import RepoFetcher
1668
2789
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1669
2790
               self.source, self.source._format, self.target, self.target._format)
1670
 
        f = GenericRepoFetcher(to_repository=self.target,
 
2791
        f = RepoFetcher(to_repository=self.target,
1671
2792
                               from_repository=self.source,
1672
2793
                               last_revision=revision_id,
1673
 
                               pb=pb)
 
2794
                               pb=pb, find_ghosts=find_ghosts)
1674
2795
        return f.count_copied, f.failed_revisions
1675
2796
 
1676
2797
    @needs_read_lock
1677
 
    def missing_revision_ids(self, revision_id=None):
 
2798
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1678
2799
        """See InterRepository.missing_revision_ids()."""
1679
2800
        # we want all revisions to satisfy revision_id in source.
1680
2801
        # but we don't want to stat every file here and there.
1689
2810
        # - RBC 20060209
1690
2811
        if revision_id is not None:
1691
2812
            source_ids = self.source.get_ancestry(revision_id)
1692
 
            assert source_ids[0] == None
 
2813
            if source_ids[0] is not None:
 
2814
                raise AssertionError()
1693
2815
            source_ids.pop(0)
1694
2816
        else:
1695
2817
            source_ids = self.source._all_possible_ids()
1700
2822
        # we do not have a revision as that would be pointless.
1701
2823
        target_ids = set(self.target._all_possible_ids())
1702
2824
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1703
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2825
        actually_present_revisions = set(
 
2826
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1704
2827
        required_revisions = source_ids_set.difference(actually_present_revisions)
1705
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1706
2828
        if revision_id is not None:
1707
2829
            # we used get_ancestry to determine source_ids then we are assured all
1708
2830
            # revisions referenced are present as they are installed in topological order.
1709
2831
            # and the tip revision was validated by get_ancestry.
1710
 
            return required_topo_revisions
 
2832
            result_set = required_revisions
1711
2833
        else:
1712
2834
            # if we just grabbed the possibly available ids, then 
1713
2835
            # we only have an estimate of whats available and need to validate
1714
2836
            # that against the revision records.
1715
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1716
 
 
1717
 
 
1718
 
class InterKnitRepo(InterRepository):
 
2837
            result_set = set(
 
2838
                self.source._eliminate_revisions_not_present(required_revisions))
 
2839
        return self.source.revision_ids_to_search_result(result_set)
 
2840
 
 
2841
 
 
2842
class InterKnitRepo(InterSameDataRepository):
1719
2843
    """Optimised code paths between Knit based repositories."""
1720
2844
 
1721
 
    _matching_repo_format = RepositoryFormatKnit1()
1722
 
    """Repository format for testing with."""
 
2845
    @classmethod
 
2846
    def _get_repo_format_to_test(self):
 
2847
        from bzrlib.repofmt import knitrepo
 
2848
        return knitrepo.RepositoryFormatKnit1()
1723
2849
 
1724
2850
    @staticmethod
1725
2851
    def is_compatible(source, target):
1729
2855
        could lead to confusing results, and there is no need to be 
1730
2856
        overly general.
1731
2857
        """
 
2858
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
1732
2859
        try:
1733
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1734
 
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
2860
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
2861
                isinstance(target._format, RepositoryFormatKnit))
1735
2862
        except AttributeError:
1736
2863
            return False
 
2864
        return are_knits and InterRepository._same_model(source, target)
1737
2865
 
1738
2866
    @needs_write_lock
1739
 
    def fetch(self, revision_id=None, pb=None):
 
2867
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1740
2868
        """See InterRepository.fetch()."""
1741
 
        from bzrlib.fetch import KnitRepoFetcher
 
2869
        from bzrlib.fetch import RepoFetcher
1742
2870
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1743
2871
               self.source, self.source._format, self.target, self.target._format)
1744
 
        f = KnitRepoFetcher(to_repository=self.target,
 
2872
        f = RepoFetcher(to_repository=self.target,
1745
2873
                            from_repository=self.source,
1746
2874
                            last_revision=revision_id,
1747
 
                            pb=pb)
 
2875
                            pb=pb, find_ghosts=find_ghosts)
1748
2876
        return f.count_copied, f.failed_revisions
1749
2877
 
1750
2878
    @needs_read_lock
1751
 
    def missing_revision_ids(self, revision_id=None):
 
2879
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1752
2880
        """See InterRepository.missing_revision_ids()."""
1753
2881
        if revision_id is not None:
1754
2882
            source_ids = self.source.get_ancestry(revision_id)
1755
 
            assert source_ids[0] == None
 
2883
            if source_ids[0] is not None:
 
2884
                raise AssertionError()
1756
2885
            source_ids.pop(0)
1757
2886
        else:
1758
 
            source_ids = self.source._all_possible_ids()
 
2887
            source_ids = self.source.all_revision_ids()
1759
2888
        source_ids_set = set(source_ids)
1760
2889
        # source_ids is the worst possible case we may need to pull.
1761
2890
        # now we want to filter source_ids against what we actually
1762
2891
        # have in target, but don't try to check for existence where we know
1763
2892
        # we do not have a revision as that would be pointless.
1764
 
        target_ids = set(self.target._all_possible_ids())
 
2893
        target_ids = set(self.target.all_revision_ids())
1765
2894
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1766
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2895
        actually_present_revisions = set(
 
2896
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1767
2897
        required_revisions = source_ids_set.difference(actually_present_revisions)
1768
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1769
2898
        if revision_id is not None:
1770
2899
            # we used get_ancestry to determine source_ids then we are assured all
1771
2900
            # revisions referenced are present as they are installed in topological order.
1772
2901
            # and the tip revision was validated by get_ancestry.
1773
 
            return required_topo_revisions
 
2902
            result_set = required_revisions
1774
2903
        else:
1775
2904
            # if we just grabbed the possibly available ids, then 
1776
2905
            # we only have an estimate of whats available and need to validate
1777
2906
            # that against the revision records.
1778
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1779
 
 
 
2907
            result_set = set(
 
2908
                self.source._eliminate_revisions_not_present(required_revisions))
 
2909
        return self.source.revision_ids_to_search_result(result_set)
 
2910
 
 
2911
 
 
2912
class InterPackRepo(InterSameDataRepository):
 
2913
    """Optimised code paths between Pack based repositories."""
 
2914
 
 
2915
    @classmethod
 
2916
    def _get_repo_format_to_test(self):
 
2917
        from bzrlib.repofmt import pack_repo
 
2918
        return pack_repo.RepositoryFormatKnitPack1()
 
2919
 
 
2920
    @staticmethod
 
2921
    def is_compatible(source, target):
 
2922
        """Be compatible with known Pack formats.
 
2923
        
 
2924
        We don't test for the stores being of specific types because that
 
2925
        could lead to confusing results, and there is no need to be 
 
2926
        overly general.
 
2927
        """
 
2928
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2929
        try:
 
2930
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2931
                isinstance(target._format, RepositoryFormatPack))
 
2932
        except AttributeError:
 
2933
            return False
 
2934
        return are_packs and InterRepository._same_model(source, target)
 
2935
 
 
2936
    @needs_write_lock
 
2937
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2938
        """See InterRepository.fetch()."""
 
2939
        if (len(self.source._fallback_repositories) > 0 or
 
2940
            len(self.target._fallback_repositories) > 0):
 
2941
            # The pack layer is not aware of fallback repositories, so when
 
2942
            # fetching from a stacked repository or into a stacked repository
 
2943
            # we use the generic fetch logic which uses the VersionedFiles
 
2944
            # attributes on repository.
 
2945
            from bzrlib.fetch import RepoFetcher
 
2946
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
2947
                                  pb, find_ghosts)
 
2948
            return fetcher.count_copied, fetcher.failed_revisions
 
2949
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2950
               self.source, self.source._format, self.target, self.target._format)
 
2951
        self.count_copied = 0
 
2952
        if revision_id is None:
 
2953
            # TODO:
 
2954
            # everything to do - use pack logic
 
2955
            # to fetch from all packs to one without
 
2956
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2957
            # till then:
 
2958
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
2959
            revision_ids = source_revision_ids - \
 
2960
                frozenset(self.target_get_parent_map(source_revision_ids))
 
2961
            revision_keys = [(revid,) for revid in revision_ids]
 
2962
            target_pack_collection = self._get_target_pack_collection()
 
2963
            index = target_pack_collection.revision_index.combined_index
 
2964
            present_revision_ids = set(item[1][0] for item in
 
2965
                index.iter_entries(revision_keys))
 
2966
            revision_ids = set(revision_ids) - present_revision_ids
 
2967
            # implementing the TODO will involve:
 
2968
            # - detecting when all of a pack is selected
 
2969
            # - avoiding as much as possible pre-selection, so the
 
2970
            # more-core routines such as create_pack_from_packs can filter in
 
2971
            # a just-in-time fashion. (though having a HEADS list on a
 
2972
            # repository might make this a lot easier, because we could
 
2973
            # sensibly detect 'new revisions' without doing a full index scan.
 
2974
        elif _mod_revision.is_null(revision_id):
 
2975
            # nothing to do:
 
2976
            return (0, [])
 
2977
        else:
 
2978
            try:
 
2979
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2980
                    find_ghosts=find_ghosts).get_keys()
 
2981
            except errors.NoSuchRevision:
 
2982
                raise errors.InstallFailed([revision_id])
 
2983
            if len(revision_ids) == 0:
 
2984
                return (0, [])
 
2985
        return self._pack(self.source, self.target, revision_ids)
 
2986
 
 
2987
    def _pack(self, source, target, revision_ids):
 
2988
        from bzrlib.repofmt.pack_repo import Packer
 
2989
        target_pack_collection = self._get_target_pack_collection()
 
2990
        packs = source._pack_collection.all_packs()
 
2991
        pack = Packer(target_pack_collection, packs, '.fetch',
 
2992
            revision_ids).pack()
 
2993
        if pack is not None:
 
2994
            target_pack_collection._save_pack_names()
 
2995
            copied_revs = pack.get_revision_count()
 
2996
            # Trigger an autopack. This may duplicate effort as we've just done
 
2997
            # a pack creation, but for now it is simpler to think about as
 
2998
            # 'upload data, then repack if needed'.
 
2999
            self._autopack()
 
3000
            return (copied_revs, [])
 
3001
        else:
 
3002
            return (0, [])
 
3003
 
 
3004
    def _autopack(self):
 
3005
        self.target._pack_collection.autopack()
 
3006
        
 
3007
    def _get_target_pack_collection(self):
 
3008
        return self.target._pack_collection
 
3009
 
 
3010
    @needs_read_lock
 
3011
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3012
        """See InterRepository.missing_revision_ids().
 
3013
        
 
3014
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3015
            revision_id.
 
3016
        """
 
3017
        if not find_ghosts and revision_id is not None:
 
3018
            return self._walk_to_common_revisions([revision_id])
 
3019
        elif revision_id is not None:
 
3020
            # Find ghosts: search for revisions pointing from one repository to
 
3021
            # the other, and vice versa, anywhere in the history of revision_id.
 
3022
            graph = self.target_get_graph(other_repository=self.source)
 
3023
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3024
            found_ids = set()
 
3025
            while True:
 
3026
                try:
 
3027
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3028
                except StopIteration:
 
3029
                    break
 
3030
                if revision_id in ghosts:
 
3031
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3032
                found_ids.update(next_revs)
 
3033
                found_ids.update(ghosts)
 
3034
            found_ids = frozenset(found_ids)
 
3035
            # Double query here: should be able to avoid this by changing the
 
3036
            # graph api further.
 
3037
            result_set = found_ids - frozenset(
 
3038
                self.target_get_parent_map(found_ids))
 
3039
        else:
 
3040
            source_ids = self.source.all_revision_ids()
 
3041
            # source_ids is the worst possible case we may need to pull.
 
3042
            # now we want to filter source_ids against what we actually
 
3043
            # have in target, but don't try to check for existence where we know
 
3044
            # we do not have a revision as that would be pointless.
 
3045
            target_ids = set(self.target.all_revision_ids())
 
3046
            result_set = set(source_ids).difference(target_ids)
 
3047
        return self.source.revision_ids_to_search_result(result_set)
 
3048
 
 
3049
 
 
3050
class InterModel1and2(InterRepository):
 
3051
 
 
3052
    @classmethod
 
3053
    def _get_repo_format_to_test(self):
 
3054
        return None
 
3055
 
 
3056
    @staticmethod
 
3057
    def is_compatible(source, target):
 
3058
        if not source.supports_rich_root() and target.supports_rich_root():
 
3059
            return True
 
3060
        else:
 
3061
            return False
 
3062
 
 
3063
    @needs_write_lock
 
3064
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3065
        """See InterRepository.fetch()."""
 
3066
        from bzrlib.fetch import Model1toKnit2Fetcher
 
3067
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
3068
                                 from_repository=self.source,
 
3069
                                 last_revision=revision_id,
 
3070
                                 pb=pb, find_ghosts=find_ghosts)
 
3071
        return f.count_copied, f.failed_revisions
 
3072
 
 
3073
    @needs_write_lock
 
3074
    def copy_content(self, revision_id=None):
 
3075
        """Make a complete copy of the content in self into destination.
 
3076
        
 
3077
        This is a destructive operation! Do not use it on existing 
 
3078
        repositories.
 
3079
 
 
3080
        :param revision_id: Only copy the content needed to construct
 
3081
                            revision_id and its parents.
 
3082
        """
 
3083
        try:
 
3084
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3085
        except NotImplementedError:
 
3086
            pass
 
3087
        # but don't bother fetching if we have the needed data now.
 
3088
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
3089
            self.target.has_revision(revision_id)):
 
3090
            return
 
3091
        self.target.fetch(self.source, revision_id=revision_id)
 
3092
 
 
3093
 
 
3094
class InterKnit1and2(InterKnitRepo):
 
3095
 
 
3096
    @classmethod
 
3097
    def _get_repo_format_to_test(self):
 
3098
        return None
 
3099
 
 
3100
    @staticmethod
 
3101
    def is_compatible(source, target):
 
3102
        """Be compatible with Knit1 source and Knit3 target"""
 
3103
        try:
 
3104
            from bzrlib.repofmt.knitrepo import (
 
3105
                RepositoryFormatKnit1,
 
3106
                RepositoryFormatKnit3,
 
3107
                )
 
3108
            from bzrlib.repofmt.pack_repo import (
 
3109
                RepositoryFormatKnitPack1,
 
3110
                RepositoryFormatKnitPack3,
 
3111
                RepositoryFormatKnitPack4,
 
3112
                RepositoryFormatKnitPack5,
 
3113
                RepositoryFormatKnitPack5RichRoot,
 
3114
                RepositoryFormatKnitPack6,
 
3115
                RepositoryFormatKnitPack6RichRoot,
 
3116
                RepositoryFormatPackDevelopment2,
 
3117
                RepositoryFormatPackDevelopment2Subtree,
 
3118
                )
 
3119
            norichroot = (
 
3120
                RepositoryFormatKnit1,            # no rr, no subtree
 
3121
                RepositoryFormatKnitPack1,        # no rr, no subtree
 
3122
                RepositoryFormatPackDevelopment2, # no rr, no subtree
 
3123
                RepositoryFormatKnitPack5,        # no rr, no subtree
 
3124
                RepositoryFormatKnitPack6,        # no rr, no subtree
 
3125
                )
 
3126
            richroot = (
 
3127
                RepositoryFormatKnit3,            # rr, subtree
 
3128
                RepositoryFormatKnitPack3,        # rr, subtree
 
3129
                RepositoryFormatKnitPack4,        # rr, no subtree
 
3130
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
 
3131
                RepositoryFormatKnitPack6RichRoot,# rr, no subtree
 
3132
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
 
3133
                )
 
3134
            for format in norichroot:
 
3135
                if format.rich_root_data:
 
3136
                    raise AssertionError('Format %s is a rich-root format'
 
3137
                        ' but is included in the non-rich-root list'
 
3138
                        % (format,))
 
3139
            for format in richroot:
 
3140
                if not format.rich_root_data:
 
3141
                    raise AssertionError('Format %s is not a rich-root format'
 
3142
                        ' but is included in the rich-root list'
 
3143
                        % (format,))
 
3144
            # TODO: One alternative is to just check format.rich_root_data,
 
3145
            #       instead of keeping membership lists. However, the formats
 
3146
            #       *also* have to use the same 'Knit' style of storage
 
3147
            #       (line-deltas, fulltexts, etc.)
 
3148
            return (isinstance(source._format, norichroot) and
 
3149
                    isinstance(target._format, richroot))
 
3150
        except AttributeError:
 
3151
            return False
 
3152
 
 
3153
    @needs_write_lock
 
3154
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3155
        """See InterRepository.fetch()."""
 
3156
        from bzrlib.fetch import Knit1to2Fetcher
 
3157
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
3158
               self.source, self.source._format, self.target, 
 
3159
               self.target._format)
 
3160
        f = Knit1to2Fetcher(to_repository=self.target,
 
3161
                            from_repository=self.source,
 
3162
                            last_revision=revision_id,
 
3163
                            pb=pb, find_ghosts=find_ghosts)
 
3164
        return f.count_copied, f.failed_revisions
 
3165
 
 
3166
 
 
3167
class InterDifferingSerializer(InterKnitRepo):
 
3168
 
 
3169
    @classmethod
 
3170
    def _get_repo_format_to_test(self):
 
3171
        return None
 
3172
 
 
3173
    @staticmethod
 
3174
    def is_compatible(source, target):
 
3175
        """Be compatible with Knit2 source and Knit3 target"""
 
3176
        if source.supports_rich_root() != target.supports_rich_root():
 
3177
            return False
 
3178
        # Ideally, we'd support fetching if the source had no tree references
 
3179
        # even if it supported them...
 
3180
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3181
            not getattr(target, '_format.supports_tree_reference', False)):
 
3182
            return False
 
3183
        return True
 
3184
 
 
3185
    def _fetch_batch(self, revision_ids, basis_id, basis_tree):
 
3186
        """Fetch across a few revisions.
 
3187
 
 
3188
        :param revision_ids: The revisions to copy
 
3189
        :param basis_id: The revision_id of basis_tree
 
3190
        :param basis_tree: A tree that is not in revision_ids which should
 
3191
            already exist in the target.
 
3192
        :return: (basis_id, basis_tree) A new basis to use now that these trees
 
3193
            have been copied.
 
3194
        """
 
3195
        # Walk though all revisions; get inventory deltas, copy referenced
 
3196
        # texts that delta references, insert the delta, revision and
 
3197
        # signature.
 
3198
        text_keys = set()
 
3199
        pending_deltas = []
 
3200
        pending_revisions = []
 
3201
        for tree in self.source.revision_trees(revision_ids):
 
3202
            current_revision_id = tree.get_revision_id()
 
3203
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3204
            for old_path, new_path, file_id, entry in delta:
 
3205
                if new_path is not None:
 
3206
                    if not (new_path or self.target.supports_rich_root()):
 
3207
                        # We leave the inventory delta in, because that
 
3208
                        # will have the deserialised inventory root
 
3209
                        # pointer.
 
3210
                        continue
 
3211
                    # TODO: Do we need:
 
3212
                    #       "if entry.revision == current_revision_id" ?
 
3213
                    if entry.revision == current_revision_id:
 
3214
                        text_keys.add((file_id, entry.revision))
 
3215
            revision = self.source.get_revision(current_revision_id)
 
3216
            pending_deltas.append((basis_id, delta,
 
3217
                current_revision_id, revision.parent_ids))
 
3218
            pending_revisions.append(revision)
 
3219
            basis_id = current_revision_id
 
3220
            basis_tree = tree
 
3221
        # Copy file texts
 
3222
        from_texts = self.source.texts
 
3223
        to_texts = self.target.texts
 
3224
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3225
            text_keys, self.target._fetch_order,
 
3226
            not self.target._fetch_uses_deltas))
 
3227
        # insert deltas
 
3228
        for delta in pending_deltas:
 
3229
            self.target.add_inventory_by_delta(*delta)
 
3230
        # insert signatures and revisions
 
3231
        for revision in pending_revisions:
 
3232
            try:
 
3233
                signature = self.source.get_signature_text(
 
3234
                    revision.revision_id)
 
3235
                self.target.add_signature_text(revision.revision_id,
 
3236
                    signature)
 
3237
            except errors.NoSuchRevision:
 
3238
                pass
 
3239
            self.target.add_revision(revision.revision_id, revision)
 
3240
        return basis_id, basis_tree
 
3241
 
 
3242
    def _fetch_all_revisions(self, revision_ids, pb):
 
3243
        """Fetch everything for the list of revisions.
 
3244
 
 
3245
        :param revision_ids: The list of revisions to fetch. Must be in
 
3246
            topological order.
 
3247
        :param pb: A ProgressBar
 
3248
        :return: None
 
3249
        """
 
3250
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3251
        batch_size = 100
 
3252
        for offset in range(0, len(revision_ids), batch_size):
 
3253
            self.target.start_write_group()
 
3254
            try:
 
3255
                pb.update('Transferring revisions', offset,
 
3256
                          len(revision_ids))
 
3257
                batch = revision_ids[offset:offset+batch_size]
 
3258
                basis_id, basis_tree = self._fetch_batch(batch,
 
3259
                    basis_id, basis_tree)
 
3260
            except:
 
3261
                self.target.abort_write_group()
 
3262
                raise
 
3263
            else:
 
3264
                self.target.commit_write_group()
 
3265
        pb.update('Transferring revisions', len(revision_ids),
 
3266
                  len(revision_ids))
 
3267
 
 
3268
    @needs_write_lock
 
3269
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3270
        """See InterRepository.fetch()."""
 
3271
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
3272
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3273
        if not revision_ids:
 
3274
            return 0, 0
 
3275
        revision_ids = tsort.topo_sort(
 
3276
            self.source.get_graph().get_parent_map(revision_ids))
 
3277
        if pb is None:
 
3278
            my_pb = ui.ui_factory.nested_progress_bar()
 
3279
            pb = my_pb
 
3280
        else:
 
3281
            my_pb = None
 
3282
        try:
 
3283
            self._fetch_all_revisions(revision_ids, pb)
 
3284
        finally:
 
3285
            if my_pb is not None:
 
3286
                my_pb.finished()
 
3287
        return len(revision_ids), 0
 
3288
 
 
3289
    def _get_basis(self, first_revision_id):
 
3290
        """Get a revision and tree which exists in the target.
 
3291
 
 
3292
        This assumes that first_revision_id is selected for transmission
 
3293
        because all other ancestors are already present. If we can't find an
 
3294
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
3295
 
 
3296
        :return: (basis_id, basis_tree)
 
3297
        """
 
3298
        first_rev = self.source.get_revision(first_revision_id)
 
3299
        try:
 
3300
            basis_id = first_rev.parent_ids[0]
 
3301
            # only valid as a basis if the target has it
 
3302
            self.target.get_revision(basis_id)
 
3303
            # Try to get a basis tree - if its a ghost it will hit the
 
3304
            # NoSuchRevision case.
 
3305
            basis_tree = self.source.revision_tree(basis_id)
 
3306
        except (IndexError, errors.NoSuchRevision):
 
3307
            basis_id = _mod_revision.NULL_REVISION
 
3308
            basis_tree = self.source.revision_tree(basis_id)
 
3309
        return basis_id, basis_tree
 
3310
 
 
3311
 
 
3312
class InterOtherToRemote(InterRepository):
 
3313
    """An InterRepository that simply delegates to the 'real' InterRepository
 
3314
    calculated for (source, target._real_repository).
 
3315
    """
 
3316
 
 
3317
    _walk_to_common_revisions_batch_size = 50
 
3318
 
 
3319
    def __init__(self, source, target):
 
3320
        InterRepository.__init__(self, source, target)
 
3321
        self._real_inter = None
 
3322
 
 
3323
    @staticmethod
 
3324
    def is_compatible(source, target):
 
3325
        if isinstance(target, remote.RemoteRepository):
 
3326
            return True
 
3327
        return False
 
3328
 
 
3329
    def _ensure_real_inter(self):
 
3330
        if self._real_inter is None:
 
3331
            self.target._ensure_real()
 
3332
            real_target = self.target._real_repository
 
3333
            self._real_inter = InterRepository.get(self.source, real_target)
 
3334
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3335
            self._real_inter.target_get_graph = self.target.get_graph
 
3336
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3337
    
 
3338
    def copy_content(self, revision_id=None):
 
3339
        self._ensure_real_inter()
 
3340
        self._real_inter.copy_content(revision_id=revision_id)
 
3341
 
 
3342
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3343
        self._ensure_real_inter()
 
3344
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3345
            find_ghosts=find_ghosts)
 
3346
 
 
3347
    @classmethod
 
3348
    def _get_repo_format_to_test(self):
 
3349
        return None
 
3350
 
 
3351
 
 
3352
class InterRemoteToOther(InterRepository):
 
3353
 
 
3354
    def __init__(self, source, target):
 
3355
        InterRepository.__init__(self, source, target)
 
3356
        self._real_inter = None
 
3357
 
 
3358
    @staticmethod
 
3359
    def is_compatible(source, target):
 
3360
        if not isinstance(source, remote.RemoteRepository):
 
3361
            return False
 
3362
        # Is source's model compatible with target's model?
 
3363
        source._ensure_real()
 
3364
        real_source = source._real_repository
 
3365
        if isinstance(real_source, remote.RemoteRepository):
 
3366
            raise NotImplementedError(
 
3367
                "We don't support remote repos backed by remote repos yet.")
 
3368
        return InterRepository._same_model(real_source, target)
 
3369
 
 
3370
    def _ensure_real_inter(self):
 
3371
        if self._real_inter is None:
 
3372
            self.source._ensure_real()
 
3373
            real_source = self.source._real_repository
 
3374
            self._real_inter = InterRepository.get(real_source, self.target)
 
3375
    
 
3376
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3377
        self._ensure_real_inter()
 
3378
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3379
            find_ghosts=find_ghosts)
 
3380
 
 
3381
    def copy_content(self, revision_id=None):
 
3382
        self._ensure_real_inter()
 
3383
        self._real_inter.copy_content(revision_id=revision_id)
 
3384
 
 
3385
    @classmethod
 
3386
    def _get_repo_format_to_test(self):
 
3387
        return None
 
3388
 
 
3389
 
 
3390
 
 
3391
class InterPackToRemotePack(InterPackRepo):
 
3392
    """A specialisation of InterPackRepo for a target that is a
 
3393
    RemoteRepository.
 
3394
 
 
3395
    This will use the get_parent_map RPC rather than plain readvs, and also
 
3396
    uses an RPC for autopacking.
 
3397
    """
 
3398
 
 
3399
    _walk_to_common_revisions_batch_size = 50
 
3400
 
 
3401
    @staticmethod
 
3402
    def is_compatible(source, target):
 
3403
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3404
        if isinstance(source._format, RepositoryFormatPack):
 
3405
            if isinstance(target, remote.RemoteRepository):
 
3406
                target._ensure_real()
 
3407
                if isinstance(target._real_repository._format,
 
3408
                              RepositoryFormatPack):
 
3409
                    if InterRepository._same_model(source, target):
 
3410
                        return True
 
3411
        return False
 
3412
    
 
3413
    def _autopack(self):
 
3414
        self.target.autopack()
 
3415
        
 
3416
    def _get_target_pack_collection(self):
 
3417
        return self.target._real_repository._pack_collection
 
3418
 
 
3419
    @classmethod
 
3420
    def _get_repo_format_to_test(self):
 
3421
        return None
 
3422
 
 
3423
 
 
3424
InterRepository.register_optimiser(InterDifferingSerializer)
 
3425
InterRepository.register_optimiser(InterSameDataRepository)
1780
3426
InterRepository.register_optimiser(InterWeaveRepo)
1781
3427
InterRepository.register_optimiser(InterKnitRepo)
1782
 
 
1783
 
 
1784
 
class RepositoryTestProviderAdapter(object):
1785
 
    """A tool to generate a suite testing multiple repository formats at once.
1786
 
 
1787
 
    This is done by copying the test once for each transport and injecting
1788
 
    the transport_server, transport_readonly_server, and bzrdir_format and
1789
 
    repository_format classes into each copy. Each copy is also given a new id()
1790
 
    to make it easy to identify.
1791
 
    """
1792
 
 
1793
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1794
 
        self._transport_server = transport_server
1795
 
        self._transport_readonly_server = transport_readonly_server
1796
 
        self._formats = formats
1797
 
    
1798
 
    def adapt(self, test):
1799
 
        result = TestSuite()
1800
 
        for repository_format, bzrdir_format in self._formats:
1801
 
            new_test = deepcopy(test)
1802
 
            new_test.transport_server = self._transport_server
1803
 
            new_test.transport_readonly_server = self._transport_readonly_server
1804
 
            new_test.bzrdir_format = bzrdir_format
1805
 
            new_test.repository_format = repository_format
1806
 
            def make_new_test_id():
1807
 
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
1808
 
                return lambda: new_id
1809
 
            new_test.id = make_new_test_id()
1810
 
            result.addTest(new_test)
1811
 
        return result
1812
 
 
1813
 
 
1814
 
class InterRepositoryTestProviderAdapter(object):
1815
 
    """A tool to generate a suite testing multiple inter repository formats.
1816
 
 
1817
 
    This is done by copying the test once for each interrepo provider and injecting
1818
 
    the transport_server, transport_readonly_server, repository_format and 
1819
 
    repository_to_format classes into each copy.
1820
 
    Each copy is also given a new id() to make it easy to identify.
1821
 
    """
1822
 
 
1823
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1824
 
        self._transport_server = transport_server
1825
 
        self._transport_readonly_server = transport_readonly_server
1826
 
        self._formats = formats
1827
 
    
1828
 
    def adapt(self, test):
1829
 
        result = TestSuite()
1830
 
        for interrepo_class, repository_format, repository_format_to in self._formats:
1831
 
            new_test = deepcopy(test)
1832
 
            new_test.transport_server = self._transport_server
1833
 
            new_test.transport_readonly_server = self._transport_readonly_server
1834
 
            new_test.interrepo_class = interrepo_class
1835
 
            new_test.repository_format = repository_format
1836
 
            new_test.repository_format_to = repository_format_to
1837
 
            def make_new_test_id():
1838
 
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
1839
 
                return lambda: new_id
1840
 
            new_test.id = make_new_test_id()
1841
 
            result.addTest(new_test)
1842
 
        return result
1843
 
 
1844
 
    @staticmethod
1845
 
    def default_test_list():
1846
 
        """Generate the default list of interrepo permutations to test."""
1847
 
        result = []
1848
 
        # test the default InterRepository between format 6 and the current 
1849
 
        # default format.
1850
 
        # XXX: robertc 20060220 reinstate this when there are two supported
1851
 
        # formats which do not have an optimal code path between them.
1852
 
        result.append((InterRepository,
1853
 
                       RepositoryFormat6(),
1854
 
                       RepositoryFormatKnit1()))
1855
 
        for optimiser in InterRepository._optimisers:
1856
 
            result.append((optimiser,
1857
 
                           optimiser._matching_repo_format,
1858
 
                           optimiser._matching_repo_format
1859
 
                           ))
1860
 
        # if there are specific combinations we want to use, we can add them 
1861
 
        # here.
1862
 
        return result
 
3428
InterRepository.register_optimiser(InterModel1and2)
 
3429
InterRepository.register_optimiser(InterKnit1and2)
 
3430
InterRepository.register_optimiser(InterPackRepo)
 
3431
InterRepository.register_optimiser(InterOtherToRemote)
 
3432
InterRepository.register_optimiser(InterRemoteToOther)
 
3433
InterRepository.register_optimiser(InterPackToRemotePack)
1863
3434
 
1864
3435
 
1865
3436
class CopyConverter(object):
1891
3462
        self.step('Moving repository to repository.backup')
1892
3463
        self.repo_dir.transport.move('repository', 'repository.backup')
1893
3464
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
3465
        repo._format.check_conversion_target(self.target_format)
1894
3466
        self.source_repo = repo._format.open(self.repo_dir,
1895
3467
            _found=True,
1896
3468
            _override_transport=backup_transport)
1913
3485
        self.pb.update(message, self.count, self.total)
1914
3486
 
1915
3487
 
1916
 
class CommitBuilder(object):
1917
 
    """Provides an interface to build up a commit.
1918
 
 
1919
 
    This allows describing a tree to be committed without needing to 
1920
 
    know the internals of the format of the repository.
1921
 
    """
1922
 
    def __init__(self, repository, parents, config, timestamp=None, 
1923
 
                 timezone=None, committer=None, revprops=None, 
1924
 
                 revision_id=None):
1925
 
        """Initiate a CommitBuilder.
1926
 
 
1927
 
        :param repository: Repository to commit to.
1928
 
        :param parents: Revision ids of the parents of the new revision.
1929
 
        :param config: Configuration to use.
1930
 
        :param timestamp: Optional timestamp recorded for commit.
1931
 
        :param timezone: Optional timezone for timestamp.
1932
 
        :param committer: Optional committer to set for commit.
1933
 
        :param revprops: Optional dictionary of revision properties.
1934
 
        :param revision_id: Optional revision id.
1935
 
        """
1936
 
        self._config = config
1937
 
 
1938
 
        if committer is None:
1939
 
            self._committer = self._config.username()
1940
 
        else:
1941
 
            assert isinstance(committer, basestring), type(committer)
1942
 
            self._committer = committer
1943
 
 
1944
 
        self.new_inventory = Inventory()
1945
 
        self._new_revision_id = revision_id
1946
 
        self.parents = parents
1947
 
        self.repository = repository
1948
 
 
1949
 
        self._revprops = {}
1950
 
        if revprops is not None:
1951
 
            self._revprops.update(revprops)
1952
 
 
1953
 
        if timestamp is None:
1954
 
            self._timestamp = time.time()
1955
 
        else:
1956
 
            self._timestamp = long(timestamp)
1957
 
 
1958
 
        if timezone is None:
1959
 
            self._timezone = local_time_offset()
1960
 
        else:
1961
 
            self._timezone = int(timezone)
1962
 
 
1963
 
        self._generate_revision_if_needed()
1964
 
 
1965
 
    def commit(self, message):
1966
 
        """Make the actual commit.
1967
 
 
1968
 
        :return: The revision id of the recorded revision.
1969
 
        """
1970
 
        rev = Revision(timestamp=self._timestamp,
1971
 
                       timezone=self._timezone,
1972
 
                       committer=self._committer,
1973
 
                       message=message,
1974
 
                       inventory_sha1=self.inv_sha1,
1975
 
                       revision_id=self._new_revision_id,
1976
 
                       properties=self._revprops)
1977
 
        rev.parent_ids = self.parents
1978
 
        self.repository.add_revision(self._new_revision_id, rev, 
1979
 
            self.new_inventory, self._config)
1980
 
        return self._new_revision_id
1981
 
 
1982
 
    def finish_inventory(self):
1983
 
        """Tell the builder that the inventory is finished."""
1984
 
        self.new_inventory.revision_id = self._new_revision_id
1985
 
        self.inv_sha1 = self.repository.add_inventory(
1986
 
            self._new_revision_id,
1987
 
            self.new_inventory,
1988
 
            self.parents
1989
 
            )
1990
 
 
1991
 
    def _gen_revision_id(self):
1992
 
        """Return new revision-id."""
1993
 
        s = '%s-%s-' % (self._config.user_email(), 
1994
 
                        compact_date(self._timestamp))
1995
 
        s += hexlify(rand_bytes(8))
1996
 
        return s
1997
 
 
1998
 
    def _generate_revision_if_needed(self):
1999
 
        """Create a revision id if None was supplied.
2000
 
        
2001
 
        If the repository can not support user-specified revision ids
2002
 
        they should override this function and raise UnsupportedOperation
2003
 
        if _new_revision_id is not None.
2004
 
 
2005
 
        :raises: UnsupportedOperation
2006
 
        """
2007
 
        if self._new_revision_id is None:
2008
 
            self._new_revision_id = self._gen_revision_id()
2009
 
 
2010
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2011
 
        """Record the content of ie from tree into the commit if needed.
2012
 
 
2013
 
        :param ie: An inventory entry present in the commit.
2014
 
        :param parent_invs: The inventories of the parent revisions of the
2015
 
            commit.
2016
 
        :param path: The path the entry is at in the tree.
2017
 
        :param tree: The tree which contains this entry and should be used to 
2018
 
        obtain content.
2019
 
        """
2020
 
        self.new_inventory.add(ie)
2021
 
 
2022
 
        # ie.revision is always None if the InventoryEntry is considered
2023
 
        # for committing. ie.snapshot will record the correct revision 
2024
 
        # which may be the sole parent if it is untouched.
2025
 
        if ie.revision is not None:
2026
 
            return
2027
 
        previous_entries = ie.find_previous_heads(
2028
 
            parent_invs,
2029
 
            self.repository.weave_store,
2030
 
            self.repository.get_transaction())
2031
 
        # we are creating a new revision for ie in the history store
2032
 
        # and inventory.
2033
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2034
 
 
2035
 
    def modified_directory(self, file_id, file_parents):
2036
 
        """Record the presence of a symbolic link.
2037
 
 
2038
 
        :param file_id: The file_id of the link to record.
2039
 
        :param file_parents: The per-file parent revision ids.
2040
 
        """
2041
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2042
 
    
2043
 
    def modified_file_text(self, file_id, file_parents,
2044
 
                           get_content_byte_lines, text_sha1=None,
2045
 
                           text_size=None):
2046
 
        """Record the text of file file_id
2047
 
 
2048
 
        :param file_id: The file_id of the file to record the text of.
2049
 
        :param file_parents: The per-file parent revision ids.
2050
 
        :param get_content_byte_lines: A callable which will return the byte
2051
 
            lines for the file.
2052
 
        :param text_sha1: Optional SHA1 of the file contents.
2053
 
        :param text_size: Optional size of the file contents.
2054
 
        """
2055
 
        mutter('storing text of file {%s} in revision {%s} into %r',
2056
 
               file_id, self._new_revision_id, self.repository.weave_store)
2057
 
        # special case to avoid diffing on renames or 
2058
 
        # reparenting
2059
 
        if (len(file_parents) == 1
2060
 
            and text_sha1 == file_parents.values()[0].text_sha1
2061
 
            and text_size == file_parents.values()[0].text_size):
2062
 
            previous_ie = file_parents.values()[0]
2063
 
            versionedfile = self.repository.weave_store.get_weave(file_id, 
2064
 
                self.repository.get_transaction())
2065
 
            versionedfile.clone_text(self._new_revision_id, 
2066
 
                previous_ie.revision, file_parents.keys())
2067
 
            return text_sha1, text_size
2068
 
        else:
2069
 
            new_lines = get_content_byte_lines()
2070
 
            # TODO: Rather than invoking sha_strings here, _add_text_to_weave
2071
 
            # should return the SHA1 and size
2072
 
            self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2073
 
            return bzrlib.osutils.sha_strings(new_lines), \
2074
 
                sum(map(len, new_lines))
2075
 
 
2076
 
    def modified_link(self, file_id, file_parents, link_target):
2077
 
        """Record the presence of a symbolic link.
2078
 
 
2079
 
        :param file_id: The file_id of the link to record.
2080
 
        :param file_parents: The per-file parent revision ids.
2081
 
        :param link_target: Target location of this link.
2082
 
        """
2083
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2084
 
 
2085
 
    def _add_text_to_weave(self, file_id, new_lines, parents):
2086
 
        versionedfile = self.repository.weave_store.get_weave_or_empty(
2087
 
            file_id, self.repository.get_transaction())
2088
 
        versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2089
 
        versionedfile.clear_cache()
2090
 
 
2091
 
 
2092
 
# Copied from xml.sax.saxutils
 
3488
_unescape_map = {
 
3489
    'apos':"'",
 
3490
    'quot':'"',
 
3491
    'amp':'&',
 
3492
    'lt':'<',
 
3493
    'gt':'>'
 
3494
}
 
3495
 
 
3496
 
 
3497
def _unescaper(match, _map=_unescape_map):
 
3498
    code = match.group(1)
 
3499
    try:
 
3500
        return _map[code]
 
3501
    except KeyError:
 
3502
        if not code.startswith('#'):
 
3503
            raise
 
3504
        return unichr(int(code[1:])).encode('utf8')
 
3505
 
 
3506
 
 
3507
_unescape_re = None
 
3508
 
 
3509
 
2093
3510
def _unescape_xml(data):
2094
 
    """Unescape &amp;, &lt;, and &gt; in a string of data.
2095
 
    """
2096
 
    data = data.replace("&lt;", "<")
2097
 
    data = data.replace("&gt;", ">")
2098
 
    # must do ampersand last
2099
 
    return data.replace("&amp;", "&")
 
3511
    """Unescape predefined XML entities in a string of data."""
 
3512
    global _unescape_re
 
3513
    if _unescape_re is None:
 
3514
        _unescape_re = re.compile('\&([^;]*);')
 
3515
    return _unescape_re.sub(_unescaper, data)
 
3516
 
 
3517
 
 
3518
class _VersionedFileChecker(object):
 
3519
 
 
3520
    def __init__(self, repository):
 
3521
        self.repository = repository
 
3522
        self.text_index = self.repository._generate_text_key_index()
 
3523
    
 
3524
    def calculate_file_version_parents(self, text_key):
 
3525
        """Calculate the correct parents for a file version according to
 
3526
        the inventories.
 
3527
        """
 
3528
        parent_keys = self.text_index[text_key]
 
3529
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3530
            return ()
 
3531
        return tuple(parent_keys)
 
3532
 
 
3533
    def check_file_version_parents(self, texts, progress_bar=None):
 
3534
        """Check the parents stored in a versioned file are correct.
 
3535
 
 
3536
        It also detects file versions that are not referenced by their
 
3537
        corresponding revision's inventory.
 
3538
 
 
3539
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3540
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3541
            correct_parents)} for each revision_id where the stored parents
 
3542
            are not correct.  dangling_file_versions is a set of (file_id,
 
3543
            revision_id) tuples for versions that are present in this versioned
 
3544
            file, but not used by the corresponding inventory.
 
3545
        """
 
3546
        wrong_parents = {}
 
3547
        self.file_ids = set([file_id for file_id, _ in
 
3548
            self.text_index.iterkeys()])
 
3549
        # text keys is now grouped by file_id
 
3550
        n_weaves = len(self.file_ids)
 
3551
        files_in_revisions = {}
 
3552
        revisions_of_files = {}
 
3553
        n_versions = len(self.text_index)
 
3554
        progress_bar.update('loading text store', 0, n_versions)
 
3555
        parent_map = self.repository.texts.get_parent_map(self.text_index)
 
3556
        # On unlistable transports this could well be empty/error...
 
3557
        text_keys = self.repository.texts.keys()
 
3558
        unused_keys = frozenset(text_keys) - set(self.text_index)
 
3559
        for num, key in enumerate(self.text_index.iterkeys()):
 
3560
            if progress_bar is not None:
 
3561
                progress_bar.update('checking text graph', num, n_versions)
 
3562
            correct_parents = self.calculate_file_version_parents(key)
 
3563
            try:
 
3564
                knit_parents = parent_map[key]
 
3565
            except errors.RevisionNotPresent:
 
3566
                # Missing text!
 
3567
                knit_parents = None
 
3568
            if correct_parents != knit_parents:
 
3569
                wrong_parents[key] = (knit_parents, correct_parents)
 
3570
        return wrong_parents, unused_keys
 
3571
 
 
3572
 
 
3573
def _old_get_graph(repository, revision_id):
 
3574
    """DO NOT USE. That is all. I'm serious."""
 
3575
    graph = repository.get_graph()
 
3576
    revision_graph = dict(((key, value) for key, value in
 
3577
        graph.iter_ancestry([revision_id]) if value is not None))
 
3578
    return _strip_NULL_ghosts(revision_graph)
 
3579
 
 
3580
 
 
3581
def _strip_NULL_ghosts(revision_graph):
 
3582
    """Also don't use this. more compatibility code for unmigrated clients."""
 
3583
    # Filter ghosts, and null:
 
3584
    if _mod_revision.NULL_REVISION in revision_graph:
 
3585
        del revision_graph[_mod_revision.NULL_REVISION]
 
3586
    for key, parents in revision_graph.items():
 
3587
        revision_graph[key] = tuple(parent for parent in parents if parent
 
3588
            in revision_graph)
 
3589
    return revision_graph