/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-08-19 18:04:49 UTC
  • mfrom: (4593.5.43 1.19-known-graph-sorted)
  • Revision ID: pqm@pqm.ubuntu.com-20090819180449-p5dibldf9pcp24n4
(jam) Add VersionedFiles.get_known_graph_ancestry and
        KnownGraph.merge_sort()

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
27
 
    config,
28
27
    debug,
29
28
    errors,
30
 
    fetch as _mod_fetch,
31
29
    fifo_cache,
32
30
    generate_ids,
33
31
    gpg,
40
38
    lru_cache,
41
39
    osutils,
42
40
    revision as _mod_revision,
43
 
    static_tuple,
44
41
    symbol_versioning,
45
 
    trace,
46
42
    tsort,
47
43
    ui,
48
44
    versionedfile,
53
49
from bzrlib.testament import Testament
54
50
""")
55
51
 
56
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
52
from bzrlib.decorators import needs_read_lock, needs_write_lock
57
53
from bzrlib.inter import InterObject
58
54
from bzrlib.inventory import (
59
55
    Inventory,
61
57
    ROOT_ID,
62
58
    entry_factory,
63
59
    )
64
 
from bzrlib.lock import _RelockDebugMixin
65
60
from bzrlib import registry
66
61
from bzrlib.trace import (
67
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
210
205
            # an inventory delta was accumulated without creating a new
211
206
            # inventory.
212
207
            basis_id = self.basis_delta_revision
213
 
            # We ignore the 'inventory' returned by add_inventory_by_delta
214
 
            # because self.new_inventory is used to hint to the rest of the
215
 
            # system what code path was taken
216
 
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
217
209
                basis_id, self._basis_delta, self._new_revision_id,
218
210
                self.parents)
219
211
        else:
473
465
            if content_summary[2] is None:
474
466
                raise ValueError("Files must not have executable = None")
475
467
            if not store:
476
 
                # We can't trust a check of the file length because of content
477
 
                # filtering...
478
 
                if (# if the exec bit has changed we have to store:
 
468
                if (# if the file length changed we have to store:
 
469
                    parent_entry.text_size != content_summary[1] or
 
470
                    # if the exec bit has changed we have to store:
479
471
                    parent_entry.executable != content_summary[2]):
480
472
                    store = True
481
473
                elif parent_entry.text_sha1 == content_summary[3]:
548
540
                ie.revision = parent_entry.revision
549
541
                return self._get_delta(ie, basis_inv, path), False, None
550
542
            ie.reference_revision = content_summary[3]
551
 
            if ie.reference_revision is None:
552
 
                raise AssertionError("invalid content_summary for nested tree: %r"
553
 
                    % (content_summary,))
554
543
            self._add_text_to_weave(ie.file_id, '', heads, None)
555
544
        else:
556
545
            raise NotImplementedError('unknown kind')
818
807
                seen_root = True
819
808
        self.new_inventory = None
820
809
        if len(inv_delta):
821
 
            # This should perhaps be guarded by a check that the basis we
822
 
            # commit against is the basis for the commit and if not do a delta
823
 
            # against the basis.
824
810
            self._any_changes = True
825
811
        if not seen_root:
826
812
            # housekeeping root entry changes do not affect no-change commits.
860
846
        # versioned roots do not change unless the tree found a change.
861
847
 
862
848
 
863
 
class RepositoryWriteLockResult(object):
864
 
    """The result of write locking a repository.
865
 
 
866
 
    :ivar repository_token: The token obtained from the underlying lock, or
867
 
        None.
868
 
    :ivar unlock: A callable which will unlock the lock.
869
 
    """
870
 
 
871
 
    def __init__(self, unlock, repository_token):
872
 
        self.repository_token = repository_token
873
 
        self.unlock = unlock
874
 
 
875
 
    def __str__(self):
876
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
877
 
            self.unlock)
878
 
 
879
 
 
880
849
######################################################################
881
850
# Repositories
882
851
 
883
852
 
884
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
853
class Repository(object):
885
854
    """Repository holding history for one or more branches.
886
855
 
887
856
    The repository holds and retrieves historical information including
1045
1014
 
1046
1015
        :seealso: add_inventory, for the contract.
1047
1016
        """
1048
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1017
        inv_lines = self._serialise_inventory_to_lines(inv)
1049
1018
        return self._inventory_add_lines(revision_id, parents,
1050
1019
            inv_lines, check_content=False)
1051
1020
 
1247
1216
                    for record in getattr(self, kind).check(keys=keys[kind]):
1248
1217
                        if record.storage_kind == 'absent':
1249
1218
                            checker._report_items.append(
1250
 
                                'Missing %s {%s}' % (kind, record.key,))
 
1219
                                'Missing inventory {%s}' % (record.key,))
1251
1220
                        else:
1252
1221
                            last_object = self._check_record(kind, record,
1253
1222
                                checker, last_object, current_keys[(kind,) + record.key])
1258
1227
        """Check a single text from this repository."""
1259
1228
        if kind == 'inventories':
1260
1229
            rev_id = record.key[0]
1261
 
            inv = self._deserialise_inventory(rev_id,
 
1230
            inv = self.deserialise_inventory(rev_id,
1262
1231
                record.get_bytes_as('fulltext'))
1263
1232
            if last_object is not None:
1264
1233
                delta = inv._make_delta(last_object)
1308
1277
 
1309
1278
        :param _format: The format of the repository on disk.
1310
1279
        :param a_bzrdir: The BzrDir of the repository.
 
1280
 
 
1281
        In the future we will have a single api for all stores for
 
1282
        getting file texts, inventories and revisions, then
 
1283
        this construct will accept instances of those things.
1311
1284
        """
