~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-12-03 20:05:29 UTC
  • mto: This revision was merged to the branch mainline in revision 4865.
  • Revision ID: john@arbash-meinel.com-20091203200529-no7ltq6gew22392l
2 test_repository tests weren't adding cleanups when opening files.

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
29
    fetch as _mod_fetch,
40
39
    lru_cache,
41
40
    osutils,
42
41
    revision as _mod_revision,
43
 
    static_tuple,
44
42
    symbol_versioning,
45
 
    trace,
46
43
    tsort,
47
44
    ui,
48
45
    versionedfile,
864
861
# Repositories
865
862
 
866
863
 
867
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
864
class Repository(_RelockDebugMixin):
868
865
    """Repository holding history for one or more branches.
869
866
 
870
867
    The repository holds and retrieves historical information including
1028
1025
 
1029
1026
        :seealso: add_inventory, for the contract.
1030
1027
        """
1031
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
1028
        inv_lines = self._serialise_inventory_to_lines(inv)
1032
1029
        return self._inventory_add_lines(revision_id, parents,
1033
1030
            inv_lines, check_content=False)
1034
1031
 
1241
1238
        """Check a single text from this repository."""
1242
1239
        if kind == 'inventories':
1243
1240
            rev_id = record.key[0]
1244
 
            inv = self._deserialise_inventory(rev_id,
 
1241
            inv = self.deserialise_inventory(rev_id,
1245
1242
                record.get_bytes_as('fulltext'))
1246
1243
            if last_object is not None:
1247
1244
                delta = inv._make_delta(last_object)
1291
1288
 
1292
1289
        :param _format: The format of the repository on disk.
1293
1290
        :param a_bzrdir: The BzrDir of the repository.
 
1291
 
 
1292
        In the future we will have a single api for all stores for
 
1293
        getting file texts, inventories and revisions, then
 
1294
        this construct will accept instances of those things.
1294
1295
        """
1295
 
        # In the future we will have a single api for all stores for
1296
 
        # getting file texts, inventories and revisions, then
1297
 
        # this construct will accept instances of those things.
1298
1296
        super(Repository, self).__init__()
1299
1297
        self._format = _format
1300
1298
        # the following are part of the public API for Repository:
1306
1304
        self._reconcile_does_inventory_gc = True
1307
1305
        self._reconcile_fixes_text_parents = False
1308
1306
        self._reconcile_backsup_inventory = True
 
1307
        # not right yet - should be more semantically clear ?
 
1308
        #
 
1309
        # TODO: make sure to construct the right store classes, etc, depending
 
1310
        # on whether escaping is required.
 
1311
        self._warn_if_deprecated()
1309
1312
        self._write_group = None
1310
1313
        # Additional places to query for data.
1311
1314
        self._fallback_repositories = []
1312
1315
        # An InventoryEntry cache, used during deserialization
1313
1316
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1314
 
        # Is it safe to return inventory entries directly from the entry cache,
1315
 
        # rather copying them?
1316
 
        self._safe_to_return_from_cache = False
1317
 
 
1318
 
    @property
1319
 
    def user_transport(self):
1320
 
        return self.bzrdir.user_transport
1321
 
 
1322
 
    @property
1323
 
    def control_transport(self):
1324
 
        return self._transport
1325
1317
 
1326
1318
    def __repr__(self):
1327
1319
        if self._fallback_repositories:
1394
1386
        locked = self.is_locked()
1395
1387
        result = self.control_files.lock_write(token=token)
1396
1388
        if not locked:
1397
 
            self._warn_if_deprecated()
1398
1389
            self._note_lock('w')
1399
1390
            for repo in self._fallback_repositories:
1400
1391
                # Writes don't affect fallback repos
1406
1397
        locked = self.is_locked()
1407
1398
        self.control_files.lock_read()
1408
1399
        if not locked:
1409
 
            self._warn_if_deprecated()
1410
1400
            self._note_lock('r')
1411
1401
            for repo in self._fallback_repositories:
1412
1402
                repo.lock_read()
1476
1466
 
1477
1467
        # now gather global repository information
1478
1468
        # XXX: This is available for many repos regardless of listability.
1479
 
        if self.user_transport.listable():
 
1469
        if self.bzrdir.root_transport.listable():
1480
1470
            # XXX: do we want to __define len__() ?
1481
1471
            # Maybe the versionedfiles object should provide a different
1482
1472
            # method to get the number of keys.
1492
1482
        :param using: If True, list only branches using this repository.
1493
1483
        """
1494
1484
        if using and not self.is_shared():
1495
 
            return self.bzrdir.list_branches()
 
1485
            try:
 
1486
                return [self.bzrdir.open_branch()]
 
1487
            except errors.NotBranchError:
 
1488
                return []
1496
1489
        class Evaluator(object):
1497
1490
 
1498
1491
            def __init__(self):
1507
1500
                    except errors.NoRepositoryPresent:
1508
1501
                        pass
1509
1502
                    else:
1510
 
                        return False, ([], repository)
 
1503
                        return False, (None, repository)
1511
1504
                self.first_call = False
1512
 
                value = (bzrdir.list_branches(), None)
 
1505
                try:
 
1506
                    value = (bzrdir.open_branch(), None)
 
1507
                except errors.NotBranchError:
 
1508
                    value = (None, None)
1513
1509
                return True, value
1514
1510
 
1515
 
        ret = []
1516
 
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1517
 
                self.user_transport, evaluate=Evaluator()):
