← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2006-07-10 15:15:40 UTC
  • mto: This revision was merged to the branch mainline in revision 1850.
  • Revision ID: john@arbash-meinel.com-20060710151540-81ad659edf6391c0
Removed duplicated highres date code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from bzrlib.lazy_import import lazy_import
18
 
lazy_import(globals(), """
19
 
import cStringIO
 
17
from binascii import hexlify
 
18
from copy import deepcopy
 
19
from cStringIO import StringIO
20
20
import re
21
21
import time
 
22
from unittest import TestSuite
22
23
 
23
 
from bzrlib import (
24
 
    bzrdir,
25
 
    check,
26
 
    chk_map,
27
 
    config,
28
 
    debug,
29
 
    errors,
30
 
    fetch as _mod_fetch,
31
 
    fifo_cache,
32
 
    generate_ids,
33
 
    gpg,
34
 
    graph,
35
 
    inventory,
36
 
    inventory_delta,
37
 
    lazy_regex,
38
 
    lockable_files,
39
 
    lockdir,
40
 
    lru_cache,
41
 
    osutils,
42
 
    revision as _mod_revision,
43
 
    static_tuple,
44
 
    symbol_versioning,
45
 
    trace,
46
 
    tsort,
47
 
    ui,
48
 
    versionedfile,
49
 
    )
50
 
from bzrlib.bundle import serializer
51
 
from bzrlib.revisiontree import RevisionTree
52
 
from bzrlib.store.versioned import VersionedFileStore
 
24
from bzrlib import bzrdir, check, delta, gpg, errors, xml5, ui, transactions, osutils
 
25
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
26
from bzrlib.errors import InvalidRevisionId
 
27
from bzrlib.graph import Graph
 
28
from bzrlib.inter import InterObject
 
29
from bzrlib.inventory import Inventory
 
30
from bzrlib.knit import KnitVersionedFile, KnitPlainFactory
 
31
from bzrlib.lockable_files import LockableFiles, TransportLock
 
32
from bzrlib.lockdir import LockDir
 
33
from bzrlib.osutils import (safe_unicode, rand_bytes, compact_date, 
 
34
                            local_time_offset)
 
35
from bzrlib.revision import NULL_REVISION, Revision
 
36
from bzrlib.store.versioned import VersionedFileStore, WeaveStore
 
37
from bzrlib.store.text import TextStore
 
38
from bzrlib.symbol_versioning import (deprecated_method,
 
39
        zero_nine, 
 
40
        )
 
41
from bzrlib.trace import mutter, note
 
42
from bzrlib.tree import RevisionTree, EmptyTree
 
43
from bzrlib.tsort import topo_sort
53
44
from bzrlib.testament import Testament
54
 
""")
55
 
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
57
 
from bzrlib.inter import InterObject
58
 
from bzrlib.inventory import (
59
 
    Inventory,
60
 
    InventoryDirectory,
61
 
    ROOT_ID,
62
 
    entry_factory,
63
 
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
 
from bzrlib import registry
66
 
from bzrlib.trace import (
67
 
    log_exception_quietly, note, mutter, mutter_callsite, warning)
68
 
 
69
 
 
70
 
# Old formats display a warning, but only once
71
 
_deprecation_warning_done = False
72
 
 
73
 
 
74
 
class CommitBuilder(object):
75
 
    """Provides an interface to build up a commit.
76
 
 
77
 
    This allows describing a tree to be committed without needing to
78
 
    know the internals of the format of the repository.
79
 
    """
80
 
 
81
 
    # all clients should supply tree roots.
82
 
    record_root_entry = True
83
 
    # the default CommitBuilder does not manage trees whose root is versioned.
84
 
    _versioned_root = False
85
 
 
86
 
    def __init__(self, repository, parents, config, timestamp=None,
87
 
                 timezone=None, committer=None, revprops=None,
88
 
                 revision_id=None):
89
 
        """Initiate a CommitBuilder.
90
 
 
91
 
        :param repository: Repository to commit to.
92
 
        :param parents: Revision ids of the parents of the new revision.
93
 
        :param config: Configuration to use.
94
 
        :param timestamp: Optional timestamp recorded for commit.
95
 
        :param timezone: Optional timezone for timestamp.
96
 
        :param committer: Optional committer to set for commit.
97
 
        :param revprops: Optional dictionary of revision properties.
98
 
        :param revision_id: Optional revision id.
99
 
        """
100
 
        self._config = config
101
 
 
102
 
        if committer is None:
103
 
            self._committer = self._config.username()
104
 
        else:
105
 
            self._committer = committer
106
 
 
107
 
        self.new_inventory = Inventory(None)
108
 
        self._new_revision_id = revision_id
109
 
        self.parents = parents
110
 
        self.repository = repository
111
 
 
112
 
        self._revprops = {}
113
 
        if revprops is not None:
114
 
            self._validate_revprops(revprops)
115
 
            self._revprops.update(revprops)
116
 
 
117
 
        if timestamp is None:
118
 
            timestamp = time.time()
119
 
        # Restrict resolution to 1ms
120
 
        self._timestamp = round(timestamp, 3)
121
 
 
122
 
        if timezone is None:
123
 
            self._timezone = osutils.local_time_offset()
124
 
        else:
125
 
            self._timezone = int(timezone)
126
 
 
127
 
        self._generate_revision_if_needed()
128
 
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
129
 
        self._basis_delta = []
130
 
        # API compatibility, older code that used CommitBuilder did not call
131
 
        # .record_delete(), which means the delta that is computed would not be
132
 
        # valid. Callers that will call record_delete() should call
133
 
        # .will_record_deletes() to indicate that.
134
 
        self._recording_deletes = False
135
 
        # memo'd check for no-op commits.
136
 
        self._any_changes = False
137
 
 
138
 
    def any_changes(self):
139
 
        """Return True if any entries were changed.
140
 
        
141
 
        This includes merge-only changes. It is the core for the --unchanged
142
 
        detection in commit.
143
 
 
144
 
        :return: True if any changes have occured.
145
 
        """
146
 
        return self._any_changes
147
 
 
148
 
    def _validate_unicode_text(self, text, context):
149
 
        """Verify things like commit messages don't have bogus characters."""
150
 
        if '\r' in text:
151
 
            raise ValueError('Invalid value for %s: %r' % (context, text))
152
 
 
153
 
    def _validate_revprops(self, revprops):
154
 
        for key, value in revprops.iteritems():
155
 
            # We know that the XML serializers do not round trip '\r'
156
 
            # correctly, so refuse to accept them
157
 
            if not isinstance(value, basestring):
158
 
                raise ValueError('revision property (%s) is not a valid'
159
 
                                 ' (unicode) string: %r' % (key, value))
160
 
            self._validate_unicode_text(value,
161
 
                                        'revision property (%s)' % (key,))
162
 
 
163
 
    def commit(self, message):
164
 
        """Make the actual commit.
165
 
 
166
 
        :return: The revision id of the recorded revision.
167
 
        """
168
 
        self._validate_unicode_text(message, 'commit message')
169
 
        rev = _mod_revision.Revision(
170
 
                       timestamp=self._timestamp,
171
 
                       timezone=self._timezone,
172
 
                       committer=self._committer,
173
 
                       message=message,
174
 
                       inventory_sha1=self.inv_sha1,
175
 
                       revision_id=self._new_revision_id,
176
 
                       properties=self._revprops)
177
 
        rev.parent_ids = self.parents
178
 
        self.repository.add_revision(self._new_revision_id, rev,
179
 
            self.new_inventory, self._config)
180
 
        self.repository.commit_write_group()
181
 
        return self._new_revision_id
182
 
 
183
 
    def abort(self):
184
 
        """Abort the commit that is being built.
185
 
        """
186
 
        self.repository.abort_write_group()
187
 
 
188
 
    def revision_tree(self):
189
 
        """Return the tree that was just committed.
190
 
 
191
 
        After calling commit() this can be called to get a RevisionTree
192
 
        representing the newly committed tree. This is preferred to
193
 
        calling Repository.revision_tree() because that may require
194
 
        deserializing the inventory, while we already have a copy in
195
 
        memory.
196
 
        """
197
 
        if self.new_inventory is None:
198
 
            self.new_inventory = self.repository.get_inventory(
199
 
                self._new_revision_id)
200
 
        return RevisionTree(self.repository, self.new_inventory,
201
 
            self._new_revision_id)
202
 
 
203
 
    def finish_inventory(self):
204
 
        """Tell the builder that the inventory is finished.
205
 
 
206
 
        :return: The inventory id in the repository, which can be used with
207
 
            repository.get_inventory.
208
 
        """
209
 
        if self.new_inventory is None:
210
 
            # an inventory delta was accumulated without creating a new
211
 
            # inventory.
212
 
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
217
 
                basis_id, self._basis_delta, self._new_revision_id,
218
 
                self.parents)
219
 
        else:
220
 
            if self.new_inventory.root is None:
221
 
                raise AssertionError('Root entry should be supplied to'
222
 
                    ' record_entry_contents, as of bzr 0.10.')
223
 
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
224
 
            self.new_inventory.revision_id = self._new_revision_id
225
 
            self.inv_sha1 = self.repository.add_inventory(
226
 
                self._new_revision_id,
227
 
                self.new_inventory,
228
 
                self.parents
229
 
                )
230
 
        return self._new_revision_id
231
 
 
232
 
    def _gen_revision_id(self):
233
 
        """Return new revision-id."""
234
 
        return generate_ids.gen_revision_id(self._config.username(),
235
 
                                            self._timestamp)
236
 
 
237
 
    def _generate_revision_if_needed(self):
238
 
        """Create a revision id if None was supplied.
239
 
 
240
 
        If the repository can not support user-specified revision ids
241
 
        they should override this function and raise CannotSetRevisionId
242
 
        if _new_revision_id is not None.
243
 
 
244
 
        :raises: CannotSetRevisionId
245
 
        """
246
 
        if self._new_revision_id is None:
247
 
            self._new_revision_id = self._gen_revision_id()
248
 
            self.random_revid = True
249
 
        else:
250
 
            self.random_revid = False
251
 
 
252
 
    def _heads(self, file_id, revision_ids):
253
 
        """Calculate the graph heads for revision_ids in the graph of file_id.
254
 
 
255
 
        This can use either a per-file graph or a global revision graph as we
256
 
        have an identity relationship between the two graphs.
257
 
        """
258
 
        return self.__heads(revision_ids)
259
 
 
260
 
    def _check_root(self, ie, parent_invs, tree):
261
 
        """Helper for record_entry_contents.
262
 
 
263
 
        :param ie: An entry being added.
264
 
        :param parent_invs: The inventories of the parent revisions of the
265
 
            commit.
266
 
        :param tree: The tree that is being committed.
267
 
        """
268
 
        # In this revision format, root entries have no knit or weave When
269
 
        # serializing out to disk and back in root.revision is always
270
 
        # _new_revision_id
271
 
        ie.revision = self._new_revision_id
272
 
 
273
 
    def _require_root_change(self, tree):
274
 
        """Enforce an appropriate root object change.
275
 
 
276
 
        This is called once when record_iter_changes is called, if and only if
277
 
        the root was not in the delta calculated by record_iter_changes.
278
 
 
279
 
        :param tree: The tree which is being committed.
280
 
        """
281
 
        # NB: if there are no parents then this method is not called, so no
282
 
        # need to guard on parents having length.
283
 
        entry = entry_factory['directory'](tree.path2id(''), '',
284
 
            None)
285
 
        entry.revision = self._new_revision_id
286
 
        self._basis_delta.append(('', '', entry.file_id, entry))
287
 
 
288
 
    def _get_delta(self, ie, basis_inv, path):
289
 
        """Get a delta against the basis inventory for ie."""
290
 
        if ie.file_id not in basis_inv:
291
 
            # add
292
 
            result = (None, path, ie.file_id, ie)
293
 
            self._basis_delta.append(result)
294
 
            return result
295
 
        elif ie != basis_inv[ie.file_id]:
296
 
            # common but altered
297
 
            # TODO: avoid tis id2path call.
298
 
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
299
 
            self._basis_delta.append(result)
300
 
            return result
301
 
        else:
302
 
            # common, unaltered
303
 
            return None
304
 
 
305
 
    def get_basis_delta(self):
306
 
        """Return the complete inventory delta versus the basis inventory.
307
 
 
308
 
        This has been built up with the calls to record_delete and
309
 
        record_entry_contents. The client must have already called
310
 
        will_record_deletes() to indicate that they will be generating a
311
 
        complete delta.
312
 
 
313
 
        :return: An inventory delta, suitable for use with apply_delta, or
314
 
            Repository.add_inventory_by_delta, etc.
315
 
        """
316
 
        if not self._recording_deletes:
317
 
            raise AssertionError("recording deletes not activated.")
318
 
        return self._basis_delta
319
 
 
320
 
    def record_delete(self, path, file_id):
321
 
        """Record that a delete occured against a basis tree.
322
 
 
323
 
        This is an optional API - when used it adds items to the basis_delta
324
 
        being accumulated by the commit builder. It cannot be called unless the
325
 
        method will_record_deletes() has been called to inform the builder that
326
 
        a delta is being supplied.
327
 
 
328
 
        :param path: The path of the thing deleted.
329
 
        :param file_id: The file id that was deleted.
330
 
        """
331
 
        if not self._recording_deletes:
332
 
            raise AssertionError("recording deletes not activated.")
333
 
        delta = (path, None, file_id, None)
334
 
        self._basis_delta.append(delta)
335
 
        self._any_changes = True
336
 
        return delta
337
 
 
338
 
    def will_record_deletes(self):
339
 
        """Tell the commit builder that deletes are being notified.
340
 
 
341
 
        This enables the accumulation of an inventory delta; for the resulting
342
 
        commit to be valid, deletes against the basis MUST be recorded via
343
 
        builder.record_delete().
344
 
        """
345
 
        self._recording_deletes = True
346
 
        try:
347
 
            basis_id = self.parents[0]
348
 
        except IndexError:
349
 
            basis_id = _mod_revision.NULL_REVISION
350
 
        self.basis_delta_revision = basis_id
351
 
 
352
 
    def record_entry_contents(self, ie, parent_invs, path, tree,
353
 
        content_summary):
354
 
        """Record the content of ie from tree into the commit if needed.
355
 
 
356
 
        Side effect: sets ie.revision when unchanged
357
 
 
358
 
        :param ie: An inventory entry present in the commit.
359
 
        :param parent_invs: The inventories of the parent revisions of the
360
 
            commit.
361
 
        :param path: The path the entry is at in the tree.
362
 
        :param tree: The tree which contains this entry and should be used to
363
 
            obtain content.
364
 
        :param content_summary: Summary data from the tree about the paths
365
 
            content - stat, length, exec, sha/link target. This is only
366
 
            accessed when the entry has a revision of None - that is when it is
367
 
            a candidate to commit.
368
 
        :return: A tuple (change_delta, version_recorded, fs_hash).
369
 
            change_delta is an inventory_delta change for this entry against
370
 
            the basis tree of the commit, or None if no change occured against
371
 
            the basis tree.
372
 
            version_recorded is True if a new version of the entry has been
373
 
            recorded. For instance, committing a merge where a file was only
374
 
            changed on the other side will return (delta, False).
375
 
            fs_hash is either None, or the hash details for the path (currently
376
 
            a tuple of the contents sha1 and the statvalue returned by
377
 
            tree.get_file_with_stat()).
378
 
        """
379
 
        if self.new_inventory.root is None:
380
 
            if ie.parent_id is not None:
381
 
                raise errors.RootMissing()
382
 
            self._check_root(ie, parent_invs, tree)
383
 
        if ie.revision is None:
384
 
            kind = content_summary[0]
385
 
        else:
386
 
            # ie is carried over from a prior commit
387
 
            kind = ie.kind
388
 
        # XXX: repository specific check for nested tree support goes here - if
389
 
        # the repo doesn't want nested trees we skip it ?
390
 
        if (kind == 'tree-reference' and
391
 
            not self.repository._format.supports_tree_reference):
392
 
            # mismatch between commit builder logic and repository:
393
 
            # this needs the entry creation pushed down into the builder.
394
 
            raise NotImplementedError('Missing repository subtree support.')
395
 
        self.new_inventory.add(ie)
396
 
 
397
 
        # TODO: slow, take it out of the inner loop.
398
 
        try:
399
 
            basis_inv = parent_invs[0]
400
 
        except IndexError:
401
 
            basis_inv = Inventory(root_id=None)
402
 
 
403
 
        # ie.revision is always None if the InventoryEntry is considered
404
 
        # for committing. We may record the previous parents revision if the
405
 
        # content is actually unchanged against a sole head.
406
 
        if ie.revision is not None:
407
 
            if not self._versioned_root and path == '':
408
 
                # repositories that do not version the root set the root's
409
 
                # revision to the new commit even when no change occurs (more
410
 
                # specifically, they do not record a revision on the root; and
411
 
                # the rev id is assigned to the root during deserialisation -
412
 
                # this masks when a change may have occurred against the basis.
413
 
                # To match this we always issue a delta, because the revision
414
 
                # of the root will always be changing.
415
 
                if ie.file_id in basis_inv:
416
 
                    delta = (basis_inv.id2path(ie.file_id), path,
417
 
                        ie.file_id, ie)
418
 
                else:
419
 
                    # add
420
 
                    delta = (None, path, ie.file_id, ie)
421
 
                self._basis_delta.append(delta)
422
 
                return delta, False, None
423
 
            else:
424
 
                # we don't need to commit this, because the caller already
425
 
                # determined that an existing revision of this file is
426
 
                # appropriate. If its not being considered for committing then
427
 
                # it and all its parents to the root must be unaltered so
428
 
                # no-change against the basis.
429
 
                if ie.revision == self._new_revision_id:
430
 
                    raise AssertionError("Impossible situation, a skipped "
431
 
                        "inventory entry (%r) claims to be modified in this "
432
 
                        "commit (%r).", (ie, self._new_revision_id))
433
 
                return None, False, None
434
 
        # XXX: Friction: parent_candidates should return a list not a dict
435
 
        #      so that we don't have to walk the inventories again.
436
 
        parent_candiate_entries = ie.parent_candidates(parent_invs)
437
 
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
438
 
        heads = []
439
 
        for inv in parent_invs:
440
 
            if ie.file_id in inv:
441
 
                old_rev = inv[ie.file_id].revision
442
 
                if old_rev in head_set:
443
 
                    heads.append(inv[ie.file_id].revision)
444
 
                    head_set.remove(inv[ie.file_id].revision)
445
 
 
446
 
        store = False
447
 
        # now we check to see if we need to write a new record to the
448
 
        # file-graph.
449
 
        # We write a new entry unless there is one head to the ancestors, and
450
 
        # the kind-derived content is unchanged.
451
 
 
452
 
        # Cheapest check first: no ancestors, or more the one head in the
453
 
        # ancestors, we write a new node.
454
 
        if len(heads) != 1:
455
 
            store = True
456
 
        if not store:
457
 
            # There is a single head, look it up for comparison
458
 
            parent_entry = parent_candiate_entries[heads[0]]
459
 
            # if the non-content specific data has changed, we'll be writing a
460
 
            # node:
461
 
            if (parent_entry.parent_id != ie.parent_id or
462
 
                parent_entry.name != ie.name):
463
 
                store = True
464
 
        # now we need to do content specific checks:
465
 
        if not store:
466
 
            # if the kind changed the content obviously has
467
 
            if kind != parent_entry.kind:
468
 
                store = True
469
 
        # Stat cache fingerprint feedback for the caller - None as we usually
470
 
        # don't generate one.
471
 
        fingerprint = None
472
 
        if kind == 'file':
473
 
            if content_summary[2] is None:
474
 
                raise ValueError("Files must not have executable = None")
475
 
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
479
 
                    parent_entry.executable != content_summary[2]):
480
 
                    store = True
481
 
                elif parent_entry.text_sha1 == content_summary[3]:
482
 
                    # all meta and content is unchanged (using a hash cache
483
 
                    # hit to check the sha)
484
 
                    ie.revision = parent_entry.revision
485
 
                    ie.text_size = parent_entry.text_size
486
 
                    ie.text_sha1 = parent_entry.text_sha1
487
 
                    ie.executable = parent_entry.executable
488
 
                    return self._get_delta(ie, basis_inv, path), False, None
489
 
                else:
490
 
                    # Either there is only a hash change(no hash cache entry,
491
 
                    # or same size content change), or there is no change on
492
 
                    # this file at all.
493
 
                    # Provide the parent's hash to the store layer, so that the
494
 
                    # content is unchanged we will not store a new node.
495
 
                    nostore_sha = parent_entry.text_sha1
496
 
            if store:
497
 
                # We want to record a new node regardless of the presence or
498
 
                # absence of a content change in the file.
499
 
                nostore_sha = None
500
 
            ie.executable = content_summary[2]
501
 
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
502
 
            try:
503
 
                text = file_obj.read()
504
 
            finally:
505
 
                file_obj.close()
506
 
            try:
507
 
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
508
 
                    ie.file_id, text, heads, nostore_sha)
509
 
                # Let the caller know we generated a stat fingerprint.
510
 
                fingerprint = (ie.text_sha1, stat_value)
511
 
            except errors.ExistingContent:
512
 
                # Turns out that the file content was unchanged, and we were
513
 
                # only going to store a new node if it was changed. Carry over
514
 
                # the entry.
515
 
                ie.revision = parent_entry.revision
516
 
                ie.text_size = parent_entry.text_size
517
 
                ie.text_sha1 = parent_entry.text_sha1
518
 
                ie.executable = parent_entry.executable
519
 
                return self._get_delta(ie, basis_inv, path), False, None
520
 
        elif kind == 'directory':
521
 
            if not store:
522
 
                # all data is meta here, nothing specific to directory, so
523
 
                # carry over:
524
 
                ie.revision = parent_entry.revision
525
 
                return self._get_delta(ie, basis_inv, path), False, None
526
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
527
 
        elif kind == 'symlink':
528
 
            current_link_target = content_summary[3]
529
 
            if not store:
530
 
                # symlink target is not generic metadata, check if it has
531
 
                # changed.
532
 
                if current_link_target != parent_entry.symlink_target:
533
 
                    store = True
534
 
            if not store:
535
 
                # unchanged, carry over.
536
 
                ie.revision = parent_entry.revision
537
 
                ie.symlink_target = parent_entry.symlink_target
538
 
                return self._get_delta(ie, basis_inv, path), False, None
539
 
            ie.symlink_target = current_link_target
540
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
541
 
        elif kind == 'tree-reference':
542
 
            if not store:
543
 
                if content_summary[3] != parent_entry.reference_revision:
544
 
                    store = True
545
 
            if not store:
546
 
                # unchanged, carry over.
547
 
                ie.reference_revision = parent_entry.reference_revision
548
 
                ie.revision = parent_entry.revision
549
 
                return self._get_delta(ie, basis_inv, path), False, None
550
 
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
555
 
        else:
556
 
            raise NotImplementedError('unknown kind')
557
 
        ie.revision = self._new_revision_id
558
 
        self._any_changes = True
559
 
        return self._get_delta(ie, basis_inv, path), True, fingerprint
560
 
 
561
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
562
 
        _entry_factory=entry_factory):
563
 
        """Record a new tree via iter_changes.
564
 
 
565
 
        :param tree: The tree to obtain text contents from for changed objects.
566
 
        :param basis_revision_id: The revision id of the tree the iter_changes
567
 
            has been generated against. Currently assumed to be the same
568
 
            as self.parents[0] - if it is not, errors may occur.
569
 
        :param iter_changes: An iter_changes iterator with the changes to apply
570
 
            to basis_revision_id. The iterator must not include any items with
571
 
            a current kind of None - missing items must be either filtered out
572
 
            or errored-on beefore record_iter_changes sees the item.
573
 
        :param _entry_factory: Private method to bind entry_factory locally for
574
 
            performance.
575
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
576
 
            tree._observed_sha1.
577
 
        """
578
 
        # Create an inventory delta based on deltas between all the parents and
579
 
        # deltas between all the parent inventories. We use inventory delta's 
580
 
        # between the inventory objects because iter_changes masks
581
 
        # last-changed-field only changes.
582
 
        # Working data:
583
 
        # file_id -> change map, change is fileid, paths, changed, versioneds,
584
 
        # parents, names, kinds, executables
585
 
        merged_ids = {}
586
 
        # {file_id -> revision_id -> inventory entry, for entries in parent
587
 
        # trees that are not parents[0]
588
 
        parent_entries = {}
589
 
        ghost_basis = False
590
 
        try:
591
 
            revtrees = list(self.repository.revision_trees(self.parents))
592
 
        except errors.NoSuchRevision:
593
 
            # one or more ghosts, slow path.
594
 
            revtrees = []
595
 
            for revision_id in self.parents:
596
 
                try:
597
 
                    revtrees.append(self.repository.revision_tree(revision_id))
598
 
                except errors.NoSuchRevision:
599
 
                    if not revtrees:
600
 
                        basis_revision_id = _mod_revision.NULL_REVISION
601
 
                        ghost_basis = True
602
 
                    revtrees.append(self.repository.revision_tree(
603
 
                        _mod_revision.NULL_REVISION))
604
 
        # The basis inventory from a repository 
605
 
        if revtrees:
606
 
            basis_inv = revtrees[0].inventory
607
 
        else:
608
 
            basis_inv = self.repository.revision_tree(
609
 
                _mod_revision.NULL_REVISION).inventory
610
 
        if len(self.parents) > 0:
611
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
612
 
                raise Exception(
613
 
                    "arbitrary basis parents not yet supported with merges")
614
 
            for revtree in revtrees[1:]:
615
 
                for change in revtree.inventory._make_delta(basis_inv):
616
 
                    if change[1] is None:
617
 
                        # Not present in this parent.
618
 
                        continue
619
 
                    if change[2] not in merged_ids:
620
 
                        if change[0] is not None:
621
 
                            basis_entry = basis_inv[change[2]]
622
 
                            merged_ids[change[2]] = [
623
 
                                # basis revid
624
 
                                basis_entry.revision,
625
 
                                # new tree revid
626
 
                                change[3].revision]
627
 
                            parent_entries[change[2]] = {
628
 
                                # basis parent
629
 
                                basis_entry.revision:basis_entry,
630
 
                                # this parent 
631
 
                                change[3].revision:change[3],
632
 
                                }
633
 
                        else:
634
 
                            merged_ids[change[2]] = [change[3].revision]
635
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
636
 
                    else:
637
 
                        merged_ids[change[2]].append(change[3].revision)
638
 
                        parent_entries[change[2]][change[3].revision] = change[3]
639
 
        else:
640
 
            merged_ids = {}
641
 
        # Setup the changes from the tree:
642
 
        # changes maps file_id -> (change, [parent revision_ids])
643
 
        changes= {}
644
 
        for change in iter_changes:
645
 
            # This probably looks up in basis_inv way to much.
646
 
            if change[1][0] is not None:
647
 
                head_candidate = [basis_inv[change[0]].revision]
648
 
            else:
649
 
                head_candidate = []
650
 
            changes[change[0]] = change, merged_ids.get(change[0],
651
 
                head_candidate)
652
 
        unchanged_merged = set(merged_ids) - set(changes)
653
 
        # Extend the changes dict with synthetic changes to record merges of
654
 
        # texts.
655
 
        for file_id in unchanged_merged:
656
 
            # Record a merged version of these items that did not change vs the
657
 
            # basis. This can be either identical parallel changes, or a revert
658
 
            # of a specific file after a merge. The recorded content will be
659
 
            # that of the current tree (which is the same as the basis), but
660
 
            # the per-file graph will reflect a merge.
661
 
            # NB:XXX: We are reconstructing path information we had, this
662
 
            # should be preserved instead.
663
 
            # inv delta  change: (file_id, (path_in_source, path_in_target),
664
 
            #   changed_content, versioned, parent, name, kind,
665
 
            #   executable)
666
 
            try:
667
 
                basis_entry = basis_inv[file_id]
668
 
            except errors.NoSuchId:
669
 
                # a change from basis->some_parents but file_id isn't in basis
670
 
                # so was new in the merge, which means it must have changed
671
 
                # from basis -> current, and as it hasn't the add was reverted
672
 
                # by the user. So we discard this change.
673
 
                pass
674
 
            else:
675
 
                change = (file_id,
676
 
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
677
 
                    False, (True, True),
678
 
                    (basis_entry.parent_id, basis_entry.parent_id),
679
 
                    (basis_entry.name, basis_entry.name),
680
 
                    (basis_entry.kind, basis_entry.kind),
681
 
                    (basis_entry.executable, basis_entry.executable))
682
 
                changes[file_id] = (change, merged_ids[file_id])
683
 
        # changes contains tuples with the change and a set of inventory
684
 
        # candidates for the file.
685
 
        # inv delta is:
686
 
        # old_path, new_path, file_id, new_inventory_entry
687
 
        seen_root = False # Is the root in the basis delta?
688
 
        inv_delta = self._basis_delta
689
 
        modified_rev = self._new_revision_id
690
 
        for change, head_candidates in changes.values():
691
 
            if change[3][1]: # versioned in target.
692
 
                # Several things may be happening here:
693
 
                # We may have a fork in the per-file graph
694
 
                #  - record a change with the content from tree
695
 
                # We may have a change against < all trees  
696
 
                #  - carry over the tree that hasn't changed
697
 
                # We may have a change against all trees
698
 
                #  - record the change with the content from tree
699
 
                kind = change[6][1]
700
 
                file_id = change[0]
701
 
                entry = _entry_factory[kind](file_id, change[5][1],
702
 
                    change[4][1])
703
 
                head_set = self._heads(change[0], set(head_candidates))
704
 
                heads = []
705
 
                # Preserve ordering.
706
 
                for head_candidate in head_candidates:
707
 
                    if head_candidate in head_set:
708
 
                        heads.append(head_candidate)
709
 
                        head_set.remove(head_candidate)
710
 
                carried_over = False
711
 
                if len(heads) == 1:
712
 
                    # Could be a carry-over situation:
713
 
                    parent_entry_revs = parent_entries.get(file_id, None)
714
 
                    if parent_entry_revs:
715
 
                        parent_entry = parent_entry_revs.get(heads[0], None)
716
 
                    else:
717
 
                        parent_entry = None
718
 
                    if parent_entry is None:
719
 
                        # The parent iter_changes was called against is the one
720
 
                        # that is the per-file head, so any change is relevant
721
 
                        # iter_changes is valid.
722
 
                        carry_over_possible = False
723
 
                    else:
724
 
                        # could be a carry over situation
725
 
                        # A change against the basis may just indicate a merge,
726
 
                        # we need to check the content against the source of the
727
 
                        # merge to determine if it was changed after the merge
728
 
                        # or carried over.
729
 
                        if (parent_entry.kind != entry.kind or
730
 
                            parent_entry.parent_id != entry.parent_id or
731
 
                            parent_entry.name != entry.name):
732
 
                            # Metadata common to all entries has changed
733
 
                            # against per-file parent
734
 
                            carry_over_possible = False
735
 
                        else:
736
 
                            carry_over_possible = True
737
 
                        # per-type checks for changes against the parent_entry
738
 
                        # are done below.
739
 
                else:
740
 
                    # Cannot be a carry-over situation
741
 
                    carry_over_possible = False
742
 
                # Populate the entry in the delta
743
 
                if kind == 'file':
744
 
                    # XXX: There is still a small race here: If someone reverts the content of a file
745
 
                    # after iter_changes examines and decides it has changed,
746
 
                    # we will unconditionally record a new version even if some
747
 
                    # other process reverts it while commit is running (with
748
 
                    # the revert happening after iter_changes did it's
749
 
                    # examination).
750
 
                    if change[7][1]:
751
 
                        entry.executable = True
752
 
                    else:
753
 
                        entry.executable = False
754
 
                    if (carry_over_possible and
755
 
                        parent_entry.executable == entry.executable):
756
 
                            # Check the file length, content hash after reading
757
 
                            # the file.
758
 
                            nostore_sha = parent_entry.text_sha1
759
 
                    else:
760
 
                        nostore_sha = None
761
 
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
762
 
                    try:
763
 
                        text = file_obj.read()
764
 
                    finally:
765
 
                        file_obj.close()
766
 
                    try:
767
 
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
768
 
                            file_id, text, heads, nostore_sha)
769
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
770
 
                    except errors.ExistingContent:
771
 
                        # No content change against a carry_over parent
772
 
                        # Perhaps this should also yield a fs hash update?
773
 
                        carried_over = True
774
 
                        entry.text_size = parent_entry.text_size
775
 
                        entry.text_sha1 = parent_entry.text_sha1
776
 
                elif kind == 'symlink':
777
 
                    # Wants a path hint?
778
 
                    entry.symlink_target = tree.get_symlink_target(file_id)
779
 
                    if (carry_over_possible and
780
 
                        parent_entry.symlink_target == entry.symlink_target):
781
 
                        carried_over = True
782
 
                    else:
783
 
                        self._add_text_to_weave(change[0], '', heads, None)
784
 
                elif kind == 'directory':
785
 
                    if carry_over_possible:
786
 
                        carried_over = True
787
 
                    else:
788
 
                        # Nothing to set on the entry.
789
 
                        # XXX: split into the Root and nonRoot versions.
790
 
                        if change[1][1] != '' or self.repository.supports_rich_root():
791
 
                            self._add_text_to_weave(change[0], '', heads, None)
792
 
                elif kind == 'tree-reference':
793
 
                    if not self.repository._format.supports_tree_reference:
