1
# Copyright (C) 2005-2010 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
33
in locations.conf, you specify the url of a branch and options for it.
34
Wildcards may be used - * and ? as normal in shell completion. Options
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
37
[/home/robertc/source]
38
recurse=False|True(default)
40
check_signatures= as above
41
create_signatures= as above.
43
explanation of options
44
----------------------
45
editor - this option sets the pop up editor to use during commits.
46
email - this option sets the user id bzr will use when committing.
47
check_signatures - this option controls whether bzr will require good gpg
48
signatures, ignore them, or check them if they are
50
create_signatures - this option controls whether bzr will always create
51
gpg signatures, never create them, or create them if the
52
branch is configured to require them.
53
log_format - this option sets the default log format. Possible values are
54
long, short, line, or a plugin can register new formats.
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
59
lastlog=log --line -r-10..-1
60
ll=log --line -r-10..-1
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
71
from fnmatch import fnmatch
73
from cStringIO import StringIO
88
from bzrlib.util.configobj import configobj
104
POLICY_APPENDPATH = 2
108
POLICY_NORECURSE: 'norecurse',
109
POLICY_APPENDPATH: 'appendpath',
114
'norecurse': POLICY_NORECURSE,
115
'appendpath': POLICY_APPENDPATH,
119
STORE_LOCATION = POLICY_NONE
120
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
121
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
126
def ConfigObj(*args, **kwargs):
128
if _ConfigObj is None:
129
class ConfigObj(configobj.ConfigObj):
131
def get_bool(self, section, key):
132
return self[section].as_bool(key)
134
def get_value(self, section, name):
135
# Try [] for the old DEFAULT section.
136
if section == "DEFAULT":
141
return self[section][name]
142
_ConfigObj = ConfigObj
143
return _ConfigObj(*args, **kwargs)
146
class Config(object):
147
"""A configuration policy - what username, editor, gpg needs etc."""
150
super(Config, self).__init__()
152
def get_editor(self):
153
"""Get the users pop up editor."""
154
raise NotImplementedError
156
def get_change_editor(self, old_tree, new_tree):
157
from bzrlib import diff
158
cmd = self._get_change_editor()
161
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
165
def get_mail_client(self):
166
"""Get a mail client to use"""
167
selected_client = self.get_user_option('mail_client')
168
_registry = mail_client.mail_client_registry
170
mail_client_class = _registry.get(selected_client)
172
raise errors.UnknownMailClient(selected_client)
173
return mail_client_class(self)
175
def _get_signature_checking(self):
176
"""Template method to override signature checking policy."""
178
def _get_signing_policy(self):
179
"""Template method to override signature creation policy."""
181
def _get_user_option(self, option_name):
182
"""Template method to provide a user option."""
185
def get_user_option(self, option_name):
186
"""Get a generic option - no special process, no default."""
187
return self._get_user_option(option_name)
189
def get_user_option_as_bool(self, option_name):
190
"""Get a generic option as a boolean - no special process, no default.
192
:return None if the option doesn't exist or its value can't be
193
interpreted as a boolean. Returns True or False otherwise.
195
s = self._get_user_option(option_name)
196
return ui.bool_from_string(s)
198
def get_user_option_as_list(self, option_name):
199
"""Get a generic option as a list - no special process, no default.
201
:return None if the option doesn't exist. Returns the value as a list
204
l = self._get_user_option(option_name)
205
if isinstance(l, (str, unicode)):
206
# A single value, most probably the user forgot the final ','
210
def gpg_signing_command(self):
211
"""What program should be used to sign signatures?"""
212
result = self._gpg_signing_command()
217
def _gpg_signing_command(self):
218
"""See gpg_signing_command()."""
221
def log_format(self):
222
"""What log format should be used"""
223
result = self._log_format()
228
def _log_format(self):
229
"""See log_format()."""
232
def post_commit(self):
233
"""An ordered list of python functions to call.
235
Each function takes branch, rev_id as parameters.
237
return self._post_commit()
239
def _post_commit(self):
240
"""See Config.post_commit."""
243
def user_email(self):
244
"""Return just the email component of a username."""
245
return extract_email_address(self.username())
248
"""Return email-style username.
250
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
252
$BZR_EMAIL can be set to override this (as well as the
253
deprecated $BZREMAIL), then
254
the concrete policy type is checked, and finally
256
If none is found, a reasonable default is (hopefully)
259
TODO: Check it's reasonably well-formed.
261
v = os.environ.get('BZR_EMAIL')
263
return v.decode(osutils.get_user_encoding())
265
v = self._get_user_id()
269
v = os.environ.get('EMAIL')
271
return v.decode(osutils.get_user_encoding())
273
name, email = _auto_user_id()
275
return '%s <%s>' % (name, email)
279
def signature_checking(self):
280
"""What is the current policy for signature checking?."""
281
policy = self._get_signature_checking()
282
if policy is not None:
284
return CHECK_IF_POSSIBLE
286
def signing_policy(self):
287
"""What is the current policy for signature checking?."""
288
policy = self._get_signing_policy()
289
if policy is not None:
291
return SIGN_WHEN_REQUIRED
293
def signature_needed(self):
294
"""Is a signature needed when committing ?."""
295
policy = self._get_signing_policy()
297
policy = self._get_signature_checking()
298
if policy is not None:
299
trace.warning("Please use create_signatures,"
300
" not check_signatures to set signing policy.")
301
if policy == CHECK_ALWAYS:
303
elif policy == SIGN_ALWAYS:
307
def get_alias(self, value):
308
return self._get_alias(value)
310
def _get_alias(self, value):
313
def get_nickname(self):
314
return self._get_nickname()
316
def _get_nickname(self):
319
def get_bzr_remote_path(self):
321
return os.environ['BZR_REMOTE_PATH']
323
path = self.get_user_option("bzr_remote_path")
328
def suppress_warning(self, warning):
329
"""Should the warning be suppressed or emitted.
331
:param warning: The name of the warning being tested.
333
:returns: True if the warning should be suppressed, False otherwise.
335
warnings = self.get_user_option_as_list('suppress_warnings')
336
if warnings is None or warning not in warnings:
342
class IniBasedConfig(Config):
343
"""A configuration policy that draws from ini files."""
345
def __init__(self, get_filename):
346
super(IniBasedConfig, self).__init__()
347
self._get_filename = get_filename
350
def _get_parser(self, file=None):
351
if self._parser is not None:
354
input = self._get_filename()
358
self._parser = ConfigObj(input, encoding='utf-8')
359
except configobj.ConfigObjError, e:
360
raise errors.ParseConfigError(e.errors, e.config.filename)
363
def _get_matching_sections(self):
364
"""Return an ordered list of (section_name, extra_path) pairs.
366
If the section contains inherited configuration, extra_path is
367
a string containing the additional path components.
369
section = self._get_section()
370
if section is not None:
371
return [(section, '')]
375
def _get_section(self):
376
"""Override this to define the section used by the config."""
379
def _get_option_policy(self, section, option_name):
380
"""Return the policy for the given (section, option_name) pair."""
383
def _get_change_editor(self):
384
return self.get_user_option('change_editor')
386
def _get_signature_checking(self):
387
"""See Config._get_signature_checking."""
388
policy = self._get_user_option('check_signatures')
390
return self._string_to_signature_policy(policy)
392
def _get_signing_policy(self):
393
"""See Config._get_signing_policy"""
394
policy = self._get_user_option('create_signatures')
396
return self._string_to_signing_policy(policy)
398
def _get_user_id(self):
399
"""Get the user id from the 'email' key in the current section."""
400
return self._get_user_option('email')
402
def _get_user_option(self, option_name):
403
"""See Config._get_user_option."""
404
for (section, extra_path) in self._get_matching_sections():
406
value = self._get_parser().get_value(section, option_name)
409
policy = self._get_option_policy(section, option_name)
410
if policy == POLICY_NONE:
412
elif policy == POLICY_NORECURSE:
413
# norecurse items only apply to the exact path
418
elif policy == POLICY_APPENDPATH:
420
value = urlutils.join(value, extra_path)
423
raise AssertionError('Unexpected config policy %r' % policy)
427
def _gpg_signing_command(self):
428
"""See Config.gpg_signing_command."""
429
return self._get_user_option('gpg_signing_command')
431
def _log_format(self):
432
"""See Config.log_format."""
433
return self._get_user_option('log_format')
435
def _post_commit(self):
436
"""See Config.post_commit."""
437
return self._get_user_option('post_commit')
439
def _string_to_signature_policy(self, signature_string):
440
"""Convert a string to a signing policy."""
441
if signature_string.lower() == 'check-available':
442
return CHECK_IF_POSSIBLE
443
if signature_string.lower() == 'ignore':
445
if signature_string.lower() == 'require':
447
raise errors.BzrError("Invalid signatures policy '%s'"
450
def _string_to_signing_policy(self, signature_string):
451
"""Convert a string to a signing policy."""
452
if signature_string.lower() == 'when-required':
453
return SIGN_WHEN_REQUIRED
454
if signature_string.lower() == 'never':
456
if signature_string.lower() == 'always':
458
raise errors.BzrError("Invalid signing policy '%s'"
461
def _get_alias(self, value):
463
return self._get_parser().get_value("ALIASES",
468
def _get_nickname(self):
469
return self.get_user_option('nickname')
472
class GlobalConfig(IniBasedConfig):
473
"""The configuration that should be used for a specific location."""
475
def get_editor(self):
476
return self._get_user_option('editor')
479
super(GlobalConfig, self).__init__(config_filename)
481
def set_user_option(self, option, value):
482
"""Save option and its value in the configuration."""
483
self._set_option(option, value, 'DEFAULT')
485
def get_aliases(self):
486
"""Return the aliases section."""
487
if 'ALIASES' in self._get_parser():
488
return self._get_parser()['ALIASES']
492
def set_alias(self, alias_name, alias_command):
493
"""Save the alias in the configuration."""
494
self._set_option(alias_name, alias_command, 'ALIASES')
496
def unset_alias(self, alias_name):
497
"""Unset an existing alias."""
498
aliases = self._get_parser().get('ALIASES')
499
if not aliases or alias_name not in aliases:
500
raise errors.NoSuchAlias(alias_name)
501
del aliases[alias_name]
502
self._write_config_file()
504
def _set_option(self, option, value, section):
505
# FIXME: RBC 20051029 This should refresh the parser and also take a
506
# file lock on bazaar.conf.
507
conf_dir = os.path.dirname(self._get_filename())
508
ensure_config_dir_exists(conf_dir)
509
self._get_parser().setdefault(section, {})[option] = value
510
self._write_config_file()
512
def _write_config_file(self):
513
f = open(self._get_filename(), 'wb')
514
self._get_parser().write(f)
518
class LocationConfig(IniBasedConfig):
519
"""A configuration object that gives the policy for a location."""
521
def __init__(self, location):
522
name_generator = locations_config_filename
523
if (not os.path.exists(name_generator()) and
524
os.path.exists(branches_config_filename())):
525
if sys.platform == 'win32':
526
trace.warning('Please rename %s to %s'
527
% (branches_config_filename(),
528
locations_config_filename()))
530
trace.warning('Please rename ~/.bazaar/branches.conf'
531
' to ~/.bazaar/locations.conf')
532
name_generator = branches_config_filename
533
super(LocationConfig, self).__init__(name_generator)
534
# local file locations are looked up by local path, rather than
535
# by file url. This is because the config file is a user
536
# file, and we would rather not expose the user to file urls.
537
if location.startswith('file://'):
538
location = urlutils.local_path_from_url(location)
539
self.location = location
541
def _get_matching_sections(self):
542
"""Return an ordered list of section names matching this location."""
543
sections = self._get_parser()
544
location_names = self.location.split('/')
545
if self.location.endswith('/'):
546
del location_names[-1]
548
for section in sections:
549
# location is a local path if possible, so we need
550
# to convert 'file://' urls to local paths if necessary.
551
# This also avoids having file:///path be a more exact
552
# match than '/path'.
553
if section.startswith('file://'):
554
section_path = urlutils.local_path_from_url(section)
556
section_path = section
557
section_names = section_path.split('/')
558
if section.endswith('/'):
559
del section_names[-1]
560
names = zip(location_names, section_names)
563
if not fnmatch(name[0], name[1]):
568
# so, for the common prefix they matched.
569
# if section is longer, no match.
570
if len(section_names) > len(location_names):
572
matches.append((len(section_names), section,
573
'/'.join(location_names[len(section_names):])))
574
matches.sort(reverse=True)
576
for (length, section, extra_path) in matches:
577
sections.append((section, extra_path))
578
# should we stop looking for parent configs here?
580
if self._get_parser()[section].as_bool('ignore_parents'):
586
def _get_option_policy(self, section, option_name):
587
"""Return the policy for the given (section, option_name) pair."""
588
# check for the old 'recurse=False' flag
590
recurse = self._get_parser()[section].as_bool('recurse')
594
return POLICY_NORECURSE
596
policy_key = option_name + ':policy'
598
policy_name = self._get_parser()[section][policy_key]
602
return _policy_value[policy_name]
604
def _set_option_policy(self, section, option_name, option_policy):
605
"""Set the policy for the given option name in the given section."""
606
# The old recurse=False option affects all options in the
607
# section. To handle multiple policies in the section, we
608
# need to convert it to a policy_norecurse key.
610
recurse = self._get_parser()[section].as_bool('recurse')
614
symbol_versioning.warn(
615
'The recurse option is deprecated as of 0.14. '
616
'The section "%s" has been converted to use policies.'
619
del self._get_parser()[section]['recurse']
621
for key in self._get_parser()[section].keys():
622
if not key.endswith(':policy'):
623
self._get_parser()[section][key +
624
':policy'] = 'norecurse'
626
policy_key = option_name + ':policy'
627
policy_name = _policy_name[option_policy]
628
if policy_name is not None:
629
self._get_parser()[section][policy_key] = policy_name
631
if policy_key in self._get_parser()[section]:
632
del self._get_parser()[section][policy_key]
634
def set_user_option(self, option, value, store=STORE_LOCATION):
635
"""Save option and its value in the configuration."""
636
if store not in [STORE_LOCATION,
637
STORE_LOCATION_NORECURSE,
638
STORE_LOCATION_APPENDPATH]:
639
raise ValueError('bad storage policy %r for %r' %
641
# FIXME: RBC 20051029 This should refresh the parser and also take a
642
# file lock on locations.conf.
643
conf_dir = os.path.dirname(self._get_filename())
644
ensure_config_dir_exists(conf_dir)
645
location = self.location
646
if location.endswith('/'):
647
location = location[:-1]
648
if (not location in self._get_parser() and
649
not location + '/' in self._get_parser()):
650
self._get_parser()[location]={}
651
elif location + '/' in self._get_parser():
652
location = location + '/'
653
self._get_parser()[location][option]=value
654
# the allowed values of store match the config policies
655
self._set_option_policy(location, option, store)
656
self._get_parser().write(file(self._get_filename(), 'wb'))
659
class BranchConfig(Config):
660
"""A configuration object giving the policy for a branch."""
662
def _get_branch_data_config(self):
663
if self._branch_data_config is None:
664
self._branch_data_config = TreeConfig(self.branch)
665
return self._branch_data_config
667
def _get_location_config(self):
668
if self._location_config is None:
669
self._location_config = LocationConfig(self.branch.base)
670
return self._location_config
672
def _get_global_config(self):
673
if self._global_config is None:
674
self._global_config = GlobalConfig()
675
return self._global_config
677
def _get_best_value(self, option_name):
678
"""This returns a user option from local, tree or global config.
680
They are tried in that order. Use get_safe_value if trusted values
683
for source in self.option_sources:
684
value = getattr(source(), option_name)()
685
if value is not None:
689
def _get_safe_value(self, option_name):
690
"""This variant of get_best_value never returns untrusted values.
692
It does not return values from the branch data, because the branch may
693
not be controlled by the user.
695
We may wish to allow locations.conf to control whether branches are
696
trusted in the future.
698
for source in (self._get_location_config, self._get_global_config):
699
value = getattr(source(), option_name)()
700
if value is not None:
704
def _get_user_id(self):
705
"""Return the full user id for the branch.
707
e.g. "John Hacker <jhacker@example.com>"
708
This is looked up in the email controlfile for the branch.
711
return (self.branch._transport.get_bytes("email")
712
.decode(osutils.get_user_encoding())
714
except errors.NoSuchFile, e:
717
return self._get_best_value('_get_user_id')
719
def _get_change_editor(self):
720
return self._get_best_value('_get_change_editor')
722
def _get_signature_checking(self):
723
"""See Config._get_signature_checking."""
724
return self._get_best_value('_get_signature_checking')
726
def _get_signing_policy(self):
727
"""See Config._get_signing_policy."""
728
return self._get_best_value('_get_signing_policy')
730
def _get_user_option(self, option_name):
731
"""See Config._get_user_option."""
732
for source in self.option_sources:
733
value = source()._get_user_option(option_name)
734
if value is not None:
738
def set_user_option(self, name, value, store=STORE_BRANCH,
740
if store == STORE_BRANCH:
741
self._get_branch_data_config().set_option(value, name)
742
elif store == STORE_GLOBAL:
743
self._get_global_config().set_user_option(name, value)
745
self._get_location_config().set_user_option(name, value, store)
748
if store in (STORE_GLOBAL, STORE_BRANCH):
749
mask_value = self._get_location_config().get_user_option(name)
750
if mask_value is not None:
751
trace.warning('Value "%s" is masked by "%s" from'
752
' locations.conf', value, mask_value)
754
if store == STORE_GLOBAL:
755
branch_config = self._get_branch_data_config()
756
mask_value = branch_config.get_user_option(name)
757
if mask_value is not None:
758
trace.warning('Value "%s" is masked by "%s" from'
759
' branch.conf', value, mask_value)
761
def _gpg_signing_command(self):
762
"""See Config.gpg_signing_command."""
763
return self._get_safe_value('_gpg_signing_command')
765
def __init__(self, branch):
766
super(BranchConfig, self).__init__()
767
self._location_config = None
768
self._branch_data_config = None
769
self._global_config = None
771
self.option_sources = (self._get_location_config,
772
self._get_branch_data_config,
773
self._get_global_config)
775
def _post_commit(self):
776
"""See Config.post_commit."""
777
return self._get_safe_value('_post_commit')
779
def _get_nickname(self):
780
value = self._get_explicit_nickname()
781
if value is not None:
783
return urlutils.unescape(self.branch.base.split('/')[-2])
785
def has_explicit_nickname(self):
786
"""Return true if a nickname has been explicitly assigned."""
787
return self._get_explicit_nickname() is not None
789
def _get_explicit_nickname(self):
790
return self._get_best_value('_get_nickname')
792
def _log_format(self):
793
"""See Config.log_format."""
794
return self._get_best_value('_log_format')
797
def ensure_config_dir_exists(path=None):
798
"""Make sure a configuration directory exists.
799
This makes sure that the directory exists.
800
On windows, since configuration directories are 2 levels deep,
801
it makes sure both the directory and the parent directory exists.
805
if not os.path.isdir(path):
806
if sys.platform == 'win32':
807
parent_dir = os.path.dirname(path)
808
if not os.path.isdir(parent_dir):
809
trace.mutter('creating config parent directory: %r', parent_dir)
811
trace.mutter('creating config directory: %r', path)
816
"""Return per-user configuration directory.
818
By default this is ~/.bazaar/
820
TODO: Global option --config-dir to override this.
822
base = os.environ.get('BZR_HOME', None)
823
if sys.platform == 'win32':
825
base = win32utils.get_appdata_location_unicode()
827
base = os.environ.get('HOME', None)
829
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
831
return osutils.pathjoin(base, 'bazaar', '2.0')
833
# cygwin, linux, and darwin all have a $HOME directory
835
base = os.path.expanduser("~")
836
return osutils.pathjoin(base, ".bazaar")
839
def config_filename():
840
"""Return per-user configuration ini file filename."""
841
return osutils.pathjoin(config_dir(), 'bazaar.conf')
844
def branches_config_filename():
845
"""Return per-user configuration ini file filename."""
846
return osutils.pathjoin(config_dir(), 'branches.conf')
849
def locations_config_filename():
850
"""Return per-user configuration ini file filename."""
851
return osutils.pathjoin(config_dir(), 'locations.conf')
854
def authentication_config_filename():
855
"""Return per-user authentication ini file filename."""
856
return osutils.pathjoin(config_dir(), 'authentication.conf')
859
def user_ignore_config_filename():
860
"""Return the user default ignore filename"""
861
return osutils.pathjoin(config_dir(), 'ignore')
865
"""Return the directory name to store crash files.
867
This doesn't implicitly create it.
869
On Windows it's in the config directory; elsewhere in the XDG cache directory.
871
if sys.platform == 'win32':
872
return osutils.pathjoin(config_dir(), 'Crash')
874
return osutils.pathjoin(xdg_cache_dir(), 'crash')
878
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
879
# Possibly this should be different on Windows?
880
e = os.environ.get('XDG_CACHE_DIR', None)
884
return os.path.expanduser('~/.cache')
888
"""Calculate automatic user identification.
890
Returns (realname, email).
892
Only used when none is set in the environment or the id file.
894
This previously used the FQDN as the default domain, but that can
895
be very slow on machines where DNS is broken. So now we simply
900
if sys.platform == 'win32':
901
name = win32utils.get_user_name_unicode()
903
raise errors.BzrError("Cannot autodetect user name.\n"
904
"Please, set your name with command like:\n"
905
'bzr whoami "Your Name <name@domain.com>"')
906
host = win32utils.get_host_name_unicode()
908
host = socket.gethostname()
909
return name, (name + '@' + host)
915
w = pwd.getpwuid(uid)
917
raise errors.BzrCommandError('Unable to determine your name. '
918
'Please use "bzr whoami" to set it.')
920
# we try utf-8 first, because on many variants (like Linux),
921
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
922
# false positives. (many users will have their user encoding set to
923
# latin-1, which cannot raise UnicodeError.)
925
gecos = w.pw_gecos.decode('utf-8')
929
encoding = osutils.get_user_encoding()
930
gecos = w.pw_gecos.decode(encoding)
932
raise errors.BzrCommandError('Unable to determine your name. '
933
'Use "bzr whoami" to set it.')
935
username = w.pw_name.decode(encoding)
937
raise errors.BzrCommandError('Unable to determine your name. '
938
'Use "bzr whoami" to set it.')
940
comma = gecos.find(',')
944
realname = gecos[:comma]
951
user_encoding = osutils.get_user_encoding()
952
realname = username = getpass.getuser().decode(user_encoding)
953
except UnicodeDecodeError:
954
raise errors.BzrError("Can't decode username as %s." % \
957
return realname, (username + '@' + socket.gethostname())
960
def parse_username(username):
961
"""Parse e-mail username and return a (name, address) tuple."""
962
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
964
return (username, '')
966
return (match.group(1), match.group(2))
969
def extract_email_address(e):
970
"""Return just the address part of an email string.
972
That is just the user@domain part, nothing else.
973
This part is required to contain only ascii characters.
974
If it can't be extracted, raises an error.
976
>>> extract_email_address('Jane Tester <jane@test.com>')
979
name, email = parse_username(e)
981
raise errors.NoEmailInUsername(e)
985
class TreeConfig(IniBasedConfig):
986
"""Branch configuration data associated with its contents, not location"""
988
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
990
def __init__(self, branch):
991
self._config = branch._get_config()
994
def _get_parser(self, file=None):
996
return IniBasedConfig._get_parser(file)
997
return self._config._get_configobj()
999
def get_option(self, name, section=None, default=None):
1000
self.branch.lock_read()
1002
return self._config.get_option(name, section, default)
1004
self.branch.unlock()
1006
def set_option(self, value, name, section=None):
1007
"""Set a per-branch configuration option"""
1008
self.branch.lock_write()
1010
self._config.set_option(value, name, section)
1012
self.branch.unlock()
1015
class AuthenticationConfig(object):
1016
"""The authentication configuration file based on a ini file.
1018
Implements the authentication.conf file described in
1019
doc/developers/authentication-ring.txt.
1022
def __init__(self, _file=None):
1023
self._config = None # The ConfigObj
1025
self._filename = authentication_config_filename()
1026
self._input = self._filename = authentication_config_filename()
1028
# Tests can provide a string as _file
1029
self._filename = None
1032
def _get_config(self):
1033
if self._config is not None:
1036
# FIXME: Should we validate something here ? Includes: empty
1037
# sections are useless, at least one of
1038
# user/password/password_encoding should be defined, etc.
1040
# Note: the encoding below declares that the file itself is utf-8
1041
# encoded, but the values in the ConfigObj are always Unicode.
1042
self._config = ConfigObj(self._input, encoding='utf-8')
1043
except configobj.ConfigObjError, e:
1044
raise errors.ParseConfigError(e.errors, e.config.filename)
1048
"""Save the config file, only tests should use it for now."""
1049
conf_dir = os.path.dirname(self._filename)
1050
ensure_config_dir_exists(conf_dir)
1051
self._get_config().write(file(self._filename, 'wb'))
1053
def _set_option(self, section_name, option_name, value):
1054
"""Set an authentication configuration option"""
1055
conf = self._get_config()
1056
section = conf.get(section_name)
1059
section = conf[section]
1060
section[option_name] = value
1063
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1065
"""Returns the matching credentials from authentication.conf file.
1067
:param scheme: protocol
1069
:param host: the server address
1071
:param port: the associated port (optional)
1073
:param user: login (optional)
1075
:param path: the absolute path on the server (optional)
1077
:param realm: the http authentication realm (optional)
1079
:return: A dict containing the matching credentials or None.
1081
- name: the section name of the credentials in the
1082
authentication.conf file,
1083
- user: can't be different from the provided user if any,
1084
- scheme: the server protocol,
1085
- host: the server address,
1086
- port: the server port (can be None),
1087
- path: the absolute server path (can be None),
1088
- realm: the http specific authentication realm (can be None),
1089
- password: the decoded password, could be None if the credential
1090
defines only the user
1091
- verify_certificates: https specific, True if the server
1092
certificate should be verified, False otherwise.
1095
for auth_def_name, auth_def in self._get_config().items():
1096
if type(auth_def) is not configobj.Section:
1097
raise ValueError("%s defined outside a section" % auth_def_name)
1099
a_scheme, a_host, a_user, a_path = map(
1100
auth_def.get, ['scheme', 'host', 'user', 'path'])
1103
a_port = auth_def.as_int('port')
1107
raise ValueError("'port' not numeric in %s" % auth_def_name)
1109
a_verify_certificates = auth_def.as_bool('verify_certificates')
1111
a_verify_certificates = True
1114
"'verify_certificates' not boolean in %s" % auth_def_name)
1117
if a_scheme is not None and scheme != a_scheme:
1119
if a_host is not None:
1120
if not (host == a_host
1121
or (a_host.startswith('.') and host.endswith(a_host))):
1123
if a_port is not None and port != a_port:
1125
if (a_path is not None and path is not None
1126
and not path.startswith(a_path)):
1128
if (a_user is not None and user is not None
1129
and a_user != user):
1130
# Never contradict the caller about the user to be used
1135
# Prepare a credentials dictionary with additional keys
1136
# for the credential providers
1137
credentials = dict(name=auth_def_name,
1144
password=auth_def.get('password', None),
1145
verify_certificates=a_verify_certificates)
1146
# Decode the password in the credentials (or get one)
1147
self.decode_password(credentials,
1148
auth_def.get('password_encoding', None))
1149
if 'auth' in debug.debug_flags:
1150
trace.mutter("Using authentication section: %r", auth_def_name)
1153
if credentials is None:
1154
# No credentials were found in authentication.conf, try the fallback
1155
# credentials stores.
1156
credentials = credential_store_registry.get_fallback_credentials(
1157
scheme, host, port, user, path, realm)
1161
def set_credentials(self, name, host, user, scheme=None, password=None,
1162
port=None, path=None, verify_certificates=None,
1164
"""Set authentication credentials for a host.
1166
Any existing credentials with matching scheme, host, port and path
1167
will be deleted, regardless of name.
1169
:param name: An arbitrary name to describe this set of credentials.
1170
:param host: Name of the host that accepts these credentials.
1171
:param user: The username portion of these credentials.
1172
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1174
:param password: Password portion of these credentials.
1175
:param port: The IP port on the host that these credentials apply to.
1176
:param path: A filesystem path on the host that these credentials
1178
:param verify_certificates: On https, verify server certificates if
1180
:param realm: The http authentication realm (optional).
1182
values = {'host': host, 'user': user}
1183
if password is not None:
1184
values['password'] = password
1185
if scheme is not None:
1186
values['scheme'] = scheme
1187
if port is not None:
1188
values['port'] = '%d' % port
1189
if path is not None:
1190
values['path'] = path
1191
if verify_certificates is not None:
1192
values['verify_certificates'] = str(verify_certificates)
1193
if realm is not None:
1194
values['realm'] = realm
1195
config = self._get_config()
1197
for section, existing_values in config.items():
1198
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1199
if existing_values.get(key) != values.get(key):
1203
config.update({name: values})
1206
def get_user(self, scheme, host, port=None, realm=None, path=None,
1207
prompt=None, ask=False, default=None):
1208
"""Get a user from authentication file.
1210
:param scheme: protocol
1212
:param host: the server address
1214
:param port: the associated port (optional)
1216
:param realm: the realm sent by the server (optional)
1218
:param path: the absolute path on the server (optional)
1220
:param ask: Ask the user if there is no explicitly configured username
1223
:param default: The username returned if none is defined (optional).
1225
:return: The found user.
1227
credentials = self.get_credentials(scheme, host, port, user=None,
1228
path=path, realm=realm)
1229
if credentials is not None:
1230
user = credentials['user']
1236
# Create a default prompt suitable for most cases
1237
prompt = scheme.upper() + ' %(host)s username'
1238
# Special handling for optional fields in the prompt
1239
if port is not None:
1240
prompt_host = '%s:%d' % (host, port)
1243
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1248
def get_password(self, scheme, host, user, port=None,
1249
realm=None, path=None, prompt=None):
1250
"""Get a password from authentication file or prompt the user for one.
1252
:param scheme: protocol
1254
:param host: the server address
1256
:param port: the associated port (optional)
1260
:param realm: the realm sent by the server (optional)
1262
:param path: the absolute path on the server (optional)
1264
:return: The found password or the one entered by the user.
1266
credentials = self.get_credentials(scheme, host, port, user, path,
1268
if credentials is not None:
1269
password = credentials['password']
1270
if password is not None and scheme is 'ssh':
1271
trace.warning('password ignored in section [%s],'
1272
' use an ssh agent instead'
1273
% credentials['name'])
1277
# Prompt user only if we could't find a password
1278
if password is None:
1280
# Create a default prompt suitable for most cases
1281
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1282
# Special handling for optional fields in the prompt
1283
if port is not None:
1284
prompt_host = '%s:%d' % (host, port)
1287
password = ui.ui_factory.get_password(prompt,
1288
host=prompt_host, user=user)
1291
def decode_password(self, credentials, encoding):
1293
cs = credential_store_registry.get_credential_store(encoding)
1295
raise ValueError('%r is not a known password_encoding' % encoding)
1296
credentials['password'] = cs.decode_password(credentials)
1300
class CredentialStoreRegistry(registry.Registry):
1301
"""A class that registers credential stores.
1303
A credential store provides access to credentials via the password_encoding
1304
field in authentication.conf sections.
1306
Except for stores provided by bzr itself, most stores are expected to be
1307
provided by plugins that will therefore use
1308
register_lazy(password_encoding, module_name, member_name, help=help,
1309
fallback=fallback) to install themselves.
1311
A fallback credential store is one that is queried if no credentials can be
1312
found via authentication.conf.
1315
def get_credential_store(self, encoding=None):
1316
cs = self.get(encoding)
1321
def is_fallback(self, name):
1322
"""Check if the named credentials store should be used as fallback."""
1323
return self.get_info(name)
1325
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1326
path=None, realm=None):
1327
"""Request credentials from all fallback credentials stores.
1329
The first credentials store that can provide credentials wins.
1332
for name in self.keys():
1333
if not self.is_fallback(name):
1335
cs = self.get_credential_store(name)
1336
credentials = cs.get_credentials(scheme, host, port, user,
1338
if credentials is not None:
1339
# We found some credentials
1343
def register(self, key, obj, help=None, override_existing=False,
1345
"""Register a new object to a name.
1347
:param key: This is the key to use to request the object later.
1348
:param obj: The object to register.
1349
:param help: Help text for this entry. This may be a string or
1350
a callable. If it is a callable, it should take two
1351
parameters (registry, key): this registry and the key that
1352
the help was registered under.
1353
:param override_existing: Raise KeyErorr if False and something has
1354
already been registered for that key. If True, ignore if there
1355
is an existing key (always register the new value).
1356
:param fallback: Whether this credential store should be
1359
return super(CredentialStoreRegistry,
1360
self).register(key, obj, help, info=fallback,
1361
override_existing=override_existing)
1363
def register_lazy(self, key, module_name, member_name,
1364
help=None, override_existing=False,
1366
"""Register a new credential store to be loaded on request.
1368
:param module_name: The python path to the module. Such as 'os.path'.
1369
:param member_name: The member of the module to return. If empty or
1370
None, get() will return the module itself.
1371
:param help: Help text for this entry. This may be a string or
1373
:param override_existing: If True, replace the existing object
1374
with the new one. If False, if there is already something
1375
registered with the same key, raise a KeyError
1376
:param fallback: Whether this credential store should be
1379
return super(CredentialStoreRegistry, self).register_lazy(
1380
key, module_name, member_name, help,
1381
info=fallback, override_existing=override_existing)
1384
credential_store_registry = CredentialStoreRegistry()
1387
class CredentialStore(object):
1388
"""An abstract class to implement storage for credentials"""
1390
def decode_password(self, credentials):
1391
"""Returns a clear text password for the provided credentials."""
1392
raise NotImplementedError(self.decode_password)
1394
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1396
"""Return the matching credentials from this credential store.
1398
This method is only called on fallback credential stores.
1400
raise NotImplementedError(self.get_credentials)
1404
class PlainTextCredentialStore(CredentialStore):
1405
"""Plain text credential store for the authentication.conf file."""
1407
def decode_password(self, credentials):
1408
"""See CredentialStore.decode_password."""
1409
return credentials['password']
1412
credential_store_registry.register('plain', PlainTextCredentialStore,
1413
help=PlainTextCredentialStore.__doc__)
1414
credential_store_registry.default_key = 'plain'
1417
class BzrDirConfig(object):
1419
def __init__(self, bzrdir):
1420
self._bzrdir = bzrdir
1421
self._config = bzrdir._get_config()
1423
def set_default_stack_on(self, value):
1424
"""Set the default stacking location.
1426
It may be set to a location, or None.
1428
This policy affects all branches contained by this bzrdir, except for
1429
those under repositories.
1431
if self._config is None:
1432
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1434
self._config.set_option('', 'default_stack_on')
1436
self._config.set_option(value, 'default_stack_on')
1438
def get_default_stack_on(self):
1439
"""Return the default stacking location.
1441
This will either be a location, or None.
1443
This policy affects all branches contained by this bzrdir, except for
1444
those under repositories.
1446
if self._config is None:
1448
value = self._config.get_option('default_stack_on')
1454
class TransportConfig(object):
1455
"""A Config that reads/writes a config file on a Transport.
1457
It is a low-level object that considers config data to be name/value pairs
1458
that may be associated with a section. Assigning meaning to the these
1459
values is done at higher levels like TreeConfig.
1462
def __init__(self, transport, filename):
1463
self._transport = transport
1464
self._filename = filename
1466
def get_option(self, name, section=None, default=None):
1467
"""Return the value associated with a named option.
1469
:param name: The name of the value
1470
:param section: The section the option is in (if any)
1471
:param default: The value to return if the value is not set
1472
:return: The value or default value
1474
configobj = self._get_configobj()
1476
section_obj = configobj
1479
section_obj = configobj[section]
1482
return section_obj.get(name, default)
1484
def set_option(self, value, name, section=None):
1485
"""Set the value associated with a named option.
1487
:param value: The value to set
1488
:param name: The name of the value to set
1489
:param section: The section the option is in (if any)
1491
configobj = self._get_configobj()
1493
configobj[name] = value
1495
configobj.setdefault(section, {})[name] = value
1496
self._set_configobj(configobj)
1498
def _get_config_file(self):
1500
return StringIO(self._transport.get_bytes(self._filename))
1501
except errors.NoSuchFile:
1504
def _get_configobj(self):
1505
return ConfigObj(self._get_config_file(), encoding='utf-8')
1507
def _set_configobj(self, configobj):
1508
out_file = StringIO()
1509
configobj.write(out_file)
1511
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