1518
 
            if branches is not None:
1519
 
                ret.extend(branches)
 
1511
        branches = []
 
1512
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1513
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1514
            if branch is not None:
 
1515
                branches.append(branch)
1520
1516
            if not using and repository is not None:
1521
 
                ret.extend(repository.find_branches())
1522
 
        return ret
 
1517
                branches.extend(repository.find_branches())
 
1518
        return branches
1523
1519
 
1524
1520
    @needs_read_lock
1525
1521
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1903
1899
                rev = self._serializer.read_revision_from_string(text)
1904
1900
                yield (revid, rev)
1905
1901
 
 
1902
    @needs_read_lock
 
1903
    def get_revision_xml(self, revision_id):
 
1904
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1905
        #       would have already do it.
 
1906
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1907
        # TODO: this can't just be replaced by:
 
1908
        # return self._serializer.write_revision_to_string(
 
1909
        #     self.get_revision(revision_id))
 
1910
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1911
        # or some other call down the path.
 
1912
        rev = self.get_revision(revision_id)
 
1913
        rev_tmp = cStringIO.StringIO()
 
1914
        # the current serializer..
 
1915
        self._serializer.write_revision(rev, rev_tmp)
 
1916
        rev_tmp.seek(0)
 
1917
        return rev_tmp.getvalue()
 
1918
 
1906
1919
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1907
1920
        """Produce a generator of revision deltas.
1908
1921
 
2150
2163
        """
2151
2164
        selected_keys = set((revid,) for revid in revision_ids)
2152
2165
        w = _inv_weave or self.inventories
2153
 
        return self._find_file_ids_from_xml_inventory_lines(
2154
 
            w.iter_lines_added_or_present_in_keys(
2155
 
                selected_keys, pb=None),
2156
 
            selected_keys)
 
2166
        pb = ui.ui_factory.nested_progress_bar()
 
2167
        try:
 
2168
            return self._find_file_ids_from_xml_inventory_lines(
 
2169
                w.iter_lines_added_or_present_in_keys(
 
2170
                    selected_keys, pb=pb),
 
2171
                selected_keys)
 
2172
        finally:
 
2173
            pb.finished()
2157
2174
 
2158
2175
    def iter_files_bytes(self, desired_files):
2159
2176
        """Iterate through file versions.
2369
2386
        """single-document based inventory iteration."""
2370
2387
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2371
2388
        for text, revision_id in inv_xmls:
2372
 
            yield self._deserialise_inventory(revision_id, text)
 
2389
            yield self.deserialise_inventory(revision_id, text)
2373
2390
 
2374
2391
    def _iter_inventory_xmls(self, revision_ids, ordering):
2375
2392
        if ordering is None:
2407
2424
                        next_key = None
2408
2425
                        break
2409
2426
 
2410
 
    def _deserialise_inventory(self, revision_id, xml):
 
2427
    def deserialise_inventory(self, revision_id, xml):
2411
2428
        """Transform the xml into an inventory object.
2412
2429
 