794
 
                        # This isn't quite sane as an error, but we shouldn't
795
 
                        # ever see this code path in practice: tree's don't
796
 
                        # permit references when the repo doesn't support tree
797
 
                        # references.
798
 
                        raise errors.UnsupportedOperation(tree.add_reference,
799
 
                            self.repository)
800
 
                    reference_revision = tree.get_reference_revision(change[0])
801
 
                    entry.reference_revision = reference_revision
802
 
                    if (carry_over_possible and
803
 
                        parent_entry.reference_revision == reference_revision):
804
 
                        carried_over = True
805
 
                    else:
806
 
                        self._add_text_to_weave(change[0], '', heads, None)
807
 
                else:
808
 
                    raise AssertionError('unknown kind %r' % kind)
809
 
                if not carried_over:
810
 
                    entry.revision = modified_rev
811
 
                else:
812
 
                    entry.revision = parent_entry.revision
813
 
            else:
814
 
                entry = None
815
 
            new_path = change[1][1]
816
 
            inv_delta.append((change[1][0], new_path, change[0], entry))
817
 
            if new_path == '':
818
 
                seen_root = True
819
 
        self.new_inventory = None
820
 
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
 
            self._any_changes = True
825
 
        if not seen_root:
826
 
            # housekeeping root entry changes do not affect no-change commits.
827
 
            self._require_root_change(tree)
828
 
        self.basis_delta_revision = basis_revision_id
829
 
 
830
 
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
831
 
        parent_keys = tuple([(file_id, parent) for parent in parents])
832
 
        return self.repository.texts._add_text(
833
 
            (file_id, self._new_revision_id), parent_keys, new_text,
834
 
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
835
 
 
836
 
 
837
 
class RootCommitBuilder(CommitBuilder):
838
 
    """This commitbuilder actually records the root id"""
839
 
 
840
 
    # the root entry gets versioned properly by this builder.
841
 
    _versioned_root = True
842
 
 
843
 
    def _check_root(self, ie, parent_invs, tree):
844
 
        """Helper for record_entry_contents.
845
 
 
846
 
        :param ie: An entry being added.
847
 
        :param parent_invs: The inventories of the parent revisions of the
848
 
            commit.
849
 
        :param tree: The tree that is being committed.
850
 
        """
851
 
 
852
 
    def _require_root_change(self, tree):
853
 
        """Enforce an appropriate root object change.
854
 
 
855
 
        This is called once when record_iter_changes is called, if and only if
856
 
        the root was not in the delta calculated by record_iter_changes.
857
 
 
858
 
        :param tree: The tree which is being committed.
859
 
        """
860
 
        # versioned roots do not change unless the tree found a change.
861
 
 
862
 
 
863
 
class RepositoryWriteLockResult(object):
864
 
    """The result of write locking a repository.
865
 
 
866
 
    :ivar repository_token: The token obtained from the underlying lock, or
867
 
        None.
868
 
    :ivar unlock: A callable which will unlock the lock.
869
 
    """
870
 
 
871
 
    def __init__(self, unlock, repository_token):
872
 
        self.repository_token = repository_token
873
 
        self.unlock = unlock
874
 
 
875
 
 
876
 
######################################################################
877
 
# Repositories
878
 
 
879
 
 
880
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
45
from bzrlib.tree import EmptyTree
 
46
from bzrlib.weave import WeaveFile
 
47
 
 
48
 
 
49
class Repository(object):
881
50
    """Repository holding history for one or more branches.
882
51
 
883
52
    The repository holds and retrieves historical information including
884
53
    revisions and file history.  It's normally accessed only by the Branch,
885
54
    which views a particular line of development through that history.
886
55
 
887
 
    The Repository builds on top of some byte storage facilies (the revisions,
888
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
889
 
    which respectively provide byte storage and a means to access the (possibly
 
56
    The Repository builds on top of Stores and a Transport, which respectively 
 
57
    describe the disk data format and the way of accessing the (possibly 
890
58
    remote) disk.
891
 
 
892
 
    The byte storage facilities are addressed via tuples, which we refer to
893
 
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
894
 
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
895
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
896
 
    byte string made up of a hash identifier and a hash value.
897
 
    We use this interface because it allows low friction with the underlying
898
 
    code that implements disk indices, network encoding and other parts of
899
 
    bzrlib.
900
 
 
901
 
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
902
 
        the serialised revisions for the repository. This can be used to obtain
903
 
        revision graph information or to access raw serialised revisions.
904
 
        The result of trying to insert data into the repository via this store
905
 
        is undefined: it should be considered read-only except for implementors
906
 
        of repositories.
907
 
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
908
 
        the serialised signatures for the repository. This can be used to
909
 
        obtain access to raw serialised signatures.  The result of trying to
910
 
        insert data into the repository via this store is undefined: it should
911
 
        be considered read-only except for implementors of repositories.
912
 
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
913
 
        the serialised inventories for the repository. This can be used to
914
 
        obtain unserialised inventories.  The result of trying to insert data
915
 
        into the repository via this store is undefined: it should be
916
 
        considered read-only except for implementors of repositories.
917
 
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
918
 
        texts of files and directories for the repository. This can be used to
919
 
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
920
 
        is usually a better interface for accessing file texts.
921
 
        The result of trying to insert data into the repository via this store
922
 
        is undefined: it should be considered read-only except for implementors
923
 
        of repositories.
924
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
925
 
        any data the repository chooses to store or have indexed by its hash.
926
 
        The result of trying to insert data into the repository via this store
927
 
        is undefined: it should be considered read-only except for implementors
928
 
        of repositories.
929
 
    :ivar _transport: Transport for file access to repository, typically
930
 
        pointing to .bzr/repository.
931
59
    """
932
60
 
933
 
    # What class to use for a CommitBuilder. Often its simpler to change this
934
 
    # in a Repository class subclass rather than to override
935
 
    # get_commit_builder.
936
 
    _commit_builder_class = CommitBuilder
937
 
    # The search regex used by xml based repositories to determine what things
938
 
    # where changed in a single commit.
939
 
    _file_ids_altered_regex = lazy_regex.lazy_compile(
940
 
        r'file_id="(?P<file_id>[^"]+)"'
941
 
        r'.* revision="(?P<revision_id>[^"]+)"'
942
 
        )
943
 
 
944
 
    def abort_write_group(self, suppress_errors=False):
945
 
        """Commit the contents accrued within the current write group.
946
 
 
947
 
        :param suppress_errors: if true, abort_write_group will catch and log
948
 
            unexpected errors that happen during the abort, rather than
949
 
            allowing them to propagate.  Defaults to False.
950
 
 
951
 
        :seealso: start_write_group.
952
 
        """
953
 
        if self._write_group is not self.get_transaction():
954
 
            # has an unlock or relock occured ?
955
 
            if suppress_errors:
956
 
                mutter(
957
 
                '(suppressed) mismatched lock context and write group. %r, %r',
958
 
                self._write_group, self.get_transaction())
959
 
                return
960
 
            raise errors.BzrError(
961
 
                'mismatched lock context and write group. %r, %r' %
962
 
                (self._write_group, self.get_transaction()))
963
 
        try:
964
 
            self._abort_write_group()
965
 
        except Exception, exc:
966
 
            self._write_group = None
967
 
            if not suppress_errors:
968
 
                raise
969
 
            mutter('abort_write_group failed')
970
 
            log_exception_quietly()
971
 
            note('bzr: ERROR (ignored): %s', exc)
972
 
        self._write_group = None
973
 
 
974
 
    def _abort_write_group(self):
975
 
        """Template method for per-repository write group cleanup.
976
 
 
977
 
        This is called during abort before the write group is considered to be
978
 
        finished and should cleanup any internal state accrued during the write
979
 
        group. There is no requirement that data handed to the repository be
980
 
        *not* made available - this is not a rollback - but neither should any
981
 
        attempt be made to ensure that data added is fully commited. Abort is
982
 
        invoked when an error has occured so futher disk or network operations
983
 
        may not be possible or may error and if possible should not be
984
 
        attempted.
985
 
        """
986
 
 
987
 
    def add_fallback_repository(self, repository):
988
 
        """Add a repository to use for looking up data not held locally.
989
 
 
990
 
        :param repository: A repository.
991
 
        """
992
 
        if not self._format.supports_external_lookups:
993
 
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
994
 
        if self.is_locked():
995
 
            # This repository will call fallback.unlock() when we transition to
996
 
            # the unlocked state, so we make sure to increment the lock count
997
 
            repository.lock_read()
998
 
        self._check_fallback_repository(repository)
999
 
        self._fallback_repositories.append(repository)
1000
 
        self.texts.add_fallback_versioned_files(repository.texts)
1001
 
        self.inventories.add_fallback_versioned_files(repository.inventories)
1002
 
        self.revisions.add_fallback_versioned_files(repository.revisions)
1003
 
        self.signatures.add_fallback_versioned_files(repository.signatures)
1004
 
        if self.chk_bytes is not None:
1005
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1006
 
 
1007
 
    def _check_fallback_repository(self, repository):
1008
 
        """Check that this repository can fallback to repository safely.
1009
 
 
1010
 
        Raise an error if not.
1011
 
 
1012
 
        :param repository: A repository to fallback to.
1013
 
        """
1014
 
        return InterRepository._assert_same_model(self, repository)
1015
 
 
1016
 
    def add_inventory(self, revision_id, inv, parents):
1017
 
        """Add the inventory inv to the repository as revision_id.
1018
 
 
1019
 
        :param parents: The revision ids of the parents that revision_id
 
61
    @needs_write_lock
 
62
    def add_inventory(self, revid, inv, parents):
 
63
        """Add the inventory inv to the repository as revid.
 
64
        
 
65
        :param parents: The revision ids of the parents that revid
1020
66
                        is known to have and are in the repository already.
1021
67
 
1022
 
        :returns: The validator(which is a sha1 digest, though what is sha'd is
1023
 
            repository format specific) of the serialized inventory.
1024
 
        """
1025
 
        if not self.is_in_write_group():
1026
 
            raise AssertionError("%r not in write group" % (self,))
1027
 
        _mod_revision.check_not_reserved_id(revision_id)
1028
 
        if not (inv.revision_id is None or inv.revision_id == revision_id):
1029
 
            raise AssertionError(
1030
 
                "Mismatch between inventory revision"
1031
 
                " id and insertion revid (%r, %r)"
1032
 
                % (inv.revision_id, revision_id))
1033
 
        if inv.root is None:
1034
 
            raise AssertionError()
1035
 
        return self._add_inventory_checked(revision_id, inv, parents)
1036
 
 
1037
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1038
 
        """Add inv to the repository after checking the inputs.
1039
 
 
1040
 
        This function can be overridden to allow different inventory styles.
1041
 
 
1042
 
        :seealso: add_inventory, for the contract.
1043
 
        """
1044
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
1045
 
        return self._inventory_add_lines(revision_id, parents,
1046
 
            inv_lines, check_content=False)
1047
 
 
1048
 
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1049
 
                               parents, basis_inv=None, propagate_caches=False):
1050
 
        """Add a new inventory expressed as a delta against another revision.
1051
 
 
1052
 
        See the inventory developers documentation for the theory behind
1053
 
        inventory deltas.
1054
 
 
1055
 
        :param basis_revision_id: The inventory id the delta was created
1056
 
            against. (This does not have to be a direct parent.)
1057
 
        :param delta: The inventory delta (see Inventory.apply_delta for
1058
 
            details).
1059
 
        :param new_revision_id: The revision id that the inventory is being
1060
 
            added for.
1061
 
        :param parents: The revision ids of the parents that revision_id is
1062
 
            known to have and are in the repository already. These are supplied
1063
 
            for repositories that depend on the inventory graph for revision
1064
 
            graph access, as well as for those that pun ancestry with delta
1065
 
            compression.
1066
 
        :param basis_inv: The basis inventory if it is already known,
1067
 
            otherwise None.
1068
 
        :param propagate_caches: If True, the caches for this inventory are
1069
 
          copied to and updated for the result if possible.
1070
 
 
1071
 
        :returns: (validator, new_inv)
1072
 
            The validator(which is a sha1 digest, though what is sha'd is
1073
 
            repository format specific) of the serialized inventory, and the
1074
 
            resulting inventory.
1075
 
        """
1076
 
        if not self.is_in_write_group():
1077
 
            raise AssertionError("%r not in write group" % (self,))
1078
 
        _mod_revision.check_not_reserved_id(new_revision_id)
1079
 
        basis_tree = self.revision_tree(basis_revision_id)
1080
 
        basis_tree.lock_read()
1081
 
        try:
1082
 
            # Note that this mutates the inventory of basis_tree, which not all
1083
 
            # inventory implementations may support: A better idiom would be to
1084
 
            # return a new inventory, but as there is no revision tree cache in
1085
 
            # repository this is safe for now - RBC 20081013
1086
 
            if basis_inv is None:
1087
 
                basis_inv = basis_tree.inventory
1088
 
            basis_inv.apply_delta(delta)
1089
 
            basis_inv.revision_id = new_revision_id
1090
 
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1091
 
                    basis_inv)
1092
 
        finally:
1093
 
            basis_tree.unlock()
1094
 
 
1095
 
    def _inventory_add_lines(self, revision_id, parents, lines,
1096
 
        check_content=True):
1097
 
        """Store lines in inv_vf and return the sha1 of the inventory."""
1098
 
        parents = [(parent,) for parent in parents]
1099
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
1100
 
            check_content=check_content)[0]
1101
 
        self.inventories._access.flush()
1102
 
        return result
1103
 
 
1104
 
    def add_revision(self, revision_id, rev, inv=None, config=None):
1105
 
        """Add rev to the revision store as revision_id.
1106
 
 
1107
 
        :param revision_id: the revision id to use.
 
68
        returns the sha1 of the serialized inventory.
 
69
        """
 
70
        assert inv.revision_id is None or inv.revision_id == revid, \
 
71
            "Mismatch between inventory revision" \
 
72
            " id and insertion revid (%r, %r)" % (inv.revision_id, revid)
 
73
        inv_text = xml5.serializer_v5.write_inventory_to_string(inv)
 
74
        inv_sha1 = osutils.sha_string(inv_text)
 
75
        inv_vf = self.control_weaves.get_weave('inventory',
 
76
                                               self.get_transaction())
 
77
        self._inventory_add_lines(inv_vf, revid, parents, osutils.split_lines(inv_text))
 
78
        return inv_sha1
 
79
 
 
80
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
 
81
        final_parents = []
 
82
        for parent in parents:
 
83
            if parent in inv_vf:
 
84
                final_parents.append(parent)
 
85
 
 
86
        inv_vf.add_lines(revid, final_parents, lines)
 
87
 
 
88
    @needs_write_lock
 
89
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
90
        """Add rev to the revision store as rev_id.
 
91
 
 
92
        :param rev_id: the revision id to use.
1108
93
        :param rev: The revision object.
1109
94
        :param inv: The inventory for the revision. if None, it will be looked
1110
95
                    up in the inventory storer
1112
97
                       If supplied its signature_needed method will be used
1113
98
                       to determine if a signature should be made.
1114
99
        """
1115
 
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
1116
 
        #       rev.parent_ids?
1117
 
        _mod_revision.check_not_reserved_id(revision_id)
1118
100
        if config is not None and config.signature_needed():
1119
101
            if inv is None:
1120
 
                inv = self.get_inventory(revision_id)
 
102
                inv = self.get_inventory(rev_id)
1121
103
            plaintext = Testament(rev, inv).as_short_text()
1122
104
            self.store_revision_signature(
1123
 
                gpg.GPGStrategy(config), plaintext, revision_id)
1124
 
        # check inventory present
1125
 
        if not self.inventories.get_parent_map([(revision_id,)]):
 
105
                gpg.GPGStrategy(config), plaintext, rev_id)
 
106
        if not rev_id in self.get_inventory_weave():
1126
107
            if inv is None:
1127
 
                raise errors.WeaveRevisionNotPresent(revision_id,
1128
 
                                                     self.inventories)
 
108
                raise errors.WeaveRevisionNotPresent(rev_id,
 
109
                                                     self.get_inventory_weave())
1129
110
            else:
1130
111
                # yes, this is not suitable for adding with ghosts.
1131
 
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1132
 
                                                        rev.parent_ids)
1133
 
        else:
1134
 
            key = (revision_id,)
1135
 
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1136
 
        self._add_revision(rev)
 
112
                self.add_inventory(rev_id, inv, rev.parent_ids)
 
113
        self._revision_store.add_revision(rev, self.get_transaction())
1137
114
 
1138
 
    def _add_revision(self, revision):
1139
 
        text = self._serializer.write_revision_to_string(revision)
1140
 
        key = (revision.revision_id,)
1141
 
        parents = tuple((parent,) for parent in revision.parent_ids)
1142
 
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
 
115
    @needs_read_lock
 
116
    def _all_possible_ids(self):
 
117
        """Return all the possible revisions that we could find."""
 
118
        return self.get_inventory_weave().versions()
1143
119
 
1144
120
    def all_revision_ids(self):
1145
 
        """Returns a list of all the revision ids in the repository.
 
121
        """Returns a list of all the revision ids in the repository. 
1146
122
 
1147
 
        This is conceptually deprecated because code should generally work on
1148
 
        the graph reachable from a particular revision, and ignore any other
1149
 
        revisions that might be present.  There is no direct replacement
1150
 
        method.
 
123
        This is deprecated because code should generally work on the graph
 
124
        reachable from a particular revision, and ignore any other revisions
 
125
        that might be present.  There is no direct replacement method.
1151
126
        """
1152
 
        if 'evil' in debug.debug_flags:
1153
 
            mutter_callsite(2, "all_revision_ids is linear with history.")
1154
127
        return self._all_revision_ids()
1155
128
 
 
129
    @needs_read_lock
1156
130
    def _all_revision_ids(self):
1157
 
        """Returns a list of all the revision ids in the repository.
 
131
        """Returns a list of all the revision ids in the repository. 
1158
132
 
1159
 
        These are in as much topological order as the underlying store can
1160
 
        present.
 
133
        These are in as much topological order as the underlying store can 
 
134
        present: for weaves ghosts may lead to a lack of correctness until
 
135
        the reweave updates the parents list.
1161
136
        """
1162
 
        raise NotImplementedError(self._all_revision_ids)
 
137
        if self._revision_store.text_store.listable():
 
138
            return self._revision_store.all_revision_ids(self.get_transaction())
 
139
        result = self._all_possible_ids()
 
140
        return self._eliminate_revisions_not_present(result)
1163
141
 
1164
142
    def break_lock(self):
1165
143
        """Break a lock if one is present from another instance.
1176
154
        Returns a set of the present revisions.
1177
155
        """
1178
156
        result = []
1179
 
        graph = self.get_graph()
1180
 
        parent_map = graph.get_parent_map(revision_ids)
1181
 
        # The old API returned a list, should this actually be a set?
1182
 
        return parent_map.keys()
1183
 
 
1184
 
    def _check_inventories(self, checker):
1185
 
        """Check the inventories found from the revision scan.
1186
 
        
1187
 
        This is responsible for verifying the sha1 of inventories and
1188
 
        creating a pending_keys set that covers data referenced by inventories.
1189
 
        """
1190
 
        bar = ui.ui_factory.nested_progress_bar()
1191
 
        try:
1192
 
            self._do_check_inventories(checker, bar)
1193
 
        finally:
1194
 
            bar.finished()
1195
 
 
1196
 
    def _do_check_inventories(self, checker, bar):
1197
 
        """Helper for _check_inventories."""
1198
 
        revno = 0
1199
 
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1200
 
        kinds = ['chk_bytes', 'texts']
1201
 
        count = len(checker.pending_keys)
1202
 
        bar.update("inventories", 0, 2)
1203
 
        current_keys = checker.pending_keys
1204
 
        checker.pending_keys = {}
1205
 
        # Accumulate current checks.
1206
 
        for key in current_keys:
1207
 
            if key[0] != 'inventories' and key[0] not in kinds:
1208
 
                checker._report_items.append('unknown key type %r' % (key,))
1209
 
            keys[key[0]].add(key[1:])
1210
 
        if keys['inventories']:
1211
 
            # NB: output order *should* be roughly sorted - topo or
1212
 
            # inverse topo depending on repository - either way decent
1213
 
            # to just delta against. However, pre-CHK formats didn't
1214
 
            # try to optimise inventory layout on disk. As such the
1215
 
            # pre-CHK code path does not use inventory deltas.
1216
 
            last_object = None
1217
 
            for record in self.inventories.check(keys=keys['inventories']):
1218
 
                if record.storage_kind == 'absent':
1219
 
                    checker._report_items.append(
1220
 
                        'Missing inventory {%s}' % (record.key,))
1221
 
                else:
1222
 
                    last_object = self._check_record('inventories', record,
1223
 
                        checker, last_object,
1224
 
                        current_keys[('inventories',) + record.key])
1225
 
            del keys['inventories']
1226
 
        else:
1227
 
            return
1228
 
        bar.update("texts", 1)
1229
 
        while (checker.pending_keys or keys['chk_bytes']
1230
 
            or keys['texts']):
1231
 
            # Something to check.
1232
 
            current_keys = checker.pending_keys
1233
 
            checker.pending_keys = {}
1234
 
            # Accumulate current checks.
1235
 
            for key in current_keys:
1236
 
                if key[0] not in kinds:
1237
 
                    checker._report_items.append('unknown key type %r' % (key,))
1238
 
                keys[key[0]].add(key[1:])
1239
 
            # Check the outermost kind only - inventories || chk_bytes || texts
1240
 
            for kind in kinds:
1241
 
                if keys[kind]:
1242
 
                    last_object = None
1243
 
                    for record in getattr(self, kind).check(keys=keys[kind]):
1244
 
                        if record.storage_kind == 'absent':
1245
 
                            checker._report_items.append(
1246
 
                                'Missing %s {%s}' % (kind, record.key,))
1247
 
                        else:
1248
 
                            last_object = self._check_record(kind, record,
1249
 
                                checker, last_object, current_keys[(kind,) + record.key])
1250
 
                    keys[kind] = set()
1251
 
                    break
1252
 
 
1253
 
    def _check_record(self, kind, record, checker, last_object, item_data):
1254
 
        """Check a single text from this repository."""
1255
 
        if kind == 'inventories':
1256
 
            rev_id = record.key[0]
1257
 
            inv = self._deserialise_inventory(rev_id,
1258
 
                record.get_bytes_as('fulltext'))
1259
 
            if last_object is not None:
1260
 
                delta = inv._make_delta(last_object)
1261
 
                for old_path, path, file_id, ie in delta:
1262
 
                    if ie is None:
1263
 
                        continue
1264
 
                    ie.check(checker, rev_id, inv)
1265
 
            else:
1266
 
                for path, ie in inv.iter_entries():
1267
 
                    ie.check(checker, rev_id, inv)
1268
 
            if self._format.fast_deltas:
1269
 
                return inv
1270
 
        elif kind == 'chk_bytes':
1271
 
            # No code written to check chk_bytes for this repo format.
1272
 
            checker._report_items.append(
1273
 
                'unsupported key type chk_bytes for %s' % (record.key,))
1274
 
        elif kind == 'texts':
1275
 
            self._check_text(record, checker, item_data)
1276
 
        else:
1277
 
            checker._report_items.append(
1278
 
                'unknown key type %s for %s' % (kind, record.key))
1279
 
 
1280
 
    def _check_text(self, record, checker, item_data):
1281
 
        """Check a single text."""
1282
 
        # Check it is extractable.
1283
 
        # TODO: check length.
1284
 
        if record.storage_kind == 'chunked':
1285
 
            chunks = record.get_bytes_as(record.storage_kind)
1286
 
            sha1 = osutils.sha_strings(chunks)
1287
 
            length = sum(map(len, chunks))
1288
 
        else:
1289
 
            content = record.get_bytes_as('fulltext')
1290
 
            sha1 = osutils.sha_string(content)
1291
 
            length = len(content)
1292
 
        if item_data and sha1 != item_data[1]:
1293
 
            checker._report_items.append(
1294
 
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1295
 
                (record.key, sha1, item_data[1], item_data[2]))
 
157
        for id in revision_ids:
 
158
            if self.has_revision(id):
 
159
               result.append(id)
 
160
        return result
1296
161
 
1297
162
    @staticmethod
1298
163
    def create(a_bzrdir):
1299
164
        """Construct the current default format repository in a_bzrdir."""
1300
165
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
1301
166
 
1302
 
    def __init__(self, _format, a_bzrdir, control_files):
 
167
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
1303
168
        """instantiate a Repository.
1304
169
 
1305
170
        :param _format: The format of the repository on disk.
1306
171
        :param a_bzrdir: The BzrDir of the repository.
 
172
 
 
173
        In the future we will have a single api for all stores for
 
174
        getting file texts, inventories and revisions, then
 
175
        this construct will accept instances of those things.
1307
176
        """
1308
 
        # In the future we will have a single api for all stores for
1309
 
        # getting file texts, inventories and revisions, then
1310
 
        # this construct will accept instances of those things.
1311
177
        super(Repository, self).__init__()
1312
178
        self._format = _format
1313
179
        # the following are part of the public API for Repository:
1314
180
        self.bzrdir = a_bzrdir
1315
181
        self.control_files = control_files
1316
 
        self._transport = control_files._transport
1317
 
        self.base = self._transport.base
1318
 
        # for tests
1319
 
        self._reconcile_does_inventory_gc = True
1320
 
        self._reconcile_fixes_text_parents = False
1321
 
        self._reconcile_backsup_inventory = True
1322
 
        self._write_group = None
1323
 
        # Additional places to query for data.
1324
 
        self._fallback_repositories = []
1325
 
        # An InventoryEntry cache, used during deserialization
1326
 
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1327
 
        # Is it safe to return inventory entries directly from the entry cache,
1328
 
        # rather copying them?
1329
 
        self._safe_to_return_from_cache = False
1330
 
 
1331
 
    @property
1332
 
    def user_transport(self):
1333
 
        return self.bzrdir.user_transport
1334
 
 
1335
 
    @property
1336
 
    def control_transport(self):
1337
 
        return self._transport
 
182
        self._revision_store = _revision_store
 
183
        self.text_store = text_store
 
184
        # backwards compatibility
 
185
        self.weave_store = text_store
 
186
        # not right yet - should be more semantically clear ? 
 
187
        # 
 
188
        self.control_store = control_store
 
189
        self.control_weaves = control_store
 
190
        # TODO: make sure to construct the right store classes, etc, depending
 
191
        # on whether escaping is required.
1338
192
 
1339
193
    def __repr__(self):
1340
 
        if self._fallback_repositories:
1341
 
            return '%s(%r, fallback_repositories=%r)' % (
1342
 
                self.__class__.__name__,
1343
 
                self.base,
1344
 
                self._fallback_repositories)
1345
 
        else:
1346
 
            return '%s(%r)' % (self.__class__.__name__,
1347
 
                               self.base)
1348
 
 
1349
 
    def _has_same_fallbacks(self, other_repo):
1350
 
        """Returns true if the repositories have the same fallbacks."""
1351
 
        my_fb = self._fallback_repositories
1352
 
        other_fb = other_repo._fallback_repositories
1353
 
        if len(my_fb) != len(other_fb):
1354
 
            return False
1355
 
        for f, g in zip(my_fb, other_fb):
1356
 
            if not f.has_same_location(g):
1357
 
                return False
1358
 
        return True
1359
 
 
1360
 
    def has_same_location(self, other):
1361
 
        """Returns a boolean indicating if this repository is at the same
1362
 
        location as another repository.
1363
 
 
1364
 
        This might return False even when two repository objects are accessing
1365
 
        the same physical repository via different URLs.
1366
 
        """
1367
 
        if self.__class__ is not other.__class__:
1368
 
            return False
1369
 
        return (self._transport.base == other._transport.base)
1370
 
 
1371
 
    def is_in_write_group(self):
1372
 
        """Return True if there is an open write group.
1373
 
 
1374
 
        :seealso: start_write_group.
1375
 
        """
1376
 
        return self._write_group is not None
 
194
        return '%s(%r)' % (self.__class__.__name__, 
 
195
                           self.bzrdir.transport.base)
1377
196
 
1378
197
    def is_locked(self):
1379
198
        return self.control_files.is_locked()
1380
199
 
1381
 
    def is_write_locked(self):
1382
 
        """Return True if this object is write locked."""
1383
 
        return self.is_locked() and self.control_files._lock_mode == 'w'
1384
 
 
1385
 
    def lock_write(self, token=None):
1386
 
        """Lock this repository for writing.
1387
 
 
1388
 
        This causes caching within the repository obejct to start accumlating
1389
 
        data during reads, and allows a 'write_group' to be obtained. Write
1390
 
        groups must be used for actual data insertion.
1391
 
 
1392
 
        A token should be passed in if you know that you have locked the object
1393
 
        some other way, and need to synchronise this object's state with that
1394
 
        fact.
1395
 
 
1396
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1397
 
 
1398
 
        :param token: if this is already locked, then lock_write will fail
1399
 
            unless the token matches the existing lock.
1400
 
        :returns: a token if this instance supports tokens, otherwise None.
1401
 
        :raises TokenLockingNotSupported: when a token is given but this
1402
 
            instance doesn't support using token locks.
1403
 
        :raises MismatchedToken: if the specified token doesn't match the token
1404
 
            of the existing lock.
1405
 
        :seealso: start_write_group.
1406
 
        :return: A RepositoryWriteLockResult.
1407
 
        """
1408
 
        locked = self.is_locked()
1409
 
        token = self.control_files.lock_write(token=token)
1410
 
        if not locked:
1411
 
            self._warn_if_deprecated()
1412
 
            self._note_lock('w')
1413
 
            for repo in self._fallback_repositories:
1414
 
                # Writes don't affect fallback repos
1415
 
                repo.lock_read()
1416
 
            self._refresh_data()
1417
 
        return RepositoryWriteLockResult(self.unlock, token)
 
200
    def lock_write(self):
 
201
        self.control_files.lock_write()
1418
202
 
1419
203
    def lock_read(self):
1420
 
        """Lock the repository for read operations.
1421
 
 
1422
 
        :return: An object with an unlock method which will release the lock
1423
 
            obtained.
1424
 
        """
1425
 
        locked = self.is_locked()
1426
204
        self.control_files.lock_read()
1427
 
        if not locked:
1428
 
            self._warn_if_deprecated()
1429
 
            self._note_lock('r')
1430
 
            for repo in self._fallback_repositories:
1431
 
                repo.lock_read()
1432
 
            self._refresh_data()
1433
 
        return self
1434
205
 
1435
206
    def get_physical_lock_status(self):
1436
207
        return self.control_files.get_physical_lock_status()
1437
208
 
1438
 
    def leave_lock_in_place(self):
1439
 
        """Tell this repository not to release the physical lock when this
1440
 
        object is unlocked.
1441
 
 
1442
 
        If lock_write doesn't return a token, then this method is not supported.
1443
 
        """
1444
 
        self.control_files.leave_in_place()
1445
 
 
1446
 
    def dont_leave_lock_in_place(self):
1447
 
        """Tell this repository to release the physical lock when this
1448
 
        object is unlocked, even if it didn't originally acquire it.
1449
 
 
1450
 
        If lock_write doesn't return a token, then this method is not supported.
1451
 
        """
1452
 
        self.control_files.dont_leave_in_place()
1453
 
 
1454
 
    @needs_read_lock
1455
 
    def gather_stats(self, revid=None, committers=None):
1456
 
        """Gather statistics from a revision id.
1457
 
 
1458
 
        :param revid: The revision id to gather statistics from, if None, then
1459
 
            no revision specific statistics are gathered.
1460
 
        :param committers: Optional parameter controlling whether to grab
1461
 
            a count of committers from the revision specific statistics.
1462
 
        :return: A dictionary of statistics. Currently this contains:
1463
 
            committers: The number of committers if requested.
1464
 
            firstrev: A tuple with timestamp, timezone for the penultimate left
1465
 
                most ancestor of revid, if revid is not the NULL_REVISION.
1466
 
            latestrev: A tuple with timestamp, timezone for revid, if revid is
1467
 
                not the NULL_REVISION.
1468
 
            revisions: The total revision count in the repository.
1469
 
            size: An estimate disk size of the repository in bytes.
1470
 
        """
1471
 
        result = {}
1472
 
        if revid and committers:
1473
 
            result['committers'] = 0
1474
 
        if revid and revid != _mod_revision.NULL_REVISION:
1475
 
            if committers:
1476
 
                all_committers = set()
1477
 
            revisions = self.get_ancestry(revid)
1478
 
            # pop the leading None
1479
 
            revisions.pop(0)
1480
 
            first_revision = None
1481
 
            if not committers:
1482
 
                # ignore the revisions in the middle - just grab first and last
1483
 
                revisions = revisions[0], revisions[-1]
1484
 
            for revision in self.get_revisions(revisions):
1485
 
                if not first_revision:
1486
 
                    first_revision = revision
1487
 
                if committers:
1488
 
                    all_committers.add(revision.committer)
1489
 
            last_revision = revision
1490
 
            if committers:
1491
 
                result['committers'] = len(all_committers)
1492
 
            result['firstrev'] = (first_revision.timestamp,
1493
 
                first_revision.timezone)
1494
 
            result['latestrev'] = (last_revision.timestamp,
1495
 
                last_revision.timezone)
1496
 
 
1497
 
        # now gather global repository information
1498
 
        # XXX: This is available for many repos regardless of listability.
1499
 
        if self.user_transport.listable():
1500
 
            # XXX: do we want to __define len__() ?
1501
 
            # Maybe the versionedfiles object should provide a different
1502
 
            # method to get the number of keys.
1503
 
            result['revisions'] = len(self.revisions.keys())
1504
 
            # result['size'] = t
1505
 
        return result
1506
 
 
1507
 
    def find_branches(self, using=False):
1508
 
        """Find branches underneath this repository.
1509
 
 
1510
 
        This will include branches inside other branches.
1511
 
 
1512
 
        :param using: If True, list only branches using this repository.
1513
 
        """
1514
 
        if using and not self.is_shared():
1515
 
            return self.bzrdir.list_branches()
1516
 
        class Evaluator(object):
1517
 
 
1518
 
            def __init__(self):
1519
 
                self.first_call = True
1520
 
 
1521
 
            def __call__(self, bzrdir):
1522
 
                # On the first call, the parameter is always the bzrdir
1523
 
                # containing the current repo.
1524
 
                if not self.first_call:
1525
 
                    try:
1526
 
                        repository = bzrdir.open_repository()
1527
 
                    except errors.NoRepositoryPresent:
1528
 
                        pass
1529
 
                    else:
1530
 
                        return False, ([], repository)
1531
 
                self.first_call = False
1532
 
                value = (bzrdir.list_branches(), None)
1533
 
                return True, value
1534
 
 
1535
 
        ret = []
1536
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1537
 
                self.user_transport, evaluate=Evaluator()):
1538
 
            if branches is not None:
1539
 
                ret.extend(branches)
1540
 
            if not using and repository is not None:
1541
 
                ret.extend(repository.find_branches())
1542
 
        return ret
1543
 
 
1544
 
    @needs_read_lock
1545
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
209
    @needs_read_lock
 
210
    def missing_revision_ids(self, other, revision_id=None):
1546
211
        """Return the revision ids that other has that this does not.
1547
 
 
 
212
        
1548
213
        These are returned in topological order.
1549
214
 
1550
215
        revision_id: only return revision ids included by revision_id.
1551
216
        """
1552
 
        return InterRepository.get(other, self).search_missing_revision_ids(
1553
 
            revision_id, find_ghosts)
 
217
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
1554
218
 
1555
219
    @staticmethod
1556
220
    def open(base):
1562
226
        control = bzrdir.BzrDir.open(base)
1563
227
        return control.open_repository()
1564
228
 
1565
 
    def copy_content_into(self, destination, revision_id=None):
 
229
    def copy_content_into(self, destination, revision_id=None, basis=None):
1566
230
        """Make a complete copy of the content in self into destination.
1567
 
 
1568
 
        This is a destructive operation! Do not use it on existing
 
231
        
 
232
        This is a destructive operation! Do not use it on existing 
1569
233
        repositories.
1570
234
        """
1571
 
        return InterRepository.get(self, destination).copy_content(revision_id)
1572
 
 
1573
 
    def commit_write_group(self):
1574
 
        """Commit the contents accrued within the current write group.
1575
 
 
1576
 
        :seealso: start_write_group.
1577
 
        
1578
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1579
 
        """
1580
 
        if self._write_group is not self.get_transaction():
1581
 
            # has an unlock or relock occured ?
1582
 
            raise errors.BzrError('mismatched lock context %r and '
1583
 
                'write group %r.' %
1584
 
                (self.get_transaction(), self._write_group))
1585
 
        result = self._commit_write_group()
1586
 
        self._write_group = None
1587
 
        return result
1588
 
 
1589
 
    def _commit_write_group(self):
1590
 
        """Template method for per-repository write group cleanup.
1591
 
 
1592
 
        This is called before the write group is considered to be
1593
 
        finished and should ensure that all data handed to the repository
1594
 
        for writing during the write group is safely committed (to the
1595
 
        extent possible considering file system caching etc).
1596
 
        """
1597
 
 
1598
 
    def suspend_write_group(self):
1599
 
        raise errors.UnsuspendableWriteGroup(self)
1600
 
 
1601
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
1602
 
        """Return the keys of missing inventory parents for revisions added in
1603
 
        this write group.
1604
 
 
1605
 
        A revision is not complete if the inventory delta for that revision
1606
 
        cannot be calculated.  Therefore if the parent inventories of a
1607
 
        revision are not present, the revision is incomplete, and e.g. cannot
1608
 
        be streamed by a smart server.  This method finds missing inventory
1609
 
        parents for revisions added in this write group.
1610
 
        """
1611
 
        if not self._format.supports_external_lookups:
1612
 
            # This is only an issue for stacked repositories
1613
 
            return set()
1614
 
        if not self.is_in_write_group():
1615
 
            raise AssertionError('not in a write group')
1616
 
 
1617
 
        # XXX: We assume that every added revision already has its
1618
 
        # corresponding inventory, so we only check for parent inventories that
1619
 
        # might be missing, rather than all inventories.
1620
 
        parents = set(self.revisions._index.get_missing_parents())
1621
 
        parents.discard(_mod_revision.NULL_REVISION)
1622
 
        unstacked_inventories = self.inventories._index
1623
 
        present_inventories = unstacked_inventories.get_parent_map(
1624
 
            key[-1:] for key in parents)
1625
 
        parents.difference_update(present_inventories)
1626
 
        if len(parents) == 0:
1627
 
            # No missing parent inventories.
1628
 
            return set()
1629
 
        if not check_for_missing_texts:
1630
 
            return set(('inventories', rev_id) for (rev_id,) in parents)
1631
 
        # Ok, now we have a list of missing inventories.  But these only matter
1632
 
        # if the inventories that reference them are missing some texts they
1633
 
        # appear to introduce.
1634
 
        # XXX: Texts referenced by all added inventories need to be present,
1635
 
        # but at the moment we're only checking for texts referenced by
1636
 
        # inventories at the graph's edge.
1637
 
        key_deps = self.revisions._index._key_dependencies
1638
 
        key_deps.satisfy_refs_for_keys(present_inventories)
1639
 
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1640
 
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1641
 
        missing_texts = set()
1642
 
        for file_id, version_ids in file_ids.iteritems():
1643
 
            missing_texts.update(
1644
 
                (file_id, version_id) for version_id in version_ids)
1645
 
        present_texts = self.texts.get_parent_map(missing_texts)
1646
 
        missing_texts.difference_update(present_texts)
1647
 
        if not missing_texts:
1648
 
            # No texts are missing, so all revisions and their deltas are
1649
 
            # reconstructable.
1650
 
            return set()
1651
 
        # Alternatively the text versions could be returned as the missing
1652
 
        # keys, but this is likely to be less data.
1653
 
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1654
 
        return missing_keys
1655
 
 
1656
 
    def refresh_data(self):
1657
 
        """Re-read any data needed to to synchronise with disk.
1658
 
 
1659
 
        This method is intended to be called after another repository instance
1660
 
        (such as one used by a smart server) has inserted data into the
1661
 
        repository. It may not be called during a write group, but may be
1662
 
        called at any other time.
1663
 
        """
1664
 
        if self.is_in_write_group():
1665
 
            raise errors.InternalBzrError(
1666
 
                "May not refresh_data while in a write group.")
1667
 
        self._refresh_data()
1668
 
 
1669
 
    def resume_write_group(self, tokens):
1670
 
        if not self.is_write_locked():
1671
 
            raise errors.NotWriteLocked(self)
1672
 
        if self._write_group:
1673
 
            raise errors.BzrError('already in a write group')
1674
 
        self._resume_write_group(tokens)
1675
 
        # so we can detect unlock/relock - the write group is now entered.
1676
 
        self._write_group = self.get_transaction()
1677
 
 
1678
 
    def _resume_write_group(self, tokens):
1679
 
        raise errors.UnsuspendableWriteGroup(self)
1680
 
 
1681
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1682
 
            fetch_spec=None):
 
235
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
 
236
 
 
237
    def fetch(self, source, revision_id=None, pb=None):
1683
238
        """Fetch the content required to construct revision_id from source.
1684
239
 
1685
 
        If revision_id is None and fetch_spec is None, then all content is
1686
 
        copied.
1687
 
 
1688
 
        fetch() may not be used when the repository is in a write group -
1689
 
        either finish the current write group before using fetch, or use
1690
 
        fetch before starting the write group.
1691
 
 
1692
 
        :param find_ghosts: Find and copy revisions in the source that are
1693
 
            ghosts in the target (and not reachable directly by walking out to
1694
 
            the first-present revision in target from revision_id).
1695
 
        :param revision_id: If specified, all the content needed for this
1696
 
            revision ID will be copied to the target.  Fetch will determine for
1697
 
            itself which content needs to be copied.
1698
 
        :param fetch_spec: If specified, a SearchResult or
1699
 
            PendingAncestryResult that describes which revisions to copy.  This
1700
 
            allows copying multiple heads at once.  Mutually exclusive with
1701
 
            revision_id.
 
240
        If revision_id is None all content is copied.
1702
241
        """
1703
 
        if fetch_spec is not None and revision_id is not None:
1704
 
            raise AssertionError(
1705
 
                "fetch_spec and revision_id are mutually exclusive.")
1706
 
        if self.is_in_write_group():
1707
 
            raise errors.InternalBzrError(
1708
 
                "May not fetch while in a write group.")
1709
 
        # fast path same-url fetch operations
1710
 
        # TODO: lift out to somewhere common with RemoteRepository
1711
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1712
 
        if (self.has_same_location(source)
1713
 
            and fetch_spec is None
1714
 
            and self._has_same_fallbacks(source)):
1715
 
            # check that last_revision is in 'from' and then return a
1716
 
            # no-operation.
1717
 
            if (revision_id is not None and
1718
 
                not _mod_revision.is_null(revision_id)):
1719
 
                self.get_revision(revision_id)
1720
 
            return 0, []
1721
 
        # if there is no specific appropriate InterRepository, this will get
1722
 
        # the InterRepository base class, which raises an
1723
 
        # IncompatibleRepositories when asked to fetch.
1724
 
        inter = InterRepository.get(source, self)
1725
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1726
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1727
 
 
1728
 
    def create_bundle(self, target, base, fileobj, format=None):
1729
 
        return serializer.write_bundle(self, target, base, fileobj, format)
1730
 
 
1731
 
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1732
 
                           timezone=None, committer=None, revprops=None,
 
242
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
 
243
                                                       pb=pb)
 
244
 
 
245
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
 
246
                           timezone=None, committer=None, revprops=None, 
1733
247
                           revision_id=None):
1734
248
        """Obtain a CommitBuilder for this repository.
1735
 
 
 
249
        
1736
250
        :param branch: Branch to commit to.
1737
251
        :param parents: Revision ids of the parents of the new revision.
1738
252
        :param config: Configuration to use.
1742
256
        :param revprops: Optional dictionary of revision properties.
1743
257
        :param revision_id: Optional revision id.
1744
258
        """
1745
 
        if self._fallback_repositories:
1746
 
            raise errors.BzrError("Cannot commit from a lightweight checkout "
1747
 
                "to a stacked branch. See "
1748
 
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1749
 
        result = self._commit_builder_class(self, parents, config,
1750
 
            timestamp, timezone, committer, revprops, revision_id)
1751
 
        self.start_write_group()
1752
 
        return result
 
259
        return CommitBuilder(self, parents, config, timestamp, timezone,
 
260
                             committer, revprops, revision_id)
1753
261
 
1754
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1755
262
    def unlock(self):
1756
 
        if (self.control_files._lock_count == 1 and
1757
 
            self.control_files._lock_mode == 'w'):
1758
 
            if self._write_group is not None:
1759
 
                self.abort_write_group()
1760
 
                self.control_files.unlock()
1761
 
                raise errors.BzrError(
1762
 
                    'Must end write groups before releasing write locks.')
1763
263
        self.control_files.unlock()
1764
 
        if self.control_files._lock_count == 0:
1765
 
            self._inventory_entry_cache.clear()
1766
 
            for repo in self._fallback_repositories:
1767
 
                repo.unlock()
1768
264
 
1769
265
    @needs_read_lock
1770
 
    def clone(self, a_bzrdir, revision_id=None):
 
266
    def clone(self, a_bzrdir, revision_id=None, basis=None):
1771
267
        """Clone this repository into a_bzrdir using the current format.
1772
268
 
1773
269
        Currently no check is made that the format of this repository and
1774
270
        the bzrdir format are compatible. FIXME RBC 20060201.
1775
 
 
1776
 
        :return: The newly created destination repository.
1777
 
        """
1778
 
        # TODO: deprecate after 0.16; cloning this with all its settings is
1779
 
        # probably not very useful -- mbp 20070423
1780
 
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
1781
 
        self.copy_content_into(dest_repo, revision_id)
1782
 
        return dest_repo
1783
 
 
1784
 
    def start_write_group(self):
1785
 
        """Start a write group in the repository.
1786
 
 
1787
 
        Write groups are used by repositories which do not have a 1:1 mapping
1788
 
        between file ids and backend store to manage the insertion of data from
1789
 
        both fetch and commit operations.
1790
 
 
1791
 
        A write lock is required around the start_write_group/commit_write_group
1792
 
        for the support of lock-requiring repository formats.
1793
 
 
1794
 
        One can only insert data into a repository inside a write group.
1795
 
 
1796
 
        :return: None.
1797
 
        """
1798
 
        if not self.is_write_locked():
1799
 
            raise errors.NotWriteLocked(self)
1800
 
        if self._write_group:
1801
 
            raise errors.BzrError('already in a write group')
1802
 
        self._start_write_group()
1803
 
        # so we can detect unlock/relock - the write group is now entered.
1804
 
        self._write_group = self.get_transaction()
1805
 
 
1806
 
    def _start_write_group(self):
1807
 
        """Template method for per-repository write group startup.
1808
 
 
1809
 
        This is called before the write group is considered to be
1810
 
        entered.
1811
 
        """
1812
 
 
1813
 
    @needs_read_lock
1814
 
    def sprout(self, to_bzrdir, revision_id=None):
1815
 
        """Create a descendent repository for new development.
1816
 
 
1817
 
        Unlike clone, this does not copy the settings of the repository.
1818
 
        """
1819
 
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1820
 
        dest_repo.fetch(self, revision_id=revision_id)
1821
 
        return dest_repo
1822
 
 
1823
 
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
271
        """
1824
272
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1825
273
            # use target default format.
1826
 
            dest_repo = a_bzrdir.create_repository()
 
274
            result = a_bzrdir.create_repository()
 
275
        # FIXME RBC 20060209 split out the repository type to avoid this check ?
 
276
        elif isinstance(a_bzrdir._format,
 
277
                      (bzrdir.BzrDirFormat4,
 
278
                       bzrdir.BzrDirFormat5,
 
279
                       bzrdir.BzrDirFormat6)):
 
280
            result = a_bzrdir.open_repository()
1827
281
        else:
1828
 
            # Most control formats need the repository to be specifically
1829
 
            # created, but on some old all-in-one formats it's not needed
1830
 
            try:
1831
 
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1832
 
            except errors.UninitializableFormat:
1833
 
                dest_repo = a_bzrdir.open_repository()
1834
 
        return dest_repo
1835
 
 
1836
 
    def _get_sink(self):
1837
 
        """Return a sink for streaming into this repository."""
1838
 
        return StreamSink(self)
1839
 
 
1840
 
    def _get_source(self, to_format):
1841
 
        """Return a source for streaming from this repository."""
1842
 
        return StreamSource(self, to_format)
 
282
            result = self._format.initialize(a_bzrdir, shared=self.is_shared())
 
283
        self.copy_content_into(result, revision_id, basis)
 
284
        return result
1843
285
 
1844
286
    @needs_read_lock
1845
287
    def has_revision(self, revision_id):
1846
288
        """True if this repository has a copy of the revision."""
1847
 
        return revision_id in self.has_revisions((revision_id,))
1848
 
 
1849
 
    @needs_read_lock
1850
 
    def has_revisions(self, revision_ids):
1851
 
        """Probe to find out the presence of multiple revisions.
1852
 
 
1853
 
        :param revision_ids: An iterable of revision_ids.
1854
 
        :return: A set of the revision_ids that were present.
1855
 
        """
1856
 
        parent_map = self.revisions.get_parent_map(
1857
 
            [(rev_id,) for rev_id in revision_ids])
1858
 
        result = set()
1859
 
        if _mod_revision.NULL_REVISION in revision_ids:
1860
 
            result.add(_mod_revision.NULL_REVISION)
1861
 
        result.update([key[0] for key in parent_map])
1862
 
        return result
1863
 
 
1864
 
    @needs_read_lock
1865
 
    def get_revision(self, revision_id):
1866
 
        """Return the Revision object for a named revision."""
1867
 
        return self.get_revisions([revision_id])[0]
 
289
        return self._revision_store.has_revision_id(revision_id,
 
290
                                                    self.get_transaction())
1868
291
 
1869
292
    @needs_read_lock
1870
293
    def get_revision_reconcile(self, revision_id):
1871
294
        """'reconcile' helper routine that allows access to a revision always.
1872
 
 
 
295
        
1873
296
        This variant of get_revision does not cross check the weave graph
1874
297
        against the revision one as get_revision does: but it should only
1875
298
        be used by reconcile, or reconcile-alike commands that are correcting
1876
299
        or testing the revision graph.
1877
300
        """
1878
 
        return self._get_revisions([revision_id])[0]
1879
 
 
 
301
        if not revision_id or not isinstance(revision_id, basestring):
 
302
            raise InvalidRevisionId(revision_id=revision_id, branch=self)
 
303
        return self._revision_store.get_revisions([revision_id],
 
304
                                                  self.get_transaction())[0]
1880
305
    @needs_read_lock
1881
306
    def get_revisions(self, revision_ids):
1882
 
        """Get many revisions at once.
1883
 
        
1884
 
        Repositories that need to check data on every revision read should 
1885
 
        subclass this method.
1886
 
        """
1887
 
        return self._get_revisions(revision_ids)
1888
 
 
1889
 
    @needs_read_lock
1890
 
    def _get_revisions(self, revision_ids):
1891
 
        """Core work logic to get many revisions without sanity checks."""
1892
 
        revs = {}
1893
 
        for revid, rev in self._iter_revisions(revision_ids):
1894
 
            if rev is None:
1895
 
                raise errors.NoSuchRevision(self, revid)
1896
 
            revs[revid] = rev
1897
 
        return [revs[revid] for revid in revision_ids]
1898
 
 
1899
 
    def _iter_revisions(self, revision_ids):
1900
 
        """Iterate over revision objects.
1901
 
 
1902
 
        :param revision_ids: An iterable of revisions to examine. None may be
1903
 
            passed to request all revisions known to the repository. Note that
1904
 
            not all repositories can find unreferenced revisions; for those
1905
 
            repositories only referenced ones will be returned.
1906
 
        :return: An iterator of (revid, revision) tuples. Absent revisions (
1907
 
            those asked for but not available) are returned as (revid, None).
1908
 
        """
1909
 
        if revision_ids is None:
1910
 
            revision_ids = self.all_revision_ids()
1911
 
        else:
1912
 
            for rev_id in revision_ids:
1913
 
                if not rev_id or not isinstance(rev_id, basestring):
1914
 
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1915
 
        keys = [(key,) for key in revision_ids]
1916
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1917
 
        for record in stream:
1918
 
            revid = record.key[0]
1919
 
            if record.storage_kind == 'absent':
1920
 
                yield (revid, None)
1921
 
            else:
1922
 
                text = record.get_bytes_as('fulltext')
1923
 
                rev = self._serializer.read_revision_from_string(text)
1924
 
                yield (revid, rev)
1925
 
 
1926
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
307
        return self._revision_store.get_revisions(revision_ids,
 
308
                                                  self.get_transaction())
 
309
 
 
310
    @needs_read_lock
 
311
    def get_revision_xml(self, revision_id):
 
312
        rev = self.get_revision(revision_id) 
 
313
        rev_tmp = StringIO()
 
314
        # the current serializer..
 
315
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
316
        rev_tmp.seek(0)
 
317
        return rev_tmp.getvalue()
 
318
 
 
319
    @needs_read_lock
 
320
    def get_revision(self, revision_id):
 
321
        """Return the Revision object for a named revision"""
 
322
        r = self.get_revision_reconcile(revision_id)
 
323
        # weave corruption can lead to absent revision markers that should be
 
324
        # present.
 
325
        # the following test is reasonably cheap (it needs a single weave read)
 
326
        # and the weave is cached in read transactions. In write transactions
 
327
        # it is not cached but typically we only read a small number of
 
328
        # revisions. For knits when they are introduced we will probably want
 
329
        # to ensure that caching write transactions are in use.
 
330
        inv = self.get_inventory_weave()
 
331
        self._check_revision_parents(r, inv)
 
332
        return r
 
333
 
 
334
    @needs_read_lock
 
335
    def get_deltas_for_revisions(self, revisions):
1927
336
        """Produce a generator of revision deltas.
1928
 
 
 
337
        
1929
338
        Note that the input is a sequence of REVISIONS, not revision_ids.
1930
339
        Trees will be held in memory until the generator exits.
1931
340
        Each delta is relative to the revision's lefthand predecessor.
1932
 
 
1933
 
        :param specific_fileids: if not None, the result is filtered
1934
 
          so that only those file-ids, their parents and their
1935
 
          children are included.
1936
341
        """
1937
 
        # Get the revision-ids of interest
1938
342
        required_trees = set()
1939
343
        for revision in revisions:
1940
344
            required_trees.add(revision.revision_id)
1941
345
            required_trees.update(revision.parent_ids[:1])
1942
 
 
1943
 
        # Get the matching filtered trees. Note that it's more
1944
 
        # efficient to pass filtered trees to changes_from() rather
1945
 
        # than doing the filtering afterwards. changes_from() could
1946
 
        # arguably do the filtering itself but it's path-based, not
1947
 
        # file-id based, so filtering before or afterwards is
1948
 
        # currently easier.
1949
 
        if specific_fileids is None:
1950
 
            trees = dict((t.get_revision_id(), t) for
1951
 
                t in self.revision_trees(required_trees))
1952
 
        else:
1953
 
            trees = dict((t.get_revision_id(), t) for
1954
 
                t in self._filtered_revision_trees(required_trees,
1955
 
                specific_fileids))
1956
 
 
1957
 
        # Calculate the deltas
 
346
        trees = dict((t.get_revision_id(), t) for 
 
347
                     t in self.revision_trees(required_trees))
1958
348
        for revision in revisions:
1959
349
            if not revision.parent_ids:
1960
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
350
                old_tree = EmptyTree()
1961
351
            else:
1962
352
                old_tree = trees[revision.parent_ids[0]]
1963
 
            yield trees[revision.revision_id].changes_from(old_tree)
 
353
            yield delta.compare_trees(old_tree, trees[revision.revision_id])
1964
354
 
1965
355
    @needs_read_lock
1966
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
356
    def get_revision_delta(self, revision_id):
1967
357
        """Return the delta for one revision.
1968
358
 
1969
359
        The delta is relative to the left-hand predecessor of the
1970
360
        revision.
1971
 
 
1972
 
        :param specific_fileids: if not None, the result is filtered
1973
 
          so that only those file-ids, their parents and their
1974
 
          children are included.
1975
361
        """
1976
362
        r = self.get_revision(revision_id)
1977
 
        return list(self.get_deltas_for_revisions([r],
1978
 
            specific_fileids=specific_fileids))[0]
 
363
        return list(self.get_deltas_for_revisions([r]))[0]
 
364
 
 
365
    def _check_revision_parents(self, revision, inventory):
 
366
        """Private to Repository and Fetch.
 
367
        
 
368
        This checks the parentage of revision in an inventory weave for 
 
369
        consistency and is only applicable to inventory-weave-for-ancestry
 
370
        using repository formats & fetchers.
 
371
        """
 
372
        weave_parents = inventory.get_parents(revision.revision_id)
 
373
        weave_names = inventory.versions()
 
374
        for parent_id in revision.parent_ids:
 
375
            if parent_id in weave_names:
 
376
                # this parent must not be a ghost.
 
377
                if not parent_id in weave_parents:
 
378
                    # but it is a ghost
 
379
                    raise errors.CorruptRepository(self)
1979
380
 
1980
381
    @needs_write_lock
1981
382
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1982
383
        signature = gpg_strategy.sign(plaintext)
1983
 
        self.add_signature_text(revision_id, signature)
1984
 
 
1985
 
    @needs_write_lock
1986
 
    def add_signature_text(self, revision_id, signature):
1987
 
        self.signatures.add_lines((revision_id,), (),
1988
 
            osutils.split_lines(signature))
1989
 
 
1990
 
    def find_text_key_references(self):
1991
 
        """Find the text key references within the repository.
1992
 
 
1993
 
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1994
 
            to whether they were referred to by the inventory of the
1995
 
            revision_id that they contain. The inventory texts from all present
1996
 
            revision ids are assessed to generate this report.
1997
 
        """
1998
 
        revision_keys = self.revisions.keys()
1999
 
        w = self.inventories
2000
 
        pb = ui.ui_factory.nested_progress_bar()
2001
 
        try:
2002
 
            return self._find_text_key_references_from_xml_inventory_lines(
2003
 
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
2004
 
        finally:
2005
 
            pb.finished()
2006
 
 
2007
 
    def _find_text_key_references_from_xml_inventory_lines(self,
2008
 
        line_iterator):
2009
 
        """Core routine for extracting references to texts from inventories.
2010
 
 
2011
 
        This performs the translation of xml lines to revision ids.
2012
 
 
2013
 
        :param line_iterator: An iterator of lines, origin_version_id
2014
 
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
2015
 
            to whether they were referred to by the inventory of the
2016
 
            revision_id that they contain. Note that if that revision_id was
2017
 
            not part of the line_iterator's output then False will be given -
2018
 
            even though it may actually refer to that key.
2019
 
        """
2020
 
        if not self._serializer.support_altered_by_hack:
2021
 
            raise AssertionError(
2022
 
                "_find_text_key_references_from_xml_inventory_lines only "
2023
 
                "supported for branches which store inventory as unnested xml"
2024
 
                ", not on %r" % self)
 
384
        self._revision_store.add_revision_signature_text(revision_id,
 
385
                                                         signature,
 
386
                                                         self.get_transaction())
 
387
 
 
388
    def fileids_altered_by_revision_ids(self, revision_ids):
 
389
        """Find the file ids and versions affected by revisions.
 
390
 
 
391
        :param revisions: an iterable containing revision ids.
 
392
        :return: a dictionary mapping altered file-ids to an iterable of
 
393
        revision_ids. Each altered file-ids has the exact revision_ids that
 
394
        altered it listed explicitly.
 
395
        """
 
396
        assert isinstance(self._format, (RepositoryFormat5,
 
397
                                         RepositoryFormat6,
 
398
                                         RepositoryFormat7,
 
399
                                         RepositoryFormatKnit1)), \
 
400
            ("fileids_altered_by_revision_ids only supported for branches " 
 
401
             "which store inventory as unnested xml, not on %r" % self)
 
402
        selected_revision_ids = set(revision_ids)
 
403
        w = self.get_inventory_weave()
2025
404
        result = {}
2026
405
 
2027
406
        # this code needs to read every new line in every inventory for the
2028
407
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2029
 
        # not present in one of those inventories is unnecessary but not
 
408
        # not present in one of those inventories is unnecessary but not 
2030
409
        # harmful because we are filtering by the revision id marker in the
2031
 
        # inventory lines : we only select file ids altered in one of those
 
410
        # inventory lines : we only select file ids altered in one of those  
2032
411
        # revisions. We don't need to see all lines in the inventory because
2033
412
        # only those added in an inventory in rev X can contain a revision=X
2034
413
        # line.
2035
 
        unescape_revid_cache = {}
2036
 
        unescape_fileid_cache = {}
2037
 
 
2038
 
        # jam 20061218 In a big fetch, this handles hundreds of thousands
2039
 
        # of lines, so it has had a lot of inlining and optimizing done.
2040
 
        # Sorry that it is a little bit messy.
2041
 
        # Move several functions to be local variables, since this is a long
2042
 
        # running loop.
2043
 
        search = self._file_ids_altered_regex.search
2044
 
        unescape = _unescape_xml
2045
 
        setdefault = result.setdefault
2046
 
        for line, line_key in line_iterator:
2047
 
            match = search(line)
2048
 
            if match is None:
2049
 
                continue
2050
 
            # One call to match.group() returning multiple items is quite a
2051
 
            # bit faster than 2 calls to match.group() each returning 1
2052
 
            file_id, revision_id = match.group('file_id', 'revision_id')
2053
 
 
2054
 
            # Inlining the cache lookups helps a lot when you make 170,000
2055
 
            # lines and 350k ids, versus 8.4 unique ids.
2056
 
            # Using a cache helps in 2 ways:
2057
 
            #   1) Avoids unnecessary decoding calls
2058
 
            #   2) Re-uses cached strings, which helps in future set and
2059
 
            #      equality checks.
2060
 
            # (2) is enough that removing encoding entirely along with
2061
 
            # the cache (so we are using plain strings) results in no
2062
 
            # performance improvement.
2063
 
            try:
2064
 
                revision_id = unescape_revid_cache[revision_id]
2065
 
            except KeyError:
2066
 
                unescaped = unescape(revision_id)
2067
 
                unescape_revid_cache[revision_id] = unescaped
2068
 
                revision_id = unescaped
2069
 
 
2070
 
            # Note that unconditionally unescaping means that we deserialise
2071
 
            # every fileid, which for general 'pull' is not great, but we don't
2072
 
            # really want to have some many fulltexts that this matters anyway.
2073
 
            # RBC 20071114.
2074
 
            try:
2075
 
                file_id = unescape_fileid_cache[file_id]
2076
 
            except KeyError:
2077
 
                unescaped = unescape(file_id)
2078
 
                unescape_fileid_cache[file_id] = unescaped
2079
 
                file_id = unescaped
2080
 
 
2081
 
            key = (file_id, revision_id)
2082
 
            setdefault(key, False)
2083
 
            if revision_id == line_key[-1]:
2084
 
                result[key] = True
2085
 
        return result
2086
 
 
2087
 
    def _inventory_xml_lines_for_keys(self, keys):
2088
 
        """Get a line iterator of the sort needed for findind references.
2089
 
 
2090
 
        Not relevant for non-xml inventory repositories.
2091
 
 
2092
 
        Ghosts in revision_keys are ignored.
2093
 
 
2094
 
        :param revision_keys: The revision keys for the inventories to inspect.
2095
 
        :return: An iterator over (inventory line, revid) for the fulltexts of
2096
 
            all of the xml inventories specified by revision_keys.
2097
 
        """
2098
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2099
 
        for record in stream:
2100
 
            if record.storage_kind != 'absent':
2101
 
                chunks = record.get_bytes_as('chunked')
2102
 
                revid = record.key[-1]
2103
 
                lines = osutils.chunks_to_lines(chunks)
2104
 
                for line in lines:
2105
 
                    yield line, revid
2106
 
 
2107
 
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2108
 
        revision_keys):
2109
 
        """Helper routine for fileids_altered_by_revision_ids.
2110
 
 
2111
 
        This performs the translation of xml lines to revision ids.
2112
 
 
2113
 
        :param line_iterator: An iterator of lines, origin_version_id
2114
 
        :param revision_keys: The revision ids to filter for. This should be a
2115
 
            set or other type which supports efficient __contains__ lookups, as
2116
 
            the revision key from each parsed line will be looked up in the
2117
 
            revision_keys filter.
2118
 
        :return: a dictionary mapping altered file-ids to an iterable of
2119
 
        revision_ids. Each altered file-ids has the exact revision_ids that
2120
 
        altered it listed explicitly.
2121
 
        """
2122
 
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2123
 
                line_iterator).iterkeys())