1312
 
        # In the future we will have a single api for all stores for
1313
 
        # getting file texts, inventories and revisions, then
1314
 
        # this construct will accept instances of those things.
1315
1285
        super(Repository, self).__init__()
1316
1286
        self._format = _format
1317
1287
        # the following are part of the public API for Repository:
1323
1293
        self._reconcile_does_inventory_gc = True
1324
1294
        self._reconcile_fixes_text_parents = False
1325
1295
        self._reconcile_backsup_inventory = True
 
1296
        # not right yet - should be more semantically clear ?
 
1297
        #
 
1298
        # TODO: make sure to construct the right store classes, etc, depending
 
1299
        # on whether escaping is required.
 
1300
        self._warn_if_deprecated()
1326
1301
        self._write_group = None
1327
1302
        # Additional places to query for data.
1328
1303
        self._fallback_repositories = []
1329
1304
        # An InventoryEntry cache, used during deserialization
1330
1305
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1331
 
        # Is it safe to return inventory entries directly from the entry cache,
1332
 
        # rather copying them?
1333
 
        self._safe_to_return_from_cache = False
1334
 
 
1335
 
    @property
1336
 
    def user_transport(self):
1337
 
        return self.bzrdir.user_transport
1338
 
 
1339
 
    @property
1340
 
    def control_transport(self):
1341
 
        return self._transport
1342
1306
 
1343
1307
    def __repr__(self):
1344
1308
        if self._fallback_repositories:
1393
1357
        data during reads, and allows a 'write_group' to be obtained. Write
1394
1358
        groups must be used for actual data insertion.
1395
1359
 
1396
 
        A token should be passed in if you know that you have locked the object
1397
 
        some other way, and need to synchronise this object's state with that
1398
 
        fact.
1399
 
 
1400
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1401
 
 
1402
1360
        :param token: if this is already locked, then lock_write will fail
1403
1361
            unless the token matches the existing lock.
1404
1362
        :returns: a token if this instance supports tokens, otherwise None.
1407
1365
        :raises MismatchedToken: if the specified token doesn't match the token
1408
1366
            of the existing lock.
1409
1367
        :seealso: start_write_group.
1410
 
        :return: A RepositoryWriteLockResult.
 
1368
 
 
1369
        A token should be passed in if you know that you have locked the object
 
1370
        some other way, and need to synchronise this object's state with that
 
1371
        fact.
 
1372
 
 
1373
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1411
1374
        """
1412
1375
        locked = self.is_locked()
1413
 
        token = self.control_files.lock_write(token=token)
 
1376
        result = self.control_files.lock_write(token=token)
1414
1377
        if not locked:
1415
 
            self._warn_if_deprecated()
1416
 
            self._note_lock('w')
1417
1378
            for repo in self._fallback_repositories:
1418
1379
                # Writes don't affect fallback repos
1419
1380
                repo.lock_read()
1420
1381
            self._refresh_data()
1421
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1382
        return result
1422
1383
 
1423
1384
    def lock_read(self):
1424
 
        """Lock the repository for read operations.
1425
 
 
1426
 
        :return: An object with an unlock method which will release the lock
1427
 
            obtained.
1428
 
        """
1429
1385
        locked = self.is_locked()
1430
1386
        self.control_files.lock_read()
1431
1387
        if not locked:
1432
 
            self._warn_if_deprecated()
1433
 
            self._note_lock('r')
1434
1388
            for repo in self._fallback_repositories:
1435
1389
                repo.lock_read()
1436
1390
            self._refresh_data()
1437
 
        return self
1438
1391
 
1439
1392
    def get_physical_lock_status(self):
1440
1393
        return self.control_files.get_physical_lock_status()
1500
1453
 
1501
1454
        # now gather global repository information
1502
1455
        # XXX: This is available for many repos regardless of listability.
1503
 
        if self.user_transport.listable():
 
1456
        if self.bzrdir.root_transport.listable():
1504
1457
            # XXX: do we want to __define len__() ?
1505
1458
            # Maybe the versionedfiles object should provide a different
1506
1459
            # method to get the number of keys.
1516
1469
        :param using: If True, list only branches using this repository.
1517
1470
        """
1518
1471
        if using and not self.is_shared():
1519
 
            return self.bzrdir.list_branches()
 
1472
            try:
 
