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)
197
# The option doesn't exist
199
val = ui.bool_from_string(s)
201
# The value can't be interpreted as a boolean
202
trace.warning('Value "%s" is not a boolean for "%s"',
206
def get_user_option_as_list(self, option_name):
207
"""Get a generic option as a list - no special process, no default.
209
:return None if the option doesn't exist. Returns the value as a list
212
l = self._get_user_option(option_name)
213
if isinstance(l, (str, unicode)):
214
# A single value, most probably the user forgot the final ','
218
def gpg_signing_command(self):
219
"""What program should be used to sign signatures?"""
220
result = self._gpg_signing_command()
225
def _gpg_signing_command(self):
226
"""See gpg_signing_command()."""
229
def log_format(self):
230
"""What log format should be used"""
231
result = self._log_format()
236
def _log_format(self):
237
"""See log_format()."""
240
def post_commit(self):
241
"""An ordered list of python functions to call.
243
Each function takes branch, rev_id as parameters.
245
return self._post_commit()
247
def _post_commit(self):
248
"""See Config.post_commit."""
251
def user_email(self):
252
"""Return just the email component of a username."""
253
return extract_email_address(self.username())
256
"""Return email-style username.
258
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
260
$BZR_EMAIL can be set to override this (as well as the
261
deprecated $BZREMAIL), then
262
the concrete policy type is checked, and finally
264
If none is found, a reasonable default is (hopefully)
267
TODO: Check it's reasonably well-formed.
269
v = os.environ.get('BZR_EMAIL')
271
return v.decode(osutils.get_user_encoding())
273
v = self._get_user_id()
277
v = os.environ.get('EMAIL')
279
return v.decode(osutils.get_user_encoding())
281
name, email = _auto_user_id()
283
return '%s <%s>' % (name, email)
287
def signature_checking(self):
288
"""What is the current policy for signature checking?."""
289
policy = self._get_signature_checking()
290
if policy is not None:
292
return CHECK_IF_POSSIBLE
294
def signing_policy(self):
295
"""What is the current policy for signature checking?."""
296
policy = self._get_signing_policy()
297
if policy is not None:
299
return SIGN_WHEN_REQUIRED
301
def signature_needed(self):
302
"""Is a signature needed when committing ?."""
303
policy = self._get_signing_policy()
305
policy = self._get_signature_checking()
306
if policy is not None:
307
trace.warning("Please use create_signatures,"
308
" not check_signatures to set signing policy.")
309
if policy == CHECK_ALWAYS:
311
elif policy == SIGN_ALWAYS:
315
def get_alias(self, value):
316
return self._get_alias(value)
318
def _get_alias(self, value):
321
def get_nickname(self):
322
return self._get_nickname()
324
def _get_nickname(self):
327
def get_bzr_remote_path(self):
329
return os.environ['BZR_REMOTE_PATH']
331
path = self.get_user_option("bzr_remote_path")
336
def suppress_warning(self, warning):
337
"""Should the warning be suppressed or emitted.
339
:param warning: The name of the warning being tested.
341
:returns: True if the warning should be suppressed, False otherwise.
343
warnings = self.get_user_option_as_list('suppress_warnings')
344
if warnings is None or warning not in warnings:
350
class IniBasedConfig(Config):
351
"""A configuration policy that draws from ini files."""
353
def __init__(self, get_filename):
354
super(IniBasedConfig, self).__init__()
355
self._get_filename = get_filename
358
def _get_parser(self, file=None):
359
if self._parser is not None:
362
input = self._get_filename()
366
self._parser = ConfigObj(input, encoding='utf-8')
367
except configobj.ConfigObjError, e:
368
raise errors.ParseConfigError(e.errors, e.config.filename)
371
def _get_matching_sections(self):
372
"""Return an ordered list of (section_name, extra_path) pairs.
374
If the section contains inherited configuration, extra_path is
375
a string containing the additional path components.
377
section = self._get_section()
378
if section is not None:
379
return [(section, '')]
383
def _get_section(self):
384
"""Override this to define the section used by the config."""
387
def _get_option_policy(self, section, option_name):
388
"""Return the policy for the given (section, option_name) pair."""
391
def _get_change_editor(self):
392
return self.get_user_option('change_editor')
394
def _get_signature_checking(self):
395
"""See Config._get_signature_checking."""
396
policy = self._get_user_option('check_signatures')
398
return self._string_to_signature_policy(policy)
400
def _get_signing_policy(self):
401
"""See Config._get_signing_policy"""
402
policy = self._get_user_option('create_signatures')
404
return self._string_to_signing_policy(policy)
406
def _get_user_id(self):
407
"""Get the user id from the 'email' key in the current section."""
408
return self._get_user_option('email')
410
def _get_user_option(self, option_name):
411
"""See Config._get_user_option."""
412
for (section, extra_path) in self._get_matching_sections():
414
value = self._get_parser().get_value(section, option_name)
417
policy = self._get_option_policy(section, option_name)
418
if policy == POLICY_NONE:
420
elif policy == POLICY_NORECURSE:
421
# norecurse items only apply to the exact path
426
elif policy == POLICY_APPENDPATH:
428
value = urlutils.join(value, extra_path)
431
raise AssertionError('Unexpected config policy %r' % policy)
435
def _gpg_signing_command(self):
436
"""See Config.gpg_signing_command."""
437
return self._get_user_option('gpg_signing_command')
439
def _log_format(self):
440
"""See Config.log_format."""
441
return self._get_user_option('log_format')
443
def _post_commit(self):
444
"""See Config.post_commit."""
445
return self._get_user_option('post_commit')
447
def _string_to_signature_policy(self, signature_string):
448
"""Convert a string to a signing policy."""
449
if signature_string.lower() == 'check-available':
450
return CHECK_IF_POSSIBLE
451
if signature_string.lower() == 'ignore':
453
if signature_string.lower() == 'require':
455
raise errors.BzrError("Invalid signatures policy '%s'"
458
def _string_to_signing_policy(self, signature_string):
459
"""Convert a string to a signing policy."""
460
if signature_string.lower() == 'when-required':
461
return SIGN_WHEN_REQUIRED
462
if signature_string.lower() == 'never':
464
if signature_string.lower() == 'always':
466
raise errors.BzrError("Invalid signing policy '%s'"
469
def _get_alias(self, value):
471
return self._get_parser().get_value("ALIASES",
476
def _get_nickname(self):
477
return self.get_user_option('nickname')
480
class GlobalConfig(IniBasedConfig):
481
"""The configuration that should be used for a specific location."""
483
def get_editor(self):
484
return self._get_user_option('editor')
487
super(GlobalConfig, self).__init__(config_filename)
489
def set_user_option(self, option, value):
490
"""Save option and its value in the configuration."""
491
self._set_option(option, value, 'DEFAULT')
493
def get_aliases(self):
494
"""Return the aliases section."""
495
if 'ALIASES' in self._get_parser():
496
return self._get_parser()['ALIASES']
500
def set_alias(self, alias_name, alias_command):
501
"""Save the alias in the configuration."""
502
self._set_option(alias_name, alias_command, 'ALIASES')
504
def unset_alias(self, alias_name):
505
"""Unset an existing alias."""
506
aliases = self._get_parser().get('ALIASES')
507
if not aliases or alias_name not in aliases:
508
raise errors.NoSuchAlias(alias_name)
509
del aliases[alias_name]
510
self._write_config_file()
512
def _set_option(self, option, value, section):
513
# FIXME: RBC 20051029 This should refresh the parser and also take a
514
# file lock on bazaar.conf.
515
conf_dir = os.path.dirname(self._get_filename())
516
ensure_config_dir_exists(conf_dir)
517
self._get_parser().setdefault(section, {})[option] = value
518
self._write_config_file()
520
def _write_config_file(self):
521
path = self._get_filename()
522
f = osutils.open_with_ownership(path, 'wb')
523
self._get_parser().write(f)
527
class LocationConfig(IniBasedConfig):
528
"""A configuration object that gives the policy for a location."""
530
def __init__(self, location):
531
name_generator = locations_config_filename
532
if (not os.path.exists(name_generator()) and
533
os.path.exists(branches_config_filename())):
534
if sys.platform == 'win32':
535
trace.warning('Please rename %s to %s'
536
% (branches_config_filename(),
537
locations_config_filename()))
539
trace.warning('Please rename ~/.bazaar/branches.conf'
540
' to ~/.bazaar/locations.conf')
541
name_generator = branches_config_filename
542
super(LocationConfig, self).__init__(name_generator)
543
# local file locations are looked up by local path, rather than
544
# by file url. This is because the config file is a user
545
# file, and we would rather not expose the user to file urls.
546
if location.startswith('file://'):
547
location = urlutils.local_path_from_url(location)
548
self.location = location
550
def _get_matching_sections(self):
551
"""Return an ordered list of section names matching this location."""
552
sections = self._get_parser()
553
location_names = self.location.split('/')
554
if self.location.endswith('/'):
555
del location_names[-1]
557
for section in sections:
558
# location is a local path if possible, so we need
559
# to convert 'file://' urls to local paths if necessary.
560
# This also avoids having file:///path be a more exact
561
# match than '/path'.
562
if section.startswith('file://'):
563
section_path = urlutils.local_path_from_url(section)
565
section_path = section
566
section_names = section_path.split('/')
567
if section.endswith('/'):
568
del section_names[-1]
569
names = zip(location_names, section_names)
572
if not fnmatch(name[0], name[1]):
577
# so, for the common prefix they matched.
578
# if section is longer, no match.
579
if len(section_names) > len(location_names):
581
matches.append((len(section_names), section,
582
'/'.join(location_names[len(section_names):])))
583
matches.sort(reverse=True)
585
for (length, section, extra_path) in matches:
586
sections.append((section, extra_path))
587
# should we stop looking for parent configs here?
589
if self._get_parser()[section].as_bool('ignore_parents'):
595
def _get_option_policy(self, section, option_name):
596
"""Return the policy for the given (section, option_name) pair."""
597
# check for the old 'recurse=False' flag
599
recurse = self._get_parser()[section].as_bool('recurse')
603
return POLICY_NORECURSE
605
policy_key = option_name + ':policy'
607
policy_name = self._get_parser()[section][policy_key]
611
return _policy_value[policy_name]
613
def _set_option_policy(self, section, option_name, option_policy):
614
"""Set the policy for the given option name in the given section."""
615
# The old recurse=False option affects all options in the
616
# section. To handle multiple policies in the section, we
617
# need to convert it to a policy_norecurse key.
619
recurse = self._get_parser()[section].as_bool('recurse')
623
symbol_versioning.warn(
624
'The recurse option is deprecated as of 0.14. '
625
'The section "%s" has been converted to use policies.'
628
del self._get_parser()[section]['recurse']
630
for key in self._get_parser()[section].keys():
631
if not key.endswith(':policy'):
632
self._get_parser()[section][key +
633
':policy'] = 'norecurse'
635
policy_key = option_name + ':policy'
636
policy_name = _policy_name[option_policy]
637
if policy_name is not None:
638
self._get_parser()[section][policy_key] = policy_name
640
if policy_key in self._get_parser()[section]:
641
del self._get_parser()[section][policy_key]
643
def set_user_option(self, option, value, store=STORE_LOCATION):
644
"""Save option and its value in the configuration."""
645
if store not in [STORE_LOCATION,
646
STORE_LOCATION_NORECURSE,
647
STORE_LOCATION_APPENDPATH]:
648
raise ValueError('bad storage policy %r for %r' %
650
# FIXME: RBC 20051029 This should refresh the parser and also take a
651
# file lock on locations.conf.
652
conf_dir = os.path.dirname(self._get_filename())
653
ensure_config_dir_exists(conf_dir)
654
location = self.location
655
if location.endswith('/'):
656
location = location[:-1]
657
if (not location in self._get_parser() and
658
not location + '/' in self._get_parser()):
659
self._get_parser()[location]={}
660
elif location + '/' in self._get_parser():
661
location = location + '/'
662
self._get_parser()[location][option]=value
663
# the allowed values of store match the config policies
664
self._set_option_policy(location, option, store)
665
self._get_parser().write(file(self._get_filename(), 'wb'))
668
class BranchConfig(Config):
669
"""A configuration object giving the policy for a branch."""
671
def _get_branch_data_config(self):
672
if self._branch_data_config is None:
673
self._branch_data_config = TreeConfig(self.branch)
674
return self._branch_data_config
676
def _get_location_config(self):
677
if self._location_config is None:
678
self._location_config = LocationConfig(self.branch.base)
679
return self._location_config
681
def _get_global_config(self):
682
if self._global_config is None:
683
self._global_config = GlobalConfig()
684
return self._global_config
686
def _get_best_value(self, option_name):
687
"""This returns a user option from local, tree or global config.
689
They are tried in that order. Use get_safe_value if trusted values
692
for source in self.option_sources:
693
value = getattr(source(), option_name)()
694
if value is not None:
698
def _get_safe_value(self, option_name):
699
"""This variant of get_best_value never returns untrusted values.
701
It does not return values from the branch data, because the branch may
702
not be controlled by the user.
704
We may wish to allow locations.conf to control whether branches are
705
trusted in the future.
707
for source in (self._get_location_config, self._get_global_config):
708
value = getattr(source(), option_name)()
709
if value is not None:
713
def _get_user_id(self):
714
"""Return the full user id for the branch.
716
e.g. "John Hacker <jhacker@example.com>"
717
This is looked up in the email controlfile for the branch.
720
return (self.branch._transport.get_bytes("email")
721
.decode(osutils.get_user_encoding())
723
except errors.NoSuchFile, e:
726
return self._get_best_value('_get_user_id')
728
def _get_change_editor(self):
729
return self._get_best_value('_get_change_editor')
731
def _get_signature_checking(self):
732
"""See Config._get_signature_checking."""
733
return self._get_best_value('_get_signature_checking')
735
def _get_signing_policy(self):
736
"""See Config._get_signing_policy."""
737
return self._get_best_value('_get_signing_policy')
739
def _get_user_option(self, option_name):
740
"""See Config._get_user_option."""
741
for source in self.option_sources:
742
value = source()._get_user_option(option_name)
743
if value is not None:
747
def set_user_option(self, name, value, store=STORE_BRANCH,
749
if store == STORE_BRANCH:
750
self._get_branch_data_config().set_option(value, name)
751
elif store == STORE_GLOBAL:
752
self._get_global_config().set_user_option(name, value)
754
self._get_location_config().set_user_option(name, value, store)
757
if store in (STORE_GLOBAL, STORE_BRANCH):
758
mask_value = self._get_location_config().get_user_option(name)
759
if mask_value is not None:
760
trace.warning('Value "%s" is masked by "%s" from'
761
' locations.conf', value, mask_value)
763
if store == STORE_GLOBAL:
764
branch_config = self._get_branch_data_config()
765
mask_value = branch_config.get_user_option(name)
766
if mask_value is not None:
767
trace.warning('Value "%s" is masked by "%s" from'
768
' branch.conf', value, mask_value)
770
def _gpg_signing_command(self):
771
"""See Config.gpg_signing_command."""
772
return self._get_safe_value('_gpg_signing_command')
774
def __init__(self, branch):
775
super(BranchConfig, self).__init__()
776
self._location_config = None
777
self._branch_data_config = None
778
self._global_config = None
780
self.option_sources = (self._get_location_config,
781
self._get_branch_data_config,
782
self._get_global_config)
784
def _post_commit(self):
785
"""See Config.post_commit."""
786
return self._get_safe_value('_post_commit')
788
def _get_nickname(self):
789
value = self._get_explicit_nickname()
790
if value is not None:
792
return urlutils.unescape(self.branch.base.split('/')[-2])
794
def has_explicit_nickname(self):
795
"""Return true if a nickname has been explicitly assigned."""
796
return self._get_explicit_nickname() is not None
798
def _get_explicit_nickname(self):
799
return self._get_best_value('_get_nickname')
801
def _log_format(self):
802
"""See Config.log_format."""
803
return self._get_best_value('_log_format')
806
def ensure_config_dir_exists(path=None):
807
"""Make sure a configuration directory exists.
808
This makes sure that the directory exists.
809
On windows, since configuration directories are 2 levels deep,
810
it makes sure both the directory and the parent directory exists.
814
if not os.path.isdir(path):
815
if sys.platform == 'win32':
816
parent_dir = os.path.dirname(path)
817
if not os.path.isdir(parent_dir):
818
trace.mutter('creating config parent directory: %r', parent_dir)
820
trace.mutter('creating config directory: %r', path)
821
osutils.mkdir_with_ownership(path)
825
"""Return per-user configuration directory.
827
By default this is ~/.bazaar/
829
TODO: Global option --config-dir to override this.
831
base = os.environ.get('BZR_HOME', None)
832
if sys.platform == 'win32':
834
base = win32utils.get_appdata_location_unicode()
836
base = os.environ.get('HOME', None)
838
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
840
return osutils.pathjoin(base, 'bazaar', '2.0')
842
# cygwin, linux, and darwin all have a $HOME directory
844
base = os.path.expanduser("~")
845
return osutils.pathjoin(base, ".bazaar")
848
def config_filename():
849
"""Return per-user configuration ini file filename."""
850
return osutils.pathjoin(config_dir(), 'bazaar.conf')
853
def branches_config_filename():
854
"""Return per-user configuration ini file filename."""
855
return osutils.pathjoin(config_dir(), 'branches.conf')
858
def locations_config_filename():
859
"""Return per-user configuration ini file filename."""
860
return osutils.pathjoin(config_dir(), 'locations.conf')
863
def authentication_config_filename():
864
"""Return per-user authentication ini file filename."""
865
return osutils.pathjoin(config_dir(), 'authentication.conf')
868
def user_ignore_config_filename():
869
"""Return the user default ignore filename"""
870
return osutils.pathjoin(config_dir(), 'ignore')
874
"""Return the directory name to store crash files.
876
This doesn't implicitly create it.
878
On Windows it's in the config directory; elsewhere it's /var/crash
879
which may be monitored by apport. It can be overridden by
882
if sys.platform == 'win32':
883
return osutils.pathjoin(config_dir(), 'Crash')
885
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
887
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
891
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
892
# Possibly this should be different on Windows?
893
e = os.environ.get('XDG_CACHE_DIR', None)
897
return os.path.expanduser('~/.cache')
901
"""Calculate automatic user identification.
903
Returns (realname, email).
905
Only used when none is set in the environment or the id file.
907
This previously used the FQDN as the default domain, but that can
908
be very slow on machines where DNS is broken. So now we simply
913
if sys.platform == 'win32':
914
name = win32utils.get_user_name_unicode()
916
raise errors.BzrError("Cannot autodetect user name.\n"
917
"Please, set your name with command like:\n"
918
'bzr whoami "Your Name <name@domain.com>"')
919
host = win32utils.get_host_name_unicode()
921
host = socket.gethostname()
922
return name, (name + '@' + host)
928
w = pwd.getpwuid(uid)
930
raise errors.BzrCommandError('Unable to determine your name. '
931
'Please use "bzr whoami" to set it.')
933
# we try utf-8 first, because on many variants (like Linux),
934
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
935
# false positives. (many users will have their user encoding set to
936
# latin-1, which cannot raise UnicodeError.)
938
gecos = w.pw_gecos.decode('utf-8')
942
encoding = osutils.get_user_encoding()
943
gecos = w.pw_gecos.decode(encoding)
945
raise errors.BzrCommandError('Unable to determine your name. '
946
'Use "bzr whoami" to set it.')
948
username = w.pw_name.decode(encoding)
950
raise errors.BzrCommandError('Unable to determine your name. '
951
'Use "bzr whoami" to set it.')
953
comma = gecos.find(',')
957
realname = gecos[:comma]
964
user_encoding = osutils.get_user_encoding()
965
realname = username = getpass.getuser().decode(user_encoding)
966
except UnicodeDecodeError:
967
raise errors.BzrError("Can't decode username as %s." % \
970
return realname, (username + '@' + socket.gethostname())
973
def parse_username(username):
974
"""Parse e-mail username and return a (name, address) tuple."""
975
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
977
return (username, '')
979
return (match.group(1), match.group(2))
982
def extract_email_address(e):
983
"""Return just the address part of an email string.
985
That is just the user@domain part, nothing else.
986
This part is required to contain only ascii characters.
987
If it can't be extracted, raises an error.
989
>>> extract_email_address('Jane Tester <jane@test.com>')
992
name, email = parse_username(e)
994
raise errors.NoEmailInUsername(e)
998
class TreeConfig(IniBasedConfig):
999
"""Branch configuration data associated with its contents, not location"""
1001
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1003
def __init__(self, branch):
1004
self._config = branch._get_config()
1005
self.branch = branch
1007
def _get_parser(self, file=None):
1008
if file is not None:
1009
return IniBasedConfig._get_parser(file)
1010
return self._config._get_configobj()
1012
def get_option(self, name, section=None, default=None):
1013
self.branch.lock_read()
1015
return self._config.get_option(name, section, default)
1017
self.branch.unlock()
1019
def set_option(self, value, name, section=None):
1020
"""Set a per-branch configuration option"""
1021
self.branch.lock_write()
1023
self._config.set_option(value, name, section)
1025
self.branch.unlock()
1028
class AuthenticationConfig(object):
1029
"""The authentication configuration file based on a ini file.
1031
Implements the authentication.conf file described in
1032
doc/developers/authentication-ring.txt.
1035
def __init__(self, _file=None):
1036
self._config = None # The ConfigObj
1038
self._filename = authentication_config_filename()
1039
self._input = self._filename = authentication_config_filename()
1041
# Tests can provide a string as _file
1042
self._filename = None
1045
def _get_config(self):
1046
if self._config is not None:
1049
# FIXME: Should we validate something here ? Includes: empty
1050
# sections are useless, at least one of
1051
# user/password/password_encoding should be defined, etc.
1053
# Note: the encoding below declares that the file itself is utf-8
1054
# encoded, but the values in the ConfigObj are always Unicode.
1055
self._config = ConfigObj(self._input, encoding='utf-8')
1056
except configobj.ConfigObjError, e:
1057
raise errors.ParseConfigError(e.errors, e.config.filename)
1061
"""Save the config file, only tests should use it for now."""
1062
conf_dir = os.path.dirname(self._filename)
1063
ensure_config_dir_exists(conf_dir)
1064
self._get_config().write(file(self._filename, 'wb'))
1066
def _set_option(self, section_name, option_name, value):
1067
"""Set an authentication configuration option"""
1068
conf = self._get_config()
1069
section = conf.get(section_name)
1072
section = conf[section]
1073
section[option_name] = value
1076
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1078
"""Returns the matching credentials from authentication.conf file.
1080
:param scheme: protocol
1082
:param host: the server address
1084
:param port: the associated port (optional)
1086
:param user: login (optional)
1088
:param path: the absolute path on the server (optional)
1090
:param realm: the http authentication realm (optional)
1092
:return: A dict containing the matching credentials or None.
1094
- name: the section name of the credentials in the
1095
authentication.conf file,
1096
- user: can't be different from the provided user if any,
1097
- scheme: the server protocol,
1098
- host: the server address,
1099
- port: the server port (can be None),
1100
- path: the absolute server path (can be None),
1101
- realm: the http specific authentication realm (can be None),
1102
- password: the decoded password, could be None if the credential
1103
defines only the user
1104
- verify_certificates: https specific, True if the server
1105
certificate should be verified, False otherwise.
1108
for auth_def_name, auth_def in self._get_config().items():
1109
if type(auth_def) is not configobj.Section:
1110
raise ValueError("%s defined outside a section" % auth_def_name)
1112
a_scheme, a_host, a_user, a_path = map(
1113
auth_def.get, ['scheme', 'host', 'user', 'path'])
1116
a_port = auth_def.as_int('port')
1120
raise ValueError("'port' not numeric in %s" % auth_def_name)
1122
a_verify_certificates = auth_def.as_bool('verify_certificates')
1124
a_verify_certificates = True
1127
"'verify_certificates' not boolean in %s" % auth_def_name)
1130
if a_scheme is not None and scheme != a_scheme:
1132
if a_host is not None:
1133
if not (host == a_host
1134
or (a_host.startswith('.') and host.endswith(a_host))):
1136
if a_port is not None and port != a_port:
1138
if (a_path is not None and path is not None
1139
and not path.startswith(a_path)):
1141
if (a_user is not None and user is not None
1142
and a_user != user):
1143
# Never contradict the caller about the user to be used
1148
# Prepare a credentials dictionary with additional keys
1149
# for the credential providers
1150
credentials = dict(name=auth_def_name,
1157
password=auth_def.get('password', None),
1158
verify_certificates=a_verify_certificates)
1159
# Decode the password in the credentials (or get one)
1160
self.decode_password(credentials,
1161
auth_def.get('password_encoding', None))
1162
if 'auth' in debug.debug_flags:
1163
trace.mutter("Using authentication section: %r", auth_def_name)
1166
if credentials is None:
1167
# No credentials were found in authentication.conf, try the fallback
1168
# credentials stores.
1169
credentials = credential_store_registry.get_fallback_credentials(
1170
scheme, host, port, user, path, realm)
1174
def set_credentials(self, name, host, user, scheme=None, password=None,
1175
port=None, path=None, verify_certificates=None,
1177
"""Set authentication credentials for a host.
1179
Any existing credentials with matching scheme, host, port and path
1180
will be deleted, regardless of name.
1182
:param name: An arbitrary name to describe this set of credentials.
1183
:param host: Name of the host that accepts these credentials.
1184
:param user: The username portion of these credentials.
1185
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1187
:param password: Password portion of these credentials.
1188
:param port: The IP port on the host that these credentials apply to.
1189
:param path: A filesystem path on the host that these credentials
1191
:param verify_certificates: On https, verify server certificates if
1193
:param realm: The http authentication realm (optional).
1195
values = {'host': host, 'user': user}
1196
if password is not None:
1197
values['password'] = password
1198
if scheme is not None:
1199
values['scheme'] = scheme
1200
if port is not None:
1201
values['port'] = '%d' % port
1202
if path is not None:
1203
values['path'] = path
1204
if verify_certificates is not None:
1205
values['verify_certificates'] = str(verify_certificates)
1206
if realm is not None:
1207
values['realm'] = realm
1208
config = self._get_config()
1210
for section, existing_values in config.items():
1211
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1212
if existing_values.get(key) != values.get(key):
1216
config.update({name: values})
1219
def get_user(self, scheme, host, port=None, realm=None, path=None,
1220
prompt=None, ask=False, default=None):
1221
"""Get a user from authentication file.
1223
:param scheme: protocol
1225
:param host: the server address
1227
:param port: the associated port (optional)
1229
:param realm: the realm sent by the server (optional)
1231
:param path: the absolute path on the server (optional)
1233
:param ask: Ask the user if there is no explicitly configured username
1236
:param default: The username returned if none is defined (optional).
1238
:return: The found user.
1240
credentials = self.get_credentials(scheme, host, port, user=None,
1241
path=path, realm=realm)
1242
if credentials is not None:
1243
user = credentials['user']
1249
# Create a default prompt suitable for most cases
1250
prompt = scheme.upper() + ' %(host)s username'
1251
# Special handling for optional fields in the prompt
1252
if port is not None:
1253
prompt_host = '%s:%d' % (host, port)
1256
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1261
def get_password(self, scheme, host, user, port=None,
1262
realm=None, path=None, prompt=None):
1263
"""Get a password from authentication file or prompt the user for one.
1265
:param scheme: protocol
1267
:param host: the server address
1269
:param port: the associated port (optional)
1273
:param realm: the realm sent by the server (optional)
1275
:param path: the absolute path on the server (optional)
1277
:return: The found password or the one entered by the user.
1279
credentials = self.get_credentials(scheme, host, port, user, path,
1281
if credentials is not None:
1282
password = credentials['password']
1283
if password is not None and scheme is 'ssh':
1284
trace.warning('password ignored in section [%s],'
1285
' use an ssh agent instead'
1286
% credentials['name'])
1290
# Prompt user only if we could't find a password
1291
if password is None:
1293
# Create a default prompt suitable for most cases
1294
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1295
# Special handling for optional fields in the prompt
1296
if port is not None:
1297
prompt_host = '%s:%d' % (host, port)
1300
password = ui.ui_factory.get_password(prompt,
1301
host=prompt_host, user=user)
1304
def decode_password(self, credentials, encoding):
1306
cs = credential_store_registry.get_credential_store(encoding)
1308
raise ValueError('%r is not a known password_encoding' % encoding)
1309
credentials['password'] = cs.decode_password(credentials)
1313
class CredentialStoreRegistry(registry.Registry):
1314
"""A class that registers credential stores.
1316
A credential store provides access to credentials via the password_encoding
1317
field in authentication.conf sections.
1319
Except for stores provided by bzr itself, most stores are expected to be
1320
provided by plugins that will therefore use
1321
register_lazy(password_encoding, module_name, member_name, help=help,
1322
fallback=fallback) to install themselves.
1324
A fallback credential store is one that is queried if no credentials can be
1325
found via authentication.conf.
1328
def get_credential_store(self, encoding=None):
1329
cs = self.get(encoding)
1334
def is_fallback(self, name):
1335
"""Check if the named credentials store should be used as fallback."""
1336
return self.get_info(name)
1338
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1339
path=None, realm=None):
1340
"""Request credentials from all fallback credentials stores.
1342
The first credentials store that can provide credentials wins.
1345
for name in self.keys():
1346
if not self.is_fallback(name):
1348
cs = self.get_credential_store(name)
1349
credentials = cs.get_credentials(scheme, host, port, user,
1351
if credentials is not None:
1352
# We found some credentials
1356
def register(self, key, obj, help=None, override_existing=False,
1358
"""Register a new object to a name.
1360
:param key: This is the key to use to request the object later.
1361
:param obj: The object to register.
1362
:param help: Help text for this entry. This may be a string or
1363
a callable. If it is a callable, it should take two
1364
parameters (registry, key): this registry and the key that
1365
the help was registered under.
1366
:param override_existing: Raise KeyErorr if False and something has
1367
already been registered for that key. If True, ignore if there
1368
is an existing key (always register the new value).
1369
:param fallback: Whether this credential store should be
1372
return super(CredentialStoreRegistry,
1373
self).register(key, obj, help, info=fallback,
1374
override_existing=override_existing)
1376
def register_lazy(self, key, module_name, member_name,
1377
help=None, override_existing=False,
1379
"""Register a new credential store to be loaded on request.
1381
:param module_name: The python path to the module. Such as 'os.path'.
1382
:param member_name: The member of the module to return. If empty or
1383
None, get() will return the module itself.
1384
:param help: Help text for this entry. This may be a string or
1386
:param override_existing: If True, replace the existing object
1387
with the new one. If False, if there is already something
1388
registered with the same key, raise a KeyError
1389
:param fallback: Whether this credential store should be
1392
return super(CredentialStoreRegistry, self).register_lazy(
1393
key, module_name, member_name, help,
1394
info=fallback, override_existing=override_existing)
1397
credential_store_registry = CredentialStoreRegistry()
1400
class CredentialStore(object):
1401
"""An abstract class to implement storage for credentials"""
1403
def decode_password(self, credentials):
1404
"""Returns a clear text password for the provided credentials."""
1405
raise NotImplementedError(self.decode_password)
1407
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1409
"""Return the matching credentials from this credential store.
1411
This method is only called on fallback credential stores.
1413
raise NotImplementedError(self.get_credentials)
1417
class PlainTextCredentialStore(CredentialStore):
1418
"""Plain text credential store for the authentication.conf file."""
1420
def decode_password(self, credentials):
1421
"""See CredentialStore.decode_password."""
1422
return credentials['password']
1425
credential_store_registry.register('plain', PlainTextCredentialStore,
1426
help=PlainTextCredentialStore.__doc__)
1427
credential_store_registry.default_key = 'plain'
1430
class BzrDirConfig(object):
1432
def __init__(self, bzrdir):
1433
self._bzrdir = bzrdir
1434
self._config = bzrdir._get_config()
1436
def set_default_stack_on(self, value):
1437
"""Set the default stacking location.
1439
It may be set to a location, or None.
1441
This policy affects all branches contained by this bzrdir, except for
1442
those under repositories.
1444
if self._config is None:
1445
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1447
self._config.set_option('', 'default_stack_on')
1449
self._config.set_option(value, 'default_stack_on')
1451
def get_default_stack_on(self):
1452
"""Return the default stacking location.
1454
This will either be a location, or None.
1456
This policy affects all branches contained by this bzrdir, except for
1457
those under repositories.
1459
if self._config is None:
1461
value = self._config.get_option('default_stack_on')
1467
class TransportConfig(object):
1468
"""A Config that reads/writes a config file on a Transport.
1470
It is a low-level object that considers config data to be name/value pairs
1471
that may be associated with a section. Assigning meaning to the these
1472
values is done at higher levels like TreeConfig.
1475
def __init__(self, transport, filename):
1476
self._transport = transport
1477
self._filename = filename
1479
def get_option(self, name, section=None, default=None):
1480
"""Return the value associated with a named option.
1482
:param name: The name of the value
1483
:param section: The section the option is in (if any)
1484
:param default: The value to return if the value is not set
1485
:return: The value or default value
1487
configobj = self._get_configobj()
1489
section_obj = configobj
1492
section_obj = configobj[section]
1495
return section_obj.get(name, default)
1497
def set_option(self, value, name, section=None):
1498
"""Set the value associated with a named option.
1500
:param value: The value to set
1501
:param name: The name of the value to set
1502
:param section: The section the option is in (if any)
1504
configobj = self._get_configobj()
1506
configobj[name] = value
1508
configobj.setdefault(section, {})[name] = value
1509
self._set_configobj(configobj)
1511
def _get_config_file(self):
1513
return StringIO(self._transport.get_bytes(self._filename))
1514
except errors.NoSuchFile:
1517
def _get_configobj(self):
1518
return ConfigObj(self._get_config_file(), encoding='utf-8')
1520
def _set_configobj(self, configobj):
1521
out_file = StringIO()
1522
configobj.write(out_file)
1524
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
