1
# Copyright (C) 2005-2011 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
32
validate_signatures_in_log=true|false(default)
33
acceptable_keys=pattern1,pattern2
34
gpg_signing_key=amy@example.com
36
in locations.conf, you specify the url of a branch and options for it.
37
Wildcards may be used - * and ? as normal in shell completion. Options
38
set in both bazaar.conf and locations.conf are overridden by the locations.conf
40
[/home/robertc/source]
41
recurse=False|True(default)
43
check_signatures= as above
44
create_signatures= as above.
45
validate_signatures_in_log=as above
46
acceptable_keys=as above
48
explanation of options
49
----------------------
50
editor - this option sets the pop up editor to use during commits.
51
email - this option sets the user id bzr will use when committing.
52
check_signatures - this option will control whether bzr will require good gpg
53
signatures, ignore them, or check them if they are
54
present. Currently it is unused except that check_signatures
55
turns on create_signatures.
56
create_signatures - this option controls whether bzr will always create
57
gpg signatures or not on commits. There is an unused
58
option which in future is expected to work if
59
branch settings require signatures.
60
log_format - this option sets the default log format. Possible values are
61
long, short, line, or a plugin can register new formats.
62
validate_signatures_in_log - show GPG signature validity in log output
63
acceptable_keys - comma separated list of key patterns acceptable for
64
verify-signatures command
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
69
lastlog=log --line -r-10..-1
70
ll=log --line -r-10..-1
81
from bzrlib.decorators import needs_write_lock
82
from bzrlib.lazy_import import lazy_import
83
lazy_import(globals(), """
86
from cStringIO import StringIO
106
from bzrlib.i18n import gettext
107
from bzrlib.util.configobj import configobj
115
from bzrlib.symbol_versioning import (
133
POLICY_APPENDPATH = 2
137
POLICY_NORECURSE: 'norecurse',
138
POLICY_APPENDPATH: 'appendpath',
143
'norecurse': POLICY_NORECURSE,
144
'appendpath': POLICY_APPENDPATH,
148
STORE_LOCATION = POLICY_NONE
149
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
150
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
155
class ConfigObj(configobj.ConfigObj):
157
def __init__(self, infile=None, **kwargs):
158
# We define our own interpolation mechanism calling it option expansion
159
super(ConfigObj, self).__init__(infile=infile,
163
def get_bool(self, section, key):
164
return self[section].as_bool(key)
166
def get_value(self, section, name):
167
# Try [] for the old DEFAULT section.
168
if section == "DEFAULT":
173
return self[section][name]
176
# FIXME: Until we can guarantee that each config file is loaded once and
177
# only once for a given bzrlib session, we don't want to re-read the file every
178
# time we query for an option so we cache the value (bad ! watch out for tests
179
# needing to restore the proper value). -- vila 20110219
180
_expand_default_value = None
181
def _get_expand_default_value():
182
global _expand_default_value
183
if _expand_default_value is not None:
184
return _expand_default_value
185
conf = GlobalConfig()
186
# Note that we must not use None for the expand value below or we'll run
187
# into infinite recursion. Using False really would be quite silly ;)
188
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
190
# This is an opt-in feature, you *really* need to clearly say you want
193
_expand_default_value = expand
197
class Config(object):
198
"""A configuration policy - what username, editor, gpg needs etc."""
201
super(Config, self).__init__()
204
"""Returns a unique ID for the config."""
205
raise NotImplementedError(self.config_id)
207
@deprecated_method(deprecated_in((2, 4, 0)))
208
def get_editor(self):
209
"""Get the users pop up editor."""
210
raise NotImplementedError
212
def get_change_editor(self, old_tree, new_tree):
213
from bzrlib import diff
214
cmd = self._get_change_editor()
217
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
220
def get_mail_client(self):
221
"""Get a mail client to use"""
222
selected_client = self.get_user_option('mail_client')
223
_registry = mail_client.mail_client_registry
225
mail_client_class = _registry.get(selected_client)
227
raise errors.UnknownMailClient(selected_client)
228
return mail_client_class(self)
230
def _get_signature_checking(self):
231
"""Template method to override signature checking policy."""
233
def _get_signing_policy(self):
234
"""Template method to override signature creation policy."""
238
def expand_options(self, string, env=None):
239
"""Expand option references in the string in the configuration context.
241
:param string: The string containing option to expand.
243
:param env: An option dict defining additional configuration options or
244
overriding existing ones.
246
:returns: The expanded string.
248
return self._expand_options_in_string(string, env)
250
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
251
"""Expand options in a list of strings in the configuration context.
253
:param slist: A list of strings.
255
:param env: An option dict defining additional configuration options or
256
overriding existing ones.
258
:param _ref_stack: Private list containing the options being
259
expanded to detect loops.
261
:returns: The flatten list of expanded strings.
263
# expand options in each value separately flattening lists
266
value = self._expand_options_in_string(s, env, _ref_stack)
267
if isinstance(value, list):
273
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
274
"""Expand options in the string in the configuration context.
276
:param string: The string to be expanded.
278
:param env: An option dict defining additional configuration options or
279
overriding existing ones.
281
:param _ref_stack: Private list containing the options being
282
expanded to detect loops.
284
:returns: The expanded string.
287
# Not much to expand there
289
if _ref_stack is None:
290
# What references are currently resolved (to detect loops)
292
if self.option_ref_re is None:
293
# We want to match the most embedded reference first (i.e. for
294
# '{{foo}}' we will get '{foo}',
295
# for '{bar{baz}}' we will get '{baz}'
296
self.option_ref_re = re.compile('({[^{}]+})')
298
# We need to iterate until no more refs appear ({{foo}} will need two
299
# iterations for example).
301
raw_chunks = self.option_ref_re.split(result)
302
if len(raw_chunks) == 1:
303
# Shorcut the trivial case: no refs
307
# Split will isolate refs so that every other chunk is a ref
309
for chunk in raw_chunks:
312
# Keep only non-empty strings (or we get bogus empty
313
# slots when a list value is involved).
318
if name in _ref_stack:
319
raise errors.OptionExpansionLoop(string, _ref_stack)
320
_ref_stack.append(name)
321
value = self._expand_option(name, env, _ref_stack)
323
raise errors.ExpandingUnknownOption(name, string)
324
if isinstance(value, list):
332
# Once a list appears as the result of an expansion, all
333
# callers will get a list result. This allows a consistent
334
# behavior even when some options in the expansion chain
335
# defined as strings (no comma in their value) but their
336
# expanded value is a list.
337
return self._expand_options_in_list(chunks, env, _ref_stack)
339
result = ''.join(chunks)
342
def _expand_option(self, name, env, _ref_stack):
343
if env is not None and name in env:
344
# Special case, values provided in env takes precedence over
348
# FIXME: This is a limited implementation, what we really need is a
349
# way to query the bzr config for the value of an option,
350
# respecting the scope rules (That is, once we implement fallback
351
# configs, getting the option value should restart from the top
352
# config, not the current one) -- vila 20101222
353
value = self.get_user_option(name, expand=False)
354
if isinstance(value, list):
355
value = self._expand_options_in_list(value, env, _ref_stack)
357
value = self._expand_options_in_string(value, env, _ref_stack)
360
def _get_user_option(self, option_name):
361
"""Template method to provide a user option."""
364
def get_user_option(self, option_name, expand=None):
365
"""Get a generic option - no special process, no default.
367
:param option_name: The queried option.
369
:param expand: Whether options references should be expanded.
371
:returns: The value of the option.
374
expand = _get_expand_default_value()
375
value = self._get_user_option(option_name)
377
if isinstance(value, list):
378
value = self._expand_options_in_list(value)
379
elif isinstance(value, dict):
380
trace.warning('Cannot expand "%s":'
381
' Dicts do not support option expansion'
384
value = self._expand_options_in_string(value)
385
for hook in OldConfigHooks['get']:
386
hook(self, option_name, value)
389
def get_user_option_as_bool(self, option_name, expand=None, default=None):
390
"""Get a generic option as a boolean.
392
:param expand: Allow expanding references to other config values.
393
:param default: Default value if nothing is configured
394
:return None if the option doesn't exist or its value can't be
395
interpreted as a boolean. Returns True or False otherwise.
397
s = self.get_user_option(option_name, expand=expand)
399
# The option doesn't exist
401
val = ui.bool_from_string(s)
403
# The value can't be interpreted as a boolean
404
trace.warning('Value "%s" is not a boolean for "%s"',
408
def get_user_option_as_list(self, option_name, expand=None):
409
"""Get a generic option as a list - no special process, no default.
411
:return None if the option doesn't exist. Returns the value as a list
414
l = self.get_user_option(option_name, expand=expand)
415
if isinstance(l, (str, unicode)):
416
# A single value, most probably the user forgot (or didn't care to
421
def get_user_option_as_int_from_SI(self, option_name, default=None):
422
"""Get a generic option from a human readable size in SI units, e.g 10MB
424
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
425
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
428
:return Integer, expanded to its base-10 value if a proper SI unit is
429
found. If the option doesn't exist, or isn't a value in
430
SI units, return default (which defaults to None)
432
val = self.get_user_option(option_name)
433
if isinstance(val, list):
438
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
442
val = int(m.group(1))
443
if m.group(2) is not None:
444
if m.group(2).lower() == 'k':
446
elif m.group(2).lower() == 'm':
448
elif m.group(2).lower() == 'g':
451
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
452
' value {1!r} is not an SI unit.').format(
460
def gpg_signing_command(self):
461
"""What program should be used to sign signatures?"""
462
result = self._gpg_signing_command()
467
def _gpg_signing_command(self):
468
"""See gpg_signing_command()."""
471
def log_format(self):
472
"""What log format should be used"""
473
result = self._log_format()
478
def _log_format(self):
479
"""See log_format()."""
482
def validate_signatures_in_log(self):
483
"""Show GPG signature validity in log"""
484
result = self._validate_signatures_in_log()
491
def _validate_signatures_in_log(self):
492
"""See validate_signatures_in_log()."""
495
def acceptable_keys(self):
496
"""Comma separated list of key patterns acceptable to
497
verify-signatures command"""
498
result = self._acceptable_keys()
501
def _acceptable_keys(self):
502
"""See acceptable_keys()."""
505
def post_commit(self):
506
"""An ordered list of python functions to call.
508
Each function takes branch, rev_id as parameters.
510
return self._post_commit()
512
def _post_commit(self):
513
"""See Config.post_commit."""
516
def user_email(self):
517
"""Return just the email component of a username."""
518
return extract_email_address(self.username())
521
"""Return email-style username.
523
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
525
$BZR_EMAIL can be set to override this, then
526
the concrete policy type is checked, and finally
528
If no username can be found, errors.NoWhoami exception is raised.
530
v = os.environ.get('BZR_EMAIL')
532
return v.decode(osutils.get_user_encoding())
533
v = self._get_user_id()
536
v = os.environ.get('EMAIL')
538
return v.decode(osutils.get_user_encoding())
539
name, email = _auto_user_id()
541
return '%s <%s>' % (name, email)
544
raise errors.NoWhoami()
546
def ensure_username(self):
547
"""Raise errors.NoWhoami if username is not set.
549
This method relies on the username() function raising the error.
553
def signature_checking(self):
554
"""What is the current policy for signature checking?."""
555
policy = self._get_signature_checking()
556
if policy is not None:
558
return CHECK_IF_POSSIBLE
560
def signing_policy(self):
561
"""What is the current policy for signature checking?."""
562
policy = self._get_signing_policy()
563
if policy is not None:
565
return SIGN_WHEN_REQUIRED
567
def signature_needed(self):
568
"""Is a signature needed when committing ?."""
569
policy = self._get_signing_policy()
571
policy = self._get_signature_checking()
572
if policy is not None:
573
#this warning should go away once check_signatures is
574
#implemented (if not before)
575
trace.warning("Please use create_signatures,"
576
" not check_signatures to set signing policy.")
577
elif policy == SIGN_ALWAYS:
581
def gpg_signing_key(self):
582
"""GPG user-id to sign commits"""
583
key = self.get_user_option('gpg_signing_key')
584
if key == "default" or key == None:
585
return self.user_email()
589
def get_alias(self, value):
590
return self._get_alias(value)
592
def _get_alias(self, value):
595
def get_nickname(self):
596
return self._get_nickname()
598
def _get_nickname(self):
601
def get_bzr_remote_path(self):
603
return os.environ['BZR_REMOTE_PATH']
605
path = self.get_user_option("bzr_remote_path")
610
def suppress_warning(self, warning):
611
"""Should the warning be suppressed or emitted.
613
:param warning: The name of the warning being tested.
615
:returns: True if the warning should be suppressed, False otherwise.
617
warnings = self.get_user_option_as_list('suppress_warnings')
618
if warnings is None or warning not in warnings:
623
def get_merge_tools(self):
625
for (oname, value, section, conf_id, parser) in self._get_options():
626
if oname.startswith('bzr.mergetool.'):
627
tool_name = oname[len('bzr.mergetool.'):]
628
tools[tool_name] = self.get_user_option(oname)
629
trace.mutter('loaded merge tools: %r' % tools)
632
def find_merge_tool(self, name):
633
# We fake a defaults mechanism here by checking if the given name can
634
# be found in the known_merge_tools if it's not found in the config.
635
# This should be done through the proposed config defaults mechanism
636
# when it becomes available in the future.
637
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
639
or mergetools.known_merge_tools.get(name, None))
643
class _ConfigHooks(hooks.Hooks):
644
"""A dict mapping hook names and a list of callables for configs.
648
"""Create the default hooks.
650
These are all empty initially, because by default nothing should get
653
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
654
self.add_hook('load',
655
'Invoked when a config store is loaded.'
656
' The signature is (store).',
658
self.add_hook('save',
659
'Invoked when a config store is saved.'
660
' The signature is (store).',
662
# The hooks for config options
664
'Invoked when a config option is read.'
665
' The signature is (stack, name, value).',
668
'Invoked when a config option is set.'
669
' The signature is (stack, name, value).',
671
self.add_hook('remove',
672
'Invoked when a config option is removed.'
673
' The signature is (stack, name).',
675
ConfigHooks = _ConfigHooks()
678
class _OldConfigHooks(hooks.Hooks):
679
"""A dict mapping hook names and a list of callables for configs.
683
"""Create the default hooks.
685
These are all empty initially, because by default nothing should get
688
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
689
self.add_hook('load',
690
'Invoked when a config store is loaded.'
691
' The signature is (config).',
693
self.add_hook('save',
694
'Invoked when a config store is saved.'
695
' The signature is (config).',
697
# The hooks for config options
699
'Invoked when a config option is read.'
700
' The signature is (config, name, value).',
703
'Invoked when a config option is set.'
704
' The signature is (config, name, value).',
706
self.add_hook('remove',
707
'Invoked when a config option is removed.'
708
' The signature is (config, name).',
710
OldConfigHooks = _OldConfigHooks()
713
class IniBasedConfig(Config):
714
"""A configuration policy that draws from ini files."""
716
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
718
"""Base class for configuration files using an ini-like syntax.
720
:param file_name: The configuration file path.
722
super(IniBasedConfig, self).__init__()
723
self.file_name = file_name
724
if symbol_versioning.deprecated_passed(get_filename):
725
symbol_versioning.warn(
726
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
727
' Use file_name instead.',
730
if get_filename is not None:
731
self.file_name = get_filename()
733
self.file_name = file_name
738
def from_string(cls, str_or_unicode, file_name=None, save=False):
739
"""Create a config object from a string.
741
:param str_or_unicode: A string representing the file content. This will
744
:param file_name: The configuration file path.
746
:param _save: Whether the file should be saved upon creation.
748
conf = cls(file_name=file_name)
749
conf._create_from_string(str_or_unicode, save)
752
def _create_from_string(self, str_or_unicode, save):
753
self._content = StringIO(str_or_unicode.encode('utf-8'))
754
# Some tests use in-memory configs, some other always need the config
755
# file to exist on disk.
757
self._write_config_file()
759
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
760
if self._parser is not None:
762
if symbol_versioning.deprecated_passed(file):
763
symbol_versioning.warn(
764
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
765
' Use IniBasedConfig(_content=xxx) instead.',
768
if self._content is not None:
769
co_input = self._content
770
elif self.file_name is None:
771
raise AssertionError('We have no content to create the config')
773
co_input = self.file_name
775
self._parser = ConfigObj(co_input, encoding='utf-8')
776
except configobj.ConfigObjError, e:
777
raise errors.ParseConfigError(e.errors, e.config.filename)
778
except UnicodeDecodeError:
779
raise errors.ConfigContentError(self.file_name)
780
# Make sure self.reload() will use the right file name
781
self._parser.filename = self.file_name
782
for hook in OldConfigHooks['load']:
787
"""Reload the config file from disk."""
788
if self.file_name is None:
789
raise AssertionError('We need a file name to reload the config')
790
if self._parser is not None:
791
self._parser.reload()
792
for hook in ConfigHooks['load']:
795
def _get_matching_sections(self):
796
"""Return an ordered list of (section_name, extra_path) pairs.
798
If the section contains inherited configuration, extra_path is
799
a string containing the additional path components.
801
section = self._get_section()
802
if section is not None:
803
return [(section, '')]
807
def _get_section(self):
808
"""Override this to define the section used by the config."""
811
def _get_sections(self, name=None):
812
"""Returns an iterator of the sections specified by ``name``.
814
:param name: The section name. If None is supplied, the default
815
configurations are yielded.
817
:return: A tuple (name, section, config_id) for all sections that will
818
be walked by user_get_option() in the 'right' order. The first one
819
is where set_user_option() will update the value.
821
parser = self._get_parser()
823
yield (name, parser[name], self.config_id())
825
# No section name has been given so we fallback to the configobj
826
# itself which holds the variables defined outside of any section.
827
yield (None, parser, self.config_id())
829
def _get_options(self, sections=None):
830
"""Return an ordered list of (name, value, section, config_id) tuples.
832
All options are returned with their associated value and the section
833
they appeared in. ``config_id`` is a unique identifier for the
834
configuration file the option is defined in.
836
:param sections: Default to ``_get_matching_sections`` if not
837
specified. This gives a better control to daughter classes about
838
which sections should be searched. This is a list of (name,
843
parser = self._get_parser()
845
for (section_name, _) in self._get_matching_sections():
847
section = parser[section_name]
849
# This could happen for an empty file for which we define a
850
# DEFAULT section. FIXME: Force callers to provide sections
851
# instead ? -- vila 20100930
853
sections.append((section_name, section))
854
config_id = self.config_id()
855
for (section_name, section) in sections:
856
for (name, value) in section.iteritems():
857
yield (name, parser._quote(value), section_name,
860
def _get_option_policy(self, section, option_name):
861
"""Return the policy for the given (section, option_name) pair."""
864
def _get_change_editor(self):
865
return self.get_user_option('change_editor')
867
def _get_signature_checking(self):
868
"""See Config._get_signature_checking."""
869
policy = self._get_user_option('check_signatures')
871
return self._string_to_signature_policy(policy)
873
def _get_signing_policy(self):
874
"""See Config._get_signing_policy"""
875
policy = self._get_user_option('create_signatures')
877
return self._string_to_signing_policy(policy)
879
def _get_user_id(self):
880
"""Get the user id from the 'email' key in the current section."""
881
return self._get_user_option('email')
883
def _get_user_option(self, option_name):
884
"""See Config._get_user_option."""
885
for (section, extra_path) in self._get_matching_sections():
887
value = self._get_parser().get_value(section, option_name)
890
policy = self._get_option_policy(section, option_name)
891
if policy == POLICY_NONE:
893
elif policy == POLICY_NORECURSE:
894
# norecurse items only apply to the exact path
899
elif policy == POLICY_APPENDPATH:
901
value = urlutils.join(value, extra_path)
904
raise AssertionError('Unexpected config policy %r' % policy)
908
def _gpg_signing_command(self):
909
"""See Config.gpg_signing_command."""
910
return self._get_user_option('gpg_signing_command')
912
def _log_format(self):
913
"""See Config.log_format."""
914
return self._get_user_option('log_format')
916
def _validate_signatures_in_log(self):
917
"""See Config.validate_signatures_in_log."""
918
return self._get_user_option('validate_signatures_in_log')
920
def _acceptable_keys(self):
921
"""See Config.acceptable_keys."""
922
return self._get_user_option('acceptable_keys')
924
def _post_commit(self):
925
"""See Config.post_commit."""
926
return self._get_user_option('post_commit')
928
def _string_to_signature_policy(self, signature_string):
929
"""Convert a string to a signing policy."""
930
if signature_string.lower() == 'check-available':
931
return CHECK_IF_POSSIBLE
932
if signature_string.lower() == 'ignore':
934
if signature_string.lower() == 'require':
936
raise errors.BzrError("Invalid signatures policy '%s'"
939
def _string_to_signing_policy(self, signature_string):
940
"""Convert a string to a signing policy."""
941
if signature_string.lower() == 'when-required':
942
return SIGN_WHEN_REQUIRED
943
if signature_string.lower() == 'never':
945
if signature_string.lower() == 'always':
947
raise errors.BzrError("Invalid signing policy '%s'"
950
def _get_alias(self, value):
952
return self._get_parser().get_value("ALIASES",
957
def _get_nickname(self):
958
return self.get_user_option('nickname')
960
def remove_user_option(self, option_name, section_name=None):
961
"""Remove a user option and save the configuration file.
963
:param option_name: The option to be removed.
965
:param section_name: The section the option is defined in, default to
969
parser = self._get_parser()
970
if section_name is None:
973
section = parser[section_name]
975
del section[option_name]
977
raise errors.NoSuchConfigOption(option_name)
978
self._write_config_file()
979
for hook in OldConfigHooks['remove']:
980
hook(self, option_name)
982
def _write_config_file(self):
983
if self.file_name is None:
984
raise AssertionError('We cannot save, self.file_name is None')
985
conf_dir = os.path.dirname(self.file_name)
986
ensure_config_dir_exists(conf_dir)
987
atomic_file = atomicfile.AtomicFile(self.file_name)
988
self._get_parser().write(atomic_file)
991
osutils.copy_ownership_from_path(self.file_name)
992
for hook in OldConfigHooks['save']:
996
class LockableConfig(IniBasedConfig):
997
"""A configuration needing explicit locking for access.
999
If several processes try to write the config file, the accesses need to be
1002
Daughter classes should decorate all methods that update a config with the
1003
``@needs_write_lock`` decorator (they call, directly or indirectly, the
1004
``_write_config_file()`` method. These methods (typically ``set_option()``
1005
and variants must reload the config file from disk before calling
1006
``_write_config_file()``), this can be achieved by calling the
1007
``self.reload()`` method. Note that the lock scope should cover both the
1008
reading and the writing of the config file which is why the decorator can't
1009
be applied to ``_write_config_file()`` only.
1011
This should be enough to implement the following logic:
1012
- lock for exclusive write access,
1013
- reload the config file from disk,
1017
This logic guarantees that a writer can update a value without erasing an
1018
update made by another writer.
1023
def __init__(self, file_name):
1024
super(LockableConfig, self).__init__(file_name=file_name)
1025
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1026
# FIXME: It doesn't matter that we don't provide possible_transports
1027
# below since this is currently used only for local config files ;
1028
# local transports are not shared. But if/when we start using
1029
# LockableConfig for other kind of transports, we will need to reuse
1030
# whatever connection is already established -- vila 20100929
1031
self.transport = transport.get_transport_from_path(self.dir)
1032
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1034
def _create_from_string(self, unicode_bytes, save):
1035
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1037
# We need to handle the saving here (as opposed to IniBasedConfig)
1038
# to be able to lock
1040
self._write_config_file()
1043
def lock_write(self, token=None):
1044
"""Takes a write lock in the directory containing the config file.
1046
If the directory doesn't exist it is created.
1048
ensure_config_dir_exists(self.dir)
1049
return self._lock.lock_write(token)
1054
def break_lock(self):
1055
self._lock.break_lock()
1058
def remove_user_option(self, option_name, section_name=None):
1059
super(LockableConfig, self).remove_user_option(option_name,
1062
def _write_config_file(self):
1063
if self._lock is None or not self._lock.is_held:
1064
# NB: if the following exception is raised it probably means a
1065
# missing @needs_write_lock decorator on one of the callers.
1066
raise errors.ObjectNotLocked(self)
1067
super(LockableConfig, self)._write_config_file()
1070
class GlobalConfig(LockableConfig):
1071
"""The configuration that should be used for a specific location."""
1074
super(GlobalConfig, self).__init__(file_name=config_filename())
1076
def config_id(self):
1080
def from_string(cls, str_or_unicode, save=False):
1081
"""Create a config object from a string.
1083
:param str_or_unicode: A string representing the file content. This
1084
will be utf-8 encoded.
1086
:param save: Whether the file should be saved upon creation.
1089
conf._create_from_string(str_or_unicode, save)
1092
@deprecated_method(deprecated_in((2, 4, 0)))
1093
def get_editor(self):
1094
return self._get_user_option('editor')
1097
def set_user_option(self, option, value):
1098
"""Save option and its value in the configuration."""
1099
self._set_option(option, value, 'DEFAULT')
1101
def get_aliases(self):
1102
"""Return the aliases section."""
1103
if 'ALIASES' in self._get_parser():
1104
return self._get_parser()['ALIASES']
1109
def set_alias(self, alias_name, alias_command):
1110
"""Save the alias in the configuration."""
1111
self._set_option(alias_name, alias_command, 'ALIASES')
1114
def unset_alias(self, alias_name):
1115
"""Unset an existing alias."""
1117
aliases = self._get_parser().get('ALIASES')
1118
if not aliases or alias_name not in aliases:
1119
raise errors.NoSuchAlias(alias_name)
1120
del aliases[alias_name]
1121
self._write_config_file()
1123
def _set_option(self, option, value, section):
1125
self._get_parser().setdefault(section, {})[option] = value
1126
self._write_config_file()
1127
for hook in OldConfigHooks['set']:
1128
hook(self, option, value)
1130
def _get_sections(self, name=None):
1131
"""See IniBasedConfig._get_sections()."""
1132
parser = self._get_parser()
1133
# We don't give access to options defined outside of any section, we
1134
# used the DEFAULT section by... default.
1135
if name in (None, 'DEFAULT'):
1136
# This could happen for an empty file where the DEFAULT section
1137
# doesn't exist yet. So we force DEFAULT when yielding
1139
if 'DEFAULT' not in parser:
1140
parser['DEFAULT']= {}
1141
yield (name, parser[name], self.config_id())
1144
def remove_user_option(self, option_name, section_name=None):
1145
if section_name is None:
1146
# We need to force the default section.
1147
section_name = 'DEFAULT'
1148
# We need to avoid the LockableConfig implementation or we'll lock
1150
super(LockableConfig, self).remove_user_option(option_name,
1153
def _iter_for_location_by_parts(sections, location):
1154
"""Keep only the sessions matching the specified location.
1156
:param sections: An iterable of section names.
1158
:param location: An url or a local path to match against.
1160
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1161
number of path components in the section name, section is the section
1162
name and extra_path is the difference between location and the section
1165
``location`` will always be a local path and never a 'file://' url but the
1166
section names themselves can be in either form.
1168
location_parts = location.rstrip('/').split('/')
1170
for section in sections:
1171
# location is a local path if possible, so we need to convert 'file://'
1172
# urls in section names to local paths if necessary.
1174
# This also avoids having file:///path be a more exact
1175
# match than '/path'.
1177
# FIXME: This still raises an issue if a user defines both file:///path
1178
# *and* /path. Should we raise an error in this case -- vila 20110505
1180
if section.startswith('file://'):
1181
section_path = urlutils.local_path_from_url(section)
1183
section_path = section
1184
section_parts = section_path.rstrip('/').split('/')
1187
if len(section_parts) > len(location_parts):
1188
# More path components in the section, they can't match
1191
# Rely on zip truncating in length to the length of the shortest
1192
# argument sequence.
1193
names = zip(location_parts, section_parts)
1195
if not fnmatch.fnmatch(name[0], name[1]):
1200
# build the path difference between the section and the location
1201
extra_path = '/'.join(location_parts[len(section_parts):])
1202
yield section, extra_path, len(section_parts)
1205
class LocationConfig(LockableConfig):
1206
"""A configuration object that gives the policy for a location."""
1208
def __init__(self, location):
1209
super(LocationConfig, self).__init__(
1210
file_name=locations_config_filename())
1211
# local file locations are looked up by local path, rather than
1212
# by file url. This is because the config file is a user
1213
# file, and we would rather not expose the user to file urls.
1214
if location.startswith('file://'):
1215
location = urlutils.local_path_from_url(location)
1216
self.location = location
1218
def config_id(self):
1222
def from_string(cls, str_or_unicode, location, save=False):
1223
"""Create a config object from a string.
1225
:param str_or_unicode: A string representing the file content. This will
1228
:param location: The location url to filter the configuration.
1230
:param save: Whether the file should be saved upon creation.
1232
conf = cls(location)
1233
conf._create_from_string(str_or_unicode, save)
1236
def _get_matching_sections(self):
1237
"""Return an ordered list of section names matching this location."""
1238
matches = list(_iter_for_location_by_parts(self._get_parser(),
1240
# put the longest (aka more specific) locations first
1242
key=lambda (section, extra_path, length): (length, section),
1244
for (section, extra_path, length) in matches:
1245
yield section, extra_path
1246
# should we stop looking for parent configs here?
1248
if self._get_parser()[section].as_bool('ignore_parents'):
1253
def _get_sections(self, name=None):
1254
"""See IniBasedConfig._get_sections()."""
1255
# We ignore the name here as the only sections handled are named with
1256
# the location path and we don't expose embedded sections either.
1257
parser = self._get_parser()
1258
for name, extra_path in self._get_matching_sections():
1259
yield (name, parser[name], self.config_id())
1261
def _get_option_policy(self, section, option_name):
1262
"""Return the policy for the given (section, option_name) pair."""
1263
# check for the old 'recurse=False' flag
1265
recurse = self._get_parser()[section].as_bool('recurse')
1269
return POLICY_NORECURSE
1271
policy_key = option_name + ':policy'
1273
policy_name = self._get_parser()[section][policy_key]
1277
return _policy_value[policy_name]
1279
def _set_option_policy(self, section, option_name, option_policy):
1280
"""Set the policy for the given option name in the given section."""
1281
# The old recurse=False option affects all options in the
1282
# section. To handle multiple policies in the section, we
1283
# need to convert it to a policy_norecurse key.
1285
recurse = self._get_parser()[section].as_bool('recurse')
1289
symbol_versioning.warn(
1290
'The recurse option is deprecated as of 0.14. '
1291
'The section "%s" has been converted to use policies.'
1294
del self._get_parser()[section]['recurse']
1296
for key in self._get_parser()[section].keys():
1297
if not key.endswith(':policy'):
1298
self._get_parser()[section][key +
1299
':policy'] = 'norecurse'
1301
policy_key = option_name + ':policy'
1302
policy_name = _policy_name[option_policy]
1303
if policy_name is not None:
1304
self._get_parser()[section][policy_key] = policy_name
1306
if policy_key in self._get_parser()[section]:
1307
del self._get_parser()[section][policy_key]
1310
def set_user_option(self, option, value, store=STORE_LOCATION):
1311
"""Save option and its value in the configuration."""
1312
if store not in [STORE_LOCATION,
1313
STORE_LOCATION_NORECURSE,
1314
STORE_LOCATION_APPENDPATH]:
1315
raise ValueError('bad storage policy %r for %r' %
1318
location = self.location
1319
if location.endswith('/'):
1320
location = location[:-1]
1321
parser = self._get_parser()
1322
if not location in parser and not location + '/' in parser:
1323
parser[location] = {}
1324
elif location + '/' in parser:
1325
location = location + '/'
1326
parser[location][option]=value
1327
# the allowed values of store match the config policies
1328
self._set_option_policy(location, option, store)
1329
self._write_config_file()
1330
for hook in OldConfigHooks['set']:
1331
hook(self, option, value)
1334
class BranchConfig(Config):
1335
"""A configuration object giving the policy for a branch."""
1337
def __init__(self, branch):
1338
super(BranchConfig, self).__init__()
1339
self._location_config = None
1340
self._branch_data_config = None
1341
self._global_config = None
1342
self.branch = branch
1343
self.option_sources = (self._get_location_config,
1344
self._get_branch_data_config,
1345
self._get_global_config)
1347
def config_id(self):
1350
def _get_branch_data_config(self):
1351
if self._branch_data_config is None:
1352
self._branch_data_config = TreeConfig(self.branch)
1353
self._branch_data_config.config_id = self.config_id
1354
return self._branch_data_config
1356
def _get_location_config(self):
1357
if self._location_config is None:
1358
self._location_config = LocationConfig(self.branch.base)
1359
return self._location_config
1361
def _get_global_config(self):
1362
if self._global_config is None:
1363
self._global_config = GlobalConfig()
1364
return self._global_config
1366
def _get_best_value(self, option_name):
1367
"""This returns a user option from local, tree or global config.
1369
They are tried in that order. Use get_safe_value if trusted values
1372
for source in self.option_sources:
1373
value = getattr(source(), option_name)()
1374
if value is not None:
1378
def _get_safe_value(self, option_name):
1379
"""This variant of get_best_value never returns untrusted values.
1381
It does not return values from the branch data, because the branch may
1382
not be controlled by the user.
1384
We may wish to allow locations.conf to control whether branches are
1385
trusted in the future.
1387
for source in (self._get_location_config, self._get_global_config):
1388
value = getattr(source(), option_name)()
1389
if value is not None:
1393
def _get_user_id(self):
1394
"""Return the full user id for the branch.
1396
e.g. "John Hacker <jhacker@example.com>"
1397
This is looked up in the email controlfile for the branch.
1400
return (self.branch._transport.get_bytes("email")
1401
.decode(osutils.get_user_encoding())
1403
except (errors.NoSuchFile, errors.PermissionDenied), e:
1406
return self._get_best_value('_get_user_id')
1408
def _get_change_editor(self):
1409
return self._get_best_value('_get_change_editor')
1411
def _get_signature_checking(self):
1412
"""See Config._get_signature_checking."""
1413
return self._get_best_value('_get_signature_checking')
1415
def _get_signing_policy(self):
1416
"""See Config._get_signing_policy."""
1417
return self._get_best_value('_get_signing_policy')
1419
def _get_user_option(self, option_name):
1420
"""See Config._get_user_option."""
1421
for source in self.option_sources:
1422
value = source()._get_user_option(option_name)
1423
if value is not None:
1427
def _get_sections(self, name=None):
1428
"""See IniBasedConfig.get_sections()."""
1429
for source in self.option_sources:
1430
for section in source()._get_sections(name):
1433
def _get_options(self, sections=None):
1435
# First the locations options
1436
for option in self._get_location_config()._get_options():
1438
# Then the branch options
1439
branch_config = self._get_branch_data_config()
1440
if sections is None:
1441
sections = [('DEFAULT', branch_config._get_parser())]
1442
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1443
# Config itself has no notion of sections :( -- vila 20101001
1444
config_id = self.config_id()
1445
for (section_name, section) in sections:
1446
for (name, value) in section.iteritems():
1447
yield (name, value, section_name,
1448
config_id, branch_config._get_parser())
1449
# Then the global options
1450
for option in self._get_global_config()._get_options():
1453
def set_user_option(self, name, value, store=STORE_BRANCH,
1455
if store == STORE_BRANCH:
1456
self._get_branch_data_config().set_option(value, name)
1457
elif store == STORE_GLOBAL:
1458
self._get_global_config().set_user_option(name, value)
1460
self._get_location_config().set_user_option(name, value, store)
1463
if store in (STORE_GLOBAL, STORE_BRANCH):
1464
mask_value = self._get_location_config().get_user_option(name)
1465
if mask_value is not None:
1466
trace.warning('Value "%s" is masked by "%s" from'
1467
' locations.conf', value, mask_value)
1469
if store == STORE_GLOBAL:
1470
branch_config = self._get_branch_data_config()
1471
mask_value = branch_config.get_user_option(name)
1472
if mask_value is not None:
1473
trace.warning('Value "%s" is masked by "%s" from'
1474
' branch.conf', value, mask_value)
1476
def remove_user_option(self, option_name, section_name=None):
1477
self._get_branch_data_config().remove_option(option_name, section_name)
1479
def _gpg_signing_command(self):
1480
"""See Config.gpg_signing_command."""
1481
return self._get_safe_value('_gpg_signing_command')
1483
def _post_commit(self):
1484
"""See Config.post_commit."""
1485
return self._get_safe_value('_post_commit')
1487
def _get_nickname(self):
1488
value = self._get_explicit_nickname()
1489
if value is not None:
1491
return urlutils.unescape(self.branch.base.split('/')[-2])
1493
def has_explicit_nickname(self):
1494
"""Return true if a nickname has been explicitly assigned."""
1495
return self._get_explicit_nickname() is not None
1497
def _get_explicit_nickname(self):
1498
return self._get_best_value('_get_nickname')
1500
def _log_format(self):
1501
"""See Config.log_format."""
1502
return self._get_best_value('_log_format')
1504
def _validate_signatures_in_log(self):
1505
"""See Config.validate_signatures_in_log."""
1506
return self._get_best_value('_validate_signatures_in_log')
1508
def _acceptable_keys(self):
1509
"""See Config.acceptable_keys."""
1510
return self._get_best_value('_acceptable_keys')
1513
def ensure_config_dir_exists(path=None):
1514
"""Make sure a configuration directory exists.
1515
This makes sure that the directory exists.
1516
On windows, since configuration directories are 2 levels deep,
1517
it makes sure both the directory and the parent directory exists.
1521
if not os.path.isdir(path):
1522
if sys.platform == 'win32':
1523
parent_dir = os.path.dirname(path)
1524
if not os.path.isdir(parent_dir):
1525
trace.mutter('creating config parent directory: %r', parent_dir)
1526
os.mkdir(parent_dir)
1527
trace.mutter('creating config directory: %r', path)
1529
osutils.copy_ownership_from_path(path)
1533
"""Return per-user configuration directory.
1535
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1536
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1537
that will be used instead.
1539
TODO: Global option --config-dir to override this.
1541
base = os.environ.get('BZR_HOME', None)
1542
if sys.platform == 'win32':
1543
# environ variables on Windows are in user encoding/mbcs. So decode
1545
if base is not None:
1546
base = base.decode('mbcs')
1548
base = win32utils.get_appdata_location_unicode()
1550
base = os.environ.get('HOME', None)
1551
if base is not None:
1552
base = base.decode('mbcs')
1554
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1556
return osutils.pathjoin(base, 'bazaar', '2.0')
1558
if base is not None:
1559
base = base.decode(osutils._fs_enc)
1560
if sys.platform == 'darwin':
1562
# this takes into account $HOME
1563
base = os.path.expanduser("~")
1564
return osutils.pathjoin(base, '.bazaar')
1567
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1569
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1570
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1571
if osutils.isdir(xdg_dir):
1573
"Using configuration in XDG directory %s." % xdg_dir)
1575
base = os.path.expanduser("~")
1576
return osutils.pathjoin(base, ".bazaar")
1579
def config_filename():
1580
"""Return per-user configuration ini file filename."""
1581
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1584
def locations_config_filename():
1585
"""Return per-user configuration ini file filename."""
1586
return osutils.pathjoin(config_dir(), 'locations.conf')
1589
def authentication_config_filename():
1590
"""Return per-user authentication ini file filename."""
1591
return osutils.pathjoin(config_dir(), 'authentication.conf')
1594
def user_ignore_config_filename():
1595
"""Return the user default ignore filename"""
1596
return osutils.pathjoin(config_dir(), 'ignore')
1600
"""Return the directory name to store crash files.
1602
This doesn't implicitly create it.
1604
On Windows it's in the config directory; elsewhere it's /var/crash
1605
which may be monitored by apport. It can be overridden by
1608
if sys.platform == 'win32':
1609
return osutils.pathjoin(config_dir(), 'Crash')
1611
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1613
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1616
def xdg_cache_dir():
1617
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1618
# Possibly this should be different on Windows?
1619
e = os.environ.get('XDG_CACHE_DIR', None)
1623
return os.path.expanduser('~/.cache')
1626
def _get_default_mail_domain():
1627
"""If possible, return the assumed default email domain.
1629
:returns: string mail domain, or None.
1631
if sys.platform == 'win32':
1632
# No implementation yet; patches welcome
1635
f = open('/etc/mailname')
1636
except (IOError, OSError), e:
1639
domain = f.read().strip()
1645
def _auto_user_id():
1646
"""Calculate automatic user identification.
1648
:returns: (realname, email), either of which may be None if they can't be
1651
Only used when none is set in the environment or the id file.
1653
This only returns an email address if we can be fairly sure the
1654
address is reasonable, ie if /etc/mailname is set on unix.
1656
This doesn't use the FQDN as the default domain because that may be
1657
slow, and it doesn't use the hostname alone because that's not normally
1658
a reasonable address.
1660
if sys.platform == 'win32':
1661
# No implementation to reliably determine Windows default mail
1662
# address; please add one.
1665
default_mail_domain = _get_default_mail_domain()
1666
if not default_mail_domain:
1672
w = pwd.getpwuid(uid)
1674
trace.mutter('no passwd entry for uid %d?' % uid)
1677
# we try utf-8 first, because on many variants (like Linux),
1678
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1679
# false positives. (many users will have their user encoding set to
1680
# latin-1, which cannot raise UnicodeError.)
1682
gecos = w.pw_gecos.decode('utf-8')
1684
except UnicodeError:
1686
encoding = osutils.get_user_encoding()
1687
gecos = w.pw_gecos.decode(encoding)
1688
except UnicodeError, e:
1689
trace.mutter("cannot decode passwd entry %s" % w)
1692
username = w.pw_name.decode(encoding)
1693
except UnicodeError, e:
1694
trace.mutter("cannot decode passwd entry %s" % w)
1697
comma = gecos.find(',')
1701
realname = gecos[:comma]
1703
return realname, (username + '@' + default_mail_domain)
1706
def parse_username(username):
1707
"""Parse e-mail username and return a (name, address) tuple."""
1708
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1710
return (username, '')
1712
return (match.group(1), match.group(2))
1715
def extract_email_address(e):
1716
"""Return just the address part of an email string.
1718
That is just the user@domain part, nothing else.
1719
This part is required to contain only ascii characters.
1720
If it can't be extracted, raises an error.
1722
>>> extract_email_address('Jane Tester <jane@test.com>')
1725
name, email = parse_username(e)
1727
raise errors.NoEmailInUsername(e)
1731
class TreeConfig(IniBasedConfig):
1732
"""Branch configuration data associated with its contents, not location"""
1734
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1736
def __init__(self, branch):
1737
self._config = branch._get_config()
1738
self.branch = branch
1740
def _get_parser(self, file=None):
1741
if file is not None:
1742
return IniBasedConfig._get_parser(file)
1743
return self._config._get_configobj()
1745
def get_option(self, name, section=None, default=None):
1746
self.branch.lock_read()
1748
return self._config.get_option(name, section, default)
1750
self.branch.unlock()
1752
def set_option(self, value, name, section=None):
1753
"""Set a per-branch configuration option"""
1754
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1755
# higher levels providing the right lock -- vila 20101004
1756
self.branch.lock_write()
1758
self._config.set_option(value, name, section)
1760
self.branch.unlock()
1762
def remove_option(self, option_name, section_name=None):
1763
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1764
# higher levels providing the right lock -- vila 20101004
1765
self.branch.lock_write()
1767
self._config.remove_option(option_name, section_name)
1769
self.branch.unlock()
1772
class AuthenticationConfig(object):
1773
"""The authentication configuration file based on a ini file.
1775
Implements the authentication.conf file described in
1776
doc/developers/authentication-ring.txt.
1779
def __init__(self, _file=None):
1780
self._config = None # The ConfigObj
1782
self._filename = authentication_config_filename()
1783
self._input = self._filename = authentication_config_filename()
1785
# Tests can provide a string as _file
1786
self._filename = None
1789
def _get_config(self):
1790
if self._config is not None:
1793
# FIXME: Should we validate something here ? Includes: empty
1794
# sections are useless, at least one of
1795
# user/password/password_encoding should be defined, etc.
1797
# Note: the encoding below declares that the file itself is utf-8
1798
# encoded, but the values in the ConfigObj are always Unicode.
1799
self._config = ConfigObj(self._input, encoding='utf-8')
1800
except configobj.ConfigObjError, e:
1801
raise errors.ParseConfigError(e.errors, e.config.filename)
1802
except UnicodeError:
1803
raise errors.ConfigContentError(self._filename)
1807
"""Save the config file, only tests should use it for now."""
1808
conf_dir = os.path.dirname(self._filename)
1809
ensure_config_dir_exists(conf_dir)
1810
f = file(self._filename, 'wb')
1812
self._get_config().write(f)
1816
def _set_option(self, section_name, option_name, value):
1817
"""Set an authentication configuration option"""
1818
conf = self._get_config()
1819
section = conf.get(section_name)
1822
section = conf[section]
1823
section[option_name] = value
1826
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1828
"""Returns the matching credentials from authentication.conf file.
1830
:param scheme: protocol
1832
:param host: the server address
1834
:param port: the associated port (optional)
1836
:param user: login (optional)
1838
:param path: the absolute path on the server (optional)
1840
:param realm: the http authentication realm (optional)
1842
:return: A dict containing the matching credentials or None.
1844
- name: the section name of the credentials in the
1845
authentication.conf file,
1846
- user: can't be different from the provided user if any,
1847
- scheme: the server protocol,
1848
- host: the server address,
1849
- port: the server port (can be None),
1850
- path: the absolute server path (can be None),
1851
- realm: the http specific authentication realm (can be None),
1852
- password: the decoded password, could be None if the credential
1853
defines only the user
1854
- verify_certificates: https specific, True if the server
1855
certificate should be verified, False otherwise.
1858
for auth_def_name, auth_def in self._get_config().items():
1859
if type(auth_def) is not configobj.Section:
1860
raise ValueError("%s defined outside a section" % auth_def_name)
1862
a_scheme, a_host, a_user, a_path = map(
1863
auth_def.get, ['scheme', 'host', 'user', 'path'])
1866
a_port = auth_def.as_int('port')
1870
raise ValueError("'port' not numeric in %s" % auth_def_name)
1872
a_verify_certificates = auth_def.as_bool('verify_certificates')
1874
a_verify_certificates = True
1877
"'verify_certificates' not boolean in %s" % auth_def_name)
1880
if a_scheme is not None and scheme != a_scheme:
1882
if a_host is not None:
1883
if not (host == a_host
1884
or (a_host.startswith('.') and host.endswith(a_host))):
1886
if a_port is not None and port != a_port:
1888
if (a_path is not None and path is not None
1889
and not path.startswith(a_path)):
1891
if (a_user is not None and user is not None
1892
and a_user != user):
1893
# Never contradict the caller about the user to be used
1898
# Prepare a credentials dictionary with additional keys
1899
# for the credential providers
1900
credentials = dict(name=auth_def_name,
1907
password=auth_def.get('password', None),
1908
verify_certificates=a_verify_certificates)
1909
# Decode the password in the credentials (or get one)
1910
self.decode_password(credentials,
1911
auth_def.get('password_encoding', None))
1912
if 'auth' in debug.debug_flags:
1913
trace.mutter("Using authentication section: %r", auth_def_name)
1916
if credentials is None:
1917
# No credentials were found in authentication.conf, try the fallback
1918
# credentials stores.
1919
credentials = credential_store_registry.get_fallback_credentials(
1920
scheme, host, port, user, path, realm)
1924
def set_credentials(self, name, host, user, scheme=None, password=None,
1925
port=None, path=None, verify_certificates=None,
1927
"""Set authentication credentials for a host.
1929
Any existing credentials with matching scheme, host, port and path
1930
will be deleted, regardless of name.
1932
:param name: An arbitrary name to describe this set of credentials.
1933
:param host: Name of the host that accepts these credentials.
1934
:param user: The username portion of these credentials.
1935
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1937
:param password: Password portion of these credentials.
1938
:param port: The IP port on the host that these credentials apply to.
1939
:param path: A filesystem path on the host that these credentials
1941
:param verify_certificates: On https, verify server certificates if
1943
:param realm: The http authentication realm (optional).
1945
values = {'host': host, 'user': user}
1946
if password is not None:
1947
values['password'] = password
1948
if scheme is not None:
1949
values['scheme'] = scheme
1950
if port is not None:
1951
values['port'] = '%d' % port
1952
if path is not None:
1953
values['path'] = path
1954
if verify_certificates is not None:
1955
values['verify_certificates'] = str(verify_certificates)
1956
if realm is not None:
1957
values['realm'] = realm
1958
config = self._get_config()
1960
for section, existing_values in config.items():
1961
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1962
if existing_values.get(key) != values.get(key):
1966
config.update({name: values})
1969
def get_user(self, scheme, host, port=None, realm=None, path=None,
1970
prompt=None, ask=False, default=None):
1971
"""Get a user from authentication file.
1973
:param scheme: protocol
1975
:param host: the server address
1977
:param port: the associated port (optional)
1979
:param realm: the realm sent by the server (optional)
1981
:param path: the absolute path on the server (optional)
1983
:param ask: Ask the user if there is no explicitly configured username
1986
:param default: The username returned if none is defined (optional).
1988
:return: The found user.
1990
credentials = self.get_credentials(scheme, host, port, user=None,
1991
path=path, realm=realm)
1992
if credentials is not None:
1993
user = credentials['user']
1999
# Create a default prompt suitable for most cases
2000
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
2001
# Special handling for optional fields in the prompt
2002
if port is not None:
2003
prompt_host = '%s:%d' % (host, port)
2006
user = ui.ui_factory.get_username(prompt, host=prompt_host)
2011
def get_password(self, scheme, host, user, port=None,
2012
realm=None, path=None, prompt=None):
2013
"""Get a password from authentication file or prompt the user for one.
2015
:param scheme: protocol
2017
:param host: the server address
2019
:param port: the associated port (optional)
2023
:param realm: the realm sent by the server (optional)
2025
:param path: the absolute path on the server (optional)
2027
:return: The found password or the one entered by the user.
2029
credentials = self.get_credentials(scheme, host, port, user, path,
2031
if credentials is not None:
2032
password = credentials['password']
2033
if password is not None and scheme is 'ssh':
2034
trace.warning('password ignored in section [%s],'
2035
' use an ssh agent instead'
2036
% credentials['name'])
2040
# Prompt user only if we could't find a password
2041
if password is None:
2043
# Create a default prompt suitable for most cases
2044
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2045
# Special handling for optional fields in the prompt
2046
if port is not None:
2047
prompt_host = '%s:%d' % (host, port)
2050
password = ui.ui_factory.get_password(prompt,
2051
host=prompt_host, user=user)
2054
def decode_password(self, credentials, encoding):
2056
cs = credential_store_registry.get_credential_store(encoding)
2058
raise ValueError('%r is not a known password_encoding' % encoding)
2059
credentials['password'] = cs.decode_password(credentials)
2063
class CredentialStoreRegistry(registry.Registry):
2064
"""A class that registers credential stores.
2066
A credential store provides access to credentials via the password_encoding
2067
field in authentication.conf sections.
2069
Except for stores provided by bzr itself, most stores are expected to be
2070
provided by plugins that will therefore use
2071
register_lazy(password_encoding, module_name, member_name, help=help,
2072
fallback=fallback) to install themselves.
2074
A fallback credential store is one that is queried if no credentials can be
2075
found via authentication.conf.
2078
def get_credential_store(self, encoding=None):
2079
cs = self.get(encoding)
2084
def is_fallback(self, name):
2085
"""Check if the named credentials store should be used as fallback."""
2086
return self.get_info(name)
2088
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2089
path=None, realm=None):
2090
"""Request credentials from all fallback credentials stores.
2092
The first credentials store that can provide credentials wins.
2095
for name in self.keys():
2096
if not self.is_fallback(name):
2098
cs = self.get_credential_store(name)
2099
credentials = cs.get_credentials(scheme, host, port, user,
2101
if credentials is not None:
2102
# We found some credentials
2106
def register(self, key, obj, help=None, override_existing=False,
2108
"""Register a new object to a name.
2110
:param key: This is the key to use to request the object later.
2111
:param obj: The object to register.
2112
:param help: Help text for this entry. This may be a string or
2113
a callable. If it is a callable, it should take two
2114
parameters (registry, key): this registry and the key that
2115
the help was registered under.
2116
:param override_existing: Raise KeyErorr if False and something has
2117
already been registered for that key. If True, ignore if there
2118
is an existing key (always register the new value).
2119
:param fallback: Whether this credential store should be
2122
return super(CredentialStoreRegistry,
2123
self).register(key, obj, help, info=fallback,
2124
override_existing=override_existing)
2126
def register_lazy(self, key, module_name, member_name,
2127
help=None, override_existing=False,
2129
"""Register a new credential store to be loaded on request.
2131
:param module_name: The python path to the module. Such as 'os.path'.
2132
:param member_name: The member of the module to return. If empty or
2133
None, get() will return the module itself.
2134
:param help: Help text for this entry. This may be a string or
2136
:param override_existing: If True, replace the existing object
2137
with the new one. If False, if there is already something
2138
registered with the same key, raise a KeyError
2139
:param fallback: Whether this credential store should be
2142
return super(CredentialStoreRegistry, self).register_lazy(
2143
key, module_name, member_name, help,
2144
info=fallback, override_existing=override_existing)
2147
credential_store_registry = CredentialStoreRegistry()
2150
class CredentialStore(object):
2151
"""An abstract class to implement storage for credentials"""
2153
def decode_password(self, credentials):
2154
"""Returns a clear text password for the provided credentials."""
2155
raise NotImplementedError(self.decode_password)
2157
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2159
"""Return the matching credentials from this credential store.
2161
This method is only called on fallback credential stores.
2163
raise NotImplementedError(self.get_credentials)
2167
class PlainTextCredentialStore(CredentialStore):
2168
__doc__ = """Plain text credential store for the authentication.conf file"""
2170
def decode_password(self, credentials):
2171
"""See CredentialStore.decode_password."""
2172
return credentials['password']
2175
credential_store_registry.register('plain', PlainTextCredentialStore,
2176
help=PlainTextCredentialStore.__doc__)
2177
credential_store_registry.default_key = 'plain'
2180
class BzrDirConfig(object):
2182
def __init__(self, bzrdir):
2183
self._bzrdir = bzrdir
2184
self._config = bzrdir._get_config()
2186
def set_default_stack_on(self, value):
2187
"""Set the default stacking location.
2189
It may be set to a location, or None.
2191
This policy affects all branches contained by this bzrdir, except for
2192
those under repositories.
2194
if self._config is None:
2195
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2197
self._config.set_option('', 'default_stack_on')
2199
self._config.set_option(value, 'default_stack_on')
2201
def get_default_stack_on(self):
2202
"""Return the default stacking location.
2204
This will either be a location, or None.
2206
This policy affects all branches contained by this bzrdir, except for
2207
those under repositories.
2209
if self._config is None:
2211
value = self._config.get_option('default_stack_on')
2217
class TransportConfig(object):
2218
"""A Config that reads/writes a config file on a Transport.
2220
It is a low-level object that considers config data to be name/value pairs
2221
that may be associated with a section. Assigning meaning to these values
2222
is done at higher levels like TreeConfig.
2225
def __init__(self, transport, filename):
2226
self._transport = transport
2227
self._filename = filename
2229
def get_option(self, name, section=None, default=None):
2230
"""Return the value associated with a named option.
2232
:param name: The name of the value
2233
:param section: The section the option is in (if any)
2234
:param default: The value to return if the value is not set
2235
:return: The value or default value
2237
configobj = self._get_configobj()
2239
section_obj = configobj
2242
section_obj = configobj[section]
2245
value = section_obj.get(name, default)
2246
for hook in OldConfigHooks['get']:
2247
hook(self, name, value)
2250
def set_option(self, value, name, section=None):
2251
"""Set the value associated with a named option.
2253
:param value: The value to set
2254
:param name: The name of the value to set
2255
:param section: The section the option is in (if any)
2257
configobj = self._get_configobj()
2259
configobj[name] = value
2261
configobj.setdefault(section, {})[name] = value
2262
for hook in OldConfigHooks['set']:
2263
hook(self, name, value)
2264
self._set_configobj(configobj)
2266
def remove_option(self, option_name, section_name=None):
2267
configobj = self._get_configobj()
2268
if section_name is None:
2269
del configobj[option_name]
2271
del configobj[section_name][option_name]
2272
for hook in OldConfigHooks['remove']:
2273
hook(self, option_name)
2274
self._set_configobj(configobj)
2276
def _get_config_file(self):
2278
f = StringIO(self._transport.get_bytes(self._filename))
2279
for hook in OldConfigHooks['load']:
2282
except errors.NoSuchFile:
2284
except errors.PermissionDenied, e:
2285
trace.warning("Permission denied while trying to open "
2286
"configuration file %s.", urlutils.unescape_for_display(
2287
urlutils.join(self._transport.base, self._filename), "utf-8"))
2290
def _external_url(self):
2291
return urlutils.join(self._transport.external_url(), self._filename)
2293
def _get_configobj(self):
2294
f = self._get_config_file()
2297
conf = ConfigObj(f, encoding='utf-8')
2298
except configobj.ConfigObjError, e:
2299
raise errors.ParseConfigError(e.errors, self._external_url())
2300
except UnicodeDecodeError:
2301
raise errors.ConfigContentError(self._external_url())
2306
def _set_configobj(self, configobj):
2307
out_file = StringIO()
2308
configobj.write(out_file)
2310
self._transport.put_file(self._filename, out_file)
2311
for hook in OldConfigHooks['save']:
2315
class Option(object):
2316
"""An option definition.
2318
The option *values* are stored in config files and found in sections.
2320
Here we define various properties about the option itself, its default
2321
value, how to convert it from stores, what to do when invalid values are
2322
encoutered, in which config files it can be stored.
2325
def __init__(self, name, default=None, default_from_env=None,
2327
from_unicode=None, invalid=None):
2328
"""Build an option definition.
2330
:param name: the name used to refer to the option.
2332
:param default: the default value to use when none exist in the config
2333
stores. This is either a string that ``from_unicode`` will convert
2334
into the proper type or a python object that can be stringified (so
2335
only the empty list is supported for example).
2337
:param default_from_env: A list of environment variables which can
2338
provide a default value. 'default' will be used only if none of the
2339
variables specified here are set in the environment.
2341
:param help: a doc string to explain the option to the user.
2343
:param from_unicode: a callable to convert the unicode string
2344
representing the option value in a store. This is not called for
2347
:param invalid: the action to be taken when an invalid value is
2348
encountered in a store. This is called only when from_unicode is
2349
invoked to convert a string and returns None or raise ValueError or
2350
TypeError. Accepted values are: None (ignore invalid values),
2351
'warning' (emit a warning), 'error' (emit an error message and
2354
if default_from_env is None:
2355
default_from_env = []
2357
# Convert the default value to a unicode string so all values are
2358
# strings internally before conversion (via from_unicode) is attempted.
2361
elif isinstance(default, list):
2362
# Only the empty list is supported
2364
raise AssertionError(
2365
'Only empty lists are supported as default values')
2367
elif isinstance(default, (str, unicode, bool, int, float)):
2368
# Rely on python to convert strings, booleans and integers
2369
self.default = u'%s' % (default,)
2371
# other python objects are not expected
2372
raise AssertionError('%r is not supported as a default value'
2374
self.default_from_env = default_from_env
2376
self.from_unicode = from_unicode
2377
if invalid and invalid not in ('warning', 'error'):
2378
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2379
self.invalid = invalid
2381
def convert_from_unicode(self, unicode_value):
2382
if self.from_unicode is None or unicode_value is None:
2383
# Don't convert or nothing to convert
2384
return unicode_value
2386
converted = self.from_unicode(unicode_value)
2387
except (ValueError, TypeError):
2388
# Invalid values are ignored
2390
if converted is None and self.invalid is not None:
2391
# The conversion failed
2392
if self.invalid == 'warning':
2393
trace.warning('Value "%s" is not valid for "%s"',
2394
unicode_value, self.name)
2395
elif self.invalid == 'error':
2396
raise errors.ConfigOptionValueError(self.name, unicode_value)
2399
def get_default(self):
2401
for var in self.default_from_env:
2403
# If the env variable is defined, its value is the default one
2404
value = os.environ[var]
2409
# Otherwise, fallback to the value defined at registration
2410
value = self.default
2413
def get_help_text(self, additional_see_also=None, plain=True):
2415
from bzrlib import help_topics
2416
result += help_topics._format_see_also(additional_see_also)
2418
result = help_topics.help_as_plain_text(result)
2422
# Predefined converters to get proper values from store
2424
def bool_from_store(unicode_str):
2425
return ui.bool_from_string(unicode_str)
2428
def int_from_store(unicode_str):
2429
return int(unicode_str)
2432
def float_from_store(unicode_str):
2433
return float(unicode_str)
2437
# Use a an empty dict to initialize an empty configobj avoiding all
2438
# parsing and encoding checks
2439
_list_converter_config = configobj.ConfigObj(
2440
{}, encoding='utf-8', list_values=True, interpolation=False)
2443
def list_from_store(unicode_str):
2444
if not isinstance(unicode_str, basestring):
2446
# Now inject our string directly as unicode. All callers got their value
2447
# from configobj, so values that need to be quoted are already properly
2449
_list_converter_config.reset()
2450
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2451
maybe_list = _list_converter_config['list']
2452
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2453
if isinstance(maybe_list, basestring):
2455
# A single value, most probably the user forgot (or didn't care to
2456
# add) the final ','
2459
# The empty string, convert to empty list
2462
# We rely on ConfigObj providing us with a list already
2467
class OptionRegistry(registry.Registry):
2468
"""Register config options by their name.
2470
This overrides ``registry.Registry`` to simplify registration by acquiring
2471
some information from the option object itself.
2474
def register(self, option):
2475
"""Register a new option to its name.
2477
:param option: The option to register. Its name is used as the key.
2479
super(OptionRegistry, self).register(option.name, option,
2482
def register_lazy(self, key, module_name, member_name):
2483
"""Register a new option to be loaded on request.
2485
:param key: the key to request the option later. Since the registration
2486
is lazy, it should be provided and match the option name.
2488
:param module_name: the python path to the module. Such as 'os.path'.
2490
:param member_name: the member of the module to return. If empty or
2491
None, get() will return the module itself.
2493
super(OptionRegistry, self).register_lazy(key,
2494
module_name, member_name)
2496
def get_help(self, key=None):
2497
"""Get the help text associated with the given key"""
2498
option = self.get(key)
2499
the_help = option.help
2500
if callable(the_help):
2501
return the_help(self, key)
2505
option_registry = OptionRegistry()
2508
# Registered options in lexicographical order
2510
option_registry.register(
2511
Option('bzr.workingtree.worth_saving_limit', default=10,
2512
from_unicode=int_from_store, invalid='warning',
2514
How many changes before saving the dirstate.
2516
-1 means that we will never rewrite the dirstate file for only
2517
stat-cache changes. Regardless of this setting, we will always rewrite
2518
the dirstate file if a file is added/removed/renamed/etc. This flag only
2519
affects the behavior of updating the dirstate file after we notice that
2520
a file has been touched.
2522
option_registry.register(
2523
Option('dirstate.fdatasync', default=True,
2524
from_unicode=bool_from_store,
2526
Flush dirstate changes onto physical disk?
2528
If true (default), working tree metadata changes are flushed through the
2529
OS buffers to physical disk. This is somewhat slower, but means data
2530
should not be lost if the machine crashes. See also repository.fdatasync.
2532
option_registry.register(
2533
Option('debug_flags', default=[], from_unicode=list_from_store,
2534
help='Debug flags to activate.'))
2535
option_registry.register(
2536
Option('default_format', default='2a',
2537
help='Format used when creating branches.'))
2538
option_registry.register(
2539
Option('dpush_strict', default=None,
2540
from_unicode=bool_from_store,
2542
The default value for ``dpush --strict``.
2544
If present, defines the ``--strict`` option default value for checking
2545
uncommitted changes before pushing into a different VCS without any
2546
custom bzr metadata.
2548
option_registry.register(
2550
help='The command called to launch an editor to enter a message.'))
2551
option_registry.register(
2552
Option('ignore_missing_extensions', default=False,
2553
from_unicode=bool_from_store,
2555
Control the missing extensions warning display.
2557
The warning will not be emitted if set to True.
2559
option_registry.register(
2561
help='Language to translate messages into.'))
2562
option_registry.register(
2563
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2565
Steal locks that appears to be dead.
2567
If set to True, bzr will check if a lock is supposed to be held by an
2568
active process from the same user on the same machine. If the user and
2569
machine match, but no process with the given PID is active, then bzr
2570
will automatically break the stale lock, and create a new lock for
2572
Otherwise, bzr will prompt as normal to break the lock.
2574
option_registry.register(
2575
Option('log_format', default='long',
2577
Log format to use when displaying revisions.
2579
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2580
may be provided by plugins.
2582
option_registry.register(
2583
Option('output_encoding',
2584
help= 'Unicode encoding for output'
2585
' (terminal encoding if not specified).'))
2586
option_registry.register(
2587
Option('push_strict', default=None,
2588
from_unicode=bool_from_store,
2590
The default value for ``push --strict``.
2592
If present, defines the ``--strict`` option default value for checking
2593
uncommitted changes before sending a merge directive.
2595
option_registry.register(
2596
Option('repository.fdatasync', default=True,
2597
from_unicode=bool_from_store,
2599
Flush repository changes onto physical disk?
2601
If true (default), repository changes are flushed through the OS buffers
2602
to physical disk. This is somewhat slower, but means data should not be
2603
lost if the machine crashes. See also dirstate.fdatasync.
2605
option_registry.register(
2606
Option('send_strict', default=None,
2607
from_unicode=bool_from_store,
2609
The default value for ``send --strict``.
2611
If present, defines the ``--strict`` option default value for checking
2612
uncommitted changes before pushing.
2615
option_registry.register(
2616
Option('serve.client_timeout',
2617
default=300.0, from_unicode=float_from_store,
2618
help="If we wait for a new request from a client for more than"
2619
" X seconds, consider the client idle, and hangup."))
2622
class Section(object):
2623
"""A section defines a dict of option name => value.
2625
This is merely a read-only dict which can add some knowledge about the
2626
options. It is *not* a python dict object though and doesn't try to mimic
2630
def __init__(self, section_id, options):
2631
self.id = section_id
2632
# We re-use the dict-like object received
2633
self.options = options
2635
def get(self, name, default=None):
2636
return self.options.get(name, default)
2639
# Mostly for debugging use
2640
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2643
_NewlyCreatedOption = object()
2644
"""Was the option created during the MutableSection lifetime"""
2647
class MutableSection(Section):
2648
"""A section allowing changes and keeping track of the original values."""
2650
def __init__(self, section_id, options):
2651
super(MutableSection, self).__init__(section_id, options)
2654
def set(self, name, value):
2655
if name not in self.options:
2656
# This is a new option
2657
self.orig[name] = _NewlyCreatedOption
2658
elif name not in self.orig:
2659
self.orig[name] = self.get(name, None)
2660
self.options[name] = value
2662
def remove(self, name):
2663
if name not in self.orig:
2664
self.orig[name] = self.get(name, None)
2665
del self.options[name]
2668
class CommandLineSection(MutableSection):
2669
"""A section used to carry command line overrides for the config options."""
2671
def __init__(self, opts=None):
2674
super(CommandLineSection, self).__init__('cmdline-overrides', opts)
2677
# The dict should be cleared but not replaced so it can be shared.
2678
self.options.clear()
2680
def _from_cmdline(self, overrides):
2681
# Reset before accepting new definitions
2683
for over in overrides:
2685
name, value = over.split('=', 1)
2687
raise errors.BzrCommandError(
2688
gettext("Invalid '%s', should be of the form 'name=value'")
2690
self.set(name, value)
2693
class Store(object):
2694
"""Abstract interface to persistent storage for configuration options."""
2696
readonly_section_class = Section
2697
mutable_section_class = MutableSection
2699
def is_loaded(self):
2700
"""Returns True if the Store has been loaded.
2702
This is used to implement lazy loading and ensure the persistent
2703
storage is queried only when needed.
2705
raise NotImplementedError(self.is_loaded)
2708
"""Loads the Store from persistent storage."""
2709
raise NotImplementedError(self.load)
2711
def _load_from_string(self, bytes):
2712
"""Create a store from a string in configobj syntax.
2714
:param bytes: A string representing the file content.
2716
raise NotImplementedError(self._load_from_string)
2719
"""Unloads the Store.
2721
This should make is_loaded() return False. This is used when the caller
2722
knows that the persistent storage has changed or may have change since
2725
raise NotImplementedError(self.unload)
2728
"""Saves the Store to persistent storage."""
2729
raise NotImplementedError(self.save)
2731
def external_url(self):
2732
raise NotImplementedError(self.external_url)
2734
def get_sections(self):
2735
"""Returns an ordered iterable of existing sections.
2737
:returns: An iterable of (name, dict).
2739
raise NotImplementedError(self.get_sections)
2741
def get_mutable_section(self, section_name=None):
2742
"""Returns the specified mutable section.
2744
:param section_name: The section identifier
2746
raise NotImplementedError(self.get_mutable_section)
2749
# Mostly for debugging use
2750
return "<config.%s(%s)>" % (self.__class__.__name__,
2751
self.external_url())
2754
class IniFileStore(Store):
2755
"""A config Store using ConfigObj for storage.
2757
:ivar transport: The transport object where the config file is located.
2759
:ivar file_name: The config file basename in the transport directory.
2761
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2762
serialize/deserialize the config file.
2765
def __init__(self, transport, file_name):
2766
"""A config Store using ConfigObj for storage.
2768
:param transport: The transport object where the config file is located.
2770
:param file_name: The config file basename in the transport directory.
2772
super(IniFileStore, self).__init__()
2773
self.transport = transport
2774
self.file_name = file_name
2775
self._config_obj = None
2777
def is_loaded(self):
2778
return self._config_obj != None
2781
self._config_obj = None
2784
"""Load the store from the associated file."""
2785
if self.is_loaded():
2788
content = self.transport.get_bytes(self.file_name)
2789
except errors.PermissionDenied:
2790
trace.warning("Permission denied while trying to load "
2791
"configuration store %s.", self.external_url())
2793
self._load_from_string(content)
2794
for hook in ConfigHooks['load']:
2797
def _load_from_string(self, bytes):
2798
"""Create a config store from a string.
2800
:param bytes: A string representing the file content.
2802
if self.is_loaded():
2803
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2804
co_input = StringIO(bytes)
2806
# The config files are always stored utf8-encoded
2807
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2809
except configobj.ConfigObjError, e:
2810
self._config_obj = None
2811
raise errors.ParseConfigError(e.errors, self.external_url())
2812
except UnicodeDecodeError:
2813
raise errors.ConfigContentError(self.external_url())
2816
if not self.is_loaded():
2820
self._config_obj.write(out)
2821
self.transport.put_bytes(self.file_name, out.getvalue())
2822
for hook in ConfigHooks['save']:
2825
def external_url(self):
2826
# FIXME: external_url should really accepts an optional relpath
2827
# parameter (bug #750169) :-/ -- vila 2011-04-04
2828
# The following will do in the interim but maybe we don't want to
2829
# expose a path here but rather a config ID and its associated
2830
# object </hand wawe>.
2831
return urlutils.join(self.transport.external_url(), self.file_name)
2833
def get_sections(self):
2834
"""Get the configobj section in the file order.
2836
:returns: An iterable of (name, dict).
2838
# We need a loaded store
2841
except (errors.NoSuchFile, errors.PermissionDenied):
2842
# If the file can't be read, there is no sections
2844
cobj = self._config_obj
2846
yield self.readonly_section_class(None, cobj)
2847
for section_name in cobj.sections:
2848
yield self.readonly_section_class(section_name, cobj[section_name])
2850
def get_mutable_section(self, section_name=None):
2851
# We need a loaded store
2854
except errors.NoSuchFile:
2855
# The file doesn't exist, let's pretend it was empty
2856
self._load_from_string('')
2857
if section_name is None:
2858
section = self._config_obj
2860
section = self._config_obj.setdefault(section_name, {})
2861
return self.mutable_section_class(section_name, section)
2864
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2865
# unlockable stores for use with objects that can already ensure the locking
2866
# (think branches). If different stores (not based on ConfigObj) are created,
2867
# they may face the same issue.
2870
class LockableIniFileStore(IniFileStore):
2871
"""A ConfigObjStore using locks on save to ensure store integrity."""
2873
def __init__(self, transport, file_name, lock_dir_name=None):
2874
"""A config Store using ConfigObj for storage.
2876
:param transport: The transport object where the config file is located.
2878
:param file_name: The config file basename in the transport directory.
2880
if lock_dir_name is None:
2881
lock_dir_name = 'lock'
2882
self.lock_dir_name = lock_dir_name
2883
super(LockableIniFileStore, self).__init__(transport, file_name)
2884
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2886
def lock_write(self, token=None):
2887
"""Takes a write lock in the directory containing the config file.
2889
If the directory doesn't exist it is created.
2891
# FIXME: This doesn't check the ownership of the created directories as
2892
# ensure_config_dir_exists does. It should if the transport is local
2893
# -- vila 2011-04-06
2894
self.transport.create_prefix()
2895
return self._lock.lock_write(token)
2900
def break_lock(self):
2901
self._lock.break_lock()
2905
# We need to be able to override the undecorated implementation
2906
self.save_without_locking()
2908
def save_without_locking(self):
2909
super(LockableIniFileStore, self).save()
2912
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2913
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2914
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2916
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2917
# functions or a registry will make it easier and clearer for tests, focusing
2918
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2919
# on a poolie's remark)
2920
class GlobalStore(LockableIniFileStore):
2922
def __init__(self, possible_transports=None):
2923
t = transport.get_transport_from_path(
2924
config_dir(), possible_transports=possible_transports)
2925
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2928
class LocationStore(LockableIniFileStore):
2930
def __init__(self, possible_transports=None):
2931
t = transport.get_transport_from_path(
2932
config_dir(), possible_transports=possible_transports)
2933
super(LocationStore, self).__init__(t, 'locations.conf')
2936
class BranchStore(IniFileStore):
2938
def __init__(self, branch):
2939
super(BranchStore, self).__init__(branch.control_transport,
2941
self.branch = branch
2943
def lock_write(self, token=None):
2944
return self.branch.lock_write(token)
2947
return self.branch.unlock()
2951
# We need to be able to override the undecorated implementation
2952
self.save_without_locking()
2954
def save_without_locking(self):
2955
super(BranchStore, self).save()
2958
class ControlStore(LockableIniFileStore):
2960
def __init__(self, bzrdir):
2961
super(ControlStore, self).__init__(bzrdir.transport,
2963
lock_dir_name='branch_lock')
2966
class SectionMatcher(object):
2967
"""Select sections into a given Store.
2969
This is intended to be used to postpone getting an iterable of sections
2973
def __init__(self, store):
2976
def get_sections(self):
2977
# This is where we require loading the store so we can see all defined
2979
sections = self.store.get_sections()
2980
# Walk the revisions in the order provided
2985
def match(self, section):
2986
"""Does the proposed section match.
2988
:param section: A Section object.
2990
:returns: True if the section matches, False otherwise.
2992
raise NotImplementedError(self.match)
2995
class NameMatcher(SectionMatcher):
2997
def __init__(self, store, section_id):
2998
super(NameMatcher, self).__init__(store)
2999
self.section_id = section_id
3001
def match(self, section):
3002
return section.id == self.section_id
3005
class LocationSection(Section):
3007
def __init__(self, section, length, extra_path):
3008
super(LocationSection, self).__init__(section.id, section.options)
3009
self.length = length
3010
self.extra_path = extra_path
3011
self.locals = {'relpath': extra_path}
3013
def get(self, name, default=None):
3014
value = super(LocationSection, self).get(name, default)
3015
if value is not None:
3016
policy_name = self.get(name + ':policy', None)
3017
policy = _policy_value.get(policy_name, POLICY_NONE)
3018
if policy == POLICY_APPENDPATH:
3019
value = urlutils.join(value, self.extra_path)
3020
# expand section local options right now (since POLICY_APPENDPATH
3021
# will never add options references, it's ok to expand after it).
3023
for is_ref, chunk in iter_option_refs(value):
3025
chunks.append(chunk)
3028
if ref in self.locals:
3029
chunks.append(self.locals[ref])
3031
chunks.append(chunk)
3032
value = ''.join(chunks)
3036
class LocationMatcher(SectionMatcher):
3038
def __init__(self, store, location):
3039
super(LocationMatcher, self).__init__(store)
3040
if location.startswith('file://'):
3041
location = urlutils.local_path_from_url(location)
3042
self.location = location
3044
def _get_matching_sections(self):
3045
"""Get all sections matching ``location``."""
3046
# We slightly diverge from LocalConfig here by allowing the no-name
3047
# section as the most generic one and the lower priority.
3048
no_name_section = None
3050
# Filter out the no_name_section so _iter_for_location_by_parts can be
3051
# used (it assumes all sections have a name).
3052
for section in self.store.get_sections():
3053
if section.id is None:
3054
no_name_section = section
3056
all_sections.append(section)
3057
# Unfortunately _iter_for_location_by_parts deals with section names so
3058
# we have to resync.
3059
filtered_sections = _iter_for_location_by_parts(
3060
[s.id for s in all_sections], self.location)
3061
iter_all_sections = iter(all_sections)
3062
matching_sections = []
3063
if no_name_section is not None:
3064
matching_sections.append(
3065
LocationSection(no_name_section, 0, self.location))
3066
for section_id, extra_path, length in filtered_sections:
3067
# a section id is unique for a given store so it's safe to take the
3068
# first matching section while iterating. Also, all filtered
3069
# sections are part of 'all_sections' and will always be found
3072
section = iter_all_sections.next()
3073
if section_id == section.id:
3074
matching_sections.append(
3075
LocationSection(section, length, extra_path))
3077
return matching_sections
3079
def get_sections(self):
3080
# Override the default implementation as we want to change the order
3081
matching_sections = self._get_matching_sections()
3082
# We want the longest (aka more specific) locations first
3083
sections = sorted(matching_sections,
3084
key=lambda section: (section.length, section.id),
3086
# Sections mentioning 'ignore_parents' restrict the selection
3087
for section in sections:
3088
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3089
ignore = section.get('ignore_parents', None)
3090
if ignore is not None:
3091
ignore = ui.bool_from_string(ignore)
3094
# Finally, we have a valid section
3098
_option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3099
"""Describes an expandable option reference.
3101
We want to match the most embedded reference first.
3103
I.e. for '{{foo}}' we will get '{foo}',
3104
for '{bar{baz}}' we will get '{baz}'
3107
def iter_option_refs(string):
3108
# Split isolate refs so every other chunk is a ref
3110
for chunk in _option_ref_re.split(string):
3115
class Stack(object):
3116
"""A stack of configurations where an option can be defined"""
3118
def __init__(self, sections_def, store=None, mutable_section_name=None):
3119
"""Creates a stack of sections with an optional store for changes.
3121
:param sections_def: A list of Section or callables that returns an
3122
iterable of Section. This defines the Sections for the Stack and
3123
can be called repeatedly if needed.
3125
:param store: The optional Store where modifications will be
3126
recorded. If none is specified, no modifications can be done.
3128
:param mutable_section_name: The name of the MutableSection where
3129
changes are recorded. This requires the ``store`` parameter to be
3132
self.sections_def = sections_def
3134
self.mutable_section_name = mutable_section_name
3136
def get(self, name, expand=None):
3137
"""Return the *first* option value found in the sections.
3139
This is where we guarantee that sections coming from Store are loaded
3140
lazily: the loading is delayed until we need to either check that an
3141
option exists or get its value, which in turn may require to discover
3142
in which sections it can be defined. Both of these (section and option
3143
existence) require loading the store (even partially).
3145
:param name: The queried option.
3147
:param expand: Whether options references should be expanded.
3149
:returns: The value of the option.
3151
# FIXME: No caching of options nor sections yet -- vila 20110503
3153
expand = _get_expand_default_value()
3155
# Ensuring lazy loading is achieved by delaying section matching (which
3156
# implies querying the persistent storage) until it can't be avoided
3157
# anymore by using callables to describe (possibly empty) section
3159
for section_or_callable in self.sections_def:
3160
# Each section can expand to multiple ones when a callable is used
3161
if callable(section_or_callable):
3162
sections = section_or_callable()
3164
sections = [section_or_callable]
3165
for section in sections:
3166
value = section.get(name)
3167
if value is not None:
3169
if value is not None:
3171
# If the option is registered, it may provide additional info about
3174
opt = option_registry.get(name)
3178
def expand_and_convert(val):
3179
# This may need to be called twice if the value is None or ends up
3180
# being None during expansion or conversion.
3183
if isinstance(val, basestring):
3184
val = self._expand_options_in_string(val)
3186
trace.warning('Cannot expand "%s":'
3187
' %s does not support option expansion'
3188
% (name, type(val)))
3190
val = opt.convert_from_unicode(val)
3192
value = expand_and_convert(value)
3193
if opt is not None and value is None:
3194
# If the option is registered, it may provide a default value
3195
value = opt.get_default()
3196
value = expand_and_convert(value)
3197
for hook in ConfigHooks['get']:
3198
hook(self, name, value)
3201
def expand_options(self, string, env=None):
3202
"""Expand option references in the string in the configuration context.
3204
:param string: The string containing option(s) to expand.
3206
:param env: An option dict defining additional configuration options or
3207
overriding existing ones.
3209
:returns: The expanded string.
3211
return self._expand_options_in_string(string, env)
3213
def _expand_options_in_string(self, string, env=None, _refs=None):
3214
"""Expand options in the string in the configuration context.
3216
:param string: The string to be expanded.
3218
:param env: An option dict defining additional configuration options or
3219
overriding existing ones.
3221
:param _refs: Private list (FIFO) containing the options being expanded
3224
:returns: The expanded string.
3227
# Not much to expand there
3230
# What references are currently resolved (to detect loops)
3233
# We need to iterate until no more refs appear ({{foo}} will need two
3234
# iterations for example).
3239
for is_ref, chunk in iter_option_refs(result):
3241
chunks.append(chunk)
3246
raise errors.OptionExpansionLoop(string, _refs)
3248
value = self._expand_option(name, env, _refs)
3250
raise errors.ExpandingUnknownOption(name, string)
3251
chunks.append(value)
3253
result = ''.join(chunks)
3256
def _expand_option(self, name, env, _refs):
3257
if env is not None and name in env:
3258
# Special case, values provided in env takes precedence over
3262
value = self.get(name, expand=False)
3263
value = self._expand_options_in_string(value, env, _refs)
3266
def _get_mutable_section(self):
3267
"""Get the MutableSection for the Stack.
3269
This is where we guarantee that the mutable section is lazily loaded:
3270
this means we won't load the corresponding store before setting a value
3271
or deleting an option. In practice the store will often be loaded but
3272
this allows helps catching some programming errors.
3274
section = self.store.get_mutable_section(self.mutable_section_name)
3277
def set(self, name, value):
3278
"""Set a new value for the option."""
3279
section = self._get_mutable_section()
3280
section.set(name, value)
3281
for hook in ConfigHooks['set']:
3282
hook(self, name, value)
3284
def remove(self, name):
3285
"""Remove an existing option."""
3286
section = self._get_mutable_section()
3287
section.remove(name)
3288
for hook in ConfigHooks['remove']:
3292
# Mostly for debugging use
3293
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3295
def _get_overrides(self):
3296
# Hack around library_state.initialize never called
3297
if bzrlib.global_state is not None:
3298
return [bzrlib.global_state.cmdline_overrides]
3302
class _CompatibleStack(Stack):
3303
"""Place holder for compatibility with previous design.
3305
This is intended to ease the transition from the Config-based design to the
3306
Stack-based design and should not be used nor relied upon by plugins.
3308
One assumption made here is that the daughter classes will all use Stores
3309
derived from LockableIniFileStore).
3311
It implements set() by re-loading the store before applying the
3312
modification and saving it.
3314
The long term plan being to implement a single write by store to save
3315
all modifications, this class should not be used in the interim.
3318
def set(self, name, value):
3321
super(_CompatibleStack, self).set(name, value)
3322
# Force a write to persistent storage
3326
class GlobalStack(_CompatibleStack):
3327
"""Global options only stack."""
3331
gstore = GlobalStore()
3332
super(GlobalStack, self).__init__(
3333
[self._get_overrides, gstore.get_sections],
3337
class LocationStack(_CompatibleStack):
3338
"""Per-location options falling back to global options stack."""
3340
def __init__(self, location):
3341
"""Make a new stack for a location and global configuration.
3343
:param location: A URL prefix to """
3344
lstore = LocationStore()
3345
matcher = LocationMatcher(lstore, location)
3346
gstore = GlobalStore()
3347
super(LocationStack, self).__init__(
3348
[self._get_overrides,
3349
matcher.get_sections, gstore.get_sections],
3353
class BranchStack(_CompatibleStack):
3354
"""Per-location options falling back to branch then global options stack."""
3356
def __init__(self, branch):
3357
bstore = BranchStore(branch)
3358
lstore = LocationStore()
3359
matcher = LocationMatcher(lstore, branch.base)
3360
gstore = GlobalStore()
3361
super(BranchStack, self).__init__(
3362
[self._get_overrides,
3363
matcher.get_sections, bstore.get_sections, gstore.get_sections],
3365
self.branch = branch
3368
class RemoteControlStack(_CompatibleStack):
3369
"""Remote control-only options stack."""
3371
def __init__(self, bzrdir):
3372
cstore = ControlStore(bzrdir)
3373
super(RemoteControlStack, self).__init__(
3374
[cstore.get_sections],
3376
self.bzrdir = bzrdir
3379
class RemoteBranchStack(_CompatibleStack):
3380
"""Remote branch-only options stack."""
3382
def __init__(self, branch):
3383
bstore = BranchStore(branch)
3384
super(RemoteBranchStack, self).__init__(
3385
[bstore.get_sections],
3387
self.branch = branch
3390
class cmd_config(commands.Command):
3391
__doc__ = """Display, set or remove a configuration option.
3393
Display the active value for a given option.
3395
If --all is specified, NAME is interpreted as a regular expression and all
3396
matching options are displayed mentioning their scope. The active value
3397
that bzr will take into account is the first one displayed for each option.
3399
If no NAME is given, --all .* is implied.
3401
Setting a value is achieved by using name=value without spaces. The value
3402
is set in the most relevant scope and can be checked by displaying the
3406
takes_args = ['name?']
3410
# FIXME: This should be a registry option so that plugins can register
3411
# their own config files (or not) -- vila 20101002
3412
commands.Option('scope', help='Reduce the scope to the specified'
3413
' configuration file.',
3415
commands.Option('all',
3416
help='Display all the defined values for the matching options.',
3418
commands.Option('remove', help='Remove the option from'
3419
' the configuration file.'),
3422
_see_also = ['configuration']
3424
@commands.display_command
3425
def run(self, name=None, all=False, directory=None, scope=None,
3427
if directory is None:
3429
directory = urlutils.normalize_url(directory)
3431
raise errors.BzrError(
3432
'--all and --remove are mutually exclusive.')
3434
# Delete the option in the given scope
3435
self._remove_config_option(name, directory, scope)
3437
# Defaults to all options
3438
self._show_matching_options('.*', directory, scope)
3441
name, value = name.split('=', 1)
3443
# Display the option(s) value(s)
3445
self._show_matching_options(name, directory, scope)
3447
self._show_value(name, directory, scope)
3450
raise errors.BzrError(
3451
'Only one option can be set.')
3452
# Set the option value
3453
self._set_config_option(name, value, directory, scope)
3455
def _get_configs(self, directory, scope=None):
3456
"""Iterate the configurations specified by ``directory`` and ``scope``.
3458
:param directory: Where the configurations are derived from.
3460
:param scope: A specific config to start from.
3462
if scope is not None:
3463
if scope == 'bazaar':
3464
yield GlobalConfig()
3465
elif scope == 'locations':
3466
yield LocationConfig(directory)
3467
elif scope == 'branch':
3469
controldir.ControlDir.open_containing_tree_or_branch(
3471
yield br.get_config()
3475
controldir.ControlDir.open_containing_tree_or_branch(
3477
yield br.get_config()
3478
except errors.NotBranchError:
3479
yield LocationConfig(directory)
3480
yield GlobalConfig()
3482
def _show_value(self, name, directory, scope):
3484
for c in self._get_configs(directory, scope):
3487
for (oname, value, section, conf_id, parser) in c._get_options():
3489
# Display only the first value and exit
3491
# FIXME: We need to use get_user_option to take policies
3492
# into account and we need to make sure the option exists
3493
# too (hence the two for loops), this needs a better API
3495
value = c.get_user_option(name)
3496
# Quote the value appropriately
3497
value = parser._quote(value)
3498
self.outf.write('%s\n' % (value,))
3502
raise errors.NoSuchConfigOption(name)
3504
def _show_matching_options(self, name, directory, scope):
3505
name = lazy_regex.lazy_compile(name)
3506
# We want any error in the regexp to be raised *now* so we need to
3507
# avoid the delay introduced by the lazy regexp. But, we still do
3508
# want the nicer errors raised by lazy_regex.
3509
name._compile_and_collapse()
3512
for c in self._get_configs(directory, scope):
3513
for (oname, value, section, conf_id, parser) in c._get_options():
3514
if name.search(oname):
3515
if cur_conf_id != conf_id:
3516
# Explain where the options are defined
3517
self.outf.write('%s:\n' % (conf_id,))
3518
cur_conf_id = conf_id
3520
if (section not in (None, 'DEFAULT')
3521
and cur_section != section):
3522
# Display the section if it's not the default (or only)
3524
self.outf.write(' [%s]\n' % (section,))
3525
cur_section = section
3526
self.outf.write(' %s = %s\n' % (oname, value))
3528
def _set_config_option(self, name, value, directory, scope):
3529
for conf in self._get_configs(directory, scope):
3530
conf.set_user_option(name, value)
3533
raise errors.NoSuchConfig(scope)
3535
def _remove_config_option(self, name, directory, scope):
3537
raise errors.BzrCommandError(
3538
'--remove expects an option to remove.')
3540
for conf in self._get_configs(directory, scope):
3541
for (section_name, section, conf_id) in conf._get_sections():
3542
if scope is not None and conf_id != scope:
3543
# Not the right configuration file
3546
if conf_id != conf.config_id():
3547
conf = self._get_configs(directory, conf_id).next()
3548
# We use the first section in the first config where the
3549
# option is defined to remove it
3550
conf.remove_user_option(name, section_name)
3555
raise errors.NoSuchConfig(scope)
3557
raise errors.NoSuchConfigOption(name)
3561
# We need adapters that can build a Store or a Stack in a test context. Test
3562
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3563
# themselves. The builder will receive a test instance and should return a
3564
# ready-to-use store or stack. Plugins that define new store/stacks can also
3565
# register themselves here to be tested against the tests defined in
3566
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3567
# for the same tests.
3569
# The registered object should be a callable receiving a test instance
3570
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3572
test_store_builder_registry = registry.Registry()
3574
# The registered object should be a callable receiving a test instance
3575
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3577
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