2124
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2125
 
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2126
 
            self._inventory_xml_lines_for_keys(parent_keys)))
2127
 
        new_keys = seen - parent_seen
2128
 
        result = {}
2129
 
        setdefault = result.setdefault
2130
 
        for key in new_keys:
2131
 
            setdefault(key[0], set()).add(key[-1])
2132
 
        return result
2133
 
 
2134
 
    def _find_parent_ids_of_revisions(self, revision_ids):
2135
 
        """Find all parent ids that are mentioned in the revision graph.
2136
 
 
2137
 
        :return: set of revisions that are parents of revision_ids which are
2138
 
            not part of revision_ids themselves
2139
 
        """
2140
 
        parent_map = self.get_parent_map(revision_ids)
2141
 
        parent_ids = set()
2142
 
        map(parent_ids.update, parent_map.itervalues())
2143
 
        parent_ids.difference_update(revision_ids)
2144
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
2145
 
        return parent_ids
2146
 
 
2147
 
    def _find_parent_keys_of_revisions(self, revision_keys):
2148
 
        """Similar to _find_parent_ids_of_revisions, but used with keys.
2149
 
 
2150
 
        :param revision_keys: An iterable of revision_keys.
2151
 
        :return: The parents of all revision_keys that are not already in
2152
 
            revision_keys
2153
 
        """
2154
 
        parent_map = self.revisions.get_parent_map(revision_keys)
2155
 
        parent_keys = set()
2156
 
        map(parent_keys.update, parent_map.itervalues())
2157
 
        parent_keys.difference_update(revision_keys)
2158
 
        parent_keys.discard(_mod_revision.NULL_REVISION)
2159
 
        return parent_keys
2160
 
 
2161
 
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2162
 
        """Find the file ids and versions affected by revisions.
2163
 
 
2164
 
        :param revisions: an iterable containing revision ids.
2165
 
        :param _inv_weave: The inventory weave from this repository or None.
2166
 
            If None, the inventory weave will be opened automatically.
2167
 
        :return: a dictionary mapping altered file-ids to an iterable of
2168
 
        revision_ids. Each altered file-ids has the exact revision_ids that
2169
 
        altered it listed explicitly.
2170
 
        """