2413
2430
        :param revision_id: The expected revision id of the inventory.
2414
2431
        :param xml: A serialised inventory.
2415
2432
        """
2416
2433
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2417
 
                    entry_cache=self._inventory_entry_cache,
2418
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2434
                    entry_cache=self._inventory_entry_cache)
2419
2435
        if result.revision_id != revision_id:
2420
2436
            raise AssertionError('revision id mismatch %s != %s' % (
2421
2437
                result.revision_id, revision_id))
2422
2438
        return result
2423
2439
 
 
2440
    def serialise_inventory(self, inv):
 
2441
        return self._serializer.write_inventory_to_string(inv)
 
2442
 
 
2443
    def _serialise_inventory_to_lines(self, inv):
 
2444
        return self._serializer.write_inventory_to_lines(inv)
 
2445
 
2424
2446
    def get_serializer_format(self):
2425
2447
        return self._serializer.format_num
2426
2448
 
2427
2449
    @needs_read_lock
2428
 
    def _get_inventory_xml(self, revision_id):
2429
 
        """Get serialized inventory as a string."""
 
2450
    def get_inventory_xml(self, revision_id):
 
2451
        """Get inventory XML as a file object."""
2430
2452
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
2431
2453
        try:
2432
2454
            text, revision_id = texts.next()
2434
2456
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2435
2457
        return text
2436
2458
 
 
2459
    @needs_read_lock
 
2460
    def get_inventory_sha1(self, revision_id):
 
2461
        """Return the sha1 hash of the inventory entry
 
2462
        """
 
2463
        return self.get_revision(revision_id).inventory_sha1
 
2464
 
2437
2465
    def get_rev_id_for_revno(self, revno, known_pair):
2438
2466
        """Return the revision id of a revno, given a later (revno, revid)
2439
2467
        pair in the same history.
2490
2518
            else:
2491
2519
                next_id = parents[0]
2492
2520
 
 
2521
    @needs_read_lock
 
2522
    def get_revision_inventory(self, revision_id):
 
2523
        """Return inventory of a past revision."""
 
2524
        # TODO: Unify this with get_inventory()
 
2525
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2526
        # must be the same as its revision, so this is trivial.
 
2527
        if revision_id is None:
 
2528
            # This does not make sense: if there is no revision,
 
2529
            # then it is the current tree inventory surely ?!
 
2530
            # and thus get_root_id() is something that looks at the last
 
2531
            # commit on the branch, and the get_root_id is an inventory check.
 
2532
            raise NotImplementedError
 
2533
            # return Inventory(self.get_root_id())
 
2534
        else:
 
2535
            return self.get_inventory(revision_id)
 
2536
 
2493
2537
    def is_shared(self):
2494
2538
        """Return True if this repository is flagged as a shared repository."""
2495
2539
        raise NotImplementedError(self.is_shared)
2529
2573
            return RevisionTree(self, Inventory(root_id=None),
2530
2574
                                _mod_revision.NULL_REVISION)
2531
2575
        else:
2532
 
            inv = self.get_inventory(revision_id)
 
2576
            inv = self.get_revision_inventory(revision_id)
2533
2577
            return RevisionTree(self, inv, revision_id)
2534
2578
 
2535
2579
    def revision_trees(self, revision_ids):
2588
2632
            keys = tsort.topo_sort(parent_map)
2589
2633
        return [None] + list(keys)
2590
2634
 
2591
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2635
    def pack(self, hint=None):
2592
2636
        """Compress the data within the repository.
2593
2637
 
2594
2638
        This operation only makes sense for some repository types. For other
2604
2648
            obtained from the result of commit_write_group(). Out of
2605
2649
            date hints are simply ignored, because concurrent operations
2606
2650
            can obsolete them rapidly.
2607
 
 
2608
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
2609
 
            the pack operation.
2610
2651
        """
2611
2652
 
2612
2653
    def get_transaction(self):
2637
2678
    def _make_parents_provider(self):
2638
2679
        return self
2639
2680
 
2640
 
    @needs_read_lock
2641
 
    def get_known_graph_ancestry(self, revision_ids):
2642
 
        """Return the known graph for a set of revision ids and their ancestors.
2643
 
        """
2644
 
        st = static_tuple.StaticTuple
