~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-31 16:12:57 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060731161257-91a231523255332c
new official bzr.ico

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
from binascii import hexlify
 
18
from copy import deepcopy
17
19
from cStringIO import StringIO
18
 
 
19
 
from bzrlib.lazy_import import lazy_import
20
 
lazy_import(globals(), """
21
20
import re
22
21
import time
 
22
from unittest import TestSuite
23
23
 
24
 
from bzrlib import (
25
 
    bzrdir,
26
 
    check,
27
 
    deprecated_graph,
28
 
    errors,
29
 
    generate_ids,
30
 
    gpg,
31
 
    graph,
32
 
    lazy_regex,
33
 
    lockable_files,
34
 
    lockdir,
35
 
    osutils,
36
 
    registry,
37
 
    remote,
38
 
    revision as _mod_revision,
39
 
    symbol_versioning,
40
 
    transactions,
41
 
    ui,
42
 
    )
43
 
from bzrlib.bundle import serializer
 
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
44
36
from bzrlib.revisiontree import RevisionTree
45
 
from bzrlib.store.versioned import VersionedFileStore
 
37
from bzrlib.store.versioned import VersionedFileStore, WeaveStore
46
38
from bzrlib.store.text import TextStore
 
39
from bzrlib.symbol_versioning import (deprecated_method,
 
40
        zero_nine, 
 
41
        )
47
42
from bzrlib.testament import Testament
48
 
 
49
 
""")
50
 
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
52
 
from bzrlib.inter import InterObject
53
 
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
54
 
from bzrlib.symbol_versioning import (
55
 
        deprecated_method,
56
 
        zero_nine,
57
 
        )
58
 
from bzrlib.trace import mutter, note, warning
59
 
 
60
 
 
61
 
# Old formats display a warning, but only once
62
 
_deprecation_warning_done = False
63
 
 
64
 
 
65
 
######################################################################
66
 
# Repositories
 
43
from bzrlib.trace import mutter, note
 
44
from bzrlib.tsort import topo_sort
 
45
from bzrlib.weave import WeaveFile
 
46
 
67
47
 
68
48
class Repository(object):
69
49
    """Repository holding history for one or more branches.
77
57
    remote) disk.
78
58
    """
79
59
 
80
 
    _file_ids_altered_regex = lazy_regex.lazy_compile(
81
 
        r'file_id="(?P<file_id>[^"]+)"'
82
 
        r'.*revision="(?P<revision_id>[^"]+)"'
83
 
        )
84
 
 
85
60
    @needs_write_lock
86
 
    def add_inventory(self, revision_id, inv, parents):
87
 
        """Add the inventory inv to the repository as revision_id.
 
61
    def add_inventory(self, revid, inv, parents):
 
62
        """Add the inventory inv to the repository as revid.
88
63
        
89
 
        :param parents: The revision ids of the parents that revision_id
 
64
        :param parents: The revision ids of the parents that revid
90
65
                        is known to have and are in the repository already.
91
66
 
92
67
        returns the sha1 of the serialized inventory.
93
68
        """
94
 
        revision_id = osutils.safe_revision_id(revision_id)
95
 
        _mod_revision.check_not_reserved_id(revision_id)
96
 
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
69
        assert inv.revision_id is None or inv.revision_id == revid, \
97
70
            "Mismatch between inventory revision" \
98
 
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
99
 
        assert inv.root is not None
100
 
        inv_text = self.serialise_inventory(inv)
 
71
            " id and insertion revid (%r, %r)" % (inv.revision_id, revid)
 
72
        inv_text = xml5.serializer_v5.write_inventory_to_string(inv)
101
73
        inv_sha1 = osutils.sha_string(inv_text)
102
74
        inv_vf = self.control_weaves.get_weave('inventory',
103
75
                                               self.get_transaction())
104
 
        self._inventory_add_lines(inv_vf, revision_id, parents,
105
 
                                  osutils.split_lines(inv_text))
 
76
        self._inventory_add_lines(inv_vf, revid, parents, osutils.split_lines(inv_text))
106
77
        return inv_sha1
107
78
 
108
 
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines):
 
79
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
109
80
        final_parents = []
110
81
        for parent in parents:
111
82
            if parent in inv_vf:
112
83
                final_parents.append(parent)
113
84
 
114
 
        inv_vf.add_lines(revision_id, final_parents, lines)
 
85
        inv_vf.add_lines(revid, final_parents, lines)
115
86
 
116
87
    @needs_write_lock
117
 
    def add_revision(self, revision_id, rev, inv=None, config=None):
118
 
        """Add rev to the revision store as revision_id.
 
88
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
89
        """Add rev to the revision store as rev_id.
119
90
 
120
 
        :param revision_id: the revision id to use.
 
91
        :param rev_id: the revision id to use.
121
92
        :param rev: The revision object.
122
93
        :param inv: The inventory for the revision. if None, it will be looked
123
94
                    up in the inventory storer
125
96
                       If supplied its signature_needed method will be used
126
97
                       to determine if a signature should be made.
127
98
        """
128
 
        revision_id = osutils.safe_revision_id(revision_id)
129
 
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
130
 
        #       rev.parent_ids?
131
 
        _mod_revision.check_not_reserved_id(revision_id)
132
99
        if config is not None and config.signature_needed():
133
100
            if inv is None:
134
 
                inv = self.get_inventory(revision_id)
 
101
                inv = self.get_inventory(rev_id)
135
102
            plaintext = Testament(rev, inv).as_short_text()
136
103
            self.store_revision_signature(
137
 
                gpg.GPGStrategy(config), plaintext, revision_id)
138
 
        if not revision_id in self.get_inventory_weave():
 
104
                gpg.GPGStrategy(config), plaintext, rev_id)
 
105
        if not rev_id in self.get_inventory_weave():
139
106
            if inv is None:
