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()
523
osutils.copy_ownership_from_path(path)
524
self._get_parser().write(f)
528
class LocationConfig(IniBasedConfig):
529
"""A configuration object that gives the policy for a location."""
531
def __init__(self, location):
532
name_generator = locations_config_filename
533
if (not os.path.exists(name_generator()) and
534
os.path.exists(branches_config_filename())):
535
if sys.platform == 'win32':
536
trace.warning('Please rename %s to %s'
537
% (branches_config_filename(),
538
locations_config_filename()))
540
trace.warning('Please rename ~/.bazaar/branches.conf'
541
' to ~/.bazaar/locations.conf')
542
name_generator = branches_config_filename
543
super(LocationConfig, self).__init__(name_generator)
544
# local file locations are looked up by local path, rather than
545
# by file url. This is because the config file is a user
546
# file, and we would rather not expose the user to file urls.
547
if location.startswith('file://'):
548
location = urlutils.local_path_from_url(location)
549
self.location = location
551
def _get_matching_sections(self):
552
"""Return an ordered list of section names matching this location."""
553
sections = self._get_parser()
554
location_names = self.location.split('/')
555
if self.location.endswith('/'):
556
del location_names[-1]
558
for section in sections:
559
# location is a local path if possible, so we need
560
# to convert 'file://' urls to local paths if necessary.
561
# This also avoids having file:///path be a more exact
562
# match than '/path'.
563
if section.startswith('file://'):
564
section_path = urlutils.local_path_from_url(section)
566
section_path = section
567
section_names = section_path.split('/')
568
if section.endswith('/'):
569
del section_names[-1]
570
names = zip(location_names, section_names)
573
if not fnmatch(name[0], name[1]):
578
# so, for the common prefix they matched.
579
# if section is longer, no match.
580
if len(section_names) > len(location_names):
582
matches.append((len(section_names), section,
583
'/'.join(location_names[len(section_names):])))
584
matches.sort(reverse=True)
586
for (length, section, extra_path) in matches:
587
sections.append((section, extra_path))
588
# should we stop looking for parent configs here?
590
if self._get_parser()[section].as_bool('ignore_parents'):
596
def _get_option_policy(self, section, option_name):
597
"""Return the policy for the given (section, option_name) pair."""
598
# check for the old 'recurse=False' flag
600
recurse = self._get_parser()[section].as_bool('recurse')
604
return POLICY_NORECURSE
606
policy_key = option_name + ':policy'
608
policy_name = self._get_parser()[section][policy_key]
612
return _policy_value[policy_name]
614
def _set_option_policy(self, section, option_name, option_policy):
615
"""Set the policy for the given option name in the given section."""
616
# The old recurse=False option affects all options in the
617
# section. To handle multiple policies in the section, we
618
# need to convert it to a policy_norecurse key.
620
recurse = self._get_parser()[section].as_bool('recurse')
624
symbol_versioning.warn(
625
'The recurse option is deprecated as of 0.14. '
626
'The section "%s" has been converted to use policies.'
629
del self._get_parser()[section]['recurse']
631
for key in self._get_parser()[section].keys():
632
if not key.endswith(':policy'):
633
self._get_parser()[section][key +
634
':policy'] = 'norecurse'
636
policy_key = option_name + ':policy'
637
policy_name = _policy_name[option_policy]
638
if policy_name is not None:
639
self._get_parser()[section][policy_key] = policy_name
641
if policy_key in self._get_parser()[section]:
642
del self._get_parser()[section][policy_key]
644
def set_user_option(self, option, value, store=STORE_LOCATION):
645
"""Save option and its value in the configuration."""
646
if store not in [STORE_LOCATION,
647
STORE_LOCATION_NORECURSE,
648
STORE_LOCATION_APPENDPATH]:
649
raise ValueError('bad storage policy %r for %r' %
651
# FIXME: RBC 20051029 This should refresh the parser and also take a
652
# file lock on locations.conf.
653
conf_dir = os.path.dirname(self._get_filename())
654
ensure_config_dir_exists(conf_dir)
655
location = self.location
656
if location.endswith('/'):
657
location = location[:-1]
658
if (not location in self._get_parser() and
659
not location + '/' in self._get_parser()):
660
self._get_parser()[location]={}
661
elif location + '/' in self._get_parser():
662
location = location + '/'
663
self._get_parser()[location][option]=value
664
# the allowed values of store match the config policies
665
self._set_option_policy(location, option, store)
666
self._get_parser().write(file(self._get_filename(), 'wb'))
669
class BranchConfig(Config):
670
"""A configuration object giving the policy for a branch."""
672
def _get_branch_data_config(self):
673
if self._branch_data_config is None:
674
self._branch_data_config = TreeConfig(self.branch)
675
return self._branch_data_config
677
def _get_location_config(self):
678
if self._location_config is None:
679
self._location_config = LocationConfig(self.branch.base)
680
return self._location_config
682
def _get_global_config(self):
683
if self._global_config is None:
684
self._global_config = GlobalConfig()
685
return self._global_config
687
def _get_best_value(self, option_name):
688
"""This returns a user option from local, tree or global config.
690
They are tried in that order. Use get_safe_value if trusted values
693
for source in self.option_sources:
694
value = getattr(source(), option_name)()
695
if value is not None:
699
def _get_safe_value(self, option_name):
700
"""This variant of get_best_value never returns untrusted values.
702
It does not return values from the branch data, because the branch may
703
not be controlled by the user.
705
We may wish to allow locations.conf to control whether branches are
706
trusted in the future.
708
for source in (self._get_location_config, self._get_global_config):
709
value = getattr(source(), option_name)()
710
if value is not None:
714
def _get_user_id(self):
715
"""Return the full user id for the branch.
717
e.g. "John Hacker <jhacker@example.com>"
718
This is looked up in the email controlfile for the branch.
721
return (self.branch._transport.get_bytes("email")
722
.decode(osutils.get_user_encoding())
724
except errors.NoSuchFile, e:
727
return self._get_best_value('_get_user_id')
729
def _get_change_editor(self):
730
return self._get_best_value('_get_change_editor')
732
def _get_signature_checking(self):
733
"""See Config._get_signature_checking."""
734
return self._get_best_value('_get_signature_checking')
736
def _get_signing_policy(self):
737
"""See Config._get_signing_policy."""
738
return self._get_best_value('_get_signing_policy')
740
def _get_user_option(self, option_name):
741
"""See Config._get_user_option."""
742
for source in self.option_sources:
743
value = source()._get_user_option(option_name)
744
if value is not None:
748
def set_user_option(self, name, value, store=STORE_BRANCH,
750
if store == STORE_BRANCH:
751
self._get_branch_data_config().set_option(value, name)
752
elif store == STORE_GLOBAL:
753
self._get_global_config().set_user_option(name, value)
755
self._get_location_config().set_user_option(name, value, store)
758
if store in (STORE_GLOBAL, STORE_BRANCH):
759
mask_value = self._get_location_config().get_user_option(name)
760
if mask_value is not None:
761
trace.warning('Value "%s" is masked by "%s" from'
762
' locations.conf', value, mask_value)
764
if store == STORE_GLOBAL:
765
branch_config = self._get_branch_data_config()
766
mask_value = branch_config.get_user_option(name)
767
if mask_value is not None:
768
trace.warning('Value "%s" is masked by "%s" from'
769
' branch.conf', value, mask_value)
771
def _gpg_signing_command(self):
772
"""See Config.gpg_signing_command."""
773
return self._get_safe_value('_gpg_signing_command')
775
def __init__(self, branch):
776
super(BranchConfig, self).__init__()
777
self._location_config = None
778
self._branch_data_config = None
779
self._global_config = None
781
self.option_sources = (self._get_location_config,
782
self._get_branch_data_config,
783
self._get_global_config)
785
def _post_commit(self):
786
"""See Config.post_commit."""
787
return self._get_safe_value('_post_commit')
789
def _get_nickname(self):
790
value = self._get_explicit_nickname()
791
if value is not None:
793
return urlutils.unescape(self.branch.base.split('/')[-2])
795
def has_explicit_nickname(self):
796
"""Return true if a nickname has been explicitly assigned."""
797
return self._get_explicit_nickname() is not None
799
def _get_explicit_nickname(self):
800
return self._get_best_value('_get_nickname')
802
def _log_format(self):
803
"""See Config.log_format."""
804
return self._get_best_value('_log_format')
807
def ensure_config_dir_exists(path=None):
808
"""Make sure a configuration directory exists.
809
This makes sure that the directory exists.
810
On windows, since configuration directories are 2 levels deep,
811
it makes sure both the directory and the parent directory exists.
815
if not os.path.isdir(path):
816
if sys.platform == 'win32':
817
parent_dir = os.path.dirname(path)
818
if not os.path.isdir(parent_dir):
819
trace.mutter('creating config parent directory: %r', parent_dir)
821
trace.mutter('creating config directory: %r', path)
823
osutils.copy_ownership_from_path(path)
827
"""Return per-user configuration directory.
829
By default this is ~/.bazaar/
831
TODO: Global option --config-dir to override this.
833
base = os.environ.get('BZR_HOME', None)
834
if sys.platform == 'win32':
836
base = win32utils.get_appdata_location_unicode()
838
base = os.environ.get('HOME', None)
840
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
842
return osutils.pathjoin(base, 'bazaar', '2.0')
844
# cygwin, linux, and darwin all have a $HOME directory
846
base = os.path.expanduser("~")
847
return osutils.pathjoin(base, ".bazaar")
850
def config_filename():
851
"""Return per-user configuration ini file filename."""
852
return osutils.pathjoin(config_dir(), 'bazaar.conf')
855
def branches_config_filename():
856
"""Return per-user configuration ini file filename."""
857
return osutils.pathjoin(config_dir(), 'branches.conf')
860
def locations_config_filename():
861
"""Return per-user configuration ini file filename."""
862
return osutils.pathjoin(config_dir(), 'locations.conf')
865
def authentication_config_filename():
866
"""Return per-user authentication ini file filename."""
867
return osutils.pathjoin(config_dir(), 'authentication.conf')
870
def user_ignore_config_filename():
871
"""Return the user default ignore filename"""
872
return osutils.pathjoin(config_dir(), 'ignore')
876
"""Return the directory name to store crash files.
878
This doesn't implicitly create it.
880
On Windows it's in the config directory; elsewhere it's /var/crash
881
which may be monitored by apport. It can be overridden by
884
if sys.platform == 'win32':
885
return osutils.pathjoin(config_dir(), 'Crash')
887
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
889
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
893
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
894
# Possibly this should be different on Windows?
895
e = os.environ.get('XDG_CACHE_DIR', None)
899
return os.path.expanduser('~/.cache')
903
"""Calculate automatic user identification.
905
Returns (realname, email).
907
Only used when none is set in the environment or the id file.
909
This previously used the FQDN as the default domain, but that can
910
be very slow on machines where DNS is broken. So now we simply
915
if sys.platform == 'win32':
916
name = win32utils.get_user_name_unicode()
918
raise errors.BzrError("Cannot autodetect user name.\n"
919
"Please, set your name with command like:\n"
920
'bzr whoami "Your Name <name@domain.com>"')
921
host = win32utils.get_host_name_unicode()
923
host = socket.gethostname()
924
return name, (name + '@' + host)
930
w = pwd.getpwuid(uid)
932
raise errors.BzrCommandError('Unable to determine your name. '
933
'Please use "bzr whoami" to set it.')
935
# we try utf-8 first, because on many variants (like Linux),
936
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
937
# false positives. (many users will have their user encoding set to
938
# latin-1, which cannot raise UnicodeError.)
940
gecos = w.pw_gecos.decode('utf-8')
944
encoding = osutils.get_user_encoding()
945
gecos = w.pw_gecos.decode(encoding)
947
raise errors.BzrCommandError('Unable to determine your name. '
948
'Use "bzr whoami" to set it.')
950
username = w.pw_name.decode(encoding)
952
raise errors.BzrCommandError('Unable to determine your name. '
953
'Use "bzr whoami" to set it.')
955
comma = gecos.find(',')
959
realname = gecos[:comma]
966
user_encoding = osutils.get_user_encoding()
967
realname = username = getpass.getuser().decode(user_encoding)
968
except UnicodeDecodeError:
969
raise errors.BzrError("Can't decode username as %s." % \
972
return realname, (username + '@' + socket.gethostname())
975
def parse_username(username):
976
"""Parse e-mail username and return a (name, address) tuple."""
977
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
979
return (username, '')
981
return (match.group(1), match.group(2))
984
def extract_email_address(e):
985
"""Return just the address part of an email string.
987
That is just the user@domain part, nothing else.
988
This part is required to contain only ascii characters.
989
If it can't be extracted, raises an error.
991
>>> extract_email_address('Jane Tester <jane@test.com>')
994
name, email = parse_username(e)
996
raise errors.NoEmailInUsername(e)
1000
class TreeConfig(IniBasedConfig):
1001
"""Branch configuration data associated with its contents, not location"""
1003
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1005
def __init__(self, branch):
1006
self._config = branch._get_config()
1007
self.branch = branch
1009
def _get_parser(self, file=None):
1010
if file is not None:
1011
return IniBasedConfig._get_parser(file)
1012
return self._config._get_configobj()
1014
def get_option(self, name, section=None, default=None):
1015
self.branch.lock_read()
1017
return self._config.get_option(name, section, default)
1019
self.branch.unlock()
1021
def set_option(self, value, name, section=None):
1022
"""Set a per-branch configuration option"""
1023
self.branch.lock_write()
1025
self._config.set_option(value, name, section)
1027
self.branch.unlock()
1030
class AuthenticationConfig(object):
1031
"""The authentication configuration file based on a ini file.
1033
Implements the authentication.conf file described in
1034
doc/developers/authentication-ring.txt.
1037
def __init__(self, _file=None):
1038
self._config = None # The ConfigObj
1040
self._filename = authentication_config_filename()
1041
self._input = self._filename = authentication_config_filename()
1043
# Tests can provide a string as _file
1044
self._filename = None
1047
def _get_config(self):
1048
if self._config is not None:
1051
# FIXME: Should we validate something here ? Includes: empty
1052
# sections are useless, at least one of
1053
# user/password/password_encoding should be defined, etc.
1055
# Note: the encoding below declares that the file itself is utf-8
1056
# encoded, but the values in the ConfigObj are always Unicode.
1057
self._config = ConfigObj(self._input, encoding='utf-8')
1058
except configobj.ConfigObjError, e:
1059
raise errors.ParseConfigError(e.errors, e.config.filename)
1063
"""Save the config file, only tests should use it for now."""
1064
conf_dir = os.path.dirname(self._filename)
1065
ensure_config_dir_exists(conf_dir)
1066
self._get_config().write(file(self._filename, 'wb'))
1068
def _set_option(self, section_name, option_name, value):
1069
"""Set an authentication configuration option"""
1070
conf = self._get_config()
1071
section = conf.get(section_name)
1074
section = conf[section]
1075
section[option_name] = value
1078
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1080
"""Returns the matching credentials from authentication.conf file.
1082
:param scheme: protocol
1084
:param host: the server address
1086
:param port: the associated port (optional)
1088
:param user: login (optional)
1090
:param path: the absolute path on the server (optional)
1092
:param realm: the http authentication realm (optional)
1094
:return: A dict containing the matching credentials or None.
1096
- name: the section name of the credentials in the
1097
authentication.conf file,
1098
- user: can't be different from the provided user if any,
1099
- scheme: the server protocol,
1100
- host: the server address,
1101
- port: the server port (can be None),
1102
- path: the absolute server path (can be None),
1103
- realm: the http specific authentication realm (can be None),
1104
- password: the decoded password, could be None if the credential
1105
defines only the user
1106
- verify_certificates: https specific, True if the server
1107
certificate should be verified, False otherwise.
1110
for auth_def_name, auth_def in self._get_config().items():
1111
if type(auth_def) is not configobj.Section:
1112
raise ValueError("%s defined outside a section" % auth_def_name)
1114
a_scheme, a_host, a_user, a_path = map(
1115
auth_def.get, ['scheme', 'host', 'user', 'path'])
1118
a_port = auth_def.as_int('port')
1122
raise ValueError("'port' not numeric in %s" % auth_def_name)
1124
a_verify_certificates = auth_def.as_bool('verify_certificates')
1126
a_verify_certificates = True
1129
"'verify_certificates' not boolean in %s" % auth_def_name)
1132
if a_scheme is not None and scheme != a_scheme:
1134
if a_host is not None:
1135
if not (host == a_host
1136
or (a_host.startswith('.') and host.endswith(a_host))):
1138
if a_port is not None and port != a_port:
1140
if (a_path is not None and path is not None
1141
and not path.startswith(a_path)):
1143
if (a_user is not None and user is not None
1144
and a_user != user):
1145
# Never contradict the caller about the user to be used
1150
# Prepare a credentials dictionary with additional keys
1151
# for the credential providers
1152
credentials = dict(name=auth_def_name,
1159
password=auth_def.get('password', None),
1160
verify_certificates=a_verify_certificates)
1161
# Decode the password in the credentials (or get one)
1162
self.decode_password(credentials,
1163
auth_def.get('password_encoding', None))
1164
if 'auth' in debug.debug_flags:
1165
trace.mutter("Using authentication section: %r", auth_def_name)
1168
if credentials is None:
1169
# No credentials were found in authentication.conf, try the fallback
1170
# credentials stores.
1171
credentials = credential_store_registry.get_fallback_credentials(
1172
scheme, host, port, user, path, realm)
1176
def set_credentials(self, name, host, user, scheme=None, password=None,
1177
port=None, path=None, verify_certificates=None,
1179
"""Set authentication credentials for a host.
1181
Any existing credentials with matching scheme, host, port and path
1182
will be deleted, regardless of name.
1184
:param name: An arbitrary name to describe this set of credentials.
1185
:param host: Name of the host that accepts these credentials.
1186
:param user: The username portion of these credentials.
1187
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1189
:param password: Password portion of these credentials.
1190
:param port: The IP port on the host that these credentials apply to.
1191
:param path: A filesystem path on the host that these credentials
1193
:param verify_certificates: On https, verify server certificates if
1195
:param realm: The http authentication realm (optional).
1197
values = {'host': host, 'user': user}
1198
if password is not None:
1199
values['password'] = password
1200
if scheme is not None:
1201
values['scheme'] = scheme
1202
if port is not None:
1203
values['port'] = '%d' % port
1204
if path is not None:
1205
values['path'] = path
1206
if verify_certificates is not None:
1207
values['verify_certificates'] = str(verify_certificates)
1208
if realm is not None:
1209
values['realm'] = realm
1210
config = self._get_config()
1212
for section, existing_values in config.items():
1213
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1214
if existing_values.get(key) != values.get(key):
1218
config.update({name: values})
1221
def get_user(self, scheme, host, port=None, realm=None, path=None,
1222
prompt=None, ask=False, default=None):
1223
"""Get a user from authentication file.
1225
:param scheme: protocol
1227
:param host: the server address
1229
:param port: the associated port (optional)
1231
:param realm: the realm sent by the server (optional)
1233
:param path: the absolute path on the server (optional)
1235
:param ask: Ask the user if there is no explicitly configured username
1238
:param default: The username returned if none is defined (optional).
1240
:return: The found user.
1242
credentials = self.get_credentials(scheme, host, port, user=None,
1243
path=path, realm=realm)
1244
if credentials is not None:
1245
user = credentials['user']
1251
# Create a default prompt suitable for most cases
1252
prompt = scheme.upper() + ' %(host)s username'
1253
# Special handling for optional fields in the prompt
1254
if port is not None:
1255
prompt_host = '%s:%d' % (host, port)
1258
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1263
def get_password(self, scheme, host, user, port=None,
1264
realm=None, path=None, prompt=None):
1265
"""Get a password from authentication file or prompt the user for one.
1267
:param scheme: protocol
1269
:param host: the server address
1271
:param port: the associated port (optional)
1275
:param realm: the realm sent by the server (optional)
1277
:param path: the absolute path on the server (optional)
1279
:return: The found password or the one entered by the user.
1281
credentials = self.get_credentials(scheme, host, port, user, path,
1283
if credentials is not None:
1284
password = credentials['password']
1285
if password is not None and scheme is 'ssh':
1286
trace.warning('password ignored in section [%s],'
1287
' use an ssh agent instead'
1288
% credentials['name'])
1292
# Prompt user only if we could't find a password
1293
if password is None:
1295
# Create a default prompt suitable for most cases
1296
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
1297
# Special handling for optional fields in the prompt
1298
if port is not None:
1299
prompt_host = '%s:%d' % (host, port)
1302
password = ui.ui_factory.get_password(prompt,
1303
host=prompt_host, user=user)
1306
def decode_password(self, credentials, encoding):
1308
cs = credential_store_registry.get_credential_store(encoding)
1310
raise ValueError('%r is not a known password_encoding' % encoding)
1311
credentials['password'] = cs.decode_password(credentials)
1315
class CredentialStoreRegistry(registry.Registry):
1316
"""A class that registers credential stores.
1318
A credential store provides access to credentials via the password_encoding
1319
field in authentication.conf sections.
1321
Except for stores provided by bzr itself, most stores are expected to be
1322
provided by plugins that will therefore use
1323
register_lazy(password_encoding, module_name, member_name, help=help,
1324
fallback=fallback) to install themselves.
1326
A fallback credential store is one that is queried if no credentials can be
1327
found via authentication.conf.
1330
def get_credential_store(self, encoding=None):
1331
cs = self.get(encoding)
1336
def is_fallback(self, name):
1337
"""Check if the named credentials store should be used as fallback."""
1338
return self.get_info(name)
1340
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1341
path=None, realm=None):
1342
"""Request credentials from all fallback credentials stores.
1344
The first credentials store that can provide credentials wins.
1347
for name in self.keys():
1348
if not self.is_fallback(name):
1350
cs = self.get_credential_store(name)
1351
credentials = cs.get_credentials(scheme, host, port, user,
1353
if credentials is not None:
1354
# We found some credentials
1358
def register(self, key, obj, help=None, override_existing=False,
1360
"""Register a new object to a name.
1362
:param key: This is the key to use to request the object later.
1363
:param obj: The object to register.
1364
:param help: Help text for this entry. This may be a string or
1365
a callable. If it is a callable, it should take two
1366
parameters (registry, key): this registry and the key that
1367
the help was registered under.
1368
:param override_existing: Raise KeyErorr if False and something has
1369
already been registered for that key. If True, ignore if there
1370
is an existing key (always register the new value).
1371
:param fallback: Whether this credential store should be
1374
return super(CredentialStoreRegistry,
1375
self).register(key, obj, help, info=fallback,
1376
override_existing=override_existing)
1378
def register_lazy(self, key, module_name, member_name,
1379
help=None, override_existing=False,
1381
"""Register a new credential store to be loaded on request.
1383
:param module_name: The python path to the module. Such as 'os.path'.
1384
:param member_name: The member of the module to return. If empty or
1385
None, get() will return the module itself.
1386
:param help: Help text for this entry. This may be a string or
1388
:param override_existing: If True, replace the existing object
1389
with the new one. If False, if there is already something
1390
registered with the same key, raise a KeyError
1391
:param fallback: Whether this credential store should be
1394
return super(CredentialStoreRegistry, self).register_lazy(
1395
key, module_name, member_name, help,
1396
info=fallback, override_existing=override_existing)
1399
credential_store_registry = CredentialStoreRegistry()
1402
class CredentialStore(object):
1403
"""An abstract class to implement storage for credentials"""
1405
def decode_password(self, credentials):
1406
"""Returns a clear text password for the provided credentials."""
1407
raise NotImplementedError(self.decode_password)
1409
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1411
"""Return the matching credentials from this credential store.
1413
This method is only called on fallback credential stores.
1415
raise NotImplementedError(self.get_credentials)
1419
class PlainTextCredentialStore(CredentialStore):
1420
__doc__ = """Plain text credential store for the authentication.conf file"""
1422
def decode_password(self, credentials):
1423
"""See CredentialStore.decode_password."""
1424
return credentials['password']
1427
credential_store_registry.register('plain', PlainTextCredentialStore,
1428
help=PlainTextCredentialStore.__doc__)
1429
credential_store_registry.default_key = 'plain'
1432
class BzrDirConfig(object):
1434
def __init__(self, bzrdir):
1435
self._bzrdir = bzrdir
1436
self._config = bzrdir._get_config()
1438
def set_default_stack_on(self, value):
1439
"""Set the default stacking location.
1441
It may be set to a location, or None.
1443
This policy affects all branches contained by this bzrdir, except for
1444
those under repositories.
1446
if self._config is None:
1447
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
1449
self._config.set_option('', 'default_stack_on')
1451
self._config.set_option(value, 'default_stack_on')
1453
def get_default_stack_on(self):
1454
"""Return the default stacking location.
1456
This will either be a location, or None.
1458
This policy affects all branches contained by this bzrdir, except for
1459
those under repositories.
1461
if self._config is None:
1463
value = self._config.get_option('default_stack_on')
1469
class TransportConfig(object):
1470
"""A Config that reads/writes a config file on a Transport.
1472
It is a low-level object that considers config data to be name/value pairs
1473
that may be associated with a section. Assigning meaning to the these
1474
values is done at higher levels like TreeConfig.
1477
def __init__(self, transport, filename):
1478
self._transport = transport
1479
self._filename = filename
1481
def get_option(self, name, section=None, default=None):
1482
"""Return the value associated with a named option.
1484
:param name: The name of the value
1485
:param section: The section the option is in (if any)
1486
:param default: The value to return if the value is not set
1487
:return: The value or default value
1489
configobj = self._get_configobj()
1491
section_obj = configobj
1494
section_obj = configobj[section]
1497
return section_obj.get(name, default)
1499
def set_option(self, value, name, section=None):
1500
"""Set the value associated with a named option.
1502
:param value: The value to set
1503
:param name: The name of the value to set
1504
:param section: The section the option is in (if any)
1506
configobj = self._get_configobj()
1508
configobj[name] = value
1510
configobj.setdefault(section, {})[name] = value
1511
self._set_configobj(configobj)
1513
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
1516
except errors.NoSuchFile:
1519
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
1522
def _set_configobj(self, configobj):
1523
out_file = StringIO()
1524
configobj.write(out_file)
1526
self._transport.put_file(self._filename, out_file)
added
removed
bzrlib/config.py