1473
                return [self.bzrdir.open_branch()]
 
1474
            except errors.NotBranchError:
 
1475
                return []
1520
1476
        class Evaluator(object):
1521
1477
 
1522
1478
            def __init__(self):
1531
1487
                    except errors.NoRepositoryPresent:
1532
1488
                        pass
1533
1489
                    else:
1534
 
                        return False, ([], repository)
 
1490
                        return False, (None, repository)
1535
1491
                self.first_call = False
1536
 
                value = (bzrdir.list_branches(), None)
 
1492
                try:
 
1493
                    value = (bzrdir.open_branch(), None)
 
1494
                except errors.NotBranchError:
 
1495
                    value = (None, None)
1537
1496
                return True, value
1538
1497
 
1539
 
        ret = []
1540
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1541
 
                self.user_transport, evaluate=Evaluator()):
1542
 
            if branches is not None:
1543
 
                ret.extend(branches)
 
1498
        branches = []
 
1499
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1500
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1501
            if branch is not None:
 
1502
                branches.append(branch)
1544
1503
            if not using and repository is not None:
1545
 
                ret.extend(repository.find_branches())
1546
 
        return ret
 
1504
                branches.extend(repository.find_branches())
 
1505
        return branches
1547
1506
 
1548
1507
    @needs_read_lock
1549
1508
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1639
1598
        # but at the moment we're only checking for texts referenced by
1640
1599
        # inventories at the graph's edge.
1641
1600
        key_deps = self.revisions._index._key_dependencies
1642
 
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1601
        key_deps.add_keys(present_inventories)
1643
1602
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
1644
1603
        file_ids = self.fileids_altered_by_revision_ids(referrers)
1645
1604
        missing_texts = set()
1755
1714
        self.start_write_group()
1756
1715
        return result
1757
1716
 
1758
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1759
1717
    def unlock(self):
1760
1718
        if (self.control_files._lock_count == 1 and
1761
1719
            self.control_files._lock_mode == 'w'):
1927
1885
                rev = self._serializer.read_revision_from_string(text)
1928
1886
                yield (revid, rev)
1929
1887
 
 
1888
    @needs_read_lock
 
1889
    def get_revision_xml(self, revision_id):
 
1890
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1891
        #       would have already do it.
 
1892
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1893
        # TODO: this can't just be replaced by:
 
1894
        # return self._serializer.write_revision_to_string(
 
1895
        #     self.get_revision(revision_id))
 
1896
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1897
        # or some other call down the path.
 
1898
        rev = self.get_revision(revision_id)
 
1899
        rev_tmp = cStringIO.StringIO()
 
1900
        # the current serializer..
 
1901
        self._serializer.write_revision(rev, rev_tmp)
 
1902
        rev_tmp.seek(0)
 
1903
        return rev_tmp.getvalue()
 
1904
 
1930
1905
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1931
1906
        """Produce a generator of revision deltas.
1932
1907
 
2174
2149
        """
2175
2150
        selected_keys = set((revid,) for revid in revision_ids)
2176
2151
        w = _inv_weave or self.inventories
2177
 
        return self._find_file_ids_from_xml_inventory_lines(
2178
 
            w.iter_lines_added_or_present_in_keys(
2179
 
                selected_keys, pb=None),
2180
 
            selected_keys)
 
2152
        pb = ui.ui_factory.nested_progress_bar()
 
2153
        try:
 
2154
            return self._find_file_ids_from_xml_inventory_lines(
 
2155
                w.iter_lines_added_or_present_in_keys(
 
2156
                    selected_keys, pb=pb),
 
2157
                selected_keys)
 
2158
        finally:
 
2159
            pb.finished()
2181
2160
 
2182
2161
    def iter_files_bytes(self, desired_files):
2183
2162
        """Iterate through file versions.
2344
2323
        num_file_ids = len(file_ids)
2345
2324
        for file_id, altered_versions in file_ids.iteritems():
2346
2325
            if pb is not None:
2347
 
                pb.update("Fetch texts", count, num_file_ids)
 
2326
                pb.update("fetch texts", count, num_file_ids)
2348
2327
            count += 1
2349
2328
            yield ("file", file_id, altered_versions)
2350
2329
 
2393
2372
        """single-document based inventory iteration."""
2394
2373
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2395
2374
        for text, revision_id in inv_xmls:
2396
 
            yield self._deserialise_inventory(revision_id, text)
 
2375
            yield self.deserialise_inventory(revision_id, text)
2397
2376
 
2398
2377
    def _iter_inventory_xmls(self, revision_ids, ordering):
2399
2378
        if ordering is None:
2431
2410
                        next_key = None
2432
2411
                        break
2433
2412
 
2434
 
    def _deserialise_inventory(self, revision_id, xml):
 
2413
    def deserialise_inventory(self, revision_id, xml):
2435
2414
        """Transform the xml into an inventory object.
2436
2415
 
2437
2416
        :param revision_id: The expected revision id of the inventory.
2438
2417
        :param xml: A serialised inventory.