2171
 
        selected_keys = set((revid,) for revid in revision_ids)
2172
 
        w = _inv_weave or self.inventories
2173
 
        return self._find_file_ids_from_xml_inventory_lines(
2174
 
            w.iter_lines_added_or_present_in_keys(
2175
 
                selected_keys, pb=None),
2176
 
            selected_keys)
2177
 
 
2178
 
    def iter_files_bytes(self, desired_files):
2179
 
        """Iterate through file versions.
2180
 
 
2181
 
        Files will not necessarily be returned in the order they occur in
2182
 
        desired_files.  No specific order is guaranteed.
2183
 
 
2184
 
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
2185
 
        value supplied by the caller as part of desired_files.  It should
2186
 
        uniquely identify the file version in the caller's context.  (Examples:
2187
 
        an index number or a TreeTransform trans_id.)
2188
 
 
2189
 
        bytes_iterator is an iterable of bytestrings for the file.  The
2190
 
        kind of iterable and length of the bytestrings are unspecified, but for
2191
 
        this implementation, it is a list of bytes produced by
2192
 
        VersionedFile.get_record_stream().
2193
 
 
2194
 
        :param desired_files: a list of (file_id, revision_id, identifier)
2195
 
            triples
2196
 
        """
2197
 
        text_keys = {}
2198
 
        for file_id, revision_id, callable_data in desired_files:
2199
 
            text_keys[(file_id, revision_id)] = callable_data
2200
 
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2201
 
            if record.storage_kind == 'absent':
2202
 
                raise errors.RevisionNotPresent(record.key, self)
2203
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
2204
 
 
2205
 
    def _generate_text_key_index(self, text_key_references=None,
2206
 
        ancestors=None):
2207
 
        """Generate a new text key index for the repository.
2208
 
 
2209
 
        This is an expensive function that will take considerable time to run.
2210
 
 
2211
 
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
2212
 
            list of parents, also text keys. When a given key has no parents,
2213
 
            the parents list will be [NULL_REVISION].
2214
 
        """
2215
 
        # All revisions, to find inventory parents.
2216
 
        if ancestors is None:
2217
 
            graph = self.get_graph()
2218
 
            ancestors = graph.get_parent_map(self.all_revision_ids())
2219
 
        if text_key_references is None:
2220
 
            text_key_references = self.find_text_key_references()
2221
 
        pb = ui.ui_factory.nested_progress_bar()
2222
 
        try:
2223
 
            return self._do_generate_text_key_index(ancestors,
2224
 
                text_key_references, pb)
2225
 
        finally:
2226
 
            pb.finished()
2227
 
 
2228
 
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
2229
 
        """Helper for _generate_text_key_index to avoid deep nesting."""
2230
 
        revision_order = tsort.topo_sort(ancestors)
2231
 
        invalid_keys = set()
2232
 
        revision_keys = {}
2233
 
        for revision_id in revision_order:
2234
 
            revision_keys[revision_id] = set()
2235
 
        text_count = len(text_key_references)
2236
 
        # a cache of the text keys to allow reuse; costs a dict of all the
2237
 
        # keys, but saves a 2-tuple for every child of a given key.
2238
 
        text_key_cache = {}
2239
 
        for text_key, valid in text_key_references.iteritems():
2240
 
            if not valid:
2241
 
                invalid_keys.add(text_key)
2242
 
            else:
2243
 
                revision_keys[text_key[1]].add(text_key)
2244
 
            text_key_cache[text_key] = text_key
2245
 
        del text_key_references
2246
 
        text_index = {}
2247
 
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
2248
 
        NULL_REVISION = _mod_revision.NULL_REVISION
2249
 
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
2250
 
        # too small for large or very branchy trees. However, for 55K path
2251
 
        # trees, it would be easy to use too much memory trivially. Ideally we
2252
 
        # could gauge this by looking at available real memory etc, but this is
2253
 
        # always a tricky proposition.
2254
 
        inventory_cache = lru_cache.LRUCache(10)
2255
 
        batch_size = 10 # should be ~150MB on a 55K path tree
2256
 
        batch_count = len(revision_order) / batch_size + 1
2257
 
        processed_texts = 0
2258
 
        pb.update("Calculating text parents", processed_texts, text_count)
2259
 
        for offset in xrange(batch_count):
2260
 
            to_query = revision_order[offset * batch_size:(offset + 1) *
2261
 
                batch_size]
2262
 
            if not to_query:
2263
 
                break
2264
 
            for revision_id in to_query:
2265
 
                parent_ids = ancestors[revision_id]
2266
 
                for text_key in revision_keys[revision_id]:
2267
 
                    pb.update("Calculating text parents", processed_texts)
2268
 
                    processed_texts += 1
2269
 
                    candidate_parents = []
2270
 
                    for parent_id in parent_ids:
2271
 
                        parent_text_key = (text_key[0], parent_id)
2272
 
                        try:
2273
 
                            check_parent = parent_text_key not in \
2274
 
                                revision_keys[parent_id]
2275
 
                        except KeyError:
2276
 
                            # the parent parent_id is a ghost:
2277
 
                            check_parent = False
2278
 
                            # truncate the derived graph against this ghost.
2279
 
                            parent_text_key = None
2280
 
                        if check_parent:
2281
 
                            # look at the parent commit details inventories to
2282
 
                            # determine possible candidates in the per file graph.
2283
 
                            # TODO: cache here.
2284
 
                            try:
2285
 
                                inv = inventory_cache[parent_id]
2286
 
                            except KeyError:
2287
 
                                inv = self.revision_tree(parent_id).inventory
2288
 
                                inventory_cache[parent_id] = inv
2289
 
                            try:
2290
 
                                parent_entry = inv[text_key[0]]
2291
 
                            except (KeyError, errors.NoSuchId):
2292
 
                                parent_entry = None
2293
 
                            if parent_entry is not None:
2294
 
                                parent_text_key = (
2295
 
                                    text_key[0], parent_entry.revision)
2296
 
                            else:
2297
 
                                parent_text_key = None
2298
 
                        if parent_text_key is not None:
2299
 
                            candidate_parents.append(
2300
 
                                text_key_cache[parent_text_key])
2301
 
                    parent_heads = text_graph.heads(candidate_parents)
2302
 
                    new_parents = list(parent_heads)
2303
 
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
2304
 
                    if new_parents == []:
2305
 
                        new_parents = [NULL_REVISION]
2306
 
                    text_index[text_key] = new_parents
2307
 
 
2308
 
        for text_key in invalid_keys:
2309
 
            text_index[text_key] = [NULL_REVISION]
2310
 
        return text_index
2311
 
 
2312
 
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2313
 
        """Get an iterable listing the keys of all the data introduced by a set
2314
 
        of revision IDs.
2315
 
 
2316
 
        The keys will be ordered so that the corresponding items can be safely
2317
 
        fetched and inserted in that order.
2318
 
 
2319
 
        :returns: An iterable producing tuples of (knit-kind, file-id,
2320
 
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2321
 
            'revisions'.  file-id is None unless knit-kind is 'file'.
2322
 
        """
2323
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2324
 
            yield result
2325
 
        del _files_pb
2326
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2327
 
            yield result
2328
 
 
2329
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2330
 
        # XXX: it's a bit weird to control the inventory weave caching in this
2331
 
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2332
 
        # maybe this generator should explicitly have the contract that it
2333
 
        # should not be iterated until the previously yielded item has been
2334
 
        # processed?
2335
 
        inv_w = self.inventories
2336
 
 
2337
 
        # file ids that changed
2338
 
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
2339
 
        count = 0
2340
 
        num_file_ids = len(file_ids)
2341
 
        for file_id, altered_versions in file_ids.iteritems():
2342
 
            if pb is not None:
2343
 
                pb.update("Fetch texts", count, num_file_ids)
2344
 
            count += 1
2345
 
            yield ("file", file_id, altered_versions)
2346
 
 
2347
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2348
 
        # inventory
2349
 
        yield ("inventory", None, revision_ids)
2350
 
 
2351
 
        # signatures
2352
 
        # XXX: Note ATM no callers actually pay attention to this return
2353
 
        #      instead they just use the list of revision ids and ignore
2354
 
        #      missing sigs. Consider removing this work entirely
2355
 
        revisions_with_signatures = set(self.signatures.get_parent_map(
2356
 
            [(r,) for r in revision_ids]))
2357
 
        revisions_with_signatures = set(
2358
 
            [r for (r,) in revisions_with_signatures])
2359
 
        revisions_with_signatures.intersection_update(revision_ids)
2360
 
        yield ("signatures", None, revisions_with_signatures)
2361
 
 
2362
 
        # revisions
2363
 
        yield ("revisions", None, revision_ids)
 
414
        for line in w.iter_lines_added_or_present_in_versions(selected_revision_ids):
 
415
            start = line.find('file_id="')+9
 
416
            if start < 9: continue
 
417
            end = line.find('"', start)
 
418
            assert end>= 0
 
419
            file_id = _unescape_xml(line[start:end])
 
420
 
 
421
            start = line.find('revision="')+10
 
422
            if start < 10: continue
 
423
            end = line.find('"', start)
 
424
            assert end>= 0
 
425
            revision_id = _unescape_xml(line[start:end])
 
426
            if revision_id in selected_revision_ids:
 
427
                result.setdefault(file_id, set()).add(revision_id)
 
428
        return result
 
429
 
 
430
    @needs_read_lock
 
431
    def get_inventory_weave(self):
 
432
        return self.control_weaves.get_weave('inventory',
 
433
            self.get_transaction())
2364
434
 
2365
435
    @needs_read_lock
2366
436
    def get_inventory(self, revision_id):
2367
 
        """Get Inventory object by revision id."""
2368
 
        return self.iter_inventories([revision_id]).next()
2369
 
 
2370
 
    def iter_inventories(self, revision_ids, ordering=None):
2371
 
        """Get many inventories by revision_ids.
2372
 
 
2373
 
        This will buffer some or all of the texts used in constructing the
2374
 
        inventories in memory, but will only parse a single inventory at a
2375
 
        time.
2376
 
 
2377
 
        :param revision_ids: The expected revision ids of the inventories.
2378
 
        :param ordering: optional ordering, e.g. 'topological'.  If not
2379
 
            specified, the order of revision_ids will be preserved (by
2380
 
            buffering if necessary).
2381
 
        :return: An iterator of inventories.
2382
 
        """
2383
 
        if ((None in revision_ids)
2384
 
            or (_mod_revision.NULL_REVISION in revision_ids)):
2385
 
            raise ValueError('cannot get null revision inventory')
2386
 
        return self._iter_inventories(revision_ids, ordering)
2387
 
 
2388
 
    def _iter_inventories(self, revision_ids, ordering):
2389
 
        """single-document based inventory iteration."""
2390
 
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2391
 
        for text, revision_id in inv_xmls:
2392
 
            yield self._deserialise_inventory(revision_id, text)
2393
 
 
2394
 
    def _iter_inventory_xmls(self, revision_ids, ordering):
2395
 
        if ordering is None:
2396
 
            order_as_requested = True
2397
 
            ordering = 'unordered'
2398
 
        else:
2399
 
            order_as_requested = False
2400
 
        keys = [(revision_id,) for revision_id in revision_ids]
2401
 
        if not keys:
2402
 
            return
2403
 
        if order_as_requested:
2404
 
            key_iter = iter(keys)
2405
 
            next_key = key_iter.next()
2406
 
        stream = self.inventories.get_record_stream(keys, ordering, True)
2407
 
        text_chunks = {}
2408
 
        for record in stream:
2409
 
            if record.storage_kind != 'absent':
2410
 
                chunks = record.get_bytes_as('chunked')
2411
 
                if order_as_requested:
2412
 
                    text_chunks[record.key] = chunks
2413
 
                else:
2414
 
                    yield ''.join(chunks), record.key[-1]
2415
 
            else:
2416
 
                raise errors.NoSuchRevision(self, record.key)
2417
 
            if order_as_requested:
2418
 
                # Yield as many results as we can while preserving order.
2419
 
                while next_key in text_chunks:
2420
 
                    chunks = text_chunks.pop(next_key)
2421
 
                    yield ''.join(chunks), next_key[-1]
2422
 
                    try:
2423
 
                        next_key = key_iter.next()
2424
 
                    except StopIteration:
2425
 
                        # We still want to fully consume the get_record_stream,
2426
 
                        # just in case it is not actually finished at this point
2427
 
                        next_key = None
2428
 
                        break
2429
 
 
2430
 
    def _deserialise_inventory(self, revision_id, xml):
2431
 
        """Transform the xml into an inventory object.
 
437
        """Get Inventory object by hash."""
 
438
        return self.deserialise_inventory(
 
439
            revision_id, self.get_inventory_xml(revision_id))
 
440
 
 
441
    def deserialise_inventory(self, revision_id, xml):
 
442
        """Transform the xml into an inventory object. 
2432
443
 
2433
444
        :param revision_id: The expected revision id of the inventory.
2434
445
        :param xml: A serialised inventory.
2435
446
        """
2436
 
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2437
 
                    entry_cache=self._inventory_entry_cache,
2438
 
                    return_from_cache=self._safe_to_return_from_cache)
2439
 
        if result.revision_id != revision_id:
2440
 
            raise AssertionError('revision id mismatch %s != %s' % (
2441
 
                result.revision_id, revision_id))
2442
 
        return result
2443
 
 
2444
 
    def get_serializer_format(self):
2445
 
        return self._serializer.format_num
 
447
        return xml5.serializer_v5.read_inventory_from_string(xml)
2446
448
 
2447
449
    @needs_read_lock
2448
 
    def _get_inventory_xml(self, revision_id):
2449
 
        """Get serialized inventory as a string."""
2450
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
450
    def get_inventory_xml(self, revision_id):
 
451
        """Get inventory XML as a file object."""
2451
452
        try:
2452
 
            text, revision_id = texts.next()
2453
 
        except StopIteration:
 
453
            assert isinstance(revision_id, basestring), type(revision_id)
 
454
            iw = self.get_inventory_weave()
 
455
            return iw.get_text(revision_id)
 
456
        except IndexError:
2454
457
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2455
 
        return text
2456
 
 
2457
 
    def get_rev_id_for_revno(self, revno, known_pair):
2458
 
        """Return the revision id of a revno, given a later (revno, revid)
2459
 
        pair in the same history.
2460
 
 
2461
 
        :return: if found (True, revid).  If the available history ran out
2462
 
            before reaching the revno, then this returns
2463
 
            (False, (closest_revno, closest_revid)).
2464
 
        """
2465
 
        known_revno, known_revid = known_pair
2466
 
        partial_history = [known_revid]
2467
 
        distance_from_known = known_revno - revno
2468
 
        if distance_from_known < 0:
2469
 
            raise ValueError(
2470
 
                'requested revno (%d) is later than given known revno (%d)'
2471
 
                % (revno, known_revno))
2472
 
        try:
2473
 
            _iter_for_revno(
2474
 
                self, partial_history, stop_index=distance_from_known)
2475
 
        except errors.RevisionNotPresent, err:
2476
 
            if err.revision_id == known_revid:
2477
 
                # The start revision (known_revid) wasn't found.
2478
 
                raise
2479
 
            # This is a stacked repository with no fallbacks, or a there's a
2480
 
            # left-hand ghost.  Either way, even though the revision named in
2481
 
            # the error isn't in this repo, we know it's the next step in this
2482
 
            # left-hand history.
2483
 
            partial_history.append(err.revision_id)
2484
 
        if len(partial_history) <= distance_from_known:
2485
 
            # Didn't find enough history to get a revid for the revno.
2486
 
            earliest_revno = known_revno - len(partial_history) + 1
2487
 
            return (False, (earliest_revno, partial_history[-1]))
2488
 
        if len(partial_history) - 1 > distance_from_known:
2489
 
            raise AssertionError('_iter_for_revno returned too much history')
2490
 
        return (True, partial_history[-1])
2491
 
 
2492
 
    def iter_reverse_revision_history(self, revision_id):
2493
 
        """Iterate backwards through revision ids in the lefthand history
2494
 
 
2495
 
        :param revision_id: The revision id to start with.  All its lefthand
2496
 
            ancestors will be traversed.
2497
 
        """
2498
 
        graph = self.get_graph()
2499
 
        next_id = revision_id
2500
 
        while True:
2501
 
            if next_id in (None, _mod_revision.NULL_REVISION):
2502
 
                return
 
458
 
 
459
    @needs_read_lock
 
460
    def get_inventory_sha1(self, revision_id):
 
461
        """Return the sha1 hash of the inventory entry
 
462
        """
 
463
        return self.get_revision(revision_id).inventory_sha1
 
464
 
 
465
    @needs_read_lock
 
466
    def get_revision_graph(self, revision_id=None):
 
467
        """Return a dictionary containing the revision graph.
 
468
        
 
469
        :param revision_id: The revision_id to get a graph from. If None, then
 
470
        the entire revision graph is returned. This is a deprecated mode of
 
471
        operation and will be removed in the future.
 
472
        :return: a dictionary of revision_id->revision_parents_list.
 
473
        """
 
474
        # special case NULL_REVISION
 
475
        if revision_id == NULL_REVISION:
 
476
            return {}
 
477
        weave = self.get_inventory_weave()
 
478
        all_revisions = self._eliminate_revisions_not_present(weave.versions())
 
479
        entire_graph = dict([(node, weave.get_parents(node)) for 
 
480
                             node in all_revisions])
 
481
        if revision_id is None:
 
482
            return entire_graph
 
483
        elif revision_id not in entire_graph:
 
484
            raise errors.NoSuchRevision(self, revision_id)
 
485
        else:
 
486
            # add what can be reached from revision_id
 
487
            result = {}
 
488
            pending = set([revision_id])
 
489
            while len(pending) > 0:
 
490
                node = pending.pop()
 
491
                result[node] = entire_graph[node]
 
492
                for revision_id in result[node]:
 
493
                    if revision_id not in result:
 
494
                        pending.add(revision_id)
 
495
            return result
 
496
 
 
497
    @needs_read_lock
 
498
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
499
        """Return a graph of the revisions with ghosts marked as applicable.
 
500
 
 
501
        :param revision_ids: an iterable of revisions to graph or None for all.
 
502
        :return: a Graph object with the graph reachable from revision_ids.
 
503
        """
 
504
        result = Graph()
 
505
        if not revision_ids:
 
506
            pending = set(self.all_revision_ids())
 
507
            required = set([])
 
508
        else:
 
509
            pending = set(revision_ids)
 
510
            # special case NULL_REVISION
 
511
            if NULL_REVISION in pending:
 
512
                pending.remove(NULL_REVISION)
 
513
            required = set(pending)
 
514
        done = set([])
 
515
        while len(pending):
 
516
            revision_id = pending.pop()
2503
517
            try:
2504
 
                parents = graph.get_parent_map([next_id])[next_id]
2505
 
            except KeyError:
2506
 
                raise errors.RevisionNotPresent(next_id, self)
2507
 
            yield next_id
2508
 
            if len(parents) == 0:
2509
 
                return
2510
 
            else:
2511
 
                next_id = parents[0]
2512
 
 
 
518
                rev = self.get_revision(revision_id)
 
519
            except errors.NoSuchRevision:
 
520
                if revision_id in required:
 
521
                    raise
 
522
                # a ghost
 
523
                result.add_ghost(revision_id)
 
524
                continue
 
525
            for parent_id in rev.parent_ids:
 
526
                # is this queued or done ?
 
527
                if (parent_id not in pending and
 
528
                    parent_id not in done):
 
529
                    # no, queue it.
 
530
                    pending.add(parent_id)
 
531
            result.add_node(revision_id, rev.parent_ids)
 
532
            done.add(revision_id)
 
533
        return result
 
534
 
 
535
    @needs_read_lock
 
536
    def get_revision_inventory(self, revision_id):
 
537
        """Return inventory of a past revision."""
 
538
        # TODO: Unify this with get_inventory()
 
539
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
540
        # must be the same as its revision, so this is trivial.
 
541
        if revision_id is None:
 
542
            # This does not make sense: if there is no revision,
 
543
            # then it is the current tree inventory surely ?!
 
544
            # and thus get_root_id() is something that looks at the last
 
545
            # commit on the branch, and the get_root_id is an inventory check.
 
546
            raise NotImplementedError
 
547
            # return Inventory(self.get_root_id())
 
548
        else:
 
549
            return self.get_inventory(revision_id)
 
550
 
 
551
    @needs_read_lock
2513
552
    def is_shared(self):
2514
553
        """Return True if this repository is flagged as a shared repository."""
2515
554
        raise NotImplementedError(self.is_shared)
2521
560
        reconciler = RepoReconciler(self, thorough=thorough)
2522
561
        reconciler.reconcile()
2523
562
        return reconciler
2524
 
 
2525
 
    def _refresh_data(self):
2526
 
        """Helper called from lock_* to ensure coherency with disk.
2527
 
 
2528
 
        The default implementation does nothing; it is however possible
2529
 
        for repositories to maintain loaded indices across multiple locks
2530
 
        by checking inside their implementation of this method to see
2531
 
        whether their indices are still valid. This depends of course on
2532
 
        the disk format being validatable in this manner. This method is
2533
 
        also called by the refresh_data() public interface to cause a refresh
2534
 
        to occur while in a write lock so that data inserted by a smart server
2535
 
        push operation is visible on the client's instance of the physical
2536
 
        repository.
2537
 
        """
2538
 
 
 
563
    
2539
564
    @needs_read_lock
2540
565
    def revision_tree(self, revision_id):
2541
566
        """Return Tree for a revision on this branch.
2542
567
 
2543
 
        `revision_id` may be NULL_REVISION for the empty tree revision.
2544
 
        """
2545
 
        revision_id = _mod_revision.ensure_null(revision_id)
 
568
        `revision_id` may be None for the null revision, in which case
 
569
        an `EmptyTree` is returned."""
2546
570
        # TODO: refactor this to use an existing revision object
2547
571
        # so we don't need to read it in twice.
2548
 
        if revision_id == _mod_revision.NULL_REVISION:
2549
 
            return RevisionTree(self, Inventory(root_id=None),
2550
 
                                _mod_revision.NULL_REVISION)
 
572
        if revision_id is None or revision_id == NULL_REVISION:
 
573
            return EmptyTree()
2551
574
        else:
2552
 
            inv = self.get_inventory(revision_id)
 
575
            inv = self.get_revision_inventory(revision_id)
2553
576
            return RevisionTree(self, inv, revision_id)
2554
577
 
 
578
    @needs_read_lock
2555
579
    def revision_trees(self, revision_ids):
2556
 
        """Return Trees for revisions in this repository.
2557
 
 
2558
 
        :param revision_ids: a sequence of revision-ids;
2559
 
          a revision-id may not be None or 'null:'
2560
 
        """
2561
 
        inventories = self.iter_inventories(revision_ids)
2562
 
        for inv in inventories:
2563
 
            yield RevisionTree(self, inv, inv.revision_id)
2564
 
 
2565
 
    def _filtered_revision_trees(self, revision_ids, file_ids):
2566
 
        """Return Tree for a revision on this branch with only some files.
2567
 
 
2568
 
        :param revision_ids: a sequence of revision-ids;
2569
 
          a revision-id may not be None or 'null:'
2570
 
        :param file_ids: if not None, the result is filtered
2571
 
          so that only those file-ids, their parents and their
2572
 
          children are included.
2573
 
        """
2574
 
        inventories = self.iter_inventories(revision_ids)
2575
 
        for inv in inventories:
2576
 
            # Should we introduce a FilteredRevisionTree class rather
2577
 
            # than pre-filter the inventory here?
2578
 
            filtered_inv = inv.filter(file_ids)
2579
 
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
580
        """Return Tree for a revision on this branch.
 
581
 
 
582
        `revision_id` may not be None or 'null:'"""
 
583
        assert None not in revision_ids
 
584
        assert NULL_REVISION not in revision_ids
 
585
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
586
        for text, revision_id in zip(texts, revision_ids):
 
587
            inv = self.deserialise_inventory(revision_id, text)
 
588
            yield RevisionTree(self, inv, revision_id)
2580
589
 
2581
590
    @needs_read_lock
2582
 
    def get_ancestry(self, revision_id, topo_sorted=True):
 
591
    def get_ancestry(self, revision_id):
2583
592
        """Return a list of revision-ids integrated by a revision.
2584
593
 
2585
 
        The first element of the list is always None, indicating the origin
2586
 
        revision.  This might change when we have history horizons, or
 
594
        The first element of the list is always None, indicating the origin 
 
595
        revision.  This might change when we have history horizons, or 
2587
596
        perhaps we should have a new API.
2588
 
 
 
597
        
2589
598
        This is topologically sorted.
2590
599
        """
2591
 
        if _mod_revision.is_null(revision_id):
 
600
        if revision_id is None:
2592
601
            return [None]
2593
602
        if not self.has_revision(revision_id):
2594
603
            raise errors.NoSuchRevision(self, revision_id)
2595
 
        graph = self.get_graph()
2596
 
        keys = set()
2597
 
        search = graph._make_breadth_first_searcher([revision_id])
2598
 
        while True:
2599
 
            try:
2600
 
                found, ghosts = search.next_with_ghosts()
2601
 
            except StopIteration:
2602
 
                break
2603
 
            keys.update(found)
2604
 
        if _mod_revision.NULL_REVISION in keys:
2605
 
            keys.remove(_mod_revision.NULL_REVISION)
2606
 
        if topo_sorted:
2607
 
            parent_map = graph.get_parent_map(keys)
2608
 
            keys = tsort.topo_sort(parent_map)
2609
 
        return [None] + list(keys)
2610
 
 
2611
 
    def pack(self, hint=None, clean_obsolete_packs=False):
2612
 
        """Compress the data within the repository.
2613
 
 
2614
 
        This operation only makes sense for some repository types. For other
2615
 
        types it should be a no-op that just returns.
2616
 
 
2617
 
        This stub method does not require a lock, but subclasses should use
2618
 
        @needs_write_lock as this is a long running call its reasonable to
2619
 
        implicitly lock for the user.
2620
 
 
2621
 
        :param hint: If not supplied, the whole repository is packed.
2622
 
            If supplied, the repository may use the hint parameter as a
2623
 
            hint for the parts of the repository to pack. A hint can be
2624
 
            obtained from the result of commit_write_group(). Out of
2625
 
            date hints are simply ignored, because concurrent operations
2626
 
            can obsolete them rapidly.
2627
 
 
2628
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2629
 
            the pack operation.
 
604
        w = self.get_inventory_weave()
 
605
        candidates = w.get_ancestry(revision_id)
 
606
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
607
 
 
608
    @needs_read_lock
 
609
    def print_file(self, file, revision_id):
 
610
        """Print `file` to stdout.
 
611
        
 
612
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
613
        - it writes to stdout, it assumes that that is valid etc. Fix
 
614
        by creating a new more flexible convenience function.
2630
615
        """
 
616
        tree = self.revision_tree(revision_id)
 
617
        # use inventory as it was in that revision
 
618
        file_id = tree.inventory.path2id(file)
 
619
        if not file_id:
 
620
            # TODO: jam 20060427 Write a test for this code path
 
621
            #       it had a bug in it, and was raising the wrong
 
622
            #       exception.
 
623
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
624
        tree.print_file(file_id)
2631
625
 
2632
626
    def get_transaction(self):
2633
627
        return self.control_files.get_transaction()
2634
628
 
2635
 
    def get_parent_map(self, revision_ids):
2636
 
        """See graph.StackedParentsProvider.get_parent_map"""
2637
 
        # revisions index works in keys; this just works in revisions
2638
 
        # therefore wrap and unwrap
2639
 
        query_keys = []
2640
 
        result = {}
2641
 
        for revision_id in revision_ids:
2642
 
            if revision_id == _mod_revision.NULL_REVISION:
2643
 
                result[revision_id] = ()
2644
 
            elif revision_id is None:
2645
 
                raise ValueError('get_parent_map(None) is not valid')
2646
 
            else:
2647
 
                query_keys.append((revision_id ,))
2648
 
        for ((revision_id,), parent_keys) in \
2649
 
                self.revisions.get_parent_map(query_keys).iteritems():
2650
 
            if parent_keys:
2651
 
                result[revision_id] = tuple([parent_revid
2652
 
                    for (parent_revid,) in parent_keys])
2653
 
            else:
2654
 
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2655
 
        return result
2656
 
 
2657
 
    def _make_parents_provider(self):
2658
 
        return self
2659
 
 
2660
 
    @needs_read_lock
2661
 
    def get_known_graph_ancestry(self, revision_ids):
2662
 
        """Return the known graph for a set of revision ids and their ancestors.
2663
 
        """
2664
 
        st = static_tuple.StaticTuple
2665
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2666
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2667
 
        return graph.GraphThunkIdsToKeys(known_graph)
2668
 
 
2669
 
    def get_graph(self, other_repository=None):
2670
 
        """Return the graph walker for this repository format"""
2671
 
        parents_provider = self._make_parents_provider()
2672
 
        if (other_repository is not None and
2673
 
            not self.has_same_location(other_repository)):
2674
 
            parents_provider = graph.StackedParentsProvider(
2675
 
                [parents_provider, other_repository._make_parents_provider()])
2676
 
        return graph.Graph(parents_provider)
2677
 
 
2678
 
    def _get_versioned_file_checker(self, text_key_references=None,
2679
 
        ancestors=None):
2680
 
        """Return an object suitable for checking versioned files.
2681
 
        
2682
 
        :param text_key_references: if non-None, an already built
2683
 
            dictionary mapping text keys ((fileid, revision_id) tuples)
2684
 
            to whether they were referred to by the inventory of the
2685
 
            revision_id that they contain. If None, this will be
2686
 
            calculated.
2687
 
        :param ancestors: Optional result from
2688
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2689
 
            available.
2690
 
        """
2691
 
        return _VersionedFileChecker(self,
2692
 
            text_key_references=text_key_references, ancestors=ancestors)
2693
 
 
2694
 
    def revision_ids_to_search_result(self, result_set):
2695
 
        """Convert a set of revision ids to a graph SearchResult."""
2696
 
        result_parents = set()
2697
 
        for parents in self.get_graph().get_parent_map(
2698
 
            result_set).itervalues():
2699
 
            result_parents.update(parents)
2700
 
        included_keys = result_set.intersection(result_parents)
2701
 
        start_keys = result_set.difference(included_keys)
2702
 
        exclude_keys = result_parents.difference(result_set)
2703
 
        result = graph.SearchResult(start_keys, exclude_keys,
2704
 
            len(result_set), result_set)
2705
 
        return result
 
629
    def revision_parents(self, revid):
 
630
        return self.get_inventory_weave().parent_names(revid)
2706
631
 
2707
632
    @needs_write_lock
2708
633
    def set_make_working_trees(self, new_value):
2715
640
                          working trees.
2716
641
        """
2717
642
        raise NotImplementedError(self.set_make_working_trees)
2718
 
 
 
643
    
2719
644
    def make_working_trees(self):
2720
645
        """Returns the policy for making working trees on new branches."""
2721
646
        raise NotImplementedError(self.make_working_trees)
2728
653
    @needs_read_lock
2729
654
    def has_signature_for_revision_id(self, revision_id):
2730
655
        """Query for a revision signature for revision_id in the repository."""
2731
 
        if not self.has_revision(revision_id):
2732
 
            raise errors.NoSuchRevision(self, revision_id)
2733
 
        sig_present = (1 == len(
2734
 
            self.signatures.get_parent_map([(revision_id,)])))
2735
 
        return sig_present
 
656
        return self._revision_store.has_signature(revision_id,
 
657
                                                  self.get_transaction())
2736
658
 
2737
659
    @needs_read_lock
2738
660
    def get_signature_text(self, revision_id):
2739
661
        """Return the text for a signature."""
2740
 
        stream = self.signatures.get_record_stream([(revision_id,)],
2741
 
            'unordered', True)
2742
 
        record = stream.next()
2743
 
        if record.storage_kind == 'absent':
2744
 
            raise errors.NoSuchRevision(self, revision_id)
2745
 
        return record.get_bytes_as('fulltext')
 
662
        return self._revision_store.get_signature_text(revision_id,
 
663
                                                       self.get_transaction())
2746
664
 
2747
665
    @needs_read_lock
2748
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
666
    def check(self, revision_ids):
2749
667
        """Check consistency of all history of given revision_ids.
2750
668
 
2751
669
        Different repository implementations should override _check().
2752
670
 
2753
671
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2754
672
             will be checked.  Typically the last revision_id of a branch.
2755
 
        :param callback_refs: A dict of check-refs to resolve and callback
2756
 
            the check/_check method on the items listed as wanting the ref.
2757
 
            see bzrlib.check.
2758
 
        :param check_repo: If False do not check the repository contents, just 
2759
 
            calculate the data callback_refs requires and call them back.
2760
673
        """
2761
 
        return self._check(revision_ids, callback_refs=callback_refs,
2762
 
            check_repo=check_repo)
 
674
        if not revision_ids:
 
675
            raise ValueError("revision_ids must be non-empty in %s.check" 
 
676
                    % (self,))
 
677
        return self._check(revision_ids)
2763
678
 
2764
 
    def _check(self, revision_ids, callback_refs, check_repo):
2765
 
        result = check.Check(self, check_repo=check_repo)
2766
 
        result.check(callback_refs)
 
