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_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 ortherwise.
195
s = self._get_user_option(option_name)
196
return ui.bool_from_string(s)
198
def gpg_signing_command(self):
199
"""What program should be used to sign signatures?"""
200
result = self._gpg_signing_command()
205
def _gpg_signing_command(self):
206
"""See gpg_signing_command()."""
209
def log_format(self):
210
"""What log format should be used"""
211
result = self._log_format()
216
def _log_format(self):
217
"""See log_format()."""
220
def post_commit(self):
221
"""An ordered list of python functions to call.
223
Each function takes branch, rev_id as parameters.
225
return self._post_commit()
227
def _post_commit(self):
228
"""See Config.post_commit."""
231
def user_email(self):
232
"""Return just the email component of a username."""
233
return extract_email_address(self.username())
236
"""Return email-style username.
238
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
240
$BZR_EMAIL can be set to override this (as well as the
241
deprecated $BZREMAIL), then
242
the concrete policy type is checked, and finally
244
If none is found, a reasonable default is (hopefully)
247
TODO: Check it's reasonably well-formed.
249
v = os.environ.get('BZR_EMAIL')
251
return v.decode(osutils.get_user_encoding())
253
v = self._get_user_id()
257
v = os.environ.get('EMAIL')
259
return v.decode(osutils.get_user_encoding())
261
name, email = _auto_user_id()
263
return '%s <%s>' % (name, email)
267
def signature_checking(self):
268
"""What is the current policy for signature checking?."""
269
policy = self._get_signature_checking()
270
if policy is not None:
272
return CHECK_IF_POSSIBLE
274
def signing_policy(self):
275
"""What is the current policy for signature checking?."""
276
policy = self._get_signing_policy()
277
if policy is not None:
279
return SIGN_WHEN_REQUIRED
281
def signature_needed(self):
282
"""Is a signature needed when committing ?."""
283
policy = self._get_signing_policy()
285
policy = self._get_signature_checking()
286
if policy is not None:
287
trace.warning("Please use create_signatures,"
288
" not check_signatures to set signing policy.")
289
if policy == CHECK_ALWAYS:
291
elif policy == SIGN_ALWAYS:
295
def get_alias(self, value):
296
return self._get_alias(value)
298
def _get_alias(self, value):
301
def get_nickname(self):
302
return self._get_nickname()
304
def _get_nickname(self):
307
def get_bzr_remote_path(self):
309
return os.environ['BZR_REMOTE_PATH']
311
path = self.get_user_option("bzr_remote_path")
317
class IniBasedConfig(Config):
318
"""A configuration policy that draws from ini files."""
320
def __init__(self, get_filename):
321
super(IniBasedConfig, self).__init__()
322
self._get_filename = get_filename
325
def _get_parser(self, file=None):
326
if self._parser is not None:
329
input = self._get_filename()
333
self._parser = ConfigObj(input, encoding='utf-8')
334
except configobj.ConfigObjError, e:
335
raise errors.ParseConfigError(e.errors, e.config.filename)
338
def _get_matching_sections(self):
339
"""Return an ordered list of (section_name, extra_path) pairs.
341
If the section contains inherited configuration, extra_path is
342
a string containing the additional path components.
344
section = self._get_section()
345
if section is not None:
346
return [(section, '')]
350
def _get_section(self):
351
"""Override this to define the section used by the config."""
354
def _get_option_policy(self, section, option_name):
355
"""Return the policy for the given (section, option_name) pair."""
358
def _get_change_editor(self):
359
return self.get_user_option('change_editor')
361
def _get_signature_checking(self):
362
"""See Config._get_signature_checking."""
363
policy = self._get_user_option('check_signatures')
365
return self._string_to_signature_policy(policy)
367
def _get_signing_policy(self):
368
"""See Config._get_signing_policy"""
369
policy = self._get_user_option('create_signatures')
371
return self._string_to_signing_policy(policy)
373
def _get_user_id(self):
374
"""Get the user id from the 'email' key in the current section."""
375
return self._get_user_option('email')
377
def _get_user_option(self, option_name):
378
"""See Config._get_user_option."""
379
for (section, extra_path) in self._get_matching_sections():
381
value = self._get_parser().get_value(section, option_name)
384
policy = self._get_option_policy(section, option_name)
385
if policy == POLICY_NONE:
387
elif policy == POLICY_NORECURSE:
388
# norecurse items only apply to the exact path
393
elif policy == POLICY_APPENDPATH:
395
value = urlutils.join(value, extra_path)
398
raise AssertionError('Unexpected config policy %r' % policy)
402
def _gpg_signing_command(self):
403
"""See Config.gpg_signing_command."""
404
return self._get_user_option('gpg_signing_command')
406
def _log_format(self):
407
"""See Config.log_format."""
408
return self._get_user_option('log_format')
410
def _post_commit(self):
411
"""See Config.post_commit."""
412
return self._get_user_option('post_commit')
414
def _string_to_signature_policy(self, signature_string):
415
"""Convert a string to a signing policy."""
416
if signature_string.lower() == 'check-available':
417
return CHECK_IF_POSSIBLE
418
if signature_string.lower() == 'ignore':
420
if signature_string.lower() == 'require':
422
raise errors.BzrError("Invalid signatures policy '%s'"
425
def _string_to_signing_policy(self, signature_string):
426
"""Convert a string to a signing policy."""
427
if signature_string.lower() == 'when-required':
428
return SIGN_WHEN_REQUIRED
429
if signature_string.lower() == 'never':
431
if signature_string.lower() == 'always':
433
raise errors.BzrError("Invalid signing policy '%s'"
436
def _get_alias(self, value):
438
return self._get_parser().get_value("ALIASES",
443
def _get_nickname(self):
444
return self.get_user_option('nickname')
447
class GlobalConfig(IniBasedConfig):
448
"""The configuration that should be used for a specific location."""
450
def get_editor(self):
451
return self._get_user_option('editor')
454
super(GlobalConfig, self).__init__(config_filename)
456
def set_user_option(self, option, value):
457
"""Save option and its value in the configuration."""
458
self._set_option(option, value, 'DEFAULT')
460
def get_aliases(self):
461
"""Return the aliases section."""
462
if 'ALIASES' in self._get_parser():
463
return self._get_parser()['ALIASES']
467
def set_alias(self, alias_name, alias_command):
468
"""Save the alias in the configuration."""
469
self._set_option(alias_name, alias_command, 'ALIASES')
471
def unset_alias(self, alias_name):
472
"""Unset an existing alias."""
473
aliases = self._get_parser().get('ALIASES')
474
if not aliases or alias_name not in aliases:
475
raise errors.NoSuchAlias(alias_name)
476
del aliases[alias_name]
477
self._write_config_file()
479
def _set_option(self, option, value, section):
480
# FIXME: RBC 20051029 This should refresh the parser and also take a
481
# file lock on bazaar.conf.
482
conf_dir = os.path.dirname(self._get_filename())
483
ensure_config_dir_exists(conf_dir)
484
self._get_parser().setdefault(section, {})[option] = value
485
self._write_config_file()
487
def _write_config_file(self):
488
f = open(self._get_filename(), 'wb')
489
self._get_parser().write(f)
493
class LocationConfig(IniBasedConfig):
494
"""A configuration object that gives the policy for a location."""
496
def __init__(self, location):
497
name_generator = locations_config_filename
498
if (not os.path.exists(name_generator()) and
499
os.path.exists(branches_config_filename())):
500
if sys.platform == 'win32':
501
trace.warning('Please rename %s to %s'
502
% (branches_config_filename(),
503
locations_config_filename()))
505
trace.warning('Please rename ~/.bazaar/branches.conf'
506
' to ~/.bazaar/locations.conf')
507
name_generator = branches_config_filename
508
super(LocationConfig, self).__init__(name_generator)
509
# local file locations are looked up by local path, rather than
510
# by file url. This is because the config file is a user
511
# file, and we would rather not expose the user to file urls.
512
if location.startswith('file://'):
513
location = urlutils.local_path_from_url(location)
514
self.location = location
516
def _get_matching_sections(self):
517
"""Return an ordered list of section names matching this location."""
518
sections = self._get_parser()
519
location_names = self.location.split('/')
520
if self.location.endswith('/'):
521
del location_names[-1]
523
for section in sections:
524
# location is a local path if possible, so we need
525
# to convert 'file://' urls to local paths if necessary.
526
# This also avoids having file:///path be a more exact
527
# match than '/path'.
528
if section.startswith('file://'):
529
section_path = urlutils.local_path_from_url(section)
531
section_path = section
532
section_names = section_path.split('/')
533
if section.endswith('/'):
534
del section_names[-1]
535
names = zip(location_names, section_names)
538
if not fnmatch(name[0], name[1]):
543
# so, for the common prefix they matched.
544
# if section is longer, no match.
545
if len(section_names) > len(location_names):
547
matches.append((len(section_names), section,
548
'/'.join(location_names[len(section_names):])))
549
matches.sort(reverse=True)
551
for (length, section, extra_path) in matches:
552
sections.append((section, extra_path))
553
# should we stop looking for parent configs here?
555
if self._get_parser()[section].as_bool('ignore_parents'):
561
def _get_option_policy(self, section, option_name):
562
"""Return the policy for the given (section, option_name) pair."""
563
# check for the old 'recurse=False' flag
565
recurse = self._get_parser()[section].as_bool('recurse')
569
return POLICY_NORECURSE
571
policy_key = option_name + ':policy'
573
policy_name = self._get_parser()[section][policy_key]
577
return _policy_value[policy_name]
579
def _set_option_policy(self, section, option_name, option_policy):
580
"""Set the policy for the given option name in the given section."""
581
# The old recurse=False option affects all options in the
582
# section. To handle multiple policies in the section, we
583
# need to convert it to a policy_norecurse key.
585
recurse = self._get_parser()[section].as_bool('recurse')
589
symbol_versioning.warn(
590
'The recurse option is deprecated as of 0.14. '
591
'The section "%s" has been converted to use policies.'
594
del self._get_parser()[section]['recurse']
596
for key in self._get_parser()[section].keys():
597
if not key.endswith(':policy'):
598
self._get_parser()[section][key +
599
':policy'] = 'norecurse'
601
policy_key = option_name + ':policy'
602
policy_name = _policy_name[option_policy]
603
if policy_name is not None:
604
self._get_parser()[section][policy_key] = policy_name
606
if policy_key in self._get_parser()[section]:
607
del self._get_parser()[section][policy_key]
609
def set_user_option(self, option, value, store=STORE_LOCATION):
610
"""Save option and its value in the configuration."""
611
if store not in [STORE_LOCATION,
612
STORE_LOCATION_NORECURSE,
613
STORE_LOCATION_APPENDPATH]:
614
raise ValueError('bad storage policy %r for %r' %
616
# FIXME: RBC 20051029 This should refresh the parser and also take a
617
# file lock on locations.conf.
618
conf_dir = os.path.dirname(self._get_filename())
619
ensure_config_dir_exists(conf_dir)
620
location = self.location
621
if location.endswith('/'):
622
location = location[:-1]
623
if (not location in self._get_parser() and
624
not location + '/' in self._get_parser()):
625
self._get_parser()[location]={}
626
elif location + '/' in self._get_parser():
627
location = location + '/'
628
self._get_parser()[location][option]=value
629
# the allowed values of store match the config policies
630
self._set_option_policy(location, option, store)
631
self._get_parser().write(file(self._get_filename(), 'wb'))
634
class BranchConfig(Config):
635
"""A configuration object giving the policy for a branch."""
637
def _get_branch_data_config(self):
638
if self._branch_data_config is None:
639
self._branch_data_config = TreeConfig(self.branch)
640
return self._branch_data_config
642
def _get_location_config(self):
643
if self._location_config is None:
644
self._location_config = LocationConfig(self.branch.base)
645
return self._location_config
647
def _get_global_config(self):
648
if self._global_config is None:
649
self._global_config = GlobalConfig()
650
return self._global_config
652
def _get_best_value(self, option_name):
653
"""This returns a user option from local, tree or global config.
655
They are tried in that order. Use get_safe_value if trusted values
658
for source in self.option_sources:
659
value = getattr(source(), option_name)()
660
if value is not None:
664
def _get_safe_value(self, option_name):
665
"""This variant of get_best_value never returns untrusted values.
667
It does not return values from the branch data, because the branch may
668
not be controlled by the user.
670
We may wish to allow locations.conf to control whether branches are
671
trusted in the future.
673
for source in (self._get_location_config, self._get_global_config):
674
value = getattr(source(), option_name)()
675
if value is not None:
679
def _get_user_id(self):
680
"""Return the full user id for the branch.
682
e.g. "John Hacker <jhacker@example.com>"
683
This is looked up in the email controlfile for the branch.
686
return (self.branch._transport.get_bytes("email")
687
.decode(osutils.get_user_encoding())
689
except errors.NoSuchFile, e:
692
return self._get_best_value('_get_user_id')
694
def _get_change_editor(self):
695
return self._get_best_value('_get_change_editor')
697
def _get_signature_checking(self):
698
"""See Config._get_signature_checking."""
699
return self._get_best_value('_get_signature_checking')
701
def _get_signing_policy(self):
702
"""See Config._get_signing_policy."""
703
return self._get_best_value('_get_signing_policy')
705
def _get_user_option(self, option_name):
706
"""See Config._get_user_option."""
707
for source in self.option_sources:
708
value = source()._get_user_option(option_name)
709
if value is not None:
713
def set_user_option(self, name, value, store=STORE_BRANCH,
715
if store == STORE_BRANCH:
716
self._get_branch_data_config().set_option(value, name)
717
elif store == STORE_GLOBAL:
718
self._get_global_config().set_user_option(name, value)
720
self._get_location_config().set_user_option(name, value, store)
723
if store in (STORE_GLOBAL, STORE_BRANCH):
724
mask_value = self._get_location_config().get_user_option(name)
725
if mask_value is not None:
726
trace.warning('Value "%s" is masked by "%s" from'
727
' locations.conf', value, mask_value)
729
if store == STORE_GLOBAL:
730
branch_config = self._get_branch_data_config()
731
mask_value = branch_config.get_user_option(name)
732
if mask_value is not None:
733
trace.warning('Value "%s" is masked by "%s" from'
734
' branch.conf', value, mask_value)
736
def _gpg_signing_command(self):
737
"""See Config.gpg_signing_command."""
738
return self._get_safe_value('_gpg_signing_command')
740
def __init__(self, branch):
741
super(BranchConfig, self).__init__()
742
self._location_config = None
743
self._branch_data_config = None
744
self._global_config = None
746
self.option_sources = (self._get_location_config,
747
self._get_branch_data_config,
748
self._get_global_config)
750
def _post_commit(self):
751
"""See Config.post_commit."""
752
return self._get_safe_value('_post_commit')
754
def _get_nickname(self):
755
value = self._get_explicit_nickname()
756
if value is not None:
758
return urlutils.unescape(self.branch.base.split('/')[-2])
760
def has_explicit_nickname(self):
761
"""Return true if a nickname has been explicitly assigned."""
762
return self._get_explicit_nickname() is not None
764
def _get_explicit_nickname(self):
765
return self._get_best_value('_get_nickname')
767
def _log_format(self):
768
"""See Config.log_format."""
769
return self._get_best_value('_log_format')
772
def ensure_config_dir_exists(path=None):
773
"""Make sure a configuration directory exists.
774
This makes sure that the directory exists.
775
On windows, since configuration directories are 2 levels deep,
776
it makes sure both the directory and the parent directory exists.
780
if not os.path.isdir(path):
781
if sys.platform == 'win32':
782
parent_dir = os.path.dirname(path)
783
if not os.path.isdir(parent_dir):
784
trace.mutter('creating config parent directory: %r', parent_dir)
786
trace.mutter('creating config directory: %r', path)
791
"""Return per-user configuration directory.
793
By default this is ~/.bazaar/
795
TODO: Global option --config-dir to override this.
797
base = os.environ.get('BZR_HOME', None)
798
if sys.platform == 'win32':
800
base = win32utils.get_appdata_location_unicode()
802
base = os.environ.get('HOME', None)
804
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
806
return osutils.pathjoin(base, 'bazaar', '2.0')
808
# cygwin, linux, and darwin all have a $HOME directory
810
base = os.path.expanduser("~")
811
return osutils.pathjoin(base, ".bazaar")
814
def config_filename():
815
"""Return per-user configuration ini file filename."""
816
return osutils.pathjoin(config_dir(), 'bazaar.conf')
819
def branches_config_filename():
820
"""Return per-user configuration ini file filename."""
821
return osutils.pathjoin(config_dir(), 'branches.conf')
824
def locations_config_filename():
825
"""Return per-user configuration ini file filename."""
826
return osutils.pathjoin(config_dir(), 'locations.conf')
829
def authentication_config_filename():
830
"""Return per-user authentication ini file filename."""
831
return osutils.pathjoin(config_dir(), 'authentication.conf')
834
def user_ignore_config_filename():
835
"""Return the user default ignore filename"""
836
return osutils.pathjoin(config_dir(), 'ignore')
840
"""Return the directory name to store crash files.
842
This doesn't implicitly create it.
844
On Windows it's in the config directory; elsewhere in the XDG cache directory.
846
if sys.platform == 'win32':
847
return osutils.pathjoin(config_dir(), 'Crash')
849
return osutils.pathjoin(xdg_cache_dir(), 'crash')
853
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
854
# Possibly this should be different on Windows?
855
e = os.environ.get('XDG_CACHE_DIR', None)
859
return os.path.expanduser('~/.cache')
863
"""Calculate automatic user identification.
865
Returns (realname, email).
867
Only used when none is set in the environment or the id file.
869
This previously used the FQDN as the default domain, but that can
870
be very slow on machines where DNS is broken. So now we simply
875
if sys.platform == 'win32':
876
name = win32utils.get_user_name_unicode()
878
raise errors.BzrError("Cannot autodetect user name.\n"
879
"Please, set your name with command like:\n"
880
'bzr whoami "Your Name <name@domain.com>"')
881
host = win32utils.get_host_name_unicode()
883
host = socket.gethostname()
884
return name, (name + '@' + host)
890
w = pwd.getpwuid(uid)
892
raise errors.BzrCommandError('Unable to determine your name. '
893
'Please use "bzr whoami" to set it.')
895
# we try utf-8 first, because on many variants (like Linux),
896
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
897
# false positives. (many users will have their user encoding set to
898
# latin-1, which cannot raise UnicodeError.)
900
gecos = w.pw_gecos.decode('utf-8')
904
encoding = osutils.get_user_encoding()
905
gecos = w.pw_gecos.decode(encoding)
907
raise errors.BzrCommandError('Unable to determine your name. '
908
'Use "bzr whoami" to set it.')
910
username = w.pw_name.decode(encoding)
912
raise errors.BzrCommandError('Unable to determine your name. '
913
'Use "bzr whoami" to set it.')
915
comma = gecos.find(',')
919
realname = gecos[:comma]
926
user_encoding = osutils.get_user_encoding()
927
realname = username = getpass.getuser().decode(user_encoding)
928
except UnicodeDecodeError:
929
raise errors.BzrError("Can't decode username as %s." % \
932
return realname, (username + '@' + socket.gethostname())
935
def parse_username(username):
936
"""Parse e-mail username and return a (name, address) tuple."""
937
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
939
return (username, '')
941
return (match.group(1), match.group(2))
944
def extract_email_address(e):
945
"""Return just the address part of an email string.
947
That is just the user@domain part, nothing else.
948
This part is required to contain only ascii characters.
949
If it can't be extracted, raises an error.
951
>>> extract_email_address('Jane Tester <jane@test.com>')
954
name, email = parse_username(e)
956
raise errors.NoEmailInUsername(e)
960
class TreeConfig(IniBasedConfig):
961
"""Branch configuration data associated with its contents, not location"""
963
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
965
def __init__(self, branch):
966
self._config = branch._get_config()
969
def _get_parser(self, file=None):
971
return IniBasedConfig._get_parser(file)
972
return self._config._get_configobj()
974
def get_option(self, name, section=None, default=None):
975
self.branch.lock_read()
977
return self._config.get_option(name, section, default)
981
def set_option(self, value, name, section=None):
982
"""Set a per-branch configuration option"""
983
self.branch.lock_write()
985
self._config.set_option(value, name, section)
990
class AuthenticationConfig(object):
991
"""The authentication configuration file based on a ini file.
993
Implements the authentication.conf file described in
994
doc/developers/authentication-ring.txt.
997
def __init__(self, _file=None):
998
self._config = None # The ConfigObj
1000
self._filename = authentication_config_filename()
1001
self._input = self._filename = authentication_config_filename()
1003
# Tests can provide a string as _file
1004
self._filename = None
1007
def _get_config(self):
1008
if self._config is not None:
1011
# FIXME: Should we validate something here ? Includes: empty
1012
# sections are useless, at least one of
1013
# user/password/password_encoding should be defined, etc.
1015
# Note: the encoding below declares that the file itself is utf-8
1016
# encoded, but the values in the ConfigObj are always Unicode.
1017
self._config = ConfigObj(self._input, encoding='utf-8')
1018
except configobj.ConfigObjError, e:
1019
raise errors.ParseConfigError(e.errors, e.config.filename)
1023
"""Save the config file, only tests should use it for now."""
1024
conf_dir = os.path.dirname(self._filename)
1025
ensure_config_dir_exists(conf_dir)
1026
self._get_config().write(file(self._filename, 'wb'))
1028
def _set_option(self, section_name, option_name, value):
1029
"""Set an authentication configuration option"""
1030
conf = self._get_config()
1031
section = conf.get(section_name)
1034
section = conf[section]
1035
section[option_name] = value
1038
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1040
"""Returns the matching credentials from authentication.conf file.
1042
:param scheme: protocol
1044
:param host: the server address
1046
:param port: the associated port (optional)
1048
:param user: login (optional)
1050
:param path: the absolute path on the server (optional)
1052
:param realm: the http authentication realm (optional)
1054
:return: A dict containing the matching credentials or None.
1056
- name: the section name of the credentials in the
1057
authentication.conf file,
1058
- user: can't be different from the provided user if any,
1059
- scheme: the server protocol,
1060
- host: the server address,
1061
- port: the server port (can be None),
1062
- path: the absolute server path (can be None),
1063
- realm: the http specific authentication realm (can be None),
1064
- password: the decoded password, could be None if the credential
1065
defines only the user
1066
- verify_certificates: https specific, True if the server
1067
certificate should be verified, False otherwise.
1070
for auth_def_name, auth_def in self._get_config().items():
1071
if type(auth_def) is not configobj.Section:
1072
raise ValueError("%s defined outside a section" % auth_def_name)
1074
a_scheme, a_host, a_user, a_path = map(
1075
auth_def.get, ['scheme', 'host', 'user', 'path'])
1078
a_port = auth_def.as_int('port')
1082
raise ValueError("'port' not numeric in %s" % auth_def_name)
1084
a_verify_certificates = auth_def.as_bool('verify_certificates')
1086
a_verify_certificates = True
1089
"'verify_certificates' not boolean in %s" % auth_def_name)
1092
if a_scheme is not None and scheme != a_scheme:
1094
if a_host is not None:
1095
if not (host == a_host
1096
or (a_host.startswith('.') and host.endswith(a_host))):
1098
if a_port is not None and port != a_port:
1100
if (a_path is not None and path is not None
1101
and not path.startswith(a_path)):
1103
if (a_user is not None and user is not None
1104
and a_user != user):
1105
# Never contradict the caller about the user to be used
1110
# Prepare a credentials dictionary with additional keys
1111
# for the credential providers
1112
credentials = dict(name=auth_def_name,
1119
password=auth_def.get('password', None),
1120
verify_certificates=a_verify_certificates)
1121
# Decode the password in the credentials (or get one)
1122
self.decode_password(credentials,
1123
auth_def.get('password_encoding', None))
1124
if 'auth' in debug.debug_flags:
1125
trace.mutter("Using authentication section: %r", auth_def_name)
1128
if credentials is None:
1129
# No credentials were found in authentication.conf, try the fallback
1130
# credentials stores.
1131
credentials = credential_store_registry.get_fallback_credentials(
1132
scheme, host, port, user, path, realm)
1136
def set_credentials(self, name, host, user, scheme=None, password=None,
1137
port=None, path=None, verify_certificates=None,
1139
"""Set authentication credentials for a host.
1141
Any existing credentials with matching scheme, host, port and path
1142
will be deleted, regardless of name.
1144
:param name: An arbitrary name to describe this set of credentials.
1145
:param host: Name of the host that accepts these credentials.
1146
:param user: The username portion of these credentials.
1147
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1149
:param password: Password portion of these credentials.
1150
:param port: The IP port on the host that these credentials apply to.
1151
:param path: A filesystem path on the host that these credentials
1153
:param verify_certificates: On https, verify server certificates if
1155
:param realm: The http authentication realm (optional).
1157
values = {'host': host, 'user': user}
1158
if password is not None:
1159
values['password'] = password
1160
if scheme is not None:
1161
values['scheme'] = scheme
1162
if port is not None:
1163
values['port'] = '%d' % port
1164
if path is not None:
1165
values['path'] = path
1166
if verify_certificates is not None:
1167
values['verify_certificates'] = str(verify_certificates)
1168
if realm is not None:
1169
values['realm'] = realm
1170
config = self._get_config()
1172
for section, existing_values in config.items():
1173
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1174
if existing_values.get(key) != values.get(key):
1178
config.update({name: values})
1181
def get_user(self, scheme, host, port=None, realm=None, path=None,
1182
prompt=None, ask=False, default=None):
1183
"""Get a user from authentication file.
1185
:param scheme: protocol
1187
:param host: the server address
1189
:param port: the associated port (optional)
1191
:param realm: the realm sent by the server (optional)
1193
:param path: the absolute path on the server (optional)
1195
:param ask: Ask the user if there is no explicitly configured username
1198
:param default: The username returned if none is defined (optional).
1200
:return: The found user.
1202
credentials = self.get_credentials(scheme, host, port, user=None,
1203
path=path, realm=realm)
1204
if credentials is not None:
1205
user = credentials['user']
1211
# Create a default prompt suitable for most cases
1212
prompt = scheme.upper() + ' %(host)s username'
1213
# Special handling for optional fields in the prompt
1214
if port is not None:
1215
prompt_host = '%s:%d' % (host, port)
1218
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1223
def get_password(self, scheme, host, user, port=None,
1224
realm=None, path=None, prompt=None):
1225
"""Get a password from authentication file or prompt the user for one.
1227
:param scheme: protocol
1229
:param host: the server address
1231
:param port: the associated port (optional)
1235
:param realm: the realm sent by the server (optional)
1237
:param path: the absolute path on the server (optional)
1239
:return: The found password or the one entered by the user.
1241
credentials = self.get_credentials(scheme, host, port, user, path,
1243
if credentials is not None:
1244
password = credentials['password']
1245
if password is not None and scheme is 'ssh':
1246
trace.warning('password ignored in section [%s],'
1247
' use an ssh agent instead'
1248
% credentials['name'])
1252
# Prompt user only if we could't find a password
1253
if password is None:
1255
# Create a default prompt suitable for most cases
1256
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1257
# Special handling for optional fields in the prompt
1258
if port is not None:
1259
prompt_host = '%s:%d' % (host, port)
1262
password = ui.ui_factory.get_password(prompt,
1263
host=prompt_host, user=user)
1266
def decode_password(self, credentials, encoding):
1268
cs = credential_store_registry.get_credential_store(encoding)
1270
raise ValueError('%r is not a known password_encoding' % encoding)
1271
credentials['password'] = cs.decode_password(credentials)
1275
class CredentialStoreRegistry(registry.Registry):
1276
"""A class that registers credential stores.
1278
A credential store provides access to credentials via the password_encoding
1279
field in authentication.conf sections.
1281
Except for stores provided by bzr itself, most stores are expected to be
1282
provided by plugins that will therefore use
1283
register_lazy(password_encoding, module_name, member_name, help=help,
1284
fallback=fallback) to install themselves.
1286
A fallback credential store is one that is queried if no credentials can be
1287
found via authentication.conf.
1290
def get_credential_store(self, encoding=None):
1291
cs = self.get(encoding)
1296
def is_fallback(self, name):
1297
"""Check if the named credentials store should be used as fallback."""
1298
return self.get_info(name)
1300
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1301
path=None, realm=None):
1302
"""Request credentials from all fallback credentials stores.
1304
The first credentials store that can provide credentials wins.
1307
for name in self.keys():
1308
if not self.is_fallback(name):
1310
cs = self.get_credential_store(name)
1311
credentials = cs.get_credentials(scheme, host, port, user,
1313
if credentials is not None:
1314
# We found some credentials
1318
def register(self, key, obj, help=None, override_existing=False,
1320
"""Register a new object to a name.
1322
:param key: This is the key to use to request the object later.
1323
:param obj: The object to register.
1324
:param help: Help text for this entry. This may be a string or
1325
a callable. If it is a callable, it should take two
1326
parameters (registry, key): this registry and the key that
1327
the help was registered under.
1328
:param override_existing: Raise KeyErorr if False and something has
1329
already been registered for that key. If True, ignore if there
1330
is an existing key (always register the new value).
1331
:param fallback: Whether this credential store should be
1334
return super(CredentialStoreRegistry,
1335
self).register(key, obj, help, info=fallback,
1336
override_existing=override_existing)
1338
def register_lazy(self, key, module_name, member_name,
1339
help=None, override_existing=False,
1341
"""Register a new credential store to be loaded on request.
1343
:param module_name: The python path to the module. Such as 'os.path'.
1344
:param member_name: The member of the module to return. If empty or
1345
None, get() will return the module itself.
1346
:param help: Help text for this entry. This may be a string or
1348
:param override_existing: If True, replace the existing object
1349
with the new one. If False, if there is already something
1350
registered with the same key, raise a KeyError
1351
:param fallback: Whether this credential store should be
1354
return super(CredentialStoreRegistry, self).register_lazy(
1355
key, module_name, member_name, help,
1356
info=fallback, override_existing=override_existing)
1359
credential_store_registry = CredentialStoreRegistry()
1362
class CredentialStore(object):
1363
"""An abstract class to implement storage for credentials"""
1365
def decode_password(self, credentials):
1366
"""Returns a clear text password for the provided credentials."""
1367
raise NotImplementedError(self.decode_password)
1369
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1371
"""Return the matching credentials from this credential store.
1373
This method is only called on fallback credential stores.
1375
raise NotImplementedError(self.get_credentials)
1379
class PlainTextCredentialStore(CredentialStore):
1380
"""Plain text credential store for the authentication.conf file."""
1382
def decode_password(self, credentials):
1383
"""See CredentialStore.decode_password."""
1384
return credentials['password']
1387
credential_store_registry.register('plain', PlainTextCredentialStore,
1388
help=PlainTextCredentialStore.__doc__)
1389
credential_store_registry.default_key = 'plain'
1392
class BzrDirConfig(object):
1394
def __init__(self, bzrdir):
1395
self._bzrdir = bzrdir
1396
self._config = bzrdir._get_config()
1398
def set_default_stack_on(self, value):
1399
"""Set the default stacking location.
1401
It may be set to 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:
1407
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1409
self._config.set_option('', 'default_stack_on')
1411
self._config.set_option(value, 'default_stack_on')
1413
def get_default_stack_on(self):
1414
"""Return the default stacking location.
1416
This will either be a location, or None.
1418
This policy affects all branches contained by this bzrdir, except for
1419
those under repositories.
1421
if self._config is None:
1423
value = self._config.get_option('default_stack_on')
1429
class TransportConfig(object):
1430
"""A Config that reads/writes a config file on a Transport.
1432
It is a low-level object that considers config data to be name/value pairs
1433
that may be associated with a section. Assigning meaning to the these
1434
values is done at higher levels like TreeConfig.
1437
def __init__(self, transport, filename):
1438
self._transport = transport
1439
self._filename = filename
1441
def get_option(self, name, section=None, default=None):
1442
"""Return the value associated with a named option.
1444
:param name: The name of the value
1445
:param section: The section the option is in (if any)
1446
:param default: The value to return if the value is not set
1447
:return: The value or default value
1449
configobj = self._get_configobj()
1451
section_obj = configobj
1454
section_obj = configobj[section]
1457
return section_obj.get(name, default)
1459
def set_option(self, value, name, section=None):
1460
"""Set the value associated with a named option.
1462
:param value: The value to set
1463
:param name: The name of the value to set
1464
:param section: The section the option is in (if any)
1466
configobj = self._get_configobj()
1468
configobj[name] = value
1470
configobj.setdefault(section, {})[name] = value
1471
self._set_configobj(configobj)
1473
def _get_config_file(self):
1475
return self._transport.get(self._filename)
1476
except errors.NoSuchFile:
1479
def _get_configobj(self):
1480
return ConfigObj(self._get_config_file(), encoding='utf-8')
1482
def _set_configobj(self, configobj):
1483
out_file = StringIO()
1484
configobj.write(out_file)
1486
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