140
 
                raise errors.WeaveRevisionNotPresent(revision_id,
 
107
                raise errors.WeaveRevisionNotPresent(rev_id,
141
108
                                                     self.get_inventory_weave())
142
109
            else:
143
110
                # yes, this is not suitable for adding with ghosts.
144
 
                self.add_inventory(revision_id, inv, rev.parent_ids)
 
111
                self.add_inventory(rev_id, inv, rev.parent_ids)
145
112
        self._revision_store.add_revision(rev, self.get_transaction())
146
113
 
147
 
    def _add_revision_text(self, revision_id, text):
148
 
        revision = self._revision_store._serializer.read_revision_from_string(
149
 
            text)
150
 
        self._revision_store._add_revision(revision, StringIO(text),
151
 
                                           self.get_transaction())
152
 
 
153
114
    @needs_read_lock
154
115
    def _all_possible_ids(self):
155
116
        """Return all the possible revisions that we could find."""
175
136
        if self._revision_store.text_store.listable():
176
137
            return self._revision_store.all_revision_ids(self.get_transaction())
177
138
        result = self._all_possible_ids()
178
 
        # TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
179
 
        #       ids. (It should, since _revision_store's API should change to
180
 
        #       return utf8 revision_ids)
181
139
        return self._eliminate_revisions_not_present(result)
182
140
 
183
141
    def break_lock(self):
230
188
        self.control_weaves = control_store
231
189
        # TODO: make sure to construct the right store classes, etc, depending
232
190
        # on whether escaping is required.
233
 
        self._warn_if_deprecated()
234
191
 
235
192
    def __repr__(self):
236
193
        return '%s(%r)' % (self.__class__.__name__, 
239
196
    def is_locked(self):
240
197
        return self.control_files.is_locked()
241
198
 
242
 
    def lock_write(self, token=None):
243
 
        """Lock this repository for writing.
244
 
        
245
 
        :param token: if this is already locked, then lock_write will fail
246
 
            unless the token matches the existing lock.
247
 
        :returns: a token if this instance supports tokens, otherwise None.
248
 
        :raises TokenLockingNotSupported: when a token is given but this
249
 
            instance doesn't support using token locks.
250
 
        :raises MismatchedToken: if the specified token doesn't match the token
251
 
            of the existing lock.
252
 
 
253
 
        A token should be passed in if you know that you have locked the object
254
 
        some other way, and need to synchronise this object's state with that
255
 
        fact.
256
 
 
257
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
258
 
        """
259
 
        return self.control_files.lock_write(token=token)
 
199
    def lock_write(self):
 
200
        self.control_files.lock_write()
260
201
 
261
202
    def lock_read(self):
262
203
        self.control_files.lock_read()
264
205
    def get_physical_lock_status(self):
265
206
        return self.control_files.get_physical_lock_status()
266
207
 
267
 
    def leave_lock_in_place(self):
268
 
        """Tell this repository not to release the physical lock when this
269
 
        object is unlocked.
270
 
        
271
 
        If lock_write doesn't return a token, then this method is not supported.
272
 
        """
273
 
        self.control_files.leave_in_place()
274
 
 
275
 
    def dont_leave_lock_in_place(self):
276
 
        """Tell this repository to release the physical lock when this
277
 
        object is unlocked, even if it didn't originally acquire it.
278
 
 
279
 
        If lock_write doesn't return a token, then this method is not supported.
280
 
        """
281
 
        self.control_files.dont_leave_in_place()
282
 
 
283
 
    @needs_read_lock
284
 
    def gather_stats(self, revid=None, committers=None):
285
 
        """Gather statistics from a revision id.
286
 
 
287
 
        :param revid: The revision id to gather statistics from, if None, then
288
 
            no revision specific statistics are gathered.
289
 
        :param committers: Optional parameter controlling whether to grab
290
 
            a count of committers from the revision specific statistics.
291
 
        :return: A dictionary of statistics. Currently this contains:
292
 
            committers: The number of committers if requested.
293
 
            firstrev: A tuple with timestamp, timezone for the penultimate left
294
 
                most ancestor of revid, if revid is not the NULL_REVISION.
295
 
            latestrev: A tuple with timestamp, timezone for revid, if revid is
296
 
                not the NULL_REVISION.
297
 
            revisions: The total revision count in the repository.
298
 
            size: An estimate disk size of the repository in bytes.
299
 
        """
300
 
        result = {}
301
 
        if revid and committers:
302
 
            result['committers'] = 0
303
 
        if revid and revid != _mod_revision.NULL_REVISION:
304
 
            if committers:
305
 
                all_committers = set()
306
 
            revisions = self.get_ancestry(revid)
307
 
            # pop the leading None
308
 
            revisions.pop(0)
309
 
            first_revision = None
310
 
            if not committers:
311
 
                # ignore the revisions in the middle - just grab first and last
312
 
                revisions = revisions[0], revisions[-1]
313
 
            for revision in self.get_revisions(revisions):
314
 
                if not first_revision:
315
 
                    first_revision = revision
316
 
                if committers:
317
 
                    all_committers.add(revision.committer)
318
 
            last_revision = revision
319
 
            if committers:
320
 
                result['committers'] = len(all_committers)
321
 
            result['firstrev'] = (first_revision.timestamp,
322
 
                first_revision.timezone)
323
 
            result['latestrev'] = (last_revision.timestamp,
324
 
                last_revision.timezone)
325
 
 
326
 
        # now gather global repository information
327
 
        if self.bzrdir.root_transport.listable():
328
 
            c, t = self._revision_store.total_size(self.get_transaction())
329
 
            result['revisions'] = c
330
 
            result['size'] = t
331
 
        return result
332
 
 
333
208
    @needs_read_lock
334
209
    def missing_revision_ids(self, other, revision_id=None):
335
210
        """Return the revision ids that other has that this does not.
338
213
 
339
214
        revision_id: only return revision ids included by revision_id.
340
215
        """
341
 
        revision_id = osutils.safe_revision_id(revision_id)
342
216
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
343
217
 
344
218
    @staticmethod
351
225
        control = bzrdir.BzrDir.open(base)
352
226
        return control.open_repository()
353
227
 
354
 
    def copy_content_into(self, destination, revision_id=None):
 
228
    def copy_content_into(self, destination, revision_id=None, basis=None):
355
229
        """Make a complete copy of the content in self into destination.
356
230
        
357
231
        This is a destructive operation! Do not use it on existing 
358
232
        repositories.
359
233
        """
360
 
        revision_id = osutils.safe_revision_id(revision_id)
361
 
        return InterRepository.get(self, destination).copy_content(revision_id)
 
234
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
362
235
 
363
236
    def fetch(self, source, revision_id=None, pb=None):
364
237
        """Fetch the content required to construct revision_id from source.
365
238
 
366
239
        If revision_id is None all content is copied.
367
240
        """
368
 
        revision_id = osutils.safe_revision_id(revision_id)
369
 
        inter = InterRepository.get(source, self)
370
 
        try:
371
 
            return inter.fetch(revision_id=revision_id, pb=pb)
372
 
        except NotImplementedError:
373
 
            raise errors.IncompatibleRepositories(source, self)
374
 
 
375
 
    def create_bundle(self, target, base, fileobj, format=None):
376
 
        return serializer.write_bundle(self, target, base, fileobj, format)
 
241
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
 
242
                                                       pb=pb)
377
243
 
378
244
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
379
245
                           timezone=None, committer=None, revprops=None, 
389
255
        :param revprops: Optional dictionary of revision properties.
390
256
        :param revision_id: Optional revision id.
391
257
        """
392
 
        revision_id = osutils.safe_revision_id(revision_id)
393
 
        return _CommitBuilder(self, parents, config, timestamp, timezone,
394
 
                              committer, revprops, revision_id)
 
258
        return CommitBuilder(self, parents, config, timestamp, timezone,
 
259
                             committer, revprops, revision_id)
395
260
 
396
261
    def unlock(self):
397
262
        self.control_files.unlock()
398
263
 
399
264
    @needs_read_lock
400
 
    def clone(self, a_bzrdir, revision_id=None):
 
265
    def clone(self, a_bzrdir, revision_id=None, basis=None):
401
266
        """Clone this repository into a_bzrdir using the current format.
402
267
 
403
268
        Currently no check is made that the format of this repository and
404
269
        the bzrdir format are compatible. FIXME RBC 20060201.
405
 
 
406
 
        :return: The newly created destination repository.
407
 
        """
408
 
        # TODO: deprecate after 0.16; cloning this with all its settings is
409
 
        # probably not very useful -- mbp 20070423
410
 
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
411
 
        self.copy_content_into(dest_repo, revision_id)
412
 
        return dest_repo
413
 
 
414
 
    @needs_read_lock
415
 
    def sprout(self, to_bzrdir, revision_id=None):
416
 
        """Create a descendent repository for new development.
417
 
 
418
 
        Unlike clone, this does not copy the settings of the repository.
419
 
        """
420
 
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
421
 
        dest_repo.fetch(self, revision_id=revision_id)
422
 
        return dest_repo
423
 
 
424
 
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
270
        """
425
271
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
426
272
            # use target default format.
427
 
            dest_repo = a_bzrdir.create_repository()
 
273
            result = a_bzrdir.create_repository()
 
274
        # FIXME RBC 20060209 split out the repository type to avoid this check ?
 
275
        elif isinstance(a_bzrdir._format,
 
276
                      (bzrdir.BzrDirFormat4,
 
277
                       bzrdir.BzrDirFormat5,
 
278
                       bzrdir.BzrDirFormat6)):
 
279
            result = a_bzrdir.open_repository()
428
280
        else:
429
 
            # Most control formats need the repository to be specifically
430
 
            # created, but on some old all-in-one formats it's not needed
431
 
            try:
432
 
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
433
 
            except errors.UninitializableFormat:
434
 
                dest_repo = a_bzrdir.open_repository()
435
 
        return dest_repo
 
281
            result = self._format.initialize(a_bzrdir, shared=self.is_shared())
 
282
        self.copy_content_into(result, revision_id, basis)
 
283
        return result
436
284
 
437
285
    @needs_read_lock
438
286
    def has_revision(self, revision_id):
439
287
        """True if this repository has a copy of the revision."""
440
 
        revision_id = osutils.safe_revision_id(revision_id)
441
288
        return self._revision_store.has_revision_id(revision_id,
442
289
                                                    self.get_transaction())
443
290
 
451
298
        or testing the revision graph.
452
299
        """
453
300
        if not revision_id or not isinstance(revision_id, basestring):
454
 
            raise errors.InvalidRevisionId(revision_id=revision_id,
455
 
                                           branch=self)
456
 
        return self.get_revisions([revision_id])[0]
457
 
 
 
301
            raise InvalidRevisionId(revision_id=revision_id, branch=self)
 
302
        return self._revision_store.get_revisions([revision_id],
 
303
                                                  self.get_transaction())[0]
458
304
    @needs_read_lock
459
305
    def get_revisions(self, revision_ids):
460
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
461
 
        revs = self._revision_store.get_revisions(revision_ids,
 
306
        return self._revision_store.get_revisions(revision_ids,
462
307
                                                  self.get_transaction())
463
 
        for rev in revs:
464
 
            assert not isinstance(rev.revision_id, unicode)
465
 
            for parent_id in rev.parent_ids:
466
 
                assert not isinstance(parent_id, unicode)
467
 
        return revs
468
308
 
469
309
    @needs_read_lock
470
310
    def get_revision_xml(self, revision_id):
471
 
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
472
 
        #       would have already do it.
473
 
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
474
 
        revision_id = osutils.safe_revision_id(revision_id)
475
 
        rev = self.get_revision(revision_id)
 
311
        rev = self.get_revision(revision_id) 
476
312
        rev_tmp = StringIO()
477
313
        # the current serializer..
478
314
        self._revision_store._serializer.write_revision(rev, rev_tmp)
482
318
    @needs_read_lock
483
319
    def get_revision(self, revision_id):
484
320
        """Return the Revision object for a named revision"""
485
 
        # TODO: jam 20070210 get_revision_reconcile should do this for us
486
 
        revision_id = osutils.safe_revision_id(revision_id)
487
321
        r = self.get_revision_reconcile(revision_id)
488
322
        # weave corruption can lead to absent revision markers that should be
489
323
        # present.
545
379
 
546
380
    @needs_write_lock
547
381
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
548
 
        revision_id = osutils.safe_revision_id(revision_id)
549
382
        signature = gpg_strategy.sign(plaintext)
550
383
        self._revision_store.add_revision_signature_text(revision_id,
551
384
                                                         signature,
559
392
        revision_ids. Each altered file-ids has the exact revision_ids that
560
393
        altered it listed explicitly.
561
394
        """
562
 
        assert self._serializer.support_altered_by_hack, \
 
395
        assert isinstance(self._format, (RepositoryFormat5,
 
396
                                         RepositoryFormat6,
 
397
                                         RepositoryFormat7,
 
398
                                         RepositoryFormatKnit1)), \
563
399
            ("fileids_altered_by_revision_ids only supported for branches " 
564
400
             "which store inventory as unnested xml, not on %r" % self)
565
 
        selected_revision_ids = set(osutils.safe_revision_id(r)
566
 
                                    for r in revision_ids)
 
401
        selected_revision_ids = set(revision_ids)
567
402
        w = self.get_inventory_weave()
568
403
        result = {}
569
404
 
575
410
        # revisions. We don't need to see all lines in the inventory because
576
411
        # only those added in an inventory in rev X can contain a revision=X
577
412
        # line.
578
 
        unescape_revid_cache = {}
579
 
        unescape_fileid_cache = {}
580
 
 
581
 
        # jam 20061218 In a big fetch, this handles hundreds of thousands
582
 
        # of lines, so it has had a lot of inlining and optimizing done.
583
 
        # Sorry that it is a little bit messy.
584
 
        # Move several functions to be local variables, since this is a long
585
 
        # running loop.
586
 
        search = self._file_ids_altered_regex.search
587
 
        unescape = _unescape_xml
588
 
        setdefault = result.setdefault
589
 
        pb = ui.ui_factory.nested_progress_bar()
590
 
        try:
591
 
            for line in w.iter_lines_added_or_present_in_versions(
592
 
                                        selected_revision_ids, pb=pb):
593
 
                match = search(line)
594
 
                if match is None:
595
 
                    continue
596
 
                # One call to match.group() returning multiple items is quite a
597
 
                # bit faster than 2 calls to match.group() each returning 1
598
 
                file_id, revision_id = match.group('file_id', 'revision_id')
599
 
 
600
 
                # Inlining the cache lookups helps a lot when you make 170,000
601
 
                # lines and 350k ids, versus 8.4 unique ids.
602
 
                # Using a cache helps in 2 ways:
603
 
                #   1) Avoids unnecessary decoding calls
604
 
                #   2) Re-uses cached strings, which helps in future set and
605
 
                #      equality checks.
606
 
                # (2) is enough that removing encoding entirely along with
607
 
                # the cache (so we are using plain strings) results in no
608
 
                # performance improvement.
609
 
                try:
610
 
                    revision_id = unescape_revid_cache[revision_id]
611
 
                except KeyError:
612
 
                    unescaped = unescape(revision_id)
613
 
                    unescape_revid_cache[revision_id] = unescaped
614
 
                    revision_id = unescaped
615
 
 
616
 
                if revision_id in selected_revision_ids:
617
 
                    try:
618
 
                        file_id = unescape_fileid_cache[file_id]
619
 
                    except KeyError:
620
 
                        unescaped = unescape(file_id)
621
 
                        unescape_fileid_cache[file_id] = unescaped
622
 
                        file_id = unescaped
623
 
                    setdefault(file_id, set()).add(revision_id)
624
 
        finally:
625
 
            pb.finished()
 
413
        for line in w.iter_lines_added_or_present_in_versions(selected_revision_ids):
 
414
            start = line.find('file_id="')+9
 
415
            if start < 9: continue
 
416
            end = line.find('"', start)
 
417
            assert end>= 0
 
418
            file_id = _unescape_xml(line[start:end])
 
419
 
 
420
            start = line.find('revision="')+10
 
421
            if start < 10: continue
 
422
            end = line.find('"', start)
 
423
            assert end>= 0
 
424
            revision_id = _unescape_xml(line[start:end])
 
425
            if revision_id in selected_revision_ids:
 
426
                result.setdefault(file_id, set()).add(revision_id)
626
427
        return result
627
428
 
628
429
    @needs_read_lock
633
434
    @needs_read_lock
634
435
    def get_inventory(self, revision_id):
635
436
        """Get Inventory object by hash."""
636
 
        # TODO: jam 20070210 Technically we don't need to sanitize, since all
637
 
        #       called functions must sanitize.
638
 
        revision_id = osutils.safe_revision_id(revision_id)
639
437
        return self.deserialise_inventory(
640
438
            revision_id, self.get_inventory_xml(revision_id))
641
439
 
645
443
        :param revision_id: The expected revision id of the inventory.
646
444
        :param xml: A serialised inventory.
647
445
        """
648
 
        revision_id = osutils.safe_revision_id(revision_id)
649
 
        result = self._serializer.read_inventory_from_string(xml)
650
 
        result.root.revision = revision_id
651
 
        return result
652
 
 
653
 
    def serialise_inventory(self, inv):
654
 
        return self._serializer.write_inventory_to_string(inv)
655
 
 
656
 
    def get_serializer_format(self):
657
 
        return self._serializer.format_num
 
446
        return xml5.serializer_v5.read_inventory_from_string(xml)
658
447
 
659
448
    @needs_read_lock
660
449
    def get_inventory_xml(self, revision_id):
661
450
        """Get inventory XML as a file object."""
662
 
        revision_id = osutils.safe_revision_id(revision_id)
663
451
        try:
664
 
            assert isinstance(revision_id, str), type(revision_id)
 
452
            assert isinstance(revision_id, basestring), type(revision_id)
665
453
            iw = self.get_inventory_weave()
666
454
            return iw.get_text(revision_id)
667
455
        except IndexError:
671
459
    def get_inventory_sha1(self, revision_id):
672
460
        """Return the sha1 hash of the inventory entry
673
461
        """
674
 
        # TODO: jam 20070210 Shouldn't this be deprecated / removed?
675
 
        revision_id = osutils.safe_revision_id(revision_id)
676
462
        return self.get_revision(revision_id).inventory_sha1
677
463
 
678
464
    @needs_read_lock
685
471
        :return: a dictionary of revision_id->revision_parents_list.
686
472
        """
687
473
        # special case NULL_REVISION
688
 
        if revision_id == _mod_revision.NULL_REVISION:
 
474
        if revision_id == NULL_REVISION:
689
475
            return {}
690
 
        revision_id = osutils.safe_revision_id(revision_id)
691
 
        a_weave = self.get_inventory_weave()
692
 
        all_revisions = self._eliminate_revisions_not_present(
693
 
                                a_weave.versions())
694
 
        entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for 
 
476
        weave = self.get_inventory_weave()
 
477
        all_revisions = self._eliminate_revisions_not_present(weave.versions())
 
478
        entire_graph = dict([(node, weave.get_parents(node)) for 
695
479
                             node in all_revisions])
696
480
        if revision_id is None:
697
481
            return entire_graph
716
500
        :param revision_ids: an iterable of revisions to graph or None for all.
717
501
        :return: a Graph object with the graph reachable from revision_ids.
718
502
        """
719
 
        result = deprecated_graph.Graph()
 
503
        result = Graph()
720
504
        if not revision_ids:
721
505
            pending = set(self.all_revision_ids())
722
506
            required = set([])
723
507
        else:
724
 
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
 
508
            pending = set(revision_ids)
725
509
            # special case NULL_REVISION
726
 
            if _mod_revision.NULL_REVISION in pending:
727
 
                pending.remove(_mod_revision.NULL_REVISION)
 
510
            if NULL_REVISION in pending:
 
511
                pending.remove(NULL_REVISION)
728
512
            required = set(pending)
729
513
        done = set([])
730
514
        while len(pending):
747
531
            done.add(revision_id)
748
532
        return result
749
533
 
750
 
    def _get_history_vf(self):
751
 
        """Get a versionedfile whose history graph reflects all revisions.
752
 
 
753
 
        For weave repositories, this is the inventory weave.
754
 
        """
755
 
        return self.get_inventory_weave()
756
 
 
757
 
    def iter_reverse_revision_history(self, revision_id):
758
 
        """Iterate backwards through revision ids in the lefthand history
759
 
 
760
 
        :param revision_id: The revision id to start with.  All its lefthand
761
 
            ancestors will be traversed.
762
 
        """
763
 
        revision_id = osutils.safe_revision_id(revision_id)
764
 
        if revision_id in (None, _mod_revision.NULL_REVISION):
765
 
            return
766
 
        next_id = revision_id
767
 
        versionedfile = self._get_history_vf()
768
 
        while True:
769
 
            yield next_id
770
 
            parents = versionedfile.get_parents(next_id)
771
 
            if len(parents) == 0:
772
 
                return
773
 
            else:
774
 
                next_id = parents[0]
775
 
 
776
534
    @needs_read_lock
777
535
    def get_revision_inventory(self, revision_id):
778
536
        """Return inventory of a past revision."""
801
559
        reconciler = RepoReconciler(self, thorough=thorough)
802
560
        reconciler.reconcile()
803
561
        return reconciler
804
 
 
 
562
    
805
563
    @needs_read_lock
806
564
    def revision_tree(self, revision_id):
807
565
        """Return Tree for a revision on this branch.
810
568
        """
811
569
        # TODO: refactor this to use an existing revision object
812
570
        # so we don't need to read it in twice.
813
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
814
 
            return RevisionTree(self, Inventory(root_id=None), 
815
 
                                _mod_revision.NULL_REVISION)
 
571
        if revision_id is None or revision_id == NULL_REVISION:
 
572
            return RevisionTree(self, Inventory(), NULL_REVISION)
816
573
        else:
817
 
            revision_id = osutils.safe_revision_id(revision_id)
818
574
            inv = self.get_revision_inventory(revision_id)
819
575
            return RevisionTree(self, inv, revision_id)
820
576
 
824
580
 
825
581
        `revision_id` may not be None or 'null:'"""
826
582
        assert None not in revision_ids
827
 
        assert _mod_revision.NULL_REVISION not in revision_ids
 
583
        assert NULL_REVISION not in revision_ids
828
584
        texts = self.get_inventory_weave().get_texts(revision_ids)
829
585
        for text, revision_id in zip(texts, revision_ids):
830
586
            inv = self.deserialise_inventory(revision_id, text)
831
587
            yield RevisionTree(self, inv, revision_id)
832
588
 
833
589
    @needs_read_lock
834
 
    def get_ancestry(self, revision_id, topo_sorted=True):
 
590
    def get_ancestry(self, revision_id):
835
591
        """Return a list of revision-ids integrated by a revision.
836
592
 
837
593
        The first element of the list is always None, indicating the origin 
840
596
        
841
597
        This is topologically sorted.
842
598
        """
843
 
        if _mod_revision.is_null(revision_id):
 
599
        if revision_id is None:
844
600
            return [None]
845
 
        revision_id = osutils.safe_revision_id(revision_id)
846
601
        if not self.has_revision(revision_id):
847
602
            raise errors.NoSuchRevision(self, revision_id)
848
603
        w = self.get_inventory_weave()
849
 
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
604
        candidates = w.get_ancestry(revision_id)
850
605
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
851
606
 
852
 
    def pack(self):
853
 
        """Compress the data within the repository.
854
 
 
855
 
        This operation only makes sense for some repository types. For other
856
 
        types it should be a no-op that just returns.
857
 
 
858
 
        This stub method does not require a lock, but subclasses should use
859
 
        @needs_write_lock as this is a long running call its reasonable to 
860
 
        implicitly lock for the user.
861
 
        """
862
 
 
863
607
    @needs_read_lock
864
608
    def print_file(self, file, revision_id):
865
609
        """Print `file` to stdout.
868
612
        - it writes to stdout, it assumes that that is valid etc. Fix
869
613
        by creating a new more flexible convenience function.
870
614
        """
871
 
        revision_id = osutils.safe_revision_id(revision_id)
872
615
        tree = self.revision_tree(revision_id)
873
616
        # use inventory as it was in that revision
874
617
        file_id = tree.inventory.path2id(file)
882
625
    def get_transaction(self):
883
626
        return self.control_files.get_transaction()
884
627
 
885
 
    def revision_parents(self, revision_id):
886
 
        revision_id = osutils.safe_revision_id(revision_id)
887
 
        return self.get_inventory_weave().parent_names(revision_id)
888
 
 
889
 
    def get_parents(self, revision_ids):
890
 
        """See StackedParentsProvider.get_parents"""
891
 
        parents_list = []
892
 
        for revision_id in revision_ids:
893
 
            if revision_id == _mod_revision.NULL_REVISION:
894
 
                parents = []
895
 
            else:
896
 
                try:
897
 
                    parents = self.get_revision(revision_id).parent_ids
898
 
                except errors.NoSuchRevision:
899
 
                    parents = None
900
 
                else:
901
 
                    if len(parents) == 0:
902
 
                        parents = [_mod_revision.NULL_REVISION]
903
 
            parents_list.append(parents)
904
 
        return parents_list
905
 
 
906
 
    def _make_parents_provider(self):
907
 
        return self
908
 
 
909
 
    def get_graph(self, other_repository=None):
910
 
        """Return the graph walker for this repository format"""
911
 
        parents_provider = self._make_parents_provider()
912
 
        if (other_repository is not None and
913
 
            other_repository.bzrdir.transport.base !=
914
 
            self.bzrdir.transport.base):
915
 
            parents_provider = graph._StackedParentsProvider(
916
 
                [parents_provider, other_repository._make_parents_provider()])
917
 
        return graph.Graph(parents_provider)
 
628
    def revision_parents(self, revid):
 
629
        return self.get_inventory_weave().parent_names(revid)
918
630
 
919
631
    @needs_write_lock
920
632
    def set_make_working_trees(self, new_value):
934
646
 
935
647
    @needs_write_lock
936
648
    def sign_revision(self, revision_id, gpg_strategy):
937
 
        revision_id = osutils.safe_revision_id(revision_id)
938
649
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
939
650
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
940
651
 
941
652
    @needs_read_lock
942
653
    def has_signature_for_revision_id(self, revision_id):
943
654
        """Query for a revision signature for revision_id in the repository."""
944
 
        revision_id = osutils.safe_revision_id(revision_id)
945
655
        return self._revision_store.has_signature(revision_id,
946
656
                                                  self.get_transaction())
947
657
 
948
658
    @needs_read_lock
949
659
    def get_signature_text(self, revision_id):
950
660
        """Return the text for a signature."""
951
 
        revision_id = osutils.safe_revision_id(revision_id)
952
661
        return self._revision_store.get_signature_text(revision_id,
953
662
                                                       self.get_transaction())
954
663
 
964
673
        if not revision_ids:
965
674
            raise ValueError("revision_ids must be non-empty in %s.check" 
966
675
                    % (self,))
967
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
968
676
        return self._check(revision_ids)
969
677
 
970
678
    def _check(self, revision_ids):
972
680
        result.check()
973
681
        return result
974
682
 
975
 
    def _warn_if_deprecated(self):
976
 
        global _deprecation_warning_done
977
 
        if _deprecation_warning_done:
978
 
            return
979
 
        _deprecation_warning_done = True
980
 
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
981
 
                % (self._format, self.bzrdir.transport.base))