679
    def _check(self, revision_ids):
 
680
        result = check.Check(self)
 
681
        result.check()
2767
682
        return result
2768
683
 
2769
 
    def _warn_if_deprecated(self, branch=None):
2770
 
        global _deprecation_warning_done
2771
 
        if _deprecation_warning_done:
2772
 
            return
2773
 
        try:
2774
 
            if branch is None:
2775
 
                conf = config.GlobalConfig()
2776
 
            else:
2777
 
                conf = branch.get_config()
2778
 
            if conf.suppress_warning('format_deprecation'):
2779
 
                return
2780
 
            warning("Format %s for %s is deprecated -"
2781
 
                    " please use 'bzr upgrade' to get better performance"
2782
 
                    % (self._format, self.bzrdir.transport.base))
2783
 
        finally:
2784
 
            _deprecation_warning_done = True
2785
 
 
2786
 
    def supports_rich_root(self):
2787
 
        return self._format.rich_root_data
2788
 
 
2789
 
    def _check_ascii_revisionid(self, revision_id, method):
2790
 
        """Private helper for ascii-only repositories."""
2791
 
        # weave repositories refuse to store revisionids that are non-ascii.
2792
 
        if revision_id is not None:
2793
 
            # weaves require ascii revision ids.
2794
 
            if isinstance(revision_id, unicode):
2795
 
                try:
2796
 
                    revision_id.encode('ascii')
2797
 
                except UnicodeEncodeError:
2798
 
                    raise errors.NonAsciiRevisionId(method, self)
2799
 
            else:
2800
 
                try:
2801
 
                    revision_id.decode('ascii')
2802
 
                except UnicodeDecodeError:
2803
 
                    raise errors.NonAsciiRevisionId(method, self)
2804
 
 
2805
 
    def revision_graph_can_have_wrong_parents(self):
2806
 
        """Is it possible for this repository to have a revision graph with
2807
 
        incorrect parents?
2808
 
 
2809
 
        If True, then this repository must also implement
2810
 
        _find_inconsistent_revision_parents so that check and reconcile can
2811
 
        check for inconsistencies before proceeding with other checks that may
2812
 
        depend on the revision index being consistent.
 
684
 
 
685
class AllInOneRepository(Repository):
 
686
    """Legacy support - the repository behaviour for all-in-one branches."""
 
687
 
 
688
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
 
689
        # we reuse one control files instance.
 
690
        dir_mode = a_bzrdir._control_files._dir_mode
 
691
        file_mode = a_bzrdir._control_files._file_mode
 
692
 
 
693
        def get_store(name, compressed=True, prefixed=False):
 
694
            # FIXME: This approach of assuming stores are all entirely compressed
 
695
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
696
            # some existing branches where there's a mixture; we probably 
 
697
            # still want the option to look for both.
 
698
            relpath = a_bzrdir._control_files._escape(name)
 
699
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
 
700
                              prefixed=prefixed, compressed=compressed,
 
701
                              dir_mode=dir_mode,
 
702
                              file_mode=file_mode)
 
703
            #if self._transport.should_cache():
 
704
            #    cache_path = os.path.join(self.cache_root, name)
 
705
            #    os.mkdir(cache_path)
 
706
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
707
            return store
 
708
 
 
709
        # not broken out yet because the controlweaves|inventory_store
 
710
        # and text_store | weave_store bits are still different.
 
711
        if isinstance(_format, RepositoryFormat4):
 
712
            # cannot remove these - there is still no consistent api 
 
713
            # which allows access to this old info.
 
714
            self.inventory_store = get_store('inventory-store')
 
715
            text_store = get_store('text-store')
 
716
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
 
717
 
 
718
    @needs_read_lock
 
719
    def is_shared(self):
 
720
        """AllInOne repositories cannot be shared."""
 
721
        return False
 
722
 
 
723
    @needs_write_lock
 
724
    def set_make_working_trees(self, new_value):
 
725
        """Set the policy flag for making working trees when creating branches.
 
726
 
 
727
        This only applies to branches that use this repository.
 
728
 
 
729
        The default is 'True'.
 
730
        :param new_value: True to restore the default, False to disable making
 
731
                          working trees.
2813
732
        """
2814
 
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2815
 
 
2816
 
 
2817
 
# remove these delegates a while after bzr 0.15
2818
 
def __make_delegated(name, from_module):
2819
 
    def _deprecated_repository_forwarder():
2820
 
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
2821
 
            % (name, from_module),
2822
 
            DeprecationWarning,
2823
 
            stacklevel=2)
2824
 
        m = __import__(from_module, globals(), locals(), [name])
2825
 
        try:
2826
 
            return getattr(m, name)
2827
 
        except AttributeError:
2828
 
            raise AttributeError('module %s has no name %s'
2829
 
                    % (m, name))
2830
 
    globals()[name] = _deprecated_repository_forwarder
2831
 
 
2832
 
for _name in [
2833
 
        'AllInOneRepository',
2834
 
        'WeaveMetaDirRepository',
2835
 
        'PreSplitOutRepositoryFormat',
2836
 
        'RepositoryFormat4',
2837
 
        'RepositoryFormat5',
2838
 
        'RepositoryFormat6',
2839
 
        'RepositoryFormat7',
2840
 
        ]:
2841
 
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
2842
 
 
2843
 
for _name in [
2844
 
        'KnitRepository',
2845
 
        'RepositoryFormatKnit',
2846
 
        'RepositoryFormatKnit1',
2847
 
        ]:
2848
 
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
733
        raise NotImplementedError(self.set_make_working_trees)
 
734
    
 
735
    def make_working_trees(self):
 
736
        """Returns the policy for making working trees on new branches."""
 
737
        return True
2849
738
 
2850
739
 
2851
740
def install_revision(repository, rev, revision_tree):
2852
741
    """Install all revision data into a repository."""
2853
 
    install_revisions(repository, [(rev, revision_tree, None)])
2854
 
 
2855
 
 
2856
 
def install_revisions(repository, iterable, num_revisions=None, pb=None):
2857
 
    """Install all revision data into a repository.
2858
 
 
2859
 
    Accepts an iterable of revision, tree, signature tuples.  The signature
2860
 
    may be None.
2861
 
    """
2862
 
    repository.start_write_group()
2863
 
    try:
2864
 
        inventory_cache = lru_cache.LRUCache(10)
2865
 
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2866
 
            _install_revision(repository, revision, revision_tree, signature,
2867
 
                inventory_cache)
2868
 
            if pb is not None:
2869
 
                pb.update('Transferring revisions', n + 1, num_revisions)
2870
 
    except:
2871
 
        repository.abort_write_group()
2872
 
        raise
2873
 
    else:
2874
 
        repository.commit_write_group()
2875
 
 
2876
 
 
2877
 
def _install_revision(repository, rev, revision_tree, signature,
2878
 
    inventory_cache):
2879
 
    """Install all revision data into a repository."""
2880
742
    present_parents = []
2881
743
    parent_trees = {}
2882
744
    for p_id in rev.parent_ids:
2884
746
            present_parents.append(p_id)
2885
747
            parent_trees[p_id] = repository.revision_tree(p_id)
2886
748
        else:
2887
 
            parent_trees[p_id] = repository.revision_tree(
2888
 
                                     _mod_revision.NULL_REVISION)
 
749
            parent_trees[p_id] = EmptyTree()
2889
750
 
2890
751
    inv = revision_tree.inventory
2891
 
    entries = inv.iter_entries()
2892
 
    # backwards compatibility hack: skip the root id.
2893
 
    if not repository.supports_rich_root():
2894
 
        path, root = entries.next()
2895
 
        if root.revision != rev.revision_id:
2896
 
            raise errors.IncompatibleRevision(repr(repository))
2897
 
    text_keys = {}
2898
 
    for path, ie in entries:
2899
 
        text_keys[(ie.file_id, ie.revision)] = ie
2900
 
    text_parent_map = repository.texts.get_parent_map(text_keys)
2901
 
    missing_texts = set(text_keys) - set(text_parent_map)
 
752
    
2902
753
    # Add the texts that are not already present
2903
 
    for text_key in missing_texts:
2904
 
        ie = text_keys[text_key]
2905
 
        text_parents = []
2906
 
        # FIXME: TODO: The following loop overlaps/duplicates that done by
2907
 
        # commit to determine parents. There is a latent/real bug here where
2908
 
        # the parents inserted are not those commit would do - in particular
2909
 
        # they are not filtered by heads(). RBC, AB
2910
 
        for revision, tree in parent_trees.iteritems():
2911
 
            if ie.file_id not in tree:
2912
 
                continue
2913
 
            parent_id = tree.inventory[ie.file_id].revision
2914
 
            if parent_id in text_parents:
2915
 
                continue
2916
 
            text_parents.append((ie.file_id, parent_id))
2917
 
        lines = revision_tree.get_file(ie.file_id).readlines()
2918
 
        repository.texts.add_lines(text_key, text_parents, lines)
 
754
    for path, ie in inv.iter_entries():
 
755
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
756
                repository.get_transaction())
 
757
        if ie.revision not in w:
 
758
            text_parents = []
 
759
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
760
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
761
            # is a latent bug here where the parents may have ancestors of each
 
762
            # other. RBC, AB
 
763
            for revision, tree in parent_trees.iteritems():
 
764
                if ie.file_id not in tree:
 
765
                    continue
 
766
                parent_id = tree.inventory[ie.file_id].revision
 
767
                if parent_id in text_parents:
 
768
                    continue
 
769
                text_parents.append(parent_id)
 
770
                    
 
771
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
772
                repository.get_transaction())
 
773
            lines = revision_tree.get_file(ie.file_id).readlines()
 
774
            vfile.add_lines(rev.revision_id, text_parents, lines)
2919
775
    try:
2920
776
        # install the inventory
2921
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2922
 
            # Cache this inventory
2923
 
            inventory_cache[rev.revision_id] = inv
2924
 
            try:
2925
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2926
 
            except KeyError:
2927
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2928
 
            else:
2929
 
                delta = inv._make_delta(basis_inv)
2930
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2931
 
                    rev.revision_id, present_parents)
2932
 
        else:
2933
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
777
        repository.add_inventory(rev.revision_id, inv, present_parents)
2934
778
    except errors.RevisionAlreadyPresent:
2935
779
        pass
2936
 
    if signature is not None:
2937
 
        repository.add_signature_text(rev.revision_id, signature)
2938
780
    repository.add_revision(rev.revision_id, rev, inv)
2939
781
 
2940
782
 
2941
783
class MetaDirRepository(Repository):
2942
 
    """Repositories in the new meta-dir layout.
2943
 
 
2944
 
    :ivar _transport: Transport for access to repository control files,
2945
 
        typically pointing to .bzr/repository.
2946
 
    """
2947
 
 
2948
 
    def __init__(self, _format, a_bzrdir, control_files):
2949
 
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
2950
 
        self._transport = control_files._transport
2951
 
 
 
784
    """Repositories in the new meta-dir layout."""
 
785
 
 
786
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
787
        super(MetaDirRepository, self).__init__(_format,
 
788
                                                a_bzrdir,
 
789
                                                control_files,
 
790
                                                _revision_store,
 
791
                                                control_store,
 
792
                                                text_store)
 
793
 
 
794
        dir_mode = self.control_files._dir_mode
 
795
        file_mode = self.control_files._file_mode
 
796
 
 
797
    @needs_read_lock
2952
798
    def is_shared(self):
2953
799
        """Return True if this repository is flagged as a shared repository."""
2954
 
        return self._transport.has('shared-storage')
 
800
        return self.control_files._transport.has('shared-storage')
2955
801
 
2956
802
    @needs_write_lock
2957
803
    def set_make_working_trees(self, new_value):
2965
811
        """
2966
812
        if new_value:
2967
813
            try:
2968
 
                self._transport.delete('no-working-trees')
 
814
                self.control_files._transport.delete('no-working-trees')
2969
815
            except errors.NoSuchFile:
2970
816
                pass
2971
817
        else:
2972
 
            self._transport.put_bytes('no-working-trees', '',
2973
 
                mode=self.bzrdir._get_file_mode())
2974
 
 
 
818
            self.control_files.put_utf8('no-working-trees', '')
 
819
    
2975
820
    def make_working_trees(self):
2976
821
        """Returns the policy for making working trees on new branches."""
2977
 
        return not self._transport.has('no-working-trees')
2978
 
 
2979
 
 
2980
 
class MetaDirVersionedFileRepository(MetaDirRepository):
2981
 
    """Repositories in a meta-dir, that work via versioned file objects."""
2982
 
 
2983
 
    def __init__(self, _format, a_bzrdir, control_files):
2984
 
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
2985
 
            control_files)
2986
 
 
2987
 
 
2988
 
network_format_registry = registry.FormatRegistry()
2989
 
"""Registry of formats indexed by their network name.
2990
 
 
2991
 
The network name for a repository format is an identifier that can be used when
2992
 
referring to formats with smart server operations. See
2993
 
RepositoryFormat.network_name() for more detail.
2994
 
"""
2995
 
 
2996
 
 
2997
 
format_registry = registry.FormatRegistry(network_format_registry)
2998
 
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2999
 
 
3000
 
This can contain either format instances themselves, or classes/factories that
3001
 
can be called to obtain one.
3002
 
"""
3003
 
 
3004
 
 
3005
 
#####################################################################
3006
 
# Repository Formats
 
822
        return not self.control_files._transport.has('no-working-trees')
 
823
 
 
824
 
 
825
class KnitRepository(MetaDirRepository):
 
826
    """Knit format repository."""
 
827
 
 
828
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
 
829
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
 
830
 
 
831
    @needs_read_lock
 
832
    def _all_revision_ids(self):
 
833
        """See Repository.all_revision_ids()."""
 
834
        # Knits get the revision graph from the index of the revision knit, so
 
835
        # it's always possible even if they're on an unlistable transport.
 
836
        return self._revision_store.all_revision_ids(self.get_transaction())
 
837
 
 
838
    def fileid_involved_between_revs(self, from_revid, to_revid):
 
839
        """Find file_id(s) which are involved in the changes between revisions.
 
840
 
 
841
        This determines the set of revisions which are involved, and then
 
842
        finds all file ids affected by those revisions.
 
843
        """
 
844
        vf = self._get_revision_vf()
 
845
        from_set = set(vf.get_ancestry(from_revid))
 
846
        to_set = set(vf.get_ancestry(to_revid))
 
847
        changed = to_set.difference(from_set)
 
848
        return self._fileid_involved_by_set(changed)
 
849
 
 
850
    def fileid_involved(self, last_revid=None):
 
851
        """Find all file_ids modified in the ancestry of last_revid.
 
852
 
 
853
        :param last_revid: If None, last_revision() will be used.
 
854
        """
 
855
        if not last_revid:
 
856
            changed = set(self.all_revision_ids())
 
857
        else:
 
858
            changed = set(self.get_ancestry(last_revid))
 
859
        if None in changed:
 
860
            changed.remove(None)
 
861
        return self._fileid_involved_by_set(changed)
 
862
 
 
863
    @needs_read_lock
 
864
    def get_ancestry(self, revision_id):
 
865
        """Return a list of revision-ids integrated by a revision.
 
866
        
 
867
        This is topologically sorted.
 
868
        """
 
869
        if revision_id is None:
 
870
            return [None]
 
871
        vf = self._get_revision_vf()
 
872
        try:
 
873
            return [None] + vf.get_ancestry(revision_id)
 
874
        except errors.RevisionNotPresent:
 
875
            raise errors.NoSuchRevision(self, revision_id)
 
876
 
 
877
    @needs_read_lock
 
878
    def get_revision(self, revision_id):
 
879
        """Return the Revision object for a named revision"""
 
880
        return self.get_revision_reconcile(revision_id)
 
881
 
 
882
    @needs_read_lock
 
883
    def get_revision_graph(self, revision_id=None):
 
884
        """Return a dictionary containing the revision graph.
 
885
 
 
886
        :param revision_id: The revision_id to get a graph from. If None, then
 
887
        the entire revision graph is returned. This is a deprecated mode of
 
888
        operation and will be removed in the future.
 
889
        :return: a dictionary of revision_id->revision_parents_list.
 
890
        """
 
891
        # special case NULL_REVISION
 
892
        if revision_id == NULL_REVISION:
 
893
            return {}
 
894
        weave = self._get_revision_vf()
 
895
        entire_graph = weave.get_graph()
 
896
        if revision_id is None:
 
897
            return weave.get_graph()
 
898
        elif revision_id not in weave:
 
899
            raise errors.NoSuchRevision(self, revision_id)
 
900
        else:
 
901
            # add what can be reached from revision_id
 
902
            result = {}
 
903
            pending = set([revision_id])
 
904
            while len(pending) > 0:
 
905
                node = pending.pop()
 
906
                result[node] = weave.get_parents(node)
 
907
                for revision_id in result[node]:
 
908
                    if revision_id not in result:
 
909
                        pending.add(revision_id)
 
910
            return result
 
911
 
 
912
    @needs_read_lock
 
913
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
914
        """Return a graph of the revisions with ghosts marked as applicable.
 
915
 
 
916
        :param revision_ids: an iterable of revisions to graph or None for all.
 
917
        :return: a Graph object with the graph reachable from revision_ids.
 
918
        """
 
919
        result = Graph()
 
920
        vf = self._get_revision_vf()
 
921
        versions = set(vf.versions())
 
922
        if not revision_ids:
 
923
            pending = set(self.all_revision_ids())
 
924
            required = set([])
 
925
        else:
 
926
            pending = set(revision_ids)
 
927
            # special case NULL_REVISION
 
928
            if NULL_REVISION in pending:
 
929
                pending.remove(NULL_REVISION)
 
930
            required = set(pending)
 
931
        done = set([])
 
932
        while len(pending):
 
933
            revision_id = pending.pop()
 
934
            if not revision_id in versions:
 
935
                if revision_id in required:
 
936
                    raise errors.NoSuchRevision(self, revision_id)
 
937
                # a ghost
 
938
                result.add_ghost(revision_id)
 
939
                # mark it as done so we don't try for it again.
 
940
                done.add(revision_id)
 
941
                continue
 
942
            parent_ids = vf.get_parents_with_ghosts(revision_id)
 
943
            for parent_id in parent_ids:
 
944
                # is this queued or done ?
 
945
                if (parent_id not in pending and
 
946
                    parent_id not in done):
 
947
                    # no, queue it.
 
948
                    pending.add(parent_id)
 
949
            result.add_node(revision_id, parent_ids)
 
950
            done.add(revision_id)
 
951
        return result
 
952
 
 
953
    def _get_revision_vf(self):
 
954
        """:return: a versioned file containing the revisions."""
 
955
        vf = self._revision_store.get_revision_file(self.get_transaction())
 
956
        return vf
 
957
 
 
958
    @needs_write_lock
 
959
    def reconcile(self, other=None, thorough=False):
 
960
        """Reconcile this repository."""
 
961
        from bzrlib.reconcile import KnitReconciler
 
962
        reconciler = KnitReconciler(self, thorough=thorough)
 
963
        reconciler.reconcile()
 
964
        return reconciler
 
965
    
 
966
    def revision_parents(self, revision_id):
 
967
        return self._get_revision_vf().get_parents(revision_id)
 
968
 
3007
969
 
3008
970
class RepositoryFormat(object):
3009
971
    """A repository format.
3010
972
 
3011
 
    Formats provide four things:
 
973
    Formats provide three things:
3012
974
     * An initialization routine to construct repository data on disk.
3013
 
     * a optional format string which is used when the BzrDir supports
3014
 
       versioned children.
 
975
     * a format string which is used when the BzrDir supports versioned
 
976
       children.
3015
977
     * an open routine which returns a Repository instance.
3016
 
     * A network name for referring to the format in smart server RPC
3017
 
       methods.
3018
 
 
3019
 
    There is one and only one Format subclass for each on-disk format. But
3020
 
    there can be one Repository subclass that is used for several different
3021
 
    formats. The _format attribute on a Repository instance can be used to
3022
 
    determine the disk format.
3023
 
 
3024
 
    Formats are placed in a registry by their format string for reference
3025
 
    during opening. These should be subclasses of RepositoryFormat for
3026
 
    consistency.
 
978
 
 
979
    Formats are placed in an dict by their format string for reference 
 
980
    during opening. These should be subclasses of RepositoryFormat
 
981
    for consistency.
3027
982
 
3028
983
    Once a format is deprecated, just deprecate the initialize and open
3029
 
    methods on the format class. Do not deprecate the object, as the
3030
 
    object may be created even when a repository instance hasn't been
3031
 
    created.
 
984
    methods on the format class. Do not deprecate the object, as the 
 
985
    object will be created every system load.
3032
986
 
3033
987
    Common instance attributes:
3034
988
    _matchingbzrdir - the bzrdir format that the repository format was
3035
989
    originally written to work with. This can be used if manually
3036
990
    constructing a bzrdir and repository, or more commonly for test suite
3037
 
    parameterization.
 
991
    parameterisation.
3038
992
    """
3039
993
 
3040
 
    # Set to True or False in derived classes. True indicates that the format
3041
 
    # supports ghosts gracefully.
3042
 
    supports_ghosts = None
3043
 
    # Can this repository be given external locations to lookup additional
3044
 
    # data. Set to True or False in derived classes.
3045
 
    supports_external_lookups = None
3046
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3047
 
    # derived classes.
3048
 
    supports_chks = None
3049
 
    # Should commit add an inventory, or an inventory delta to the repository.
3050
 
    _commit_inv_deltas = True
3051
 
    # What order should fetch operations request streams in?
3052
 
    # The default is unordered as that is the cheapest for an origin to
3053
 
    # provide.
3054
 
    _fetch_order = 'unordered'
3055
 
    # Does this repository format use deltas that can be fetched as-deltas ?
3056
 
    # (E.g. knits, where the knit deltas can be transplanted intact.
3057
 
    # We default to False, which will ensure that enough data to get
3058
 
    # a full text out of any fetch stream will be grabbed.
3059
 
    _fetch_uses_deltas = False
3060
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
3061
 
    # some repository formats that can suffer internal inconsistencies.
3062
 
    _fetch_reconcile = False
3063
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
3064
 
    # code path for commit, amongst other things.
3065
 
    fast_deltas = None
3066
 
    # Does doing a pack operation compress data? Useful for the pack UI command
3067
 
    # (so if there is one pack, the operation can still proceed because it may
3068
 
    # help), and for fetching when data won't have come from the same
3069
 
    # compressor.
3070
 
    pack_compresses = False
3071
 
    # Does the repository inventory storage understand references to trees?
3072
 
    supports_tree_reference = None
3073
 
    # Is the format experimental ?
3074
 
    experimental = False
3075
 
 
3076
 
    def __repr__(self):
3077
 
        return "%s()" % self.__class__.__name__
3078
 
 
3079
 
    def __eq__(self, other):
3080
 
        # format objects are generally stateless
3081
 
        return isinstance(other, self.__class__)
3082
 
 
3083
 
    def __ne__(self, other):
3084
 
        return not self == other
 
994
    _default_format = None
 
995
    """The default format used for new repositories."""
 
996
 
 
997
    _formats = {}
 
998
    """The known formats."""
3085
999
 
3086
1000
    @classmethod
3087
1001
    def find_format(klass, a_bzrdir):
3088
 
        """Return the format for the repository object in a_bzrdir.
3089
 
 
3090
 
        This is used by bzr native formats that have a "format" file in
3091
 
        the repository.  Other methods may be used by different types of
3092
 
        control directory.
3093
 
        """
 
1002
        """Return the format for the repository object in a_bzrdir."""
3094
1003
        try:
3095
1004
            transport = a_bzrdir.get_repository_transport(None)
3096
 
            format_string = transport.get_bytes("format")
3097
 
            return format_registry.get(format_string)
 
1005
            format_string = transport.get("format").read()
 
1006
            return klass._formats[format_string]
3098
1007
        except errors.NoSuchFile:
3099
1008
            raise errors.NoRepositoryPresent(a_bzrdir)
3100
1009
        except KeyError:
3101
 
            raise errors.UnknownFormatError(format=format_string,
3102
 
                                            kind='repository')
3103
 
 
3104
 
    @classmethod
3105
 
    def register_format(klass, format):
3106
 
        format_registry.register(format.get_format_string(), format)
3107
 
 
3108
 
    @classmethod
3109
 
    def unregister_format(klass, format):
3110
 
        format_registry.remove(format.get_format_string())
3111
 
 
 
1010
            raise errors.UnknownFormatError(format=format_string)
 
1011
 
 
1012
    def _get_control_store(self, repo_transport, control_files):
 
1013
        """Return the control store for this repository."""
 
1014
        raise NotImplementedError(self._get_control_store)
 
1015
    
3112
1016
    @classmethod
3113
1017
    def get_default_format(klass):
3114
1018
        """Return the current default format."""
3115
 
        from bzrlib import bzrdir
3116
 
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
1019
        return klass._default_format
3117
1020
 
3118
1021
    def get_format_string(self):
3119
1022
        """Return the ASCII format string that identifies this format.
3120
 
 
3121
 
        Note that in pre format ?? repositories the format string is
 
1023
        
 
1024
        Note that in pre format ?? repositories the format string is 
3122
1025
        not permitted nor written to disk.
3123
1026
        """
3124
1027
        raise NotImplementedError(self.get_format_string)
3127
1030
        """Return the short description for this format."""
3128
1031
        raise NotImplementedError(self.get_format_description)
3129
1032
 
3130
 
    # TODO: this shouldn't be in the base class, it's specific to things that
3131
 
    # use weaves or knits -- mbp 20070207
 
1033
    def _get_revision_store(self, repo_transport, control_files):
 
1034
        """Return the revision store object for this a_bzrdir."""
 
1035
        raise NotImplementedError(self._get_revision_store)
 
1036
 
 
1037
    def _get_text_rev_store(self,
 
1038
                            transport,
 
1039
                            control_files,
 
1040
                            name,
 
1041
                            compressed=True,
 
1042
                            prefixed=False,
 
1043
                            serializer=None):
 
1044
        """Common logic for getting a revision store for a repository.
 
1045
        
 
1046
        see self._get_revision_store for the subclass-overridable method to 
 
1047
        get the store for a repository.
 
1048
        """
 
1049
        from bzrlib.store.revision.text import TextRevisionStore
 
1050
        dir_mode = control_files._dir_mode
 
1051
        file_mode = control_files._file_mode
 
1052
        text_store =TextStore(transport.clone(name),
 
1053
                              prefixed=prefixed,
 
1054
                              compressed=compressed,
 
1055
                              dir_mode=dir_mode,
 
1056
                              file_mode=file_mode)
 
1057
        _revision_store = TextRevisionStore(text_store, serializer)
 
1058
        return _revision_store
 
1059
 
3132
1060
    def _get_versioned_file_store(self,
3133
1061
                                  name,
3134
1062
                                  transport,
3135
1063
                                  control_files,
3136
1064
                                  prefixed=True,
3137
 
                                  versionedfile_class=None,
3138
 
                                  versionedfile_kwargs={},
 
1065
                                  versionedfile_class=WeaveFile,
3139
1066
                                  escaped=False):
3140
 
        if versionedfile_class is None:
3141
 
            versionedfile_class = self._versionedfile_class
3142
1067
        weave_transport = control_files._transport.clone(name)
3143
1068
        dir_mode = control_files._dir_mode
3144
1069
        file_mode = control_files._file_mode
3146
1071
                                  dir_mode=dir_mode,
3147
1072
                                  file_mode=file_mode,
3148
1073
                                  versionedfile_class=versionedfile_class,
3149
 
                                  versionedfile_kwargs=versionedfile_kwargs,
3150
1074
                                  escaped=escaped)
3151
1075
 
3152
1076
    def initialize(self, a_bzrdir, shared=False):
3154
1078
 
3155
1079
        :param a_bzrdir: The bzrdir to put the new repository in it.
3156
1080
        :param shared: The repository should be initialized as a sharable one.
3157
 
        :returns: The new repository object.
3158
1081
 
3159
1082
        This may raise UninitializableFormat if shared repository are not
3160
1083
        compatible the a_bzrdir.
3161
1084
        """
3162
 
        raise NotImplementedError(self.initialize)
3163
1085
 
3164
1086
    def is_supported(self):
3165
1087
        """Is this format supported?
3166
1088
 
3167
1089
        Supported formats must be initializable and openable.
3168
 
        Unsupported formats may not support initialization or committing or
 
1090
        Unsupported formats may not support initialization or committing or 
3169
1091
        some other features depending on the reason for not being supported.
3170
1092
        """
3171
1093
        return True
3172
1094
 
3173
 
    def network_name(self):
3174
 
        """A simple byte string uniquely identifying this format for RPC calls.
3175
 
 
3176
 
        MetaDir repository formats use their disk format string to identify the
3177
 
        repository over the wire. All in one formats such as bzr < 0.8, and
3178
 
        foreign formats like svn/git and hg should use some marker which is
3179
 
        unique and immutable.
3180
 
        """
3181
 
        raise NotImplementedError(self.network_name)
3182
 
 
3183
 
    def check_conversion_target(self, target_format):
3184
 
        if self.rich_root_data and not target_format.rich_root_data:
3185
 
            raise errors.BadConversionTarget(
3186
 
                'Does not support rich root data.', target_format,
3187
 
                from_format=self)
3188
 
        if (self.supports_tree_reference and 
3189
 
            not getattr(target_format, 'supports_tree_reference', False)):
3190
 
            raise errors.BadConversionTarget(
3191
 
                'Does not support nested trees', target_format,
3192
 
                from_format=self)
3193
 
 
3194
1095
    def open(self, a_bzrdir, _found=False):
3195
1096
        """Return an instance of this format for the bzrdir a_bzrdir.
3196
 
 
 
1097
        
3197
1098
        _found is a private parameter, do not use it.
3198
1099
        """
3199
1100
        raise NotImplementedError(self.open)
3200
1101
 
3201
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3202
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3203
 
        hooks = BzrDir.hooks['post_repo_init']
3204
 
        if not hooks:
3205
 
            return
3206
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3207
 
        for hook in hooks:
3208
 
            hook(params)
 
1102
    @classmethod
 
1103
    def register_format(klass, format):
 
1104
        klass._formats[format.get_format_string()] = format
 
1105
 
 
1106
    @classmethod
 
1107
    def set_default_format(klass, format):
 
1108
        klass._default_format = format
 
1109
 
 
1110
    @classmethod
 
1111
    def unregister_format(klass, format):
 
1112
        assert klass._formats[format.get_format_string()] is format
 
1113
        del klass._formats[format.get_format_string()]
 
1114
 
 
1115
 
 
1116
class PreSplitOutRepositoryFormat(RepositoryFormat):
 
1117
    """Base class for the pre split out repository formats."""
 
1118
 
 
1119
    def initialize(self, a_bzrdir, shared=False, _internal=False):
 
1120
        """Create a weave repository.
 
1121
        
 
1122
        TODO: when creating split out bzr branch formats, move this to a common
 
1123
        base for Format5, Format6. or something like that.
 
1124
        """
 
1125
        from bzrlib.weavefile import write_weave_v5
 
1126
        from bzrlib.weave import Weave
 
1127
 
 
1128
        if shared:
 
1129
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
1130
 
 
1131
        if not _internal:
 
1132
            # always initialized when the bzrdir is.
 
1133
            return self.open(a_bzrdir, _found=True)
 
1134
        
 
1135
        # Create an empty weave
 
1136
        sio = StringIO()
 
1137
        write_weave_v5(Weave(), sio)
 
1138
        empty_weave = sio.getvalue()
 
1139
 
 
1140
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1141
        dirs = ['revision-store', 'weaves']
 
1142
        files = [('inventory.weave', StringIO(empty_weave)),
 
1143
                 ]
 
1144
        
 
1145
        # FIXME: RBC 20060125 don't peek under the covers
 
1146
        # NB: no need to escape relative paths that are url safe.
 
1147
        control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
 
1148
                                      TransportLock)
 
1149
        control_files.create_lock()
 
1150
        control_files.lock_write()
 
1151
        control_files._transport.mkdir_multi(dirs,
 
1152
                mode=control_files._dir_mode)
 
1153
        try:
 
1154
            for file, content in files:
 
1155
                control_files.put(file, content)
 
1156
        finally:
 
1157
            control_files.unlock()
 
1158
        return self.open(a_bzrdir, _found=True)
 
1159
 
 
1160
    def _get_control_store(self, repo_transport, control_files):
 
1161
        """Return the control store for this repository."""
 
1162
        return self._get_versioned_file_store('',
 
1163
                                              repo_transport,
 
1164
                                              control_files,
 
1165
                                              prefixed=False)
 
1166
 
 
1167
    def _get_text_store(self, transport, control_files):
 
1168
        """Get a store for file texts for this format."""
 
1169
        raise NotImplementedError(self._get_text_store)
 
1170
 
 
1171
    def open(self, a_bzrdir, _found=False):
 
1172
        """See RepositoryFormat.open()."""
 
1173
        if not _found:
 
1174
            # we are being called directly and must probe.
 
1175
            raise NotImplementedError
 
1176
 
 
1177
        repo_transport = a_bzrdir.get_repository_transport(None)
 
1178
        control_files = a_bzrdir._control_files
 
1179
        text_store = self._get_text_store(repo_transport, control_files)
 
1180
        control_store = self._get_control_store(repo_transport, control_files)
 
1181
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1182
        return AllInOneRepository(_format=self,
 
1183
                                  a_bzrdir=a_bzrdir,
 
1184
                                  _revision_store=_revision_store,
 
1185
                                  control_store=control_store,
 
1186
                                  text_store=text_store)
 