2439
2418
        """
2440
2419
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2441
 
                    entry_cache=self._inventory_entry_cache,
2442
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2420
                    entry_cache=self._inventory_entry_cache)
2443
2421
        if result.revision_id != revision_id:
2444
2422
            raise AssertionError('revision id mismatch %s != %s' % (
2445
2423
                result.revision_id, revision_id))
2446
2424
        return result
2447
2425
 
 
2426
    def serialise_inventory(self, inv):
 
2427
        return self._serializer.write_inventory_to_string(inv)
 
2428
 
 
2429
    def _serialise_inventory_to_lines(self, inv):
 
2430
        return self._serializer.write_inventory_to_lines(inv)
 
2431
 
2448
2432
    def get_serializer_format(self):
2449
2433
        return self._serializer.format_num
2450
2434
 
2451
2435
    @needs_read_lock
2452
 
    def _get_inventory_xml(self, revision_id):
2453
 
        """Get serialized inventory as a string."""
 
2436
    def get_inventory_xml(self, revision_id):
 
2437
        """Get inventory XML as a file object."""
2454
2438
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
2455
2439
        try:
2456
2440
            text, revision_id = texts.next()
2458
2442
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2459
2443
        return text
2460
2444
 
 
2445
    @needs_read_lock
 
2446
    def get_inventory_sha1(self, revision_id):
 
2447
        """Return the sha1 hash of the inventory entry
 
2448
        """
 
2449
        return self.get_revision(revision_id).inventory_sha1
 
2450
 
2461
2451
    def get_rev_id_for_revno(self, revno, known_pair):
2462
2452
        """Return the revision id of a revno, given a later (revno, revid)
2463
2453
        pair in the same history.
2514
2504
            else:
2515
2505
                next_id = parents[0]
2516
2506
 
 
2507
    @needs_read_lock
 
2508
    def get_revision_inventory(self, revision_id):
 
2509
        """Return inventory of a past revision."""
 
2510
        # TODO: Unify this with get_inventory()
 
2511
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2512
        # must be the same as its revision, so this is trivial.
 
2513
        if revision_id is None:
 
2514
            # This does not make sense: if there is no revision,
 
2515
            # then it is the current tree inventory surely ?!
 
2516
            # and thus get_root_id() is something that looks at the last
 
2517
            # commit on the branch, and the get_root_id is an inventory check.
 
2518
            raise NotImplementedError
 
2519
            # return Inventory(self.get_root_id())
 
2520
        else:
 
2521
            return self.get_inventory(revision_id)
 
2522
 
2517
2523
    def is_shared(self):
2518
2524
        """Return True if this repository is flagged as a shared repository."""
2519
2525
        raise NotImplementedError(self.is_shared)
2553
2559
            return RevisionTree(self, Inventory(root_id=None),
2554
2560
                                _mod_revision.NULL_REVISION)
2555
2561
        else:
2556
 
            inv = self.get_inventory(revision_id)
 
2562
            inv = self.get_revision_inventory(revision_id)
2557
2563
            return RevisionTree(self, inv, revision_id)
2558
2564
 
2559
2565
    def revision_trees(self, revision_ids):
2612
2618
            keys = tsort.topo_sort(parent_map)
2613
2619
        return [None] + list(keys)
2614
2620
 
2615
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2621
    def pack(self, hint=None):
2616
2622
        """Compress the data within the repository.
2617
2623
 
2618
2624
        This operation only makes sense for some repository types. For other
2628
2634
            obtained from the result of commit_write_group(). Out of
2629
2635
            date hints are simply ignored, because concurrent operations
2630
2636
            can obsolete them rapidly.
2631
 
 
2632
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2633
 
            the pack operation.
2634
2637
        """
2635
2638
 
2636
2639
    def get_transaction(self):
2652
2655
        for ((revision_id,), parent_keys) in \
2653
2656
                self.revisions.get_parent_map(query_keys).iteritems():
2654
2657
            if parent_keys:
2655
 
                result[revision_id] = tuple([parent_revid
2656
 
                    for (parent_revid,) in parent_keys])
 
2658
                result[revision_id] = tuple(parent_revid
 
2659
                    for (parent_revid,) in parent_keys)
2657
2660
            else:
2658
2661
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2659
2662
        return result
2661
2664
    def _make_parents_provider(self):
2662
2665
        return self
2663
2666
 
2664
 
    @needs_read_lock
2665
 
    def get_known_graph_ancestry(self, revision_ids):
2666
 
        """Return the known graph for a set of revision ids and their ancestors.
2667
 
        """
2668
 
        st = static_tuple.StaticTuple
2669
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2670
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2671
 
        return graph.GraphThunkIdsToKeys(known_graph)
2672
 
 
2673
2667
    def get_graph(self, other_repository=None):
2674
2668
        """Return the graph walker for this repository format"""
2675
2669
        parents_provider = self._make_parents_provider()
2770
2764
        result.check(callback_refs)
2771
2765
        return result
2772
2766
 