982
 
 
983
 
    def supports_rich_root(self):
984
 
        return self._format.rich_root_data
985
 
 
986
 
    def _check_ascii_revisionid(self, revision_id, method):
987
 
        """Private helper for ascii-only repositories."""
988
 
        # weave repositories refuse to store revisionids that are non-ascii.
989
 
        if revision_id is not None:
990
 
            # weaves require ascii revision ids.
991
 
            if isinstance(revision_id, unicode):
992
 
                try:
993
 
                    revision_id.encode('ascii')
994
 
                except UnicodeEncodeError:
995
 
                    raise errors.NonAsciiRevisionId(method, self)
996
 
            else:
997
 
                try:
998
 
                    revision_id.decode('ascii')
999
 
                except UnicodeDecodeError:
1000
 
                    raise errors.NonAsciiRevisionId(method, self)
1001
 
 
1002
 
 
1003
 
 
1004
 
# remove these delegates a while after bzr 0.15
1005
 
def __make_delegated(name, from_module):
1006
 
    def _deprecated_repository_forwarder():
1007
 
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
1008
 
            % (name, from_module),
1009
 
            DeprecationWarning,
1010
 
            stacklevel=2)
1011
 
        m = __import__(from_module, globals(), locals(), [name])
1012
 
        try:
1013
 
            return getattr(m, name)
1014
 
        except AttributeError:
1015
 
            raise AttributeError('module %s has no name %s'
1016
 
                    % (m, name))
1017
 
    globals()[name] = _deprecated_repository_forwarder
1018
 
 
1019
 
for _name in [
1020
 
        'AllInOneRepository',
1021
 
        'WeaveMetaDirRepository',
1022
 
        'PreSplitOutRepositoryFormat',
1023
 
        'RepositoryFormat4',
1024
 
        'RepositoryFormat5',
1025
 
        'RepositoryFormat6',
1026
 
        'RepositoryFormat7',
1027
 
        ]:
1028
 
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
1029
 
 
1030
 
for _name in [
1031
 
        'KnitRepository',
1032
 
        'RepositoryFormatKnit',
1033
 
        'RepositoryFormatKnit1',
1034
 
        ]:
1035
 
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
683
 
 
684
class AllInOneRepository(Repository):
 
685
    """Legacy support - the repository behaviour for all-in-one branches."""
 
686
 
 
687
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
 
688
        # we reuse one control files instance.
 
689
        dir_mode = a_bzrdir._control_files._dir_mode
 
690
        file_mode = a_bzrdir._control_files._file_mode
 
691
 
 
692
        def get_store(name, compressed=True, prefixed=False):
 
693
            # FIXME: This approach of assuming stores are all entirely compressed
 
694
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
695
            # some existing branches where there's a mixture; we probably 
 
696
            # still want the option to look for both.
 
697
            relpath = a_bzrdir._control_files._escape(name)
 
698
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
 
699
                              prefixed=prefixed, compressed=compressed,
 
700
                              dir_mode=dir_mode,
 
701
                              file_mode=file_mode)
 
702
            #if self._transport.should_cache():
 
703
            #    cache_path = os.path.join(self.cache_root, name)
 
704
            #    os.mkdir(cache_path)
 
705
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
706
            return store
 
707
 
 
708
        # not broken out yet because the controlweaves|inventory_store
 
709
        # and text_store | weave_store bits are still different.
 
710
        if isinstance(_format, RepositoryFormat4):
 
711
            # cannot remove these - there is still no consistent api 
 
712
            # which allows access to this old info.
 
713
            self.inventory_store = get_store('inventory-store')
 
714
            text_store = get_store('text-store')
 
715
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
 
716
 
 
717
    @needs_read_lock
 
718
    def is_shared(self):
 
719
        """AllInOne repositories cannot be shared."""
 
720
        return False
 
721
 
 
722
    @needs_write_lock
 
723
    def set_make_working_trees(self, new_value):
 
724
        """Set the policy flag for making working trees when creating branches.
 
725
 
 
726
        This only applies to branches that use this repository.
 
727
 
 
728
        The default is 'True'.
 
729
        :param new_value: True to restore the default, False to disable making
 
730
                          working trees.
 
731
        """
 
732
        raise NotImplementedError(self.set_make_working_trees)
 
733
    
 
734
    def make_working_trees(self):
 
735
        """Returns the policy for making working trees on new branches."""
 
736
        return True
1036
737
 
1037
738
 
