125
class ConfigObj(configobj.ConfigObj):
127
def get_bool(self, section, key):
128
return self[section].as_bool(key)
130
def get_value(self, section, name):
131
# Try [] for the old DEFAULT section.
132
if section == "DEFAULT":
137
return self[section][name]
126
def ConfigObj(*args, **kwargs):
128
if _ConfigObj is None:
129
class ConfigObj(configobj.ConfigObj):
131
def get_bool(self, section, key):
132
return self[section].as_bool(key)
134
def get_value(self, section, name):
135
# Try [] for the old DEFAULT section.
136
if section == "DEFAULT":
141
return self[section][name]
142
_ConfigObj = ConfigObj
143
return _ConfigObj(*args, **kwargs)
140
146
class Config(object):
141
147
"""A configuration policy - what username, editor, gpg needs etc."""
150
super(Config, self).__init__()
143
152
def get_editor(self):
144
153
"""Get the users pop up editor."""
145
154
raise NotImplementedError
156
def get_change_editor(self, old_tree, new_tree):
157
from bzrlib import diff
158
cmd = self._get_change_editor()
161
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
147
165
def get_mail_client(self):
148
166
"""Get a mail client to use"""
149
167
selected_client = self.get_user_option('mail_client')
168
_registry = mail_client.mail_client_registry
151
mail_client_class = {
152
None: mail_client.DefaultMail,
154
'evolution': mail_client.Evolution,
155
'kmail': mail_client.KMail,
156
'mutt': mail_client.Mutt,
157
'thunderbird': mail_client.Thunderbird,
159
'default': mail_client.DefaultMail,
160
'editor': mail_client.Editor,
161
'mapi': mail_client.MAPIClient,
162
'xdg-email': mail_client.XDGEmail,
170
mail_client_class = _registry.get(selected_client)
165
172
raise errors.UnknownMailClient(selected_client)
166
173
return mail_client_class(self)
440
481
def set_user_option(self, option, value):
441
482
"""Save option and its value in the configuration."""
483
self._set_option(option, value, 'DEFAULT')
485
def get_aliases(self):
486
"""Return the aliases section."""
487
if 'ALIASES' in self._get_parser():
488
return self._get_parser()['ALIASES']
492
def set_alias(self, alias_name, alias_command):
493
"""Save the alias in the configuration."""
494
self._set_option(alias_name, alias_command, 'ALIASES')
496
def unset_alias(self, alias_name):
497
"""Unset an existing alias."""
498
aliases = self._get_parser().get('ALIASES')
499
if not aliases or alias_name not in aliases:
500
raise errors.NoSuchAlias(alias_name)
501
del aliases[alias_name]
502
self._write_config_file()
504
def _set_option(self, option, value, section):
442
505
# FIXME: RBC 20051029 This should refresh the parser and also take a
443
506
# file lock on bazaar.conf.
444
507
conf_dir = os.path.dirname(self._get_filename())
445
508
ensure_config_dir_exists(conf_dir)
446
if 'DEFAULT' not in self._get_parser():
447
self._get_parser()['DEFAULT'] = {}
448
self._get_parser()['DEFAULT'][option] = value
449
f = open(self._get_filename(), 'wb')
509
self._get_parser().setdefault(section, {})[option] = value
510
self._write_config_file()
512
def _write_config_file(self):
513
path = self._get_filename()
514
f = osutils.open_with_ownership(path, 'wb')
450
515
self._get_parser().write(f)
1051
1137
if a_user is None:
1052
1138
# Can't find a user
1140
# Prepare a credentials dictionary with additional keys
1141
# for the credential providers
1054
1142
credentials = dict(name=auth_def_name,
1055
user=a_user, password=auth_def['password'],
1149
password=auth_def.get('password', None),
1056
1150
verify_certificates=a_verify_certificates)
1151
# Decode the password in the credentials (or get one)
1057
1152
self.decode_password(credentials,
1058
1153
auth_def.get('password_encoding', None))
1059
1154
if 'auth' in debug.debug_flags:
1060
1155
trace.mutter("Using authentication section: %r", auth_def_name)
1158
if credentials is None:
1159
# No credentials were found in authentication.conf, try the fallback
1160
# credentials stores.
1161
credentials = credential_store_registry.get_fallback_credentials(
1162
scheme, host, port, user, path, realm)
1063
1164
return credentials
1065
def get_user(self, scheme, host, port=None,
1066
realm=None, path=None, prompt=None):
1166
def set_credentials(self, name, host, user, scheme=None, password=None,
1167
port=None, path=None, verify_certificates=None,
1169
"""Set authentication credentials for a host.
1171
Any existing credentials with matching scheme, host, port and path
1172
will be deleted, regardless of name.
1174
:param name: An arbitrary name to describe this set of credentials.
1175
:param host: Name of the host that accepts these credentials.
1176
:param user: The username portion of these credentials.
1177
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1179
:param password: Password portion of these credentials.
1180
:param port: The IP port on the host that these credentials apply to.
1181
:param path: A filesystem path on the host that these credentials
1183
:param verify_certificates: On https, verify server certificates if
1185
:param realm: The http authentication realm (optional).
1187
values = {'host': host, 'user': user}
1188
if password is not None:
1189
values['password'] = password
1190
if scheme is not None:
1191
values['scheme'] = scheme
1192
if port is not None:
1193
values['port'] = '%d' % port
1194
if path is not None:
1195
values['path'] = path
1196
if verify_certificates is not None:
1197
values['verify_certificates'] = str(verify_certificates)
1198
if realm is not None:
1199
values['realm'] = realm
1200
config = self._get_config()
1202
for section, existing_values in config.items():
1203
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1204
if existing_values.get(key) != values.get(key):
1208
config.update({name: values})
1211
def get_user(self, scheme, host, port=None, realm=None, path=None,
1212
prompt=None, ask=False, default=None):
1067
1213
"""Get a user from authentication file.
1069
1215
:param scheme: protocol
1124
1294
return password
1126
1296
def decode_password(self, credentials, encoding):
1298
cs = credential_store_registry.get_credential_store(encoding)
1300
raise ValueError('%r is not a known password_encoding' % encoding)
1301
credentials['password'] = cs.decode_password(credentials)
1305
class CredentialStoreRegistry(registry.Registry):
1306
"""A class that registers credential stores.
1308
A credential store provides access to credentials via the password_encoding
1309
field in authentication.conf sections.
1311
Except for stores provided by bzr itself, most stores are expected to be
1312
provided by plugins that will therefore use
1313
register_lazy(password_encoding, module_name, member_name, help=help,
1314
fallback=fallback) to install themselves.
1316
A fallback credential store is one that is queried if no credentials can be
1317
found via authentication.conf.
1320
def get_credential_store(self, encoding=None):
1321
cs = self.get(encoding)
1326
def is_fallback(self, name):
1327
"""Check if the named credentials store should be used as fallback."""
1328
return self.get_info(name)
1330
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1331
path=None, realm=None):
1332
"""Request credentials from all fallback credentials stores.
1334
The first credentials store that can provide credentials wins.
1337
for name in self.keys():
1338
if not self.is_fallback(name):
1340
cs = self.get_credential_store(name)
1341
credentials = cs.get_credentials(scheme, host, port, user,
1343
if credentials is not None:
1344
# We found some credentials
1348
def register(self, key, obj, help=None, override_existing=False,
1350
"""Register a new object to a name.
1352
:param key: This is the key to use to request the object later.
1353
:param obj: The object to register.
1354
:param help: Help text for this entry. This may be a string or
1355
a callable. If it is a callable, it should take two
1356
parameters (registry, key): this registry and the key that
1357
the help was registered under.
1358
:param override_existing: Raise KeyErorr if False and something has
1359
already been registered for that key. If True, ignore if there
1360
is an existing key (always register the new value).
1361
:param fallback: Whether this credential store should be
1364
return super(CredentialStoreRegistry,
1365
self).register(key, obj, help, info=fallback,
1366
override_existing=override_existing)
1368
def register_lazy(self, key, module_name, member_name,
1369
help=None, override_existing=False,
1371
"""Register a new credential store to be loaded on request.
1373
:param module_name: The python path to the module. Such as 'os.path'.
1374
:param member_name: The member of the module to return. If empty or
1375
None, get() will return the module itself.
1376
:param help: Help text for this entry. This may be a string or
1378
:param override_existing: If True, replace the existing object
1379
with the new one. If False, if there is already something
1380
registered with the same key, raise a KeyError
1381
:param fallback: Whether this credential store should be
1384
return super(CredentialStoreRegistry, self).register_lazy(
1385
key, module_name, member_name, help,
1386
info=fallback, override_existing=override_existing)
1389
credential_store_registry = CredentialStoreRegistry()
1392
class CredentialStore(object):
1393
"""An abstract class to implement storage for credentials"""
1395
def decode_password(self, credentials):
1396
"""Returns a clear text password for the provided credentials."""
1397
raise NotImplementedError(self.decode_password)
1399
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1401
"""Return the matching credentials from this credential store.
1403
This method is only called on fallback credential stores.
1405
raise NotImplementedError(self.get_credentials)
1409
class PlainTextCredentialStore(CredentialStore):
1410
"""Plain text credential store for the authentication.conf file."""
1412
def decode_password(self, credentials):
1413
"""See CredentialStore.decode_password."""
1414
return credentials['password']
1417
credential_store_registry.register('plain', PlainTextCredentialStore,
1418
help=PlainTextCredentialStore.__doc__)
1419
credential_store_registry.default_key = 'plain'
1422
class BzrDirConfig(object):
1424
def __init__(self, bzrdir):
1425
self._bzrdir = bzrdir
1426
self._config = bzrdir._get_config()
1428
def set_default_stack_on(self, value):
1429
"""Set the default stacking location.
1431
It may be set to a location, or None.
1433
This policy affects all branches contained by this bzrdir, except for
1434
those under repositories.
1436
if self._config is None:
1437
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1439
self._config.set_option('', 'default_stack_on')
1441
self._config.set_option(value, 'default_stack_on')
1443
def get_default_stack_on(self):
1444
"""Return the default stacking location.
1446
This will either be a location, or None.
1448
This policy affects all branches contained by this bzrdir, except for
1449
those under repositories.
1451
if self._config is None:
1453
value = self._config.get_option('default_stack_on')
1459
class TransportConfig(object):
1460
"""A Config that reads/writes a config file on a Transport.
1462
It is a low-level object that considers config data to be name/value pairs
1463
that may be associated with a section. Assigning meaning to the these
1464
values is done at higher levels like TreeConfig.
1467
def __init__(self, transport, filename):
1468
self._transport = transport
1469
self._filename = filename
1471
def get_option(self, name, section=None, default=None):
1472
"""Return the value associated with a named option.
1474
:param name: The name of the value
1475
:param section: The section the option is in (if any)
1476
:param default: The value to return if the value is not set
1477
:return: The value or default value
1479
configobj = self._get_configobj()
1481
section_obj = configobj
1484
section_obj = configobj[section]
1487
return section_obj.get(name, default)
1489
def set_option(self, value, name, section=None):
1490
"""Set the value associated with a named option.
1492
:param value: The value to set
1493
:param name: The name of the value to set
1494
:param section: The section the option is in (if any)
1496
configobj = self._get_configobj()
1498
configobj[name] = value
1500
configobj.setdefault(section, {})[name] = value
1501
self._set_configobj(configobj)
1503
def _get_config_file(self):
1505
return StringIO(self._transport.get_bytes(self._filename))
1506
except errors.NoSuchFile:
1509
def _get_configobj(self):
1510
return ConfigObj(self._get_config_file(), encoding='utf-8')
1512
def _set_configobj(self, configobj):
1513
out_file = StringIO()
1514
configobj.write(out_file)
1516
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