2773
 
    def _warn_if_deprecated(self, branch=None):
 
2767
    def _warn_if_deprecated(self):
2774
2768
        global _deprecation_warning_done
2775
2769
        if _deprecation_warning_done:
2776
2770
            return
2777
 
        try:
2778
 
            if branch is None:
2779
 
                conf = config.GlobalConfig()
2780
 
            else:
2781
 
                conf = branch.get_config()
2782
 
            if conf.suppress_warning('format_deprecation'):
2783
 
                return
2784
 
            warning("Format %s for %s is deprecated -"
2785
 
                    " please use 'bzr upgrade' to get better performance"
2786
 
                    % (self._format, self.bzrdir.transport.base))
2787
 
        finally:
2788
 
            _deprecation_warning_done = True
 
2771
        _deprecation_warning_done = True
 
2772
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2773
                % (self._format, self.bzrdir.transport.base))
2789
2774
 
2790
2775
    def supports_rich_root(self):
2791
2776
        return self._format.rich_root_data
3074
3059
    pack_compresses = False
3075
3060
    # Does the repository inventory storage understand references to trees?
3076
3061
    supports_tree_reference = None
3077
 
    # Is the format experimental ?
3078
 
    experimental = False
3079
3062
 
3080
 
    def __repr__(self):
3081
 
        return "%s()" % self.__class__.__name__
 
3063
    def __str__(self):
 
3064
        return "<%s>" % self.__class__.__name__
3082
3065
 
3083
3066
    def __eq__(self, other):
3084
3067
        # format objects are generally stateless
3097
3080
        """
3098
3081
        try:
3099
3082
            transport = a_bzrdir.get_repository_transport(None)
3100
 
            format_string = transport.get_bytes("format")
 
3083
            format_string = transport.get("format").read()
3101
3084
            return format_registry.get(format_string)
3102
3085
        except errors.NoSuchFile:
3103
3086
            raise errors.NoRepositoryPresent(a_bzrdir)
3202
3185
        """
3203
3186
        raise NotImplementedError(self.open)
3204
3187
 
3205
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3206
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3207
 
        hooks = BzrDir.hooks['post_repo_init']
3208
 
        if not hooks:
3209
 
            return
3210
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3211
 
        for hook in hooks:
3212
 
            hook(params)
3213
 
 
3214
3188
 
3215
3189
class MetaDirRepositoryFormat(RepositoryFormat):
3216
3190
    """Common base class for the new repositories using the metadir layout."""
3421
3395
 
3422
3396
        :param revision_id: if None all content is copied, if NULL_REVISION no
3423
3397
                            content is copied.
3424
 
        :param pb: ignored.
 
3398
        :param pb: optional progress bar to use for progress reports. If not
 
3399
                   provided a default one will be created.
3425
3400
        :return: None.
3426
3401
        """
3427
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3428
3402
        from bzrlib.fetch import RepoFetcher
3429
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3430
 
        if self.source._format.network_name() != self.target._format.network_name():
3431
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3432
 
                from_format=self.source._format,
3433
 
                to_format=self.target._format)
3434
3403
        f = RepoFetcher(to_repository=self.target,
3435
3404
                               from_repository=self.source,
3436
3405
                               last_revision=revision_id,
3437
3406
                               fetch_spec=fetch_spec,
3438
 
                               find_ghosts=find_ghosts)
 
3407
                               pb=pb, find_ghosts=find_ghosts)
3439
3408
 
3440
3409
    def _walk_to_common_revisions(self, revision_ids):
3441
3410
        """Walk out from revision_ids in source to revisions target has.
3610
3579
                self.target.texts.insert_record_stream(
3611
3580
                    self.source.texts.get_record_stream(
3612
3581
                        self.source.texts.keys(), 'topological', False))
3613
 
                pb.update('Copying inventory', 0, 1)
 
3582
                pb.update('copying inventory', 0, 1)
3614
3583
                self.target.inventories.insert_record_stream(
3615
3584
                    self.source.inventories.get_record_stream(
3616
3585
                        self.source.inventories.keys(), 'topological', False))
3763
3732
            return False
3764
3733
        return True
3765
3734
 
3766
 
    def _get_trees(self, revision_ids, cache):
3767
 
        possible_trees = []
3768
 
        for rev_id in revision_ids:
3769
 
            if rev_id in cache:
3770
 
                possible_trees.append((rev_id, cache[rev_id]))
3771
 
            else:
3772
 
                # Not cached, but inventory might be present anyway.
3773
 
                try:
3774
 
                    tree = self.source.revision_tree(rev_id)
3775
 
                except errors.NoSuchRevision:
3776
 
                    # Nope, parent is ghost.
3777
 
                    pass
3778
 
                else:
3779
 
                    cache[rev_id] = tree
3780
 
                    possible_trees.append((rev_id, tree))
3781
 
        return possible_trees
3782
 
 
3783
 
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3735
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3784
3736
        """Get the best delta and base for this revision.
3785
3737
 
3786
3738
        :return: (basis_id, delta)
3787
3739
        """
 
