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
88
from bzrlib.util.configobj import configobj
104
POLICY_APPENDPATH = 2
108
POLICY_NORECURSE: 'norecurse',
109
POLICY_APPENDPATH: 'appendpath',
114
'norecurse': POLICY_NORECURSE,
115
'appendpath': POLICY_APPENDPATH,
119
STORE_LOCATION = POLICY_NONE
120
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
121
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
126
def ConfigObj(*args, **kwargs):
128
if _ConfigObj is None:
129
class ConfigObj(configobj.ConfigObj):
131
def get_bool(self, section, key):
132
return self[section].as_bool(key)
134
def get_value(self, section, name):
135
# Try [] for the old DEFAULT section.
136
if section == "DEFAULT":
141
return self[section][name]
142
_ConfigObj = ConfigObj
143
return _ConfigObj(*args, **kwargs)
146
class Config(object):
147
"""A configuration policy - what username, editor, gpg needs etc."""
150
super(Config, self).__init__()
152
def get_editor(self):
153
"""Get the users pop up editor."""
154
raise NotImplementedError
156
def get_change_editor(self, old_tree, new_tree):
157
from bzrlib import diff
158
cmd = self._get_change_editor()
161
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
165
def get_mail_client(self):
166
"""Get a mail client to use"""
167
selected_client = self.get_user_option('mail_client')
168
_registry = mail_client.mail_client_registry
170
mail_client_class = _registry.get(selected_client)
172
raise errors.UnknownMailClient(selected_client)
173
return mail_client_class(self)
175
def _get_signature_checking(self):
176
"""Template method to override signature checking policy."""
178
def _get_signing_policy(self):
179
"""Template method to override signature creation policy."""
181
def _get_user_option(self, option_name):
182
"""Template method to provide a user option."""
185
def get_user_option(self, option_name):
186
"""Get a generic option - no special process, no default."""
187
return self._get_user_option(option_name)
189
def get_user_option_as_bool(self, option_name):
190
"""Get a generic option as a boolean - no special process, no default.
192
:return None if the option doesn't exist or its value can't be
193
interpreted as a boolean. Returns True or False otherwise.
195
s = self._get_user_option(option_name)
197
# The option doesn't exist
199
val = ui.bool_from_string(s)
201
# The value can't be interpreted as a boolean
202
trace.warning('Value "%s" is not a boolean for "%s"',
206
def get_user_option_as_list(self, option_name):
207
"""Get a generic option as a list - no special process, no default.
209
:return None if the option doesn't exist. Returns the value as a list
212
l = self._get_user_option(option_name)
213
if isinstance(l, (str, unicode)):
214
# A single value, most probably the user forgot the final ','
218
def gpg_signing_command(self):
219
"""What program should be used to sign signatures?"""
220
result = self._gpg_signing_command()
225
def _gpg_signing_command(self):
226
"""See gpg_signing_command()."""
229
def log_format(self):
230
"""What log format should be used"""
231
result = self._log_format()
236
def _log_format(self):
237
"""See log_format()."""
240
def post_commit(self):
241
"""An ordered list of python functions to call.
243
Each function takes branch, rev_id as parameters.
245
return self._post_commit()
247
def _post_commit(self):
248
"""See Config.post_commit."""
251
def user_email(self):
252
"""Return just the email component of a username."""
253
return extract_email_address(self.username())
256
"""Return email-style username.
258
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
260
$BZR_EMAIL can be set to override this, then
261
the concrete policy type is checked, and finally
263
If no username can be found, errors.NoWhoami exception is raised.
265
TODO: Check it's reasonably well-formed.
267
v = os.environ.get('BZR_EMAIL')
269
return v.decode(osutils.get_user_encoding())
271
v = self._get_user_id()
275
v = os.environ.get('EMAIL')
277
return v.decode(osutils.get_user_encoding())
279
raise errors.NoWhoami()
281
def ensure_username(self):
282
"""Raise errors.NoWhoami if username is not set.
284
This method relies on the username() function raising the error.
288
def signature_checking(self):
289
"""What is the current policy for signature checking?."""
290
policy = self._get_signature_checking()
291
if policy is not None:
293
return CHECK_IF_POSSIBLE
295
def signing_policy(self):
296
"""What is the current policy for signature checking?."""
297
policy = self._get_signing_policy()
298
if policy is not None:
300
return SIGN_WHEN_REQUIRED
302
def signature_needed(self):
303
"""Is a signature needed when committing ?."""
304
policy = self._get_signing_policy()
306
policy = self._get_signature_checking()
307
if policy is not None:
308
trace.warning("Please use create_signatures,"
309
" not check_signatures to set signing policy.")
310
if policy == CHECK_ALWAYS:
312
elif policy == SIGN_ALWAYS:
316
def get_alias(self, value):
317
return self._get_alias(value)
319
def _get_alias(self, value):
322
def get_nickname(self):
323
return self._get_nickname()
325
def _get_nickname(self):
328
def get_bzr_remote_path(self):
330
return os.environ['BZR_REMOTE_PATH']
332
path = self.get_user_option("bzr_remote_path")
337
def suppress_warning(self, warning):
338
"""Should the warning be suppressed or emitted.
340
:param warning: The name of the warning being tested.
342
:returns: True if the warning should be suppressed, False otherwise.
344
warnings = self.get_user_option_as_list('suppress_warnings')
345
if warnings is None or warning not in warnings:
351
class IniBasedConfig(Config):
352
"""A configuration policy that draws from ini files."""
354
def __init__(self, get_filename):
355
super(IniBasedConfig, self).__init__()
356
self._get_filename = get_filename
359
def _get_parser(self, file=None):
360
if self._parser is not None:
363
input = self._get_filename()
367
self._parser = ConfigObj(input, encoding='utf-8')
368
except configobj.ConfigObjError, e:
369
raise errors.ParseConfigError(e.errors, e.config.filename)
372
def _get_matching_sections(self):
373
"""Return an ordered list of (section_name, extra_path) pairs.
375
If the section contains inherited configuration, extra_path is
376
a string containing the additional path components.
378
section = self._get_section()
379
if section is not None:
380
return [(section, '')]
384
def _get_section(self):
385
"""Override this to define the section used by the config."""
388
def _get_option_policy(self, section, option_name):
389
"""Return the policy for the given (section, option_name) pair."""
392
def _get_change_editor(self):
393
return self.get_user_option('change_editor')
395
def _get_signature_checking(self):
396
"""See Config._get_signature_checking."""
397
policy = self._get_user_option('check_signatures')
399
return self._string_to_signature_policy(policy)
401
def _get_signing_policy(self):
402
"""See Config._get_signing_policy"""
403
policy = self._get_user_option('create_signatures')
405
return self._string_to_signing_policy(policy)
407
def _get_user_id(self):
408
"""Get the user id from the 'email' key in the current section."""
409
return self._get_user_option('email')
411
def _get_user_option(self, option_name):
412
"""See Config._get_user_option."""
413
for (section, extra_path) in self._get_matching_sections():
415
value = self._get_parser().get_value(section, option_name)
418
policy = self._get_option_policy(section, option_name)
419
if policy == POLICY_NONE:
421
elif policy == POLICY_NORECURSE:
422
# norecurse items only apply to the exact path
427
elif policy == POLICY_APPENDPATH:
429
value = urlutils.join(value, extra_path)
432
raise AssertionError('Unexpected config policy %r' % policy)
436
def _gpg_signing_command(self):
437
"""See Config.gpg_signing_command."""
438
return self._get_user_option('gpg_signing_command')
440
def _log_format(self):
441
"""See Config.log_format."""
442
return self._get_user_option('log_format')
444
def _post_commit(self):
445
"""See Config.post_commit."""
446
return self._get_user_option('post_commit')
448
def _string_to_signature_policy(self, signature_string):
449
"""Convert a string to a signing policy."""
450
if signature_string.lower() == 'check-available':
451
return CHECK_IF_POSSIBLE
452
if signature_string.lower() == 'ignore':
454
if signature_string.lower() == 'require':
456
raise errors.BzrError("Invalid signatures policy '%s'"
459
def _string_to_signing_policy(self, signature_string):
460
"""Convert a string to a signing policy."""
461
if signature_string.lower() == 'when-required':
462
return SIGN_WHEN_REQUIRED
463
if signature_string.lower() == 'never':
465
if signature_string.lower() == 'always':
467
raise errors.BzrError("Invalid signing policy '%s'"
470
def _get_alias(self, value):
472
return self._get_parser().get_value("ALIASES",
477
def _get_nickname(self):
478
return self.get_user_option('nickname')
481
class GlobalConfig(IniBasedConfig):
482
"""The configuration that should be used for a specific location."""
484
def get_editor(self):
485
return self._get_user_option('editor')
488
super(GlobalConfig, self).__init__(config_filename)
490
def set_user_option(self, option, value):
491
"""Save option and its value in the configuration."""
492
self._set_option(option, value, 'DEFAULT')
494
def get_aliases(self):
495
"""Return the aliases section."""
496
if 'ALIASES' in self._get_parser():
497
return self._get_parser()['ALIASES']
501
def set_alias(self, alias_name, alias_command):
502
"""Save the alias in the configuration."""
503
self._set_option(alias_name, alias_command, 'ALIASES')
505
def unset_alias(self, alias_name):
506
"""Unset an existing alias."""
507
aliases = self._get_parser().get('ALIASES')
508
if not aliases or alias_name not in aliases:
509
raise errors.NoSuchAlias(alias_name)
510
del aliases[alias_name]
511
self._write_config_file()
513
def _set_option(self, option, value, section):
514
# FIXME: RBC 20051029 This should refresh the parser and also take a
515
# file lock on bazaar.conf.
516
conf_dir = os.path.dirname(self._get_filename())
517
ensure_config_dir_exists(conf_dir)
518
self._get_parser().setdefault(section, {})[option] = value
519
self._write_config_file()
521
def _write_config_file(self):
522
path = self._get_filename()
524
osutils.copy_ownership_from_path(path)
525
self._get_parser().write(f)
529
class LocationConfig(IniBasedConfig):
530
"""A configuration object that gives the policy for a location."""
532
def __init__(self, location):
533
name_generator = locations_config_filename
534
if (not os.path.exists(name_generator()) and
535
os.path.exists(branches_config_filename())):
536
if sys.platform == 'win32':
537
trace.warning('Please rename %s to %s'
538
% (branches_config_filename(),
539
locations_config_filename()))
541
trace.warning('Please rename ~/.bazaar/branches.conf'
542
' to ~/.bazaar/locations.conf')
543
name_generator = branches_config_filename
544
super(LocationConfig, self).__init__(name_generator)
545
# local file locations are looked up by local path, rather than
546
# by file url. This is because the config file is a user
547
# file, and we would rather not expose the user to file urls.
548
if location.startswith('file://'):
549
location = urlutils.local_path_from_url(location)
550
self.location = location
552
def _get_matching_sections(self):
553
"""Return an ordered list of section names matching this location."""
554
sections = self._get_parser()
555
location_names = self.location.split('/')
556
if self.location.endswith('/'):
557
del location_names[-1]
559
for section in sections:
560
# location is a local path if possible, so we need
561
# to convert 'file://' urls to local paths if necessary.
562
# This also avoids having file:///path be a more exact
563
# match than '/path'.
564
if section.startswith('file://'):
565
section_path = urlutils.local_path_from_url(section)
567
section_path = section
568
section_names = section_path.split('/')
569
if section.endswith('/'):
570
del section_names[-1]
571
names = zip(location_names, section_names)
574
if not fnmatch(name[0], name[1]):
579
# so, for the common prefix they matched.
580
# if section is longer, no match.
581
if len(section_names) > len(location_names):
583
matches.append((len(section_names), section,
584
'/'.join(location_names[len(section_names):])))
585
matches.sort(reverse=True)
587
for (length, section, extra_path) in matches:
588
sections.append((section, extra_path))
589
# should we stop looking for parent configs here?
591
if self._get_parser()[section].as_bool('ignore_parents'):
597
def _get_option_policy(self, section, option_name):
598
"""Return the policy for the given (section, option_name) pair."""
599
# check for the old 'recurse=False' flag
601
recurse = self._get_parser()[section].as_bool('recurse')
605
return POLICY_NORECURSE
607
policy_key = option_name + ':policy'
609
policy_name = self._get_parser()[section][policy_key]
613
return _policy_value[policy_name]
615
def _set_option_policy(self, section, option_name, option_policy):
616
"""Set the policy for the given option name in the given section."""
617
# The old recurse=False option affects all options in the
618
# section. To handle multiple policies in the section, we
619
# need to convert it to a policy_norecurse key.
621
recurse = self._get_parser()[section].as_bool('recurse')
625
symbol_versioning.warn(
626
'The recurse option is deprecated as of 0.14. '
627
'The section "%s" has been converted to use policies.'
630
del self._get_parser()[section]['recurse']
632
for key in self._get_parser()[section].keys():
633
if not key.endswith(':policy'):
634
self._get_parser()[section][key +
635
':policy'] = 'norecurse'
637
policy_key = option_name + ':policy'
638
policy_name = _policy_name[option_policy]
639
if policy_name is not None:
640
self._get_parser()[section][policy_key] = policy_name
642
if policy_key in self._get_parser()[section]:
643
del self._get_parser()[section][policy_key]
645
def set_user_option(self, option, value, store=STORE_LOCATION):
646
"""Save option and its value in the configuration."""
647
if store not in [STORE_LOCATION,
648
STORE_LOCATION_NORECURSE,
649
STORE_LOCATION_APPENDPATH]:
650
raise ValueError('bad storage policy %r for %r' %
652
# FIXME: RBC 20051029 This should refresh the parser and also take a
653
# file lock on locations.conf.
654
conf_dir = os.path.dirname(self._get_filename())
655
ensure_config_dir_exists(conf_dir)
656
location = self.location
657
if location.endswith('/'):
658
location = location[:-1]
659
if (not location in self._get_parser() and
660
not location + '/' in self._get_parser()):
661
self._get_parser()[location]={}
662
elif location + '/' in self._get_parser():
663
location = location + '/'
664
self._get_parser()[location][option]=value
665
# the allowed values of store match the config policies
666
self._set_option_policy(location, option, store)
667
self._get_parser().write(file(self._get_filename(), 'wb'))
670
class BranchConfig(Config):
671
"""A configuration object giving the policy for a branch."""
673
def _get_branch_data_config(self):
674
if self._branch_data_config is None:
675
self._branch_data_config = TreeConfig(self.branch)
676
return self._branch_data_config
678
def _get_location_config(self):
679
if self._location_config is None:
680
self._location_config = LocationConfig(self.branch.base)
681
return self._location_config
683
def _get_global_config(self):
684
if self._global_config is None:
685
self._global_config = GlobalConfig()
686
return self._global_config
688
def _get_best_value(self, option_name):
689
"""This returns a user option from local, tree or global config.
691
They are tried in that order. Use get_safe_value if trusted values
694
for source in self.option_sources:
695
value = getattr(source(), option_name)()
696
if value is not None:
700
def _get_safe_value(self, option_name):
701
"""This variant of get_best_value never returns untrusted values.
703
It does not return values from the branch data, because the branch may
704
not be controlled by the user.
706
We may wish to allow locations.conf to control whether branches are
707
trusted in the future.
709
for source in (self._get_location_config, self._get_global_config):
710
value = getattr(source(), option_name)()
711
if value is not None:
715
def _get_user_id(self):
716
"""Return the full user id for the branch.
718
e.g. "John Hacker <jhacker@example.com>"
719
This is looked up in the email controlfile for the branch.
722
return (self.branch._transport.get_bytes("email")
723
.decode(osutils.get_user_encoding())
725
except errors.NoSuchFile, e:
728
return self._get_best_value('_get_user_id')
730
def _get_change_editor(self):
731
return self._get_best_value('_get_change_editor')
733
def _get_signature_checking(self):
734
"""See Config._get_signature_checking."""
735
return self._get_best_value('_get_signature_checking')
737
def _get_signing_policy(self):
738
"""See Config._get_signing_policy."""
739
return self._get_best_value('_get_signing_policy')
741
def _get_user_option(self, option_name):
742
"""See Config._get_user_option."""
743
for source in self.option_sources:
744
value = source()._get_user_option(option_name)
745
if value is not None:
749
def set_user_option(self, name, value, store=STORE_BRANCH,
751
if store == STORE_BRANCH:
752
self._get_branch_data_config().set_option(value, name)
753
elif store == STORE_GLOBAL:
754
self._get_global_config().set_user_option(name, value)
756
self._get_location_config().set_user_option(name, value, store)
759
if store in (STORE_GLOBAL, STORE_BRANCH):
760
mask_value = self._get_location_config().get_user_option(name)
761
if mask_value is not None:
762
trace.warning('Value "%s" is masked by "%s" from'
763
' locations.conf', value, mask_value)
765
if store == STORE_GLOBAL:
766
branch_config = self._get_branch_data_config()
767
mask_value = branch_config.get_user_option(name)
768
if mask_value is not None:
769
trace.warning('Value "%s" is masked by "%s" from'
770
' branch.conf', value, mask_value)
772
def _gpg_signing_command(self):
773
"""See Config.gpg_signing_command."""
774
return self._get_safe_value('_gpg_signing_command')
776
def __init__(self, branch):
777
super(BranchConfig, self).__init__()
778
self._location_config = None
779
self._branch_data_config = None
780
self._global_config = None
782
self.option_sources = (self._get_location_config,
783
self._get_branch_data_config,
784
self._get_global_config)
786
def _post_commit(self):
787
"""See Config.post_commit."""
788
return self._get_safe_value('_post_commit')
790
def _get_nickname(self):
791
value = self._get_explicit_nickname()
792
if value is not None:
794
return urlutils.unescape(self.branch.base.split('/')[-2])
796
def has_explicit_nickname(self):
797
"""Return true if a nickname has been explicitly assigned."""
798
return self._get_explicit_nickname() is not None
800
def _get_explicit_nickname(self):
801
return self._get_best_value('_get_nickname')
803
def _log_format(self):
804
"""See Config.log_format."""
805
return self._get_best_value('_log_format')
808
def ensure_config_dir_exists(path=None):
809
"""Make sure a configuration directory exists.
810
This makes sure that the directory exists.
811
On windows, since configuration directories are 2 levels deep,
812
it makes sure both the directory and the parent directory exists.
816
if not os.path.isdir(path):
817
if sys.platform == 'win32':
818
parent_dir = os.path.dirname(path)
819
if not os.path.isdir(parent_dir):
820
trace.mutter('creating config parent directory: %r', parent_dir)
822
trace.mutter('creating config directory: %r', path)
824
osutils.copy_ownership_from_path(path)
828
"""Return per-user configuration directory.
830
By default this is ~/.bazaar/
832
TODO: Global option --config-dir to override this.
834
base = os.environ.get('BZR_HOME', None)
835
if sys.platform == 'win32':
837
base = win32utils.get_appdata_location_unicode()
839
base = os.environ.get('HOME', None)
841
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
843
return osutils.pathjoin(base, 'bazaar', '2.0')
845
# cygwin, linux, and darwin all have a $HOME directory
847
base = os.path.expanduser("~")
848
return osutils.pathjoin(base, ".bazaar")
851
def config_filename():
852
"""Return per-user configuration ini file filename."""
853
return osutils.pathjoin(config_dir(), 'bazaar.conf')
856
def branches_config_filename():
857
"""Return per-user configuration ini file filename."""
858
return osutils.pathjoin(config_dir(), 'branches.conf')
861
def locations_config_filename():
862
"""Return per-user configuration ini file filename."""
863
return osutils.pathjoin(config_dir(), 'locations.conf')
866
def authentication_config_filename():
867
"""Return per-user authentication ini file filename."""
868
return osutils.pathjoin(config_dir(), 'authentication.conf')
871
def user_ignore_config_filename():
872
"""Return the user default ignore filename"""
873
return osutils.pathjoin(config_dir(), 'ignore')
877
"""Return the directory name to store crash files.
879
This doesn't implicitly create it.
881
On Windows it's in the config directory; elsewhere it's /var/crash
882
which may be monitored by apport. It can be overridden by
885
if sys.platform == 'win32':
886
return osutils.pathjoin(config_dir(), 'Crash')
888
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
890
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
894
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
895
# Possibly this should be different on Windows?
896
e = os.environ.get('XDG_CACHE_DIR', None)
900
return os.path.expanduser('~/.cache')
903
def parse_username(username):
904
"""Parse e-mail username and return a (name, address) tuple."""
905
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
907
return (username, '')
909
return (match.group(1), match.group(2))
912
def extract_email_address(e):
913
"""Return just the address part of an email string.
915
That is just the user@domain part, nothing else.
916
This part is required to contain only ascii characters.
917
If it can't be extracted, raises an error.
919
>>> extract_email_address('Jane Tester <jane@test.com>')
922
name, email = parse_username(e)
924
raise errors.NoEmailInUsername(e)
928
class TreeConfig(IniBasedConfig):
929
"""Branch configuration data associated with its contents, not location"""
931
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
933
def __init__(self, branch):
934
self._config = branch._get_config()
937
def _get_parser(self, file=None):
939
return IniBasedConfig._get_parser(file)
940
return self._config._get_configobj()
942
def get_option(self, name, section=None, default=None):
943
self.branch.lock_read()
945
return self._config.get_option(name, section, default)
949
def set_option(self, value, name, section=None):
950
"""Set a per-branch configuration option"""
951
self.branch.lock_write()
953
self._config.set_option(value, name, section)
958
class AuthenticationConfig(object):
959
"""The authentication configuration file based on a ini file.
961
Implements the authentication.conf file described in
962
doc/developers/authentication-ring.txt.
965
def __init__(self, _file=None):
966
self._config = None # The ConfigObj
968
self._filename = authentication_config_filename()
969
self._input = self._filename = authentication_config_filename()
971
# Tests can provide a string as _file
972
self._filename = None
975
def _get_config(self):
976
if self._config is not None:
979
# FIXME: Should we validate something here ? Includes: empty
980
# sections are useless, at least one of
981
# user/password/password_encoding should be defined, etc.
983
# Note: the encoding below declares that the file itself is utf-8
984
# encoded, but the values in the ConfigObj are always Unicode.
985
self._config = ConfigObj(self._input, encoding='utf-8')
986
except configobj.ConfigObjError, e:
987
raise errors.ParseConfigError(e.errors, e.config.filename)
991
"""Save the config file, only tests should use it for now."""
992
conf_dir = os.path.dirname(self._filename)
993
ensure_config_dir_exists(conf_dir)
994
self._get_config().write(file(self._filename, 'wb'))
996
def _set_option(self, section_name, option_name, value):
997
"""Set an authentication configuration option"""
998
conf = self._get_config()
999
section = conf.get(section_name)
1002
section = conf[section]
1003
section[option_name] = value
1006
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1008
"""Returns the matching credentials from authentication.conf file.
1010
:param scheme: protocol
1012
:param host: the server address
1014
:param port: the associated port (optional)
1016
:param user: login (optional)
1018
:param path: the absolute path on the server (optional)
1020
:param realm: the http authentication realm (optional)
1022
:return: A dict containing the matching credentials or None.
1024
- name: the section name of the credentials in the
1025
authentication.conf file,
1026
- user: can't be different from the provided user if any,
1027
- scheme: the server protocol,
1028
- host: the server address,
1029
- port: the server port (can be None),
1030
- path: the absolute server path (can be None),
1031
- realm: the http specific authentication realm (can be None),
1032
- password: the decoded password, could be None if the credential
1033
defines only the user
1034
- verify_certificates: https specific, True if the server
1035
certificate should be verified, False otherwise.
1038
for auth_def_name, auth_def in self._get_config().items():
1039
if type(auth_def) is not configobj.Section:
1040
raise ValueError("%s defined outside a section" % auth_def_name)
1042
a_scheme, a_host, a_user, a_path = map(
1043
auth_def.get, ['scheme', 'host', 'user', 'path'])
1046
a_port = auth_def.as_int('port')
1050
raise ValueError("'port' not numeric in %s" % auth_def_name)
1052
a_verify_certificates = auth_def.as_bool('verify_certificates')
1054
a_verify_certificates = True
1057
"'verify_certificates' not boolean in %s" % auth_def_name)
1060
if a_scheme is not None and scheme != a_scheme:
1062
if a_host is not None:
1063
if not (host == a_host
1064
or (a_host.startswith('.') and host.endswith(a_host))):
1066
if a_port is not None and port != a_port:
1068
if (a_path is not None and path is not None
1069
and not path.startswith(a_path)):
1071
if (a_user is not None and user is not None
1072
and a_user != user):
1073
# Never contradict the caller about the user to be used
1078
# Prepare a credentials dictionary with additional keys
1079
# for the credential providers
1080
credentials = dict(name=auth_def_name,
1087
password=auth_def.get('password', None),
1088
verify_certificates=a_verify_certificates)
1089
# Decode the password in the credentials (or get one)
1090
self.decode_password(credentials,
1091
auth_def.get('password_encoding', None))
1092
if 'auth' in debug.debug_flags:
1093
trace.mutter("Using authentication section: %r", auth_def_name)
1096
if credentials is None:
1097
# No credentials were found in authentication.conf, try the fallback
1098
# credentials stores.
1099
credentials = credential_store_registry.get_fallback_credentials(
1100
scheme, host, port, user, path, realm)
1104
def set_credentials(self, name, host, user, scheme=None, password=None,
1105
port=None, path=None, verify_certificates=None,
1107
"""Set authentication credentials for a host.
1109
Any existing credentials with matching scheme, host, port and path
1110
will be deleted, regardless of name.
1112
:param name: An arbitrary name to describe this set of credentials.
1113
:param host: Name of the host that accepts these credentials.
1114
:param user: The username portion of these credentials.
1115
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1117
:param password: Password portion of these credentials.
1118
:param port: The IP port on the host that these credentials apply to.
1119
:param path: A filesystem path on the host that these credentials
1121
:param verify_certificates: On https, verify server certificates if
1123
:param realm: The http authentication realm (optional).
1125
values = {'host': host, 'user': user}
1126
if password is not None:
1127
values['password'] = password
1128
if scheme is not None:
1129
values['scheme'] = scheme
1130
if port is not None:
1131
values['port'] = '%d' % port
1132
if path is not None:
1133
values['path'] = path
1134
if verify_certificates is not None:
1135
values['verify_certificates'] = str(verify_certificates)
1136
if realm is not None:
1137
values['realm'] = realm
1138
config = self._get_config()
1140
for section, existing_values in config.items():
1141
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1142
if existing_values.get(key) != values.get(key):
1146
config.update({name: values})
1149
def get_user(self, scheme, host, port=None, realm=None, path=None,
1150
prompt=None, ask=False, default=None):
1151
"""Get a user from authentication file.
1153
:param scheme: protocol
1155
:param host: the server address
1157
:param port: the associated port (optional)
1159
:param realm: the realm sent by the server (optional)
1161
:param path: the absolute path on the server (optional)
1163
:param ask: Ask the user if there is no explicitly configured username
1166
:param default: The username returned if none is defined (optional).
1168
:return: The found user.
1170
credentials = self.get_credentials(scheme, host, port, user=None,
1171
path=path, realm=realm)
1172
if credentials is not None:
1173
user = credentials['user']
1179
# Create a default prompt suitable for most cases
1180
prompt = scheme.upper() + ' %(host)s username'
1181
# Special handling for optional fields in the prompt
1182
if port is not None:
1183
prompt_host = '%s:%d' % (host, port)
1186
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1191
def get_password(self, scheme, host, user, port=None,
1192
realm=None, path=None, prompt=None):
1193
"""Get a password from authentication file or prompt the user for one.
1195
:param scheme: protocol
1197
:param host: the server address
1199
:param port: the associated port (optional)
1203
:param realm: the realm sent by the server (optional)
1205
:param path: the absolute path on the server (optional)
1207
:return: The found password or the one entered by the user.
1209
credentials = self.get_credentials(scheme, host, port, user, path,
1211
if credentials is not None:
1212
password = credentials['password']
1213
if password is not None and scheme is 'ssh':
1214
trace.warning('password ignored in section [%s],'
1215
' use an ssh agent instead'
1216
% credentials['name'])
1220
# Prompt user only if we could't find a password
1221
if password is None:
1223
# Create a default prompt suitable for most cases
1224
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1225
# Special handling for optional fields in the prompt
1226
if port is not None:
1227
prompt_host = '%s:%d' % (host, port)
1230
password = ui.ui_factory.get_password(prompt,
1231
host=prompt_host, user=user)
1234
def decode_password(self, credentials, encoding):
1236
cs = credential_store_registry.get_credential_store(encoding)
1238
raise ValueError('%r is not a known password_encoding' % encoding)
1239
credentials['password'] = cs.decode_password(credentials)
1243
class CredentialStoreRegistry(registry.Registry):
1244
"""A class that registers credential stores.
1246
A credential store provides access to credentials via the password_encoding
1247
field in authentication.conf sections.
1249
Except for stores provided by bzr itself, most stores are expected to be
1250
provided by plugins that will therefore use
1251
register_lazy(password_encoding, module_name, member_name, help=help,
1252
fallback=fallback) to install themselves.
1254
A fallback credential store is one that is queried if no credentials can be
1255
found via authentication.conf.
1258
def get_credential_store(self, encoding=None):
1259
cs = self.get(encoding)
1264
def is_fallback(self, name):
1265
"""Check if the named credentials store should be used as fallback."""
1266
return self.get_info(name)
1268
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1269
path=None, realm=None):
1270
"""Request credentials from all fallback credentials stores.
1272
The first credentials store that can provide credentials wins.
1275
for name in self.keys():
1276
if not self.is_fallback(name):
1278
cs = self.get_credential_store(name)
1279
credentials = cs.get_credentials(scheme, host, port, user,
1281
if credentials is not None:
1282
# We found some credentials
1286
def register(self, key, obj, help=None, override_existing=False,
1288
"""Register a new object to a name.
1290
:param key: This is the key to use to request the object later.
1291
:param obj: The object to register.
1292
:param help: Help text for this entry. This may be a string or
1293
a callable. If it is a callable, it should take two
1294
parameters (registry, key): this registry and the key that
1295
the help was registered under.
1296
:param override_existing: Raise KeyErorr if False and something has
1297
already been registered for that key. If True, ignore if there
1298
is an existing key (always register the new value).
1299
:param fallback: Whether this credential store should be
1302
return super(CredentialStoreRegistry,
1303
self).register(key, obj, help, info=fallback,
1304
override_existing=override_existing)
1306
def register_lazy(self, key, module_name, member_name,
1307
help=None, override_existing=False,
1309
"""Register a new credential store to be loaded on request.
1311
:param module_name: The python path to the module. Such as 'os.path'.
1312
:param member_name: The member of the module to return. If empty or
1313
None, get() will return the module itself.
1314
:param help: Help text for this entry. This may be a string or
1316
:param override_existing: If True, replace the existing object
1317
with the new one. If False, if there is already something
1318
registered with the same key, raise a KeyError
1319
:param fallback: Whether this credential store should be
1322
return super(CredentialStoreRegistry, self).register_lazy(
1323
key, module_name, member_name, help,
1324
info=fallback, override_existing=override_existing)
1327
credential_store_registry = CredentialStoreRegistry()
1330
class CredentialStore(object):
1331
"""An abstract class to implement storage for credentials"""
1333
def decode_password(self, credentials):
1334
"""Returns a clear text password for the provided credentials."""
1335
raise NotImplementedError(self.decode_password)
1337
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1339
"""Return the matching credentials from this credential store.
1341
This method is only called on fallback credential stores.
1343
raise NotImplementedError(self.get_credentials)
1347
class PlainTextCredentialStore(CredentialStore):
1348
__doc__ = """Plain text credential store for the authentication.conf file"""
1350
def decode_password(self, credentials):
1351
"""See CredentialStore.decode_password."""
1352
return credentials['password']
1355
credential_store_registry.register('plain', PlainTextCredentialStore,
1356
help=PlainTextCredentialStore.__doc__)
1357
credential_store_registry.default_key = 'plain'
1360
class BzrDirConfig(object):
1362
def __init__(self, bzrdir):
1363
self._bzrdir = bzrdir
1364
self._config = bzrdir._get_config()
1366
def set_default_stack_on(self, value):
1367
"""Set the default stacking location.
1369
It may be set to a location, or None.
1371
This policy affects all branches contained by this bzrdir, except for
1372
those under repositories.
1374
if self._config is None:
1375
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1377
self._config.set_option('', 'default_stack_on')
1379
self._config.set_option(value, 'default_stack_on')
1381
def get_default_stack_on(self):
1382
"""Return the default stacking location.
1384
This will either be a location, or None.
1386
This policy affects all branches contained by this bzrdir, except for
1387
those under repositories.
1389
if self._config is None:
1391
value = self._config.get_option('default_stack_on')
1397
class TransportConfig(object):
1398
"""A Config that reads/writes a config file on a Transport.
1400
It is a low-level object that considers config data to be name/value pairs
1401
that may be associated with a section. Assigning meaning to the these
1402
values is done at higher levels like TreeConfig.
1405
def __init__(self, transport, filename):
1406
self._transport = transport
1407
self._filename = filename
1409
def get_option(self, name, section=None, default=None):
1410
"""Return the value associated with a named option.
1412
:param name: The name of the value
1413
:param section: The section the option is in (if any)
1414
:param default: The value to return if the value is not set
1415
:return: The value or default value
1417
configobj = self._get_configobj()
1419
section_obj = configobj
1422
section_obj = configobj[section]
1425
return section_obj.get(name, default)
1427
def set_option(self, value, name, section=None):
1428
"""Set the value associated with a named option.
1430
:param value: The value to set
1431
:param name: The name of the value to set
1432
:param section: The section the option is in (if any)
1434
configobj = self._get_configobj()
1436
configobj[name] = value
1438
configobj.setdefault(section, {})[name] = value
1439
self._set_configobj(configobj)
1441
def _get_config_file(self):
1443
return StringIO(self._transport.get_bytes(self._filename))
1444
except errors.NoSuchFile:
1447
def _get_configobj(self):
1448
return ConfigObj(self._get_config_file(), encoding='utf-8')
1450
def _set_configobj(self, configobj):
1451
out_file = StringIO()
1452
configobj.write(out_file)
1454
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
