147
146
class Config(object):
148
147
"""A configuration policy - what username, editor, gpg needs etc."""
151
super(Config, self).__init__()
153
149
def get_editor(self):
154
150
"""Get the users pop up editor."""
155
151
raise NotImplementedError
157
def get_change_editor(self, old_tree, new_tree):
158
from bzrlib import diff
159
cmd = self._get_change_editor()
162
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
166
153
def get_mail_client(self):
167
154
"""Get a mail client to use"""
168
155
selected_client = self.get_user_option('mail_client')
187
174
"""Get a generic option - no special process, no default."""
188
175
return self._get_user_option(option_name)
190
def get_user_option_as_bool(self, option_name):
191
"""Get a generic option as a boolean - no special process, no default.
193
:return None if the option doesn't exist or its value can't be
194
interpreted as a boolean. Returns True or False otherwise.
196
s = self._get_user_option(option_name)
198
# The option doesn't exist
200
val = ui.bool_from_string(s)
202
# The value can't be interpreted as a boolean
203
trace.warning('Value "%s" is not a boolean for "%s"',
207
def get_user_option_as_list(self, option_name):
208
"""Get a generic option as a list - no special process, no default.
210
:return None if the option doesn't exist. Returns the value as a list
213
l = self._get_user_option(option_name)
214
if isinstance(l, (str, unicode)):
215
# A single value, most probably the user forgot the final ','
219
177
def gpg_signing_command(self):
220
178
"""What program should be used to sign signatures?"""
221
179
result = self._gpg_signing_command()
259
220
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
261
$BZR_EMAIL can be set to override this, then
222
$BZR_EMAIL can be set to override this (as well as the
223
deprecated $BZREMAIL), then
262
224
the concrete policy type is checked, and finally
263
225
$EMAIL is examined.
264
If no username can be found, errors.NoWhoami exception is raised.
226
If none is found, a reasonable default is (hopefully)
266
229
TODO: Check it's reasonably well-formed.
278
241
return v.decode(osutils.get_user_encoding())
280
raise errors.NoWhoami()
282
def ensure_username(self):
283
"""Raise errors.NoWhoami if username is not set.
285
This method relies on the username() function raising the error.
243
name, email = _auto_user_id()
245
return '%s <%s>' % (name, email)
289
249
def signature_checking(self):
290
250
"""What is the current policy for signature checking?."""
338
def suppress_warning(self, warning):
339
"""Should the warning be suppressed or emitted.
341
:param warning: The name of the warning being tested.
343
:returns: True if the warning should be suppressed, False otherwise.
345
warnings = self.get_user_option_as_list('suppress_warnings')
346
if warnings is None or warning not in warnings:
352
299
class IniBasedConfig(Config):
353
300
"""A configuration policy that draws from ini files."""
355
def __init__(self, get_filename):
356
super(IniBasedConfig, self).__init__()
357
self._get_filename = get_filename
360
302
def _get_parser(self, file=None):
361
303
if self._parser is not None:
362
304
return self._parser
874
812
return osutils.pathjoin(config_dir(), 'ignore')
878
"""Return the directory name to store crash files.
880
This doesn't implicitly create it.
882
On Windows it's in the config directory; elsewhere it's /var/crash
883
which may be monitored by apport. It can be overridden by
816
"""Calculate automatic user identification.
818
Returns (realname, email).
820
Only used when none is set in the environment or the id file.
822
This previously used the FQDN as the default domain, but that can
823
be very slow on machines where DNS is broken. So now we simply
886
828
if sys.platform == 'win32':
887
return osutils.pathjoin(config_dir(), 'Crash')
889
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
891
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
895
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
896
# Possibly this should be different on Windows?
897
e = os.environ.get('XDG_CACHE_DIR', None)
901
return os.path.expanduser('~/.cache')
829
name = win32utils.get_user_name_unicode()
831
raise errors.BzrError("Cannot autodetect user name.\n"
832
"Please, set your name with command like:\n"
833
'bzr whoami "Your Name <name@domain.com>"')
834
host = win32utils.get_host_name_unicode()
836
host = socket.gethostname()
837
return name, (name + '@' + host)
843
w = pwd.getpwuid(uid)
845
raise errors.BzrCommandError('Unable to determine your name. '
846
'Please use "bzr whoami" to set it.')
848
# we try utf-8 first, because on many variants (like Linux),
849
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
850
# false positives. (many users will have their user encoding set to
851
# latin-1, which cannot raise UnicodeError.)
853
gecos = w.pw_gecos.decode('utf-8')
857
encoding = osutils.get_user_encoding()
858
gecos = w.pw_gecos.decode(encoding)
860
raise errors.BzrCommandError('Unable to determine your name. '
861
'Use "bzr whoami" to set it.')
863
username = w.pw_name.decode(encoding)
865
raise errors.BzrCommandError('Unable to determine your name. '
866
'Use "bzr whoami" to set it.')
868
comma = gecos.find(',')
872
realname = gecos[:comma]
879
user_encoding = osutils.get_user_encoding()
880
realname = username = getpass.getuser().decode(user_encoding)
881
except UnicodeDecodeError:
882
raise errors.BzrError("Can't decode username as %s." % \
885
return realname, (username + '@' + socket.gethostname())
904
888
def parse_username(username):
992
977
"""Save the config file, only tests should use it for now."""
993
978
conf_dir = os.path.dirname(self._filename)
994
979
ensure_config_dir_exists(conf_dir)
995
f = file(self._filename, 'wb')
997
self._get_config().write(f)
980
self._get_config().write(file(self._filename, 'wb'))
1001
982
def _set_option(self, section_name, option_name, value):
1002
983
"""Set an authentication configuration option"""
1098
1079
trace.mutter("Using authentication section: %r", auth_def_name)
1101
if credentials is None:
1102
# No credentials were found in authentication.conf, try the fallback
1103
# credentials stores.
1104
credentials = credential_store_registry.get_fallback_credentials(
1105
scheme, host, port, user, path, realm)
1107
1082
return credentials
1109
1084
def set_credentials(self, name, host, user, scheme=None, password=None,
1151
1126
config.update({name: values})
1154
def get_user(self, scheme, host, port=None, realm=None, path=None,
1155
prompt=None, ask=False, default=None):
1129
def get_user(self, scheme, host, port=None,
1130
realm=None, path=None, prompt=None):
1156
1131
"""Get a user from authentication file.
1158
1133
:param scheme: protocol
1178
1148
user = credentials['user']
1184
# Create a default prompt suitable for most cases
1185
prompt = scheme.upper() + ' %(host)s username'
1186
# Special handling for optional fields in the prompt
1187
if port is not None:
1188
prompt_host = '%s:%d' % (host, port)
1191
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1196
1153
def get_password(self, scheme, host, user, port=None,
1251
1208
A credential store provides access to credentials via the password_encoding
1252
1209
field in authentication.conf sections.
1254
Except for stores provided by bzr itself, most stores are expected to be
1211
Except for stores provided by bzr itself,most stores are expected to be
1255
1212
provided by plugins that will therefore use
1256
1213
register_lazy(password_encoding, module_name, member_name, help=help,
1257
fallback=fallback) to install themselves.
1259
A fallback credential store is one that is queried if no credentials can be
1260
found via authentication.conf.
1214
info=info) to install themselves.
1263
1217
def get_credential_store(self, encoding=None):
1269
def is_fallback(self, name):
1270
"""Check if the named credentials store should be used as fallback."""
1271
return self.get_info(name)
1273
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1274
path=None, realm=None):
1275
"""Request credentials from all fallback credentials stores.
1277
The first credentials store that can provide credentials wins.
1280
for name in self.keys():
1281
if not self.is_fallback(name):
1283
cs = self.get_credential_store(name)
1284
credentials = cs.get_credentials(scheme, host, port, user,
1286
if credentials is not None:
1287
# We found some credentials
1291
def register(self, key, obj, help=None, override_existing=False,
1293
"""Register a new object to a name.
1295
:param key: This is the key to use to request the object later.
1296
:param obj: The object to register.
1297
:param help: Help text for this entry. This may be a string or
1298
a callable. If it is a callable, it should take two
1299
parameters (registry, key): this registry and the key that
1300
the help was registered under.
1301
:param override_existing: Raise KeyErorr if False and something has
1302
already been registered for that key. If True, ignore if there
1303
is an existing key (always register the new value).
1304
:param fallback: Whether this credential store should be
1307
return super(CredentialStoreRegistry,
1308
self).register(key, obj, help, info=fallback,
1309
override_existing=override_existing)
1311
def register_lazy(self, key, module_name, member_name,
1312
help=None, override_existing=False,
1314
"""Register a new credential store to be loaded on request.
1316
:param module_name: The python path to the module. Such as 'os.path'.
1317
:param member_name: The member of the module to return. If empty or
1318
None, get() will return the module itself.
1319
:param help: Help text for this entry. This may be a string or
1321
:param override_existing: If True, replace the existing object
1322
with the new one. If False, if there is already something
1323
registered with the same key, raise a KeyError
1324
:param fallback: Whether this credential store should be
1327
return super(CredentialStoreRegistry, self).register_lazy(
1328
key, module_name, member_name, help,
1329
info=fallback, override_existing=override_existing)
1332
1224
credential_store_registry = CredentialStoreRegistry()
1336
1228
"""An abstract class to implement storage for credentials"""
1338
1230
def decode_password(self, credentials):
1339
"""Returns a clear text password for the provided credentials."""
1231
"""Returns a password for the provided credentials in clear text."""
1340
1232
raise NotImplementedError(self.decode_password)
1342
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1344
"""Return the matching credentials from this credential store.
1346
This method is only called on fallback credential stores.
1348
raise NotImplementedError(self.get_credentials)
1352
1235
class PlainTextCredentialStore(CredentialStore):
1353
__doc__ = """Plain text credential store for the authentication.conf file"""
1236
"""Plain text credential store for the authentication.conf file."""
1355
1238
def decode_password(self, credentials):
1356
1239
"""See CredentialStore.decode_password."""
1365
1248
class BzrDirConfig(object):
1367
def __init__(self, bzrdir):
1368
self._bzrdir = bzrdir
1369
self._config = bzrdir._get_config()
1250
def __init__(self, transport):
1251
self._config = TransportConfig(transport, 'control.conf')
1371
1253
def set_default_stack_on(self, value):
1372
1254
"""Set the default stacking location.
1443
1321
configobj.setdefault(section, {})[name] = value
1444
1322
self._set_configobj(configobj)
1446
def _get_config_file(self):
1324
def _get_configobj(self):
1448
return StringIO(self._transport.get_bytes(self._filename))
1326
return ConfigObj(self._transport.get(self._filename),
1449
1328
except errors.NoSuchFile:
1452
def _get_configobj(self):
1453
f = self._get_config_file()
1455
return ConfigObj(f, encoding='utf-8')
1329
return ConfigObj(encoding='utf-8')
1459
1331
def _set_configobj(self, configobj):
1460
1332
out_file = StringIO()
added
removed
bzrlib/config.py