3740
        possible_trees = [(parent_id, cache[parent_id])
 
3741
                          for parent_id in parent_ids
 
3742
                           if parent_id in cache]
 
3743
        if len(possible_trees) == 0:
 
3744
            # There either aren't any parents, or the parents aren't in the
 
3745
            # cache, so just use the last converted tree
 
3746
            possible_trees.append((basis_id, cache[basis_id]))
3788
3747
        deltas = []
3789
 
        # Generate deltas against each tree, to find the shortest.
3790
 
        texts_possibly_new_in_tree = set()
3791
3748
        for basis_id, basis_tree in possible_trees:
3792
3749
            delta = tree.inventory._make_delta(basis_tree.inventory)
3793
 
            for old_path, new_path, file_id, new_entry in delta:
3794
 
                if new_path is None:
3795
 
                    # This file_id isn't present in the new rev, so we don't
3796
 
                    # care about it.
3797
 
                    continue
3798
 
                if not new_path:
3799
 
                    # Rich roots are handled elsewhere...
3800
 
                    continue
3801
 
                kind = new_entry.kind
3802
 
                if kind != 'directory' and kind != 'file':
3803
 
                    # No text record associated with this inventory entry.
3804
 
                    continue
3805
 
                # This is a directory or file that has changed somehow.
3806
 
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3807
3750
            deltas.append((len(delta), basis_id, delta))
3808
3751
        deltas.sort()
3809
3752
        return deltas[0][1:]
3810
3753
 
3811
 
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3812
 
        """Find all parent revisions that are absent, but for which the
3813
 
        inventory is present, and copy those inventories.
3814
 
 
3815
 
        This is necessary to preserve correctness when the source is stacked
3816
 
        without fallbacks configured.  (Note that in cases like upgrade the
3817
 
        source may be not have _fallback_repositories even though it is
3818
 
        stacked.)
3819
 
        """
3820
 
        parent_revs = set()
3821
 
        for parents in parent_map.values():
3822
 
            parent_revs.update(parents)
3823
 
        present_parents = self.source.get_parent_map(parent_revs)
3824
 
        absent_parents = set(parent_revs).difference(present_parents)
3825
 
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3826
 
            (rev_id,) for rev_id in absent_parents)
3827
 
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3828
 
        for parent_tree in self.source.revision_trees(parent_inv_ids):
3829
 
            current_revision_id = parent_tree.get_revision_id()
3830
 
            parents_parents_keys = parent_invs_keys_for_stacking[
3831
 
                (current_revision_id,)]
3832
 
            parents_parents = [key[-1] for key in parents_parents_keys]
3833
 
            basis_id = _mod_revision.NULL_REVISION
3834
 
            basis_tree = self.source.revision_tree(basis_id)
3835
 
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3836
 
            self.target.add_inventory_by_delta(
3837
 
                basis_id, delta, current_revision_id, parents_parents)
3838
 
            cache[current_revision_id] = parent_tree
3839
 
 
3840
 
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
 
3754
    def _fetch_batch(self, revision_ids, basis_id, cache):
3841
3755
        """Fetch across a few revisions.
3842
3756
 
3843
3757
        :param revision_ids: The revisions to copy
3844
3758
        :param basis_id: The revision_id of a tree that must be in cache, used
3845
3759
            as a basis for delta when no other base is available
3846
3760
        :param cache: A cache of RevisionTrees that we can use.
3847
 
        :param a_graph: A Graph object to determine the heads() of the
3848
 
            rich-root data stream.
3849
3761
        :return: The revision_id of the last converted tree. The RevisionTree
3850
3762
            for it will be in cache
3851
3763
        """
3857
3769
        pending_deltas = []
3858
3770
        pending_revisions = []
3859
3771
        parent_map = self.source.get_parent_map(revision_ids)
3860
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3861
 
        self.source._safe_to_return_from_cache = True
3862
3772
        for tree in self.source.revision_trees(revision_ids):
3863
 
            # Find a inventory delta for this revision.
3864
 
            # Find text entries that need to be copied, too.
3865
3773
            current_revision_id = tree.get_revision_id()
3866
3774
            parent_ids = parent_map.get(current_revision_id, ())
3867
 
            parent_trees = self._get_trees(parent_ids, cache)
3868
 
            possible_trees = list(parent_trees)
3869
 
            if len(possible_trees) == 0:
3870
 
                # There either aren't any parents, or the parents are ghosts,
3871
 
                # so just use the last converted tree.
3872
 
                possible_trees.append((basis_id, cache[basis_id]))
3873
3775
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3874
 
                                                           possible_trees)
3875
 
            revision = self.source.get_revision(current_revision_id)
3876
 
            pending_deltas.append((basis_id, delta,
3877
 
                current_revision_id, revision.parent_ids))
 
3776
                                                           basis_id, cache)
3878
3777
            if self._converting_to_rich_root:
3879
3778
                self._revision_id_to_root_id[current_revision_id] = \
