142
144
"""Get the users pop up editor."""
143
145
raise NotImplementedError
147
def get_mail_client(self):
148
"""Get a mail client to use"""
149
selected_client = self.get_user_option('mail_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
'emacs-mailmode': mail_client.EmacsMailMode,
163
'xdg-email': mail_client.XDGEmail,
166
raise errors.UnknownMailClient(selected_client)
167
return mail_client_class(self)
145
169
def _get_signature_checking(self):
146
170
"""Template method to override signature checking policy."""
429
458
def __init__(self, location):
430
459
name_generator = locations_config_filename
431
if (not os.path.exists(name_generator()) and
460
if (not os.path.exists(name_generator()) and
432
461
os.path.exists(branches_config_filename())):
433
462
if sys.platform == 'win32':
434
warning('Please rename %s to %s'
435
% (branches_config_filename(),
436
locations_config_filename()))
463
trace.warning('Please rename %s to %s'
464
% (branches_config_filename(),
465
locations_config_filename()))
438
warning('Please rename ~/.bazaar/branches.conf'
439
' to ~/.bazaar/locations.conf')
467
trace.warning('Please rename ~/.bazaar/branches.conf'
468
' to ~/.bazaar/locations.conf')
440
469
name_generator = branches_config_filename
441
470
super(LocationConfig, self).__init__(name_generator)
442
471
# local file locations are looked up by local path, rather than
642
def set_user_option(self, name, value, store=STORE_BRANCH):
671
def set_user_option(self, name, value, store=STORE_BRANCH,
643
673
if store == STORE_BRANCH:
644
674
self._get_branch_data_config().set_option(value, name)
645
675
elif store == STORE_GLOBAL:
646
676
self._get_global_config().set_user_option(name, value)
648
678
self._get_location_config().set_user_option(name, value, store)
681
if store in (STORE_GLOBAL, STORE_BRANCH):
682
mask_value = self._get_location_config().get_user_option(name)
683
if mask_value is not None:
684
trace.warning('Value "%s" is masked by "%s" from'
685
' locations.conf', value, mask_value)
687
if store == STORE_GLOBAL:
688
branch_config = self._get_branch_data_config()
689
mask_value = branch_config.get_user_option(name)
690
if mask_value is not None:
691
trace.warning('Value "%s" is masked by "%s" from'
692
' branch.conf', value, mask_value)
650
695
def _gpg_signing_command(self):
651
696
"""See Config.gpg_signing_command."""
812
863
return realname, (username + '@' + socket.gethostname())
866
def parse_username(username):
867
"""Parse e-mail username and return a (name, address) tuple."""
868
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
870
return (username, '')
872
return (match.group(1), match.group(2))
815
875
def extract_email_address(e):
816
876
"""Return just the address part of an email string.
818
878
That is just the user@domain part, nothing else.
819
879
This part is required to contain only ascii characters.
820
880
If it can't be extracted, raises an error.
822
882
>>> extract_email_address('Jane Tester <jane@test.com>')
825
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
885
name, email = parse_username(e)
827
887
raise errors.NoEmailInUsername(e)
831
891
class TreeConfig(IniBasedConfig):
832
892
"""Branch configuration data associated with its contents, not location"""
833
894
def __init__(self, branch):
834
895
self.branch = branch
880
941
self.branch.control_files.put('branch.conf', out_file)
882
943
self.branch.unlock()
946
class AuthenticationConfig(object):
947
"""The authentication configuration file based on a ini file.
949
Implements the authentication.conf file described in
950
doc/developers/authentication-ring.txt.
953
def __init__(self, _file=None):
954
self._config = None # The ConfigObj
956
self._filename = authentication_config_filename()
957
self._input = self._filename = authentication_config_filename()
959
# Tests can provide a string as _file
960
self._filename = None
963
def _get_config(self):
964
if self._config is not None:
967
# FIXME: Should we validate something here ? Includes: empty
968
# sections are useless, at least one of
969
# user/password/password_encoding should be defined, etc.
971
# Note: the encoding below declares that the file itself is utf-8
972
# encoded, but the values in the ConfigObj are always Unicode.
973
self._config = ConfigObj(self._input, encoding='utf-8')
974
except configobj.ConfigObjError, e:
975
raise errors.ParseConfigError(e.errors, e.config.filename)
979
"""Save the config file, only tests should use it for now."""
980
conf_dir = os.path.dirname(self._filename)
981
ensure_config_dir_exists(conf_dir)
982
self._get_config().write(file(self._filename, 'wb'))
984
def _set_option(self, section_name, option_name, value):
985
"""Set an authentication configuration option"""
986
conf = self._get_config()
987
section = conf.get(section_name)
990
section = conf[section]
991
section[option_name] = value
994
def get_credentials(self, scheme, host, port=None, user=None, path=None):
995
"""Returns the matching credentials from authentication.conf file.
997
:param scheme: protocol
999
:param host: the server address
1001
:param port: the associated port (optional)
1003
:param user: login (optional)
1005
:param path: the absolute path on the server (optional)
1007
:return: A dict containing the matching credentials or None.
1009
- name: the section name of the credentials in the
1010
authentication.conf file,
1011
- user: can't de different from the provided user if any,
1012
- password: the decoded password, could be None if the credential
1013
defines only the user
1014
- verify_certificates: https specific, True if the server
1015
certificate should be verified, False otherwise.
1018
for auth_def_name, auth_def in self._get_config().items():
1019
a_scheme, a_host, a_user, a_path = map(
1020
auth_def.get, ['scheme', 'host', 'user', 'path'])
1023
a_port = auth_def.as_int('port')
1027
raise ValueError("'port' not numeric in %s" % auth_def_name)
1029
a_verify_certificates = auth_def.as_bool('verify_certificates')
1031
a_verify_certificates = True
1034
"'verify_certificates' not boolean in %s" % auth_def_name)
1037
if a_scheme is not None and scheme != a_scheme:
1039
if a_host is not None:
1040
if not (host == a_host
1041
or (a_host.startswith('.') and host.endswith(a_host))):
1043
if a_port is not None and port != a_port:
1045
if (a_path is not None and path is not None
1046
and not path.startswith(a_path)):
1048
if (a_user is not None and user is not None
1049
and a_user != user):
1050
# Never contradict the caller about the user to be used
1055
credentials = dict(name=auth_def_name,
1056
user=a_user, password=auth_def['password'],
1057
verify_certificates=a_verify_certificates)
1058
self.decode_password(credentials,
1059
auth_def.get('password_encoding', None))
1060
if 'auth' in debug.debug_flags:
1061
trace.mutter("Using authentication section: %r", auth_def_name)
1066
def get_user(self, scheme, host, port=None,
1067
realm=None, path=None, prompt=None):
1068
"""Get a user from authentication file.
1070
:param scheme: protocol
1072
:param host: the server address
1074
:param port: the associated port (optional)
1076
:param realm: the realm sent by the server (optional)
1078
:param path: the absolute path on the server (optional)
1080
:return: The found user.
1082
credentials = self.get_credentials(scheme, host, port, user=None,
1084
if credentials is not None:
1085
user = credentials['user']
1090
def get_password(self, scheme, host, user, port=None,
1091
realm=None, path=None, prompt=None):
1092
"""Get a password from authentication file or prompt the user for one.
1094
:param scheme: protocol
1096
:param host: the server address
1098
:param port: the associated port (optional)
1102
:param realm: the realm sent by the server (optional)
1104
:param path: the absolute path on the server (optional)
1106
:return: The found password or the one entered by the user.
1108
credentials = self.get_credentials(scheme, host, port, user, path)
1109
if credentials is not None:
1110
password = credentials['password']
1113
# Prompt user only if we could't find a password
1114
if password is None:
1116
# Create a default prompt suitable for most of the cases
1117
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1118
# Special handling for optional fields in the prompt
1119
if port is not None:
1120
prompt_host = '%s:%d' % (host, port)
1123
password = ui.ui_factory.get_password(prompt,
1124
host=prompt_host, user=user)
1127
def decode_password(self, credentials, encoding):
added
removed
bzrlib/config.py
