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
self._set_option(option, value, 'DEFAULT')
445
def get_aliases(self):
446
"""Return the aliases section."""
447
if 'ALIASES' in self._get_parser():
448
return self._get_parser()['ALIASES']
452
def set_alias(self, alias_name, alias_command):
453
"""Save the alias in the configuration."""
454
self._set_option(alias_name, alias_command, 'ALIASES')
456
def unset_alias(self, alias_name):
457
"""Unset an existing alias."""
458
aliases = self._get_parser().get('ALIASES')
459
if not aliases or alias_name not in aliases:
460
raise errors.NoSuchAlias(alias_name)
461
del aliases[alias_name]
462
self._writeConfigFile()
464
def _set_option(self, option, value, section):
465
# FIXME: RBC 20051029 This should refresh the parser and also take a
466
# file lock on bazaar.conf.
467
conf_dir = os.path.dirname(self._get_filename())
468
ensure_config_dir_exists(conf_dir)
469
self._get_parser().setdefault(section, {})[option] = value
470
self._writeConfigFile()
472
def _writeConfigFile(self):
473
f = open(self._get_filename(), 'wb')
474
self._get_parser().write(f)
478
class LocationConfig(IniBasedConfig):
479
"""A configuration object that gives the policy for a location."""
481
def __init__(self, location):
482
name_generator = locations_config_filename
483
if (not os.path.exists(name_generator()) and
484
os.path.exists(branches_config_filename())):
485
if sys.platform == 'win32':
486
trace.warning('Please rename %s to %s'
487
% (branches_config_filename(),
488
locations_config_filename()))
490
trace.warning('Please rename ~/.bazaar/branches.conf'
491
' to ~/.bazaar/locations.conf')
492
name_generator = branches_config_filename
493
super(LocationConfig, self).__init__(name_generator)
494
# local file locations are looked up by local path, rather than
495
# by file url. This is because the config file is a user
496
# file, and we would rather not expose the user to file urls.
497
if location.startswith('file://'):
498
location = urlutils.local_path_from_url(location)
499
self.location = location
501
def _get_matching_sections(self):
502
"""Return an ordered list of section names matching this location."""
503
sections = self._get_parser()
504
location_names = self.location.split('/')
505
if self.location.endswith('/'):
506
del location_names[-1]
508
for section in sections:
509
# location is a local path if possible, so we need
510
# to convert 'file://' urls to local paths if necessary.
511
# This also avoids having file:///path be a more exact
512
# match than '/path'.
513
if section.startswith('file://'):
514
section_path = urlutils.local_path_from_url(section)
516
section_path = section
517
section_names = section_path.split('/')
518
if section.endswith('/'):
519
del section_names[-1]
520
names = zip(location_names, section_names)
523
if not fnmatch(name[0], name[1]):
528
# so, for the common prefix they matched.
529
# if section is longer, no match.
530
if len(section_names) > len(location_names):
532
matches.append((len(section_names), section,
533
'/'.join(location_names[len(section_names):])))
534
matches.sort(reverse=True)
536
for (length, section, extra_path) in matches:
537
sections.append((section, extra_path))
538
# should we stop looking for parent configs here?
540
if self._get_parser()[section].as_bool('ignore_parents'):
546
def _get_option_policy(self, section, option_name):
547
"""Return the policy for the given (section, option_name) pair."""
548
# check for the old 'recurse=False' flag
550
recurse = self._get_parser()[section].as_bool('recurse')
554
return POLICY_NORECURSE
556
policy_key = option_name + ':policy'
558
policy_name = self._get_parser()[section][policy_key]
562
return _policy_value[policy_name]
564
def _set_option_policy(self, section, option_name, option_policy):
565
"""Set the policy for the given option name in the given section."""
566
# The old recurse=False option affects all options in the
567
# section. To handle multiple policies in the section, we
568
# need to convert it to a policy_norecurse key.
570
recurse = self._get_parser()[section].as_bool('recurse')
574
symbol_versioning.warn(
575
'The recurse option is deprecated as of 0.14. '
576
'The section "%s" has been converted to use policies.'
579
del self._get_parser()[section]['recurse']
581
for key in self._get_parser()[section].keys():
582
if not key.endswith(':policy'):
583
self._get_parser()[section][key +
584
':policy'] = 'norecurse'
586
policy_key = option_name + ':policy'
587
policy_name = _policy_name[option_policy]
588
if policy_name is not None:
589
self._get_parser()[section][policy_key] = policy_name
591
if policy_key in self._get_parser()[section]:
592
del self._get_parser()[section][policy_key]
594
def set_user_option(self, option, value, store=STORE_LOCATION):
595
"""Save option and its value in the configuration."""
596
assert store in [STORE_LOCATION,
597
STORE_LOCATION_NORECURSE,
598
STORE_LOCATION_APPENDPATH], 'bad storage policy'
599
# FIXME: RBC 20051029 This should refresh the parser and also take a
600
# file lock on locations.conf.
601
conf_dir = os.path.dirname(self._get_filename())
602
ensure_config_dir_exists(conf_dir)
603
location = self.location
604
if location.endswith('/'):
605
location = location[:-1]
606
if (not location in self._get_parser() and
607
not location + '/' in self._get_parser()):
608
self._get_parser()[location]={}
609
elif location + '/' in self._get_parser():
610
location = location + '/'
611
self._get_parser()[location][option]=value
612
# the allowed values of store match the config policies
613
self._set_option_policy(location, option, store)
614
self._get_parser().write(file(self._get_filename(), 'wb'))
617
class BranchConfig(Config):
618
"""A configuration object giving the policy for a branch."""
620
def _get_branch_data_config(self):
621
if self._branch_data_config is None:
622
self._branch_data_config = TreeConfig(self.branch)
623
return self._branch_data_config
625
def _get_location_config(self):
626
if self._location_config is None:
627
self._location_config = LocationConfig(self.branch.base)
628
return self._location_config
630
def _get_global_config(self):
631
if self._global_config is None:
632
self._global_config = GlobalConfig()
633
return self._global_config
635
def _get_best_value(self, option_name):
636
"""This returns a user option from local, tree or global config.
638
They are tried in that order. Use get_safe_value if trusted values
641
for source in self.option_sources:
642
value = getattr(source(), option_name)()
643
if value is not None:
647
def _get_safe_value(self, option_name):
648
"""This variant of get_best_value never returns untrusted values.
650
It does not return values from the branch data, because the branch may
651
not be controlled by the user.
653
We may wish to allow locations.conf to control whether branches are
654
trusted in the future.
656
for source in (self._get_location_config, self._get_global_config):
657
value = getattr(source(), option_name)()
658
if value is not None:
662
def _get_user_id(self):
663
"""Return the full user id for the branch.
665
e.g. "John Hacker <jhacker@foo.org>"
666
This is looked up in the email controlfile for the branch.
669
return (self.branch.control_files.get_utf8("email")
671
.decode(bzrlib.user_encoding)
673
except errors.NoSuchFile, e:
676
return self._get_best_value('_get_user_id')
678
def _get_signature_checking(self):
679
"""See Config._get_signature_checking."""
680
return self._get_best_value('_get_signature_checking')
682
def _get_signing_policy(self):
683
"""See Config._get_signing_policy."""
684
return self._get_best_value('_get_signing_policy')
686
def _get_user_option(self, option_name):
687
"""See Config._get_user_option."""
688
for source in self.option_sources:
689
value = source()._get_user_option(option_name)
690
if value is not None:
694
def set_user_option(self, name, value, store=STORE_BRANCH,
696
if store == STORE_BRANCH:
697
self._get_branch_data_config().set_option(value, name)
698
elif store == STORE_GLOBAL:
699
self._get_global_config().set_user_option(name, value)
701
self._get_location_config().set_user_option(name, value, store)
704
if store in (STORE_GLOBAL, STORE_BRANCH):
705
mask_value = self._get_location_config().get_user_option(name)
706
if mask_value is not None:
707
trace.warning('Value "%s" is masked by "%s" from'
708
' locations.conf', value, mask_value)
710
if store == STORE_GLOBAL:
711
branch_config = self._get_branch_data_config()
712
mask_value = branch_config.get_user_option(name)
713
if mask_value is not None:
714
trace.warning('Value "%s" is masked by "%s" from'
715
' branch.conf', value, mask_value)
718
def _gpg_signing_command(self):
719
"""See Config.gpg_signing_command."""
720
return self._get_safe_value('_gpg_signing_command')
722
def __init__(self, branch):
723
super(BranchConfig, self).__init__()
724
self._location_config = None
725
self._branch_data_config = None
726
self._global_config = None
728
self.option_sources = (self._get_location_config,
729
self._get_branch_data_config,
730
self._get_global_config)
732
def _post_commit(self):
733
"""See Config.post_commit."""
734
return self._get_safe_value('_post_commit')
736
def _get_nickname(self):
737
value = self._get_explicit_nickname()
738
if value is not None:
740
return urlutils.unescape(self.branch.base.split('/')[-2])
742
def has_explicit_nickname(self):
743
"""Return true if a nickname has been explicitly assigned."""
744
return self._get_explicit_nickname() is not None
746
def _get_explicit_nickname(self):
747
return self._get_best_value('_get_nickname')
749
def _log_format(self):
750
"""See Config.log_format."""
751
return self._get_best_value('_log_format')
754
def ensure_config_dir_exists(path=None):
755
"""Make sure a configuration directory exists.
756
This makes sure that the directory exists.
757
On windows, since configuration directories are 2 levels deep,
758
it makes sure both the directory and the parent directory exists.
762
if not os.path.isdir(path):
763
if sys.platform == 'win32':
764
parent_dir = os.path.dirname(path)
765
if not os.path.isdir(parent_dir):
766
trace.mutter('creating config parent directory: %r', parent_dir)
768
trace.mutter('creating config directory: %r', path)
773
"""Return per-user configuration directory.
775
By default this is ~/.bazaar/
777
TODO: Global option --config-dir to override this.
779
base = os.environ.get('BZR_HOME', None)
780
if sys.platform == 'win32':
782
base = win32utils.get_appdata_location_unicode()
784
base = os.environ.get('HOME', None)
786
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
788
return osutils.pathjoin(base, 'bazaar', '2.0')
790
# cygwin, linux, and darwin all have a $HOME directory
792
base = os.path.expanduser("~")
793
return osutils.pathjoin(base, ".bazaar")
796
def config_filename():
797
"""Return per-user configuration ini file filename."""
798
return osutils.pathjoin(config_dir(), 'bazaar.conf')
801
def branches_config_filename():
802
"""Return per-user configuration ini file filename."""
803
return osutils.pathjoin(config_dir(), 'branches.conf')
806
def locations_config_filename():
807
"""Return per-user configuration ini file filename."""
808
return osutils.pathjoin(config_dir(), 'locations.conf')
811
def authentication_config_filename():
812
"""Return per-user authentication ini file filename."""
813
return osutils.pathjoin(config_dir(), 'authentication.conf')
816
def user_ignore_config_filename():
817
"""Return the user default ignore filename"""
818
return osutils.pathjoin(config_dir(), 'ignore')
822
"""Calculate automatic user identification.
824
Returns (realname, email).
826
Only used when none is set in the environment or the id file.
828
This previously used the FQDN as the default domain, but that can
829
be very slow on machines where DNS is broken. So now we simply
834
if sys.platform == 'win32':
835
name = win32utils.get_user_name_unicode()
837
raise errors.BzrError("Cannot autodetect user name.\n"
838
"Please, set your name with command like:\n"
839
'bzr whoami "Your Name <name@domain.com>"')
840
host = win32utils.get_host_name_unicode()
842
host = socket.gethostname()
843
return name, (name + '@' + host)
848
w = pwd.getpwuid(uid)
850
# we try utf-8 first, because on many variants (like Linux),
851
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
852
# false positives. (many users will have their user encoding set to
853
# latin-1, which cannot raise UnicodeError.)
855
gecos = w.pw_gecos.decode('utf-8')
859
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
860
encoding = bzrlib.user_encoding
862
raise errors.BzrCommandError('Unable to determine your name. '
863
'Use "bzr whoami" to set it.')
865
username = w.pw_name.decode(encoding)
867
raise errors.BzrCommandError('Unable to determine your name. '
868
'Use "bzr whoami" to set it.')
870
comma = gecos.find(',')
874
realname = gecos[:comma]
881
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
882
except UnicodeDecodeError:
883
raise errors.BzrError("Can't decode username as %s." % \
884
bzrlib.user_encoding)
886
return realname, (username + '@' + socket.gethostname())
889
def parse_username(username):
890
"""Parse e-mail username and return a (name, address) tuple."""
891
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
893
return (username, '')
895
return (match.group(1), match.group(2))
898
def extract_email_address(e):
899
"""Return just the address part of an email string.
901
That is just the user@domain part, nothing else.
902
This part is required to contain only ascii characters.
903
If it can't be extracted, raises an error.
905
>>> extract_email_address('Jane Tester <jane@test.com>')
908
name, email = parse_username(e)
910
raise errors.NoEmailInUsername(e)
914
class TreeConfig(IniBasedConfig):
915
"""Branch configuration data associated with its contents, not location"""
917
def __init__(self, branch):
918
transport = branch.control_files._transport
919
self._config = TransportConfig(transport, 'branch.conf')
922
def _get_parser(self, file=None):
924
return IniBasedConfig._get_parser(file)
925
return self._config._get_configobj()
927
def get_option(self, name, section=None, default=None):
928
self.branch.lock_read()
930
return self._config.get_option(name, section, default)
935
def set_option(self, value, name, section=None):
936
"""Set a per-branch configuration option"""
937
self.branch.lock_write()
939
self._config.set_option(value, name, section)
944
class AuthenticationConfig(object):
945
"""The authentication configuration file based on a ini file.
947
Implements the authentication.conf file described in
948
doc/developers/authentication-ring.txt.
951
def __init__(self, _file=None):
952
self._config = None # The ConfigObj
954
self._filename = authentication_config_filename()
955
self._input = self._filename = authentication_config_filename()
957
# Tests can provide a string as _file
958
self._filename = None
961
def _get_config(self):
962
if self._config is not None:
965
# FIXME: Should we validate something here ? Includes: empty
966
# sections are useless, at least one of
967
# user/password/password_encoding should be defined, etc.
969
# Note: the encoding below declares that the file itself is utf-8
970
# encoded, but the values in the ConfigObj are always Unicode.
971
self._config = ConfigObj(self._input, encoding='utf-8')
972
except configobj.ConfigObjError, e:
973
raise errors.ParseConfigError(e.errors, e.config.filename)
977
"""Save the config file, only tests should use it for now."""
978
conf_dir = os.path.dirname(self._filename)
979
ensure_config_dir_exists(conf_dir)
980
self._get_config().write(file(self._filename, 'wb'))
982
def _set_option(self, section_name, option_name, value):
983
"""Set an authentication configuration option"""
984
conf = self._get_config()
985
section = conf.get(section_name)
988
section = conf[section]
989
section[option_name] = value
992
def get_credentials(self, scheme, host, port=None, user=None, path=None):
993
"""Returns the matching credentials from authentication.conf file.
995
:param scheme: protocol
997
:param host: the server address
999
:param port: the associated port (optional)
1001
:param user: login (optional)
1003
:param path: the absolute path on the server (optional)
1005
:return: A dict containing the matching credentials or None.
1007
- name: the section name of the credentials in the
1008
authentication.conf file,
1009
- user: can't de different from the provided user if any,
1010
- password: the decoded password, could be None if the credential
1011
defines only the user
1012
- verify_certificates: https specific, True if the server
1013
certificate should be verified, False otherwise.
1016
for auth_def_name, auth_def in self._get_config().items():
1017
a_scheme, a_host, a_user, a_path = map(
1018
auth_def.get, ['scheme', 'host', 'user', 'path'])
1021
a_port = auth_def.as_int('port')
1025
raise ValueError("'port' not numeric in %s" % auth_def_name)
1027
a_verify_certificates = auth_def.as_bool('verify_certificates')
1029
a_verify_certificates = True
1032
"'verify_certificates' not boolean in %s" % auth_def_name)
1035
if a_scheme is not None and scheme != a_scheme:
1037
if a_host is not None:
1038
if not (host == a_host
1039
or (a_host.startswith('.') and host.endswith(a_host))):
1041
if a_port is not None and port != a_port:
1043
if (a_path is not None and path is not None
1044
and not path.startswith(a_path)):
1046
if (a_user is not None and user is not None
1047
and a_user != user):
1048
# Never contradict the caller about the user to be used
1053
credentials = dict(name=auth_def_name,
1054
user=a_user, password=auth_def['password'],
1055
verify_certificates=a_verify_certificates)
1056
self.decode_password(credentials,
1057
auth_def.get('password_encoding', None))
1058
if 'auth' in debug.debug_flags:
1059
trace.mutter("Using authentication section: %r", auth_def_name)
1064
def get_user(self, scheme, host, port=None,
1065
realm=None, path=None, prompt=None):
1066
"""Get a user from authentication file.
1068
:param scheme: protocol
1070
:param host: the server address
1072
:param port: the associated port (optional)
1074
:param realm: the realm sent by the server (optional)
1076
:param path: the absolute path on the server (optional)
1078
:return: The found user.
1080
credentials = self.get_credentials(scheme, host, port, user=None,
1082
if credentials is not None:
1083
user = credentials['user']
1088
def get_password(self, scheme, host, user, port=None,
1089
realm=None, path=None, prompt=None):
1090
"""Get a password from authentication file or prompt the user for one.
1092
:param scheme: protocol
1094
:param host: the server address
1096
:param port: the associated port (optional)
1100
:param realm: the realm sent by the server (optional)
1102
:param path: the absolute path on the server (optional)
1104
:return: The found password or the one entered by the user.
1106
credentials = self.get_credentials(scheme, host, port, user, path)
1107
if credentials is not None:
1108
password = credentials['password']
1111
# Prompt user only if we could't find a password
1112
if password is None:
1114
# Create a default prompt suitable for most of the cases
1115
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1116
# Special handling for optional fields in the prompt
1117
if port is not None:
1118
prompt_host = '%s:%d' % (host, port)
1121
password = ui.ui_factory.get_password(prompt,
1122
host=prompt_host, user=user)
1125
def decode_password(self, credentials, encoding):
1129
class TransportConfig(object):
1130
"""A Config that reads/writes a config file on a Transport.
1132
It is a low-level object that considers config data to be name/value pairs
1133
that may be associated with a section. Assigning meaning to the these
1134
values is done at higher levels like TreeConfig.
1137
def __init__(self, transport, filename):
1138
self._transport = transport
1139
self._filename = filename
1141
def get_option(self, name, section=None, default=None):
1142
"""Return the value associated with a named option.
1144
:param name: The name of the value
1145
:param section: The section the option is in (if any)
1146
:param default: The value to return if the value is not set
1147
:return: The value or default value
1149
configobj = self._get_configobj()
1151
section_obj = configobj
1154
section_obj = configobj[section]
1157
return section_obj.get(name, default)
1159
def set_option(self, value, name, section=None):
1160
"""Set the value associated with a named option.
1162
:param value: The value to set
1163
:param name: The name of the value to set
1164
:param section: The section the option is in (if any)
1166
configobj = self._get_configobj()
1168
configobj[name] = value
1170
configobj.setdefault(section, {})[name] = value
1171
self._set_configobj(configobj)
1173
def _get_configobj(self):
1175
return ConfigObj(self._transport.get(self._filename),
1177
except errors.NoSuchFile:
1178
return ConfigObj(encoding='utf-8')
1180
def _set_configobj(self, configobj):
1181
out_file = StringIO()
1182
configobj.write(out_file)
1184
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