3880
3779
                    tree.get_root_id()
3881
 
            # Determine which texts are in present in this revision but not in
3882
 
            # any of the available parents.
3883
 
            texts_possibly_new_in_tree = set()
 
3780
            # Find text entries that need to be copied
3884
3781
            for old_path, new_path, file_id, entry in delta:
3885
 
                if new_path is None:
3886
 
                    # This file_id isn't present in the new rev
3887
 
                    continue
3888
 
                if not new_path:
3889
 
                    # This is the root
3890
 
                    if not self.target.supports_rich_root():
3891
 
                        # The target doesn't support rich root, so we don't
3892
 
                        # copy
3893
 
                        continue
3894
 
                    if self._converting_to_rich_root:
3895
 
                        # This can't be copied normally, we have to insert
3896
 
                        # it specially
3897
 
                        root_keys_to_create.add((file_id, entry.revision))
3898
 
                        continue
3899
 
                kind = entry.kind
3900
 
                texts_possibly_new_in_tree.add((file_id, entry.revision))
3901
 
            for basis_id, basis_tree in possible_trees:
3902
 
                basis_inv = basis_tree.inventory
3903
 
                for file_key in list(texts_possibly_new_in_tree):
3904
 
                    file_id, file_revision = file_key
3905
 
                    try:
3906
 
                        entry = basis_inv[file_id]
3907
 
                    except errors.NoSuchId:
3908
 
                        continue
3909
 
                    if entry.revision == file_revision:
3910
 
                        texts_possibly_new_in_tree.remove(file_key)
3911
 
            text_keys.update(texts_possibly_new_in_tree)
 
3782
                if new_path is not None:
 
3783
                    if not new_path:
 
3784
                        # This is the root
 
3785
                        if not self.target.supports_rich_root():
 
3786
                            # The target doesn't support rich root, so we don't
 
3787
                            # copy
 
3788
                            continue
 
3789
                        if self._converting_to_rich_root:
 
3790
                            # This can't be copied normally, we have to insert
 
3791
                            # it specially
 
3792
                            root_keys_to_create.add((file_id, entry.revision))
 
3793
                            continue
 
3794
                    text_keys.add((file_id, entry.revision))
 
3795
            revision = self.source.get_revision(current_revision_id)
 
3796
            pending_deltas.append((basis_id, delta,
 
3797
                current_revision_id, revision.parent_ids))
3912
3798
            pending_revisions.append(revision)
3913
3799
            cache[current_revision_id] = tree
3914
3800
            basis_id = current_revision_id
3915
 
        self.source._safe_to_return_from_cache = False
3916
3801
        # Copy file texts
3917
3802
        from_texts = self.source.texts
3918
3803
        to_texts = self.target.texts
3919
3804
        if root_keys_to_create:
3920
 
            root_stream = _mod_fetch._new_root_data_stream(
 
3805
            from bzrlib.fetch import _new_root_data_stream
 
3806
            root_stream = _new_root_data_stream(
3921
3807
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
3922
 
                self.source, graph=a_graph)
 
3808
                self.source)
3923
3809
            to_texts.insert_record_stream(root_stream)
3924
3810
        to_texts.insert_record_stream(from_texts.get_record_stream(
3925
3811
            text_keys, self.target._format._fetch_order,
3947
3833
            for parent_tree in self.source.revision_trees(parent_map):
3948
3834
                current_revision_id = parent_tree.get_revision_id()
3949
3835
                parents_parents = parent_map[current_revision_id]
3950
 
                possible_trees = self._get_trees(parents_parents, cache)
3951
 
                if len(possible_trees) == 0:
3952
 
                    # There either aren't any parents, or the parents are
3953
 
                    # ghosts, so just use the last converted tree.
3954
 
                    possible_trees.append((basis_id, cache[basis_id]))
3955
3836
                basis_id, delta = self._get_delta_for_revision(parent_tree,
3956
 
                    parents_parents, possible_trees)
 
3837
                    parents_parents, basis_id, cache)
3957
3838
                self.target.add_inventory_by_delta(
3958
3839
                    basis_id, delta, current_revision_id, parents_parents)
3959
3840
        # insert signatures and revisions
3982
3863
        cache[basis_id] = basis_tree
3983
3864
        del basis_tree # We don't want to hang on to it here
3984
3865
        hints = []
3985
 
        if self._converting_to_rich_root and len(revision_ids) > 100:
3986
 
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3987
 
                                                            revision_ids)
3988
 
        else:
3989
 
            a_graph = None
3990
 
 
3991
3866
        for offset in range(0, len(revision_ids), batch_size):
3992
3867
            self.target.start_write_group()
3993
3868
            try:
3994
3869
                pb.update('Transferring revisions', offset,
3995
3870
                          len(revision_ids))
3996
3871
                batch = revision_ids[offset:offset+batch_size]
3997
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
3998
 
                                             a_graph=a_graph)
 
3872
                basis_id = self._fetch_batch(batch, basis_id, cache)
3999
3873
            except:
