~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Robert Collins
  • Date: 2007-05-07 16:48:14 UTC
  • mto: This revision was merged to the branch mainline in revision 2485.
  • Revision ID: robertc@robertcollins.net-20070507164814-wpagonutf4b5cf8s
Move HACKING to docs/developers/HACKING and adjust Makefile to accomodate this.

Show diffs side-by-side

added added

removed removed

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