1038
739
def install_revision(repository, rev, revision_tree):
1047
748
            parent_trees[p_id] = repository.revision_tree(None)
1048
749
 
1049
750
    inv = revision_tree.inventory
 
751
    
 
752
    # backwards compatability hack: skip the root id.
1050
753
    entries = inv.iter_entries()
1051
 
    # backwards compatability hack: skip the root id.
1052
 
    if not repository.supports_rich_root():
1053
 
        path, root = entries.next()
1054
 
        if root.revision != rev.revision_id:
1055
 
            raise errors.IncompatibleRevision(repr(repository))
 
754
    entries.next()
1056
755
    # Add the texts that are not already present
1057
756
    for path, ie in entries:
1058
757
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
1093
792
                                                _revision_store,
1094
793
                                                control_store,
1095
794
                                                text_store)
 
795
 
1096
796
        dir_mode = self.control_files._dir_mode
1097
797
        file_mode = self.control_files._file_mode
1098
798
 
1124
824
        return not self.control_files._transport.has('no-working-trees')
1125
825
 
1126
826
 
1127
 
class RepositoryFormatRegistry(registry.Registry):
1128
 
    """Registry of RepositoryFormats.
1129
 
    """
1130
 
 
1131
 
    def get(self, format_string):
1132
 
        r = registry.Registry.get(self, format_string)
1133
 
        if callable(r):
1134
 
            r = r()
1135
 
        return r
 
827
class KnitRepository(MetaDirRepository):
 
828
    """Knit format repository."""
 
829
 
 
830
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
 
831
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
 
832
 
 
833
    @needs_read_lock
 
834
    def _all_revision_ids(self):
 
835
        """See Repository.all_revision_ids()."""
 
836
        # Knits get the revision graph from the index of the revision knit, so
 
837
        # it's always possible even if they're on an unlistable transport.
 
838
        return self._revision_store.all_revision_ids(self.get_transaction())
 
839
 
 
840
    def fileid_involved_between_revs(self, from_revid, to_revid):
 
841
        """Find file_id(s) which are involved in the changes between revisions.
 
842
 
 
843
        This determines the set of revisions which are involved, and then
 
844
        finds all file ids affected by those revisions.
 
845
        """
 
846
        vf = self._get_revision_vf()
 
847
        from_set = set(vf.get_ancestry(from_revid))
 
848
        to_set = set(vf.get_ancestry(to_revid))
 
849
        changed = to_set.difference(from_set)
 
850
        return self._fileid_involved_by_set(changed)
 
851
 
 
852
    def fileid_involved(self, last_revid=None):
 
853
        """Find all file_ids modified in the ancestry of last_revid.
 
854
 
 
855
        :param last_revid: If None, last_revision() will be used.
 
856
        """
 
857
        if not last_revid:
 
858
            changed = set(self.all_revision_ids())
 
859
        else:
 
860
            changed = set(self.get_ancestry(last_revid))
 
861
        if None in changed:
 
862
            changed.remove(None)
 
863
        return self._fileid_involved_by_set(changed)
 
864
 
 
865
    @needs_read_lock
 
866
    def get_ancestry(self, revision_id):
 
867
        """Return a list of revision-ids integrated by a revision.
 
868
        
 
869
        This is topologically sorted.
 
870
        """
 
871
        if revision_id is None:
 
872
            return [None]
 
873
        vf = self._get_revision_vf()
 
874
        try:
 
875
            return [None] + vf.get_ancestry(revision_id)
 
876
        except errors.RevisionNotPresent:
 
877
            raise errors.NoSuchRevision(self, revision_id)
 
878
 
 
879
    @needs_read_lock
 
880
    def get_revision(self, revision_id):
 
881
        """Return the Revision object for a named revision"""
 
882
        return self.get_revision_reconcile(revision_id)
 
883
 
 
884
    @needs_read_lock
 
885
    def get_revision_graph(self, revision_id=None):
 
886
        """Return a dictionary containing the revision graph.
 
887
 
 
888
        :param revision_id: The revision_id to get a graph from. If None, then
 
889
        the entire revision graph is returned. This is a deprecated mode of
 
890
        operation and will be removed in the future.
 
891
        :return: a dictionary of revision_id->revision_parents_list.
 
892
        """
 
893
        # special case NULL_REVISION
 
894
        if revision_id == NULL_REVISION:
 
895
            return {}
 
896
        weave = self._get_revision_vf()
 
897
        entire_graph = weave.get_graph()
 
898
        if revision_id is None:
 
899
            return weave.get_graph()
 
900
        elif revision_id not in weave:
 
901
            raise errors.NoSuchRevision(self, revision_id)
 
902
        else:
 
903
            # add what can be reached from revision_id
 
904
            result = {}
 
905
            pending = set([revision_id])
 
906
            while len(pending) > 0:
 
907
                node = pending.pop()
 
908
                result[node] = weave.get_parents(node)
 
909
                for revision_id in result[node]:
 
910
                    if revision_id not in result:
 
911
                        pending.add(revision_id)
 
912
            return result
 
913
 
 
914
    @needs_read_lock
 
915
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
916
        """Return a graph of the revisions with ghosts marked as applicable.
 
917
 
 
918
        :param revision_ids: an iterable of revisions to graph or None for all.
 
919
        :return: a Graph object with the graph reachable from revision_ids.
 
920
        """
 
921
        result = Graph()
 
922
        vf = self._get_revision_vf()
 
923
        versions = set(vf.versions())
 
924
        if not revision_ids:
 
925
            pending = set(self.all_revision_ids())
 
926
            required = set([])
 
927
        else:
 
928
            pending = set(revision_ids)
 
929
            # special case NULL_REVISION
 
930
            if NULL_REVISION in pending:
 
931
                pending.remove(NULL_REVISION)
 
932
            required = set(pending)
 
933
        done = set([])
 
934
        while len(pending):
 
935
            revision_id = pending.pop()
 
936
            if not revision_id in versions:
 
937
                if revision_id in required:
 
938
                    raise errors.NoSuchRevision(self, revision_id)
 
939
                # a ghost
 
940
                result.add_ghost(revision_id)
 
941
                # mark it as done so we don't try for it again.
 
942
                done.add(revision_id)
 
943
                continue
 
944
            parent_ids = vf.get_parents_with_ghosts(revision_id)
 
945
            for parent_id in parent_ids:
 
946
                # is this queued or done ?
 
947
                if (parent_id not in pending and
 
948
                    parent_id not in done):
 
949
                    # no, queue it.
 
950
                    pending.add(parent_id)
 
951
            result.add_node(revision_id, parent_ids)
 
952
            done.add(revision_id)
 
953
        return result
 
954
 
 
955
    def _get_revision_vf(self):
 
956
        """:return: a versioned file containing the revisions."""
 
957
        vf = self._revision_store.get_revision_file(self.get_transaction())
 
958
        return vf
 
959
 
 
960
    @needs_write_lock
 
961
    def reconcile(self, other=None, thorough=False):
 
962
        """Reconcile this repository."""
 
963
        from bzrlib.reconcile import KnitReconciler
 
964
        reconciler = KnitReconciler(self, thorough=thorough)
 
965
        reconciler.reconcile()
 
966
        return reconciler
1136
967
    
1137
 
 
1138
 
format_registry = RepositoryFormatRegistry()
1139
 
"""Registry of formats, indexed by their identifying format string.
1140
 
 
1141
 
This can contain either format instances themselves, or classes/factories that
1142
 
can be called to obtain one.
1143
 
"""
1144
 
 
1145
 
 
1146
 
#####################################################################
1147
 
# Repository Formats
 
968
    def revision_parents(self, revision_id):
 
969
        return self._get_revision_vf().get_parents(revision_id)
 
970
 
1148
971
 
1149
972
class RepositoryFormat(object):
1150
973
    """A repository format.
1170
993
    parameterisation.
1171
994
    """
1172
995
 
1173
 
    def __str__(self):
1174
 
        return "<%s>" % self.__class__.__name__
1175
 
 
1176
 
    def __eq__(self, other):
1177
 
        # format objects are generally stateless
1178
 
        return isinstance(other, self.__class__)
1179
 
 
1180
 
    def __ne__(self, other):
1181
 
        return not self == other
 
996
    _default_format = None
 
997
    """The default format used for new repositories."""
 
998
 
 
999
    _formats = {}
 
1000
    """The known formats."""
1182
1001
 
1183
1002
    @classmethod
1184
1003
    def find_format(klass, a_bzrdir):
1185
 
        """Return the format for the repository object in a_bzrdir.
1186
 
        
1187
 
        This is used by bzr native formats that have a "format" file in
1188
 
        the repository.  Other methods may be used by different types of 
1189
 
        control directory.
1190
 
        """
 
1004
        """Return the format for the repository object in a_bzrdir."""
1191
1005
        try:
1192
1006
            transport = a_bzrdir.get_repository_transport(None)
1193
1007
            format_string = transport.get("format").read()
1194
 
            return format_registry.get(format_string)
 
1008
            return klass._formats[format_string]
1195
1009
        except errors.NoSuchFile:
1196
1010
            raise errors.NoRepositoryPresent(a_bzrdir)
1197
1011
        except KeyError:
1198
1012
            raise errors.UnknownFormatError(format=format_string)
1199
1013
 
1200
 
    @classmethod
1201
 
    def register_format(klass, format):
1202
 
        format_registry.register(format.get_format_string(), format)
1203
 
 
1204
 
    @classmethod
1205
 
    def unregister_format(klass, format):
1206
 
        format_registry.remove(format.get_format_string())
 
1014
    def _get_control_store(self, repo_transport, control_files):
 
1015
        """Return the control store for this repository."""
 
1016
        raise NotImplementedError(self._get_control_store)
1207
1017
    
1208
1018
    @classmethod
1209
1019
    def get_default_format(klass):
1210
1020
        """Return the current default format."""
1211
 
        from bzrlib import bzrdir
1212
 
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1213
 
 
1214
 
    def _get_control_store(self, repo_transport, control_files):
1215
 
        """Return the control store for this repository."""
1216
 
        raise NotImplementedError(self._get_control_store)
 
1021
        return klass._default_format
1217
1022
 
1218
1023
    def get_format_string(self):
1219
1024
        """Return the ASCII format string that identifies this format.
1246
1051
        from bzrlib.store.revision.text import TextRevisionStore
1247
1052
        dir_mode = control_files._dir_mode
1248
1053
        file_mode = control_files._file_mode
1249
 
        text_store = TextStore(transport.clone(name),
 
1054
        text_store =TextStore(transport.clone(name),
1250
1055
                              prefixed=prefixed,
1251
1056
                              compressed=compressed,
1252
1057
                              dir_mode=dir_mode,
1254
1059
        _revision_store = TextRevisionStore(text_store, serializer)
1255
1060
        return _revision_store
1256
1061
 
1257
 
    # TODO: this shouldn't be in the base class, it's specific to things that
1258
 
    # use weaves or knits -- mbp 20070207
1259
1062
    def _get_versioned_file_store(self,
1260
1063
                                  name,
1261
1064
                                  transport,
1262
1065
                                  control_files,
1263
1066
                                  prefixed=True,
1264
 
                                  versionedfile_class=None,
1265
 
                                  versionedfile_kwargs={},
 
1067
                                  versionedfile_class=WeaveFile,
1266
1068
                                  escaped=False):
1267
 
        if versionedfile_class is None:
1268
 
            versionedfile_class = self._versionedfile_class
1269
1069
        weave_transport = control_files._transport.clone(name)
1270
1070
        dir_mode = control_files._dir_mode
1271
1071
        file_mode = control_files._file_mode
1273
1073
                                  dir_mode=dir_mode,
1274
1074
                                  file_mode=file_mode,
1275
1075
                                  versionedfile_class=versionedfile_class,
1276
 
                                  versionedfile_kwargs=versionedfile_kwargs,
1277
1076
                                  escaped=escaped)
1278
1077
 
1279
1078
    def initialize(self, a_bzrdir, shared=False):
1281
1080
 
1282
1081
        :param a_bzrdir: The bzrdir to put the new repository in it.
1283
1082
        :param shared: The repository should be initialized as a sharable one.
1284
 
        :returns: The new repository object.
1285
 
        
 
1083
 
1286
1084
        This may raise UninitializableFormat if shared repository are not
1287
1085
        compatible the a_bzrdir.
1288
1086
        """
1289
 
        raise NotImplementedError(self.initialize)
1290
1087
 
1291
1088
    def is_supported(self):
1292
1089
        """Is this format supported?
1297
1094
        """
1298
1095
        return True
1299
1096
 