4000
 
                self.source._safe_to_return_from_cache = False
4001
3874
                self.target.abort_write_group()
4002
3875
                raise
4003
3876
            else:
4015
3888
        """See InterRepository.fetch()."""
4016
3889
        if fetch_spec is not None:
4017
3890
            raise AssertionError("Not implemented yet...")
4018
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4019
3891
        if (not self.source.supports_rich_root()
4020
3892
            and self.target.supports_rich_root()):
4021
3893
            self._converting_to_rich_root = True
4022
3894
            self._revision_id_to_root_id = {}
4023
3895
        else:
4024
3896
            self._converting_to_rich_root = False
4025
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4026
 
        if self.source._format.network_name() != self.target._format.network_name():
4027
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4028
 
                from_format=self.source._format,
4029
 
                to_format=self.target._format)
4030
3897
        revision_ids = self.target.search_missing_revision_ids(self.source,
4031
3898
            revision_id, find_ghosts=find_ghosts).get_keys()
4032
3899
        if not revision_ids:
4101
3968
        :param to_convert: The disk object to convert.
4102
3969
        :param pb: a progress bar to use for progress information.
4103
3970
        """
4104
 
        pb = ui.ui_factory.nested_progress_bar()
 
3971
        self.pb = pb
4105
3972
        self.count = 0
4106
3973
        self.total = 4
4107
3974
        # this is only useful with metadir layouts - separated repo content.
4108
3975
        # trigger an assertion if not such
4109
3976
        repo._format.get_format_string()
4110
3977
        self.repo_dir = repo.bzrdir
4111
 
        pb.update('Moving repository to repository.backup')
 
3978
        self.step('Moving repository to repository.backup')
4112
3979
        self.repo_dir.transport.move('repository', 'repository.backup')
4113
3980
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4114
3981
        repo._format.check_conversion_target(self.target_format)
4115
3982
        self.source_repo = repo._format.open(self.repo_dir,
4116
3983
            _found=True,
4117
3984
            _override_transport=backup_transport)
4118
 
        pb.update('Creating new repository')
 
3985
        self.step('Creating new repository')
4119
3986
        converted = self.target_format.initialize(self.repo_dir,
4120
3987
                                                  self.source_repo.is_shared())
4121
3988
        converted.lock_write()
4122
3989
        try:
4123
 
            pb.update('Copying content')
 
3990
            self.step('Copying content into repository.')
4124
3991
            self.source_repo.copy_content_into(converted)
4125
3992
        finally:
4126
3993
            converted.unlock()
4127
 
        pb.update('Deleting old repository content')
 
3994
        self.step('Deleting old repository content.')
4128
3995
        self.repo_dir.transport.delete_tree('repository.backup')
4129
 
        ui.ui_factory.note('repository converted')
4130
 
        pb.finished()
 
3996
        self.pb.note('repository converted')
 
3997
 
 
3998
    def step(self, message):
 
3999
        """Update the pb by a step."""
 
4000
        self.count +=1
 
4001
        self.pb.update(message, self.count, self.total)
4131
4002
 
4132
4003
 
4133
4004
_unescape_map = {
4353
4224
                ):
4354
4225
                if versioned_file is None:
4355
4226
                    continue
4356
 
                # TODO: key is often going to be a StaticTuple object
4357
 
                #       I don't believe we can define a method by which
4358
 
                #       (prefix,) + StaticTuple will work, though we could
4359
 
                #       define a StaticTuple.sq_concat that would allow you to
4360
 
                #       pass in either a tuple or a StaticTuple as the second
4361
 
                #       object, so instead we could have:
4362
 
                #       StaticTuple(prefix) + key here...
4363
4227
                missing_keys.update((prefix,) + key for key in
4364
4228
                    versioned_file.get_missing_compression_parent_keys())
4365
4229
        except NotImplementedError:
4477
4341
        fetching the inventory weave.
4478
4342
        """
4479
4343
        if self._rich_root_upgrade():
4480
 
            return _mod_fetch.Inter1and2Helper(
 
4344
            import bzrlib.fetch
 
4345
            return bzrlib.fetch.Inter1and2Helper(
4481
4346
                self.from_repository).generate_root_texts(revs)
4482
4347
        else:
4483
4348
            return []
4625
4490
 
4626
4491
    def _get_convertable_inventory_stream(self, revision_ids,
4627
4492
                                          delta_versus_null=False):
4628
 
        # The two formats are sufficiently different that there is no fast
4629
 
        # path, so we need to send just inventorydeltas, which any
4630
 
        # sufficiently modern client can insert into any repository.
4631
 
        # The StreamSink code expects to be able to
 
4493
        # The source is using CHKs, but the target either doesn't or it has a
 
4494
        # different serializer.  The StreamSink code expects to be able to
4632
4495
        # convert on the target, so we need to put bytes-on-the-wire that can
4633
4496
        # be converted.  That means inventory deltas (if the remote is <1.19,
4634
4497
        # RemoteStreamSink will fallback to VFS to insert the deltas).