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
'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,
172
165
raise errors.UnknownMailClient(selected_client)
173
166
return mail_client_class(self)
498
440
def set_user_option(self, option, value):
499
441
"""Save option and its value in the configuration."""
500
self._set_option(option, value, 'DEFAULT')
502
def get_aliases(self):
503
"""Return the aliases section."""
504
if 'ALIASES' in self._get_parser():
505
return self._get_parser()['ALIASES']
509
def set_alias(self, alias_name, alias_command):
510
"""Save the alias in the configuration."""
511
self._set_option(alias_name, alias_command, 'ALIASES')
513
def unset_alias(self, alias_name):
514
"""Unset an existing alias."""
515
aliases = self._get_parser().get('ALIASES')
516
if not aliases or alias_name not in aliases:
517
raise errors.NoSuchAlias(alias_name)
518
del aliases[alias_name]
519
self._write_config_file()
521
def _set_option(self, option, value, section):
522
442
# FIXME: RBC 20051029 This should refresh the parser and also take a
523
443
# file lock on bazaar.conf.
524
444
conf_dir = os.path.dirname(self._get_filename())
525
445
ensure_config_dir_exists(conf_dir)
526
self._get_parser().setdefault(section, {})[option] = value
527
self._write_config_file()
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')
450
self._get_parser().write(f)
530
454
class LocationConfig(IniBasedConfig):
873
793
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
797
"""Calculate automatic user identification.
799
Returns (realname, email).
801
Only used when none is set in the environment or the id file.
803
This previously used the FQDN as the default domain, but that can
804
be very slow on machines where DNS is broken. So now we simply
885
809
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')
903
def parse_username(username):
904
"""Parse e-mail username and return a (name, address) tuple."""
905
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
907
return (username, '')
909
return (match.group(1), match.group(2))
810
name = win32utils.get_user_name_unicode()
812
raise errors.BzrError("Cannot autodetect user name.\n"
813
"Please, set your name with command like:\n"
814
'bzr whoami "Your Name <name@domain.com>"')
815
host = win32utils.get_host_name_unicode()
817
host = socket.gethostname()
818
return name, (name + '@' + host)
823
w = pwd.getpwuid(uid)
825
# we try utf-8 first, because on many variants (like Linux),
826
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
827
# false positives. (many users will have their user encoding set to
828
# latin-1, which cannot raise UnicodeError.)
830
gecos = w.pw_gecos.decode('utf-8')
834
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
835
encoding = bzrlib.user_encoding
837
raise errors.BzrCommandError('Unable to determine your name. '
838
'Use "bzr whoami" to set it.')
840
username = w.pw_name.decode(encoding)
842
raise errors.BzrCommandError('Unable to determine your name. '
843
'Use "bzr whoami" to set it.')
845
comma = gecos.find(',')
849
realname = gecos[:comma]
856
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
857
except UnicodeDecodeError:
858
raise errors.BzrError("Can't decode username as %s." % \
859
bzrlib.user_encoding)
861
return realname, (username + '@' + socket.gethostname())
912
864
def extract_email_address(e):
913
865
"""Return just the address part of an email string.
915
That is just the user@domain part, nothing else.
867
That is just the user@domain part, nothing else.
916
868
This part is required to contain only ascii characters.
917
869
If it can't be extracted, raises an error.
919
871
>>> extract_email_address('Jane Tester <jane@test.com>')
922
name, email = parse_username(e)
874
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
924
876
raise errors.NoEmailInUsername(e)
928
880
class TreeConfig(IniBasedConfig):
929
881
"""Branch configuration data associated with its contents, not location"""
931
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
933
883
def __init__(self, branch):
934
self._config = branch._get_config()
935
884
self.branch = branch
937
886
def _get_parser(self, file=None):
938
887
if file is not None:
939
888
return IniBasedConfig._get_parser(file)
940
return self._config._get_configobj()
889
return self._get_config()
891
def _get_config(self):
893
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
895
except errors.NoSuchFile:
896
obj = ConfigObj(encoding='utf=8')
942
899
def get_option(self, name, section=None, default=None):
943
900
self.branch.lock_read()
945
return self._config.get_option(name, section, default)
902
obj = self._get_config()
904
if section is not None:
947
910
self.branch.unlock()
949
913
def set_option(self, value, name, section=None):
950
914
"""Set a per-branch configuration option"""
951
915
self.branch.lock_write()
953
self._config.set_option(value, name, section)
917
cfg_obj = self._get_config()
922
obj = cfg_obj[section]
924
cfg_obj[section] = {}
925
obj = cfg_obj[section]
927
out_file = StringIO()
928
cfg_obj.write(out_file)
930
self.branch.control_files.put('branch.conf', out_file)
955
932
self.branch.unlock()
1079
1041
if a_user is None:
1080
1042
# Can't find a user
1082
# Prepare a credentials dictionary with additional keys
1083
# for the credential providers
1084
1044
credentials = dict(name=auth_def_name,
1091
password=auth_def.get('password', None),
1045
user=a_user, password=auth_def['password'],
1092
1046
verify_certificates=a_verify_certificates)
1093
# Decode the password in the credentials (or get one)
1094
1047
self.decode_password(credentials,
1095
1048
auth_def.get('password_encoding', None))
1096
1049
if 'auth' in debug.debug_flags:
1097
1050
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
1053
return credentials
1108
def set_credentials(self, name, host, user, scheme=None, password=None,
1109
port=None, path=None, verify_certificates=None,
1111
"""Set authentication credentials for a host.
1113
Any existing credentials with matching scheme, host, port and path
1114
will be deleted, regardless of name.
1116
:param name: An arbitrary name to describe this set of credentials.
1117
:param host: Name of the host that accepts these credentials.
1118
:param user: The username portion of these credentials.
1119
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1121
:param password: Password portion of these credentials.
1122
:param port: The IP port on the host that these credentials apply to.
1123
:param path: A filesystem path on the host that these credentials
1125
:param verify_certificates: On https, verify server certificates if
1127
:param realm: The http authentication realm (optional).
1129
values = {'host': host, 'user': user}
1130
if password is not None:
1131
values['password'] = password
1132
if scheme is not None:
1133
values['scheme'] = scheme
1134
if port is not None:
1135
values['port'] = '%d' % port
1136
if path is not None:
1137
values['path'] = path
1138
if verify_certificates is not None:
1139
values['verify_certificates'] = str(verify_certificates)
1140
if realm is not None:
1141
values['realm'] = realm
1142
config = self._get_config()
1144
for section, existing_values in config.items():
1145
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1146
if existing_values.get(key) != values.get(key):
1150
config.update({name: values})
1153
def get_user(self, scheme, host, port=None, realm=None, path=None,
1154
prompt=None, ask=False, default=None):
1055
def get_user(self, scheme, host, port=None,
1056
realm=None, path=None, prompt=None):
1155
1057
"""Get a user from authentication file.
1157
1059
:param scheme: protocol
1236
1114
return password
1238
1116
def decode_password(self, credentials, encoding):
1240
cs = credential_store_registry.get_credential_store(encoding)
1242
raise ValueError('%r is not a known password_encoding' % encoding)
1243
credentials['password'] = cs.decode_password(credentials)
1247
class CredentialStoreRegistry(registry.Registry):
1248
"""A class that registers credential stores.
1250
A credential store provides access to credentials via the password_encoding
1251
field in authentication.conf sections.
1253
Except for stores provided by bzr itself, most stores are expected to be
1254
provided by plugins that will therefore use
1255
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.
1262
def get_credential_store(self, encoding=None):
1263
cs = self.get(encoding)
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
credential_store_registry = CredentialStoreRegistry()
1334
class CredentialStore(object):
1335
"""An abstract class to implement storage for credentials"""
1337
def decode_password(self, credentials):
1338
"""Returns a clear text password for the provided credentials."""
1339
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
class PlainTextCredentialStore(CredentialStore):
1352
__doc__ = """Plain text credential store for the authentication.conf file"""
1354
def decode_password(self, credentials):
1355
"""See CredentialStore.decode_password."""
1356
return credentials['password']
1359
credential_store_registry.register('plain', PlainTextCredentialStore,
1360
help=PlainTextCredentialStore.__doc__)
1361
credential_store_registry.default_key = 'plain'
1364
class BzrDirConfig(object):
1366
def __init__(self, bzrdir):
1367
self._bzrdir = bzrdir
1368
self._config = bzrdir._get_config()
1370
def set_default_stack_on(self, value):
1371
"""Set the default stacking location.
1373
It may be set to a location, or None.
1375
This policy affects all branches contained by this bzrdir, except for
1376
those under repositories.
1378
if self._config is None:
1379
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1381
self._config.set_option('', 'default_stack_on')
1383
self._config.set_option(value, 'default_stack_on')
1385
def get_default_stack_on(self):
1386
"""Return the default stacking location.
1388
This will either be a location, or None.
1390
This policy affects all branches contained by this bzrdir, except for
1391
those under repositories.
1393
if self._config is None:
1395
value = self._config.get_option('default_stack_on')
1401
class TransportConfig(object):
1402
"""A Config that reads/writes a config file on a Transport.
1404
It is a low-level object that considers config data to be name/value pairs
1405
that may be associated with a section. Assigning meaning to the these
1406
values is done at higher levels like TreeConfig.
1409
def __init__(self, transport, filename):
1410
self._transport = transport
1411
self._filename = filename
1413
def get_option(self, name, section=None, default=None):
1414
"""Return the value associated with a named option.
1416
:param name: The name of the value
1417
:param section: The section the option is in (if any)
1418
:param default: The value to return if the value is not set
1419
:return: The value or default value
1421
configobj = self._get_configobj()
1423
section_obj = configobj
1426
section_obj = configobj[section]
1429
return section_obj.get(name, default)
1431
def set_option(self, value, name, section=None):
1432
"""Set the value associated with a named option.
1434
:param value: The value to set
1435
:param name: The name of the value to set
1436
:param section: The section the option is in (if any)
1438
configobj = self._get_configobj()
1440
configobj[name] = value
1442
configobj.setdefault(section, {})[name] = value
1443
self._set_configobj(configobj)
1445
def _get_config_file(self):
1447
return StringIO(self._transport.get_bytes(self._filename))
1448
except errors.NoSuchFile:
1451
def _get_configobj(self):
1452
f = self._get_config_file()
1454
return ConfigObj(f, encoding='utf-8')
1458
def _set_configobj(self, configobj):
1459
out_file = StringIO()
1460
configobj.write(out_file)
1462
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