1300
 
    def check_conversion_target(self, target_format):
1301
 
        raise NotImplementedError(self.check_conversion_target)
1302
 
 
1303
1097
    def open(self, a_bzrdir, _found=False):
1304
1098
        """Return an instance of this format for the bzrdir a_bzrdir.
1305
1099
        
1307
1101
        """
1308
1102
        raise NotImplementedError(self.open)
1309
1103
 
 
1104
    @classmethod
 
1105
    def register_format(klass, format):
 
1106
        klass._formats[format.get_format_string()] = format
 
1107
 
 
1108
    @classmethod
 
1109
    def set_default_format(klass, format):
 
1110
        klass._default_format = format
 
1111
 
 
1112
    @classmethod
 
1113
    def unregister_format(klass, format):
 
1114
        assert klass._formats[format.get_format_string()] is format
 
1115
        del klass._formats[format.get_format_string()]
 
1116
 
 
1117
 
 
1118
class PreSplitOutRepositoryFormat(RepositoryFormat):
 
1119
    """Base class for the pre split out repository formats."""
 
1120
 
 
1121
    def initialize(self, a_bzrdir, shared=False, _internal=False):
 
1122
        """Create a weave repository.
 
1123
        
 
1124
        TODO: when creating split out bzr branch formats, move this to a common
 
1125
        base for Format5, Format6. or something like that.
 
1126
        """
 
1127
        from bzrlib.weavefile import write_weave_v5
 
1128
        from bzrlib.weave import Weave
 
1129
 
 
1130
        if shared:
 
1131
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
1132
 
 
1133
        if not _internal:
 
1134
            # always initialized when the bzrdir is.
 
1135
            return self.open(a_bzrdir, _found=True)
 
1136
        
 
1137
        # Create an empty weave
 
1138
        sio = StringIO()
 
1139
        write_weave_v5(Weave(), sio)
 
1140
        empty_weave = sio.getvalue()
 
1141
 
 
1142
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1143
        dirs = ['revision-store', 'weaves']
 
1144
        files = [('inventory.weave', StringIO(empty_weave)),
 
1145
                 ]
 
1146
        
 
1147
        # FIXME: RBC 20060125 don't peek under the covers
 
1148
        # NB: no need to escape relative paths that are url safe.
 
1149
        control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
 
1150
                                      TransportLock)
 
1151
        control_files.create_lock()
 
1152
        control_files.lock_write()
 
1153
        control_files._transport.mkdir_multi(dirs,
 
1154
                mode=control_files._dir_mode)
 
1155
        try:
 
1156
            for file, content in files:
 
1157
                control_files.put(file, content)
 
1158
        finally:
 
1159
            control_files.unlock()
 
1160
        return self.open(a_bzrdir, _found=True)
 
1161
 
 
1162
    def _get_control_store(self, repo_transport, control_files):
 
1163
        """Return the control store for this repository."""
 
1164
        return self._get_versioned_file_store('',
 
1165
                                              repo_transport,
 
1166
                                              control_files,
 
1167
                                              prefixed=False)
 
1168
 
 
1169
    def _get_text_store(self, transport, control_files):
 
1170
        """Get a store for file texts for this format."""
 
1171
        raise NotImplementedError(self._get_text_store)
 
1172
 
 
1173
    def open(self, a_bzrdir, _found=False):
 
1174
        """See RepositoryFormat.open()."""
 
1175
        if not _found:
 
1176
            # we are being called directly and must probe.
 
1177
            raise NotImplementedError
 
1178
 
 
1179
        repo_transport = a_bzrdir.get_repository_transport(None)
 
1180
        control_files = a_bzrdir._control_files
 
1181
        text_store = self._get_text_store(repo_transport, control_files)
 
1182
        control_store = self._get_control_store(repo_transport, control_files)
 
1183
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1184
        return AllInOneRepository(_format=self,
 
1185
                                  a_bzrdir=a_bzrdir,
 
1186
                                  _revision_store=_revision_store,
 
1187
                                  control_store=control_store,
 
1188
                                  text_store=text_store)
 
1189
 
 
1190
 
 
1191
class RepositoryFormat4(PreSplitOutRepositoryFormat):
 
1192
    """Bzr repository format 4.
 
1193
 
 
1194
    This repository format has:
 
1195
     - flat stores
 
1196
     - TextStores for texts, inventories,revisions.
 
1197
 
 
1198
    This format is deprecated: it indexes texts using a text id which is
 
1199
    removed in format 5; initialization and write support for this format
 
1200
    has been removed.
 
1201
    """
 
1202
 
 
1203
    def __init__(self):
 
1204
        super(RepositoryFormat4, self).__init__()
 
1205
        self._matchingbzrdir = bzrdir.BzrDirFormat4()
 
1206
 
 
1207
    def get_format_description(self):
 
1208
        """See RepositoryFormat.get_format_description()."""
 
1209
        return "Repository format 4"
 
1210
 
 
1211
    def initialize(self, url, shared=False, _internal=False):
 
1212
        """Format 4 branches cannot be created."""
 
1213
        raise errors.UninitializableFormat(self)
 
1214
 
 
1215
    def is_supported(self):
 
1216
        """Format 4 is not supported.
 
1217
 
 
1218
        It is not supported because the model changed from 4 to 5 and the
 
1219
        conversion logic is expensive - so doing it on the fly was not 
 
1220
        feasible.
 
1221
        """
 
1222
        return False
 
1223
 
 
1224
    def _get_control_store(self, repo_transport, control_files):
 
1225
        """Format 4 repositories have no formal control store at this point.
 
1226
        
 
1227
        This will cause any control-file-needing apis to fail - this is desired.
 
1228
        """
 
1229
        return None
 
1230
    
 
1231
    def _get_revision_store(self, repo_transport, control_files):
 
1232
        """See RepositoryFormat._get_revision_store()."""
 
1233
        from bzrlib.xml4 import serializer_v4
 
1234
        return self._get_text_rev_store(repo_transport,
 
1235
                                        control_files,
 
1236
                                        'revision-store',
 
1237
                                        serializer=serializer_v4)
 
1238
 
 
1239
    def _get_text_store(self, transport, control_files):
 
1240
        """See RepositoryFormat._get_text_store()."""
 
1241
 
 
1242
 
 
1243
class RepositoryFormat5(PreSplitOutRepositoryFormat):
 
1244
    """Bzr control format 5.
 
1245
 
 
1246
    This repository format has:
 
1247
     - weaves for file texts and inventory
 
1248
     - flat stores
 
1249
     - TextStores for revisions and signatures.
 
1250
    """
 
1251
 
 
1252
    def __init__(self):
 
1253
        super(RepositoryFormat5, self).__init__()
 
1254
        self._matchingbzrdir = bzrdir.BzrDirFormat5()
 
1255
 
 
1256
    def get_format_description(self):
 
1257
        """See RepositoryFormat.get_format_description()."""
 
1258
        return "Weave repository format 5"
 
1259
 
 
1260
    def _get_revision_store(self, repo_transport, control_files):
 
1261
        """See RepositoryFormat._get_revision_store()."""
 
1262
        """Return the revision store object for this a_bzrdir."""
 
1263
        return self._get_text_rev_store(repo_transport,
 
1264
                                        control_files,
 
1265
                                        'revision-store',
 
1266
                                        compressed=False)
 
1267
 
 
1268
    def _get_text_store(self, transport, control_files):
 
1269
        """See RepositoryFormat._get_text_store()."""
 
1270
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
 
1271
 
 
1272
 
 
1273
class RepositoryFormat6(PreSplitOutRepositoryFormat):
 
1274
    """Bzr control format 6.
 
1275
 
 
1276
    This repository format has:
 
1277
     - weaves for file texts and inventory
 
1278
     - hash subdirectory based stores.
 
1279
     - TextStores for revisions and signatures.
 
1280
    """
 
1281
 
 
1282
    def __init__(self):
 
1283
        super(RepositoryFormat6, self).__init__()
 
1284
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1285
 
 
1286
    def get_format_description(self):
 
1287
        """See RepositoryFormat.get_format_description()."""
 
1288
        return "Weave repository format 6"
 
1289
 
 
1290
    def _get_revision_store(self, repo_transport, control_files):
 
1291
        """See RepositoryFormat._get_revision_store()."""
 
1292
        return self._get_text_rev_store(repo_transport,
 
1293
                                        control_files,
 
1294
                                        'revision-store',
 
1295
                                        compressed=False,
 
1296
                                        prefixed=True)
 
1297
 
 
1298
    def _get_text_store(self, transport, control_files):
 
1299
        """See RepositoryFormat._get_text_store()."""
 
1300
        return self._get_versioned_file_store('weaves', transport, control_files)
 
1301
 
1310
1302
 
1311
1303
class MetaDirRepositoryFormat(RepositoryFormat):
1312
1304
    """Common base class for the new repositories using the metadir layout."""
1313
1305
 
1314
 
    rich_root_data = False
1315
 
    supports_tree_reference = False
1316
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1317
 
 
1318
1306
    def __init__(self):
1319
1307
        super(MetaDirRepositoryFormat, self).__init__()
 
1308
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1320
1309
 
1321
1310
    def _create_control_files(self, a_bzrdir):
1322
1311
        """Create the required files and the initial control_files object."""
1323
1312
        # FIXME: RBC 20060125 don't peek under the covers
1324
1313
        # NB: no need to escape relative paths that are url safe.
1325
1314
        repository_transport = a_bzrdir.get_repository_transport(self)
1326
 
        control_files = lockable_files.LockableFiles(repository_transport,
1327
 
                                'lock', lockdir.LockDir)
 
1315
        control_files = LockableFiles(repository_transport, 'lock', LockDir)
1328
1316
        control_files.create_lock()
1329
1317
        return control_files
1330
1318
 
1345
1333
            control_files.unlock()
1346
1334
 
1347
1335
 
 
1336
class RepositoryFormat7(MetaDirRepositoryFormat):
 
1337
    """Bzr repository 7.
 
1338
 
 
1339
    This repository format has:
 
1340
     - weaves for file texts and inventory
 
1341
     - hash subdirectory based stores.
 
1342
     - TextStores for revisions and signatures.
 
1343
     - a format marker of its own
 
1344
     - an optional 'shared-storage' flag
 
1345
     - an optional 'no-working-trees' flag
 
1346
    """
 
1347
 
 
1348
    def _get_control_store(self, repo_transport, control_files):
 
1349
        """Return the control store for this repository."""
 
1350
        return self._get_versioned_file_store('',
 
1351
                                              repo_transport,
 
1352
                                              control_files,
 
1353
                                              prefixed=False)
 
1354
 
 
1355
    def get_format_string(self):
 
1356
        """See RepositoryFormat.get_format_string()."""
 
1357
        return "Bazaar-NG Repository format 7"
 
1358
 
 
1359
    def get_format_description(self):
 
1360
        """See RepositoryFormat.get_format_description()."""
 
1361
        return "Weave repository format 7"
 
1362
 
 
1363
    def _get_revision_store(self, repo_transport, control_files):
 
1364
        """See RepositoryFormat._get_revision_store()."""
 
1365
        return self._get_text_rev_store(repo_transport,
 
1366
                                        control_files,
 
1367
                                        'revision-store',
 
1368
                                        compressed=False,
 
1369
                                        prefixed=True,
 
1370
                                        )
 
1371
 
 
1372
    def _get_text_store(self, transport, control_files):
 
1373
        """See RepositoryFormat._get_text_store()."""
 
1374
        return self._get_versioned_file_store('weaves',
 
1375
                                              transport,
 
1376
                                              control_files)
 
1377
 
 
1378
    def initialize(self, a_bzrdir, shared=False):
 
1379
        """Create a weave repository.
 
1380
 
 
1381
        :param shared: If true the repository will be initialized as a shared
 
1382
                       repository.
 
1383
        """
 
1384
        from bzrlib.weavefile import write_weave_v5
 
1385
        from bzrlib.weave import Weave
 
1386
 
 
1387
        # Create an empty weave
 
1388
        sio = StringIO()
 
1389
        write_weave_v5(Weave(), sio)
 
1390
        empty_weave = sio.getvalue()
 
1391
 
 
1392
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1393
        dirs = ['revision-store', 'weaves']
 
1394
        files = [('inventory.weave', StringIO(empty_weave)), 
 
1395
                 ]
 
1396
        utf8_files = [('format', self.get_format_string())]
 
1397
 
 
1398
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1399
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1400
 
 
1401
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1402
        """See RepositoryFormat.open().
 
1403
        
 
1404
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1405
                                    repository at a slightly different url
 
1406
                                    than normal. I.e. during 'upgrade'.
 
1407
        """
 
