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 Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by brz.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
32
validate_signatures_in_log=true|false(default)
33
acceptable_keys=pattern1,pattern2
34
gpg_signing_key=amy@example.com
36
in locations.conf, you specify the url of a branch and options for it.
37
Wildcards may be used - * and ? as normal in shell completion. Options
38
set in both bazaar.conf and locations.conf are overridden by the locations.conf
40
[/home/robertc/source]
41
recurse=False|True(default)
43
check_signatures= as above
44
create_signatures= as above.
45
validate_signatures_in_log=as above
46
acceptable_keys=as above
48
explanation of options
49
----------------------
50
editor - this option sets the pop up editor to use during commits.
51
email - this option sets the user id brz will use when committing.
52
check_signatures - this option will control whether brz will require good gpg
53
signatures, ignore them, or check them if they are
54
present. Currently it is unused except that check_signatures
55
turns on create_signatures.
56
create_signatures - this option controls whether brz will always create
57
gpg signatures or not on commits. There is an unused
58
option which in future is expected to work if
59
branch settings require signatures.
60
log_format - this option sets the default log format. Possible values are
61
long, short, line, or a plugin can register new formats.
62
validate_signatures_in_log - show GPG signature validity in log output
63
acceptable_keys - comma separated list of key patterns acceptable for
64
verify-signatures command
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
69
lastlog=log --line -r-10..-1
70
ll=log --line -r-10..-1
75
from __future__ import absolute_import
82
from .decorators import needs_write_lock
83
from .lazy_import import lazy_import
84
lazy_import(globals(), """
106
from breezy.i18n import gettext
114
from .sixish import (
135
POLICY_APPENDPATH = 2
139
POLICY_NORECURSE: 'norecurse',
140
POLICY_APPENDPATH: 'appendpath',
145
'norecurse': POLICY_NORECURSE,
146
'appendpath': POLICY_APPENDPATH,
150
STORE_LOCATION = POLICY_NONE
151
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
152
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
157
def signature_policy_from_unicode(signature_string):
158
"""Convert a string to a signing policy."""
159
if signature_string.lower() == 'check-available':
160
return CHECK_IF_POSSIBLE
161
if signature_string.lower() == 'ignore':
163
if signature_string.lower() == 'require':
165
raise ValueError("Invalid signatures policy '%s'"
169
def signing_policy_from_unicode(signature_string):
170
"""Convert a string to a signing policy."""
171
if signature_string.lower() == 'when-required':
172
return SIGN_WHEN_REQUIRED
173
if signature_string.lower() == 'never':
175
if signature_string.lower() == 'always':
177
raise ValueError("Invalid signing policy '%s'"
181
def _has_decode_bug():
182
"""True if configobj will fail to decode to unicode on Python 2."""
183
if sys.version_info > (3,):
185
conf = configobj.ConfigObj()
186
decode = getattr(conf, "_decode", None)
188
result = decode(b"\xc2\xa7", "utf-8")
189
if isinstance(result[0], str):
194
def _has_triplequote_bug():
195
"""True if triple quote logic is reversed, see lp:710410."""
196
conf = configobj.ConfigObj()
197
quote = getattr(conf, "_get_triple_quote", None)
198
if quote and quote('"""') != "'''":
203
class ConfigObj(configobj.ConfigObj):
205
def __init__(self, infile=None, **kwargs):
206
# We define our own interpolation mechanism calling it option expansion
207
super(ConfigObj, self).__init__(infile=infile,
211
if _has_decode_bug():
212
def _decode(self, infile, encoding):
213
if isinstance(infile, str) and encoding:
214
return infile.decode(encoding).splitlines(True)
215
return super(ConfigObj, self)._decode(infile, encoding)
217
if _has_triplequote_bug():
218
def _get_triple_quote(self, value):
219
quot = super(ConfigObj, self)._get_triple_quote(value)
220
if quot == configobj.tdquot:
221
return configobj.tsquot
222
return configobj.tdquot
224
def get_bool(self, section, key):
225
return self[section].as_bool(key)
227
def get_value(self, section, name):
228
# Try [] for the old DEFAULT section.
229
if section == "DEFAULT":
234
return self[section][name]
237
class Config(object):
238
"""A configuration policy - what username, editor, gpg needs etc."""
241
super(Config, self).__init__()
244
"""Returns a unique ID for the config."""
245
raise NotImplementedError(self.config_id)
247
def get_change_editor(self, old_tree, new_tree):
248
from breezy import diff
249
cmd = self._get_change_editor()
252
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
255
def _get_signature_checking(self):
256
"""Template method to override signature checking policy."""
258
def _get_signing_policy(self):
259
"""Template method to override signature creation policy."""
263
def expand_options(self, string, env=None):
264
"""Expand option references in the string in the configuration context.
266
:param string: The string containing option to expand.
268
:param env: An option dict defining additional configuration options or
269
overriding existing ones.
271
:returns: The expanded string.
273
return self._expand_options_in_string(string, env)
275
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
276
"""Expand options in a list of strings in the configuration context.
278
:param slist: A list of strings.
280
:param env: An option dict defining additional configuration options or
281
overriding existing ones.
283
:param _ref_stack: Private list containing the options being
284
expanded to detect loops.
286
:returns: The flatten list of expanded strings.
288
# expand options in each value separately flattening lists
291
value = self._expand_options_in_string(s, env, _ref_stack)
292
if isinstance(value, list):
298
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
299
"""Expand options in the string in the configuration context.
301
:param string: The string to be expanded.
303
:param env: An option dict defining additional configuration options or
304
overriding existing ones.
306
:param _ref_stack: Private list containing the options being
307
expanded to detect loops.
309
:returns: The expanded string.
312
# Not much to expand there
314
if _ref_stack is None:
315
# What references are currently resolved (to detect loops)
317
if self.option_ref_re is None:
318
# We want to match the most embedded reference first (i.e. for
319
# '{{foo}}' we will get '{foo}',
320
# for '{bar{baz}}' we will get '{baz}'
321
self.option_ref_re = re.compile('({[^{}]+})')
323
# We need to iterate until no more refs appear ({{foo}} will need two
324
# iterations for example).
326
raw_chunks = self.option_ref_re.split(result)
327
if len(raw_chunks) == 1:
328
# Shorcut the trivial case: no refs
332
# Split will isolate refs so that every other chunk is a ref
334
for chunk in raw_chunks:
337
# Keep only non-empty strings (or we get bogus empty
338
# slots when a list value is involved).
343
if name in _ref_stack:
344
raise errors.OptionExpansionLoop(string, _ref_stack)
345
_ref_stack.append(name)
346
value = self._expand_option(name, env, _ref_stack)
348
raise errors.ExpandingUnknownOption(name, string)
349
if isinstance(value, list):
357
# Once a list appears as the result of an expansion, all
358
# callers will get a list result. This allows a consistent
359
# behavior even when some options in the expansion chain
360
# defined as strings (no comma in their value) but their
361
# expanded value is a list.
362
return self._expand_options_in_list(chunks, env, _ref_stack)
364
result = ''.join(chunks)
367
def _expand_option(self, name, env, _ref_stack):
368
if env is not None and name in env:
369
# Special case, values provided in env takes precedence over
373
# FIXME: This is a limited implementation, what we really need is a
374
# way to query the brz config for the value of an option,
375
# respecting the scope rules (That is, once we implement fallback
376
# configs, getting the option value should restart from the top
377
# config, not the current one) -- vila 20101222
378
value = self.get_user_option(name, expand=False)
379
if isinstance(value, list):
380
value = self._expand_options_in_list(value, env, _ref_stack)
382
value = self._expand_options_in_string(value, env, _ref_stack)
385
def _get_user_option(self, option_name):
386
"""Template method to provide a user option."""
389
def get_user_option(self, option_name, expand=True):
390
"""Get a generic option - no special process, no default.
392
:param option_name: The queried option.
394
:param expand: Whether options references should be expanded.
396
:returns: The value of the option.
398
value = self._get_user_option(option_name)
400
if isinstance(value, list):
401
value = self._expand_options_in_list(value)
402
elif isinstance(value, dict):
403
trace.warning('Cannot expand "%s":'
404
' Dicts do not support option expansion'
407
value = self._expand_options_in_string(value)
408
for hook in OldConfigHooks['get']:
409
hook(self, option_name, value)
412
def get_user_option_as_bool(self, option_name, expand=None, default=None):
413
"""Get a generic option as a boolean.
415
:param expand: Allow expanding references to other config values.
416
:param default: Default value if nothing is configured
417
:return None if the option doesn't exist or its value can't be
418
interpreted as a boolean. Returns True or False otherwise.
420
s = self.get_user_option(option_name, expand=expand)
422
# The option doesn't exist
424
val = ui.bool_from_string(s)
426
# The value can't be interpreted as a boolean
427
trace.warning('Value "%s" is not a boolean for "%s"',
431
def get_user_option_as_list(self, option_name, expand=None):
432
"""Get a generic option as a list - no special process, no default.
434
:return None if the option doesn't exist. Returns the value as a list
437
l = self.get_user_option(option_name, expand=expand)
438
if isinstance(l, string_types):
439
# A single value, most probably the user forgot (or didn't care to
444
def _log_format(self):
445
"""See log_format()."""
448
def validate_signatures_in_log(self):
449
"""Show GPG signature validity in log"""
450
result = self._validate_signatures_in_log()
457
def _validate_signatures_in_log(self):
458
"""See validate_signatures_in_log()."""
461
def _post_commit(self):
462
"""See Config.post_commit."""
465
def user_email(self):
466
"""Return just the email component of a username."""
467
return extract_email_address(self.username())
470
"""Return email-style username.
472
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
474
$BRZ_EMAIL can be set to override this, then
475
the concrete policy type is checked, and finally
477
If no username can be found, errors.NoWhoami exception is raised.
479
v = os.environ.get('BRZ_EMAIL')
481
return v.decode(osutils.get_user_encoding())
482
v = self._get_user_id()
485
return default_email()
487
def ensure_username(self):
488
"""Raise errors.NoWhoami if username is not set.
490
This method relies on the username() function raising the error.
494
def get_alias(self, value):
495
return self._get_alias(value)
497
def _get_alias(self, value):
500
def get_nickname(self):
501
return self._get_nickname()
503
def _get_nickname(self):
506
def get_bzr_remote_path(self):
508
return os.environ['BZR_REMOTE_PATH']
510
path = self.get_user_option("bzr_remote_path")
515
def suppress_warning(self, warning):
516
"""Should the warning be suppressed or emitted.
518
:param warning: The name of the warning being tested.
520
:returns: True if the warning should be suppressed, False otherwise.
522
warnings = self.get_user_option_as_list('suppress_warnings')
523
if warnings is None or warning not in warnings:
528
def get_merge_tools(self):
530
for (oname, value, section, conf_id, parser) in self._get_options():
531
if oname.startswith('bzr.mergetool.'):
532
tool_name = oname[len('bzr.mergetool.'):]
533
tools[tool_name] = self.get_user_option(oname, False)
534
trace.mutter('loaded merge tools: %r' % tools)
537
def find_merge_tool(self, name):
538
# We fake a defaults mechanism here by checking if the given name can
539
# be found in the known_merge_tools if it's not found in the config.
540
# This should be done through the proposed config defaults mechanism
541
# when it becomes available in the future.
542
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
544
or mergetools.known_merge_tools.get(name, None))
548
class _ConfigHooks(hooks.Hooks):
549
"""A dict mapping hook names and a list of callables for configs.
553
"""Create the default hooks.
555
These are all empty initially, because by default nothing should get
558
super(_ConfigHooks, self).__init__('breezy.config', 'ConfigHooks')
559
self.add_hook('load',
560
'Invoked when a config store is loaded.'
561
' The signature is (store).',
563
self.add_hook('save',
564
'Invoked when a config store is saved.'
565
' The signature is (store).',
567
# The hooks for config options
569
'Invoked when a config option is read.'
570
' The signature is (stack, name, value).',
573
'Invoked when a config option is set.'
574
' The signature is (stack, name, value).',
576
self.add_hook('remove',
577
'Invoked when a config option is removed.'
578
' The signature is (stack, name).',
580
ConfigHooks = _ConfigHooks()
583
class _OldConfigHooks(hooks.Hooks):
584
"""A dict mapping hook names and a list of callables for configs.
588
"""Create the default hooks.
590
These are all empty initially, because by default nothing should get
593
super(_OldConfigHooks, self).__init__('breezy.config', 'OldConfigHooks')
594
self.add_hook('load',
595
'Invoked when a config store is loaded.'
596
' The signature is (config).',
598
self.add_hook('save',
599
'Invoked when a config store is saved.'
600
' The signature is (config).',
602
# The hooks for config options
604
'Invoked when a config option is read.'
605
' The signature is (config, name, value).',
608
'Invoked when a config option is set.'
609
' The signature is (config, name, value).',
611
self.add_hook('remove',
612
'Invoked when a config option is removed.'
613
' The signature is (config, name).',
615
OldConfigHooks = _OldConfigHooks()
618
class IniBasedConfig(Config):
619
"""A configuration policy that draws from ini files."""
621
def __init__(self, file_name=None):
622
"""Base class for configuration files using an ini-like syntax.
624
:param file_name: The configuration file path.
626
super(IniBasedConfig, self).__init__()
627
self.file_name = file_name
628
self.file_name = file_name
633
def from_string(cls, str_or_unicode, file_name=None, save=False):
634
"""Create a config object from a string.
636
:param str_or_unicode: A string representing the file content. This will
639
:param file_name: The configuration file path.
641
:param _save: Whether the file should be saved upon creation.
643
conf = cls(file_name=file_name)
644
conf._create_from_string(str_or_unicode, save)
647
def _create_from_string(self, str_or_unicode, save):
648
self._content = BytesIO(str_or_unicode.encode('utf-8'))
649
# Some tests use in-memory configs, some other always need the config
650
# file to exist on disk.
652
self._write_config_file()
654
def _get_parser(self):
655
if self._parser is not None:
657
if self._content is not None:
658
co_input = self._content
659
elif self.file_name is None:
660
raise AssertionError('We have no content to create the config')
662
co_input = self.file_name
664
self._parser = ConfigObj(co_input, encoding='utf-8')
665
except configobj.ConfigObjError as e:
666
raise errors.ParseConfigError(e.errors, e.config.filename)
667
except UnicodeDecodeError:
668
raise errors.ConfigContentError(self.file_name)
669
# Make sure self.reload() will use the right file name
670
self._parser.filename = self.file_name
671
for hook in OldConfigHooks['load']:
676
"""Reload the config file from disk."""
677
if self.file_name is None:
678
raise AssertionError('We need a file name to reload the config')
679
if self._parser is not None:
680
self._parser.reload()
681
for hook in ConfigHooks['load']:
684
def _get_matching_sections(self):
685
"""Return an ordered list of (section_name, extra_path) pairs.
687
If the section contains inherited configuration, extra_path is
688
a string containing the additional path components.
690
section = self._get_section()
691
if section is not None:
692
return [(section, '')]
696
def _get_section(self):
697
"""Override this to define the section used by the config."""
700
def _get_sections(self, name=None):
701
"""Returns an iterator of the sections specified by ``name``.
703
:param name: The section name. If None is supplied, the default
704
configurations are yielded.
706
:return: A tuple (name, section, config_id) for all sections that will
707
be walked by user_get_option() in the 'right' order. The first one
708
is where set_user_option() will update the value.
710
parser = self._get_parser()
712
yield (name, parser[name], self.config_id())
714
# No section name has been given so we fallback to the configobj
715
# itself which holds the variables defined outside of any section.
716
yield (None, parser, self.config_id())
718
def _get_options(self, sections=None):
719
"""Return an ordered list of (name, value, section, config_id) tuples.
721
All options are returned with their associated value and the section
722
they appeared in. ``config_id`` is a unique identifier for the
723
configuration file the option is defined in.
725
:param sections: Default to ``_get_matching_sections`` if not
726
specified. This gives a better control to daughter classes about
727
which sections should be searched. This is a list of (name,
732
parser = self._get_parser()
734
for (section_name, _) in self._get_matching_sections():
736
section = parser[section_name]
738
# This could happen for an empty file for which we define a
739
# DEFAULT section. FIXME: Force callers to provide sections
740
# instead ? -- vila 20100930
742
sections.append((section_name, section))
743
config_id = self.config_id()
744
for (section_name, section) in sections:
745
for (name, value) in section.iteritems():
746
yield (name, parser._quote(value), section_name,
749
def _get_option_policy(self, section, option_name):
750
"""Return the policy for the given (section, option_name) pair."""
753
def _get_change_editor(self):
754
return self.get_user_option('change_editor')
756
def _get_signature_checking(self):
757
"""See Config._get_signature_checking."""
758
policy = self._get_user_option('check_signatures')
760
return signature_policy_from_unicode(policy)
762
def _get_signing_policy(self):
763
"""See Config._get_signing_policy"""
764
policy = self._get_user_option('create_signatures')
766
return signing_policy_from_unicode(policy)
768
def _get_user_id(self):
769
"""Get the user id from the 'email' key in the current section."""
770
return self._get_user_option('email')
772
def _get_user_option(self, option_name):
773
"""See Config._get_user_option."""
774
for (section, extra_path) in self._get_matching_sections():
776
value = self._get_parser().get_value(section, option_name)
779
policy = self._get_option_policy(section, option_name)
780
if policy == POLICY_NONE:
782
elif policy == POLICY_NORECURSE:
783
# norecurse items only apply to the exact path
788
elif policy == POLICY_APPENDPATH:
790
value = urlutils.join(value, extra_path)
793
raise AssertionError('Unexpected config policy %r' % policy)
797
def _gpg_signing_command(self):
798
"""See Config.gpg_signing_command."""
799
return self._get_user_option('gpg_signing_command')
801
def _log_format(self):
802
"""See Config.log_format."""
803
return self._get_user_option('log_format')
805
def _validate_signatures_in_log(self):
806
"""See Config.validate_signatures_in_log."""
807
return self._get_user_option('validate_signatures_in_log')
809
def _acceptable_keys(self):
810
"""See Config.acceptable_keys."""
811
return self._get_user_option('acceptable_keys')
813
def _post_commit(self):
814
"""See Config.post_commit."""
815
return self._get_user_option('post_commit')
817
def _get_alias(self, value):
819
return self._get_parser().get_value("ALIASES",
824
def _get_nickname(self):
825
return self.get_user_option('nickname')
827
def remove_user_option(self, option_name, section_name=None):
828
"""Remove a user option and save the configuration file.
830
:param option_name: The option to be removed.
832
:param section_name: The section the option is defined in, default to
836
parser = self._get_parser()
837
if section_name is None:
840
section = parser[section_name]
842
del section[option_name]
844
raise errors.NoSuchConfigOption(option_name)
845
self._write_config_file()
846
for hook in OldConfigHooks['remove']:
847
hook(self, option_name)
849
def _write_config_file(self):
850
if self.file_name is None:
851
raise AssertionError('We cannot save, self.file_name is None')
852
conf_dir = os.path.dirname(self.file_name)
853
ensure_config_dir_exists(conf_dir)
854
atomic_file = atomicfile.AtomicFile(self.file_name)
855
self._get_parser().write(atomic_file)
858
osutils.copy_ownership_from_path(self.file_name)
859
for hook in OldConfigHooks['save']:
863
class LockableConfig(IniBasedConfig):
864
"""A configuration needing explicit locking for access.
866
If several processes try to write the config file, the accesses need to be
869
Daughter classes should decorate all methods that update a config with the
870
``@needs_write_lock`` decorator (they call, directly or indirectly, the
871
``_write_config_file()`` method. These methods (typically ``set_option()``
872
and variants must reload the config file from disk before calling
873
``_write_config_file()``), this can be achieved by calling the
874
``self.reload()`` method. Note that the lock scope should cover both the
875
reading and the writing of the config file which is why the decorator can't
876
be applied to ``_write_config_file()`` only.
878
This should be enough to implement the following logic:
879
- lock for exclusive write access,
880
- reload the config file from disk,
884
This logic guarantees that a writer can update a value without erasing an
885
update made by another writer.
890
def __init__(self, file_name):
891
super(LockableConfig, self).__init__(file_name=file_name)
892
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
893
# FIXME: It doesn't matter that we don't provide possible_transports
894
# below since this is currently used only for local config files ;
895
# local transports are not shared. But if/when we start using
896
# LockableConfig for other kind of transports, we will need to reuse
897
# whatever connection is already established -- vila 20100929
898
self.transport = transport.get_transport_from_path(self.dir)
899
self._lock = lockdir.LockDir(self.transport, self.lock_name)
901
def _create_from_string(self, unicode_bytes, save):
902
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
904
# We need to handle the saving here (as opposed to IniBasedConfig)
907
self._write_config_file()
910
def lock_write(self, token=None):
911
"""Takes a write lock in the directory containing the config file.
913
If the directory doesn't exist it is created.
915
ensure_config_dir_exists(self.dir)
916
return self._lock.lock_write(token)
921
def break_lock(self):
922
self._lock.break_lock()
925
def remove_user_option(self, option_name, section_name=None):
926
super(LockableConfig, self).remove_user_option(option_name,
929
def _write_config_file(self):
930
if self._lock is None or not self._lock.is_held:
931
# NB: if the following exception is raised it probably means a
932
# missing @needs_write_lock decorator on one of the callers.
933
raise errors.ObjectNotLocked(self)
934
super(LockableConfig, self)._write_config_file()
937
class GlobalConfig(LockableConfig):
938
"""The configuration that should be used for a specific location."""
941
super(GlobalConfig, self).__init__(file_name=config_filename())
947
def from_string(cls, str_or_unicode, save=False):
948
"""Create a config object from a string.
950
:param str_or_unicode: A string representing the file content. This
951
will be utf-8 encoded.
953
:param save: Whether the file should be saved upon creation.
956
conf._create_from_string(str_or_unicode, save)
960
def set_user_option(self, option, value):
961
"""Save option and its value in the configuration."""
962
self._set_option(option, value, 'DEFAULT')
964
def get_aliases(self):
965
"""Return the aliases section."""
966
if 'ALIASES' in self._get_parser():
967
return self._get_parser()['ALIASES']
972
def set_alias(self, alias_name, alias_command):
973
"""Save the alias in the configuration."""
974
self._set_option(alias_name, alias_command, 'ALIASES')
977
def unset_alias(self, alias_name):
978
"""Unset an existing alias."""
980
aliases = self._get_parser().get('ALIASES')
981
if not aliases or alias_name not in aliases:
982
raise errors.NoSuchAlias(alias_name)
983
del aliases[alias_name]
984
self._write_config_file()
986
def _set_option(self, option, value, section):
988
self._get_parser().setdefault(section, {})[option] = value
989
self._write_config_file()
990
for hook in OldConfigHooks['set']:
991
hook(self, option, value)
993
def _get_sections(self, name=None):
994
"""See IniBasedConfig._get_sections()."""
995
parser = self._get_parser()
996
# We don't give access to options defined outside of any section, we
997
# used the DEFAULT section by... default.
998
if name in (None, 'DEFAULT'):
999
# This could happen for an empty file where the DEFAULT section
1000
# doesn't exist yet. So we force DEFAULT when yielding
1002
if 'DEFAULT' not in parser:
1003
parser['DEFAULT']= {}
1004
yield (name, parser[name], self.config_id())
1007
def remove_user_option(self, option_name, section_name=None):
1008
if section_name is None:
1009
# We need to force the default section.
1010
section_name = 'DEFAULT'
1011
# We need to avoid the LockableConfig implementation or we'll lock
1013
super(LockableConfig, self).remove_user_option(option_name,
1016
def _iter_for_location_by_parts(sections, location):
1017
"""Keep only the sessions matching the specified location.
1019
:param sections: An iterable of section names.
1021
:param location: An url or a local path to match against.
1023
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1024
number of path components in the section name, section is the section
1025
name and extra_path is the difference between location and the section
1028
``location`` will always be a local path and never a 'file://' url but the
1029
section names themselves can be in either form.
1031
location_parts = location.rstrip('/').split('/')
1033
for section in sections:
1034
# location is a local path if possible, so we need to convert 'file://'
1035
# urls in section names to local paths if necessary.
1037
# This also avoids having file:///path be a more exact
1038
# match than '/path'.
1040
# FIXME: This still raises an issue if a user defines both file:///path
1041
# *and* /path. Should we raise an error in this case -- vila 20110505
1043
if section.startswith('file://'):
1044
section_path = urlutils.local_path_from_url(section)
1046
section_path = section
1047
section_parts = section_path.rstrip('/').split('/')
1050
if len(section_parts) > len(location_parts):
1051
# More path components in the section, they can't match
1054
# Rely on zip truncating in length to the length of the shortest
1055
# argument sequence.
1056
for name in zip(location_parts, section_parts):
1057
if not fnmatch.fnmatch(name[0], name[1]):
1062
# build the path difference between the section and the location
1063
extra_path = '/'.join(location_parts[len(section_parts):])
1064
yield section, extra_path, len(section_parts)
1067
class LocationConfig(LockableConfig):
1068
"""A configuration object that gives the policy for a location."""
1070
def __init__(self, location):
1071
super(LocationConfig, self).__init__(
1072
file_name=locations_config_filename())
1073
# local file locations are looked up by local path, rather than
1074
# by file url. This is because the config file is a user
1075
# file, and we would rather not expose the user to file urls.
1076
if location.startswith('file://'):
1077
location = urlutils.local_path_from_url(location)
1078
self.location = location
1080
def config_id(self):
1084
def from_string(cls, str_or_unicode, location, save=False):
1085
"""Create a config object from a string.
1087
:param str_or_unicode: A string representing the file content. This will
1090
:param location: The location url to filter the configuration.
1092
:param save: Whether the file should be saved upon creation.
1094
conf = cls(location)
1095
conf._create_from_string(str_or_unicode, save)
1098
def _get_matching_sections(self):
1099
"""Return an ordered list of section names matching this location."""
1100
# put the longest (aka more specific) locations first
1102
_iter_for_location_by_parts(self._get_parser(), self.location),
1103
key=lambda match: (match[2], match[0]),
1105
for (section, extra_path, length) in matches:
1106
yield section, extra_path
1107
# should we stop looking for parent configs here?
1109
if self._get_parser()[section].as_bool('ignore_parents'):
1114
def _get_sections(self, name=None):
1115
"""See IniBasedConfig._get_sections()."""
1116
# We ignore the name here as the only sections handled are named with
1117
# the location path and we don't expose embedded sections either.
1118
parser = self._get_parser()
1119
for name, extra_path in self._get_matching_sections():
1120
yield (name, parser[name], self.config_id())
1122
def _get_option_policy(self, section, option_name):
1123
"""Return the policy for the given (section, option_name) pair."""
1124
# check for the old 'recurse=False' flag
1126
recurse = self._get_parser()[section].as_bool('recurse')
1130
return POLICY_NORECURSE
1132
policy_key = option_name + ':policy'
1134
policy_name = self._get_parser()[section][policy_key]
1138
return _policy_value[policy_name]
1140
def _set_option_policy(self, section, option_name, option_policy):
1141
"""Set the policy for the given option name in the given section."""
1142
policy_key = option_name + ':policy'
1143
policy_name = _policy_name[option_policy]
1144
if policy_name is not None:
1145
self._get_parser()[section][policy_key] = policy_name
1147
if policy_key in self._get_parser()[section]:
1148
del self._get_parser()[section][policy_key]
1151
def set_user_option(self, option, value, store=STORE_LOCATION):
1152
"""Save option and its value in the configuration."""
1153
if store not in [STORE_LOCATION,
1154
STORE_LOCATION_NORECURSE,
1155
STORE_LOCATION_APPENDPATH]:
1156
raise ValueError('bad storage policy %r for %r' %
1159
location = self.location
1160
if location.endswith('/'):
1161
location = location[:-1]
1162
parser = self._get_parser()
1163
if not location in parser and not location + '/' in parser:
1164
parser[location] = {}
1165
elif location + '/' in parser:
1166
location = location + '/'
1167
parser[location][option]=value
1168
# the allowed values of store match the config policies
1169
self._set_option_policy(location, option, store)
1170
self._write_config_file()
1171
for hook in OldConfigHooks['set']:
1172
hook(self, option, value)
1175
class BranchConfig(Config):
1176
"""A configuration object giving the policy for a branch."""
1178
def __init__(self, branch):
1179
super(BranchConfig, self).__init__()
1180
self._location_config = None
1181
self._branch_data_config = None
1182
self._global_config = None
1183
self.branch = branch
1184
self.option_sources = (self._get_location_config,
1185
self._get_branch_data_config,
1186
self._get_global_config)
1188
def config_id(self):
1191
def _get_branch_data_config(self):
1192
if self._branch_data_config is None:
1193
self._branch_data_config = TreeConfig(self.branch)
1194
self._branch_data_config.config_id = self.config_id
1195
return self._branch_data_config
1197
def _get_location_config(self):
1198
if self._location_config is None:
1199
self._location_config = LocationConfig(self.branch.base)
1200
return self._location_config
1202
def _get_global_config(self):
1203
if self._global_config is None:
1204
self._global_config = GlobalConfig()
1205
return self._global_config
1207
def _get_best_value(self, option_name):
1208
"""This returns a user option from local, tree or global config.
1210
They are tried in that order. Use get_safe_value if trusted values
1213
for source in self.option_sources:
1214
value = getattr(source(), option_name)()
1215
if value is not None:
1219
def _get_safe_value(self, option_name):
1220
"""This variant of get_best_value never returns untrusted values.
1222
It does not return values from the branch data, because the branch may
1223
not be controlled by the user.
1225
We may wish to allow locations.conf to control whether branches are
1226
trusted in the future.
1228
for source in (self._get_location_config, self._get_global_config):
1229
value = getattr(source(), option_name)()
1230
if value is not None:
1234
def _get_user_id(self):
1235
"""Return the full user id for the branch.
1237
e.g. "John Hacker <jhacker@example.com>"
1238
This is looked up in the email controlfile for the branch.
1240
return self._get_best_value('_get_user_id')
1242
def _get_change_editor(self):
1243
return self._get_best_value('_get_change_editor')
1245
def _get_signature_checking(self):
1246
"""See Config._get_signature_checking."""
1247
return self._get_best_value('_get_signature_checking')
1249
def _get_signing_policy(self):
1250
"""See Config._get_signing_policy."""
1251
return self._get_best_value('_get_signing_policy')
1253
def _get_user_option(self, option_name):
1254
"""See Config._get_user_option."""
1255
for source in self.option_sources:
1256
value = source()._get_user_option(option_name)
1257
if value is not None:
1261
def _get_sections(self, name=None):
1262
"""See IniBasedConfig.get_sections()."""
1263
for source in self.option_sources:
1264
for section in source()._get_sections(name):
1267
def _get_options(self, sections=None):
1269
# First the locations options
1270
for option in self._get_location_config()._get_options():
1272
# Then the branch options
1273
branch_config = self._get_branch_data_config()
1274
if sections is None:
1275
sections = [('DEFAULT', branch_config._get_parser())]
1276
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1277
# Config itself has no notion of sections :( -- vila 20101001
1278
config_id = self.config_id()
1279
for (section_name, section) in sections:
1280
for (name, value) in section.iteritems():
1281
yield (name, value, section_name,
1282
config_id, branch_config._get_parser())
1283
# Then the global options
1284
for option in self._get_global_config()._get_options():
1287
def set_user_option(self, name, value, store=STORE_BRANCH,
1289
if store == STORE_BRANCH:
1290
self._get_branch_data_config().set_option(value, name)
1291
elif store == STORE_GLOBAL:
1292
self._get_global_config().set_user_option(name, value)
1294
self._get_location_config().set_user_option(name, value, store)
1297
if store in (STORE_GLOBAL, STORE_BRANCH):
1298
mask_value = self._get_location_config().get_user_option(name)
1299
if mask_value is not None:
1300
trace.warning('Value "%s" is masked by "%s" from'
1301
' locations.conf', value, mask_value)
1303
if store == STORE_GLOBAL:
1304
branch_config = self._get_branch_data_config()
1305
mask_value = branch_config.get_user_option(name)
1306
if mask_value is not None:
1307
trace.warning('Value "%s" is masked by "%s" from'
1308
' branch.conf', value, mask_value)
1310
def remove_user_option(self, option_name, section_name=None):
1311
self._get_branch_data_config().remove_option(option_name, section_name)
1313
def _gpg_signing_command(self):
1314
"""See Config.gpg_signing_command."""
1315
return self._get_safe_value('_gpg_signing_command')
1317
def _post_commit(self):
1318
"""See Config.post_commit."""
1319
return self._get_safe_value('_post_commit')
1321
def _get_nickname(self):
1322
value = self._get_explicit_nickname()
1323
if value is not None:
1325
if self.branch.name:
1326
return self.branch.name
1327
return urlutils.unescape(self.branch.base.split('/')[-2])
1329
def has_explicit_nickname(self):
1330
"""Return true if a nickname has been explicitly assigned."""
1331
return self._get_explicit_nickname() is not None
1333
def _get_explicit_nickname(self):
1334
return self._get_best_value('_get_nickname')
1336
def _log_format(self):
1337
"""See Config.log_format."""
1338
return self._get_best_value('_log_format')
1340
def _validate_signatures_in_log(self):
1341
"""See Config.validate_signatures_in_log."""
1342
return self._get_best_value('_validate_signatures_in_log')
1344
def _acceptable_keys(self):
1345
"""See Config.acceptable_keys."""
1346
return self._get_best_value('_acceptable_keys')
1349
def ensure_config_dir_exists(path=None):
1350
"""Make sure a configuration directory exists.
1351
This makes sure that the directory exists.
1352
On windows, since configuration directories are 2 levels deep,
1353
it makes sure both the directory and the parent directory exists.
1357
if not os.path.isdir(path):
1358
if sys.platform == 'win32':
1359
parent_dir = os.path.dirname(path)
1360
if not os.path.isdir(parent_dir):
1361
trace.mutter('creating config parent directory: %r', parent_dir)
1362
os.mkdir(parent_dir)
1363
trace.mutter('creating config directory: %r', path)
1365
osutils.copy_ownership_from_path(path)
1368
def bazaar_config_dir():
1369
"""Return per-user configuration directory as unicode string
1371
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1372
and Linux. On Mac OS X and Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1373
that will be used instead.
1375
TODO: Global option --config-dir to override this.
1377
base = osutils.path_from_environ('BZR_HOME')
1378
if sys.platform == 'win32':
1380
base = win32utils.get_appdata_location()
1382
base = win32utils.get_home_location()
1383
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1384
# APPDATA, but hard to move. See bug 348640 for more.
1385
return osutils.pathjoin(base, 'bazaar', '2.0')
1387
xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1389
xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1390
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1391
if osutils.isdir(xdg_dir):
1393
"Using configuration in XDG directory %s." % xdg_dir)
1395
base = osutils._get_home_dir()
1396
return osutils.pathjoin(base, ".bazaar")
1400
"""Return per-user configuration directory as unicode string
1402
By default this is %APPDATA%/breezy on Windows, $XDG_CONFIG_HOME/breezy on
1403
Mac OS X and Linux. If the breezy config directory doesn't exist but
1404
the bazaar one (see bazaar_config_dir()) does, use that instead.
1406
TODO: Global option --config-dir to override this.
1408
base = osutils.path_from_environ('BRZ_HOME')
1409
if sys.platform == 'win32':
1411
base = win32utils.get_appdata_location()
1413
base = win32utils.get_home_location()
1414
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1415
# APPDATA, but hard to move. See bug 348640 for more.
1417
base = osutils.path_from_environ('XDG_CONFIG_HOME')
1419
base = osutils.pathjoin(osutils._get_home_dir(), ".config")
1420
breezy_dir = osutils.pathjoin(base, 'breezy')
1421
if osutils.isdir(breezy_dir):
1423
# If the breezy directory doesn't exist, but the bazaar one does, use that:
1424
bazaar_dir = bazaar_config_dir()
1425
if osutils.isdir(bazaar_dir):
1427
"Using Bazaar configuration directory (%s)", bazaar_dir)
1432
def config_filename():
1433
"""Return per-user configuration ini file filename."""
1434
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1437
def locations_config_filename():
1438
"""Return per-user configuration ini file filename."""
1439
return osutils.pathjoin(config_dir(), 'locations.conf')
1442
def authentication_config_filename():
1443
"""Return per-user authentication ini file filename."""
1444
return osutils.pathjoin(config_dir(), 'authentication.conf')
1447
def user_ignore_config_filename():
1448
"""Return the user default ignore filename"""
1449
return osutils.pathjoin(config_dir(), 'ignore')
1453
"""Return the directory name to store crash files.
1455
This doesn't implicitly create it.
1457
On Windows it's in the config directory; elsewhere it's /var/crash
1458
which may be monitored by apport. It can be overridden by
1461
if sys.platform == 'win32':
1462
return osutils.pathjoin(config_dir(), 'Crash')
1464
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1466
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1469
def xdg_cache_dir():
1470
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1471
# Possibly this should be different on Windows?
1472
e = os.environ.get('XDG_CACHE_HOME', None)
1476
return os.path.expanduser('~/.cache')
1479
def _get_default_mail_domain(mailname_file='/etc/mailname'):
1480
"""If possible, return the assumed default email domain.
1482
:returns: string mail domain, or None.
1484
if sys.platform == 'win32':
1485
# No implementation yet; patches welcome
1488
f = open(mailname_file)
1489
except (IOError, OSError) as e:
1492
domain = f.readline().strip()
1498
def default_email():
1499
v = os.environ.get('BRZ_EMAIL')
1501
return v.decode(osutils.get_user_encoding())
1502
v = os.environ.get('EMAIL')
1504
return v.decode(osutils.get_user_encoding())
1505
name, email = _auto_user_id()
1507
return u'%s <%s>' % (name, email)
1510
raise errors.NoWhoami()
1513
def _auto_user_id():
1514
"""Calculate automatic user identification.
1516
:returns: (realname, email), either of which may be None if they can't be
1519
Only used when none is set in the environment or the id file.
1521
This only returns an email address if we can be fairly sure the
1522
address is reasonable, ie if /etc/mailname is set on unix.
1524
This doesn't use the FQDN as the default domain because that may be
1525
slow, and it doesn't use the hostname alone because that's not normally
1526
a reasonable address.
1528
if sys.platform == 'win32':
1529
# No implementation to reliably determine Windows default mail
1530
# address; please add one.
1533
default_mail_domain = _get_default_mail_domain()
1534
if not default_mail_domain:
1540
w = pwd.getpwuid(uid)
1542
trace.mutter('no passwd entry for uid %d?' % uid)
1545
# we try utf-8 first, because on many variants (like Linux),
1546
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1547
# false positives. (many users will have their user encoding set to
1548
# latin-1, which cannot raise UnicodeError.)
1550
gecos = w.pw_gecos.decode('utf-8')
1552
except UnicodeError:
1554
encoding = osutils.get_user_encoding()
1555
gecos = w.pw_gecos.decode(encoding)
1556
except UnicodeError as e:
1557
trace.mutter("cannot decode passwd entry %s" % w)
1560
username = w.pw_name.decode(encoding)
1561
except UnicodeError as e:
1562
trace.mutter("cannot decode passwd entry %s" % w)
1565
comma = gecos.find(',')
1569
realname = gecos[:comma]
1571
return realname, (username + '@' + default_mail_domain)
1574
def parse_username(username):
1575
"""Parse e-mail username and return a (name, address) tuple."""
1576
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1578
return (username, '')
1580
return (match.group(1), match.group(2))
1583
def extract_email_address(e):
1584
"""Return just the address part of an email string.
1586
That is just the user@domain part, nothing else.
1587
This part is required to contain only ascii characters.
1588
If it can't be extracted, raises an error.
1590
>>> extract_email_address('Jane Tester <jane@test.com>')
1593
name, email = parse_username(e)
1595
raise errors.NoEmailInUsername(e)
1599
class TreeConfig(IniBasedConfig):
1600
"""Branch configuration data associated with its contents, not location"""
1602
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1604
def __init__(self, branch):
1605
self._config = branch._get_config()
1606
self.branch = branch
1608
def _get_parser(self, file=None):
1609
if file is not None:
1610
return IniBasedConfig._get_parser(file)
1611
return self._config._get_configobj()
1613
def get_option(self, name, section=None, default=None):
1614
self.branch.lock_read()
1616
return self._config.get_option(name, section, default)
1618
self.branch.unlock()
1620
def set_option(self, value, name, section=None):
1621
"""Set a per-branch configuration option"""
1622
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1623
# higher levels providing the right lock -- vila 20101004
1624
self.branch.lock_write()
1626
self._config.set_option(value, name, section)
1628
self.branch.unlock()
1630
def remove_option(self, option_name, section_name=None):
1631
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1632
# higher levels providing the right lock -- vila 20101004
1633
self.branch.lock_write()
1635
self._config.remove_option(option_name, section_name)
1637
self.branch.unlock()
1640
class AuthenticationConfig(object):
1641
"""The authentication configuration file based on a ini file.
1643
Implements the authentication.conf file described in
1644
doc/developers/authentication-ring.txt.
1647
def __init__(self, _file=None):
1648
self._config = None # The ConfigObj
1650
self._filename = authentication_config_filename()
1651
self._input = self._filename = authentication_config_filename()
1653
# Tests can provide a string as _file
1654
self._filename = None
1657
def _get_config(self):
1658
if self._config is not None:
1661
# FIXME: Should we validate something here ? Includes: empty
1662
# sections are useless, at least one of
1663
# user/password/password_encoding should be defined, etc.
1665
# Note: the encoding below declares that the file itself is utf-8
1666
# encoded, but the values in the ConfigObj are always Unicode.
1667
self._config = ConfigObj(self._input, encoding='utf-8')
1668
except configobj.ConfigObjError as e:
1669
raise errors.ParseConfigError(e.errors, e.config.filename)
1670
except UnicodeError:
1671
raise errors.ConfigContentError(self._filename)
1675
"""Save the config file, only tests should use it for now."""
1676
conf_dir = os.path.dirname(self._filename)
1677
ensure_config_dir_exists(conf_dir)
1678
f = file(self._filename, 'wb')
1680
self._get_config().write(f)
1684
def _set_option(self, section_name, option_name, value):
1685
"""Set an authentication configuration option"""
1686
conf = self._get_config()
1687
section = conf.get(section_name)
1690
section = conf[section]
1691
section[option_name] = value
1694
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1696
"""Returns the matching credentials from authentication.conf file.
1698
:param scheme: protocol
1700
:param host: the server address
1702
:param port: the associated port (optional)
1704
:param user: login (optional)
1706
:param path: the absolute path on the server (optional)
1708
:param realm: the http authentication realm (optional)
1710
:return: A dict containing the matching credentials or None.
1712
- name: the section name of the credentials in the
1713
authentication.conf file,
1714
- user: can't be different from the provided user if any,
1715
- scheme: the server protocol,
1716
- host: the server address,
1717
- port: the server port (can be None),
1718
- path: the absolute server path (can be None),
1719
- realm: the http specific authentication realm (can be None),
1720
- password: the decoded password, could be None if the credential
1721
defines only the user
1722
- verify_certificates: https specific, True if the server
1723
certificate should be verified, False otherwise.
1726
for auth_def_name, auth_def in self._get_config().iteritems():
1727
if not isinstance(auth_def, configobj.Section):
1728
raise ValueError("%s defined outside a section" % auth_def_name)
1730
a_scheme, a_host, a_user, a_path = map(
1731
auth_def.get, ['scheme', 'host', 'user', 'path'])
1734
a_port = auth_def.as_int('port')
1738
raise ValueError("'port' not numeric in %s" % auth_def_name)
1740
a_verify_certificates = auth_def.as_bool('verify_certificates')
1742
a_verify_certificates = True
1745
"'verify_certificates' not boolean in %s" % auth_def_name)
1748
if a_scheme is not None and scheme != a_scheme:
1750
if a_host is not None:
1751
if not (host == a_host
1752
or (a_host.startswith('.') and host.endswith(a_host))):
1754
if a_port is not None and port != a_port:
1756
if (a_path is not None and path is not None
1757
and not path.startswith(a_path)):
1759
if (a_user is not None and user is not None
1760
and a_user != user):
1761
# Never contradict the caller about the user to be used
1766
# Prepare a credentials dictionary with additional keys
1767
# for the credential providers
1768
credentials = dict(name=auth_def_name,
1775
password=auth_def.get('password', None),
1776
verify_certificates=a_verify_certificates)
1777
# Decode the password in the credentials (or get one)
1778
self.decode_password(credentials,
1779
auth_def.get('password_encoding', None))
1780
if 'auth' in debug.debug_flags:
1781
trace.mutter("Using authentication section: %r", auth_def_name)
1784
if credentials is None:
1785
# No credentials were found in authentication.conf, try the fallback
1786
# credentials stores.
1787
credentials = credential_store_registry.get_fallback_credentials(
1788
scheme, host, port, user, path, realm)
1792
def set_credentials(self, name, host, user, scheme=None, password=None,
1793
port=None, path=None, verify_certificates=None,
1795
"""Set authentication credentials for a host.
1797
Any existing credentials with matching scheme, host, port and path
1798
will be deleted, regardless of name.
1800
:param name: An arbitrary name to describe this set of credentials.
1801
:param host: Name of the host that accepts these credentials.
1802
:param user: The username portion of these credentials.
1803
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1805
:param password: Password portion of these credentials.
1806
:param port: The IP port on the host that these credentials apply to.
1807
:param path: A filesystem path on the host that these credentials
1809
:param verify_certificates: On https, verify server certificates if
1811
:param realm: The http authentication realm (optional).
1813
values = {'host': host, 'user': user}
1814
if password is not None:
1815
values['password'] = password
1816
if scheme is not None:
1817
values['scheme'] = scheme
1818
if port is not None:
1819
values['port'] = '%d' % port
1820
if path is not None:
1821
values['path'] = path
1822
if verify_certificates is not None:
1823
values['verify_certificates'] = str(verify_certificates)
1824
if realm is not None:
1825
values['realm'] = realm
1826
config = self._get_config()
1828
for section, existing_values in config.iteritems():
1829
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1830
if existing_values.get(key) != values.get(key):
1834
config.update({name: values})
1837
def get_user(self, scheme, host, port=None, realm=None, path=None,
1838
prompt=None, ask=False, default=None):
1839
"""Get a user from authentication file.
1841
:param scheme: protocol
1843
:param host: the server address
1845
:param port: the associated port (optional)
1847
:param realm: the realm sent by the server (optional)
1849
:param path: the absolute path on the server (optional)
1851
:param ask: Ask the user if there is no explicitly configured username
1854
:param default: The username returned if none is defined (optional).
1856
:return: The found user.
1858
credentials = self.get_credentials(scheme, host, port, user=None,
1859
path=path, realm=realm)
1860
if credentials is not None:
1861
user = credentials['user']
1867
# Create a default prompt suitable for most cases
1868
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1869
# Special handling for optional fields in the prompt
1870
if port is not None:
1871
prompt_host = '%s:%d' % (host, port)
1874
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1879
def get_password(self, scheme, host, user, port=None,
1880
realm=None, path=None, prompt=None):
1881
"""Get a password from authentication file or prompt the user for one.
1883
:param scheme: protocol
1885
:param host: the server address
1887
:param port: the associated port (optional)
1891
:param realm: the realm sent by the server (optional)
1893
:param path: the absolute path on the server (optional)
1895
:return: The found password or the one entered by the user.
1897
credentials = self.get_credentials(scheme, host, port, user, path,
1899
if credentials is not None:
1900
password = credentials['password']
1901
if password is not None and scheme is 'ssh':
1902
trace.warning('password ignored in section [%s],'
1903
' use an ssh agent instead'
1904
% credentials['name'])
1908
# Prompt user only if we could't find a password
1909
if password is None:
1911
# Create a default prompt suitable for most cases
1912
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1913
# Special handling for optional fields in the prompt
1914
if port is not None:
1915
prompt_host = '%s:%d' % (host, port)
1918
password = ui.ui_factory.get_password(prompt,
1919
host=prompt_host, user=user)
1922
def decode_password(self, credentials, encoding):
1924
cs = credential_store_registry.get_credential_store(encoding)
1926
raise ValueError('%r is not a known password_encoding' % encoding)
1927
credentials['password'] = cs.decode_password(credentials)
1931
class CredentialStoreRegistry(registry.Registry):
1932
"""A class that registers credential stores.
1934
A credential store provides access to credentials via the password_encoding
1935
field in authentication.conf sections.
1937
Except for stores provided by brz itself, most stores are expected to be
1938
provided by plugins that will therefore use
1939
register_lazy(password_encoding, module_name, member_name, help=help,
1940
fallback=fallback) to install themselves.
1942
A fallback credential store is one that is queried if no credentials can be
1943
found via authentication.conf.
1946
def get_credential_store(self, encoding=None):
1947
cs = self.get(encoding)
1952
def is_fallback(self, name):
1953
"""Check if the named credentials store should be used as fallback."""
1954
return self.get_info(name)
1956
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1957
path=None, realm=None):
1958
"""Request credentials from all fallback credentials stores.
1960
The first credentials store that can provide credentials wins.
1963
for name in self.keys():
1964
if not self.is_fallback(name):
1966
cs = self.get_credential_store(name)
1967
credentials = cs.get_credentials(scheme, host, port, user,
1969
if credentials is not None:
1970
# We found some credentials
1974
def register(self, key, obj, help=None, override_existing=False,
1976
"""Register a new object to a name.
1978
:param key: This is the key to use to request the object later.
1979
:param obj: The object to register.
1980
:param help: Help text for this entry. This may be a string or
1981
a callable. If it is a callable, it should take two
1982
parameters (registry, key): this registry and the key that
1983
the help was registered under.
1984
:param override_existing: Raise KeyErorr if False and something has
1985
already been registered for that key. If True, ignore if there
1986
is an existing key (always register the new value).
1987
:param fallback: Whether this credential store should be
1990
return super(CredentialStoreRegistry,
1991
self).register(key, obj, help, info=fallback,
1992
override_existing=override_existing)
1994
def register_lazy(self, key, module_name, member_name,
1995
help=None, override_existing=False,
1997
"""Register a new credential store to be loaded on request.
1999
:param module_name: The python path to the module. Such as 'os.path'.
2000
:param member_name: The member of the module to return. If empty or
2001
None, get() will return the module itself.
2002
:param help: Help text for this entry. This may be a string or
2004
:param override_existing: If True, replace the existing object
2005
with the new one. If False, if there is already something
2006
registered with the same key, raise a KeyError
2007
:param fallback: Whether this credential store should be
2010
return super(CredentialStoreRegistry, self).register_lazy(
2011
key, module_name, member_name, help,
2012
info=fallback, override_existing=override_existing)
2015
credential_store_registry = CredentialStoreRegistry()
2018
class CredentialStore(object):
2019
"""An abstract class to implement storage for credentials"""
2021
def decode_password(self, credentials):
2022
"""Returns a clear text password for the provided credentials."""
2023
raise NotImplementedError(self.decode_password)
2025
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2027
"""Return the matching credentials from this credential store.
2029
This method is only called on fallback credential stores.
2031
raise NotImplementedError(self.get_credentials)
2035
class PlainTextCredentialStore(CredentialStore):
2036
__doc__ = """Plain text credential store for the authentication.conf file"""
2038
def decode_password(self, credentials):
2039
"""See CredentialStore.decode_password."""
2040
return credentials['password']
2043
credential_store_registry.register('plain', PlainTextCredentialStore,
2044
help=PlainTextCredentialStore.__doc__)
2045
credential_store_registry.default_key = 'plain'
2048
class Base64CredentialStore(CredentialStore):
2049
__doc__ = """Base64 credential store for the authentication.conf file"""
2051
def decode_password(self, credentials):
2052
"""See CredentialStore.decode_password."""
2053
# GZ 2012-07-28: Will raise binascii.Error if password is not base64,
2054
# should probably propogate as something more useful.
2055
return base64.decodestring(credentials['password'])
2057
credential_store_registry.register('base64', Base64CredentialStore,
2058
help=Base64CredentialStore.__doc__)
2061
class BzrDirConfig(object):
2063
def __init__(self, bzrdir):
2064
self._bzrdir = bzrdir
2065
self._config = bzrdir._get_config()
2067
def set_default_stack_on(self, value):
2068
"""Set the default stacking location.
2070
It may be set to a location, or None.
2072
This policy affects all branches contained by this control dir, except
2073
for those under repositories.
2075
if self._config is None:
2076
raise errors.BzrError("Cannot set configuration in %s"
2079
self._config.set_option('', 'default_stack_on')
2081
self._config.set_option(value, 'default_stack_on')
2083
def get_default_stack_on(self):
2084
"""Return the default stacking location.
2086
This will either be a location, or None.
2088
This policy affects all branches contained by this control dir, except
2089
for those under repositories.
2091
if self._config is None:
2093
value = self._config.get_option('default_stack_on')
2099
class TransportConfig(object):
2100
"""A Config that reads/writes a config file on a Transport.
2102
It is a low-level object that considers config data to be name/value pairs
2103
that may be associated with a section. Assigning meaning to these values
2104
is done at higher levels like TreeConfig.
2107
def __init__(self, transport, filename):
2108
self._transport = transport
2109
self._filename = filename
2111
def get_option(self, name, section=None, default=None):
2112
"""Return the value associated with a named option.
2114
:param name: The name of the value
2115
:param section: The section the option is in (if any)
2116
:param default: The value to return if the value is not set
2117
:return: The value or default value
2119
configobj = self._get_configobj()
2121
section_obj = configobj
2124
section_obj = configobj[section]
2127
value = section_obj.get(name, default)
2128
for hook in OldConfigHooks['get']:
2129
hook(self, name, value)
2132
def set_option(self, value, name, section=None):
2133
"""Set the value associated with a named option.
2135
:param value: The value to set
2136
:param name: The name of the value to set
2137
:param section: The section the option is in (if any)
2139
configobj = self._get_configobj()
2141
configobj[name] = value
2143
configobj.setdefault(section, {})[name] = value
2144
for hook in OldConfigHooks['set']:
2145
hook(self, name, value)
2146
self._set_configobj(configobj)
2148
def remove_option(self, option_name, section_name=None):
2149
configobj = self._get_configobj()
2150
if section_name is None:
2151
del configobj[option_name]
2153
del configobj[section_name][option_name]
2154
for hook in OldConfigHooks['remove']:
2155
hook(self, option_name)
2156
self._set_configobj(configobj)
2158
def _get_config_file(self):
2160
f = BytesIO(self._transport.get_bytes(self._filename))
2161
for hook in OldConfigHooks['load']:
2164
except errors.NoSuchFile:
2166
except errors.PermissionDenied as e:
2167
trace.warning("Permission denied while trying to open "
2168
"configuration file %s.", urlutils.unescape_for_display(
2169
urlutils.join(self._transport.base, self._filename), "utf-8"))
2172
def _external_url(self):
2173
return urlutils.join(self._transport.external_url(), self._filename)
2175
def _get_configobj(self):
2176
f = self._get_config_file()
2179
conf = ConfigObj(f, encoding='utf-8')
2180
except configobj.ConfigObjError as e:
2181
raise errors.ParseConfigError(e.errors, self._external_url())
2182
except UnicodeDecodeError:
2183
raise errors.ConfigContentError(self._external_url())
2188
def _set_configobj(self, configobj):
2189
out_file = BytesIO()
2190
configobj.write(out_file)
2192
self._transport.put_file(self._filename, out_file)
2193
for hook in OldConfigHooks['save']:
2197
class Option(object):
2198
"""An option definition.
2200
The option *values* are stored in config files and found in sections.
2202
Here we define various properties about the option itself, its default
2203
value, how to convert it from stores, what to do when invalid values are
2204
encoutered, in which config files it can be stored.
2207
def __init__(self, name, override_from_env=None,
2208
default=None, default_from_env=None,
2209
help=None, from_unicode=None, invalid=None, unquote=True):
2210
"""Build an option definition.
2212
:param name: the name used to refer to the option.
2214
:param override_from_env: A list of environment variables which can
2215
provide override any configuration setting.
2217
:param default: the default value to use when none exist in the config
2218
stores. This is either a string that ``from_unicode`` will convert
2219
into the proper type, a callable returning a unicode string so that
2220
``from_unicode`` can be used on the return value, or a python
2221
object that can be stringified (so only the empty list is supported
2224
:param default_from_env: A list of environment variables which can
2225
provide a default value. 'default' will be used only if none of the
2226
variables specified here are set in the environment.
2228
:param help: a doc string to explain the option to the user.
2230
:param from_unicode: a callable to convert the unicode string
2231
representing the option value in a store or its default value.
2233
:param invalid: the action to be taken when an invalid value is
2234
encountered in a store. This is called only when from_unicode is
2235
invoked to convert a string and returns None or raise ValueError or
2236
TypeError. Accepted values are: None (ignore invalid values),
2237
'warning' (emit a warning), 'error' (emit an error message and
2240
:param unquote: should the unicode value be unquoted before conversion.
2241
This should be used only when the store providing the values cannot
2242
safely unquote them (see http://pad.lv/906897). It is provided so
2243
daughter classes can handle the quoting themselves.
2245
if override_from_env is None:
2246
override_from_env = []
2247
if default_from_env is None:
2248
default_from_env = []
2250
self.override_from_env = override_from_env
2251
# Convert the default value to a unicode string so all values are
2252
# strings internally before conversion (via from_unicode) is attempted.
2255
elif isinstance(default, list):
2256
# Only the empty list is supported
2258
raise AssertionError(
2259
'Only empty lists are supported as default values')
2261
elif isinstance(default, (binary_type, text_type, bool, int, float)):
2262
# Rely on python to convert strings, booleans and integers
2263
self.default = u'%s' % (default,)
2264
elif callable(default):
2265
self.default = default
2267
# other python objects are not expected
2268
raise AssertionError('%r is not supported as a default value'
2270
self.default_from_env = default_from_env
2272
self.from_unicode = from_unicode
2273
self.unquote = unquote
2274
if invalid and invalid not in ('warning', 'error'):
2275
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2276
self.invalid = invalid
2282
def convert_from_unicode(self, store, unicode_value):
2283
if self.unquote and store is not None and unicode_value is not None:
2284
unicode_value = store.unquote(unicode_value)
2285
if self.from_unicode is None or unicode_value is None:
2286
# Don't convert or nothing to convert
2287
return unicode_value
2289
converted = self.from_unicode(unicode_value)
2290
except (ValueError, TypeError):
2291
# Invalid values are ignored
2293
if converted is None and self.invalid is not None:
2294
# The conversion failed
2295
if self.invalid == 'warning':
2296
trace.warning('Value "%s" is not valid for "%s"',
2297
unicode_value, self.name)
2298
elif self.invalid == 'error':
2299
raise errors.ConfigOptionValueError(self.name, unicode_value)
2302
def get_override(self):
2304
for var in self.override_from_env:
2306
# If the env variable is defined, its value takes precedence
2307
value = os.environ[var].decode(osutils.get_user_encoding())
2313
def get_default(self):
2315
for var in self.default_from_env:
2317
# If the env variable is defined, its value is the default one
2318
value = os.environ[var].decode(osutils.get_user_encoding())
2323
# Otherwise, fallback to the value defined at registration
2324
if callable(self.default):
2325
value = self.default()
2326
if not isinstance(value, text_type):
2327
raise AssertionError(
2328
"Callable default value for '%s' should be unicode"
2331
value = self.default
2334
def get_help_topic(self):
2337
def get_help_text(self, additional_see_also=None, plain=True):
2339
from breezy import help_topics
2340
result += help_topics._format_see_also(additional_see_also)
2342
result = help_topics.help_as_plain_text(result)
2346
# Predefined converters to get proper values from store
2348
def bool_from_store(unicode_str):
2349
return ui.bool_from_string(unicode_str)
2352
def int_from_store(unicode_str):
2353
return int(unicode_str)
2356
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2358
def int_SI_from_store(unicode_str):
2359
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2361
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2362
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2365
:return Integer, expanded to its base-10 value if a proper SI unit is
2366
found, None otherwise.
2368
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2369
p = re.compile(regexp, re.IGNORECASE)
2370
m = p.match(unicode_str)
2373
val, _, unit = m.groups()
2377
coeff = _unit_suffixes[unit.upper()]
2379
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2384
def float_from_store(unicode_str):
2385
return float(unicode_str)
2388
# Use an empty dict to initialize an empty configobj avoiding all parsing and
2390
_list_converter_config = configobj.ConfigObj(
2391
{}, encoding='utf-8', list_values=True, interpolation=False)
2394
class ListOption(Option):
2396
def __init__(self, name, default=None, default_from_env=None,
2397
help=None, invalid=None):
2398
"""A list Option definition.
2400
This overrides the base class so the conversion from a unicode string
2401
can take quoting into account.
2403
super(ListOption, self).__init__(
2404
name, default=default, default_from_env=default_from_env,
2405
from_unicode=self.from_unicode, help=help,
2406
invalid=invalid, unquote=False)
2408
def from_unicode(self, unicode_str):
2409
if not isinstance(unicode_str, string_types):
2411
# Now inject our string directly as unicode. All callers got their
2412
# value from configobj, so values that need to be quoted are already
2414
_list_converter_config.reset()
2415
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2416
maybe_list = _list_converter_config['list']
2417
if isinstance(maybe_list, string_types):
2419
# A single value, most probably the user forgot (or didn't care
2420
# to add) the final ','
2423
# The empty string, convert to empty list
2426
# We rely on ConfigObj providing us with a list already
2431
class RegistryOption(Option):
2432
"""Option for a choice from a registry."""
2434
def __init__(self, name, registry, default_from_env=None,
2435
help=None, invalid=None):
2436
"""A registry based Option definition.
2438
This overrides the base class so the conversion from a unicode string
2439
can take quoting into account.
2441
super(RegistryOption, self).__init__(
2442
name, default=lambda: unicode(registry.default_key),
2443
default_from_env=default_from_env,
2444
from_unicode=self.from_unicode, help=help,
2445
invalid=invalid, unquote=False)
2446
self.registry = registry
2448
def from_unicode(self, unicode_str):
2449
if not isinstance(unicode_str, string_types):
2452
return self.registry.get(unicode_str)
2455
"Invalid value %s for %s."
2456
"See help for a list of possible values." % (unicode_str,
2461
ret = [self._help, "\n\nThe following values are supported:\n"]
2462
for key in self.registry.keys():
2463
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2467
_option_ref_re = lazy_regex.lazy_compile('({[^\d\W](?:\.\w|-\w|\w)*})')
2468
"""Describes an expandable option reference.
2470
We want to match the most embedded reference first.
2472
I.e. for '{{foo}}' we will get '{foo}',
2473
for '{bar{baz}}' we will get '{baz}'
2476
def iter_option_refs(string):
2477
# Split isolate refs so every other chunk is a ref
2479
for chunk in _option_ref_re.split(string):
2484
class OptionRegistry(registry.Registry):
2485
"""Register config options by their name.
2487
This overrides ``registry.Registry`` to simplify registration by acquiring
2488
some information from the option object itself.
2491
def _check_option_name(self, option_name):
2492
"""Ensures an option name is valid.
2494
:param option_name: The name to validate.
2496
if _option_ref_re.match('{%s}' % option_name) is None:
2497
raise errors.IllegalOptionName(option_name)
2499
def register(self, option):
2500
"""Register a new option to its name.
2502
:param option: The option to register. Its name is used as the key.
2504
self._check_option_name(option.name)
2505
super(OptionRegistry, self).register(option.name, option,
2508
def register_lazy(self, key, module_name, member_name):
2509
"""Register a new option to be loaded on request.
2511
:param key: the key to request the option later. Since the registration
2512
is lazy, it should be provided and match the option name.
2514
:param module_name: the python path to the module. Such as 'os.path'.
2516
:param member_name: the member of the module to return. If empty or
2517
None, get() will return the module itself.
2519
self._check_option_name(key)
2520
super(OptionRegistry, self).register_lazy(key,
2521
module_name, member_name)
2523
def get_help(self, key=None):
2524
"""Get the help text associated with the given key"""
2525
option = self.get(key)
2526
the_help = option.help
2527
if callable(the_help):
2528
return the_help(self, key)
2532
option_registry = OptionRegistry()
2535
# Registered options in lexicographical order
2537
option_registry.register(
2538
Option('append_revisions_only',
2539
default=None, from_unicode=bool_from_store, invalid='warning',
2541
Whether to only append revisions to the mainline.
2543
If this is set to true, then it is not possible to change the
2544
existing mainline of the branch.
2546
option_registry.register(
2547
ListOption('acceptable_keys',
2550
List of GPG key patterns which are acceptable for verification.
2552
option_registry.register(
2553
Option('add.maximum_file_size',
2554
default=u'20MB', from_unicode=int_SI_from_store,
2556
Size above which files should be added manually.
2558
Files below this size are added automatically when using ``bzr add`` without
2561
A negative value means disable the size check.
2563
option_registry.register(
2565
default=None, from_unicode=bool_from_store,
2567
Is the branch bound to ``bound_location``.
2569
If set to "True", the branch should act as a checkout, and push each commit to
2570
the bound_location. This option is normally set by ``bind``/``unbind``.
2572
See also: bound_location.
2574
option_registry.register(
2575
Option('bound_location',
2578
The location that commits should go to when acting as a checkout.
2580
This option is normally set by ``bind``.
2584
option_registry.register(
2585
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2587
Whether revisions associated with tags should be fetched.
2589
option_registry.register_lazy(
2590
'bzr.transform.orphan_policy', 'breezy.transform', 'opt_transform_orphan')
2591
option_registry.register(
2592
Option('bzr.workingtree.worth_saving_limit', default=10,
2593
from_unicode=int_from_store, invalid='warning',
2595
How many changes before saving the dirstate.
2597
-1 means that we will never rewrite the dirstate file for only
2598
stat-cache changes. Regardless of this setting, we will always rewrite
2599
the dirstate file if a file is added/removed/renamed/etc. This flag only
2600
affects the behavior of updating the dirstate file after we notice that
2601
a file has been touched.
2603
option_registry.register(
2604
Option('bugtracker', default=None,
2606
Default bug tracker to use.
2608
This bug tracker will be used for example when marking bugs
2609
as fixed using ``bzr commit --fixes``, if no explicit
2610
bug tracker was specified.
2612
option_registry.register(
2613
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2614
from_unicode=signature_policy_from_unicode,
2616
GPG checking policy.
2618
Possible values: require, ignore, check-available (default)
2620
this option will control whether bzr will require good gpg
2621
signatures, ignore them, or check them if they are
2624
option_registry.register(
2625
Option('child_submit_format',
2626
help='''The preferred format of submissions to this branch.'''))
2627
option_registry.register(
2628
Option('child_submit_to',
2629
help='''Where submissions to this branch are mailed to.'''))
2630
option_registry.register(
2631
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2632
from_unicode=signing_policy_from_unicode,
2636
Possible values: always, never, when-required (default)
2638
This option controls whether bzr will always create
2639
gpg signatures or not on commits.
2641
option_registry.register(
2642
Option('dirstate.fdatasync', default=True,
2643
from_unicode=bool_from_store,
2645
Flush dirstate changes onto physical disk?
2647
If true (default), working tree metadata changes are flushed through the
2648
OS buffers to physical disk. This is somewhat slower, but means data
2649
should not be lost if the machine crashes. See also repository.fdatasync.
2651
option_registry.register(
2652
ListOption('debug_flags', default=[],
2653
help='Debug flags to activate.'))
2654
option_registry.register(
2655
Option('default_format', default='2a',
2656
help='Format used when creating branches.'))
2657
option_registry.register(
2658
Option('dpush_strict', default=None,
2659
from_unicode=bool_from_store,
2661
The default value for ``dpush --strict``.
2663
If present, defines the ``--strict`` option default value for checking
2664
uncommitted changes before pushing into a different VCS without any
2665
custom bzr metadata.
2667
option_registry.register(
2669
help='The command called to launch an editor to enter a message.'))
2670
option_registry.register(
2671
Option('email', override_from_env=['BRZ_EMAIL'], default=default_email,
2672
help='The users identity'))
2673
option_registry.register(
2674
Option('gpg_signing_command',
2677
Program to use use for creating signatures.
2679
This should support at least the -u and --clearsign options.
2681
option_registry.register(
2682
Option('gpg_signing_key',
2685
GPG key to use for signing.
2687
This defaults to the first key associated with the users email.
2689
option_registry.register(
2690
Option('ignore_missing_extensions', default=False,
2691
from_unicode=bool_from_store,
2693
Control the missing extensions warning display.
2695
The warning will not be emitted if set to True.
2697
option_registry.register(
2699
help='Language to translate messages into.'))
2700
option_registry.register(
2701
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2703
Steal locks that appears to be dead.
2705
If set to True, bzr will check if a lock is supposed to be held by an
2706
active process from the same user on the same machine. If the user and
2707
machine match, but no process with the given PID is active, then bzr
2708
will automatically break the stale lock, and create a new lock for
2710
Otherwise, bzr will prompt as normal to break the lock.
2712
option_registry.register(
2713
Option('log_format', default='long',
2715
Log format to use when displaying revisions.
2717
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2718
may be provided by plugins.
2720
option_registry.register_lazy('mail_client', 'breezy.mail_client',
2722
option_registry.register(
2723
Option('output_encoding',
2724
help= 'Unicode encoding for output'
2725
' (terminal encoding if not specified).'))
2726
option_registry.register(
2727
Option('parent_location',
2730
The location of the default branch for pull or merge.
2732
This option is normally set when creating a branch, the first ``pull`` or by
2733
``pull --remember``.
2735
option_registry.register(
2736
Option('post_commit', default=None,
2738
Post commit functions.
2740
An ordered list of python functions to call, separated by spaces.
2742
Each function takes branch, rev_id as parameters.
2744
option_registry.register_lazy('progress_bar', 'breezy.ui.text',
2746
option_registry.register(
2747
Option('public_branch',
2750
A publically-accessible version of this branch.
2752
This implies that the branch setting this option is not publically-accessible.
2753
Used and set by ``bzr send``.
2755
option_registry.register(
2756
Option('push_location',
2759
The location of the default branch for push.
2761
This option is normally set by the first ``push`` or ``push --remember``.
2763
option_registry.register(
2764
Option('push_strict', default=None,
2765
from_unicode=bool_from_store,
2767
The default value for ``push --strict``.
2769
If present, defines the ``--strict`` option default value for checking
2770
uncommitted changes before sending a merge directive.
2772
option_registry.register(
2773
Option('repository.fdatasync', default=True,
2774
from_unicode=bool_from_store,
2776
Flush repository changes onto physical disk?
2778
If true (default), repository changes are flushed through the OS buffers
2779
to physical disk. This is somewhat slower, but means data should not be
2780
lost if the machine crashes. See also dirstate.fdatasync.
2782
option_registry.register_lazy('smtp_server',
2783
'breezy.smtp_connection', 'smtp_server')
2784
option_registry.register_lazy('smtp_password',
2785
'breezy.smtp_connection', 'smtp_password')
2786
option_registry.register_lazy('smtp_username',
2787
'breezy.smtp_connection', 'smtp_username')
2788
option_registry.register(
2789
Option('selftest.timeout',
2791
from_unicode=int_from_store,
2792
help='Abort selftest if one test takes longer than this many seconds',
2795
option_registry.register(
2796
Option('send_strict', default=None,
2797
from_unicode=bool_from_store,
2799
The default value for ``send --strict``.
2801
If present, defines the ``--strict`` option default value for checking
2802
uncommitted changes before sending a bundle.
2805
option_registry.register(
2806
Option('serve.client_timeout',
2807
default=300.0, from_unicode=float_from_store,
2808
help="If we wait for a new request from a client for more than"
2809
" X seconds, consider the client idle, and hangup."))
2810
option_registry.register(
2811
Option('stacked_on_location',
2813
help="""The location where this branch is stacked on."""))
2814
option_registry.register(
2815
Option('submit_branch',
2818
The branch you intend to submit your current work to.
2820
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2821
by the ``submit:`` revision spec.
2823
option_registry.register(
2825
help='''Where submissions from this branch are mailed to.'''))
2826
option_registry.register(
2827
ListOption('suppress_warnings',
2829
help="List of warning classes to suppress."))
2830
option_registry.register(
2831
Option('validate_signatures_in_log', default=False,
2832
from_unicode=bool_from_store, invalid='warning',
2833
help='''Whether to validate signatures in brz log.'''))
2834
option_registry.register_lazy('ssl.ca_certs',
2835
'breezy.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2837
option_registry.register_lazy('ssl.cert_reqs',
2838
'breezy.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2841
class Section(object):
2842
"""A section defines a dict of option name => value.
2844
This is merely a read-only dict which can add some knowledge about the
2845
options. It is *not* a python dict object though and doesn't try to mimic
2849
def __init__(self, section_id, options):
2850
self.id = section_id
2851
# We re-use the dict-like object received
2852
self.options = options
2854
def get(self, name, default=None, expand=True):
2855
return self.options.get(name, default)
2857
def iter_option_names(self):
2858
for k in self.options.keys():
2862
# Mostly for debugging use
2863
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2866
_NewlyCreatedOption = object()
2867
"""Was the option created during the MutableSection lifetime"""
2868
_DeletedOption = object()
2869
"""Was the option deleted during the MutableSection lifetime"""
2872
class MutableSection(Section):
2873
"""A section allowing changes and keeping track of the original values."""
2875
def __init__(self, section_id, options):
2876
super(MutableSection, self).__init__(section_id, options)
2877
self.reset_changes()
2879
def set(self, name, value):
2880
if name not in self.options:
2881
# This is a new option
2882
self.orig[name] = _NewlyCreatedOption
2883
elif name not in self.orig:
2884
self.orig[name] = self.get(name, None)
2885
self.options[name] = value
2887
def remove(self, name):
2888
if name not in self.orig and name in self.options:
2889
self.orig[name] = self.get(name, None)
2890
del self.options[name]
2892
def reset_changes(self):
2895
def apply_changes(self, dirty, store):
2896
"""Apply option value changes.
2898
``self`` has been reloaded from the persistent storage. ``dirty``
2899
contains the changes made since the previous loading.
2901
:param dirty: the mutable section containing the changes.
2903
:param store: the store containing the section
2905
for k, expected in dirty.orig.items():
2906
actual = dirty.get(k, _DeletedOption)
2907
reloaded = self.get(k, _NewlyCreatedOption)
2908
if actual is _DeletedOption:
2909
if k in self.options:
2913
# Report concurrent updates in an ad-hoc way. This should only
2914
# occurs when different processes try to update the same option
2915
# which is not supported (as in: the config framework is not meant
2916
# to be used as a sharing mechanism).
2917
if expected != reloaded:
2918
if actual is _DeletedOption:
2919
actual = '<DELETED>'
2920
if reloaded is _NewlyCreatedOption:
2921
reloaded = '<CREATED>'
2922
if expected is _NewlyCreatedOption:
2923
expected = '<CREATED>'
2924
# Someone changed the value since we get it from the persistent
2926
trace.warning(gettext(
2927
"Option {0} in section {1} of {2} was changed"
2928
" from {3} to {4}. The {5} value will be saved.".format(
2929
k, self.id, store.external_url(), expected,
2931
# No need to keep track of these changes
2932
self.reset_changes()
2935
class Store(object):
2936
"""Abstract interface to persistent storage for configuration options."""
2938
readonly_section_class = Section
2939
mutable_section_class = MutableSection
2942
# Which sections need to be saved (by section id). We use a dict here
2943
# so the dirty sections can be shared by multiple callers.
2944
self.dirty_sections = {}
2946
def is_loaded(self):
2947
"""Returns True if the Store has been loaded.
2949
This is used to implement lazy loading and ensure the persistent
2950
storage is queried only when needed.
2952
raise NotImplementedError(self.is_loaded)
2955
"""Loads the Store from persistent storage."""
2956
raise NotImplementedError(self.load)
2958
def _load_from_string(self, bytes):
2959
"""Create a store from a string in configobj syntax.
2961
:param bytes: A string representing the file content.
2963
raise NotImplementedError(self._load_from_string)
2966
"""Unloads the Store.
2968
This should make is_loaded() return False. This is used when the caller
2969
knows that the persistent storage has changed or may have change since
2972
raise NotImplementedError(self.unload)
2974
def quote(self, value):
2975
"""Quote a configuration option value for storing purposes.
2977
This allows Stacks to present values as they will be stored.
2981
def unquote(self, value):
2982
"""Unquote a configuration option value into unicode.
2984
The received value is quoted as stored.
2989
"""Saves the Store to persistent storage."""
2990
raise NotImplementedError(self.save)
2992
def _need_saving(self):
2993
for s in self.dirty_sections.values():
2995
# At least one dirty section contains a modification
2999
def apply_changes(self, dirty_sections):
3000
"""Apply changes from dirty sections while checking for coherency.
3002
The Store content is discarded and reloaded from persistent storage to
3003
acquire up-to-date values.
3005
Dirty sections are MutableSection which kept track of the value they
3006
are expected to update.
3008
# We need an up-to-date version from the persistent storage, unload the
3009
# store. The reload will occur when needed (triggered by the first
3010
# get_mutable_section() call below.
3012
# Apply the changes from the preserved dirty sections
3013
for section_id, dirty in dirty_sections.items():
3014
clean = self.get_mutable_section(section_id)
3015
clean.apply_changes(dirty, self)
3016
# Everything is clean now
3017
self.dirty_sections = {}
3019
def save_changes(self):
3020
"""Saves the Store to persistent storage if changes occurred.
3022
Apply the changes recorded in the mutable sections to a store content
3023
refreshed from persistent storage.
3025
raise NotImplementedError(self.save_changes)
3027
def external_url(self):
3028
raise NotImplementedError(self.external_url)
3030
def get_sections(self):
3031
"""Returns an ordered iterable of existing sections.
3033
:returns: An iterable of (store, section).
3035
raise NotImplementedError(self.get_sections)
3037
def get_mutable_section(self, section_id=None):
3038
"""Returns the specified mutable section.
3040
:param section_id: The section identifier
3042
raise NotImplementedError(self.get_mutable_section)
3045
# Mostly for debugging use
3046
return "<config.%s(%s)>" % (self.__class__.__name__,
3047
self.external_url())
3050
class CommandLineStore(Store):
3051
"A store to carry command line overrides for the config options."""
3053
def __init__(self, opts=None):
3054
super(CommandLineStore, self).__init__()
3061
# The dict should be cleared but not replaced so it can be shared.
3062
self.options.clear()
3064
def _from_cmdline(self, overrides):
3065
# Reset before accepting new definitions
3067
for over in overrides:
3069
name, value = over.split('=', 1)
3071
raise errors.BzrCommandError(
3072
gettext("Invalid '%s', should be of the form 'name=value'")
3074
self.options[name] = value
3076
def external_url(self):
3077
# Not an url but it makes debugging easier and is never needed
3081
def get_sections(self):
3082
yield self, self.readonly_section_class(None, self.options)
3085
class IniFileStore(Store):
3086
"""A config Store using ConfigObj for storage.
3088
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3089
serialize/deserialize the config file.
3093
"""A config Store using ConfigObj for storage.
3095
super(IniFileStore, self).__init__()
3096
self._config_obj = None
3098
def is_loaded(self):
3099
return self._config_obj != None
3102
self._config_obj = None
3103
self.dirty_sections = {}
3105
def _load_content(self):
3106
"""Load the config file bytes.
3108
This should be provided by subclasses
3110
:return: Byte string
3112
raise NotImplementedError(self._load_content)
3114
def _save_content(self, content):
3115
"""Save the config file bytes.
3117
This should be provided by subclasses
3119
:param content: Config file bytes to write
3121
raise NotImplementedError(self._save_content)
3124
"""Load the store from the associated file."""
3125
if self.is_loaded():
3127
content = self._load_content()
3128
self._load_from_string(content)
3129
for hook in ConfigHooks['load']:
3132
def _load_from_string(self, bytes):
3133
"""Create a config store from a string.
3135
:param bytes: A string representing the file content.
3137
if self.is_loaded():
3138
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3139
co_input = BytesIO(bytes)
3141
# The config files are always stored utf8-encoded
3142
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3144
except configobj.ConfigObjError as e:
3145
self._config_obj = None
3146
raise errors.ParseConfigError(e.errors, self.external_url())
3147
except UnicodeDecodeError:
3148
raise errors.ConfigContentError(self.external_url())
3150
def save_changes(self):
3151
if not self.is_loaded():
3154
if not self._need_saving():
3156
# Preserve the current version
3157
dirty_sections = self.dirty_sections.copy()
3158
self.apply_changes(dirty_sections)
3159
# Save to the persistent storage
3163
if not self.is_loaded():
3167
self._config_obj.write(out)
3168
self._save_content(out.getvalue())
3169
for hook in ConfigHooks['save']:
3172
def get_sections(self):
3173
"""Get the configobj section in the file order.
3175
:returns: An iterable of (store, section).
3177
# We need a loaded store
3180
except (errors.NoSuchFile, errors.PermissionDenied):
3181
# If the file can't be read, there is no sections
3183
cobj = self._config_obj
3185
yield self, self.readonly_section_class(None, cobj)
3186
for section_name in cobj.sections:
3188
self.readonly_section_class(section_name,
3189
cobj[section_name]))
3191
def get_mutable_section(self, section_id=None):
3192
# We need a loaded store
3195
except errors.NoSuchFile:
3196
# The file doesn't exist, let's pretend it was empty
3197
self._load_from_string('')
3198
if section_id in self.dirty_sections:
3199
# We already created a mutable section for this id
3200
return self.dirty_sections[section_id]
3201
if section_id is None:
3202
section = self._config_obj
3204
section = self._config_obj.setdefault(section_id, {})
3205
mutable_section = self.mutable_section_class(section_id, section)
3206
# All mutable sections can become dirty
3207
self.dirty_sections[section_id] = mutable_section
3208
return mutable_section
3210
def quote(self, value):
3212
# configobj conflates automagical list values and quoting
3213
self._config_obj.list_values = True
3214
return self._config_obj._quote(value)
3216
self._config_obj.list_values = False
3218
def unquote(self, value):
3219
if value and isinstance(value, string_types):
3220
# _unquote doesn't handle None nor empty strings nor anything that
3221
# is not a string, really.
3222
value = self._config_obj._unquote(value)
3225
def external_url(self):
3226
# Since an IniFileStore can be used without a file (at least in tests),
3227
# it's better to provide something than raising a NotImplementedError.
3228
# All daughter classes are supposed to provide an implementation
3230
return 'In-Process Store, no URL'
3233
class TransportIniFileStore(IniFileStore):
3234
"""IniFileStore that loads files from a transport.
3236
:ivar transport: The transport object where the config file is located.
3238
:ivar file_name: The config file basename in the transport directory.
3241
def __init__(self, transport, file_name):
3242
"""A Store using a ini file on a Transport
3244
:param transport: The transport object where the config file is located.
3245
:param file_name: The config file basename in the transport directory.
3247
super(TransportIniFileStore, self).__init__()
3248
self.transport = transport
3249
self.file_name = file_name
3251
def _load_content(self):
3253
return self.transport.get_bytes(self.file_name)
3254
except errors.PermissionDenied:
3255
trace.warning("Permission denied while trying to load "
3256
"configuration store %s.", self.external_url())
3259
def _save_content(self, content):
3260
self.transport.put_bytes(self.file_name, content)
3262
def external_url(self):
3263
# FIXME: external_url should really accepts an optional relpath
3264
# parameter (bug #750169) :-/ -- vila 2011-04-04
3265
# The following will do in the interim but maybe we don't want to
3266
# expose a path here but rather a config ID and its associated
3267
# object </hand wawe>.
3268
return urlutils.join(
3269
self.transport.external_url(), urlutils.escape(self.file_name))
3272
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3273
# unlockable stores for use with objects that can already ensure the locking
3274
# (think branches). If different stores (not based on ConfigObj) are created,
3275
# they may face the same issue.
3278
class LockableIniFileStore(TransportIniFileStore):
3279
"""A ConfigObjStore using locks on save to ensure store integrity."""
3281
def __init__(self, transport, file_name, lock_dir_name=None):
3282
"""A config Store using ConfigObj for storage.
3284
:param transport: The transport object where the config file is located.
3286
:param file_name: The config file basename in the transport directory.
3288
if lock_dir_name is None:
3289
lock_dir_name = 'lock'
3290
self.lock_dir_name = lock_dir_name
3291
super(LockableIniFileStore, self).__init__(transport, file_name)
3292
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3294
def lock_write(self, token=None):
3295
"""Takes a write lock in the directory containing the config file.
3297
If the directory doesn't exist it is created.
3299
# FIXME: This doesn't check the ownership of the created directories as
3300
# ensure_config_dir_exists does. It should if the transport is local
3301
# -- vila 2011-04-06
3302
self.transport.create_prefix()
3303
return self._lock.lock_write(token)
3308
def break_lock(self):
3309
self._lock.break_lock()
3313
# We need to be able to override the undecorated implementation
3314
self.save_without_locking()
3316
def save_without_locking(self):
3317
super(LockableIniFileStore, self).save()
3320
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3321
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3322
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3324
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3325
# functions or a registry will make it easier and clearer for tests, focusing
3326
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3327
# on a poolie's remark)
3328
class GlobalStore(LockableIniFileStore):
3329
"""A config store for global options.
3331
There is a single GlobalStore for a given process.
3334
def __init__(self, possible_transports=None):
3335
t = transport.get_transport_from_path(
3336
config_dir(), possible_transports=possible_transports)
3337
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3341
class LocationStore(LockableIniFileStore):
3342
"""A config store for options specific to a location.
3344
There is a single LocationStore for a given process.
3347
def __init__(self, possible_transports=None):
3348
t = transport.get_transport_from_path(
3349
config_dir(), possible_transports=possible_transports)
3350
super(LocationStore, self).__init__(t, 'locations.conf')
3351
self.id = 'locations'
3354
class BranchStore(TransportIniFileStore):
3355
"""A config store for branch options.
3357
There is a single BranchStore for a given branch.
3360
def __init__(self, branch):
3361
super(BranchStore, self).__init__(branch.control_transport,
3363
self.branch = branch
3367
class ControlStore(LockableIniFileStore):
3369
def __init__(self, bzrdir):
3370
super(ControlStore, self).__init__(bzrdir.transport,
3372
lock_dir_name='branch_lock')
3376
class SectionMatcher(object):
3377
"""Select sections into a given Store.
3379
This is intended to be used to postpone getting an iterable of sections
3383
def __init__(self, store):
3386
def get_sections(self):
3387
# This is where we require loading the store so we can see all defined
3389
sections = self.store.get_sections()
3390
# Walk the revisions in the order provided
3391
for store, s in sections:
3395
def match(self, section):
3396
"""Does the proposed section match.
3398
:param section: A Section object.
3400
:returns: True if the section matches, False otherwise.
3402
raise NotImplementedError(self.match)
3405
class NameMatcher(SectionMatcher):
3407
def __init__(self, store, section_id):
3408
super(NameMatcher, self).__init__(store)
3409
self.section_id = section_id
3411
def match(self, section):
3412
return section.id == self.section_id
3415
class LocationSection(Section):
3417
def __init__(self, section, extra_path, branch_name=None):
3418
super(LocationSection, self).__init__(section.id, section.options)
3419
self.extra_path = extra_path
3420
if branch_name is None:
3422
self.locals = {'relpath': extra_path,
3423
'basename': urlutils.basename(extra_path),
3424
'branchname': branch_name}
3426
def get(self, name, default=None, expand=True):
3427
value = super(LocationSection, self).get(name, default)
3428
if value is not None and expand:
3429
policy_name = self.get(name + ':policy', None)
3430
policy = _policy_value.get(policy_name, POLICY_NONE)
3431
if policy == POLICY_APPENDPATH:
3432
value = urlutils.join(value, self.extra_path)
3433
# expand section local options right now (since POLICY_APPENDPATH
3434
# will never add options references, it's ok to expand after it).
3436
for is_ref, chunk in iter_option_refs(value):
3438
chunks.append(chunk)
3441
if ref in self.locals:
3442
chunks.append(self.locals[ref])
3444
chunks.append(chunk)
3445
value = ''.join(chunks)
3449
class StartingPathMatcher(SectionMatcher):
3450
"""Select sections for a given location respecting the Store order."""
3452
# FIXME: Both local paths and urls can be used for section names as well as
3453
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3454
# inherited the fuzziness from the previous ``LocationConfig``
3455
# implementation. We probably need to revisit which encoding is allowed for
3456
# both ``location`` and section names and how we normalize
3457
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3458
# related too. -- vila 2012-01-04
3460
def __init__(self, store, location):
3461
super(StartingPathMatcher, self).__init__(store)
3462
if location.startswith('file://'):
3463
location = urlutils.local_path_from_url(location)
3464
self.location = location
3466
def get_sections(self):
3467
"""Get all sections matching ``location`` in the store.
3469
The most generic sections are described first in the store, then more
3470
specific ones can be provided for reduced scopes.
3472
The returned section are therefore returned in the reversed order so
3473
the most specific ones can be found first.
3475
location_parts = self.location.rstrip('/').split('/')
3477
# Later sections are more specific, they should be returned first
3478
for _, section in reversed(list(store.get_sections())):
3479
if section.id is None:
3480
# The no-name section is always included if present
3481
yield store, LocationSection(section, self.location)
3483
section_path = section.id
3484
if section_path.startswith('file://'):
3485
# the location is already a local path or URL, convert the
3486
# section id to the same format
3487
section_path = urlutils.local_path_from_url(section_path)
3488
if (self.location.startswith(section_path)
3489
or fnmatch.fnmatch(self.location, section_path)):
3490
section_parts = section_path.rstrip('/').split('/')
3491
extra_path = '/'.join(location_parts[len(section_parts):])
3492
yield store, LocationSection(section, extra_path)
3495
class LocationMatcher(SectionMatcher):
3497
def __init__(self, store, location):
3498
super(LocationMatcher, self).__init__(store)
3499
url, params = urlutils.split_segment_parameters(location)
3500
if location.startswith('file://'):
3501
location = urlutils.local_path_from_url(location)
3502
self.location = location
3503
branch_name = params.get('branch')
3504
if branch_name is None:
3505
self.branch_name = urlutils.basename(self.location)
3507
self.branch_name = urlutils.unescape(branch_name)
3509
def _get_matching_sections(self):
3510
"""Get all sections matching ``location``."""
3511
# We slightly diverge from LocalConfig here by allowing the no-name
3512
# section as the most generic one and the lower priority.
3513
no_name_section = None
3515
# Filter out the no_name_section so _iter_for_location_by_parts can be
3516
# used (it assumes all sections have a name).
3517
for _, section in self.store.get_sections():
3518
if section.id is None:
3519
no_name_section = section
3521
all_sections.append(section)
3522
# Unfortunately _iter_for_location_by_parts deals with section names so
3523
# we have to resync.
3524
filtered_sections = _iter_for_location_by_parts(
3525
[s.id for s in all_sections], self.location)
3526
iter_all_sections = iter(all_sections)
3527
matching_sections = []
3528
if no_name_section is not None:
3529
matching_sections.append(
3530
(0, LocationSection(no_name_section, self.location)))
3531
for section_id, extra_path, length in filtered_sections:
3532
# a section id is unique for a given store so it's safe to take the
3533
# first matching section while iterating. Also, all filtered
3534
# sections are part of 'all_sections' and will always be found
3537
section = next(iter_all_sections)
3538
if section_id == section.id:
3539
section = LocationSection(section, extra_path,
3541
matching_sections.append((length, section))
3543
return matching_sections
3545
def get_sections(self):
3546
# Override the default implementation as we want to change the order
3547
# We want the longest (aka more specific) locations first
3548
sections = sorted(self._get_matching_sections(),
3549
key=lambda match: (match[0], match[1].id),
3551
# Sections mentioning 'ignore_parents' restrict the selection
3552
for _, section in sections:
3553
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3554
ignore = section.get('ignore_parents', None)
3555
if ignore is not None:
3556
ignore = ui.bool_from_string(ignore)
3559
# Finally, we have a valid section
3560
yield self.store, section
3563
# FIXME: _shared_stores should be an attribute of a library state once a
3564
# library_state object is always available.
3566
_shared_stores_at_exit_installed = False
3568
class Stack(object):
3569
"""A stack of configurations where an option can be defined"""
3571
def __init__(self, sections_def, store=None, mutable_section_id=None):
3572
"""Creates a stack of sections with an optional store for changes.
3574
:param sections_def: A list of Section or callables that returns an
3575
iterable of Section. This defines the Sections for the Stack and
3576
can be called repeatedly if needed.
3578
:param store: The optional Store where modifications will be
3579
recorded. If none is specified, no modifications can be done.
3581
:param mutable_section_id: The id of the MutableSection where changes
3582
are recorded. This requires the ``store`` parameter to be
3585
self.sections_def = sections_def
3587
self.mutable_section_id = mutable_section_id
3589
def iter_sections(self):
3590
"""Iterate all the defined sections."""
3591
# Ensuring lazy loading is achieved by delaying section matching (which
3592
# implies querying the persistent storage) until it can't be avoided
3593
# anymore by using callables to describe (possibly empty) section
3595
for sections in self.sections_def:
3596
for store, section in sections():
3597
yield store, section
3599
def get(self, name, expand=True, convert=True):
3600
"""Return the *first* option value found in the sections.
3602
This is where we guarantee that sections coming from Store are loaded
3603
lazily: the loading is delayed until we need to either check that an
3604
option exists or get its value, which in turn may require to discover
3605
in which sections it can be defined. Both of these (section and option
3606
existence) require loading the store (even partially).
3608
:param name: The queried option.
3610
:param expand: Whether options references should be expanded.
3612
:param convert: Whether the option value should be converted from
3613
unicode (do nothing for non-registered options).
3615
:returns: The value of the option.
3617
# FIXME: No caching of options nor sections yet -- vila 20110503
3619
found_store = None # Where the option value has been found
3620
# If the option is registered, it may provide additional info about
3623
opt = option_registry.get(name)
3628
def expand_and_convert(val):
3629
# This may need to be called in different contexts if the value is
3630
# None or ends up being None during expansion or conversion.
3633
if isinstance(val, string_types):
3634
val = self._expand_options_in_string(val)
3636
trace.warning('Cannot expand "%s":'
3637
' %s does not support option expansion'
3638
% (name, type(val)))
3640
val = found_store.unquote(val)
3642
val = opt.convert_from_unicode(found_store, val)
3645
# First of all, check if the environment can override the configuration
3647
if opt is not None and opt.override_from_env:
3648
value = opt.get_override()
3649
value = expand_and_convert(value)
3651
for store, section in self.iter_sections():
3652
value = section.get(name)
3653
if value is not None:
3656
value = expand_and_convert(value)
3657
if opt is not None and value is None:
3658
# If the option is registered, it may provide a default value
3659
value = opt.get_default()
3660
value = expand_and_convert(value)
3661
for hook in ConfigHooks['get']:
3662
hook(self, name, value)
3665
def expand_options(self, string, env=None):
3666
"""Expand option references in the string in the configuration context.
3668
:param string: The string containing option(s) to expand.
3670
:param env: An option dict defining additional configuration options or
3671
overriding existing ones.
3673
:returns: The expanded string.
3675
return self._expand_options_in_string(string, env)
3677
def _expand_options_in_string(self, string, env=None, _refs=None):
3678
"""Expand options in the string in the configuration context.
3680
:param string: The string to be expanded.
3682
:param env: An option dict defining additional configuration options or
3683
overriding existing ones.
3685
:param _refs: Private list (FIFO) containing the options being expanded
3688
:returns: The expanded string.
3691
# Not much to expand there
3694
# What references are currently resolved (to detect loops)
3697
# We need to iterate until no more refs appear ({{foo}} will need two
3698
# iterations for example).
3703
for is_ref, chunk in iter_option_refs(result):
3705
chunks.append(chunk)
3710
raise errors.OptionExpansionLoop(string, _refs)
3712
value = self._expand_option(name, env, _refs)
3714
raise errors.ExpandingUnknownOption(name, string)
3715
chunks.append(value)
3717
result = ''.join(chunks)
3720
def _expand_option(self, name, env, _refs):
3721
if env is not None and name in env:
3722
# Special case, values provided in env takes precedence over
3726
value = self.get(name, expand=False, convert=False)
3727
value = self._expand_options_in_string(value, env, _refs)
3730
def _get_mutable_section(self):
3731
"""Get the MutableSection for the Stack.
3733
This is where we guarantee that the mutable section is lazily loaded:
3734
this means we won't load the corresponding store before setting a value
3735
or deleting an option. In practice the store will often be loaded but
3736
this helps catching some programming errors.
3739
section = store.get_mutable_section(self.mutable_section_id)
3740
return store, section
3742
def set(self, name, value):
3743
"""Set a new value for the option."""
3744
store, section = self._get_mutable_section()
3745
section.set(name, store.quote(value))
3746
for hook in ConfigHooks['set']:
3747
hook(self, name, value)
3749
def remove(self, name):
3750
"""Remove an existing option."""
3751
_, section = self._get_mutable_section()
3752
section.remove(name)
3753
for hook in ConfigHooks['remove']:
3757
# Mostly for debugging use
3758
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3760
def _get_overrides(self):
3761
# FIXME: Hack around library_state.initialize never called
3762
if breezy.global_state is not None:
3763
return breezy.global_state.cmdline_overrides.get_sections()
3766
def get_shared_store(self, store, state=None):
3767
"""Get a known shared store.
3769
Store urls uniquely identify them and are used to ensure a single copy
3770
is shared across all users.
3772
:param store: The store known to the caller.
3774
:param state: The library state where the known stores are kept.
3776
:returns: The store received if it's not a known one, an already known
3780
state = breezy.global_state
3782
global _shared_stores_at_exit_installed
3783
stores = _shared_stores
3784
def save_config_changes():
3785
for k, store in stores.items():
3786
store.save_changes()
3787
if not _shared_stores_at_exit_installed:
3788
# FIXME: Ugly hack waiting for library_state to always be
3789
# available. -- vila 20120731
3791
atexit.register(save_config_changes)
3792
_shared_stores_at_exit_installed = True
3794
stores = state.config_stores
3795
url = store.external_url()
3803
class MemoryStack(Stack):
3804
"""A configuration stack defined from a string.
3806
This is mainly intended for tests and requires no disk resources.
3809
def __init__(self, content=None):
3810
"""Create an in-memory stack from a given content.
3812
It uses a single store based on configobj and support reading and
3815
:param content: The initial content of the store. If None, the store is
3816
not loaded and ``_load_from_string`` can and should be used if
3819
store = IniFileStore()
3820
if content is not None:
3821
store._load_from_string(content)
3822
super(MemoryStack, self).__init__(
3823
[store.get_sections], store)
3826
class _CompatibleStack(Stack):
3827
"""Place holder for compatibility with previous design.
3829
This is intended to ease the transition from the Config-based design to the
3830
Stack-based design and should not be used nor relied upon by plugins.
3832
One assumption made here is that the daughter classes will all use Stores
3833
derived from LockableIniFileStore).
3835
It implements set() and remove () by re-loading the store before applying
3836
the modification and saving it.
3838
The long term plan being to implement a single write by store to save
3839
all modifications, this class should not be used in the interim.
3842
def set(self, name, value):
3845
super(_CompatibleStack, self).set(name, value)
3846
# Force a write to persistent storage
3849
def remove(self, name):
3852
super(_CompatibleStack, self).remove(name)
3853
# Force a write to persistent storage
3857
class GlobalStack(Stack):
3858
"""Global options only stack.
3860
The following sections are queried:
3862
* command-line overrides,
3864
* the 'DEFAULT' section in bazaar.conf
3866
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3871
gstore = self.get_shared_store(GlobalStore())
3872
super(GlobalStack, self).__init__(
3873
[self._get_overrides,
3874
NameMatcher(gstore, 'DEFAULT').get_sections],
3875
gstore, mutable_section_id='DEFAULT')
3878
class LocationStack(Stack):
3879
"""Per-location options falling back to global options stack.
3882
The following sections are queried:
3884
* command-line overrides,
3886
* the sections matching ``location`` in ``locations.conf``, the order being
3887
defined by the number of path components in the section glob, higher
3888
numbers first (from most specific section to most generic).
3890
* the 'DEFAULT' section in bazaar.conf
3892
This stack will use the ``location`` section in locations.conf as its
3896
def __init__(self, location):
3897
"""Make a new stack for a location and global configuration.
3899
:param location: A URL prefix to """
3900
lstore = self.get_shared_store(LocationStore())
3901
if location.startswith('file://'):
3902
location = urlutils.local_path_from_url(location)
3903
gstore = self.get_shared_store(GlobalStore())
3904
super(LocationStack, self).__init__(
3905
[self._get_overrides,
3906
LocationMatcher(lstore, location).get_sections,
3907
NameMatcher(gstore, 'DEFAULT').get_sections],
3908
lstore, mutable_section_id=location)
3911
class BranchStack(Stack):
3912
"""Per-location options falling back to branch then global options stack.
3914
The following sections are queried:
3916
* command-line overrides,
3918
* the sections matching ``location`` in ``locations.conf``, the order being
3919
defined by the number of path components in the section glob, higher
3920
numbers first (from most specific section to most generic),
3922
* the no-name section in branch.conf,
3924
* the ``DEFAULT`` section in ``bazaar.conf``.
3926
This stack will use the no-name section in ``branch.conf`` as its
3930
def __init__(self, branch):
3931
lstore = self.get_shared_store(LocationStore())
3932
bstore = branch._get_config_store()
3933
gstore = self.get_shared_store(GlobalStore())
3934
super(BranchStack, self).__init__(
3935
[self._get_overrides,
3936
LocationMatcher(lstore, branch.base).get_sections,
3937
NameMatcher(bstore, None).get_sections,
3938
NameMatcher(gstore, 'DEFAULT').get_sections],
3940
self.branch = branch
3942
def lock_write(self, token=None):
3943
return self.branch.lock_write(token)
3946
return self.branch.unlock()
3949
def set(self, name, value):
3950
super(BranchStack, self).set(name, value)
3951
# Unlocking the branch will trigger a store.save_changes() so the last
3952
# unlock saves all the changes.
3955
def remove(self, name):
3956
super(BranchStack, self).remove(name)
3957
# Unlocking the branch will trigger a store.save_changes() so the last
3958
# unlock saves all the changes.
3961
class RemoteControlStack(Stack):
3962
"""Remote control-only options stack."""
3964
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3965
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3966
# control.conf and is used only for stack options.
3968
def __init__(self, bzrdir):
3969
cstore = bzrdir._get_config_store()
3970
super(RemoteControlStack, self).__init__(
3971
[NameMatcher(cstore, None).get_sections],
3973
self.controldir = bzrdir
3976
class BranchOnlyStack(Stack):
3977
"""Branch-only options stack."""
3979
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3980
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3981
# -- vila 2011-12-16
3983
def __init__(self, branch):
3984
bstore = branch._get_config_store()
3985
super(BranchOnlyStack, self).__init__(
3986
[NameMatcher(bstore, None).get_sections],
3988
self.branch = branch
3990
def lock_write(self, token=None):
3991
return self.branch.lock_write(token)
3994
return self.branch.unlock()
3997
def set(self, name, value):
3998
super(BranchOnlyStack, self).set(name, value)
3999
# Force a write to persistent storage
4000
self.store.save_changes()
4003
def remove(self, name):
4004
super(BranchOnlyStack, self).remove(name)
4005
# Force a write to persistent storage
4006
self.store.save_changes()
4009
class cmd_config(commands.Command):
4010
__doc__ = """Display, set or remove a configuration option.
4012
Display the active value for option NAME.
4014
If --all is specified, NAME is interpreted as a regular expression and all
4015
matching options are displayed mentioning their scope and without resolving
4016
option references in the value). The active value that bzr will take into
4017
account is the first one displayed for each option.
4019
If NAME is not given, --all .* is implied (all options are displayed for the
4022
Setting a value is achieved by using NAME=value without spaces. The value
4023
is set in the most relevant scope and can be checked by displaying the
4026
Removing a value is achieved by using --remove NAME.
4029
takes_args = ['name?']
4033
# FIXME: This should be a registry option so that plugins can register
4034
# their own config files (or not) and will also address
4035
# http://pad.lv/788991 -- vila 20101115
4036
commands.Option('scope', help='Reduce the scope to the specified'
4037
' configuration file.',
4039
commands.Option('all',
4040
help='Display all the defined values for the matching options.',
4042
commands.Option('remove', help='Remove the option from'
4043
' the configuration file.'),
4046
_see_also = ['configuration']
4048
@commands.display_command
4049
def run(self, name=None, all=False, directory=None, scope=None,
4051
if directory is None:
4053
directory = directory_service.directories.dereference(directory)
4054
directory = urlutils.normalize_url(directory)
4056
raise errors.BzrError(
4057
'--all and --remove are mutually exclusive.')
4059
# Delete the option in the given scope
4060
self._remove_config_option(name, directory, scope)
4062
# Defaults to all options
4063
self._show_matching_options('.*', directory, scope)
4066
name, value = name.split('=', 1)
4068
# Display the option(s) value(s)
4070
self._show_matching_options(name, directory, scope)
4072
self._show_value(name, directory, scope)
4075
raise errors.BzrError(
4076
'Only one option can be set.')
4077
# Set the option value
4078
self._set_config_option(name, value, directory, scope)
4080
def _get_stack(self, directory, scope=None, write_access=False):
4081
"""Get the configuration stack specified by ``directory`` and ``scope``.
4083
:param directory: Where the configurations are derived from.
4085
:param scope: A specific config to start from.
4087
:param write_access: Whether a write access to the stack will be
4090
# FIXME: scope should allow access to plugin-specific stacks (even
4091
# reduced to the plugin-specific store), related to
4092
# http://pad.lv/788991 -- vila 2011-11-15
4093
if scope is not None:
4094
if scope == 'bazaar':
4095
return GlobalStack()
4096
elif scope == 'locations':
4097
return LocationStack(directory)
4098
elif scope == 'branch':
4100
controldir.ControlDir.open_containing_tree_or_branch(
4103
self.add_cleanup(br.lock_write().unlock)
4104
return br.get_config_stack()
4105
raise errors.NoSuchConfig(scope)
4109
controldir.ControlDir.open_containing_tree_or_branch(
4112
self.add_cleanup(br.lock_write().unlock)
4113
return br.get_config_stack()
4114
except errors.NotBranchError:
4115
return LocationStack(directory)
4117
def _quote_multiline(self, value):
4119
value = '"""' + value + '"""'
4122
def _show_value(self, name, directory, scope):
4123
conf = self._get_stack(directory, scope)
4124
value = conf.get(name, expand=True, convert=False)
4125
if value is not None:
4126
# Quote the value appropriately
4127
value = self._quote_multiline(value)
4128
self.outf.write('%s\n' % (value,))
4130
raise errors.NoSuchConfigOption(name)
4132
def _show_matching_options(self, name, directory, scope):
4133
name = lazy_regex.lazy_compile(name)
4134
# We want any error in the regexp to be raised *now* so we need to
4135
# avoid the delay introduced by the lazy regexp. But, we still do
4136
# want the nicer errors raised by lazy_regex.
4137
name._compile_and_collapse()
4140
conf = self._get_stack(directory, scope)
4141
for store, section in conf.iter_sections():
4142
for oname in section.iter_option_names():
4143
if name.search(oname):
4144
if cur_store_id != store.id:
4145
# Explain where the options are defined
4146
self.outf.write('%s:\n' % (store.id,))
4147
cur_store_id = store.id
4149
if (section.id is not None and cur_section != section.id):
4150
# Display the section id as it appears in the store
4151
# (None doesn't appear by definition)
4152
self.outf.write(' [%s]\n' % (section.id,))
4153
cur_section = section.id
4154
value = section.get(oname, expand=False)
4155
# Quote the value appropriately
4156
value = self._quote_multiline(value)
4157
self.outf.write(' %s = %s\n' % (oname, value))
4159
def _set_config_option(self, name, value, directory, scope):
4160
conf = self._get_stack(directory, scope, write_access=True)
4161
conf.set(name, value)
4162
# Explicitly save the changes
4163
conf.store.save_changes()
4165
def _remove_config_option(self, name, directory, scope):
4167
raise errors.BzrCommandError(
4168
'--remove expects an option to remove.')
4169
conf = self._get_stack(directory, scope, write_access=True)
4172
# Explicitly save the changes
4173
conf.store.save_changes()
4175
raise errors.NoSuchConfigOption(name)
4180
# We need adapters that can build a Store or a Stack in a test context. Test
4181
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4182
# themselves. The builder will receive a test instance and should return a
4183
# ready-to-use store or stack. Plugins that define new store/stacks can also
4184
# register themselves here to be tested against the tests defined in
4185
# breezy.tests.test_config. Note that the builder can be called multiple times
4186
# for the same test.
4188
# The registered object should be a callable receiving a test instance
4189
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4191
test_store_builder_registry = registry.Registry()
4193
# The registered object should be a callable receiving a test instance
4194
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4196
test_stack_builder_registry = registry.Registry()
added
removed
breezy/config.py
