1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
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
860
857
# versioned roots do not change unless the tree found a change.
863
class RepositoryWriteLockResult(object):
864
"""The result of write locking a repository.
866
:ivar repository_token: The token obtained from the underlying lock, or
868
:ivar unlock: A callable which will unlock the lock.
871
def __init__(self, unlock, repository_token):
872
self.repository_token = repository_token
876
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
880
860
######################################################################
884
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
864
class Repository(_RelockDebugMixin):
885
865
"""Repository holding history for one or more branches.
887
867
The repository holds and retrieves historical information including
1046
1026
:seealso: add_inventory, for the contract.
1048
inv_lines = self._serializer.write_inventory_to_lines(inv)
1028
inv_lines = self._serialise_inventory_to_lines(inv)
1049
1029
return self._inventory_add_lines(revision_id, parents,
1050
1030
inv_lines, check_content=False)
1258
1238
"""Check a single text from this repository."""
1259
1239
if kind == 'inventories':
1260
1240
rev_id = record.key[0]
1261
inv = self._deserialise_inventory(rev_id,
1241
inv = self.deserialise_inventory(rev_id,
1262
1242
record.get_bytes_as('fulltext'))
1263
1243
if last_object is not None:
1264
1244
delta = inv._make_delta(last_object)
1309
1289
:param _format: The format of the repository on disk.
1310
1290
:param a_bzrdir: The BzrDir of the repository.
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.
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
1296
super(Repository, self).__init__()
1316
1297
self._format = _format
1317
1298
# the following are part of the public API for Repository:
1323
1304
self._reconcile_does_inventory_gc = True
1324
1305
self._reconcile_fixes_text_parents = False
1325
1306
self._reconcile_backsup_inventory = True
1307
# not right yet - should be more semantically clear ?
1309
# TODO: make sure to construct the right store classes, etc, depending
1310
# on whether escaping is required.
1311
self._warn_if_deprecated()
1326
1312
self._write_group = None
1327
1313
# Additional places to query for data.
1328
1314
self._fallback_repositories = []
1332
1318
# rather copying them?
1333
1319
self._safe_to_return_from_cache = False
1336
def user_transport(self):
1337
return self.bzrdir.user_transport
1340
def control_transport(self):
1341
return self._transport
1343
1321
def __repr__(self):
1344
1322
if self._fallback_repositories:
1345
1323
return '%s(%r, fallback_repositories=%r)' % (
1393
1371
data during reads, and allows a 'write_group' to be obtained. Write
1394
1372
groups must be used for actual data insertion.
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
1400
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1402
1374
:param token: if this is already locked, then lock_write will fail
1403
1375
unless the token matches the existing lock.
1404
1376
:returns: a token if this instance supports tokens, otherwise None.
1407
1379
:raises MismatchedToken: if the specified token doesn't match the token
1408
1380
of the existing lock.
1409
1381
:seealso: start_write_group.
1410
:return: A RepositoryWriteLockResult.
1383
A token should be passed in if you know that you have locked the object
1384
some other way, and need to synchronise this object's state with that
1387
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1412
1389
locked = self.is_locked()
1413
token = self.control_files.lock_write(token=token)
1390
result = self.control_files.lock_write(token=token)
1415
self._warn_if_deprecated()
1416
1392
self._note_lock('w')
1417
1393
for repo in self._fallback_repositories:
1418
1394
# Writes don't affect fallback repos
1419
1395
repo.lock_read()
1420
1396
self._refresh_data()
1421
return RepositoryWriteLockResult(self.unlock, token)
1423
1399
def lock_read(self):
1424
"""Lock the repository for read operations.
1426
:return: An object with an unlock method which will release the lock
1429
1400
locked = self.is_locked()
1430
1401
self.control_files.lock_read()
1432
self._warn_if_deprecated()
1433
1403
self._note_lock('r')
1434
1404
for repo in self._fallback_repositories:
1435
1405
repo.lock_read()
1436
1406
self._refresh_data()
1439
1408
def get_physical_lock_status(self):
1440
1409
return self.control_files.get_physical_lock_status()
1501
1470
# now gather global repository information
1502
1471
# XXX: This is available for many repos regardless of listability.
1503
if self.user_transport.listable():
1472
if self.bzrdir.root_transport.listable():
1504
1473
# XXX: do we want to __define len__() ?
1505
1474
# Maybe the versionedfiles object should provide a different
1506
1475
# method to get the number of keys.
1516
1485
:param using: If True, list only branches using this repository.
1518
1487
if using and not self.is_shared():
1519
return self.bzrdir.list_branches()
1489
return [self.bzrdir.open_branch()]
1490
except errors.NotBranchError:
1520
1492
class Evaluator(object):
1522
1494
def __init__(self):
1531
1503
except errors.NoRepositoryPresent:
1534
return False, ([], repository)
1506
return False, (None, repository)
1535
1507
self.first_call = False
1536
value = (bzrdir.list_branches(), None)
1509
value = (bzrdir.open_branch(), None)
1510
except errors.NotBranchError:
1511
value = (None, None)
1537
1512
return True, value
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)
1515
for branch, repository in bzrdir.BzrDir.find_bzrdirs(
1516
self.bzrdir.root_transport, evaluate=Evaluator()):
1517
if branch is not None:
1518
branches.append(branch)
1544
1519
if not using and repository is not None:
1545
ret.extend(repository.find_branches())
1520
branches.extend(repository.find_branches())
1548
1523
@needs_read_lock
1549
1524
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1927
1902
rev = self._serializer.read_revision_from_string(text)
1928
1903
yield (revid, rev)
1906
def get_revision_xml(self, revision_id):
1907
# TODO: jam 20070210 This shouldn't be necessary since get_revision
1908
# would have already do it.
1909
# TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1910
# TODO: this can't just be replaced by:
1911
# return self._serializer.write_revision_to_string(
1912
# self.get_revision(revision_id))
1913
# as cStringIO preservers the encoding unlike write_revision_to_string
1914
# or some other call down the path.
1915
rev = self.get_revision(revision_id)
1916
rev_tmp = cStringIO.StringIO()
1917
# the current serializer..
1918
self._serializer.write_revision(rev, rev_tmp)
1920
return rev_tmp.getvalue()
1930
1922
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1931
1923
"""Produce a generator of revision deltas.
2175
2167
selected_keys = set((revid,) for revid in revision_ids)
2176
2168
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),
2169
pb = ui.ui_factory.nested_progress_bar()
2171
return self._find_file_ids_from_xml_inventory_lines(
2172
w.iter_lines_added_or_present_in_keys(
2173
selected_keys, pb=pb),
2182
2178
def iter_files_bytes(self, desired_files):
2183
2179
"""Iterate through file versions.
2393
2389
"""single-document based inventory iteration."""
2394
2390
inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2395
2391
for text, revision_id in inv_xmls:
2396
yield self._deserialise_inventory(revision_id, text)
2392
yield self.deserialise_inventory(revision_id, text)
2398
2394
def _iter_inventory_xmls(self, revision_ids, ordering):
2399
2395
if ordering is None:
2431
2427
next_key = None
2434
def _deserialise_inventory(self, revision_id, xml):
2430
def deserialise_inventory(self, revision_id, xml):
2435
2431
"""Transform the xml into an inventory object.
2437
2433
:param revision_id: The expected revision id of the inventory.
2445
2441
result.revision_id, revision_id))
2444
def serialise_inventory(self, inv):
2445
return self._serializer.write_inventory_to_string(inv)
2447
def _serialise_inventory_to_lines(self, inv):
2448
return self._serializer.write_inventory_to_lines(inv)
2448
2450
def get_serializer_format(self):
2449
2451
return self._serializer.format_num
2451
2453
@needs_read_lock
2452
def _get_inventory_xml(self, revision_id):
2453
"""Get serialized inventory as a string."""
2454
def get_inventory_xml(self, revision_id):
2455
"""Get inventory XML as a file object."""
2454
2456
texts = self._iter_inventory_xmls([revision_id], 'unordered')
2456
2458
text, revision_id = texts.next()
2458
2460
raise errors.HistoryMissing(self, 'inventory', revision_id)
2464
def get_inventory_sha1(self, revision_id):
2465
"""Return the sha1 hash of the inventory entry
2467
return self.get_revision(revision_id).inventory_sha1
2461
2469
def get_rev_id_for_revno(self, revno, known_pair):
2462
2470
"""Return the revision id of a revno, given a later (revno, revid)
2463
2471
pair in the same history.
2515
2523
next_id = parents[0]
2526
def get_revision_inventory(self, revision_id):
2527
"""Return inventory of a past revision."""
2528
# TODO: Unify this with get_inventory()
2529
# bzr 0.0.6 and later imposes the constraint that the inventory_id
2530
# must be the same as its revision, so this is trivial.
2531
if revision_id is None:
2532
# This does not make sense: if there is no revision,
2533
# then it is the current tree inventory surely ?!
2534
# and thus get_root_id() is something that looks at the last
2535
# commit on the branch, and the get_root_id is an inventory check.
2536
raise NotImplementedError
2537
# return Inventory(self.get_root_id())
2539
return self.get_inventory(revision_id)
2517
2541
def is_shared(self):
2518
2542
"""Return True if this repository is flagged as a shared repository."""
2519
2543
raise NotImplementedError(self.is_shared)
2553
2577
return RevisionTree(self, Inventory(root_id=None),
2554
2578
_mod_revision.NULL_REVISION)
2556
inv = self.get_inventory(revision_id)
2580
inv = self.get_revision_inventory(revision_id)
2557
2581
return RevisionTree(self, inv, revision_id)
2559
2583
def revision_trees(self, revision_ids):
2612
2636
keys = tsort.topo_sort(parent_map)
2613
2637
return [None] + list(keys)
2615
def pack(self, hint=None, clean_obsolete_packs=False):
2639
def pack(self, hint=None):
2616
2640
"""Compress the data within the repository.
2618
2642
This operation only makes sense for some repository types. For other
2628
2652
obtained from the result of commit_write_group(). Out of
2629
2653
date hints are simply ignored, because concurrent operations
2630
2654
can obsolete them rapidly.
2632
:param clean_obsolete_packs: Clean obsolete packs immediately after
2636
2657
def get_transaction(self):
2661
2682
def _make_parents_provider(self):
2665
def get_known_graph_ancestry(self, revision_ids):
2666
"""Return the known graph for a set of revision ids and their ancestors.
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)
2673
2685
def get_graph(self, other_repository=None):
2674
2686
"""Return the graph walker for this repository format"""
2675
2687
parents_provider = self._make_parents_provider()
2770
2782
result.check(callback_refs)
2773
def _warn_if_deprecated(self, branch=None):
2785
def _warn_if_deprecated(self):
2774
2786
global _deprecation_warning_done
2775
2787
if _deprecation_warning_done:
2779
conf = config.GlobalConfig()
2781
conf = branch.get_config()
2782
if conf.suppress_warning('format_deprecation'):
2784
warning("Format %s for %s is deprecated -"
2785
" please use 'bzr upgrade' to get better performance"
2786
% (self._format, self.bzrdir.transport.base))
2788
_deprecation_warning_done = True
2789
_deprecation_warning_done = True
2790
warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
2791
% (self._format, self.bzrdir.transport.base))
2790
2793
def supports_rich_root(self):
2791
2794
return self._format.rich_root_data
3074
3077
pack_compresses = False
3075
3078
# Does the repository inventory storage understand references to trees?
3076
3079
supports_tree_reference = None
3077
# Is the format experimental ?
3078
experimental = False
3081
return "%s()" % self.__class__.__name__
3082
return "<%s>" % self.__class__.__name__
3083
3084
def __eq__(self, other):
3084
3085
# format objects are generally stateless
3203
3204
raise NotImplementedError(self.open)
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']
3210
params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3215
3207
class MetaDirRepositoryFormat(RepositoryFormat):
3216
3208
"""Common base class for the new repositories using the metadir layout."""
3422
3414
:param revision_id: if None all content is copied, if NULL_REVISION no
3423
3415
content is copied.
3416
:param pb: optional progress bar to use for progress reports. If not
3417
provided a default one will be created.
3427
ui.ui_factory.warn_experimental_format_fetch(self)
3428
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
f = RepoFetcher(to_repository=self.target,
3420
f = _mod_fetch.RepoFetcher(to_repository=self.target,
3435
3421
from_repository=self.source,
3436
3422
last_revision=revision_id,
3437
3423
fetch_spec=fetch_spec,
3438
find_ghosts=find_ghosts)
3424
pb=pb, find_ghosts=find_ghosts)
3440
3426
def _walk_to_common_revisions(self, revision_ids):
3441
3427
"""Walk out from revision_ids in source to revisions target has.
4015
4001
"""See InterRepository.fetch()."""
4016
4002
if fetch_spec is not None:
4017
4003
raise AssertionError("Not implemented yet...")
4018
ui.ui_factory.warn_experimental_format_fetch(self)
4019
4004
if (not self.source.supports_rich_root()
4020
4005
and self.target.supports_rich_root()):
4021
4006
self._converting_to_rich_root = True
4022
4007
self._revision_id_to_root_id = {}
4024
4009
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
4010
revision_ids = self.target.search_missing_revision_ids(self.source,
4031
4011
revision_id, find_ghosts=find_ghosts).get_keys()
4032
4012
if not revision_ids:
4101
4081
:param to_convert: The disk object to convert.
4102
4082
:param pb: a progress bar to use for progress information.
4104
pb = ui.ui_factory.nested_progress_bar()
4107
4087
# this is only useful with metadir layouts - separated repo content.
4108
4088
# trigger an assertion if not such
4109
4089
repo._format.get_format_string()
4110
4090
self.repo_dir = repo.bzrdir
4111
pb.update('Moving repository to repository.backup')
4091
self.step('Moving repository to repository.backup')
4112
4092
self.repo_dir.transport.move('repository', 'repository.backup')
4113
4093
backup_transport = self.repo_dir.transport.clone('repository.backup')
4114
4094
repo._format.check_conversion_target(self.target_format)
4115
4095
self.source_repo = repo._format.open(self.repo_dir,
4117
4097
_override_transport=backup_transport)
4118
pb.update('Creating new repository')
4098
self.step('Creating new repository')
4119
4099
converted = self.target_format.initialize(self.repo_dir,
4120
4100
self.source_repo.is_shared())
4121
4101
converted.lock_write()
4123
pb.update('Copying content')
4103
self.step('Copying content')
4124
4104
self.source_repo.copy_content_into(converted)
4126
4106
converted.unlock()
4127
pb.update('Deleting old repository content')
4107
self.step('Deleting old repository content')
4128
4108
self.repo_dir.transport.delete_tree('repository.backup')
4129
4109
ui.ui_factory.note('repository converted')
4111
def step(self, message):
4112
"""Update the pb by a step."""
4114
self.pb.update(message, self.count, self.total)
4133
4117
_unescape_map = {
4626
4610
def _get_convertable_inventory_stream(self, revision_ids,
4627
4611
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
4612
# The source is using CHKs, but the target either doesn't or it has a
4613
# different serializer. The StreamSink code expects to be able to
4632
4614
# convert on the target, so we need to put bytes-on-the-wire that can
4633
4615
# be converted. That means inventory deltas (if the remote is <1.19,
4634
4616
# RemoteStreamSink will fallback to VFS to insert the deltas).
added
removed
bzrlib/repository.py