1408
        if not _found:
 
1409
            format = RepositoryFormat.find_format(a_bzrdir)
 
1410
            assert format.__class__ ==  self.__class__
 
1411
        if _override_transport is not None:
 
1412
            repo_transport = _override_transport
 
1413
        else:
 
1414
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1415
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1416
        text_store = self._get_text_store(repo_transport, control_files)
 
1417
        control_store = self._get_control_store(repo_transport, control_files)
 
1418
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1419
        return MetaDirRepository(_format=self,
 
1420
                                 a_bzrdir=a_bzrdir,
 
1421
                                 control_files=control_files,
 
1422
                                 _revision_store=_revision_store,
 
1423
                                 control_store=control_store,
 
1424
                                 text_store=text_store)
 
1425
 
 
1426
 
 
1427
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
 
1428
    """Bzr repository knit format 1.
 
1429
 
 
1430
    This repository format has:
 
1431
     - knits for file texts and inventory
 
1432
     - hash subdirectory based stores.
 
1433
     - knits for revisions and signatures
 
1434
     - TextStores for revisions and signatures.
 
1435
     - a format marker of its own
 
1436
     - an optional 'shared-storage' flag
 
1437
     - an optional 'no-working-trees' flag
 
1438
     - a LockDir lock
 
1439
 
 
1440
    This format was introduced in bzr 0.8.
 
1441
    """
 
1442
 
 
1443
    def _get_control_store(self, repo_transport, control_files):
 
1444
        """Return the control store for this repository."""
 
1445
        return VersionedFileStore(
 
1446
            repo_transport,
 
1447
            prefixed=False,
 
1448
            file_mode=control_files._file_mode,
 
1449
            versionedfile_class=KnitVersionedFile,
 
1450
            versionedfile_kwargs={'factory':KnitPlainFactory()},
 
1451
            )
 
1452
 
 
1453
    def get_format_string(self):
 
1454
        """See RepositoryFormat.get_format_string()."""
 
1455
        return "Bazaar-NG Knit Repository Format 1"
 
1456
 
 
1457
    def get_format_description(self):
 
1458
        """See RepositoryFormat.get_format_description()."""
 
1459
        return "Knit repository format 1"
 
1460
 
 
1461
    def _get_revision_store(self, repo_transport, control_files):
 
1462
        """See RepositoryFormat._get_revision_store()."""
 
1463
        from bzrlib.store.revision.knit import KnitRevisionStore
 
1464
        versioned_file_store = VersionedFileStore(
 
1465
            repo_transport,
 
1466
            file_mode=control_files._file_mode,
 
1467
            prefixed=False,
 
1468
            precious=True,
 
1469
            versionedfile_class=KnitVersionedFile,
 
1470
            versionedfile_kwargs={'delta':False, 'factory':KnitPlainFactory()},
 
1471
            escaped=True,
 
1472
            )
 
1473
        return KnitRevisionStore(versioned_file_store)
 
1474
 
 
1475
    def _get_text_store(self, transport, control_files):
 
1476
        """See RepositoryFormat._get_text_store()."""
 
1477
        return self._get_versioned_file_store('knits',
 
1478
                                              transport,
 
1479
                                              control_files,
 
1480
                                              versionedfile_class=KnitVersionedFile,
 
1481
                                              escaped=True)
 
1482
 
 
1483
    def initialize(self, a_bzrdir, shared=False):
 
1484
        """Create a knit format 1 repository.
 
1485
 
 
1486
        :param a_bzrdir: bzrdir to contain the new repository; must already
 
1487
            be initialized.
 
1488
        :param shared: If true the repository will be initialized as a shared
 
1489
                       repository.
 
1490
        """
 
1491
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1492
        dirs = ['revision-store', 'knits']
 
1493
        files = []
 
1494
        utf8_files = [('format', self.get_format_string())]
 
1495
        
 
1496
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1497
        repo_transport = a_bzrdir.get_repository_transport(None)
 
1498
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1499
        control_store = self._get_control_store(repo_transport, control_files)
 
1500
        transaction = transactions.WriteTransaction()
 
1501
        # trigger a write of the inventory store.
 
1502
        control_store.get_weave_or_empty('inventory', transaction)
 
1503
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1504
        _revision_store.has_revision_id('A', transaction)
 
1505
        _revision_store.get_signature_file(transaction)
 
1506
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1507
 
 
1508
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1509
        """See RepositoryFormat.open().
 
1510
        
 
1511
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1512
                                    repository at a slightly different url
 
1513
                                    than normal. I.e. during 'upgrade'.
 
1514
        """
 
1515
        if not _found:
 
1516
            format = RepositoryFormat.find_format(a_bzrdir)
 
1517
            assert format.__class__ ==  self.__class__
 
1518
        if _override_transport is not None:
 
1519
            repo_transport = _override_transport
 
1520
        else:
 
1521
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1522
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1523
        text_store = self._get_text_store(repo_transport, control_files)
 
1524
        control_store = self._get_control_store(repo_transport, control_files)
 
1525
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1526
        return KnitRepository(_format=self,
 
1527
                              a_bzrdir=a_bzrdir,
 
1528
                              control_files=control_files,
 
1529
                              _revision_store=_revision_store,
 
1530
                              control_store=control_store,
 
1531
                              text_store=text_store)
 
1532
 
 
1533
 
1348
1534
# formats which have no format string are not discoverable
1349
 
# and not independently creatable, so are not registered.  They're 
1350
 
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
1351
 
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1352
 
# the repository is not separately opened are similar.
1353
 
 
1354
 
format_registry.register_lazy(
1355
 
    'Bazaar-NG Repository format 7',
1356
 
    'bzrlib.repofmt.weaverepo',
1357
 
    'RepositoryFormat7'
1358
 
    )
1359
 
# KEEP in sync with bzrdir.format_registry default, which controls the overall
1360
 
# default control directory format
1361
 
 
1362
 
format_registry.register_lazy(
1363
 
    'Bazaar-NG Knit Repository Format 1',
1364
 
    'bzrlib.repofmt.knitrepo',
1365
 
    'RepositoryFormatKnit1',
1366
 
    )
1367
 
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
1368
 
 
1369
 
format_registry.register_lazy(
1370
 
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1371
 
    'bzrlib.repofmt.knitrepo',
1372
 
    'RepositoryFormatKnit3',
1373
 
    )
 
1535
# and not independently creatable, so are not registered.
 
1536
RepositoryFormat.register_format(RepositoryFormat7())
 
1537
_default_format = RepositoryFormatKnit1()
 
1538
RepositoryFormat.register_format(_default_format)
 
1539
RepositoryFormat.set_default_format(_default_format)
 
1540
_legacy_formats = [RepositoryFormat4(),
 
1541
                   RepositoryFormat5(),
 
1542
                   RepositoryFormat6()]
1374
1543
 
1375
1544
 
1376
1545
class InterRepository(InterObject):
1385
1554
    InterRepository.get(other).method_name(parameters).
1386
1555
    """
1387
1556
 
1388
 
    _optimisers = []
 
1557
    _optimisers = set()
1389
1558
    """The available optimised InterRepository types."""
1390
1559
 
1391
 
    def copy_content(self, revision_id=None):
1392
 
        raise NotImplementedError(self.copy_content)
1393
 
 
 
1560
    @needs_write_lock
 
1561
    def copy_content(self, revision_id=None, basis=None):
 
1562
        """Make a complete copy of the content in self into destination.
 
1563
        
 
1564
        This is a destructive operation! Do not use it on existing 
 
1565
        repositories.
 
1566
 
 
1567
        :param revision_id: Only copy the content needed to construct
 
1568
                            revision_id and its parents.
 
1569
        :param basis: Copy the needed data preferentially from basis.
 
1570
        """
 
1571
        try:
 
1572
            self.target.set_make_working_trees(self.source.make_working_trees())
 
1573
        except NotImplementedError:
 
1574
            pass
 
1575
        # grab the basis available data
 
1576
        if basis is not None:
 
1577
            self.target.fetch(basis, revision_id=revision_id)
 
1578
        # but don't bother fetching if we have the needed data now.
 
1579
        if (revision_id not in (None, NULL_REVISION) and 
 
1580
            self.target.has_revision(revision_id)):
 
1581
            return
 
1582
        self.target.fetch(self.source, revision_id=revision_id)
 
1583
 
 
1584
    @needs_write_lock
1394
1585
    def fetch(self, revision_id=None, pb=None):
1395
1586
        """Fetch the content required to construct revision_id.
1396
1587
 
1397
 
        The content is copied from self.source to self.target.
 
1588
        The content is copied from source to target.
1398
1589
 
1399
1590
        :param revision_id: if None all content is copied, if NULL_REVISION no
1400
1591
                            content is copied.
1404
1595
        Returns the copied revision count and the failed revisions in a tuple:
1405
1596
        (copied, failures).
1406
1597
        """
1407
 
        raise NotImplementedError(self.fetch)
1408
 
   
 
1598
        from bzrlib.fetch import GenericRepoFetcher
 
1599
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1600
               self.source, self.source._format, self.target, self.target._format)
 
1601
        f = GenericRepoFetcher(to_repository=self.target,
 
1602
                               from_repository=self.source,
 
1603
                               last_revision=revision_id,
 
1604
                               pb=pb)
 
1605
        return f.count_copied, f.failed_revisions
 
1606
 
1409
1607
    @needs_read_lock
1410
1608
    def missing_revision_ids(self, revision_id=None):
1411
1609
        """Return the revision ids that source has that target does not.
1418
1616
        # generic, possibly worst case, slow code path.
1419
1617
        target_ids = set(self.target.all_revision_ids())
1420
1618
        if revision_id is not None:
1421
 
            # TODO: jam 20070210 InterRepository is internal enough that it
1422
 
            #       should assume revision_ids are already utf-8
1423
 
            revision_id = osutils.safe_revision_id(revision_id)
1424
1619
            source_ids = self.source.get_ancestry(revision_id)
1425
 
            assert source_ids[0] is None
 
1620
            assert source_ids[0] == None
1426
1621
            source_ids.pop(0)
1427
1622
        else:
1428
1623
            source_ids = self.source.all_revision_ids()
1433
1628
        return [rev_id for rev_id in source_ids if rev_id in result_set]
1434
1629
 
1435
1630
 
1436
 
class InterSameDataRepository(InterRepository):
1437
 
    """Code for converting between repositories that represent the same data.
1438
 
    
1439
 
    Data format and model must match for this to work.
1440
 
    """
1441
 
 
1442
 
    @classmethod
1443
 
    def _get_repo_format_to_test(self):
1444
 
        """Repository format for testing with."""
1445
 
        return RepositoryFormat.get_default_format()
1446
 
 
1447
 
    @staticmethod
1448
 
    def is_compatible(source, target):
1449
 
        if source.supports_rich_root() != target.supports_rich_root():
1450
 
            return False
1451
 
        if source._serializer != target._serializer:
1452
 
            return False
1453
 
        return True
1454
 
 
1455
 
    @needs_write_lock
1456
 
    def copy_content(self, revision_id=None):
1457
 
        """Make a complete copy of the content in self into destination.
1458
 
 
1459
 
        This copies both the repository's revision data, and configuration information
1460
 
        such as the make_working_trees setting.
1461
 
        
1462
 
        This is a destructive operation! Do not use it on existing 
1463
 
        repositories.
1464
 
 
1465
 
        :param revision_id: Only copy the content needed to construct
1466
 
                            revision_id and its parents.
1467
 
        """
1468
 
        try:
1469
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1470
 
        except NotImplementedError:
1471
 
            pass
1472
 
        # TODO: jam 20070210 This is fairly internal, so we should probably
1473
 
        #       just assert that revision_id is not unicode.
1474
 
        revision_id = osutils.safe_revision_id(revision_id)
1475
 
        # but don't bother fetching if we have the needed data now.
1476
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1477
 
            self.target.has_revision(revision_id)):
1478
 
            return
1479
 
        self.target.fetch(self.source, revision_id=revision_id)
1480
 
 
1481
 
    @needs_write_lock
1482
 
    def fetch(self, revision_id=None, pb=None):
1483
 
        """See InterRepository.fetch()."""
1484
 
        from bzrlib.fetch import GenericRepoFetcher
1485
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1486
 
               self.source, self.source._format, self.target, 
1487
 
               self.target._format)
1488
 
        # TODO: jam 20070210 This should be an assert, not a translate
1489
 
        revision_id = osutils.safe_revision_id(revision_id)
