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(), """
104
from bzrlib.i18n import gettext
105
from bzrlib.util.configobj import configobj
113
from bzrlib.symbol_versioning import (
131
POLICY_APPENDPATH = 2
135
POLICY_NORECURSE: 'norecurse',
136
POLICY_APPENDPATH: 'appendpath',
141
'norecurse': POLICY_NORECURSE,
142
'appendpath': POLICY_APPENDPATH,
146
STORE_LOCATION = POLICY_NONE
147
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
148
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
153
def signature_policy_from_unicode(signature_string):
154
"""Convert a string to a signing policy."""
155
if signature_string.lower() == 'check-available':
156
return CHECK_IF_POSSIBLE
157
if signature_string.lower() == 'ignore':
159
if signature_string.lower() == 'require':
161
raise ValueError("Invalid signatures policy '%s'"
165
def signing_policy_from_unicode(signature_string):
166
"""Convert a string to a signing policy."""
167
if signature_string.lower() == 'when-required':
168
return SIGN_WHEN_REQUIRED
169
if signature_string.lower() == 'never':
171
if signature_string.lower() == 'always':
173
raise ValueError("Invalid signing policy '%s'"
177
class ConfigObj(configobj.ConfigObj):
179
def __init__(self, infile=None, **kwargs):
180
# We define our own interpolation mechanism calling it option expansion
181
super(ConfigObj, self).__init__(infile=infile,
185
def get_bool(self, section, key):
186
return self[section].as_bool(key)
188
def get_value(self, section, name):
189
# Try [] for the old DEFAULT section.
190
if section == "DEFAULT":
195
return self[section][name]
198
# FIXME: Until we can guarantee that each config file is loaded once and
199
# only once for a given bzrlib session, we don't want to re-read the file every
200
# time we query for an option so we cache the value (bad ! watch out for tests
201
# needing to restore the proper value). -- vila 20110219
202
_expand_default_value = None
203
def _get_expand_default_value():
204
global _expand_default_value
205
if _expand_default_value is not None:
206
return _expand_default_value
207
conf = GlobalConfig()
208
# Note that we must not use None for the expand value below or we'll run
209
# into infinite recursion. Using False really would be quite silly ;)
210
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
212
# This is an opt-in feature, you *really* need to clearly say you want
215
_expand_default_value = expand
219
class Config(object):
220
"""A configuration policy - what username, editor, gpg needs etc."""
223
super(Config, self).__init__()
226
"""Returns a unique ID for the config."""
227
raise NotImplementedError(self.config_id)
229
@deprecated_method(deprecated_in((2, 4, 0)))
230
def get_editor(self):
231
"""Get the users pop up editor."""
232
raise NotImplementedError
234
def get_change_editor(self, old_tree, new_tree):
235
from bzrlib import diff
236
cmd = self._get_change_editor()
239
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
242
def _get_signature_checking(self):
243
"""Template method to override signature checking policy."""
245
def _get_signing_policy(self):
246
"""Template method to override signature creation policy."""
250
def expand_options(self, string, env=None):
251
"""Expand option references in the string in the configuration context.
253
:param string: The string containing option to expand.
255
:param env: An option dict defining additional configuration options or
256
overriding existing ones.
258
:returns: The expanded string.
260
return self._expand_options_in_string(string, env)
262
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
263
"""Expand options in a list of strings in the configuration context.
265
:param slist: A list of strings.
267
:param env: An option dict defining additional configuration options or
268
overriding existing ones.
270
:param _ref_stack: Private list containing the options being
271
expanded to detect loops.
273
:returns: The flatten list of expanded strings.
275
# expand options in each value separately flattening lists
278
value = self._expand_options_in_string(s, env, _ref_stack)
279
if isinstance(value, list):
285
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
286
"""Expand options in the string in the configuration context.
288
:param string: The string to be expanded.
290
:param env: An option dict defining additional configuration options or
291
overriding existing ones.
293
:param _ref_stack: Private list containing the options being
294
expanded to detect loops.
296
:returns: The expanded string.
299
# Not much to expand there
301
if _ref_stack is None:
302
# What references are currently resolved (to detect loops)
304
if self.option_ref_re is None:
305
# We want to match the most embedded reference first (i.e. for
306
# '{{foo}}' we will get '{foo}',
307
# for '{bar{baz}}' we will get '{baz}'
308
self.option_ref_re = re.compile('({[^{}]+})')
310
# We need to iterate until no more refs appear ({{foo}} will need two
311
# iterations for example).
313
raw_chunks = self.option_ref_re.split(result)
314
if len(raw_chunks) == 1:
315
# Shorcut the trivial case: no refs
319
# Split will isolate refs so that every other chunk is a ref
321
for chunk in raw_chunks:
324
# Keep only non-empty strings (or we get bogus empty
325
# slots when a list value is involved).
330
if name in _ref_stack:
331
raise errors.OptionExpansionLoop(string, _ref_stack)
332
_ref_stack.append(name)
333
value = self._expand_option(name, env, _ref_stack)
335
raise errors.ExpandingUnknownOption(name, string)
336
if isinstance(value, list):
344
# Once a list appears as the result of an expansion, all
345
# callers will get a list result. This allows a consistent
346
# behavior even when some options in the expansion chain
347
# defined as strings (no comma in their value) but their
348
# expanded value is a list.
349
return self._expand_options_in_list(chunks, env, _ref_stack)
351
result = ''.join(chunks)
354
def _expand_option(self, name, env, _ref_stack):
355
if env is not None and name in env:
356
# Special case, values provided in env takes precedence over
360
# FIXME: This is a limited implementation, what we really need is a
361
# way to query the bzr config for the value of an option,
362
# respecting the scope rules (That is, once we implement fallback
363
# configs, getting the option value should restart from the top
364
# config, not the current one) -- vila 20101222
365
value = self.get_user_option(name, expand=False)
366
if isinstance(value, list):
367
value = self._expand_options_in_list(value, env, _ref_stack)
369
value = self._expand_options_in_string(value, env, _ref_stack)
372
def _get_user_option(self, option_name):
373
"""Template method to provide a user option."""
376
def get_user_option(self, option_name, expand=None):
377
"""Get a generic option - no special process, no default.
379
:param option_name: The queried option.
381
:param expand: Whether options references should be expanded.
383
:returns: The value of the option.
386
expand = _get_expand_default_value()
387
value = self._get_user_option(option_name)
389
if isinstance(value, list):
390
value = self._expand_options_in_list(value)
391
elif isinstance(value, dict):
392
trace.warning('Cannot expand "%s":'
393
' Dicts do not support option expansion'
396
value = self._expand_options_in_string(value)
397
for hook in OldConfigHooks['get']:
398
hook(self, option_name, value)
401
def get_user_option_as_bool(self, option_name, expand=None, default=None):
402
"""Get a generic option as a boolean.
404
:param expand: Allow expanding references to other config values.
405
:param default: Default value if nothing is configured
406
:return None if the option doesn't exist or its value can't be
407
interpreted as a boolean. Returns True or False otherwise.
409
s = self.get_user_option(option_name, expand=expand)
411
# The option doesn't exist
413
val = ui.bool_from_string(s)
415
# The value can't be interpreted as a boolean
416
trace.warning('Value "%s" is not a boolean for "%s"',
420
def get_user_option_as_list(self, option_name, expand=None):
421
"""Get a generic option as a list - no special process, no default.
423
:return None if the option doesn't exist. Returns the value as a list
426
l = self.get_user_option(option_name, expand=expand)
427
if isinstance(l, (str, unicode)):
428
# A single value, most probably the user forgot (or didn't care to
433
@deprecated_method(deprecated_in((2, 5, 0)))
434
def get_user_option_as_int_from_SI(self, option_name, default=None):
435
"""Get a generic option from a human readable size in SI units, e.g 10MB
437
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
438
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
441
:return Integer, expanded to its base-10 value if a proper SI unit is
442
found. If the option doesn't exist, or isn't a value in
443
SI units, return default (which defaults to None)
445
val = self.get_user_option(option_name)
446
if isinstance(val, list):
451
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
455
val = int(m.group(1))
456
if m.group(2) is not None:
457
if m.group(2).lower() == 'k':
459
elif m.group(2).lower() == 'm':
461
elif m.group(2).lower() == 'g':
464
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
465
' value {1!r} is not an SI unit.').format(
472
@deprecated_method(deprecated_in((2, 5, 0)))
473
def gpg_signing_command(self):
474
"""What program should be used to sign signatures?"""
475
result = self._gpg_signing_command()
480
def _gpg_signing_command(self):
481
"""See gpg_signing_command()."""
484
@deprecated_method(deprecated_in((2, 5, 0)))
485
def log_format(self):
486
"""What log format should be used"""
487
result = self._log_format()
492
def _log_format(self):
493
"""See log_format()."""
496
def validate_signatures_in_log(self):
497
"""Show GPG signature validity in log"""
498
result = self._validate_signatures_in_log()
505
def _validate_signatures_in_log(self):
506
"""See validate_signatures_in_log()."""
509
@deprecated_method(deprecated_in((2, 5, 0)))
510
def acceptable_keys(self):
511
"""Comma separated list of key patterns acceptable to
512
verify-signatures command"""
513
result = self._acceptable_keys()
516
def _acceptable_keys(self):
517
"""See acceptable_keys()."""
520
@deprecated_method(deprecated_in((2, 5, 0)))
521
def post_commit(self):
522
"""An ordered list of python functions to call.
524
Each function takes branch, rev_id as parameters.
526
return self._post_commit()
528
def _post_commit(self):
529
"""See Config.post_commit."""
532
def user_email(self):
533
"""Return just the email component of a username."""
534
return extract_email_address(self.username())
537
"""Return email-style username.
539
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
541
$BZR_EMAIL can be set to override this, then
542
the concrete policy type is checked, and finally
544
If no username can be found, errors.NoWhoami exception is raised.
546
v = os.environ.get('BZR_EMAIL')
548
return v.decode(osutils.get_user_encoding())
549
v = self._get_user_id()
552
return default_email()
554
def ensure_username(self):
555
"""Raise errors.NoWhoami if username is not set.
557
This method relies on the username() function raising the error.
561
@deprecated_method(deprecated_in((2, 5, 0)))
562
def signature_checking(self):
563
"""What is the current policy for signature checking?."""
564
policy = self._get_signature_checking()
565
if policy is not None:
567
return CHECK_IF_POSSIBLE
569
@deprecated_method(deprecated_in((2, 5, 0)))
570
def signing_policy(self):
571
"""What is the current policy for signature checking?."""
572
policy = self._get_signing_policy()
573
if policy is not None:
575
return SIGN_WHEN_REQUIRED
577
@deprecated_method(deprecated_in((2, 5, 0)))
578
def signature_needed(self):
579
"""Is a signature needed when committing ?."""
580
policy = self._get_signing_policy()
582
policy = self._get_signature_checking()
583
if policy is not None:
584
#this warning should go away once check_signatures is
585
#implemented (if not before)
586
trace.warning("Please use create_signatures,"
587
" not check_signatures to set signing policy.")
588
elif policy == SIGN_ALWAYS:
592
@deprecated_method(deprecated_in((2, 5, 0)))
593
def gpg_signing_key(self):
594
"""GPG user-id to sign commits"""
595
key = self.get_user_option('gpg_signing_key')
596
if key == "default" or key == None:
597
return self.user_email()
601
def get_alias(self, value):
602
return self._get_alias(value)
604
def _get_alias(self, value):
607
def get_nickname(self):
608
return self._get_nickname()
610
def _get_nickname(self):
613
def get_bzr_remote_path(self):
615
return os.environ['BZR_REMOTE_PATH']
617
path = self.get_user_option("bzr_remote_path")
622
def suppress_warning(self, warning):
623
"""Should the warning be suppressed or emitted.
625
:param warning: The name of the warning being tested.
627
:returns: True if the warning should be suppressed, False otherwise.
629
warnings = self.get_user_option_as_list('suppress_warnings')
630
if warnings is None or warning not in warnings:
635
def get_merge_tools(self):
637
for (oname, value, section, conf_id, parser) in self._get_options():
638
if oname.startswith('bzr.mergetool.'):
639
tool_name = oname[len('bzr.mergetool.'):]
640
tools[tool_name] = self.get_user_option(oname)
641
trace.mutter('loaded merge tools: %r' % tools)
644
def find_merge_tool(self, name):
645
# We fake a defaults mechanism here by checking if the given name can
646
# be found in the known_merge_tools if it's not found in the config.
647
# This should be done through the proposed config defaults mechanism
648
# when it becomes available in the future.
649
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
651
or mergetools.known_merge_tools.get(name, None))
655
class _ConfigHooks(hooks.Hooks):
656
"""A dict mapping hook names and a list of callables for configs.
660
"""Create the default hooks.
662
These are all empty initially, because by default nothing should get
665
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
666
self.add_hook('load',
667
'Invoked when a config store is loaded.'
668
' The signature is (store).',
670
self.add_hook('save',
671
'Invoked when a config store is saved.'
672
' The signature is (store).',
674
# The hooks for config options
676
'Invoked when a config option is read.'
677
' The signature is (stack, name, value).',
680
'Invoked when a config option is set.'
681
' The signature is (stack, name, value).',
683
self.add_hook('remove',
684
'Invoked when a config option is removed.'
685
' The signature is (stack, name).',
687
ConfigHooks = _ConfigHooks()
690
class _OldConfigHooks(hooks.Hooks):
691
"""A dict mapping hook names and a list of callables for configs.
695
"""Create the default hooks.
697
These are all empty initially, because by default nothing should get
700
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
701
self.add_hook('load',
702
'Invoked when a config store is loaded.'
703
' The signature is (config).',
705
self.add_hook('save',
706
'Invoked when a config store is saved.'
707
' The signature is (config).',
709
# The hooks for config options
711
'Invoked when a config option is read.'
712
' The signature is (config, name, value).',
715
'Invoked when a config option is set.'
716
' The signature is (config, name, value).',
718
self.add_hook('remove',
719
'Invoked when a config option is removed.'
720
' The signature is (config, name).',
722
OldConfigHooks = _OldConfigHooks()
725
class IniBasedConfig(Config):
726
"""A configuration policy that draws from ini files."""
728
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
730
"""Base class for configuration files using an ini-like syntax.
732
:param file_name: The configuration file path.
734
super(IniBasedConfig, self).__init__()
735
self.file_name = file_name
736
if symbol_versioning.deprecated_passed(get_filename):
737
symbol_versioning.warn(
738
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
739
' Use file_name instead.',
742
if get_filename is not None:
743
self.file_name = get_filename()
745
self.file_name = file_name
750
def from_string(cls, str_or_unicode, file_name=None, save=False):
751
"""Create a config object from a string.
753
:param str_or_unicode: A string representing the file content. This will
756
:param file_name: The configuration file path.
758
:param _save: Whether the file should be saved upon creation.
760
conf = cls(file_name=file_name)
761
conf._create_from_string(str_or_unicode, save)
764
def _create_from_string(self, str_or_unicode, save):
765
self._content = StringIO(str_or_unicode.encode('utf-8'))
766
# Some tests use in-memory configs, some other always need the config
767
# file to exist on disk.
769
self._write_config_file()
771
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
772
if self._parser is not None:
774
if symbol_versioning.deprecated_passed(file):
775
symbol_versioning.warn(
776
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
777
' Use IniBasedConfig(_content=xxx) instead.',
780
if self._content is not None:
781
co_input = self._content
782
elif self.file_name is None:
783
raise AssertionError('We have no content to create the config')
785
co_input = self.file_name
787
self._parser = ConfigObj(co_input, encoding='utf-8')
788
except configobj.ConfigObjError, e:
789
raise errors.ParseConfigError(e.errors, e.config.filename)
790
except UnicodeDecodeError:
791
raise errors.ConfigContentError(self.file_name)
792
# Make sure self.reload() will use the right file name
793
self._parser.filename = self.file_name
794
for hook in OldConfigHooks['load']:
799
"""Reload the config file from disk."""
800
if self.file_name is None:
801
raise AssertionError('We need a file name to reload the config')
802
if self._parser is not None:
803
self._parser.reload()
804
for hook in ConfigHooks['load']:
807
def _get_matching_sections(self):
808
"""Return an ordered list of (section_name, extra_path) pairs.
810
If the section contains inherited configuration, extra_path is
811
a string containing the additional path components.
813
section = self._get_section()
814
if section is not None:
815
return [(section, '')]
819
def _get_section(self):
820
"""Override this to define the section used by the config."""
823
def _get_sections(self, name=None):
824
"""Returns an iterator of the sections specified by ``name``.
826
:param name: The section name. If None is supplied, the default
827
configurations are yielded.
829
:return: A tuple (name, section, config_id) for all sections that will
830
be walked by user_get_option() in the 'right' order. The first one
831
is where set_user_option() will update the value.
833
parser = self._get_parser()
835
yield (name, parser[name], self.config_id())
837
# No section name has been given so we fallback to the configobj
838
# itself which holds the variables defined outside of any section.
839
yield (None, parser, self.config_id())
841
def _get_options(self, sections=None):
842
"""Return an ordered list of (name, value, section, config_id) tuples.
844
All options are returned with their associated value and the section
845
they appeared in. ``config_id`` is a unique identifier for the
846
configuration file the option is defined in.
848
:param sections: Default to ``_get_matching_sections`` if not
849
specified. This gives a better control to daughter classes about
850
which sections should be searched. This is a list of (name,
855
parser = self._get_parser()
857
for (section_name, _) in self._get_matching_sections():
859
section = parser[section_name]
861
# This could happen for an empty file for which we define a
862
# DEFAULT section. FIXME: Force callers to provide sections
863
# instead ? -- vila 20100930
865
sections.append((section_name, section))
866
config_id = self.config_id()
867
for (section_name, section) in sections:
868
for (name, value) in section.iteritems():
869
yield (name, parser._quote(value), section_name,
872
def _get_option_policy(self, section, option_name):
873
"""Return the policy for the given (section, option_name) pair."""
876
def _get_change_editor(self):
877
return self.get_user_option('change_editor')
879
def _get_signature_checking(self):
880
"""See Config._get_signature_checking."""
881
policy = self._get_user_option('check_signatures')
883
return signature_policy_from_unicode(policy)
885
def _get_signing_policy(self):
886
"""See Config._get_signing_policy"""
887
policy = self._get_user_option('create_signatures')
889
return signing_policy_from_unicode(policy)
891
def _get_user_id(self):
892
"""Get the user id from the 'email' key in the current section."""
893
return self._get_user_option('email')
895
def _get_user_option(self, option_name):
896
"""See Config._get_user_option."""
897
for (section, extra_path) in self._get_matching_sections():
899
value = self._get_parser().get_value(section, option_name)
902
policy = self._get_option_policy(section, option_name)
903
if policy == POLICY_NONE:
905
elif policy == POLICY_NORECURSE:
906
# norecurse items only apply to the exact path
911
elif policy == POLICY_APPENDPATH:
913
value = urlutils.join(value, extra_path)
916
raise AssertionError('Unexpected config policy %r' % policy)
920
def _gpg_signing_command(self):
921
"""See Config.gpg_signing_command."""
922
return self._get_user_option('gpg_signing_command')
924
def _log_format(self):
925
"""See Config.log_format."""
926
return self._get_user_option('log_format')
928
def _validate_signatures_in_log(self):
929
"""See Config.validate_signatures_in_log."""
930
return self._get_user_option('validate_signatures_in_log')
932
def _acceptable_keys(self):
933
"""See Config.acceptable_keys."""
934
return self._get_user_option('acceptable_keys')
936
def _post_commit(self):
937
"""See Config.post_commit."""
938
return self._get_user_option('post_commit')
940
def _get_alias(self, value):
942
return self._get_parser().get_value("ALIASES",
947
def _get_nickname(self):
948
return self.get_user_option('nickname')
950
def remove_user_option(self, option_name, section_name=None):
951
"""Remove a user option and save the configuration file.
953
:param option_name: The option to be removed.
955
:param section_name: The section the option is defined in, default to
959
parser = self._get_parser()
960
if section_name is None:
963
section = parser[section_name]
965
del section[option_name]
967
raise errors.NoSuchConfigOption(option_name)
968
self._write_config_file()
969
for hook in OldConfigHooks['remove']:
970
hook(self, option_name)
972
def _write_config_file(self):
973
if self.file_name is None:
974
raise AssertionError('We cannot save, self.file_name is None')
975
conf_dir = os.path.dirname(self.file_name)
976
ensure_config_dir_exists(conf_dir)
977
atomic_file = atomicfile.AtomicFile(self.file_name)
978
self._get_parser().write(atomic_file)
981
osutils.copy_ownership_from_path(self.file_name)
982
for hook in OldConfigHooks['save']:
986
class LockableConfig(IniBasedConfig):
987
"""A configuration needing explicit locking for access.
989
If several processes try to write the config file, the accesses need to be
992
Daughter classes should decorate all methods that update a config with the
993
``@needs_write_lock`` decorator (they call, directly or indirectly, the
994
``_write_config_file()`` method. These methods (typically ``set_option()``
995
and variants must reload the config file from disk before calling
996
``_write_config_file()``), this can be achieved by calling the
997
``self.reload()`` method. Note that the lock scope should cover both the
998
reading and the writing of the config file which is why the decorator can't
999
be applied to ``_write_config_file()`` only.
1001
This should be enough to implement the following logic:
1002
- lock for exclusive write access,
1003
- reload the config file from disk,
1007
This logic guarantees that a writer can update a value without erasing an
1008
update made by another writer.
1013
def __init__(self, file_name):
1014
super(LockableConfig, self).__init__(file_name=file_name)
1015
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1016
# FIXME: It doesn't matter that we don't provide possible_transports
1017
# below since this is currently used only for local config files ;
1018
# local transports are not shared. But if/when we start using
1019
# LockableConfig for other kind of transports, we will need to reuse
1020
# whatever connection is already established -- vila 20100929
1021
self.transport = transport.get_transport_from_path(self.dir)
1022
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1024
def _create_from_string(self, unicode_bytes, save):
1025
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1027
# We need to handle the saving here (as opposed to IniBasedConfig)
1028
# to be able to lock
1030
self._write_config_file()
1033
def lock_write(self, token=None):
1034
"""Takes a write lock in the directory containing the config file.
1036
If the directory doesn't exist it is created.
1038
ensure_config_dir_exists(self.dir)
1039
return self._lock.lock_write(token)
1044
def break_lock(self):
1045
self._lock.break_lock()
1048
def remove_user_option(self, option_name, section_name=None):
1049
super(LockableConfig, self).remove_user_option(option_name,
1052
def _write_config_file(self):
1053
if self._lock is None or not self._lock.is_held:
1054
# NB: if the following exception is raised it probably means a
1055
# missing @needs_write_lock decorator on one of the callers.
1056
raise errors.ObjectNotLocked(self)
1057
super(LockableConfig, self)._write_config_file()
1060
class GlobalConfig(LockableConfig):
1061
"""The configuration that should be used for a specific location."""
1064
super(GlobalConfig, self).__init__(file_name=config_filename())
1066
def config_id(self):
1070
def from_string(cls, str_or_unicode, save=False):
1071
"""Create a config object from a string.
1073
:param str_or_unicode: A string representing the file content. This
1074
will be utf-8 encoded.
1076
:param save: Whether the file should be saved upon creation.
1079
conf._create_from_string(str_or_unicode, save)
1082
@deprecated_method(deprecated_in((2, 4, 0)))
1083
def get_editor(self):
1084
return self._get_user_option('editor')
1087
def set_user_option(self, option, value):
1088
"""Save option and its value in the configuration."""
1089
self._set_option(option, value, 'DEFAULT')
1091
def get_aliases(self):
1092
"""Return the aliases section."""
1093
if 'ALIASES' in self._get_parser():
1094
return self._get_parser()['ALIASES']
1099
def set_alias(self, alias_name, alias_command):
1100
"""Save the alias in the configuration."""
1101
self._set_option(alias_name, alias_command, 'ALIASES')
1104
def unset_alias(self, alias_name):
1105
"""Unset an existing alias."""
1107
aliases = self._get_parser().get('ALIASES')
1108
if not aliases or alias_name not in aliases:
1109
raise errors.NoSuchAlias(alias_name)
1110
del aliases[alias_name]
1111
self._write_config_file()
1113
def _set_option(self, option, value, section):
1115
self._get_parser().setdefault(section, {})[option] = value
1116
self._write_config_file()
1117
for hook in OldConfigHooks['set']:
1118
hook(self, option, value)
1120
def _get_sections(self, name=None):
1121
"""See IniBasedConfig._get_sections()."""
1122
parser = self._get_parser()
1123
# We don't give access to options defined outside of any section, we
1124
# used the DEFAULT section by... default.
1125
if name in (None, 'DEFAULT'):
1126
# This could happen for an empty file where the DEFAULT section
1127
# doesn't exist yet. So we force DEFAULT when yielding
1129
if 'DEFAULT' not in parser:
1130
parser['DEFAULT']= {}
1131
yield (name, parser[name], self.config_id())
1134
def remove_user_option(self, option_name, section_name=None):
1135
if section_name is None:
1136
# We need to force the default section.
1137
section_name = 'DEFAULT'
1138
# We need to avoid the LockableConfig implementation or we'll lock
1140
super(LockableConfig, self).remove_user_option(option_name,
1143
def _iter_for_location_by_parts(sections, location):
1144
"""Keep only the sessions matching the specified location.
1146
:param sections: An iterable of section names.
1148
:param location: An url or a local path to match against.
1150
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1151
number of path components in the section name, section is the section
1152
name and extra_path is the difference between location and the section
1155
``location`` will always be a local path and never a 'file://' url but the
1156
section names themselves can be in either form.
1158
location_parts = location.rstrip('/').split('/')
1160
for section in sections:
1161
# location is a local path if possible, so we need to convert 'file://'
1162
# urls in section names to local paths if necessary.
1164
# This also avoids having file:///path be a more exact
1165
# match than '/path'.
1167
# FIXME: This still raises an issue if a user defines both file:///path
1168
# *and* /path. Should we raise an error in this case -- vila 20110505
1170
if section.startswith('file://'):
1171
section_path = urlutils.local_path_from_url(section)
1173
section_path = section
1174
section_parts = section_path.rstrip('/').split('/')
1177
if len(section_parts) > len(location_parts):
1178
# More path components in the section, they can't match
1181
# Rely on zip truncating in length to the length of the shortest
1182
# argument sequence.
1183
names = zip(location_parts, section_parts)
1185
if not fnmatch.fnmatch(name[0], name[1]):
1190
# build the path difference between the section and the location
1191
extra_path = '/'.join(location_parts[len(section_parts):])
1192
yield section, extra_path, len(section_parts)
1195
class LocationConfig(LockableConfig):
1196
"""A configuration object that gives the policy for a location."""
1198
def __init__(self, location):
1199
super(LocationConfig, self).__init__(
1200
file_name=locations_config_filename())
1201
# local file locations are looked up by local path, rather than
1202
# by file url. This is because the config file is a user
1203
# file, and we would rather not expose the user to file urls.
1204
if location.startswith('file://'):
1205
location = urlutils.local_path_from_url(location)
1206
self.location = location
1208
def config_id(self):
1212
def from_string(cls, str_or_unicode, location, save=False):
1213
"""Create a config object from a string.
1215
:param str_or_unicode: A string representing the file content. This will
1218
:param location: The location url to filter the configuration.
1220
:param save: Whether the file should be saved upon creation.
1222
conf = cls(location)
1223
conf._create_from_string(str_or_unicode, save)
1226
def _get_matching_sections(self):
1227
"""Return an ordered list of section names matching this location."""
1228
matches = list(_iter_for_location_by_parts(self._get_parser(),
1230
# put the longest (aka more specific) locations first
1232
key=lambda (section, extra_path, length): (length, section),
1234
for (section, extra_path, length) in matches:
1235
yield section, extra_path
1236
# should we stop looking for parent configs here?
1238
if self._get_parser()[section].as_bool('ignore_parents'):
1243
def _get_sections(self, name=None):
1244
"""See IniBasedConfig._get_sections()."""
1245
# We ignore the name here as the only sections handled are named with
1246
# the location path and we don't expose embedded sections either.
1247
parser = self._get_parser()
1248
for name, extra_path in self._get_matching_sections():
1249
yield (name, parser[name], self.config_id())
1251
def _get_option_policy(self, section, option_name):
1252
"""Return the policy for the given (section, option_name) pair."""
1253
# check for the old 'recurse=False' flag
1255
recurse = self._get_parser()[section].as_bool('recurse')
1259
return POLICY_NORECURSE
1261
policy_key = option_name + ':policy'
1263
policy_name = self._get_parser()[section][policy_key]
1267
return _policy_value[policy_name]
1269
def _set_option_policy(self, section, option_name, option_policy):
1270
"""Set the policy for the given option name in the given section."""
1271
# The old recurse=False option affects all options in the
1272
# section. To handle multiple policies in the section, we
1273
# need to convert it to a policy_norecurse key.
1275
recurse = self._get_parser()[section].as_bool('recurse')
1279
symbol_versioning.warn(
1280
'The recurse option is deprecated as of 0.14. '
1281
'The section "%s" has been converted to use policies.'
1284
del self._get_parser()[section]['recurse']
1286
for key in self._get_parser()[section].keys():
1287
if not key.endswith(':policy'):
1288
self._get_parser()[section][key +
1289
':policy'] = 'norecurse'
1291
policy_key = option_name + ':policy'
1292
policy_name = _policy_name[option_policy]
1293
if policy_name is not None:
1294
self._get_parser()[section][policy_key] = policy_name
1296
if policy_key in self._get_parser()[section]:
1297
del self._get_parser()[section][policy_key]
1300
def set_user_option(self, option, value, store=STORE_LOCATION):
1301
"""Save option and its value in the configuration."""
1302
if store not in [STORE_LOCATION,
1303
STORE_LOCATION_NORECURSE,
1304
STORE_LOCATION_APPENDPATH]:
1305
raise ValueError('bad storage policy %r for %r' %
1308
location = self.location
1309
if location.endswith('/'):
1310
location = location[:-1]
1311
parser = self._get_parser()
1312
if not location in parser and not location + '/' in parser:
1313
parser[location] = {}
1314
elif location + '/' in parser:
1315
location = location + '/'
1316
parser[location][option]=value
1317
# the allowed values of store match the config policies
1318
self._set_option_policy(location, option, store)
1319
self._write_config_file()
1320
for hook in OldConfigHooks['set']:
1321
hook(self, option, value)
1324
class BranchConfig(Config):
1325
"""A configuration object giving the policy for a branch."""
1327
def __init__(self, branch):
1328
super(BranchConfig, self).__init__()
1329
self._location_config = None
1330
self._branch_data_config = None
1331
self._global_config = None
1332
self.branch = branch
1333
self.option_sources = (self._get_location_config,
1334
self._get_branch_data_config,
1335
self._get_global_config)
1337
def config_id(self):
1340
def _get_branch_data_config(self):
1341
if self._branch_data_config is None:
1342
self._branch_data_config = TreeConfig(self.branch)
1343
self._branch_data_config.config_id = self.config_id
1344
return self._branch_data_config
1346
def _get_location_config(self):
1347
if self._location_config is None:
1348
self._location_config = LocationConfig(self.branch.base)
1349
return self._location_config
1351
def _get_global_config(self):
1352
if self._global_config is None:
1353
self._global_config = GlobalConfig()
1354
return self._global_config
1356
def _get_best_value(self, option_name):
1357
"""This returns a user option from local, tree or global config.
1359
They are tried in that order. Use get_safe_value if trusted values
1362
for source in self.option_sources:
1363
value = getattr(source(), option_name)()
1364
if value is not None:
1368
def _get_safe_value(self, option_name):
1369
"""This variant of get_best_value never returns untrusted values.
1371
It does not return values from the branch data, because the branch may
1372
not be controlled by the user.
1374
We may wish to allow locations.conf to control whether branches are
1375
trusted in the future.
1377
for source in (self._get_location_config, self._get_global_config):
1378
value = getattr(source(), option_name)()
1379
if value is not None:
1383
def _get_user_id(self):
1384
"""Return the full user id for the branch.
1386
e.g. "John Hacker <jhacker@example.com>"
1387
This is looked up in the email controlfile for the branch.
1389
return self._get_best_value('_get_user_id')
1391
def _get_change_editor(self):
1392
return self._get_best_value('_get_change_editor')
1394
def _get_signature_checking(self):
1395
"""See Config._get_signature_checking."""
1396
return self._get_best_value('_get_signature_checking')
1398
def _get_signing_policy(self):
1399
"""See Config._get_signing_policy."""
1400
return self._get_best_value('_get_signing_policy')
1402
def _get_user_option(self, option_name):
1403
"""See Config._get_user_option."""
1404
for source in self.option_sources:
1405
value = source()._get_user_option(option_name)
1406
if value is not None:
1410
def _get_sections(self, name=None):
1411
"""See IniBasedConfig.get_sections()."""
1412
for source in self.option_sources:
1413
for section in source()._get_sections(name):
1416
def _get_options(self, sections=None):
1418
# First the locations options
1419
for option in self._get_location_config()._get_options():
1421
# Then the branch options
1422
branch_config = self._get_branch_data_config()
1423
if sections is None:
1424
sections = [('DEFAULT', branch_config._get_parser())]
1425
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1426
# Config itself has no notion of sections :( -- vila 20101001
1427
config_id = self.config_id()
1428
for (section_name, section) in sections:
1429
for (name, value) in section.iteritems():
1430
yield (name, value, section_name,
1431
config_id, branch_config._get_parser())
1432
# Then the global options
1433
for option in self._get_global_config()._get_options():
1436
def set_user_option(self, name, value, store=STORE_BRANCH,
1438
if store == STORE_BRANCH:
1439
self._get_branch_data_config().set_option(value, name)
1440
elif store == STORE_GLOBAL:
1441
self._get_global_config().set_user_option(name, value)
1443
self._get_location_config().set_user_option(name, value, store)
1446
if store in (STORE_GLOBAL, STORE_BRANCH):
1447
mask_value = self._get_location_config().get_user_option(name)
1448
if mask_value is not None:
1449
trace.warning('Value "%s" is masked by "%s" from'
1450
' locations.conf', value, mask_value)
1452
if store == STORE_GLOBAL:
1453
branch_config = self._get_branch_data_config()
1454
mask_value = branch_config.get_user_option(name)
1455
if mask_value is not None:
1456
trace.warning('Value "%s" is masked by "%s" from'
1457
' branch.conf', value, mask_value)
1459
def remove_user_option(self, option_name, section_name=None):
1460
self._get_branch_data_config().remove_option(option_name, section_name)
1462
def _gpg_signing_command(self):
1463
"""See Config.gpg_signing_command."""
1464
return self._get_safe_value('_gpg_signing_command')
1466
def _post_commit(self):
1467
"""See Config.post_commit."""
1468
return self._get_safe_value('_post_commit')
1470
def _get_nickname(self):
1471
value = self._get_explicit_nickname()
1472
if value is not None:
1474
return urlutils.unescape(self.branch.base.split('/')[-2])
1476
def has_explicit_nickname(self):
1477
"""Return true if a nickname has been explicitly assigned."""
1478
return self._get_explicit_nickname() is not None
1480
def _get_explicit_nickname(self):
1481
return self._get_best_value('_get_nickname')
1483
def _log_format(self):
1484
"""See Config.log_format."""
1485
return self._get_best_value('_log_format')
1487
def _validate_signatures_in_log(self):
1488
"""See Config.validate_signatures_in_log."""
1489
return self._get_best_value('_validate_signatures_in_log')
1491
def _acceptable_keys(self):
1492
"""See Config.acceptable_keys."""
1493
return self._get_best_value('_acceptable_keys')
1496
def ensure_config_dir_exists(path=None):
1497
"""Make sure a configuration directory exists.
1498
This makes sure that the directory exists.
1499
On windows, since configuration directories are 2 levels deep,
1500
it makes sure both the directory and the parent directory exists.
1504
if not os.path.isdir(path):
1505
if sys.platform == 'win32':
1506
parent_dir = os.path.dirname(path)
1507
if not os.path.isdir(parent_dir):
1508
trace.mutter('creating config parent directory: %r', parent_dir)
1509
os.mkdir(parent_dir)
1510
trace.mutter('creating config directory: %r', path)
1512
osutils.copy_ownership_from_path(path)
1516
"""Return per-user configuration directory.
1518
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1519
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1520
that will be used instead.
1522
TODO: Global option --config-dir to override this.
1524
base = os.environ.get('BZR_HOME', None)
1525
if sys.platform == 'win32':
1526
# environ variables on Windows are in user encoding/mbcs. So decode
1528
if base is not None:
1529
base = base.decode('mbcs')
1531
base = win32utils.get_appdata_location_unicode()
1533
base = os.environ.get('HOME', None)
1534
if base is not None:
1535
base = base.decode('mbcs')
1537
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1539
return osutils.pathjoin(base, 'bazaar', '2.0')
1541
if base is not None:
1542
base = base.decode(osutils._fs_enc)
1543
if sys.platform == 'darwin':
1545
# this takes into account $HOME
1546
base = os.path.expanduser("~")
1547
return osutils.pathjoin(base, '.bazaar')
1550
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1552
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1553
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1554
if osutils.isdir(xdg_dir):
1556
"Using configuration in XDG directory %s." % xdg_dir)
1558
base = os.path.expanduser("~")
1559
return osutils.pathjoin(base, ".bazaar")
1562
def config_filename():
1563
"""Return per-user configuration ini file filename."""
1564
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1567
def locations_config_filename():
1568
"""Return per-user configuration ini file filename."""
1569
return osutils.pathjoin(config_dir(), 'locations.conf')
1572
def authentication_config_filename():
1573
"""Return per-user authentication ini file filename."""
1574
return osutils.pathjoin(config_dir(), 'authentication.conf')
1577
def user_ignore_config_filename():
1578
"""Return the user default ignore filename"""
1579
return osutils.pathjoin(config_dir(), 'ignore')
1583
"""Return the directory name to store crash files.
1585
This doesn't implicitly create it.
1587
On Windows it's in the config directory; elsewhere it's /var/crash
1588
which may be monitored by apport. It can be overridden by
1591
if sys.platform == 'win32':
1592
return osutils.pathjoin(config_dir(), 'Crash')
1594
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1596
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1599
def xdg_cache_dir():
1600
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1601
# Possibly this should be different on Windows?
1602
e = os.environ.get('XDG_CACHE_DIR', None)
1606
return os.path.expanduser('~/.cache')
1609
def _get_default_mail_domain():
1610
"""If possible, return the assumed default email domain.
1612
:returns: string mail domain, or None.
1614
if sys.platform == 'win32':
1615
# No implementation yet; patches welcome
1618
f = open('/etc/mailname')
1619
except (IOError, OSError), e:
1622
domain = f.read().strip()
1628
def default_email():
1629
v = os.environ.get('BZR_EMAIL')
1631
return v.decode(osutils.get_user_encoding())
1632
v = os.environ.get('EMAIL')
1634
return v.decode(osutils.get_user_encoding())
1635
name, email = _auto_user_id()
1637
return u'%s <%s>' % (name, email)
1640
raise errors.NoWhoami()
1643
def _auto_user_id():
1644
"""Calculate automatic user identification.
1646
:returns: (realname, email), either of which may be None if they can't be
1649
Only used when none is set in the environment or the id file.
1651
This only returns an email address if we can be fairly sure the
1652
address is reasonable, ie if /etc/mailname is set on unix.
1654
This doesn't use the FQDN as the default domain because that may be
1655
slow, and it doesn't use the hostname alone because that's not normally
1656
a reasonable address.
1658
if sys.platform == 'win32':
1659
# No implementation to reliably determine Windows default mail
1660
# address; please add one.
1663
default_mail_domain = _get_default_mail_domain()
1664
if not default_mail_domain:
1670
w = pwd.getpwuid(uid)
1672
trace.mutter('no passwd entry for uid %d?' % uid)
1675
# we try utf-8 first, because on many variants (like Linux),
1676
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1677
# false positives. (many users will have their user encoding set to
1678
# latin-1, which cannot raise UnicodeError.)
1680
gecos = w.pw_gecos.decode('utf-8')
1682
except UnicodeError:
1684
encoding = osutils.get_user_encoding()
1685
gecos = w.pw_gecos.decode(encoding)
1686
except UnicodeError, e:
1687
trace.mutter("cannot decode passwd entry %s" % w)
1690
username = w.pw_name.decode(encoding)
1691
except UnicodeError, e:
1692
trace.mutter("cannot decode passwd entry %s" % w)
1695
comma = gecos.find(',')
1699
realname = gecos[:comma]
1701
return realname, (username + '@' + default_mail_domain)
1704
def parse_username(username):
1705
"""Parse e-mail username and return a (name, address) tuple."""
1706
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1708
return (username, '')
1710
return (match.group(1), match.group(2))
1713
def extract_email_address(e):
1714
"""Return just the address part of an email string.
1716
That is just the user@domain part, nothing else.
1717
This part is required to contain only ascii characters.
1718
If it can't be extracted, raises an error.
1720
>>> extract_email_address('Jane Tester <jane@test.com>')
1723
name, email = parse_username(e)
1725
raise errors.NoEmailInUsername(e)
1729
class TreeConfig(IniBasedConfig):
1730
"""Branch configuration data associated with its contents, not location"""
1732
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1734
def __init__(self, branch):
1735
self._config = branch._get_config()
1736
self.branch = branch
1738
def _get_parser(self, file=None):
1739
if file is not None:
1740
return IniBasedConfig._get_parser(file)
1741
return self._config._get_configobj()
1743
def get_option(self, name, section=None, default=None):
1744
self.branch.lock_read()
1746
return self._config.get_option(name, section, default)
1748
self.branch.unlock()
1750
def set_option(self, value, name, section=None):
1751
"""Set a per-branch configuration option"""
1752
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1753
# higher levels providing the right lock -- vila 20101004
1754
self.branch.lock_write()
1756
self._config.set_option(value, name, section)
1758
self.branch.unlock()
1760
def remove_option(self, option_name, section_name=None):
1761
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1762
# higher levels providing the right lock -- vila 20101004
1763
self.branch.lock_write()
1765
self._config.remove_option(option_name, section_name)
1767
self.branch.unlock()
1770
class AuthenticationConfig(object):
1771
"""The authentication configuration file based on a ini file.
1773
Implements the authentication.conf file described in
1774
doc/developers/authentication-ring.txt.
1777
def __init__(self, _file=None):
1778
self._config = None # The ConfigObj
1780
self._filename = authentication_config_filename()
1781
self._input = self._filename = authentication_config_filename()
1783
# Tests can provide a string as _file
1784
self._filename = None
1787
def _get_config(self):
1788
if self._config is not None:
1791
# FIXME: Should we validate something here ? Includes: empty
1792
# sections are useless, at least one of
1793
# user/password/password_encoding should be defined, etc.
1795
# Note: the encoding below declares that the file itself is utf-8
1796
# encoded, but the values in the ConfigObj are always Unicode.
1797
self._config = ConfigObj(self._input, encoding='utf-8')
1798
except configobj.ConfigObjError, e:
1799
raise errors.ParseConfigError(e.errors, e.config.filename)
1800
except UnicodeError:
1801
raise errors.ConfigContentError(self._filename)
1805
"""Save the config file, only tests should use it for now."""
1806
conf_dir = os.path.dirname(self._filename)
1807
ensure_config_dir_exists(conf_dir)
1808
f = file(self._filename, 'wb')
1810
self._get_config().write(f)
1814
def _set_option(self, section_name, option_name, value):
1815
"""Set an authentication configuration option"""
1816
conf = self._get_config()
1817
section = conf.get(section_name)
1820
section = conf[section]
1821
section[option_name] = value
1824
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1826
"""Returns the matching credentials from authentication.conf file.
1828
:param scheme: protocol
1830
:param host: the server address
1832
:param port: the associated port (optional)
1834
:param user: login (optional)
1836
:param path: the absolute path on the server (optional)
1838
:param realm: the http authentication realm (optional)
1840
:return: A dict containing the matching credentials or None.
1842
- name: the section name of the credentials in the
1843
authentication.conf file,
1844
- user: can't be different from the provided user if any,
1845
- scheme: the server protocol,
1846
- host: the server address,
1847
- port: the server port (can be None),
1848
- path: the absolute server path (can be None),
1849
- realm: the http specific authentication realm (can be None),
1850
- password: the decoded password, could be None if the credential
1851
defines only the user
1852
- verify_certificates: https specific, True if the server
1853
certificate should be verified, False otherwise.
1856
for auth_def_name, auth_def in self._get_config().items():
1857
if type(auth_def) is not configobj.Section:
1858
raise ValueError("%s defined outside a section" % auth_def_name)
1860
a_scheme, a_host, a_user, a_path = map(
1861
auth_def.get, ['scheme', 'host', 'user', 'path'])
1864
a_port = auth_def.as_int('port')
1868
raise ValueError("'port' not numeric in %s" % auth_def_name)
1870
a_verify_certificates = auth_def.as_bool('verify_certificates')
1872
a_verify_certificates = True
1875
"'verify_certificates' not boolean in %s" % auth_def_name)
1878
if a_scheme is not None and scheme != a_scheme:
1880
if a_host is not None:
1881
if not (host == a_host
1882
or (a_host.startswith('.') and host.endswith(a_host))):
1884
if a_port is not None and port != a_port:
1886
if (a_path is not None and path is not None
1887
and not path.startswith(a_path)):
1889
if (a_user is not None and user is not None
1890
and a_user != user):
1891
# Never contradict the caller about the user to be used
1896
# Prepare a credentials dictionary with additional keys
1897
# for the credential providers
1898
credentials = dict(name=auth_def_name,
1905
password=auth_def.get('password', None),
1906
verify_certificates=a_verify_certificates)
1907
# Decode the password in the credentials (or get one)
1908
self.decode_password(credentials,
1909
auth_def.get('password_encoding', None))
1910
if 'auth' in debug.debug_flags:
1911
trace.mutter("Using authentication section: %r", auth_def_name)
1914
if credentials is None:
1915
# No credentials were found in authentication.conf, try the fallback
1916
# credentials stores.
1917
credentials = credential_store_registry.get_fallback_credentials(
1918
scheme, host, port, user, path, realm)
1922
def set_credentials(self, name, host, user, scheme=None, password=None,
1923
port=None, path=None, verify_certificates=None,
1925
"""Set authentication credentials for a host.
1927
Any existing credentials with matching scheme, host, port and path
1928
will be deleted, regardless of name.
1930
:param name: An arbitrary name to describe this set of credentials.
1931
:param host: Name of the host that accepts these credentials.
1932
:param user: The username portion of these credentials.
1933
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1935
:param password: Password portion of these credentials.
1936
:param port: The IP port on the host that these credentials apply to.
1937
:param path: A filesystem path on the host that these credentials
1939
:param verify_certificates: On https, verify server certificates if
1941
:param realm: The http authentication realm (optional).
1943
values = {'host': host, 'user': user}
1944
if password is not None:
1945
values['password'] = password
1946
if scheme is not None:
1947
values['scheme'] = scheme
1948
if port is not None:
1949
values['port'] = '%d' % port
1950
if path is not None:
1951
values['path'] = path
1952
if verify_certificates is not None:
1953
values['verify_certificates'] = str(verify_certificates)
1954
if realm is not None:
1955
values['realm'] = realm
1956
config = self._get_config()
1958
for section, existing_values in config.items():
1959
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1960
if existing_values.get(key) != values.get(key):
1964
config.update({name: values})
1967
def get_user(self, scheme, host, port=None, realm=None, path=None,
1968
prompt=None, ask=False, default=None):
1969
"""Get a user from authentication file.
1971
:param scheme: protocol
1973
:param host: the server address
1975
:param port: the associated port (optional)
1977
:param realm: the realm sent by the server (optional)
1979
:param path: the absolute path on the server (optional)
1981
:param ask: Ask the user if there is no explicitly configured username
1984
:param default: The username returned if none is defined (optional).
1986
:return: The found user.
1988
credentials = self.get_credentials(scheme, host, port, user=None,
1989
path=path, realm=realm)
1990
if credentials is not None:
1991
user = credentials['user']
1997
# Create a default prompt suitable for most cases
1998
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1999
# Special handling for optional fields in the prompt
2000
if port is not None:
2001
prompt_host = '%s:%d' % (host, port)
2004
user = ui.ui_factory.get_username(prompt, host=prompt_host)
2009
def get_password(self, scheme, host, user, port=None,
2010
realm=None, path=None, prompt=None):
2011
"""Get a password from authentication file or prompt the user for one.
2013
:param scheme: protocol
2015
:param host: the server address
2017
:param port: the associated port (optional)
2021
:param realm: the realm sent by the server (optional)
2023
:param path: the absolute path on the server (optional)
2025
:return: The found password or the one entered by the user.
2027
credentials = self.get_credentials(scheme, host, port, user, path,
2029
if credentials is not None:
2030
password = credentials['password']
2031
if password is not None and scheme is 'ssh':
2032
trace.warning('password ignored in section [%s],'
2033
' use an ssh agent instead'
2034
% credentials['name'])
2038
# Prompt user only if we could't find a password
2039
if password is None:
2041
# Create a default prompt suitable for most cases
2042
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2043
# Special handling for optional fields in the prompt
2044
if port is not None:
2045
prompt_host = '%s:%d' % (host, port)
2048
password = ui.ui_factory.get_password(prompt,
2049
host=prompt_host, user=user)
2052
def decode_password(self, credentials, encoding):
2054
cs = credential_store_registry.get_credential_store(encoding)
2056
raise ValueError('%r is not a known password_encoding' % encoding)
2057
credentials['password'] = cs.decode_password(credentials)
2061
class CredentialStoreRegistry(registry.Registry):
2062
"""A class that registers credential stores.
2064
A credential store provides access to credentials via the password_encoding
2065
field in authentication.conf sections.
2067
Except for stores provided by bzr itself, most stores are expected to be
2068
provided by plugins that will therefore use
2069
register_lazy(password_encoding, module_name, member_name, help=help,
2070
fallback=fallback) to install themselves.
2072
A fallback credential store is one that is queried if no credentials can be
2073
found via authentication.conf.
2076
def get_credential_store(self, encoding=None):
2077
cs = self.get(encoding)
2082
def is_fallback(self, name):
2083
"""Check if the named credentials store should be used as fallback."""
2084
return self.get_info(name)
2086
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2087
path=None, realm=None):
2088
"""Request credentials from all fallback credentials stores.
2090
The first credentials store that can provide credentials wins.
2093
for name in self.keys():
2094
if not self.is_fallback(name):
2096
cs = self.get_credential_store(name)
2097
credentials = cs.get_credentials(scheme, host, port, user,
2099
if credentials is not None:
2100
# We found some credentials
2104
def register(self, key, obj, help=None, override_existing=False,
2106
"""Register a new object to a name.
2108
:param key: This is the key to use to request the object later.
2109
:param obj: The object to register.
2110
:param help: Help text for this entry. This may be a string or
2111
a callable. If it is a callable, it should take two
2112
parameters (registry, key): this registry and the key that
2113
the help was registered under.
2114
:param override_existing: Raise KeyErorr if False and something has
2115
already been registered for that key. If True, ignore if there
2116
is an existing key (always register the new value).
2117
:param fallback: Whether this credential store should be
2120
return super(CredentialStoreRegistry,
2121
self).register(key, obj, help, info=fallback,
2122
override_existing=override_existing)
2124
def register_lazy(self, key, module_name, member_name,
2125
help=None, override_existing=False,
2127
"""Register a new credential store to be loaded on request.
2129
:param module_name: The python path to the module. Such as 'os.path'.
2130
:param member_name: The member of the module to return. If empty or
2131
None, get() will return the module itself.
2132
:param help: Help text for this entry. This may be a string or
2134
:param override_existing: If True, replace the existing object
2135
with the new one. If False, if there is already something
2136
registered with the same key, raise a KeyError
2137
:param fallback: Whether this credential store should be
2140
return super(CredentialStoreRegistry, self).register_lazy(
2141
key, module_name, member_name, help,
2142
info=fallback, override_existing=override_existing)
2145
credential_store_registry = CredentialStoreRegistry()
2148
class CredentialStore(object):
2149
"""An abstract class to implement storage for credentials"""
2151
def decode_password(self, credentials):
2152
"""Returns a clear text password for the provided credentials."""
2153
raise NotImplementedError(self.decode_password)
2155
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2157
"""Return the matching credentials from this credential store.
2159
This method is only called on fallback credential stores.
2161
raise NotImplementedError(self.get_credentials)
2165
class PlainTextCredentialStore(CredentialStore):
2166
__doc__ = """Plain text credential store for the authentication.conf file"""
2168
def decode_password(self, credentials):
2169
"""See CredentialStore.decode_password."""
2170
return credentials['password']
2173
credential_store_registry.register('plain', PlainTextCredentialStore,
2174
help=PlainTextCredentialStore.__doc__)
2175
credential_store_registry.default_key = 'plain'
2178
class BzrDirConfig(object):
2180
def __init__(self, bzrdir):
2181
self._bzrdir = bzrdir
2182
self._config = bzrdir._get_config()
2184
def set_default_stack_on(self, value):
2185
"""Set the default stacking location.
2187
It may be set to a location, or None.
2189
This policy affects all branches contained by this bzrdir, except for
2190
those under repositories.
2192
if self._config is None:
2193
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2195
self._config.set_option('', 'default_stack_on')
2197
self._config.set_option(value, 'default_stack_on')
2199
def get_default_stack_on(self):
2200
"""Return the default stacking location.
2202
This will either be a location, or None.
2204
This policy affects all branches contained by this bzrdir, except for
2205
those under repositories.
2207
if self._config is None:
2209
value = self._config.get_option('default_stack_on')
2215
class TransportConfig(object):
2216
"""A Config that reads/writes a config file on a Transport.
2218
It is a low-level object that considers config data to be name/value pairs
2219
that may be associated with a section. Assigning meaning to these values
2220
is done at higher levels like TreeConfig.
2223
def __init__(self, transport, filename):
2224
self._transport = transport
2225
self._filename = filename
2227
def get_option(self, name, section=None, default=None):
2228
"""Return the value associated with a named option.
2230
:param name: The name of the value
2231
:param section: The section the option is in (if any)
2232
:param default: The value to return if the value is not set
2233
:return: The value or default value
2235
configobj = self._get_configobj()
2237
section_obj = configobj
2240
section_obj = configobj[section]
2243
value = section_obj.get(name, default)
2244
for hook in OldConfigHooks['get']:
2245
hook(self, name, value)
2248
def set_option(self, value, name, section=None):
2249
"""Set the value associated with a named option.
2251
:param value: The value to set
2252
:param name: The name of the value to set
2253
:param section: The section the option is in (if any)
2255
configobj = self._get_configobj()
2257
configobj[name] = value
2259
configobj.setdefault(section, {})[name] = value
2260
for hook in OldConfigHooks['set']:
2261
hook(self, name, value)
2262
self._set_configobj(configobj)
2264
def remove_option(self, option_name, section_name=None):
2265
configobj = self._get_configobj()
2266
if section_name is None:
2267
del configobj[option_name]
2269
del configobj[section_name][option_name]
2270
for hook in OldConfigHooks['remove']:
2271
hook(self, option_name)
2272
self._set_configobj(configobj)
2274
def _get_config_file(self):
2276
f = StringIO(self._transport.get_bytes(self._filename))
2277
for hook in OldConfigHooks['load']:
2280
except errors.NoSuchFile:
2282
except errors.PermissionDenied, e:
2283
trace.warning("Permission denied while trying to open "
2284
"configuration file %s.", urlutils.unescape_for_display(
2285
urlutils.join(self._transport.base, self._filename), "utf-8"))
2288
def _external_url(self):
2289
return urlutils.join(self._transport.external_url(), self._filename)
2291
def _get_configobj(self):
2292
f = self._get_config_file()
2295
conf = ConfigObj(f, encoding='utf-8')
2296
except configobj.ConfigObjError, e:
2297
raise errors.ParseConfigError(e.errors, self._external_url())
2298
except UnicodeDecodeError:
2299
raise errors.ConfigContentError(self._external_url())
2304
def _set_configobj(self, configobj):
2305
out_file = StringIO()
2306
configobj.write(out_file)
2308
self._transport.put_file(self._filename, out_file)
2309
for hook in OldConfigHooks['save']:
2313
class Option(object):
2314
"""An option definition.
2316
The option *values* are stored in config files and found in sections.
2318
Here we define various properties about the option itself, its default
2319
value, how to convert it from stores, what to do when invalid values are
2320
encoutered, in which config files it can be stored.
2323
def __init__(self, name, override_from_env=None,
2324
default=None, default_from_env=None,
2325
help=None, from_unicode=None, invalid=None, unquote=True):
2326
"""Build an option definition.
2328
:param name: the name used to refer to the option.
2330
:param override_from_env: A list of environment variables which can
2331
provide override any configuration setting.
2333
:param default: the default value to use when none exist in the config
2334
stores. This is either a string that ``from_unicode`` will convert
2335
into the proper type, a callable returning a unicode string so that
2336
``from_unicode`` can be used on the return value, or a python
2337
object that can be stringified (so only the empty list is supported
2340
:param default_from_env: A list of environment variables which can
2341
provide a default value. 'default' will be used only if none of the
2342
variables specified here are set in the environment.
2344
:param help: a doc string to explain the option to the user.
2346
:param from_unicode: a callable to convert the unicode string
2347
representing the option value in a store. This is not called for
2350
:param invalid: the action to be taken when an invalid value is
2351
encountered in a store. This is called only when from_unicode is
2352
invoked to convert a string and returns None or raise ValueError or
2353
TypeError. Accepted values are: None (ignore invalid values),
2354
'warning' (emit a warning), 'error' (emit an error message and
2357
:param unquote: should the unicode value be unquoted before conversion.
2358
This should be used only when the store providing the values cannot
2359
safely unquote them (see http://pad.lv/906897). It is provided so
2360
daughter classes can handle the quoting themselves.
2362
if override_from_env is None:
2363
override_from_env = []
2364
if default_from_env is None:
2365
default_from_env = []
2367
self.override_from_env = override_from_env
2368
# Convert the default value to a unicode string so all values are
2369
# strings internally before conversion (via from_unicode) is attempted.
2372
elif isinstance(default, list):
2373
# Only the empty list is supported
2375
raise AssertionError(
2376
'Only empty lists are supported as default values')
2378
elif isinstance(default, (str, unicode, bool, int, float)):
2379
# Rely on python to convert strings, booleans and integers
2380
self.default = u'%s' % (default,)
2381
elif callable(default):
2382
self.default = default
2384
# other python objects are not expected
2385
raise AssertionError('%r is not supported as a default value'
2387
self.default_from_env = default_from_env
2389
self.from_unicode = from_unicode
2390
self.unquote = unquote
2391
if invalid and invalid not in ('warning', 'error'):
2392
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2393
self.invalid = invalid
2399
def convert_from_unicode(self, store, unicode_value):
2400
if self.unquote and store is not None and unicode_value is not None:
2401
unicode_value = store.unquote(unicode_value)
2402
if self.from_unicode is None or unicode_value is None:
2403
# Don't convert or nothing to convert
2404
return unicode_value
2406
converted = self.from_unicode(unicode_value)
2407
except (ValueError, TypeError):
2408
# Invalid values are ignored
2410
if converted is None and self.invalid is not None:
2411
# The conversion failed
2412
if self.invalid == 'warning':
2413
trace.warning('Value "%s" is not valid for "%s"',
2414
unicode_value, self.name)
2415
elif self.invalid == 'error':
2416
raise errors.ConfigOptionValueError(self.name, unicode_value)
2419
def get_override(self):
2421
for var in self.override_from_env:
2423
# If the env variable is defined, its value takes precedence
2424
value = os.environ[var].decode(osutils.get_user_encoding())
2430
def get_default(self):
2432
for var in self.default_from_env:
2434
# If the env variable is defined, its value is the default one
2435
value = os.environ[var].decode(osutils.get_user_encoding())
2440
# Otherwise, fallback to the value defined at registration
2441
if callable(self.default):
2442
value = self.default()
2443
if not isinstance(value, unicode):
2444
raise AssertionError(
2445
'Callable default values should be unicode')
2447
value = self.default
2450
def get_help_text(self, additional_see_also=None, plain=True):
2452
from bzrlib import help_topics
2453
result += help_topics._format_see_also(additional_see_also)
2455
result = help_topics.help_as_plain_text(result)
2459
# Predefined converters to get proper values from store
2461
def bool_from_store(unicode_str):
2462
return ui.bool_from_string(unicode_str)
2465
def int_from_store(unicode_str):
2466
return int(unicode_str)
2469
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2471
def int_SI_from_store(unicode_str):
2472
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2474
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2475
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2478
:return Integer, expanded to its base-10 value if a proper SI unit is
2479
found, None otherwise.
2481
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2482
p = re.compile(regexp, re.IGNORECASE)
2483
m = p.match(unicode_str)
2486
val, _, unit = m.groups()
2490
coeff = _unit_suffixes[unit.upper()]
2492
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2497
def float_from_store(unicode_str):
2498
return float(unicode_str)
2501
# Use a an empty dict to initialize an empty configobj avoiding all
2502
# parsing and encoding checks
2503
_list_converter_config = configobj.ConfigObj(
2504
{}, encoding='utf-8', list_values=True, interpolation=False)
2507
class ListOption(Option):
2509
def __init__(self, name, default=None, default_from_env=None,
2510
help=None, invalid=None):
2511
"""A list Option definition.
2513
This overrides the base class so the conversion from a unicode string
2514
can take quoting into account.
2516
super(ListOption, self).__init__(
2517
name, default=default, default_from_env=default_from_env,
2518
from_unicode=self.from_unicode, help=help,
2519
invalid=invalid, unquote=False)
2521
def from_unicode(self, unicode_str):
2522
if not isinstance(unicode_str, basestring):
2524
# Now inject our string directly as unicode. All callers got their
2525
# value from configobj, so values that need to be quoted are already
2527
_list_converter_config.reset()
2528
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2529
maybe_list = _list_converter_config['list']
2530
if isinstance(maybe_list, basestring):
2532
# A single value, most probably the user forgot (or didn't care
2533
# to add) the final ','
2536
# The empty string, convert to empty list
2539
# We rely on ConfigObj providing us with a list already
2544
class RegistryOption(Option):
2545
"""Option for a choice from a registry."""
2547
def __init__(self, name, registry, default_from_env=None,
2548
help=None, invalid=None):
2549
"""A registry based Option definition.
2551
This overrides the base class so the conversion from a unicode string
2552
can take quoting into account.
2554
super(RegistryOption, self).__init__(
2555
name, default=lambda: unicode(registry.default_key),
2556
default_from_env=default_from_env,
2557
from_unicode=self.from_unicode, help=help,
2558
invalid=invalid, unquote=False)
2559
self.registry = registry
2561
def from_unicode(self, unicode_str):
2562
if not isinstance(unicode_str, basestring):
2565
return self.registry.get(unicode_str)
2568
"Invalid value %s for %s."
2569
"See help for a list of possible values." % (unicode_str,
2574
ret = [self._help, "\n\nThe following values are supported:\n"]
2575
for key in self.registry.keys():
2576
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2580
class OptionRegistry(registry.Registry):
2581
"""Register config options by their name.
2583
This overrides ``registry.Registry`` to simplify registration by acquiring
2584
some information from the option object itself.
2587
def register(self, option):
2588
"""Register a new option to its name.
2590
:param option: The option to register. Its name is used as the key.
2592
super(OptionRegistry, self).register(option.name, option,
2595
def register_lazy(self, key, module_name, member_name):
2596
"""Register a new option to be loaded on request.
2598
:param key: the key to request the option later. Since the registration
2599
is lazy, it should be provided and match the option name.
2601
:param module_name: the python path to the module. Such as 'os.path'.
2603
:param member_name: the member of the module to return. If empty or
2604
None, get() will return the module itself.
2606
super(OptionRegistry, self).register_lazy(key,
2607
module_name, member_name)
2609
def get_help(self, key=None):
2610
"""Get the help text associated with the given key"""
2611
option = self.get(key)
2612
the_help = option.help
2613
if callable(the_help):
2614
return the_help(self, key)
2618
option_registry = OptionRegistry()
2621
# Registered options in lexicographical order
2623
option_registry.register(
2624
Option('append_revisions_only',
2625
default=None, from_unicode=bool_from_store, invalid='warning',
2627
Whether to only append revisions to the mainline.
2629
If this is set to true, then it is not possible to change the
2630
existing mainline of the branch.
2632
option_registry.register(
2633
ListOption('acceptable_keys',
2636
List of GPG key patterns which are acceptable for verification.
2638
option_registry.register(
2639
Option('add.maximum_file_size',
2640
default=u'20MB', from_unicode=int_SI_from_store,
2642
Size above which files should be added manually.
2644
Files below this size are added automatically when using ``bzr add`` without
2647
A negative value means disable the size check.
2649
option_registry.register(
2651
default=None, from_unicode=bool_from_store,
2653
Is the branch bound to ``bound_location``.
2655
If set to "True", the branch should act as a checkout, and push each commit to
2656
the bound_location. This option is normally set by ``bind``/``unbind``.
2658
See also: bound_location.
2660
option_registry.register(
2661
Option('bound_location',
2664
The location that commits should go to when acting as a checkout.
2666
This option is normally set by ``bind``.
2670
option_registry.register(
2671
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2673
Whether revisions associated with tags should be fetched.
2675
option_registry.register(
2676
Option('bzr.workingtree.worth_saving_limit', default=10,
2677
from_unicode=int_from_store, invalid='warning',
2679
How many changes before saving the dirstate.
2681
-1 means that we will never rewrite the dirstate file for only
2682
stat-cache changes. Regardless of this setting, we will always rewrite
2683
the dirstate file if a file is added/removed/renamed/etc. This flag only
2684
affects the behavior of updating the dirstate file after we notice that
2685
a file has been touched.
2687
option_registry.register(
2688
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2689
from_unicode=signature_policy_from_unicode,
2691
GPG checking policy.
2693
Possible values: require, ignore, check-available (default)
2695
this option will control whether bzr will require good gpg
2696
signatures, ignore them, or check them if they are
2699
option_registry.register(
2700
Option('child_submit_format',
2701
help='''The preferred format of submissions to this branch.'''))
2702
option_registry.register(
2703
Option('child_submit_to',
2704
help='''Where submissions to this branch are mailed to.'''))
2705
option_registry.register(
2706
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2707
from_unicode=signing_policy_from_unicode,
2711
Possible values: always, never, when-required (default)
2713
This option controls whether bzr will always create
2714
gpg signatures or not on commits.
2716
option_registry.register(
2717
Option('dirstate.fdatasync', default=True,
2718
from_unicode=bool_from_store,
2720
Flush dirstate changes onto physical disk?
2722
If true (default), working tree metadata changes are flushed through the
2723
OS buffers to physical disk. This is somewhat slower, but means data
2724
should not be lost if the machine crashes. See also repository.fdatasync.
2726
option_registry.register(
2727
ListOption('debug_flags', default=[],
2728
help='Debug flags to activate.'))
2729
option_registry.register(
2730
Option('default_format', default='2a',
2731
help='Format used when creating branches.'))
2732
option_registry.register(
2733
Option('dpush_strict', default=None,
2734
from_unicode=bool_from_store,
2736
The default value for ``dpush --strict``.
2738
If present, defines the ``--strict`` option default value for checking
2739
uncommitted changes before pushing into a different VCS without any
2740
custom bzr metadata.
2742
option_registry.register(
2744
help='The command called to launch an editor to enter a message.'))
2745
option_registry.register(
2746
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2747
help='The users identity'))
2748
option_registry.register(
2749
Option('gpg_signing_command',
2752
Program to use use for creating signatures.
2754
This should support at least the -u and --clearsign options.
2756
option_registry.register(
2757
Option('gpg_signing_key',
2760
GPG key to use for signing.
2762
This defaults to the first key associated with the users email.
2764
option_registry.register(
2765
Option('ignore_missing_extensions', default=False,
2766
from_unicode=bool_from_store,
2768
Control the missing extensions warning display.
2770
The warning will not be emitted if set to True.
2772
option_registry.register(
2774
help='Language to translate messages into.'))
2775
option_registry.register(
2776
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2778
Steal locks that appears to be dead.
2780
If set to True, bzr will check if a lock is supposed to be held by an
2781
active process from the same user on the same machine. If the user and
2782
machine match, but no process with the given PID is active, then bzr
2783
will automatically break the stale lock, and create a new lock for
2785
Otherwise, bzr will prompt as normal to break the lock.
2787
option_registry.register(
2788
Option('log_format', default='long',
2790
Log format to use when displaying revisions.
2792
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2793
may be provided by plugins.
2795
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2797
option_registry.register(
2798
Option('output_encoding',
2799
help= 'Unicode encoding for output'
2800
' (terminal encoding if not specified).'))
2801
option_registry.register(
2802
Option('parent_location',
2805
The location of the default branch for pull or merge.
2807
This option is normally set when creating a branch, the first ``pull`` or by
2808
``pull --remember``.
2810
option_registry.register(
2811
Option('post_commit', default=None,
2813
Post commit functions.
2815
An ordered list of python functions to call, separated by spaces.
2817
Each function takes branch, rev_id as parameters.
2819
option_registry.register(
2820
Option('public_branch',
2823
A publically-accessible version of this branch.
2825
This implies that the branch setting this option is not publically-accessible.
2826
Used and set by ``bzr send``.
2828
option_registry.register(
2829
Option('push_location',
2832
The location of the default branch for push.
2834
This option is normally set by the first ``push`` or ``push --remember``.
2836
option_registry.register(
2837
Option('push_strict', default=None,
2838
from_unicode=bool_from_store,
2840
The default value for ``push --strict``.
2842
If present, defines the ``--strict`` option default value for checking
2843
uncommitted changes before sending a merge directive.
2845
option_registry.register(
2846
Option('repository.fdatasync', default=True,
2847
from_unicode=bool_from_store,
2849
Flush repository changes onto physical disk?
2851
If true (default), repository changes are flushed through the OS buffers
2852
to physical disk. This is somewhat slower, but means data should not be
2853
lost if the machine crashes. See also dirstate.fdatasync.
2855
option_registry.register_lazy('smtp_server',
2856
'bzrlib.smtp_connection', 'smtp_server')
2857
option_registry.register_lazy('smtp_password',
2858
'bzrlib.smtp_connection', 'smtp_password')
2859
option_registry.register_lazy('smtp_username',
2860
'bzrlib.smtp_connection', 'smtp_username')
2861
option_registry.register(
2862
Option('selftest.timeout',
2864
from_unicode=int_from_store,
2865
help='Abort selftest if one test takes longer than this many seconds',
2868
option_registry.register(
2869
Option('send_strict', default=None,
2870
from_unicode=bool_from_store,
2872
The default value for ``send --strict``.
2874
If present, defines the ``--strict`` option default value for checking
2875
uncommitted changes before sending a bundle.
2878
option_registry.register(
2879
Option('serve.client_timeout',
2880
default=300.0, from_unicode=float_from_store,
2881
help="If we wait for a new request from a client for more than"
2882
" X seconds, consider the client idle, and hangup."))
2883
option_registry.register(
2884
Option('stacked_on_location',
2886
help="""The location where this branch is stacked on."""))
2887
option_registry.register(
2888
Option('submit_branch',
2891
The branch you intend to submit your current work to.
2893
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2894
by the ``submit:`` revision spec.
2896
option_registry.register(
2898
help='''Where submissions from this branch are mailed to.'''))
2899
option_registry.register(
2900
ListOption('suppress_warnings',
2902
help="List of warning classes to suppress."))
2903
option_registry.register(
2904
Option('validate_signatures_in_log', default=False,
2905
from_unicode=bool_from_store, invalid='warning',
2906
help='''Whether to validate signatures in bzr log.'''))
2907
option_registry.register_lazy('ssl.ca_certs',
2908
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2910
option_registry.register_lazy('ssl.cert_reqs',
2911
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2915
class Section(object):
2916
"""A section defines a dict of option name => value.
2918
This is merely a read-only dict which can add some knowledge about the
2919
options. It is *not* a python dict object though and doesn't try to mimic
2923
def __init__(self, section_id, options):
2924
self.id = section_id
2925
# We re-use the dict-like object received
2926
self.options = options
2928
def get(self, name, default=None, expand=True):
2929
return self.options.get(name, default)
2931
def iter_option_names(self):
2932
for k in self.options.iterkeys():
2936
# Mostly for debugging use
2937
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2940
_NewlyCreatedOption = object()
2941
"""Was the option created during the MutableSection lifetime"""
2942
_DeletedOption = object()
2943
"""Was the option deleted during the MutableSection lifetime"""
2946
class MutableSection(Section):
2947
"""A section allowing changes and keeping track of the original values."""
2949
def __init__(self, section_id, options):
2950
super(MutableSection, self).__init__(section_id, options)
2951
self.reset_changes()
2953
def set(self, name, value):
2954
if name not in self.options:
2955
# This is a new option
2956
self.orig[name] = _NewlyCreatedOption
2957
elif name not in self.orig:
2958
self.orig[name] = self.get(name, None)
2959
self.options[name] = value
2961
def remove(self, name):
2962
if name not in self.orig:
2963
self.orig[name] = self.get(name, None)
2964
del self.options[name]
2966
def reset_changes(self):
2969
def apply_changes(self, dirty, store):
2970
"""Apply option value changes.
2972
``self`` has been reloaded from the persistent storage. ``dirty``
2973
contains the changes made since the previous loading.
2975
:param dirty: the mutable section containing the changes.
2977
:param store: the store containing the section
2979
for k, expected in dirty.orig.iteritems():
2980
actual = dirty.get(k, _DeletedOption)
2981
reloaded = self.get(k, _NewlyCreatedOption)
2982
if actual is _DeletedOption:
2983
if k in self.options:
2987
# Report concurrent updates in an ad-hoc way. This should only
2988
# occurs when different processes try to update the same option
2989
# which is not supported (as in: the config framework is not meant
2990
# to be used a sharing mechanism).
2991
if expected != reloaded:
2992
if actual is _DeletedOption:
2993
actual = '<DELETED>'
2994
if reloaded is _NewlyCreatedOption:
2995
reloaded = '<CREATED>'
2996
if expected is _NewlyCreatedOption:
2997
expected = '<CREATED>'
2998
# Someone changed the value since we get it from the persistent
3000
trace.warning(gettext(
3001
"Option {0} in section {1} of {2} was changed"
3002
" from {3} to {4}. The {5} value will be saved.".format(
3003
k, self.id, store.external_url(), expected,
3005
# No need to keep track of these changes
3006
self.reset_changes()
3009
class Store(object):
3010
"""Abstract interface to persistent storage for configuration options."""
3012
readonly_section_class = Section
3013
mutable_section_class = MutableSection
3016
# Which sections need to be saved
3017
self.dirty_sections = []
3019
def is_loaded(self):
3020
"""Returns True if the Store has been loaded.
3022
This is used to implement lazy loading and ensure the persistent
3023
storage is queried only when needed.
3025
raise NotImplementedError(self.is_loaded)
3028
"""Loads the Store from persistent storage."""
3029
raise NotImplementedError(self.load)
3031
def _load_from_string(self, bytes):
3032
"""Create a store from a string in configobj syntax.
3034
:param bytes: A string representing the file content.
3036
raise NotImplementedError(self._load_from_string)
3039
"""Unloads the Store.
3041
This should make is_loaded() return False. This is used when the caller
3042
knows that the persistent storage has changed or may have change since
3045
raise NotImplementedError(self.unload)
3047
def quote(self, value):
3048
"""Quote a configuration option value for storing purposes.
3050
This allows Stacks to present values as they will be stored.
3054
def unquote(self, value):
3055
"""Unquote a configuration option value into unicode.
3057
The received value is quoted as stored.
3062
"""Saves the Store to persistent storage."""
3063
raise NotImplementedError(self.save)
3065
def _need_saving(self):
3066
for s in self.dirty_sections:
3068
# At least one dirty section contains a modification
3072
def apply_changes(self, dirty_sections):
3073
"""Apply changes from dirty sections while checking for coherency.
3075
The Store content is discarded and reloaded from persistent storage to
3076
acquire up-to-date values.
3078
Dirty sections are MutableSection which kept track of the value they
3079
are expected to update.
3081
# We need an up-to-date version from the persistent storage, unload the
3082
# store. The reload will occur when needed (triggered by the first
3083
# get_mutable_section() call below.
3085
# Apply the changes from the preserved dirty sections
3086
for dirty in dirty_sections:
3087
clean = self.get_mutable_section(dirty.id)
3088
clean.apply_changes(dirty, self)
3089
# Everything is clean now
3090
self.dirty_sections = []
3092
def save_changes(self):
3093
"""Saves the Store to persistent storage if changes occurred.
3095
Apply the changes recorded in the mutable sections to a store content
3096
refreshed from persistent storage.
3098
raise NotImplementedError(self.save_changes)
3100
def external_url(self):
3101
raise NotImplementedError(self.external_url)
3103
def get_sections(self):
3104
"""Returns an ordered iterable of existing sections.
3106
:returns: An iterable of (store, section).
3108
raise NotImplementedError(self.get_sections)
3110
def get_mutable_section(self, section_id=None):
3111
"""Returns the specified mutable section.
3113
:param section_id: The section identifier
3115
raise NotImplementedError(self.get_mutable_section)
3118
# Mostly for debugging use
3119
return "<config.%s(%s)>" % (self.__class__.__name__,
3120
self.external_url())
3123
class CommandLineStore(Store):
3124
"A store to carry command line overrides for the config options."""
3126
def __init__(self, opts=None):
3127
super(CommandLineStore, self).__init__()
3134
# The dict should be cleared but not replaced so it can be shared.
3135
self.options.clear()
3137
def _from_cmdline(self, overrides):
3138
# Reset before accepting new definitions
3140
for over in overrides:
3142
name, value = over.split('=', 1)
3144
raise errors.BzrCommandError(
3145
gettext("Invalid '%s', should be of the form 'name=value'")
3147
self.options[name] = value
3149
def external_url(self):
3150
# Not an url but it makes debugging easier and is never needed
3154
def get_sections(self):
3155
yield self, self.readonly_section_class(None, self.options)
3158
class IniFileStore(Store):
3159
"""A config Store using ConfigObj for storage.
3161
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3162
serialize/deserialize the config file.
3166
"""A config Store using ConfigObj for storage.
3168
super(IniFileStore, self).__init__()
3169
self._config_obj = None
3171
def is_loaded(self):
3172
return self._config_obj != None
3175
self._config_obj = None
3176
self.dirty_sections = []
3178
def _load_content(self):
3179
"""Load the config file bytes.
3181
This should be provided by subclasses
3183
:return: Byte string
3185
raise NotImplementedError(self._load_content)
3187
def _save_content(self, content):
3188
"""Save the config file bytes.
3190
This should be provided by subclasses
3192
:param content: Config file bytes to write
3194
raise NotImplementedError(self._save_content)
3197
"""Load the store from the associated file."""
3198
if self.is_loaded():
3200
content = self._load_content()
3201
self._load_from_string(content)
3202
for hook in ConfigHooks['load']:
3205
def _load_from_string(self, bytes):
3206
"""Create a config store from a string.
3208
:param bytes: A string representing the file content.
3210
if self.is_loaded():
3211
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3212
co_input = StringIO(bytes)
3214
# The config files are always stored utf8-encoded
3215
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3217
except configobj.ConfigObjError, e:
3218
self._config_obj = None
3219
raise errors.ParseConfigError(e.errors, self.external_url())
3220
except UnicodeDecodeError:
3221
raise errors.ConfigContentError(self.external_url())
3223
def save_changes(self):
3224
if not self.is_loaded():
3227
if not self._need_saving():
3229
# Preserve the current version
3230
current = self._config_obj
3231
dirty_sections = list(self.dirty_sections)
3232
self.apply_changes(dirty_sections)
3233
# Save to the persistent storage
3237
if not self.is_loaded():
3241
self._config_obj.write(out)
3242
self._save_content(out.getvalue())
3243
for hook in ConfigHooks['save']:
3246
def get_sections(self):
3247
"""Get the configobj section in the file order.
3249
:returns: An iterable of (store, section).
3251
# We need a loaded store
3254
except (errors.NoSuchFile, errors.PermissionDenied):
3255
# If the file can't be read, there is no sections
3257
cobj = self._config_obj
3259
yield self, self.readonly_section_class(None, cobj)
3260
for section_name in cobj.sections:
3262
self.readonly_section_class(section_name,
3263
cobj[section_name]))
3265
def get_mutable_section(self, section_id=None):
3266
# We need a loaded store
3269
except errors.NoSuchFile:
3270
# The file doesn't exist, let's pretend it was empty
3271
self._load_from_string('')
3272
if section_id is None:
3273
section = self._config_obj
3275
section = self._config_obj.setdefault(section_id, {})
3276
mutable_section = self.mutable_section_class(section_id, section)
3277
# All mutable sections can become dirty
3278
self.dirty_sections.append(mutable_section)
3279
return mutable_section
3281
def quote(self, value):
3283
# configobj conflates automagical list values and quoting
3284
self._config_obj.list_values = True
3285
return self._config_obj._quote(value)
3287
self._config_obj.list_values = False
3289
def unquote(self, value):
3290
if value and isinstance(value, basestring):
3291
# _unquote doesn't handle None nor empty strings nor anything that
3292
# is not a string, really.
3293
value = self._config_obj._unquote(value)
3296
def external_url(self):
3297
# Since an IniFileStore can be used without a file (at least in tests),
3298
# it's better to provide something than raising a NotImplementedError.
3299
# All daughter classes are supposed to provide an implementation
3301
return 'In-Process Store, no URL'
3303
class TransportIniFileStore(IniFileStore):
3304
"""IniFileStore that loads files from a transport.
3306
:ivar transport: The transport object where the config file is located.
3308
:ivar file_name: The config file basename in the transport directory.
3311
def __init__(self, transport, file_name):
3312
"""A Store using a ini file on a Transport
3314
:param transport: The transport object where the config file is located.
3315
:param file_name: The config file basename in the transport directory.
3317
super(TransportIniFileStore, self).__init__()
3318
self.transport = transport
3319
self.file_name = file_name
3321
def _load_content(self):
3323
return self.transport.get_bytes(self.file_name)
3324
except errors.PermissionDenied:
3325
trace.warning("Permission denied while trying to load "
3326
"configuration store %s.", self.external_url())
3329
def _save_content(self, content):
3330
self.transport.put_bytes(self.file_name, content)
3332
def external_url(self):
3333
# FIXME: external_url should really accepts an optional relpath
3334
# parameter (bug #750169) :-/ -- vila 2011-04-04
3335
# The following will do in the interim but maybe we don't want to
3336
# expose a path here but rather a config ID and its associated
3337
# object </hand wawe>.
3338
return urlutils.join(self.transport.external_url(), self.file_name)
3341
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3342
# unlockable stores for use with objects that can already ensure the locking
3343
# (think branches). If different stores (not based on ConfigObj) are created,
3344
# they may face the same issue.
3347
class LockableIniFileStore(TransportIniFileStore):
3348
"""A ConfigObjStore using locks on save to ensure store integrity."""
3350
def __init__(self, transport, file_name, lock_dir_name=None):
3351
"""A config Store using ConfigObj for storage.
3353
:param transport: The transport object where the config file is located.
3355
:param file_name: The config file basename in the transport directory.
3357
if lock_dir_name is None:
3358
lock_dir_name = 'lock'
3359
self.lock_dir_name = lock_dir_name
3360
super(LockableIniFileStore, self).__init__(transport, file_name)
3361
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3363
def lock_write(self, token=None):
3364
"""Takes a write lock in the directory containing the config file.
3366
If the directory doesn't exist it is created.
3368
# FIXME: This doesn't check the ownership of the created directories as
3369
# ensure_config_dir_exists does. It should if the transport is local
3370
# -- vila 2011-04-06
3371
self.transport.create_prefix()
3372
return self._lock.lock_write(token)
3377
def break_lock(self):
3378
self._lock.break_lock()
3382
# We need to be able to override the undecorated implementation
3383
self.save_without_locking()
3385
def save_without_locking(self):
3386
super(LockableIniFileStore, self).save()
3389
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3390
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3391
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3393
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3394
# functions or a registry will make it easier and clearer for tests, focusing
3395
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3396
# on a poolie's remark)
3397
class GlobalStore(LockableIniFileStore):
3399
def __init__(self, possible_transports=None):
3400
t = transport.get_transport_from_path(
3401
config_dir(), possible_transports=possible_transports)
3402
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3406
class LocationStore(LockableIniFileStore):
3408
def __init__(self, possible_transports=None):
3409
t = transport.get_transport_from_path(
3410
config_dir(), possible_transports=possible_transports)
3411
super(LocationStore, self).__init__(t, 'locations.conf')
3412
self.id = 'locations'
3415
class BranchStore(TransportIniFileStore):
3417
def __init__(self, branch):
3418
super(BranchStore, self).__init__(branch.control_transport,
3420
self.branch = branch
3423
def lock_write(self, token=None):
3424
return self.branch.lock_write(token)
3427
return self.branch.unlock()
3431
# We need to be able to override the undecorated implementation
3432
self.save_without_locking()
3434
def save_without_locking(self):
3435
super(BranchStore, self).save()
3438
class ControlStore(LockableIniFileStore):
3440
def __init__(self, bzrdir):
3441
super(ControlStore, self).__init__(bzrdir.transport,
3443
lock_dir_name='branch_lock')
3447
class SectionMatcher(object):
3448
"""Select sections into a given Store.
3450
This is intended to be used to postpone getting an iterable of sections
3454
def __init__(self, store):
3457
def get_sections(self):
3458
# This is where we require loading the store so we can see all defined
3460
sections = self.store.get_sections()
3461
# Walk the revisions in the order provided
3462
for store, s in sections:
3466
def match(self, section):
3467
"""Does the proposed section match.
3469
:param section: A Section object.
3471
:returns: True if the section matches, False otherwise.
3473
raise NotImplementedError(self.match)
3476
class NameMatcher(SectionMatcher):
3478
def __init__(self, store, section_id):
3479
super(NameMatcher, self).__init__(store)
3480
self.section_id = section_id
3482
def match(self, section):
3483
return section.id == self.section_id
3486
class LocationSection(Section):
3488
def __init__(self, section, extra_path):
3489
super(LocationSection, self).__init__(section.id, section.options)
3490
self.extra_path = extra_path
3491
self.locals = {'relpath': extra_path,
3492
'basename': urlutils.basename(extra_path)}
3494
def get(self, name, default=None, expand=True):
3495
value = super(LocationSection, self).get(name, default)
3496
if value is not None and expand:
3497
policy_name = self.get(name + ':policy', None)
3498
policy = _policy_value.get(policy_name, POLICY_NONE)
3499
if policy == POLICY_APPENDPATH:
3500
value = urlutils.join(value, self.extra_path)
3501
# expand section local options right now (since POLICY_APPENDPATH
3502
# will never add options references, it's ok to expand after it).
3504
for is_ref, chunk in iter_option_refs(value):
3506
chunks.append(chunk)
3509
if ref in self.locals:
3510
chunks.append(self.locals[ref])
3512
chunks.append(chunk)
3513
value = ''.join(chunks)
3517
class StartingPathMatcher(SectionMatcher):
3518
"""Select sections for a given location respecting the Store order."""
3520
# FIXME: Both local paths and urls can be used for section names as well as
3521
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3522
# inherited the fuzziness from the previous ``LocationConfig``
3523
# implementation. We probably need to revisit which encoding is allowed for
3524
# both ``location`` and section names and how we normalize
3525
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3526
# related too. -- vila 2012-01-04
3528
def __init__(self, store, location):
3529
super(StartingPathMatcher, self).__init__(store)
3530
if location.startswith('file://'):
3531
location = urlutils.local_path_from_url(location)
3532
self.location = location
3534
def get_sections(self):
3535
"""Get all sections matching ``location`` in the store.
3537
The most generic sections are described first in the store, then more
3538
specific ones can be provided for reduced scopes.
3540
The returned section are therefore returned in the reversed order so
3541
the most specific ones can be found first.
3543
location_parts = self.location.rstrip('/').split('/')
3546
# Later sections are more specific, they should be returned first
3547
for _, section in reversed(list(store.get_sections())):
3548
if section.id is None:
3549
# The no-name section is always included if present
3550
yield store, LocationSection(section, self.location)
3552
section_path = section.id
3553
if section_path.startswith('file://'):
3554
# the location is already a local path or URL, convert the
3555
# section id to the same format
3556
section_path = urlutils.local_path_from_url(section_path)
3557
if (self.location.startswith(section_path)
3558
or fnmatch.fnmatch(self.location, section_path)):
3559
section_parts = section_path.rstrip('/').split('/')
3560
extra_path = '/'.join(location_parts[len(section_parts):])
3561
yield store, LocationSection(section, extra_path)
3564
class LocationMatcher(SectionMatcher):
3566
def __init__(self, store, location):
3567
super(LocationMatcher, self).__init__(store)
3568
if location.startswith('file://'):
3569
location = urlutils.local_path_from_url(location)
3570
self.location = location
3572
def _get_matching_sections(self):
3573
"""Get all sections matching ``location``."""
3574
# We slightly diverge from LocalConfig here by allowing the no-name
3575
# section as the most generic one and the lower priority.
3576
no_name_section = None
3578
# Filter out the no_name_section so _iter_for_location_by_parts can be
3579
# used (it assumes all sections have a name).
3580
for _, section in self.store.get_sections():
3581
if section.id is None:
3582
no_name_section = section
3584
all_sections.append(section)
3585
# Unfortunately _iter_for_location_by_parts deals with section names so
3586
# we have to resync.
3587
filtered_sections = _iter_for_location_by_parts(
3588
[s.id for s in all_sections], self.location)
3589
iter_all_sections = iter(all_sections)
3590
matching_sections = []
3591
if no_name_section is not None:
3592
matching_sections.append(
3593
(0, LocationSection(no_name_section, self.location)))
3594
for section_id, extra_path, length in filtered_sections:
3595
# a section id is unique for a given store so it's safe to take the
3596
# first matching section while iterating. Also, all filtered
3597
# sections are part of 'all_sections' and will always be found
3600
section = iter_all_sections.next()
3601
if section_id == section.id:
3602
matching_sections.append(
3603
(length, LocationSection(section, extra_path)))
3605
return matching_sections
3607
def get_sections(self):
3608
# Override the default implementation as we want to change the order
3609
matching_sections = self._get_matching_sections()
3610
# We want the longest (aka more specific) locations first
3611
sections = sorted(matching_sections,
3612
key=lambda (length, section): (length, section.id),
3614
# Sections mentioning 'ignore_parents' restrict the selection
3615
for _, section in sections:
3616
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3617
ignore = section.get('ignore_parents', None)
3618
if ignore is not None:
3619
ignore = ui.bool_from_string(ignore)
3622
# Finally, we have a valid section
3623
yield self.store, section
3626
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3627
"""Describes an expandable option reference.
3629
We want to match the most embedded reference first.
3631
I.e. for '{{foo}}' we will get '{foo}',
3632
for '{bar{baz}}' we will get '{baz}'
3635
def iter_option_refs(string):
3636
# Split isolate refs so every other chunk is a ref
3638
for chunk in _option_ref_re.split(string):
3643
class Stack(object):
3644
"""A stack of configurations where an option can be defined"""
3646
def __init__(self, sections_def, store=None, mutable_section_id=None):
3647
"""Creates a stack of sections with an optional store for changes.
3649
:param sections_def: A list of Section or callables that returns an
3650
iterable of Section. This defines the Sections for the Stack and
3651
can be called repeatedly if needed.
3653
:param store: The optional Store where modifications will be
3654
recorded. If none is specified, no modifications can be done.
3656
:param mutable_section_id: The id of the MutableSection where changes
3657
are recorded. This requires the ``store`` parameter to be
3660
self.sections_def = sections_def
3662
self.mutable_section_id = mutable_section_id
3664
def get(self, name, expand=None):
3665
"""Return the *first* option value found in the sections.
3667
This is where we guarantee that sections coming from Store are loaded
3668
lazily: the loading is delayed until we need to either check that an
3669
option exists or get its value, which in turn may require to discover
3670
in which sections it can be defined. Both of these (section and option
3671
existence) require loading the store (even partially).
3673
:param name: The queried option.
3675
:param expand: Whether options references should be expanded.
3677
:returns: The value of the option.
3679
# FIXME: No caching of options nor sections yet -- vila 20110503
3681
expand = _get_expand_default_value()
3683
found_store = None # Where the option value has been found
3684
# If the option is registered, it may provide additional info about
3687
opt = option_registry.get(name)
3692
def expand_and_convert(val):
3693
# This may need to be called in different contexts if the value is
3694
# None or ends up being None during expansion or conversion.
3697
if isinstance(val, basestring):
3698
val = self._expand_options_in_string(val)
3700
trace.warning('Cannot expand "%s":'
3701
' %s does not support option expansion'
3702
% (name, type(val)))
3704
val = found_store.unquote(val)
3706
val = opt.convert_from_unicode(found_store, val)
3709
# First of all, check if the environment can override the configuration
3711
if opt is not None and opt.override_from_env:
3712
value = opt.get_override()
3713
value = expand_and_convert(value)
3715
# Ensuring lazy loading is achieved by delaying section matching
3716
# (which implies querying the persistent storage) until it can't be
3717
# avoided anymore by using callables to describe (possibly empty)
3719
for sections in self.sections_def:
3720
for store, section in sections():
3721
value = section.get(name)
3722
if value is not None:
3725
if value is not None:
3727
value = expand_and_convert(value)
3728
if opt is not None and value is None:
3729
# If the option is registered, it may provide a default value
3730
value = opt.get_default()
3731
value = expand_and_convert(value)
3732
for hook in ConfigHooks['get']:
3733
hook(self, name, value)
3736
def expand_options(self, string, env=None):
3737
"""Expand option references in the string in the configuration context.
3739
:param string: The string containing option(s) to expand.
3741
:param env: An option dict defining additional configuration options or
3742
overriding existing ones.
3744
:returns: The expanded string.
3746
return self._expand_options_in_string(string, env)
3748
def _expand_options_in_string(self, string, env=None, _refs=None):
3749
"""Expand options in the string in the configuration context.
3751
:param string: The string to be expanded.
3753
:param env: An option dict defining additional configuration options or
3754
overriding existing ones.
3756
:param _refs: Private list (FIFO) containing the options being expanded
3759
:returns: The expanded string.
3762
# Not much to expand there
3765
# What references are currently resolved (to detect loops)
3768
# We need to iterate until no more refs appear ({{foo}} will need two
3769
# iterations for example).
3774
for is_ref, chunk in iter_option_refs(result):
3776
chunks.append(chunk)
3781
raise errors.OptionExpansionLoop(string, _refs)
3783
value = self._expand_option(name, env, _refs)
3785
raise errors.ExpandingUnknownOption(name, string)
3786
chunks.append(value)
3788
result = ''.join(chunks)
3791
def _expand_option(self, name, env, _refs):
3792
if env is not None and name in env:
3793
# Special case, values provided in env takes precedence over
3797
value = self.get(name, expand=False)
3798
value = self._expand_options_in_string(value, env, _refs)
3801
def _get_mutable_section(self):
3802
"""Get the MutableSection for the Stack.
3804
This is where we guarantee that the mutable section is lazily loaded:
3805
this means we won't load the corresponding store before setting a value
3806
or deleting an option. In practice the store will often be loaded but
3807
this helps catching some programming errors.
3810
section = store.get_mutable_section(self.mutable_section_id)
3811
return store, section
3813
def set(self, name, value):
3814
"""Set a new value for the option."""
3815
store, section = self._get_mutable_section()
3816
section.set(name, store.quote(value))
3817
for hook in ConfigHooks['set']:
3818
hook(self, name, value)
3820
def remove(self, name):
3821
"""Remove an existing option."""
3822
_, section = self._get_mutable_section()
3823
section.remove(name)
3824
for hook in ConfigHooks['remove']:
3828
# Mostly for debugging use
3829
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3831
def _get_overrides(self):
3832
# Hack around library_state.initialize never called
3833
if bzrlib.global_state is not None:
3834
return bzrlib.global_state.cmdline_overrides.get_sections()
3838
class MemoryStack(Stack):
3839
"""A configuration stack defined from a string.
3841
This is mainly intended for tests and requires no disk resources.
3844
def __init__(self, content=None):
3845
"""Create an in-memory stack from a given content.
3847
It uses a single store based on configobj and support reading and
3850
:param content: The initial content of the store. If None, the store is
3851
not loaded and ``_load_from_string`` can and should be used if
3854
store = IniFileStore()
3855
if content is not None:
3856
store._load_from_string(content)
3857
super(MemoryStack, self).__init__(
3858
[store.get_sections], store)
3861
class _CompatibleStack(Stack):
3862
"""Place holder for compatibility with previous design.
3864
This is intended to ease the transition from the Config-based design to the
3865
Stack-based design and should not be used nor relied upon by plugins.
3867
One assumption made here is that the daughter classes will all use Stores
3868
derived from LockableIniFileStore).
3870
It implements set() and remove () by re-loading the store before applying
3871
the modification and saving it.
3873
The long term plan being to implement a single write by store to save
3874
all modifications, this class should not be used in the interim.
3877
def set(self, name, value):
3880
super(_CompatibleStack, self).set(name, value)
3881
# Force a write to persistent storage
3884
def remove(self, name):
3887
super(_CompatibleStack, self).remove(name)
3888
# Force a write to persistent storage
3892
class GlobalStack(_CompatibleStack):
3893
"""Global options only stack.
3895
The following sections are queried:
3897
* command-line overrides,
3899
* the 'DEFAULT' section in bazaar.conf
3901
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3906
gstore = GlobalStore()
3907
super(GlobalStack, self).__init__(
3908
[self._get_overrides,
3909
NameMatcher(gstore, 'DEFAULT').get_sections],
3910
gstore, mutable_section_id='DEFAULT')
3913
class LocationStack(_CompatibleStack):
3914
"""Per-location options falling back to global options stack.
3917
The following sections are queried:
3919
* command-line overrides,
3921
* the sections matching ``location`` in ``locations.conf``, the order being
3922
defined by the number of path components in the section glob, higher
3923
numbers first (from most specific section to most generic).
3925
* the 'DEFAULT' section in bazaar.conf
3927
This stack will use the ``location`` section in locations.conf as its
3931
def __init__(self, location):
3932
"""Make a new stack for a location and global configuration.
3934
:param location: A URL prefix to """
3935
lstore = LocationStore()
3936
if location.startswith('file://'):
3937
location = urlutils.local_path_from_url(location)
3938
gstore = GlobalStore()
3939
super(LocationStack, self).__init__(
3940
[self._get_overrides,
3941
LocationMatcher(lstore, location).get_sections,
3942
NameMatcher(gstore, 'DEFAULT').get_sections],
3943
lstore, mutable_section_id=location)
3946
class BranchStack(_CompatibleStack):
3947
"""Per-location options falling back to branch then global options stack.
3949
The following sections are queried:
3951
* command-line overrides,
3953
* the sections matching ``location`` in ``locations.conf``, the order being
3954
defined by the number of path components in the section glob, higher
3955
numbers first (from most specific section to most generic),
3957
* the no-name section in branch.conf,
3959
* the ``DEFAULT`` section in ``bazaar.conf``.
3961
This stack will use the no-name section in ``branch.conf`` as its
3965
def __init__(self, branch):
3966
lstore = LocationStore()
3967
bstore = branch._get_config_store()
3968
gstore = GlobalStore()
3969
super(BranchStack, self).__init__(
3970
[self._get_overrides,
3971
LocationMatcher(lstore, branch.base).get_sections,
3972
NameMatcher(bstore, None).get_sections,
3973
NameMatcher(gstore, 'DEFAULT').get_sections],
3975
self.branch = branch
3978
class RemoteControlStack(_CompatibleStack):
3979
"""Remote control-only options stack."""
3981
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3982
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3983
# control.conf and is used only for stack options.
3985
def __init__(self, bzrdir):
3986
cstore = bzrdir._get_config_store()
3987
super(RemoteControlStack, self).__init__(
3988
[NameMatcher(cstore, None).get_sections],
3990
self.bzrdir = bzrdir
3993
class BranchOnlyStack(_CompatibleStack):
3994
"""Branch-only options stack."""
3996
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3997
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3998
# -- vila 2011-12-16
4000
def __init__(self, branch):
4001
bstore = branch._get_config_store()
4002
super(BranchOnlyStack, self).__init__(
4003
[NameMatcher(bstore, None).get_sections],
4005
self.branch = branch
4008
# Use a an empty dict to initialize an empty configobj avoiding all
4009
# parsing and encoding checks
4010
_quoting_config = configobj.ConfigObj(
4011
{}, encoding='utf-8', interpolation=False, list_values=True)
4013
class cmd_config(commands.Command):
4014
__doc__ = """Display, set or remove a configuration option.
4016
Display the active value for a given option.
4018
If --all is specified, NAME is interpreted as a regular expression and all
4019
matching options are displayed mentioning their scope. The active value
4020
that bzr will take into account is the first one displayed for each option.
4022
If no NAME is given, --all .* is implied.
4024
Setting a value is achieved by using name=value without spaces. The value
4025
is set in the most relevant scope and can be checked by displaying the
4029
takes_args = ['name?']
4033
# FIXME: This should be a registry option so that plugins can register
4034
# their own config files (or not) and will also address
4035
# http://pad.lv/788991 -- vila 20101115
4036
commands.Option('scope', help='Reduce the scope to the specified'
4037
' configuration file.',
4039
commands.Option('all',
4040
help='Display all the defined values for the matching options.',
4042
commands.Option('remove', help='Remove the option from'
4043
' the configuration file.'),
4046
_see_also = ['configuration']
4048
@commands.display_command
4049
def run(self, name=None, all=False, directory=None, scope=None,
4051
if directory is None:
4053
directory = urlutils.normalize_url(directory)
4055
raise errors.BzrError(
4056
'--all and --remove are mutually exclusive.')
4058
# Delete the option in the given scope
4059
self._remove_config_option(name, directory, scope)
4061
# Defaults to all options
4062
self._show_matching_options('.*', directory, scope)
4065
name, value = name.split('=', 1)
4067
# Display the option(s) value(s)
4069
self._show_matching_options(name, directory, scope)
4071
self._show_value(name, directory, scope)
4074
raise errors.BzrError(
4075
'Only one option can be set.')
4076
# Set the option value
4077
self._set_config_option(name, value, directory, scope)
4079
def _get_stack(self, directory, scope=None):
4080
"""Get the configuration stack specified by ``directory`` and ``scope``.
4082
:param directory: Where the configurations are derived from.
4084
:param scope: A specific config to start from.
4086
# FIXME: scope should allow access to plugin-specific stacks (even
4087
# reduced to the plugin-specific store), related to
4088
# http://pad.lv/788991 -- vila 2011-11-15
4089
if scope is not None:
4090
if scope == 'bazaar':
4091
return GlobalStack()
4092
elif scope == 'locations':
4093
return LocationStack(directory)
4094
elif scope == 'branch':
4096
controldir.ControlDir.open_containing_tree_or_branch(
4098
return br.get_config_stack()
4099
raise errors.NoSuchConfig(scope)
4103
controldir.ControlDir.open_containing_tree_or_branch(
4105
return br.get_config_stack()
4106
except errors.NotBranchError:
4107
return LocationStack(directory)
4109
def _show_value(self, name, directory, scope):
4110
conf = self._get_stack(directory, scope)
4111
value = conf.get(name, expand=True)
4112
if value is not None:
4113
# Quote the value appropriately
4114
value = _quoting_config._quote(value)
4115
self.outf.write('%s\n' % (value,))
4117
raise errors.NoSuchConfigOption(name)
4119
def _show_matching_options(self, name, directory, scope):
4120
name = lazy_regex.lazy_compile(name)
4121
# We want any error in the regexp to be raised *now* so we need to
4122
# avoid the delay introduced by the lazy regexp. But, we still do
4123
# want the nicer errors raised by lazy_regex.
4124
name._compile_and_collapse()
4127
conf = self._get_stack(directory, scope)
4128
for sections in conf.sections_def:
4129
for store, section in sections():
4130
for oname in section.iter_option_names():
4131
if name.search(oname):
4132
if cur_store_id != store.id:
4133
# Explain where the options are defined
4134
self.outf.write('%s:\n' % (store.id,))
4135
cur_store_id = store.id
4137
if (section.id is not None
4138
and cur_section != section.id):
4139
# Display the section id as it appears in the store
4140
# (None doesn't appear by definition)
4141
self.outf.write(' [%s]\n' % (section.id,))
4142
cur_section = section.id
4143
value = section.get(oname, expand=False)
4144
# Since we don't use the stack, we need to restore a
4147
opt = option_registry.get(oname)
4148
value = opt.convert_from_unicode(store, value)
4150
value = store.unquote(value)
4151
value = _quoting_config._quote(value)
4152
self.outf.write(' %s = %s\n' % (oname, value))
4154
def _set_config_option(self, name, value, directory, scope):
4155
conf = self._get_stack(directory, scope)
4156
conf.set(name, value)
4158
def _remove_config_option(self, name, directory, scope):
4160
raise errors.BzrCommandError(
4161
'--remove expects an option to remove.')
4162
conf = self._get_stack(directory, scope)
4166
raise errors.NoSuchConfigOption(name)
4171
# We need adapters that can build a Store or a Stack in a test context. Test
4172
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4173
# themselves. The builder will receive a test instance and should return a
4174
# ready-to-use store or stack. Plugins that define new store/stacks can also
4175
# register themselves here to be tested against the tests defined in
4176
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4177
# for the same test.
4179
# The registered object should be a callable receiving a test instance
4180
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4182
test_store_builder_registry = registry.Registry()
4184
# The registered object should be a callable receiving a test instance
4185
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4187
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
