1
# Copyright (C) 2005, 2007 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
33
in locations.conf, you specify the url of a branch and options for it.
34
Wildcards may be used - * and ? as normal in shell completion. Options
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
37
[/home/robertc/source]
38
recurse=False|True(default)
40
check_signatures= as above
41
create_signatures= as above.
43
explanation of options
44
----------------------
45
editor - this option sets the pop up editor to use during commits.
46
email - this option sets the user id bzr will use when committing.
47
check_signatures - this option controls whether bzr will require good gpg
48
signatures, ignore them, or check them if they are
50
create_signatures - this option controls whether bzr will always create
51
gpg signatures, never create them, or create them if the
52
branch is configured to require them.
53
log_format - this option sets the default log format. Possible values are
54
long, short, line, or a plugin can register new formats.
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
59
lastlog=log --line -r-10..-1
60
ll=log --line -r-10..-1
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
71
from fnmatch import fnmatch
73
from cStringIO import StringIO
87
from bzrlib.util.configobj import configobj
103
POLICY_APPENDPATH = 2
107
POLICY_NORECURSE: 'norecurse',
108
POLICY_APPENDPATH: 'appendpath',
113
'norecurse': POLICY_NORECURSE,
114
'appendpath': POLICY_APPENDPATH,
118
STORE_LOCATION = POLICY_NONE
119
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
120
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
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]
140
class Config(object):
141
"""A configuration policy - what username, editor, gpg needs etc."""
143
def get_editor(self):
144
"""Get the users pop up editor."""
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
'xdg-email': mail_client.XDGEmail,
165
raise errors.UnknownMailClient(selected_client)
166
return mail_client_class(self)
168
def _get_signature_checking(self):
169
"""Template method to override signature checking policy."""
171
def _get_signing_policy(self):
172
"""Template method to override signature creation policy."""
174
def _get_user_option(self, option_name):
175
"""Template method to provide a user option."""
178
def get_user_option(self, option_name):
179
"""Get a generic option - no special process, no default."""
180
return self._get_user_option(option_name)
182
def gpg_signing_command(self):
183
"""What program should be used to sign signatures?"""
184
result = self._gpg_signing_command()
189
def _gpg_signing_command(self):
190
"""See gpg_signing_command()."""
193
def log_format(self):
194
"""What log format should be used"""
195
result = self._log_format()
200
def _log_format(self):
201
"""See log_format()."""
205
super(Config, self).__init__()
207
def post_commit(self):
208
"""An ordered list of python functions to call.
210
Each function takes branch, rev_id as parameters.
212
return self._post_commit()
214
def _post_commit(self):
215
"""See Config.post_commit."""
218
def user_email(self):
219
"""Return just the email component of a username."""
220
return extract_email_address(self.username())
223
"""Return email-style username.
225
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
227
$BZR_EMAIL can be set to override this (as well as the
228
deprecated $BZREMAIL), then
229
the concrete policy type is checked, and finally
231
If none is found, a reasonable default is (hopefully)
234
TODO: Check it's reasonably well-formed.
236
v = os.environ.get('BZR_EMAIL')
238
return v.decode(bzrlib.user_encoding)
240
v = self._get_user_id()
244
v = os.environ.get('EMAIL')
246
return v.decode(bzrlib.user_encoding)
248
name, email = _auto_user_id()
250
return '%s <%s>' % (name, email)
254
def signature_checking(self):
255
"""What is the current policy for signature checking?."""
256
policy = self._get_signature_checking()
257
if policy is not None:
259
return CHECK_IF_POSSIBLE
261
def signing_policy(self):
262
"""What is the current policy for signature checking?."""
263
policy = self._get_signing_policy()
264
if policy is not None:
266
return SIGN_WHEN_REQUIRED
268
def signature_needed(self):
269
"""Is a signature needed when committing ?."""
270
policy = self._get_signing_policy()
272
policy = self._get_signature_checking()
273
if policy is not None:
274
trace.warning("Please use create_signatures,"
275
" not check_signatures to set signing policy.")
276
if policy == CHECK_ALWAYS:
278
elif policy == SIGN_ALWAYS:
282
def get_alias(self, value):
283
return self._get_alias(value)
285
def _get_alias(self, value):
288
def get_nickname(self):
289
return self._get_nickname()
291
def _get_nickname(self):
294
def get_bzr_remote_path(self):
296
return os.environ['BZR_REMOTE_PATH']
298
path = self.get_user_option("bzr_remote_path")
304
class IniBasedConfig(Config):
305
"""A configuration policy that draws from ini files."""
307
def _get_parser(self, file=None):
308
if self._parser is not None:
311
input = self._get_filename()
315
self._parser = ConfigObj(input, encoding='utf-8')
316
except configobj.ConfigObjError, e:
317
raise errors.ParseConfigError(e.errors, e.config.filename)
320
def _get_matching_sections(self):
321
"""Return an ordered list of (section_name, extra_path) pairs.
323
If the section contains inherited configuration, extra_path is
324
a string containing the additional path components.
326
section = self._get_section()
327
if section is not None:
328
return [(section, '')]
332
def _get_section(self):
333
"""Override this to define the section used by the config."""
336
def _get_option_policy(self, section, option_name):
337
"""Return the policy for the given (section, option_name) pair."""
340
def _get_signature_checking(self):
341
"""See Config._get_signature_checking."""
342
policy = self._get_user_option('check_signatures')
344
return self._string_to_signature_policy(policy)
346
def _get_signing_policy(self):
347
"""See Config._get_signing_policy"""
348
policy = self._get_user_option('create_signatures')
350
return self._string_to_signing_policy(policy)
352
def _get_user_id(self):
353
"""Get the user id from the 'email' key in the current section."""
354
return self._get_user_option('email')
356
def _get_user_option(self, option_name):
357
"""See Config._get_user_option."""
358
for (section, extra_path) in self._get_matching_sections():
360
value = self._get_parser().get_value(section, option_name)
363
policy = self._get_option_policy(section, option_name)
364
if policy == POLICY_NONE:
366
elif policy == POLICY_NORECURSE:
367
# norecurse items only apply to the exact path
372
elif policy == POLICY_APPENDPATH:
374
value = urlutils.join(value, extra_path)
377
raise AssertionError('Unexpected config policy %r' % policy)
381
def _gpg_signing_command(self):
382
"""See Config.gpg_signing_command."""
383
return self._get_user_option('gpg_signing_command')
385
def _log_format(self):
386
"""See Config.log_format."""
387
return self._get_user_option('log_format')
389
def __init__(self, get_filename):
390
super(IniBasedConfig, self).__init__()
391
self._get_filename = get_filename
394
def _post_commit(self):
395
"""See Config.post_commit."""
396
return self._get_user_option('post_commit')
398
def _string_to_signature_policy(self, signature_string):
399
"""Convert a string to a signing policy."""
400
if signature_string.lower() == 'check-available':
401
return CHECK_IF_POSSIBLE
402
if signature_string.lower() == 'ignore':
404
if signature_string.lower() == 'require':
406
raise errors.BzrError("Invalid signatures policy '%s'"
409
def _string_to_signing_policy(self, signature_string):
410
"""Convert a string to a signing policy."""
411
if signature_string.lower() == 'when-required':
412
return SIGN_WHEN_REQUIRED
413
if signature_string.lower() == 'never':
415
if signature_string.lower() == 'always':
417
raise errors.BzrError("Invalid signing policy '%s'"
420
def _get_alias(self, value):
422
return self._get_parser().get_value("ALIASES",
427
def _get_nickname(self):
428
return self.get_user_option('nickname')
431
class GlobalConfig(IniBasedConfig):
432
"""The configuration that should be used for a specific location."""
434
def get_editor(self):
435
return self._get_user_option('editor')
438
super(GlobalConfig, self).__init__(config_filename)
440
def set_user_option(self, option, value):
441
"""Save option and its value in the configuration."""
442
# FIXME: RBC 20051029 This should refresh the parser and also take a
443
# file lock on bazaar.conf.
444
conf_dir = os.path.dirname(self._get_filename())
445
ensure_config_dir_exists(conf_dir)
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)
454
class LocationConfig(IniBasedConfig):
455
"""A configuration object that gives the policy for a location."""
457
def __init__(self, location):
458
name_generator = locations_config_filename
459
if (not os.path.exists(name_generator()) and
460
os.path.exists(branches_config_filename())):
461
if sys.platform == 'win32':
462
trace.warning('Please rename %s to %s'
463
% (branches_config_filename(),
464
locations_config_filename()))
466
trace.warning('Please rename ~/.bazaar/branches.conf'
467
' to ~/.bazaar/locations.conf')
468
name_generator = branches_config_filename
469
super(LocationConfig, self).__init__(name_generator)
470
# local file locations are looked up by local path, rather than
471
# by file url. This is because the config file is a user
472
# file, and we would rather not expose the user to file urls.
473
if location.startswith('file://'):
474
location = urlutils.local_path_from_url(location)
475
self.location = location
477
def _get_matching_sections(self):
478
"""Return an ordered list of section names matching this location."""
479
sections = self._get_parser()
480
location_names = self.location.split('/')
481
if self.location.endswith('/'):
482
del location_names[-1]
484
for section in sections:
485
# location is a local path if possible, so we need
486
# to convert 'file://' urls to local paths if necessary.
487
# This also avoids having file:///path be a more exact
488
# match than '/path'.
489
if section.startswith('file://'):
490
section_path = urlutils.local_path_from_url(section)
492
section_path = section
493
section_names = section_path.split('/')
494
if section.endswith('/'):
495
del section_names[-1]
496
names = zip(location_names, section_names)
499
if not fnmatch(name[0], name[1]):
504
# so, for the common prefix they matched.
505
# if section is longer, no match.
506
if len(section_names) > len(location_names):
508
matches.append((len(section_names), section,
509
'/'.join(location_names[len(section_names):])))
510
matches.sort(reverse=True)
512
for (length, section, extra_path) in matches:
513
sections.append((section, extra_path))
514
# should we stop looking for parent configs here?
516
if self._get_parser()[section].as_bool('ignore_parents'):
522
def _get_option_policy(self, section, option_name):
523
"""Return the policy for the given (section, option_name) pair."""
524
# check for the old 'recurse=False' flag
526
recurse = self._get_parser()[section].as_bool('recurse')
530
return POLICY_NORECURSE
532
policy_key = option_name + ':policy'
534
policy_name = self._get_parser()[section][policy_key]
538
return _policy_value[policy_name]
540
def _set_option_policy(self, section, option_name, option_policy):
541
"""Set the policy for the given option name in the given section."""
542
# The old recurse=False option affects all options in the
543
# section. To handle multiple policies in the section, we
544
# need to convert it to a policy_norecurse key.
546
recurse = self._get_parser()[section].as_bool('recurse')
550
symbol_versioning.warn(
551
'The recurse option is deprecated as of 0.14. '
552
'The section "%s" has been converted to use policies.'
555
del self._get_parser()[section]['recurse']
557
for key in self._get_parser()[section].keys():
558
if not key.endswith(':policy'):
559
self._get_parser()[section][key +
560
':policy'] = 'norecurse'
562
policy_key = option_name + ':policy'
563
policy_name = _policy_name[option_policy]
564
if policy_name is not None:
565
self._get_parser()[section][policy_key] = policy_name
567
if policy_key in self._get_parser()[section]:
568
del self._get_parser()[section][policy_key]
570
def set_user_option(self, option, value, store=STORE_LOCATION):
571
"""Save option and its value in the configuration."""
572
assert store in [STORE_LOCATION,
573
STORE_LOCATION_NORECURSE,
574
STORE_LOCATION_APPENDPATH], 'bad storage policy'
575
# FIXME: RBC 20051029 This should refresh the parser and also take a
576
# file lock on locations.conf.
577
conf_dir = os.path.dirname(self._get_filename())
578
ensure_config_dir_exists(conf_dir)
579
location = self.location
580
if location.endswith('/'):
581
location = location[:-1]
582
if (not location in self._get_parser() and
583
not location + '/' in self._get_parser()):
584
self._get_parser()[location]={}
585
elif location + '/' in self._get_parser():
586
location = location + '/'
587
self._get_parser()[location][option]=value
588
# the allowed values of store match the config policies
589
self._set_option_policy(location, option, store)
590
self._get_parser().write(file(self._get_filename(), 'wb'))
593
class BranchConfig(Config):
594
"""A configuration object giving the policy for a branch."""
596
def _get_branch_data_config(self):
597
if self._branch_data_config is None:
598
self._branch_data_config = TreeConfig(self.branch)
599
return self._branch_data_config
601
def _get_location_config(self):
602
if self._location_config is None:
603
self._location_config = LocationConfig(self.branch.base)
604
return self._location_config
606
def _get_global_config(self):
607
if self._global_config is None:
608
self._global_config = GlobalConfig()
609
return self._global_config
611
def _get_best_value(self, option_name):
612
"""This returns a user option from local, tree or global config.
614
They are tried in that order. Use get_safe_value if trusted values
617
for source in self.option_sources:
618
value = getattr(source(), option_name)()
619
if value is not None:
623
def _get_safe_value(self, option_name):
624
"""This variant of get_best_value never returns untrusted values.
626
It does not return values from the branch data, because the branch may
627
not be controlled by the user.
629
We may wish to allow locations.conf to control whether branches are
630
trusted in the future.
632
for source in (self._get_location_config, self._get_global_config):
633
value = getattr(source(), option_name)()
634
if value is not None:
638
def _get_user_id(self):
639
"""Return the full user id for the branch.
641
e.g. "John Hacker <jhacker@foo.org>"
642
This is looked up in the email controlfile for the branch.
645
return (self.branch.control_files.get_utf8("email")
647
.decode(bzrlib.user_encoding)
649
except errors.NoSuchFile, e:
652
return self._get_best_value('_get_user_id')
654
def _get_signature_checking(self):
655
"""See Config._get_signature_checking."""
656
return self._get_best_value('_get_signature_checking')
658
def _get_signing_policy(self):
659
"""See Config._get_signing_policy."""
660
return self._get_best_value('_get_signing_policy')
662
def _get_user_option(self, option_name):
663
"""See Config._get_user_option."""
664
for source in self.option_sources:
665
value = source()._get_user_option(option_name)
666
if value is not None:
670
def set_user_option(self, name, value, store=STORE_BRANCH,
672
if store == STORE_BRANCH:
673
self._get_branch_data_config().set_option(value, name)
674
elif store == STORE_GLOBAL:
675
self._get_global_config().set_user_option(name, value)
677
self._get_location_config().set_user_option(name, value, store)
680
if store in (STORE_GLOBAL, STORE_BRANCH):
681
mask_value = self._get_location_config().get_user_option(name)
682
if mask_value is not None:
683
trace.warning('Value "%s" is masked by "%s" from'
684
' locations.conf', value, mask_value)
686
if store == STORE_GLOBAL:
687
branch_config = self._get_branch_data_config()
688
mask_value = branch_config.get_user_option(name)
689
if mask_value is not None:
690
trace.warning('Value "%s" is masked by "%s" from'
691
' branch.conf', value, mask_value)
694
def _gpg_signing_command(self):
695
"""See Config.gpg_signing_command."""
696
return self._get_safe_value('_gpg_signing_command')
698
def __init__(self, branch):
699
super(BranchConfig, self).__init__()
700
self._location_config = None
701
self._branch_data_config = None
702
self._global_config = None
704
self.option_sources = (self._get_location_config,
705
self._get_branch_data_config,
706
self._get_global_config)
708
def _post_commit(self):
709
"""See Config.post_commit."""
710
return self._get_safe_value('_post_commit')
712
def _get_nickname(self):
713
value = self._get_explicit_nickname()
714
if value is not None:
716
return urlutils.unescape(self.branch.base.split('/')[-2])
718
def has_explicit_nickname(self):
719
"""Return true if a nickname has been explicitly assigned."""
720
return self._get_explicit_nickname() is not None
722
def _get_explicit_nickname(self):
723
return self._get_best_value('_get_nickname')
725
def _log_format(self):
726
"""See Config.log_format."""
727
return self._get_best_value('_log_format')
730
def ensure_config_dir_exists(path=None):
731
"""Make sure a configuration directory exists.
732
This makes sure that the directory exists.
733
On windows, since configuration directories are 2 levels deep,
734
it makes sure both the directory and the parent directory exists.
738
if not os.path.isdir(path):
739
if sys.platform == 'win32':
740
parent_dir = os.path.dirname(path)
741
if not os.path.isdir(parent_dir):
742
trace.mutter('creating config parent directory: %r', parent_dir)
744
trace.mutter('creating config directory: %r', path)
749
"""Return per-user configuration directory.
751
By default this is ~/.bazaar/
753
TODO: Global option --config-dir to override this.
755
base = os.environ.get('BZR_HOME', None)
756
if sys.platform == 'win32':
758
base = win32utils.get_appdata_location_unicode()
760
base = os.environ.get('HOME', None)
762
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
764
return osutils.pathjoin(base, 'bazaar', '2.0')
766
# cygwin, linux, and darwin all have a $HOME directory
768
base = os.path.expanduser("~")
769
return osutils.pathjoin(base, ".bazaar")
772
def config_filename():
773
"""Return per-user configuration ini file filename."""
774
return osutils.pathjoin(config_dir(), 'bazaar.conf')
777
def branches_config_filename():
778
"""Return per-user configuration ini file filename."""
779
return osutils.pathjoin(config_dir(), 'branches.conf')
782
def locations_config_filename():
783
"""Return per-user configuration ini file filename."""
784
return osutils.pathjoin(config_dir(), 'locations.conf')
787
def authentication_config_filename():
788
"""Return per-user authentication ini file filename."""
789
return osutils.pathjoin(config_dir(), 'authentication.conf')
792
def user_ignore_config_filename():
793
"""Return the user default ignore filename"""
794
return osutils.pathjoin(config_dir(), 'ignore')
798
"""Calculate automatic user identification.
800
Returns (realname, email).
802
Only used when none is set in the environment or the id file.
804
This previously used the FQDN as the default domain, but that can
805
be very slow on machines where DNS is broken. So now we simply
810
if sys.platform == 'win32':
811
name = win32utils.get_user_name_unicode()
813
raise errors.BzrError("Cannot autodetect user name.\n"
814
"Please, set your name with command like:\n"
815
'bzr whoami "Your Name <name@domain.com>"')
816
host = win32utils.get_host_name_unicode()
818
host = socket.gethostname()
819
return name, (name + '@' + host)
824
w = pwd.getpwuid(uid)
826
# we try utf-8 first, because on many variants (like Linux),
827
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
828
# false positives. (many users will have their user encoding set to
829
# latin-1, which cannot raise UnicodeError.)
831
gecos = w.pw_gecos.decode('utf-8')
835
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
836
encoding = bzrlib.user_encoding
838
raise errors.BzrCommandError('Unable to determine your name. '
839
'Use "bzr whoami" to set it.')
841
username = w.pw_name.decode(encoding)
843
raise errors.BzrCommandError('Unable to determine your name. '
844
'Use "bzr whoami" to set it.')
846
comma = gecos.find(',')
850
realname = gecos[:comma]
857
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
858
except UnicodeDecodeError:
859
raise errors.BzrError("Can't decode username as %s." % \
860
bzrlib.user_encoding)
862
return realname, (username + '@' + socket.gethostname())
865
def parse_username(username):
866
"""Parse e-mail username and return a (name, address) tuple."""
867
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
869
return (username, '')
871
return (match.group(1), match.group(2))
874
def extract_email_address(e):
875
"""Return just the address part of an email string.
877
That is just the user@domain part, nothing else.
878
This part is required to contain only ascii characters.
879
If it can't be extracted, raises an error.
881
>>> extract_email_address('Jane Tester <jane@test.com>')
884
name, email = parse_username(e)
886
raise errors.NoEmailInUsername(e)
890
class TreeConfig(IniBasedConfig):
891
"""Branch configuration data associated with its contents, not location"""
893
def __init__(self, branch):
894
transport = branch.control_files._transport
895
self._config = TransportConfig(transport, 'branch.conf')
898
def _get_parser(self, file=None):
900
return IniBasedConfig._get_parser(file)
901
return self._config._get_configobj()
903
def get_option(self, name, section=None, default=None):
904
self.branch.lock_read()
906
return self._config.get_option(name, section, default)
911
def set_option(self, value, name, section=None):
912
"""Set a per-branch configuration option"""
913
self.branch.lock_write()
915
self._config.set_option(value, name, section)
920
class AuthenticationConfig(object):
921
"""The authentication configuration file based on a ini file.
923
Implements the authentication.conf file described in
924
doc/developers/authentication-ring.txt.
927
def __init__(self, _file=None):
928
self._config = None # The ConfigObj
930
self._filename = authentication_config_filename()
931
self._input = self._filename = authentication_config_filename()
933
# Tests can provide a string as _file
934
self._filename = None
937
def _get_config(self):
938
if self._config is not None:
941
# FIXME: Should we validate something here ? Includes: empty
942
# sections are useless, at least one of
943
# user/password/password_encoding should be defined, etc.
945
# Note: the encoding below declares that the file itself is utf-8
946
# encoded, but the values in the ConfigObj are always Unicode.
947
self._config = ConfigObj(self._input, encoding='utf-8')
948
except configobj.ConfigObjError, e:
949
raise errors.ParseConfigError(e.errors, e.config.filename)
953
"""Save the config file, only tests should use it for now."""
954
conf_dir = os.path.dirname(self._filename)
955
ensure_config_dir_exists(conf_dir)
956
self._get_config().write(file(self._filename, 'wb'))
958
def _set_option(self, section_name, option_name, value):
959
"""Set an authentication configuration option"""
960
conf = self._get_config()
961
section = conf.get(section_name)
964
section = conf[section]
965
section[option_name] = value
968
def get_credentials(self, scheme, host, port=None, user=None, path=None):
969
"""Returns the matching credentials from authentication.conf file.
971
:param scheme: protocol
973
:param host: the server address
975
:param port: the associated port (optional)
977
:param user: login (optional)
979
:param path: the absolute path on the server (optional)
981
:return: A dict containing the matching credentials or None.
983
- name: the section name of the credentials in the
984
authentication.conf file,
985
- user: can't de different from the provided user if any,
986
- password: the decoded password, could be None if the credential
987
defines only the user
988
- verify_certificates: https specific, True if the server
989
certificate should be verified, False otherwise.
992
for auth_def_name, auth_def in self._get_config().items():
993
a_scheme, a_host, a_user, a_path = map(
994
auth_def.get, ['scheme', 'host', 'user', 'path'])
997
a_port = auth_def.as_int('port')
1001
raise ValueError("'port' not numeric in %s" % auth_def_name)
1003
a_verify_certificates = auth_def.as_bool('verify_certificates')
1005
a_verify_certificates = True
1008
"'verify_certificates' not boolean in %s" % auth_def_name)
1011
if a_scheme is not None and scheme != a_scheme:
1013
if a_host is not None:
1014
if not (host == a_host
1015
or (a_host.startswith('.') and host.endswith(a_host))):
1017
if a_port is not None and port != a_port:
1019
if (a_path is not None and path is not None
1020
and not path.startswith(a_path)):
1022
if (a_user is not None and user is not None
1023
and a_user != user):
1024
# Never contradict the caller about the user to be used
1029
credentials = dict(name=auth_def_name,
1030
user=a_user, password=auth_def['password'],
1031
verify_certificates=a_verify_certificates)
1032
self.decode_password(credentials,
1033
auth_def.get('password_encoding', None))
1034
if 'auth' in debug.debug_flags:
1035
trace.mutter("Using authentication section: %r", auth_def_name)
1040
def get_user(self, scheme, host, port=None,
1041
realm=None, path=None, prompt=None):
1042
"""Get a user from authentication file.
1044
:param scheme: protocol
1046
:param host: the server address
1048
:param port: the associated port (optional)
1050
:param realm: the realm sent by the server (optional)
1052
:param path: the absolute path on the server (optional)
1054
:return: The found user.
1056
credentials = self.get_credentials(scheme, host, port, user=None,
1058
if credentials is not None:
1059
user = credentials['user']
1064
def get_password(self, scheme, host, user, port=None,
1065
realm=None, path=None, prompt=None):
1066
"""Get a password from authentication file or prompt the user for one.
1068
:param scheme: protocol
1070
:param host: the server address
1072
: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 password or the one entered by the user.
1082
credentials = self.get_credentials(scheme, host, port, user, path)
1083
if credentials is not None:
1084
password = credentials['password']
1087
# Prompt user only if we could't find a password
1088
if password is None:
1090
# Create a default prompt suitable for most of the cases
1091
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1092
# Special handling for optional fields in the prompt
1093
if port is not None:
1094
prompt_host = '%s:%d' % (host, port)
1097
password = ui.ui_factory.get_password(prompt,
1098
host=prompt_host, user=user)
1101
def decode_password(self, credentials, encoding):
1105
class TransportConfig(object):
1106
"""A configuration representation that stores data on a Transport.
1108
It is a low-level object that considers config data to be name/value pairs
1109
that may be associated with a section. Assigning meaning to the these
1110
values is done at higher levels like TreeConfig.
1113
def __init__(self, transport, filename):
1114
self._transport = transport
1115
self._filename = filename
1117
def get_option(self, name, section=None, default=None):
1118
"""Return the value associated with a named option.
1120
:param name: The name of the value
1121
:param section: The section the option is in (if any)
1122
:param default: The value to return if the value is not set
1123
:return: The value or default value
1125
configobj = self._get_configobj()
1127
section_obj = configobj
1130
section_obj = configobj[section]
1133
return section_obj.get(name, default)
1135
def set_option(self, value, name, section=None):
1136
"""Set the value associated with a named option.
1138
:param value: The value to set
1139
:param name: The name of the value to set
1140
:param section: The section the option is in (if any)
1142
configobj = self._get_configobj()
1144
configobj[name] = value
1146
configobj.setdefault(section, {})[name] = value
1147
self._set_configobj(configobj)
1149
def _get_configobj(self):
1151
return ConfigObj(self._transport.get(self._filename),
1153
except errors.NoSuchFile:
1154
return ConfigObj(encoding='utf-8')
1156
def _set_configobj(self, configobj):
1157
out_file = StringIO()
1158
configobj.write(out_file)
1160
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