1490
 
        f = GenericRepoFetcher(to_repository=self.target,
1491
 
                               from_repository=self.source,
1492
 
                               last_revision=revision_id,
1493
 
                               pb=pb)
1494
 
        return f.count_copied, f.failed_revisions
1495
 
 
1496
 
 
1497
 
class InterWeaveRepo(InterSameDataRepository):
 
1631
class InterWeaveRepo(InterRepository):
1498
1632
    """Optimised code paths between Weave based repositories."""
1499
1633
 
1500
 
    @classmethod
1501
 
    def _get_repo_format_to_test(self):
1502
 
        from bzrlib.repofmt import weaverepo
1503
 
        return weaverepo.RepositoryFormat7()
 
1634
    _matching_repo_format = RepositoryFormat7()
 
1635
    """Repository format for testing with."""
1504
1636
 
1505
1637
    @staticmethod
1506
1638
    def is_compatible(source, target):
1510
1642
        could lead to confusing results, and there is no need to be 
1511
1643
        overly general.
1512
1644
        """
1513
 
        from bzrlib.repofmt.weaverepo import (
1514
 
                RepositoryFormat5,
1515
 
                RepositoryFormat6,
1516
 
                RepositoryFormat7,
1517
 
                )
1518
1645
        try:
1519
1646
            return (isinstance(source._format, (RepositoryFormat5,
1520
1647
                                                RepositoryFormat6,
1526
1653
            return False
1527
1654
    
1528
1655
    @needs_write_lock
1529
 
    def copy_content(self, revision_id=None):
 
1656
    def copy_content(self, revision_id=None, basis=None):
1530
1657
        """See InterRepository.copy_content()."""
1531
1658
        # weave specific optimised path:
1532
 
        # TODO: jam 20070210 Internal, should be an assert, not translate
1533
 
        revision_id = osutils.safe_revision_id(revision_id)
1534
 
        try:
1535
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1536
 
        except NotImplementedError:
1537
 
            pass
1538
 
        # FIXME do not peek!
1539
 
        if self.source.control_files._transport.listable():
1540
 
            pb = ui.ui_factory.nested_progress_bar()
 
1659
        if basis is not None:
 
1660
            # copy the basis in, then fetch remaining data.
 
1661
            basis.copy_content_into(self.target, revision_id)
 
1662
            # the basis copy_content_into could miss-set this.
1541
1663
            try:
1542
 
                self.target.weave_store.copy_all_ids(
1543
 
                    self.source.weave_store,
1544
 
                    pb=pb,
1545
 
                    from_transaction=self.source.get_transaction(),
1546
 
                    to_transaction=self.target.get_transaction())
1547
 
                pb.update('copying inventory', 0, 1)
1548
 
                self.target.control_weaves.copy_multi(
1549
 
                    self.source.control_weaves, ['inventory'],
1550
 
                    from_transaction=self.source.get_transaction(),
1551
 
                    to_transaction=self.target.get_transaction())
1552
 
                self.target._revision_store.text_store.copy_all_ids(
1553
 
                    self.source._revision_store.text_store,
1554
 
                    pb=pb)
1555
 
            finally:
1556
 
                pb.finished()
1557
 
        else:
 
1664
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1665
            except NotImplementedError:
 
1666
                pass
1558
1667
            self.target.fetch(self.source, revision_id=revision_id)
 
1668
        else:
 
1669
            try:
 
1670
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1671
            except NotImplementedError:
 
1672
                pass
 
1673
            # FIXME do not peek!
 
1674
            if self.source.control_files._transport.listable():
 
1675
                pb = ui.ui_factory.nested_progress_bar()
 
1676
                try:
 
1677
                    self.target.weave_store.copy_all_ids(
 
1678
                        self.source.weave_store,
 
1679
                        pb=pb,
 
1680
                        from_transaction=self.source.get_transaction(),
 
1681
                        to_transaction=self.target.get_transaction())
 
1682
                    pb.update('copying inventory', 0, 1)
 
1683
                    self.target.control_weaves.copy_multi(
 
1684
                        self.source.control_weaves, ['inventory'],
 
1685
                        from_transaction=self.source.get_transaction(),
 
1686
                        to_transaction=self.target.get_transaction())
 
1687
                    self.target._revision_store.text_store.copy_all_ids(
 
1688
                        self.source._revision_store.text_store,
 
1689
                        pb=pb)
 
1690
                finally:
 
1691
                    pb.finished()
 
1692
            else:
 
1693
                self.target.fetch(self.source, revision_id=revision_id)
1559
1694
 
1560
1695
    @needs_write_lock
1561
1696
    def fetch(self, revision_id=None, pb=None):
1563
1698
        from bzrlib.fetch import GenericRepoFetcher
1564
1699
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1565
1700
               self.source, self.source._format, self.target, self.target._format)
1566
 
        # TODO: jam 20070210 This should be an assert, not a translate
1567
 
        revision_id = osutils.safe_revision_id(revision_id)
1568
1701
        f = GenericRepoFetcher(to_repository=self.target,
1569
1702
                               from_repository=self.source,
1570
1703
                               last_revision=revision_id,
1587
1720
        # - RBC 20060209
1588
1721
        if revision_id is not None:
1589
1722
            source_ids = self.source.get_ancestry(revision_id)
1590
 
            assert source_ids[0] is None
 
1723
            assert source_ids[0] == None
1591
1724
            source_ids.pop(0)
1592
1725
        else:
1593
1726
            source_ids = self.source._all_possible_ids()
1613
1746
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1614
1747
 
1615
1748
 
1616
 
class InterKnitRepo(InterSameDataRepository):
 
1749
class InterKnitRepo(InterRepository):
1617
1750
    """Optimised code paths between Knit based repositories."""
1618
1751
 
1619
 
    @classmethod
1620
 
    def _get_repo_format_to_test(self):
1621
 
        from bzrlib.repofmt import knitrepo
1622
 
        return knitrepo.RepositoryFormatKnit1()
 
1752
    _matching_repo_format = RepositoryFormatKnit1()
 
1753
    """Repository format for testing with."""
1623
1754
 
1624
1755
    @staticmethod
1625
1756
    def is_compatible(source, target):
1629
1760
        could lead to confusing results, and there is no need to be 
1630
1761
        overly general.
1631
1762
        """
1632
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1
1633
1763
        try:
1634
1764
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1635
1765
                    isinstance(target._format, (RepositoryFormatKnit1)))
1642
1772
        from bzrlib.fetch import KnitRepoFetcher
1643
1773
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1644
1774
               self.source, self.source._format, self.target, self.target._format)
1645
 
        # TODO: jam 20070210 This should be an assert, not a translate
1646
 
        revision_id = osutils.safe_revision_id(revision_id)
1647
1775
        f = KnitRepoFetcher(to_repository=self.target,
1648
1776
                            from_repository=self.source,
1649
1777
                            last_revision=revision_id,
1655
1783
        """See InterRepository.missing_revision_ids()."""
1656
1784
        if revision_id is not None:
1657
1785
            source_ids = self.source.get_ancestry(revision_id)
1658
 
            assert source_ids[0] is None
 
1786
            assert source_ids[0] == None
1659
1787
            source_ids.pop(0)
1660
1788
        else:
1661
1789
            source_ids = self.source._all_possible_ids()
1680
1808
            # that against the revision records.
1681
1809
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1682
1810
 
1683
 
 
1684
 
class InterModel1and2(InterRepository):
1685
 
 
1686
 
    @classmethod
1687
 
    def _get_repo_format_to_test(self):
1688
 
        return None
1689
 
 
1690
 
    @staticmethod
1691
 
    def is_compatible(source, target):
1692
 
        if not source.supports_rich_root() and target.supports_rich_root():
1693
 
            return True
1694
 
        else:
1695
 
            return False
1696
 
 
1697
 
    @needs_write_lock
1698
 
    def fetch(self, revision_id=None, pb=None):
1699
 
        """See InterRepository.fetch()."""
1700
 
        from bzrlib.fetch import Model1toKnit2Fetcher
1701
 
        # TODO: jam 20070210 This should be an assert, not a translate
1702
 
        revision_id = osutils.safe_revision_id(revision_id)
1703
 
        f = Model1toKnit2Fetcher(to_repository=self.target,
1704
 
                                 from_repository=self.source,
1705
 
                                 last_revision=revision_id,
1706
 
                                 pb=pb)
1707
 
        return f.count_copied, f.failed_revisions
1708
 
 
1709
 
    @needs_write_lock
1710
 
    def copy_content(self, revision_id=None):
1711
 
        """Make a complete copy of the content in self into destination.
1712
 
        
1713
 
        This is a destructive operation! Do not use it on existing 
1714
 
        repositories.
1715
 
 
1716
 
        :param revision_id: Only copy the content needed to construct
1717
 
                            revision_id and its parents.
1718
 
        """
1719
 
        try:
1720
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1721
 
        except NotImplementedError:
1722
 
            pass
1723
 
        # TODO: jam 20070210 Internal, assert, don't translate
1724
 
        revision_id = osutils.safe_revision_id(revision_id)
1725
 
        # but don't bother fetching if we have the needed data now.
1726
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1727
 
            self.target.has_revision(revision_id)):
1728
 
            return
1729
 
        self.target.fetch(self.source, revision_id=revision_id)
1730
 
 
1731
 
 
1732
 
class InterKnit1and2(InterKnitRepo):
1733
 
 
1734
 
    @classmethod
1735
 
    def _get_repo_format_to_test(self):
1736
 
        return None
1737
 
 
1738
 
    @staticmethod
1739
 
    def is_compatible(source, target):
1740
 
        """Be compatible with Knit1 source and Knit3 target"""
1741
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
1742
 
        try:
1743
 
            from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
1744
 
                    RepositoryFormatKnit3
1745
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1746
 
                    isinstance(target._format, (RepositoryFormatKnit3)))
1747
 
        except AttributeError:
1748
 
            return False
1749
 
 
1750
 
    @needs_write_lock
1751
 
    def fetch(self, revision_id=None, pb=None):
1752
 
        """See InterRepository.fetch()."""
1753
 
        from bzrlib.fetch import Knit1to2Fetcher
1754
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1755
 
               self.source, self.source._format, self.target, 
1756
 
               self.target._format)
1757
 
        # TODO: jam 20070210 This should be an assert, not a translate
1758
 
        revision_id = osutils.safe_revision_id(revision_id)
1759
 
        f = Knit1to2Fetcher(to_repository=self.target,
1760
 
                            from_repository=self.source,
1761
 
                            last_revision=revision_id,
1762
 
                            pb=pb)
1763
 
        return f.count_copied, f.failed_revisions
1764
 
 
1765
 
 
1766
 
class InterRemoteRepository(InterRepository):
1767
 
    """Code for converting between RemoteRepository objects.
1768
 
 
1769
 
    This just gets an non-remote repository from the RemoteRepository, and calls
1770
 
    InterRepository.get again.
1771
 
    """
1772
 
 
1773
 
    def __init__(self, source, target):
1774
 
        if isinstance(source, remote.RemoteRepository):
1775
 
            source._ensure_real()
1776
 
            real_source = source._real_repository
1777
 
        else:
1778
 
            real_source = source
1779
 
        if isinstance(target, remote.RemoteRepository):
1780
 
            target._ensure_real()
1781
 
            real_target = target._real_repository
1782
 
        else:
1783
 
            real_target = target
1784
 
        self.real_inter = InterRepository.get(real_source, real_target)
1785
 
 
1786
 
    @staticmethod
1787
 
    def is_compatible(source, target):
1788
 
        if isinstance(source, remote.RemoteRepository):
1789
 
            return True
1790
 
        if isinstance(target, remote.RemoteRepository):
1791
 
            return True
1792
 
        return False
1793
 
 
1794
 
    def copy_content(self, revision_id=None):
1795
 
        self.real_inter.copy_content(revision_id=revision_id)
1796
 
 
1797
 
    def fetch(self, revision_id=None, pb=None):
1798
 
        self.real_inter.fetch(revision_id=revision_id, pb=pb)
1799
 
 
1800
 
    @classmethod
1801
 
    def _get_repo_format_to_test(self):
1802
 
        return None
1803
 
 
1804
 
 
1805
 
InterRepository.register_optimiser(InterSameDataRepository)
1806
1811
InterRepository.register_optimiser(InterWeaveRepo)
1807
1812
InterRepository.register_optimiser(InterKnitRepo)
1808
 
InterRepository.register_optimiser(InterModel1and2)
1809
 
InterRepository.register_optimiser(InterKnit1and2)
1810
 
InterRepository.register_optimiser(InterRemoteRepository)
 
1813
 
 
1814
 
 
1815
class RepositoryTestProviderAdapter(object):
 
