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
'emacsclient': mail_client.EmacsMail,
155
'evolution': mail_client.Evolution,
156
'kmail': mail_client.KMail,
157
'mutt': mail_client.Mutt,
158
'thunderbird': mail_client.Thunderbird,
160
'default': mail_client.DefaultMail,
161
'editor': mail_client.Editor,
162
'mapi': mail_client.MAPIClient,
163
'xdg-email': mail_client.XDGEmail,
166
raise errors.UnknownMailClient(selected_client)
167
return mail_client_class(self)
169
def _get_signature_checking(self):
170
"""Template method to override signature checking policy."""
172
def _get_signing_policy(self):
173
"""Template method to override signature creation policy."""
175
def _get_user_option(self, option_name):
176
"""Template method to provide a user option."""
179
def get_user_option(self, option_name):
180
"""Get a generic option - no special process, no default."""
181
return self._get_user_option(option_name)
183
def gpg_signing_command(self):
184
"""What program should be used to sign signatures?"""
185
result = self._gpg_signing_command()
190
def _gpg_signing_command(self):
191
"""See gpg_signing_command()."""
194
def log_format(self):
195
"""What log format should be used"""
196
result = self._log_format()
201
def _log_format(self):
202
"""See log_format()."""
206
super(Config, self).__init__()
208
def post_commit(self):
209
"""An ordered list of python functions to call.
211
Each function takes branch, rev_id as parameters.
213
return self._post_commit()
215
def _post_commit(self):
216
"""See Config.post_commit."""
219
def user_email(self):
220
"""Return just the email component of a username."""
221
return extract_email_address(self.username())
224
"""Return email-style username.
226
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
228
$BZR_EMAIL can be set to override this (as well as the
229
deprecated $BZREMAIL), then
230
the concrete policy type is checked, and finally
232
If none is found, a reasonable default is (hopefully)
235
TODO: Check it's reasonably well-formed.
237
v = os.environ.get('BZR_EMAIL')
239
return v.decode(bzrlib.user_encoding)
241
v = self._get_user_id()
245
v = os.environ.get('EMAIL')
247
return v.decode(bzrlib.user_encoding)
249
name, email = _auto_user_id()
251
return '%s <%s>' % (name, email)
255
def signature_checking(self):
256
"""What is the current policy for signature checking?."""
257
policy = self._get_signature_checking()
258
if policy is not None:
260
return CHECK_IF_POSSIBLE
262
def signing_policy(self):
263
"""What is the current policy for signature checking?."""
264
policy = self._get_signing_policy()
265
if policy is not None:
267
return SIGN_WHEN_REQUIRED
269
def signature_needed(self):
270
"""Is a signature needed when committing ?."""
271
policy = self._get_signing_policy()
273
policy = self._get_signature_checking()
274
if policy is not None:
275
trace.warning("Please use create_signatures,"
276
" not check_signatures to set signing policy.")
277
if policy == CHECK_ALWAYS:
279
elif policy == SIGN_ALWAYS:
283
def get_alias(self, value):
284
return self._get_alias(value)
286
def _get_alias(self, value):
289
def get_nickname(self):
290
return self._get_nickname()
292
def _get_nickname(self):
295
def get_bzr_remote_path(self):
297
return os.environ['BZR_REMOTE_PATH']
299
path = self.get_user_option("bzr_remote_path")
305
class IniBasedConfig(Config):
306
"""A configuration policy that draws from ini files."""
308
def _get_parser(self, file=None):
309
if self._parser is not None:
312
input = self._get_filename()
316
self._parser = ConfigObj(input, encoding='utf-8')
317
except configobj.ConfigObjError, e:
318
raise errors.ParseConfigError(e.errors, e.config.filename)
321
def _get_matching_sections(self):
322
"""Return an ordered list of (section_name, extra_path) pairs.
324
If the section contains inherited configuration, extra_path is
325
a string containing the additional path components.
327
section = self._get_section()
328
if section is not None:
329
return [(section, '')]
333
def _get_section(self):
334
"""Override this to define the section used by the config."""
337
def _get_option_policy(self, section, option_name):
338
"""Return the policy for the given (section, option_name) pair."""
341
def _get_signature_checking(self):
342
"""See Config._get_signature_checking."""
343
policy = self._get_user_option('check_signatures')
345
return self._string_to_signature_policy(policy)
347
def _get_signing_policy(self):
348
"""See Config._get_signing_policy"""
349
policy = self._get_user_option('create_signatures')
351
return self._string_to_signing_policy(policy)
353
def _get_user_id(self):
354
"""Get the user id from the 'email' key in the current section."""
355
return self._get_user_option('email')
357
def _get_user_option(self, option_name):
358
"""See Config._get_user_option."""
359
for (section, extra_path) in self._get_matching_sections():
361
value = self._get_parser().get_value(section, option_name)
364
policy = self._get_option_policy(section, option_name)
365
if policy == POLICY_NONE:
367
elif policy == POLICY_NORECURSE:
368
# norecurse items only apply to the exact path
373
elif policy == POLICY_APPENDPATH:
375
value = urlutils.join(value, extra_path)
378
raise AssertionError('Unexpected config policy %r' % policy)
382
def _gpg_signing_command(self):
383
"""See Config.gpg_signing_command."""
384
return self._get_user_option('gpg_signing_command')
386
def _log_format(self):
387
"""See Config.log_format."""
388
return self._get_user_option('log_format')
390
def __init__(self, get_filename):
391
super(IniBasedConfig, self).__init__()
392
self._get_filename = get_filename
395
def _post_commit(self):
396
"""See Config.post_commit."""
397
return self._get_user_option('post_commit')
399
def _string_to_signature_policy(self, signature_string):
400
"""Convert a string to a signing policy."""
401
if signature_string.lower() == 'check-available':
402
return CHECK_IF_POSSIBLE
403
if signature_string.lower() == 'ignore':
405
if signature_string.lower() == 'require':
407
raise errors.BzrError("Invalid signatures policy '%s'"
410
def _string_to_signing_policy(self, signature_string):
411
"""Convert a string to a signing policy."""
412
if signature_string.lower() == 'when-required':
413
return SIGN_WHEN_REQUIRED
414
if signature_string.lower() == 'never':
416
if signature_string.lower() == 'always':
418
raise errors.BzrError("Invalid signing policy '%s'"
421
def _get_alias(self, value):
423
return self._get_parser().get_value("ALIASES",
428
def _get_nickname(self):
429
return self.get_user_option('nickname')
432
class GlobalConfig(IniBasedConfig):
433
"""The configuration that should be used for a specific location."""
435
def get_editor(self):
436
return self._get_user_option('editor')
439
super(GlobalConfig, self).__init__(config_filename)
441
def set_user_option(self, option, value):
442
"""Save option and its value in the configuration."""
443
# FIXME: RBC 20051029 This should refresh the parser and also take a
444
# file lock on bazaar.conf.
445
conf_dir = os.path.dirname(self._get_filename())
446
ensure_config_dir_exists(conf_dir)
447
if 'DEFAULT' not in self._get_parser():
448
self._get_parser()['DEFAULT'] = {}
449
self._get_parser()['DEFAULT'][option] = value
450
f = open(self._get_filename(), 'wb')
451
self._get_parser().write(f)
455
class LocationConfig(IniBasedConfig):
456
"""A configuration object that gives the policy for a location."""
458
def __init__(self, location):
459
name_generator = locations_config_filename
460
if (not os.path.exists(name_generator()) and
461
os.path.exists(branches_config_filename())):
462
if sys.platform == 'win32':
463
trace.warning('Please rename %s to %s'
464
% (branches_config_filename(),
465
locations_config_filename()))
467
trace.warning('Please rename ~/.bazaar/branches.conf'
468
' to ~/.bazaar/locations.conf')
469
name_generator = branches_config_filename
470
super(LocationConfig, self).__init__(name_generator)
471
# local file locations are looked up by local path, rather than
472
# by file url. This is because the config file is a user
473
# file, and we would rather not expose the user to file urls.
474
if location.startswith('file://'):
475
location = urlutils.local_path_from_url(location)
476
self.location = location
478
def _get_matching_sections(self):
479
"""Return an ordered list of section names matching this location."""
480
sections = self._get_parser()
481
location_names = self.location.split('/')
482
if self.location.endswith('/'):
483
del location_names[-1]
485
for section in sections:
486
# location is a local path if possible, so we need
487
# to convert 'file://' urls to local paths if necessary.
488
# This also avoids having file:///path be a more exact
489
# match than '/path'.
490
if section.startswith('file://'):
491
section_path = urlutils.local_path_from_url(section)
493
section_path = section
494
section_names = section_path.split('/')
495
if section.endswith('/'):
496
del section_names[-1]
497
names = zip(location_names, section_names)
500
if not fnmatch(name[0], name[1]):
505
# so, for the common prefix they matched.
506
# if section is longer, no match.
507
if len(section_names) > len(location_names):
509
matches.append((len(section_names), section,
510
'/'.join(location_names[len(section_names):])))
511
matches.sort(reverse=True)
513
for (length, section, extra_path) in matches:
514
sections.append((section, extra_path))
515
# should we stop looking for parent configs here?
517
if self._get_parser()[section].as_bool('ignore_parents'):
523
def _get_option_policy(self, section, option_name):
524
"""Return the policy for the given (section, option_name) pair."""
525
# check for the old 'recurse=False' flag
527
recurse = self._get_parser()[section].as_bool('recurse')
531
return POLICY_NORECURSE
533
policy_key = option_name + ':policy'
535
policy_name = self._get_parser()[section][policy_key]
539
return _policy_value[policy_name]
541
def _set_option_policy(self, section, option_name, option_policy):
542
"""Set the policy for the given option name in the given section."""
543
# The old recurse=False option affects all options in the
544
# section. To handle multiple policies in the section, we
545
# need to convert it to a policy_norecurse key.
547
recurse = self._get_parser()[section].as_bool('recurse')
551
symbol_versioning.warn(
552
'The recurse option is deprecated as of 0.14. '
553
'The section "%s" has been converted to use policies.'
556
del self._get_parser()[section]['recurse']
558
for key in self._get_parser()[section].keys():
559
if not key.endswith(':policy'):
560
self._get_parser()[section][key +
561
':policy'] = 'norecurse'
563
policy_key = option_name + ':policy'
564
policy_name = _policy_name[option_policy]
565
if policy_name is not None:
566
self._get_parser()[section][policy_key] = policy_name
568
if policy_key in self._get_parser()[section]:
569
del self._get_parser()[section][policy_key]
571
def set_user_option(self, option, value, store=STORE_LOCATION):
572
"""Save option and its value in the configuration."""
573
if store not in [STORE_LOCATION,
574
STORE_LOCATION_NORECURSE,
575
STORE_LOCATION_APPENDPATH]:
576
raise ValueError('bad storage policy %r for %r' %
578
# FIXME: RBC 20051029 This should refresh the parser and also take a
579
# file lock on locations.conf.
580
conf_dir = os.path.dirname(self._get_filename())
581
ensure_config_dir_exists(conf_dir)
582
location = self.location
583
if location.endswith('/'):
584
location = location[:-1]
585
if (not location in self._get_parser() and
586
not location + '/' in self._get_parser()):
587
self._get_parser()[location]={}
588
elif location + '/' in self._get_parser():
589
location = location + '/'
590
self._get_parser()[location][option]=value
591
# the allowed values of store match the config policies
592
self._set_option_policy(location, option, store)
593
self._get_parser().write(file(self._get_filename(), 'wb'))
596
class BranchConfig(Config):
597
"""A configuration object giving the policy for a branch."""
599
def _get_branch_data_config(self):
600
if self._branch_data_config is None:
601
self._branch_data_config = TreeConfig(self.branch)
602
return self._branch_data_config
604
def _get_location_config(self):
605
if self._location_config is None:
606
self._location_config = LocationConfig(self.branch.base)
607
return self._location_config
609
def _get_global_config(self):
610
if self._global_config is None:
611
self._global_config = GlobalConfig()
612
return self._global_config
614
def _get_best_value(self, option_name):
615
"""This returns a user option from local, tree or global config.
617
They are tried in that order. Use get_safe_value if trusted values
620
for source in self.option_sources:
621
value = getattr(source(), option_name)()
622
if value is not None:
626
def _get_safe_value(self, option_name):
627
"""This variant of get_best_value never returns untrusted values.
629
It does not return values from the branch data, because the branch may
630
not be controlled by the user.
632
We may wish to allow locations.conf to control whether branches are
633
trusted in the future.
635
for source in (self._get_location_config, self._get_global_config):
636
value = getattr(source(), option_name)()
637
if value is not None:
641
def _get_user_id(self):
642
"""Return the full user id for the branch.
644
e.g. "John Hacker <jhacker@foo.org>"
645
This is looked up in the email controlfile for the branch.
648
return (self.branch.control_files._transport.get_bytes("email")
649
.decode(bzrlib.user_encoding)
651
except errors.NoSuchFile, e:
654
return self._get_best_value('_get_user_id')
656
def _get_signature_checking(self):
657
"""See Config._get_signature_checking."""
658
return self._get_best_value('_get_signature_checking')
660
def _get_signing_policy(self):
661
"""See Config._get_signing_policy."""
662
return self._get_best_value('_get_signing_policy')
664
def _get_user_option(self, option_name):
665
"""See Config._get_user_option."""
666
for source in self.option_sources:
667
value = source()._get_user_option(option_name)
668
if value is not None:
672
def set_user_option(self, name, value, store=STORE_BRANCH,
674
if store == STORE_BRANCH:
675
self._get_branch_data_config().set_option(value, name)
676
elif store == STORE_GLOBAL:
677
self._get_global_config().set_user_option(name, value)
679
self._get_location_config().set_user_option(name, value, store)
682
if store in (STORE_GLOBAL, STORE_BRANCH):
683
mask_value = self._get_location_config().get_user_option(name)
684
if mask_value is not None:
685
trace.warning('Value "%s" is masked by "%s" from'
686
' locations.conf', value, mask_value)
688
if store == STORE_GLOBAL:
689
branch_config = self._get_branch_data_config()
690
mask_value = branch_config.get_user_option(name)
691
if mask_value is not None:
692
trace.warning('Value "%s" is masked by "%s" from'
693
' branch.conf', value, mask_value)
696
def _gpg_signing_command(self):
697
"""See Config.gpg_signing_command."""
698
return self._get_safe_value('_gpg_signing_command')
700
def __init__(self, branch):
701
super(BranchConfig, self).__init__()
702
self._location_config = None
703
self._branch_data_config = None
704
self._global_config = None
706
self.option_sources = (self._get_location_config,
707
self._get_branch_data_config,
708
self._get_global_config)
710
def _post_commit(self):
711
"""See Config.post_commit."""
712
return self._get_safe_value('_post_commit')
714
def _get_nickname(self):
715
value = self._get_explicit_nickname()
716
if value is not None:
718
return urlutils.unescape(self.branch.base.split('/')[-2])
720
def has_explicit_nickname(self):
721
"""Return true if a nickname has been explicitly assigned."""
722
return self._get_explicit_nickname() is not None
724
def _get_explicit_nickname(self):
725
return self._get_best_value('_get_nickname')
727
def _log_format(self):
728
"""See Config.log_format."""
729
return self._get_best_value('_log_format')
732
def ensure_config_dir_exists(path=None):
733
"""Make sure a configuration directory exists.
734
This makes sure that the directory exists.
735
On windows, since configuration directories are 2 levels deep,
736
it makes sure both the directory and the parent directory exists.
740
if not os.path.isdir(path):
741
if sys.platform == 'win32':
742
parent_dir = os.path.dirname(path)
743
if not os.path.isdir(parent_dir):
744
trace.mutter('creating config parent directory: %r', parent_dir)
746
trace.mutter('creating config directory: %r', path)
751
"""Return per-user configuration directory.
753
By default this is ~/.bazaar/
755
TODO: Global option --config-dir to override this.
757
base = os.environ.get('BZR_HOME', None)
758
if sys.platform == 'win32':
760
base = win32utils.get_appdata_location_unicode()
762
base = os.environ.get('HOME', None)
764
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
766
return osutils.pathjoin(base, 'bazaar', '2.0')
768
# cygwin, linux, and darwin all have a $HOME directory
770
base = os.path.expanduser("~")
771
return osutils.pathjoin(base, ".bazaar")
774
def config_filename():
775
"""Return per-user configuration ini file filename."""
776
return osutils.pathjoin(config_dir(), 'bazaar.conf')
779
def branches_config_filename():
780
"""Return per-user configuration ini file filename."""
781
return osutils.pathjoin(config_dir(), 'branches.conf')
784
def locations_config_filename():
785
"""Return per-user configuration ini file filename."""
786
return osutils.pathjoin(config_dir(), 'locations.conf')
789
def authentication_config_filename():
790
"""Return per-user authentication ini file filename."""
791
return osutils.pathjoin(config_dir(), 'authentication.conf')
794
def user_ignore_config_filename():
795
"""Return the user default ignore filename"""
796
return osutils.pathjoin(config_dir(), 'ignore')
800
"""Calculate automatic user identification.
802
Returns (realname, email).
804
Only used when none is set in the environment or the id file.
806
This previously used the FQDN as the default domain, but that can
807
be very slow on machines where DNS is broken. So now we simply
812
if sys.platform == 'win32':
813
name = win32utils.get_user_name_unicode()
815
raise errors.BzrError("Cannot autodetect user name.\n"
816
"Please, set your name with command like:\n"
817
'bzr whoami "Your Name <name@domain.com>"')
818
host = win32utils.get_host_name_unicode()
820
host = socket.gethostname()
821
return name, (name + '@' + host)
826
w = pwd.getpwuid(uid)
828
# we try utf-8 first, because on many variants (like Linux),
829
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
830
# false positives. (many users will have their user encoding set to
831
# latin-1, which cannot raise UnicodeError.)
833
gecos = w.pw_gecos.decode('utf-8')
837
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
838
encoding = bzrlib.user_encoding
840
raise errors.BzrCommandError('Unable to determine your name. '
841
'Use "bzr whoami" to set it.')
843
username = w.pw_name.decode(encoding)
845
raise errors.BzrCommandError('Unable to determine your name. '
846
'Use "bzr whoami" to set it.')
848
comma = gecos.find(',')
852
realname = gecos[:comma]
859
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
860
except UnicodeDecodeError:
861
raise errors.BzrError("Can't decode username as %s." % \
862
bzrlib.user_encoding)
864
return realname, (username + '@' + socket.gethostname())
867
def parse_username(username):
868
"""Parse e-mail username and return a (name, address) tuple."""
869
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
871
return (username, '')
873
return (match.group(1), match.group(2))
876
def extract_email_address(e):
877
"""Return just the address part of an email string.
879
That is just the user@domain part, nothing else.
880
This part is required to contain only ascii characters.
881
If it can't be extracted, raises an error.
883
>>> extract_email_address('Jane Tester <jane@test.com>')
886
name, email = parse_username(e)
888
raise errors.NoEmailInUsername(e)
892
class TreeConfig(IniBasedConfig):
893
"""Branch configuration data associated with its contents, not location"""
895
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
897
def __init__(self, branch):
898
transport = branch.control_files._transport
899
self._config = TransportConfig(transport, 'branch.conf')
902
def _get_parser(self, file=None):
904
return IniBasedConfig._get_parser(file)
905
return self._config._get_configobj()
907
def get_option(self, name, section=None, default=None):
908
self.branch.lock_read()
910
return self._config.get_option(name, section, default)
915
def set_option(self, value, name, section=None):
916
"""Set a per-branch configuration option"""
917
self.branch.lock_write()
919
self._config.set_option(value, name, section)
924
class AuthenticationConfig(object):
925
"""The authentication configuration file based on a ini file.
927
Implements the authentication.conf file described in
928
doc/developers/authentication-ring.txt.
931
def __init__(self, _file=None):
932
self._config = None # The ConfigObj
934
self._filename = authentication_config_filename()
935
self._input = self._filename = authentication_config_filename()
937
# Tests can provide a string as _file
938
self._filename = None
941
def _get_config(self):
942
if self._config is not None:
945
# FIXME: Should we validate something here ? Includes: empty
946
# sections are useless, at least one of
947
# user/password/password_encoding should be defined, etc.
949
# Note: the encoding below declares that the file itself is utf-8
950
# encoded, but the values in the ConfigObj are always Unicode.
951
self._config = ConfigObj(self._input, encoding='utf-8')
952
except configobj.ConfigObjError, e:
953
raise errors.ParseConfigError(e.errors, e.config.filename)
957
"""Save the config file, only tests should use it for now."""
958
conf_dir = os.path.dirname(self._filename)
959
ensure_config_dir_exists(conf_dir)
960
self._get_config().write(file(self._filename, 'wb'))
962
def _set_option(self, section_name, option_name, value):
963
"""Set an authentication configuration option"""
964
conf = self._get_config()
965
section = conf.get(section_name)
968
section = conf[section]
969
section[option_name] = value
972
def get_credentials(self, scheme, host, port=None, user=None, path=None):
973
"""Returns the matching credentials from authentication.conf file.
975
:param scheme: protocol
977
:param host: the server address
979
:param port: the associated port (optional)
981
:param user: login (optional)
983
:param path: the absolute path on the server (optional)
985
:return: A dict containing the matching credentials or None.
987
- name: the section name of the credentials in the
988
authentication.conf file,
989
- user: can't de different from the provided user if any,
990
- password: the decoded password, could be None if the credential
991
defines only the user
992
- verify_certificates: https specific, True if the server
993
certificate should be verified, False otherwise.
996
for auth_def_name, auth_def in self._get_config().items():
997
if type(auth_def) is not configobj.Section:
998
raise ValueError("%s defined outside a section" % auth_def_name)
1000
a_scheme, a_host, a_user, a_path = map(
1001
auth_def.get, ['scheme', 'host', 'user', 'path'])
1004
a_port = auth_def.as_int('port')
1008
raise ValueError("'port' not numeric in %s" % auth_def_name)
1010
a_verify_certificates = auth_def.as_bool('verify_certificates')
1012
a_verify_certificates = True
1015
"'verify_certificates' not boolean in %s" % auth_def_name)
1018
if a_scheme is not None and scheme != a_scheme:
1020
if a_host is not None:
1021
if not (host == a_host
1022
or (a_host.startswith('.') and host.endswith(a_host))):
1024
if a_port is not None and port != a_port:
1026
if (a_path is not None and path is not None
1027
and not path.startswith(a_path)):
1029
if (a_user is not None and user is not None
1030
and a_user != user):
1031
# Never contradict the caller about the user to be used
1036
credentials = dict(name=auth_def_name,
1038
password=auth_def.get('password', None),
1039
verify_certificates=a_verify_certificates)
1040
self.decode_password(credentials,
1041
auth_def.get('password_encoding', None))
1042
if 'auth' in debug.debug_flags:
1043
trace.mutter("Using authentication section: %r", auth_def_name)
1048
def get_user(self, scheme, host, port=None,
1049
realm=None, path=None, prompt=None):
1050
"""Get a user from authentication file.
1052
:param scheme: protocol
1054
:param host: the server address
1056
:param port: the associated port (optional)
1058
:param realm: the realm sent by the server (optional)
1060
:param path: the absolute path on the server (optional)
1062
:return: The found user.
1064
credentials = self.get_credentials(scheme, host, port, user=None,
1066
if credentials is not None:
1067
user = credentials['user']
1072
def get_password(self, scheme, host, user, port=None,
1073
realm=None, path=None, prompt=None):
1074
"""Get a password from authentication file or prompt the user for one.
1076
:param scheme: protocol
1078
:param host: the server address
1080
:param port: the associated port (optional)
1084
:param realm: the realm sent by the server (optional)
1086
:param path: the absolute path on the server (optional)
1088
:return: The found password or the one entered by the user.
1090
credentials = self.get_credentials(scheme, host, port, user, path)
1091
if credentials is not None:
1092
password = credentials['password']
1093
if password is not None and scheme is 'ssh':
1094
trace.warning('password ignored in section [%s],'
1095
' use an ssh agent instead'
1096
% credentials['name'])
1100
# Prompt user only if we could't find a password
1101
if password is None:
1103
# Create a default prompt suitable for most cases
1104
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1105
# Special handling for optional fields in the prompt
1106
if port is not None:
1107
prompt_host = '%s:%d' % (host, port)
1110
password = ui.ui_factory.get_password(prompt,
1111
host=prompt_host, user=user)
1114
def decode_password(self, credentials, encoding):
1118
class TransportConfig(object):
1119
"""A Config that reads/writes a config file on a Transport.
1121
It is a low-level object that considers config data to be name/value pairs
1122
that may be associated with a section. Assigning meaning to the these
1123
values is done at higher levels like TreeConfig.
1126
def __init__(self, transport, filename):
1127
self._transport = transport
1128
self._filename = filename
1130
def get_option(self, name, section=None, default=None):
1131
"""Return the value associated with a named option.
1133
:param name: The name of the value
1134
:param section: The section the option is in (if any)
1135
:param default: The value to return if the value is not set
1136
:return: The value or default value
1138
configobj = self._get_configobj()
1140
section_obj = configobj
1143
section_obj = configobj[section]
1146
return section_obj.get(name, default)
1148
def set_option(self, value, name, section=None):
1149
"""Set the value associated with a named option.
1151
:param value: The value to set
1152
:param name: The name of the value to set
1153
:param section: The section the option is in (if any)
1155
configobj = self._get_configobj()
1157
configobj[name] = value
1159
configobj.setdefault(section, {})[name] = value
1160
self._set_configobj(configobj)
1162
def _get_configobj(self):
1164
return ConfigObj(self._transport.get(self._filename),
1166
except errors.NoSuchFile:
1167
return ConfigObj(encoding='utf-8')
1169
def _set_configobj(self, configobj):
1170
out_file = StringIO()
1171
configobj.write(out_file)
1173
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
