1
# Copyright (C) 2005-2012 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
75
from __future__ import absolute_import
76
from cStringIO import StringIO
81
from bzrlib.decorators import needs_write_lock
82
from bzrlib.lazy_import import lazy_import
83
lazy_import(globals(), """
105
from bzrlib.i18n import gettext
106
from bzrlib.util.configobj import configobj
114
from bzrlib.symbol_versioning import (
132
POLICY_APPENDPATH = 2
136
POLICY_NORECURSE: 'norecurse',
137
POLICY_APPENDPATH: 'appendpath',
142
'norecurse': POLICY_NORECURSE,
143
'appendpath': POLICY_APPENDPATH,
147
STORE_LOCATION = POLICY_NONE
148
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
149
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
154
def signature_policy_from_unicode(signature_string):
155
"""Convert a string to a signing policy."""
156
if signature_string.lower() == 'check-available':
157
return CHECK_IF_POSSIBLE
158
if signature_string.lower() == 'ignore':
160
if signature_string.lower() == 'require':
162
raise ValueError("Invalid signatures policy '%s'"
166
def signing_policy_from_unicode(signature_string):
167
"""Convert a string to a signing policy."""
168
if signature_string.lower() == 'when-required':
169
return SIGN_WHEN_REQUIRED
170
if signature_string.lower() == 'never':
172
if signature_string.lower() == 'always':
174
raise ValueError("Invalid signing policy '%s'"
178
class ConfigObj(configobj.ConfigObj):
180
def __init__(self, infile=None, **kwargs):
181
# We define our own interpolation mechanism calling it option expansion
182
super(ConfigObj, self).__init__(infile=infile,
186
def get_bool(self, section, key):
187
return self[section].as_bool(key)
189
def get_value(self, section, name):
190
# Try [] for the old DEFAULT section.
191
if section == "DEFAULT":
196
return self[section][name]
199
# FIXME: Until we can guarantee that each config file is loaded once and
200
# only once for a given bzrlib session, we don't want to re-read the file every
201
# time we query for an option so we cache the value (bad ! watch out for tests
202
# needing to restore the proper value). -- vila 20110219
203
_expand_default_value = None
204
def _get_expand_default_value():
205
global _expand_default_value
206
if _expand_default_value is not None:
207
return _expand_default_value
208
conf = GlobalConfig()
209
# Note that we must not use None for the expand value below or we'll run
210
# into infinite recursion. Using False really would be quite silly ;)
211
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
213
# This is an opt-in feature, you *really* need to clearly say you want
216
_expand_default_value = expand
220
class Config(object):
221
"""A configuration policy - what username, editor, gpg needs etc."""
224
super(Config, self).__init__()
227
"""Returns a unique ID for the config."""
228
raise NotImplementedError(self.config_id)
230
@deprecated_method(deprecated_in((2, 4, 0)))
231
def get_editor(self):
232
"""Get the users pop up editor."""
233
raise NotImplementedError
235
def get_change_editor(self, old_tree, new_tree):
236
from bzrlib import diff
237
cmd = self._get_change_editor()
240
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
243
def get_mail_client(self):
244
"""Get a mail client to use"""
245
selected_client = self.get_user_option('mail_client')
246
_registry = mail_client.mail_client_registry
248
mail_client_class = _registry.get(selected_client)
250
raise errors.UnknownMailClient(selected_client)
251
return mail_client_class(self)
253
def _get_signature_checking(self):
254
"""Template method to override signature checking policy."""
256
def _get_signing_policy(self):
257
"""Template method to override signature creation policy."""
261
def expand_options(self, string, env=None):
262
"""Expand option references in the string in the configuration context.
264
:param string: The string containing option to expand.
266
:param env: An option dict defining additional configuration options or
267
overriding existing ones.
269
:returns: The expanded string.
271
return self._expand_options_in_string(string, env)
273
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
274
"""Expand options in a list of strings in the configuration context.
276
:param slist: A list of strings.
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 flatten list of expanded strings.
286
# expand options in each value separately flattening lists
289
value = self._expand_options_in_string(s, env, _ref_stack)
290
if isinstance(value, list):
296
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
297
"""Expand options in the string in the configuration context.
299
:param string: The string to be expanded.
301
:param env: An option dict defining additional configuration options or
302
overriding existing ones.
304
:param _ref_stack: Private list containing the options being
305
expanded to detect loops.
307
:returns: The expanded string.
310
# Not much to expand there
312
if _ref_stack is None:
313
# What references are currently resolved (to detect loops)
315
if self.option_ref_re is None:
316
# We want to match the most embedded reference first (i.e. for
317
# '{{foo}}' we will get '{foo}',
318
# for '{bar{baz}}' we will get '{baz}'
319
self.option_ref_re = re.compile('({[^{}]+})')
321
# We need to iterate until no more refs appear ({{foo}} will need two
322
# iterations for example).
324
raw_chunks = self.option_ref_re.split(result)
325
if len(raw_chunks) == 1:
326
# Shorcut the trivial case: no refs
330
# Split will isolate refs so that every other chunk is a ref
332
for chunk in raw_chunks:
335
# Keep only non-empty strings (or we get bogus empty
336
# slots when a list value is involved).
341
if name in _ref_stack:
342
raise errors.OptionExpansionLoop(string, _ref_stack)
343
_ref_stack.append(name)
344
value = self._expand_option(name, env, _ref_stack)
346
raise errors.ExpandingUnknownOption(name, string)
347
if isinstance(value, list):
355
# Once a list appears as the result of an expansion, all
356
# callers will get a list result. This allows a consistent
357
# behavior even when some options in the expansion chain
358
# defined as strings (no comma in their value) but their
359
# expanded value is a list.
360
return self._expand_options_in_list(chunks, env, _ref_stack)
362
result = ''.join(chunks)
365
def _expand_option(self, name, env, _ref_stack):
366
if env is not None and name in env:
367
# Special case, values provided in env takes precedence over
371
# FIXME: This is a limited implementation, what we really need is a
372
# way to query the bzr config for the value of an option,
373
# respecting the scope rules (That is, once we implement fallback
374
# configs, getting the option value should restart from the top
375
# config, not the current one) -- vila 20101222
376
value = self.get_user_option(name, expand=False)
377
if isinstance(value, list):
378
value = self._expand_options_in_list(value, env, _ref_stack)
380
value = self._expand_options_in_string(value, env, _ref_stack)
383
def _get_user_option(self, option_name):
384
"""Template method to provide a user option."""
387
def get_user_option(self, option_name, expand=None):
388
"""Get a generic option - no special process, no default.
390
:param option_name: The queried option.
392
:param expand: Whether options references should be expanded.
394
:returns: The value of the option.
397
expand = _get_expand_default_value()
398
value = self._get_user_option(option_name)
400
if isinstance(value, list):
401
value = self._expand_options_in_list(value)
402
elif isinstance(value, dict):
403
trace.warning('Cannot expand "%s":'
404
' Dicts do not support option expansion'
407
value = self._expand_options_in_string(value)
408
for hook in OldConfigHooks['get']:
409
hook(self, option_name, value)
412
def get_user_option_as_bool(self, option_name, expand=None, default=None):
413
"""Get a generic option as a boolean.
415
:param expand: Allow expanding references to other config values.
416
:param default: Default value if nothing is configured
417
:return None if the option doesn't exist or its value can't be
418
interpreted as a boolean. Returns True or False otherwise.
420
s = self.get_user_option(option_name, expand=expand)
422
# The option doesn't exist
424
val = ui.bool_from_string(s)
426
# The value can't be interpreted as a boolean
427
trace.warning('Value "%s" is not a boolean for "%s"',
431
def get_user_option_as_list(self, option_name, expand=None):
432
"""Get a generic option as a list - no special process, no default.
434
:return None if the option doesn't exist. Returns the value as a list
437
l = self.get_user_option(option_name, expand=expand)
438
if isinstance(l, (str, unicode)):
439
# A single value, most probably the user forgot (or didn't care to
444
@deprecated_method(deprecated_in((2, 5, 0)))
445
def get_user_option_as_int_from_SI(self, option_name, default=None):
446
"""Get a generic option from a human readable size in SI units, e.g 10MB
448
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
449
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
452
:return Integer, expanded to its base-10 value if a proper SI unit is
453
found. If the option doesn't exist, or isn't a value in
454
SI units, return default (which defaults to None)
456
val = self.get_user_option(option_name)
457
if isinstance(val, list):
462
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
466
val = int(m.group(1))
467
if m.group(2) is not None:
468
if m.group(2).lower() == 'k':
470
elif m.group(2).lower() == 'm':
472
elif m.group(2).lower() == 'g':
475
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
476
' value {1!r} is not an SI unit.').format(
483
@deprecated_method(deprecated_in((2, 5, 0)))
484
def gpg_signing_command(self):
485
"""What program should be used to sign signatures?"""
486
result = self._gpg_signing_command()
491
def _gpg_signing_command(self):
492
"""See gpg_signing_command()."""
495
@deprecated_method(deprecated_in((2, 5, 0)))
496
def log_format(self):
497
"""What log format should be used"""
498
result = self._log_format()
503
def _log_format(self):
504
"""See log_format()."""
507
def validate_signatures_in_log(self):
508
"""Show GPG signature validity in log"""
509
result = self._validate_signatures_in_log()
516
def _validate_signatures_in_log(self):
517
"""See validate_signatures_in_log()."""
520
@deprecated_method(deprecated_in((2, 5, 0)))
521
def acceptable_keys(self):
522
"""Comma separated list of key patterns acceptable to
523
verify-signatures command"""
524
result = self._acceptable_keys()
527
def _acceptable_keys(self):
528
"""See acceptable_keys()."""
531
@deprecated_method(deprecated_in((2, 5, 0)))
532
def post_commit(self):
533
"""An ordered list of python functions to call.
535
Each function takes branch, rev_id as parameters.
537
return self._post_commit()
539
def _post_commit(self):
540
"""See Config.post_commit."""
543
def user_email(self):
544
"""Return just the email component of a username."""
545
return extract_email_address(self.username())
548
"""Return email-style username.
550
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
552
$BZR_EMAIL can be set to override this, then
553
the concrete policy type is checked, and finally
555
If no username can be found, errors.NoWhoami exception is raised.
557
v = os.environ.get('BZR_EMAIL')
559
return v.decode(osutils.get_user_encoding())
560
v = self._get_user_id()
563
return default_email()
565
def ensure_username(self):
566
"""Raise errors.NoWhoami if username is not set.
568
This method relies on the username() function raising the error.
572
@deprecated_method(deprecated_in((2, 5, 0)))
573
def signature_checking(self):
574
"""What is the current policy for signature checking?."""
575
policy = self._get_signature_checking()
576
if policy is not None:
578
return CHECK_IF_POSSIBLE
580
@deprecated_method(deprecated_in((2, 5, 0)))
581
def signing_policy(self):
582
"""What is the current policy for signature checking?."""
583
policy = self._get_signing_policy()
584
if policy is not None:
586
return SIGN_WHEN_REQUIRED
588
@deprecated_method(deprecated_in((2, 5, 0)))
589
def signature_needed(self):
590
"""Is a signature needed when committing ?."""
591
policy = self._get_signing_policy()
593
policy = self._get_signature_checking()
594
if policy is not None:
595
#this warning should go away once check_signatures is
596
#implemented (if not before)
597
trace.warning("Please use create_signatures,"
598
" not check_signatures to set signing policy.")
599
elif policy == SIGN_ALWAYS:
603
@deprecated_method(deprecated_in((2, 5, 0)))
604
def gpg_signing_key(self):
605
"""GPG user-id to sign commits"""
606
key = self.get_user_option('gpg_signing_key')
607
if key == "default" or key == None:
608
return self.user_email()
612
def get_alias(self, value):
613
return self._get_alias(value)
615
def _get_alias(self, value):
618
def get_nickname(self):
619
return self._get_nickname()
621
def _get_nickname(self):
624
def get_bzr_remote_path(self):
626
return os.environ['BZR_REMOTE_PATH']
628
path = self.get_user_option("bzr_remote_path")
633
def suppress_warning(self, warning):
634
"""Should the warning be suppressed or emitted.
636
:param warning: The name of the warning being tested.
638
:returns: True if the warning should be suppressed, False otherwise.
640
warnings = self.get_user_option_as_list('suppress_warnings')
641
if warnings is None or warning not in warnings:
646
def get_merge_tools(self):
648
for (oname, value, section, conf_id, parser) in self._get_options():
649
if oname.startswith('bzr.mergetool.'):
650
tool_name = oname[len('bzr.mergetool.'):]
651
tools[tool_name] = self.get_user_option(oname)
652
trace.mutter('loaded merge tools: %r' % tools)
655
def find_merge_tool(self, name):
656
# We fake a defaults mechanism here by checking if the given name can
657
# be found in the known_merge_tools if it's not found in the config.
658
# This should be done through the proposed config defaults mechanism
659
# when it becomes available in the future.
660
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
662
or mergetools.known_merge_tools.get(name, None))
666
class _ConfigHooks(hooks.Hooks):
667
"""A dict mapping hook names and a list of callables for configs.
671
"""Create the default hooks.
673
These are all empty initially, because by default nothing should get
676
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
677
self.add_hook('load',
678
'Invoked when a config store is loaded.'
679
' The signature is (store).',
681
self.add_hook('save',
682
'Invoked when a config store is saved.'
683
' The signature is (store).',
685
# The hooks for config options
687
'Invoked when a config option is read.'
688
' The signature is (stack, name, value).',
691
'Invoked when a config option is set.'
692
' The signature is (stack, name, value).',
694
self.add_hook('remove',
695
'Invoked when a config option is removed.'
696
' The signature is (stack, name).',
698
ConfigHooks = _ConfigHooks()
701
class _OldConfigHooks(hooks.Hooks):
702
"""A dict mapping hook names and a list of callables for configs.
706
"""Create the default hooks.
708
These are all empty initially, because by default nothing should get
711
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
712
self.add_hook('load',
713
'Invoked when a config store is loaded.'
714
' The signature is (config).',
716
self.add_hook('save',
717
'Invoked when a config store is saved.'
718
' The signature is (config).',
720
# The hooks for config options
722
'Invoked when a config option is read.'
723
' The signature is (config, name, value).',
726
'Invoked when a config option is set.'
727
' The signature is (config, name, value).',
729
self.add_hook('remove',
730
'Invoked when a config option is removed.'
731
' The signature is (config, name).',
733
OldConfigHooks = _OldConfigHooks()
736
class IniBasedConfig(Config):
737
"""A configuration policy that draws from ini files."""
739
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
741
"""Base class for configuration files using an ini-like syntax.
743
:param file_name: The configuration file path.
745
super(IniBasedConfig, self).__init__()
746
self.file_name = file_name
747
if symbol_versioning.deprecated_passed(get_filename):
748
symbol_versioning.warn(
749
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
750
' Use file_name instead.',
753
if get_filename is not None:
754
self.file_name = get_filename()
756
self.file_name = file_name
761
def from_string(cls, str_or_unicode, file_name=None, save=False):
762
"""Create a config object from a string.
764
:param str_or_unicode: A string representing the file content. This will
767
:param file_name: The configuration file path.
769
:param _save: Whether the file should be saved upon creation.
771
conf = cls(file_name=file_name)
772
conf._create_from_string(str_or_unicode, save)
775
def _create_from_string(self, str_or_unicode, save):
776
self._content = StringIO(str_or_unicode.encode('utf-8'))
777
# Some tests use in-memory configs, some other always need the config
778
# file to exist on disk.
780
self._write_config_file()
782
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
783
if self._parser is not None:
785
if symbol_versioning.deprecated_passed(file):
786
symbol_versioning.warn(
787
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
788
' Use IniBasedConfig(_content=xxx) instead.',
791
if self._content is not None:
792
co_input = self._content
793
elif self.file_name is None:
794
raise AssertionError('We have no content to create the config')
796
co_input = self.file_name
798
self._parser = ConfigObj(co_input, encoding='utf-8')
799
except configobj.ConfigObjError, e:
800
raise errors.ParseConfigError(e.errors, e.config.filename)
801
except UnicodeDecodeError:
802
raise errors.ConfigContentError(self.file_name)
803
# Make sure self.reload() will use the right file name
804
self._parser.filename = self.file_name
805
for hook in OldConfigHooks['load']:
810
"""Reload the config file from disk."""
811
if self.file_name is None:
812
raise AssertionError('We need a file name to reload the config')
813
if self._parser is not None:
814
self._parser.reload()
815
for hook in ConfigHooks['load']:
818
def _get_matching_sections(self):
819
"""Return an ordered list of (section_name, extra_path) pairs.
821
If the section contains inherited configuration, extra_path is
822
a string containing the additional path components.
824
section = self._get_section()
825
if section is not None:
826
return [(section, '')]
830
def _get_section(self):
831
"""Override this to define the section used by the config."""
834
def _get_sections(self, name=None):
835
"""Returns an iterator of the sections specified by ``name``.
837
:param name: The section name. If None is supplied, the default
838
configurations are yielded.
840
:return: A tuple (name, section, config_id) for all sections that will
841
be walked by user_get_option() in the 'right' order. The first one
842
is where set_user_option() will update the value.
844
parser = self._get_parser()
846
yield (name, parser[name], self.config_id())
848
# No section name has been given so we fallback to the configobj
849
# itself which holds the variables defined outside of any section.
850
yield (None, parser, self.config_id())
852
def _get_options(self, sections=None):
853
"""Return an ordered list of (name, value, section, config_id) tuples.
855
All options are returned with their associated value and the section
856
they appeared in. ``config_id`` is a unique identifier for the
857
configuration file the option is defined in.
859
:param sections: Default to ``_get_matching_sections`` if not
860
specified. This gives a better control to daughter classes about
861
which sections should be searched. This is a list of (name,
866
parser = self._get_parser()
868
for (section_name, _) in self._get_matching_sections():
870
section = parser[section_name]
872
# This could happen for an empty file for which we define a
873
# DEFAULT section. FIXME: Force callers to provide sections
874
# instead ? -- vila 20100930
876
sections.append((section_name, section))
877
config_id = self.config_id()
878
for (section_name, section) in sections:
879
for (name, value) in section.iteritems():
880
yield (name, parser._quote(value), section_name,
883
def _get_option_policy(self, section, option_name):
884
"""Return the policy for the given (section, option_name) pair."""
887
def _get_change_editor(self):
888
return self.get_user_option('change_editor')
890
def _get_signature_checking(self):
891
"""See Config._get_signature_checking."""
892
policy = self._get_user_option('check_signatures')
894
return signature_policy_from_unicode(policy)
896
def _get_signing_policy(self):
897
"""See Config._get_signing_policy"""
898
policy = self._get_user_option('create_signatures')
900
return signing_policy_from_unicode(policy)
902
def _get_user_id(self):
903
"""Get the user id from the 'email' key in the current section."""
904
return self._get_user_option('email')
906
def _get_user_option(self, option_name):
907
"""See Config._get_user_option."""
908
for (section, extra_path) in self._get_matching_sections():
910
value = self._get_parser().get_value(section, option_name)
913
policy = self._get_option_policy(section, option_name)
914
if policy == POLICY_NONE:
916
elif policy == POLICY_NORECURSE:
917
# norecurse items only apply to the exact path
922
elif policy == POLICY_APPENDPATH:
924
value = urlutils.join(value, extra_path)
927
raise AssertionError('Unexpected config policy %r' % policy)
931
def _gpg_signing_command(self):
932
"""See Config.gpg_signing_command."""
933
return self._get_user_option('gpg_signing_command')
935
def _log_format(self):
936
"""See Config.log_format."""
937
return self._get_user_option('log_format')
939
def _validate_signatures_in_log(self):
940
"""See Config.validate_signatures_in_log."""
941
return self._get_user_option('validate_signatures_in_log')
943
def _acceptable_keys(self):
944
"""See Config.acceptable_keys."""
945
return self._get_user_option('acceptable_keys')
947
def _post_commit(self):
948
"""See Config.post_commit."""
949
return self._get_user_option('post_commit')
951
def _get_alias(self, value):
953
return self._get_parser().get_value("ALIASES",
958
def _get_nickname(self):
959
return self.get_user_option('nickname')
961
def remove_user_option(self, option_name, section_name=None):
962
"""Remove a user option and save the configuration file.
964
:param option_name: The option to be removed.
966
:param section_name: The section the option is defined in, default to
970
parser = self._get_parser()
971
if section_name is None:
974
section = parser[section_name]
976
del section[option_name]
978
raise errors.NoSuchConfigOption(option_name)
979
self._write_config_file()
980
for hook in OldConfigHooks['remove']:
981
hook(self, option_name)
983
def _write_config_file(self):
984
if self.file_name is None:
985
raise AssertionError('We cannot save, self.file_name is None')
986
conf_dir = os.path.dirname(self.file_name)
987
ensure_config_dir_exists(conf_dir)
988
atomic_file = atomicfile.AtomicFile(self.file_name)
989
self._get_parser().write(atomic_file)
992
osutils.copy_ownership_from_path(self.file_name)
993
for hook in OldConfigHooks['save']:
997
class LockableConfig(IniBasedConfig):
998
"""A configuration needing explicit locking for access.
1000
If several processes try to write the config file, the accesses need to be
1003
Daughter classes should decorate all methods that update a config with the
1004
``@needs_write_lock`` decorator (they call, directly or indirectly, the
1005
``_write_config_file()`` method. These methods (typically ``set_option()``
1006
and variants must reload the config file from disk before calling
1007
``_write_config_file()``), this can be achieved by calling the
1008
``self.reload()`` method. Note that the lock scope should cover both the
1009
reading and the writing of the config file which is why the decorator can't
1010
be applied to ``_write_config_file()`` only.
1012
This should be enough to implement the following logic:
1013
- lock for exclusive write access,
1014
- reload the config file from disk,
1018
This logic guarantees that a writer can update a value without erasing an
1019
update made by another writer.
1024
def __init__(self, file_name):
1025
super(LockableConfig, self).__init__(file_name=file_name)
1026
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1027
# FIXME: It doesn't matter that we don't provide possible_transports
1028
# below since this is currently used only for local config files ;
1029
# local transports are not shared. But if/when we start using
1030
# LockableConfig for other kind of transports, we will need to reuse
1031
# whatever connection is already established -- vila 20100929
1032
self.transport = transport.get_transport_from_path(self.dir)
1033
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1035
def _create_from_string(self, unicode_bytes, save):
1036
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1038
# We need to handle the saving here (as opposed to IniBasedConfig)
1039
# to be able to lock
1041
self._write_config_file()
1044
def lock_write(self, token=None):
1045
"""Takes a write lock in the directory containing the config file.
1047
If the directory doesn't exist it is created.
1049
ensure_config_dir_exists(self.dir)
1050
return self._lock.lock_write(token)
1055
def break_lock(self):
1056
self._lock.break_lock()
1059
def remove_user_option(self, option_name, section_name=None):
1060
super(LockableConfig, self).remove_user_option(option_name,
1063
def _write_config_file(self):
1064
if self._lock is None or not self._lock.is_held:
1065
# NB: if the following exception is raised it probably means a
1066
# missing @needs_write_lock decorator on one of the callers.
1067
raise errors.ObjectNotLocked(self)
1068
super(LockableConfig, self)._write_config_file()
1071
class GlobalConfig(LockableConfig):
1072
"""The configuration that should be used for a specific location."""
1075
super(GlobalConfig, self).__init__(file_name=config_filename())
1077
def config_id(self):
1081
def from_string(cls, str_or_unicode, save=False):
1082
"""Create a config object from a string.
1084
:param str_or_unicode: A string representing the file content. This
1085
will be utf-8 encoded.
1087
:param save: Whether the file should be saved upon creation.
1090
conf._create_from_string(str_or_unicode, save)
1093
@deprecated_method(deprecated_in((2, 4, 0)))
1094
def get_editor(self):
1095
return self._get_user_option('editor')
1098
def set_user_option(self, option, value):
1099
"""Save option and its value in the configuration."""
1100
self._set_option(option, value, 'DEFAULT')
1102
def get_aliases(self):
1103
"""Return the aliases section."""
1104
if 'ALIASES' in self._get_parser():
1105
return self._get_parser()['ALIASES']
1110
def set_alias(self, alias_name, alias_command):
1111
"""Save the alias in the configuration."""
1112
self._set_option(alias_name, alias_command, 'ALIASES')
1115
def unset_alias(self, alias_name):
1116
"""Unset an existing alias."""
1118
aliases = self._get_parser().get('ALIASES')
1119
if not aliases or alias_name not in aliases:
1120
raise errors.NoSuchAlias(alias_name)
1121
del aliases[alias_name]
1122
self._write_config_file()
1124
def _set_option(self, option, value, section):
1126
self._get_parser().setdefault(section, {})[option] = value
1127
self._write_config_file()
1128
for hook in OldConfigHooks['set']:
1129
hook(self, option, value)
1131
def _get_sections(self, name=None):
1132
"""See IniBasedConfig._get_sections()."""
1133
parser = self._get_parser()
1134
# We don't give access to options defined outside of any section, we
1135
# used the DEFAULT section by... default.
1136
if name in (None, 'DEFAULT'):
1137
# This could happen for an empty file where the DEFAULT section
1138
# doesn't exist yet. So we force DEFAULT when yielding
1140
if 'DEFAULT' not in parser:
1141
parser['DEFAULT']= {}
1142
yield (name, parser[name], self.config_id())
1145
def remove_user_option(self, option_name, section_name=None):
1146
if section_name is None:
1147
# We need to force the default section.
1148
section_name = 'DEFAULT'
1149
# We need to avoid the LockableConfig implementation or we'll lock
1151
super(LockableConfig, self).remove_user_option(option_name,
1154
def _iter_for_location_by_parts(sections, location):
1155
"""Keep only the sessions matching the specified location.
1157
:param sections: An iterable of section names.
1159
:param location: An url or a local path to match against.
1161
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1162
number of path components in the section name, section is the section
1163
name and extra_path is the difference between location and the section
1166
``location`` will always be a local path and never a 'file://' url but the
1167
section names themselves can be in either form.
1169
location_parts = location.rstrip('/').split('/')
1171
for section in sections:
1172
# location is a local path if possible, so we need to convert 'file://'
1173
# urls in section names to local paths if necessary.
1175
# This also avoids having file:///path be a more exact
1176
# match than '/path'.
1178
# FIXME: This still raises an issue if a user defines both file:///path
1179
# *and* /path. Should we raise an error in this case -- vila 20110505
1181
if section.startswith('file://'):
1182
section_path = urlutils.local_path_from_url(section)
1184
section_path = section
1185
section_parts = section_path.rstrip('/').split('/')
1188
if len(section_parts) > len(location_parts):
1189
# More path components in the section, they can't match
1192
# Rely on zip truncating in length to the length of the shortest
1193
# argument sequence.
1194
names = zip(location_parts, section_parts)
1196
if not fnmatch.fnmatch(name[0], name[1]):
1201
# build the path difference between the section and the location
1202
extra_path = '/'.join(location_parts[len(section_parts):])
1203
yield section, extra_path, len(section_parts)
1206
class LocationConfig(LockableConfig):
1207
"""A configuration object that gives the policy for a location."""
1209
def __init__(self, location):
1210
super(LocationConfig, self).__init__(
1211
file_name=locations_config_filename())
1212
# local file locations are looked up by local path, rather than
1213
# by file url. This is because the config file is a user
1214
# file, and we would rather not expose the user to file urls.
1215
if location.startswith('file://'):
1216
location = urlutils.local_path_from_url(location)
1217
self.location = location
1219
def config_id(self):
1223
def from_string(cls, str_or_unicode, location, save=False):
1224
"""Create a config object from a string.
1226
:param str_or_unicode: A string representing the file content. This will
1229
:param location: The location url to filter the configuration.
1231
:param save: Whether the file should be saved upon creation.
1233
conf = cls(location)
1234
conf._create_from_string(str_or_unicode, save)
1237
def _get_matching_sections(self):
1238
"""Return an ordered list of section names matching this location."""
1239
matches = list(_iter_for_location_by_parts(self._get_parser(),
1241
# put the longest (aka more specific) locations first
1243
key=lambda (section, extra_path, length): (length, section),
1245
for (section, extra_path, length) in matches:
1246
yield section, extra_path
1247
# should we stop looking for parent configs here?
1249
if self._get_parser()[section].as_bool('ignore_parents'):
1254
def _get_sections(self, name=None):
1255
"""See IniBasedConfig._get_sections()."""
1256
# We ignore the name here as the only sections handled are named with
1257
# the location path and we don't expose embedded sections either.
1258
parser = self._get_parser()
1259
for name, extra_path in self._get_matching_sections():
1260
yield (name, parser[name], self.config_id())
1262
def _get_option_policy(self, section, option_name):
1263
"""Return the policy for the given (section, option_name) pair."""
1264
# check for the old 'recurse=False' flag
1266
recurse = self._get_parser()[section].as_bool('recurse')
1270
return POLICY_NORECURSE
1272
policy_key = option_name + ':policy'
1274
policy_name = self._get_parser()[section][policy_key]
1278
return _policy_value[policy_name]
1280
def _set_option_policy(self, section, option_name, option_policy):
1281
"""Set the policy for the given option name in the given section."""
1282
# The old recurse=False option affects all options in the
1283
# section. To handle multiple policies in the section, we
1284
# need to convert it to a policy_norecurse key.
1286
recurse = self._get_parser()[section].as_bool('recurse')
1290
symbol_versioning.warn(
1291
'The recurse option is deprecated as of 0.14. '
1292
'The section "%s" has been converted to use policies.'
1295
del self._get_parser()[section]['recurse']
1297
for key in self._get_parser()[section].keys():
1298
if not key.endswith(':policy'):
1299
self._get_parser()[section][key +
1300
':policy'] = 'norecurse'
1302
policy_key = option_name + ':policy'
1303
policy_name = _policy_name[option_policy]
1304
if policy_name is not None:
1305
self._get_parser()[section][policy_key] = policy_name
1307
if policy_key in self._get_parser()[section]:
1308
del self._get_parser()[section][policy_key]
1311
def set_user_option(self, option, value, store=STORE_LOCATION):
1312
"""Save option and its value in the configuration."""
1313
if store not in [STORE_LOCATION,
1314
STORE_LOCATION_NORECURSE,
1315
STORE_LOCATION_APPENDPATH]:
1316
raise ValueError('bad storage policy %r for %r' %
1319
location = self.location
1320
if location.endswith('/'):
1321
location = location[:-1]
1322
parser = self._get_parser()
1323
if not location in parser and not location + '/' in parser:
1324
parser[location] = {}
1325
elif location + '/' in parser:
1326
location = location + '/'
1327
parser[location][option]=value
1328
# the allowed values of store match the config policies
1329
self._set_option_policy(location, option, store)
1330
self._write_config_file()
1331
for hook in OldConfigHooks['set']:
1332
hook(self, option, value)
1335
class BranchConfig(Config):
1336
"""A configuration object giving the policy for a branch."""
1338
def __init__(self, branch):
1339
super(BranchConfig, self).__init__()
1340
self._location_config = None
1341
self._branch_data_config = None
1342
self._global_config = None
1343
self.branch = branch
1344
self.option_sources = (self._get_location_config,
1345
self._get_branch_data_config,
1346
self._get_global_config)
1348
def config_id(self):
1351
def _get_branch_data_config(self):
1352
if self._branch_data_config is None:
1353
self._branch_data_config = TreeConfig(self.branch)
1354
self._branch_data_config.config_id = self.config_id
1355
return self._branch_data_config
1357
def _get_location_config(self):
1358
if self._location_config is None:
1359
self._location_config = LocationConfig(self.branch.base)
1360
return self._location_config
1362
def _get_global_config(self):
1363
if self._global_config is None:
1364
self._global_config = GlobalConfig()
1365
return self._global_config
1367
def _get_best_value(self, option_name):
1368
"""This returns a user option from local, tree or global config.
1370
They are tried in that order. Use get_safe_value if trusted values
1373
for source in self.option_sources:
1374
value = getattr(source(), option_name)()
1375
if value is not None:
1379
def _get_safe_value(self, option_name):
1380
"""This variant of get_best_value never returns untrusted values.
1382
It does not return values from the branch data, because the branch may
1383
not be controlled by the user.
1385
We may wish to allow locations.conf to control whether branches are
1386
trusted in the future.
1388
for source in (self._get_location_config, self._get_global_config):
1389
value = getattr(source(), option_name)()
1390
if value is not None:
1394
def _get_user_id(self):
1395
"""Return the full user id for the branch.
1397
e.g. "John Hacker <jhacker@example.com>"
1398
This is looked up in the email controlfile for the branch.
1400
return self._get_best_value('_get_user_id')
1402
def _get_change_editor(self):
1403
return self._get_best_value('_get_change_editor')
1405
def _get_signature_checking(self):
1406
"""See Config._get_signature_checking."""
1407
return self._get_best_value('_get_signature_checking')
1409
def _get_signing_policy(self):
1410
"""See Config._get_signing_policy."""
1411
return self._get_best_value('_get_signing_policy')
1413
def _get_user_option(self, option_name):
1414
"""See Config._get_user_option."""
1415
for source in self.option_sources:
1416
value = source()._get_user_option(option_name)
1417
if value is not None:
1421
def _get_sections(self, name=None):
1422
"""See IniBasedConfig.get_sections()."""
1423
for source in self.option_sources:
1424
for section in source()._get_sections(name):
1427
def _get_options(self, sections=None):
1429
# First the locations options
1430
for option in self._get_location_config()._get_options():
1432
# Then the branch options
1433
branch_config = self._get_branch_data_config()
1434
if sections is None:
1435
sections = [('DEFAULT', branch_config._get_parser())]
1436
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1437
# Config itself has no notion of sections :( -- vila 20101001
1438
config_id = self.config_id()
1439
for (section_name, section) in sections:
1440
for (name, value) in section.iteritems():
1441
yield (name, value, section_name,
1442
config_id, branch_config._get_parser())
1443
# Then the global options
1444
for option in self._get_global_config()._get_options():
1447
def set_user_option(self, name, value, store=STORE_BRANCH,
1449
if store == STORE_BRANCH:
1450
self._get_branch_data_config().set_option(value, name)
1451
elif store == STORE_GLOBAL:
1452
self._get_global_config().set_user_option(name, value)
1454
self._get_location_config().set_user_option(name, value, store)
1457
if store in (STORE_GLOBAL, STORE_BRANCH):
1458
mask_value = self._get_location_config().get_user_option(name)
1459
if mask_value is not None:
1460
trace.warning('Value "%s" is masked by "%s" from'
1461
' locations.conf', value, mask_value)
1463
if store == STORE_GLOBAL:
1464
branch_config = self._get_branch_data_config()
1465
mask_value = branch_config.get_user_option(name)
1466
if mask_value is not None:
1467
trace.warning('Value "%s" is masked by "%s" from'
1468
' branch.conf', value, mask_value)
1470
def remove_user_option(self, option_name, section_name=None):
1471
self._get_branch_data_config().remove_option(option_name, section_name)
1473
def _gpg_signing_command(self):
1474
"""See Config.gpg_signing_command."""
1475
return self._get_safe_value('_gpg_signing_command')
1477
def _post_commit(self):
1478
"""See Config.post_commit."""
1479
return self._get_safe_value('_post_commit')
1481
def _get_nickname(self):
1482
value = self._get_explicit_nickname()
1483
if value is not None:
1485
return urlutils.unescape(self.branch.base.split('/')[-2])
1487
def has_explicit_nickname(self):
1488
"""Return true if a nickname has been explicitly assigned."""
1489
return self._get_explicit_nickname() is not None
1491
def _get_explicit_nickname(self):
1492
return self._get_best_value('_get_nickname')
1494
def _log_format(self):
1495
"""See Config.log_format."""
1496
return self._get_best_value('_log_format')
1498
def _validate_signatures_in_log(self):
1499
"""See Config.validate_signatures_in_log."""
1500
return self._get_best_value('_validate_signatures_in_log')
1502
def _acceptable_keys(self):
1503
"""See Config.acceptable_keys."""
1504
return self._get_best_value('_acceptable_keys')
1507
def ensure_config_dir_exists(path=None):
1508
"""Make sure a configuration directory exists.
1509
This makes sure that the directory exists.
1510
On windows, since configuration directories are 2 levels deep,
1511
it makes sure both the directory and the parent directory exists.
1515
if not os.path.isdir(path):
1516
if sys.platform == 'win32':
1517
parent_dir = os.path.dirname(path)
1518
if not os.path.isdir(parent_dir):
1519
trace.mutter('creating config parent directory: %r', parent_dir)
1520
os.mkdir(parent_dir)
1521
trace.mutter('creating config directory: %r', path)
1523
osutils.copy_ownership_from_path(path)
1527
"""Return per-user configuration directory.
1529
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1530
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1531
that will be used instead.
1533
TODO: Global option --config-dir to override this.
1535
base = os.environ.get('BZR_HOME', None)
1536
if sys.platform == 'win32':
1537
# environ variables on Windows are in user encoding/mbcs. So decode
1539
if base is not None:
1540
base = base.decode('mbcs')
1542
base = win32utils.get_appdata_location_unicode()
1544
base = os.environ.get('HOME', None)
1545
if base is not None:
1546
base = base.decode('mbcs')
1548
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1550
return osutils.pathjoin(base, 'bazaar', '2.0')
1552
if base is not None:
1553
base = base.decode(osutils._fs_enc)
1554
if sys.platform == 'darwin':
1556
# this takes into account $HOME
1557
base = os.path.expanduser("~")
1558
return osutils.pathjoin(base, '.bazaar')
1561
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1563
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1564
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1565
if osutils.isdir(xdg_dir):
1567
"Using configuration in XDG directory %s." % xdg_dir)
1569
base = os.path.expanduser("~")
1570
return osutils.pathjoin(base, ".bazaar")
1573
def config_filename():
1574
"""Return per-user configuration ini file filename."""
1575
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1578
def locations_config_filename():
1579
"""Return per-user configuration ini file filename."""
1580
return osutils.pathjoin(config_dir(), 'locations.conf')
1583
def authentication_config_filename():
1584
"""Return per-user authentication ini file filename."""
1585
return osutils.pathjoin(config_dir(), 'authentication.conf')
1588
def user_ignore_config_filename():
1589
"""Return the user default ignore filename"""
1590
return osutils.pathjoin(config_dir(), 'ignore')
1594
"""Return the directory name to store crash files.
1596
This doesn't implicitly create it.
1598
On Windows it's in the config directory; elsewhere it's /var/crash
1599
which may be monitored by apport. It can be overridden by
1602
if sys.platform == 'win32':
1603
return osutils.pathjoin(config_dir(), 'Crash')
1605
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1607
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1610
def xdg_cache_dir():
1611
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1612
# Possibly this should be different on Windows?
1613
e = os.environ.get('XDG_CACHE_DIR', None)
1617
return os.path.expanduser('~/.cache')
1620
def _get_default_mail_domain():
1621
"""If possible, return the assumed default email domain.
1623
:returns: string mail domain, or None.
1625
if sys.platform == 'win32':
1626
# No implementation yet; patches welcome
1629
f = open('/etc/mailname')
1630
except (IOError, OSError), e:
1633
domain = f.read().strip()
1639
def default_email():
1640
v = os.environ.get('BZR_EMAIL')
1642
return v.decode(osutils.get_user_encoding())
1643
v = os.environ.get('EMAIL')
1645
return v.decode(osutils.get_user_encoding())
1646
name, email = _auto_user_id()
1648
return u'%s <%s>' % (name, email)
1651
raise errors.NoWhoami()
1654
def _auto_user_id():
1655
"""Calculate automatic user identification.
1657
:returns: (realname, email), either of which may be None if they can't be
1660
Only used when none is set in the environment or the id file.
1662
This only returns an email address if we can be fairly sure the
1663
address is reasonable, ie if /etc/mailname is set on unix.
1665
This doesn't use the FQDN as the default domain because that may be
1666
slow, and it doesn't use the hostname alone because that's not normally
1667
a reasonable address.
1669
if sys.platform == 'win32':
1670
# No implementation to reliably determine Windows default mail
1671
# address; please add one.
1674
default_mail_domain = _get_default_mail_domain()
1675
if not default_mail_domain:
1681
w = pwd.getpwuid(uid)
1683
trace.mutter('no passwd entry for uid %d?' % uid)
1686
# we try utf-8 first, because on many variants (like Linux),
1687
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1688
# false positives. (many users will have their user encoding set to
1689
# latin-1, which cannot raise UnicodeError.)
1691
gecos = w.pw_gecos.decode('utf-8')
1693
except UnicodeError:
1695
encoding = osutils.get_user_encoding()
1696
gecos = w.pw_gecos.decode(encoding)
1697
except UnicodeError, e:
1698
trace.mutter("cannot decode passwd entry %s" % w)
1701
username = w.pw_name.decode(encoding)
1702
except UnicodeError, e:
1703
trace.mutter("cannot decode passwd entry %s" % w)
1706
comma = gecos.find(',')
1710
realname = gecos[:comma]
1712
return realname, (username + '@' + default_mail_domain)
1715
def parse_username(username):
1716
"""Parse e-mail username and return a (name, address) tuple."""
1717
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1719
return (username, '')
1721
return (match.group(1), match.group(2))
1724
def extract_email_address(e):
1725
"""Return just the address part of an email string.
1727
That is just the user@domain part, nothing else.
1728
This part is required to contain only ascii characters.
1729
If it can't be extracted, raises an error.
1731
>>> extract_email_address('Jane Tester <jane@test.com>')
1734
name, email = parse_username(e)
1736
raise errors.NoEmailInUsername(e)
1740
class TreeConfig(IniBasedConfig):
1741
"""Branch configuration data associated with its contents, not location"""
1743
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1745
def __init__(self, branch):
1746
self._config = branch._get_config()
1747
self.branch = branch
1749
def _get_parser(self, file=None):
1750
if file is not None:
1751
return IniBasedConfig._get_parser(file)
1752
return self._config._get_configobj()
1754
def get_option(self, name, section=None, default=None):
1755
self.branch.lock_read()
1757
return self._config.get_option(name, section, default)
1759
self.branch.unlock()
1761
def set_option(self, value, name, section=None):
1762
"""Set a per-branch configuration option"""
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.set_option(value, name, section)
1769
self.branch.unlock()
1771
def remove_option(self, option_name, section_name=None):
1772
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1773
# higher levels providing the right lock -- vila 20101004
1774
self.branch.lock_write()
1776
self._config.remove_option(option_name, section_name)
1778
self.branch.unlock()
1781
class AuthenticationConfig(object):
1782
"""The authentication configuration file based on a ini file.
1784
Implements the authentication.conf file described in
1785
doc/developers/authentication-ring.txt.
1788
def __init__(self, _file=None):
1789
self._config = None # The ConfigObj
1791
self._filename = authentication_config_filename()
1792
self._input = self._filename = authentication_config_filename()
1794
# Tests can provide a string as _file
1795
self._filename = None
1798
def _get_config(self):
1799
if self._config is not None:
1802
# FIXME: Should we validate something here ? Includes: empty
1803
# sections are useless, at least one of
1804
# user/password/password_encoding should be defined, etc.
1806
# Note: the encoding below declares that the file itself is utf-8
1807
# encoded, but the values in the ConfigObj are always Unicode.
1808
self._config = ConfigObj(self._input, encoding='utf-8')
1809
except configobj.ConfigObjError, e:
1810
raise errors.ParseConfigError(e.errors, e.config.filename)
1811
except UnicodeError:
1812
raise errors.ConfigContentError(self._filename)
1816
"""Save the config file, only tests should use it for now."""
1817
conf_dir = os.path.dirname(self._filename)
1818
ensure_config_dir_exists(conf_dir)
1819
f = file(self._filename, 'wb')
1821
self._get_config().write(f)
1825
def _set_option(self, section_name, option_name, value):
1826
"""Set an authentication configuration option"""
1827
conf = self._get_config()
1828
section = conf.get(section_name)
1831
section = conf[section]
1832
section[option_name] = value
1835
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1837
"""Returns the matching credentials from authentication.conf file.
1839
:param scheme: protocol
1841
:param host: the server address
1843
:param port: the associated port (optional)
1845
:param user: login (optional)
1847
:param path: the absolute path on the server (optional)
1849
:param realm: the http authentication realm (optional)
1851
:return: A dict containing the matching credentials or None.
1853
- name: the section name of the credentials in the
1854
authentication.conf file,
1855
- user: can't be different from the provided user if any,
1856
- scheme: the server protocol,
1857
- host: the server address,
1858
- port: the server port (can be None),
1859
- path: the absolute server path (can be None),
1860
- realm: the http specific authentication realm (can be None),
1861
- password: the decoded password, could be None if the credential
1862
defines only the user
1863
- verify_certificates: https specific, True if the server
1864
certificate should be verified, False otherwise.
1867
for auth_def_name, auth_def in self._get_config().items():
1868
if type(auth_def) is not configobj.Section:
1869
raise ValueError("%s defined outside a section" % auth_def_name)
1871
a_scheme, a_host, a_user, a_path = map(
1872
auth_def.get, ['scheme', 'host', 'user', 'path'])
1875
a_port = auth_def.as_int('port')
1879
raise ValueError("'port' not numeric in %s" % auth_def_name)
1881
a_verify_certificates = auth_def.as_bool('verify_certificates')
1883
a_verify_certificates = True
1886
"'verify_certificates' not boolean in %s" % auth_def_name)
1889
if a_scheme is not None and scheme != a_scheme:
1891
if a_host is not None:
1892
if not (host == a_host
1893
or (a_host.startswith('.') and host.endswith(a_host))):
1895
if a_port is not None and port != a_port:
1897
if (a_path is not None and path is not None
1898
and not path.startswith(a_path)):
1900
if (a_user is not None and user is not None
1901
and a_user != user):
1902
# Never contradict the caller about the user to be used
1907
# Prepare a credentials dictionary with additional keys
1908
# for the credential providers
1909
credentials = dict(name=auth_def_name,
1916
password=auth_def.get('password', None),
1917
verify_certificates=a_verify_certificates)
1918
# Decode the password in the credentials (or get one)
1919
self.decode_password(credentials,
1920
auth_def.get('password_encoding', None))
1921
if 'auth' in debug.debug_flags:
1922
trace.mutter("Using authentication section: %r", auth_def_name)
1925
if credentials is None:
1926
# No credentials were found in authentication.conf, try the fallback
1927
# credentials stores.
1928
credentials = credential_store_registry.get_fallback_credentials(
1929
scheme, host, port, user, path, realm)
1933
def set_credentials(self, name, host, user, scheme=None, password=None,
1934
port=None, path=None, verify_certificates=None,
1936
"""Set authentication credentials for a host.
1938
Any existing credentials with matching scheme, host, port and path
1939
will be deleted, regardless of name.
1941
:param name: An arbitrary name to describe this set of credentials.
1942
:param host: Name of the host that accepts these credentials.
1943
:param user: The username portion of these credentials.
1944
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1946
:param password: Password portion of these credentials.
1947
:param port: The IP port on the host that these credentials apply to.
1948
:param path: A filesystem path on the host that these credentials
1950
:param verify_certificates: On https, verify server certificates if
1952
:param realm: The http authentication realm (optional).
1954
values = {'host': host, 'user': user}
1955
if password is not None:
1956
values['password'] = password
1957
if scheme is not None:
1958
values['scheme'] = scheme
1959
if port is not None:
1960
values['port'] = '%d' % port
1961
if path is not None:
1962
values['path'] = path
1963
if verify_certificates is not None:
1964
values['verify_certificates'] = str(verify_certificates)
1965
if realm is not None:
1966
values['realm'] = realm
1967
config = self._get_config()
1969
for section, existing_values in config.items():
1970
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1971
if existing_values.get(key) != values.get(key):
1975
config.update({name: values})
1978
def get_user(self, scheme, host, port=None, realm=None, path=None,
1979
prompt=None, ask=False, default=None):
1980
"""Get a user from authentication file.
1982
:param scheme: protocol
1984
:param host: the server address
1986
:param port: the associated port (optional)
1988
:param realm: the realm sent by the server (optional)
1990
:param path: the absolute path on the server (optional)
1992
:param ask: Ask the user if there is no explicitly configured username
1995
:param default: The username returned if none is defined (optional).
1997
:return: The found user.
1999
credentials = self.get_credentials(scheme, host, port, user=None,
2000
path=path, realm=realm)
2001
if credentials is not None:
2002
user = credentials['user']
2008
# Create a default prompt suitable for most cases
2009
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
2010
# Special handling for optional fields in the prompt
2011
if port is not None:
2012
prompt_host = '%s:%d' % (host, port)
2015
user = ui.ui_factory.get_username(prompt, host=prompt_host)
2020
def get_password(self, scheme, host, user, port=None,
2021
realm=None, path=None, prompt=None):
2022
"""Get a password from authentication file or prompt the user for one.
2024
:param scheme: protocol
2026
:param host: the server address
2028
:param port: the associated port (optional)
2032
:param realm: the realm sent by the server (optional)
2034
:param path: the absolute path on the server (optional)
2036
:return: The found password or the one entered by the user.
2038
credentials = self.get_credentials(scheme, host, port, user, path,
2040
if credentials is not None:
2041
password = credentials['password']
2042
if password is not None and scheme is 'ssh':
2043
trace.warning('password ignored in section [%s],'
2044
' use an ssh agent instead'
2045
% credentials['name'])
2049
# Prompt user only if we could't find a password
2050
if password is None:
2052
# Create a default prompt suitable for most cases
2053
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2054
# Special handling for optional fields in the prompt
2055
if port is not None:
2056
prompt_host = '%s:%d' % (host, port)
2059
password = ui.ui_factory.get_password(prompt,
2060
host=prompt_host, user=user)
2063
def decode_password(self, credentials, encoding):
2065
cs = credential_store_registry.get_credential_store(encoding)
2067
raise ValueError('%r is not a known password_encoding' % encoding)
2068
credentials['password'] = cs.decode_password(credentials)
2072
class CredentialStoreRegistry(registry.Registry):
2073
"""A class that registers credential stores.
2075
A credential store provides access to credentials via the password_encoding
2076
field in authentication.conf sections.
2078
Except for stores provided by bzr itself, most stores are expected to be
2079
provided by plugins that will therefore use
2080
register_lazy(password_encoding, module_name, member_name, help=help,
2081
fallback=fallback) to install themselves.
2083
A fallback credential store is one that is queried if no credentials can be
2084
found via authentication.conf.
2087
def get_credential_store(self, encoding=None):
2088
cs = self.get(encoding)
2093
def is_fallback(self, name):
2094
"""Check if the named credentials store should be used as fallback."""
2095
return self.get_info(name)
2097
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2098
path=None, realm=None):
2099
"""Request credentials from all fallback credentials stores.
2101
The first credentials store that can provide credentials wins.
2104
for name in self.keys():
2105
if not self.is_fallback(name):
2107
cs = self.get_credential_store(name)
2108
credentials = cs.get_credentials(scheme, host, port, user,
2110
if credentials is not None:
2111
# We found some credentials
2115
def register(self, key, obj, help=None, override_existing=False,
2117
"""Register a new object to a name.
2119
:param key: This is the key to use to request the object later.
2120
:param obj: The object to register.
2121
:param help: Help text for this entry. This may be a string or
2122
a callable. If it is a callable, it should take two
2123
parameters (registry, key): this registry and the key that
2124
the help was registered under.
2125
:param override_existing: Raise KeyErorr if False and something has
2126
already been registered for that key. If True, ignore if there
2127
is an existing key (always register the new value).
2128
:param fallback: Whether this credential store should be
2131
return super(CredentialStoreRegistry,
2132
self).register(key, obj, help, info=fallback,
2133
override_existing=override_existing)
2135
def register_lazy(self, key, module_name, member_name,
2136
help=None, override_existing=False,
2138
"""Register a new credential store to be loaded on request.
2140
:param module_name: The python path to the module. Such as 'os.path'.
2141
:param member_name: The member of the module to return. If empty or
2142
None, get() will return the module itself.
2143
:param help: Help text for this entry. This may be a string or
2145
:param override_existing: If True, replace the existing object
2146
with the new one. If False, if there is already something
2147
registered with the same key, raise a KeyError
2148
:param fallback: Whether this credential store should be
2151
return super(CredentialStoreRegistry, self).register_lazy(
2152
key, module_name, member_name, help,
2153
info=fallback, override_existing=override_existing)
2156
credential_store_registry = CredentialStoreRegistry()
2159
class CredentialStore(object):
2160
"""An abstract class to implement storage for credentials"""
2162
def decode_password(self, credentials):
2163
"""Returns a clear text password for the provided credentials."""
2164
raise NotImplementedError(self.decode_password)
2166
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2168
"""Return the matching credentials from this credential store.
2170
This method is only called on fallback credential stores.
2172
raise NotImplementedError(self.get_credentials)
2176
class PlainTextCredentialStore(CredentialStore):
2177
__doc__ = """Plain text credential store for the authentication.conf file"""
2179
def decode_password(self, credentials):
2180
"""See CredentialStore.decode_password."""
2181
return credentials['password']
2184
credential_store_registry.register('plain', PlainTextCredentialStore,
2185
help=PlainTextCredentialStore.__doc__)
2186
credential_store_registry.default_key = 'plain'
2189
class BzrDirConfig(object):
2191
def __init__(self, bzrdir):
2192
self._bzrdir = bzrdir
2193
self._config = bzrdir._get_config()
2195
def set_default_stack_on(self, value):
2196
"""Set the default stacking location.
2198
It may be set to a location, or None.
2200
This policy affects all branches contained by this bzrdir, except for
2201
those under repositories.
2203
if self._config is None:
2204
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2206
self._config.set_option('', 'default_stack_on')
2208
self._config.set_option(value, 'default_stack_on')
2210
def get_default_stack_on(self):
2211
"""Return the default stacking location.
2213
This will either be a location, or None.
2215
This policy affects all branches contained by this bzrdir, except for
2216
those under repositories.
2218
if self._config is None:
2220
value = self._config.get_option('default_stack_on')
2226
class TransportConfig(object):
2227
"""A Config that reads/writes a config file on a Transport.
2229
It is a low-level object that considers config data to be name/value pairs
2230
that may be associated with a section. Assigning meaning to these values
2231
is done at higher levels like TreeConfig.
2234
def __init__(self, transport, filename):
2235
self._transport = transport
2236
self._filename = filename
2238
def get_option(self, name, section=None, default=None):
2239
"""Return the value associated with a named option.
2241
:param name: The name of the value
2242
:param section: The section the option is in (if any)
2243
:param default: The value to return if the value is not set
2244
:return: The value or default value
2246
configobj = self._get_configobj()
2248
section_obj = configobj
2251
section_obj = configobj[section]
2254
value = section_obj.get(name, default)
2255
for hook in OldConfigHooks['get']:
2256
hook(self, name, value)
2259
def set_option(self, value, name, section=None):
2260
"""Set the value associated with a named option.
2262
:param value: The value to set
2263
:param name: The name of the value to set
2264
:param section: The section the option is in (if any)
2266
configobj = self._get_configobj()
2268
configobj[name] = value
2270
configobj.setdefault(section, {})[name] = value
2271
for hook in OldConfigHooks['set']:
2272
hook(self, name, value)
2273
self._set_configobj(configobj)
2275
def remove_option(self, option_name, section_name=None):
2276
configobj = self._get_configobj()
2277
if section_name is None:
2278
del configobj[option_name]
2280
del configobj[section_name][option_name]
2281
for hook in OldConfigHooks['remove']:
2282
hook(self, option_name)
2283
self._set_configobj(configobj)
2285
def _get_config_file(self):
2287
f = StringIO(self._transport.get_bytes(self._filename))
2288
for hook in OldConfigHooks['load']:
2291
except errors.NoSuchFile:
2293
except errors.PermissionDenied, e:
2294
trace.warning("Permission denied while trying to open "
2295
"configuration file %s.", urlutils.unescape_for_display(
2296
urlutils.join(self._transport.base, self._filename), "utf-8"))
2299
def _external_url(self):
2300
return urlutils.join(self._transport.external_url(), self._filename)
2302
def _get_configobj(self):
2303
f = self._get_config_file()
2306
conf = ConfigObj(f, encoding='utf-8')
2307
except configobj.ConfigObjError, e:
2308
raise errors.ParseConfigError(e.errors, self._external_url())
2309
except UnicodeDecodeError:
2310
raise errors.ConfigContentError(self._external_url())
2315
def _set_configobj(self, configobj):
2316
out_file = StringIO()
2317
configobj.write(out_file)
2319
self._transport.put_file(self._filename, out_file)
2320
for hook in OldConfigHooks['save']:
2324
class Option(object):
2325
"""An option definition.
2327
The option *values* are stored in config files and found in sections.
2329
Here we define various properties about the option itself, its default
2330
value, how to convert it from stores, what to do when invalid values are
2331
encoutered, in which config files it can be stored.
2334
def __init__(self, name, override_from_env=None,
2335
default=None, default_from_env=None,
2336
help=None, from_unicode=None, invalid=None, unquote=True):
2337
"""Build an option definition.
2339
:param name: the name used to refer to the option.
2341
:param override_from_env: A list of environment variables which can
2342
provide override any configuration setting.
2344
:param default: the default value to use when none exist in the config
2345
stores. This is either a string that ``from_unicode`` will convert
2346
into the proper type, a callable returning a unicode string so that
2347
``from_unicode`` can be used on the return value, or a python
2348
object that can be stringified (so only the empty list is supported
2351
:param default_from_env: A list of environment variables which can
2352
provide a default value. 'default' will be used only if none of the
2353
variables specified here are set in the environment.
2355
:param help: a doc string to explain the option to the user.
2357
:param from_unicode: a callable to convert the unicode string
2358
representing the option value in a store. This is not called for
2361
:param invalid: the action to be taken when an invalid value is
2362
encountered in a store. This is called only when from_unicode is
2363
invoked to convert a string and returns None or raise ValueError or
2364
TypeError. Accepted values are: None (ignore invalid values),
2365
'warning' (emit a warning), 'error' (emit an error message and
2368
:param unquote: should the unicode value be unquoted before conversion.
2369
This should be used only when the store providing the values cannot
2370
safely unquote them (see http://pad.lv/906897). It is provided so
2371
daughter classes can handle the quoting themselves.
2373
if override_from_env is None:
2374
override_from_env = []
2375
if default_from_env is None:
2376
default_from_env = []
2378
self.override_from_env = override_from_env
2379
# Convert the default value to a unicode string so all values are
2380
# strings internally before conversion (via from_unicode) is attempted.
2383
elif isinstance(default, list):
2384
# Only the empty list is supported
2386
raise AssertionError(
2387
'Only empty lists are supported as default values')
2389
elif isinstance(default, (str, unicode, bool, int, float)):
2390
# Rely on python to convert strings, booleans and integers
2391
self.default = u'%s' % (default,)
2392
elif callable(default):
2393
self.default = default
2395
# other python objects are not expected
2396
raise AssertionError('%r is not supported as a default value'
2398
self.default_from_env = default_from_env
2400
self.from_unicode = from_unicode
2401
self.unquote = unquote
2402
if invalid and invalid not in ('warning', 'error'):
2403
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2404
self.invalid = invalid
2406
def convert_from_unicode(self, store, unicode_value):
2407
if self.unquote and store is not None and unicode_value is not None:
2408
unicode_value = store.unquote(unicode_value)
2409
if self.from_unicode is None or unicode_value is None:
2410
# Don't convert or nothing to convert
2411
return unicode_value
2413
converted = self.from_unicode(unicode_value)
2414
except (ValueError, TypeError):
2415
# Invalid values are ignored
2417
if converted is None and self.invalid is not None:
2418
# The conversion failed
2419
if self.invalid == 'warning':
2420
trace.warning('Value "%s" is not valid for "%s"',
2421
unicode_value, self.name)
2422
elif self.invalid == 'error':
2423
raise errors.ConfigOptionValueError(self.name, unicode_value)
2426
def get_override(self):
2428
for var in self.override_from_env:
2430
# If the env variable is defined, its value takes precedence
2431
value = os.environ[var].decode(osutils.get_user_encoding())
2437
def get_default(self):
2439
for var in self.default_from_env:
2441
# If the env variable is defined, its value is the default one
2442
value = os.environ[var].decode(osutils.get_user_encoding())
2447
# Otherwise, fallback to the value defined at registration
2448
if callable(self.default):
2449
value = self.default()
2450
if not isinstance(value, unicode):
2451
raise AssertionError(
2452
'Callable default values should be unicode')
2454
value = self.default
2457
def get_help_text(self, additional_see_also=None, plain=True):
2459
from bzrlib import help_topics
2460
result += help_topics._format_see_also(additional_see_also)
2462
result = help_topics.help_as_plain_text(result)
2466
# Predefined converters to get proper values from store
2468
def bool_from_store(unicode_str):
2469
return ui.bool_from_string(unicode_str)
2472
def int_from_store(unicode_str):
2473
return int(unicode_str)
2476
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2478
def int_SI_from_store(unicode_str):
2479
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2481
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2482
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2485
:return Integer, expanded to its base-10 value if a proper SI unit is
2486
found, None otherwise.
2488
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2489
p = re.compile(regexp, re.IGNORECASE)
2490
m = p.match(unicode_str)
2493
val, _, unit = m.groups()
2497
coeff = _unit_suffixes[unit.upper()]
2499
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2504
def float_from_store(unicode_str):
2505
return float(unicode_str)
2508
# Use a an empty dict to initialize an empty configobj avoiding all
2509
# parsing and encoding checks
2510
_list_converter_config = configobj.ConfigObj(
2511
{}, encoding='utf-8', list_values=True, interpolation=False)
2514
class ListOption(Option):
2516
def __init__(self, name, default=None, default_from_env=None,
2517
help=None, invalid=None):
2518
"""A list Option definition.
2520
This overrides the base class so the conversion from a unicode string
2521
can take quoting into account.
2523
super(ListOption, self).__init__(
2524
name, default=default, default_from_env=default_from_env,
2525
from_unicode=self.from_unicode, help=help,
2526
invalid=invalid, unquote=False)
2528
def from_unicode(self, unicode_str):
2529
if not isinstance(unicode_str, basestring):
2531
# Now inject our string directly as unicode. All callers got their
2532
# value from configobj, so values that need to be quoted are already
2534
_list_converter_config.reset()
2535
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2536
maybe_list = _list_converter_config['list']
2537
if isinstance(maybe_list, basestring):
2539
# A single value, most probably the user forgot (or didn't care
2540
# to add) the final ','
2543
# The empty string, convert to empty list
2546
# We rely on ConfigObj providing us with a list already
2551
class OptionRegistry(registry.Registry):
2552
"""Register config options by their name.
2554
This overrides ``registry.Registry`` to simplify registration by acquiring
2555
some information from the option object itself.
2558
def register(self, option):
2559
"""Register a new option to its name.
2561
:param option: The option to register. Its name is used as the key.
2563
super(OptionRegistry, self).register(option.name, option,
2566
def register_lazy(self, key, module_name, member_name):
2567
"""Register a new option to be loaded on request.
2569
:param key: the key to request the option later. Since the registration
2570
is lazy, it should be provided and match the option name.
2572
:param module_name: the python path to the module. Such as 'os.path'.
2574
:param member_name: the member of the module to return. If empty or
2575
None, get() will return the module itself.
2577
super(OptionRegistry, self).register_lazy(key,
2578
module_name, member_name)
2580
def get_help(self, key=None):
2581
"""Get the help text associated with the given key"""
2582
option = self.get(key)
2583
the_help = option.help
2584
if callable(the_help):
2585
return the_help(self, key)
2589
option_registry = OptionRegistry()
2592
# Registered options in lexicographical order
2594
option_registry.register(
2595
Option('append_revisions_only',
2596
default=None, from_unicode=bool_from_store, invalid='warning',
2598
Whether to only append revisions to the mainline.
2600
If this is set to true, then it is not possible to change the
2601
existing mainline of the branch.
2603
option_registry.register(
2604
ListOption('acceptable_keys',
2607
List of GPG key patterns which are acceptable for verification.
2609
option_registry.register(
2610
Option('add.maximum_file_size',
2611
default=u'20MB', from_unicode=int_SI_from_store,
2613
Size above which files should be added manually.
2615
Files below this size are added automatically when using ``bzr add`` without
2618
A negative value means disable the size check.
2620
option_registry.register(
2622
default=None, from_unicode=bool_from_store,
2624
Is the branch bound to ``bound_location``.
2626
If set to "True", the branch should act as a checkout, and push each commit to
2627
the bound_location. This option is normally set by ``bind``/``unbind``.
2629
See also: bound_location.
2631
option_registry.register(
2632
Option('bound_location',
2635
The location that commits should go to when acting as a checkout.
2637
This option is normally set by ``bind``.
2641
option_registry.register(
2642
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2644
Whether revisions associated with tags should be fetched.
2646
option_registry.register(
2647
Option('bzr.workingtree.worth_saving_limit', default=10,
2648
from_unicode=int_from_store, invalid='warning',
2650
How many changes before saving the dirstate.
2652
-1 means that we will never rewrite the dirstate file for only
2653
stat-cache changes. Regardless of this setting, we will always rewrite
2654
the dirstate file if a file is added/removed/renamed/etc. This flag only
2655
affects the behavior of updating the dirstate file after we notice that
2656
a file has been touched.
2658
option_registry.register(
2659
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2660
from_unicode=signature_policy_from_unicode,
2662
GPG checking policy.
2664
Possible values: require, ignore, check-available (default)
2666
this option will control whether bzr will require good gpg
2667
signatures, ignore them, or check them if they are
2670
option_registry.register(
2671
Option('child_submit_format',
2672
help='''The preferred format of submissions to this branch.'''))
2673
option_registry.register(
2674
Option('child_submit_to',
2675
help='''Where submissions to this branch are mailed to.'''))
2676
option_registry.register(
2677
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2678
from_unicode=signing_policy_from_unicode,
2682
Possible values: always, never, when-required (default)
2684
This option controls whether bzr will always create
2685
gpg signatures or not on commits.
2687
option_registry.register(
2688
Option('dirstate.fdatasync', default=True,
2689
from_unicode=bool_from_store,
2691
Flush dirstate changes onto physical disk?
2693
If true (default), working tree metadata changes are flushed through the
2694
OS buffers to physical disk. This is somewhat slower, but means data
2695
should not be lost if the machine crashes. See also repository.fdatasync.
2697
option_registry.register(
2698
ListOption('debug_flags', default=[],
2699
help='Debug flags to activate.'))
2700
option_registry.register(
2701
Option('default_format', default='2a',
2702
help='Format used when creating branches.'))
2703
option_registry.register(
2704
Option('dpush_strict', default=None,
2705
from_unicode=bool_from_store,
2707
The default value for ``dpush --strict``.
2709
If present, defines the ``--strict`` option default value for checking
2710
uncommitted changes before pushing into a different VCS without any
2711
custom bzr metadata.
2713
option_registry.register(
2715
help='The command called to launch an editor to enter a message.'))
2716
option_registry.register(
2717
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2718
help='The users identity'))
2719
option_registry.register(
2720
Option('gpg_signing_command',
2723
Program to use use for creating signatures.
2725
This should support at least the -u and --clearsign options.
2727
option_registry.register(
2728
Option('gpg_signing_key',
2731
GPG key to use for signing.
2733
This defaults to the first key associated with the users email.
2735
option_registry.register(
2736
Option('ignore_missing_extensions', default=False,
2737
from_unicode=bool_from_store,
2739
Control the missing extensions warning display.
2741
The warning will not be emitted if set to True.
2743
option_registry.register(
2745
help='Language to translate messages into.'))
2746
option_registry.register(
2747
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2749
Steal locks that appears to be dead.
2751
If set to True, bzr will check if a lock is supposed to be held by an
2752
active process from the same user on the same machine. If the user and
2753
machine match, but no process with the given PID is active, then bzr
2754
will automatically break the stale lock, and create a new lock for
2756
Otherwise, bzr will prompt as normal to break the lock.
2758
option_registry.register(
2759
Option('log_format', default='long',
2761
Log format to use when displaying revisions.
2763
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2764
may be provided by plugins.
2766
option_registry.register(
2767
Option('output_encoding',
2768
help= 'Unicode encoding for output'
2769
' (terminal encoding if not specified).'))
2770
option_registry.register(
2771
Option('parent_location',
2774
The location of the default branch for pull or merge.
2776
This option is normally set when creating a branch, the first ``pull`` or by
2777
``pull --remember``.
2779
option_registry.register(
2780
Option('post_commit', default=None,
2782
Post commit functions.
2784
An ordered list of python functions to call, separated by spaces.
2786
Each function takes branch, rev_id as parameters.
2788
option_registry.register(
2789
Option('public_branch',
2792
A publically-accessible version of this branch.
2794
This implies that the branch setting this option is not publically-accessible.
2795
Used and set by ``bzr send``.
2797
option_registry.register(
2798
Option('push_location',
2801
The location of the default branch for push.
2803
This option is normally set by the first ``push`` or ``push --remember``.
2805
option_registry.register(
2806
Option('push_strict', default=None,
2807
from_unicode=bool_from_store,
2809
The default value for ``push --strict``.
2811
If present, defines the ``--strict`` option default value for checking
2812
uncommitted changes before sending a merge directive.
2814
option_registry.register(
2815
Option('repository.fdatasync', default=True,
2816
from_unicode=bool_from_store,
2818
Flush repository changes onto physical disk?
2820
If true (default), repository changes are flushed through the OS buffers
2821
to physical disk. This is somewhat slower, but means data should not be
2822
lost if the machine crashes. See also dirstate.fdatasync.
2824
option_registry.register_lazy('smtp_server',
2825
'bzrlib.smtp_connection', 'smtp_server')
2826
option_registry.register_lazy('smtp_password',
2827
'bzrlib.smtp_connection', 'smtp_password')
2828
option_registry.register_lazy('smtp_username',
2829
'bzrlib.smtp_connection', 'smtp_username')
2830
option_registry.register(
2831
Option('selftest.timeout',
2833
from_unicode=int_from_store,
2834
help='Abort selftest if one test takes longer than this many seconds',
2837
option_registry.register(
2838
Option('send_strict', default=None,
2839
from_unicode=bool_from_store,
2841
The default value for ``send --strict``.
2843
If present, defines the ``--strict`` option default value for checking
2844
uncommitted changes before sending a bundle.
2847
option_registry.register(
2848
Option('serve.client_timeout',
2849
default=300.0, from_unicode=float_from_store,
2850
help="If we wait for a new request from a client for more than"
2851
" X seconds, consider the client idle, and hangup."))
2852
option_registry.register(
2853
Option('stacked_on_location',
2855
help="""The location where this branch is stacked on."""))
2856
option_registry.register(
2857
Option('submit_branch',
2860
The branch you intend to submit your current work to.
2862
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2863
by the ``submit:`` revision spec.
2865
option_registry.register(
2867
help='''Where submissions from this branch are mailed to.'''))
2869
option_registry.register_lazy('ssl.ca_certs',
2870
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2872
option_registry.register_lazy('ssl.cert_reqs',
2873
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2877
class Section(object):
2878
"""A section defines a dict of option name => value.
2880
This is merely a read-only dict which can add some knowledge about the
2881
options. It is *not* a python dict object though and doesn't try to mimic
2885
def __init__(self, section_id, options):
2886
self.id = section_id
2887
# We re-use the dict-like object received
2888
self.options = options
2890
def get(self, name, default=None, expand=True):
2891
return self.options.get(name, default)
2893
def iter_option_names(self):
2894
for k in self.options.iterkeys():
2898
# Mostly for debugging use
2899
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2902
_NewlyCreatedOption = object()
2903
"""Was the option created during the MutableSection lifetime"""
2904
_DeletedOption = object()
2905
"""Was the option deleted during the MutableSection lifetime"""
2908
class MutableSection(Section):
2909
"""A section allowing changes and keeping track of the original values."""
2911
def __init__(self, section_id, options):
2912
super(MutableSection, self).__init__(section_id, options)
2913
self.reset_changes()
2915
def set(self, name, value):
2916
if name not in self.options:
2917
# This is a new option
2918
self.orig[name] = _NewlyCreatedOption
2919
elif name not in self.orig:
2920
self.orig[name] = self.get(name, None)
2921
self.options[name] = value
2923
def remove(self, name):
2924
if name not in self.orig:
2925
self.orig[name] = self.get(name, None)
2926
del self.options[name]
2928
def reset_changes(self):
2931
def apply_changes(self, dirty, store):
2932
"""Apply option value changes.
2934
``self`` has been reloaded from the persistent storage. ``dirty``
2935
contains the changes made since the previous loading.
2937
:param dirty: the mutable section containing the changes.
2939
:param store: the store containing the section
2941
for k, expected in dirty.orig.iteritems():
2942
actual = dirty.get(k, _DeletedOption)
2943
reloaded = self.get(k, _NewlyCreatedOption)
2944
if actual is _DeletedOption:
2945
if k in self.options:
2949
# Report concurrent updates in an ad-hoc way. This should only
2950
# occurs when different processes try to update the same option
2951
# which is not supported (as in: the config framework is not meant
2952
# to be used a sharing mechanism).
2953
if expected != reloaded:
2954
if actual is _DeletedOption:
2955
actual = '<DELETED>'
2956
if reloaded is _NewlyCreatedOption:
2957
reloaded = '<CREATED>'
2958
if expected is _NewlyCreatedOption:
2959
expected = '<CREATED>'
2960
# Someone changed the value since we get it from the persistent
2962
trace.warning(gettext(
2963
"Option {0} in section {1} of {2} was changed"
2964
" from {3} to {4}. The {5} value will be saved.".format(
2965
k, self.id, store.external_url(), expected,
2967
# No need to keep track of these changes
2968
self.reset_changes()
2971
class Store(object):
2972
"""Abstract interface to persistent storage for configuration options."""
2974
readonly_section_class = Section
2975
mutable_section_class = MutableSection
2978
# Which sections need to be saved
2979
self.dirty_sections = []
2981
def is_loaded(self):
2982
"""Returns True if the Store has been loaded.
2984
This is used to implement lazy loading and ensure the persistent
2985
storage is queried only when needed.
2987
raise NotImplementedError(self.is_loaded)
2990
"""Loads the Store from persistent storage."""
2991
raise NotImplementedError(self.load)
2993
def _load_from_string(self, bytes):
2994
"""Create a store from a string in configobj syntax.
2996
:param bytes: A string representing the file content.
2998
raise NotImplementedError(self._load_from_string)
3001
"""Unloads the Store.
3003
This should make is_loaded() return False. This is used when the caller
3004
knows that the persistent storage has changed or may have change since
3007
raise NotImplementedError(self.unload)
3009
def quote(self, value):
3010
"""Quote a configuration option value for storing purposes.
3012
This allows Stacks to present values as they will be stored.
3016
def unquote(self, value):
3017
"""Unquote a configuration option value into unicode.
3019
The received value is quoted as stored.
3024
"""Saves the Store to persistent storage."""
3025
raise NotImplementedError(self.save)
3027
def _need_saving(self):
3028
for s in self.dirty_sections:
3030
# At least one dirty section contains a modification
3034
def apply_changes(self, dirty_sections):
3035
"""Apply changes from dirty sections while checking for coherency.
3037
The Store content is discarded and reloaded from persistent storage to
3038
acquire up-to-date values.
3040
Dirty sections are MutableSection which kept track of the value they
3041
are expected to update.
3043
# We need an up-to-date version from the persistent storage, unload the
3044
# store. The reload will occur when needed (triggered by the first
3045
# get_mutable_section() call below.
3047
# Apply the changes from the preserved dirty sections
3048
for dirty in dirty_sections:
3049
clean = self.get_mutable_section(dirty.id)
3050
clean.apply_changes(dirty, self)
3051
# Everything is clean now
3052
self.dirty_sections = []
3054
def save_changes(self):
3055
"""Saves the Store to persistent storage if changes occurred.
3057
Apply the changes recorded in the mutable sections to a store content
3058
refreshed from persistent storage.
3060
raise NotImplementedError(self.save_changes)
3062
def external_url(self):
3063
raise NotImplementedError(self.external_url)
3065
def get_sections(self):
3066
"""Returns an ordered iterable of existing sections.
3068
:returns: An iterable of (store, section).
3070
raise NotImplementedError(self.get_sections)
3072
def get_mutable_section(self, section_id=None):
3073
"""Returns the specified mutable section.
3075
:param section_id: The section identifier
3077
raise NotImplementedError(self.get_mutable_section)
3080
# Mostly for debugging use
3081
return "<config.%s(%s)>" % (self.__class__.__name__,
3082
self.external_url())
3085
class CommandLineStore(Store):
3086
"A store to carry command line overrides for the config options."""
3088
def __init__(self, opts=None):
3089
super(CommandLineStore, self).__init__()
3096
# The dict should be cleared but not replaced so it can be shared.
3097
self.options.clear()
3099
def _from_cmdline(self, overrides):
3100
# Reset before accepting new definitions
3102
for over in overrides:
3104
name, value = over.split('=', 1)
3106
raise errors.BzrCommandError(
3107
gettext("Invalid '%s', should be of the form 'name=value'")
3109
self.options[name] = value
3111
def external_url(self):
3112
# Not an url but it makes debugging easier and is never needed
3116
def get_sections(self):
3117
yield self, self.readonly_section_class(None, self.options)
3120
class IniFileStore(Store):
3121
"""A config Store using ConfigObj for storage.
3123
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3124
serialize/deserialize the config file.
3128
"""A config Store using ConfigObj for storage.
3130
super(IniFileStore, self).__init__()
3131
self._config_obj = None
3133
def is_loaded(self):
3134
return self._config_obj != None
3137
self._config_obj = None
3138
self.dirty_sections = []
3140
def _load_content(self):
3141
"""Load the config file bytes.
3143
This should be provided by subclasses
3145
:return: Byte string
3147
raise NotImplementedError(self._load_content)
3149
def _save_content(self, content):
3150
"""Save the config file bytes.
3152
This should be provided by subclasses
3154
:param content: Config file bytes to write
3156
raise NotImplementedError(self._save_content)
3159
"""Load the store from the associated file."""
3160
if self.is_loaded():
3162
content = self._load_content()
3163
self._load_from_string(content)
3164
for hook in ConfigHooks['load']:
3167
def _load_from_string(self, bytes):
3168
"""Create a config store from a string.
3170
:param bytes: A string representing the file content.
3172
if self.is_loaded():
3173
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3174
co_input = StringIO(bytes)
3176
# The config files are always stored utf8-encoded
3177
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3179
except configobj.ConfigObjError, e:
3180
self._config_obj = None
3181
raise errors.ParseConfigError(e.errors, self.external_url())
3182
except UnicodeDecodeError:
3183
raise errors.ConfigContentError(self.external_url())
3185
def save_changes(self):
3186
if not self.is_loaded():
3189
if not self._need_saving():
3191
# Preserve the current version
3192
current = self._config_obj
3193
dirty_sections = list(self.dirty_sections)
3194
self.apply_changes(dirty_sections)
3195
# Save to the persistent storage
3199
if not self.is_loaded():
3203
self._config_obj.write(out)
3204
self._save_content(out.getvalue())
3205
for hook in ConfigHooks['save']:
3208
def get_sections(self):
3209
"""Get the configobj section in the file order.
3211
:returns: An iterable of (store, section).
3213
# We need a loaded store
3216
except (errors.NoSuchFile, errors.PermissionDenied):
3217
# If the file can't be read, there is no sections
3219
cobj = self._config_obj
3221
yield self, self.readonly_section_class(None, cobj)
3222
for section_name in cobj.sections:
3224
self.readonly_section_class(section_name,
3225
cobj[section_name]))
3227
def get_mutable_section(self, section_id=None):
3228
# We need a loaded store
3231
except errors.NoSuchFile:
3232
# The file doesn't exist, let's pretend it was empty
3233
self._load_from_string('')
3234
if section_id is None:
3235
section = self._config_obj
3237
section = self._config_obj.setdefault(section_id, {})
3238
mutable_section = self.mutable_section_class(section_id, section)
3239
# All mutable sections can become dirty
3240
self.dirty_sections.append(mutable_section)
3241
return mutable_section
3243
def quote(self, value):
3245
# configobj conflates automagical list values and quoting
3246
self._config_obj.list_values = True
3247
return self._config_obj._quote(value)
3249
self._config_obj.list_values = False
3251
def unquote(self, value):
3252
if value and isinstance(value, basestring):
3253
# _unquote doesn't handle None nor empty strings nor anything that
3254
# is not a string, really.
3255
value = self._config_obj._unquote(value)
3258
def external_url(self):
3259
# Since an IniFileStore can be used without a file (at least in tests),
3260
# it's better to provide something than raising a NotImplementedError.
3261
# All daughter classes are supposed to provide an implementation
3263
return 'In-Process Store, no URL'
3265
class TransportIniFileStore(IniFileStore):
3266
"""IniFileStore that loads files from a transport.
3268
:ivar transport: The transport object where the config file is located.
3270
:ivar file_name: The config file basename in the transport directory.
3273
def __init__(self, transport, file_name):
3274
"""A Store using a ini file on a Transport
3276
:param transport: The transport object where the config file is located.
3277
:param file_name: The config file basename in the transport directory.
3279
super(TransportIniFileStore, self).__init__()
3280
self.transport = transport
3281
self.file_name = file_name
3283
def _load_content(self):
3285
return self.transport.get_bytes(self.file_name)
3286
except errors.PermissionDenied:
3287
trace.warning("Permission denied while trying to load "
3288
"configuration store %s.", self.external_url())
3291
def _save_content(self, content):
3292
self.transport.put_bytes(self.file_name, content)
3294
def external_url(self):
3295
# FIXME: external_url should really accepts an optional relpath
3296
# parameter (bug #750169) :-/ -- vila 2011-04-04
3297
# The following will do in the interim but maybe we don't want to
3298
# expose a path here but rather a config ID and its associated
3299
# object </hand wawe>.
3300
return urlutils.join(self.transport.external_url(), self.file_name)
3303
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3304
# unlockable stores for use with objects that can already ensure the locking
3305
# (think branches). If different stores (not based on ConfigObj) are created,
3306
# they may face the same issue.
3309
class LockableIniFileStore(TransportIniFileStore):
3310
"""A ConfigObjStore using locks on save to ensure store integrity."""
3312
def __init__(self, transport, file_name, lock_dir_name=None):
3313
"""A config Store using ConfigObj for storage.
3315
:param transport: The transport object where the config file is located.
3317
:param file_name: The config file basename in the transport directory.
3319
if lock_dir_name is None:
3320
lock_dir_name = 'lock'
3321
self.lock_dir_name = lock_dir_name
3322
super(LockableIniFileStore, self).__init__(transport, file_name)
3323
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3325
def lock_write(self, token=None):
3326
"""Takes a write lock in the directory containing the config file.
3328
If the directory doesn't exist it is created.
3330
# FIXME: This doesn't check the ownership of the created directories as
3331
# ensure_config_dir_exists does. It should if the transport is local
3332
# -- vila 2011-04-06
3333
self.transport.create_prefix()
3334
return self._lock.lock_write(token)
3339
def break_lock(self):
3340
self._lock.break_lock()
3344
# We need to be able to override the undecorated implementation
3345
self.save_without_locking()
3347
def save_without_locking(self):
3348
super(LockableIniFileStore, self).save()
3351
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3352
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3353
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3355
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3356
# functions or a registry will make it easier and clearer for tests, focusing
3357
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3358
# on a poolie's remark)
3359
class GlobalStore(LockableIniFileStore):
3361
def __init__(self, possible_transports=None):
3362
t = transport.get_transport_from_path(
3363
config_dir(), possible_transports=possible_transports)
3364
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3368
class LocationStore(LockableIniFileStore):
3370
def __init__(self, possible_transports=None):
3371
t = transport.get_transport_from_path(
3372
config_dir(), possible_transports=possible_transports)
3373
super(LocationStore, self).__init__(t, 'locations.conf')
3374
self.id = 'locations'
3377
class BranchStore(TransportIniFileStore):
3379
def __init__(self, branch):
3380
super(BranchStore, self).__init__(branch.control_transport,
3382
self.branch = branch
3385
def lock_write(self, token=None):
3386
return self.branch.lock_write(token)
3389
return self.branch.unlock()
3393
# We need to be able to override the undecorated implementation
3394
self.save_without_locking()
3396
def save_without_locking(self):
3397
super(BranchStore, self).save()
3400
class ControlStore(LockableIniFileStore):
3402
def __init__(self, bzrdir):
3403
super(ControlStore, self).__init__(bzrdir.transport,
3405
lock_dir_name='branch_lock')
3409
class SectionMatcher(object):
3410
"""Select sections into a given Store.
3412
This is intended to be used to postpone getting an iterable of sections
3416
def __init__(self, store):
3419
def get_sections(self):
3420
# This is where we require loading the store so we can see all defined
3422
sections = self.store.get_sections()
3423
# Walk the revisions in the order provided
3424
for store, s in sections:
3428
def match(self, section):
3429
"""Does the proposed section match.
3431
:param section: A Section object.
3433
:returns: True if the section matches, False otherwise.
3435
raise NotImplementedError(self.match)
3438
class NameMatcher(SectionMatcher):
3440
def __init__(self, store, section_id):
3441
super(NameMatcher, self).__init__(store)
3442
self.section_id = section_id
3444
def match(self, section):
3445
return section.id == self.section_id
3448
class LocationSection(Section):
3450
def __init__(self, section, extra_path):
3451
super(LocationSection, self).__init__(section.id, section.options)
3452
self.extra_path = extra_path
3453
self.locals = {'relpath': extra_path,
3454
'basename': urlutils.basename(extra_path)}
3456
def get(self, name, default=None, expand=True):
3457
value = super(LocationSection, self).get(name, default)
3458
if value is not None and expand:
3459
policy_name = self.get(name + ':policy', None)
3460
policy = _policy_value.get(policy_name, POLICY_NONE)
3461
if policy == POLICY_APPENDPATH:
3462
value = urlutils.join(value, self.extra_path)
3463
# expand section local options right now (since POLICY_APPENDPATH
3464
# will never add options references, it's ok to expand after it).
3466
for is_ref, chunk in iter_option_refs(value):
3468
chunks.append(chunk)
3471
if ref in self.locals:
3472
chunks.append(self.locals[ref])
3474
chunks.append(chunk)
3475
value = ''.join(chunks)
3479
class StartingPathMatcher(SectionMatcher):
3480
"""Select sections for a given location respecting the Store order."""
3482
# FIXME: Both local paths and urls can be used for section names as well as
3483
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3484
# inherited the fuzziness from the previous ``LocationConfig``
3485
# implementation. We probably need to revisit which encoding is allowed for
3486
# both ``location`` and section names and how we normalize
3487
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3488
# related too. -- vila 2012-01-04
3490
def __init__(self, store, location):
3491
super(StartingPathMatcher, self).__init__(store)
3492
if location.startswith('file://'):
3493
location = urlutils.local_path_from_url(location)
3494
self.location = location
3496
def get_sections(self):
3497
"""Get all sections matching ``location`` in the store.
3499
The most generic sections are described first in the store, then more
3500
specific ones can be provided for reduced scopes.
3502
The returned section are therefore returned in the reversed order so
3503
the most specific ones can be found first.
3505
location_parts = self.location.rstrip('/').split('/')
3508
# Later sections are more specific, they should be returned first
3509
for _, section in reversed(list(store.get_sections())):
3510
if section.id is None:
3511
# The no-name section is always included if present
3512
yield store, LocationSection(section, self.location)
3514
section_path = section.id
3515
if section_path.startswith('file://'):
3516
# the location is already a local path or URL, convert the
3517
# section id to the same format
3518
section_path = urlutils.local_path_from_url(section_path)
3519
if (self.location.startswith(section_path)
3520
or fnmatch.fnmatch(self.location, section_path)):
3521
section_parts = section_path.rstrip('/').split('/')
3522
extra_path = '/'.join(location_parts[len(section_parts):])
3523
yield store, LocationSection(section, extra_path)
3526
class LocationMatcher(SectionMatcher):
3528
def __init__(self, store, location):
3529
super(LocationMatcher, self).__init__(store)
3530
if location.startswith('file://'):
3531
location = urlutils.local_path_from_url(location)
3532
self.location = location
3534
def _get_matching_sections(self):
3535
"""Get all sections matching ``location``."""
3536
# We slightly diverge from LocalConfig here by allowing the no-name
3537
# section as the most generic one and the lower priority.
3538
no_name_section = None
3540
# Filter out the no_name_section so _iter_for_location_by_parts can be
3541
# used (it assumes all sections have a name).
3542
for _, section in self.store.get_sections():
3543
if section.id is None:
3544
no_name_section = section
3546
all_sections.append(section)
3547
# Unfortunately _iter_for_location_by_parts deals with section names so
3548
# we have to resync.
3549
filtered_sections = _iter_for_location_by_parts(
3550
[s.id for s in all_sections], self.location)
3551
iter_all_sections = iter(all_sections)
3552
matching_sections = []
3553
if no_name_section is not None:
3554
matching_sections.append(
3555
(0, LocationSection(no_name_section, self.location)))
3556
for section_id, extra_path, length in filtered_sections:
3557
# a section id is unique for a given store so it's safe to take the
3558
# first matching section while iterating. Also, all filtered
3559
# sections are part of 'all_sections' and will always be found
3562
section = iter_all_sections.next()
3563
if section_id == section.id:
3564
matching_sections.append(
3565
(length, LocationSection(section, extra_path)))
3567
return matching_sections
3569
def get_sections(self):
3570
# Override the default implementation as we want to change the order
3571
matching_sections = self._get_matching_sections()
3572
# We want the longest (aka more specific) locations first
3573
sections = sorted(matching_sections,
3574
key=lambda (length, section): (length, section.id),
3576
# Sections mentioning 'ignore_parents' restrict the selection
3577
for _, section in sections:
3578
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3579
ignore = section.get('ignore_parents', None)
3580
if ignore is not None:
3581
ignore = ui.bool_from_string(ignore)
3584
# Finally, we have a valid section
3585
yield self.store, section
3588
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3589
"""Describes an expandable option reference.
3591
We want to match the most embedded reference first.
3593
I.e. for '{{foo}}' we will get '{foo}',
3594
for '{bar{baz}}' we will get '{baz}'
3597
def iter_option_refs(string):
3598
# Split isolate refs so every other chunk is a ref
3600
for chunk in _option_ref_re.split(string):
3605
class Stack(object):
3606
"""A stack of configurations where an option can be defined"""
3608
def __init__(self, sections_def, store=None, mutable_section_id=None):
3609
"""Creates a stack of sections with an optional store for changes.
3611
:param sections_def: A list of Section or callables that returns an
3612
iterable of Section. This defines the Sections for the Stack and
3613
can be called repeatedly if needed.
3615
:param store: The optional Store where modifications will be
3616
recorded. If none is specified, no modifications can be done.
3618
:param mutable_section_id: The id of the MutableSection where changes
3619
are recorded. This requires the ``store`` parameter to be
3622
self.sections_def = sections_def
3624
self.mutable_section_id = mutable_section_id
3626
def get(self, name, expand=None):
3627
"""Return the *first* option value found in the sections.
3629
This is where we guarantee that sections coming from Store are loaded
3630
lazily: the loading is delayed until we need to either check that an
3631
option exists or get its value, which in turn may require to discover
3632
in which sections it can be defined. Both of these (section and option
3633
existence) require loading the store (even partially).
3635
:param name: The queried option.
3637
:param expand: Whether options references should be expanded.
3639
:returns: The value of the option.
3641
# FIXME: No caching of options nor sections yet -- vila 20110503
3643
expand = _get_expand_default_value()
3645
found_store = None # Where the option value has been found
3646
# If the option is registered, it may provide additional info about
3649
opt = option_registry.get(name)
3654
def expand_and_convert(val):
3655
# This may need to be called in different contexts if the value is
3656
# None or ends up being None during expansion or conversion.
3659
if isinstance(val, basestring):
3660
val = self._expand_options_in_string(val)
3662
trace.warning('Cannot expand "%s":'
3663
' %s does not support option expansion'
3664
% (name, type(val)))
3666
val = found_store.unquote(val)
3668
val = opt.convert_from_unicode(found_store, val)
3671
# First of all, check if the environment can override the configuration
3673
if opt is not None and opt.override_from_env:
3674
value = opt.get_override()
3675
value = expand_and_convert(value)
3677
# Ensuring lazy loading is achieved by delaying section matching
3678
# (which implies querying the persistent storage) until it can't be
3679
# avoided anymore by using callables to describe (possibly empty)
3681
for sections in self.sections_def:
3682
for store, section in sections():
3683
value = section.get(name)
3684
if value is not None:
3687
if value is not None:
3689
value = expand_and_convert(value)
3690
if opt is not None and value is None:
3691
# If the option is registered, it may provide a default value
3692
value = opt.get_default()
3693
value = expand_and_convert(value)
3694
for hook in ConfigHooks['get']:
3695
hook(self, name, value)
3698
def expand_options(self, string, env=None):
3699
"""Expand option references in the string in the configuration context.
3701
:param string: The string containing option(s) to expand.
3703
:param env: An option dict defining additional configuration options or
3704
overriding existing ones.
3706
:returns: The expanded string.
3708
return self._expand_options_in_string(string, env)
3710
def _expand_options_in_string(self, string, env=None, _refs=None):
3711
"""Expand options in the string in the configuration context.
3713
:param string: The string to be expanded.
3715
:param env: An option dict defining additional configuration options or
3716
overriding existing ones.
3718
:param _refs: Private list (FIFO) containing the options being expanded
3721
:returns: The expanded string.
3724
# Not much to expand there
3727
# What references are currently resolved (to detect loops)
3730
# We need to iterate until no more refs appear ({{foo}} will need two
3731
# iterations for example).
3736
for is_ref, chunk in iter_option_refs(result):
3738
chunks.append(chunk)
3743
raise errors.OptionExpansionLoop(string, _refs)
3745
value = self._expand_option(name, env, _refs)
3747
raise errors.ExpandingUnknownOption(name, string)
3748
chunks.append(value)
3750
result = ''.join(chunks)
3753
def _expand_option(self, name, env, _refs):
3754
if env is not None and name in env:
3755
# Special case, values provided in env takes precedence over
3759
value = self.get(name, expand=False)
3760
value = self._expand_options_in_string(value, env, _refs)
3763
def _get_mutable_section(self):
3764
"""Get the MutableSection for the Stack.
3766
This is where we guarantee that the mutable section is lazily loaded:
3767
this means we won't load the corresponding store before setting a value
3768
or deleting an option. In practice the store will often be loaded but
3769
this helps catching some programming errors.
3772
section = store.get_mutable_section(self.mutable_section_id)
3773
return store, section
3775
def set(self, name, value):
3776
"""Set a new value for the option."""
3777
store, section = self._get_mutable_section()
3778
section.set(name, store.quote(value))
3779
for hook in ConfigHooks['set']:
3780
hook(self, name, value)
3782
def remove(self, name):
3783
"""Remove an existing option."""
3784
_, section = self._get_mutable_section()
3785
section.remove(name)
3786
for hook in ConfigHooks['remove']:
3790
# Mostly for debugging use
3791
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3793
def _get_overrides(self):
3794
# Hack around library_state.initialize never called
3795
if bzrlib.global_state is not None:
3796
return bzrlib.global_state.cmdline_overrides.get_sections()
3800
class MemoryStack(Stack):
3801
"""A configuration stack defined from a string.
3803
This is mainly intended for tests and requires no disk resources.
3806
def __init__(self, content=None):
3807
"""Create an in-memory stack from a given content.
3809
It uses a single store based on configobj and support reading and
3812
:param content: The initial content of the store. If None, the store is
3813
not loaded and ``_load_from_string`` can and should be used if
3816
store = IniFileStore()
3817
if content is not None:
3818
store._load_from_string(content)
3819
super(MemoryStack, self).__init__(
3820
[store.get_sections], store)
3823
class _CompatibleStack(Stack):
3824
"""Place holder for compatibility with previous design.
3826
This is intended to ease the transition from the Config-based design to the
3827
Stack-based design and should not be used nor relied upon by plugins.
3829
One assumption made here is that the daughter classes will all use Stores
3830
derived from LockableIniFileStore).
3832
It implements set() and remove () by re-loading the store before applying
3833
the modification and saving it.
3835
The long term plan being to implement a single write by store to save
3836
all modifications, this class should not be used in the interim.
3839
def set(self, name, value):
3842
super(_CompatibleStack, self).set(name, value)
3843
# Force a write to persistent storage
3846
def remove(self, name):
3849
super(_CompatibleStack, self).remove(name)
3850
# Force a write to persistent storage
3854
class GlobalStack(_CompatibleStack):
3855
"""Global options only stack.
3857
The following sections are queried:
3859
* command-line overrides,
3861
* the 'DEFAULT' section in bazaar.conf
3863
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3868
gstore = GlobalStore()
3869
super(GlobalStack, self).__init__(
3870
[self._get_overrides,
3871
NameMatcher(gstore, 'DEFAULT').get_sections],
3872
gstore, mutable_section_id='DEFAULT')
3875
class LocationStack(_CompatibleStack):
3876
"""Per-location options falling back to global options stack.
3879
The following sections are queried:
3881
* command-line overrides,
3883
* the sections matching ``location`` in ``locations.conf``, the order being
3884
defined by the number of path components in the section glob, higher
3885
numbers first (from most specific section to most generic).
3887
* the 'DEFAULT' section in bazaar.conf
3889
This stack will use the ``location`` section in locations.conf as its
3893
def __init__(self, location):
3894
"""Make a new stack for a location and global configuration.
3896
:param location: A URL prefix to """
3897
lstore = LocationStore()
3898
if location.startswith('file://'):
3899
location = urlutils.local_path_from_url(location)
3900
gstore = GlobalStore()
3901
super(LocationStack, self).__init__(
3902
[self._get_overrides,
3903
LocationMatcher(lstore, location).get_sections,
3904
NameMatcher(gstore, 'DEFAULT').get_sections],
3905
lstore, mutable_section_id=location)
3908
class BranchStack(_CompatibleStack):
3909
"""Per-location options falling back to branch then global options stack.
3911
The following sections are queried:
3913
* command-line overrides,
3915
* the sections matching ``location`` in ``locations.conf``, the order being
3916
defined by the number of path components in the section glob, higher
3917
numbers first (from most specific section to most generic),
3919
* the no-name section in branch.conf,
3921
* the ``DEFAULT`` section in ``bazaar.conf``.
3923
This stack will use the no-name section in ``branch.conf`` as its
3927
def __init__(self, branch):
3928
lstore = LocationStore()
3929
bstore = branch._get_config_store()
3930
gstore = GlobalStore()
3931
super(BranchStack, self).__init__(
3932
[self._get_overrides,
3933
LocationMatcher(lstore, branch.base).get_sections,
3934
NameMatcher(bstore, None).get_sections,
3935
NameMatcher(gstore, 'DEFAULT').get_sections],
3937
self.branch = branch
3940
class RemoteControlStack(_CompatibleStack):
3941
"""Remote control-only options stack."""
3943
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3944
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3945
# control.conf and is used only for stack options.
3947
def __init__(self, bzrdir):
3948
cstore = bzrdir._get_config_store()
3949
super(RemoteControlStack, self).__init__(
3950
[NameMatcher(cstore, None).get_sections],
3952
self.bzrdir = bzrdir
3955
class BranchOnlyStack(_CompatibleStack):
3956
"""Branch-only options stack."""
3958
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3959
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3960
# -- vila 2011-12-16
3962
def __init__(self, branch):
3963
bstore = branch._get_config_store()
3964
super(BranchOnlyStack, self).__init__(
3965
[NameMatcher(bstore, None).get_sections],
3967
self.branch = branch
3970
# Use a an empty dict to initialize an empty configobj avoiding all
3971
# parsing and encoding checks
3972
_quoting_config = configobj.ConfigObj(
3973
{}, encoding='utf-8', interpolation=False, list_values=True)
3975
class cmd_config(commands.Command):
3976
__doc__ = """Display, set or remove a configuration option.
3978
Display the active value for a given option.
3980
If --all is specified, NAME is interpreted as a regular expression and all
3981
matching options are displayed mentioning their scope. The active value
3982
that bzr will take into account is the first one displayed for each option.
3984
If no NAME is given, --all .* is implied.
3986
Setting a value is achieved by using name=value without spaces. The value
3987
is set in the most relevant scope and can be checked by displaying the
3991
takes_args = ['name?']
3995
# FIXME: This should be a registry option so that plugins can register
3996
# their own config files (or not) and will also address
3997
# http://pad.lv/788991 -- vila 20101115
3998
commands.Option('scope', help='Reduce the scope to the specified'
3999
' configuration file.',
4001
commands.Option('all',
4002
help='Display all the defined values for the matching options.',
4004
commands.Option('remove', help='Remove the option from'
4005
' the configuration file.'),
4008
_see_also = ['configuration']
4010
@commands.display_command
4011
def run(self, name=None, all=False, directory=None, scope=None,
4013
if directory is None:
4015
directory = urlutils.normalize_url(directory)
4017
raise errors.BzrError(
4018
'--all and --remove are mutually exclusive.')
4020
# Delete the option in the given scope
4021
self._remove_config_option(name, directory, scope)
4023
# Defaults to all options
4024
self._show_matching_options('.*', directory, scope)
4027
name, value = name.split('=', 1)
4029
# Display the option(s) value(s)
4031
self._show_matching_options(name, directory, scope)
4033
self._show_value(name, directory, scope)
4036
raise errors.BzrError(
4037
'Only one option can be set.')
4038
# Set the option value
4039
self._set_config_option(name, value, directory, scope)
4041
def _get_stack(self, directory, scope=None):
4042
"""Get the configuration stack specified by ``directory`` and ``scope``.
4044
:param directory: Where the configurations are derived from.
4046
:param scope: A specific config to start from.
4048
# FIXME: scope should allow access to plugin-specific stacks (even
4049
# reduced to the plugin-specific store), related to
4050
# http://pad.lv/788991 -- vila 2011-11-15
4051
if scope is not None:
4052
if scope == 'bazaar':
4053
return GlobalStack()
4054
elif scope == 'locations':
4055
return LocationStack(directory)
4056
elif scope == 'branch':
4058
controldir.ControlDir.open_containing_tree_or_branch(
4060
return br.get_config_stack()
4061
raise errors.NoSuchConfig(scope)
4065
controldir.ControlDir.open_containing_tree_or_branch(
4067
return br.get_config_stack()
4068
except errors.NotBranchError:
4069
return LocationStack(directory)
4071
def _show_value(self, name, directory, scope):
4072
conf = self._get_stack(directory, scope)
4073
value = conf.get(name, expand=True)
4074
if value is not None:
4075
# Quote the value appropriately
4076
value = _quoting_config._quote(value)
4077
self.outf.write('%s\n' % (value,))
4079
raise errors.NoSuchConfigOption(name)
4081
def _show_matching_options(self, name, directory, scope):
4082
name = lazy_regex.lazy_compile(name)
4083
# We want any error in the regexp to be raised *now* so we need to
4084
# avoid the delay introduced by the lazy regexp. But, we still do
4085
# want the nicer errors raised by lazy_regex.
4086
name._compile_and_collapse()
4089
conf = self._get_stack(directory, scope)
4090
for sections in conf.sections_def:
4091
for store, section in sections():
4092
for oname in section.iter_option_names():
4093
if name.search(oname):
4094
if cur_store_id != store.id:
4095
# Explain where the options are defined
4096
self.outf.write('%s:\n' % (store.id,))
4097
cur_store_id = store.id
4099
if (section.id is not None
4100
and cur_section != section.id):
4101
# Display the section id as it appears in the store
4102
# (None doesn't appear by definition)
4103
self.outf.write(' [%s]\n' % (section.id,))
4104
cur_section = section.id
4105
value = section.get(oname, expand=False)
4106
# Since we don't use the stack, we need to restore a
4109
opt = option_registry.get(oname)
4110
value = opt.convert_from_unicode(store, value)
4112
value = store.unquote(value)
4113
value = _quoting_config._quote(value)
4114
self.outf.write(' %s = %s\n' % (oname, value))
4116
def _set_config_option(self, name, value, directory, scope):
4117
conf = self._get_stack(directory, scope)
4118
conf.set(name, value)
4120
def _remove_config_option(self, name, directory, scope):
4122
raise errors.BzrCommandError(
4123
'--remove expects an option to remove.')
4124
conf = self._get_stack(directory, scope)
4128
raise errors.NoSuchConfigOption(name)
4133
# We need adapters that can build a Store or a Stack in a test context. Test
4134
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4135
# themselves. The builder will receive a test instance and should return a
4136
# ready-to-use store or stack. Plugins that define new store/stacks can also
4137
# register themselves here to be tested against the tests defined in
4138
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4139
# for the same test.
4141
# The registered object should be a callable receiving a test instance
4142
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4144
test_store_builder_registry = registry.Registry()
4146
# The registered object should be a callable receiving a test instance
4147
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4149
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