2645
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
2646
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2647
 
        return graph.GraphThunkIdsToKeys(known_graph)
2648
 
 
2649
2681
    def get_graph(self, other_repository=None):
2650
2682
        """Return the graph walker for this repository format"""
2651
2683
        parents_provider = self._make_parents_provider()
2746
2778
        result.check(callback_refs)
2747
2779
        return result
2748
2780
 
2749
 
    def _warn_if_deprecated(self, branch=None):
 
2781
    def _warn_if_deprecated(self):
2750
2782
        global _deprecation_warning_done
2751
2783
        if _deprecation_warning_done:
2752
2784
            return
2753
 
        try:
2754
 
            if branch is None:
2755
 
                conf = config.GlobalConfig()
2756
 
            else:
2757
 
                conf = branch.get_config()
2758
 
            if conf.suppress_warning('format_deprecation'):
2759
 
                return
2760
 
            warning("Format %s for %s is deprecated -"
2761
 
                    " please use 'bzr upgrade' to get better performance"
2762
 
                    % (self._format, self.bzrdir.transport.base))
2763
 
        finally:
2764
 
            _deprecation_warning_done = True
 
2785
        _deprecation_warning_done = True
 
2786
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2787
                % (self._format, self.bzrdir.transport.base))
2765
2788
 
2766
2789
    def supports_rich_root(self):
2767
2790
        return self._format.rich_root_data
3050
3073
    pack_compresses = False
3051
3074
    # Does the repository inventory storage understand references to trees?
3052
3075
    supports_tree_reference = None
3053
 
    # Is the format experimental ?
3054
 
    experimental = False
3055
3076
 
3056
 
    def __repr__(self):
3057
 
        return "%s()" % self.__class__.__name__
 
3077
    def __str__(self):
 
3078
        return "<%s>" % self.__class__.__name__
3058
3079
 
3059
3080
    def __eq__(self, other):
3060
3081
        # format objects are generally stateless
3178
3199
        """
3179
3200
        raise NotImplementedError(self.open)
3180
3201
 
3181
 
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3182
 
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3183
 
        hooks = BzrDir.hooks['post_repo_init']
3184
 
        if not hooks:
3185
 
            return
3186
 
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3187
 
        for hook in hooks:
3188
 
            hook(params)
3189
 
 
3190
3202
 
3191
3203
class MetaDirRepositoryFormat(RepositoryFormat):
3192
3204
    """Common base class for the new repositories using the metadir layout."""
3397
3409
 
3398
3410
        :param revision_id: if None all content is copied, if NULL_REVISION no
3399
3411
                            content is copied.
3400
 
        :param pb: ignored.
 
3412
        :param pb: optional progress bar to use for progress reports. If not
 
3413
                   provided a default one will be created.
3401
3414
        :return: None.
3402
3415
        """
3403
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3404
 
        from bzrlib.fetch import RepoFetcher
3405
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
3406
 
        if self.source._format.network_name() != self.target._format.network_name():
3407
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
3408
 
                from_format=self.source._format,
3409
 
                to_format=self.target._format)
3410
 
        f = RepoFetcher(to_repository=self.target,
 
3416
        f = _mod_fetch.RepoFetcher(to_repository=self.target,
3411
3417
                               from_repository=self.source,
3412
3418
                               last_revision=revision_id,
3413
3419
                               fetch_spec=fetch_spec,
3414
 
                               find_ghosts=find_ghosts)
 
3420
                               pb=pb, find_ghosts=find_ghosts)
3415
3421
 
3416
3422
    def _walk_to_common_revisions(self, revision_ids):
