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()
514
f = osutils.open_with_ownership(path, 'wb')
515
self._get_parser().write(f)
519
class LocationConfig(IniBasedConfig):
520
"""A configuration object that gives the policy for a location."""
522
def __init__(self, location):
523
name_generator = locations_config_filename
524
if (not os.path.exists(name_generator()) and
525
os.path.exists(branches_config_filename())):
526
if sys.platform == 'win32':
527
trace.warning('Please rename %s to %s'
528
% (branches_config_filename(),
529
locations_config_filename()))
531
trace.warning('Please rename ~/.bazaar/branches.conf'
532
' to ~/.bazaar/locations.conf')
533
name_generator = branches_config_filename
534
super(LocationConfig, self).__init__(name_generator)
535
# local file locations are looked up by local path, rather than
536
# by file url. This is because the config file is a user
537
# file, and we would rather not expose the user to file urls.
538
if location.startswith('file://'):
539
location = urlutils.local_path_from_url(location)
540
self.location = location
542
def _get_matching_sections(self):
543
"""Return an ordered list of section names matching this location."""
544
sections = self._get_parser()
545
location_names = self.location.split('/')
546
if self.location.endswith('/'):
547
del location_names[-1]
549
for section in sections:
550
# location is a local path if possible, so we need
551
# to convert 'file://' urls to local paths if necessary.
552
# This also avoids having file:///path be a more exact
553
# match than '/path'.
554
if section.startswith('file://'):
555
section_path = urlutils.local_path_from_url(section)
557
section_path = section
558
section_names = section_path.split('/')
559
if section.endswith('/'):
560
del section_names[-1]
561
names = zip(location_names, section_names)
564
if not fnmatch(name[0], name[1]):
569
# so, for the common prefix they matched.
570
# if section is longer, no match.
571
if len(section_names) > len(location_names):
573
matches.append((len(section_names), section,
574
'/'.join(location_names[len(section_names):])))
575
matches.sort(reverse=True)
577
for (length, section, extra_path) in matches:
578
sections.append((section, extra_path))
579
# should we stop looking for parent configs here?
581
if self._get_parser()[section].as_bool('ignore_parents'):
587
def _get_option_policy(self, section, option_name):
588
"""Return the policy for the given (section, option_name) pair."""
589
# check for the old 'recurse=False' flag
591
recurse = self._get_parser()[section].as_bool('recurse')
595
return POLICY_NORECURSE
597
policy_key = option_name + ':policy'
599
policy_name = self._get_parser()[section][policy_key]
603
return _policy_value[policy_name]
605
def _set_option_policy(self, section, option_name, option_policy):
606
"""Set the policy for the given option name in the given section."""
607
# The old recurse=False option affects all options in the
608
# section. To handle multiple policies in the section, we
609
# need to convert it to a policy_norecurse key.
611
recurse = self._get_parser()[section].as_bool('recurse')
615
symbol_versioning.warn(
616
'The recurse option is deprecated as of 0.14. '
617
'The section "%s" has been converted to use policies.'
620
del self._get_parser()[section]['recurse']
622
for key in self._get_parser()[section].keys():
623
if not key.endswith(':policy'):
624
self._get_parser()[section][key +
625
':policy'] = 'norecurse'
627
policy_key = option_name + ':policy'
628
policy_name = _policy_name[option_policy]
629
if policy_name is not None:
630
self._get_parser()[section][policy_key] = policy_name
632
if policy_key in self._get_parser()[section]:
633
del self._get_parser()[section][policy_key]
635
def set_user_option(self, option, value, store=STORE_LOCATION):
636
"""Save option and its value in the configuration."""
637
if store not in [STORE_LOCATION,
638
STORE_LOCATION_NORECURSE,
639
STORE_LOCATION_APPENDPATH]:
640
raise ValueError('bad storage policy %r for %r' %
642
# FIXME: RBC 20051029 This should refresh the parser and also take a
643
# file lock on locations.conf.
644
conf_dir = os.path.dirname(self._get_filename())
645
ensure_config_dir_exists(conf_dir)
646
location = self.location
647
if location.endswith('/'):
648
location = location[:-1]
649
if (not location in self._get_parser() and
650
not location + '/' in self._get_parser()):
651
self._get_parser()[location]={}
652
elif location + '/' in self._get_parser():
653
location = location + '/'
654
self._get_parser()[location][option]=value
655
# the allowed values of store match the config policies
656
self._set_option_policy(location, option, store)
657
self._get_parser().write(file(self._get_filename(), 'wb'))
660
class BranchConfig(Config):
661
"""A configuration object giving the policy for a branch."""
663
def _get_branch_data_config(self):
664
if self._branch_data_config is None:
665
self._branch_data_config = TreeConfig(self.branch)
666
return self._branch_data_config
668
def _get_location_config(self):
669
if self._location_config is None:
670
self._location_config = LocationConfig(self.branch.base)
671
return self._location_config
673
def _get_global_config(self):
674
if self._global_config is None:
675
self._global_config = GlobalConfig()
676
return self._global_config
678
def _get_best_value(self, option_name):
679
"""This returns a user option from local, tree or global config.
681
They are tried in that order. Use get_safe_value if trusted values
684
for source in self.option_sources:
685
value = getattr(source(), option_name)()
686
if value is not None:
690
def _get_safe_value(self, option_name):
691
"""This variant of get_best_value never returns untrusted values.
693
It does not return values from the branch data, because the branch may
694
not be controlled by the user.
696
We may wish to allow locations.conf to control whether branches are
697
trusted in the future.
699
for source in (self._get_location_config, self._get_global_config):
700
value = getattr(source(), option_name)()
701
if value is not None:
705
def _get_user_id(self):
706
"""Return the full user id for the branch.
708
e.g. "John Hacker <jhacker@example.com>"
709
This is looked up in the email controlfile for the branch.
712
return (self.branch._transport.get_bytes("email")
713
.decode(osutils.get_user_encoding())
715
except errors.NoSuchFile, e:
718
return self._get_best_value('_get_user_id')
720
def _get_change_editor(self):
721
return self._get_best_value('_get_change_editor')
723
def _get_signature_checking(self):
724
"""See Config._get_signature_checking."""
725
return self._get_best_value('_get_signature_checking')
727
def _get_signing_policy(self):
728
"""See Config._get_signing_policy."""
729
return self._get_best_value('_get_signing_policy')
731
def _get_user_option(self, option_name):
732
"""See Config._get_user_option."""
733
for source in self.option_sources:
734
value = source()._get_user_option(option_name)
735
if value is not None:
739
def set_user_option(self, name, value, store=STORE_BRANCH,
741
if store == STORE_BRANCH:
742
self._get_branch_data_config().set_option(value, name)
743
elif store == STORE_GLOBAL:
744
self._get_global_config().set_user_option(name, value)
746
self._get_location_config().set_user_option(name, value, store)
749
if store in (STORE_GLOBAL, STORE_BRANCH):
750
mask_value = self._get_location_config().get_user_option(name)
751
if mask_value is not None:
752
trace.warning('Value "%s" is masked by "%s" from'
753
' locations.conf', value, mask_value)
755
if store == STORE_GLOBAL:
756
branch_config = self._get_branch_data_config()
757
mask_value = branch_config.get_user_option(name)
758
if mask_value is not None:
759
trace.warning('Value "%s" is masked by "%s" from'
760
' branch.conf', value, mask_value)
762
def _gpg_signing_command(self):
763
"""See Config.gpg_signing_command."""
764
return self._get_safe_value('_gpg_signing_command')
766
def __init__(self, branch):
767
super(BranchConfig, self).__init__()
768
self._location_config = None
769
self._branch_data_config = None
770
self._global_config = None
772
self.option_sources = (self._get_location_config,
773
self._get_branch_data_config,
774
self._get_global_config)
776
def _post_commit(self):
777
"""See Config.post_commit."""
778
return self._get_safe_value('_post_commit')
780
def _get_nickname(self):
781
value = self._get_explicit_nickname()
782
if value is not None:
784
return urlutils.unescape(self.branch.base.split('/')[-2])
786
def has_explicit_nickname(self):
787
"""Return true if a nickname has been explicitly assigned."""
788
return self._get_explicit_nickname() is not None
790
def _get_explicit_nickname(self):
791
return self._get_best_value('_get_nickname')
793
def _log_format(self):
794
"""See Config.log_format."""
795
return self._get_best_value('_log_format')
798
def ensure_config_dir_exists(path=None):
799
"""Make sure a configuration directory exists.
800
This makes sure that the directory exists.
801
On windows, since configuration directories are 2 levels deep,
802
it makes sure both the directory and the parent directory exists.
806
if not os.path.isdir(path):
807
if sys.platform == 'win32':
808
parent_dir = os.path.dirname(path)
809
if not os.path.isdir(parent_dir):
810
trace.mutter('creating config parent directory: %r', parent_dir)
812
trace.mutter('creating config directory: %r', path)
813
osutils.mkdir_with_ownership(path)
817
"""Return per-user configuration directory.
819
By default this is ~/.bazaar/
821
TODO: Global option --config-dir to override this.
823
base = os.environ.get('BZR_HOME', None)
824
if sys.platform == 'win32':
826
base = win32utils.get_appdata_location_unicode()
828
base = os.environ.get('HOME', None)
830
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
832
return osutils.pathjoin(base, 'bazaar', '2.0')
834
# cygwin, linux, and darwin all have a $HOME directory
836
base = os.path.expanduser("~")
837
return osutils.pathjoin(base, ".bazaar")
840
def config_filename():
841
"""Return per-user configuration ini file filename."""
842
return osutils.pathjoin(config_dir(), 'bazaar.conf')
845
def branches_config_filename():
846
"""Return per-user configuration ini file filename."""
847
return osutils.pathjoin(config_dir(), 'branches.conf')
850
def locations_config_filename():
851
"""Return per-user configuration ini file filename."""
852
return osutils.pathjoin(config_dir(), 'locations.conf')
855
def authentication_config_filename():
856
"""Return per-user authentication ini file filename."""
857
return osutils.pathjoin(config_dir(), 'authentication.conf')
860
def user_ignore_config_filename():
861
"""Return the user default ignore filename"""
862
return osutils.pathjoin(config_dir(), 'ignore')
866
"""Return the directory name to store crash files.
868
This doesn't implicitly create it.
870
On Windows it's in the config directory; elsewhere it's /var/crash
871
which may be monitored by apport. It can be overridden by
874
if sys.platform == 'win32':
875
return osutils.pathjoin(config_dir(), 'Crash')
877
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
879
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
883
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
884
# Possibly this should be different on Windows?
885
e = os.environ.get('XDG_CACHE_DIR', None)
889
return os.path.expanduser('~/.cache')
893
"""Calculate automatic user identification.
895
Returns (realname, email).
897
Only used when none is set in the environment or the id file.
899
This previously used the FQDN as the default domain, but that can
900
be very slow on machines where DNS is broken. So now we simply
905
if sys.platform == 'win32':
906
name = win32utils.get_user_name_unicode()
908
raise errors.BzrError("Cannot autodetect user name.\n"
909
"Please, set your name with command like:\n"
910
'bzr whoami "Your Name <name@domain.com>"')
911
host = win32utils.get_host_name_unicode()
913
host = socket.gethostname()
914
return name, (name + '@' + host)
920
w = pwd.getpwuid(uid)
922
raise errors.BzrCommandError('Unable to determine your name. '
923
'Please use "bzr whoami" to set it.')
925
# we try utf-8 first, because on many variants (like Linux),
926
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
927
# false positives. (many users will have their user encoding set to
928
# latin-1, which cannot raise UnicodeError.)
930
gecos = w.pw_gecos.decode('utf-8')
934
encoding = osutils.get_user_encoding()
935
gecos = w.pw_gecos.decode(encoding)
937
raise errors.BzrCommandError('Unable to determine your name. '
938
'Use "bzr whoami" to set it.')
940
username = w.pw_name.decode(encoding)
942
raise errors.BzrCommandError('Unable to determine your name. '
943
'Use "bzr whoami" to set it.')
945
comma = gecos.find(',')
949
realname = gecos[:comma]
956
user_encoding = osutils.get_user_encoding()
957
realname = username = getpass.getuser().decode(user_encoding)
958
except UnicodeDecodeError:
959
raise errors.BzrError("Can't decode username as %s." % \
962
return realname, (username + '@' + socket.gethostname())
965
def parse_username(username):
966
"""Parse e-mail username and return a (name, address) tuple."""
967
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
969
return (username, '')
971
return (match.group(1), match.group(2))
974
def extract_email_address(e):
975
"""Return just the address part of an email string.
977
That is just the user@domain part, nothing else.
978
This part is required to contain only ascii characters.
979
If it can't be extracted, raises an error.
981
>>> extract_email_address('Jane Tester <jane@test.com>')
984
name, email = parse_username(e)
986
raise errors.NoEmailInUsername(e)
990
class TreeConfig(IniBasedConfig):
991
"""Branch configuration data associated with its contents, not location"""
993
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
995
def __init__(self, branch):
996
self._config = branch._get_config()
999
def _get_parser(self, file=None):
1000
if file is not None:
1001
return IniBasedConfig._get_parser(file)
1002
return self._config._get_configobj()
1004
def get_option(self, name, section=None, default=None):
1005
self.branch.lock_read()
1007
return self._config.get_option(name, section, default)
1009
self.branch.unlock()
1011
def set_option(self, value, name, section=None):
1012
"""Set a per-branch configuration option"""
1013
self.branch.lock_write()
1015
self._config.set_option(value, name, section)
1017
self.branch.unlock()
1020
class AuthenticationConfig(object):
1021
"""The authentication configuration file based on a ini file.
1023
Implements the authentication.conf file described in
1024
doc/developers/authentication-ring.txt.
1027
def __init__(self, _file=None):
1028
self._config = None # The ConfigObj
1030
self._filename = authentication_config_filename()
1031
self._input = self._filename = authentication_config_filename()
1033
# Tests can provide a string as _file
1034
self._filename = None
1037
def _get_config(self):
1038
if self._config is not None:
1041
# FIXME: Should we validate something here ? Includes: empty
1042
# sections are useless, at least one of
1043
# user/password/password_encoding should be defined, etc.
1045
# Note: the encoding below declares that the file itself is utf-8
1046
# encoded, but the values in the ConfigObj are always Unicode.
1047
self._config = ConfigObj(self._input, encoding='utf-8')
1048
except configobj.ConfigObjError, e:
1049
raise errors.ParseConfigError(e.errors, e.config.filename)
1053
"""Save the config file, only tests should use it for now."""
1054
conf_dir = os.path.dirname(self._filename)
1055
ensure_config_dir_exists(conf_dir)
1056
self._get_config().write(file(self._filename, 'wb'))
1058
def _set_option(self, section_name, option_name, value):
1059
"""Set an authentication configuration option"""
1060
conf = self._get_config()
1061
section = conf.get(section_name)
1064
section = conf[section]
1065
section[option_name] = value
1068
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1070
"""Returns the matching credentials from authentication.conf file.
1072
:param scheme: protocol
1074
:param host: the server address
1076
:param port: the associated port (optional)
1078
:param user: login (optional)
1080
:param path: the absolute path on the server (optional)
1082
:param realm: the http authentication realm (optional)
1084
:return: A dict containing the matching credentials or None.
1086
- name: the section name of the credentials in the
1087
authentication.conf file,
1088
- user: can't be different from the provided user if any,
1089
- scheme: the server protocol,
1090
- host: the server address,
1091
- port: the server port (can be None),
1092
- path: the absolute server path (can be None),
1093
- realm: the http specific authentication realm (can be None),
1094
- password: the decoded password, could be None if the credential
1095
defines only the user
1096
- verify_certificates: https specific, True if the server
1097
certificate should be verified, False otherwise.
1100
for auth_def_name, auth_def in self._get_config().items():
1101
if type(auth_def) is not configobj.Section:
1102
raise ValueError("%s defined outside a section" % auth_def_name)
1104
a_scheme, a_host, a_user, a_path = map(
1105
auth_def.get, ['scheme', 'host', 'user', 'path'])
1108
a_port = auth_def.as_int('port')
1112
raise ValueError("'port' not numeric in %s" % auth_def_name)
1114
a_verify_certificates = auth_def.as_bool('verify_certificates')
1116
a_verify_certificates = True
1119
"'verify_certificates' not boolean in %s" % auth_def_name)
1122
if a_scheme is not None and scheme != a_scheme:
1124
if a_host is not None:
1125
if not (host == a_host
1126
or (a_host.startswith('.') and host.endswith(a_host))):
1128
if a_port is not None and port != a_port:
1130
if (a_path is not None and path is not None
1131
and not path.startswith(a_path)):
1133
if (a_user is not None and user is not None
1134
and a_user != user):
1135
# Never contradict the caller about the user to be used
1140
# Prepare a credentials dictionary with additional keys
1141
# for the credential providers
1142
credentials = dict(name=auth_def_name,
1149
password=auth_def.get('password', None),
1150
verify_certificates=a_verify_certificates)
1151
# Decode the password in the credentials (or get one)
1152
self.decode_password(credentials,
1153
auth_def.get('password_encoding', None))
1154
if 'auth' in debug.debug_flags:
1155
trace.mutter("Using authentication section: %r", auth_def_name)
1158
if credentials is None:
1159
# No credentials were found in authentication.conf, try the fallback
1160
# credentials stores.
1161
credentials = credential_store_registry.get_fallback_credentials(
1162
scheme, host, port, user, path, realm)
1166
def set_credentials(self, name, host, user, scheme=None, password=None,
1167
port=None, path=None, verify_certificates=None,
1169
"""Set authentication credentials for a host.
1171
Any existing credentials with matching scheme, host, port and path
1172
will be deleted, regardless of name.
1174
:param name: An arbitrary name to describe this set of credentials.
1175
:param host: Name of the host that accepts these credentials.
1176
:param user: The username portion of these credentials.
1177
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1179
:param password: Password portion of these credentials.
1180
:param port: The IP port on the host that these credentials apply to.
1181
:param path: A filesystem path on the host that these credentials
1183
:param verify_certificates: On https, verify server certificates if
1185
:param realm: The http authentication realm (optional).
1187
values = {'host': host, 'user': user}
1188
if password is not None:
1189
values['password'] = password
1190
if scheme is not None:
1191
values['scheme'] = scheme
1192
if port is not None:
1193
values['port'] = '%d' % port
1194
if path is not None:
1195
values['path'] = path
1196
if verify_certificates is not None:
1197
values['verify_certificates'] = str(verify_certificates)
1198
if realm is not None:
1199
values['realm'] = realm
1200
config = self._get_config()
1202
for section, existing_values in config.items():
1203
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1204
if existing_values.get(key) != values.get(key):
1208
config.update({name: values})
1211
def get_user(self, scheme, host, port=None, realm=None, path=None,
1212
prompt=None, ask=False, default=None):
1213
"""Get a user from authentication file.
1215
:param scheme: protocol
1217
:param host: the server address
1219
:param port: the associated port (optional)
1221
:param realm: the realm sent by the server (optional)
1223
:param path: the absolute path on the server (optional)
1225
:param ask: Ask the user if there is no explicitly configured username
1228
:param default: The username returned if none is defined (optional).
1230
:return: The found user.
1232
credentials = self.get_credentials(scheme, host, port, user=None,
1233
path=path, realm=realm)
1234
if credentials is not None:
1235
user = credentials['user']
1241
# Create a default prompt suitable for most cases
1242
prompt = scheme.upper() + ' %(host)s username'
1243
# Special handling for optional fields in the prompt
1244
if port is not None:
1245
prompt_host = '%s:%d' % (host, port)
1248
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1253
def get_password(self, scheme, host, user, port=None,
1254
realm=None, path=None, prompt=None):
1255
"""Get a password from authentication file or prompt the user for one.
1257
:param scheme: protocol
1259
:param host: the server address
1261
:param port: the associated port (optional)
1265
:param realm: the realm sent by the server (optional)
1267
:param path: the absolute path on the server (optional)
1269
:return: The found password or the one entered by the user.
1271
credentials = self.get_credentials(scheme, host, port, user, path,
1273
if credentials is not None:
1274
password = credentials['password']
1275
if password is not None and scheme is 'ssh':
1276
trace.warning('password ignored in section [%s],'
1277
' use an ssh agent instead'
1278
% credentials['name'])
1282
# Prompt user only if we could't find a password
1283
if password is None:
1285
# Create a default prompt suitable for most cases
1286
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1287
# Special handling for optional fields in the prompt
1288
if port is not None:
1289
prompt_host = '%s:%d' % (host, port)
1292
password = ui.ui_factory.get_password(prompt,
1293
host=prompt_host, user=user)
1296
def decode_password(self, credentials, encoding):
1298
cs = credential_store_registry.get_credential_store(encoding)
1300
raise ValueError('%r is not a known password_encoding' % encoding)
1301
credentials['password'] = cs.decode_password(credentials)
1305
class CredentialStoreRegistry(registry.Registry):
1306
"""A class that registers credential stores.
1308
A credential store provides access to credentials via the password_encoding
1309
field in authentication.conf sections.
1311
Except for stores provided by bzr itself, most stores are expected to be
1312
provided by plugins that will therefore use
1313
register_lazy(password_encoding, module_name, member_name, help=help,
1314
fallback=fallback) to install themselves.
1316
A fallback credential store is one that is queried if no credentials can be
1317
found via authentication.conf.
1320
def get_credential_store(self, encoding=None):
1321
cs = self.get(encoding)
1326
def is_fallback(self, name):
1327
"""Check if the named credentials store should be used as fallback."""
1328
return self.get_info(name)
1330
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1331
path=None, realm=None):
1332
"""Request credentials from all fallback credentials stores.
1334
The first credentials store that can provide credentials wins.
1337
for name in self.keys():
1338
if not self.is_fallback(name):
1340
cs = self.get_credential_store(name)
1341
credentials = cs.get_credentials(scheme, host, port, user,
1343
if credentials is not None:
1344
# We found some credentials
1348
def register(self, key, obj, help=None, override_existing=False,
1350
"""Register a new object to a name.
1352
:param key: This is the key to use to request the object later.
1353
:param obj: The object to register.
1354
:param help: Help text for this entry. This may be a string or
1355
a callable. If it is a callable, it should take two
1356
parameters (registry, key): this registry and the key that
1357
the help was registered under.
1358
:param override_existing: Raise KeyErorr if False and something has
1359
already been registered for that key. If True, ignore if there
1360
is an existing key (always register the new value).
1361
:param fallback: Whether this credential store should be
1364
return super(CredentialStoreRegistry,
1365
self).register(key, obj, help, info=fallback,
1366
override_existing=override_existing)
1368
def register_lazy(self, key, module_name, member_name,
1369
help=None, override_existing=False,
1371
"""Register a new credential store to be loaded on request.
1373
:param module_name: The python path to the module. Such as 'os.path'.
1374
:param member_name: The member of the module to return. If empty or
1375
None, get() will return the module itself.
1376
:param help: Help text for this entry. This may be a string or
1378
:param override_existing: If True, replace the existing object
1379
with the new one. If False, if there is already something
1380
registered with the same key, raise a KeyError
1381
:param fallback: Whether this credential store should be
1384
return super(CredentialStoreRegistry, self).register_lazy(
1385
key, module_name, member_name, help,
1386
info=fallback, override_existing=override_existing)
1389
credential_store_registry = CredentialStoreRegistry()
1392
class CredentialStore(object):
1393
"""An abstract class to implement storage for credentials"""
1395
def decode_password(self, credentials):
1396
"""Returns a clear text password for the provided credentials."""
1397
raise NotImplementedError(self.decode_password)
1399
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1401
"""Return the matching credentials from this credential store.
1403
This method is only called on fallback credential stores.
1405
raise NotImplementedError(self.get_credentials)
1409
class PlainTextCredentialStore(CredentialStore):
1410
"""Plain text credential store for the authentication.conf file."""
1412
def decode_password(self, credentials):
1413
"""See CredentialStore.decode_password."""
1414
return credentials['password']
1417
credential_store_registry.register('plain', PlainTextCredentialStore,
1418
help=PlainTextCredentialStore.__doc__)
1419
credential_store_registry.default_key = 'plain'
1422
class BzrDirConfig(object):
1424
def __init__(self, bzrdir):
1425
self._bzrdir = bzrdir
1426
self._config = bzrdir._get_config()
1428
def set_default_stack_on(self, value):
1429
"""Set the default stacking location.
1431
It may be set to a location, or None.
1433
This policy affects all branches contained by this bzrdir, except for
1434
those under repositories.
1436
if self._config is None:
1437
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1439
self._config.set_option('', 'default_stack_on')
1441
self._config.set_option(value, 'default_stack_on')
1443
def get_default_stack_on(self):
1444
"""Return the default stacking location.
1446
This will either be a location, or None.
1448
This policy affects all branches contained by this bzrdir, except for
1449
those under repositories.
1451
if self._config is None:
1453
value = self._config.get_option('default_stack_on')
1459
class TransportConfig(object):
1460
"""A Config that reads/writes a config file on a Transport.
1462
It is a low-level object that considers config data to be name/value pairs
1463
that may be associated with a section. Assigning meaning to the these
1464
values is done at higher levels like TreeConfig.
1467
def __init__(self, transport, filename):
1468
self._transport = transport
1469
self._filename = filename
1471
def get_option(self, name, section=None, default=None):
1472
"""Return the value associated with a named option.
1474
:param name: The name of the value
1475
:param section: The section the option is in (if any)
1476
:param default: The value to return if the value is not set
1477
:return: The value or default value
1479
configobj = self._get_configobj()
1481
section_obj = configobj
1484
section_obj = configobj[section]
1487
return section_obj.get(name, default)
1489
def set_option(self, value, name, section=None):
1490
"""Set the value associated with a named option.
1492
:param value: The value to set
1493
:param name: The name of the value to set
1494
:param section: The section the option is in (if any)
1496
configobj = self._get_configobj()
1498
configobj[name] = value
1500
configobj.setdefault(section, {})[name] = value
1501
self._set_configobj(configobj)
1503
def _get_config_file(self):
1505
return StringIO(self._transport.get_bytes(self._filename))
1506
except errors.NoSuchFile:
1509
def _get_configobj(self):
1510
return ConfigObj(self._get_config_file(), encoding='utf-8')
1512
def _set_configobj(self, configobj):
1513
out_file = StringIO()
1514
configobj.write(out_file)
1516
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
