662
361
elif location + '/' in self._get_parser():
663
362
location = location + '/'
664
363
self._get_parser()[location][option]=value
665
# the allowed values of store match the config policies
666
self._set_option_policy(location, option, store)
667
self._get_parser().write(file(self._get_filename(), 'wb'))
364
self._get_parser().write()
670
367
class BranchConfig(Config):
671
368
"""A configuration object giving the policy for a branch."""
673
def _get_branch_data_config(self):
674
if self._branch_data_config is None:
675
self._branch_data_config = TreeConfig(self.branch)
676
return self._branch_data_config
678
370
def _get_location_config(self):
679
371
if self._location_config is None:
680
372
self._location_config = LocationConfig(self.branch.base)
681
373
return self._location_config
683
def _get_global_config(self):
684
if self._global_config is None:
685
self._global_config = GlobalConfig()
686
return self._global_config
688
def _get_best_value(self, option_name):
689
"""This returns a user option from local, tree or global config.
691
They are tried in that order. Use get_safe_value if trusted values
694
for source in self.option_sources:
695
value = getattr(source(), option_name)()
696
if value is not None:
700
def _get_safe_value(self, option_name):
701
"""This variant of get_best_value never returns untrusted values.
703
It does not return values from the branch data, because the branch may
704
not be controlled by the user.
706
We may wish to allow locations.conf to control whether branches are
707
trusted in the future.
709
for source in (self._get_location_config, self._get_global_config):
710
value = getattr(source(), option_name)()
711
if value is not None:
715
375
def _get_user_id(self):
716
376
"""Return the full user id for the branch.
718
e.g. "John Hacker <jhacker@example.com>"
378
e.g. "John Hacker <jhacker@foo.org>"
719
379
This is looked up in the email controlfile for the branch.
722
return (self.branch._transport.get_bytes("email")
723
.decode(osutils.get_user_encoding())
382
return (self.branch.controlfile("email", "r")
384
.decode(bzrlib.user_encoding)
725
386
except errors.NoSuchFile, e:
728
return self._get_best_value('_get_user_id')
730
def _get_change_editor(self):
731
return self._get_best_value('_get_change_editor')
389
return self._get_location_config()._get_user_id()
733
391
def _get_signature_checking(self):
734
392
"""See Config._get_signature_checking."""
735
return self._get_best_value('_get_signature_checking')
737
def _get_signing_policy(self):
738
"""See Config._get_signing_policy."""
739
return self._get_best_value('_get_signing_policy')
393
return self._get_location_config()._get_signature_checking()
741
395
def _get_user_option(self, option_name):
742
396
"""See Config._get_user_option."""
743
for source in self.option_sources:
744
value = source()._get_user_option(option_name)
745
if value is not None:
749
def set_user_option(self, name, value, store=STORE_BRANCH,
751
if store == STORE_BRANCH:
752
self._get_branch_data_config().set_option(value, name)
753
elif store == STORE_GLOBAL:
754
self._get_global_config().set_user_option(name, value)
756
self._get_location_config().set_user_option(name, value, store)
759
if store in (STORE_GLOBAL, STORE_BRANCH):
760
mask_value = self._get_location_config().get_user_option(name)
761
if mask_value is not None:
762
trace.warning('Value "%s" is masked by "%s" from'
763
' locations.conf', value, mask_value)
765
if store == STORE_GLOBAL:
766
branch_config = self._get_branch_data_config()
767
mask_value = branch_config.get_user_option(name)
768
if mask_value is not None:
769
trace.warning('Value "%s" is masked by "%s" from'
770
' branch.conf', value, mask_value)
397
return self._get_location_config()._get_user_option(option_name)
772
399
def _gpg_signing_command(self):
773
400
"""See Config.gpg_signing_command."""
774
return self._get_safe_value('_gpg_signing_command')
401
return self._get_location_config()._gpg_signing_command()
776
403
def __init__(self, branch):
777
404
super(BranchConfig, self).__init__()
778
405
self._location_config = None
779
self._branch_data_config = None
780
self._global_config = None
781
406
self.branch = branch
782
self.option_sources = (self._get_location_config,
783
self._get_branch_data_config,
784
self._get_global_config)
786
408
def _post_commit(self):
787
409
"""See Config.post_commit."""
788
return self._get_safe_value('_post_commit')
790
def _get_nickname(self):
791
value = self._get_explicit_nickname()
792
if value is not None:
794
return urlutils.unescape(self.branch.base.split('/')[-2])
796
def has_explicit_nickname(self):
797
"""Return true if a nickname has been explicitly assigned."""
798
return self._get_explicit_nickname() is not None
800
def _get_explicit_nickname(self):
801
return self._get_best_value('_get_nickname')
803
def _log_format(self):
804
"""See Config.log_format."""
805
return self._get_best_value('_log_format')
410
return self._get_location_config()._post_commit()
808
413
def ensure_config_dir_exists(path=None):
817
422
if sys.platform == 'win32':
818
423
parent_dir = os.path.dirname(path)
819
424
if not os.path.isdir(parent_dir):
820
trace.mutter('creating config parent directory: %r', parent_dir)
425
mutter('creating config parent directory: %r', parent_dir)
821
426
os.mkdir(parent_dir)
822
trace.mutter('creating config directory: %r', path)
427
mutter('creating config directory: %r', path)
824
osutils.copy_ownership_from_path(path)
827
430
def config_dir():
828
431
"""Return per-user configuration directory.
830
433
By default this is ~/.bazaar/
832
435
TODO: Global option --config-dir to override this.
834
437
base = os.environ.get('BZR_HOME', None)
835
438
if sys.platform == 'win32':
837
base = win32utils.get_appdata_location_unicode()
440
base = os.environ.get('APPDATA', None)
839
442
base = os.environ.get('HOME', None)
841
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
843
return osutils.pathjoin(base, 'bazaar', '2.0')
444
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
445
return pathjoin(base, 'bazaar', '2.0')
845
447
# cygwin, linux, and darwin all have a $HOME directory
847
449
base = os.path.expanduser("~")
848
return osutils.pathjoin(base, ".bazaar")
450
return pathjoin(base, ".bazaar")
851
453
def config_filename():
852
454
"""Return per-user configuration ini file filename."""
853
return osutils.pathjoin(config_dir(), 'bazaar.conf')
455
return pathjoin(config_dir(), 'bazaar.conf')
856
458
def branches_config_filename():
857
459
"""Return per-user configuration ini file filename."""
858
return osutils.pathjoin(config_dir(), 'branches.conf')
861
def locations_config_filename():
862
"""Return per-user configuration ini file filename."""
863
return osutils.pathjoin(config_dir(), 'locations.conf')
866
def authentication_config_filename():
867
"""Return per-user authentication ini file filename."""
868
return osutils.pathjoin(config_dir(), 'authentication.conf')
871
def user_ignore_config_filename():
872
"""Return the user default ignore filename"""
873
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
460
return pathjoin(config_dir(), 'branches.conf')
464
"""Calculate automatic user identification.
466
Returns (realname, email).
468
Only used when none is set in the environment or the id file.
470
This previously used the FQDN as the default domain, but that can
471
be very slow on machines where DNS is broken. So now we simply
885
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))
476
# XXX: Any good way to get real user name on win32?
481
w = pwd.getpwuid(uid)
482
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
483
username = w.pw_name.decode(bzrlib.user_encoding)
484
comma = gecos.find(',')
488
realname = gecos[:comma]
494
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
496
return realname, (username + '@' + socket.gethostname())
912
499
def extract_email_address(e):
913
500
"""Return just the address part of an email string.
915
That is just the user@domain part, nothing else.
502
That is just the user@domain part, nothing else.
916
503
This part is required to contain only ascii characters.
917
504
If it can't be extracted, raises an error.
919
506
>>> extract_email_address('Jane Tester <jane@test.com>')
922
name, email = parse_username(e)
924
raise errors.NoEmailInUsername(e)
928
class TreeConfig(IniBasedConfig):
509
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
511
raise errors.BzrError("%r doesn't seem to contain "
512
"a reasonable email address" % e)
515
class TreeConfig(object):
929
516
"""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
517
def __init__(self, branch):
934
self._config = branch._get_config()
935
518
self.branch = branch
937
def _get_parser(self, file=None):
939
return IniBasedConfig._get_parser(file)
940
return self._config._get_configobj()
520
def _get_config(self):
522
obj = ConfigObj(self.branch.controlfile('branch.conf',
525
except errors.NoSuchFile:
942
529
def get_option(self, name, section=None, default=None):
943
530
self.branch.lock_read()
945
return self._config.get_option(name, section, default)
532
obj = self._get_config()
534
if section is not None:
947
540
self.branch.unlock()
949
543
def set_option(self, value, name, section=None):
950
544
"""Set a per-branch configuration option"""
951
545
self.branch.lock_write()
953
self._config.set_option(value, name, section)
547
cfg_obj = self._get_config()
552
obj = cfg_obj[section]
554
cfg_obj[section] = {}
555
obj = cfg_obj[section]
557
cfg_obj.encode('UTF-8')
558
out_file = StringIO(''.join([l+'\n' for l in cfg_obj.write()]))
560
self.branch.put_controlfile('branch.conf', out_file, encode=False)
955
562
self.branch.unlock()
958
class AuthenticationConfig(object):
959
"""The authentication configuration file based on a ini file.
961
Implements the authentication.conf file described in
962
doc/developers/authentication-ring.txt.
965
def __init__(self, _file=None):
966
self._config = None # The ConfigObj
968
self._filename = authentication_config_filename()
969
self._input = self._filename = authentication_config_filename()
971
# Tests can provide a string as _file
972
self._filename = None
975
def _get_config(self):
976
if self._config is not None:
979
# FIXME: Should we validate something here ? Includes: empty
980
# sections are useless, at least one of
981
# user/password/password_encoding should be defined, etc.
983
# Note: the encoding below declares that the file itself is utf-8
984
# encoded, but the values in the ConfigObj are always Unicode.
985
self._config = ConfigObj(self._input, encoding='utf-8')
986
except configobj.ConfigObjError, e:
987
raise errors.ParseConfigError(e.errors, e.config.filename)
991
"""Save the config file, only tests should use it for now."""
992
conf_dir = os.path.dirname(self._filename)
993
ensure_config_dir_exists(conf_dir)
994
self._get_config().write(file(self._filename, 'wb'))
996
def _set_option(self, section_name, option_name, value):
997
"""Set an authentication configuration option"""
998
conf = self._get_config()
999
section = conf.get(section_name)
1002
section = conf[section]
1003
section[option_name] = value
1006
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1008
"""Returns the matching credentials from authentication.conf file.
1010
:param scheme: protocol
1012
:param host: the server address
1014
:param port: the associated port (optional)
1016
:param user: login (optional)
1018
:param path: the absolute path on the server (optional)
1020
:param realm: the http authentication realm (optional)
1022
:return: A dict containing the matching credentials or None.
1024
- name: the section name of the credentials in the
1025
authentication.conf file,
1026
- user: can't be different from the provided user if any,
1027
- scheme: the server protocol,
1028
- host: the server address,
1029
- port: the server port (can be None),
1030
- path: the absolute server path (can be None),
1031
- realm: the http specific authentication realm (can be None),
1032
- password: the decoded password, could be None if the credential
1033
defines only the user
1034
- verify_certificates: https specific, True if the server
1035
certificate should be verified, False otherwise.
1038
for auth_def_name, auth_def in self._get_config().items():
1039
if type(auth_def) is not configobj.Section:
1040
raise ValueError("%s defined outside a section" % auth_def_name)
1042
a_scheme, a_host, a_user, a_path = map(
1043
auth_def.get, ['scheme', 'host', 'user', 'path'])
1046
a_port = auth_def.as_int('port')
1050
raise ValueError("'port' not numeric in %s" % auth_def_name)
1052
a_verify_certificates = auth_def.as_bool('verify_certificates')
1054
a_verify_certificates = True
1057
"'verify_certificates' not boolean in %s" % auth_def_name)
1060
if a_scheme is not None and scheme != a_scheme:
1062
if a_host is not None:
1063
if not (host == a_host
1064
or (a_host.startswith('.') and host.endswith(a_host))):
1066
if a_port is not None and port != a_port:
1068
if (a_path is not None and path is not None
1069
and not path.startswith(a_path)):
1071
if (a_user is not None and user is not None
1072
and a_user != user):
1073
# Never contradict the caller about the user to be used
1078
# Prepare a credentials dictionary with additional keys
1079
# for the credential providers
1080
credentials = dict(name=auth_def_name,
1087
password=auth_def.get('password', None),
1088
verify_certificates=a_verify_certificates)
1089
# Decode the password in the credentials (or get one)
1090
self.decode_password(credentials,
1091
auth_def.get('password_encoding', None))
1092
if 'auth' in debug.debug_flags:
1093
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)
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):
1151
"""Get a user from authentication file.
1153
:param scheme: protocol
1155
:param host: the server address
1157
:param port: the associated port (optional)
1159
:param realm: the realm sent by the server (optional)
1161
:param path: the absolute path on the server (optional)
1163
:param ask: Ask the user if there is no explicitly configured username
1166
:param default: The username returned if none is defined (optional).
1168
:return: The found user.
1170
credentials = self.get_credentials(scheme, host, port, user=None,
1171
path=path, realm=realm)
1172
if credentials is not None:
1173
user = credentials['user']
1179
# Create a default prompt suitable for most cases
1180
prompt = scheme.upper() + ' %(host)s username'
1181
# Special handling for optional fields in the prompt
1182
if port is not None:
1183
prompt_host = '%s:%d' % (host, port)
1186
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1191
def get_password(self, scheme, host, user, port=None,
1192
realm=None, path=None, prompt=None):
1193
"""Get a password from authentication file or prompt the user for one.
1195
:param scheme: protocol
1197
:param host: the server address
1199
:param port: the associated port (optional)
1203
:param realm: the realm sent by the server (optional)
1205
:param path: the absolute path on the server (optional)
1207
:return: The found password or the one entered by the user.
1209
credentials = self.get_credentials(scheme, host, port, user, path,
1211
if credentials is not None:
1212
password = credentials['password']
1213
if password is not None and scheme is 'ssh':
1214
trace.warning('password ignored in section [%s],'
1215
' use an ssh agent instead'
1216
% credentials['name'])
1220
# Prompt user only if we could't find a password
1221
if password is None:
1223
# Create a default prompt suitable for most cases
1224
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1225
# Special handling for optional fields in the prompt
1226
if port is not None:
1227
prompt_host = '%s:%d' % (host, port)
1230
password = ui.ui_factory.get_password(prompt,
1231
host=prompt_host, user=user)
1234
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
class TransportConfig(object):
1398
"""A Config that reads/writes a config file on a Transport.
1400
It is a low-level object that considers config data to be name/value pairs
1401
that may be associated with a section. Assigning meaning to the these
1402
values is done at higher levels like TreeConfig.
1405
def __init__(self, transport, filename):
1406
self._transport = transport
1407
self._filename = filename
1409
def get_option(self, name, section=None, default=None):
1410
"""Return the value associated with a named option.
1412
:param name: The name of the value
1413
:param section: The section the option is in (if any)
1414
:param default: The value to return if the value is not set
1415
:return: The value or default value
1417
configobj = self._get_configobj()
1419
section_obj = configobj
1422
section_obj = configobj[section]
1425
return section_obj.get(name, default)
1427
def set_option(self, value, name, section=None):
1428
"""Set the value associated with a named option.
1430
:param value: The value to set
1431
:param name: The name of the value to set
1432
:param section: The section the option is in (if any)
1434
configobj = self._get_configobj()
1436
configobj[name] = value
1438
configobj.setdefault(section, {})[name] = value
1439
self._set_configobj(configobj)
1441
def _get_config_file(self):
1443
return StringIO(self._transport.get_bytes(self._filename))
1444
except errors.NoSuchFile:
1447
def _get_configobj(self):
1448
return ConfigObj(self._get_config_file(), encoding='utf-8')
1450
def _set_configobj(self, configobj):
1451
out_file = StringIO()
1452
configobj.write(out_file)
1454
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
