146
146
class Config(object):
147
147
"""A configuration policy - what username, editor, gpg needs etc."""
150
super(Config, self).__init__()
152
149
def get_editor(self):
153
150
"""Get the users pop up editor."""
154
151
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
153
def get_mail_client(self):
166
154
"""Get a mail client to use"""
167
155
selected_client = self.get_user_option('mail_client')
186
174
"""Get a generic option - no special process, no default."""
187
175
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
177
def gpg_signing_command(self):
219
178
"""What program should be used to sign signatures?"""
220
179
result = self._gpg_signing_command()
258
220
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
260
$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
261
224
the concrete policy type is checked, and finally
262
225
$EMAIL is examined.
263
If no username can be found, errors.NoWhoami exception is raised.
226
If none is found, a reasonable default is (hopefully)
265
229
TODO: Check it's reasonably well-formed.
277
241
return v.decode(osutils.get_user_encoding())
279
raise errors.NoWhoami()
281
def ensure_username(self):
282
"""Raise errors.NoWhoami if username is not set.
284
This method relies on the username() function raising the error.
243
name, email = _auto_user_id()
245
return '%s <%s>' % (name, email)
288
249
def signature_checking(self):
289
250
"""What is the current policy for signature checking?."""
337
def suppress_warning(self, warning):
338
"""Should the warning be suppressed or emitted.
340
:param warning: The name of the warning being tested.
342
:returns: True if the warning should be suppressed, False otherwise.
344
warnings = self.get_user_option_as_list('suppress_warnings')
345
if warnings is None or warning not in warnings:
351
299
class IniBasedConfig(Config):
352
300
"""A configuration policy that draws from ini files."""
354
def __init__(self, get_filename):
355
super(IniBasedConfig, self).__init__()
356
self._get_filename = get_filename
359
302
def _get_parser(self, file=None):
360
303
if self._parser is not None:
361
304
return self._parser
873
813
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
817
"""Calculate automatic user identification.
819
Returns (realname, email).
821
Only used when none is set in the environment or the id file.
823
This previously used the FQDN as the default domain, but that can
824
be very slow on machines where DNS is broken. So now we simply
885
829
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')
830
name = win32utils.get_user_name_unicode()
832
raise errors.BzrError("Cannot autodetect user name.\n"
833
"Please, set your name with command like:\n"
834
'bzr whoami "Your Name <name@domain.com>"')
835
host = win32utils.get_host_name_unicode()
837
host = socket.gethostname()
838
return name, (name + '@' + host)
844
w = pwd.getpwuid(uid)
846
raise errors.BzrCommandError('Unable to determine your name. '
847
'Please use "bzr whoami" to set it.')
849
# we try utf-8 first, because on many variants (like Linux),
850
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
851
# false positives. (many users will have their user encoding set to
852
# latin-1, which cannot raise UnicodeError.)
854
gecos = w.pw_gecos.decode('utf-8')
858
encoding = osutils.get_user_encoding()
859
gecos = w.pw_gecos.decode(encoding)
861
raise errors.BzrCommandError('Unable to determine your name. '
862
'Use "bzr whoami" to set it.')
864
username = w.pw_name.decode(encoding)
866
raise errors.BzrCommandError('Unable to determine your name. '
867
'Use "bzr whoami" to set it.')
869
comma = gecos.find(',')
873
realname = gecos[:comma]
880
user_encoding = osutils.get_user_encoding()
881
realname = username = getpass.getuser().decode(user_encoding)
882
except UnicodeDecodeError:
883
raise errors.BzrError("Can't decode username as %s." % \
886
return realname, (username + '@' + socket.gethostname())
903
889
def parse_username(username):
931
917
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
933
919
def __init__(self, branch):
934
self._config = branch._get_config()
920
# XXX: Really this should be asking the branch for its configuration
921
# data, rather than relying on a Transport, so that it can work
922
# more cleanly with a RemoteBranch that has no transport.
923
self._config = TransportConfig(branch._transport, 'branch.conf')
935
924
self.branch = branch
937
926
def _get_parser(self, file=None):
991
981
"""Save the config file, only tests should use it for now."""
992
982
conf_dir = os.path.dirname(self._filename)
993
983
ensure_config_dir_exists(conf_dir)
994
f = file(self._filename, 'wb')
996
self._get_config().write(f)
984
self._get_config().write(file(self._filename, 'wb'))
1000
986
def _set_option(self, section_name, option_name, value):
1001
987
"""Set an authentication configuration option"""
1097
1083
trace.mutter("Using authentication section: %r", auth_def_name)
1100
if credentials is None:
1101
# No credentials were found in authentication.conf, try the fallback
1102
# credentials stores.
1103
credentials = credential_store_registry.get_fallback_credentials(
1104
scheme, host, port, user, path, realm)
1106
1086
return credentials
1108
1088
def set_credentials(self, name, host, user, scheme=None, password=None,
1150
1130
config.update({name: values})
1153
def get_user(self, scheme, host, port=None, realm=None, path=None,
1154
prompt=None, ask=False, default=None):
1133
def get_user(self, scheme, host, port=None,
1134
realm=None, path=None, prompt=None):
1155
1135
"""Get a user from authentication file.
1157
1137
:param scheme: protocol
1177
1152
user = credentials['user']
1183
# Create a default prompt suitable for most cases
1184
prompt = scheme.upper() + ' %(host)s username'
1185
# Special handling for optional fields in the prompt
1186
if port is not None:
1187
prompt_host = '%s:%d' % (host, port)
1190
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1195
1157
def get_password(self, scheme, host, user, port=None,
1250
1212
A credential store provides access to credentials via the password_encoding
1251
1213
field in authentication.conf sections.
1253
Except for stores provided by bzr itself, most stores are expected to be
1215
Except for stores provided by bzr itself,most stores are expected to be
1254
1216
provided by plugins that will therefore use
1255
1217
register_lazy(password_encoding, module_name, member_name, help=help,
1256
fallback=fallback) to install themselves.
1258
A fallback credential store is one that is queried if no credentials can be
1259
found via authentication.conf.
1218
info=info) to install themselves.
1262
1221
def get_credential_store(self, encoding=None):
1268
def is_fallback(self, name):
1269
"""Check if the named credentials store should be used as fallback."""
1270
return self.get_info(name)
1272
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1273
path=None, realm=None):
1274
"""Request credentials from all fallback credentials stores.
1276
The first credentials store that can provide credentials wins.
1279
for name in self.keys():
1280
if not self.is_fallback(name):
1282
cs = self.get_credential_store(name)
1283
credentials = cs.get_credentials(scheme, host, port, user,
1285
if credentials is not None:
1286
# We found some credentials
1290
def register(self, key, obj, help=None, override_existing=False,
1292
"""Register a new object to a name.
1294
:param key: This is the key to use to request the object later.
1295
:param obj: The object to register.
1296
:param help: Help text for this entry. This may be a string or
1297
a callable. If it is a callable, it should take two
1298
parameters (registry, key): this registry and the key that
1299
the help was registered under.
1300
:param override_existing: Raise KeyErorr if False and something has
1301
already been registered for that key. If True, ignore if there
1302
is an existing key (always register the new value).
1303
:param fallback: Whether this credential store should be
1306
return super(CredentialStoreRegistry,
1307
self).register(key, obj, help, info=fallback,
1308
override_existing=override_existing)
1310
def register_lazy(self, key, module_name, member_name,
1311
help=None, override_existing=False,
1313
"""Register a new credential store to be loaded on request.
1315
:param module_name: The python path to the module. Such as 'os.path'.
1316
:param member_name: The member of the module to return. If empty or
1317
None, get() will return the module itself.
1318
:param help: Help text for this entry. This may be a string or
1320
:param override_existing: If True, replace the existing object
1321
with the new one. If False, if there is already something
1322
registered with the same key, raise a KeyError
1323
:param fallback: Whether this credential store should be
1326
return super(CredentialStoreRegistry, self).register_lazy(
1327
key, module_name, member_name, help,
1328
info=fallback, override_existing=override_existing)
1331
1228
credential_store_registry = CredentialStoreRegistry()
1335
1232
"""An abstract class to implement storage for credentials"""
1337
1234
def decode_password(self, credentials):
1338
"""Returns a clear text password for the provided credentials."""
1235
"""Returns a password for the provided credentials in clear text."""
1339
1236
raise NotImplementedError(self.decode_password)
1341
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1343
"""Return the matching credentials from this credential store.
1345
This method is only called on fallback credential stores.
1347
raise NotImplementedError(self.get_credentials)
1351
1239
class PlainTextCredentialStore(CredentialStore):
1352
__doc__ = """Plain text credential store for the authentication.conf file"""
1240
"""Plain text credential store for the authentication.conf file."""
1354
1242
def decode_password(self, credentials):
1355
1243
"""See CredentialStore.decode_password."""
1364
1252
class BzrDirConfig(object):
1366
def __init__(self, bzrdir):
1367
self._bzrdir = bzrdir
1368
self._config = bzrdir._get_config()
1254
def __init__(self, transport):
1255
self._config = TransportConfig(transport, 'control.conf')
1370
1257
def set_default_stack_on(self, value):
1371
1258
"""Set the default stacking location.
1442
1325
configobj.setdefault(section, {})[name] = value
1443
1326
self._set_configobj(configobj)
1445
def _get_config_file(self):
1328
def _get_configobj(self):
1447
return StringIO(self._transport.get_bytes(self._filename))
1330
return ConfigObj(self._transport.get(self._filename),
1448
1332
except errors.NoSuchFile:
1451
def _get_configobj(self):
1452
f = self._get_config_file()
1454
return ConfigObj(f, encoding='utf-8')
1333
return ConfigObj(encoding='utf-8')
1458
1335
def _set_configobj(self, configobj):
1459
1336
out_file = StringIO()
added
removed
bzrlib/config.py
