1
# Copyright (C) 2005-2014, 2016 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 Breezy.
21
Currently this configuration resides in ~/.config/breezy/breezy.conf
22
and ~/.config/breezy/locations.conf, which is written to by brz.
24
If the first location doesn't exist, then brz falls back to reading
25
Bazaar configuration files in ~/.bazaar or ~/.config/bazaar.
27
In breezy.conf the following options may be set:
29
editor=name-of-program
30
email=Your Name <your@email.address>
31
check_signatures=require|ignore|check-available(default)
32
create_signatures=always|never|when-required(default)
33
log_format=name-of-format
34
validate_signatures_in_log=true|false(default)
35
acceptable_keys=pattern1,pattern2
36
gpg_signing_key=amy@example.com
38
in locations.conf, you specify the url of a branch and options for it.
39
Wildcards may be used - * and ? as normal in shell completion. Options
40
set in both breezy.conf and locations.conf are overridden by the locations.conf
42
[/home/robertc/source]
43
recurse=False|True(default)
45
check_signatures= as above
46
create_signatures= as above.
47
validate_signatures_in_log=as above
48
acceptable_keys=as above
50
explanation of options
51
----------------------
52
editor - this option sets the pop up editor to use during commits.
53
email - this option sets the user id brz will use when committing.
54
check_signatures - this option will control whether brz will require good gpg
55
signatures, ignore them, or check them if they are
56
present. Currently it is unused except that check_signatures
57
turns on create_signatures.
58
create_signatures - this option controls whether brz will always create
59
gpg signatures or not on commits. There is an unused
60
option which in future is expected to work if
61
branch settings require signatures.
62
log_format - this option sets the default log format. Possible values are
63
long, short, line, or a plugin can register new formats.
64
validate_signatures_in_log - show GPG signature validity in log output
65
acceptable_keys - comma separated list of key patterns acceptable for
66
verify-signatures command
68
In breezy.conf you can also define aliases in the ALIASES sections, example
71
lastlog=log --line -r-10..-1
72
ll=log --line -r-10..-1
77
from __future__ import absolute_import
84
from .lazy_import import lazy_import
85
lazy_import(globals(), """
109
from breezy.i18n import gettext
118
from .sixish import (
139
POLICY_APPENDPATH = 2
143
POLICY_NORECURSE: 'norecurse',
144
POLICY_APPENDPATH: 'appendpath',
149
'norecurse': POLICY_NORECURSE,
150
'appendpath': POLICY_APPENDPATH,
154
STORE_LOCATION = POLICY_NONE
155
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
156
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
161
class OptionExpansionLoop(errors.BzrError):
163
_fmt = 'Loop involving %(refs)r while expanding "%(string)s".'
165
def __init__(self, string, refs):
167
self.refs = '->'.join(refs)
170
class ExpandingUnknownOption(errors.BzrError):
172
_fmt = 'Option "%(name)s" is not defined while expanding "%(string)s".'
174
def __init__(self, name, string):
179
class IllegalOptionName(errors.BzrError):
181
_fmt = 'Option "%(name)s" is not allowed.'
183
def __init__(self, name):
187
class ConfigContentError(errors.BzrError):
189
_fmt = "Config file %(filename)s is not UTF-8 encoded\n"
191
def __init__(self, filename):
192
self.filename = filename
195
class ParseConfigError(errors.BzrError):
197
_fmt = "Error(s) parsing config file %(filename)s:\n%(errors)s"
199
def __init__(self, errors, filename):
200
self.filename = filename
201
self.errors = '\n'.join(e.msg for e in errors)
204
class ConfigOptionValueError(errors.BzrError):
206
_fmt = ('Bad value "%(value)s" for option "%(name)s".\n'
207
'See ``brz help %(name)s``')
209
def __init__(self, name, value):
210
errors.BzrError.__init__(self, name=name, value=value)
213
class NoEmailInUsername(errors.BzrError):
215
_fmt = "%(username)r does not seem to contain a reasonable email address"
217
def __init__(self, username):
218
self.username = username
221
class NoSuchConfig(errors.BzrError):
223
_fmt = ('The "%(config_id)s" configuration does not exist.')
225
def __init__(self, config_id):
226
errors.BzrError.__init__(self, config_id=config_id)
229
class NoSuchConfigOption(errors.BzrError):
231
_fmt = ('The "%(option_name)s" configuration option does not exist.')
233
def __init__(self, option_name):
234
errors.BzrError.__init__(self, option_name=option_name)
237
class NoWhoami(errors.BzrError):
239
_fmt = ('Unable to determine your name.\n'
240
"Please, set your name with the 'whoami' command.\n"
241
'E.g. brz whoami "Your Name <name@example.com>"')
244
def signature_policy_from_unicode(signature_string):
245
"""Convert a string to a signing policy."""
246
if signature_string.lower() == 'check-available':
247
return CHECK_IF_POSSIBLE
248
if signature_string.lower() == 'ignore':
250
if signature_string.lower() == 'require':
252
raise ValueError("Invalid signatures policy '%s'"
256
def signing_policy_from_unicode(signature_string):
257
"""Convert a string to a signing policy."""
258
if signature_string.lower() == 'when-required':
259
return SIGN_WHEN_REQUIRED
260
if signature_string.lower() == 'never':
262
if signature_string.lower() == 'always':
264
raise ValueError("Invalid signing policy '%s'"
268
def _has_decode_bug():
269
"""True if configobj will fail to decode to unicode on Python 2."""
270
if sys.version_info > (3,):
272
conf = configobj.ConfigObj()
273
decode = getattr(conf, "_decode", None)
275
result = decode(b"\xc2\xa7", "utf-8")
276
if isinstance(result[0], str):
281
def _has_triplequote_bug():
282
"""True if triple quote logic is reversed, see lp:710410."""
283
conf = configobj.ConfigObj()
284
quote = getattr(conf, "_get_triple_quote", None)
285
if quote and quote('"""') != "'''":
290
class ConfigObj(configobj.ConfigObj):
292
def __init__(self, infile=None, **kwargs):
293
# We define our own interpolation mechanism calling it option expansion
294
super(ConfigObj, self).__init__(infile=infile,
298
if _has_decode_bug():
299
def _decode(self, infile, encoding):
300
if isinstance(infile, str) and encoding:
301
return infile.decode(encoding).splitlines(True)
302
return super(ConfigObj, self)._decode(infile, encoding)
304
if _has_triplequote_bug():
305
def _get_triple_quote(self, value):
306
quot = super(ConfigObj, self)._get_triple_quote(value)
307
if quot == configobj.tdquot:
308
return configobj.tsquot
309
return configobj.tdquot
311
def get_bool(self, section, key):
312
return self[section].as_bool(key)
314
def get_value(self, section, name):
315
# Try [] for the old DEFAULT section.
316
if section == "DEFAULT":
321
return self[section][name]
324
class Config(object):
325
"""A configuration policy - what username, editor, gpg needs etc."""
328
super(Config, self).__init__()
331
"""Returns a unique ID for the config."""
332
raise NotImplementedError(self.config_id)
334
def get_change_editor(self, old_tree, new_tree):
335
from breezy import diff
336
cmd = self._get_change_editor()
339
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
342
def _get_signature_checking(self):
343
"""Template method to override signature checking policy."""
345
def _get_signing_policy(self):
346
"""Template method to override signature creation policy."""
350
def expand_options(self, string, env=None):
351
"""Expand option references in the string in the configuration context.
353
:param string: The string containing option to expand.
355
:param env: An option dict defining additional configuration options or
356
overriding existing ones.
358
:returns: The expanded string.
360
return self._expand_options_in_string(string, env)
362
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
363
"""Expand options in a list of strings in the configuration context.
365
:param slist: A list of strings.
367
:param env: An option dict defining additional configuration options or
368
overriding existing ones.
370
:param _ref_stack: Private list containing the options being
371
expanded to detect loops.
373
:returns: The flatten list of expanded strings.
375
# expand options in each value separately flattening lists
378
value = self._expand_options_in_string(s, env, _ref_stack)
379
if isinstance(value, list):
385
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
386
"""Expand options in the string in the configuration context.
388
:param string: The string to be expanded.
390
:param env: An option dict defining additional configuration options or
391
overriding existing ones.
393
:param _ref_stack: Private list containing the options being
394
expanded to detect loops.
396
:returns: The expanded string.
399
# Not much to expand there
401
if _ref_stack is None:
402
# What references are currently resolved (to detect loops)
404
if self.option_ref_re is None:
405
# We want to match the most embedded reference first (i.e. for
406
# '{{foo}}' we will get '{foo}',
407
# for '{bar{baz}}' we will get '{baz}'
408
self.option_ref_re = re.compile('({[^{}]+})')
410
# We need to iterate until no more refs appear ({{foo}} will need two
411
# iterations for example).
413
raw_chunks = self.option_ref_re.split(result)
414
if len(raw_chunks) == 1:
415
# Shorcut the trivial case: no refs
419
# Split will isolate refs so that every other chunk is a ref
421
for chunk in raw_chunks:
424
# Keep only non-empty strings (or we get bogus empty
425
# slots when a list value is involved).
430
if name in _ref_stack:
431
raise OptionExpansionLoop(string, _ref_stack)
432
_ref_stack.append(name)
433
value = self._expand_option(name, env, _ref_stack)
435
raise ExpandingUnknownOption(name, string)
436
if isinstance(value, list):
444
# Once a list appears as the result of an expansion, all
445
# callers will get a list result. This allows a consistent
446
# behavior even when some options in the expansion chain
447
# defined as strings (no comma in their value) but their
448
# expanded value is a list.
449
return self._expand_options_in_list(chunks, env, _ref_stack)
451
result = ''.join(chunks)
454
def _expand_option(self, name, env, _ref_stack):
455
if env is not None and name in env:
456
# Special case, values provided in env takes precedence over
460
# FIXME: This is a limited implementation, what we really need is a
461
# way to query the brz config for the value of an option,
462
# respecting the scope rules (That is, once we implement fallback
463
# configs, getting the option value should restart from the top
464
# config, not the current one) -- vila 20101222
465
value = self.get_user_option(name, expand=False)
466
if isinstance(value, list):
467
value = self._expand_options_in_list(value, env, _ref_stack)
469
value = self._expand_options_in_string(value, env, _ref_stack)
472
def _get_user_option(self, option_name):
473
"""Template method to provide a user option."""
476
def get_user_option(self, option_name, expand=True):
477
"""Get a generic option - no special process, no default.
479
:param option_name: The queried option.
481
:param expand: Whether options references should be expanded.
483
:returns: The value of the option.
485
value = self._get_user_option(option_name)
487
if isinstance(value, list):
488
value = self._expand_options_in_list(value)
489
elif isinstance(value, dict):
490
trace.warning('Cannot expand "%s":'
491
' Dicts do not support option expansion'
494
value = self._expand_options_in_string(value)
495
for hook in OldConfigHooks['get']:
496
hook(self, option_name, value)
499
def get_user_option_as_bool(self, option_name, expand=None, default=None):
500
"""Get a generic option as a boolean.
502
:param expand: Allow expanding references to other config values.
503
:param default: Default value if nothing is configured
504
:return None if the option doesn't exist or its value can't be
505
interpreted as a boolean. Returns True or False otherwise.
507
s = self.get_user_option(option_name, expand=expand)
509
# The option doesn't exist
511
val = ui.bool_from_string(s)
513
# The value can't be interpreted as a boolean
514
trace.warning('Value "%s" is not a boolean for "%s"',
518
def get_user_option_as_list(self, option_name, expand=None):
519
"""Get a generic option as a list - no special process, no default.
521
:return None if the option doesn't exist. Returns the value as a list
524
l = self.get_user_option(option_name, expand=expand)
525
if isinstance(l, string_types):
526
# A single value, most probably the user forgot (or didn't care to
531
def _log_format(self):
532
"""See log_format()."""
535
def validate_signatures_in_log(self):
536
"""Show GPG signature validity in log"""
537
result = self._validate_signatures_in_log()
544
def _validate_signatures_in_log(self):
545
"""See validate_signatures_in_log()."""
548
def _post_commit(self):
549
"""See Config.post_commit."""
552
def user_email(self):
553
"""Return just the email component of a username."""
554
return extract_email_address(self.username())
557
"""Return email-style username.
559
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
561
$BRZ_EMAIL can be set to override this, then
562
the concrete policy type is checked, and finally
564
If no username can be found, NoWhoami exception is raised.
566
v = os.environ.get('BRZ_EMAIL')
569
v = v.decode(osutils.get_user_encoding())
571
v = self._get_user_id()
574
return default_email()
576
def ensure_username(self):
577
"""Raise NoWhoami if username is not set.
579
This method relies on the username() function raising the error.
583
def get_alias(self, value):
584
return self._get_alias(value)
586
def _get_alias(self, value):
589
def get_nickname(self):
590
return self._get_nickname()
592
def _get_nickname(self):
595
def get_bzr_remote_path(self):
597
return os.environ['BZR_REMOTE_PATH']
599
path = self.get_user_option("bzr_remote_path")
604
def suppress_warning(self, warning):
605
"""Should the warning be suppressed or emitted.
607
:param warning: The name of the warning being tested.
609
:returns: True if the warning should be suppressed, False otherwise.
611
warnings = self.get_user_option_as_list('suppress_warnings')
612
if warnings is None or warning not in warnings:
617
def get_merge_tools(self):
619
for (oname, value, section, conf_id, parser) in self._get_options():
620
if oname.startswith('bzr.mergetool.'):
621
tool_name = oname[len('bzr.mergetool.'):]
622
tools[tool_name] = self.get_user_option(oname, False)
623
trace.mutter('loaded merge tools: %r' % tools)
626
def find_merge_tool(self, name):
627
# We fake a defaults mechanism here by checking if the given name can
628
# be found in the known_merge_tools if it's not found in the config.
629
# This should be done through the proposed config defaults mechanism
630
# when it becomes available in the future.
631
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
633
or mergetools.known_merge_tools.get(name, None))
637
class _ConfigHooks(hooks.Hooks):
638
"""A dict mapping hook names and a list of callables for configs.
642
"""Create the default hooks.
644
These are all empty initially, because by default nothing should get
647
super(_ConfigHooks, self).__init__('breezy.config', 'ConfigHooks')
648
self.add_hook('load',
649
'Invoked when a config store is loaded.'
650
' The signature is (store).',
652
self.add_hook('save',
653
'Invoked when a config store is saved.'
654
' The signature is (store).',
656
# The hooks for config options
658
'Invoked when a config option is read.'
659
' The signature is (stack, name, value).',
662
'Invoked when a config option is set.'
663
' The signature is (stack, name, value).',
665
self.add_hook('remove',
666
'Invoked when a config option is removed.'
667
' The signature is (stack, name).',
669
ConfigHooks = _ConfigHooks()
672
class _OldConfigHooks(hooks.Hooks):
673
"""A dict mapping hook names and a list of callables for configs.
677
"""Create the default hooks.
679
These are all empty initially, because by default nothing should get
682
super(_OldConfigHooks, self).__init__('breezy.config', 'OldConfigHooks')
683
self.add_hook('load',
684
'Invoked when a config store is loaded.'
685
' The signature is (config).',
687
self.add_hook('save',
688
'Invoked when a config store is saved.'
689
' The signature is (config).',
691
# The hooks for config options
693
'Invoked when a config option is read.'
694
' The signature is (config, name, value).',
697
'Invoked when a config option is set.'
698
' The signature is (config, name, value).',
700
self.add_hook('remove',
701
'Invoked when a config option is removed.'
702
' The signature is (config, name).',
704
OldConfigHooks = _OldConfigHooks()
707
class IniBasedConfig(Config):
708
"""A configuration policy that draws from ini files."""
710
def __init__(self, file_name=None):
711
"""Base class for configuration files using an ini-like syntax.
713
:param file_name: The configuration file path.
715
super(IniBasedConfig, self).__init__()
716
self.file_name = file_name
717
self.file_name = file_name
722
def from_string(cls, str_or_unicode, file_name=None, save=False):
723
"""Create a config object from a string.
725
:param str_or_unicode: A string representing the file content. This will
728
:param file_name: The configuration file path.
730
:param _save: Whether the file should be saved upon creation.
732
conf = cls(file_name=file_name)
733
conf._create_from_string(str_or_unicode, save)
736
def _create_from_string(self, str_or_unicode, save):
737
if isinstance(str_or_unicode, text_type):
738
str_or_unicode = str_or_unicode.encode('utf-8')
739
self._content = BytesIO(str_or_unicode)
740
# Some tests use in-memory configs, some other always need the config
741
# file to exist on disk.
743
self._write_config_file()
745
def _get_parser(self):
746
if self._parser is not None:
748
if self._content is not None:
749
co_input = self._content
750
elif self.file_name is None:
751
raise AssertionError('We have no content to create the config')
753
co_input = self.file_name
755
self._parser = ConfigObj(co_input, encoding='utf-8')
756
except configobj.ConfigObjError as e:
757
raise ParseConfigError(e.errors, e.config.filename)
758
except UnicodeDecodeError:
759
raise ConfigContentError(self.file_name)
760
# Make sure self.reload() will use the right file name
761
self._parser.filename = self.file_name
762
for hook in OldConfigHooks['load']:
767
"""Reload the config file from disk."""
768
if self.file_name is None:
769
raise AssertionError('We need a file name to reload the config')
770
if self._parser is not None:
771
self._parser.reload()
772
for hook in ConfigHooks['load']:
775
def _get_matching_sections(self):
776
"""Return an ordered list of (section_name, extra_path) pairs.
778
If the section contains inherited configuration, extra_path is
779
a string containing the additional path components.
781
section = self._get_section()
782
if section is not None:
783
return [(section, '')]
787
def _get_section(self):
788
"""Override this to define the section used by the config."""
791
def _get_sections(self, name=None):
792
"""Returns an iterator of the sections specified by ``name``.
794
:param name: The section name. If None is supplied, the default
795
configurations are yielded.
797
:return: A tuple (name, section, config_id) for all sections that will
798
be walked by user_get_option() in the 'right' order. The first one
799
is where set_user_option() will update the value.
801
parser = self._get_parser()
803
yield (name, parser[name], self.config_id())
805
# No section name has been given so we fallback to the configobj
806
# itself which holds the variables defined outside of any section.
807
yield (None, parser, self.config_id())
809
def _get_options(self, sections=None):
810
"""Return an ordered list of (name, value, section, config_id) tuples.
812
All options are returned with their associated value and the section
813
they appeared in. ``config_id`` is a unique identifier for the
814
configuration file the option is defined in.
816
:param sections: Default to ``_get_matching_sections`` if not
817
specified. This gives a better control to daughter classes about
818
which sections should be searched. This is a list of (name,
823
parser = self._get_parser()
825
for (section_name, _) in self._get_matching_sections():
827
section = parser[section_name]
829
# This could happen for an empty file for which we define a
830
# DEFAULT section. FIXME: Force callers to provide sections
831
# instead ? -- vila 20100930
833
sections.append((section_name, section))
834
config_id = self.config_id()
835
for (section_name, section) in sections:
836
for (name, value) in section.iteritems():
837
yield (name, parser._quote(value), section_name,
840
def _get_option_policy(self, section, option_name):
841
"""Return the policy for the given (section, option_name) pair."""
844
def _get_change_editor(self):
845
return self.get_user_option('change_editor')
847
def _get_signature_checking(self):
848
"""See Config._get_signature_checking."""
849
policy = self._get_user_option('check_signatures')
851
return signature_policy_from_unicode(policy)
853
def _get_signing_policy(self):
854
"""See Config._get_signing_policy"""
855
policy = self._get_user_option('create_signatures')
857
return signing_policy_from_unicode(policy)
859
def _get_user_id(self):
860
"""Get the user id from the 'email' key in the current section."""
861
return self._get_user_option('email')
863
def _get_user_option(self, option_name):
864
"""See Config._get_user_option."""
865
for (section, extra_path) in self._get_matching_sections():
867
value = self._get_parser().get_value(section, option_name)
870
policy = self._get_option_policy(section, option_name)
871
if policy == POLICY_NONE:
873
elif policy == POLICY_NORECURSE:
874
# norecurse items only apply to the exact path
879
elif policy == POLICY_APPENDPATH:
881
value = urlutils.join(value, extra_path)
884
raise AssertionError('Unexpected config policy %r' % policy)
888
def _log_format(self):
889
"""See Config.log_format."""
890
return self._get_user_option('log_format')
892
def _validate_signatures_in_log(self):
893
"""See Config.validate_signatures_in_log."""
894
return self._get_user_option('validate_signatures_in_log')
896
def _acceptable_keys(self):
897
"""See Config.acceptable_keys."""
898
return self._get_user_option('acceptable_keys')
900
def _post_commit(self):
901
"""See Config.post_commit."""
902
return self._get_user_option('post_commit')
904
def _get_alias(self, value):
906
return self._get_parser().get_value("ALIASES",
911
def _get_nickname(self):
912
return self.get_user_option('nickname')
914
def remove_user_option(self, option_name, section_name=None):
915
"""Remove a user option and save the configuration file.
917
:param option_name: The option to be removed.
919
:param section_name: The section the option is defined in, default to
923
parser = self._get_parser()
924
if section_name is None:
927
section = parser[section_name]
929
del section[option_name]
931
raise NoSuchConfigOption(option_name)
932
self._write_config_file()
933
for hook in OldConfigHooks['remove']:
934
hook(self, option_name)
936
def _write_config_file(self):
937
if self.file_name is None:
938
raise AssertionError('We cannot save, self.file_name is None')
939
conf_dir = os.path.dirname(self.file_name)
940
ensure_config_dir_exists(conf_dir)
941
atomic_file = atomicfile.AtomicFile(self.file_name)
942
self._get_parser().write(atomic_file)
945
osutils.copy_ownership_from_path(self.file_name)
946
for hook in OldConfigHooks['save']:
950
class LockableConfig(IniBasedConfig):
951
"""A configuration needing explicit locking for access.
953
If several processes try to write the config file, the accesses need to be
956
Daughter classes should use the self.lock_write() decorator method when they
957
upate a config (they call, directly or indirectly, the
958
``_write_config_file()`` method. These methods (typically ``set_option()``
959
and variants must reload the config file from disk before calling
960
``_write_config_file()``), this can be achieved by calling the
961
``self.reload()`` method. Note that the lock scope should cover both the
962
reading and the writing of the config file which is why the decorator can't
963
be applied to ``_write_config_file()`` only.
965
This should be enough to implement the following logic:
966
- lock for exclusive write access,
967
- reload the config file from disk,
971
This logic guarantees that a writer can update a value without erasing an
972
update made by another writer.
977
def __init__(self, file_name):
978
super(LockableConfig, self).__init__(file_name=file_name)
979
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
980
# FIXME: It doesn't matter that we don't provide possible_transports
981
# below since this is currently used only for local config files ;
982
# local transports are not shared. But if/when we start using
983
# LockableConfig for other kind of transports, we will need to reuse
984
# whatever connection is already established -- vila 20100929
985
self.transport = transport.get_transport_from_path(self.dir)
986
self._lock = lockdir.LockDir(self.transport, self.lock_name)
988
def _create_from_string(self, unicode_bytes, save):
989
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
991
# We need to handle the saving here (as opposed to IniBasedConfig)
994
self._write_config_file()
997
def lock_write(self, token=None):
998
"""Takes a write lock in the directory containing the config file.
1000
If the directory doesn't exist it is created.
1002
ensure_config_dir_exists(self.dir)
1003
token = self._lock.lock_write(token)
1004
return lock.LogicalLockResult(self.unlock, token)
1009
def break_lock(self):
1010
self._lock.break_lock()
1012
def remove_user_option(self, option_name, section_name=None):
1013
with self.lock_write():
1014
super(LockableConfig, self).remove_user_option(
1015
option_name, section_name)
1017
def _write_config_file(self):
1018
if self._lock is None or not self._lock.is_held:
1019
# NB: if the following exception is raised it probably means a
1020
# missing call to lock_write() by one of the callers.
1021
raise errors.ObjectNotLocked(self)
1022
super(LockableConfig, self)._write_config_file()
1025
class GlobalConfig(LockableConfig):
1026
"""The configuration that should be used for a specific location."""
1029
super(GlobalConfig, self).__init__(file_name=config_filename())
1031
def config_id(self):
1035
def from_string(cls, str_or_unicode, save=False):
1036
"""Create a config object from a string.
1038
:param str_or_unicode: A string representing the file content. This
1039
will be utf-8 encoded.
1041
:param save: Whether the file should be saved upon creation.
1044
conf._create_from_string(str_or_unicode, save)
1047
def set_user_option(self, option, value):
1048
"""Save option and its value in the configuration."""
1049
with self.lock_write():
1050
self._set_option(option, value, 'DEFAULT')
1052
def get_aliases(self):
1053
"""Return the aliases section."""
1054
if 'ALIASES' in self._get_parser():
1055
return self._get_parser()['ALIASES']
1059
def set_alias(self, alias_name, alias_command):
1060
"""Save the alias in the configuration."""
1061
with self.lock_write():
1062
self._set_option(alias_name, alias_command, 'ALIASES')
1064
def unset_alias(self, alias_name):
1065
"""Unset an existing alias."""
1066
with self.lock_write():
1068
aliases = self._get_parser().get('ALIASES')
1069
if not aliases or alias_name not in aliases:
1070
raise errors.NoSuchAlias(alias_name)
1071
del aliases[alias_name]
1072
self._write_config_file()
1074
def _set_option(self, option, value, section):
1076
self._get_parser().setdefault(section, {})[option] = value
1077
self._write_config_file()
1078
for hook in OldConfigHooks['set']:
1079
hook(self, option, value)
1081
def _get_sections(self, name=None):
1082
"""See IniBasedConfig._get_sections()."""
1083
parser = self._get_parser()
1084
# We don't give access to options defined outside of any section, we
1085
# used the DEFAULT section by... default.
1086
if name in (None, 'DEFAULT'):
1087
# This could happen for an empty file where the DEFAULT section
1088
# doesn't exist yet. So we force DEFAULT when yielding
1090
if 'DEFAULT' not in parser:
1091
parser['DEFAULT'] = {}
1092
yield (name, parser[name], self.config_id())
1094
def remove_user_option(self, option_name, section_name=None):
1095
if section_name is None:
1096
# We need to force the default section.
1097
section_name = 'DEFAULT'
1098
with self.lock_write():
1099
# We need to avoid the LockableConfig implementation or we'll lock
1101
super(LockableConfig, self).remove_user_option(
1102
option_name, section_name)
1105
def _iter_for_location_by_parts(sections, location):
1106
"""Keep only the sessions matching the specified location.
1108
:param sections: An iterable of section names.
1110
:param location: An url or a local path to match against.
1112
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1113
number of path components in the section name, section is the section
1114
name and extra_path is the difference between location and the section
1117
``location`` will always be a local path and never a 'file://' url but the
1118
section names themselves can be in either form.
1120
location_parts = location.rstrip('/').split('/')
1122
for section in sections:
1123
# location is a local path if possible, so we need to convert 'file://'
1124
# urls in section names to local paths if necessary.
1126
# This also avoids having file:///path be a more exact
1127
# match than '/path'.
1129
# FIXME: This still raises an issue if a user defines both file:///path
1130
# *and* /path. Should we raise an error in this case -- vila 20110505
1132
if section.startswith('file://'):
1133
section_path = urlutils.local_path_from_url(section)
1135
section_path = section
1136
section_parts = section_path.rstrip('/').split('/')
1139
if len(section_parts) > len(location_parts):
1140
# More path components in the section, they can't match
1143
# Rely on zip truncating in length to the length of the shortest
1144
# argument sequence.
1145
for name in zip(location_parts, section_parts):
1146
if not fnmatch.fnmatch(name[0], name[1]):
1151
# build the path difference between the section and the location
1152
extra_path = '/'.join(location_parts[len(section_parts):])
1153
yield section, extra_path, len(section_parts)
1156
class LocationConfig(LockableConfig):
1157
"""A configuration object that gives the policy for a location."""
1159
def __init__(self, location):
1160
super(LocationConfig, self).__init__(
1161
file_name=locations_config_filename())
1162
# local file locations are looked up by local path, rather than
1163
# by file url. This is because the config file is a user
1164
# file, and we would rather not expose the user to file urls.
1165
if location.startswith('file://'):
1166
location = urlutils.local_path_from_url(location)
1167
self.location = location
1169
def config_id(self):
1173
def from_string(cls, str_or_unicode, location, save=False):
1174
"""Create a config object from a string.
1176
:param str_or_unicode: A string representing the file content. This will
1179
:param location: The location url to filter the configuration.
1181
:param save: Whether the file should be saved upon creation.
1183
conf = cls(location)
1184
conf._create_from_string(str_or_unicode, save)
1187
def _get_matching_sections(self):
1188
"""Return an ordered list of section names matching this location."""
1189
# put the longest (aka more specific) locations first
1191
_iter_for_location_by_parts(self._get_parser(), self.location),
1192
key=lambda match: (match[2], match[0]),
1194
for (section, extra_path, length) in matches:
1195
yield section, extra_path
1196
# should we stop looking for parent configs here?
1198
if self._get_parser()[section].as_bool('ignore_parents'):
1203
def _get_sections(self, name=None):
1204
"""See IniBasedConfig._get_sections()."""
1205
# We ignore the name here as the only sections handled are named with
1206
# the location path and we don't expose embedded sections either.
1207
parser = self._get_parser()
1208
for name, extra_path in self._get_matching_sections():
1209
yield (name, parser[name], self.config_id())
1211
def _get_option_policy(self, section, option_name):
1212
"""Return the policy for the given (section, option_name) pair."""
1213
# check for the old 'recurse=False' flag
1215
recurse = self._get_parser()[section].as_bool('recurse')
1219
return POLICY_NORECURSE
1221
policy_key = option_name + ':policy'
1223
policy_name = self._get_parser()[section][policy_key]
1227
return _policy_value[policy_name]
1229
def _set_option_policy(self, section, option_name, option_policy):
1230
"""Set the policy for the given option name in the given section."""
1231
policy_key = option_name + ':policy'
1232
policy_name = _policy_name[option_policy]
1233
if policy_name is not None:
1234
self._get_parser()[section][policy_key] = policy_name
1236
if policy_key in self._get_parser()[section]:
1237
del self._get_parser()[section][policy_key]
1239
def set_user_option(self, option, value, store=STORE_LOCATION):
1240
"""Save option and its value in the configuration."""
1241
if store not in [STORE_LOCATION,
1242
STORE_LOCATION_NORECURSE,
1243
STORE_LOCATION_APPENDPATH]:
1244
raise ValueError('bad storage policy %r for %r' %
1246
with self.lock_write():
1248
location = self.location
1249
if location.endswith('/'):
1250
location = location[:-1]
1251
parser = self._get_parser()
1252
if location not in parser and not location + '/' in parser:
1253
parser[location] = {}
1254
elif location + '/' in parser:
1255
location = location + '/'
1256
parser[location][option] = value
1257
# the allowed values of store match the config policies
1258
self._set_option_policy(location, option, store)
1259
self._write_config_file()
1260
for hook in OldConfigHooks['set']:
1261
hook(self, option, value)
1264
class BranchConfig(Config):
1265
"""A configuration object giving the policy for a branch."""
1267
def __init__(self, branch):
1268
super(BranchConfig, self).__init__()
1269
self._location_config = None
1270
self._branch_data_config = None
1271
self._global_config = None
1272
self.branch = branch
1273
self.option_sources = (self._get_location_config,
1274
self._get_branch_data_config,
1275
self._get_global_config)
1277
def config_id(self):
1280
def _get_branch_data_config(self):
1281
if self._branch_data_config is None:
1282
self._branch_data_config = TreeConfig(self.branch)
1283
self._branch_data_config.config_id = self.config_id
1284
return self._branch_data_config
1286
def _get_location_config(self):
1287
if self._location_config is None:
1288
self._location_config = LocationConfig(self.branch.base)
1289
return self._location_config
1291
def _get_global_config(self):
1292
if self._global_config is None:
1293
self._global_config = GlobalConfig()
1294
return self._global_config
1296
def _get_best_value(self, option_name):
1297
"""This returns a user option from local, tree or global config.
1299
They are tried in that order. Use get_safe_value if trusted values
1302
for source in self.option_sources:
1303
value = getattr(source(), option_name)()
1304
if value is not None:
1308
def _get_safe_value(self, option_name):
1309
"""This variant of get_best_value never returns untrusted values.
1311
It does not return values from the branch data, because the branch may
1312
not be controlled by the user.
1314
We may wish to allow locations.conf to control whether branches are
1315
trusted in the future.
1317
for source in (self._get_location_config, self._get_global_config):
1318
value = getattr(source(), option_name)()
1319
if value is not None:
1323
def _get_user_id(self):
1324
"""Return the full user id for the branch.
1326
e.g. "John Hacker <jhacker@example.com>"
1327
This is looked up in the email controlfile for the branch.
1329
return self._get_best_value('_get_user_id')
1331
def _get_change_editor(self):
1332
return self._get_best_value('_get_change_editor')
1334
def _get_signature_checking(self):
1335
"""See Config._get_signature_checking."""
1336
return self._get_best_value('_get_signature_checking')
1338
def _get_signing_policy(self):
1339
"""See Config._get_signing_policy."""
1340
return self._get_best_value('_get_signing_policy')
1342
def _get_user_option(self, option_name):
1343
"""See Config._get_user_option."""
1344
for source in self.option_sources:
1345
value = source()._get_user_option(option_name)
1346
if value is not None:
1350
def _get_sections(self, name=None):
1351
"""See IniBasedConfig.get_sections()."""
1352
for source in self.option_sources:
1353
for section in source()._get_sections(name):
1356
def _get_options(self, sections=None):
1358
# First the locations options
1359
for option in self._get_location_config()._get_options():
1361
# Then the branch options
1362
branch_config = self._get_branch_data_config()
1363
if sections is None:
1364
sections = [('DEFAULT', branch_config._get_parser())]
1365
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1366
# Config itself has no notion of sections :( -- vila 20101001
1367
config_id = self.config_id()
1368
for (section_name, section) in sections:
1369
for (name, value) in section.iteritems():
1370
yield (name, value, section_name,
1371
config_id, branch_config._get_parser())
1372
# Then the global options
1373
for option in self._get_global_config()._get_options():
1376
def set_user_option(self, name, value, store=STORE_BRANCH,
1378
if store == STORE_BRANCH:
1379
self._get_branch_data_config().set_option(value, name)
1380
elif store == STORE_GLOBAL:
1381
self._get_global_config().set_user_option(name, value)
1383
self._get_location_config().set_user_option(name, value, store)
1386
if store in (STORE_GLOBAL, STORE_BRANCH):
1387
mask_value = self._get_location_config().get_user_option(name)
1388
if mask_value is not None:
1389
trace.warning('Value "%s" is masked by "%s" from'
1390
' locations.conf', value, mask_value)
1392
if store == STORE_GLOBAL:
1393
branch_config = self._get_branch_data_config()
1394
mask_value = branch_config.get_user_option(name)
1395
if mask_value is not None:
1396
trace.warning('Value "%s" is masked by "%s" from'
1397
' branch.conf', value, mask_value)
1399
def remove_user_option(self, option_name, section_name=None):
1400
self._get_branch_data_config().remove_option(option_name, section_name)
1402
def _post_commit(self):
1403
"""See Config.post_commit."""
1404
return self._get_safe_value('_post_commit')
1406
def _get_nickname(self):
1407
value = self._get_explicit_nickname()
1408
if value is not None:
1410
if self.branch.name:
1411
return self.branch.name
1412
return urlutils.unescape(self.branch.base.split('/')[-2])
1414
def has_explicit_nickname(self):
1415
"""Return true if a nickname has been explicitly assigned."""
1416
return self._get_explicit_nickname() is not None
1418
def _get_explicit_nickname(self):
1419
return self._get_best_value('_get_nickname')
1421
def _log_format(self):
1422
"""See Config.log_format."""
1423
return self._get_best_value('_log_format')
1425
def _validate_signatures_in_log(self):
1426
"""See Config.validate_signatures_in_log."""
1427
return self._get_best_value('_validate_signatures_in_log')
1429
def _acceptable_keys(self):
1430
"""See Config.acceptable_keys."""
1431
return self._get_best_value('_acceptable_keys')
1434
def ensure_config_dir_exists(path=None):
1435
"""Make sure a configuration directory exists.
1436
This makes sure that the directory exists.
1437
On windows, since configuration directories are 2 levels deep,
1438
it makes sure both the directory and the parent directory exists.
1442
if not os.path.isdir(path):
1443
if sys.platform == 'win32':
1444
parent_dir = os.path.dirname(path)
1445
if not os.path.isdir(parent_dir):
1446
trace.mutter('creating config parent directory: %r', parent_dir)
1447
os.mkdir(parent_dir)
1448
trace.mutter('creating config directory: %r', path)
1450
osutils.copy_ownership_from_path(path)
1453
def bazaar_config_dir():
1454
"""Return per-user configuration directory as unicode string
1456
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1457
and Linux. On Mac OS X and Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1458
that will be used instead.
1460
TODO: Global option --config-dir to override this.
1462
base = osutils.path_from_environ('BZR_HOME')
1463
if sys.platform == 'win32':
1465
base = win32utils.get_appdata_location()
1467
base = win32utils.get_home_location()
1468
return osutils.pathjoin(base, 'bazaar', '2.0')
1470
xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1472
xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1473
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1474
if osutils.isdir(xdg_dir):
1476
"Using configuration in XDG directory %s." % xdg_dir)
1478
base = osutils._get_home_dir()
1479
return osutils.pathjoin(base, ".bazaar")
1483
"""Return per-user configuration directory as unicode string
1485
By default this is %APPDATA%/breezy on Windows, $XDG_CONFIG_HOME/breezy on
1486
Mac OS X and Linux. If the breezy config directory doesn't exist but
1487
the bazaar one (see bazaar_config_dir()) does, use that instead.
1489
# TODO: Global option --config-dir to override this.
1490
base = osutils.path_from_environ('BRZ_HOME')
1491
if sys.platform == 'win32':
1493
base = win32utils.get_appdata_location()
1495
base = win32utils.get_home_location()
1497
base = osutils.path_from_environ('XDG_CONFIG_HOME')
1499
base = osutils.pathjoin(osutils._get_home_dir(), ".config")
1500
breezy_dir = osutils.pathjoin(base, 'breezy')
1501
if osutils.isdir(breezy_dir):
1502
return (breezy_dir, 'breezy')
1503
# If the breezy directory doesn't exist, but the bazaar one does, use that:
1504
bazaar_dir = bazaar_config_dir()
1505
if osutils.isdir(bazaar_dir):
1507
"Using Bazaar configuration directory (%s)", bazaar_dir)
1508
return (bazaar_dir, 'bazaar')
1509
return (breezy_dir, 'breezy')
1513
"""Return per-user configuration directory as unicode string
1515
By default this is %APPDATA%/breezy on Windows, $XDG_CONFIG_HOME/breezy on
1516
Mac OS X and Linux. If the breezy config directory doesn't exist but
1517
the bazaar one (see bazaar_config_dir()) does, use that instead.
1519
return _config_dir()[0]
1522
def config_filename():
1523
"""Return per-user configuration ini file filename."""
1524
path, kind = _config_dir()
1525
if kind == 'bazaar':
1526
return osutils.pathjoin(path, 'bazaar.conf')
1528
return osutils.pathjoin(path, 'breezy.conf')
1531
def locations_config_filename():
1532
"""Return per-user configuration ini file filename."""
1533
return osutils.pathjoin(config_dir(), 'locations.conf')
1536
def authentication_config_filename():
1537
"""Return per-user authentication ini file filename."""
1538
return osutils.pathjoin(config_dir(), 'authentication.conf')
1541
def user_ignore_config_filename():
1542
"""Return the user default ignore filename"""
1543
return osutils.pathjoin(config_dir(), 'ignore')
1547
"""Return the directory name to store crash files.
1549
This doesn't implicitly create it.
1551
On Windows it's in the config directory; elsewhere it's /var/crash
1552
which may be monitored by apport. It can be overridden by
1555
if sys.platform == 'win32':
1556
return osutils.pathjoin(config_dir(), 'Crash')
1558
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1560
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1563
def xdg_cache_dir():
1564
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1565
# Possibly this should be different on Windows?
1566
e = os.environ.get('XDG_CACHE_HOME', None)
1570
return os.path.expanduser('~/.cache')
1573
def _get_default_mail_domain(mailname_file='/etc/mailname'):
1574
"""If possible, return the assumed default email domain.
1576
:returns: string mail domain, or None.
1578
if sys.platform == 'win32':
1579
# No implementation yet; patches welcome
1582
f = open(mailname_file)
1583
except (IOError, OSError) as e:
1586
domain = f.readline().strip()
1592
def default_email():
1593
v = os.environ.get('BRZ_EMAIL')
1596
v = v.decode(osutils.get_user_encoding())
1598
v = os.environ.get('EMAIL')
1601
v = v.decode(osutils.get_user_encoding())
1603
name, email = _auto_user_id()
1605
return u'%s <%s>' % (name, email)
1611
def _auto_user_id():
1612
"""Calculate automatic user identification.
1614
:returns: (realname, email), either of which may be None if they can't be
1617
Only used when none is set in the environment or the id file.
1619
This only returns an email address if we can be fairly sure the
1620
address is reasonable, ie if /etc/mailname is set on unix.
1622
This doesn't use the FQDN as the default domain because that may be
1623
slow, and it doesn't use the hostname alone because that's not normally
1624
a reasonable address.
1626
if sys.platform == 'win32':
1627
# No implementation to reliably determine Windows default mail
1628
# address; please add one.
1631
default_mail_domain = _get_default_mail_domain()
1632
if not default_mail_domain:
1638
w = pwd.getpwuid(uid)
1640
trace.mutter('no passwd entry for uid %d?' % uid)
1643
# we try utf-8 first, because on many variants (like Linux),
1644
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1645
# false positives. (many users will have their user encoding set to
1646
# latin-1, which cannot raise UnicodeError.)
1648
if isinstance(gecos, bytes):
1650
gecos = gecos.decode('utf-8')
1652
except UnicodeError:
1654
encoding = osutils.get_user_encoding()
1655
gecos = gecos.decode(encoding)
1656
except UnicodeError as e:
1657
trace.mutter("cannot decode passwd entry %s" % w)
1660
username = w.pw_name
1661
if isinstance(username, bytes):
1663
username = username.decode(encoding)
1664
except UnicodeError as e:
1665
trace.mutter("cannot decode passwd entry %s" % w)
1668
comma = gecos.find(',')
1672
realname = gecos[:comma]
1674
return realname, (username + '@' + default_mail_domain)
1677
def parse_username(username):
1678
"""Parse e-mail username and return a (name, address) tuple."""
1679
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1681
return (username, '')
1683
return (match.group(1), match.group(2))
1686
def extract_email_address(e):
1687
"""Return just the address part of an email string.
1689
That is just the user@domain part, nothing else.
1690
This part is required to contain only ascii characters.
1691
If it can't be extracted, raises an error.
1693
>>> extract_email_address('Jane Tester <jane@test.com>')
1696
name, email = parse_username(e)
1698
raise NoEmailInUsername(e)
1702
class TreeConfig(IniBasedConfig):
1703
"""Branch configuration data associated with its contents, not location"""
1705
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1707
def __init__(self, branch):
1708
self._config = branch._get_config()
1709
self.branch = branch
1711
def _get_parser(self, file=None):
1712
if file is not None:
1713
return IniBasedConfig._get_parser(file)
1714
return self._config._get_configobj()
1716
def get_option(self, name, section=None, default=None):
1717
with self.branch.lock_read():
1718
return self._config.get_option(name, section, default)
1720
def set_option(self, value, name, section=None):
1721
"""Set a per-branch configuration option"""
1722
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1723
# higher levels providing the right lock -- vila 20101004
1724
with self.branch.lock_write():
1725
self._config.set_option(value, name, section)
1727
def remove_option(self, option_name, section_name=None):
1728
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1729
# higher levels providing the right lock -- vila 20101004
1730
with self.branch.lock_write():
1731
self._config.remove_option(option_name, section_name)
1734
_authentication_config_permission_errors = set()
1737
class AuthenticationConfig(object):
1738
"""The authentication configuration file based on a ini file.
1740
Implements the authentication.conf file described in
1741
doc/developers/authentication-ring.txt.
1744
def __init__(self, _file=None):
1745
self._config = None # The ConfigObj
1747
self._filename = authentication_config_filename()
1748
self._input = self._filename = authentication_config_filename()
1749
self._check_permissions()
1751
# Tests can provide a string as _file
1752
self._filename = None
1755
def _get_config(self):
1756
if self._config is not None:
1759
# FIXME: Should we validate something here ? Includes: empty
1760
# sections are useless, at least one of
1761
# user/password/password_encoding should be defined, etc.
1763
# Note: the encoding below declares that the file itself is utf-8
1764
# encoded, but the values in the ConfigObj are always Unicode.
1765
self._config = ConfigObj(self._input, encoding='utf-8')
1766
except configobj.ConfigObjError as e:
1767
raise ParseConfigError(e.errors, e.config.filename)
1768
except UnicodeError:
1769
raise ConfigContentError(self._filename)
1772
def _check_permissions(self):
1773
"""Check permission of auth file are user read/write able only."""
1775
st = os.stat(self._filename)
1776
except OSError as e:
1777
if e.errno != errno.ENOENT:
1778
trace.mutter('Unable to stat %r: %r', self._filename, e)
1780
mode = stat.S_IMODE(st.st_mode)
1781
if ((stat.S_IXOTH | stat.S_IWOTH | stat.S_IROTH | stat.S_IXGRP |
1782
stat.S_IWGRP | stat.S_IRGRP ) & mode):
1784
if (not self._filename in _authentication_config_permission_errors
1785
and not GlobalConfig().suppress_warning(
1786
'insecure_permissions')):
1787
trace.warning("The file '%s' has insecure "
1788
"file permissions. Saved passwords may be accessible "
1789
"by other users.", self._filename)
1790
_authentication_config_permission_errors.add(self._filename)
1793
"""Save the config file, only tests should use it for now."""
1794
conf_dir = os.path.dirname(self._filename)
1795
ensure_config_dir_exists(conf_dir)
1796
fd = os.open(self._filename, os.O_RDWR|os.O_CREAT, 0o600)
1798
f = os.fdopen(fd, 'wb')
1799
self._get_config().write(f)
1803
def _set_option(self, section_name, option_name, value):
1804
"""Set an authentication configuration option"""
1805
conf = self._get_config()
1806
section = conf.get(section_name)
1809
section = conf[section]
1810
section[option_name] = value
1813
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1815
"""Returns the matching credentials from authentication.conf file.
1817
:param scheme: protocol
1819
:param host: the server address
1821
:param port: the associated port (optional)
1823
:param user: login (optional)
1825
:param path: the absolute path on the server (optional)
1827
:param realm: the http authentication realm (optional)
1829
:return: A dict containing the matching credentials or None.
1831
- name: the section name of the credentials in the
1832
authentication.conf file,
1833
- user: can't be different from the provided user if any,
1834
- scheme: the server protocol,
1835
- host: the server address,
1836
- port: the server port (can be None),
1837
- path: the absolute server path (can be None),
1838
- realm: the http specific authentication realm (can be None),
1839
- password: the decoded password, could be None if the credential
1840
defines only the user
1841
- verify_certificates: https specific, True if the server
1842
certificate should be verified, False otherwise.
1845
for auth_def_name, auth_def in self._get_config().iteritems():
1846
if not isinstance(auth_def, configobj.Section):
1847
raise ValueError("%s defined outside a section" % auth_def_name)
1849
a_scheme, a_host, a_user, a_path = map(
1850
auth_def.get, ['scheme', 'host', 'user', 'path'])
1853
a_port = auth_def.as_int('port')
1857
raise ValueError("'port' not numeric in %s" % auth_def_name)
1859
a_verify_certificates = auth_def.as_bool('verify_certificates')
1861
a_verify_certificates = True
1864
"'verify_certificates' not boolean in %s" % auth_def_name)
1867
if a_scheme is not None and scheme != a_scheme:
1869
if a_host is not None:
1870
if not (host == a_host
1871
or (a_host.startswith('.') and host.endswith(a_host))):
1873
if a_port is not None and port != a_port:
1875
if (a_path is not None and path is not None
1876
and not path.startswith(a_path)):
1878
if (a_user is not None and user is not None
1879
and a_user != user):
1880
# Never contradict the caller about the user to be used
1885
# Prepare a credentials dictionary with additional keys
1886
# for the credential providers
1887
credentials = dict(name=auth_def_name,
1894
password=auth_def.get('password', None),
1895
verify_certificates=a_verify_certificates)
1896
# Decode the password in the credentials (or get one)
1897
self.decode_password(credentials,
1898
auth_def.get('password_encoding', None))
1899
if 'auth' in debug.debug_flags:
1900
trace.mutter("Using authentication section: %r", auth_def_name)
1903
if credentials is None:
1904
# No credentials were found in authentication.conf, try the fallback
1905
# credentials stores.
1906
credentials = credential_store_registry.get_fallback_credentials(
1907
scheme, host, port, user, path, realm)
1911
def set_credentials(self, name, host, user, scheme=None, password=None,
1912
port=None, path=None, verify_certificates=None,
1914
"""Set authentication credentials for a host.
1916
Any existing credentials with matching scheme, host, port and path
1917
will be deleted, regardless of name.
1919
:param name: An arbitrary name to describe this set of credentials.
1920
:param host: Name of the host that accepts these credentials.
1921
:param user: The username portion of these credentials.
1922
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1924
:param password: Password portion of these credentials.
1925
:param port: The IP port on the host that these credentials apply to.
1926
:param path: A filesystem path on the host that these credentials
1928
:param verify_certificates: On https, verify server certificates if
1930
:param realm: The http authentication realm (optional).
1932
values = {'host': host, 'user': user}
1933
if password is not None:
1934
values['password'] = password
1935
if scheme is not None:
1936
values['scheme'] = scheme
1937
if port is not None:
1938
values['port'] = '%d' % port
1939
if path is not None:
1940
values['path'] = path
1941
if verify_certificates is not None:
1942
values['verify_certificates'] = str(verify_certificates)
1943
if realm is not None:
1944
values['realm'] = realm
1945
config = self._get_config()
1947
for section, existing_values in config.iteritems():
1948
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1949
if existing_values.get(key) != values.get(key):
1953
config.update({name: values})
1956
def get_user(self, scheme, host, port=None, realm=None, path=None,
1957
prompt=None, ask=False, default=None):
1958
"""Get a user from authentication file.
1960
:param scheme: protocol
1962
:param host: the server address
1964
:param port: the associated port (optional)
1966
:param realm: the realm sent by the server (optional)
1968
:param path: the absolute path on the server (optional)
1970
:param ask: Ask the user if there is no explicitly configured username
1973
:param default: The username returned if none is defined (optional).
1975
:return: The found user.
1977
credentials = self.get_credentials(scheme, host, port, user=None,
1978
path=path, realm=realm)
1979
if credentials is not None:
1980
user = credentials['user']
1986
# Create a default prompt suitable for most cases
1987
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1988
# Special handling for optional fields in the prompt
1989
if port is not None:
1990
prompt_host = '%s:%d' % (host, port)
1993
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1998
def get_password(self, scheme, host, user, port=None,
1999
realm=None, path=None, prompt=None):
2000
"""Get a password from authentication file or prompt the user for one.
2002
:param scheme: protocol
2004
:param host: the server address
2006
:param port: the associated port (optional)
2010
:param realm: the realm sent by the server (optional)
2012
:param path: the absolute path on the server (optional)
2014
:return: The found password or the one entered by the user.
2016
credentials = self.get_credentials(scheme, host, port, user, path,
2018
if credentials is not None:
2019
password = credentials['password']
2020
if password is not None and scheme is 'ssh':
2021
trace.warning('password ignored in section [%s],'
2022
' use an ssh agent instead'
2023
% credentials['name'])
2027
# Prompt user only if we could't find a password
2028
if password is None:
2030
# Create a default prompt suitable for most cases
2031
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2032
# Special handling for optional fields in the prompt
2033
if port is not None:
2034
prompt_host = '%s:%d' % (host, port)
2037
password = ui.ui_factory.get_password(prompt,
2038
host=prompt_host, user=user)
2041
def decode_password(self, credentials, encoding):
2043
cs = credential_store_registry.get_credential_store(encoding)
2045
raise ValueError('%r is not a known password_encoding' % encoding)
2046
credentials['password'] = cs.decode_password(credentials)
2050
class CredentialStoreRegistry(registry.Registry):
2051
"""A class that registers credential stores.
2053
A credential store provides access to credentials via the password_encoding
2054
field in authentication.conf sections.
2056
Except for stores provided by brz itself, most stores are expected to be
2057
provided by plugins that will therefore use
2058
register_lazy(password_encoding, module_name, member_name, help=help,
2059
fallback=fallback) to install themselves.
2061
A fallback credential store is one that is queried if no credentials can be
2062
found via authentication.conf.
2065
def get_credential_store(self, encoding=None):
2066
cs = self.get(encoding)
2071
def is_fallback(self, name):
2072
"""Check if the named credentials store should be used as fallback."""
2073
return self.get_info(name)
2075
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2076
path=None, realm=None):
2077
"""Request credentials from all fallback credentials stores.
2079
The first credentials store that can provide credentials wins.
2082
for name in self.keys():
2083
if not self.is_fallback(name):
2085
cs = self.get_credential_store(name)
2086
credentials = cs.get_credentials(scheme, host, port, user,
2088
if credentials is not None:
2089
# We found some credentials
2093
def register(self, key, obj, help=None, override_existing=False,
2095
"""Register a new object to a name.
2097
:param key: This is the key to use to request the object later.
2098
:param obj: The object to register.
2099
:param help: Help text for this entry. This may be a string or
2100
a callable. If it is a callable, it should take two
2101
parameters (registry, key): this registry and the key that
2102
the help was registered under.
2103
:param override_existing: Raise KeyErorr if False and something has
2104
already been registered for that key. If True, ignore if there
2105
is an existing key (always register the new value).
2106
:param fallback: Whether this credential store should be
2109
return super(CredentialStoreRegistry,
2110
self).register(key, obj, help, info=fallback,
2111
override_existing=override_existing)
2113
def register_lazy(self, key, module_name, member_name,
2114
help=None, override_existing=False,
2116
"""Register a new credential store to be loaded on request.
2118
:param module_name: The python path to the module. Such as 'os.path'.
2119
:param member_name: The member of the module to return. If empty or
2120
None, get() will return the module itself.
2121
:param help: Help text for this entry. This may be a string or
2123
:param override_existing: If True, replace the existing object
2124
with the new one. If False, if there is already something
2125
registered with the same key, raise a KeyError
2126
:param fallback: Whether this credential store should be
2129
return super(CredentialStoreRegistry, self).register_lazy(
2130
key, module_name, member_name, help,
2131
info=fallback, override_existing=override_existing)
2134
credential_store_registry = CredentialStoreRegistry()
2137
class CredentialStore(object):
2138
"""An abstract class to implement storage for credentials"""
2140
def decode_password(self, credentials):
2141
"""Returns a clear text password for the provided credentials."""
2142
raise NotImplementedError(self.decode_password)
2144
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2146
"""Return the matching credentials from this credential store.
2148
This method is only called on fallback credential stores.
2150
raise NotImplementedError(self.get_credentials)
2154
class PlainTextCredentialStore(CredentialStore):
2155
__doc__ = """Plain text credential store for the authentication.conf file"""
2157
def decode_password(self, credentials):
2158
"""See CredentialStore.decode_password."""
2159
return credentials['password']
2162
credential_store_registry.register('plain', PlainTextCredentialStore,
2163
help=PlainTextCredentialStore.__doc__)
2164
credential_store_registry.default_key = 'plain'
2167
class Base64CredentialStore(CredentialStore):
2168
__doc__ = """Base64 credential store for the authentication.conf file"""
2170
def decode_password(self, credentials):
2171
"""See CredentialStore.decode_password."""
2172
# GZ 2012-07-28: Will raise binascii.Error if password is not base64,
2173
# should probably propogate as something more useful.
2174
return base64.standard_b64decode(credentials['password'])
2176
credential_store_registry.register('base64', Base64CredentialStore,
2177
help=Base64CredentialStore.__doc__)
2180
class BzrDirConfig(object):
2182
def __init__(self, bzrdir):
2183
self._bzrdir = bzrdir
2184
self._config = bzrdir._get_config()
2186
def set_default_stack_on(self, value):
2187
"""Set the default stacking location.
2189
It may be set to a location, or None.
2191
This policy affects all branches contained by this control dir, except
2192
for those under repositories.
2194
if self._config is None:
2195
raise errors.BzrError("Cannot set configuration in %s"
2198
self._config.set_option('', 'default_stack_on')
2200
self._config.set_option(value, 'default_stack_on')
2202
def get_default_stack_on(self):
2203
"""Return the default stacking location.
2205
This will either be a location, or None.
2207
This policy affects all branches contained by this control dir, except
2208
for those under repositories.
2210
if self._config is None:
2212
value = self._config.get_option('default_stack_on')
2218
class TransportConfig(object):
2219
"""A Config that reads/writes a config file on a Transport.
2221
It is a low-level object that considers config data to be name/value pairs
2222
that may be associated with a section. Assigning meaning to these values
2223
is done at higher levels like TreeConfig.
2226
def __init__(self, transport, filename):
2227
self._transport = transport
2228
self._filename = filename
2230
def get_option(self, name, section=None, default=None):
2231
"""Return the value associated with a named option.
2233
:param name: The name of the value
2234
:param section: The section the option is in (if any)
2235
:param default: The value to return if the value is not set
2236
:return: The value or default value
2238
configobj = self._get_configobj()
2240
section_obj = configobj
2243
section_obj = configobj[section]
2246
value = section_obj.get(name, default)
2247
for hook in OldConfigHooks['get']:
2248
hook(self, name, value)
2251
def set_option(self, value, name, section=None):
2252
"""Set the value associated with a named option.
2254
:param value: The value to set
2255
:param name: The name of the value to set
2256
:param section: The section the option is in (if any)
2258
configobj = self._get_configobj()
2260
configobj[name] = value
2262
configobj.setdefault(section, {})[name] = value
2263
for hook in OldConfigHooks['set']:
2264
hook(self, name, value)
2265
self._set_configobj(configobj)
2267
def remove_option(self, option_name, section_name=None):
2268
configobj = self._get_configobj()
2269
if section_name is None:
2270
del configobj[option_name]
2272
del configobj[section_name][option_name]
2273
for hook in OldConfigHooks['remove']:
2274
hook(self, option_name)
2275
self._set_configobj(configobj)
2277
def _get_config_file(self):
2279
f = BytesIO(self._transport.get_bytes(self._filename))
2280
for hook in OldConfigHooks['load']:
2283
except errors.NoSuchFile:
2285
except errors.PermissionDenied as e:
2286
trace.warning("Permission denied while trying to open "
2287
"configuration file %s.", urlutils.unescape_for_display(
2288
urlutils.join(self._transport.base, self._filename), "utf-8"))
2291
def _external_url(self):
2292
return urlutils.join(self._transport.external_url(), self._filename)
2294
def _get_configobj(self):
2295
f = self._get_config_file()
2298
conf = ConfigObj(f, encoding='utf-8')
2299
except configobj.ConfigObjError as e:
2300
raise ParseConfigError(e.errors, self._external_url())
2301
except UnicodeDecodeError:
2302
raise ConfigContentError(self._external_url())
2307
def _set_configobj(self, configobj):
2308
out_file = BytesIO()
2309
configobj.write(out_file)
2311
self._transport.put_file(self._filename, out_file)
2312
for hook in OldConfigHooks['save']:
2316
class Option(object):
2317
"""An option definition.
2319
The option *values* are stored in config files and found in sections.
2321
Here we define various properties about the option itself, its default
2322
value, how to convert it from stores, what to do when invalid values are
2323
encoutered, in which config files it can be stored.
2326
def __init__(self, name, override_from_env=None,
2327
default=None, default_from_env=None,
2328
help=None, from_unicode=None, invalid=None, unquote=True):
2329
"""Build an option definition.
2331
:param name: the name used to refer to the option.
2333
:param override_from_env: A list of environment variables which can
2334
provide override any configuration setting.
2336
:param default: the default value to use when none exist in the config
2337
stores. This is either a string that ``from_unicode`` will convert
2338
into the proper type, a callable returning a unicode string so that
2339
``from_unicode`` can be used on the return value, or a python
2340
object that can be stringified (so only the empty list is supported
2343
:param default_from_env: A list of environment variables which can
2344
provide a default value. 'default' will be used only if none of the
2345
variables specified here are set in the environment.
2347
:param help: a doc string to explain the option to the user.
2349
:param from_unicode: a callable to convert the unicode string
2350
representing the option value in a store or its default value.
2352
:param invalid: the action to be taken when an invalid value is
2353
encountered in a store. This is called only when from_unicode is
2354
invoked to convert a string and returns None or raise ValueError or
2355
TypeError. Accepted values are: None (ignore invalid values),
2356
'warning' (emit a warning), 'error' (emit an error message and
2359
:param unquote: should the unicode value be unquoted before conversion.
2360
This should be used only when the store providing the values cannot
2361
safely unquote them (see http://pad.lv/906897). It is provided so
2362
daughter classes can handle the quoting themselves.
2364
if override_from_env is None:
2365
override_from_env = []
2366
if default_from_env is None:
2367
default_from_env = []
2369
self.override_from_env = override_from_env
2370
# Convert the default value to a unicode string so all values are
2371
# strings internally before conversion (via from_unicode) is attempted.
2374
elif isinstance(default, list):
2375
# Only the empty list is supported
2377
raise AssertionError(
2378
'Only empty lists are supported as default values')
2380
elif isinstance(default, (binary_type, text_type, bool, int, float)):
2381
# Rely on python to convert strings, booleans and integers
2382
self.default = u'%s' % (default,)
2383
elif callable(default):
2384
self.default = default
2386
# other python objects are not expected
2387
raise AssertionError('%r is not supported as a default value'
2389
self.default_from_env = default_from_env
2391
self.from_unicode = from_unicode
2392
self.unquote = unquote
2393
if invalid and invalid not in ('warning', 'error'):
2394
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2395
self.invalid = invalid
2401
def convert_from_unicode(self, store, unicode_value):
2402
if self.unquote and store is not None and unicode_value is not None:
2403
unicode_value = store.unquote(unicode_value)
2404
if self.from_unicode is None or unicode_value is None:
2405
# Don't convert or nothing to convert
2406
return unicode_value
2408
converted = self.from_unicode(unicode_value)
2409
except (ValueError, TypeError):
2410
# Invalid values are ignored
2412
if converted is None and self.invalid is not None:
2413
# The conversion failed
2414
if self.invalid == 'warning':
2415
trace.warning('Value "%s" is not valid for "%s"',
2416
unicode_value, self.name)
2417
elif self.invalid == 'error':
2418
raise ConfigOptionValueError(self.name, unicode_value)
2421
def get_override(self):
2423
for var in self.override_from_env:
2425
# If the env variable is defined, its value takes precedence
2426
value = os.environ[var]
2428
value = value.decode(osutils.get_user_encoding())
2434
def get_default(self):
2436
for var in self.default_from_env:
2438
# If the env variable is defined, its value is the default one
2439
value = os.environ[var]
2441
value = value.decode(osutils.get_user_encoding())
2446
# Otherwise, fallback to the value defined at registration
2447
if callable(self.default):
2448
value = self.default()
2449
if not isinstance(value, text_type):
2450
raise AssertionError(
2451
"Callable default value for '%s' should be unicode"
2454
value = self.default
2457
def get_help_topic(self):
2460
def get_help_text(self, additional_see_also=None, plain=True):
2462
from breezy import help_topics
2463
result += help_topics._format_see_also(additional_see_also)
2465
result = help_topics.help_as_plain_text(result)
2469
# Predefined converters to get proper values from store
2471
def bool_from_store(unicode_str):
2472
return ui.bool_from_string(unicode_str)
2475
def int_from_store(unicode_str):
2476
return int(unicode_str)
2479
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2481
def int_SI_from_store(unicode_str):
2482
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2484
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2485
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2488
:return Integer, expanded to its base-10 value if a proper SI unit is
2489
found, None otherwise.
2491
regexp = "^(\\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2492
p = re.compile(regexp, re.IGNORECASE)
2493
m = p.match(unicode_str)
2496
val, _, unit = m.groups()
2500
coeff = _unit_suffixes[unit.upper()]
2502
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2507
def float_from_store(unicode_str):
2508
return float(unicode_str)
2511
# Use an empty dict to initialize an empty configobj avoiding all parsing and
2513
_list_converter_config = configobj.ConfigObj(
2514
{}, encoding='utf-8', list_values=True, interpolation=False)
2517
class ListOption(Option):
2519
def __init__(self, name, default=None, default_from_env=None,
2520
help=None, invalid=None):
2521
"""A list Option definition.
2523
This overrides the base class so the conversion from a unicode string
2524
can take quoting into account.
2526
super(ListOption, self).__init__(
2527
name, default=default, default_from_env=default_from_env,
2528
from_unicode=self.from_unicode, help=help,
2529
invalid=invalid, unquote=False)
2531
def from_unicode(self, unicode_str):
2532
if not isinstance(unicode_str, string_types):
2534
# Now inject our string directly as unicode. All callers got their
2535
# value from configobj, so values that need to be quoted are already
2537
_list_converter_config.reset()
2538
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2539
maybe_list = _list_converter_config['list']
2540
if isinstance(maybe_list, string_types):
2542
# A single value, most probably the user forgot (or didn't care
2543
# to add) the final ','
2546
# The empty string, convert to empty list
2549
# We rely on ConfigObj providing us with a list already
2554
class RegistryOption(Option):
2555
"""Option for a choice from a registry."""
2557
def __init__(self, name, registry, default_from_env=None,
2558
help=None, invalid=None):
2559
"""A registry based Option definition.
2561
This overrides the base class so the conversion from a unicode string
2562
can take quoting into account.
2564
super(RegistryOption, self).__init__(
2565
name, default=lambda: registry.default_key,
2566
default_from_env=default_from_env,
2567
from_unicode=self.from_unicode, help=help,
2568
invalid=invalid, unquote=False)
2569
self.registry = registry
2571
def from_unicode(self, unicode_str):
2572
if not isinstance(unicode_str, string_types):
2575
return self.registry.get(unicode_str)
2578
"Invalid value %s for %s."
2579
"See help for a list of possible values." % (unicode_str,
2584
ret = [self._help, "\n\nThe following values are supported:\n"]
2585
for key in self.registry.keys():
2586
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2590
_option_ref_re = lazy_regex.lazy_compile('({[^\\d\\W](?:\\.\\w|-\\w|\\w)*})')
2591
"""Describes an expandable option reference.
2593
We want to match the most embedded reference first.
2595
I.e. for '{{foo}}' we will get '{foo}',
2596
for '{bar{baz}}' we will get '{baz}'
2599
def iter_option_refs(string):
2600
# Split isolate refs so every other chunk is a ref
2602
for chunk in _option_ref_re.split(string):
2607
class OptionRegistry(registry.Registry):
2608
"""Register config options by their name.
2610
This overrides ``registry.Registry`` to simplify registration by acquiring
2611
some information from the option object itself.
2614
def _check_option_name(self, option_name):
2615
"""Ensures an option name is valid.
2617
:param option_name: The name to validate.
2619
if _option_ref_re.match('{%s}' % option_name) is None:
2620
raise IllegalOptionName(option_name)
2622
def register(self, option):
2623
"""Register a new option to its name.
2625
:param option: The option to register. Its name is used as the key.
2627
self._check_option_name(option.name)
2628
super(OptionRegistry, self).register(option.name, option,
2631
def register_lazy(self, key, module_name, member_name):
2632
"""Register a new option to be loaded on request.
2634
:param key: the key to request the option later. Since the registration
2635
is lazy, it should be provided and match the option name.
2637
:param module_name: the python path to the module. Such as 'os.path'.
2639
:param member_name: the member of the module to return. If empty or
2640
None, get() will return the module itself.
2642
self._check_option_name(key)
2643
super(OptionRegistry, self).register_lazy(key,
2644
module_name, member_name)
2646
def get_help(self, key=None):
2647
"""Get the help text associated with the given key"""
2648
option = self.get(key)
2649
the_help = option.help
2650
if callable(the_help):
2651
return the_help(self, key)
2655
option_registry = OptionRegistry()
2658
# Registered options in lexicographical order
2660
option_registry.register(
2661
Option('append_revisions_only',
2662
default=None, from_unicode=bool_from_store, invalid='warning',
2664
Whether to only append revisions to the mainline.
2666
If this is set to true, then it is not possible to change the
2667
existing mainline of the branch.
2669
option_registry.register(
2670
ListOption('acceptable_keys',
2673
List of GPG key patterns which are acceptable for verification.
2675
option_registry.register(
2676
Option('add.maximum_file_size',
2677
default=u'20MB', from_unicode=int_SI_from_store,
2679
Size above which files should be added manually.
2681
Files below this size are added automatically when using ``bzr add`` without
2684
A negative value means disable the size check.
2686
option_registry.register(
2688
default=None, from_unicode=bool_from_store,
2690
Is the branch bound to ``bound_location``.
2692
If set to "True", the branch should act as a checkout, and push each commit to
2693
the bound_location. This option is normally set by ``bind``/``unbind``.
2695
See also: bound_location.
2697
option_registry.register(
2698
Option('bound_location',
2701
The location that commits should go to when acting as a checkout.
2703
This option is normally set by ``bind``.
2707
option_registry.register(
2708
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2710
Whether revisions associated with tags should be fetched.
2712
option_registry.register_lazy(
2713
'transform.orphan_policy', 'breezy.transform', 'opt_transform_orphan')
2714
option_registry.register(
2715
Option('bzr.workingtree.worth_saving_limit', default=10,
2716
from_unicode=int_from_store, invalid='warning',
2718
How many changes before saving the dirstate.
2720
-1 means that we will never rewrite the dirstate file for only
2721
stat-cache changes. Regardless of this setting, we will always rewrite
2722
the dirstate file if a file is added/removed/renamed/etc. This flag only
2723
affects the behavior of updating the dirstate file after we notice that
2724
a file has been touched.
2726
option_registry.register(
2727
Option('bugtracker', default=None,
2729
Default bug tracker to use.
2731
This bug tracker will be used for example when marking bugs
2732
as fixed using ``bzr commit --fixes``, if no explicit
2733
bug tracker was specified.
2735
option_registry.register(
2736
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2737
from_unicode=signature_policy_from_unicode,
2739
GPG checking policy.
2741
Possible values: require, ignore, check-available (default)
2743
this option will control whether bzr will require good gpg
2744
signatures, ignore them, or check them if they are
2747
option_registry.register(
2748
Option('child_submit_format',
2749
help='''The preferred format of submissions to this branch.'''))
2750
option_registry.register(
2751
Option('child_submit_to',
2752
help='''Where submissions to this branch are mailed to.'''))
2753
option_registry.register(
2754
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2755
from_unicode=signing_policy_from_unicode,
2759
Possible values: always, never, when-required (default)
2761
This option controls whether bzr will always create
2762
gpg signatures or not on commits.
2764
option_registry.register(
2765
Option('dirstate.fdatasync', default=True,
2766
from_unicode=bool_from_store,
2768
Flush dirstate changes onto physical disk?
2770
If true (default), working tree metadata changes are flushed through the
2771
OS buffers to physical disk. This is somewhat slower, but means data
2772
should not be lost if the machine crashes. See also repository.fdatasync.
2774
option_registry.register(
2775
ListOption('debug_flags', default=[],
2776
help='Debug flags to activate.'))
2777
option_registry.register(
2778
Option('default_format', default='2a',
2779
help='Format used when creating branches.'))
2780
option_registry.register(
2781
Option('dpush_strict', default=None,
2782
from_unicode=bool_from_store,
2784
The default value for ``dpush --strict``.
2786
If present, defines the ``--strict`` option default value for checking
2787
uncommitted changes before pushing into a different VCS without any
2788
custom bzr metadata.
2790
option_registry.register(
2792
help='The command called to launch an editor to enter a message.'))
2793
option_registry.register(
2794
Option('email', override_from_env=['BRZ_EMAIL'], default=default_email,
2795
help='The users identity'))
2796
option_registry.register(
2797
Option('gpg_signing_key',
2800
GPG key to use for signing.
2802
This defaults to the first key associated with the users email.
2804
option_registry.register(
2806
help='Language to translate messages into.'))
2807
option_registry.register(
2808
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2810
Steal locks that appears to be dead.
2812
If set to True, bzr will check if a lock is supposed to be held by an
2813
active process from the same user on the same machine. If the user and
2814
machine match, but no process with the given PID is active, then bzr
2815
will automatically break the stale lock, and create a new lock for
2817
Otherwise, bzr will prompt as normal to break the lock.
2819
option_registry.register(
2820
Option('log_format', default='long',
2822
Log format to use when displaying revisions.
2824
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2825
may be provided by plugins.
2827
option_registry.register_lazy('mail_client', 'breezy.mail_client',
2829
option_registry.register(
2830
Option('output_encoding',
2831
help= 'Unicode encoding for output'
2832
' (terminal encoding if not specified).'))
2833
option_registry.register(
2834
Option('parent_location',
2837
The location of the default branch for pull or merge.
2839
This option is normally set when creating a branch, the first ``pull`` or by
2840
``pull --remember``.
2842
option_registry.register(
2843
Option('post_commit', default=None,
2845
Post commit functions.
2847
An ordered list of python functions to call, separated by spaces.
2849
Each function takes branch, rev_id as parameters.
2851
option_registry.register_lazy('progress_bar', 'breezy.ui.text',
2853
option_registry.register(
2854
Option('public_branch',
2857
A publically-accessible version of this branch.
2859
This implies that the branch setting this option is not publically-accessible.
2860
Used and set by ``bzr send``.
2862
option_registry.register(
2863
Option('push_location',
2866
The location of the default branch for push.
2868
This option is normally set by the first ``push`` or ``push --remember``.
2870
option_registry.register(
2871
Option('push_strict', default=None,
2872
from_unicode=bool_from_store,
2874
The default value for ``push --strict``.
2876
If present, defines the ``--strict`` option default value for checking
2877
uncommitted changes before sending a merge directive.
2879
option_registry.register(
2880
Option('repository.fdatasync', default=True,
2881
from_unicode=bool_from_store,
2883
Flush repository changes onto physical disk?
2885
If true (default), repository changes are flushed through the OS buffers
2886
to physical disk. This is somewhat slower, but means data should not be
2887
lost if the machine crashes. See also dirstate.fdatasync.
2889
option_registry.register_lazy('smtp_server',
2890
'breezy.smtp_connection', 'smtp_server')
2891
option_registry.register_lazy('smtp_password',
2892
'breezy.smtp_connection', 'smtp_password')
2893
option_registry.register_lazy('smtp_username',
2894
'breezy.smtp_connection', 'smtp_username')
2895
option_registry.register(
2896
Option('selftest.timeout',
2898
from_unicode=int_from_store,
2899
help='Abort selftest if one test takes longer than this many seconds',
2902
option_registry.register(
2903
Option('send_strict', default=None,
2904
from_unicode=bool_from_store,
2906
The default value for ``send --strict``.
2908
If present, defines the ``--strict`` option default value for checking
2909
uncommitted changes before sending a bundle.
2912
option_registry.register(
2913
Option('serve.client_timeout',
2914
default=300.0, from_unicode=float_from_store,
2915
help="If we wait for a new request from a client for more than"
2916
" X seconds, consider the client idle, and hangup."))
2917
option_registry.register(
2918
Option('stacked_on_location',
2920
help="""The location where this branch is stacked on."""))
2921
option_registry.register(
2922
Option('submit_branch',
2925
The branch you intend to submit your current work to.
2927
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2928
by the ``submit:`` revision spec.
2930
option_registry.register(
2932
help='''Where submissions from this branch are mailed to.'''))
2933
option_registry.register(
2934
ListOption('suppress_warnings',
2936
help="List of warning classes to suppress."))
2937
option_registry.register(
2938
Option('validate_signatures_in_log', default=False,
2939
from_unicode=bool_from_store, invalid='warning',
2940
help='''Whether to validate signatures in brz log.'''))
2941
option_registry.register_lazy('ssl.ca_certs',
2942
'breezy.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2944
option_registry.register_lazy('ssl.cert_reqs',
2945
'breezy.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2948
class Section(object):
2949
"""A section defines a dict of option name => value.
2951
This is merely a read-only dict which can add some knowledge about the
2952
options. It is *not* a python dict object though and doesn't try to mimic
2956
def __init__(self, section_id, options):
2957
self.id = section_id
2958
# We re-use the dict-like object received
2959
self.options = options
2961
def get(self, name, default=None, expand=True):
2962
return self.options.get(name, default)
2964
def iter_option_names(self):
2965
for k in self.options.keys():
2969
# Mostly for debugging use
2970
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2973
_NewlyCreatedOption = object()
2974
"""Was the option created during the MutableSection lifetime"""
2975
_DeletedOption = object()
2976
"""Was the option deleted during the MutableSection lifetime"""
2979
class MutableSection(Section):
2980
"""A section allowing changes and keeping track of the original values."""
2982
def __init__(self, section_id, options):
2983
super(MutableSection, self).__init__(section_id, options)
2984
self.reset_changes()
2986
def set(self, name, value):
2987
if name not in self.options:
2988
# This is a new option
2989
self.orig[name] = _NewlyCreatedOption
2990
elif name not in self.orig:
2991
self.orig[name] = self.get(name, None)
2992
self.options[name] = value
2994
def remove(self, name):
2995
if name not in self.orig and name in self.options:
2996
self.orig[name] = self.get(name, None)
2997
del self.options[name]
2999
def reset_changes(self):
3002
def apply_changes(self, dirty, store):
3003
"""Apply option value changes.
3005
``self`` has been reloaded from the persistent storage. ``dirty``
3006
contains the changes made since the previous loading.
3008
:param dirty: the mutable section containing the changes.
3010
:param store: the store containing the section
3012
for k, expected in dirty.orig.items():
3013
actual = dirty.get(k, _DeletedOption)
3014
reloaded = self.get(k, _NewlyCreatedOption)
3015
if actual is _DeletedOption:
3016
if k in self.options:
3020
# Report concurrent updates in an ad-hoc way. This should only
3021
# occurs when different processes try to update the same option
3022
# which is not supported (as in: the config framework is not meant
3023
# to be used as a sharing mechanism).
3024
if expected != reloaded:
3025
if actual is _DeletedOption:
3026
actual = '<DELETED>'
3027
if reloaded is _NewlyCreatedOption:
3028
reloaded = '<CREATED>'
3029
if expected is _NewlyCreatedOption:
3030
expected = '<CREATED>'
3031
# Someone changed the value since we get it from the persistent
3033
trace.warning(gettext(
3034
"Option {0} in section {1} of {2} was changed"
3035
" from {3} to {4}. The {5} value will be saved.".format(
3036
k, self.id, store.external_url(), expected,
3038
# No need to keep track of these changes
3039
self.reset_changes()
3042
class Store(object):
3043
"""Abstract interface to persistent storage for configuration options."""
3045
readonly_section_class = Section
3046
mutable_section_class = MutableSection
3049
# Which sections need to be saved (by section id). We use a dict here
3050
# so the dirty sections can be shared by multiple callers.
3051
self.dirty_sections = {}
3053
def is_loaded(self):
3054
"""Returns True if the Store has been loaded.
3056
This is used to implement lazy loading and ensure the persistent
3057
storage is queried only when needed.
3059
raise NotImplementedError(self.is_loaded)
3062
"""Loads the Store from persistent storage."""
3063
raise NotImplementedError(self.load)
3065
def _load_from_string(self, bytes):
3066
"""Create a store from a string in configobj syntax.
3068
:param bytes: A string representing the file content.
3070
raise NotImplementedError(self._load_from_string)
3073
"""Unloads the Store.
3075
This should make is_loaded() return False. This is used when the caller
3076
knows that the persistent storage has changed or may have change since
3079
raise NotImplementedError(self.unload)
3081
def quote(self, value):
3082
"""Quote a configuration option value for storing purposes.
3084
This allows Stacks to present values as they will be stored.
3088
def unquote(self, value):
3089
"""Unquote a configuration option value into unicode.
3091
The received value is quoted as stored.
3096
"""Saves the Store to persistent storage."""
3097
raise NotImplementedError(self.save)
3099
def _need_saving(self):
3100
for s in self.dirty_sections.values():
3102
# At least one dirty section contains a modification
3106
def apply_changes(self, dirty_sections):
3107
"""Apply changes from dirty sections while checking for coherency.
3109
The Store content is discarded and reloaded from persistent storage to
3110
acquire up-to-date values.
3112
Dirty sections are MutableSection which kept track of the value they
3113
are expected to update.
3115
# We need an up-to-date version from the persistent storage, unload the
3116
# store. The reload will occur when needed (triggered by the first
3117
# get_mutable_section() call below.
3119
# Apply the changes from the preserved dirty sections
3120
for section_id, dirty in dirty_sections.items():
3121
clean = self.get_mutable_section(section_id)
3122
clean.apply_changes(dirty, self)
3123
# Everything is clean now
3124
self.dirty_sections = {}
3126
def save_changes(self):
3127
"""Saves the Store to persistent storage if changes occurred.
3129
Apply the changes recorded in the mutable sections to a store content
3130
refreshed from persistent storage.
3132
raise NotImplementedError(self.save_changes)
3134
def external_url(self):
3135
raise NotImplementedError(self.external_url)
3137
def get_sections(self):
3138
"""Returns an ordered iterable of existing sections.
3140
:returns: An iterable of (store, section).
3142
raise NotImplementedError(self.get_sections)
3144
def get_mutable_section(self, section_id=None):
3145
"""Returns the specified mutable section.
3147
:param section_id: The section identifier
3149
raise NotImplementedError(self.get_mutable_section)
3152
# Mostly for debugging use
3153
return "<config.%s(%s)>" % (self.__class__.__name__,
3154
self.external_url())
3157
class CommandLineStore(Store):
3158
"A store to carry command line overrides for the config options."""
3160
def __init__(self, opts=None):
3161
super(CommandLineStore, self).__init__()
3168
# The dict should be cleared but not replaced so it can be shared.
3169
self.options.clear()
3171
def _from_cmdline(self, overrides):
3172
# Reset before accepting new definitions
3174
for over in overrides:
3176
name, value = over.split('=', 1)
3178
raise errors.BzrCommandError(
3179
gettext("Invalid '%s', should be of the form 'name=value'")
3181
self.options[name] = value
3183
def external_url(self):
3184
# Not an url but it makes debugging easier and is never needed
3188
def get_sections(self):
3189
yield self, self.readonly_section_class(None, self.options)
3192
class IniFileStore(Store):
3193
"""A config Store using ConfigObj for storage.
3195
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3196
serialize/deserialize the config file.
3200
"""A config Store using ConfigObj for storage.
3202
super(IniFileStore, self).__init__()
3203
self._config_obj = None
3205
def is_loaded(self):
3206
return self._config_obj != None
3209
self._config_obj = None
3210
self.dirty_sections = {}
3212
def _load_content(self):
3213
"""Load the config file bytes.
3215
This should be provided by subclasses
3217
:return: Byte string
3219
raise NotImplementedError(self._load_content)
3221
def _save_content(self, content):
3222
"""Save the config file bytes.
3224
This should be provided by subclasses
3226
:param content: Config file bytes to write
3228
raise NotImplementedError(self._save_content)
3231
"""Load the store from the associated file."""
3232
if self.is_loaded():
3234
content = self._load_content()
3235
self._load_from_string(content)
3236
for hook in ConfigHooks['load']:
3239
def _load_from_string(self, bytes):
3240
"""Create a config store from a string.
3242
:param bytes: A string representing the file content.
3244
if self.is_loaded():
3245
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3246
co_input = BytesIO(bytes)
3248
# The config files are always stored utf8-encoded
3249
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3251
except configobj.ConfigObjError as e:
3252
self._config_obj = None
3253
raise ParseConfigError(e.errors, self.external_url())
3254
except UnicodeDecodeError:
3255
raise ConfigContentError(self.external_url())
3257
def save_changes(self):
3258
if not self.is_loaded():
3261
if not self._need_saving():
3263
# Preserve the current version
3264
dirty_sections = self.dirty_sections.copy()
3265
self.apply_changes(dirty_sections)
3266
# Save to the persistent storage
3270
if not self.is_loaded():
3274
self._config_obj.write(out)
3275
self._save_content(out.getvalue())
3276
for hook in ConfigHooks['save']:
3279
def get_sections(self):
3280
"""Get the configobj section in the file order.
3282
:returns: An iterable of (store, section).
3284
# We need a loaded store
3287
except (errors.NoSuchFile, errors.PermissionDenied):
3288
# If the file can't be read, there is no sections
3290
cobj = self._config_obj
3292
yield self, self.readonly_section_class(None, cobj)
3293
for section_name in cobj.sections:
3295
self.readonly_section_class(section_name,
3296
cobj[section_name]))
3298
def get_mutable_section(self, section_id=None):
3299
# We need a loaded store
3302
except errors.NoSuchFile:
3303
# The file doesn't exist, let's pretend it was empty
3304
self._load_from_string(b'')
3305
if section_id in self.dirty_sections:
3306
# We already created a mutable section for this id
3307
return self.dirty_sections[section_id]
3308
if section_id is None:
3309
section = self._config_obj
3311
section = self._config_obj.setdefault(section_id, {})
3312
mutable_section = self.mutable_section_class(section_id, section)
3313
# All mutable sections can become dirty
3314
self.dirty_sections[section_id] = mutable_section
3315
return mutable_section
3317
def quote(self, value):
3319
# configobj conflates automagical list values and quoting
3320
self._config_obj.list_values = True
3321
return self._config_obj._quote(value)
3323
self._config_obj.list_values = False
3325
def unquote(self, value):
3326
if value and isinstance(value, string_types):
3327
# _unquote doesn't handle None nor empty strings nor anything that
3328
# is not a string, really.
3329
value = self._config_obj._unquote(value)
3332
def external_url(self):
3333
# Since an IniFileStore can be used without a file (at least in tests),
3334
# it's better to provide something than raising a NotImplementedError.
3335
# All daughter classes are supposed to provide an implementation
3337
return 'In-Process Store, no URL'
3340
class TransportIniFileStore(IniFileStore):
3341
"""IniFileStore that loads files from a transport.
3343
:ivar transport: The transport object where the config file is located.
3345
:ivar file_name: The config file basename in the transport directory.
3348
def __init__(self, transport, file_name):
3349
"""A Store using a ini file on a Transport
3351
:param transport: The transport object where the config file is located.
3352
:param file_name: The config file basename in the transport directory.
3354
super(TransportIniFileStore, self).__init__()
3355
self.transport = transport
3356
self.file_name = file_name
3358
def _load_content(self):
3360
return self.transport.get_bytes(self.file_name)
3361
except errors.PermissionDenied:
3362
trace.warning("Permission denied while trying to load "
3363
"configuration store %s.", self.external_url())
3366
def _save_content(self, content):
3367
self.transport.put_bytes(self.file_name, content)
3369
def external_url(self):
3370
# FIXME: external_url should really accepts an optional relpath
3371
# parameter (bug #750169) :-/ -- vila 2011-04-04
3372
# The following will do in the interim but maybe we don't want to
3373
# expose a path here but rather a config ID and its associated
3374
# object </hand wawe>.
3375
return urlutils.join(
3376
self.transport.external_url(), urlutils.escape(self.file_name))
3379
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3380
# unlockable stores for use with objects that can already ensure the locking
3381
# (think branches). If different stores (not based on ConfigObj) are created,
3382
# they may face the same issue.
3385
class LockableIniFileStore(TransportIniFileStore):
3386
"""A ConfigObjStore using locks on save to ensure store integrity."""
3388
def __init__(self, transport, file_name, lock_dir_name=None):
3389
"""A config Store using ConfigObj for storage.
3391
:param transport: The transport object where the config file is located.
3393
:param file_name: The config file basename in the transport directory.
3395
if lock_dir_name is None:
3396
lock_dir_name = 'lock'
3397
self.lock_dir_name = lock_dir_name
3398
super(LockableIniFileStore, self).__init__(transport, file_name)
3399
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3401
def lock_write(self, token=None):
3402
"""Takes a write lock in the directory containing the config file.
3404
If the directory doesn't exist it is created.
3406
# FIXME: This doesn't check the ownership of the created directories as
3407
# ensure_config_dir_exists does. It should if the transport is local
3408
# -- vila 2011-04-06
3409
self.transport.create_prefix()
3410
token = self._lock.lock_write(token)
3411
return lock.LogicalLockResult(self.unlock, token)
3416
def break_lock(self):
3417
self._lock.break_lock()
3420
with self.lock_write():
3421
# We need to be able to override the undecorated implementation
3422
self.save_without_locking()
3424
def save_without_locking(self):
3425
super(LockableIniFileStore, self).save()
3428
# FIXME: global, breezy, shouldn't that be 'user' instead or even
3429
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3430
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3432
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3433
# functions or a registry will make it easier and clearer for tests, focusing
3434
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3435
# on a poolie's remark)
3436
class GlobalStore(LockableIniFileStore):
3437
"""A config store for global options.
3439
There is a single GlobalStore for a given process.
3442
def __init__(self, possible_transports=None):
3443
(path, kind) = _config_dir()
3444
t = transport.get_transport_from_path(
3445
path, possible_transports=possible_transports)
3446
filename = {'bazaar': 'bazaar.conf', 'breezy': 'breezy.conf'}[kind]
3447
super(GlobalStore, self).__init__(t, filename)
3451
class LocationStore(LockableIniFileStore):
3452
"""A config store for options specific to a location.
3454
There is a single LocationStore for a given process.
3457
def __init__(self, possible_transports=None):
3458
t = transport.get_transport_from_path(
3459
config_dir(), possible_transports=possible_transports)
3460
super(LocationStore, self).__init__(t, 'locations.conf')
3461
self.id = 'locations'
3464
class BranchStore(TransportIniFileStore):
3465
"""A config store for branch options.
3467
There is a single BranchStore for a given branch.
3470
def __init__(self, branch):
3471
super(BranchStore, self).__init__(branch.control_transport,
3473
self.branch = branch
3477
class ControlStore(LockableIniFileStore):
3479
def __init__(self, bzrdir):
3480
super(ControlStore, self).__init__(bzrdir.transport,
3482
lock_dir_name='branch_lock')
3486
class SectionMatcher(object):
3487
"""Select sections into a given Store.
3489
This is intended to be used to postpone getting an iterable of sections
3493
def __init__(self, store):
3496
def get_sections(self):
3497
# This is where we require loading the store so we can see all defined
3499
sections = self.store.get_sections()
3500
# Walk the revisions in the order provided
3501
for store, s in sections:
3505
def match(self, section):
3506
"""Does the proposed section match.
3508
:param section: A Section object.
3510
:returns: True if the section matches, False otherwise.
3512
raise NotImplementedError(self.match)
3515
class NameMatcher(SectionMatcher):
3517
def __init__(self, store, section_id):
3518
super(NameMatcher, self).__init__(store)
3519
self.section_id = section_id
3521
def match(self, section):
3522
return section.id == self.section_id
3525
class LocationSection(Section):
3527
def __init__(self, section, extra_path, branch_name=None):
3528
super(LocationSection, self).__init__(section.id, section.options)
3529
self.extra_path = extra_path
3530
if branch_name is None:
3532
self.locals = {'relpath': extra_path,
3533
'basename': urlutils.basename(extra_path),
3534
'branchname': branch_name}
3536
def get(self, name, default=None, expand=True):
3537
value = super(LocationSection, self).get(name, default)
3538
if value is not None and expand:
3539
policy_name = self.get(name + ':policy', None)
3540
policy = _policy_value.get(policy_name, POLICY_NONE)
3541
if policy == POLICY_APPENDPATH:
3542
value = urlutils.join(value, self.extra_path)
3543
# expand section local options right now (since POLICY_APPENDPATH
3544
# will never add options references, it's ok to expand after it).
3546
for is_ref, chunk in iter_option_refs(value):
3548
chunks.append(chunk)
3551
if ref in self.locals:
3552
chunks.append(self.locals[ref])
3554
chunks.append(chunk)
3555
value = ''.join(chunks)
3559
class StartingPathMatcher(SectionMatcher):
3560
"""Select sections for a given location respecting the Store order."""
3562
# FIXME: Both local paths and urls can be used for section names as well as
3563
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3564
# inherited the fuzziness from the previous ``LocationConfig``
3565
# implementation. We probably need to revisit which encoding is allowed for
3566
# both ``location`` and section names and how we normalize
3567
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3568
# related too. -- vila 2012-01-04
3570
def __init__(self, store, location):
3571
super(StartingPathMatcher, self).__init__(store)
3572
if location.startswith('file://'):
3573
location = urlutils.local_path_from_url(location)
3574
self.location = location
3576
def get_sections(self):
3577
"""Get all sections matching ``location`` in the store.
3579
The most generic sections are described first in the store, then more
3580
specific ones can be provided for reduced scopes.
3582
The returned section are therefore returned in the reversed order so
3583
the most specific ones can be found first.
3585
location_parts = self.location.rstrip('/').split('/')
3587
# Later sections are more specific, they should be returned first
3588
for _, section in reversed(list(store.get_sections())):
3589
if section.id is None:
3590
# The no-name section is always included if present
3591
yield store, LocationSection(section, self.location)
3593
section_path = section.id
3594
if section_path.startswith('file://'):
3595
# the location is already a local path or URL, convert the
3596
# section id to the same format
3597
section_path = urlutils.local_path_from_url(section_path)
3598
if (self.location.startswith(section_path)
3599
or fnmatch.fnmatch(self.location, section_path)):
3600
section_parts = section_path.rstrip('/').split('/')
3601
extra_path = '/'.join(location_parts[len(section_parts):])
3602
yield store, LocationSection(section, extra_path)
3605
class LocationMatcher(SectionMatcher):
3607
def __init__(self, store, location):
3608
super(LocationMatcher, self).__init__(store)
3609
url, params = urlutils.split_segment_parameters(location)
3610
if location.startswith('file://'):
3611
location = urlutils.local_path_from_url(location)
3612
self.location = location
3613
branch_name = params.get('branch')
3614
if branch_name is None:
3615
self.branch_name = urlutils.basename(self.location)
3617
self.branch_name = urlutils.unescape(branch_name)
3619
def _get_matching_sections(self):
3620
"""Get all sections matching ``location``."""
3621
# We slightly diverge from LocalConfig here by allowing the no-name
3622
# section as the most generic one and the lower priority.
3623
no_name_section = None
3625
# Filter out the no_name_section so _iter_for_location_by_parts can be
3626
# used (it assumes all sections have a name).
3627
for _, section in self.store.get_sections():
3628
if section.id is None:
3629
no_name_section = section
3631
all_sections.append(section)
3632
# Unfortunately _iter_for_location_by_parts deals with section names so
3633
# we have to resync.
3634
filtered_sections = _iter_for_location_by_parts(
3635
[s.id for s in all_sections], self.location)
3636
iter_all_sections = iter(all_sections)
3637
matching_sections = []
3638
if no_name_section is not None:
3639
matching_sections.append(
3640
(0, LocationSection(no_name_section, self.location)))
3641
for section_id, extra_path, length in filtered_sections:
3642
# a section id is unique for a given store so it's safe to take the
3643
# first matching section while iterating. Also, all filtered
3644
# sections are part of 'all_sections' and will always be found
3647
section = next(iter_all_sections)
3648
if section_id == section.id:
3649
section = LocationSection(section, extra_path,
3651
matching_sections.append((length, section))
3653
return matching_sections
3655
def get_sections(self):
3656
# Override the default implementation as we want to change the order
3657
# We want the longest (aka more specific) locations first
3658
sections = sorted(self._get_matching_sections(),
3659
key=lambda match: (match[0], match[1].id),
3661
# Sections mentioning 'ignore_parents' restrict the selection
3662
for _, section in sections:
3663
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3664
ignore = section.get('ignore_parents', None)
3665
if ignore is not None:
3666
ignore = ui.bool_from_string(ignore)
3669
# Finally, we have a valid section
3670
yield self.store, section
3673
# FIXME: _shared_stores should be an attribute of a library state once a
3674
# library_state object is always available.
3676
_shared_stores_at_exit_installed = False
3678
class Stack(object):
3679
"""A stack of configurations where an option can be defined"""
3681
def __init__(self, sections_def, store=None, mutable_section_id=None):
3682
"""Creates a stack of sections with an optional store for changes.
3684
:param sections_def: A list of Section or callables that returns an
3685
iterable of Section. This defines the Sections for the Stack and
3686
can be called repeatedly if needed.
3688
:param store: The optional Store where modifications will be
3689
recorded. If none is specified, no modifications can be done.
3691
:param mutable_section_id: The id of the MutableSection where changes
3692
are recorded. This requires the ``store`` parameter to be
3695
self.sections_def = sections_def
3697
self.mutable_section_id = mutable_section_id
3699
def iter_sections(self):
3700
"""Iterate all the defined sections."""
3701
# Ensuring lazy loading is achieved by delaying section matching (which
3702
# implies querying the persistent storage) until it can't be avoided
3703
# anymore by using callables to describe (possibly empty) section
3705
for sections in self.sections_def:
3706
for store, section in sections():
3707
yield store, section
3709
def get(self, name, expand=True, convert=True):
3710
"""Return the *first* option value found in the sections.
3712
This is where we guarantee that sections coming from Store are loaded
3713
lazily: the loading is delayed until we need to either check that an
3714
option exists or get its value, which in turn may require to discover
3715
in which sections it can be defined. Both of these (section and option
3716
existence) require loading the store (even partially).
3718
:param name: The queried option.
3720
:param expand: Whether options references should be expanded.
3722
:param convert: Whether the option value should be converted from
3723
unicode (do nothing for non-registered options).
3725
:returns: The value of the option.
3727
# FIXME: No caching of options nor sections yet -- vila 20110503
3729
found_store = None # Where the option value has been found
3730
# If the option is registered, it may provide additional info about
3733
opt = option_registry.get(name)
3738
def expand_and_convert(val):
3739
# This may need to be called in different contexts if the value is
3740
# None or ends up being None during expansion or conversion.
3743
if isinstance(val, string_types):
3744
val = self._expand_options_in_string(val)
3746
trace.warning('Cannot expand "%s":'
3747
' %s does not support option expansion'
3748
% (name, type(val)))
3750
val = found_store.unquote(val)
3752
val = opt.convert_from_unicode(found_store, val)
3755
# First of all, check if the environment can override the configuration
3757
if opt is not None and opt.override_from_env:
3758
value = opt.get_override()
3759
value = expand_and_convert(value)
3761
for store, section in self.iter_sections():
3762
value = section.get(name)
3763
if value is not None:
3766
value = expand_and_convert(value)
3767
if opt is not None and value is None:
3768
# If the option is registered, it may provide a default value
3769
value = opt.get_default()
3770
value = expand_and_convert(value)
3771
for hook in ConfigHooks['get']:
3772
hook(self, name, value)
3775
def expand_options(self, string, env=None):
3776
"""Expand option references in the string in the configuration context.
3778
:param string: The string containing option(s) to expand.
3780
:param env: An option dict defining additional configuration options or
3781
overriding existing ones.
3783
:returns: The expanded string.
3785
return self._expand_options_in_string(string, env)
3787
def _expand_options_in_string(self, string, env=None, _refs=None):
3788
"""Expand options in the string in the configuration context.
3790
:param string: The string to be expanded.
3792
:param env: An option dict defining additional configuration options or
3793
overriding existing ones.
3795
:param _refs: Private list (FIFO) containing the options being expanded
3798
:returns: The expanded string.
3801
# Not much to expand there
3804
# What references are currently resolved (to detect loops)
3807
# We need to iterate until no more refs appear ({{foo}} will need two
3808
# iterations for example).
3813
for is_ref, chunk in iter_option_refs(result):
3815
chunks.append(chunk)
3820
raise OptionExpansionLoop(string, _refs)
3822
value = self._expand_option(name, env, _refs)
3824
raise ExpandingUnknownOption(name, string)
3825
chunks.append(value)
3827
result = ''.join(chunks)
3830
def _expand_option(self, name, env, _refs):
3831
if env is not None and name in env:
3832
# Special case, values provided in env takes precedence over
3836
value = self.get(name, expand=False, convert=False)
3837
value = self._expand_options_in_string(value, env, _refs)
3840
def _get_mutable_section(self):
3841
"""Get the MutableSection for the Stack.
3843
This is where we guarantee that the mutable section is lazily loaded:
3844
this means we won't load the corresponding store before setting a value
3845
or deleting an option. In practice the store will often be loaded but
3846
this helps catching some programming errors.
3849
section = store.get_mutable_section(self.mutable_section_id)
3850
return store, section
3852
def set(self, name, value):
3853
"""Set a new value for the option."""
3854
store, section = self._get_mutable_section()
3855
section.set(name, store.quote(value))
3856
for hook in ConfigHooks['set']:
3857
hook(self, name, value)
3859
def remove(self, name):
3860
"""Remove an existing option."""
3861
_, section = self._get_mutable_section()
3862
section.remove(name)
3863
for hook in ConfigHooks['remove']:
3867
# Mostly for debugging use
3868
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3870
def _get_overrides(self):
3871
if breezy._global_state is not None:
3872
# TODO(jelmer): Urgh, this is circular so we can't call breezy.get_global_state()
3873
return breezy._global_state.cmdline_overrides.get_sections()
3876
def get_shared_store(self, store, state=None):
3877
"""Get a known shared store.
3879
Store urls uniquely identify them and are used to ensure a single copy
3880
is shared across all users.
3882
:param store: The store known to the caller.
3884
:param state: The library state where the known stores are kept.
3886
:returns: The store received if it's not a known one, an already known
3890
# TODO(jelmer): Urgh, this is circular so we can't call breezy.get_global_state()
3891
state = breezy._global_state
3893
global _shared_stores_at_exit_installed
3894
stores = _shared_stores
3895
def save_config_changes():
3896
for k, store in stores.items():
3897
store.save_changes()
3898
if not _shared_stores_at_exit_installed:
3899
# FIXME: Ugly hack waiting for library_state to always be
3900
# available. -- vila 20120731
3902
atexit.register(save_config_changes)
3903
_shared_stores_at_exit_installed = True
3905
stores = state.config_stores
3906
url = store.external_url()
3914
class MemoryStack(Stack):
3915
"""A configuration stack defined from a string.
3917
This is mainly intended for tests and requires no disk resources.
3920
def __init__(self, content=None):
3921
"""Create an in-memory stack from a given content.
3923
It uses a single store based on configobj and support reading and
3926
:param content: The initial content of the store. If None, the store is
3927
not loaded and ``_load_from_string`` can and should be used if
3930
store = IniFileStore()
3931
if content is not None:
3932
store._load_from_string(content)
3933
super(MemoryStack, self).__init__(
3934
[store.get_sections], store)
3937
class _CompatibleStack(Stack):
3938
"""Place holder for compatibility with previous design.
3940
This is intended to ease the transition from the Config-based design to the
3941
Stack-based design and should not be used nor relied upon by plugins.
3943
One assumption made here is that the daughter classes will all use Stores
3944
derived from LockableIniFileStore).
3946
It implements set() and remove () by re-loading the store before applying
3947
the modification and saving it.
3949
The long term plan being to implement a single write by store to save
3950
all modifications, this class should not be used in the interim.
3953
def set(self, name, value):
3956
super(_CompatibleStack, self).set(name, value)
3957
# Force a write to persistent storage
3960
def remove(self, name):
3963
super(_CompatibleStack, self).remove(name)
3964
# Force a write to persistent storage
3968
class GlobalStack(Stack):
3969
"""Global options only stack.
3971
The following sections are queried:
3973
* command-line overrides,
3975
* the 'DEFAULT' section in bazaar.conf
3977
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3982
gstore = self.get_shared_store(GlobalStore())
3983
super(GlobalStack, self).__init__(
3984
[self._get_overrides,
3985
NameMatcher(gstore, 'DEFAULT').get_sections],
3986
gstore, mutable_section_id='DEFAULT')
3989
class LocationStack(Stack):
3990
"""Per-location options falling back to global options stack.
3993
The following sections are queried:
3995
* command-line overrides,
3997
* the sections matching ``location`` in ``locations.conf``, the order being
3998
defined by the number of path components in the section glob, higher
3999
numbers first (from most specific section to most generic).
4001
* the 'DEFAULT' section in bazaar.conf
4003
This stack will use the ``location`` section in locations.conf as its
4007
def __init__(self, location):
4008
"""Make a new stack for a location and global configuration.
4010
:param location: A URL prefix to """
4011
lstore = self.get_shared_store(LocationStore())
4012
if location.startswith('file://'):
4013
location = urlutils.local_path_from_url(location)
4014
gstore = self.get_shared_store(GlobalStore())
4015
super(LocationStack, self).__init__(
4016
[self._get_overrides,
4017
LocationMatcher(lstore, location).get_sections,
4018
NameMatcher(gstore, 'DEFAULT').get_sections],
4019
lstore, mutable_section_id=location)
4022
class BranchStack(Stack):
4023
"""Per-location options falling back to branch then global options stack.
4025
The following sections are queried:
4027
* command-line overrides,
4029
* the sections matching ``location`` in ``locations.conf``, the order being
4030
defined by the number of path components in the section glob, higher
4031
numbers first (from most specific section to most generic),
4033
* the no-name section in branch.conf,
4035
* the ``DEFAULT`` section in ``bazaar.conf``.
4037
This stack will use the no-name section in ``branch.conf`` as its
4041
def __init__(self, branch):
4042
lstore = self.get_shared_store(LocationStore())
4043
bstore = branch._get_config_store()
4044
gstore = self.get_shared_store(GlobalStore())
4045
super(BranchStack, self).__init__(
4046
[self._get_overrides,
4047
LocationMatcher(lstore, branch.base).get_sections,
4048
NameMatcher(bstore, None).get_sections,
4049
NameMatcher(gstore, 'DEFAULT').get_sections],
4051
self.branch = branch
4053
def lock_write(self, token=None):
4054
return self.branch.lock_write(token)
4057
return self.branch.unlock()
4059
def set(self, name, value):
4060
with self.lock_write():
4061
super(BranchStack, self).set(name, value)
4062
# Unlocking the branch will trigger a store.save_changes() so the
4063
# last unlock saves all the changes.
4065
def remove(self, name):
4066
with self.lock_write():
4067
super(BranchStack, self).remove(name)
4068
# Unlocking the branch will trigger a store.save_changes() so the
4069
# last unlock saves all the changes.
4072
class RemoteControlStack(Stack):
4073
"""Remote control-only options stack."""
4075
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
4076
# with the stack used for remote bzr dirs. RemoteControlStack only uses
4077
# control.conf and is used only for stack options.
4079
def __init__(self, bzrdir):
4080
cstore = bzrdir._get_config_store()
4081
super(RemoteControlStack, self).__init__(
4082
[NameMatcher(cstore, None).get_sections],
4084
self.controldir = bzrdir
4087
class BranchOnlyStack(Stack):
4088
"""Branch-only options stack."""
4090
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
4091
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
4092
# -- vila 2011-12-16
4094
def __init__(self, branch):
4095
bstore = branch._get_config_store()
4096
super(BranchOnlyStack, self).__init__(
4097
[NameMatcher(bstore, None).get_sections],
4099
self.branch = branch
4101
def lock_write(self, token=None):
4102
return self.branch.lock_write(token)
4105
return self.branch.unlock()
4107
def set(self, name, value):
4108
with self.lock_write():
4109
super(BranchOnlyStack, self).set(name, value)
4110
# Force a write to persistent storage
4111
self.store.save_changes()
4113
def remove(self, name):
4114
with self.lock_write():
4115
super(BranchOnlyStack, self).remove(name)
4116
# Force a write to persistent storage
4117
self.store.save_changes()
4120
class cmd_config(commands.Command):
4121
__doc__ = """Display, set or remove a configuration option.
4123
Display the active value for option NAME.
4125
If --all is specified, NAME is interpreted as a regular expression and all
4126
matching options are displayed mentioning their scope and without resolving
4127
option references in the value). The active value that bzr will take into
4128
account is the first one displayed for each option.
4130
If NAME is not given, --all .* is implied (all options are displayed for the
4133
Setting a value is achieved by using NAME=value without spaces. The value
4134
is set in the most relevant scope and can be checked by displaying the
4137
Removing a value is achieved by using --remove NAME.
4140
takes_args = ['name?']
4144
# FIXME: This should be a registry option so that plugins can register
4145
# their own config files (or not) and will also address
4146
# http://pad.lv/788991 -- vila 20101115
4147
commands.Option('scope', help='Reduce the scope to the specified'
4148
' configuration file.',
4150
commands.Option('all',
4151
help='Display all the defined values for the matching options.',
4153
commands.Option('remove', help='Remove the option from'
4154
' the configuration file.'),
4157
_see_also = ['configuration']
4159
@commands.display_command
4160
def run(self, name=None, all=False, directory=None, scope=None,
4162
if directory is None:
4164
directory = directory_service.directories.dereference(directory)
4165
directory = urlutils.normalize_url(directory)
4167
raise errors.BzrError(
4168
'--all and --remove are mutually exclusive.')
4170
# Delete the option in the given scope
4171
self._remove_config_option(name, directory, scope)
4173
# Defaults to all options
4174
self._show_matching_options('.*', directory, scope)
4177
name, value = name.split('=', 1)
4179
# Display the option(s) value(s)
4181
self._show_matching_options(name, directory, scope)
4183
self._show_value(name, directory, scope)
4186
raise errors.BzrError(
4187
'Only one option can be set.')
4188
# Set the option value
4189
self._set_config_option(name, value, directory, scope)
4191
def _get_stack(self, directory, scope=None, write_access=False):
4192
"""Get the configuration stack specified by ``directory`` and ``scope``.
4194
:param directory: Where the configurations are derived from.
4196
:param scope: A specific config to start from.
4198
:param write_access: Whether a write access to the stack will be
4201
# FIXME: scope should allow access to plugin-specific stacks (even
4202
# reduced to the plugin-specific store), related to
4203
# http://pad.lv/788991 -- vila 2011-11-15
4204
if scope is not None:
4205
if scope == 'breezy':
4206
return GlobalStack()
4207
elif scope == 'locations':
4208
return LocationStack(directory)
4209
elif scope == 'branch':
4211
controldir.ControlDir.open_containing_tree_or_branch(
4214
self.add_cleanup(br.lock_write().unlock)
4215
return br.get_config_stack()
4216
raise NoSuchConfig(scope)
4220
controldir.ControlDir.open_containing_tree_or_branch(
4223
self.add_cleanup(br.lock_write().unlock)
4224
return br.get_config_stack()
4225
except errors.NotBranchError:
4226
return LocationStack(directory)
4228
def _quote_multiline(self, value):
4230
value = '"""' + value + '"""'
4233
def _show_value(self, name, directory, scope):
4234
conf = self._get_stack(directory, scope)
4235
value = conf.get(name, expand=True, convert=False)
4236
if value is not None:
4237
# Quote the value appropriately
4238
value = self._quote_multiline(value)
4239
self.outf.write('%s\n' % (value,))
4241
raise NoSuchConfigOption(name)
4243
def _show_matching_options(self, name, directory, scope):
4244
name = lazy_regex.lazy_compile(name)
4245
# We want any error in the regexp to be raised *now* so we need to
4246
# avoid the delay introduced by the lazy regexp. But, we still do
4247
# want the nicer errors raised by lazy_regex.
4248
name._compile_and_collapse()
4251
conf = self._get_stack(directory, scope)
4252
for store, section in conf.iter_sections():
4253
for oname in section.iter_option_names():
4254
if name.search(oname):
4255
if cur_store_id != store.id:
4256
# Explain where the options are defined
4257
self.outf.write('%s:\n' % (store.id,))
4258
cur_store_id = store.id
4260
if (section.id is not None and cur_section != section.id):
4261
# Display the section id as it appears in the store
4262
# (None doesn't appear by definition)
4263
self.outf.write(' [%s]\n' % (section.id,))
4264
cur_section = section.id
4265
value = section.get(oname, expand=False)
4266
# Quote the value appropriately
4267
value = self._quote_multiline(value)
4268
self.outf.write(' %s = %s\n' % (oname, value))
4270
def _set_config_option(self, name, value, directory, scope):
4271
conf = self._get_stack(directory, scope, write_access=True)
4272
conf.set(name, value)
4273
# Explicitly save the changes
4274
conf.store.save_changes()
4276
def _remove_config_option(self, name, directory, scope):
4278
raise errors.BzrCommandError(
4279
'--remove expects an option to remove.')
4280
conf = self._get_stack(directory, scope, write_access=True)
4283
# Explicitly save the changes
4284
conf.store.save_changes()
4286
raise NoSuchConfigOption(name)
4291
# We need adapters that can build a Store or a Stack in a test context. Test
4292
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4293
# themselves. The builder will receive a test instance and should return a
4294
# ready-to-use store or stack. Plugins that define new store/stacks can also
4295
# register themselves here to be tested against the tests defined in
4296
# breezy.tests.test_config. Note that the builder can be called multiple times
4297
# for the same test.
4299
# The registered object should be a callable receiving a test instance
4300
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4302
test_store_builder_registry = registry.Registry()
4304
# The registered object should be a callable receiving a test instance
4305
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4307
test_stack_builder_registry = registry.Registry()
added
removed
breezy/config.py
