1
# Copyright (C) 2005, 2007, 2008 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_mail_client(self):
157
"""Get a mail client to use"""
158
selected_client = self.get_user_option('mail_client')
159
_registry = mail_client.mail_client_registry
161
mail_client_class = _registry.get(selected_client)
163
raise errors.UnknownMailClient(selected_client)
164
return mail_client_class(self)
166
def _get_signature_checking(self):
167
"""Template method to override signature checking policy."""
169
def _get_signing_policy(self):
170
"""Template method to override signature creation policy."""
172
def _get_user_option(self, option_name):
173
"""Template method to provide a user option."""
176
def get_user_option(self, option_name):
177
"""Get a generic option - no special process, no default."""
178
return self._get_user_option(option_name)
180
def get_user_option_as_bool(self, option_name):
181
"""Get a generic option as a boolean - no special process, no default.
183
:return None if the option doesn't exist or its value can't be
184
interpreted as a boolean. Returns True or False ortherwise.
186
s = self._get_user_option(option_name)
187
return ui.bool_from_string(s)
189
def gpg_signing_command(self):
190
"""What program should be used to sign signatures?"""
191
result = self._gpg_signing_command()
196
def _gpg_signing_command(self):
197
"""See gpg_signing_command()."""
200
def log_format(self):
201
"""What log format should be used"""
202
result = self._log_format()
207
def _log_format(self):
208
"""See log_format()."""
211
def post_commit(self):
212
"""An ordered list of python functions to call.
214
Each function takes branch, rev_id as parameters.
216
return self._post_commit()
218
def _post_commit(self):
219
"""See Config.post_commit."""
222
def user_email(self):
223
"""Return just the email component of a username."""
224
return extract_email_address(self.username())
227
"""Return email-style username.
229
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
231
$BZR_EMAIL can be set to override this (as well as the
232
deprecated $BZREMAIL), then
233
the concrete policy type is checked, and finally
235
If none is found, a reasonable default is (hopefully)
238
TODO: Check it's reasonably well-formed.
240
v = os.environ.get('BZR_EMAIL')
242
return v.decode(osutils.get_user_encoding())
244
v = self._get_user_id()
248
v = os.environ.get('EMAIL')
250
return v.decode(osutils.get_user_encoding())
252
name, email = _auto_user_id()
254
return '%s <%s>' % (name, email)
258
def signature_checking(self):
259
"""What is the current policy for signature checking?."""
260
policy = self._get_signature_checking()
261
if policy is not None:
263
return CHECK_IF_POSSIBLE
265
def signing_policy(self):
266
"""What is the current policy for signature checking?."""
267
policy = self._get_signing_policy()
268
if policy is not None:
270
return SIGN_WHEN_REQUIRED
272
def signature_needed(self):
273
"""Is a signature needed when committing ?."""
274
policy = self._get_signing_policy()
276
policy = self._get_signature_checking()
277
if policy is not None:
278
trace.warning("Please use create_signatures,"
279
" not check_signatures to set signing policy.")
280
if policy == CHECK_ALWAYS:
282
elif policy == SIGN_ALWAYS:
286
def get_alias(self, value):
287
return self._get_alias(value)
289
def _get_alias(self, value):
292
def get_nickname(self):
293
return self._get_nickname()
295
def _get_nickname(self):
298
def get_bzr_remote_path(self):
300
return os.environ['BZR_REMOTE_PATH']
302
path = self.get_user_option("bzr_remote_path")
308
class IniBasedConfig(Config):
309
"""A configuration policy that draws from ini files."""
311
def __init__(self, get_filename):
312
super(IniBasedConfig, self).__init__()
313
self._get_filename = get_filename
316
def _get_parser(self, file=None):
317
if self._parser is not None:
320
input = self._get_filename()
324
self._parser = ConfigObj(input, encoding='utf-8')
325
except configobj.ConfigObjError, e:
326
raise errors.ParseConfigError(e.errors, e.config.filename)
329
def _get_matching_sections(self):
330
"""Return an ordered list of (section_name, extra_path) pairs.
332
If the section contains inherited configuration, extra_path is
333
a string containing the additional path components.
335
section = self._get_section()
336
if section is not None:
337
return [(section, '')]
341
def _get_section(self):
342
"""Override this to define the section used by the config."""
345
def _get_option_policy(self, section, option_name):
346
"""Return the policy for the given (section, option_name) pair."""
349
def _get_signature_checking(self):
350
"""See Config._get_signature_checking."""
351
policy = self._get_user_option('check_signatures')
353
return self._string_to_signature_policy(policy)
355
def _get_signing_policy(self):
356
"""See Config._get_signing_policy"""
357
policy = self._get_user_option('create_signatures')
359
return self._string_to_signing_policy(policy)
361
def _get_user_id(self):
362
"""Get the user id from the 'email' key in the current section."""
363
return self._get_user_option('email')
365
def _get_user_option(self, option_name):
366
"""See Config._get_user_option."""
367
for (section, extra_path) in self._get_matching_sections():
369
value = self._get_parser().get_value(section, option_name)
372
policy = self._get_option_policy(section, option_name)
373
if policy == POLICY_NONE:
375
elif policy == POLICY_NORECURSE:
376
# norecurse items only apply to the exact path
381
elif policy == POLICY_APPENDPATH:
383
value = urlutils.join(value, extra_path)
386
raise AssertionError('Unexpected config policy %r' % policy)
390
def _gpg_signing_command(self):
391
"""See Config.gpg_signing_command."""
392
return self._get_user_option('gpg_signing_command')
394
def _log_format(self):
395
"""See Config.log_format."""
396
return self._get_user_option('log_format')
398
def _post_commit(self):
399
"""See Config.post_commit."""
400
return self._get_user_option('post_commit')
402
def _string_to_signature_policy(self, signature_string):
403
"""Convert a string to a signing policy."""
404
if signature_string.lower() == 'check-available':
405
return CHECK_IF_POSSIBLE
406
if signature_string.lower() == 'ignore':
408
if signature_string.lower() == 'require':
410
raise errors.BzrError("Invalid signatures policy '%s'"
413
def _string_to_signing_policy(self, signature_string):
414
"""Convert a string to a signing policy."""
415
if signature_string.lower() == 'when-required':
416
return SIGN_WHEN_REQUIRED
417
if signature_string.lower() == 'never':
419
if signature_string.lower() == 'always':
421
raise errors.BzrError("Invalid signing policy '%s'"
424
def _get_alias(self, value):
426
return self._get_parser().get_value("ALIASES",
431
def _get_nickname(self):
432
return self.get_user_option('nickname')
435
class GlobalConfig(IniBasedConfig):
436
"""The configuration that should be used for a specific location."""
438
def get_editor(self):
439
return self._get_user_option('editor')
442
super(GlobalConfig, self).__init__(config_filename)
444
def set_user_option(self, option, value):
445
"""Save option and its value in the configuration."""
446
self._set_option(option, value, 'DEFAULT')
448
def get_aliases(self):
449
"""Return the aliases section."""
450
if 'ALIASES' in self._get_parser():
451
return self._get_parser()['ALIASES']
455
def set_alias(self, alias_name, alias_command):
456
"""Save the alias in the configuration."""
457
self._set_option(alias_name, alias_command, 'ALIASES')
459
def unset_alias(self, alias_name):
460
"""Unset an existing alias."""
461
aliases = self._get_parser().get('ALIASES')
462
if not aliases or alias_name not in aliases:
463
raise errors.NoSuchAlias(alias_name)
464
del aliases[alias_name]
465
self._write_config_file()
467
def _set_option(self, option, value, section):
468
# FIXME: RBC 20051029 This should refresh the parser and also take a
469
# file lock on bazaar.conf.
470
conf_dir = os.path.dirname(self._get_filename())
471
ensure_config_dir_exists(conf_dir)
472
self._get_parser().setdefault(section, {})[option] = value
473
self._write_config_file()
475
def _write_config_file(self):
476
f = open(self._get_filename(), 'wb')
477
self._get_parser().write(f)
481
class LocationConfig(IniBasedConfig):
482
"""A configuration object that gives the policy for a location."""
484
def __init__(self, location):
485
name_generator = locations_config_filename
486
if (not os.path.exists(name_generator()) and
487
os.path.exists(branches_config_filename())):
488
if sys.platform == 'win32':
489
trace.warning('Please rename %s to %s'
490
% (branches_config_filename(),
491
locations_config_filename()))
493
trace.warning('Please rename ~/.bazaar/branches.conf'
494
' to ~/.bazaar/locations.conf')
495
name_generator = branches_config_filename
496
super(LocationConfig, self).__init__(name_generator)
497
# local file locations are looked up by local path, rather than
498
# by file url. This is because the config file is a user
499
# file, and we would rather not expose the user to file urls.
500
if location.startswith('file://'):
501
location = urlutils.local_path_from_url(location)
502
self.location = location
504
def _get_matching_sections(self):
505
"""Return an ordered list of section names matching this location."""
506
sections = self._get_parser()
507
location_names = self.location.split('/')
508
if self.location.endswith('/'):
509
del location_names[-1]
511
for section in sections:
512
# location is a local path if possible, so we need
513
# to convert 'file://' urls to local paths if necessary.
514
# This also avoids having file:///path be a more exact
515
# match than '/path'.
516
if section.startswith('file://'):
517
section_path = urlutils.local_path_from_url(section)
519
section_path = section
520
section_names = section_path.split('/')
521
if section.endswith('/'):
522
del section_names[-1]
523
names = zip(location_names, section_names)
526
if not fnmatch(name[0], name[1]):
531
# so, for the common prefix they matched.
532
# if section is longer, no match.
533
if len(section_names) > len(location_names):
535
matches.append((len(section_names), section,
536
'/'.join(location_names[len(section_names):])))
537
matches.sort(reverse=True)
539
for (length, section, extra_path) in matches:
540
sections.append((section, extra_path))
541
# should we stop looking for parent configs here?
543
if self._get_parser()[section].as_bool('ignore_parents'):
549
def _get_option_policy(self, section, option_name):
550
"""Return the policy for the given (section, option_name) pair."""
551
# check for the old 'recurse=False' flag
553
recurse = self._get_parser()[section].as_bool('recurse')
557
return POLICY_NORECURSE
559
policy_key = option_name + ':policy'
561
policy_name = self._get_parser()[section][policy_key]
565
return _policy_value[policy_name]
567
def _set_option_policy(self, section, option_name, option_policy):
568
"""Set the policy for the given option name in the given section."""
569
# The old recurse=False option affects all options in the
570
# section. To handle multiple policies in the section, we
571
# need to convert it to a policy_norecurse key.
573
recurse = self._get_parser()[section].as_bool('recurse')
577
symbol_versioning.warn(
578
'The recurse option is deprecated as of 0.14. '
579
'The section "%s" has been converted to use policies.'
582
del self._get_parser()[section]['recurse']
584
for key in self._get_parser()[section].keys():
585
if not key.endswith(':policy'):
586
self._get_parser()[section][key +
587
':policy'] = 'norecurse'
589
policy_key = option_name + ':policy'
590
policy_name = _policy_name[option_policy]
591
if policy_name is not None:
592
self._get_parser()[section][policy_key] = policy_name
594
if policy_key in self._get_parser()[section]:
595
del self._get_parser()[section][policy_key]
597
def set_user_option(self, option, value, store=STORE_LOCATION):
598
"""Save option and its value in the configuration."""
599
if store not in [STORE_LOCATION,
600
STORE_LOCATION_NORECURSE,
601
STORE_LOCATION_APPENDPATH]:
602
raise ValueError('bad storage policy %r for %r' %
604
# FIXME: RBC 20051029 This should refresh the parser and also take a
605
# file lock on locations.conf.
606
conf_dir = os.path.dirname(self._get_filename())
607
ensure_config_dir_exists(conf_dir)
608
location = self.location
609
if location.endswith('/'):
610
location = location[:-1]
611
if (not location in self._get_parser() and
612
not location + '/' in self._get_parser()):
613
self._get_parser()[location]={}
614
elif location + '/' in self._get_parser():
615
location = location + '/'
616
self._get_parser()[location][option]=value
617
# the allowed values of store match the config policies
618
self._set_option_policy(location, option, store)
619
self._get_parser().write(file(self._get_filename(), 'wb'))
622
class BranchConfig(Config):
623
"""A configuration object giving the policy for a branch."""
625
def _get_branch_data_config(self):
626
if self._branch_data_config is None:
627
self._branch_data_config = TreeConfig(self.branch)
628
return self._branch_data_config
630
def _get_location_config(self):
631
if self._location_config is None:
632
self._location_config = LocationConfig(self.branch.base)
633
return self._location_config
635
def _get_global_config(self):
636
if self._global_config is None:
637
self._global_config = GlobalConfig()
638
return self._global_config
640
def _get_best_value(self, option_name):
641
"""This returns a user option from local, tree or global config.
643
They are tried in that order. Use get_safe_value if trusted values
646
for source in self.option_sources:
647
value = getattr(source(), option_name)()
648
if value is not None:
652
def _get_safe_value(self, option_name):
653
"""This variant of get_best_value never returns untrusted values.
655
It does not return values from the branch data, because the branch may
656
not be controlled by the user.
658
We may wish to allow locations.conf to control whether branches are
659
trusted in the future.
661
for source in (self._get_location_config, self._get_global_config):
662
value = getattr(source(), option_name)()
663
if value is not None:
667
def _get_user_id(self):
668
"""Return the full user id for the branch.
670
e.g. "John Hacker <jhacker@example.com>"
671
This is looked up in the email controlfile for the branch.
674
return (self.branch._transport.get_bytes("email")
675
.decode(osutils.get_user_encoding())
677
except errors.NoSuchFile, e:
680
return self._get_best_value('_get_user_id')
682
def _get_signature_checking(self):
683
"""See Config._get_signature_checking."""
684
return self._get_best_value('_get_signature_checking')
686
def _get_signing_policy(self):
687
"""See Config._get_signing_policy."""
688
return self._get_best_value('_get_signing_policy')
690
def _get_user_option(self, option_name):
691
"""See Config._get_user_option."""
692
for source in self.option_sources:
693
value = source()._get_user_option(option_name)
694
if value is not None:
698
def set_user_option(self, name, value, store=STORE_BRANCH,
700
if store == STORE_BRANCH:
701
self._get_branch_data_config().set_option(value, name)
702
elif store == STORE_GLOBAL:
703
self._get_global_config().set_user_option(name, value)
705
self._get_location_config().set_user_option(name, value, store)
708
if store in (STORE_GLOBAL, STORE_BRANCH):
709
mask_value = self._get_location_config().get_user_option(name)
710
if mask_value is not None:
711
trace.warning('Value "%s" is masked by "%s" from'
712
' locations.conf', value, mask_value)
714
if store == STORE_GLOBAL:
715
branch_config = self._get_branch_data_config()
716
mask_value = branch_config.get_user_option(name)
717
if mask_value is not None:
718
trace.warning('Value "%s" is masked by "%s" from'
719
' branch.conf', value, mask_value)
721
def _gpg_signing_command(self):
722
"""See Config.gpg_signing_command."""
723
return self._get_safe_value('_gpg_signing_command')
725
def __init__(self, branch):
726
super(BranchConfig, self).__init__()
727
self._location_config = None
728
self._branch_data_config = None
729
self._global_config = None
731
self.option_sources = (self._get_location_config,
732
self._get_branch_data_config,
733
self._get_global_config)
735
def _post_commit(self):
736
"""See Config.post_commit."""
737
return self._get_safe_value('_post_commit')
739
def _get_nickname(self):
740
value = self._get_explicit_nickname()
741
if value is not None:
743
return urlutils.unescape(self.branch.base.split('/')[-2])
745
def has_explicit_nickname(self):
746
"""Return true if a nickname has been explicitly assigned."""
747
return self._get_explicit_nickname() is not None
749
def _get_explicit_nickname(self):
750
return self._get_best_value('_get_nickname')
752
def _log_format(self):
753
"""See Config.log_format."""
754
return self._get_best_value('_log_format')
757
def ensure_config_dir_exists(path=None):
758
"""Make sure a configuration directory exists.
759
This makes sure that the directory exists.
760
On windows, since configuration directories are 2 levels deep,
761
it makes sure both the directory and the parent directory exists.
765
if not os.path.isdir(path):
766
if sys.platform == 'win32':
767
parent_dir = os.path.dirname(path)
768
if not os.path.isdir(parent_dir):
769
trace.mutter('creating config parent directory: %r', parent_dir)
771
trace.mutter('creating config directory: %r', path)
776
"""Return per-user configuration directory.
778
By default this is ~/.bazaar/
780
TODO: Global option --config-dir to override this.
782
base = os.environ.get('BZR_HOME', None)
783
if sys.platform == 'win32':
785
base = win32utils.get_appdata_location_unicode()
787
base = os.environ.get('HOME', None)
789
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
791
return osutils.pathjoin(base, 'bazaar', '2.0')
793
# cygwin, linux, and darwin all have a $HOME directory
795
base = os.path.expanduser("~")
796
return osutils.pathjoin(base, ".bazaar")
799
def config_filename():
800
"""Return per-user configuration ini file filename."""
801
return osutils.pathjoin(config_dir(), 'bazaar.conf')
804
def branches_config_filename():
805
"""Return per-user configuration ini file filename."""
806
return osutils.pathjoin(config_dir(), 'branches.conf')
809
def locations_config_filename():
810
"""Return per-user configuration ini file filename."""
811
return osutils.pathjoin(config_dir(), 'locations.conf')
814
def authentication_config_filename():
815
"""Return per-user authentication ini file filename."""
816
return osutils.pathjoin(config_dir(), 'authentication.conf')
819
def user_ignore_config_filename():
820
"""Return the user default ignore filename"""
821
return osutils.pathjoin(config_dir(), 'ignore')
825
"""Return the directory name to store crash files.
827
This doesn't implicitly create it.
829
On Windows it's in the config directory; elsewhere in the XDG cache directory.
831
if sys.platform == 'win32':
832
return osutils.pathjoin(config_dir(), 'Crash')
834
return osutils.pathjoin(xdg_cache_dir(), 'crash')
838
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
839
# Possibly this should be different on Windows?
840
e = os.environ.get('XDG_CACHE_DIR', None)
844
return os.path.expanduser('~/.cache')
848
"""Calculate automatic user identification.
850
Returns (realname, email).
852
Only used when none is set in the environment or the id file.
854
This previously used the FQDN as the default domain, but that can
855
be very slow on machines where DNS is broken. So now we simply
860
if sys.platform == 'win32':
861
name = win32utils.get_user_name_unicode()
863
raise errors.BzrError("Cannot autodetect user name.\n"
864
"Please, set your name with command like:\n"
865
'bzr whoami "Your Name <name@domain.com>"')
866
host = win32utils.get_host_name_unicode()
868
host = socket.gethostname()
869
return name, (name + '@' + host)
875
w = pwd.getpwuid(uid)
877
raise errors.BzrCommandError('Unable to determine your name. '
878
'Please use "bzr whoami" to set it.')
880
# we try utf-8 first, because on many variants (like Linux),
881
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
882
# false positives. (many users will have their user encoding set to
883
# latin-1, which cannot raise UnicodeError.)
885
gecos = w.pw_gecos.decode('utf-8')
889
encoding = osutils.get_user_encoding()
890
gecos = w.pw_gecos.decode(encoding)
892
raise errors.BzrCommandError('Unable to determine your name. '
893
'Use "bzr whoami" to set it.')
895
username = w.pw_name.decode(encoding)
897
raise errors.BzrCommandError('Unable to determine your name. '
898
'Use "bzr whoami" to set it.')
900
comma = gecos.find(',')
904
realname = gecos[:comma]
911
user_encoding = osutils.get_user_encoding()
912
realname = username = getpass.getuser().decode(user_encoding)
913
except UnicodeDecodeError:
914
raise errors.BzrError("Can't decode username as %s." % \
917
return realname, (username + '@' + socket.gethostname())
920
def parse_username(username):
921
"""Parse e-mail username and return a (name, address) tuple."""
922
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
924
return (username, '')
926
return (match.group(1), match.group(2))
929
def extract_email_address(e):
930
"""Return just the address part of an email string.
932
That is just the user@domain part, nothing else.
933
This part is required to contain only ascii characters.
934
If it can't be extracted, raises an error.
936
>>> extract_email_address('Jane Tester <jane@test.com>')
939
name, email = parse_username(e)
941
raise errors.NoEmailInUsername(e)
945
class TreeConfig(IniBasedConfig):
946
"""Branch configuration data associated with its contents, not location"""
948
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
950
def __init__(self, branch):
951
self._config = branch._get_config()
954
def _get_parser(self, file=None):
956
return IniBasedConfig._get_parser(file)
957
return self._config._get_configobj()
959
def get_option(self, name, section=None, default=None):
960
self.branch.lock_read()
962
return self._config.get_option(name, section, default)
966
def set_option(self, value, name, section=None):
967
"""Set a per-branch configuration option"""
968
self.branch.lock_write()
970
self._config.set_option(value, name, section)
975
class AuthenticationConfig(object):
976
"""The authentication configuration file based on a ini file.
978
Implements the authentication.conf file described in
979
doc/developers/authentication-ring.txt.
982
def __init__(self, _file=None):
983
self._config = None # The ConfigObj
985
self._filename = authentication_config_filename()
986
self._input = self._filename = authentication_config_filename()
988
# Tests can provide a string as _file
989
self._filename = None
992
def _get_config(self):
993
if self._config is not None:
996
# FIXME: Should we validate something here ? Includes: empty
997
# sections are useless, at least one of
998
# user/password/password_encoding should be defined, etc.
1000
# Note: the encoding below declares that the file itself is utf-8
1001
# encoded, but the values in the ConfigObj are always Unicode.
1002
self._config = ConfigObj(self._input, encoding='utf-8')
1003
except configobj.ConfigObjError, e:
1004
raise errors.ParseConfigError(e.errors, e.config.filename)
1008
"""Save the config file, only tests should use it for now."""
1009
conf_dir = os.path.dirname(self._filename)
1010
ensure_config_dir_exists(conf_dir)
1011
self._get_config().write(file(self._filename, 'wb'))
1013
def _set_option(self, section_name, option_name, value):
1014
"""Set an authentication configuration option"""
1015
conf = self._get_config()
1016
section = conf.get(section_name)
1019
section = conf[section]
1020
section[option_name] = value
1023
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1025
"""Returns the matching credentials from authentication.conf file.
1027
:param scheme: protocol
1029
:param host: the server address
1031
:param port: the associated port (optional)
1033
:param user: login (optional)
1035
:param path: the absolute path on the server (optional)
1037
:param realm: the http authentication realm (optional)
1039
:return: A dict containing the matching credentials or None.
1041
- name: the section name of the credentials in the
1042
authentication.conf file,
1043
- user: can't be different from the provided user if any,
1044
- scheme: the server protocol,
1045
- host: the server address,
1046
- port: the server port (can be None),
1047
- path: the absolute server path (can be None),
1048
- realm: the http specific authentication realm (can be None),
1049
- password: the decoded password, could be None if the credential
1050
defines only the user
1051
- verify_certificates: https specific, True if the server
1052
certificate should be verified, False otherwise.
1055
for auth_def_name, auth_def in self._get_config().items():
1056
if type(auth_def) is not configobj.Section:
1057
raise ValueError("%s defined outside a section" % auth_def_name)
1059
a_scheme, a_host, a_user, a_path = map(
1060
auth_def.get, ['scheme', 'host', 'user', 'path'])
1063
a_port = auth_def.as_int('port')
1067
raise ValueError("'port' not numeric in %s" % auth_def_name)
1069
a_verify_certificates = auth_def.as_bool('verify_certificates')
1071
a_verify_certificates = True
1074
"'verify_certificates' not boolean in %s" % auth_def_name)
1077
if a_scheme is not None and scheme != a_scheme:
1079
if a_host is not None:
1080
if not (host == a_host
1081
or (a_host.startswith('.') and host.endswith(a_host))):
1083
if a_port is not None and port != a_port:
1085
if (a_path is not None and path is not None
1086
and not path.startswith(a_path)):
1088
if (a_user is not None and user is not None
1089
and a_user != user):
1090
# Never contradict the caller about the user to be used
1095
# Prepare a credentials dictionary with additional keys
1096
# for the credential providers
1097
credentials = dict(name=auth_def_name,
1104
password=auth_def.get('password', None),
1105
verify_certificates=a_verify_certificates)
1106
# Decode the password in the credentials (or get one)
1107
self.decode_password(credentials,
1108
auth_def.get('password_encoding', None))
1109
if 'auth' in debug.debug_flags:
1110
trace.mutter("Using authentication section: %r", auth_def_name)
1113
if credentials is None:
1114
# No credentials were found in authentication.conf, try the fallback
1115
# credentials stores.
1116
credentials = credential_store_registry.get_fallback_credentials(
1117
scheme, host, port, user, path, realm)
1121
def set_credentials(self, name, host, user, scheme=None, password=None,
1122
port=None, path=None, verify_certificates=None,
1124
"""Set authentication credentials for a host.
1126
Any existing credentials with matching scheme, host, port and path
1127
will be deleted, regardless of name.
1129
:param name: An arbitrary name to describe this set of credentials.
1130
:param host: Name of the host that accepts these credentials.
1131
:param user: The username portion of these credentials.
1132
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1134
:param password: Password portion of these credentials.
1135
:param port: The IP port on the host that these credentials apply to.
1136
:param path: A filesystem path on the host that these credentials
1138
:param verify_certificates: On https, verify server certificates if
1140
:param realm: The http authentication realm (optional).
1142
values = {'host': host, 'user': user}
1143
if password is not None:
1144
values['password'] = password
1145
if scheme is not None:
1146
values['scheme'] = scheme
1147
if port is not None:
1148
values['port'] = '%d' % port
1149
if path is not None:
1150
values['path'] = path
1151
if verify_certificates is not None:
1152
values['verify_certificates'] = str(verify_certificates)
1153
if realm is not None:
1154
values['realm'] = realm
1155
config = self._get_config()
1157
for section, existing_values in config.items():
1158
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1159
if existing_values.get(key) != values.get(key):
1163
config.update({name: values})
1166
def get_user(self, scheme, host, port=None, realm=None, path=None,
1167
prompt=None, ask=False, default=None):
1168
"""Get a user from authentication file.
1170
:param scheme: protocol
1172
:param host: the server address
1174
:param port: the associated port (optional)
1176
:param realm: the realm sent by the server (optional)
1178
:param path: the absolute path on the server (optional)
1180
:param ask: Ask the user if there is no explicitly configured username
1183
:param default: The username returned if none is defined (optional).
1185
:return: The found user.
1187
credentials = self.get_credentials(scheme, host, port, user=None,
1188
path=path, realm=realm)
1189
if credentials is not None:
1190
user = credentials['user']
1196
# Create a default prompt suitable for most cases
1197
prompt = scheme.upper() + ' %(host)s username'
1198
# Special handling for optional fields in the prompt
1199
if port is not None:
1200
prompt_host = '%s:%d' % (host, port)
1203
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1208
def get_password(self, scheme, host, user, port=None,
1209
realm=None, path=None, prompt=None):
1210
"""Get a password from authentication file or prompt the user for one.
1212
:param scheme: protocol
1214
:param host: the server address
1216
:param port: the associated port (optional)
1220
:param realm: the realm sent by the server (optional)
1222
:param path: the absolute path on the server (optional)
1224
:return: The found password or the one entered by the user.
1226
credentials = self.get_credentials(scheme, host, port, user, path,
1228
if credentials is not None:
1229
password = credentials['password']
1230
if password is not None and scheme is 'ssh':
1231
trace.warning('password ignored in section [%s],'
1232
' use an ssh agent instead'
1233
% credentials['name'])
1237
# Prompt user only if we could't find a password
1238
if password is None:
1240
# Create a default prompt suitable for most cases
1241
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1242
# Special handling for optional fields in the prompt
1243
if port is not None:
1244
prompt_host = '%s:%d' % (host, port)
1247
password = ui.ui_factory.get_password(prompt,
1248
host=prompt_host, user=user)
1251
def decode_password(self, credentials, encoding):
1253
cs = credential_store_registry.get_credential_store(encoding)
1255
raise ValueError('%r is not a known password_encoding' % encoding)
1256
credentials['password'] = cs.decode_password(credentials)
1260
class CredentialStoreRegistry(registry.Registry):
1261
"""A class that registers credential stores.
1263
A credential store provides access to credentials via the password_encoding
1264
field in authentication.conf sections.
1266
Except for stores provided by bzr itself, most stores are expected to be
1267
provided by plugins that will therefore use
1268
register_lazy(password_encoding, module_name, member_name, help=help,
1269
fallback=fallback) to install themselves.
1271
A fallback credential store is one that is queried if no credentials can be
1272
found via authentication.conf.
1275
def get_credential_store(self, encoding=None):
1276
cs = self.get(encoding)
1281
def is_fallback(self, name):
1282
"""Check if the named credentials store should be used as fallback."""
1283
return self.get_info(name)
1285
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1286
path=None, realm=None):
1287
"""Request credentials from all fallback credentials stores.
1289
The first credentials store that can provide credentials wins.
1292
for name in self.keys():
1293
if not self.is_fallback(name):
1295
cs = self.get_credential_store(name)
1296
credentials = cs.get_credentials(scheme, host, port, user,
1298
if credentials is not None:
1299
# We found some credentials
1303
def register(self, key, obj, help=None, override_existing=False,
1305
"""Register a new object to a name.
1307
:param key: This is the key to use to request the object later.
1308
:param obj: The object to register.
1309
:param help: Help text for this entry. This may be a string or
1310
a callable. If it is a callable, it should take two
1311
parameters (registry, key): this registry and the key that
1312
the help was registered under.
1313
:param override_existing: Raise KeyErorr if False and something has
1314
already been registered for that key. If True, ignore if there
1315
is an existing key (always register the new value).
1316
:param fallback: Whether this credential store should be
1319
return super(CredentialStoreRegistry,
1320
self).register(key, obj, help, info=fallback,
1321
override_existing=override_existing)
1323
def register_lazy(self, key, module_name, member_name,
1324
help=None, override_existing=False,
1326
"""Register a new credential store to be loaded on request.
1328
:param module_name: The python path to the module. Such as 'os.path'.
1329
:param member_name: The member of the module to return. If empty or
1330
None, get() will return the module itself.
1331
:param help: Help text for this entry. This may be a string or
1333
:param override_existing: If True, replace the existing object
1334
with the new one. If False, if there is already something
1335
registered with the same key, raise a KeyError
1336
:param fallback: Whether this credential store should be
1339
return super(CredentialStoreRegistry, self).register_lazy(
1340
key, module_name, member_name, help,
1341
info=fallback, override_existing=override_existing)
1344
credential_store_registry = CredentialStoreRegistry()
1347
class CredentialStore(object):
1348
"""An abstract class to implement storage for credentials"""
1350
def decode_password(self, credentials):
1351
"""Returns a clear text password for the provided credentials."""
1352
raise NotImplementedError(self.decode_password)
1354
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1356
"""Return the matching credentials from this credential store.
1358
This method is only called on fallback credential stores.
1360
raise NotImplementedError(self.get_credentials)
1364
class PlainTextCredentialStore(CredentialStore):
1365
"""Plain text credential store for the authentication.conf file."""
1367
def decode_password(self, credentials):
1368
"""See CredentialStore.decode_password."""
1369
return credentials['password']
1372
credential_store_registry.register('plain', PlainTextCredentialStore,
1373
help=PlainTextCredentialStore.__doc__)
1374
credential_store_registry.default_key = 'plain'
1377
class BzrDirConfig(object):
1379
def __init__(self, bzrdir):
1380
self._bzrdir = bzrdir
1381
self._config = bzrdir._get_config()
1383
def set_default_stack_on(self, value):
1384
"""Set the default stacking location.
1386
It may be set to a location, or None.
1388
This policy affects all branches contained by this bzrdir, except for
1389
those under repositories.
1391
if self._config is None:
1392
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1394
self._config.set_option('', 'default_stack_on')
1396
self._config.set_option(value, 'default_stack_on')
1398
def get_default_stack_on(self):
1399
"""Return the default stacking location.
1401
This will either be a location, or None.
1403
This policy affects all branches contained by this bzrdir, except for
1404
those under repositories.
1406
if self._config is None:
1408
value = self._config.get_option('default_stack_on')
1414
class TransportConfig(object):
1415
"""A Config that reads/writes a config file on a Transport.
1417
It is a low-level object that considers config data to be name/value pairs
1418
that may be associated with a section. Assigning meaning to the these
1419
values is done at higher levels like TreeConfig.
1422
def __init__(self, transport, filename):
1423
self._transport = transport
1424
self._filename = filename
1426
def get_option(self, name, section=None, default=None):
1427
"""Return the value associated with a named option.
1429
:param name: The name of the value
1430
:param section: The section the option is in (if any)
1431
:param default: The value to return if the value is not set
1432
:return: The value or default value
1434
configobj = self._get_configobj()
1436
section_obj = configobj
1439
section_obj = configobj[section]
1442
return section_obj.get(name, default)
1444
def set_option(self, value, name, section=None):
1445
"""Set the value associated with a named option.
1447
:param value: The value to set
1448
:param name: The name of the value to set
1449
:param section: The section the option is in (if any)
1451
configobj = self._get_configobj()
1453
configobj[name] = value
1455
configobj.setdefault(section, {})[name] = value
1456
self._set_configobj(configobj)
1458
def _get_config_file(self):
1460
return self._transport.get(self._filename)
1461
except errors.NoSuchFile:
1464
def _get_configobj(self):
1465
return ConfigObj(self._get_config_file(), encoding='utf-8')
1467
def _set_configobj(self, configobj):
1468
out_file = StringIO()
1469
configobj.write(out_file)
1471
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
