1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
89
from bzrlib.util.configobj import configobj
105
POLICY_APPENDPATH = 2
109
POLICY_NORECURSE: 'norecurse',
110
POLICY_APPENDPATH: 'appendpath',
115
'norecurse': POLICY_NORECURSE,
116
'appendpath': POLICY_APPENDPATH,
120
STORE_LOCATION = POLICY_NONE
121
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
122
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
127
def ConfigObj(*args, **kwargs):
129
if _ConfigObj is None:
130
class ConfigObj(configobj.ConfigObj):
132
def get_bool(self, section, key):
133
return self[section].as_bool(key)
135
def get_value(self, section, name):
136
# Try [] for the old DEFAULT section.
137
if section == "DEFAULT":
142
return self[section][name]
143
_ConfigObj = ConfigObj
144
return _ConfigObj(*args, **kwargs)
147
class Config(object):
148
"""A configuration policy - what username, editor, gpg needs etc."""
151
super(Config, self).__init__()
153
def get_editor(self):
154
"""Get the users pop up editor."""
155
raise NotImplementedError
157
def get_change_editor(self, old_tree, new_tree):
158
from bzrlib import diff
159
cmd = self._get_change_editor()
162
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
166
def get_mail_client(self):
167
"""Get a mail client to use"""
168
selected_client = self.get_user_option('mail_client')
169
_registry = mail_client.mail_client_registry
171
mail_client_class = _registry.get(selected_client)
173
raise errors.UnknownMailClient(selected_client)
174
return mail_client_class(self)
176
def _get_signature_checking(self):
177
"""Template method to override signature checking policy."""
179
def _get_signing_policy(self):
180
"""Template method to override signature creation policy."""
182
def _get_user_option(self, option_name):
183
"""Template method to provide a user option."""
186
def get_user_option(self, option_name):
187
"""Get a generic option - no special process, no default."""
188
return self._get_user_option(option_name)
190
def get_user_option_as_bool(self, option_name):
191
"""Get a generic option as a boolean - no special process, no default.
193
:return None if the option doesn't exist or its value can't be
194
interpreted as a boolean. Returns True or False otherwise.
196
s = self._get_user_option(option_name)
198
# The option doesn't exist
200
val = ui.bool_from_string(s)
202
# The value can't be interpreted as a boolean
203
trace.warning('Value "%s" is not a boolean for "%s"',
207
def get_user_option_as_list(self, option_name):
208
"""Get a generic option as a list - no special process, no default.
210
:return None if the option doesn't exist. Returns the value as a list
213
l = self._get_user_option(option_name)
214
if isinstance(l, (str, unicode)):
215
# A single value, most probably the user forgot the final ','
219
def gpg_signing_command(self):
220
"""What program should be used to sign signatures?"""
221
result = self._gpg_signing_command()
226
def _gpg_signing_command(self):
227
"""See gpg_signing_command()."""
230
def log_format(self):
231
"""What log format should be used"""
232
result = self._log_format()
237
def _log_format(self):
238
"""See log_format()."""
241
def post_commit(self):
242
"""An ordered list of python functions to call.
244
Each function takes branch, rev_id as parameters.
246
return self._post_commit()
248
def _post_commit(self):
249
"""See Config.post_commit."""
252
def user_email(self):
253
"""Return just the email component of a username."""
254
return extract_email_address(self.username())
257
"""Return email-style username.
259
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
261
$BZR_EMAIL can be set to override this, then
262
the concrete policy type is checked, and finally
264
If no username can be found, errors.NoWhoami exception is raised.
266
TODO: Check it's reasonably well-formed.
268
v = os.environ.get('BZR_EMAIL')
270
return v.decode(osutils.get_user_encoding())
272
v = self._get_user_id()
276
v = os.environ.get('EMAIL')
278
return v.decode(osutils.get_user_encoding())
280
raise errors.NoWhoami()
282
def ensure_username(self):
283
"""Raise errors.NoWhoami if username is not set.
285
This method relies on the username() function raising the error.
289
def signature_checking(self):
290
"""What is the current policy for signature checking?."""
291
policy = self._get_signature_checking()
292
if policy is not None:
294
return CHECK_IF_POSSIBLE
296
def signing_policy(self):
297
"""What is the current policy for signature checking?."""
298
policy = self._get_signing_policy()
299
if policy is not None:
301
return SIGN_WHEN_REQUIRED
303
def signature_needed(self):
304
"""Is a signature needed when committing ?."""
305
policy = self._get_signing_policy()
307
policy = self._get_signature_checking()
308
if policy is not None:
309
trace.warning("Please use create_signatures,"
310
" not check_signatures to set signing policy.")
311
if policy == CHECK_ALWAYS:
313
elif policy == SIGN_ALWAYS:
317
def get_alias(self, value):
318
return self._get_alias(value)
320
def _get_alias(self, value):
323
def get_nickname(self):
324
return self._get_nickname()
326
def _get_nickname(self):
329
def get_bzr_remote_path(self):
331
return os.environ['BZR_REMOTE_PATH']
333
path = self.get_user_option("bzr_remote_path")
338
def suppress_warning(self, warning):
339
"""Should the warning be suppressed or emitted.
341
:param warning: The name of the warning being tested.
343
:returns: True if the warning should be suppressed, False otherwise.
345
warnings = self.get_user_option_as_list('suppress_warnings')
346
if warnings is None or warning not in warnings:
352
class IniBasedConfig(Config):
353
"""A configuration policy that draws from ini files."""
355
def __init__(self, get_filename):
356
super(IniBasedConfig, self).__init__()
357
self._get_filename = get_filename
360
def _get_parser(self, file=None):
361
if self._parser is not None:
364
input = self._get_filename()
368
self._parser = ConfigObj(input, encoding='utf-8')
369
except configobj.ConfigObjError, e:
370
raise errors.ParseConfigError(e.errors, e.config.filename)
373
def _get_matching_sections(self):
374
"""Return an ordered list of (section_name, extra_path) pairs.
376
If the section contains inherited configuration, extra_path is
377
a string containing the additional path components.
379
section = self._get_section()
380
if section is not None:
381
return [(section, '')]
385
def _get_section(self):
386
"""Override this to define the section used by the config."""
389
def _get_option_policy(self, section, option_name):
390
"""Return the policy for the given (section, option_name) pair."""
393
def _get_change_editor(self):
394
return self.get_user_option('change_editor')
396
def _get_signature_checking(self):
397
"""See Config._get_signature_checking."""
398
policy = self._get_user_option('check_signatures')
400
return self._string_to_signature_policy(policy)
402
def _get_signing_policy(self):
403
"""See Config._get_signing_policy"""
404
policy = self._get_user_option('create_signatures')
406
return self._string_to_signing_policy(policy)
408
def _get_user_id(self):
409
"""Get the user id from the 'email' key in the current section."""
410
return self._get_user_option('email')
412
def _get_user_option(self, option_name):
413
"""See Config._get_user_option."""
414
for (section, extra_path) in self._get_matching_sections():
416
value = self._get_parser().get_value(section, option_name)
419
policy = self._get_option_policy(section, option_name)
420
if policy == POLICY_NONE:
422
elif policy == POLICY_NORECURSE:
423
# norecurse items only apply to the exact path
428
elif policy == POLICY_APPENDPATH:
430
value = urlutils.join(value, extra_path)
433
raise AssertionError('Unexpected config policy %r' % policy)
437
def _gpg_signing_command(self):
438
"""See Config.gpg_signing_command."""
439
return self._get_user_option('gpg_signing_command')
441
def _log_format(self):
442
"""See Config.log_format."""
443
return self._get_user_option('log_format')
445
def _post_commit(self):
446
"""See Config.post_commit."""
447
return self._get_user_option('post_commit')
449
def _string_to_signature_policy(self, signature_string):
450
"""Convert a string to a signing policy."""
451
if signature_string.lower() == 'check-available':
452
return CHECK_IF_POSSIBLE
453
if signature_string.lower() == 'ignore':
455
if signature_string.lower() == 'require':
457
raise errors.BzrError("Invalid signatures policy '%s'"
460
def _string_to_signing_policy(self, signature_string):
461
"""Convert a string to a signing policy."""
462
if signature_string.lower() == 'when-required':
463
return SIGN_WHEN_REQUIRED
464
if signature_string.lower() == 'never':
466
if signature_string.lower() == 'always':
468
raise errors.BzrError("Invalid signing policy '%s'"
471
def _get_alias(self, value):
473
return self._get_parser().get_value("ALIASES",
478
def _get_nickname(self):
479
return self.get_user_option('nickname')
481
def _write_config_file(self):
482
filename = self._get_filename()
483
atomic_file = atomicfile.AtomicFile(filename)
484
self._get_parser().write(atomic_file)
487
osutils.copy_ownership_from_path(filename)
490
class GlobalConfig(IniBasedConfig):
491
"""The configuration that should be used for a specific location."""
493
def get_editor(self):
494
return self._get_user_option('editor')
497
super(GlobalConfig, self).__init__(config_filename)
499
def set_user_option(self, option, value):
500
"""Save option and its value in the configuration."""
501
self._set_option(option, value, 'DEFAULT')
503
def get_aliases(self):
504
"""Return the aliases section."""
505
if 'ALIASES' in self._get_parser():
506
return self._get_parser()['ALIASES']
510
def set_alias(self, alias_name, alias_command):
511
"""Save the alias in the configuration."""
512
self._set_option(alias_name, alias_command, 'ALIASES')
514
def unset_alias(self, alias_name):
515
"""Unset an existing alias."""
516
aliases = self._get_parser().get('ALIASES')
517
if not aliases or alias_name not in aliases:
518
raise errors.NoSuchAlias(alias_name)
519
del aliases[alias_name]
520
self._write_config_file()
522
def _set_option(self, option, value, section):
523
# FIXME: RBC 20051029 This should refresh the parser and also take a
524
# file lock on bazaar.conf.
525
conf_dir = os.path.dirname(self._get_filename())
526
ensure_config_dir_exists(conf_dir)
527
self._get_parser().setdefault(section, {})[option] = value
528
self._write_config_file()
531
class LocationConfig(IniBasedConfig):
532
"""A configuration object that gives the policy for a location."""
534
def __init__(self, location):
535
name_generator = locations_config_filename
536
if (not os.path.exists(name_generator()) and
537
os.path.exists(branches_config_filename())):
538
if sys.platform == 'win32':
539
trace.warning('Please rename %s to %s'
540
% (branches_config_filename(),
541
locations_config_filename()))
543
trace.warning('Please rename ~/.bazaar/branches.conf'
544
' to ~/.bazaar/locations.conf')
545
name_generator = branches_config_filename
546
super(LocationConfig, self).__init__(name_generator)
547
# local file locations are looked up by local path, rather than
548
# by file url. This is because the config file is a user
549
# file, and we would rather not expose the user to file urls.
550
if location.startswith('file://'):
551
location = urlutils.local_path_from_url(location)
552
self.location = location
554
def _get_matching_sections(self):
555
"""Return an ordered list of section names matching this location."""
556
sections = self._get_parser()
557
location_names = self.location.split('/')
558
if self.location.endswith('/'):
559
del location_names[-1]
561
for section in sections:
562
# location is a local path if possible, so we need
563
# to convert 'file://' urls to local paths if necessary.
564
# This also avoids having file:///path be a more exact
565
# match than '/path'.
566
if section.startswith('file://'):
567
section_path = urlutils.local_path_from_url(section)
569
section_path = section
570
section_names = section_path.split('/')
571
if section.endswith('/'):
572
del section_names[-1]
573
names = zip(location_names, section_names)
576
if not fnmatch(name[0], name[1]):
581
# so, for the common prefix they matched.
582
# if section is longer, no match.
583
if len(section_names) > len(location_names):
585
matches.append((len(section_names), section,
586
'/'.join(location_names[len(section_names):])))
587
matches.sort(reverse=True)
589
for (length, section, extra_path) in matches:
590
sections.append((section, extra_path))
591
# should we stop looking for parent configs here?
593
if self._get_parser()[section].as_bool('ignore_parents'):
599
def _get_option_policy(self, section, option_name):
600
"""Return the policy for the given (section, option_name) pair."""
601
# check for the old 'recurse=False' flag
603
recurse = self._get_parser()[section].as_bool('recurse')
607
return POLICY_NORECURSE
609
policy_key = option_name + ':policy'
611
policy_name = self._get_parser()[section][policy_key]
615
return _policy_value[policy_name]
617
def _set_option_policy(self, section, option_name, option_policy):
618
"""Set the policy for the given option name in the given section."""
619
# The old recurse=False option affects all options in the
620
# section. To handle multiple policies in the section, we
621
# need to convert it to a policy_norecurse key.
623
recurse = self._get_parser()[section].as_bool('recurse')
627
symbol_versioning.warn(
628
'The recurse option is deprecated as of 0.14. '
629
'The section "%s" has been converted to use policies.'
632
del self._get_parser()[section]['recurse']
634
for key in self._get_parser()[section].keys():
635
if not key.endswith(':policy'):
636
self._get_parser()[section][key +
637
':policy'] = 'norecurse'
639
policy_key = option_name + ':policy'
640
policy_name = _policy_name[option_policy]
641
if policy_name is not None:
642
self._get_parser()[section][policy_key] = policy_name
644
if policy_key in self._get_parser()[section]:
645
del self._get_parser()[section][policy_key]
647
def set_user_option(self, option, value, store=STORE_LOCATION):
648
"""Save option and its value in the configuration."""
649
if store not in [STORE_LOCATION,
650
STORE_LOCATION_NORECURSE,
651
STORE_LOCATION_APPENDPATH]:
652
raise ValueError('bad storage policy %r for %r' %
654
# FIXME: RBC 20051029 This should refresh the parser and also take a
655
# file lock on locations.conf.
656
conf_dir = os.path.dirname(self._get_filename())
657
ensure_config_dir_exists(conf_dir)
658
location = self.location
659
if location.endswith('/'):
660
location = location[:-1]
661
if (not location in self._get_parser() and
662
not location + '/' in self._get_parser()):
663
self._get_parser()[location]={}
664
elif location + '/' in self._get_parser():
665
location = location + '/'
666
self._get_parser()[location][option]=value
667
# the allowed values of store match the config policies
668
self._set_option_policy(location, option, store)
669
self._write_config_file()
672
class BranchConfig(Config):
673
"""A configuration object giving the policy for a branch."""
675
def _get_branch_data_config(self):
676
if self._branch_data_config is None:
677
self._branch_data_config = TreeConfig(self.branch)
678
return self._branch_data_config
680
def _get_location_config(self):
681
if self._location_config is None:
682
self._location_config = LocationConfig(self.branch.base)
683
return self._location_config
685
def _get_global_config(self):
686
if self._global_config is None:
687
self._global_config = GlobalConfig()
688
return self._global_config
690
def _get_best_value(self, option_name):
691
"""This returns a user option from local, tree or global config.
693
They are tried in that order. Use get_safe_value if trusted values
696
for source in self.option_sources:
697
value = getattr(source(), option_name)()
698
if value is not None:
702
def _get_safe_value(self, option_name):
703
"""This variant of get_best_value never returns untrusted values.
705
It does not return values from the branch data, because the branch may
706
not be controlled by the user.
708
We may wish to allow locations.conf to control whether branches are
709
trusted in the future.
711
for source in (self._get_location_config, self._get_global_config):
712
value = getattr(source(), option_name)()
713
if value is not None:
717
def _get_user_id(self):
718
"""Return the full user id for the branch.
720
e.g. "John Hacker <jhacker@example.com>"
721
This is looked up in the email controlfile for the branch.
724
return (self.branch._transport.get_bytes("email")
725
.decode(osutils.get_user_encoding())
727
except errors.NoSuchFile, e:
730
return self._get_best_value('_get_user_id')
732
def _get_change_editor(self):
733
return self._get_best_value('_get_change_editor')
735
def _get_signature_checking(self):
736
"""See Config._get_signature_checking."""
737
return self._get_best_value('_get_signature_checking')
739
def _get_signing_policy(self):
740
"""See Config._get_signing_policy."""
741
return self._get_best_value('_get_signing_policy')
743
def _get_user_option(self, option_name):
744
"""See Config._get_user_option."""
745
for source in self.option_sources:
746
value = source()._get_user_option(option_name)
747
if value is not None:
751
def set_user_option(self, name, value, store=STORE_BRANCH,
753
if store == STORE_BRANCH:
754
self._get_branch_data_config().set_option(value, name)
755
elif store == STORE_GLOBAL:
756
self._get_global_config().set_user_option(name, value)
758
self._get_location_config().set_user_option(name, value, store)
761
if store in (STORE_GLOBAL, STORE_BRANCH):
762
mask_value = self._get_location_config().get_user_option(name)
763
if mask_value is not None:
764
trace.warning('Value "%s" is masked by "%s" from'
765
' locations.conf', value, mask_value)
767
if store == STORE_GLOBAL:
768
branch_config = self._get_branch_data_config()
769
mask_value = branch_config.get_user_option(name)
770
if mask_value is not None:
771
trace.warning('Value "%s" is masked by "%s" from'
772
' branch.conf', value, mask_value)
774
def _gpg_signing_command(self):
775
"""See Config.gpg_signing_command."""
776
return self._get_safe_value('_gpg_signing_command')
778
def __init__(self, branch):
779
super(BranchConfig, self).__init__()
780
self._location_config = None
781
self._branch_data_config = None
782
self._global_config = None
784
self.option_sources = (self._get_location_config,
785
self._get_branch_data_config,
786
self._get_global_config)
788
def _post_commit(self):
789
"""See Config.post_commit."""
790
return self._get_safe_value('_post_commit')
792
def _get_nickname(self):
793
value = self._get_explicit_nickname()
794
if value is not None:
796
return urlutils.unescape(self.branch.base.split('/')[-2])
798
def has_explicit_nickname(self):
799
"""Return true if a nickname has been explicitly assigned."""
800
return self._get_explicit_nickname() is not None
802
def _get_explicit_nickname(self):
803
return self._get_best_value('_get_nickname')
805
def _log_format(self):
806
"""See Config.log_format."""
807
return self._get_best_value('_log_format')
810
def ensure_config_dir_exists(path=None):
811
"""Make sure a configuration directory exists.
812
This makes sure that the directory exists.
813
On windows, since configuration directories are 2 levels deep,
814
it makes sure both the directory and the parent directory exists.
818
if not os.path.isdir(path):
819
if sys.platform == 'win32':
820
parent_dir = os.path.dirname(path)
821
if not os.path.isdir(parent_dir):
822
trace.mutter('creating config parent directory: %r', parent_dir)
824
trace.mutter('creating config directory: %r', path)
826
osutils.copy_ownership_from_path(path)
830
"""Return per-user configuration directory.
832
By default this is ~/.bazaar/
834
TODO: Global option --config-dir to override this.
836
base = os.environ.get('BZR_HOME', None)
837
if sys.platform == 'win32':
839
base = win32utils.get_appdata_location_unicode()
841
base = os.environ.get('HOME', None)
843
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
845
return osutils.pathjoin(base, 'bazaar', '2.0')
848
base = os.path.expanduser("~")
849
return osutils.pathjoin(base, ".bazaar")
852
def config_filename():
853
"""Return per-user configuration ini file filename."""
854
return osutils.pathjoin(config_dir(), 'bazaar.conf')
857
def branches_config_filename():
858
"""Return per-user configuration ini file filename."""
859
return osutils.pathjoin(config_dir(), 'branches.conf')
862
def locations_config_filename():
863
"""Return per-user configuration ini file filename."""
864
return osutils.pathjoin(config_dir(), 'locations.conf')
867
def authentication_config_filename():
868
"""Return per-user authentication ini file filename."""
869
return osutils.pathjoin(config_dir(), 'authentication.conf')
872
def user_ignore_config_filename():
873
"""Return the user default ignore filename"""
874
return osutils.pathjoin(config_dir(), 'ignore')
878
"""Return the directory name to store crash files.
880
This doesn't implicitly create it.
882
On Windows it's in the config directory; elsewhere it's /var/crash
883
which may be monitored by apport. It can be overridden by
886
if sys.platform == 'win32':
887
return osutils.pathjoin(config_dir(), 'Crash')
889
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
891
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
895
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
896
# Possibly this should be different on Windows?
897
e = os.environ.get('XDG_CACHE_DIR', None)
901
return os.path.expanduser('~/.cache')
904
def parse_username(username):
905
"""Parse e-mail username and return a (name, address) tuple."""
906
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
908
return (username, '')
910
return (match.group(1), match.group(2))
913
def extract_email_address(e):
914
"""Return just the address part of an email string.
916
That is just the user@domain part, nothing else.
917
This part is required to contain only ascii characters.
918
If it can't be extracted, raises an error.
920
>>> extract_email_address('Jane Tester <jane@test.com>')
923
name, email = parse_username(e)
925
raise errors.NoEmailInUsername(e)
929
class TreeConfig(IniBasedConfig):
930
"""Branch configuration data associated with its contents, not location"""
932
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
934
def __init__(self, branch):
935
self._config = branch._get_config()
938
def _get_parser(self, file=None):
940
return IniBasedConfig._get_parser(file)
941
return self._config._get_configobj()
943
def get_option(self, name, section=None, default=None):
944
self.branch.lock_read()
946
return self._config.get_option(name, section, default)
950
def set_option(self, value, name, section=None):
951
"""Set a per-branch configuration option"""
952
self.branch.lock_write()
954
self._config.set_option(value, name, section)
959
class AuthenticationConfig(object):
960
"""The authentication configuration file based on a ini file.
962
Implements the authentication.conf file described in
963
doc/developers/authentication-ring.txt.
966
def __init__(self, _file=None):
967
self._config = None # The ConfigObj
969
self._filename = authentication_config_filename()
970
self._input = self._filename = authentication_config_filename()
972
# Tests can provide a string as _file
973
self._filename = None
976
def _get_config(self):
977
if self._config is not None:
980
# FIXME: Should we validate something here ? Includes: empty
981
# sections are useless, at least one of
982
# user/password/password_encoding should be defined, etc.
984
# Note: the encoding below declares that the file itself is utf-8
985
# encoded, but the values in the ConfigObj are always Unicode.
986
self._config = ConfigObj(self._input, encoding='utf-8')
987
except configobj.ConfigObjError, e:
988
raise errors.ParseConfigError(e.errors, e.config.filename)
992
"""Save the config file, only tests should use it for now."""
993
conf_dir = os.path.dirname(self._filename)
994
ensure_config_dir_exists(conf_dir)
995
f = file(self._filename, 'wb')
997
self._get_config().write(f)
1001
def _set_option(self, section_name, option_name, value):
1002
"""Set an authentication configuration option"""
1003
conf = self._get_config()
1004
section = conf.get(section_name)
1007
section = conf[section]
1008
section[option_name] = value
1011
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1013
"""Returns the matching credentials from authentication.conf file.
1015
:param scheme: protocol
1017
:param host: the server address
1019
:param port: the associated port (optional)
1021
:param user: login (optional)
1023
:param path: the absolute path on the server (optional)
1025
:param realm: the http authentication realm (optional)
1027
:return: A dict containing the matching credentials or None.
1029
- name: the section name of the credentials in the
1030
authentication.conf file,
1031
- user: can't be different from the provided user if any,
1032
- scheme: the server protocol,
1033
- host: the server address,
1034
- port: the server port (can be None),
1035
- path: the absolute server path (can be None),
1036
- realm: the http specific authentication realm (can be None),
1037
- password: the decoded password, could be None if the credential
1038
defines only the user
1039
- verify_certificates: https specific, True if the server
1040
certificate should be verified, False otherwise.
1043
for auth_def_name, auth_def in self._get_config().items():
1044
if type(auth_def) is not configobj.Section:
1045
raise ValueError("%s defined outside a section" % auth_def_name)
1047
a_scheme, a_host, a_user, a_path = map(
1048
auth_def.get, ['scheme', 'host', 'user', 'path'])
1051
a_port = auth_def.as_int('port')
1055
raise ValueError("'port' not numeric in %s" % auth_def_name)
1057
a_verify_certificates = auth_def.as_bool('verify_certificates')
1059
a_verify_certificates = True
1062
"'verify_certificates' not boolean in %s" % auth_def_name)
1065
if a_scheme is not None and scheme != a_scheme:
1067
if a_host is not None:
1068
if not (host == a_host
1069
or (a_host.startswith('.') and host.endswith(a_host))):
1071
if a_port is not None and port != a_port:
1073
if (a_path is not None and path is not None
1074
and not path.startswith(a_path)):
1076
if (a_user is not None and user is not None
1077
and a_user != user):
1078
# Never contradict the caller about the user to be used
1083
# Prepare a credentials dictionary with additional keys
1084
# for the credential providers
1085
credentials = dict(name=auth_def_name,
1092
password=auth_def.get('password', None),
1093
verify_certificates=a_verify_certificates)
1094
# Decode the password in the credentials (or get one)
1095
self.decode_password(credentials,
1096
auth_def.get('password_encoding', None))
1097
if 'auth' in debug.debug_flags:
1098
trace.mutter("Using authentication section: %r", auth_def_name)
1101
if credentials is None:
1102
# No credentials were found in authentication.conf, try the fallback
1103
# credentials stores.
1104
credentials = credential_store_registry.get_fallback_credentials(
1105
scheme, host, port, user, path, realm)
1109
def set_credentials(self, name, host, user, scheme=None, password=None,
1110
port=None, path=None, verify_certificates=None,
1112
"""Set authentication credentials for a host.
1114
Any existing credentials with matching scheme, host, port and path
1115
will be deleted, regardless of name.
1117
:param name: An arbitrary name to describe this set of credentials.
1118
:param host: Name of the host that accepts these credentials.
1119
:param user: The username portion of these credentials.
1120
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1122
:param password: Password portion of these credentials.
1123
:param port: The IP port on the host that these credentials apply to.
1124
:param path: A filesystem path on the host that these credentials
1126
:param verify_certificates: On https, verify server certificates if
1128
:param realm: The http authentication realm (optional).
1130
values = {'host': host, 'user': user}
1131
if password is not None:
1132
values['password'] = password
1133
if scheme is not None:
1134
values['scheme'] = scheme
1135
if port is not None:
1136
values['port'] = '%d' % port
1137
if path is not None:
1138
values['path'] = path
1139
if verify_certificates is not None:
1140
values['verify_certificates'] = str(verify_certificates)
1141
if realm is not None:
1142
values['realm'] = realm
1143
config = self._get_config()
1145
for section, existing_values in config.items():
1146
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1147
if existing_values.get(key) != values.get(key):
1151
config.update({name: values})
1154
def get_user(self, scheme, host, port=None, realm=None, path=None,
1155
prompt=None, ask=False, default=None):
1156
"""Get a user from authentication file.
1158
:param scheme: protocol
1160
:param host: the server address
1162
:param port: the associated port (optional)
1164
:param realm: the realm sent by the server (optional)
1166
:param path: the absolute path on the server (optional)
1168
:param ask: Ask the user if there is no explicitly configured username
1171
:param default: The username returned if none is defined (optional).
1173
:return: The found user.
1175
credentials = self.get_credentials(scheme, host, port, user=None,
1176
path=path, realm=realm)
1177
if credentials is not None:
1178
user = credentials['user']
1184
# Create a default prompt suitable for most cases
1185
prompt = scheme.upper() + ' %(host)s username'
1186
# Special handling for optional fields in the prompt
1187
if port is not None:
1188
prompt_host = '%s:%d' % (host, port)
1191
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1196
def get_password(self, scheme, host, user, port=None,
1197
realm=None, path=None, prompt=None):
1198
"""Get a password from authentication file or prompt the user for one.
1200
:param scheme: protocol
1202
:param host: the server address
1204
:param port: the associated port (optional)
1208
:param realm: the realm sent by the server (optional)
1210
:param path: the absolute path on the server (optional)
1212
:return: The found password or the one entered by the user.
1214
credentials = self.get_credentials(scheme, host, port, user, path,
1216
if credentials is not None:
1217
password = credentials['password']
1218
if password is not None and scheme is 'ssh':
1219
trace.warning('password ignored in section [%s],'
1220
' use an ssh agent instead'
1221
% credentials['name'])
1225
# Prompt user only if we could't find a password
1226
if password is None:
1228
# Create a default prompt suitable for most cases
1229
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1230
# Special handling for optional fields in the prompt
1231
if port is not None:
1232
prompt_host = '%s:%d' % (host, port)
1235
password = ui.ui_factory.get_password(prompt,
1236
host=prompt_host, user=user)
1239
def decode_password(self, credentials, encoding):
1241
cs = credential_store_registry.get_credential_store(encoding)
1243
raise ValueError('%r is not a known password_encoding' % encoding)
1244
credentials['password'] = cs.decode_password(credentials)
1248
class CredentialStoreRegistry(registry.Registry):
1249
"""A class that registers credential stores.
1251
A credential store provides access to credentials via the password_encoding
1252
field in authentication.conf sections.
1254
Except for stores provided by bzr itself, most stores are expected to be
1255
provided by plugins that will therefore use
1256
register_lazy(password_encoding, module_name, member_name, help=help,
1257
fallback=fallback) to install themselves.
1259
A fallback credential store is one that is queried if no credentials can be
1260
found via authentication.conf.
1263
def get_credential_store(self, encoding=None):
1264
cs = self.get(encoding)
1269
def is_fallback(self, name):
1270
"""Check if the named credentials store should be used as fallback."""
1271
return self.get_info(name)
1273
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1274
path=None, realm=None):
1275
"""Request credentials from all fallback credentials stores.
1277
The first credentials store that can provide credentials wins.
1280
for name in self.keys():
1281
if not self.is_fallback(name):
1283
cs = self.get_credential_store(name)
1284
credentials = cs.get_credentials(scheme, host, port, user,
1286
if credentials is not None:
1287
# We found some credentials
1291
def register(self, key, obj, help=None, override_existing=False,
1293
"""Register a new object to a name.
1295
:param key: This is the key to use to request the object later.
1296
:param obj: The object to register.
1297
:param help: Help text for this entry. This may be a string or
1298
a callable. If it is a callable, it should take two
1299
parameters (registry, key): this registry and the key that
1300
the help was registered under.
1301
:param override_existing: Raise KeyErorr if False and something has
1302
already been registered for that key. If True, ignore if there
1303
is an existing key (always register the new value).
1304
:param fallback: Whether this credential store should be
1307
return super(CredentialStoreRegistry,
1308
self).register(key, obj, help, info=fallback,
1309
override_existing=override_existing)
1311
def register_lazy(self, key, module_name, member_name,
1312
help=None, override_existing=False,
1314
"""Register a new credential store to be loaded on request.
1316
:param module_name: The python path to the module. Such as 'os.path'.
1317
:param member_name: The member of the module to return. If empty or
1318
None, get() will return the module itself.
1319
:param help: Help text for this entry. This may be a string or
1321
:param override_existing: If True, replace the existing object
1322
with the new one. If False, if there is already something
1323
registered with the same key, raise a KeyError
1324
:param fallback: Whether this credential store should be
1327
return super(CredentialStoreRegistry, self).register_lazy(
1328
key, module_name, member_name, help,
1329
info=fallback, override_existing=override_existing)
1332
credential_store_registry = CredentialStoreRegistry()
1335
class CredentialStore(object):
1336
"""An abstract class to implement storage for credentials"""
1338
def decode_password(self, credentials):
1339
"""Returns a clear text password for the provided credentials."""
1340
raise NotImplementedError(self.decode_password)
1342
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1344
"""Return the matching credentials from this credential store.
1346
This method is only called on fallback credential stores.
1348
raise NotImplementedError(self.get_credentials)
1352
class PlainTextCredentialStore(CredentialStore):
1353
__doc__ = """Plain text credential store for the authentication.conf file"""
1355
def decode_password(self, credentials):
1356
"""See CredentialStore.decode_password."""
1357
return credentials['password']
1360
credential_store_registry.register('plain', PlainTextCredentialStore,
1361
help=PlainTextCredentialStore.__doc__)
1362
credential_store_registry.default_key = 'plain'
1365
class BzrDirConfig(object):
1367
def __init__(self, bzrdir):
1368
self._bzrdir = bzrdir
1369
self._config = bzrdir._get_config()
1371
def set_default_stack_on(self, value):
1372
"""Set the default stacking location.
1374
It may be set to a location, or None.
1376
This policy affects all branches contained by this bzrdir, except for
1377
those under repositories.
1379
if self._config is None:
1380
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1382
self._config.set_option('', 'default_stack_on')
1384
self._config.set_option(value, 'default_stack_on')
1386
def get_default_stack_on(self):
1387
"""Return the default stacking location.
1389
This will either be a location, or None.
1391
This policy affects all branches contained by this bzrdir, except for
1392
those under repositories.
1394
if self._config is None:
1396
value = self._config.get_option('default_stack_on')
1402
class TransportConfig(object):
1403
"""A Config that reads/writes a config file on a Transport.
1405
It is a low-level object that considers config data to be name/value pairs
1406
that may be associated with a section. Assigning meaning to the these
1407
values is done at higher levels like TreeConfig.
1410
def __init__(self, transport, filename):
1411
self._transport = transport
1412
self._filename = filename
1414
def get_option(self, name, section=None, default=None):
1415
"""Return the value associated with a named option.
1417
:param name: The name of the value
1418
:param section: The section the option is in (if any)
1419
:param default: The value to return if the value is not set
1420
:return: The value or default value
1422
configobj = self._get_configobj()
1424
section_obj = configobj
1427
section_obj = configobj[section]
1430
return section_obj.get(name, default)
1432
def set_option(self, value, name, section=None):
1433
"""Set the value associated with a named option.
1435
:param value: The value to set
1436
:param name: The name of the value to set
1437
:param section: The section the option is in (if any)
1439
configobj = self._get_configobj()
1441
configobj[name] = value
1443
configobj.setdefault(section, {})[name] = value
1444
self._set_configobj(configobj)
1446
def _get_config_file(self):
1448
return StringIO(self._transport.get_bytes(self._filename))
1449
except errors.NoSuchFile:
1452
def _get_configobj(self):
1453
f = self._get_config_file()
1455
return ConfigObj(f, encoding='utf-8')
1459
def _set_configobj(self, configobj):
1460
out_file = StringIO()
1461
configobj.write(out_file)
1463
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