3417
3423
        """Walk out from revision_ids in source to revisions target has.
3834
3840
        pending_revisions = []
3835
3841
        parent_map = self.source.get_parent_map(revision_ids)
3836
3842
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3837
 
        self.source._safe_to_return_from_cache = True
3838
3843
        for tree in self.source.revision_trees(revision_ids):
3839
3844
            # Find a inventory delta for this revision.
3840
3845
            # Find text entries that need to be copied, too.
3888
3893
            pending_revisions.append(revision)
3889
3894
            cache[current_revision_id] = tree
3890
3895
            basis_id = current_revision_id
3891
 
        self.source._safe_to_return_from_cache = False
3892
3896
        # Copy file texts
3893
3897
        from_texts = self.source.texts
3894
3898
        to_texts = self.target.texts
3973
3977
                basis_id = self._fetch_batch(batch, basis_id, cache,
3974
3978
                                             a_graph=a_graph)
3975
3979
            except:
3976
 
                self.source._safe_to_return_from_cache = False
3977
3980
                self.target.abort_write_group()
3978
3981
                raise
3979
3982
            else:
3991
3994
        """See InterRepository.fetch()."""
3992
3995
        if fetch_spec is not None:
3993
3996
            raise AssertionError("Not implemented yet...")
3994
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3995
3997
        if (not self.source.supports_rich_root()
3996
3998
            and self.target.supports_rich_root()):
3997
3999
            self._converting_to_rich_root = True
3998
4000
            self._revision_id_to_root_id = {}
3999
4001
        else:
4000
4002
            self._converting_to_rich_root = False
4001
 
        # See <https://launchpad.net/bugs/456077> asking for a warning here
4002
 
        if self.source._format.network_name() != self.target._format.network_name():
4003
 
            ui.ui_factory.show_user_warning('cross_format_fetch',
4004
 
                from_format=self.source._format,
4005
 
                to_format=self.target._format)
4006
4003
        revision_ids = self.target.search_missing_revision_ids(self.source,
4007
4004
            revision_id, find_ghosts=find_ghosts).get_keys()
4008
4005
        if not revision_ids:
4077
4074
        :param to_convert: The disk object to convert.
4078
4075
        :param pb: a progress bar to use for progress information.
4079
4076
        """
4080
 
        pb = ui.ui_factory.nested_progress_bar()
 
4077
        self.pb = pb
4081
4078
        self.count = 0
4082
4079
        self.total = 4
4083
4080
        # this is only useful with metadir layouts - separated repo content.
4084
4081
        # trigger an assertion if not such
4085
4082
        repo._format.get_format_string()
4086
4083
        self.repo_dir = repo.bzrdir
4087
 
        pb.update('Moving repository to repository.backup')
 
4084
        self.step('Moving repository to repository.backup')
4088
4085
        self.repo_dir.transport.move('repository', 'repository.backup')
4089
4086
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4090
4087
        repo._format.check_conversion_target(self.target_format)
4091
4088
        self.source_repo = repo._format.open(self.repo_dir,
4092
4089
            _found=True,
4093
4090
            _override_transport=backup_transport)
4094
 
        pb.update('Creating new repository')
 
4091
        self.step('Creating new repository')
4095
4092
        converted = self.target_format.initialize(self.repo_dir,
4096
4093
                                                  self.source_repo.is_shared())
4097
4094
        converted.lock_write()
4098
4095
        try:
4099
 
            pb.update('Copying content')
 
4096
            self.step('Copying content')
4100
4097
            self.source_repo.copy_content_into(converted)
4101
4098
        finally:
4102
4099
            converted.unlock()
4103
 
        pb.update('Deleting old repository content')
 
4100
        self.step('Deleting old repository content')
4104
4101
        self.repo_dir.transport.delete_tree('repository.backup')
4105
4102
        ui.ui_factory.note('repository converted')
4106
 
        pb.finished()
 
4103
 
 
4104
    def step(self, message):
 
4105
        """Update the pb by a step."""
 
4106
        self.count +=1
 
4107
        self.pb.update(message, self.count, self.total)
4107
4108
 
4108
4109
 
4109
4110
_unescape_map = {
4601
4602
 
4602
4603
    def _get_convertable_inventory_stream(self, revision_ids,
4603
4604
                                          delta_versus_null=False):
4604
 
        # The two formats are sufficiently different that there is no fast
4605
 
        # path, so we need to send just inventorydeltas, which any
4606
 
        # sufficiently modern client can insert into any repository.
4607
 
        # The StreamSink code expects to be able to
 
4605
        # The source is using CHKs, but the target either doesn't or it has a
 
4606
        # different serializer.  The StreamSink code expects to be able to
4608
4607
        # convert on the target, so we need to put bytes-on-the-wire that can
4609
4608
        # be converted.  That means inventory deltas (if the remote is <1.19,
4610
4609
        # RemoteStreamSink will fallback to VFS to insert the deltas).