1816
    """A tool to generate a suite testing multiple repository formats at once.
 
1817
 
 
1818
    This is done by copying the test once for each transport and injecting
 
1819
    the transport_server, transport_readonly_server, and bzrdir_format and
 
1820
    repository_format classes into each copy. Each copy is also given a new id()
 
1821
    to make it easy to identify.
 
1822
    """
 
1823
 
 
1824
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1825
        self._transport_server = transport_server
 
1826
        self._transport_readonly_server = transport_readonly_server
 
1827
        self._formats = formats
 
1828
    
 
1829
    def adapt(self, test):
 
1830
        result = TestSuite()
 
1831
        for repository_format, bzrdir_format in self._formats:
 
1832
            new_test = deepcopy(test)
 
1833
            new_test.transport_server = self._transport_server
 
1834
            new_test.transport_readonly_server = self._transport_readonly_server
 
1835
            new_test.bzrdir_format = bzrdir_format
 
1836
            new_test.repository_format = repository_format
 
1837
            def make_new_test_id():
 
1838
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
 
1839
                return lambda: new_id
 
1840
            new_test.id = make_new_test_id()
 
1841
            result.addTest(new_test)
 
1842
        return result
 
1843
 
 
1844
 
 
1845
class InterRepositoryTestProviderAdapter(object):
 
1846
    """A tool to generate a suite testing multiple inter repository formats.
 
1847
 
 
1848
    This is done by copying the test once for each interrepo provider and injecting
 
1849
    the transport_server, transport_readonly_server, repository_format and 
 
1850
    repository_to_format classes into each copy.
 
1851
    Each copy is also given a new id() to make it easy to identify.
 
1852
    """
 
1853
 
 
1854
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1855
        self._transport_server = transport_server
 
1856
        self._transport_readonly_server = transport_readonly_server
 
1857
        self._formats = formats
 
1858
    
 
1859
    def adapt(self, test):
 
1860
        result = TestSuite()
 
1861
        for interrepo_class, repository_format, repository_format_to in self._formats:
 
1862
            new_test = deepcopy(test)
 
1863
            new_test.transport_server = self._transport_server
 
1864
            new_test.transport_readonly_server = self._transport_readonly_server
 
1865
            new_test.interrepo_class = interrepo_class
 
1866
            new_test.repository_format = repository_format
 
1867
            new_test.repository_format_to = repository_format_to
 
1868
            def make_new_test_id():
 
1869
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
 
1870
                return lambda: new_id
 
1871
            new_test.id = make_new_test_id()
 
1872
            result.addTest(new_test)
 
1873
        return result
 
1874
 
 
1875
    @staticmethod
 
1876
    def default_test_list():
 
1877
        """Generate the default list of interrepo permutations to test."""
 
1878
        result = []
 
1879
        # test the default InterRepository between format 6 and the current 
 
1880
        # default format.
 
1881
        # XXX: robertc 20060220 reinstate this when there are two supported
 
1882
        # formats which do not have an optimal code path between them.
 
1883
        result.append((InterRepository,
 
1884
                       RepositoryFormat6(),
 
1885
                       RepositoryFormatKnit1()))
 
1886
        for optimiser in InterRepository._optimisers:
 
1887
            result.append((optimiser,
 
1888
                           optimiser._matching_repo_format,
 
1889
                           optimiser._matching_repo_format
 
1890
                           ))
 
1891
        # if there are specific combinations we want to use, we can add them 
 
1892
        # here.
 
1893
        return result
1811
1894
 
1812
1895
 
1813
1896
class CopyConverter(object):
1839
1922
        self.step('Moving repository to repository.backup')
1840
1923
        self.repo_dir.transport.move('repository', 'repository.backup')
1841
1924
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1842
 
        repo._format.check_conversion_target(self.target_format)
1843
1925
        self.source_repo = repo._format.open(self.repo_dir,
1844
1926
            _found=True,
1845
1927
            _override_transport=backup_transport)
1868
1950
    This allows describing a tree to be committed without needing to 
1869
1951
    know the internals of the format of the repository.
1870
1952
    """
1871
 
    
1872
 
    record_root_entry = False
1873
1953
    def __init__(self, repository, parents, config, timestamp=None, 
1874
1954
                 timezone=None, committer=None, revprops=None, 
1875
1955
                 revision_id=None):
1892
1972
            assert isinstance(committer, basestring), type(committer)
1893
1973
            self._committer = committer
1894
1974
 
1895
 
        self.new_inventory = Inventory(None)
1896
 
        self._new_revision_id = osutils.safe_revision_id(revision_id)
 
1975
        self.new_inventory = Inventory()
 
1976
        self._new_revision_id = revision_id
1897
1977
        self.parents = parents
1898
1978
        self.repository = repository
1899
1979
 
1907
1987
        self._timestamp = round(timestamp, 3)
1908
1988
 
1909
1989
        if timezone is None:
1910
 
            self._timezone = osutils.local_time_offset()
 
1990
            self._timezone = local_time_offset()
1911
1991
        else:
1912
1992
            self._timezone = int(timezone)
1913
1993
 
1918
1998
 
1919
1999
        :return: The revision id of the recorded revision.
1920
2000
        """
1921
 
        rev = _mod_revision.Revision(
1922
 
                       timestamp=self._timestamp,
 
2001
        rev = Revision(timestamp=self._timestamp,
1923
2002
                       timezone=self._timezone,
1924
2003
                       committer=self._committer,
1925
2004
                       message=message,
1931
2010
            self.new_inventory, self._config)
1932
2011
        return self._new_revision_id
1933
2012
 
1934
 
    def revision_tree(self):
1935
 
        """Return the tree that was just committed.
1936
 
 
1937
 
        After calling commit() this can be called to get a RevisionTree
1938
 
        representing the newly committed tree. This is preferred to
1939
 
        calling Repository.revision_tree() because that may require
1940
 
        deserializing the inventory, while we already have a copy in
1941
 
        memory.
1942
 
        """
1943
 
        return RevisionTree(self.repository, self.new_inventory,
1944
 
                            self._new_revision_id)
1945
 
 
1946
2013
    def finish_inventory(self):
1947
2014
        """Tell the builder that the inventory is finished."""
1948
 
        if self.new_inventory.root is None:
1949
 
            symbol_versioning.warn('Root entry should be supplied to'
1950
 
                ' record_entry_contents, as of bzr 0.10.',
1951
 
                 DeprecationWarning, stacklevel=2)
1952
 
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
1953
2015
        self.new_inventory.revision_id = self._new_revision_id
1954
2016
        self.inv_sha1 = self.repository.add_inventory(
1955
2017
            self._new_revision_id,
1959
2021
 
1960
2022
    def _gen_revision_id(self):
1961
2023
        """Return new revision-id."""
1962
 
        return generate_ids.gen_revision_id(self._config.username(),
1963
 
                                            self._timestamp)
 
2024
        s = '%s-%s-' % (self._config.user_email(), 
 
2025
                        compact_date(self._timestamp))
 
2026
        s += hexlify(rand_bytes(8))
 
2027
        return s
1964
2028
 
1965
2029
    def _generate_revision_if_needed(self):
1966
2030
        """Create a revision id if None was supplied.
1967
2031
        
1968
2032
        If the repository can not support user-specified revision ids
1969
 
        they should override this function and raise CannotSetRevisionId
 
2033
        they should override this function and raise UnsupportedOperation
1970
2034
        if _new_revision_id is not None.
1971
2035
 
1972
 
        :raises: CannotSetRevisionId
 
2036
        :raises: UnsupportedOperation
1973
2037
        """
1974
2038
        if self._new_revision_id is None:
1975
2039
            self._new_revision_id = self._gen_revision_id()
1977
2041
    def record_entry_contents(self, ie, parent_invs, path, tree):
1978
2042
        """Record the content of ie from tree into the commit if needed.
1979
2043
 
1980
 
        Side effect: sets ie.revision when unchanged
1981
 
 
1982
2044
        :param ie: An inventory entry present in the commit.
1983
2045
        :param parent_invs: The inventories of the parent revisions of the
1984
2046
            commit.
1986
2048
        :param tree: The tree which contains this entry and should be used to 
1987
2049
        obtain content.
1988
2050
        """
1989
 
        if self.new_inventory.root is None and ie.parent_id is not None:
1990
 
            symbol_versioning.warn('Root entry should be supplied to'
1991
 
                ' record_entry_contents, as of bzr 0.10.',
1992
 
                 DeprecationWarning, stacklevel=2)
1993
 
            self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
1994
 
                                       '', tree)
1995
2051
        self.new_inventory.add(ie)
1996
2052
 
1997
2053
        # ie.revision is always None if the InventoryEntry is considered
1999
2055
        # which may be the sole parent if it is untouched.
2000
2056
        if ie.revision is not None:
2001
2057
            return
2002
 
 
2003
 
        # In this revision format, root entries have no knit or weave
2004
 
        if ie is self.new_inventory.root:
2005
 
            # When serializing out to disk and back in
2006
 
            # root.revision is always _new_revision_id
2007
 
            ie.revision = self._new_revision_id
2008
 
            return
2009
2058
        previous_entries = ie.find_previous_heads(
2010
2059
            parent_invs,
2011
2060
            self.repository.weave_store,
2021
2070
        :param file_parents: The per-file parent revision ids.
2022
2071
        """
2023
2072
        self._add_text_to_weave(file_id, [], file_parents.keys())
2024
 
 
2025
 
    def modified_reference(self, file_id, file_parents):
2026
 
        """Record the modification of a reference.
2027
 
 
2028
 
        :param file_id: The file_id of the link to record.
2029
 
        :param file_parents: The per-file parent revision ids.
2030
 
        """
2031
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2032
2073
    
2033
2074
    def modified_file_text(self, file_id, file_parents,
2034
2075
                           get_content_byte_lines, text_sha1=None,
2079
2120
        versionedfile.clear_cache()
2080
2121
 
2081
2122
 
2082
 
class _CommitBuilder(CommitBuilder):
2083
 
    """Temporary class so old CommitBuilders are detected properly
2084
 
    
2085
 
    Note: CommitBuilder works whether or not root entry is recorded.
2086
 
    """
2087
 
 
2088
 
    record_root_entry = True
2089
 
 
2090
 
 
2091
 
class RootCommitBuilder(CommitBuilder):
2092
 
    """This commitbuilder actually records the root id"""
2093
 
    
2094
 
    record_root_entry = True
2095
 
 
2096
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2097
 
        """Record the content of ie from tree into the commit if needed.
2098
 
 
2099
 
        Side effect: sets ie.revision when unchanged
2100
 
 
2101
 
        :param ie: An inventory entry present in the commit.
2102
 
        :param parent_invs: The inventories of the parent revisions of the
2103
 
            commit.
2104
 
        :param path: The path the entry is at in the tree.
2105
 
        :param tree: The tree which contains this entry and should be used to 
2106
 
        obtain content.
2107
 
        """
2108
 
        assert self.new_inventory.root is not None or ie.parent_id is None
2109
 
        self.new_inventory.add(ie)
2110
 
 
2111
 
        # ie.revision is always None if the InventoryEntry is considered
2112
 
        # for committing. ie.snapshot will record the correct revision 
2113
 
        # which may be the sole parent if it is untouched.
2114
 
        if ie.revision is not None:
2115
 
            return
2116
 
 
2117
 
        previous_entries = ie.find_previous_heads(
2118
 
            parent_invs,
2119
 
            self.repository.weave_store,
2120
 
            self.repository.get_transaction())
2121
 
        # we are creating a new revision for ie in the history store
2122
 
        # and inventory.
2123
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2124
 
 
2125
 
 
2126
2123
_unescape_map = {
2127
2124
    'apos':"'",
2128
2125
    'quot':'"',
2133
2130
 
2134
2131
 
2135
2132
def _unescaper(match, _map=_unescape_map):
2136
 
    code = match.group(1)
2137
 
    try:
2138
 
        return _map[code]
2139
 
    except KeyError:
2140
 
        if not code.startswith('#'):
2141
 
            raise
2142
 
        return unichr(int(code[1:])).encode('utf8')
 
2133
    return _map[match.group(1)]
2143
2134
 
2144
2135
 
2145
2136
_unescape_re = None
2149
2140
    """Unescape predefined XML entities in a string of data."""
2150
2141
    global _unescape_re
2151
2142
    if _unescape_re is None:
2152
 
        _unescape_re = re.compile('\&([^;]*);')
 
2143
        _unescape_re = re.compile('\&([^;]*);')
2153
2144
    return _unescape_re.sub(_unescaper, data)