252
899
"""See Config.log_format."""
253
900
return self._get_user_option('log_format')
255
def __init__(self, get_filename):
256
super(IniBasedConfig, self).__init__()
257
self._get_filename = get_filename
902
def _validate_signatures_in_log(self):
903
"""See Config.validate_signatures_in_log."""
904
return self._get_user_option('validate_signatures_in_log')
906
def _acceptable_keys(self):
907
"""See Config.acceptable_keys."""
908
return self._get_user_option('acceptable_keys')
260
910
def _post_commit(self):
261
911
"""See Config.post_commit."""
262
912
return self._get_user_option('post_commit')
264
def _string_to_signature_policy(self, signature_string):
265
"""Convert a string to a signing policy."""
266
if signature_string.lower() == 'check-available':
267
return CHECK_IF_POSSIBLE
268
if signature_string.lower() == 'ignore':
270
if signature_string.lower() == 'require':
272
raise errors.BzrError("Invalid signatures policy '%s'"
275
914
def _get_alias(self, value):
277
return self._get_parser().get_value("ALIASES",
916
return self._get_parser().get_value("ALIASES",
283
class GlobalConfig(IniBasedConfig):
921
def _get_nickname(self):
922
return self.get_user_option('nickname')
924
def remove_user_option(self, option_name, section_name=None):
925
"""Remove a user option and save the configuration file.
927
:param option_name: The option to be removed.
929
:param section_name: The section the option is defined in, default to
933
parser = self._get_parser()
934
if section_name is None:
937
section = parser[section_name]
939
del section[option_name]
941
raise errors.NoSuchConfigOption(option_name)
942
self._write_config_file()
943
for hook in OldConfigHooks['remove']:
944
hook(self, option_name)
946
def _write_config_file(self):
947
if self.file_name is None:
948
raise AssertionError('We cannot save, self.file_name is None')
949
conf_dir = os.path.dirname(self.file_name)
950
ensure_config_dir_exists(conf_dir)
951
atomic_file = atomicfile.AtomicFile(self.file_name)
952
self._get_parser().write(atomic_file)
955
osutils.copy_ownership_from_path(self.file_name)
956
for hook in OldConfigHooks['save']:
960
class LockableConfig(IniBasedConfig):
961
"""A configuration needing explicit locking for access.
963
If several processes try to write the config file, the accesses need to be
966
Daughter classes should decorate all methods that update a config with the
967
``@needs_write_lock`` decorator (they call, directly or indirectly, the
968
``_write_config_file()`` method. These methods (typically ``set_option()``
969
and variants must reload the config file from disk before calling
970
``_write_config_file()``), this can be achieved by calling the
971
``self.reload()`` method. Note that the lock scope should cover both the
972
reading and the writing of the config file which is why the decorator can't
973
be applied to ``_write_config_file()`` only.
975
This should be enough to implement the following logic:
976
- lock for exclusive write access,
977
- reload the config file from disk,
981
This logic guarantees that a writer can update a value without erasing an
982
update made by another writer.
987
def __init__(self, file_name):
988
super(LockableConfig, self).__init__(file_name=file_name)
989
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
990
# FIXME: It doesn't matter that we don't provide possible_transports
991
# below since this is currently used only for local config files ;
992
# local transports are not shared. But if/when we start using
993
# LockableConfig for other kind of transports, we will need to reuse
994
# whatever connection is already established -- vila 20100929
995
self.transport = transport.get_transport_from_path(self.dir)
996
self._lock = lockdir.LockDir(self.transport, self.lock_name)
998
def _create_from_string(self, unicode_bytes, save):
999
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1001
# We need to handle the saving here (as opposed to IniBasedConfig)
1002
# to be able to lock
1004
self._write_config_file()
1007
def lock_write(self, token=None):
1008
"""Takes a write lock in the directory containing the config file.
1010
If the directory doesn't exist it is created.
1012
ensure_config_dir_exists(self.dir)
1013
return self._lock.lock_write(token)
1018
def break_lock(self):
1019
self._lock.break_lock()
1022
def remove_user_option(self, option_name, section_name=None):
1023
super(LockableConfig, self).remove_user_option(option_name,
1026
def _write_config_file(self):
1027
if self._lock is None or not self._lock.is_held:
1028
# NB: if the following exception is raised it probably means a
1029
# missing @needs_write_lock decorator on one of the callers.
1030
raise errors.ObjectNotLocked(self)
1031
super(LockableConfig, self)._write_config_file()
1034
class GlobalConfig(LockableConfig):
284
1035
"""The configuration that should be used for a specific location."""
286
def get_editor(self):
287
return self._get_user_option('editor')
289
1037
def __init__(self):
290
super(GlobalConfig, self).__init__(config_filename)
293
class LocationConfig(IniBasedConfig):
294
"""A configuration object that gives the policy for a location."""
296
def __init__(self, location):
297
super(LocationConfig, self).__init__(branches_config_filename)
298
self._global_config = None
299
self.location = location
301
def _get_global_config(self):
302
if self._global_config is None:
303
self._global_config = GlobalConfig()
304
return self._global_config
306
def _get_section(self):
307
"""Get the section we should look in for config items.
309
Returns None if none exists.
310
TODO: perhaps return a NullSection that thunks through to the
1038
super(GlobalConfig, self).__init__(file_name=config_filename())
1040
def config_id(self):
1044
def from_string(cls, str_or_unicode, save=False):
1045
"""Create a config object from a string.
1047
:param str_or_unicode: A string representing the file content. This
1048
will be utf-8 encoded.
1050
:param save: Whether the file should be saved upon creation.
313
sections = self._get_parser()
314
location_names = self.location.split('/')
315
if self.location.endswith('/'):
316
del location_names[-1]
318
for section in sections:
319
section_names = section.split('/')
320
if section.endswith('/'):
321
del section_names[-1]
322
names = zip(location_names, section_names)
1053
conf._create_from_string(str_or_unicode, save)
1057
def set_user_option(self, option, value):
1058
"""Save option and its value in the configuration."""
1059
self._set_option(option, value, 'DEFAULT')
1061
def get_aliases(self):
1062
"""Return the aliases section."""
1063
if 'ALIASES' in self._get_parser():
1064
return self._get_parser()['ALIASES']
1069
def set_alias(self, alias_name, alias_command):
1070
"""Save the alias in the configuration."""
1071
self._set_option(alias_name, alias_command, 'ALIASES')
1074
def unset_alias(self, alias_name):
1075
"""Unset an existing alias."""
1077
aliases = self._get_parser().get('ALIASES')
1078
if not aliases or alias_name not in aliases:
1079
raise errors.NoSuchAlias(alias_name)
1080
del aliases[alias_name]
1081
self._write_config_file()
1083
def _set_option(self, option, value, section):
1085
self._get_parser().setdefault(section, {})[option] = value
1086
self._write_config_file()
1087
for hook in OldConfigHooks['set']:
1088
hook(self, option, value)
1090
def _get_sections(self, name=None):
1091
"""See IniBasedConfig._get_sections()."""
1092
parser = self._get_parser()
1093
# We don't give access to options defined outside of any section, we
1094
# used the DEFAULT section by... default.
1095
if name in (None, 'DEFAULT'):
1096
# This could happen for an empty file where the DEFAULT section
1097
# doesn't exist yet. So we force DEFAULT when yielding
1099
if 'DEFAULT' not in parser:
1100
parser['DEFAULT']= {}
1101
yield (name, parser[name], self.config_id())
1104
def remove_user_option(self, option_name, section_name=None):
1105
if section_name is None:
1106
# We need to force the default section.
1107
section_name = 'DEFAULT'
1108
# We need to avoid the LockableConfig implementation or we'll lock
1110
super(LockableConfig, self).remove_user_option(option_name,
1113
def _iter_for_location_by_parts(sections, location):
1114
"""Keep only the sessions matching the specified location.
1116
:param sections: An iterable of section names.
1118
:param location: An url or a local path to match against.
1120
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1121
number of path components in the section name, section is the section
1122
name and extra_path is the difference between location and the section
1125
``location`` will always be a local path and never a 'file://' url but the
1126
section names themselves can be in either form.
1128
location_parts = location.rstrip('/').split('/')
1130
for section in sections:
1131
# location is a local path if possible, so we need to convert 'file://'
1132
# urls in section names to local paths if necessary.
1134
# This also avoids having file:///path be a more exact
1135
# match than '/path'.
1137
# FIXME: This still raises an issue if a user defines both file:///path
1138
# *and* /path. Should we raise an error in this case -- vila 20110505
1140
if section.startswith('file://'):
1141
section_path = urlutils.local_path_from_url(section)
1143
section_path = section
1144
section_parts = section_path.rstrip('/').split('/')
1147
if len(section_parts) > len(location_parts):
1148
# More path components in the section, they can't match
1151
# Rely on zip truncating in length to the length of the shortest
1152
# argument sequence.
1153
names = zip(location_parts, section_parts)
324
1154
for name in names:
325
if not fnmatch(name[0], name[1]):
1155
if not fnmatch.fnmatch(name[0], name[1]):
330
# so, for the common prefix they matched.
331
# if section is longer, no match.
332
if len(section_names) > len(location_names):
334
# if path is longer, and recurse is not true, no match
335
if len(section_names) < len(location_names):
337
if not self._get_parser()[section].as_bool('recurse'):
341
matches.append((len(section_names), section))
344
matches.sort(reverse=True)
347
def _gpg_signing_command(self):
348
"""See Config.gpg_signing_command."""
349
command = super(LocationConfig, self)._gpg_signing_command()
350
if command is not None:
352
return self._get_global_config()._gpg_signing_command()
354
def _log_format(self):
355
"""See Config.log_format."""
356
command = super(LocationConfig, self)._log_format()
357
if command is not None:
359
return self._get_global_config()._log_format()
361
def _get_user_id(self):
362
user_id = super(LocationConfig, self)._get_user_id()
363
if user_id is not None:
365
return self._get_global_config()._get_user_id()
367
def _get_user_option(self, option_name):
368
"""See Config._get_user_option."""
369
option_value = super(LocationConfig,
370
self)._get_user_option(option_name)
371
if option_value is not None:
373
return self._get_global_config()._get_user_option(option_name)
375
def _get_signature_checking(self):
376
"""See Config._get_signature_checking."""
377
check = super(LocationConfig, self)._get_signature_checking()
378
if check is not None:
380
return self._get_global_config()._get_signature_checking()
382
def _post_commit(self):
383
"""See Config.post_commit."""
384
hook = self._get_user_option('post_commit')
387
return self._get_global_config()._post_commit()
389
def set_user_option(self, option, value):
1160
# build the path difference between the section and the location
1161
extra_path = '/'.join(location_parts[len(section_parts):])
1162
yield section, extra_path, len(section_parts)
1165
class LocationConfig(LockableConfig):
1166
"""A configuration object that gives the policy for a location."""
1168
def __init__(self, location):
1169
super(LocationConfig, self).__init__(
1170
file_name=locations_config_filename())
1171
# local file locations are looked up by local path, rather than
1172
# by file url. This is because the config file is a user
1173
# file, and we would rather not expose the user to file urls.
1174
if location.startswith('file://'):
1175
location = urlutils.local_path_from_url(location)
1176
self.location = location
1178
def config_id(self):
1182
def from_string(cls, str_or_unicode, location, save=False):
1183
"""Create a config object from a string.
1185
:param str_or_unicode: A string representing the file content. This will
1188
:param location: The location url to filter the configuration.
1190
:param save: Whether the file should be saved upon creation.
1192
conf = cls(location)
1193
conf._create_from_string(str_or_unicode, save)
1196
def _get_matching_sections(self):
1197
"""Return an ordered list of section names matching this location."""
1198
matches = list(_iter_for_location_by_parts(self._get_parser(),
1200
# put the longest (aka more specific) locations first
1202
key=lambda (section, extra_path, length): (length, section),
1204
for (section, extra_path, length) in matches:
1205
yield section, extra_path
1206
# should we stop looking for parent configs here?
1208
if self._get_parser()[section].as_bool('ignore_parents'):
1213
def _get_sections(self, name=None):
1214
"""See IniBasedConfig._get_sections()."""
1215
# We ignore the name here as the only sections handled are named with
1216
# the location path and we don't expose embedded sections either.
1217
parser = self._get_parser()
1218
for name, extra_path in self._get_matching_sections():
1219
yield (name, parser[name], self.config_id())
1221
def _get_option_policy(self, section, option_name):
1222
"""Return the policy for the given (section, option_name) pair."""
1223
# check for the old 'recurse=False' flag
1225
recurse = self._get_parser()[section].as_bool('recurse')
1229
return POLICY_NORECURSE
1231
policy_key = option_name + ':policy'
1233
policy_name = self._get_parser()[section][policy_key]
1237
return _policy_value[policy_name]
1239
def _set_option_policy(self, section, option_name, option_policy):
1240
"""Set the policy for the given option name in the given section."""
1241
# The old recurse=False option affects all options in the
1242
# section. To handle multiple policies in the section, we
1243
# need to convert it to a policy_norecurse key.
1245
recurse = self._get_parser()[section].as_bool('recurse')
1249
symbol_versioning.warn(
1250
'The recurse option is deprecated as of 0.14. '
1251
'The section "%s" has been converted to use policies.'
1254
del self._get_parser()[section]['recurse']
1256
for key in self._get_parser()[section].keys():
1257
if not key.endswith(':policy'):
1258
self._get_parser()[section][key +
1259
':policy'] = 'norecurse'
1261
policy_key = option_name + ':policy'
1262
policy_name = _policy_name[option_policy]
1263
if policy_name is not None:
1264
self._get_parser()[section][policy_key] = policy_name
1266
if policy_key in self._get_parser()[section]:
1267
del self._get_parser()[section][policy_key]
1270
def set_user_option(self, option, value, store=STORE_LOCATION):
390
1271
"""Save option and its value in the configuration."""
391
# FIXME: RBC 20051029 This should refresh the parser and also take a
392
# file lock on branches.conf.
393
conf_dir = os.path.dirname(self._get_filename())
394
ensure_config_dir_exists(conf_dir)
1272
if store not in [STORE_LOCATION,
1273
STORE_LOCATION_NORECURSE,
1274
STORE_LOCATION_APPENDPATH]:
1275
raise ValueError('bad storage policy %r for %r' %
395
1278
location = self.location
396
1279
if location.endswith('/'):
397
1280
location = location[:-1]
398
if (not location in self._get_parser() and
399
not location + '/' in self._get_parser()):
400
self._get_parser()[location]={}
401
elif location + '/' in self._get_parser():
1281
parser = self._get_parser()
1282
if not location in parser and not location + '/' in parser:
1283
parser[location] = {}
1284
elif location + '/' in parser:
402
1285
location = location + '/'
403
self._get_parser()[location][option]=value
404
self._get_parser().write(file(self._get_filename(), 'wb'))
1286
parser[location][option]=value
1287
# the allowed values of store match the config policies
1288
self._set_option_policy(location, option, store)
1289
self._write_config_file()
1290
for hook in OldConfigHooks['set']:
1291
hook(self, option, value)
407
1294
class BranchConfig(Config):
408
1295
"""A configuration object giving the policy for a branch."""
1297
def __init__(self, branch):
1298
super(BranchConfig, self).__init__()
1299
self._location_config = None
1300
self._branch_data_config = None
1301
self._global_config = None
1302
self.branch = branch
1303
self.option_sources = (self._get_location_config,
1304
self._get_branch_data_config,
1305
self._get_global_config)
1307
def config_id(self):
1310
def _get_branch_data_config(self):
1311
if self._branch_data_config is None:
1312
self._branch_data_config = TreeConfig(self.branch)
1313
self._branch_data_config.config_id = self.config_id
1314
return self._branch_data_config
410
1316
def _get_location_config(self):
411
1317
if self._location_config is None:
412
1318
self._location_config = LocationConfig(self.branch.base)
413
1319
return self._location_config
1321
def _get_global_config(self):
1322
if self._global_config is None:
1323
self._global_config = GlobalConfig()
1324
return self._global_config
1326
def _get_best_value(self, option_name):
1327
"""This returns a user option from local, tree or global config.
1329
They are tried in that order. Use get_safe_value if trusted values
1332
for source in self.option_sources:
1333
value = getattr(source(), option_name)()
1334
if value is not None:
1338
def _get_safe_value(self, option_name):
1339
"""This variant of get_best_value never returns untrusted values.
1341
It does not return values from the branch data, because the branch may
1342
not be controlled by the user.
1344
We may wish to allow locations.conf to control whether branches are
1345
trusted in the future.
1347
for source in (self._get_location_config, self._get_global_config):
1348
value = getattr(source(), option_name)()
1349
if value is not None:
415
1353
def _get_user_id(self):
416
1354
"""Return the full user id for the branch.
418
e.g. "John Hacker <jhacker@foo.org>"
1356
e.g. "John Hacker <jhacker@example.com>"
419
1357
This is looked up in the email controlfile for the branch.
422
return (self.branch.control_files.get_utf8("email")
424
.decode(bzrlib.user_encoding)
426
except errors.NoSuchFile, e:
429
return self._get_location_config()._get_user_id()
1359
return self._get_best_value('_get_user_id')
1361
def _get_change_editor(self):
1362
return self._get_best_value('_get_change_editor')
431
1364
def _get_signature_checking(self):
432
1365
"""See Config._get_signature_checking."""
433
return self._get_location_config()._get_signature_checking()
1366
return self._get_best_value('_get_signature_checking')
1368
def _get_signing_policy(self):
1369
"""See Config._get_signing_policy."""
1370
return self._get_best_value('_get_signing_policy')
435
1372
def _get_user_option(self, option_name):
436
1373
"""See Config._get_user_option."""
437
return self._get_location_config()._get_user_option(option_name)
1374
for source in self.option_sources:
1375
value = source()._get_user_option(option_name)
1376
if value is not None:
1380
def _get_sections(self, name=None):
1381
"""See IniBasedConfig.get_sections()."""
1382
for source in self.option_sources:
1383
for section in source()._get_sections(name):
1386
def _get_options(self, sections=None):
1388
# First the locations options
1389
for option in self._get_location_config()._get_options():
1391
# Then the branch options
1392
branch_config = self._get_branch_data_config()
1393
if sections is None:
1394
sections = [('DEFAULT', branch_config._get_parser())]
1395
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1396
# Config itself has no notion of sections :( -- vila 20101001
1397
config_id = self.config_id()
1398
for (section_name, section) in sections:
1399
for (name, value) in section.iteritems():
1400
yield (name, value, section_name,
1401
config_id, branch_config._get_parser())
1402
# Then the global options
1403
for option in self._get_global_config()._get_options():
1406
def set_user_option(self, name, value, store=STORE_BRANCH,
1408
if store == STORE_BRANCH:
1409
self._get_branch_data_config().set_option(value, name)
1410
elif store == STORE_GLOBAL:
1411
self._get_global_config().set_user_option(name, value)
1413
self._get_location_config().set_user_option(name, value, store)
1416
if store in (STORE_GLOBAL, STORE_BRANCH):
1417
mask_value = self._get_location_config().get_user_option(name)
1418
if mask_value is not None:
1419
trace.warning('Value "%s" is masked by "%s" from'
1420
' locations.conf', value, mask_value)
1422
if store == STORE_GLOBAL:
1423
branch_config = self._get_branch_data_config()
1424
mask_value = branch_config.get_user_option(name)
1425
if mask_value is not None:
1426
trace.warning('Value "%s" is masked by "%s" from'
1427
' branch.conf', value, mask_value)
1429
def remove_user_option(self, option_name, section_name=None):
1430
self._get_branch_data_config().remove_option(option_name, section_name)
439
1432
def _gpg_signing_command(self):
440
1433
"""See Config.gpg_signing_command."""
441
return self._get_location_config()._gpg_signing_command()
443
def __init__(self, branch):
444
super(BranchConfig, self).__init__()
445
self._location_config = None
1434
return self._get_safe_value('_gpg_signing_command')
448
1436
def _post_commit(self):
449
1437
"""See Config.post_commit."""
450
return self._get_location_config()._post_commit()
1438
return self._get_safe_value('_post_commit')
1440
def _get_nickname(self):
1441
value = self._get_explicit_nickname()
1442
if value is not None:
1444
if self.branch.name:
1445
return self.branch.name
1446
return urlutils.unescape(self.branch.base.split('/')[-2])
1448
def has_explicit_nickname(self):
1449
"""Return true if a nickname has been explicitly assigned."""
1450
return self._get_explicit_nickname() is not None
1452
def _get_explicit_nickname(self):
1453
return self._get_best_value('_get_nickname')
452
1455
def _log_format(self):
453
1456
"""See Config.log_format."""
454
return self._get_location_config()._log_format()
1457
return self._get_best_value('_log_format')
1459
def _validate_signatures_in_log(self):
1460
"""See Config.validate_signatures_in_log."""
1461
return self._get_best_value('_validate_signatures_in_log')
1463
def _acceptable_keys(self):
1464
"""See Config.acceptable_keys."""
1465
return self._get_best_value('_acceptable_keys')
457
1468
def ensure_config_dir_exists(path=None):
466
1477
if sys.platform == 'win32':
467
1478
parent_dir = os.path.dirname(path)
468
1479
if not os.path.isdir(parent_dir):
469
mutter('creating config parent directory: %r', parent_dir)
471
mutter('creating config directory: %r', path)
1480
trace.mutter('creating config parent directory: %r', parent_dir)
1481
os.mkdir(parent_dir)
1482
trace.mutter('creating config directory: %r', path)
1484
osutils.copy_ownership_from_path(path)
475
1487
def config_dir():
476
"""Return per-user configuration directory.
478
By default this is ~/.bazaar/
1488
"""Return per-user configuration directory as unicode string
1490
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1491
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1492
that will be used instead.
480
1494
TODO: Global option --config-dir to override this.
482
base = os.environ.get('BZR_HOME', None)
1496
base = osutils.path_from_environ('BZR_HOME')
483
1497
if sys.platform == 'win32':
484
1498
if base is None:
485
base = os.environ.get('APPDATA', None)
487
base = os.environ.get('HOME', None)
489
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
490
return pathjoin(base, 'bazaar', '2.0')
492
# cygwin, linux, and darwin all have a $HOME directory
494
base = os.path.expanduser("~")
495
return pathjoin(base, ".bazaar")
1499
base = win32utils.get_appdata_location()
1501
base = win32utils.get_home_location()
1502
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1503
# APPDATA, but hard to move. See bug 348640 for more.
1504
return osutils.pathjoin(base, 'bazaar', '2.0')
1506
# GZ 2012-02-01: What should OSX use instead of XDG if anything?
1507
if sys.platform != 'darwin':
1508
xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1510
xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1511
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1512
if osutils.isdir(xdg_dir):
1514
"Using configuration in XDG directory %s." % xdg_dir)
1516
base = osutils._get_home_dir()
1517
return osutils.pathjoin(base, ".bazaar")
498
1520
def config_filename():
499
1521
"""Return per-user configuration ini file filename."""
500
return pathjoin(config_dir(), 'bazaar.conf')
503
def branches_config_filename():
1522
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1525
def locations_config_filename():
504
1526
"""Return per-user configuration ini file filename."""
505
return pathjoin(config_dir(), 'branches.conf')
1527
return osutils.pathjoin(config_dir(), 'locations.conf')
1530
def authentication_config_filename():
1531
"""Return per-user authentication ini file filename."""
1532
return osutils.pathjoin(config_dir(), 'authentication.conf')
1535
def user_ignore_config_filename():
1536
"""Return the user default ignore filename"""
1537
return osutils.pathjoin(config_dir(), 'ignore')
1541
"""Return the directory name to store crash files.
1543
This doesn't implicitly create it.
1545
On Windows it's in the config directory; elsewhere it's /var/crash
1546
which may be monitored by apport. It can be overridden by
1549
if sys.platform == 'win32':
1550
return osutils.pathjoin(config_dir(), 'Crash')
1552
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1554
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1557
def xdg_cache_dir():
1558
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1559
# Possibly this should be different on Windows?
1560
e = os.environ.get('XDG_CACHE_DIR', None)
1564
return os.path.expanduser('~/.cache')
1567
def _get_default_mail_domain(mailname_file='/etc/mailname'):
1568
"""If possible, return the assumed default email domain.
1570
:returns: string mail domain, or None.
1572
if sys.platform == 'win32':
1573
# No implementation yet; patches welcome
1576
f = open(mailname_file)
1577
except (IOError, OSError), e:
1580
domain = f.readline().strip()
1586
def default_email():
1587
v = os.environ.get('BZR_EMAIL')
1589
return v.decode(osutils.get_user_encoding())
1590
v = os.environ.get('EMAIL')
1592
return v.decode(osutils.get_user_encoding())
1593
name, email = _auto_user_id()
1595
return u'%s <%s>' % (name, email)
1598
raise errors.NoWhoami()
508
1601
def _auto_user_id():
509
1602
"""Calculate automatic user identification.
511
Returns (realname, email).
1604
:returns: (realname, email), either of which may be None if they can't be
513
1607
Only used when none is set in the environment or the id file.
515
This previously used the FQDN as the default domain, but that can
516
be very slow on machines where DNS is broken. So now we simply
1609
This only returns an email address if we can be fairly sure the
1610
address is reasonable, ie if /etc/mailname is set on unix.
1612
This doesn't use the FQDN as the default domain because that may be
1613
slow, and it doesn't use the hostname alone because that's not normally
1614
a reasonable address.
521
# XXX: Any good way to get real user name on win32?
1616
if sys.platform == 'win32':
1617
# No implementation to reliably determine Windows default mail
1618
# address; please add one.
1621
default_mail_domain = _get_default_mail_domain()
1622
if not default_mail_domain:
526
1628
w = pwd.getpwuid(uid)
529
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
530
username = w.pw_name.decode(bzrlib.user_encoding)
531
except UnicodeDecodeError:
532
# We're using pwd, therefore we're on Unix, so /etc/passwd is ok.
533
raise errors.BzrError("Can't decode username in " \
534
"/etc/passwd as %s." % bzrlib.user_encoding)
536
comma = gecos.find(',')
540
realname = gecos[:comma]
547
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
548
except UnicodeDecodeError:
549
raise errors.BzrError("Can't decode username as %s." % \
550
bzrlib.user_encoding)
552
return realname, (username + '@' + socket.gethostname())
1630
trace.mutter('no passwd entry for uid %d?' % uid)
1633
# we try utf-8 first, because on many variants (like Linux),
1634
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1635
# false positives. (many users will have their user encoding set to
1636
# latin-1, which cannot raise UnicodeError.)
1638
gecos = w.pw_gecos.decode('utf-8')
1640
except UnicodeError:
1642
encoding = osutils.get_user_encoding()
1643
gecos = w.pw_gecos.decode(encoding)
1644
except UnicodeError, e:
1645
trace.mutter("cannot decode passwd entry %s" % w)
1648
username = w.pw_name.decode(encoding)
1649
except UnicodeError, e:
1650
trace.mutter("cannot decode passwd entry %s" % w)
1653
comma = gecos.find(',')
1657
realname = gecos[:comma]
1659
return realname, (username + '@' + default_mail_domain)
1662
def parse_username(username):
1663
"""Parse e-mail username and return a (name, address) tuple."""
1664
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1666
return (username, '')
1668
return (match.group(1), match.group(2))
555
1671
def extract_email_address(e):
556
1672
"""Return just the address part of an email string.
558
That is just the user@domain part, nothing else.
1674
That is just the user@domain part, nothing else.
559
1675
This part is required to contain only ascii characters.
560
1676
If it can't be extracted, raises an error.
562
1678
>>> extract_email_address('Jane Tester <jane@test.com>')
565
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
567
raise errors.BzrError("%r doesn't seem to contain "
568
"a reasonable email address" % e)
571
class TreeConfig(object):
1681
name, email = parse_username(e)
1683
raise errors.NoEmailInUsername(e)
1687
class TreeConfig(IniBasedConfig):
572
1688
"""Branch configuration data associated with its contents, not location"""
1690
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
573
1692
def __init__(self, branch):
1693
self._config = branch._get_config()
574
1694
self.branch = branch
576
def _get_config(self):
578
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
580
except errors.NoSuchFile:
581
obj = ConfigObj(encoding='utf=8')
1696
def _get_parser(self, file=None):
1697
if file is not None:
1698
return IniBasedConfig._get_parser(file)
1699
return self._config._get_configobj()
584
1701
def get_option(self, name, section=None, default=None):
585
1702
self.branch.lock_read()
587
obj = self._get_config()
589
if section is not None:
1704
return self._config.get_option(name, section, default)
595
1706
self.branch.unlock()
598
1708
def set_option(self, value, name, section=None):
599
1709
"""Set a per-branch configuration option"""
600
self.branch.lock_write()
602
cfg_obj = self._get_config()
607
obj = cfg_obj[section]
609
cfg_obj[section] = {}
610
obj = cfg_obj[section]
612
out_file = StringIO()
613
cfg_obj.write(out_file)
615
self.branch.control_files.put('branch.conf', out_file)
1710
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1711
# higher levels providing the right lock -- vila 20101004
1712
self.branch.lock_write()
1714
self._config.set_option(value, name, section)
1716
self.branch.unlock()
1718
def remove_option(self, option_name, section_name=None):
1719
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1720
# higher levels providing the right lock -- vila 20101004
1721
self.branch.lock_write()
1723
self._config.remove_option(option_name, section_name)
1725
self.branch.unlock()
1728
class AuthenticationConfig(object):
1729
"""The authentication configuration file based on a ini file.
1731
Implements the authentication.conf file described in
1732
doc/developers/authentication-ring.txt.
1735
def __init__(self, _file=None):
1736
self._config = None # The ConfigObj
1738
self._filename = authentication_config_filename()
1739
self._input = self._filename = authentication_config_filename()
1741
# Tests can provide a string as _file
1742
self._filename = None
1745
def _get_config(self):
1746
if self._config is not None:
1749
# FIXME: Should we validate something here ? Includes: empty
1750
# sections are useless, at least one of
1751
# user/password/password_encoding should be defined, etc.
1753
# Note: the encoding below declares that the file itself is utf-8
1754
# encoded, but the values in the ConfigObj are always Unicode.
1755
self._config = ConfigObj(self._input, encoding='utf-8')
1756
except configobj.ConfigObjError, e:
1757
raise errors.ParseConfigError(e.errors, e.config.filename)
1758
except UnicodeError:
1759
raise errors.ConfigContentError(self._filename)
1763
"""Save the config file, only tests should use it for now."""
1764
conf_dir = os.path.dirname(self._filename)
1765
ensure_config_dir_exists(conf_dir)
1766
f = file(self._filename, 'wb')
1768
self._get_config().write(f)
1772
def _set_option(self, section_name, option_name, value):
1773
"""Set an authentication configuration option"""
1774
conf = self._get_config()
1775
section = conf.get(section_name)
1778
section = conf[section]
1779
section[option_name] = value
1782
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1784
"""Returns the matching credentials from authentication.conf file.
1786
:param scheme: protocol
1788
:param host: the server address
1790
:param port: the associated port (optional)
1792
:param user: login (optional)
1794
:param path: the absolute path on the server (optional)
1796
:param realm: the http authentication realm (optional)
1798
:return: A dict containing the matching credentials or None.
1800
- name: the section name of the credentials in the
1801
authentication.conf file,
1802
- user: can't be different from the provided user if any,
1803
- scheme: the server protocol,
1804
- host: the server address,
1805
- port: the server port (can be None),
1806
- path: the absolute server path (can be None),
1807
- realm: the http specific authentication realm (can be None),
1808
- password: the decoded password, could be None if the credential
1809
defines only the user
1810
- verify_certificates: https specific, True if the server
1811
certificate should be verified, False otherwise.
1814
for auth_def_name, auth_def in self._get_config().items():
1815
if type(auth_def) is not configobj.Section:
1816
raise ValueError("%s defined outside a section" % auth_def_name)
1818
a_scheme, a_host, a_user, a_path = map(
1819
auth_def.get, ['scheme', 'host', 'user', 'path'])
1822
a_port = auth_def.as_int('port')
1826
raise ValueError("'port' not numeric in %s" % auth_def_name)
1828
a_verify_certificates = auth_def.as_bool('verify_certificates')
1830
a_verify_certificates = True
1833
"'verify_certificates' not boolean in %s" % auth_def_name)
1836
if a_scheme is not None and scheme != a_scheme:
1838
if a_host is not None:
1839
if not (host == a_host
1840
or (a_host.startswith('.') and host.endswith(a_host))):
1842
if a_port is not None and port != a_port:
1844
if (a_path is not None and path is not None
1845
and not path.startswith(a_path)):
1847
if (a_user is not None and user is not None
1848
and a_user != user):
1849
# Never contradict the caller about the user to be used
1854
# Prepare a credentials dictionary with additional keys
1855
# for the credential providers
1856
credentials = dict(name=auth_def_name,
1863
password=auth_def.get('password', None),
1864
verify_certificates=a_verify_certificates)
1865
# Decode the password in the credentials (or get one)
1866
self.decode_password(credentials,
1867
auth_def.get('password_encoding', None))
1868
if 'auth' in debug.debug_flags:
1869
trace.mutter("Using authentication section: %r", auth_def_name)
1872
if credentials is None:
1873
# No credentials were found in authentication.conf, try the fallback
1874
# credentials stores.
1875
credentials = credential_store_registry.get_fallback_credentials(
1876
scheme, host, port, user, path, realm)
1880
def set_credentials(self, name, host, user, scheme=None, password=None,
1881
port=None, path=None, verify_certificates=None,
1883
"""Set authentication credentials for a host.
1885
Any existing credentials with matching scheme, host, port and path
1886
will be deleted, regardless of name.
1888
:param name: An arbitrary name to describe this set of credentials.
1889
:param host: Name of the host that accepts these credentials.
1890
:param user: The username portion of these credentials.
1891
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1893
:param password: Password portion of these credentials.
1894
:param port: The IP port on the host that these credentials apply to.
1895
:param path: A filesystem path on the host that these credentials
1897
:param verify_certificates: On https, verify server certificates if
1899
:param realm: The http authentication realm (optional).
1901
values = {'host': host, 'user': user}
1902
if password is not None:
1903
values['password'] = password
1904
if scheme is not None:
1905
values['scheme'] = scheme
1906
if port is not None:
1907
values['port'] = '%d' % port
1908
if path is not None:
1909
values['path'] = path
1910
if verify_certificates is not None:
1911
values['verify_certificates'] = str(verify_certificates)
1912
if realm is not None:
1913
values['realm'] = realm
1914
config = self._get_config()
1916
for section, existing_values in config.items():
1917
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1918
if existing_values.get(key) != values.get(key):
1922
config.update({name: values})
1925
def get_user(self, scheme, host, port=None, realm=None, path=None,
1926
prompt=None, ask=False, default=None):
1927
"""Get a user from authentication file.
1929
:param scheme: protocol
1931
:param host: the server address
1933
:param port: the associated port (optional)
1935
:param realm: the realm sent by the server (optional)
1937
:param path: the absolute path on the server (optional)
1939
:param ask: Ask the user if there is no explicitly configured username
1942
:param default: The username returned if none is defined (optional).
1944
:return: The found user.
1946
credentials = self.get_credentials(scheme, host, port, user=None,
1947
path=path, realm=realm)
1948
if credentials is not None:
1949
user = credentials['user']
1955
# Create a default prompt suitable for most cases
1956
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1957
# Special handling for optional fields in the prompt
1958
if port is not None:
1959
prompt_host = '%s:%d' % (host, port)
1962
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1967
def get_password(self, scheme, host, user, port=None,
1968
realm=None, path=None, prompt=None):
1969
"""Get a password from authentication file or prompt the user for one.
1971
:param scheme: protocol
1973
:param host: the server address
1975
:param port: the associated port (optional)
1979
:param realm: the realm sent by the server (optional)
1981
:param path: the absolute path on the server (optional)
1983
:return: The found password or the one entered by the user.
1985
credentials = self.get_credentials(scheme, host, port, user, path,
1987
if credentials is not None:
1988
password = credentials['password']
1989
if password is not None and scheme is 'ssh':
1990
trace.warning('password ignored in section [%s],'
1991
' use an ssh agent instead'
1992
% credentials['name'])
1996
# Prompt user only if we could't find a password
1997
if password is None:
1999
# Create a default prompt suitable for most cases
2000
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2001
# Special handling for optional fields in the prompt
2002
if port is not None:
2003
prompt_host = '%s:%d' % (host, port)
2006
password = ui.ui_factory.get_password(prompt,
2007
host=prompt_host, user=user)
2010
def decode_password(self, credentials, encoding):
2012
cs = credential_store_registry.get_credential_store(encoding)
2014
raise ValueError('%r is not a known password_encoding' % encoding)
2015
credentials['password'] = cs.decode_password(credentials)
2019
class CredentialStoreRegistry(registry.Registry):
2020
"""A class that registers credential stores.
2022
A credential store provides access to credentials via the password_encoding
2023
field in authentication.conf sections.
2025
Except for stores provided by bzr itself, most stores are expected to be
2026
provided by plugins that will therefore use
2027
register_lazy(password_encoding, module_name, member_name, help=help,
2028
fallback=fallback) to install themselves.
2030
A fallback credential store is one that is queried if no credentials can be
2031
found via authentication.conf.
2034
def get_credential_store(self, encoding=None):
2035
cs = self.get(encoding)
2040
def is_fallback(self, name):
2041
"""Check if the named credentials store should be used as fallback."""
2042
return self.get_info(name)
2044
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2045
path=None, realm=None):
2046
"""Request credentials from all fallback credentials stores.
2048
The first credentials store that can provide credentials wins.
2051
for name in self.keys():
2052
if not self.is_fallback(name):
2054
cs = self.get_credential_store(name)
2055
credentials = cs.get_credentials(scheme, host, port, user,
2057
if credentials is not None:
2058
# We found some credentials
2062
def register(self, key, obj, help=None, override_existing=False,
2064
"""Register a new object to a name.
2066
:param key: This is the key to use to request the object later.
2067
:param obj: The object to register.
2068
:param help: Help text for this entry. This may be a string or
2069
a callable. If it is a callable, it should take two
2070
parameters (registry, key): this registry and the key that
2071
the help was registered under.
2072
:param override_existing: Raise KeyErorr if False and something has
2073
already been registered for that key. If True, ignore if there
2074
is an existing key (always register the new value).
2075
:param fallback: Whether this credential store should be
2078
return super(CredentialStoreRegistry,
2079
self).register(key, obj, help, info=fallback,
2080
override_existing=override_existing)
2082
def register_lazy(self, key, module_name, member_name,
2083
help=None, override_existing=False,
2085
"""Register a new credential store to be loaded on request.
2087
:param module_name: The python path to the module. Such as 'os.path'.
2088
:param member_name: The member of the module to return. If empty or
2089
None, get() will return the module itself.
2090
:param help: Help text for this entry. This may be a string or
2092
:param override_existing: If True, replace the existing object
2093
with the new one. If False, if there is already something
2094
registered with the same key, raise a KeyError
2095
:param fallback: Whether this credential store should be
2098
return super(CredentialStoreRegistry, self).register_lazy(
2099
key, module_name, member_name, help,
2100
info=fallback, override_existing=override_existing)
2103
credential_store_registry = CredentialStoreRegistry()
2106
class CredentialStore(object):
2107
"""An abstract class to implement storage for credentials"""
2109
def decode_password(self, credentials):
2110
"""Returns a clear text password for the provided credentials."""
2111
raise NotImplementedError(self.decode_password)
2113
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2115
"""Return the matching credentials from this credential store.
2117
This method is only called on fallback credential stores.
2119
raise NotImplementedError(self.get_credentials)
2123
class PlainTextCredentialStore(CredentialStore):
2124
__doc__ = """Plain text credential store for the authentication.conf file"""
2126
def decode_password(self, credentials):
2127
"""See CredentialStore.decode_password."""
2128
return credentials['password']
2131
credential_store_registry.register('plain', PlainTextCredentialStore,
2132
help=PlainTextCredentialStore.__doc__)
2133
credential_store_registry.default_key = 'plain'
2136
class Base64CredentialStore(CredentialStore):
2137
__doc__ = """Base64 credential store for the authentication.conf file"""
2139
def decode_password(self, credentials):
2140
"""See CredentialStore.decode_password."""
2141
# GZ 2012-07-28: Will raise binascii.Error if password is not base64,
2142
# should probably propogate as something more useful.
2143
return base64.decodestring(credentials['password'])
2145
credential_store_registry.register('base64', Base64CredentialStore,
2146
help=Base64CredentialStore.__doc__)
2149
class BzrDirConfig(object):
2151
def __init__(self, bzrdir):
2152
self._bzrdir = bzrdir
2153
self._config = bzrdir._get_config()
2155
def set_default_stack_on(self, value):
2156
"""Set the default stacking location.
2158
It may be set to a location, or None.
2160
This policy affects all branches contained by this control dir, except
2161
for those under repositories.
2163
if self._config is None:
2164
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2166
self._config.set_option('', 'default_stack_on')
2168
self._config.set_option(value, 'default_stack_on')
2170
def get_default_stack_on(self):
2171
"""Return the default stacking location.
2173
This will either be a location, or None.
2175
This policy affects all branches contained by this control dir, except
2176
for those under repositories.
2178
if self._config is None:
2180
value = self._config.get_option('default_stack_on')
2186
class TransportConfig(object):
2187
"""A Config that reads/writes a config file on a Transport.
2189
It is a low-level object that considers config data to be name/value pairs
2190
that may be associated with a section. Assigning meaning to these values
2191
is done at higher levels like TreeConfig.
2194
def __init__(self, transport, filename):
2195
self._transport = transport
2196
self._filename = filename
2198
def get_option(self, name, section=None, default=None):
2199
"""Return the value associated with a named option.
2201
:param name: The name of the value
2202
:param section: The section the option is in (if any)
2203
:param default: The value to return if the value is not set
2204
:return: The value or default value
2206
configobj = self._get_configobj()
2208
section_obj = configobj
2211
section_obj = configobj[section]
2214
value = section_obj.get(name, default)
2215
for hook in OldConfigHooks['get']:
2216
hook(self, name, value)
2219
def set_option(self, value, name, section=None):
2220
"""Set the value associated with a named option.
2222
:param value: The value to set
2223
:param name: The name of the value to set
2224
:param section: The section the option is in (if any)
2226
configobj = self._get_configobj()
2228
configobj[name] = value
2230
configobj.setdefault(section, {})[name] = value
2231
for hook in OldConfigHooks['set']:
2232
hook(self, name, value)
2233
self._set_configobj(configobj)
2235
def remove_option(self, option_name, section_name=None):
2236
configobj = self._get_configobj()
2237
if section_name is None:
2238
del configobj[option_name]
2240
del configobj[section_name][option_name]
2241
for hook in OldConfigHooks['remove']:
2242
hook(self, option_name)
2243
self._set_configobj(configobj)
2245
def _get_config_file(self):
2247
f = StringIO(self._transport.get_bytes(self._filename))
2248
for hook in OldConfigHooks['load']:
2251
except errors.NoSuchFile:
2253
except errors.PermissionDenied, e:
2254
trace.warning("Permission denied while trying to open "
2255
"configuration file %s.", urlutils.unescape_for_display(
2256
urlutils.join(self._transport.base, self._filename), "utf-8"))
2259
def _external_url(self):
2260
return urlutils.join(self._transport.external_url(), self._filename)
2262
def _get_configobj(self):
2263
f = self._get_config_file()
2266
conf = ConfigObj(f, encoding='utf-8')
2267
except configobj.ConfigObjError, e:
2268
raise errors.ParseConfigError(e.errors, self._external_url())
2269
except UnicodeDecodeError:
2270
raise errors.ConfigContentError(self._external_url())
2275
def _set_configobj(self, configobj):
2276
out_file = StringIO()
2277
configobj.write(out_file)
2279
self._transport.put_file(self._filename, out_file)
2280
for hook in OldConfigHooks['save']:
2284
class Option(object):
2285
"""An option definition.
2287
The option *values* are stored in config files and found in sections.
2289
Here we define various properties about the option itself, its default
2290
value, how to convert it from stores, what to do when invalid values are
2291
encoutered, in which config files it can be stored.
2294
def __init__(self, name, override_from_env=None,
2295
default=None, default_from_env=None,
2296
help=None, from_unicode=None, invalid=None, unquote=True):
2297
"""Build an option definition.
2299
:param name: the name used to refer to the option.
2301
:param override_from_env: A list of environment variables which can
2302
provide override any configuration setting.
2304
:param default: the default value to use when none exist in the config
2305
stores. This is either a string that ``from_unicode`` will convert
2306
into the proper type, a callable returning a unicode string so that
2307
``from_unicode`` can be used on the return value, or a python
2308
object that can be stringified (so only the empty list is supported
2311
:param default_from_env: A list of environment variables which can
2312
provide a default value. 'default' will be used only if none of the
2313
variables specified here are set in the environment.
2315
:param help: a doc string to explain the option to the user.
2317
:param from_unicode: a callable to convert the unicode string
2318
representing the option value in a store. This is not called for
2321
:param invalid: the action to be taken when an invalid value is
2322
encountered in a store. This is called only when from_unicode is
2323
invoked to convert a string and returns None or raise ValueError or
2324
TypeError. Accepted values are: None (ignore invalid values),
2325
'warning' (emit a warning), 'error' (emit an error message and
2328
:param unquote: should the unicode value be unquoted before conversion.
2329
This should be used only when the store providing the values cannot
2330
safely unquote them (see http://pad.lv/906897). It is provided so
2331
daughter classes can handle the quoting themselves.
2333
if override_from_env is None:
2334
override_from_env = []
2335
if default_from_env is None:
2336
default_from_env = []
2338
self.override_from_env = override_from_env
2339
# Convert the default value to a unicode string so all values are
2340
# strings internally before conversion (via from_unicode) is attempted.
2343
elif isinstance(default, list):
2344
# Only the empty list is supported
2346
raise AssertionError(
2347
'Only empty lists are supported as default values')
2349
elif isinstance(default, (str, unicode, bool, int, float)):
2350
# Rely on python to convert strings, booleans and integers
2351
self.default = u'%s' % (default,)
2352
elif callable(default):
2353
self.default = default
2355
# other python objects are not expected
2356
raise AssertionError('%r is not supported as a default value'
2358
self.default_from_env = default_from_env
2360
self.from_unicode = from_unicode
2361
self.unquote = unquote
2362
if invalid and invalid not in ('warning', 'error'):
2363
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2364
self.invalid = invalid
2370
def convert_from_unicode(self, store, unicode_value):
2371
if self.unquote and store is not None and unicode_value is not None:
2372
unicode_value = store.unquote(unicode_value)
2373
if self.from_unicode is None or unicode_value is None:
2374
# Don't convert or nothing to convert
2375
return unicode_value
2377
converted = self.from_unicode(unicode_value)
2378
except (ValueError, TypeError):
2379
# Invalid values are ignored
2381
if converted is None and self.invalid is not None:
2382
# The conversion failed
2383
if self.invalid == 'warning':
2384
trace.warning('Value "%s" is not valid for "%s"',
2385
unicode_value, self.name)
2386
elif self.invalid == 'error':
2387
raise errors.ConfigOptionValueError(self.name, unicode_value)
2390
def get_override(self):
2392
for var in self.override_from_env:
2394
# If the env variable is defined, its value takes precedence
2395
value = os.environ[var].decode(osutils.get_user_encoding())
2401
def get_default(self):
2403
for var in self.default_from_env:
2405
# If the env variable is defined, its value is the default one
2406
value = os.environ[var].decode(osutils.get_user_encoding())
2411
# Otherwise, fallback to the value defined at registration
2412
if callable(self.default):
2413
value = self.default()
2414
if not isinstance(value, unicode):
2415
raise AssertionError(
2416
"Callable default value for '%s' should be unicode"
2419
value = self.default
2422
def get_help_topic(self):
2425
def get_help_text(self, additional_see_also=None, plain=True):
2427
from bzrlib import help_topics
2428
result += help_topics._format_see_also(additional_see_also)
2430
result = help_topics.help_as_plain_text(result)
2434
# Predefined converters to get proper values from store
2436
def bool_from_store(unicode_str):
2437
return ui.bool_from_string(unicode_str)
2440
def int_from_store(unicode_str):
2441
return int(unicode_str)
2444
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2446
def int_SI_from_store(unicode_str):
2447
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2449
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2450
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2453
:return Integer, expanded to its base-10 value if a proper SI unit is
2454
found, None otherwise.
2456
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2457
p = re.compile(regexp, re.IGNORECASE)
2458
m = p.match(unicode_str)
2461
val, _, unit = m.groups()
2465
coeff = _unit_suffixes[unit.upper()]
2467
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2472
def float_from_store(unicode_str):
2473
return float(unicode_str)
2476
# Use a an empty dict to initialize an empty configobj avoiding all
2477
# parsing and encoding checks
2478
_list_converter_config = configobj.ConfigObj(
2479
{}, encoding='utf-8', list_values=True, interpolation=False)
2482
class ListOption(Option):
2484
def __init__(self, name, default=None, default_from_env=None,
2485
help=None, invalid=None):
2486
"""A list Option definition.
2488
This overrides the base class so the conversion from a unicode string
2489
can take quoting into account.
2491
super(ListOption, self).__init__(
2492
name, default=default, default_from_env=default_from_env,
2493
from_unicode=self.from_unicode, help=help,
2494
invalid=invalid, unquote=False)
2496
def from_unicode(self, unicode_str):
2497
if not isinstance(unicode_str, basestring):
2499
# Now inject our string directly as unicode. All callers got their
2500
# value from configobj, so values that need to be quoted are already
2502
_list_converter_config.reset()
2503
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2504
maybe_list = _list_converter_config['list']
2505
if isinstance(maybe_list, basestring):
2507
# A single value, most probably the user forgot (or didn't care
2508
# to add) the final ','
2511
# The empty string, convert to empty list
2514
# We rely on ConfigObj providing us with a list already
2519
class RegistryOption(Option):
2520
"""Option for a choice from a registry."""
2522
def __init__(self, name, registry, default_from_env=None,
2523
help=None, invalid=None):
2524
"""A registry based Option definition.
2526
This overrides the base class so the conversion from a unicode string
2527
can take quoting into account.
2529
super(RegistryOption, self).__init__(
2530
name, default=lambda: unicode(registry.default_key),
2531
default_from_env=default_from_env,
2532
from_unicode=self.from_unicode, help=help,
2533
invalid=invalid, unquote=False)
2534
self.registry = registry
2536
def from_unicode(self, unicode_str):
2537
if not isinstance(unicode_str, basestring):
2540
return self.registry.get(unicode_str)
2543
"Invalid value %s for %s."
2544
"See help for a list of possible values." % (unicode_str,
2549
ret = [self._help, "\n\nThe following values are supported:\n"]
2550
for key in self.registry.keys():
2551
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2555
class OptionRegistry(registry.Registry):
2556
"""Register config options by their name.
2558
This overrides ``registry.Registry`` to simplify registration by acquiring
2559
some information from the option object itself.
2562
def register(self, option):
2563
"""Register a new option to its name.
2565
:param option: The option to register. Its name is used as the key.
2567
super(OptionRegistry, self).register(option.name, option,
2570
def register_lazy(self, key, module_name, member_name):
2571
"""Register a new option to be loaded on request.
2573
:param key: the key to request the option later. Since the registration
2574
is lazy, it should be provided and match the option name.
2576
:param module_name: the python path to the module. Such as 'os.path'.
2578
:param member_name: the member of the module to return. If empty or
2579
None, get() will return the module itself.
2581
super(OptionRegistry, self).register_lazy(key,
2582
module_name, member_name)
2584
def get_help(self, key=None):
2585
"""Get the help text associated with the given key"""
2586
option = self.get(key)
2587
the_help = option.help
2588
if callable(the_help):
2589
return the_help(self, key)
2593
option_registry = OptionRegistry()
2596
# Registered options in lexicographical order
2598
option_registry.register(
2599
Option('append_revisions_only',
2600
default=None, from_unicode=bool_from_store, invalid='warning',
2602
Whether to only append revisions to the mainline.
2604
If this is set to true, then it is not possible to change the
2605
existing mainline of the branch.
2607
option_registry.register(
2608
ListOption('acceptable_keys',
2611
List of GPG key patterns which are acceptable for verification.
2613
option_registry.register(
2614
Option('add.maximum_file_size',
2615
default=u'20MB', from_unicode=int_SI_from_store,
2617
Size above which files should be added manually.
2619
Files below this size are added automatically when using ``bzr add`` without
2622
A negative value means disable the size check.
2624
option_registry.register(
2626
default=None, from_unicode=bool_from_store,
2628
Is the branch bound to ``bound_location``.
2630
If set to "True", the branch should act as a checkout, and push each commit to
2631
the bound_location. This option is normally set by ``bind``/``unbind``.
2633
See also: bound_location.
2635
option_registry.register(
2636
Option('bound_location',
2639
The location that commits should go to when acting as a checkout.
2641
This option is normally set by ``bind``.
2645
option_registry.register(
2646
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2648
Whether revisions associated with tags should be fetched.
2650
option_registry.register_lazy(
2651
'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
2652
option_registry.register(
2653
Option('bzr.workingtree.worth_saving_limit', default=10,
2654
from_unicode=int_from_store, invalid='warning',
2656
How many changes before saving the dirstate.
2658
-1 means that we will never rewrite the dirstate file for only
2659
stat-cache changes. Regardless of this setting, we will always rewrite
2660
the dirstate file if a file is added/removed/renamed/etc. This flag only
2661
affects the behavior of updating the dirstate file after we notice that
2662
a file has been touched.
2664
option_registry.register(
2665
Option('bugtracker', default=None,
2667
Default bug tracker to use.
2669
This bug tracker will be used for example when marking bugs
2670
as fixed using ``bzr commit --fixes``, if no explicit
2671
bug tracker was specified.
2673
option_registry.register(
2674
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2675
from_unicode=signature_policy_from_unicode,
2677
GPG checking policy.
2679
Possible values: require, ignore, check-available (default)
2681
this option will control whether bzr will require good gpg
2682
signatures, ignore them, or check them if they are
2685
option_registry.register(
2686
Option('child_submit_format',
2687
help='''The preferred format of submissions to this branch.'''))
2688
option_registry.register(
2689
Option('child_submit_to',
2690
help='''Where submissions to this branch are mailed to.'''))
2691
option_registry.register(
2692
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2693
from_unicode=signing_policy_from_unicode,
2697
Possible values: always, never, when-required (default)
2699
This option controls whether bzr will always create
2700
gpg signatures or not on commits.
2702
option_registry.register(
2703
Option('dirstate.fdatasync', default=True,
2704
from_unicode=bool_from_store,
2706
Flush dirstate changes onto physical disk?
2708
If true (default), working tree metadata changes are flushed through the
2709
OS buffers to physical disk. This is somewhat slower, but means data
2710
should not be lost if the machine crashes. See also repository.fdatasync.
2712
option_registry.register(
2713
ListOption('debug_flags', default=[],
2714
help='Debug flags to activate.'))
2715
option_registry.register(
2716
Option('default_format', default='2a',
2717
help='Format used when creating branches.'))
2718
option_registry.register(
2719
Option('dpush_strict', default=None,
2720
from_unicode=bool_from_store,
2722
The default value for ``dpush --strict``.
2724
If present, defines the ``--strict`` option default value for checking
2725
uncommitted changes before pushing into a different VCS without any
2726
custom bzr metadata.
2728
option_registry.register(
2730
help='The command called to launch an editor to enter a message.'))
2731
option_registry.register(
2732
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2733
help='The users identity'))
2734
option_registry.register(
2735
Option('gpg_signing_command',
2738
Program to use use for creating signatures.
2740
This should support at least the -u and --clearsign options.
2742
option_registry.register(
2743
Option('gpg_signing_key',
2746
GPG key to use for signing.
2748
This defaults to the first key associated with the users email.
2750
option_registry.register(
2751
Option('ignore_missing_extensions', default=False,
2752
from_unicode=bool_from_store,
2754
Control the missing extensions warning display.
2756
The warning will not be emitted if set to True.
2758
option_registry.register(
2760
help='Language to translate messages into.'))
2761
option_registry.register(
2762
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2764
Steal locks that appears to be dead.
2766
If set to True, bzr will check if a lock is supposed to be held by an
2767
active process from the same user on the same machine. If the user and
2768
machine match, but no process with the given PID is active, then bzr
2769
will automatically break the stale lock, and create a new lock for
2771
Otherwise, bzr will prompt as normal to break the lock.
2773
option_registry.register(
2774
Option('log_format', default='long',
2776
Log format to use when displaying revisions.
2778
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2779
may be provided by plugins.
2781
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2783
option_registry.register(
2784
Option('output_encoding',
2785
help= 'Unicode encoding for output'
2786
' (terminal encoding if not specified).'))
2787
option_registry.register(
2788
Option('parent_location',
2791
The location of the default branch for pull or merge.
2793
This option is normally set when creating a branch, the first ``pull`` or by
2794
``pull --remember``.
2796
option_registry.register(
2797
Option('post_commit', default=None,
2799
Post commit functions.
2801
An ordered list of python functions to call, separated by spaces.
2803
Each function takes branch, rev_id as parameters.
2805
option_registry.register(
2806
Option('public_branch',
2809
A publically-accessible version of this branch.
2811
This implies that the branch setting this option is not publically-accessible.
2812
Used and set by ``bzr send``.
2814
option_registry.register(
2815
Option('push_location',
2818
The location of the default branch for push.
2820
This option is normally set by the first ``push`` or ``push --remember``.
2822
option_registry.register(
2823
Option('push_strict', default=None,
2824
from_unicode=bool_from_store,
2826
The default value for ``push --strict``.
2828
If present, defines the ``--strict`` option default value for checking
2829
uncommitted changes before sending a merge directive.
2831
option_registry.register(
2832
Option('repository.fdatasync', default=True,
2833
from_unicode=bool_from_store,
2835
Flush repository changes onto physical disk?
2837
If true (default), repository changes are flushed through the OS buffers
2838
to physical disk. This is somewhat slower, but means data should not be
2839
lost if the machine crashes. See also dirstate.fdatasync.
2841
option_registry.register_lazy('smtp_server',
2842
'bzrlib.smtp_connection', 'smtp_server')
2843
option_registry.register_lazy('smtp_password',
2844
'bzrlib.smtp_connection', 'smtp_password')
2845
option_registry.register_lazy('smtp_username',
2846
'bzrlib.smtp_connection', 'smtp_username')
2847
option_registry.register(
2848
Option('selftest.timeout',
2850
from_unicode=int_from_store,
2851
help='Abort selftest if one test takes longer than this many seconds',
2854
option_registry.register(
2855
Option('send_strict', default=None,
2856
from_unicode=bool_from_store,
2858
The default value for ``send --strict``.
2860
If present, defines the ``--strict`` option default value for checking
2861
uncommitted changes before sending a bundle.
2864
option_registry.register(
2865
Option('serve.client_timeout',
2866
default=300.0, from_unicode=float_from_store,
2867
help="If we wait for a new request from a client for more than"
2868
" X seconds, consider the client idle, and hangup."))
2869
option_registry.register(
2870
Option('stacked_on_location',
2872
help="""The location where this branch is stacked on."""))
2873
option_registry.register(
2874
Option('submit_branch',
2877
The branch you intend to submit your current work to.
2879
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2880
by the ``submit:`` revision spec.
2882
option_registry.register(
2884
help='''Where submissions from this branch are mailed to.'''))
2885
option_registry.register(
2886
ListOption('suppress_warnings',
2888
help="List of warning classes to suppress."))
2889
option_registry.register(
2890
Option('validate_signatures_in_log', default=False,
2891
from_unicode=bool_from_store, invalid='warning',
2892
help='''Whether to validate signatures in bzr log.'''))
2893
option_registry.register_lazy('ssl.ca_certs',
2894
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2896
option_registry.register_lazy('ssl.cert_reqs',
2897
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2900
class Section(object):
2901
"""A section defines a dict of option name => value.
2903
This is merely a read-only dict which can add some knowledge about the
2904
options. It is *not* a python dict object though and doesn't try to mimic
2908
def __init__(self, section_id, options):
2909
self.id = section_id
2910
# We re-use the dict-like object received
2911
self.options = options
2913
def get(self, name, default=None, expand=True):
2914
return self.options.get(name, default)
2916
def iter_option_names(self):
2917
for k in self.options.iterkeys():
2921
# Mostly for debugging use
2922
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2925
_NewlyCreatedOption = object()
2926
"""Was the option created during the MutableSection lifetime"""
2927
_DeletedOption = object()
2928
"""Was the option deleted during the MutableSection lifetime"""
2931
class MutableSection(Section):
2932
"""A section allowing changes and keeping track of the original values."""
2934
def __init__(self, section_id, options):
2935
super(MutableSection, self).__init__(section_id, options)
2936
self.reset_changes()
2938
def set(self, name, value):
2939
if name not in self.options:
2940
# This is a new option
2941
self.orig[name] = _NewlyCreatedOption
2942
elif name not in self.orig:
2943
self.orig[name] = self.get(name, None)
2944
self.options[name] = value
2946
def remove(self, name):
2947
if name not in self.orig:
2948
self.orig[name] = self.get(name, None)
2949
del self.options[name]
2951
def reset_changes(self):
2954
def apply_changes(self, dirty, store):
2955
"""Apply option value changes.
2957
``self`` has been reloaded from the persistent storage. ``dirty``
2958
contains the changes made since the previous loading.
2960
:param dirty: the mutable section containing the changes.
2962
:param store: the store containing the section
2964
for k, expected in dirty.orig.iteritems():
2965
actual = dirty.get(k, _DeletedOption)
2966
reloaded = self.get(k, _NewlyCreatedOption)
2967
if actual is _DeletedOption:
2968
if k in self.options:
2972
# Report concurrent updates in an ad-hoc way. This should only
2973
# occurs when different processes try to update the same option
2974
# which is not supported (as in: the config framework is not meant
2975
# to be used as a sharing mechanism).
2976
if expected != reloaded:
2977
if actual is _DeletedOption:
2978
actual = '<DELETED>'
2979
if reloaded is _NewlyCreatedOption:
2980
reloaded = '<CREATED>'
2981
if expected is _NewlyCreatedOption:
2982
expected = '<CREATED>'
2983
# Someone changed the value since we get it from the persistent
2985
trace.warning(gettext(
2986
"Option {0} in section {1} of {2} was changed"
2987
" from {3} to {4}. The {5} value will be saved.".format(
2988
k, self.id, store.external_url(), expected,
2990
# No need to keep track of these changes
2991
self.reset_changes()
2994
class Store(object):
2995
"""Abstract interface to persistent storage for configuration options."""
2997
readonly_section_class = Section
2998
mutable_section_class = MutableSection
3001
# Which sections need to be saved (by section id). We use a dict here
3002
# so the dirty sections can be shared by multiple callers.
3003
self.dirty_sections = {}
3005
def is_loaded(self):
3006
"""Returns True if the Store has been loaded.
3008
This is used to implement lazy loading and ensure the persistent
3009
storage is queried only when needed.
3011
raise NotImplementedError(self.is_loaded)
3014
"""Loads the Store from persistent storage."""
3015
raise NotImplementedError(self.load)
3017
def _load_from_string(self, bytes):
3018
"""Create a store from a string in configobj syntax.
3020
:param bytes: A string representing the file content.
3022
raise NotImplementedError(self._load_from_string)
3025
"""Unloads the Store.
3027
This should make is_loaded() return False. This is used when the caller
3028
knows that the persistent storage has changed or may have change since
3031
raise NotImplementedError(self.unload)
3033
def quote(self, value):
3034
"""Quote a configuration option value for storing purposes.
3036
This allows Stacks to present values as they will be stored.
3040
def unquote(self, value):
3041
"""Unquote a configuration option value into unicode.
3043
The received value is quoted as stored.
3048
"""Saves the Store to persistent storage."""
3049
raise NotImplementedError(self.save)
3051
def _need_saving(self):
3052
for s in self.dirty_sections.values():
3054
# At least one dirty section contains a modification
3058
def apply_changes(self, dirty_sections):
3059
"""Apply changes from dirty sections while checking for coherency.
3061
The Store content is discarded and reloaded from persistent storage to
3062
acquire up-to-date values.
3064
Dirty sections are MutableSection which kept track of the value they
3065
are expected to update.
3067
# We need an up-to-date version from the persistent storage, unload the
3068
# store. The reload will occur when needed (triggered by the first
3069
# get_mutable_section() call below.
3071
# Apply the changes from the preserved dirty sections
3072
for section_id, dirty in dirty_sections.iteritems():
3073
clean = self.get_mutable_section(section_id)
3074
clean.apply_changes(dirty, self)
3075
# Everything is clean now
3076
self.dirty_sections = {}
3078
def save_changes(self):
3079
"""Saves the Store to persistent storage if changes occurred.
3081
Apply the changes recorded in the mutable sections to a store content
3082
refreshed from persistent storage.
3084
raise NotImplementedError(self.save_changes)
3086
def external_url(self):
3087
raise NotImplementedError(self.external_url)
3089
def get_sections(self):
3090
"""Returns an ordered iterable of existing sections.
3092
:returns: An iterable of (store, section).
3094
raise NotImplementedError(self.get_sections)
3096
def get_mutable_section(self, section_id=None):
3097
"""Returns the specified mutable section.
3099
:param section_id: The section identifier
3101
raise NotImplementedError(self.get_mutable_section)
3104
# Mostly for debugging use
3105
return "<config.%s(%s)>" % (self.__class__.__name__,
3106
self.external_url())
3109
class CommandLineStore(Store):
3110
"A store to carry command line overrides for the config options."""
3112
def __init__(self, opts=None):
3113
super(CommandLineStore, self).__init__()
3120
# The dict should be cleared but not replaced so it can be shared.
3121
self.options.clear()
3123
def _from_cmdline(self, overrides):
3124
# Reset before accepting new definitions
3126
for over in overrides:
3128
name, value = over.split('=', 1)
3130
raise errors.BzrCommandError(
3131
gettext("Invalid '%s', should be of the form 'name=value'")
3133
self.options[name] = value
3135
def external_url(self):
3136
# Not an url but it makes debugging easier and is never needed
3140
def get_sections(self):
3141
yield self, self.readonly_section_class(None, self.options)
3144
class IniFileStore(Store):
3145
"""A config Store using ConfigObj for storage.
3147
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3148
serialize/deserialize the config file.
3152
"""A config Store using ConfigObj for storage.
3154
super(IniFileStore, self).__init__()
3155
self._config_obj = None
3157
def is_loaded(self):
3158
return self._config_obj != None
3161
self._config_obj = None
3162
self.dirty_sections = {}
3164
def _load_content(self):
3165
"""Load the config file bytes.
3167
This should be provided by subclasses
3169
:return: Byte string
3171
raise NotImplementedError(self._load_content)
3173
def _save_content(self, content):
3174
"""Save the config file bytes.
3176
This should be provided by subclasses
3178
:param content: Config file bytes to write
3180
raise NotImplementedError(self._save_content)
3183
"""Load the store from the associated file."""
3184
if self.is_loaded():
3186
content = self._load_content()
3187
self._load_from_string(content)
3188
for hook in ConfigHooks['load']:
3191
def _load_from_string(self, bytes):
3192
"""Create a config store from a string.
3194
:param bytes: A string representing the file content.
3196
if self.is_loaded():
3197
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3198
co_input = StringIO(bytes)
3200
# The config files are always stored utf8-encoded
3201
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3203
except configobj.ConfigObjError, e:
3204
self._config_obj = None
3205
raise errors.ParseConfigError(e.errors, self.external_url())
3206
except UnicodeDecodeError:
3207
raise errors.ConfigContentError(self.external_url())
3209
def save_changes(self):
3210
if not self.is_loaded():
3213
if not self._need_saving():
3215
# Preserve the current version
3216
dirty_sections = dict(self.dirty_sections.items())
3217
self.apply_changes(dirty_sections)
3218
# Save to the persistent storage
3222
if not self.is_loaded():
3226
self._config_obj.write(out)
3227
self._save_content(out.getvalue())
3228
for hook in ConfigHooks['save']:
3231
def get_sections(self):
3232
"""Get the configobj section in the file order.
3234
:returns: An iterable of (store, section).
3236
# We need a loaded store
3239
except (errors.NoSuchFile, errors.PermissionDenied):
3240
# If the file can't be read, there is no sections
3242
cobj = self._config_obj
3244
yield self, self.readonly_section_class(None, cobj)
3245
for section_name in cobj.sections:
3247
self.readonly_section_class(section_name,
3248
cobj[section_name]))
3250
def get_mutable_section(self, section_id=None):
3251
# We need a loaded store
3254
except errors.NoSuchFile:
3255
# The file doesn't exist, let's pretend it was empty
3256
self._load_from_string('')
3257
if section_id in self.dirty_sections:
3258
# We already created a mutable section for this id
3259
return self.dirty_sections[section_id]
3260
if section_id is None:
3261
section = self._config_obj
3263
section = self._config_obj.setdefault(section_id, {})
3264
mutable_section = self.mutable_section_class(section_id, section)
3265
# All mutable sections can become dirty
3266
self.dirty_sections[section_id] = mutable_section
3267
return mutable_section
3269
def quote(self, value):
3271
# configobj conflates automagical list values and quoting
3272
self._config_obj.list_values = True
3273
return self._config_obj._quote(value)
3275
self._config_obj.list_values = False
3277
def unquote(self, value):
3278
if value and isinstance(value, basestring):
3279
# _unquote doesn't handle None nor empty strings nor anything that
3280
# is not a string, really.
3281
value = self._config_obj._unquote(value)
3284
def external_url(self):
3285
# Since an IniFileStore can be used without a file (at least in tests),
3286
# it's better to provide something than raising a NotImplementedError.
3287
# All daughter classes are supposed to provide an implementation
3289
return 'In-Process Store, no URL'
3291
class TransportIniFileStore(IniFileStore):
3292
"""IniFileStore that loads files from a transport.
3294
:ivar transport: The transport object where the config file is located.
3296
:ivar file_name: The config file basename in the transport directory.
3299
def __init__(self, transport, file_name):
3300
"""A Store using a ini file on a Transport
3302
:param transport: The transport object where the config file is located.
3303
:param file_name: The config file basename in the transport directory.
3305
super(TransportIniFileStore, self).__init__()
3306
self.transport = transport
3307
self.file_name = file_name
3309
def _load_content(self):
3311
return self.transport.get_bytes(self.file_name)
3312
except errors.PermissionDenied:
3313
trace.warning("Permission denied while trying to load "
3314
"configuration store %s.", self.external_url())
3317
def _save_content(self, content):
3318
self.transport.put_bytes(self.file_name, content)
3320
def external_url(self):
3321
# FIXME: external_url should really accepts an optional relpath
3322
# parameter (bug #750169) :-/ -- vila 2011-04-04
3323
# The following will do in the interim but maybe we don't want to
3324
# expose a path here but rather a config ID and its associated
3325
# object </hand wawe>.
3326
return urlutils.join(self.transport.external_url(), self.file_name)
3329
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3330
# unlockable stores for use with objects that can already ensure the locking
3331
# (think branches). If different stores (not based on ConfigObj) are created,
3332
# they may face the same issue.
3335
class LockableIniFileStore(TransportIniFileStore):
3336
"""A ConfigObjStore using locks on save to ensure store integrity."""
3338
def __init__(self, transport, file_name, lock_dir_name=None):
3339
"""A config Store using ConfigObj for storage.
3341
:param transport: The transport object where the config file is located.
3343
:param file_name: The config file basename in the transport directory.
3345
if lock_dir_name is None:
3346
lock_dir_name = 'lock'
3347
self.lock_dir_name = lock_dir_name
3348
super(LockableIniFileStore, self).__init__(transport, file_name)
3349
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3351
def lock_write(self, token=None):
3352
"""Takes a write lock in the directory containing the config file.
3354
If the directory doesn't exist it is created.
3356
# FIXME: This doesn't check the ownership of the created directories as
3357
# ensure_config_dir_exists does. It should if the transport is local
3358
# -- vila 2011-04-06
3359
self.transport.create_prefix()
3360
return self._lock.lock_write(token)
3365
def break_lock(self):
3366
self._lock.break_lock()
3370
# We need to be able to override the undecorated implementation
3371
self.save_without_locking()
3373
def save_without_locking(self):
3374
super(LockableIniFileStore, self).save()
3377
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3378
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3379
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3381
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3382
# functions or a registry will make it easier and clearer for tests, focusing
3383
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3384
# on a poolie's remark)
3385
class GlobalStore(LockableIniFileStore):
3387
def __init__(self, possible_transports=None):
3388
t = transport.get_transport_from_path(
3389
config_dir(), possible_transports=possible_transports)
3390
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3394
class LocationStore(LockableIniFileStore):
3396
def __init__(self, possible_transports=None):
3397
t = transport.get_transport_from_path(
3398
config_dir(), possible_transports=possible_transports)
3399
super(LocationStore, self).__init__(t, 'locations.conf')
3400
self.id = 'locations'
3403
class BranchStore(TransportIniFileStore):
3405
def __init__(self, branch):
3406
super(BranchStore, self).__init__(branch.control_transport,
3408
self.branch = branch
3412
class ControlStore(LockableIniFileStore):
3414
def __init__(self, bzrdir):
3415
super(ControlStore, self).__init__(bzrdir.transport,
3417
lock_dir_name='branch_lock')
3421
class SectionMatcher(object):
3422
"""Select sections into a given Store.
3424
This is intended to be used to postpone getting an iterable of sections
3428
def __init__(self, store):
3431
def get_sections(self):
3432
# This is where we require loading the store so we can see all defined
3434
sections = self.store.get_sections()
3435
# Walk the revisions in the order provided
3436
for store, s in sections:
3440
def match(self, section):
3441
"""Does the proposed section match.
3443
:param section: A Section object.
3445
:returns: True if the section matches, False otherwise.
3447
raise NotImplementedError(self.match)
3450
class NameMatcher(SectionMatcher):
3452
def __init__(self, store, section_id):
3453
super(NameMatcher, self).__init__(store)
3454
self.section_id = section_id
3456
def match(self, section):
3457
return section.id == self.section_id
3460
class LocationSection(Section):
3462
def __init__(self, section, extra_path, branch_name=None):
3463
super(LocationSection, self).__init__(section.id, section.options)
3464
self.extra_path = extra_path
3465
if branch_name is None:
3467
self.locals = {'relpath': extra_path,
3468
'basename': urlutils.basename(extra_path),
3469
'branchname': branch_name}
3471
def get(self, name, default=None, expand=True):
3472
value = super(LocationSection, self).get(name, default)
3473
if value is not None and expand:
3474
policy_name = self.get(name + ':policy', None)
3475
policy = _policy_value.get(policy_name, POLICY_NONE)
3476
if policy == POLICY_APPENDPATH:
3477
value = urlutils.join(value, self.extra_path)
3478
# expand section local options right now (since POLICY_APPENDPATH
3479
# will never add options references, it's ok to expand after it).
3481
for is_ref, chunk in iter_option_refs(value):
3483
chunks.append(chunk)
3486
if ref in self.locals:
3487
chunks.append(self.locals[ref])
3489
chunks.append(chunk)
3490
value = ''.join(chunks)
3494
class StartingPathMatcher(SectionMatcher):
3495
"""Select sections for a given location respecting the Store order."""
3497
# FIXME: Both local paths and urls can be used for section names as well as
3498
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3499
# inherited the fuzziness from the previous ``LocationConfig``
3500
# implementation. We probably need to revisit which encoding is allowed for
3501
# both ``location`` and section names and how we normalize
3502
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3503
# related too. -- vila 2012-01-04
3505
def __init__(self, store, location):
3506
super(StartingPathMatcher, self).__init__(store)
3507
if location.startswith('file://'):
3508
location = urlutils.local_path_from_url(location)
3509
self.location = location
3511
def get_sections(self):
3512
"""Get all sections matching ``location`` in the store.
3514
The most generic sections are described first in the store, then more
3515
specific ones can be provided for reduced scopes.
3517
The returned section are therefore returned in the reversed order so
3518
the most specific ones can be found first.
3520
location_parts = self.location.rstrip('/').split('/')
3523
# Later sections are more specific, they should be returned first
3524
for _, section in reversed(list(store.get_sections())):
3525
if section.id is None:
3526
# The no-name section is always included if present
3527
yield store, LocationSection(section, self.location)
3529
section_path = section.id
3530
if section_path.startswith('file://'):
3531
# the location is already a local path or URL, convert the
3532
# section id to the same format
3533
section_path = urlutils.local_path_from_url(section_path)
3534
if (self.location.startswith(section_path)
3535
or fnmatch.fnmatch(self.location, section_path)):
3536
section_parts = section_path.rstrip('/').split('/')
3537
extra_path = '/'.join(location_parts[len(section_parts):])
3538
yield store, LocationSection(section, extra_path)
3541
class LocationMatcher(SectionMatcher):
3543
def __init__(self, store, location):
3544
super(LocationMatcher, self).__init__(store)
3545
url, params = urlutils.split_segment_parameters(location)
3546
if location.startswith('file://'):
3547
location = urlutils.local_path_from_url(location)
3548
self.location = location
3549
branch_name = params.get('branch')
3550
if branch_name is None:
3551
self.branch_name = urlutils.basename(self.location)
3553
self.branch_name = urlutils.unescape(branch_name)
3555
def _get_matching_sections(self):
3556
"""Get all sections matching ``location``."""
3557
# We slightly diverge from LocalConfig here by allowing the no-name
3558
# section as the most generic one and the lower priority.
3559
no_name_section = None
3561
# Filter out the no_name_section so _iter_for_location_by_parts can be
3562
# used (it assumes all sections have a name).
3563
for _, section in self.store.get_sections():
3564
if section.id is None:
3565
no_name_section = section
3567
all_sections.append(section)
3568
# Unfortunately _iter_for_location_by_parts deals with section names so
3569
# we have to resync.
3570
filtered_sections = _iter_for_location_by_parts(
3571
[s.id for s in all_sections], self.location)
3572
iter_all_sections = iter(all_sections)
3573
matching_sections = []
3574
if no_name_section is not None:
3575
matching_sections.append(
3576
(0, LocationSection(no_name_section, self.location)))
3577
for section_id, extra_path, length in filtered_sections:
3578
# a section id is unique for a given store so it's safe to take the
3579
# first matching section while iterating. Also, all filtered
3580
# sections are part of 'all_sections' and will always be found
3583
section = iter_all_sections.next()
3584
if section_id == section.id:
3585
section = LocationSection(section, extra_path,
3587
matching_sections.append((length, section))
3589
return matching_sections
3591
def get_sections(self):
3592
# Override the default implementation as we want to change the order
3593
matching_sections = self._get_matching_sections()
3594
# We want the longest (aka more specific) locations first
3595
sections = sorted(matching_sections,
3596
key=lambda (length, section): (length, section.id),
3598
# Sections mentioning 'ignore_parents' restrict the selection
3599
for _, section in sections:
3600
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3601
ignore = section.get('ignore_parents', None)
3602
if ignore is not None:
3603
ignore = ui.bool_from_string(ignore)
3606
# Finally, we have a valid section
3607
yield self.store, section
3610
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3611
"""Describes an expandable option reference.
3613
We want to match the most embedded reference first.
3615
I.e. for '{{foo}}' we will get '{foo}',
3616
for '{bar{baz}}' we will get '{baz}'
3619
def iter_option_refs(string):
3620
# Split isolate refs so every other chunk is a ref
3622
for chunk in _option_ref_re.split(string):
3627
class Stack(object):
3628
"""A stack of configurations where an option can be defined"""
3630
def __init__(self, sections_def, store=None, mutable_section_id=None):
3631
"""Creates a stack of sections with an optional store for changes.
3633
:param sections_def: A list of Section or callables that returns an
3634
iterable of Section. This defines the Sections for the Stack and
3635
can be called repeatedly if needed.
3637
:param store: The optional Store where modifications will be
3638
recorded. If none is specified, no modifications can be done.
3640
:param mutable_section_id: The id of the MutableSection where changes
3641
are recorded. This requires the ``store`` parameter to be
3644
self.sections_def = sections_def
3646
self.mutable_section_id = mutable_section_id
3648
def iter_sections(self):
3649
"""Iterate all the defined sections."""
3650
# Ensuring lazy loading is achieved by delaying section matching (which
3651
# implies querying the persistent storage) until it can't be avoided
3652
# anymore by using callables to describe (possibly empty) section
3654
for sections in self.sections_def:
3655
for store, section in sections():
3656
yield store, section
3658
def get(self, name, expand=True, convert=True):
3659
"""Return the *first* option value found in the sections.
3661
This is where we guarantee that sections coming from Store are loaded
3662
lazily: the loading is delayed until we need to either check that an
3663
option exists or get its value, which in turn may require to discover
3664
in which sections it can be defined. Both of these (section and option
3665
existence) require loading the store (even partially).
3667
:param name: The queried option.
3669
:param expand: Whether options references should be expanded.
3671
:param convert: Whether the option value should be converted from
3672
unicode (do nothing for non-registered options).
3674
:returns: The value of the option.
3676
# FIXME: No caching of options nor sections yet -- vila 20110503
3678
found_store = None # Where the option value has been found
3679
# If the option is registered, it may provide additional info about
3682
opt = option_registry.get(name)
3687
def expand_and_convert(val):
3688
# This may need to be called in different contexts if the value is
3689
# None or ends up being None during expansion or conversion.
3692
if isinstance(val, basestring):
3693
val = self._expand_options_in_string(val)
3695
trace.warning('Cannot expand "%s":'
3696
' %s does not support option expansion'
3697
% (name, type(val)))
3699
val = found_store.unquote(val)
3701
val = opt.convert_from_unicode(found_store, val)
3704
# First of all, check if the environment can override the configuration
3706
if opt is not None and opt.override_from_env:
3707
value = opt.get_override()
3708
value = expand_and_convert(value)
3710
for store, section in self.iter_sections():
3711
value = section.get(name)
3712
if value is not None:
3715
value = expand_and_convert(value)
3716
if opt is not None and value is None:
3717
# If the option is registered, it may provide a default value
3718
value = opt.get_default()
3719
value = expand_and_convert(value)
3720
for hook in ConfigHooks['get']:
3721
hook(self, name, value)
3724
def expand_options(self, string, env=None):
3725
"""Expand option references in the string in the configuration context.
3727
:param string: The string containing option(s) to expand.
3729
:param env: An option dict defining additional configuration options or
3730
overriding existing ones.
3732
:returns: The expanded string.
3734
return self._expand_options_in_string(string, env)
3736
def _expand_options_in_string(self, string, env=None, _refs=None):
3737
"""Expand options in the string in the configuration context.
3739
:param string: The string to be expanded.
3741
:param env: An option dict defining additional configuration options or
3742
overriding existing ones.
3744
:param _refs: Private list (FIFO) containing the options being expanded
3747
:returns: The expanded string.
3750
# Not much to expand there
3753
# What references are currently resolved (to detect loops)
3756
# We need to iterate until no more refs appear ({{foo}} will need two
3757
# iterations for example).
3762
for is_ref, chunk in iter_option_refs(result):
3764
chunks.append(chunk)
3769
raise errors.OptionExpansionLoop(string, _refs)
3771
value = self._expand_option(name, env, _refs)
3773
raise errors.ExpandingUnknownOption(name, string)
3774
chunks.append(value)
3776
result = ''.join(chunks)
3779
def _expand_option(self, name, env, _refs):
3780
if env is not None and name in env:
3781
# Special case, values provided in env takes precedence over
3785
value = self.get(name, expand=False, convert=False)
3786
value = self._expand_options_in_string(value, env, _refs)
3789
def _get_mutable_section(self):
3790
"""Get the MutableSection for the Stack.
3792
This is where we guarantee that the mutable section is lazily loaded:
3793
this means we won't load the corresponding store before setting a value
3794
or deleting an option. In practice the store will often be loaded but
3795
this helps catching some programming errors.
3798
section = store.get_mutable_section(self.mutable_section_id)
3799
return store, section
3801
def set(self, name, value):
3802
"""Set a new value for the option."""
3803
store, section = self._get_mutable_section()
3804
section.set(name, store.quote(value))
3805
for hook in ConfigHooks['set']:
3806
hook(self, name, value)
3808
def remove(self, name):
3809
"""Remove an existing option."""
3810
_, section = self._get_mutable_section()
3811
section.remove(name)
3812
for hook in ConfigHooks['remove']:
3816
# Mostly for debugging use
3817
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3819
def _get_overrides(self):
3820
# Hack around library_state.initialize never called
3821
if bzrlib.global_state is not None:
3822
return bzrlib.global_state.cmdline_overrides.get_sections()
3826
class MemoryStack(Stack):
3827
"""A configuration stack defined from a string.
3829
This is mainly intended for tests and requires no disk resources.
3832
def __init__(self, content=None):
3833
"""Create an in-memory stack from a given content.
3835
It uses a single store based on configobj and support reading and
3838
:param content: The initial content of the store. If None, the store is
3839
not loaded and ``_load_from_string`` can and should be used if
3842
store = IniFileStore()
3843
if content is not None:
3844
store._load_from_string(content)
3845
super(MemoryStack, self).__init__(
3846
[store.get_sections], store)
3849
class _CompatibleStack(Stack):
3850
"""Place holder for compatibility with previous design.
3852
This is intended to ease the transition from the Config-based design to the
3853
Stack-based design and should not be used nor relied upon by plugins.
3855
One assumption made here is that the daughter classes will all use Stores
3856
derived from LockableIniFileStore).
3858
It implements set() and remove () by re-loading the store before applying
3859
the modification and saving it.
3861
The long term plan being to implement a single write by store to save
3862
all modifications, this class should not be used in the interim.
3865
def set(self, name, value):
3868
super(_CompatibleStack, self).set(name, value)
3869
# Force a write to persistent storage
3872
def remove(self, name):
3875
super(_CompatibleStack, self).remove(name)
3876
# Force a write to persistent storage
3880
class GlobalStack(_CompatibleStack):
3881
"""Global options only stack.
3883
The following sections are queried:
3885
* command-line overrides,
3887
* the 'DEFAULT' section in bazaar.conf
3889
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3894
gstore = GlobalStore()
3895
super(GlobalStack, self).__init__(
3896
[self._get_overrides,
3897
NameMatcher(gstore, 'DEFAULT').get_sections],
3898
gstore, mutable_section_id='DEFAULT')
3901
class LocationStack(_CompatibleStack):
3902
"""Per-location options falling back to global options stack.
3905
The following sections are queried:
3907
* command-line overrides,
3909
* the sections matching ``location`` in ``locations.conf``, the order being
3910
defined by the number of path components in the section glob, higher
3911
numbers first (from most specific section to most generic).
3913
* the 'DEFAULT' section in bazaar.conf
3915
This stack will use the ``location`` section in locations.conf as its
3919
def __init__(self, location):
3920
"""Make a new stack for a location and global configuration.
3922
:param location: A URL prefix to """
3923
lstore = LocationStore()
3924
if location.startswith('file://'):
3925
location = urlutils.local_path_from_url(location)
3926
gstore = GlobalStore()
3927
super(LocationStack, self).__init__(
3928
[self._get_overrides,
3929
LocationMatcher(lstore, location).get_sections,
3930
NameMatcher(gstore, 'DEFAULT').get_sections],
3931
lstore, mutable_section_id=location)
3934
class BranchStack(Stack):
3935
"""Per-location options falling back to branch then global options stack.
3937
The following sections are queried:
3939
* command-line overrides,
3941
* the sections matching ``location`` in ``locations.conf``, the order being
3942
defined by the number of path components in the section glob, higher
3943
numbers first (from most specific section to most generic),
3945
* the no-name section in branch.conf,
3947
* the ``DEFAULT`` section in ``bazaar.conf``.
3949
This stack will use the no-name section in ``branch.conf`` as its
3953
def __init__(self, branch):
3954
lstore = LocationStore()
3955
bstore = branch._get_config_store()
3956
gstore = GlobalStore()
3957
super(BranchStack, self).__init__(
3958
[self._get_overrides,
3959
LocationMatcher(lstore, branch.base).get_sections,
3960
NameMatcher(bstore, None).get_sections,
3961
NameMatcher(gstore, 'DEFAULT').get_sections],
3963
self.branch = branch
3965
def lock_write(self, token=None):
3966
return self.branch.lock_write(token)
3969
return self.branch.unlock()
3972
def set(self, name, value):
3973
super(BranchStack, self).set(name, value)
3974
# Unlocking the branch will trigger a store.save_changes() so the last
3975
# unlock saves all the changes.
3978
def remove(self, name):
3979
super(BranchStack, self).remove(name)
3980
# Unlocking the branch will trigger a store.save_changes() so the last
3981
# unlock saves all the changes.
3984
class RemoteControlStack(_CompatibleStack):
3985
"""Remote control-only options stack."""
3987
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3988
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3989
# control.conf and is used only for stack options.
3991
def __init__(self, bzrdir):
3992
cstore = bzrdir._get_config_store()
3993
super(RemoteControlStack, self).__init__(
3994
[NameMatcher(cstore, None).get_sections],
3996
self.bzrdir = bzrdir
3999
class BranchOnlyStack(Stack):
4000
"""Branch-only options stack."""
4002
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
4003
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
4004
# -- vila 2011-12-16
4006
def __init__(self, branch):
4007
bstore = branch._get_config_store()
4008
super(BranchOnlyStack, self).__init__(
4009
[NameMatcher(bstore, None).get_sections],
4011
self.branch = branch
4013
def lock_write(self, token=None):
4014
return self.branch.lock_write(token)
4017
return self.branch.unlock()
4020
def set(self, name, value):
4021
super(BranchOnlyStack, self).set(name, value)
4022
# Force a write to persistent storage
4023
self.store.save_changes()
4026
def remove(self, name):
4027
super(BranchOnlyStack, self).remove(name)
4028
# Force a write to persistent storage
4029
self.store.save_changes()
4032
class cmd_config(commands.Command):
4033
__doc__ = """Display, set or remove a configuration option.
4035
Display the active value for a given option.
4037
If --all is specified, NAME is interpreted as a regular expression and all
4038
matching options are displayed mentioning their scope. The active value
4039
that bzr will take into account is the first one displayed for each option.
4041
If no NAME is given, --all .* is implied.
4043
Setting a value is achieved by using name=value without spaces. The value
4044
is set in the most relevant scope and can be checked by displaying the
4048
takes_args = ['name?']
4052
# FIXME: This should be a registry option so that plugins can register
4053
# their own config files (or not) and will also address
4054
# http://pad.lv/788991 -- vila 20101115
4055
commands.Option('scope', help='Reduce the scope to the specified'
4056
' configuration file.',
4058
commands.Option('all',
4059
help='Display all the defined values for the matching options.',
4061
commands.Option('remove', help='Remove the option from'
4062
' the configuration file.'),
4065
_see_also = ['configuration']
4067
@commands.display_command
4068
def run(self, name=None, all=False, directory=None, scope=None,
4070
if directory is None:
4072
directory = directory_service.directories.dereference(directory)
4073
directory = urlutils.normalize_url(directory)
4075
raise errors.BzrError(
4076
'--all and --remove are mutually exclusive.')
4078
# Delete the option in the given scope
4079
self._remove_config_option(name, directory, scope)
4081
# Defaults to all options
4082
self._show_matching_options('.*', directory, scope)
4085
name, value = name.split('=', 1)
4087
# Display the option(s) value(s)
4089
self._show_matching_options(name, directory, scope)
4091
self._show_value(name, directory, scope)
4094
raise errors.BzrError(
4095
'Only one option can be set.')
4096
# Set the option value
4097
self._set_config_option(name, value, directory, scope)
4099
def _get_stack(self, directory, scope=None, write_access=False):
4100
"""Get the configuration stack specified by ``directory`` and ``scope``.
4102
:param directory: Where the configurations are derived from.
4104
:param scope: A specific config to start from.
4106
:param write_access: Whether a write access to the stack will be
4109
# FIXME: scope should allow access to plugin-specific stacks (even
4110
# reduced to the plugin-specific store), related to
4111
# http://pad.lv/788991 -- vila 2011-11-15
4112
if scope is not None:
4113
if scope == 'bazaar':
4114
return GlobalStack()
4115
elif scope == 'locations':
4116
return LocationStack(directory)
4117
elif scope == 'branch':
4119
controldir.ControlDir.open_containing_tree_or_branch(
4122
self.add_cleanup(br.lock_write().unlock)
4123
return br.get_config_stack()
4124
raise errors.NoSuchConfig(scope)
4128
controldir.ControlDir.open_containing_tree_or_branch(
4131
self.add_cleanup(br.lock_write().unlock)
4132
return br.get_config_stack()
4133
except errors.NotBranchError:
4134
return LocationStack(directory)
4136
def _quote_multiline(self, value):
4138
value = '"""' + value + '"""'
4141
def _show_value(self, name, directory, scope):
4142
conf = self._get_stack(directory, scope)
4143
value = conf.get(name, expand=True, convert=False)
4144
if value is not None:
4145
# Quote the value appropriately
4146
value = self._quote_multiline(value)
4147
self.outf.write('%s\n' % (value,))
4149
raise errors.NoSuchConfigOption(name)
4151
def _show_matching_options(self, name, directory, scope):
4152
name = lazy_regex.lazy_compile(name)
4153
# We want any error in the regexp to be raised *now* so we need to
4154
# avoid the delay introduced by the lazy regexp. But, we still do
4155
# want the nicer errors raised by lazy_regex.
4156
name._compile_and_collapse()
4159
conf = self._get_stack(directory, scope)
4160
for store, section in conf.iter_sections():
4161
for oname in section.iter_option_names():
4162
if name.search(oname):
4163
if cur_store_id != store.id:
4164
# Explain where the options are defined
4165
self.outf.write('%s:\n' % (store.id,))
4166
cur_store_id = store.id
4168
if (section.id is not None and cur_section != section.id):
4169
# Display the section id as it appears in the store
4170
# (None doesn't appear by definition)
4171
self.outf.write(' [%s]\n' % (section.id,))
4172
cur_section = section.id
4173
value = section.get(oname, expand=False)
4174
# Quote the value appropriately
4175
value = self._quote_multiline(value)
4176
self.outf.write(' %s = %s\n' % (oname, value))
4178
def _set_config_option(self, name, value, directory, scope):
4179
conf = self._get_stack(directory, scope, write_access=True)
4180
conf.set(name, value)
4182
def _remove_config_option(self, name, directory, scope):
4184
raise errors.BzrCommandError(
4185
'--remove expects an option to remove.')
4186
conf = self._get_stack(directory, scope, write_access=True)
4190
raise errors.NoSuchConfigOption(name)
4195
# We need adapters that can build a Store or a Stack in a test context. Test
4196
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4197
# themselves. The builder will receive a test instance and should return a
4198
# ready-to-use store or stack. Plugins that define new store/stacks can also
4199
# register themselves here to be tested against the tests defined in
4200
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4201
# for the same test.
4203
# The registered object should be a callable receiving a test instance
4204
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4206
test_store_builder_registry = registry.Registry()
4208
# The registered object should be a callable receiving a test instance
4209
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4211
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