1187
 
 
1188
 
 
1189
class RepositoryFormat4(PreSplitOutRepositoryFormat):
 
1190
    """Bzr repository format 4.
 
1191
 
 
1192
    This repository format has:
 
1193
     - flat stores
 
1194
     - TextStores for texts, inventories,revisions.
 
1195
 
 
1196
    This format is deprecated: it indexes texts using a text id which is
 
1197
    removed in format 5; initialization and write support for this format
 
1198
    has been removed.
 
1199
    """
 
1200
 
 
1201
    def __init__(self):
 
1202
        super(RepositoryFormat4, self).__init__()
 
1203
        self._matchingbzrdir = bzrdir.BzrDirFormat4()
 
1204
 
 
1205
    def get_format_description(self):
 
1206
        """See RepositoryFormat.get_format_description()."""
 
1207
        return "Repository format 4"
 
1208
 
 
1209
    def initialize(self, url, shared=False, _internal=False):
 
1210
        """Format 4 branches cannot be created."""
 
1211
        raise errors.UninitializableFormat(self)
 
1212
 
 
1213
    def is_supported(self):
 
1214
        """Format 4 is not supported.
 
1215
 
 
1216
        It is not supported because the model changed from 4 to 5 and the
 
1217
        conversion logic is expensive - so doing it on the fly was not 
 
1218
        feasible.
 
1219
        """
 
1220
        return False
 
1221
 
 
1222
    def _get_control_store(self, repo_transport, control_files):
 
1223
        """Format 4 repositories have no formal control store at this point.
 
1224
        
 
1225
        This will cause any control-file-needing apis to fail - this is desired.
 
1226
        """
 
1227
        return None
 
1228
    
 
1229
    def _get_revision_store(self, repo_transport, control_files):
 
1230
        """See RepositoryFormat._get_revision_store()."""
 
1231
        from bzrlib.xml4 import serializer_v4
 
1232
        return self._get_text_rev_store(repo_transport,
 
1233
                                        control_files,
 
1234
                                        'revision-store',
 
1235
                                        serializer=serializer_v4)
 
1236
 
 
1237
    def _get_text_store(self, transport, control_files):
 
1238
        """See RepositoryFormat._get_text_store()."""
 
1239
 
 
1240
 
 
1241
class RepositoryFormat5(PreSplitOutRepositoryFormat):
 
1242
    """Bzr control format 5.
 
1243
 
 
1244
    This repository format has:
 
1245
     - weaves for file texts and inventory
 
1246
     - flat stores
 
1247
     - TextStores for revisions and signatures.
 
1248
    """
 
1249
 
 
1250
    def __init__(self):
 
1251
        super(RepositoryFormat5, self).__init__()
 
1252
        self._matchingbzrdir = bzrdir.BzrDirFormat5()
 
1253
 
 
1254
    def get_format_description(self):
 
1255
        """See RepositoryFormat.get_format_description()."""
 
1256
        return "Weave repository format 5"
 
1257
 
 
1258
    def _get_revision_store(self, repo_transport, control_files):
 
1259
        """See RepositoryFormat._get_revision_store()."""
 
1260
        """Return the revision store object for this a_bzrdir."""
 
1261
        return self._get_text_rev_store(repo_transport,
 
1262
                                        control_files,
 
1263
                                        'revision-store',
 
1264
                                        compressed=False)
 
1265
 
 
1266
    def _get_text_store(self, transport, control_files):
 
1267
        """See RepositoryFormat._get_text_store()."""
 
1268
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
 
1269
 
 
1270
 
 
1271
class RepositoryFormat6(PreSplitOutRepositoryFormat):
 
1272
    """Bzr control format 6.
 
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
    """
 
1279
 
 
1280
    def __init__(self):
 
1281
        super(RepositoryFormat6, self).__init__()
 
1282
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1283
 
 
1284
    def get_format_description(self):
 
1285
        """See RepositoryFormat.get_format_description()."""
 
1286
        return "Weave repository format 6"
 
1287
 
 
1288
    def _get_revision_store(self, repo_transport, control_files):
 
1289
        """See RepositoryFormat._get_revision_store()."""
 
1290
        return self._get_text_rev_store(repo_transport,
 
1291
                                        control_files,
 
1292
                                        'revision-store',
 
1293
                                        compressed=False,
 
1294
                                        prefixed=True)
 
1295
 
 
1296
    def _get_text_store(self, transport, control_files):
 
1297
        """See RepositoryFormat._get_text_store()."""
 
1298
        return self._get_versioned_file_store('weaves', transport, control_files)
3209
1299
 
3210
1300
 
3211
1301
class MetaDirRepositoryFormat(RepositoryFormat):
3212
1302
    """Common base class for the new repositories using the metadir layout."""
3213
1303
 
3214
 
    rich_root_data = False
3215
 
    supports_tree_reference = False
3216
 
    supports_external_lookups = False
3217
 
 
3218
 
    @property
3219
 
    def _matchingbzrdir(self):
3220
 
        matching = bzrdir.BzrDirMetaFormat1()
3221
 
        matching.repository_format = self
3222
 
        return matching
3223
 
 
3224
1304
    def __init__(self):
3225
1305
        super(MetaDirRepositoryFormat, self).__init__()
 
1306
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3226
1307
 
3227
1308
    def _create_control_files(self, a_bzrdir):
3228
1309
        """Create the required files and the initial control_files object."""
3229
1310
        # FIXME: RBC 20060125 don't peek under the covers
3230
1311
        # NB: no need to escape relative paths that are url safe.
3231
1312
        repository_transport = a_bzrdir.get_repository_transport(self)
3232
 
        control_files = lockable_files.LockableFiles(repository_transport,
3233
 
                                'lock', lockdir.LockDir)
 
1313
        control_files = LockableFiles(repository_transport, 'lock', LockDir)
3234
1314
        control_files.create_lock()
3235
1315
        return control_files
3236
1316
 
3238
1318
        """Upload the initial blank content."""
3239
1319
        control_files = self._create_control_files(a_bzrdir)
3240
1320
        control_files.lock_write()
3241
 
        transport = control_files._transport
3242
 
        if shared == True:
3243
 
            utf8_files += [('shared-storage', '')]
3244
1321
        try:
3245
 
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
3246
 
            for (filename, content_stream) in files:
3247
 
                transport.put_file(filename, content_stream,
3248
 
                    mode=a_bzrdir._get_file_mode())
3249
 
            for (filename, content_bytes) in utf8_files:
3250
 
                transport.put_bytes_non_atomic(filename, content_bytes,
3251
 
                    mode=a_bzrdir._get_file_mode())
 
1322
            control_files._transport.mkdir_multi(dirs,
 
1323
                    mode=control_files._dir_mode)
 
1324
            for file, content in files:
 
1325
                control_files.put(file, content)
 
1326
            for file, content in utf8_files:
 
1327
                control_files.put_utf8(file, content)
 
1328
            if shared == True:
 
1329
                control_files.put_utf8('shared-storage', '')
3252
1330
        finally:
3253
1331
            control_files.unlock()
3254
1332
 
3255
 
    def network_name(self):
3256
 
        """Metadir formats have matching disk and network format strings."""
3257
 
        return self.get_format_string()
3258
 
 
3259
 
 
3260
 
# Pre-0.8 formats that don't have a disk format string (because they are
3261
 
# versioned by the matching control directory). We use the control directories
3262
 
# disk format string as a key for the network_name because they meet the
3263
 
# constraints (simple string, unique, immutable).
3264
 
network_format_registry.register_lazy(
3265
 
    "Bazaar-NG branch, format 5\n",
3266
 
    'bzrlib.repofmt.weaverepo',
3267
 
    'RepositoryFormat5',
3268
 
)
3269
 
network_format_registry.register_lazy(
3270
 
    "Bazaar-NG branch, format 6\n",
3271
 
    'bzrlib.repofmt.weaverepo',
3272
 
    'RepositoryFormat6',
3273
 
)
3274
 
 
3275
 
# formats which have no format string are not discoverable or independently
3276
 
# creatable on disk, so are not registered in format_registry.  They're
3277
 
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
3278
 
# needed, it's constructed directly by the BzrDir.  Non-native formats where
3279
 
# the repository is not separately opened are similar.
3280
 
 
3281
 
format_registry.register_lazy(
3282
 
    'Bazaar-NG Repository format 7',
3283
 
    'bzrlib.repofmt.weaverepo',
3284
 
    'RepositoryFormat7'
3285
 
    )
3286
 
 
3287
 
format_registry.register_lazy(
3288
 
    'Bazaar-NG Knit Repository Format 1',
3289
 
    'bzrlib.repofmt.knitrepo',
3290
 
    'RepositoryFormatKnit1',
3291
 
    )
3292
 
 
3293
 
format_registry.register_lazy(
3294
 
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
3295
 
    'bzrlib.repofmt.knitrepo',
3296
 
    'RepositoryFormatKnit3',
3297
 
    )
3298
 
 
3299
 
format_registry.register_lazy(
3300
 
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
3301
 
    'bzrlib.repofmt.knitrepo',
3302
 
    'RepositoryFormatKnit4',
3303
 
    )
3304
 
 
3305
 
# Pack-based formats. There is one format for pre-subtrees, and one for
3306
 
# post-subtrees to allow ease of testing.
3307
 
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
3308
 
format_registry.register_lazy(
3309
 
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
3310
 
    'bzrlib.repofmt.pack_repo',
3311
 
    'RepositoryFormatKnitPack1',
3312
 
    )
3313
 
format_registry.register_lazy(
3314
 
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
3315
 
    'bzrlib.repofmt.pack_repo',
3316
 
    'RepositoryFormatKnitPack3',
3317
 
    )
3318
 
format_registry.register_lazy(
3319
 
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
3320
 
    'bzrlib.repofmt.pack_repo',
3321
 
    'RepositoryFormatKnitPack4',
3322
 
    )
3323
 
format_registry.register_lazy(
3324
 
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
3325
 
    'bzrlib.repofmt.pack_repo',
3326
 
    'RepositoryFormatKnitPack5',
3327
 
    )
3328
 
format_registry.register_lazy(
3329
 
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
3330
 
    'bzrlib.repofmt.pack_repo',
3331
 
    'RepositoryFormatKnitPack5RichRoot',
3332
 
    )
3333
 
format_registry.register_lazy(
3334
 
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
3335
 
    'bzrlib.repofmt.pack_repo',
3336
 
    'RepositoryFormatKnitPack5RichRootBroken',
3337
 
    )
3338
 
format_registry.register_lazy(
3339
 
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
3340
 
    'bzrlib.repofmt.pack_repo',
3341
 
    'RepositoryFormatKnitPack6',
3342
 
    )
3343
 
format_registry.register_lazy(
3344
 
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
3345
 
    'bzrlib.repofmt.pack_repo',
3346
 
    'RepositoryFormatKnitPack6RichRoot',
3347
 
    )
3348
 
 
3349
 
# Development formats.
3350
 
# Obsolete but kept pending a CHK based subtree format.
3351
 
format_registry.register_lazy(
3352
 
    ("Bazaar development format 2 with subtree support "
3353
 
        "(needs bzr.dev from before 1.8)\n"),
3354
 
    'bzrlib.repofmt.pack_repo',
3355
 
    'RepositoryFormatPackDevelopment2Subtree',
3356
 
    )
3357
 
 
3358
 
# 1.14->1.16 go below here
3359
 
format_registry.register_lazy(
3360
 
    'Bazaar development format - group compression and chk inventory'
3361
 
        ' (needs bzr.dev from 1.14)\n',
3362
 
    'bzrlib.repofmt.groupcompress_repo',
3363
 
    'RepositoryFormatCHK1',
3364
 
    )
3365
 
 
3366
 
format_registry.register_lazy(
3367
 
    'Bazaar development format - chk repository with bencode revision '
3368
 
        'serialization (needs bzr.dev from 1.16)\n',
3369
 
    'bzrlib.repofmt.groupcompress_repo',
3370
 
    'RepositoryFormatCHK2',
3371
 
    )
3372
 
format_registry.register_lazy(
3373
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3374
 
    'bzrlib.repofmt.groupcompress_repo',
3375
 
    'RepositoryFormat2a',
3376
 
    )
 
1333
 
 
1334
class RepositoryFormat7(MetaDirRepositoryFormat):
 
1335
    """Bzr repository 7.
 
1336
 
 
1337
    This repository format has:
 
1338
     - weaves for file texts and inventory
 
1339
     - hash subdirectory based stores.
 
1340
     - TextStores for revisions and signatures.
 
1341
     - a format marker of its own
 
1342
     - an optional 'shared-storage' flag
 
1343
     - an optional 'no-working-trees' flag
 
1344
    """
 
1345
 
 
1346
    def _get_control_store(self, repo_transport, control_files):
 
1347
        """Return the control store for this repository."""
 
1348
        return self._get_versioned_file_store('',
 
1349
                                              repo_transport,
 
1350
                                              control_files,
 
1351
                                              prefixed=False)
 
1352
 
 
1353
    def get_format_string(self):
 
1354
        """See RepositoryFormat.get_format_string()."""
 
1355
        return "Bazaar-NG Repository format 7"
 
1356
 
 
1357
    def get_format_description(self):
 
1358
        """See RepositoryFormat.get_format_description()."""
 
1359
        return "Weave repository format 7"
 
1360
 
 
1361
    def _get_revision_store(self, repo_transport, control_files):
 
1362
        """See RepositoryFormat._get_revision_store()."""
 
1363
        return self._get_text_rev_store(repo_transport,
 
1364
                                        control_files,
 
1365
                                        'revision-store',
 
1366
                                        compressed=False,
 
1367
                                        prefixed=True,
 
1368
                                        )
 
1369
 
 
1370
    def _get_text_store(self, transport, control_files):
 
1371
        """See RepositoryFormat._get_text_store()."""
 
1372
        return self._get_versioned_file_store('weaves',
 
1373
                                              transport,
 
1374
                                              control_files)
 
1375
 
 
1376
    def initialize(self, a_bzrdir, shared=False):
 
1377
        """Create a weave repository.
 
1378
 
 
1379
        :param shared: If true the repository will be initialized as a shared
 
1380
                       repository.
 
1381
        """
 
1382
        from bzrlib.weavefile import write_weave_v5
 
1383
        from bzrlib.weave import Weave
 
1384
 
 
1385
        # Create an empty weave
 
1386
        sio = StringIO()
 
1387
        write_weave_v5(Weave(), sio)
 
1388
        empty_weave = sio.getvalue()
 
1389
 
 
1390
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1391
        dirs = ['revision-store', 'weaves']
 
1392
        files = [('inventory.weave', StringIO(empty_weave)), 
 
1393
                 ]
 
1394
        utf8_files = [('format', self.get_format_string())]
 
1395
 
 
1396
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1397
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1398
 
 
1399
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1400
        """See RepositoryFormat.open().
 
1401
        
 
1402
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1403
                                    repository at a slightly different url
 
1404
                                    than normal. I.e. during 'upgrade'.
 
1405
        """
 
1406
        if not _found:
 
1407
            format = RepositoryFormat.find_format(a_bzrdir)
 
1408
            assert format.__class__ ==  self.__class__
 
1409
        if _override_transport is not None:
 
1410
            repo_transport = _override_transport
 
1411
        else:
 
1412
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1413
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1414
        text_store = self._get_text_store(repo_transport, control_files)
 
1415
        control_store = self._get_control_store(repo_transport, control_files)
 
1416
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1417
        return MetaDirRepository(_format=self,
 
1418
                                 a_bzrdir=a_bzrdir,
 
1419
                                 control_files=control_files,
 
1420
                                 _revision_store=_revision_store,
 
1421
                                 control_store=control_store,
 
1422
                                 text_store=text_store)
 
1423
 
 
1424
 
 
1425
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
 
1426
    """Bzr repository knit format 1.
 
1427
 
 
1428
    This repository format has:
 
1429
     - knits for file texts and inventory
 
1430
     - hash subdirectory based stores.
 
1431
     - knits for revisions and signatures
 
1432
     - TextStores for revisions and signatures.
 
1433
     - a format marker of its own
 
1434
     - an optional 'shared-storage' flag
 
1435
     - an optional 'no-working-trees' flag
 
1436
     - a LockDir lock
 
1437
 
 
1438
    This format was introduced in bzr 0.8.
 
1439
    """
 
1440
 
 
1441
    def _get_control_store(self, repo_transport, control_files):
 
1442
        """Return the control store for this repository."""
 
1443
        return VersionedFileStore(
 
1444
            repo_transport,
 
1445
            prefixed=False,
 
1446
            file_mode=control_files._file_mode,
 
1447
            versionedfile_class=KnitVersionedFile,
 
1448
            versionedfile_kwargs={'factory':KnitPlainFactory()},
 
1449
            )
 
1450
 
 
1451
    def get_format_string(self):
 
1452
        """See RepositoryFormat.get_format_string()."""
 
1453
        return "Bazaar-NG Knit Repository Format 1"
 
1454
 
 
1455
    def get_format_description(self):
 
1456
        """See RepositoryFormat.get_format_description()."""
 
1457
        return "Knit repository format 1"
 
1458
 
 
1459
    def _get_revision_store(self, repo_transport, control_files):
 
1460
        """See RepositoryFormat._get_revision_store()."""
 
1461
        from bzrlib.store.revision.knit import KnitRevisionStore
 
1462
        versioned_file_store = VersionedFileStore(
 
1463
            repo_transport,
 
1464
            file_mode=control_files._file_mode,
 
1465
            prefixed=False,
 
1466
            precious=True,
 
1467
            versionedfile_class=KnitVersionedFile,
 
1468
            versionedfile_kwargs={'delta':False, 'factory':KnitPlainFactory()},
 
1469
            escaped=True,
 
1470
            )
 
1471
        return KnitRevisionStore(versioned_file_store)
 
1472
 
 
1473
    def _get_text_store(self, transport, control_files):
 
1474
        """See RepositoryFormat._get_text_store()."""
 
1475
        return self._get_versioned_file_store('knits',
 
1476
                                              transport,
 
1477
                                              control_files,
 
1478
                                              versionedfile_class=KnitVersionedFile,
 
1479
                                              escaped=True)
 
1480
 
 
1481
    def initialize(self, a_bzrdir, shared=False):
 
1482
        """Create a knit format 1 repository.
 
1483
 
 
1484
        :param a_bzrdir: bzrdir to contain the new repository; must already
 
1485
            be initialized.
 
1486
        :param shared: If true the repository will be initialized as a shared
 
1487
                       repository.
 
1488
        """
 
1489
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1490
        dirs = ['revision-store', 'knits']
 
1491
        files = []
 
1492
        utf8_files = [('format', self.get_format_string())]
 
1493
        
 
1494
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1495
        repo_transport = a_bzrdir.get_repository_transport(None)
 
1496
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1497
        control_store = self._get_control_store(repo_transport, control_files)
 
1498
        transaction = transactions.WriteTransaction()
 
1499
        # trigger a write of the inventory store.
 
1500
        control_store.get_weave_or_empty('inventory', transaction)
 
1501
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1502
        _revision_store.has_revision_id('A', transaction)
 
1503
        _revision_store.get_signature_file(transaction)
 
1504
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1505
 
 
1506
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1507
        """See RepositoryFormat.open().
 
1508
        
 
1509
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1510
                                    repository at a slightly different url
 
1511
                                    than normal. I.e. during 'upgrade'.
 
1512
        """
 
1513
        if not _found:
 
1514
            format = RepositoryFormat.find_format(a_bzrdir)
 
1515
            assert format.__class__ ==  self.__class__
 
1516
        if _override_transport is not None:
 
1517
            repo_transport = _override_transport
 
1518
        else:
 
1519
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1520
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1521
        text_store = self._get_text_store(repo_transport, control_files)
 
1522
        control_store = self._get_control_store(repo_transport, control_files)
 
1523
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1524
        return KnitRepository(_format=self,
 
1525
                              a_bzrdir=a_bzrdir,
 
1526
                              control_files=control_files,
 
1527
                              _revision_store=_revision_store,
 
1528
                              control_store=control_store,
 
1529
                              text_store=text_store)
 
1530
 
 
1531
 
 
1532
# formats which have no format string are not discoverable
 
1533
# and not independently creatable, so are not registered.
 
1534
RepositoryFormat.register_format(RepositoryFormat7())
 
1535
_default_format = RepositoryFormatKnit1()
 
1536
RepositoryFormat.register_format(_default_format)
 
1537
RepositoryFormat.set_default_format(_default_format)
 
1538
_legacy_formats = [RepositoryFormat4(),
 
1539
                   RepositoryFormat5(),
 
1540
                   RepositoryFormat6()]
3377
1541
 
3378
1542
 
3379
1543
class InterRepository(InterObject):
3380
1544
    """This class represents operations taking place between two repositories.
3381
1545
 
3382
1546
    Its instances have methods like copy_content and fetch, and contain
3383
 
    references to the source and target repositories these operations can be
 
1547
    references to the source and target repositories these operations can be 
3384
1548
    carried out on.
3385
1549
 
3386
1550
    Often we will provide convenience methods on 'repository' which carry out
3388
1552
    InterRepository.get(other).method_name(parameters).
3389
1553
    """
3390
1554
 
3391
 
    _walk_to_common_revisions_batch_size = 50
3392
 
    _optimisers = []
 
1555
    _optimisers = set()
3393
1556
    """The available optimised InterRepository types."""
3394
1557
 
3395
1558
    @needs_write_lock
3396
 
    def copy_content(self, revision_id=None):
 
1559
    def copy_content(self, revision_id=None, basis=None):
3397
1560
        """Make a complete copy of the content in self into destination.
3398
 
 
3399
 
        This is a destructive operation! Do not use it on existing
 
1561
        
 
1562
        This is a destructive operation! Do not use it on existing 
3400
1563
        repositories.
3401
1564
 
3402
1565
        :param revision_id: Only copy the content needed to construct
3403
1566
                            revision_id and its parents.
 
1567
        :param basis: Copy the needed data preferentially from basis.
3404
1568
        """
3405
1569
        try:
3406
1570
            self.target.set_make_working_trees(self.source.make_working_trees())
3407
1571
        except NotImplementedError:
3408
1572
            pass
 
1573
        # grab the basis available data
 
1574
        if basis is not None:
 
1575
            self.target.fetch(basis, revision_id=revision_id)
 
1576
        # but don't bother fetching if we have the needed data now.
 
1577
        if (revision_id not in (None, NULL_REVISION) and 
 
1578
            self.target.has_revision(revision_id)):
 
1579
            return
3409
1580
        self.target.fetch(self.source, revision_id=revision_id)
3410
1581
 
 
1582
    def _double_lock(self, lock_source, lock_target):
 
1583
        """Take out too locks, rolling back the first if the second throws."""
 
1584
        lock_source()
 
1585
        try:
 
1586
            lock_target()
 
1587
        except Exception:
 
1588
            # we want to ensure that we don't leave source locked by mistake.
 
1589
            # and any error on target should not confuse source.
 
1590
            self.source.unlock()
 
1591
            raise
 
1592
 
3411
1593
    @needs_write_lock
3412
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3413
 
            fetch_spec=None):
 
1594
    def fetch(self, revision_id=None, pb=None):
3414
1595
        """Fetch the content required to construct revision_id.
3415
1596
 
3416
 
        The content is copied from self.source to self.target.
 
1597
        The content is copied from source to target.
3417
1598
 
3418
1599
        :param revision_id: if None all content is copied, if NULL_REVISION no
3419
1600
                            content is copied.
3420
 
        :param pb: ignored.
3421
 
        :return: None.
 
1601
        :param pb: optional progress bar to use for progress reports. If not
 
1602
                   provided a default one will be created.
 
1603
 
 
1604
        Returns the copied revision count and the failed revisions in a tuple:
 
1605
        (copied, failures).
3422
1606
        """
3423
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3424
 
        from bzrlib.fetch import RepoFetcher
3425
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3426
 
        if self.source._format.network_name() != self.target._format.network_name():
3427
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3428
 
                from_format=self.source._format,
3429
 
                to_format=self.target._format)
3430
 
        f = RepoFetcher(to_repository=self.target,
 
1607
        from bzrlib.fetch import GenericRepoFetcher
 
1608
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1609
               self.source, self.source._format, self.target, self.target._format)
 
1610
        f = GenericRepoFetcher(to_repository=self.target,
3431
1611
                               from_repository=self.source,
3432
1612
                               last_revision=revision_id,
3433
 
                               fetch_spec=fetch_spec,
3434
 
                               find_ghosts=find_ghosts)
3435
 
 
3436
 
    def _walk_to_common_revisions(self, revision_ids):
3437
 
        """Walk out from revision_ids in source to revisions target has.
3438
 
 
3439
 
        :param revision_ids: The start point for the search.
3440
 
        :return: A set of revision ids.
3441
 
        """
3442
 
        target_graph = self.target.get_graph()
3443
 
        revision_ids = frozenset(revision_ids)
3444
 
        missing_revs = set()
3445
 
        source_graph = self.source.get_graph()
3446
 
        # ensure we don't pay silly lookup costs.
3447
 
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
3448
 
        null_set = frozenset([_mod_revision.NULL_REVISION])
3449
 
        searcher_exhausted = False
3450
 
        while True:
3451
 
            next_revs = set()
3452
 
            ghosts = set()
3453
 
            # Iterate the searcher until we have enough next_revs
3454
 
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
3455
 
                try:
3456
 
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
3457
 
                    next_revs.update(next_revs_part)
3458
 
                    ghosts.update(ghosts_part)
3459
 
                except StopIteration:
3460
 
                    searcher_exhausted = True
3461
 
                    break
3462
 
            # If there are ghosts in the source graph, and the caller asked for
3463
 
            # them, make sure that they are present in the target.
3464
 
            # We don't care about other ghosts as we can't fetch them and
3465
 
            # haven't been asked to.
3466
 
            ghosts_to_check = set(revision_ids.intersection(ghosts))
3467
 
            revs_to_get = set(next_revs).union(ghosts_to_check)
3468
 
            if revs_to_get:
3469
 
                have_revs = set(target_graph.get_parent_map(revs_to_get))
3470
 
                # we always have NULL_REVISION present.
3471
 
                have_revs = have_revs.union(null_set)
3472
 
                # Check if the target is missing any ghosts we need.
3473
 
                ghosts_to_check.difference_update(have_revs)
3474
 
                if ghosts_to_check:
3475
 
                    # One of the caller's revision_ids is a ghost in both the
3476
 
                    # source and the target.
3477
 
                    raise errors.NoSuchRevision(
3478
 
                        self.source, ghosts_to_check.pop())
3479
 
                missing_revs.update(next_revs - have_revs)
3480
 
                # Because we may have walked past the original stop point, make
3481
 
                # sure everything is stopped
3482
 
                stop_revs = searcher.find_seen_ancestors(have_revs)
3483
 
                searcher.stop_searching_any(stop_revs)
3484
 
            if searcher_exhausted:
3485
 
                break
3486
 
        return searcher.get_result()
 
1613
                               pb=pb)
 
1614
        return f.count_copied, f.failed_revisions
 
1615
 
 
1616
    def lock_read(self):
 
1617
        """Take out a logical read lock.
 
1618
 
 
1619
        This will lock the source branch and the target branch. The source gets
 
1620
        a read lock and the target a read lock.
 
1621
        """
 
1622
        self._double_lock(self.source.lock_read, self.target.lock_read)
 
1623
 
 
1624
    def lock_write(self):
 
1625
        """Take out a logical write lock.
 
1626
 
 
1627
        This will lock the source branch and the target branch. The source gets
 
1628
        a read lock and the target a write lock.
 
1629
        """
 
1630
        self._double_lock(self.source.lock_read, self.target.lock_write)
3487
1631
 
3488
1632
    @needs_read_lock
3489
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
1633
    def missing_revision_ids(self, revision_id=None):
3490
1634
        """Return the revision ids that source has that target does not.
 
1635
        
 
1636
        These are returned in topological order.
3491
1637
 
3492
1638
        :param revision_id: only return revision ids included by this
3493
1639
                            revision_id.
3494
 
        :param find_ghosts: If True find missing revisions in deep history
3495
 
            rather than just finding the surface difference.
3496
 
        :return: A bzrlib.graph.SearchResult.
3497
1640
        """
3498
 
        # stop searching at found target revisions.
3499
 
        if not find_ghosts and revision_id is not None:
3500
 
            return self._walk_to_common_revisions([revision_id])
3501
1641
        # generic, possibly worst case, slow code path.
3502
1642
        target_ids = set(self.target.all_revision_ids())
3503
1643
        if revision_id is not None:
3504
1644
            source_ids = self.source.get_ancestry(revision_id)
3505
 
            if source_ids[0] is not None:
3506
 
                raise AssertionError()
 
1645
            assert source_ids[0] == None
3507
1646
            source_ids.pop(0)
3508
1647
        else:
3509
1648
            source_ids = self.source.all_revision_ids()
3510
1649
        result_set = set(source_ids).difference(target_ids)
3511
 
        return self.source.revision_ids_to_search_result(result_set)
3512
 
 
3513
 
    @staticmethod
3514
 
    def _same_model(source, target):
3515
 
        """True if source and target have the same data representation.
3516
 
 
3517
 
        Note: this is always called on the base class; overriding it in a
3518
 
        subclass will have no effect.
3519
 
        """
 
1650
        # this may look like a no-op: its not. It preserves the ordering
 
1651
        # other_ids had while only returning the members from other_ids
 
1652
        # that we've decided we need.
 
1653
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
1654
 
 
1655
    def unlock(self):
 
1656
        """Release the locks on source and target."""
3520
1657
        try:
3521
 
            InterRepository._assert_same_model(source, target)
3522
 
            return True
3523
 
        except errors.IncompatibleRepositories, e:
3524
 
            return False
3525
 
 
3526
 
    @staticmethod
3527
 
    def _assert_same_model(source, target):
3528
 
        """Raise an exception if two repositories do not use the same model.
3529
 
        """
3530
 
        if source.supports_rich_root() != target.supports_rich_root():
3531
 
            raise errors.IncompatibleRepositories(source, target,
3532
 
                "different rich-root support")
3533
 
        if source._serializer != target._serializer:
3534
 
            raise errors.IncompatibleRepositories(source, target,
3535
 
                "different serializers")
3536
 
 
3537
 
 
3538
 
class InterSameDataRepository(InterRepository):
3539
 
    """Code for converting between repositories that represent the same data.
3540
 
 
3541
 
    Data format and model must match for this to work.
3542
 
    """
3543
 
 
3544
 
    @classmethod
3545
 
    def _get_repo_format_to_test(self):
3546
 
        """Repository format for testing with.
3547
 
 
3548
 
        InterSameData can pull from subtree to subtree and from non-subtree to
3549
 
        non-subtree, so we test this with the richest repository format.
3550
 
        """
3551
 
        from bzrlib.repofmt import knitrepo
3552
 
        return knitrepo.RepositoryFormatKnit3()
3553
 
 
3554
 
    @staticmethod
3555
 
    def is_compatible(source, target):
3556
 
        return InterRepository._same_model(source, target)
3557
 
 
3558
 
 
3559
 
class InterWeaveRepo(InterSameDataRepository):
3560
 
    """Optimised code paths between Weave based repositories.
3561
 
 
3562
 
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3563
 
    implemented lazy inter-object optimisation.
3564
 
    """
3565
 
 
3566
 
    @classmethod
3567
 
    def _get_repo_format_to_test(self):
3568
 
        from bzrlib.repofmt import weaverepo
3569
 
        return weaverepo.RepositoryFormat7()
 
1658
            self.target.unlock()
 
1659
        finally:
 
1660
            self.source.unlock()
 
1661
 
 
1662
 
 
1663
class InterWeaveRepo(InterRepository):
 
1664
    """Optimised code paths between Weave based repositories."""
 
1665
 
 
1666
    _matching_repo_format = RepositoryFormat7()
 
1667
    """Repository format for testing with."""
3570
1668
 
3571
1669
    @staticmethod
3572
1670
    def is_compatible(source, target):
3573
1671
        """Be compatible with known Weave formats.
3574
 
 
 
1672
        
3575
1673
        We don't test for the stores being of specific types because that
3576
 
        could lead to confusing results, and there is no need to be
 
1674
        could lead to confusing results, and there is no need to be 
3577
1675
        overly general.
3578
1676
        """
3579
 
        from bzrlib.repofmt.weaverepo import (
3580
 
                RepositoryFormat5,
3581
 
                RepositoryFormat6,
3582
 
                RepositoryFormat7,
3583
 
                )
3584
1677
        try:
3585
1678
            return (isinstance(source._format, (RepositoryFormat5,
3586
1679
                                                RepositoryFormat6,
3590
1683
                                                RepositoryFormat7)))
3591
1684
        except AttributeError:
3592
1685
            return False
3593
 
 
 
1686
    
3594
1687
    @needs_write_lock
3595
 
    def copy_content(self, revision_id=None):
 
1688
    def copy_content(self, revision_id=None, basis=None):
3596
1689
        """See InterRepository.copy_content()."""
3597
1690
        # weave specific optimised path:
3598
 
        try:
3599
 
            self.target.set_make_working_trees(self.source.make_working_trees())
3600
 
        except (errors.RepositoryUpgradeRequired, NotImplemented):
3601
 
            pass
3602
 
        # FIXME do not peek!
3603
 
        if self.source._transport.listable():
3604
 
            pb = ui.ui_factory.nested_progress_bar()
 
1691
        if basis is not None:
 
