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
path = self._get_filename()
515
osutils.copy_ownership_from_path(path)
516
self._get_parser().write(f)
520
class LocationConfig(IniBasedConfig):
521
"""A configuration object that gives the policy for a location."""
523
def __init__(self, location):
524
name_generator = locations_config_filename
525
if (not os.path.exists(name_generator()) and
526
os.path.exists(branches_config_filename())):
527
if sys.platform == 'win32':
528
trace.warning('Please rename %s to %s'
529
% (branches_config_filename(),
530
locations_config_filename()))
532
trace.warning('Please rename ~/.bazaar/branches.conf'
533
' to ~/.bazaar/locations.conf')
534
name_generator = branches_config_filename
535
super(LocationConfig, self).__init__(name_generator)
536
# local file locations are looked up by local path, rather than
537
# by file url. This is because the config file is a user
538
# file, and we would rather not expose the user to file urls.
539
if location.startswith('file://'):
540
location = urlutils.local_path_from_url(location)
541
self.location = location
543
def _get_matching_sections(self):
544
"""Return an ordered list of section names matching this location."""
545
sections = self._get_parser()
546
location_names = self.location.split('/')
547
if self.location.endswith('/'):
548
del location_names[-1]
550
for section in sections:
551
# location is a local path if possible, so we need
552
# to convert 'file://' urls to local paths if necessary.
553
# This also avoids having file:///path be a more exact
554
# match than '/path'.
555
if section.startswith('file://'):
556
section_path = urlutils.local_path_from_url(section)
558
section_path = section
559
section_names = section_path.split('/')
560
if section.endswith('/'):
561
del section_names[-1]
562
names = zip(location_names, section_names)
565
if not fnmatch(name[0], name[1]):
570
# so, for the common prefix they matched.
571
# if section is longer, no match.
572
if len(section_names) > len(location_names):
574
matches.append((len(section_names), section,
575
'/'.join(location_names[len(section_names):])))
576
matches.sort(reverse=True)
578
for (length, section, extra_path) in matches:
579
sections.append((section, extra_path))
580
# should we stop looking for parent configs here?
582
if self._get_parser()[section].as_bool('ignore_parents'):
588
def _get_option_policy(self, section, option_name):
589
"""Return the policy for the given (section, option_name) pair."""
590
# check for the old 'recurse=False' flag
592
recurse = self._get_parser()[section].as_bool('recurse')
596
return POLICY_NORECURSE
598
policy_key = option_name + ':policy'
600
policy_name = self._get_parser()[section][policy_key]
604
return _policy_value[policy_name]
606
def _set_option_policy(self, section, option_name, option_policy):
607
"""Set the policy for the given option name in the given section."""
608
# The old recurse=False option affects all options in the
609
# section. To handle multiple policies in the section, we
610
# need to convert it to a policy_norecurse key.
612
recurse = self._get_parser()[section].as_bool('recurse')
616
symbol_versioning.warn(
617
'The recurse option is deprecated as of 0.14. '
618
'The section "%s" has been converted to use policies.'
621
del self._get_parser()[section]['recurse']
623
for key in self._get_parser()[section].keys():
624
if not key.endswith(':policy'):
625
self._get_parser()[section][key +
626
':policy'] = 'norecurse'
628
policy_key = option_name + ':policy'
629
policy_name = _policy_name[option_policy]
630
if policy_name is not None:
631
self._get_parser()[section][policy_key] = policy_name
633
if policy_key in self._get_parser()[section]:
634
del self._get_parser()[section][policy_key]
636
def set_user_option(self, option, value, store=STORE_LOCATION):
637
"""Save option and its value in the configuration."""
638
if store not in [STORE_LOCATION,
639
STORE_LOCATION_NORECURSE,
640
STORE_LOCATION_APPENDPATH]:
641
raise ValueError('bad storage policy %r for %r' %
643
# FIXME: RBC 20051029 This should refresh the parser and also take a
644
# file lock on locations.conf.
645
conf_dir = os.path.dirname(self._get_filename())
646
ensure_config_dir_exists(conf_dir)
647
location = self.location
648
if location.endswith('/'):
649
location = location[:-1]
650
if (not location in self._get_parser() and
651
not location + '/' in self._get_parser()):
652
self._get_parser()[location]={}
653
elif location + '/' in self._get_parser():
654
location = location + '/'
655
self._get_parser()[location][option]=value
656
# the allowed values of store match the config policies
657
self._set_option_policy(location, option, store)
658
self._get_parser().write(file(self._get_filename(), 'wb'))
661
class BranchConfig(Config):
662
"""A configuration object giving the policy for a branch."""
664
def _get_branch_data_config(self):
665
if self._branch_data_config is None:
666
self._branch_data_config = TreeConfig(self.branch)
667
return self._branch_data_config
669
def _get_location_config(self):
670
if self._location_config is None:
671
self._location_config = LocationConfig(self.branch.base)
672
return self._location_config
674
def _get_global_config(self):
675
if self._global_config is None:
676
self._global_config = GlobalConfig()
677
return self._global_config
679
def _get_best_value(self, option_name):
680
"""This returns a user option from local, tree or global config.
682
They are tried in that order. Use get_safe_value if trusted values
685
for source in self.option_sources:
686
value = getattr(source(), option_name)()
687
if value is not None:
691
def _get_safe_value(self, option_name):
692
"""This variant of get_best_value never returns untrusted values.
694
It does not return values from the branch data, because the branch may
695
not be controlled by the user.
697
We may wish to allow locations.conf to control whether branches are
698
trusted in the future.
700
for source in (self._get_location_config, self._get_global_config):
701
value = getattr(source(), option_name)()
702
if value is not None:
706
def _get_user_id(self):
707
"""Return the full user id for the branch.
709
e.g. "John Hacker <jhacker@example.com>"
710
This is looked up in the email controlfile for the branch.
713
return (self.branch._transport.get_bytes("email")
714
.decode(osutils.get_user_encoding())
716
except errors.NoSuchFile, e:
719
return self._get_best_value('_get_user_id')
721
def _get_change_editor(self):
722
return self._get_best_value('_get_change_editor')
724
def _get_signature_checking(self):
725
"""See Config._get_signature_checking."""
726
return self._get_best_value('_get_signature_checking')
728
def _get_signing_policy(self):
729
"""See Config._get_signing_policy."""
730
return self._get_best_value('_get_signing_policy')
732
def _get_user_option(self, option_name):
733
"""See Config._get_user_option."""
734
for source in self.option_sources:
735
value = source()._get_user_option(option_name)
736
if value is not None:
740
def set_user_option(self, name, value, store=STORE_BRANCH,
742
if store == STORE_BRANCH:
743
self._get_branch_data_config().set_option(value, name)
744
elif store == STORE_GLOBAL:
745
self._get_global_config().set_user_option(name, value)
747
self._get_location_config().set_user_option(name, value, store)
750
if store in (STORE_GLOBAL, STORE_BRANCH):
751
mask_value = self._get_location_config().get_user_option(name)
752
if mask_value is not None:
753
trace.warning('Value "%s" is masked by "%s" from'
754
' locations.conf', value, mask_value)
756
if store == STORE_GLOBAL:
757
branch_config = self._get_branch_data_config()
758
mask_value = branch_config.get_user_option(name)
759
if mask_value is not None:
760
trace.warning('Value "%s" is masked by "%s" from'
761
' branch.conf', value, mask_value)
763
def _gpg_signing_command(self):
764
"""See Config.gpg_signing_command."""
765
return self._get_safe_value('_gpg_signing_command')
767
def __init__(self, branch):
768
super(BranchConfig, self).__init__()
769
self._location_config = None
770
self._branch_data_config = None
771
self._global_config = None
773
self.option_sources = (self._get_location_config,
774
self._get_branch_data_config,
775
self._get_global_config)
777
def _post_commit(self):
778
"""See Config.post_commit."""
779
return self._get_safe_value('_post_commit')
781
def _get_nickname(self):
782
value = self._get_explicit_nickname()
783
if value is not None:
785
return urlutils.unescape(self.branch.base.split('/')[-2])
787
def has_explicit_nickname(self):
788
"""Return true if a nickname has been explicitly assigned."""
789
return self._get_explicit_nickname() is not None
791
def _get_explicit_nickname(self):
792
return self._get_best_value('_get_nickname')
794
def _log_format(self):
795
"""See Config.log_format."""
796
return self._get_best_value('_log_format')
799
def ensure_config_dir_exists(path=None):
800
"""Make sure a configuration directory exists.
801
This makes sure that the directory exists.
802
On windows, since configuration directories are 2 levels deep,
803
it makes sure both the directory and the parent directory exists.
807
if not os.path.isdir(path):
808
if sys.platform == 'win32':
809
parent_dir = os.path.dirname(path)
810
if not os.path.isdir(parent_dir):
811
trace.mutter('creating config parent directory: %r', parent_dir)
813
trace.mutter('creating config directory: %r', path)
815
osutils.copy_ownership_from_path(path)
819
"""Return per-user configuration directory.
821
By default this is ~/.bazaar/
823
TODO: Global option --config-dir to override this.
825
base = os.environ.get('BZR_HOME', None)
826
if sys.platform == 'win32':
828
base = win32utils.get_appdata_location_unicode()
830
base = os.environ.get('HOME', None)
832
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
834
return osutils.pathjoin(base, 'bazaar', '2.0')
836
# cygwin, linux, and darwin all have a $HOME directory
838
base = os.path.expanduser("~")
839
return osutils.pathjoin(base, ".bazaar")
842
def config_filename():
843
"""Return per-user configuration ini file filename."""
844
return osutils.pathjoin(config_dir(), 'bazaar.conf')
847
def branches_config_filename():
848
"""Return per-user configuration ini file filename."""
849
return osutils.pathjoin(config_dir(), 'branches.conf')
852
def locations_config_filename():
853
"""Return per-user configuration ini file filename."""
854
return osutils.pathjoin(config_dir(), 'locations.conf')
857
def authentication_config_filename():
858
"""Return per-user authentication ini file filename."""
859
return osutils.pathjoin(config_dir(), 'authentication.conf')
862
def user_ignore_config_filename():
863
"""Return the user default ignore filename"""
864
return osutils.pathjoin(config_dir(), 'ignore')
868
"""Return the directory name to store crash files.
870
This doesn't implicitly create it.
872
On Windows it's in the config directory; elsewhere it's /var/crash
873
which may be monitored by apport. It can be overridden by
876
if sys.platform == 'win32':
877
return osutils.pathjoin(config_dir(), 'Crash')
879
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
881
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
885
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
886
# Possibly this should be different on Windows?
887
e = os.environ.get('XDG_CACHE_DIR', None)
891
return os.path.expanduser('~/.cache')
895
"""Calculate automatic user identification.
897
Returns (realname, email).
899
Only used when none is set in the environment or the id file.
901
This previously used the FQDN as the default domain, but that can
902
be very slow on machines where DNS is broken. So now we simply
907
if sys.platform == 'win32':
908
name = win32utils.get_user_name_unicode()
910
raise errors.BzrError("Cannot autodetect user name.\n"
911
"Please, set your name with command like:\n"
912
'bzr whoami "Your Name <name@domain.com>"')
913
host = win32utils.get_host_name_unicode()
915
host = socket.gethostname()
916
return name, (name + '@' + host)
922
w = pwd.getpwuid(uid)
924
raise errors.BzrCommandError('Unable to determine your name. '
925
'Please use "bzr whoami" to set it.')
927
# we try utf-8 first, because on many variants (like Linux),
928
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
929
# false positives. (many users will have their user encoding set to
930
# latin-1, which cannot raise UnicodeError.)
932
gecos = w.pw_gecos.decode('utf-8')
936
encoding = osutils.get_user_encoding()
937
gecos = w.pw_gecos.decode(encoding)
939
raise errors.BzrCommandError('Unable to determine your name. '
940
'Use "bzr whoami" to set it.')
942
username = w.pw_name.decode(encoding)
944
raise errors.BzrCommandError('Unable to determine your name. '
945
'Use "bzr whoami" to set it.')
947
comma = gecos.find(',')
951
realname = gecos[:comma]
958
user_encoding = osutils.get_user_encoding()
959
realname = username = getpass.getuser().decode(user_encoding)
960
except UnicodeDecodeError:
961
raise errors.BzrError("Can't decode username as %s." % \
964
return realname, (username + '@' + socket.gethostname())
967
def parse_username(username):
968
"""Parse e-mail username and return a (name, address) tuple."""
969
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
971
return (username, '')
973
return (match.group(1), match.group(2))
976
def extract_email_address(e):
977
"""Return just the address part of an email string.
979
That is just the user@domain part, nothing else.
980
This part is required to contain only ascii characters.
981
If it can't be extracted, raises an error.
983
>>> extract_email_address('Jane Tester <jane@test.com>')
986
name, email = parse_username(e)
988
raise errors.NoEmailInUsername(e)
992
class TreeConfig(IniBasedConfig):
993
"""Branch configuration data associated with its contents, not location"""
995
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
997
def __init__(self, branch):
998
self._config = branch._get_config()
1001
def _get_parser(self, file=None):
1002
if file is not None:
1003
return IniBasedConfig._get_parser(file)
1004
return self._config._get_configobj()
1006
def get_option(self, name, section=None, default=None):
1007
self.branch.lock_read()
1009
return self._config.get_option(name, section, default)
1011
self.branch.unlock()
1013
def set_option(self, value, name, section=None):
1014
"""Set a per-branch configuration option"""
1015
self.branch.lock_write()
1017
self._config.set_option(value, name, section)
1019
self.branch.unlock()
1022
class AuthenticationConfig(object):
1023
"""The authentication configuration file based on a ini file.
1025
Implements the authentication.conf file described in
1026
doc/developers/authentication-ring.txt.
1029
def __init__(self, _file=None):
1030
self._config = None # The ConfigObj
1032
self._filename = authentication_config_filename()
1033
self._input = self._filename = authentication_config_filename()
1035
# Tests can provide a string as _file
1036
self._filename = None
1039
def _get_config(self):
1040
if self._config is not None:
1043
# FIXME: Should we validate something here ? Includes: empty
1044
# sections are useless, at least one of
1045
# user/password/password_encoding should be defined, etc.
1047
# Note: the encoding below declares that the file itself is utf-8
1048
# encoded, but the values in the ConfigObj are always Unicode.
1049
self._config = ConfigObj(self._input, encoding='utf-8')
1050
except configobj.ConfigObjError, e:
1051
raise errors.ParseConfigError(e.errors, e.config.filename)
1055
"""Save the config file, only tests should use it for now."""
1056
conf_dir = os.path.dirname(self._filename)
1057
ensure_config_dir_exists(conf_dir)
1058
self._get_config().write(file(self._filename, 'wb'))
1060
def _set_option(self, section_name, option_name, value):
1061
"""Set an authentication configuration option"""
1062
conf = self._get_config()
1063
section = conf.get(section_name)
1066
section = conf[section]
1067
section[option_name] = value
1070
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1072
"""Returns the matching credentials from authentication.conf file.
1074
:param scheme: protocol
1076
:param host: the server address
1078
:param port: the associated port (optional)
1080
:param user: login (optional)
1082
:param path: the absolute path on the server (optional)
1084
:param realm: the http authentication realm (optional)
1086
:return: A dict containing the matching credentials or None.
1088
- name: the section name of the credentials in the
1089
authentication.conf file,
1090
- user: can't be different from the provided user if any,
1091
- scheme: the server protocol,
1092
- host: the server address,
1093
- port: the server port (can be None),
1094
- path: the absolute server path (can be None),
1095
- realm: the http specific authentication realm (can be None),
1096
- password: the decoded password, could be None if the credential
1097
defines only the user
1098
- verify_certificates: https specific, True if the server
1099
certificate should be verified, False otherwise.
1102
for auth_def_name, auth_def in self._get_config().items():
1103
if type(auth_def) is not configobj.Section:
1104
raise ValueError("%s defined outside a section" % auth_def_name)
1106
a_scheme, a_host, a_user, a_path = map(
1107
auth_def.get, ['scheme', 'host', 'user', 'path'])
1110
a_port = auth_def.as_int('port')
1114
raise ValueError("'port' not numeric in %s" % auth_def_name)
1116
a_verify_certificates = auth_def.as_bool('verify_certificates')
1118
a_verify_certificates = True
1121
"'verify_certificates' not boolean in %s" % auth_def_name)
1124
if a_scheme is not None and scheme != a_scheme:
1126
if a_host is not None:
1127
if not (host == a_host
1128
or (a_host.startswith('.') and host.endswith(a_host))):
1130
if a_port is not None and port != a_port:
1132
if (a_path is not None and path is not None
1133
and not path.startswith(a_path)):
1135
if (a_user is not None and user is not None
1136
and a_user != user):
1137
# Never contradict the caller about the user to be used
1142
# Prepare a credentials dictionary with additional keys
1143
# for the credential providers
1144
credentials = dict(name=auth_def_name,
1151
password=auth_def.get('password', None),
1152
verify_certificates=a_verify_certificates)
1153
# Decode the password in the credentials (or get one)
1154
self.decode_password(credentials,
1155
auth_def.get('password_encoding', None))
1156
if 'auth' in debug.debug_flags:
1157
trace.mutter("Using authentication section: %r", auth_def_name)
1160
if credentials is None:
1161
# No credentials were found in authentication.conf, try the fallback
1162
# credentials stores.
1163
credentials = credential_store_registry.get_fallback_credentials(
1164
scheme, host, port, user, path, realm)
1168
def set_credentials(self, name, host, user, scheme=None, password=None,
1169
port=None, path=None, verify_certificates=None,
1171
"""Set authentication credentials for a host.
1173
Any existing credentials with matching scheme, host, port and path
1174
will be deleted, regardless of name.
1176
:param name: An arbitrary name to describe this set of credentials.
1177
:param host: Name of the host that accepts these credentials.
1178
:param user: The username portion of these credentials.
1179
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1181
:param password: Password portion of these credentials.
1182
:param port: The IP port on the host that these credentials apply to.
1183
:param path: A filesystem path on the host that these credentials
1185
:param verify_certificates: On https, verify server certificates if
1187
:param realm: The http authentication realm (optional).
1189
values = {'host': host, 'user': user}
1190
if password is not None:
1191
values['password'] = password
1192
if scheme is not None:
1193
values['scheme'] = scheme
1194
if port is not None:
1195
values['port'] = '%d' % port
1196
if path is not None:
1197
values['path'] = path
1198
if verify_certificates is not None:
1199
values['verify_certificates'] = str(verify_certificates)
1200
if realm is not None:
1201
values['realm'] = realm
1202
config = self._get_config()
1204
for section, existing_values in config.items():
1205
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1206
if existing_values.get(key) != values.get(key):
1210
config.update({name: values})
1213
def get_user(self, scheme, host, port=None, realm=None, path=None,
1214
prompt=None, ask=False, default=None):
1215
"""Get a user from authentication file.
1217
:param scheme: protocol
1219
:param host: the server address
1221
:param port: the associated port (optional)
1223
:param realm: the realm sent by the server (optional)
1225
:param path: the absolute path on the server (optional)
1227
:param ask: Ask the user if there is no explicitly configured username
1230
:param default: The username returned if none is defined (optional).
1232
:return: The found user.
1234
credentials = self.get_credentials(scheme, host, port, user=None,
1235
path=path, realm=realm)
1236
if credentials is not None:
1237
user = credentials['user']
1243
# Create a default prompt suitable for most cases
1244
prompt = scheme.upper() + ' %(host)s username'
1245
# Special handling for optional fields in the prompt
1246
if port is not None:
1247
prompt_host = '%s:%d' % (host, port)
1250
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1255
def get_password(self, scheme, host, user, port=None,
1256
realm=None, path=None, prompt=None):
1257
"""Get a password from authentication file or prompt the user for one.
1259
:param scheme: protocol
1261
:param host: the server address
1263
:param port: the associated port (optional)
1267
:param realm: the realm sent by the server (optional)
1269
:param path: the absolute path on the server (optional)
1271
:return: The found password or the one entered by the user.
1273
credentials = self.get_credentials(scheme, host, port, user, path,
1275
if credentials is not None:
1276
password = credentials['password']
1277
if password is not None and scheme is 'ssh':
1278
trace.warning('password ignored in section [%s],'
1279
' use an ssh agent instead'
1280
% credentials['name'])
1284
# Prompt user only if we could't find a password
1285
if password is None:
1287
# Create a default prompt suitable for most cases
1288
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1289
# Special handling for optional fields in the prompt
1290
if port is not None:
1291
prompt_host = '%s:%d' % (host, port)
1294
password = ui.ui_factory.get_password(prompt,
1295
host=prompt_host, user=user)
1298
def decode_password(self, credentials, encoding):
1300
cs = credential_store_registry.get_credential_store(encoding)
1302
raise ValueError('%r is not a known password_encoding' % encoding)
1303
credentials['password'] = cs.decode_password(credentials)
1307
class CredentialStoreRegistry(registry.Registry):
1308
"""A class that registers credential stores.
1310
A credential store provides access to credentials via the password_encoding
1311
field in authentication.conf sections.
1313
Except for stores provided by bzr itself, most stores are expected to be
1314
provided by plugins that will therefore use
1315
register_lazy(password_encoding, module_name, member_name, help=help,
1316
fallback=fallback) to install themselves.
1318
A fallback credential store is one that is queried if no credentials can be
1319
found via authentication.conf.
1322
def get_credential_store(self, encoding=None):
1323
cs = self.get(encoding)
1328
def is_fallback(self, name):
1329
"""Check if the named credentials store should be used as fallback."""
1330
return self.get_info(name)
1332
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1333
path=None, realm=None):
1334
"""Request credentials from all fallback credentials stores.
1336
The first credentials store that can provide credentials wins.
1339
for name in self.keys():
1340
if not self.is_fallback(name):
1342
cs = self.get_credential_store(name)
1343
credentials = cs.get_credentials(scheme, host, port, user,
1345
if credentials is not None:
1346
# We found some credentials
1350
def register(self, key, obj, help=None, override_existing=False,
1352
"""Register a new object to a name.
1354
:param key: This is the key to use to request the object later.
1355
:param obj: The object to register.
1356
:param help: Help text for this entry. This may be a string or
1357
a callable. If it is a callable, it should take two
1358
parameters (registry, key): this registry and the key that
1359
the help was registered under.
1360
:param override_existing: Raise KeyErorr if False and something has
1361
already been registered for that key. If True, ignore if there
1362
is an existing key (always register the new value).
1363
:param fallback: Whether this credential store should be
1366
return super(CredentialStoreRegistry,
1367
self).register(key, obj, help, info=fallback,
1368
override_existing=override_existing)
1370
def register_lazy(self, key, module_name, member_name,
1371
help=None, override_existing=False,
1373
"""Register a new credential store to be loaded on request.
1375
:param module_name: The python path to the module. Such as 'os.path'.
1376
:param member_name: The member of the module to return. If empty or
1377
None, get() will return the module itself.
1378
:param help: Help text for this entry. This may be a string or
1380
:param override_existing: If True, replace the existing object
1381
with the new one. If False, if there is already something
1382
registered with the same key, raise a KeyError
1383
:param fallback: Whether this credential store should be
1386
return super(CredentialStoreRegistry, self).register_lazy(
1387
key, module_name, member_name, help,
1388
info=fallback, override_existing=override_existing)
1391
credential_store_registry = CredentialStoreRegistry()
1394
class CredentialStore(object):
1395
"""An abstract class to implement storage for credentials"""
1397
def decode_password(self, credentials):
1398
"""Returns a clear text password for the provided credentials."""
1399
raise NotImplementedError(self.decode_password)
1401
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1403
"""Return the matching credentials from this credential store.
1405
This method is only called on fallback credential stores.
1407
raise NotImplementedError(self.get_credentials)
1411
class PlainTextCredentialStore(CredentialStore):
1412
"""Plain text credential store for the authentication.conf file."""
1414
def decode_password(self, credentials):
1415
"""See CredentialStore.decode_password."""
1416
return credentials['password']
1419
credential_store_registry.register('plain', PlainTextCredentialStore,
1420
help=PlainTextCredentialStore.__doc__)
1421
credential_store_registry.default_key = 'plain'
1424
class BzrDirConfig(object):
1426
def __init__(self, bzrdir):
1427
self._bzrdir = bzrdir
1428
self._config = bzrdir._get_config()
1430
def set_default_stack_on(self, value):
1431
"""Set the default stacking location.
1433
It may be set to a location, or None.
1435
This policy affects all branches contained by this bzrdir, except for
1436
those under repositories.
1438
if self._config is None:
1439
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1441
self._config.set_option('', 'default_stack_on')
1443
self._config.set_option(value, 'default_stack_on')
1445
def get_default_stack_on(self):
1446
"""Return the default stacking location.
1448
This will either be a location, or None.
1450
This policy affects all branches contained by this bzrdir, except for
1451
those under repositories.
1453
if self._config is None:
1455
value = self._config.get_option('default_stack_on')
1461
class TransportConfig(object):
1462
"""A Config that reads/writes a config file on a Transport.
1464
It is a low-level object that considers config data to be name/value pairs
1465
that may be associated with a section. Assigning meaning to the these
1466
values is done at higher levels like TreeConfig.
1469
def __init__(self, transport, filename):
1470
self._transport = transport
1471
self._filename = filename
1473
def get_option(self, name, section=None, default=None):
1474
"""Return the value associated with a named option.
1476
:param name: The name of the value
1477
:param section: The section the option is in (if any)
1478
:param default: The value to return if the value is not set
1479
:return: The value or default value
1481
configobj = self._get_configobj()
1483
section_obj = configobj
1486
section_obj = configobj[section]
1489
return section_obj.get(name, default)
1491
def set_option(self, value, name, section=None):
1492
"""Set the value associated with a named option.
1494
:param value: The value to set
1495
:param name: The name of the value to set
1496
:param section: The section the option is in (if any)
1498
configobj = self._get_configobj()
1500
configobj[name] = value
1502
configobj.setdefault(section, {})[name] = value
1503
self._set_configobj(configobj)
1505
def _get_config_file(self):
1507
return StringIO(self._transport.get_bytes(self._filename))
1508
except errors.NoSuchFile:
1511
def _get_configobj(self):
1512
return ConfigObj(self._get_config_file(), encoding='utf-8')
1514
def _set_configobj(self, configobj):
1515
out_file = StringIO()
1516
configobj.write(out_file)
1518
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
