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
atomic_file = atomicfile.AtomicFile(self._get_filename())
483
self._get_parser().write(atomic_file)
488
class GlobalConfig(IniBasedConfig):
489
"""The configuration that should be used for a specific location."""
491
def get_editor(self):
492
return self._get_user_option('editor')
495
super(GlobalConfig, self).__init__(config_filename)
497
def set_user_option(self, option, value):
498
"""Save option and its value in the configuration."""
499
self._set_option(option, value, 'DEFAULT')
501
def get_aliases(self):
502
"""Return the aliases section."""
503
if 'ALIASES' in self._get_parser():
504
return self._get_parser()['ALIASES']
508
def set_alias(self, alias_name, alias_command):
509
"""Save the alias in the configuration."""
510
self._set_option(alias_name, alias_command, 'ALIASES')
512
def unset_alias(self, alias_name):
513
"""Unset an existing alias."""
514
aliases = self._get_parser().get('ALIASES')
515
if not aliases or alias_name not in aliases:
516
raise errors.NoSuchAlias(alias_name)
517
del aliases[alias_name]
518
self._write_config_file()
520
def _set_option(self, option, value, section):
521
# FIXME: RBC 20051029 This should refresh the parser and also take a
522
# file lock on bazaar.conf.
523
conf_dir = os.path.dirname(self._get_filename())
524
ensure_config_dir_exists(conf_dir)
525
self._get_parser().setdefault(section, {})[option] = value
526
self._write_config_file()
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._write_config_file()
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')
846
base = os.path.expanduser("~")
847
return osutils.pathjoin(base, ".bazaar")
850
def config_filename():
851
"""Return per-user configuration ini file filename."""
852
return osutils.pathjoin(config_dir(), 'bazaar.conf')
855
def branches_config_filename():
856
"""Return per-user configuration ini file filename."""
857
return osutils.pathjoin(config_dir(), 'branches.conf')
860
def locations_config_filename():
861
"""Return per-user configuration ini file filename."""
862
return osutils.pathjoin(config_dir(), 'locations.conf')
865
def authentication_config_filename():
866
"""Return per-user authentication ini file filename."""
867
return osutils.pathjoin(config_dir(), 'authentication.conf')
870
def user_ignore_config_filename():
871
"""Return the user default ignore filename"""
872
return osutils.pathjoin(config_dir(), 'ignore')
876
"""Return the directory name to store crash files.
878
This doesn't implicitly create it.
880
On Windows it's in the config directory; elsewhere it's /var/crash
881
which may be monitored by apport. It can be overridden by
884
if sys.platform == 'win32':
885
return osutils.pathjoin(config_dir(), 'Crash')
887
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
889
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
893
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
894
# Possibly this should be different on Windows?
895
e = os.environ.get('XDG_CACHE_DIR', None)
899
return os.path.expanduser('~/.cache')
902
def parse_username(username):
903
"""Parse e-mail username and return a (name, address) tuple."""
904
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
906
return (username, '')
908
return (match.group(1), match.group(2))
911
def extract_email_address(e):
912
"""Return just the address part of an email string.
914
That is just the user@domain part, nothing else.
915
This part is required to contain only ascii characters.
916
If it can't be extracted, raises an error.
918
>>> extract_email_address('Jane Tester <jane@test.com>')
921
name, email = parse_username(e)
923
raise errors.NoEmailInUsername(e)
927
class TreeConfig(IniBasedConfig):
928
"""Branch configuration data associated with its contents, not location"""
930
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
932
def __init__(self, branch):
933
self._config = branch._get_config()
936
def _get_parser(self, file=None):
938
return IniBasedConfig._get_parser(file)
939
return self._config._get_configobj()
941
def get_option(self, name, section=None, default=None):
942
self.branch.lock_read()
944
return self._config.get_option(name, section, default)
948
def set_option(self, value, name, section=None):
949
"""Set a per-branch configuration option"""
950
self.branch.lock_write()
952
self._config.set_option(value, name, section)
957
class AuthenticationConfig(object):
958
"""The authentication configuration file based on a ini file.
960
Implements the authentication.conf file described in
961
doc/developers/authentication-ring.txt.
964
def __init__(self, _file=None):
965
self._config = None # The ConfigObj
967
self._filename = authentication_config_filename()
968
self._input = self._filename = authentication_config_filename()
970
# Tests can provide a string as _file
971
self._filename = None
974
def _get_config(self):
975
if self._config is not None:
978
# FIXME: Should we validate something here ? Includes: empty
979
# sections are useless, at least one of
980
# user/password/password_encoding should be defined, etc.
982
# Note: the encoding below declares that the file itself is utf-8
983
# encoded, but the values in the ConfigObj are always Unicode.
984
self._config = ConfigObj(self._input, encoding='utf-8')
985
except configobj.ConfigObjError, e:
986
raise errors.ParseConfigError(e.errors, e.config.filename)
990
"""Save the config file, only tests should use it for now."""
991
conf_dir = os.path.dirname(self._filename)
992
ensure_config_dir_exists(conf_dir)
993
f = file(self._filename, 'wb')
995
self._get_config().write(f)
999
def _set_option(self, section_name, option_name, value):
1000
"""Set an authentication configuration option"""
1001
conf = self._get_config()
1002
section = conf.get(section_name)
1005
section = conf[section]
1006
section[option_name] = value
1009
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1011
"""Returns the matching credentials from authentication.conf file.
1013
:param scheme: protocol
1015
:param host: the server address
1017
:param port: the associated port (optional)
1019
:param user: login (optional)
1021
:param path: the absolute path on the server (optional)
1023
:param realm: the http authentication realm (optional)
1025
:return: A dict containing the matching credentials or None.
1027
- name: the section name of the credentials in the
1028
authentication.conf file,
1029
- user: can't be different from the provided user if any,
1030
- scheme: the server protocol,
1031
- host: the server address,
1032
- port: the server port (can be None),
1033
- path: the absolute server path (can be None),
1034
- realm: the http specific authentication realm (can be None),
1035
- password: the decoded password, could be None if the credential
1036
defines only the user
1037
- verify_certificates: https specific, True if the server
1038
certificate should be verified, False otherwise.
1041
for auth_def_name, auth_def in self._get_config().items():
1042
if type(auth_def) is not configobj.Section:
1043
raise ValueError("%s defined outside a section" % auth_def_name)
1045
a_scheme, a_host, a_user, a_path = map(
1046
auth_def.get, ['scheme', 'host', 'user', 'path'])
1049
a_port = auth_def.as_int('port')
1053
raise ValueError("'port' not numeric in %s" % auth_def_name)
1055
a_verify_certificates = auth_def.as_bool('verify_certificates')
1057
a_verify_certificates = True
1060
"'verify_certificates' not boolean in %s" % auth_def_name)
1063
if a_scheme is not None and scheme != a_scheme:
1065
if a_host is not None:
1066
if not (host == a_host
1067
or (a_host.startswith('.') and host.endswith(a_host))):
1069
if a_port is not None and port != a_port:
1071
if (a_path is not None and path is not None
1072
and not path.startswith(a_path)):
1074
if (a_user is not None and user is not None
1075
and a_user != user):
1076
# Never contradict the caller about the user to be used
1081
# Prepare a credentials dictionary with additional keys
1082
# for the credential providers
1083
credentials = dict(name=auth_def_name,
1090
password=auth_def.get('password', None),
1091
verify_certificates=a_verify_certificates)
1092
# Decode the password in the credentials (or get one)
1093
self.decode_password(credentials,
1094
auth_def.get('password_encoding', None))
1095
if 'auth' in debug.debug_flags:
1096
trace.mutter("Using authentication section: %r", auth_def_name)
1099
if credentials is None:
1100
# No credentials were found in authentication.conf, try the fallback
1101
# credentials stores.
1102
credentials = credential_store_registry.get_fallback_credentials(
1103
scheme, host, port, user, path, realm)
1107
def set_credentials(self, name, host, user, scheme=None, password=None,
1108
port=None, path=None, verify_certificates=None,
1110
"""Set authentication credentials for a host.
1112
Any existing credentials with matching scheme, host, port and path
1113
will be deleted, regardless of name.
1115
:param name: An arbitrary name to describe this set of credentials.
1116
:param host: Name of the host that accepts these credentials.
1117
:param user: The username portion of these credentials.
1118
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1120
:param password: Password portion of these credentials.
1121
:param port: The IP port on the host that these credentials apply to.
1122
:param path: A filesystem path on the host that these credentials
1124
:param verify_certificates: On https, verify server certificates if
1126
:param realm: The http authentication realm (optional).
1128
values = {'host': host, 'user': user}
1129
if password is not None:
1130
values['password'] = password
1131
if scheme is not None:
1132
values['scheme'] = scheme
1133
if port is not None:
1134
values['port'] = '%d' % port
1135
if path is not None:
1136
values['path'] = path
1137
if verify_certificates is not None:
1138
values['verify_certificates'] = str(verify_certificates)
1139
if realm is not None:
1140
values['realm'] = realm
1141
config = self._get_config()
1143
for section, existing_values in config.items():
1144
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1145
if existing_values.get(key) != values.get(key):
1149
config.update({name: values})
1152
def get_user(self, scheme, host, port=None, realm=None, path=None,
1153
prompt=None, ask=False, default=None):
1154
"""Get a user from authentication file.
1156
:param scheme: protocol
1158
:param host: the server address
1160
:param port: the associated port (optional)
1162
:param realm: the realm sent by the server (optional)
1164
:param path: the absolute path on the server (optional)
1166
:param ask: Ask the user if there is no explicitly configured username
1169
:param default: The username returned if none is defined (optional).
1171
:return: The found user.
1173
credentials = self.get_credentials(scheme, host, port, user=None,
1174
path=path, realm=realm)
1175
if credentials is not None:
1176
user = credentials['user']
1182
# Create a default prompt suitable for most cases
1183
prompt = scheme.upper() + ' %(host)s username'
1184
# Special handling for optional fields in the prompt
1185
if port is not None:
1186
prompt_host = '%s:%d' % (host, port)
1189
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1194
def get_password(self, scheme, host, user, port=None,
1195
realm=None, path=None, prompt=None):
1196
"""Get a password from authentication file or prompt the user for one.
1198
:param scheme: protocol
1200
:param host: the server address
1202
:param port: the associated port (optional)
1206
:param realm: the realm sent by the server (optional)
1208
:param path: the absolute path on the server (optional)
1210
:return: The found password or the one entered by the user.
1212
credentials = self.get_credentials(scheme, host, port, user, path,
1214
if credentials is not None:
1215
password = credentials['password']
1216
if password is not None and scheme is 'ssh':
1217
trace.warning('password ignored in section [%s],'
1218
' use an ssh agent instead'
1219
% credentials['name'])
1223
# Prompt user only if we could't find a password
1224
if password is None:
1226
# Create a default prompt suitable for most cases
1227
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1228
# Special handling for optional fields in the prompt
1229
if port is not None:
1230
prompt_host = '%s:%d' % (host, port)
1233
password = ui.ui_factory.get_password(prompt,
1234
host=prompt_host, user=user)
1237
def decode_password(self, credentials, encoding):
1239
cs = credential_store_registry.get_credential_store(encoding)
1241
raise ValueError('%r is not a known password_encoding' % encoding)
1242
credentials['password'] = cs.decode_password(credentials)
1246
class CredentialStoreRegistry(registry.Registry):
1247
"""A class that registers credential stores.
1249
A credential store provides access to credentials via the password_encoding
1250
field in authentication.conf sections.
1252
Except for stores provided by bzr itself, most stores are expected to be
1253
provided by plugins that will therefore use
1254
register_lazy(password_encoding, module_name, member_name, help=help,
1255
fallback=fallback) to install themselves.
1257
A fallback credential store is one that is queried if no credentials can be
1258
found via authentication.conf.
1261
def get_credential_store(self, encoding=None):
1262
cs = self.get(encoding)
1267
def is_fallback(self, name):
1268
"""Check if the named credentials store should be used as fallback."""
1269
return self.get_info(name)
1271
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1272
path=None, realm=None):
1273
"""Request credentials from all fallback credentials stores.
1275
The first credentials store that can provide credentials wins.
1278
for name in self.keys():
1279
if not self.is_fallback(name):
1281
cs = self.get_credential_store(name)
1282
credentials = cs.get_credentials(scheme, host, port, user,
1284
if credentials is not None:
1285
# We found some credentials
1289
def register(self, key, obj, help=None, override_existing=False,
1291
"""Register a new object to a name.
1293
:param key: This is the key to use to request the object later.
1294
:param obj: The object to register.
1295
:param help: Help text for this entry. This may be a string or
1296
a callable. If it is a callable, it should take two
1297
parameters (registry, key): this registry and the key that
1298
the help was registered under.
1299
:param override_existing: Raise KeyErorr if False and something has
1300
already been registered for that key. If True, ignore if there
1301
is an existing key (always register the new value).
1302
:param fallback: Whether this credential store should be
1305
return super(CredentialStoreRegistry,
1306
self).register(key, obj, help, info=fallback,
1307
override_existing=override_existing)
1309
def register_lazy(self, key, module_name, member_name,
1310
help=None, override_existing=False,
1312
"""Register a new credential store to be loaded on request.
1314
:param module_name: The python path to the module. Such as 'os.path'.
1315
:param member_name: The member of the module to return. If empty or
1316
None, get() will return the module itself.
1317
:param help: Help text for this entry. This may be a string or
1319
:param override_existing: If True, replace the existing object
1320
with the new one. If False, if there is already something
1321
registered with the same key, raise a KeyError
1322
:param fallback: Whether this credential store should be
1325
return super(CredentialStoreRegistry, self).register_lazy(
1326
key, module_name, member_name, help,
1327
info=fallback, override_existing=override_existing)
1330
credential_store_registry = CredentialStoreRegistry()
1333
class CredentialStore(object):
1334
"""An abstract class to implement storage for credentials"""
1336
def decode_password(self, credentials):
1337
"""Returns a clear text password for the provided credentials."""
1338
raise NotImplementedError(self.decode_password)
1340
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1342
"""Return the matching credentials from this credential store.
1344
This method is only called on fallback credential stores.
1346
raise NotImplementedError(self.get_credentials)
1350
class PlainTextCredentialStore(CredentialStore):
1351
__doc__ = """Plain text credential store for the authentication.conf file"""
1353
def decode_password(self, credentials):
1354
"""See CredentialStore.decode_password."""
1355
return credentials['password']
1358
credential_store_registry.register('plain', PlainTextCredentialStore,
1359
help=PlainTextCredentialStore.__doc__)
1360
credential_store_registry.default_key = 'plain'
1363
class BzrDirConfig(object):
1365
def __init__(self, bzrdir):
1366
self._bzrdir = bzrdir
1367
self._config = bzrdir._get_config()
1369
def set_default_stack_on(self, value):
1370
"""Set the default stacking location.
1372
It may be set to a location, or None.
1374
This policy affects all branches contained by this bzrdir, except for
1375
those under repositories.
1377
if self._config is None:
1378
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1380
self._config.set_option('', 'default_stack_on')
1382
self._config.set_option(value, 'default_stack_on')
1384
def get_default_stack_on(self):
1385
"""Return the default stacking location.
1387
This will either be a location, or None.
1389
This policy affects all branches contained by this bzrdir, except for
1390
those under repositories.
1392
if self._config is None:
1394
value = self._config.get_option('default_stack_on')
1400
class TransportConfig(object):
1401
"""A Config that reads/writes a config file on a Transport.
1403
It is a low-level object that considers config data to be name/value pairs
1404
that may be associated with a section. Assigning meaning to the these
1405
values is done at higher levels like TreeConfig.
1408
def __init__(self, transport, filename):
1409
self._transport = transport
1410
self._filename = filename
1412
def get_option(self, name, section=None, default=None):
1413
"""Return the value associated with a named option.
1415
:param name: The name of the value
1416
:param section: The section the option is in (if any)
1417
:param default: The value to return if the value is not set
1418
:return: The value or default value
1420
configobj = self._get_configobj()
1422
section_obj = configobj
1425
section_obj = configobj[section]
1428
return section_obj.get(name, default)
1430
def set_option(self, value, name, section=None):
1431
"""Set the value associated with a named option.
1433
:param value: The value to set
1434
:param name: The name of the value to set
1435
:param section: The section the option is in (if any)
1437
configobj = self._get_configobj()
1439
configobj[name] = value
1441
configobj.setdefault(section, {})[name] = value
1442
self._set_configobj(configobj)
1444
def _get_config_file(self):
1446
return StringIO(self._transport.get_bytes(self._filename))
1447
except errors.NoSuchFile:
1450
def _get_configobj(self):
1451
f = self._get_config_file()
1453
return ConfigObj(f, encoding='utf-8')
1457
def _set_configobj(self, configobj):
1458
out_file = StringIO()
1459
configobj.write(out_file)
1461
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