1692
            # copy the basis in, then fetch remaining data.
 
1693
            basis.copy_content_into(self.target, revision_id)
 
1694
            # the basis copy_content_into could miss-set this.
3605
1695
            try:
3606
 
                self.target.texts.insert_record_stream(
3607
 
                    self.source.texts.get_record_stream(
3608
 
                        self.source.texts.keys(), 'topological', False))
3609
 
                pb.update('Copying inventory', 0, 1)
3610
 
                self.target.inventories.insert_record_stream(
3611
 
                    self.source.inventories.get_record_stream(
3612
 
                        self.source.inventories.keys(), 'topological', False))
3613
 
                self.target.signatures.insert_record_stream(
3614
 
                    self.source.signatures.get_record_stream(
3615
 
                        self.source.signatures.keys(),
3616
 
                        'unordered', True))
3617
 
                self.target.revisions.insert_record_stream(
3618
 
                    self.source.revisions.get_record_stream(
3619
 
                        self.source.revisions.keys(),
3620
 
                        'topological', True))
3621
 
            finally:
3622
 
                pb.finished()
3623
 
        else:
 
1696
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1697
            except NotImplementedError:
 
1698
                pass
3624
1699
            self.target.fetch(self.source, revision_id=revision_id)
 
1700
        else:
 
1701
            try:
 
1702
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1703
            except NotImplementedError:
 
1704
                pass
 
1705
            # FIXME do not peek!
 
1706
            if self.source.control_files._transport.listable():
 
1707
                pb = ui.ui_factory.nested_progress_bar()
 
1708
                try:
 
1709
                    self.target.weave_store.copy_all_ids(
 
1710
                        self.source.weave_store,
 
1711
                        pb=pb,
 
1712
                        from_transaction=self.source.get_transaction(),
 
1713
                        to_transaction=self.target.get_transaction())
 
1714
                    pb.update('copying inventory', 0, 1)
 
1715
                    self.target.control_weaves.copy_multi(
 
1716
                        self.source.control_weaves, ['inventory'],
 
1717
                        from_transaction=self.source.get_transaction(),
 
1718
                        to_transaction=self.target.get_transaction())
 
1719
                    self.target._revision_store.text_store.copy_all_ids(
 
1720
                        self.source._revision_store.text_store,
 
1721
                        pb=pb)
 
1722
                finally:
 
1723
                    pb.finished()
 
1724
            else:
 
1725
                self.target.fetch(self.source, revision_id=revision_id)
 
1726
 
 
1727
    @needs_write_lock
 
1728
    def fetch(self, revision_id=None, pb=None):
 
1729
        """See InterRepository.fetch()."""
 
1730
        from bzrlib.fetch import GenericRepoFetcher
 
1731
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1732
               self.source, self.source._format, self.target, self.target._format)
 
1733
        f = GenericRepoFetcher(to_repository=self.target,
 
1734
                               from_repository=self.source,
 
1735
                               last_revision=revision_id,
 
1736
                               pb=pb)
 
1737
        return f.count_copied, f.failed_revisions
3625
1738
 
3626
1739
    @needs_read_lock
3627
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
1740
    def missing_revision_ids(self, revision_id=None):
3628
1741
        """See InterRepository.missing_revision_ids()."""
3629
1742
        # we want all revisions to satisfy revision_id in source.
3630
1743
        # but we don't want to stat every file here and there.
3631
 
        # we want then, all revisions other needs to satisfy revision_id
 
1744
        # we want then, all revisions other needs to satisfy revision_id 
3632
1745
        # checked, but not those that we have locally.
3633
 
        # so the first thing is to get a subset of the revisions to
 
1746
        # so the first thing is to get a subset of the revisions to 
3634
1747
        # satisfy revision_id in source, and then eliminate those that
3635
 
        # we do already have.
3636
 
        # this is slow on high latency connection to self, but as this
3637
 
        # disk format scales terribly for push anyway due to rewriting
 
1748
        # we do already have. 
 
1749
        # this is slow on high latency connection to self, but as as this
 
1750
        # disk format scales terribly for push anyway due to rewriting 
3638
1751
        # inventory.weave, this is considered acceptable.
3639
1752
        # - RBC 20060209
3640
1753
        if revision_id is not None:
3641
1754
            source_ids = self.source.get_ancestry(revision_id)
3642
 
            if source_ids[0] is not None:
3643
 
                raise AssertionError()
 
1755
            assert source_ids[0] == None
3644
1756
            source_ids.pop(0)
3645
1757
        else:
3646
1758
            source_ids = self.source._all_possible_ids()
3651
1763
        # we do not have a revision as that would be pointless.
3652
1764
        target_ids = set(self.target._all_possible_ids())
3653
1765
        possibly_present_revisions = target_ids.intersection(source_ids_set)
3654
 
        actually_present_revisions = set(
3655
 
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
1766
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
3656
1767
        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]
3657
1769
        if revision_id is not None:
3658
1770
            # we used get_ancestry to determine source_ids then we are assured all
3659
1771
            # revisions referenced are present as they are installed in topological order.
3660
1772
            # and the tip revision was validated by get_ancestry.
3661
 
            result_set = required_revisions
 
1773
            return required_topo_revisions
3662
1774
        else:
3663
 
            # if we just grabbed the possibly available ids, then
 
1775
            # if we just grabbed the possibly available ids, then 
3664
1776
            # we only have an estimate of whats available and need to validate
3665
1777
            # that against the revision records.
3666
 
            result_set = set(
3667
 
                self.source._eliminate_revisions_not_present(required_revisions))
3668
 
        return self.source.revision_ids_to_search_result(result_set)
3669
 
 
3670
 
 
3671
 
class InterKnitRepo(InterSameDataRepository):
 
1778
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
1779
 
 
1780
 
 
1781
class InterKnitRepo(InterRepository):
3672
1782
    """Optimised code paths between Knit based repositories."""
3673
1783
 
3674
 
    @classmethod
3675
 
    def _get_repo_format_to_test(self):
3676
 
        from bzrlib.repofmt import knitrepo
3677
 
        return knitrepo.RepositoryFormatKnit1()
 
1784
    _matching_repo_format = RepositoryFormatKnit1()
 
1785
    """Repository format for testing with."""
3678
1786
 
3679
1787
    @staticmethod
3680
1788
    def is_compatible(source, target):
3681
1789
        """Be compatible with known Knit formats.
3682
 
 
 
1790
        
3683
1791
        We don't test for the stores being of specific types because that
3684
 
        could lead to confusing results, and there is no need to be
 
1792
        could lead to confusing results, and there is no need to be 
3685
1793
        overly general.
3686
1794
        """
3687
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3688
1795
        try:
3689
 
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
3690
 
                isinstance(target._format, RepositoryFormatKnit))
 
1796
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
 
1797
                    isinstance(target._format, (RepositoryFormatKnit1)))
3691
1798
        except AttributeError:
3692
1799
            return False
3693
 
        return are_knits and InterRepository._same_model(source, target)
 
1800
 
 
1801
    @needs_write_lock
 
1802
    def fetch(self, revision_id=None, pb=None):
 
1803
        """See InterRepository.fetch()."""
 
1804
        from bzrlib.fetch import KnitRepoFetcher
 
1805
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1806
               self.source, self.source._format, self.target, self.target._format)
 
1807
        f = KnitRepoFetcher(to_repository=self.target,
 
1808
                            from_repository=self.source,
 
1809
                            last_revision=revision_id,
 
1810
                            pb=pb)
 
1811
        return f.count_copied, f.failed_revisions
3694
1812
 
3695
1813
    @needs_read_lock
3696
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
1814
    def missing_revision_ids(self, revision_id=None):
3697
1815
        """See InterRepository.missing_revision_ids()."""
3698
1816
        if revision_id is not None:
3699
1817
            source_ids = self.source.get_ancestry(revision_id)
3700
 
            if source_ids[0] is not None:
3701
 
                raise AssertionError()
 
1818
            assert source_ids[0] == None
3702
1819
            source_ids.pop(0)
3703
1820
        else:
3704
 
            source_ids = self.source.all_revision_ids()
 
1821
            source_ids = self.source._all_possible_ids()
3705
1822
        source_ids_set = set(source_ids)
3706
1823
        # source_ids is the worst possible case we may need to pull.
3707
1824
        # now we want to filter source_ids against what we actually
3708
1825
        # have in target, but don't try to check for existence where we know
3709
1826
        # we do not have a revision as that would be pointless.
3710
 
        target_ids = set(self.target.all_revision_ids())
 
1827
        target_ids = set(self.target._all_possible_ids())
3711
1828
        possibly_present_revisions = target_ids.intersection(source_ids_set)
3712
 
        actually_present_revisions = set(
3713
 
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
1829
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
3714
1830
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
1831
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
3715
1832
        if revision_id is not None:
3716
1833
            # we used get_ancestry to determine source_ids then we are assured all
3717
1834
            # revisions referenced are present as they are installed in topological order.
3718
1835
            # and the tip revision was validated by get_ancestry.
3719
 
            result_set = required_revisions
 
1836
            return required_topo_revisions
3720
1837
        else:
3721
 
            # if we just grabbed the possibly available ids, then
 
1838
            # if we just grabbed the possibly available ids, then 
3722
1839
            # we only have an estimate of whats available and need to validate
3723
1840
            # that against the revision records.
3724
 
            result_set = set(
3725
 
                self.source._eliminate_revisions_not_present(required_revisions))
3726
 
        return self.source.revision_ids_to_search_result(result_set)
3727
 
 
3728
 
 
3729
 
class InterDifferingSerializer(InterRepository):
3730
 
 
3731
 
    @classmethod
3732
 
    def _get_repo_format_to_test(self):
3733
 
        return None
3734
 
 
3735
 
    @staticmethod
3736
 
    def is_compatible(source, target):
3737
 
        """Be compatible with Knit2 source and Knit3 target"""
3738
 
        # This is redundant with format.check_conversion_target(), however that
3739
 
        # raises an exception, and we just want to say "False" as in we won't
3740
 
        # support converting between these formats.
3741
 
        if 'IDS_never' in debug.debug_flags:
3742
 
            return False
3743
 
        if source.supports_rich_root() and not target.supports_rich_root():
3744
 
            return False
3745
 
        if (source._format.supports_tree_reference
3746
 
            and not target._format.supports_tree_reference):
3747
 
            return False
3748
 
        if target._fallback_repositories and target._format.supports_chks:
3749
 
            # IDS doesn't know how to copy CHKs for the parent inventories it
3750
 
            # adds to stacked repos.
3751
 
            return False
3752
 
        if 'IDS_always' in debug.debug_flags:
3753
 
            return True
3754
 
        # Only use this code path for local source and target.  IDS does far
3755
 
        # too much IO (both bandwidth and roundtrips) over a network.
3756
 
        if not source.bzrdir.transport.base.startswith('file:///'):
3757
 
            return False
3758
 
        if not target.bzrdir.transport.base.startswith('file:///'):
3759
 
            return False
3760
 
        return True
3761
 
 
3762
 
    def _get_trees(self, revision_ids, cache):
3763
 
        possible_trees = []
3764
 
        for rev_id in revision_ids:
3765
 
            if rev_id in cache:
3766
 
                possible_trees.append((rev_id, cache[rev_id]))
3767
 
            else:
3768
 
                # Not cached, but inventory might be present anyway.
3769
 
                try:
3770
 
                    tree = self.source.revision_tree(rev_id)
3771
 
                except errors.NoSuchRevision:
3772
 
                    # Nope, parent is ghost.
3773
 
                    pass
3774
 
                else:
3775
 
                    cache[rev_id] = tree
3776
 
                    possible_trees.append((rev_id, tree))
3777
 
        return possible_trees
3778
 
 
3779
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3780
 
        """Get the best delta and base for this revision.
3781
 
 
3782
 
        :return: (basis_id, delta)
3783
 
        """
3784
 
        deltas = []
3785
 
        # Generate deltas against each tree, to find the shortest.
3786
 
        texts_possibly_new_in_tree = set()
3787
 
        for basis_id, basis_tree in possible_trees:
3788
 
            delta = tree.inventory._make_delta(basis_tree.inventory)
3789
 
            for old_path, new_path, file_id, new_entry in delta:
3790
 
                if new_path is None:
3791
 
                    # This file_id isn't present in the new rev, so we don't
3792
 
                    # care about it.
3793
 
                    continue
3794
 
                if not new_path:
3795
 
                    # Rich roots are handled elsewhere...
3796
 
                    continue
3797
 
                kind = new_entry.kind
3798
 
                if kind != 'directory' and kind != 'file':
3799
 
                    # No text record associated with this inventory entry.
3800
 
                    continue
3801
 
                # This is a directory or file that has changed somehow.
3802
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3803
 
            deltas.append((len(delta), basis_id, delta))
3804
 
        deltas.sort()
3805
 
        return deltas[0][1:]
3806
 
 
3807
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3808
 
        """Find all parent revisions that are absent, but for which the
3809
 
        inventory is present, and copy those inventories.
3810
 
 
3811
 
        This is necessary to preserve correctness when the source is stacked
3812
 
        without fallbacks configured.  (Note that in cases like upgrade the
3813
 
        source may be not have _fallback_repositories even though it is
3814
 
        stacked.)
3815
 
        """
3816
 
        parent_revs = set()
3817
 
        for parents in parent_map.values():
3818
 
            parent_revs.update(parents)
3819
 
        present_parents = self.source.get_parent_map(parent_revs)
3820
 
        absent_parents = set(parent_revs).difference(present_parents)
3821
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3822
 
            (rev_id,) for rev_id in absent_parents)
3823
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3824
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3825
 
            current_revision_id = parent_tree.get_revision_id()
3826
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3827
 
                (current_revision_id,)]
3828
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3829
 
            basis_id = _mod_revision.NULL_REVISION
3830
 
            basis_tree = self.source.revision_tree(basis_id)
3831
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3832
 
            self.target.add_inventory_by_delta(
3833
 
                basis_id, delta, current_revision_id, parents_parents)
3834
 
            cache[current_revision_id] = parent_tree
3835
 
 
3836
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3837
 
        """Fetch across a few revisions.
3838
 
 
3839
 
        :param revision_ids: The revisions to copy
3840
 
        :param basis_id: The revision_id of a tree that must be in cache, used
3841
 
            as a basis for delta when no other base is available
3842
 
        :param cache: A cache of RevisionTrees that we can use.
3843
 
        :param a_graph: A Graph object to determine the heads() of the
3844
 
            rich-root data stream.
3845
 
        :return: The revision_id of the last converted tree. The RevisionTree
3846
 
            for it will be in cache
3847
 
        """
3848
 
        # Walk though all revisions; get inventory deltas, copy referenced
3849
 
        # texts that delta references, insert the delta, revision and
3850
 
        # signature.
3851
 
        root_keys_to_create = set()
3852
 
        text_keys = set()
3853
 
        pending_deltas = []
3854
 
        pending_revisions = []
3855
 
        parent_map = self.source.get_parent_map(revision_ids)
3856
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3857
 
        self.source._safe_to_return_from_cache = True
3858
 
        for tree in self.source.revision_trees(revision_ids):
3859
 
            # Find a inventory delta for this revision.
3860
 
            # Find text entries that need to be copied, too.
3861
 
            current_revision_id = tree.get_revision_id()
3862
 
            parent_ids = parent_map.get(current_revision_id, ())
3863
 
            parent_trees = self._get_trees(parent_ids, cache)
3864
 
            possible_trees = list(parent_trees)
3865
 
            if len(possible_trees) == 0:
3866
 
                # There either aren't any parents, or the parents are ghosts,
3867
 
                # so just use the last converted tree.
3868
 
                possible_trees.append((basis_id, cache[basis_id]))
3869
 
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3870
 
                                                           possible_trees)
3871
 
            revision = self.source.get_revision(current_revision_id)
3872
 
            pending_deltas.append((basis_id, delta,
3873
 
                current_revision_id, revision.parent_ids))
3874
 
            if self._converting_to_rich_root:
3875
 
                self._revision_id_to_root_id[current_revision_id] = \
3876
 
                    tree.get_root_id()
3877
 
            # Determine which texts are in present in this revision but not in
3878
 
            # any of the available parents.
3879
 
            texts_possibly_new_in_tree = set()
3880
 
            for old_path, new_path, file_id, entry in delta:
3881
 
                if new_path is None:
3882
 
                    # This file_id isn't present in the new rev
3883
 
                    continue
3884
 
                if not new_path:
3885
 
                    # This is the root
3886
 
                    if not self.target.supports_rich_root():
3887
 
                        # The target doesn't support rich root, so we don't
3888
 
                        # copy
3889
 
                        continue
3890
 
                    if self._converting_to_rich_root:
3891
 
                        # This can't be copied normally, we have to insert
3892
 
                        # it specially
3893
 
                        root_keys_to_create.add((file_id, entry.revision))
3894
 
                        continue
3895
 
                kind = entry.kind
3896
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3897
 
            for basis_id, basis_tree in possible_trees:
3898
 
                basis_inv = basis_tree.inventory
3899
 
                for file_key in list(texts_possibly_new_in_tree):
3900
 
                    file_id, file_revision = file_key
3901
 
                    try:
3902
 
                        entry = basis_inv[file_id]
3903
 
                    except errors.NoSuchId:
3904
 
                        continue
3905
 
                    if entry.revision == file_revision:
3906
 
                        texts_possibly_new_in_tree.remove(file_key)
3907
 
            text_keys.update(texts_possibly_new_in_tree)
3908
 
            pending_revisions.append(revision)
3909
 
            cache[current_revision_id] = tree
3910
 
            basis_id = current_revision_id
3911
 
        self.source._safe_to_return_from_cache = False
3912
 
        # Copy file texts
3913
 
        from_texts = self.source.texts
3914
 
        to_texts = self.target.texts
3915
 
        if root_keys_to_create:
3916
 
            root_stream = _mod_fetch._new_root_data_stream(
3917
 
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3918
 
                self.source, graph=a_graph)
3919
 
            to_texts.insert_record_stream(root_stream)
3920
 
        to_texts.insert_record_stream(from_texts.get_record_stream(
3921
 
            text_keys, self.target._format._fetch_order,
3922
 
            not self.target._format._fetch_uses_deltas))
3923
 
        # insert inventory deltas
3924
 
        for delta in pending_deltas:
3925
 
            self.target.add_inventory_by_delta(*delta)
3926
 
        if self.target._fallback_repositories:
3927
 
            # Make sure this stacked repository has all the parent inventories
3928
 
            # for the new revisions that we are about to insert.  We do this
3929
 
            # before adding the revisions so that no revision is added until
3930
 
            # all the inventories it may depend on are added.
3931
 
            # Note that this is overzealous, as we may have fetched these in an
3932
 
            # earlier batch.
3933
 
            parent_ids = set()
3934
 
            revision_ids = set()
3935
 
            for revision in pending_revisions:
3936
 
                revision_ids.add(revision.revision_id)
3937
 
                parent_ids.update(revision.parent_ids)
3938
 
            parent_ids.difference_update(revision_ids)
3939
 
            parent_ids.discard(_mod_revision.NULL_REVISION)
3940
 
            parent_map = self.source.get_parent_map(parent_ids)
3941
 
            # we iterate over parent_map and not parent_ids because we don't
3942
 
            # want to try copying any revision which is a ghost
3943
 
            for parent_tree in self.source.revision_trees(parent_map):
3944
 
                current_revision_id = parent_tree.get_revision_id()
3945
 
                parents_parents = parent_map[current_revision_id]
3946
 
                possible_trees = self._get_trees(parents_parents, cache)
3947
 
                if len(possible_trees) == 0:
3948
 
                    # There either aren't any parents, or the parents are
3949
 
                    # ghosts, so just use the last converted tree.
3950
 
                    possible_trees.append((basis_id, cache[basis_id]))
3951
 
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3952
 
                    parents_parents, possible_trees)
3953
 
                self.target.add_inventory_by_delta(
3954
 
                    basis_id, delta, current_revision_id, parents_parents)
3955
 
        # insert signatures and revisions
3956
 
        for revision in pending_revisions:
3957
 
            try:
3958
 
                signature = self.source.get_signature_text(
3959
 
                    revision.revision_id)
3960
 
                self.target.add_signature_text(revision.revision_id,
3961
 
                    signature)
3962
 
            except errors.NoSuchRevision:
3963
 
                pass
3964
 
            self.target.add_revision(revision.revision_id, revision)
3965
 
        return basis_id
3966
 
 
3967
 
    def _fetch_all_revisions(self, revision_ids, pb):
3968
 
        """Fetch everything for the list of revisions.
3969
 
 
3970
 
        :param revision_ids: The list of revisions to fetch. Must be in
3971
 
            topological order.
3972
 
        :param pb: A ProgressTask
3973
 
        :return: None
3974
 
        """
3975
 
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3976
 
        batch_size = 100
3977
 
        cache = lru_cache.LRUCache(100)
3978
 
        cache[basis_id] = basis_tree
3979
 
        del basis_tree # We don't want to hang on to it here
3980
 
        hints = []
3981
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3982
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3983
 
                                                            revision_ids)
3984
 
        else:
3985
 
            a_graph = None
3986
 
 
3987
 
        for offset in range(0, len(revision_ids), batch_size):
3988
 
            self.target.start_write_group()
3989
 
            try:
3990
 
                pb.update('Transferring revisions', offset,
3991
 
                          len(revision_ids))
3992
 
                batch = revision_ids[offset:offset+batch_size]
3993
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3994
 
                                             a_graph=a_graph)
3995
 
            except:
3996
 
                self.source._safe_to_return_from_cache = False
3997
 
                self.target.abort_write_group()
3998
 
                raise
3999
 
            else:
4000
 
                hint = self.target.commit_write_group()
4001
 
                if hint:
4002
 
                    hints.extend(hint)
4003
 
        if hints and self.target._format.pack_compresses:
4004
 
            self.target.pack(hint=hints)
4005
 
        pb.update('Transferring revisions', len(revision_ids),
4006
 
                  len(revision_ids))
4007
 
 
4008
 
    @needs_write_lock
4009
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
4010
 
            fetch_spec=None):
4011
 
        """See InterRepository.fetch()."""
4012
 
        if fetch_spec is not None:
4013
 
            raise AssertionError("Not implemented yet...")
4014
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4015
 
        if (not self.source.supports_rich_root()
4016
 
            and self.target.supports_rich_root()):
4017
 
            self._converting_to_rich_root = True
4018
 
            self._revision_id_to_root_id = {}
4019
 
        else:
4020
 
            self._converting_to_rich_root = False
4021
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4022
 
        if self.source._format.network_name() != self.target._format.network_name():
4023
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4024
 
                from_format=self.source._format,
4025
 
                to_format=self.target._format)
4026
 
        revision_ids = self.target.search_missing_revision_ids(self.source,
4027
 
            revision_id, find_ghosts=find_ghosts).get_keys()
4028
 
        if not revision_ids:
4029
 
            return 0, 0
4030
 
        revision_ids = tsort.topo_sort(
4031
 
            self.source.get_graph().get_parent_map(revision_ids))
4032
 
        if not revision_ids:
4033
 
            return 0, 0
4034
 
        # Walk though all revisions; get inventory deltas, copy referenced
4035
 
        # texts that delta references, insert the delta, revision and
4036
 
        # signature.
4037
 
        if pb is None:
4038
 
            my_pb = ui.ui_factory.nested_progress_bar()
4039
 
            pb = my_pb
4040
 
        else:
4041
 
            symbol_versioning.warn(
4042
 
                symbol_versioning.deprecated_in((1, 14, 0))
4043
 
                % "pb parameter to fetch()")
4044
 
            my_pb = None
4045
 
        try:
4046
 
            self._fetch_all_revisions(revision_ids, pb)
4047
 
        finally:
4048
 
            if my_pb is not None:
4049
 
                my_pb.finished()
4050
 
        return len(revision_ids), 0
4051
 
 
4052
 
    def _get_basis(self, first_revision_id):
4053
 
        """Get a revision and tree which exists in the target.
4054
 
 
4055
 
        This assumes that first_revision_id is selected for transmission
4056
 
        because all other ancestors are already present. If we can't find an
4057
 
        ancestor we fall back to NULL_REVISION since we know that is safe.
4058
 
 
4059
 
        :return: (basis_id, basis_tree)
4060
 
        """
4061
 
        first_rev = self.source.get_revision(first_revision_id)
4062
 
        try:
4063
 
            basis_id = first_rev.parent_ids[0]
4064
 
            # only valid as a basis if the target has it
4065
 
            self.target.get_revision(basis_id)
4066
 
            # Try to get a basis tree - if its a ghost it will hit the
4067
 
            # NoSuchRevision case.
4068
 
            basis_tree = self.source.revision_tree(basis_id)
4069
 
        except (IndexError, errors.NoSuchRevision):
4070
 
            basis_id = _mod_revision.NULL_REVISION
4071
 
            basis_tree = self.source.revision_tree(basis_id)
4072
 
        return basis_id, basis_tree
4073
 
 
4074
 
 
4075
 
InterRepository.register_optimiser(InterDifferingSerializer)
4076
 
InterRepository.register_optimiser(InterSameDataRepository)
 
1841
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
1842
 
4077
1843
InterRepository.register_optimiser(InterWeaveRepo)
4078
1844
InterRepository.register_optimiser(InterKnitRepo)
4079
1845
 
4080
1846
 
 
1847
class RepositoryTestProviderAdapter(object):
 
1848
    """A tool to generate a suite testing multiple repository formats at once.
 
1849
 
 
1850
    This is done by copying the test once for each transport and injecting
 
1851
    the transport_server, transport_readonly_server, and bzrdir_format and
 
1852
    repository_format classes into each copy. Each copy is also given a new id()
 
1853
    to make it easy to identify.
 
1854
    """
 
1855
 
 
1856
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1857
        self._transport_server = transport_server
 
1858
        self._transport_readonly_server = transport_readonly_server
 
1859
        self._formats = formats
 
1860
    
 
1861
    def adapt(self, test):
 
1862
        result = TestSuite()
 
1863
        for repository_format, bzrdir_format in self._formats:
 
1864
            new_test = deepcopy(test)
 
1865
            new_test.transport_server = self._transport_server
 
1866
            new_test.transport_readonly_server = self._transport_readonly_server
 
1867
            new_test.bzrdir_format = bzrdir_format
 
1868
            new_test.repository_format = repository_format
 
1869
            def make_new_test_id():
 
1870
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
 
1871
                return lambda: new_id
 
1872
            new_test.id = make_new_test_id()
 
1873
            result.addTest(new_test)
 
1874
        return result
 
1875
 
 
1876
 
 
1877
class InterRepositoryTestProviderAdapter(object):
 
1878
    """A tool to generate a suite testing multiple inter repository formats.
 
1879
 
 
1880
    This is done by copying the test once for each interrepo provider and injecting
 
1881
    the transport_server, transport_readonly_server, repository_format and 
 
1882
    repository_to_format classes into each copy.
 
1883
    Each copy is also given a new id() to make it easy to identify.
 
1884
    """
 
1885
 
 
1886
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1887
        self._transport_server = transport_server
 
1888
        self._transport_readonly_server = transport_readonly_server
 
1889
        self._formats = formats
 
1890
    
 
1891
    def adapt(self, test):
 
1892
        result = TestSuite()
 
1893
        for interrepo_class, repository_format, repository_format_to in self._formats:
 
1894
            new_test = deepcopy(test)
 
1895
            new_test.transport_server = self._transport_server
 
1896
            new_test.transport_readonly_server = self._transport_readonly_server
 
1897
            new_test.interrepo_class = interrepo_class
 
1898
            new_test.repository_format = repository_format
 
1899
            new_test.repository_format_to = repository_format_to
 
1900
            def make_new_test_id():
 
1901
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
 
1902
                return lambda: new_id
 
1903
            new_test.id = make_new_test_id()
 
1904
            result.addTest(new_test)
 
1905
        return result
 
1906
 
 
1907
    @staticmethod
 
1908
    def default_test_list():
 
1909
        """Generate the default list of interrepo permutations to test."""
 
1910
        result = []
 
1911
        # test the default InterRepository between format 6 and the current 
 
1912
        # default format.
 
1913
        # XXX: robertc 20060220 reinstate this when there are two supported
 
1914
        # formats which do not have an optimal code path between them.
 
1915
        result.append((InterRepository,
 
1916
                       RepositoryFormat6(),
 
1917
                       RepositoryFormatKnit1()))
 
1918
        for optimiser in InterRepository._optimisers:
 
1919
            result.append((optimiser,
 
1920
                           optimiser._matching_repo_format,
 
1921
                           optimiser._matching_repo_format
 
1922
                           ))
 
1923
        # if there are specific combinations we want to use, we can add them 
 
1924
        # here.
 
1925
        return result
 
1926
 
 
1927
 
4081
1928
class CopyConverter(object):
4082
1929
    """A repository conversion tool which just performs a copy of the content.
4083
 
 
 
1930
    
4084
1931
    This is slow but quite reliable.
4085
1932
    """
4086
1933
 
4090
1937
        :param target_format: The format the resulting repository should be.
4091
1938
        """
4092
1939
        self.target_format = target_format
4093
 
 
 
1940
        
4094
1941
    def convert(self, repo, pb):
4095
1942
        """Perform the conversion of to_convert, giving feedback via pb.
4096
1943
 
4097
1944
        :param to_convert: The disk object to convert.
4098
1945
        :param pb: a progress bar to use for progress information.
4099
1946
        """
4100
 
        pb = ui.ui_factory.nested_progress_bar()
 
1947
        self.pb = pb
4101
1948
        self.count = 0
4102
1949
        self.total = 4
4103
1950
        # this is only useful with metadir layouts - separated repo content.
4104
1951
        # trigger an assertion if not such
4105
1952
        repo._format.get_format_string()
4106
1953
        self.repo_dir = repo.bzrdir
4107
 
        pb.update('Moving repository to repository.backup')
 
1954
        self.step('Moving repository to repository.backup')
4108
1955
        self.repo_dir.transport.move('repository', 'repository.backup')
4109
1956
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4110
 
        repo._format.check_conversion_target(self.target_format)
4111
1957
        self.source_repo = repo._format.open(self.repo_dir,
4112
1958
            _found=True,
4113
1959
            _override_transport=backup_transport)
4114
 
        pb.update('Creating new repository')
 
1960
        self.step('Creating new repository')
4115
1961
        converted = self.target_format.initialize(self.repo_dir,
4116
1962
                                                  self.source_repo.is_shared())
4117
1963
        converted.lock_write()
4118
1964
        try:
4119
 
            pb.update('Copying content')
 
1965
            self.step('Copying content into repository.')
4120
1966
            self.source_repo.copy_content_into(converted)
4121
1967
        finally:
4122
1968
            converted.unlock()
4123
 
        pb.update('Deleting old repository content')
 
1969
        self.step('Deleting old repository content.')
4124
1970
        self.repo_dir.transport.delete_tree('repository.backup')
4125
 
        ui.ui_factory.note('repository converted')
4126
 
        pb.finished()
4127
 
 
4128
 
 
4129
 
_unescape_map = {
4130
 
    'apos':"'",
4131
 
    'quot':'"',
4132
 
    'amp':'&',
4133
 
    'lt':'<',
4134
 
    'gt':'>'
4135
 
}
4136
 
 
4137
 
 
4138
 
def _unescaper(match, _map=_unescape_map):
4139
 
    code = match.group(1)
4140
 
    try:
4141
 
        return _map[code]
4142
 
    except KeyError:
4143
 
        if not code.startswith('#'):
4144
 
            raise
4145
 
        return unichr(int(code[1:])).encode('utf8')
4146
 
 
4147
 
 
4148
 
_unescape_re = None
4149
 
 
4150
 
 
 
1971
        self.pb.note('repository converted')
 
1972
 
 
1973
    def step(self, message):
 
1974
        """Update the pb by a step."""
 
1975
        self.count +=1
 
1976
        self.pb.update(message, self.count, self.total)
 
1977
 
 
1978
 
 
1979
class CommitBuilder(object):
 
1980
    """Provides an interface to build up a commit.
 
1981
 
 
1982
    This allows describing a tree to be committed without needing to 
 
1983
    know the internals of the format of the repository.
 
1984
    """
 
1985
    def __init__(self, repository, parents, config, timestamp=None, 
 
1986
                 timezone=None, committer=None, revprops=None, 
 
1987
                 revision_id=None):
 
1988
        """Initiate a CommitBuilder.
 
1989
 
 
1990
        :param repository: Repository to commit to.
 
1991
        :param parents: Revision ids of the parents of the new revision.
 
1992
        :param config: Configuration to use.
 
1993
        :param timestamp: Optional timestamp recorded for commit.
 
1994
        :param timezone: Optional timezone for timestamp.
 
1995
        :param committer: Optional committer to set for commit.
 
1996
        :param revprops: Optional dictionary of revision properties.
 
1997
        :param revision_id: Optional revision id.
 
1998
        """
 
1999
        self._config = config
 
2000
 
 
2001
        if committer is None:
 
2002
            self._committer = self._config.username()
 
2003
        else:
 
2004
            assert isinstance(committer, basestring), type(committer)
 
2005
            self._committer = committer
 
2006
 
 
2007
        self.new_inventory = Inventory()
 
2008
        self._new_revision_id = revision_id
 
2009
        self.parents = parents
 
2010
        self.repository = repository
 
2011
 
 
2012
        self._revprops = {}
 
2013
        if revprops is not None:
 
2014
            self._revprops.update(revprops)
 
2015
 
 
2016
        if timestamp is None:
 
2017
            self._timestamp = time.time()
 
2018
        else:
 
2019
            self._timestamp = long(timestamp)
 
2020
 
 
2021
        if timezone is None:
 
2022
            self._timezone = local_time_offset()
 
2023
        else:
 
2024
            self._timezone = int(timezone)
 
2025
 
 
2026
        self._generate_revision_if_needed()
 
2027
 
 
2028
    def commit(self, message):
 
2029
        """Make the actual commit.
 
