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)
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]
146
140
class Config(object):
147
141
"""A configuration policy - what username, editor, gpg needs etc."""
150
super(Config, self).__init__()
152
143
def get_editor(self):
153
144
"""Get the users pop up editor."""
154
145
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,
165
147
def get_mail_client(self):
166
148
"""Get a mail client to use"""
167
149
selected_client = self.get_user_option('mail_client')
168
_registry = mail_client.mail_client_registry
170
mail_client_class = _registry.get(selected_client)
151
mail_client_class = {
152
None: mail_client.DefaultMail,
154
'emacsclient': mail_client.EmacsMail,
155
'evolution': mail_client.Evolution,
156
'kmail': mail_client.KMail,
157
'mutt': mail_client.Mutt,
158
'thunderbird': mail_client.Thunderbird,
160
'default': mail_client.DefaultMail,
161
'editor': mail_client.Editor,
162
'mapi': mail_client.MAPIClient,
163
'xdg-email': mail_client.XDGEmail,
172
166
raise errors.UnknownMailClient(selected_client)
173
167
return mail_client_class(self)
186
180
"""Get a generic option - no special process, no default."""
187
181
return self._get_user_option(option_name)
189
def get_user_option_as_bool(self, option_name):
190
"""Get a generic option as a boolean - no special process, no default.
192
:return None if the option doesn't exist or its value can't be
193
interpreted as a boolean. Returns True or False otherwise.
195
s = self._get_user_option(option_name)
197
# The option doesn't exist
199
val = ui.bool_from_string(s)
201
# The value can't be interpreted as a boolean
202
trace.warning('Value "%s" is not a boolean for "%s"',
206
def get_user_option_as_list(self, option_name):
207
"""Get a generic option as a list - no special process, no default.
209
:return None if the option doesn't exist. Returns the value as a list
212
l = self._get_user_option(option_name)
213
if isinstance(l, (str, unicode)):
214
# A single value, most probably the user forgot the final ','
218
183
def gpg_signing_command(self):
219
184
"""What program should be used to sign signatures?"""
220
185
result = self._gpg_signing_command()
490
441
def set_user_option(self, option, value):
491
442
"""Save option and its value in the configuration."""
492
self._set_option(option, value, 'DEFAULT')
494
def get_aliases(self):
495
"""Return the aliases section."""
496
if 'ALIASES' in self._get_parser():
497
return self._get_parser()['ALIASES']
501
def set_alias(self, alias_name, alias_command):
502
"""Save the alias in the configuration."""
503
self._set_option(alias_name, alias_command, 'ALIASES')
505
def unset_alias(self, alias_name):
506
"""Unset an existing alias."""
507
aliases = self._get_parser().get('ALIASES')
508
if not aliases or alias_name not in aliases:
509
raise errors.NoSuchAlias(alias_name)
510
del aliases[alias_name]
511
self._write_config_file()
513
def _set_option(self, option, value, section):
514
443
# FIXME: RBC 20051029 This should refresh the parser and also take a
515
444
# file lock on bazaar.conf.
516
445
conf_dir = os.path.dirname(self._get_filename())
517
446
ensure_config_dir_exists(conf_dir)
518
self._get_parser().setdefault(section, {})[option] = value
519
self._write_config_file()
521
def _write_config_file(self):
522
path = self._get_filename()
524
osutils.copy_ownership_from_path(path)
447
if 'DEFAULT' not in self._get_parser():
448
self._get_parser()['DEFAULT'] = {}
449
self._get_parser()['DEFAULT'][option] = value
450
f = open(self._get_filename(), 'wb')
525
451
self._get_parser().write(f)
873
795
return osutils.pathjoin(config_dir(), 'ignore')
877
"""Return the directory name to store crash files.
879
This doesn't implicitly create it.
881
On Windows it's in the config directory; elsewhere it's /var/crash
882
which may be monitored by apport. It can be overridden by
799
"""Calculate automatic user identification.
801
Returns (realname, email).
803
Only used when none is set in the environment or the id file.
805
This previously used the FQDN as the default domain, but that can
806
be very slow on machines where DNS is broken. So now we simply
885
811
if sys.platform == 'win32':
886
return osutils.pathjoin(config_dir(), 'Crash')
888
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
890
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
894
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
895
# Possibly this should be different on Windows?
896
e = os.environ.get('XDG_CACHE_DIR', None)
900
return os.path.expanduser('~/.cache')
812
name = win32utils.get_user_name_unicode()
814
raise errors.BzrError("Cannot autodetect user name.\n"
815
"Please, set your name with command like:\n"
816
'bzr whoami "Your Name <name@domain.com>"')
817
host = win32utils.get_host_name_unicode()
819
host = socket.gethostname()
820
return name, (name + '@' + host)
825
w = pwd.getpwuid(uid)
827
# we try utf-8 first, because on many variants (like Linux),
828
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
829
# false positives. (many users will have their user encoding set to
830
# latin-1, which cannot raise UnicodeError.)
832
gecos = w.pw_gecos.decode('utf-8')
836
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
837
encoding = bzrlib.user_encoding
839
raise errors.BzrCommandError('Unable to determine your name. '
840
'Use "bzr whoami" to set it.')
842
username = w.pw_name.decode(encoding)
844
raise errors.BzrCommandError('Unable to determine your name. '
845
'Use "bzr whoami" to set it.')
847
comma = gecos.find(',')
851
realname = gecos[:comma]
858
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
859
except UnicodeDecodeError:
860
raise errors.BzrError("Can't decode username as %s." % \
861
bzrlib.user_encoding)
863
return realname, (username + '@' + socket.gethostname())
903
866
def parse_username(username):
1075
1027
if a_user is None:
1076
1028
# Can't find a user
1078
# Prepare a credentials dictionary with additional keys
1079
# for the credential providers
1080
1030
credentials = dict(name=auth_def_name,
1087
password=auth_def.get('password', None),
1031
user=a_user, password=auth_def['password'],
1088
1032
verify_certificates=a_verify_certificates)
1089
# Decode the password in the credentials (or get one)
1090
1033
self.decode_password(credentials,
1091
1034
auth_def.get('password_encoding', None))
1092
1035
if 'auth' in debug.debug_flags:
1093
1036
trace.mutter("Using authentication section: %r", auth_def_name)
1096
if credentials is None:
1097
# No credentials were found in authentication.conf, try the fallback
1098
# credentials stores.
1099
credentials = credential_store_registry.get_fallback_credentials(
1100
scheme, host, port, user, path, realm)
1102
1039
return credentials
1104
def set_credentials(self, name, host, user, scheme=None, password=None,
1105
port=None, path=None, verify_certificates=None,
1107
"""Set authentication credentials for a host.
1109
Any existing credentials with matching scheme, host, port and path
1110
will be deleted, regardless of name.
1112
:param name: An arbitrary name to describe this set of credentials.
1113
:param host: Name of the host that accepts these credentials.
1114
:param user: The username portion of these credentials.
1115
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1117
:param password: Password portion of these credentials.
1118
:param port: The IP port on the host that these credentials apply to.
1119
:param path: A filesystem path on the host that these credentials
1121
:param verify_certificates: On https, verify server certificates if
1123
:param realm: The http authentication realm (optional).
1125
values = {'host': host, 'user': user}
1126
if password is not None:
1127
values['password'] = password
1128
if scheme is not None:
1129
values['scheme'] = scheme
1130
if port is not None:
1131
values['port'] = '%d' % port
1132
if path is not None:
1133
values['path'] = path
1134
if verify_certificates is not None:
1135
values['verify_certificates'] = str(verify_certificates)
1136
if realm is not None:
1137
values['realm'] = realm
1138
config = self._get_config()
1140
for section, existing_values in config.items():
1141
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1142
if existing_values.get(key) != values.get(key):
1146
config.update({name: values})
1149
def get_user(self, scheme, host, port=None, realm=None, path=None,
1150
prompt=None, ask=False, default=None):
1041
def get_user(self, scheme, host, port=None,
1042
realm=None, path=None, prompt=None):
1151
1043
"""Get a user from authentication file.
1153
1045
:param scheme: protocol
1232
1100
return password
1234
1102
def decode_password(self, credentials, encoding):
1236
cs = credential_store_registry.get_credential_store(encoding)
1238
raise ValueError('%r is not a known password_encoding' % encoding)
1239
credentials['password'] = cs.decode_password(credentials)
1243
class CredentialStoreRegistry(registry.Registry):
1244
"""A class that registers credential stores.
1246
A credential store provides access to credentials via the password_encoding
1247
field in authentication.conf sections.
1249
Except for stores provided by bzr itself, most stores are expected to be
1250
provided by plugins that will therefore use
1251
register_lazy(password_encoding, module_name, member_name, help=help,
1252
fallback=fallback) to install themselves.
1254
A fallback credential store is one that is queried if no credentials can be
1255
found via authentication.conf.
1258
def get_credential_store(self, encoding=None):
1259
cs = self.get(encoding)
1264
def is_fallback(self, name):
1265
"""Check if the named credentials store should be used as fallback."""
1266
return self.get_info(name)
1268
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1269
path=None, realm=None):
1270
"""Request credentials from all fallback credentials stores.
1272
The first credentials store that can provide credentials wins.
1275
for name in self.keys():
1276
if not self.is_fallback(name):
1278
cs = self.get_credential_store(name)
1279
credentials = cs.get_credentials(scheme, host, port, user,
1281
if credentials is not None:
1282
# We found some credentials
1286
def register(self, key, obj, help=None, override_existing=False,
1288
"""Register a new object to a name.
1290
:param key: This is the key to use to request the object later.
1291
:param obj: The object to register.
1292
:param help: Help text for this entry. This may be a string or
1293
a callable. If it is a callable, it should take two
1294
parameters (registry, key): this registry and the key that
1295
the help was registered under.
1296
:param override_existing: Raise KeyErorr if False and something has
1297
already been registered for that key. If True, ignore if there
1298
is an existing key (always register the new value).
1299
:param fallback: Whether this credential store should be
1302
return super(CredentialStoreRegistry,
1303
self).register(key, obj, help, info=fallback,
1304
override_existing=override_existing)
1306
def register_lazy(self, key, module_name, member_name,
1307
help=None, override_existing=False,
1309
"""Register a new credential store to be loaded on request.
1311
:param module_name: The python path to the module. Such as 'os.path'.
1312
:param member_name: The member of the module to return. If empty or
1313
None, get() will return the module itself.
1314
:param help: Help text for this entry. This may be a string or
1316
:param override_existing: If True, replace the existing object
1317
with the new one. If False, if there is already something
1318
registered with the same key, raise a KeyError
1319
:param fallback: Whether this credential store should be
1322
return super(CredentialStoreRegistry, self).register_lazy(
1323
key, module_name, member_name, help,
1324
info=fallback, override_existing=override_existing)
1327
credential_store_registry = CredentialStoreRegistry()
1330
class CredentialStore(object):
1331
"""An abstract class to implement storage for credentials"""
1333
def decode_password(self, credentials):
1334
"""Returns a clear text password for the provided credentials."""
1335
raise NotImplementedError(self.decode_password)
1337
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1339
"""Return the matching credentials from this credential store.
1341
This method is only called on fallback credential stores.
1343
raise NotImplementedError(self.get_credentials)
1347
class PlainTextCredentialStore(CredentialStore):
1348
__doc__ = """Plain text credential store for the authentication.conf file"""
1350
def decode_password(self, credentials):
1351
"""See CredentialStore.decode_password."""
1352
return credentials['password']
1355
credential_store_registry.register('plain', PlainTextCredentialStore,
1356
help=PlainTextCredentialStore.__doc__)
1357
credential_store_registry.default_key = 'plain'
1360
class BzrDirConfig(object):
1362
def __init__(self, bzrdir):
1363
self._bzrdir = bzrdir
1364
self._config = bzrdir._get_config()
1366
def set_default_stack_on(self, value):
1367
"""Set the default stacking location.
1369
It may be set to a location, or None.
1371
This policy affects all branches contained by this bzrdir, except for
1372
those under repositories.
1374
if self._config is None:
1375
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1377
self._config.set_option('', 'default_stack_on')
1379
self._config.set_option(value, 'default_stack_on')
1381
def get_default_stack_on(self):
1382
"""Return the default stacking location.
1384
This will either be a location, or None.
1386
This policy affects all branches contained by this bzrdir, except for
1387
those under repositories.
1389
if self._config is None:
1391
value = self._config.get_option('default_stack_on')
1397
1106
class TransportConfig(object):
added
removed
bzrlib/config.py