2030
 
 
2031
        :return: The revision id of the recorded revision.
 
2032
        """
 
2033
        rev = Revision(timestamp=self._timestamp,
 
2034
                       timezone=self._timezone,
 
2035
                       committer=self._committer,
 
2036
                       message=message,
 
2037
                       inventory_sha1=self.inv_sha1,
 
2038
                       revision_id=self._new_revision_id,
 
2039
                       properties=self._revprops)
 
2040
        rev.parent_ids = self.parents
 
2041
        self.repository.add_revision(self._new_revision_id, rev, 
 
2042
            self.new_inventory, self._config)
 
2043
        return self._new_revision_id
 
2044
 
 
2045
    def finish_inventory(self):
 
2046
        """Tell the builder that the inventory is finished."""
 
2047
        self.new_inventory.revision_id = self._new_revision_id
 
2048
        self.inv_sha1 = self.repository.add_inventory(
 
2049
            self._new_revision_id,
 
2050
            self.new_inventory,
 
2051
            self.parents
 
2052
            )
 
2053
 
 
2054
    def _gen_revision_id(self):
 
2055
        """Return new revision-id."""
 
2056
        s = '%s-%s-' % (self._config.user_email(), 
 
2057
                        compact_date(self._timestamp))
 
2058
        s += hexlify(rand_bytes(8))
 
2059
        return s
 
2060
 
 
2061
    def _generate_revision_if_needed(self):
 
2062
        """Create a revision id if None was supplied.
 
2063
        
 
2064
        If the repository can not support user-specified revision ids
 
2065
        they should override this function and raise UnsupportedOperation
 
2066
        if _new_revision_id is not None.
 
2067
 
 
2068
        :raises: UnsupportedOperation
 
2069
        """
 
2070
        if self._new_revision_id is None:
 
2071
            self._new_revision_id = self._gen_revision_id()
 
2072
 
 
2073
    def record_entry_contents(self, ie, parent_invs, path, tree):
 
2074
        """Record the content of ie from tree into the commit if needed.
 
2075
 
 
2076
        :param ie: An inventory entry present in the commit.
 
2077
        :param parent_invs: The inventories of the parent revisions of the
 
2078
            commit.
 
2079
        :param path: The path the entry is at in the tree.
 
2080
        :param tree: The tree which contains this entry and should be used to 
 
2081
        obtain content.
 
2082
        """
 
2083
        self.new_inventory.add(ie)
 
2084
 
 
2085
        # ie.revision is always None if the InventoryEntry is considered
 
2086
        # for committing. ie.snapshot will record the correct revision 
 
2087
        # which may be the sole parent if it is untouched.
 
2088
        if ie.revision is not None:
 
2089
            return
 
2090
        previous_entries = ie.find_previous_heads(
 
2091
            parent_invs,
 
2092
            self.repository.weave_store,
 
2093
            self.repository.get_transaction())
 
2094
        # we are creating a new revision for ie in the history store
 
2095
        # and inventory.
 
2096
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
 
2097
 
 
2098
    def modified_directory(self, file_id, file_parents):
 
2099
        """Record the presence of a symbolic link.
 
2100
 
 
2101
        :param file_id: The file_id of the link to record.
 
2102
        :param file_parents: The per-file parent revision ids.
 
2103
        """
 
2104
        self._add_text_to_weave(file_id, [], file_parents.keys())
 
2105
    
 
2106
    def modified_file_text(self, file_id, file_parents,
 
2107
                           get_content_byte_lines, text_sha1=None,
 
2108
                           text_size=None):
 
2109
        """Record the text of file file_id
 
2110
 
 
2111
        :param file_id: The file_id of the file to record the text of.
 
2112
        :param file_parents: The per-file parent revision ids.
 
2113
        :param get_content_byte_lines: A callable which will return the byte
 
2114
            lines for the file.
 
2115
        :param text_sha1: Optional SHA1 of the file contents.
 
2116
        :param text_size: Optional size of the file contents.
 
2117
        """
 
2118
        mutter('storing text of file {%s} in revision {%s} into %r',
 
2119
               file_id, self._new_revision_id, self.repository.weave_store)
 
2120
        # special case to avoid diffing on renames or 
 
2121
        # reparenting
 
2122
        if (len(file_parents) == 1
 
2123
            and text_sha1 == file_parents.values()[0].text_sha1
 
2124
            and text_size == file_parents.values()[0].text_size):
 
2125
            previous_ie = file_parents.values()[0]
 
2126
            versionedfile = self.repository.weave_store.get_weave(file_id, 
 
2127
                self.repository.get_transaction())
 
2128
            versionedfile.clone_text(self._new_revision_id, 
 
2129
                previous_ie.revision, file_parents.keys())
 
2130
            return text_sha1, text_size
 
2131
        else:
 
2132
            new_lines = get_content_byte_lines()
 
2133
            # TODO: Rather than invoking sha_strings here, _add_text_to_weave
 
2134
            # should return the SHA1 and size
 
2135
            self._add_text_to_weave(file_id, new_lines, file_parents.keys())
 
2136
            return osutils.sha_strings(new_lines), \
 
2137
                sum(map(len, new_lines))
 
2138
 
 
2139
    def modified_link(self, file_id, file_parents, link_target):
 
2140
        """Record the presence of a symbolic link.
 
2141
 
 
2142
        :param file_id: The file_id of the link to record.
 
2143
        :param file_parents: The per-file parent revision ids.
 
2144
        :param link_target: Target location of this link.
 
2145
        """
 
2146
        self._add_text_to_weave(file_id, [], file_parents.keys())
 
2147
 
 
2148
    def _add_text_to_weave(self, file_id, new_lines, parents):
 
2149
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
2150
            file_id, self.repository.get_transaction())
 
2151
        versionedfile.add_lines(self._new_revision_id, parents, new_lines)
 
2152
        versionedfile.clear_cache()
 
2153
 
 
2154
 
 
2155
# Copied from xml.sax.saxutils
4151
2156
def _unescape_xml(data):
4152
 
    """Unescape predefined XML entities in a string of data."""
4153
 
    global _unescape_re
4154
 
    if _unescape_re is None:
4155
 
        _unescape_re = re.compile('\&([^;]*);')
4156
 
    return _unescape_re.sub(_unescaper, data)
4157
 
 
4158
 
 
4159
 
class _VersionedFileChecker(object):
4160
 
 
4161
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
4162
 
        self.repository = repository
4163
 
        self.text_index = self.repository._generate_text_key_index(
4164
 
            text_key_references=text_key_references, ancestors=ancestors)
4165
 
 
4166
 
    def calculate_file_version_parents(self, text_key):
4167
 
        """Calculate the correct parents for a file version according to
4168
 
        the inventories.
4169
 
        """
4170
 
        parent_keys = self.text_index[text_key]
4171
 
        if parent_keys == [_mod_revision.NULL_REVISION]:
4172
 
            return ()
4173
 
        return tuple(parent_keys)
4174
 
 
4175
 
    def check_file_version_parents(self, texts, progress_bar=None):
4176
 
        """Check the parents stored in a versioned file are correct.
4177
 
 
4178
 
        It also detects file versions that are not referenced by their
4179
 
        corresponding revision's inventory.
4180
 
 
4181
 
        :returns: A tuple of (wrong_parents, dangling_file_versions).
4182
 
            wrong_parents is a dict mapping {revision_id: (stored_parents,
4183
 
            correct_parents)} for each revision_id where the stored parents
4184
 
            are not correct.  dangling_file_versions is a set of (file_id,
4185
 
            revision_id) tuples for versions that are present in this versioned
4186
 
            file, but not used by the corresponding inventory.
4187
 
        """
4188
 
        local_progress = None
4189
 
        if progress_bar is None:
4190
 
            local_progress = ui.ui_factory.nested_progress_bar()
4191
 
            progress_bar = local_progress
4192
 
        try:
4193
 
            return self._check_file_version_parents(texts, progress_bar)
4194
 
        finally:
4195
 
            if local_progress:
4196
 
                local_progress.finished()
4197
 
 
4198
 
    def _check_file_version_parents(self, texts, progress_bar):
4199
 
        """See check_file_version_parents."""
4200
 
        wrong_parents = {}
4201
 
        self.file_ids = set([file_id for file_id, _ in
4202
 
            self.text_index.iterkeys()])
4203
 
        # text keys is now grouped by file_id
4204
 
        n_versions = len(self.text_index)
4205
 
        progress_bar.update('loading text store', 0, n_versions)
4206
 
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4207
 
        # On unlistable transports this could well be empty/error...
4208
 
        text_keys = self.repository.texts.keys()
4209
 
        unused_keys = frozenset(text_keys) - set(self.text_index)
4210
 
        for num, key in enumerate(self.text_index.iterkeys()):
4211
 
            progress_bar.update('checking text graph', num, n_versions)
4212
 
            correct_parents = self.calculate_file_version_parents(key)
4213
 
            try:
4214
 
                knit_parents = parent_map[key]
4215
 
            except errors.RevisionNotPresent:
4216
 
                # Missing text!
4217
 
                knit_parents = None
4218
 
            if correct_parents != knit_parents:
4219
 
                wrong_parents[key] = (knit_parents, correct_parents)
4220
 
        return wrong_parents, unused_keys
4221
 
 
4222
 
 
4223
 
def _old_get_graph(repository, revision_id):
4224
 
    """DO NOT USE. That is all. I'm serious."""
4225
 
    graph = repository.get_graph()
4226
 
    revision_graph = dict(((key, value) for key, value in
4227
 
        graph.iter_ancestry([revision_id]) if value is not None))
4228
 
    return _strip_NULL_ghosts(revision_graph)
4229
 
 
4230
 
 
4231
 
def _strip_NULL_ghosts(revision_graph):
4232
 
    """Also don't use this. more compatibility code for unmigrated clients."""
4233
 
    # Filter ghosts, and null:
4234
 
    if _mod_revision.NULL_REVISION in revision_graph:
4235
 
        del revision_graph[_mod_revision.NULL_REVISION]
4236
 
    for key, parents in revision_graph.items():
4237
 
        revision_graph[key] = tuple(parent for parent in parents if parent
4238
 
            in revision_graph)
4239
 
    return revision_graph
4240
 
 
4241
 
 
4242
 
class StreamSink(object):
4243
 
    """An object that can insert a stream into a repository.
4244
 
 
4245
 
    This interface handles the complexity of reserialising inventories and
4246
 
    revisions from different formats, and allows unidirectional insertion into
4247
 
    stacked repositories without looking for the missing basis parents
4248
 
    beforehand.
4249
 
    """
4250
 
 
4251
 
    def __init__(self, target_repo):
4252
 
        self.target_repo = target_repo
4253
 
 
4254
 
    def insert_stream(self, stream, src_format, resume_tokens):
4255
 
        """Insert a stream's content into the target repository.
4256
 
 
4257
 
        :param src_format: a bzr repository format.
4258
 
 
4259
 
        :return: a list of resume tokens and an  iterable of keys additional
4260
 
            items required before the insertion can be completed.
4261
 
        """
4262
 
        self.target_repo.lock_write()
4263
 
        try:
4264
 
            if resume_tokens:
4265
 
                self.target_repo.resume_write_group(resume_tokens)
4266
 
                is_resume = True
4267
 
            else:
4268
 
                self.target_repo.start_write_group()
4269
 
                is_resume = False
4270
 
            try:
4271
 
                # locked_insert_stream performs a commit|suspend.
4272
 
                return self._locked_insert_stream(stream, src_format, is_resume)
4273
 
            except:
4274
 
                self.target_repo.abort_write_group(suppress_errors=True)
4275
 
                raise
4276
 
        finally:
4277
 
            self.target_repo.unlock()
4278
 
 
4279
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
4280
 
        to_serializer = self.target_repo._format._serializer
4281
 
        src_serializer = src_format._serializer
4282
 
        new_pack = None
4283
 
        if to_serializer == src_serializer:
4284
 
            # If serializers match and the target is a pack repository, set the
4285
 
            # write cache size on the new pack.  This avoids poor performance
4286
 
            # on transports where append is unbuffered (such as
4287
 
            # RemoteTransport).  This is safe to do because nothing should read
4288
 
            # back from the target repository while a stream with matching
4289
 
            # serialization is being inserted.
4290
 
            # The exception is that a delta record from the source that should
4291
 
            # be a fulltext may need to be expanded by the target (see
4292
 
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
4293
 
            # explicitly flush any buffered writes first in that rare case.
4294
 
            try:
4295
 
                new_pack = self.target_repo._pack_collection._new_pack
4296
 
            except AttributeError:
4297
 
                # Not a pack repository
4298
 
                pass
4299
 
            else:
4300
 
                new_pack.set_write_cache_size(1024*1024)
4301
 
        for substream_type, substream in stream:
4302
 
            if 'stream' in debug.debug_flags:
4303
 
                mutter('inserting substream: %s', substream_type)
4304
 
            if substream_type == 'texts':
4305
 
                self.target_repo.texts.insert_record_stream(substream)
4306
 
            elif substream_type == 'inventories':
4307
 
                if src_serializer == to_serializer:
4308
 
                    self.target_repo.inventories.insert_record_stream(
4309
 
                        substream)
4310
 
                else:
4311
 
                    self._extract_and_insert_inventories(
4312
 
                        substream, src_serializer)
4313
 
            elif substream_type == 'inventory-deltas':
4314
 
                self._extract_and_insert_inventory_deltas(
4315
 
                    substream, src_serializer)
4316
 
            elif substream_type == 'chk_bytes':
4317
 
                # XXX: This doesn't support conversions, as it assumes the
4318
 
                #      conversion was done in the fetch code.
4319
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4320
 
            elif substream_type == 'revisions':
4321
 
                # This may fallback to extract-and-insert more often than
4322
 
                # required if the serializers are different only in terms of
4323
 
                # the inventory.
4324
 
                if src_serializer == to_serializer:
4325
 
                    self.target_repo.revisions.insert_record_stream(
4326
 
                        substream)
4327
 
                else:
4328
 
                    self._extract_and_insert_revisions(substream,
4329
 
                        src_serializer)
4330
 
            elif substream_type == 'signatures':
4331
 
                self.target_repo.signatures.insert_record_stream(substream)
4332
 
            else:
4333
 
                raise AssertionError('kaboom! %s' % (substream_type,))
4334
 
        # Done inserting data, and the missing_keys calculations will try to
4335
 
        # read back from the inserted data, so flush the writes to the new pack
4336
 
        # (if this is pack format).
4337
 
        if new_pack is not None:
4338
 
            new_pack._write_data('', flush=True)
4339
 
        # Find all the new revisions (including ones from resume_tokens)
4340
 
        missing_keys = self.target_repo.get_missing_parent_inventories(
4341
 
            check_for_missing_texts=is_resume)
4342
 
        try:
4343
 
            for prefix, versioned_file in (
4344
 
                ('texts', self.target_repo.texts),
4345
 
                ('inventories', self.target_repo.inventories),
4346
 
                ('revisions', self.target_repo.revisions),
4347
 
                ('signatures', self.target_repo.signatures),
4348
 
                ('chk_bytes', self.target_repo.chk_bytes),
4349
 
                ):
4350
 
                if versioned_file is None:
4351
 
                    continue
4352
 
                # TODO: key is often going to be a StaticTuple object
4353
 
                #       I don't believe we can define a method by which
4354
 
                #       (prefix,) + StaticTuple will work, though we could
4355
 
                #       define a StaticTuple.sq_concat that would allow you to
4356
 
                #       pass in either a tuple or a StaticTuple as the second
4357
 
                #       object, so instead we could have:
4358
 
                #       StaticTuple(prefix) + key here...
4359
 
                missing_keys.update((prefix,) + key for key in
4360
 
                    versioned_file.get_missing_compression_parent_keys())
4361
 
        except NotImplementedError:
4362
 
            # cannot even attempt suspending, and missing would have failed
4363
 
            # during stream insertion.
4364
 
            missing_keys = set()
4365
 
        else:
4366
 
            if missing_keys:
4367
 
                # suspend the write group and tell the caller what we is
4368
 
                # missing. We know we can suspend or else we would not have
4369
 
                # entered this code path. (All repositories that can handle
4370
 
                # missing keys can handle suspending a write group).
4371
 
                write_group_tokens = self.target_repo.suspend_write_group()
4372
 
                return write_group_tokens, missing_keys
4373
 
        hint = self.target_repo.commit_write_group()
4374
 
        if (to_serializer != src_serializer and
4375
 
            self.target_repo._format.pack_compresses):
4376
 
            self.target_repo.pack(hint=hint)
4377
 
        return [], set()
4378
 
 
4379
 
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
4380
 
        target_rich_root = self.target_repo._format.rich_root_data
4381
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4382
 
        for record in substream:
4383
 
            # Insert the delta directly
4384
 
            inventory_delta_bytes = record.get_bytes_as('fulltext')
4385
 
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
4386
 
            try:
4387
 
                parse_result = deserialiser.parse_text_bytes(
4388
 
                    inventory_delta_bytes)
4389
 
            except inventory_delta.IncompatibleInventoryDelta, err:
4390
 
                trace.mutter("Incompatible delta: %s", err.msg)
4391
 
                raise errors.IncompatibleRevision(self.target_repo._format)
4392
 
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4393
 
            revision_id = new_id
4394
 
            parents = [key[0] for key in record.parents]
4395
 
            self.target_repo.add_inventory_by_delta(
4396
 
                basis_id, inv_delta, revision_id, parents)
4397
 
 
4398
 
    def _extract_and_insert_inventories(self, substream, serializer,
4399
 
            parse_delta=None):
4400
 
        """Generate a new inventory versionedfile in target, converting data.
4401
 
 
4402
 
        The inventory is retrieved from the source, (deserializing it), and
4403
 
        stored in the target (reserializing it in a different format).
4404
 
        """
4405
 
        target_rich_root = self.target_repo._format.rich_root_data
4406
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4407
 
        for record in substream:
4408
 
            # It's not a delta, so it must be a fulltext in the source
4409
 
            # serializer's format.
4410
 
            bytes = record.get_bytes_as('fulltext')
4411
 
            revision_id = record.key[0]
4412
 
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4413
 
            parents = [key[0] for key in record.parents]
4414
 
            self.target_repo.add_inventory(revision_id, inv, parents)
4415
 
            # No need to keep holding this full inv in memory when the rest of
4416
 
            # the substream is likely to be all deltas.
4417
 
            del inv
4418
 
 
4419
 
    def _extract_and_insert_revisions(self, substream, serializer):
4420
 
        for record in substream:
4421
 
            bytes = record.get_bytes_as('fulltext')
4422
 
            revision_id = record.key[0]
4423
 
            rev = serializer.read_revision_from_string(bytes)
4424
 
            if rev.revision_id != revision_id:
4425
 
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4426
 
            self.target_repo.add_revision(revision_id, rev)
4427
 
 
4428
 
    def finished(self):
4429
 
        if self.target_repo._format._fetch_reconcile:
4430
 
            self.target_repo.reconcile()
4431
 
 
4432
 
 
4433
 
class StreamSource(object):
4434
 
    """A source of a stream for fetching between repositories."""
4435
 
 
4436
 
    def __init__(self, from_repository, to_format):
4437
 
        """Create a StreamSource streaming from from_repository."""
4438
 
        self.from_repository = from_repository
4439
 
        self.to_format = to_format
4440
 
 
4441
 
    def delta_on_metadata(self):
4442
 
        """Return True if delta's are permitted on metadata streams.
4443
 
 
4444
 
        That is on revisions and signatures.
4445
 
        """
4446
 
        src_serializer = self.from_repository._format._serializer
4447
 
        target_serializer = self.to_format._serializer
4448
 
        return (self.to_format._fetch_uses_deltas and
4449
 
            src_serializer == target_serializer)
4450
 
 
4451
 
    def _fetch_revision_texts(self, revs):
4452
 
        # fetch signatures first and then the revision texts
4453
 
        # may need to be a InterRevisionStore call here.
4454
 
        from_sf = self.from_repository.signatures
4455
 
        # A missing signature is just skipped.
4456
 
        keys = [(rev_id,) for rev_id in revs]
4457
 
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4458
 
            keys,
4459
 
            self.to_format._fetch_order,
4460
 
            not self.to_format._fetch_uses_deltas))
4461
 
        # If a revision has a delta, this is actually expanded inside the
4462
 
        # insert_record_stream code now, which is an alternate fix for
4463
 
        # bug #261339
4464
 
        from_rf = self.from_repository.revisions
4465
 
        revisions = from_rf.get_record_stream(
4466
 
            keys,
4467
 
            self.to_format._fetch_order,
4468
 
            not self.delta_on_metadata())
4469
 
        return [('signatures', signatures), ('revisions', revisions)]
4470
 
 
4471
 
    def _generate_root_texts(self, revs):
4472
 
        """This will be called by get_stream between fetching weave texts and
4473
 
        fetching the inventory weave.
4474
 
        """
4475
 
        if self._rich_root_upgrade():
4476
 
            return _mod_fetch.Inter1and2Helper(
4477
 
                self.from_repository).generate_root_texts(revs)
4478
 
        else:
4479
 
            return []
4480
 
 
4481
 
    def get_stream(self, search):
4482
 
        phase = 'file'
4483
 
        revs = search.get_keys()
4484
 
        graph = self.from_repository.get_graph()
4485
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4486
 
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4487
 
        text_keys = []
4488
 
        for knit_kind, file_id, revisions in data_to_fetch:
4489
 
            if knit_kind != phase:
4490
 
                phase = knit_kind
4491
 
                # Make a new progress bar for this phase
4492
 
            if knit_kind == "file":
4493
 
                # Accumulate file texts
4494
 
                text_keys.extend([(file_id, revision) for revision in
4495
 
                    revisions])
4496
 
            elif knit_kind == "inventory":
4497
 
                # Now copy the file texts.
4498
 
                from_texts = self.from_repository.texts
4499
 
                yield ('texts', from_texts.get_record_stream(
4500
 
                    text_keys, self.to_format._fetch_order,
4501
 
                    not self.to_format._fetch_uses_deltas))
4502
 
                # Cause an error if a text occurs after we have done the
4503
 
                # copy.
4504
 
                text_keys = None
4505
 
                # Before we process the inventory we generate the root
4506
 
                # texts (if necessary) so that the inventories references
4507
 
                # will be valid.
4508
 
                for _ in self._generate_root_texts(revs):
4509
 
                    yield _
4510
 
                # we fetch only the referenced inventories because we do not
4511
 
                # know for unselected inventories whether all their required
4512
 
                # texts are present in the other repository - it could be
4513
 
                # corrupt.
4514
 
                for info in self._get_inventory_stream(revs):
4515
 
                    yield info
4516
 
            elif knit_kind == "signatures":
4517
 
                # Nothing to do here; this will be taken care of when
4518
 
                # _fetch_revision_texts happens.
4519
 
                pass
4520
 
            elif knit_kind == "revisions":
4521
 
                for record in self._fetch_revision_texts(revs):
4522
 
                    yield record
4523
 
            else:
4524
 
                raise AssertionError("Unknown knit kind %r" % knit_kind)
4525
 
 
4526
 
    def get_stream_for_missing_keys(self, missing_keys):
4527
 
        # missing keys can only occur when we are byte copying and not
4528
 
        # translating (because translation means we don't send
4529
 
        # unreconstructable deltas ever).
4530
 
        keys = {}
4531
 
        keys['texts'] = set()
4532
 
        keys['revisions'] = set()
4533
 
        keys['inventories'] = set()
4534
 
        keys['chk_bytes'] = set()
4535
 
        keys['signatures'] = set()
4536
 
        for key in missing_keys:
4537
 
            keys[key[0]].add(key[1:])
4538
 
        if len(keys['revisions']):
4539
 
            # If we allowed copying revisions at this point, we could end up
4540
 
            # copying a revision without copying its required texts: a
4541
 
            # violation of the requirements for repository integrity.
4542
 
            raise AssertionError(
4543
 
                'cannot copy revisions to fill in missing deltas %s' % (
4544
 
                    keys['revisions'],))
4545
 
        for substream_kind, keys in keys.iteritems():
4546
 
            vf = getattr(self.from_repository, substream_kind)
4547
 
            if vf is None and keys:
4548
 
                    raise AssertionError(
4549
 
                        "cannot fill in keys for a versioned file we don't"
4550
 
                        " have: %s needs %s" % (substream_kind, keys))
4551
 
            if not keys:
4552
 
                # No need to stream something we don't have
4553
 
                continue
4554
 
            if substream_kind == 'inventories':
4555
 
                # Some missing keys are genuinely ghosts, filter those out.
4556
 
                present = self.from_repository.inventories.get_parent_map(keys)
4557
 
                revs = [key[0] for key in present]
4558
 
                # Get the inventory stream more-or-less as we do for the
4559
 
                # original stream; there's no reason to assume that records
4560
 
                # direct from the source will be suitable for the sink.  (Think
4561
 
                # e.g. 2a -> 1.9-rich-root).
4562
 
                for info in self._get_inventory_stream(revs, missing=True):
4563
 
                    yield info
4564
 
                continue
4565
 
 
4566
 
            # Ask for full texts always so that we don't need more round trips
4567
 
            # after this stream.
4568
 
            # Some of the missing keys are genuinely ghosts, so filter absent
4569
 
            # records. The Sink is responsible for doing another check to
4570
 
            # ensure that ghosts don't introduce missing data for future
4571
 
            # fetches.
4572
 
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4573
 
                self.to_format._fetch_order, True))
4574
 
            yield substream_kind, stream
4575
 
 
4576
 
    def inventory_fetch_order(self):
4577
 
        if self._rich_root_upgrade():
4578
 
            return 'topological'
4579
 
        else:
4580
 
            return self.to_format._fetch_order
4581
 
 
4582
 
    def _rich_root_upgrade(self):
4583
 
        return (not self.from_repository._format.rich_root_data and
4584
 
            self.to_format.rich_root_data)
4585
 
 
4586
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4587
 
        from_format = self.from_repository._format
4588
 
        if (from_format.supports_chks and self.to_format.supports_chks and
4589
 
            from_format.network_name() == self.to_format.network_name()):
4590
 
            raise AssertionError(
4591
 
                "this case should be handled by GroupCHKStreamSource")
4592
 
        elif 'forceinvdeltas' in debug.debug_flags:
4593
 
            return self._get_convertable_inventory_stream(revision_ids,
4594
 
                    delta_versus_null=missing)
4595
 
        elif from_format.network_name() == self.to_format.network_name():
4596
 
            # Same format.
4597
 
            return self._get_simple_inventory_stream(revision_ids,
4598
 
                    missing=missing)
4599
 
        elif (not from_format.supports_chks and not self.to_format.supports_chks
4600
 
                and from_format._serializer == self.to_format._serializer):
4601
 
            # Essentially the same format.
4602
 
            return self._get_simple_inventory_stream(revision_ids,
4603
 
                    missing=missing)
4604
 
        else:
4605
 
            # Any time we switch serializations, we want to use an
4606
 
            # inventory-delta based approach.
4607
 
            return self._get_convertable_inventory_stream(revision_ids,
4608
 
                    delta_versus_null=missing)
4609
 
 
4610
 
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
4611
 
        # NB: This currently reopens the inventory weave in source;
4612
 
        # using a single stream interface instead would avoid this.
4613
 
        from_weave = self.from_repository.inventories
4614
 
        if missing:
4615
 
            delta_closure = True
4616
 
        else:
4617
 
            delta_closure = not self.delta_on_metadata()
4618
 
        yield ('inventories', from_weave.get_record_stream(
4619
 
            [(rev_id,) for rev_id in revision_ids],
4620
 
            self.inventory_fetch_order(), delta_closure))
4621
 
 
4622
 
    def _get_convertable_inventory_stream(self, revision_ids,
4623
 
                                          delta_versus_null=False):
4624
 
        # The two formats are sufficiently different that there is no fast
4625
 
        # path, so we need to send just inventorydeltas, which any
4626
 
        # sufficiently modern client can insert into any repository.
4627
 
        # The StreamSink code expects to be able to
4628
 
        # convert on the target, so we need to put bytes-on-the-wire that can
4629
 
        # be converted.  That means inventory deltas (if the remote is <1.19,
4630
 
        # RemoteStreamSink will fallback to VFS to insert the deltas).
4631
 
        yield ('inventory-deltas',
4632
 
           self._stream_invs_as_deltas(revision_ids,
4633
 
                                       delta_versus_null=delta_versus_null))
4634
 
 
4635
 
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4636
 
        """Return a stream of inventory-deltas for the given rev ids.
4637
 
 
4638
 
        :param revision_ids: The list of inventories to transmit
4639
 
        :param delta_versus_null: Don't try to find a minimal delta for this
4640
 
            entry, instead compute the delta versus the NULL_REVISION. This
4641
 
            effectively streams a complete inventory. Used for stuff like
4642
 
            filling in missing parents, etc.
4643
 
        """
4644
 
        from_repo = self.from_repository
4645
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4646
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4647
 
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
4648
 
        # method...
4649
 
        inventories = self.from_repository.iter_inventories(
4650
 
            revision_ids, 'topological')
4651
 
        format = from_repo._format
4652
 
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4653
 
        inventory_cache = lru_cache.LRUCache(50)
4654
 
        null_inventory = from_repo.revision_tree(
4655
 
            _mod_revision.NULL_REVISION).inventory
4656
 
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4657
 
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
4658
 
        # repo back into a non-rich-root repo ought to be allowed)
4659
 
        serializer = inventory_delta.InventoryDeltaSerializer(
4660
 
            versioned_root=format.rich_root_data,
4661
 
            tree_references=format.supports_tree_reference)
4662
 
        for inv in inventories:
4663
 
            key = (inv.revision_id,)
4664
 
            parent_keys = parent_map.get(key, ())
4665
 
            delta = None
4666
 
            if not delta_versus_null and parent_keys:
4667
 
                # The caller did not ask for complete inventories and we have
4668
 
                # some parents that we can delta against.  Make a delta against
4669
 
                # each parent so that we can find the smallest.
4670
 
                parent_ids = [parent_key[0] for parent_key in parent_keys]
4671
 
                for parent_id in parent_ids:
4672
 
                    if parent_id not in invs_sent_so_far:
4673
 
                        # We don't know that the remote side has this basis, so
4674
 
                        # we can't use it.
4675
 
                        continue
4676
 
                    if parent_id == _mod_revision.NULL_REVISION:
4677
 
                        parent_inv = null_inventory
4678
 
                    else:
4679
 
                        parent_inv = inventory_cache.get(parent_id, None)
4680
 
                        if parent_inv is None:
4681
 
                            parent_inv = from_repo.get_inventory(parent_id)
4682
 
                    candidate_delta = inv._make_delta(parent_inv)
4683
 
                    if (delta is None or
4684
 
                        len(delta) > len(candidate_delta)):
4685
 
                        delta = candidate_delta
4686
 
                        basis_id = parent_id
4687
 
            if delta is None:
4688
 
                # Either none of the parents ended up being suitable, or we
4689
 
                # were asked to delta against NULL
4690
 
                basis_id = _mod_revision.NULL_REVISION
4691
 
                delta = inv._make_delta(null_inventory)
4692
 
            invs_sent_so_far.add(inv.revision_id)
4693
 
            inventory_cache[inv.revision_id] = inv
4694
 
            delta_serialized = ''.join(
4695
 
                serializer.delta_to_lines(basis_id, key[-1], delta))
4696
 
            yield versionedfile.FulltextContentFactory(
4697
 
                key, parent_keys, None, delta_serialized)
4698
 
 
4699
 
 
4700
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4701
 
                    stop_revision=None):
4702
 
    """Extend the partial history to include a given index
4703
 
 
4704
 
    If a stop_index is supplied, stop when that index has been reached.
4705
 
    If a stop_revision is supplied, stop when that revision is
4706
 
    encountered.  Otherwise, stop when the beginning of history is
4707
 
    reached.
4708
 
 
4709
 
    :param stop_index: The index which should be present.  When it is
4710
 
        present, history extension will stop.
4711
 
    :param stop_revision: The revision id which should be present.  When
4712
 
        it is encountered, history extension will stop.
4713
 
    """
4714
 
    start_revision = partial_history_cache[-1]
4715
 
    iterator = repo.iter_reverse_revision_history(start_revision)
4716
 
    try:
4717
 
        #skip the last revision in the list
4718
 
        iterator.next()
4719
 
        while True:
4720
 
            if (stop_index is not None and
4721
 
                len(partial_history_cache) > stop_index):
4722
 
                break
4723
 
            if partial_history_cache[-1] == stop_revision:
4724
 
                break
4725
 
            revision_id = iterator.next()
4726
 
            partial_history_cache.append(revision_id)
4727
 
    except StopIteration:
4728
 
        # No more history
4729
 
        return
4730
 
 
 
2157
    """Unescape &amp;, &lt;, and &gt; in a string of data.
 
2158
    """
 
2159
    data = data.replace("&lt;", "<")
 
2160
    data = data.replace("&gt;", ">")
 
2161
    # must do ampersand last
 
2162
    return data.replace("&amp;", "&")