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 (
134
POLICY_APPENDPATH = 2
138
POLICY_NORECURSE: 'norecurse',
139
POLICY_APPENDPATH: 'appendpath',
144
'norecurse': POLICY_NORECURSE,
145
'appendpath': POLICY_APPENDPATH,
149
STORE_LOCATION = POLICY_NONE
150
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
151
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
156
def signature_policy_from_unicode(signature_string):
157
"""Convert a string to a signing policy."""
158
if signature_string.lower() == 'check-available':
159
return CHECK_IF_POSSIBLE
160
if signature_string.lower() == 'ignore':
162
if signature_string.lower() == 'require':
164
raise ValueError("Invalid signatures policy '%s'"
168
def signing_policy_from_unicode(signature_string):
169
"""Convert a string to a signing policy."""
170
if signature_string.lower() == 'when-required':
171
return SIGN_WHEN_REQUIRED
172
if signature_string.lower() == 'never':
174
if signature_string.lower() == 'always':
176
raise ValueError("Invalid signing policy '%s'"
180
def _has_decode_bug():
181
"""True if configobj will fail to decode to unicode on Python 2."""
182
if sys.version_info > (3,):
184
conf = configobj.ConfigObj()
185
decode = getattr(conf, "_decode", None)
187
result = decode(b"\xc2\xa7", "utf-8")
188
if isinstance(result[0], str):
193
def _has_triplequote_bug():
194
"""True if triple quote logic is reversed, see lp:710410."""
195
conf = configobj.ConfigObj()
196
quote = getattr(conf, "_get_triple_quote", None)
197
if quote and quote('"""') != "'''":
202
class ConfigObj(configobj.ConfigObj):
204
def __init__(self, infile=None, **kwargs):
205
# We define our own interpolation mechanism calling it option expansion
206
super(ConfigObj, self).__init__(infile=infile,
210
if _has_decode_bug():
211
def _decode(self, infile, encoding):
212
if isinstance(infile, str) and encoding:
213
return infile.decode(encoding).splitlines(True)
214
return super(ConfigObj, self)._decode(infile, encoding)
216
if _has_triplequote_bug():
217
def _get_triple_quote(self, value):
218
quot = super(ConfigObj, self)._get_triple_quote(value)
219
if quot == configobj.tdquot:
220
return configobj.tsquot
221
return configobj.tdquot
223
def get_bool(self, section, key):
224
return self[section].as_bool(key)
226
def get_value(self, section, name):
227
# Try [] for the old DEFAULT section.
228
if section == "DEFAULT":
233
return self[section][name]
236
class Config(object):
237
"""A configuration policy - what username, editor, gpg needs etc."""
240
super(Config, self).__init__()
243
"""Returns a unique ID for the config."""
244
raise NotImplementedError(self.config_id)
246
def get_change_editor(self, old_tree, new_tree):
247
from breezy import diff
248
cmd = self._get_change_editor()
251
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
254
def _get_signature_checking(self):
255
"""Template method to override signature checking policy."""
257
def _get_signing_policy(self):
258
"""Template method to override signature creation policy."""
262
def expand_options(self, string, env=None):
263
"""Expand option references in the string in the configuration context.
265
:param string: The string containing option to expand.
267
:param env: An option dict defining additional configuration options or
268
overriding existing ones.
270
:returns: The expanded string.
272
return self._expand_options_in_string(string, env)
274
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
275
"""Expand options in a list of strings in the configuration context.
277
:param slist: A list of strings.
279
:param env: An option dict defining additional configuration options or
280
overriding existing ones.
282
:param _ref_stack: Private list containing the options being
283
expanded to detect loops.
285
:returns: The flatten list of expanded strings.
287
# expand options in each value separately flattening lists
290
value = self._expand_options_in_string(s, env, _ref_stack)
291
if isinstance(value, list):
297
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
298
"""Expand options in the string in the configuration context.
300
:param string: The string to be expanded.
302
:param env: An option dict defining additional configuration options or
303
overriding existing ones.
305
:param _ref_stack: Private list containing the options being
306
expanded to detect loops.
308
:returns: The expanded string.
311
# Not much to expand there
313
if _ref_stack is None:
314
# What references are currently resolved (to detect loops)
316
if self.option_ref_re is None:
317
# We want to match the most embedded reference first (i.e. for
318
# '{{foo}}' we will get '{foo}',
319
# for '{bar{baz}}' we will get '{baz}'
320
self.option_ref_re = re.compile('({[^{}]+})')
322
# We need to iterate until no more refs appear ({{foo}} will need two
323
# iterations for example).
325
raw_chunks = self.option_ref_re.split(result)
326
if len(raw_chunks) == 1:
327
# Shorcut the trivial case: no refs
331
# Split will isolate refs so that every other chunk is a ref
333
for chunk in raw_chunks:
336
# Keep only non-empty strings (or we get bogus empty
337
# slots when a list value is involved).
342
if name in _ref_stack:
343
raise errors.OptionExpansionLoop(string, _ref_stack)
344
_ref_stack.append(name)
345
value = self._expand_option(name, env, _ref_stack)
347
raise errors.ExpandingUnknownOption(name, string)
348
if isinstance(value, list):
356
# Once a list appears as the result of an expansion, all
357
# callers will get a list result. This allows a consistent
358
# behavior even when some options in the expansion chain
359
# defined as strings (no comma in their value) but their
360
# expanded value is a list.
361
return self._expand_options_in_list(chunks, env, _ref_stack)
363
result = ''.join(chunks)
366
def _expand_option(self, name, env, _ref_stack):
367
if env is not None and name in env:
368
# Special case, values provided in env takes precedence over
372
# FIXME: This is a limited implementation, what we really need is a
373
# way to query the brz config for the value of an option,
374
# respecting the scope rules (That is, once we implement fallback
375
# configs, getting the option value should restart from the top
376
# config, not the current one) -- vila 20101222
377
value = self.get_user_option(name, expand=False)
378
if isinstance(value, list):
379
value = self._expand_options_in_list(value, env, _ref_stack)
381
value = self._expand_options_in_string(value, env, _ref_stack)
384
def _get_user_option(self, option_name):
385
"""Template method to provide a user option."""
388
def get_user_option(self, option_name, expand=True):
389
"""Get a generic option - no special process, no default.
391
:param option_name: The queried option.
393
:param expand: Whether options references should be expanded.
395
:returns: The value of the option.
397
value = self._get_user_option(option_name)
399
if isinstance(value, list):
400
value = self._expand_options_in_list(value)
401
elif isinstance(value, dict):
402
trace.warning('Cannot expand "%s":'
403
' Dicts do not support option expansion'
406
value = self._expand_options_in_string(value)
407
for hook in OldConfigHooks['get']:
408
hook(self, option_name, value)
411
def get_user_option_as_bool(self, option_name, expand=None, default=None):
412
"""Get a generic option as a boolean.
414
:param expand: Allow expanding references to other config values.
415
:param default: Default value if nothing is configured
416
:return None if the option doesn't exist or its value can't be
417
interpreted as a boolean. Returns True or False otherwise.
419
s = self.get_user_option(option_name, expand=expand)
421
# The option doesn't exist
423
val = ui.bool_from_string(s)
425
# The value can't be interpreted as a boolean
426
trace.warning('Value "%s" is not a boolean for "%s"',
430
def get_user_option_as_list(self, option_name, expand=None):
431
"""Get a generic option as a list - no special process, no default.
433
:return None if the option doesn't exist. Returns the value as a list
436
l = self.get_user_option(option_name, expand=expand)
437
if isinstance(l, string_types):
438
# A single value, most probably the user forgot (or didn't care to
443
def _log_format(self):
444
"""See log_format()."""
447
def validate_signatures_in_log(self):
448
"""Show GPG signature validity in log"""
449
result = self._validate_signatures_in_log()
456
def _validate_signatures_in_log(self):
457
"""See validate_signatures_in_log()."""
460
def _post_commit(self):
461
"""See Config.post_commit."""
464
def user_email(self):
465
"""Return just the email component of a username."""
466
return extract_email_address(self.username())
469
"""Return email-style username.
471
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
473
$BRZ_EMAIL can be set to override this, then
474
the concrete policy type is checked, and finally
476
If no username can be found, errors.NoWhoami exception is raised.
478
v = os.environ.get('BRZ_EMAIL')
480
return v.decode(osutils.get_user_encoding())
481
v = self._get_user_id()
484
return default_email()
486
def ensure_username(self):
487
"""Raise errors.NoWhoami if username is not set.
489
This method relies on the username() function raising the error.
493
def get_alias(self, value):
494
return self._get_alias(value)
496
def _get_alias(self, value):
499
def get_nickname(self):
500
return self._get_nickname()
502
def _get_nickname(self):
505
def get_bzr_remote_path(self):
507
return os.environ['BZR_REMOTE_PATH']
509
path = self.get_user_option("bzr_remote_path")
514
def suppress_warning(self, warning):
515
"""Should the warning be suppressed or emitted.
517
:param warning: The name of the warning being tested.
519
:returns: True if the warning should be suppressed, False otherwise.
521
warnings = self.get_user_option_as_list('suppress_warnings')
522
if warnings is None or warning not in warnings:
527
def get_merge_tools(self):
529
for (oname, value, section, conf_id, parser) in self._get_options():
530
if oname.startswith('bzr.mergetool.'):
531
tool_name = oname[len('bzr.mergetool.'):]
532
tools[tool_name] = self.get_user_option(oname, False)
533
trace.mutter('loaded merge tools: %r' % tools)
536
def find_merge_tool(self, name):
537
# We fake a defaults mechanism here by checking if the given name can
538
# be found in the known_merge_tools if it's not found in the config.
539
# This should be done through the proposed config defaults mechanism
540
# when it becomes available in the future.
541
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
543
or mergetools.known_merge_tools.get(name, None))
547
class _ConfigHooks(hooks.Hooks):
548
"""A dict mapping hook names and a list of callables for configs.
552
"""Create the default hooks.
554
These are all empty initially, because by default nothing should get
557
super(_ConfigHooks, self).__init__('breezy.config', 'ConfigHooks')
558
self.add_hook('load',
559
'Invoked when a config store is loaded.'
560
' The signature is (store).',
562
self.add_hook('save',
563
'Invoked when a config store is saved.'
564
' The signature is (store).',
566
# The hooks for config options
568
'Invoked when a config option is read.'
569
' The signature is (stack, name, value).',
572
'Invoked when a config option is set.'
573
' The signature is (stack, name, value).',
575
self.add_hook('remove',
576
'Invoked when a config option is removed.'
577
' The signature is (stack, name).',
579
ConfigHooks = _ConfigHooks()
582
class _OldConfigHooks(hooks.Hooks):
583
"""A dict mapping hook names and a list of callables for configs.
587
"""Create the default hooks.
589
These are all empty initially, because by default nothing should get
592
super(_OldConfigHooks, self).__init__('breezy.config', 'OldConfigHooks')
593
self.add_hook('load',
594
'Invoked when a config store is loaded.'
595
' The signature is (config).',
597
self.add_hook('save',
598
'Invoked when a config store is saved.'
599
' The signature is (config).',
601
# The hooks for config options
603
'Invoked when a config option is read.'
604
' The signature is (config, name, value).',
607
'Invoked when a config option is set.'
608
' The signature is (config, name, value).',
610
self.add_hook('remove',
611
'Invoked when a config option is removed.'
612
' The signature is (config, name).',
614
OldConfigHooks = _OldConfigHooks()
617
class IniBasedConfig(Config):
618
"""A configuration policy that draws from ini files."""
620
def __init__(self, file_name=None):
621
"""Base class for configuration files using an ini-like syntax.
623
:param file_name: The configuration file path.
625
super(IniBasedConfig, self).__init__()
626
self.file_name = file_name
627
self.file_name = file_name
632
def from_string(cls, str_or_unicode, file_name=None, save=False):
633
"""Create a config object from a string.
635
:param str_or_unicode: A string representing the file content. This will
638
:param file_name: The configuration file path.
640
:param _save: Whether the file should be saved upon creation.
642
conf = cls(file_name=file_name)
643
conf._create_from_string(str_or_unicode, save)
646
def _create_from_string(self, str_or_unicode, save):
647
self._content = BytesIO(str_or_unicode.encode('utf-8'))
648
# Some tests use in-memory configs, some other always need the config
649
# file to exist on disk.
651
self._write_config_file()
653
def _get_parser(self):
654
if self._parser is not None:
656
if self._content is not None:
657
co_input = self._content
658
elif self.file_name is None:
659
raise AssertionError('We have no content to create the config')
661
co_input = self.file_name
663
self._parser = ConfigObj(co_input, encoding='utf-8')
664
except configobj.ConfigObjError as e:
665
raise errors.ParseConfigError(e.errors, e.config.filename)
666
except UnicodeDecodeError:
667
raise errors.ConfigContentError(self.file_name)
668
# Make sure self.reload() will use the right file name
669
self._parser.filename = self.file_name
670
for hook in OldConfigHooks['load']:
675
"""Reload the config file from disk."""
676
if self.file_name is None:
677
raise AssertionError('We need a file name to reload the config')
678
if self._parser is not None:
679
self._parser.reload()
680
for hook in ConfigHooks['load']:
683
def _get_matching_sections(self):
684
"""Return an ordered list of (section_name, extra_path) pairs.
686
If the section contains inherited configuration, extra_path is
687
a string containing the additional path components.
689
section = self._get_section()
690
if section is not None:
691
return [(section, '')]
695
def _get_section(self):
696
"""Override this to define the section used by the config."""
699
def _get_sections(self, name=None):
700
"""Returns an iterator of the sections specified by ``name``.
702
:param name: The section name. If None is supplied, the default
703
configurations are yielded.
705
:return: A tuple (name, section, config_id) for all sections that will
706
be walked by user_get_option() in the 'right' order. The first one
707
is where set_user_option() will update the value.
709
parser = self._get_parser()
711
yield (name, parser[name], self.config_id())
713
# No section name has been given so we fallback to the configobj
714
# itself which holds the variables defined outside of any section.
715
yield (None, parser, self.config_id())
717
def _get_options(self, sections=None):
718
"""Return an ordered list of (name, value, section, config_id) tuples.
720
All options are returned with their associated value and the section
721
they appeared in. ``config_id`` is a unique identifier for the
722
configuration file the option is defined in.
724
:param sections: Default to ``_get_matching_sections`` if not
725
specified. This gives a better control to daughter classes about
726
which sections should be searched. This is a list of (name,
731
parser = self._get_parser()
733
for (section_name, _) in self._get_matching_sections():
735
section = parser[section_name]
737
# This could happen for an empty file for which we define a
738
# DEFAULT section. FIXME: Force callers to provide sections
739
# instead ? -- vila 20100930
741
sections.append((section_name, section))
742
config_id = self.config_id()
743
for (section_name, section) in sections:
744
for (name, value) in section.iteritems():
745
yield (name, parser._quote(value), section_name,
748
def _get_option_policy(self, section, option_name):
749
"""Return the policy for the given (section, option_name) pair."""
752
def _get_change_editor(self):
753
return self.get_user_option('change_editor')
755
def _get_signature_checking(self):
756
"""See Config._get_signature_checking."""
757
policy = self._get_user_option('check_signatures')
759
return signature_policy_from_unicode(policy)
761
def _get_signing_policy(self):
762
"""See Config._get_signing_policy"""
763
policy = self._get_user_option('create_signatures')
765
return signing_policy_from_unicode(policy)
767
def _get_user_id(self):
768
"""Get the user id from the 'email' key in the current section."""
769
return self._get_user_option('email')
771
def _get_user_option(self, option_name):
772
"""See Config._get_user_option."""
773
for (section, extra_path) in self._get_matching_sections():
775
value = self._get_parser().get_value(section, option_name)
778
policy = self._get_option_policy(section, option_name)
779
if policy == POLICY_NONE:
781
elif policy == POLICY_NORECURSE:
782
# norecurse items only apply to the exact path
787
elif policy == POLICY_APPENDPATH:
789
value = urlutils.join(value, extra_path)
792
raise AssertionError('Unexpected config policy %r' % policy)
796
def _gpg_signing_command(self):
797
"""See Config.gpg_signing_command."""
798
return self._get_user_option('gpg_signing_command')
800
def _log_format(self):
801
"""See Config.log_format."""
802
return self._get_user_option('log_format')
804
def _validate_signatures_in_log(self):
805
"""See Config.validate_signatures_in_log."""
806
return self._get_user_option('validate_signatures_in_log')
808
def _acceptable_keys(self):
809
"""See Config.acceptable_keys."""
810
return self._get_user_option('acceptable_keys')
812
def _post_commit(self):
813
"""See Config.post_commit."""
814
return self._get_user_option('post_commit')
816
def _get_alias(self, value):
818
return self._get_parser().get_value("ALIASES",
823
def _get_nickname(self):
824
return self.get_user_option('nickname')
826
def remove_user_option(self, option_name, section_name=None):
827
"""Remove a user option and save the configuration file.
829
:param option_name: The option to be removed.
831
:param section_name: The section the option is defined in, default to
835
parser = self._get_parser()
836
if section_name is None:
839
section = parser[section_name]
841
del section[option_name]
843
raise errors.NoSuchConfigOption(option_name)
844
self._write_config_file()
845
for hook in OldConfigHooks['remove']:
846
hook(self, option_name)
848
def _write_config_file(self):
849
if self.file_name is None:
850
raise AssertionError('We cannot save, self.file_name is None')
851
conf_dir = os.path.dirname(self.file_name)
852
ensure_config_dir_exists(conf_dir)
853
atomic_file = atomicfile.AtomicFile(self.file_name)
854
self._get_parser().write(atomic_file)
857
osutils.copy_ownership_from_path(self.file_name)
858
for hook in OldConfigHooks['save']:
862
class LockableConfig(IniBasedConfig):
863
"""A configuration needing explicit locking for access.
865
If several processes try to write the config file, the accesses need to be
868
Daughter classes should decorate all methods that update a config with the
869
``@needs_write_lock`` decorator (they call, directly or indirectly, the
870
``_write_config_file()`` method. These methods (typically ``set_option()``
871
and variants must reload the config file from disk before calling
872
``_write_config_file()``), this can be achieved by calling the
873
``self.reload()`` method. Note that the lock scope should cover both the
874
reading and the writing of the config file which is why the decorator can't
875
be applied to ``_write_config_file()`` only.
877
This should be enough to implement the following logic:
878
- lock for exclusive write access,
879
- reload the config file from disk,
883
This logic guarantees that a writer can update a value without erasing an
884
update made by another writer.
889
def __init__(self, file_name):
890
super(LockableConfig, self).__init__(file_name=file_name)
891
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
892
# FIXME: It doesn't matter that we don't provide possible_transports
893
# below since this is currently used only for local config files ;
894
# local transports are not shared. But if/when we start using
895
# LockableConfig for other kind of transports, we will need to reuse
896
# whatever connection is already established -- vila 20100929
897
self.transport = transport.get_transport_from_path(self.dir)
898
self._lock = lockdir.LockDir(self.transport, self.lock_name)
900
def _create_from_string(self, unicode_bytes, save):
901
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
903
# We need to handle the saving here (as opposed to IniBasedConfig)
906
self._write_config_file()
909
def lock_write(self, token=None):
910
"""Takes a write lock in the directory containing the config file.
912
If the directory doesn't exist it is created.
914
ensure_config_dir_exists(self.dir)
915
return self._lock.lock_write(token)
920
def break_lock(self):
921
self._lock.break_lock()
924
def remove_user_option(self, option_name, section_name=None):
925
super(LockableConfig, self).remove_user_option(option_name,
928
def _write_config_file(self):
929
if self._lock is None or not self._lock.is_held:
930
# NB: if the following exception is raised it probably means a
931
# missing @needs_write_lock decorator on one of the callers.
932
raise errors.ObjectNotLocked(self)
933
super(LockableConfig, self)._write_config_file()
936
class GlobalConfig(LockableConfig):
937
"""The configuration that should be used for a specific location."""
940
super(GlobalConfig, self).__init__(file_name=config_filename())
946
def from_string(cls, str_or_unicode, save=False):
947
"""Create a config object from a string.
949
:param str_or_unicode: A string representing the file content. This
950
will be utf-8 encoded.
952
:param save: Whether the file should be saved upon creation.
955
conf._create_from_string(str_or_unicode, save)
959
def set_user_option(self, option, value):
960
"""Save option and its value in the configuration."""
961
self._set_option(option, value, 'DEFAULT')
963
def get_aliases(self):
964
"""Return the aliases section."""
965
if 'ALIASES' in self._get_parser():
966
return self._get_parser()['ALIASES']
971
def set_alias(self, alias_name, alias_command):
972
"""Save the alias in the configuration."""
973
self._set_option(alias_name, alias_command, 'ALIASES')
976
def unset_alias(self, alias_name):
977
"""Unset an existing alias."""
979
aliases = self._get_parser().get('ALIASES')
980
if not aliases or alias_name not in aliases:
981
raise errors.NoSuchAlias(alias_name)
982
del aliases[alias_name]
983
self._write_config_file()
985
def _set_option(self, option, value, section):
987
self._get_parser().setdefault(section, {})[option] = value
988
self._write_config_file()
989
for hook in OldConfigHooks['set']:
990
hook(self, option, value)
992
def _get_sections(self, name=None):
993
"""See IniBasedConfig._get_sections()."""
994
parser = self._get_parser()
995
# We don't give access to options defined outside of any section, we
996
# used the DEFAULT section by... default.
997
if name in (None, 'DEFAULT'):
998
# This could happen for an empty file where the DEFAULT section
999
# doesn't exist yet. So we force DEFAULT when yielding
1001
if 'DEFAULT' not in parser:
1002
parser['DEFAULT']= {}
1003
yield (name, parser[name], self.config_id())
1006
def remove_user_option(self, option_name, section_name=None):
1007
if section_name is None:
1008
# We need to force the default section.
1009
section_name = 'DEFAULT'
1010
# We need to avoid the LockableConfig implementation or we'll lock
1012
super(LockableConfig, self).remove_user_option(option_name,
1015
def _iter_for_location_by_parts(sections, location):
1016
"""Keep only the sessions matching the specified location.
1018
:param sections: An iterable of section names.
1020
:param location: An url or a local path to match against.
1022
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1023
number of path components in the section name, section is the section
1024
name and extra_path is the difference between location and the section
1027
``location`` will always be a local path and never a 'file://' url but the
1028
section names themselves can be in either form.
1030
location_parts = location.rstrip('/').split('/')
1032
for section in sections:
1033
# location is a local path if possible, so we need to convert 'file://'
1034
# urls in section names to local paths if necessary.
1036
# This also avoids having file:///path be a more exact
1037
# match than '/path'.
1039
# FIXME: This still raises an issue if a user defines both file:///path
1040
# *and* /path. Should we raise an error in this case -- vila 20110505
1042
if section.startswith('file://'):
1043
section_path = urlutils.local_path_from_url(section)
1045
section_path = section
1046
section_parts = section_path.rstrip('/').split('/')
1049
if len(section_parts) > len(location_parts):
1050
# More path components in the section, they can't match
1053
# Rely on zip truncating in length to the length of the shortest
1054
# argument sequence.
1055
for name in zip(location_parts, section_parts):
1056
if not fnmatch.fnmatch(name[0], name[1]):
1061
# build the path difference between the section and the location
1062
extra_path = '/'.join(location_parts[len(section_parts):])
1063
yield section, extra_path, len(section_parts)
1066
class LocationConfig(LockableConfig):
1067
"""A configuration object that gives the policy for a location."""
1069
def __init__(self, location):
1070
super(LocationConfig, self).__init__(
1071
file_name=locations_config_filename())
1072
# local file locations are looked up by local path, rather than
1073
# by file url. This is because the config file is a user
1074
# file, and we would rather not expose the user to file urls.
1075
if location.startswith('file://'):
1076
location = urlutils.local_path_from_url(location)
1077
self.location = location
1079
def config_id(self):
1083
def from_string(cls, str_or_unicode, location, save=False):
1084
"""Create a config object from a string.
1086
:param str_or_unicode: A string representing the file content. This will
1089
:param location: The location url to filter the configuration.
1091
:param save: Whether the file should be saved upon creation.
1093
conf = cls(location)
1094
conf._create_from_string(str_or_unicode, save)
1097
def _get_matching_sections(self):
1098
"""Return an ordered list of section names matching this location."""
1099
# put the longest (aka more specific) locations first
1101
_iter_for_location_by_parts(self._get_parser(), self.location),
1102
key=lambda match: (match[2], match[0]),
1104
for (section, extra_path, length) in matches:
1105
yield section, extra_path
1106
# should we stop looking for parent configs here?
1108
if self._get_parser()[section].as_bool('ignore_parents'):
1113
def _get_sections(self, name=None):
1114
"""See IniBasedConfig._get_sections()."""
1115
# We ignore the name here as the only sections handled are named with
1116
# the location path and we don't expose embedded sections either.
1117
parser = self._get_parser()
1118
for name, extra_path in self._get_matching_sections():
1119
yield (name, parser[name], self.config_id())
1121
def _get_option_policy(self, section, option_name):
1122
"""Return the policy for the given (section, option_name) pair."""
1123
# check for the old 'recurse=False' flag
1125
recurse = self._get_parser()[section].as_bool('recurse')
1129
return POLICY_NORECURSE
1131
policy_key = option_name + ':policy'
1133
policy_name = self._get_parser()[section][policy_key]
1137
return _policy_value[policy_name]
1139
def _set_option_policy(self, section, option_name, option_policy):
1140
"""Set the policy for the given option name in the given section."""
1141
policy_key = option_name + ':policy'
1142
policy_name = _policy_name[option_policy]
1143
if policy_name is not None:
1144
self._get_parser()[section][policy_key] = policy_name
1146
if policy_key in self._get_parser()[section]:
1147
del self._get_parser()[section][policy_key]
1150
def set_user_option(self, option, value, store=STORE_LOCATION):
1151
"""Save option and its value in the configuration."""
1152
if store not in [STORE_LOCATION,
1153
STORE_LOCATION_NORECURSE,
1154
STORE_LOCATION_APPENDPATH]:
1155
raise ValueError('bad storage policy %r for %r' %
1158
location = self.location
1159
if location.endswith('/'):
1160
location = location[:-1]
1161
parser = self._get_parser()
1162
if not location in parser and not location + '/' in parser:
1163
parser[location] = {}
1164
elif location + '/' in parser:
1165
location = location + '/'
1166
parser[location][option]=value
1167
# the allowed values of store match the config policies
1168
self._set_option_policy(location, option, store)
1169
self._write_config_file()
1170
for hook in OldConfigHooks['set']:
1171
hook(self, option, value)
1174
class BranchConfig(Config):
1175
"""A configuration object giving the policy for a branch."""
1177
def __init__(self, branch):
1178
super(BranchConfig, self).__init__()
1179
self._location_config = None
1180
self._branch_data_config = None
1181
self._global_config = None
1182
self.branch = branch
1183
self.option_sources = (self._get_location_config,
1184
self._get_branch_data_config,
1185
self._get_global_config)
1187
def config_id(self):
1190
def _get_branch_data_config(self):
1191
if self._branch_data_config is None:
1192
self._branch_data_config = TreeConfig(self.branch)
1193
self._branch_data_config.config_id = self.config_id
1194
return self._branch_data_config
1196
def _get_location_config(self):
1197
if self._location_config is None:
1198
self._location_config = LocationConfig(self.branch.base)
1199
return self._location_config
1201
def _get_global_config(self):
1202
if self._global_config is None:
1203
self._global_config = GlobalConfig()
1204
return self._global_config
1206
def _get_best_value(self, option_name):
1207
"""This returns a user option from local, tree or global config.
1209
They are tried in that order. Use get_safe_value if trusted values
1212
for source in self.option_sources:
1213
value = getattr(source(), option_name)()
1214
if value is not None:
1218
def _get_safe_value(self, option_name):
1219
"""This variant of get_best_value never returns untrusted values.
1221
It does not return values from the branch data, because the branch may
1222
not be controlled by the user.
1224
We may wish to allow locations.conf to control whether branches are
1225
trusted in the future.
1227
for source in (self._get_location_config, self._get_global_config):
1228
value = getattr(source(), option_name)()
1229
if value is not None:
1233
def _get_user_id(self):
1234
"""Return the full user id for the branch.
1236
e.g. "John Hacker <jhacker@example.com>"
1237
This is looked up in the email controlfile for the branch.
1239
return self._get_best_value('_get_user_id')
1241
def _get_change_editor(self):
1242
return self._get_best_value('_get_change_editor')
1244
def _get_signature_checking(self):
1245
"""See Config._get_signature_checking."""
1246
return self._get_best_value('_get_signature_checking')
1248
def _get_signing_policy(self):
1249
"""See Config._get_signing_policy."""
1250
return self._get_best_value('_get_signing_policy')
1252
def _get_user_option(self, option_name):
1253
"""See Config._get_user_option."""
1254
for source in self.option_sources:
1255
value = source()._get_user_option(option_name)
1256
if value is not None:
1260
def _get_sections(self, name=None):
1261
"""See IniBasedConfig.get_sections()."""
1262
for source in self.option_sources:
1263
for section in source()._get_sections(name):
1266
def _get_options(self, sections=None):
1268
# First the locations options
1269
for option in self._get_location_config()._get_options():
1271
# Then the branch options
1272
branch_config = self._get_branch_data_config()
1273
if sections is None:
1274
sections = [('DEFAULT', branch_config._get_parser())]
1275
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1276
# Config itself has no notion of sections :( -- vila 20101001
1277
config_id = self.config_id()
1278
for (section_name, section) in sections:
1279
for (name, value) in section.iteritems():
1280
yield (name, value, section_name,
1281
config_id, branch_config._get_parser())
1282
# Then the global options
1283
for option in self._get_global_config()._get_options():
1286
def set_user_option(self, name, value, store=STORE_BRANCH,
1288
if store == STORE_BRANCH:
1289
self._get_branch_data_config().set_option(value, name)
1290
elif store == STORE_GLOBAL:
1291
self._get_global_config().set_user_option(name, value)
1293
self._get_location_config().set_user_option(name, value, store)
1296
if store in (STORE_GLOBAL, STORE_BRANCH):
1297
mask_value = self._get_location_config().get_user_option(name)
1298
if mask_value is not None:
1299
trace.warning('Value "%s" is masked by "%s" from'
1300
' locations.conf', value, mask_value)
1302
if store == STORE_GLOBAL:
1303
branch_config = self._get_branch_data_config()
1304
mask_value = branch_config.get_user_option(name)
1305
if mask_value is not None:
1306
trace.warning('Value "%s" is masked by "%s" from'
1307
' branch.conf', value, mask_value)
1309
def remove_user_option(self, option_name, section_name=None):
1310
self._get_branch_data_config().remove_option(option_name, section_name)
1312
def _gpg_signing_command(self):
1313
"""See Config.gpg_signing_command."""
1314
return self._get_safe_value('_gpg_signing_command')
1316
def _post_commit(self):
1317
"""See Config.post_commit."""
1318
return self._get_safe_value('_post_commit')
1320
def _get_nickname(self):
1321
value = self._get_explicit_nickname()
1322
if value is not None:
1324
if self.branch.name:
1325
return self.branch.name
1326
return urlutils.unescape(self.branch.base.split('/')[-2])
1328
def has_explicit_nickname(self):
1329
"""Return true if a nickname has been explicitly assigned."""
1330
return self._get_explicit_nickname() is not None
1332
def _get_explicit_nickname(self):
1333
return self._get_best_value('_get_nickname')
1335
def _log_format(self):
1336
"""See Config.log_format."""
1337
return self._get_best_value('_log_format')
1339
def _validate_signatures_in_log(self):
1340
"""See Config.validate_signatures_in_log."""
1341
return self._get_best_value('_validate_signatures_in_log')
1343
def _acceptable_keys(self):
1344
"""See Config.acceptable_keys."""
1345
return self._get_best_value('_acceptable_keys')
1348
def ensure_config_dir_exists(path=None):
1349
"""Make sure a configuration directory exists.
1350
This makes sure that the directory exists.
1351
On windows, since configuration directories are 2 levels deep,
1352
it makes sure both the directory and the parent directory exists.
1356
if not os.path.isdir(path):
1357
if sys.platform == 'win32':
1358
parent_dir = os.path.dirname(path)
1359
if not os.path.isdir(parent_dir):
1360
trace.mutter('creating config parent directory: %r', parent_dir)
1361
os.mkdir(parent_dir)
1362
trace.mutter('creating config directory: %r', path)
1364
osutils.copy_ownership_from_path(path)
1367
def bazaar_config_dir():
1368
"""Return per-user configuration directory as unicode string
1370
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1371
and Linux. On Mac OS X and Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1372
that will be used instead.
1374
TODO: Global option --config-dir to override this.
1376
base = osutils.path_from_environ('BZR_HOME')
1377
if sys.platform == 'win32':
1379
base = win32utils.get_appdata_location()
1381
base = win32utils.get_home_location()
1382
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1383
# APPDATA, but hard to move. See bug 348640 for more.
1384
return osutils.pathjoin(base, 'bazaar', '2.0')
1386
xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1388
xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1389
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1390
if osutils.isdir(xdg_dir):
1392
"Using configuration in XDG directory %s." % xdg_dir)
1394
base = osutils._get_home_dir()
1395
return osutils.pathjoin(base, ".bazaar")
1399
"""Return per-user configuration directory as unicode string
1401
By default this is %APPDATA%/breezy on Windows, $XDG_CONFIG_HOME/breezy on
1402
Mac OS X and Linux. If the breezy config directory doesn't exist but
1403
the bazaar one (see bazaar_config_dir()) does, use that instead.
1405
TODO: Global option --config-dir to override this.
1407
base = osutils.path_from_environ('BRZ_HOME')
1408
if sys.platform == 'win32':
1410
base = win32utils.get_appdata_location()
1412
base = win32utils.get_home_location()
1413
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1414
# APPDATA, but hard to move. See bug 348640 for more.
1416
base = osutils.path_from_environ('XDG_CONFIG_HOME')
1418
base = osutils.pathjoin(osutils._get_home_dir(), ".config")
1419
breezy_dir = osutils.pathjoin(base, 'breezy')
1420
if osutils.isdir(breezy_dir):
1422
# If the breezy directory doesn't exist, but the bazaar one does, use that:
1423
bazaar_dir = bazaar_config_dir()
1424
if osutils.isdir(bazaar_dir):
1426
"Using Bazaar configuration directory (%s)", bazaar_dir)
1431
def config_filename():
1432
"""Return per-user configuration ini file filename."""
1433
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1436
def locations_config_filename():
1437
"""Return per-user configuration ini file filename."""
1438
return osutils.pathjoin(config_dir(), 'locations.conf')
1441
def authentication_config_filename():
1442
"""Return per-user authentication ini file filename."""
1443
return osutils.pathjoin(config_dir(), 'authentication.conf')
1446
def user_ignore_config_filename():
1447
"""Return the user default ignore filename"""
1448
return osutils.pathjoin(config_dir(), 'ignore')
1452
"""Return the directory name to store crash files.
1454
This doesn't implicitly create it.
1456
On Windows it's in the config directory; elsewhere it's /var/crash
1457
which may be monitored by apport. It can be overridden by
1460
if sys.platform == 'win32':
1461
return osutils.pathjoin(config_dir(), 'Crash')
1463
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1465
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1468
def xdg_cache_dir():
1469
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1470
# Possibly this should be different on Windows?
1471
e = os.environ.get('XDG_CACHE_HOME', None)
1475
return os.path.expanduser('~/.cache')
1478
def _get_default_mail_domain(mailname_file='/etc/mailname'):
1479
"""If possible, return the assumed default email domain.
1481
:returns: string mail domain, or None.
1483
if sys.platform == 'win32':
1484
# No implementation yet; patches welcome
1487
f = open(mailname_file)
1488
except (IOError, OSError) as e:
1491
domain = f.readline().strip()
1497
def default_email():
1498
v = os.environ.get('BRZ_EMAIL')
1500
return v.decode(osutils.get_user_encoding())
1501
v = os.environ.get('EMAIL')
1503
return v.decode(osutils.get_user_encoding())
1504
name, email = _auto_user_id()
1506
return u'%s <%s>' % (name, email)
1509
raise errors.NoWhoami()
1512
def _auto_user_id():
1513
"""Calculate automatic user identification.
1515
:returns: (realname, email), either of which may be None if they can't be
1518
Only used when none is set in the environment or the id file.
1520
This only returns an email address if we can be fairly sure the
1521
address is reasonable, ie if /etc/mailname is set on unix.
1523
This doesn't use the FQDN as the default domain because that may be
1524
slow, and it doesn't use the hostname alone because that's not normally
1525
a reasonable address.
1527
if sys.platform == 'win32':
1528
# No implementation to reliably determine Windows default mail
1529
# address; please add one.
1532
default_mail_domain = _get_default_mail_domain()
1533
if not default_mail_domain:
1539
w = pwd.getpwuid(uid)
1541
trace.mutter('no passwd entry for uid %d?' % uid)
1544
# we try utf-8 first, because on many variants (like Linux),
1545
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1546
# false positives. (many users will have their user encoding set to
1547
# latin-1, which cannot raise UnicodeError.)
1549
gecos = w.pw_gecos.decode('utf-8')
1551
except UnicodeError:
1553
encoding = osutils.get_user_encoding()
1554
gecos = w.pw_gecos.decode(encoding)
1555
except UnicodeError as e:
1556
trace.mutter("cannot decode passwd entry %s" % w)
1559
username = w.pw_name.decode(encoding)
1560
except UnicodeError as e:
1561
trace.mutter("cannot decode passwd entry %s" % w)
1564
comma = gecos.find(',')
1568
realname = gecos[:comma]
1570
return realname, (username + '@' + default_mail_domain)
1573
def parse_username(username):
1574
"""Parse e-mail username and return a (name, address) tuple."""
1575
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1577
return (username, '')
1579
return (match.group(1), match.group(2))
1582
def extract_email_address(e):
1583
"""Return just the address part of an email string.
1585
That is just the user@domain part, nothing else.
1586
This part is required to contain only ascii characters.
1587
If it can't be extracted, raises an error.
1589
>>> extract_email_address('Jane Tester <jane@test.com>')
1592
name, email = parse_username(e)
1594
raise errors.NoEmailInUsername(e)
1598
class TreeConfig(IniBasedConfig):
1599
"""Branch configuration data associated with its contents, not location"""
1601
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1603
def __init__(self, branch):
1604
self._config = branch._get_config()
1605
self.branch = branch
1607
def _get_parser(self, file=None):
1608
if file is not None:
1609
return IniBasedConfig._get_parser(file)
1610
return self._config._get_configobj()
1612
def get_option(self, name, section=None, default=None):
1613
self.branch.lock_read()
1615
return self._config.get_option(name, section, default)
1617
self.branch.unlock()
1619
def set_option(self, value, name, section=None):
1620
"""Set a per-branch configuration option"""
1621
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1622
# higher levels providing the right lock -- vila 20101004
1623
self.branch.lock_write()
1625
self._config.set_option(value, name, section)
1627
self.branch.unlock()
1629
def remove_option(self, option_name, section_name=None):
1630
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1631
# higher levels providing the right lock -- vila 20101004
1632
self.branch.lock_write()
1634
self._config.remove_option(option_name, section_name)
1636
self.branch.unlock()
1639
class AuthenticationConfig(object):
1640
"""The authentication configuration file based on a ini file.
1642
Implements the authentication.conf file described in
1643
doc/developers/authentication-ring.txt.
1646
def __init__(self, _file=None):
1647
self._config = None # The ConfigObj
1649
self._filename = authentication_config_filename()
1650
self._input = self._filename = authentication_config_filename()
1652
# Tests can provide a string as _file
1653
self._filename = None
1656
def _get_config(self):
1657
if self._config is not None:
1660
# FIXME: Should we validate something here ? Includes: empty
1661
# sections are useless, at least one of
1662
# user/password/password_encoding should be defined, etc.
1664
# Note: the encoding below declares that the file itself is utf-8
1665
# encoded, but the values in the ConfigObj are always Unicode.
1666
self._config = ConfigObj(self._input, encoding='utf-8')
1667
except configobj.ConfigObjError as e:
1668
raise errors.ParseConfigError(e.errors, e.config.filename)
1669
except UnicodeError:
1670
raise errors.ConfigContentError(self._filename)
1674
"""Save the config file, only tests should use it for now."""
1675
conf_dir = os.path.dirname(self._filename)
1676
ensure_config_dir_exists(conf_dir)
1677
f = file(self._filename, 'wb')
1679
self._get_config().write(f)
1683
def _set_option(self, section_name, option_name, value):
1684
"""Set an authentication configuration option"""
1685
conf = self._get_config()
1686
section = conf.get(section_name)
1689
section = conf[section]
1690
section[option_name] = value
1693
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1695
"""Returns the matching credentials from authentication.conf file.
1697
:param scheme: protocol
1699
:param host: the server address
1701
:param port: the associated port (optional)
1703
:param user: login (optional)
1705
:param path: the absolute path on the server (optional)
1707
:param realm: the http authentication realm (optional)
1709
:return: A dict containing the matching credentials or None.
1711
- name: the section name of the credentials in the
1712
authentication.conf file,
1713
- user: can't be different from the provided user if any,
1714
- scheme: the server protocol,
1715
- host: the server address,
1716
- port: the server port (can be None),
1717
- path: the absolute server path (can be None),
1718
- realm: the http specific authentication realm (can be None),
1719
- password: the decoded password, could be None if the credential
1720
defines only the user
1721
- verify_certificates: https specific, True if the server
1722
certificate should be verified, False otherwise.
1725
for auth_def_name, auth_def in self._get_config().iteritems():
1726
if not isinstance(auth_def, configobj.Section):
1727
raise ValueError("%s defined outside a section" % auth_def_name)
1729
a_scheme, a_host, a_user, a_path = map(
1730
auth_def.get, ['scheme', 'host', 'user', 'path'])
1733
a_port = auth_def.as_int('port')
1737
raise ValueError("'port' not numeric in %s" % auth_def_name)
1739
a_verify_certificates = auth_def.as_bool('verify_certificates')
1741
a_verify_certificates = True
1744
"'verify_certificates' not boolean in %s" % auth_def_name)
1747
if a_scheme is not None and scheme != a_scheme:
1749
if a_host is not None:
1750
if not (host == a_host
1751
or (a_host.startswith('.') and host.endswith(a_host))):
1753
if a_port is not None and port != a_port:
1755
if (a_path is not None and path is not None
1756
and not path.startswith(a_path)):
1758
if (a_user is not None and user is not None
1759
and a_user != user):
1760
# Never contradict the caller about the user to be used
1765
# Prepare a credentials dictionary with additional keys
1766
# for the credential providers
1767
credentials = dict(name=auth_def_name,
1774
password=auth_def.get('password', None),
1775
verify_certificates=a_verify_certificates)
1776
# Decode the password in the credentials (or get one)
1777
self.decode_password(credentials,
1778
auth_def.get('password_encoding', None))
1779
if 'auth' in debug.debug_flags:
1780
trace.mutter("Using authentication section: %r", auth_def_name)
1783
if credentials is None:
1784
# No credentials were found in authentication.conf, try the fallback
1785
# credentials stores.
1786
credentials = credential_store_registry.get_fallback_credentials(
1787
scheme, host, port, user, path, realm)
1791
def set_credentials(self, name, host, user, scheme=None, password=None,
1792
port=None, path=None, verify_certificates=None,
1794
"""Set authentication credentials for a host.
1796
Any existing credentials with matching scheme, host, port and path
1797
will be deleted, regardless of name.
1799
:param name: An arbitrary name to describe this set of credentials.
1800
:param host: Name of the host that accepts these credentials.
1801
:param user: The username portion of these credentials.
1802
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1804
:param password: Password portion of these credentials.
1805
:param port: The IP port on the host that these credentials apply to.
1806
:param path: A filesystem path on the host that these credentials
1808
:param verify_certificates: On https, verify server certificates if
1810
:param realm: The http authentication realm (optional).
1812
values = {'host': host, 'user': user}
1813
if password is not None:
1814
values['password'] = password
1815
if scheme is not None:
1816
values['scheme'] = scheme
1817
if port is not None:
1818
values['port'] = '%d' % port
1819
if path is not None:
1820
values['path'] = path
1821
if verify_certificates is not None:
1822
values['verify_certificates'] = str(verify_certificates)
1823
if realm is not None:
1824
values['realm'] = realm
1825
config = self._get_config()
1827
for section, existing_values in config.iteritems():
1828
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1829
if existing_values.get(key) != values.get(key):
1833
config.update({name: values})
1836
def get_user(self, scheme, host, port=None, realm=None, path=None,
1837
prompt=None, ask=False, default=None):
1838
"""Get a user from authentication file.
1840
:param scheme: protocol
1842
:param host: the server address
1844
:param port: the associated port (optional)
1846
:param realm: the realm sent by the server (optional)
1848
:param path: the absolute path on the server (optional)
1850
:param ask: Ask the user if there is no explicitly configured username
1853
:param default: The username returned if none is defined (optional).
1855
:return: The found user.
1857
credentials = self.get_credentials(scheme, host, port, user=None,
1858
path=path, realm=realm)
1859
if credentials is not None:
1860
user = credentials['user']
1866
# Create a default prompt suitable for most cases
1867
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1868
# Special handling for optional fields in the prompt
1869
if port is not None:
1870
prompt_host = '%s:%d' % (host, port)
1873
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1878
def get_password(self, scheme, host, user, port=None,
1879
realm=None, path=None, prompt=None):
1880
"""Get a password from authentication file or prompt the user for one.
1882
:param scheme: protocol
1884
:param host: the server address
1886
:param port: the associated port (optional)
1890
:param realm: the realm sent by the server (optional)
1892
:param path: the absolute path on the server (optional)
1894
:return: The found password or the one entered by the user.
1896
credentials = self.get_credentials(scheme, host, port, user, path,
1898
if credentials is not None:
1899
password = credentials['password']
1900
if password is not None and scheme is 'ssh':
1901
trace.warning('password ignored in section [%s],'
1902
' use an ssh agent instead'
1903
% credentials['name'])
1907
# Prompt user only if we could't find a password
1908
if password is None:
1910
# Create a default prompt suitable for most cases
1911
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1912
# Special handling for optional fields in the prompt
1913
if port is not None:
1914
prompt_host = '%s:%d' % (host, port)
1917
password = ui.ui_factory.get_password(prompt,
1918
host=prompt_host, user=user)
1921
def decode_password(self, credentials, encoding):
1923
cs = credential_store_registry.get_credential_store(encoding)
1925
raise ValueError('%r is not a known password_encoding' % encoding)
1926
credentials['password'] = cs.decode_password(credentials)
1930
class CredentialStoreRegistry(registry.Registry):
1931
"""A class that registers credential stores.
1933
A credential store provides access to credentials via the password_encoding
1934
field in authentication.conf sections.
1936
Except for stores provided by brz itself, most stores are expected to be
1937
provided by plugins that will therefore use
1938
register_lazy(password_encoding, module_name, member_name, help=help,
1939
fallback=fallback) to install themselves.
1941
A fallback credential store is one that is queried if no credentials can be
1942
found via authentication.conf.
1945
def get_credential_store(self, encoding=None):
1946
cs = self.get(encoding)
1951
def is_fallback(self, name):
1952
"""Check if the named credentials store should be used as fallback."""
1953
return self.get_info(name)
1955
def get_fallback_credentials(self, scheme, host, port=None, user=None,
1956
path=None, realm=None):
1957
"""Request credentials from all fallback credentials stores.
1959
The first credentials store that can provide credentials wins.
1962
for name in self.keys():
1963
if not self.is_fallback(name):
1965
cs = self.get_credential_store(name)
1966
credentials = cs.get_credentials(scheme, host, port, user,
1968
if credentials is not None:
1969
# We found some credentials
1973
def register(self, key, obj, help=None, override_existing=False,
1975
"""Register a new object to a name.
1977
:param key: This is the key to use to request the object later.
1978
:param obj: The object to register.
1979
:param help: Help text for this entry. This may be a string or
1980
a callable. If it is a callable, it should take two
1981
parameters (registry, key): this registry and the key that
1982
the help was registered under.
1983
:param override_existing: Raise KeyErorr if False and something has
1984
already been registered for that key. If True, ignore if there
1985
is an existing key (always register the new value).
1986
:param fallback: Whether this credential store should be
1989
return super(CredentialStoreRegistry,
1990
self).register(key, obj, help, info=fallback,
1991
override_existing=override_existing)
1993
def register_lazy(self, key, module_name, member_name,
1994
help=None, override_existing=False,
1996
"""Register a new credential store to be loaded on request.
1998
:param module_name: The python path to the module. Such as 'os.path'.
1999
:param member_name: The member of the module to return. If empty or
2000
None, get() will return the module itself.
2001
:param help: Help text for this entry. This may be a string or
2003
:param override_existing: If True, replace the existing object
2004
with the new one. If False, if there is already something
2005
registered with the same key, raise a KeyError
2006
:param fallback: Whether this credential store should be
2009
return super(CredentialStoreRegistry, self).register_lazy(
2010
key, module_name, member_name, help,
2011
info=fallback, override_existing=override_existing)
2014
credential_store_registry = CredentialStoreRegistry()
2017
class CredentialStore(object):
2018
"""An abstract class to implement storage for credentials"""
2020
def decode_password(self, credentials):
2021
"""Returns a clear text password for the provided credentials."""
2022
raise NotImplementedError(self.decode_password)
2024
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2026
"""Return the matching credentials from this credential store.
2028
This method is only called on fallback credential stores.
2030
raise NotImplementedError(self.get_credentials)
2034
class PlainTextCredentialStore(CredentialStore):
2035
__doc__ = """Plain text credential store for the authentication.conf file"""
2037
def decode_password(self, credentials):
2038
"""See CredentialStore.decode_password."""
2039
return credentials['password']
2042
credential_store_registry.register('plain', PlainTextCredentialStore,
2043
help=PlainTextCredentialStore.__doc__)
2044
credential_store_registry.default_key = 'plain'
2047
class Base64CredentialStore(CredentialStore):
2048
__doc__ = """Base64 credential store for the authentication.conf file"""
2050
def decode_password(self, credentials):
2051
"""See CredentialStore.decode_password."""
2052
# GZ 2012-07-28: Will raise binascii.Error if password is not base64,
2053
# should probably propogate as something more useful.
2054
return base64.decodestring(credentials['password'])
2056
credential_store_registry.register('base64', Base64CredentialStore,
2057
help=Base64CredentialStore.__doc__)
2060
class BzrDirConfig(object):
2062
def __init__(self, bzrdir):
2063
self._bzrdir = bzrdir
2064
self._config = bzrdir._get_config()
2066
def set_default_stack_on(self, value):
2067
"""Set the default stacking location.
2069
It may be set to a location, or None.
2071
This policy affects all branches contained by this control dir, except
2072
for those under repositories.
2074
if self._config is None:
2075
raise errors.BzrError("Cannot set configuration in %s"
2078
self._config.set_option('', 'default_stack_on')
2080
self._config.set_option(value, 'default_stack_on')
2082
def get_default_stack_on(self):
2083
"""Return the default stacking location.
2085
This will either be a location, or None.
2087
This policy affects all branches contained by this control dir, except
2088
for those under repositories.
2090
if self._config is None:
2092
value = self._config.get_option('default_stack_on')
2098
class TransportConfig(object):
2099
"""A Config that reads/writes a config file on a Transport.
2101
It is a low-level object that considers config data to be name/value pairs
2102
that may be associated with a section. Assigning meaning to these values
2103
is done at higher levels like TreeConfig.
2106
def __init__(self, transport, filename):
2107
self._transport = transport
2108
self._filename = filename
2110
def get_option(self, name, section=None, default=None):
2111
"""Return the value associated with a named option.
2113
:param name: The name of the value
2114
:param section: The section the option is in (if any)
2115
:param default: The value to return if the value is not set
2116
:return: The value or default value
2118
configobj = self._get_configobj()
2120
section_obj = configobj
2123
section_obj = configobj[section]
2126
value = section_obj.get(name, default)
2127
for hook in OldConfigHooks['get']:
2128
hook(self, name, value)
2131
def set_option(self, value, name, section=None):
2132
"""Set the value associated with a named option.
2134
:param value: The value to set
2135
:param name: The name of the value to set
2136
:param section: The section the option is in (if any)
2138
configobj = self._get_configobj()
2140
configobj[name] = value
2142
configobj.setdefault(section, {})[name] = value
2143
for hook in OldConfigHooks['set']:
2144
hook(self, name, value)
2145
self._set_configobj(configobj)
2147
def remove_option(self, option_name, section_name=None):
2148
configobj = self._get_configobj()
2149
if section_name is None:
2150
del configobj[option_name]
2152
del configobj[section_name][option_name]
2153
for hook in OldConfigHooks['remove']:
2154
hook(self, option_name)
2155
self._set_configobj(configobj)
2157
def _get_config_file(self):
2159
f = BytesIO(self._transport.get_bytes(self._filename))
2160
for hook in OldConfigHooks['load']:
2163
except errors.NoSuchFile:
2165
except errors.PermissionDenied as e:
2166
trace.warning("Permission denied while trying to open "
2167
"configuration file %s.", urlutils.unescape_for_display(
2168
urlutils.join(self._transport.base, self._filename), "utf-8"))
2171
def _external_url(self):
2172
return urlutils.join(self._transport.external_url(), self._filename)
2174
def _get_configobj(self):
2175
f = self._get_config_file()
2178
conf = ConfigObj(f, encoding='utf-8')
2179
except configobj.ConfigObjError as e:
2180
raise errors.ParseConfigError(e.errors, self._external_url())
2181
except UnicodeDecodeError:
2182
raise errors.ConfigContentError(self._external_url())
2187
def _set_configobj(self, configobj):
2188
out_file = BytesIO()
2189
configobj.write(out_file)
2191
self._transport.put_file(self._filename, out_file)
2192
for hook in OldConfigHooks['save']:
2196
class Option(object):
2197
"""An option definition.
2199
The option *values* are stored in config files and found in sections.
2201
Here we define various properties about the option itself, its default
2202
value, how to convert it from stores, what to do when invalid values are
2203
encoutered, in which config files it can be stored.
2206
def __init__(self, name, override_from_env=None,
2207
default=None, default_from_env=None,
2208
help=None, from_unicode=None, invalid=None, unquote=True):
2209
"""Build an option definition.
2211
:param name: the name used to refer to the option.
2213
:param override_from_env: A list of environment variables which can
2214
provide override any configuration setting.
2216
:param default: the default value to use when none exist in the config
2217
stores. This is either a string that ``from_unicode`` will convert
2218
into the proper type, a callable returning a unicode string so that
2219
``from_unicode`` can be used on the return value, or a python
2220
object that can be stringified (so only the empty list is supported
2223
:param default_from_env: A list of environment variables which can
2224
provide a default value. 'default' will be used only if none of the
2225
variables specified here are set in the environment.
2227
:param help: a doc string to explain the option to the user.
2229
:param from_unicode: a callable to convert the unicode string
2230
representing the option value in a store or its default value.
2232
:param invalid: the action to be taken when an invalid value is
2233
encountered in a store. This is called only when from_unicode is
2234
invoked to convert a string and returns None or raise ValueError or
2235
TypeError. Accepted values are: None (ignore invalid values),
2236
'warning' (emit a warning), 'error' (emit an error message and
2239
:param unquote: should the unicode value be unquoted before conversion.
2240
This should be used only when the store providing the values cannot
2241
safely unquote them (see http://pad.lv/906897). It is provided so
2242
daughter classes can handle the quoting themselves.
2244
if override_from_env is None:
2245
override_from_env = []
2246
if default_from_env is None:
2247
default_from_env = []
2249
self.override_from_env = override_from_env
2250
# Convert the default value to a unicode string so all values are
2251
# strings internally before conversion (via from_unicode) is attempted.
2254
elif isinstance(default, list):
2255
# Only the empty list is supported
2257
raise AssertionError(
2258
'Only empty lists are supported as default values')
2260
elif isinstance(default, (binary_type, text_type, bool, int, float)):
2261
# Rely on python to convert strings, booleans and integers
2262
self.default = u'%s' % (default,)
2263
elif callable(default):
2264
self.default = default
2266
# other python objects are not expected
2267
raise AssertionError('%r is not supported as a default value'
2269
self.default_from_env = default_from_env
2271
self.from_unicode = from_unicode
2272
self.unquote = unquote
2273
if invalid and invalid not in ('warning', 'error'):
2274
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2275
self.invalid = invalid
2281
def convert_from_unicode(self, store, unicode_value):
2282
if self.unquote and store is not None and unicode_value is not None:
2283
unicode_value = store.unquote(unicode_value)
2284
if self.from_unicode is None or unicode_value is None:
2285
# Don't convert or nothing to convert
2286
return unicode_value
2288
converted = self.from_unicode(unicode_value)
2289
except (ValueError, TypeError):
2290
# Invalid values are ignored
2292
if converted is None and self.invalid is not None:
2293
# The conversion failed
2294
if self.invalid == 'warning':
2295
trace.warning('Value "%s" is not valid for "%s"',
2296
unicode_value, self.name)
2297
elif self.invalid == 'error':
2298
raise errors.ConfigOptionValueError(self.name, unicode_value)
2301
def get_override(self):
2303
for var in self.override_from_env:
2305
# If the env variable is defined, its value takes precedence
2306
value = os.environ[var].decode(osutils.get_user_encoding())
2312
def get_default(self):
2314
for var in self.default_from_env:
2316
# If the env variable is defined, its value is the default one
2317
value = os.environ[var].decode(osutils.get_user_encoding())
2322
# Otherwise, fallback to the value defined at registration
2323
if callable(self.default):
2324
value = self.default()
2325
if not isinstance(value, text_type):
2326
raise AssertionError(
2327
"Callable default value for '%s' should be unicode"
2330
value = self.default
2333
def get_help_topic(self):
2336
def get_help_text(self, additional_see_also=None, plain=True):
2338
from breezy import help_topics
2339
result += help_topics._format_see_also(additional_see_also)
2341
result = help_topics.help_as_plain_text(result)
2345
# Predefined converters to get proper values from store
2347
def bool_from_store(unicode_str):
2348
return ui.bool_from_string(unicode_str)
2351
def int_from_store(unicode_str):
2352
return int(unicode_str)
2355
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2357
def int_SI_from_store(unicode_str):
2358
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2360
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2361
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2364
:return Integer, expanded to its base-10 value if a proper SI unit is
2365
found, None otherwise.
2367
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2368
p = re.compile(regexp, re.IGNORECASE)
2369
m = p.match(unicode_str)
2372
val, _, unit = m.groups()
2376
coeff = _unit_suffixes[unit.upper()]
2378
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2383
def float_from_store(unicode_str):
2384
return float(unicode_str)
2387
# Use an empty dict to initialize an empty configobj avoiding all parsing and
2389
_list_converter_config = configobj.ConfigObj(
2390
{}, encoding='utf-8', list_values=True, interpolation=False)
2393
class ListOption(Option):
2395
def __init__(self, name, default=None, default_from_env=None,
2396
help=None, invalid=None):
2397
"""A list Option definition.
2399
This overrides the base class so the conversion from a unicode string
2400
can take quoting into account.
2402
super(ListOption, self).__init__(
2403
name, default=default, default_from_env=default_from_env,
2404
from_unicode=self.from_unicode, help=help,
2405
invalid=invalid, unquote=False)
2407
def from_unicode(self, unicode_str):
2408
if not isinstance(unicode_str, string_types):
2410
# Now inject our string directly as unicode. All callers got their
2411
# value from configobj, so values that need to be quoted are already
2413
_list_converter_config.reset()
2414
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2415
maybe_list = _list_converter_config['list']
2416
if isinstance(maybe_list, string_types):
2418
# A single value, most probably the user forgot (or didn't care
2419
# to add) the final ','
2422
# The empty string, convert to empty list
2425
# We rely on ConfigObj providing us with a list already
2430
class RegistryOption(Option):
2431
"""Option for a choice from a registry."""
2433
def __init__(self, name, registry, default_from_env=None,
2434
help=None, invalid=None):
2435
"""A registry based Option definition.
2437
This overrides the base class so the conversion from a unicode string
2438
can take quoting into account.
2440
super(RegistryOption, self).__init__(
2441
name, default=lambda: unicode(registry.default_key),
2442
default_from_env=default_from_env,
2443
from_unicode=self.from_unicode, help=help,
2444
invalid=invalid, unquote=False)
2445
self.registry = registry
2447
def from_unicode(self, unicode_str):
2448
if not isinstance(unicode_str, string_types):
2451
return self.registry.get(unicode_str)
2454
"Invalid value %s for %s."
2455
"See help for a list of possible values." % (unicode_str,
2460
ret = [self._help, "\n\nThe following values are supported:\n"]
2461
for key in self.registry.keys():
2462
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2466
_option_ref_re = lazy_regex.lazy_compile('({[^\d\W](?:\.\w|-\w|\w)*})')
2467
"""Describes an expandable option reference.
2469
We want to match the most embedded reference first.
2471
I.e. for '{{foo}}' we will get '{foo}',
2472
for '{bar{baz}}' we will get '{baz}'
2475
def iter_option_refs(string):
2476
# Split isolate refs so every other chunk is a ref
2478
for chunk in _option_ref_re.split(string):
2483
class OptionRegistry(registry.Registry):
2484
"""Register config options by their name.
2486
This overrides ``registry.Registry`` to simplify registration by acquiring
2487
some information from the option object itself.
2490
def _check_option_name(self, option_name):
2491
"""Ensures an option name is valid.
2493
:param option_name: The name to validate.
2495
if _option_ref_re.match('{%s}' % option_name) is None:
2496
raise errors.IllegalOptionName(option_name)
2498
def register(self, option):
2499
"""Register a new option to its name.
2501
:param option: The option to register. Its name is used as the key.
2503
self._check_option_name(option.name)
2504
super(OptionRegistry, self).register(option.name, option,
2507
def register_lazy(self, key, module_name, member_name):
2508
"""Register a new option to be loaded on request.
2510
:param key: the key to request the option later. Since the registration
2511
is lazy, it should be provided and match the option name.
2513
:param module_name: the python path to the module. Such as 'os.path'.
2515
:param member_name: the member of the module to return. If empty or
2516
None, get() will return the module itself.
2518
self._check_option_name(key)
2519
super(OptionRegistry, self).register_lazy(key,
2520
module_name, member_name)
2522
def get_help(self, key=None):
2523
"""Get the help text associated with the given key"""
2524
option = self.get(key)
2525
the_help = option.help
2526
if callable(the_help):
2527
return the_help(self, key)
2531
option_registry = OptionRegistry()
2534
# Registered options in lexicographical order
2536
option_registry.register(
2537
Option('append_revisions_only',
2538
default=None, from_unicode=bool_from_store, invalid='warning',
2540
Whether to only append revisions to the mainline.
2542
If this is set to true, then it is not possible to change the
2543
existing mainline of the branch.
2545
option_registry.register(
2546
ListOption('acceptable_keys',
2549
List of GPG key patterns which are acceptable for verification.
2551
option_registry.register(
2552
Option('add.maximum_file_size',
2553
default=u'20MB', from_unicode=int_SI_from_store,
2555
Size above which files should be added manually.
2557
Files below this size are added automatically when using ``bzr add`` without
2560
A negative value means disable the size check.
2562
option_registry.register(
2564
default=None, from_unicode=bool_from_store,
2566
Is the branch bound to ``bound_location``.
2568
If set to "True", the branch should act as a checkout, and push each commit to
2569
the bound_location. This option is normally set by ``bind``/``unbind``.
2571
See also: bound_location.
2573
option_registry.register(
2574
Option('bound_location',
2577
The location that commits should go to when acting as a checkout.
2579
This option is normally set by ``bind``.
2583
option_registry.register(
2584
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2586
Whether revisions associated with tags should be fetched.
2588
option_registry.register_lazy(
2589
'bzr.transform.orphan_policy', 'breezy.transform', 'opt_transform_orphan')
2590
option_registry.register(
2591
Option('bzr.workingtree.worth_saving_limit', default=10,
2592
from_unicode=int_from_store, invalid='warning',
2594
How many changes before saving the dirstate.
2596
-1 means that we will never rewrite the dirstate file for only
2597
stat-cache changes. Regardless of this setting, we will always rewrite
2598
the dirstate file if a file is added/removed/renamed/etc. This flag only
2599
affects the behavior of updating the dirstate file after we notice that
2600
a file has been touched.
2602
option_registry.register(
2603
Option('bugtracker', default=None,
2605
Default bug tracker to use.
2607
This bug tracker will be used for example when marking bugs
2608
as fixed using ``bzr commit --fixes``, if no explicit
2609
bug tracker was specified.
2611
option_registry.register(
2612
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2613
from_unicode=signature_policy_from_unicode,
2615
GPG checking policy.
2617
Possible values: require, ignore, check-available (default)
2619
this option will control whether bzr will require good gpg
2620
signatures, ignore them, or check them if they are
2623
option_registry.register(
2624
Option('child_submit_format',
2625
help='''The preferred format of submissions to this branch.'''))
2626
option_registry.register(
2627
Option('child_submit_to',
2628
help='''Where submissions to this branch are mailed to.'''))
2629
option_registry.register(
2630
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2631
from_unicode=signing_policy_from_unicode,
2635
Possible values: always, never, when-required (default)
2637
This option controls whether bzr will always create
2638
gpg signatures or not on commits.
2640
option_registry.register(
2641
Option('dirstate.fdatasync', default=True,
2642
from_unicode=bool_from_store,
2644
Flush dirstate changes onto physical disk?
2646
If true (default), working tree metadata changes are flushed through the
2647
OS buffers to physical disk. This is somewhat slower, but means data
2648
should not be lost if the machine crashes. See also repository.fdatasync.
2650
option_registry.register(
2651
ListOption('debug_flags', default=[],
2652
help='Debug flags to activate.'))
2653
option_registry.register(
2654
Option('default_format', default='2a',
2655
help='Format used when creating branches.'))
2656
option_registry.register(
2657
Option('dpush_strict', default=None,
2658
from_unicode=bool_from_store,
2660
The default value for ``dpush --strict``.
2662
If present, defines the ``--strict`` option default value for checking
2663
uncommitted changes before pushing into a different VCS without any
2664
custom bzr metadata.
2666
option_registry.register(
2668
help='The command called to launch an editor to enter a message.'))
2669
option_registry.register(
2670
Option('email', override_from_env=['BRZ_EMAIL'], default=default_email,
2671
help='The users identity'))
2672
option_registry.register(
2673
Option('gpg_signing_command',
2676
Program to use use for creating signatures.
2678
This should support at least the -u and --clearsign options.
2680
option_registry.register(
2681
Option('gpg_signing_key',
2684
GPG key to use for signing.
2686
This defaults to the first key associated with the users email.
2688
option_registry.register(
2689
Option('ignore_missing_extensions', default=False,
2690
from_unicode=bool_from_store,
2692
Control the missing extensions warning display.
2694
The warning will not be emitted if set to True.
2696
option_registry.register(
2698
help='Language to translate messages into.'))
2699
option_registry.register(
2700
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2702
Steal locks that appears to be dead.
2704
If set to True, bzr will check if a lock is supposed to be held by an
2705
active process from the same user on the same machine. If the user and
2706
machine match, but no process with the given PID is active, then bzr
2707
will automatically break the stale lock, and create a new lock for
2709
Otherwise, bzr will prompt as normal to break the lock.
2711
option_registry.register(
2712
Option('log_format', default='long',
2714
Log format to use when displaying revisions.
2716
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2717
may be provided by plugins.
2719
option_registry.register_lazy('mail_client', 'breezy.mail_client',
2721
option_registry.register(
2722
Option('output_encoding',
2723
help= 'Unicode encoding for output'
2724
' (terminal encoding if not specified).'))
2725
option_registry.register(
2726
Option('parent_location',
2729
The location of the default branch for pull or merge.
2731
This option is normally set when creating a branch, the first ``pull`` or by
2732
``pull --remember``.
2734
option_registry.register(
2735
Option('post_commit', default=None,
2737
Post commit functions.
2739
An ordered list of python functions to call, separated by spaces.
2741
Each function takes branch, rev_id as parameters.
2743
option_registry.register_lazy('progress_bar', 'breezy.ui.text',
2745
option_registry.register(
2746
Option('public_branch',
2749
A publically-accessible version of this branch.
2751
This implies that the branch setting this option is not publically-accessible.
2752
Used and set by ``bzr send``.
2754
option_registry.register(
2755
Option('push_location',
2758
The location of the default branch for push.
2760
This option is normally set by the first ``push`` or ``push --remember``.
2762
option_registry.register(
2763
Option('push_strict', default=None,
2764
from_unicode=bool_from_store,
2766
The default value for ``push --strict``.
2768
If present, defines the ``--strict`` option default value for checking
2769
uncommitted changes before sending a merge directive.
2771
option_registry.register(
2772
Option('repository.fdatasync', default=True,
2773
from_unicode=bool_from_store,
2775
Flush repository changes onto physical disk?
2777
If true (default), repository changes are flushed through the OS buffers
2778
to physical disk. This is somewhat slower, but means data should not be
2779
lost if the machine crashes. See also dirstate.fdatasync.
2781
option_registry.register_lazy('smtp_server',
2782
'breezy.smtp_connection', 'smtp_server')
2783
option_registry.register_lazy('smtp_password',
2784
'breezy.smtp_connection', 'smtp_password')
2785
option_registry.register_lazy('smtp_username',
2786
'breezy.smtp_connection', 'smtp_username')
2787
option_registry.register(
2788
Option('selftest.timeout',
2790
from_unicode=int_from_store,
2791
help='Abort selftest if one test takes longer than this many seconds',
2794
option_registry.register(
2795
Option('send_strict', default=None,
2796
from_unicode=bool_from_store,
2798
The default value for ``send --strict``.
2800
If present, defines the ``--strict`` option default value for checking
2801
uncommitted changes before sending a bundle.
2804
option_registry.register(
2805
Option('serve.client_timeout',
2806
default=300.0, from_unicode=float_from_store,
2807
help="If we wait for a new request from a client for more than"
2808
" X seconds, consider the client idle, and hangup."))
2809
option_registry.register(
2810
Option('stacked_on_location',
2812
help="""The location where this branch is stacked on."""))
2813
option_registry.register(
2814
Option('submit_branch',
2817
The branch you intend to submit your current work to.
2819
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2820
by the ``submit:`` revision spec.
2822
option_registry.register(
2824
help='''Where submissions from this branch are mailed to.'''))
2825
option_registry.register(
2826
ListOption('suppress_warnings',
2828
help="List of warning classes to suppress."))
2829
option_registry.register(
2830
Option('validate_signatures_in_log', default=False,
2831
from_unicode=bool_from_store, invalid='warning',
2832
help='''Whether to validate signatures in brz log.'''))
2833
option_registry.register_lazy('ssl.ca_certs',
2834
'breezy.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2836
option_registry.register_lazy('ssl.cert_reqs',
2837
'breezy.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2840
class Section(object):
2841
"""A section defines a dict of option name => value.
2843
This is merely a read-only dict which can add some knowledge about the
2844
options. It is *not* a python dict object though and doesn't try to mimic
2848
def __init__(self, section_id, options):
2849
self.id = section_id
2850
# We re-use the dict-like object received
2851
self.options = options
2853
def get(self, name, default=None, expand=True):
2854
return self.options.get(name, default)
2856
def iter_option_names(self):
2857
for k in self.options.keys():
2861
# Mostly for debugging use
2862
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2865
_NewlyCreatedOption = object()
2866
"""Was the option created during the MutableSection lifetime"""
2867
_DeletedOption = object()
2868
"""Was the option deleted during the MutableSection lifetime"""
2871
class MutableSection(Section):
2872
"""A section allowing changes and keeping track of the original values."""
2874
def __init__(self, section_id, options):
2875
super(MutableSection, self).__init__(section_id, options)
2876
self.reset_changes()
2878
def set(self, name, value):
2879
if name not in self.options:
2880
# This is a new option
2881
self.orig[name] = _NewlyCreatedOption
2882
elif name not in self.orig:
2883
self.orig[name] = self.get(name, None)
2884
self.options[name] = value
2886
def remove(self, name):
2887
if name not in self.orig and name in self.options:
2888
self.orig[name] = self.get(name, None)
2889
del self.options[name]
2891
def reset_changes(self):
2894
def apply_changes(self, dirty, store):
2895
"""Apply option value changes.
2897
``self`` has been reloaded from the persistent storage. ``dirty``
2898
contains the changes made since the previous loading.
2900
:param dirty: the mutable section containing the changes.
2902
:param store: the store containing the section
2904
for k, expected in dirty.orig.items():
2905
actual = dirty.get(k, _DeletedOption)
2906
reloaded = self.get(k, _NewlyCreatedOption)
2907
if actual is _DeletedOption:
2908
if k in self.options:
2912
# Report concurrent updates in an ad-hoc way. This should only
2913
# occurs when different processes try to update the same option
2914
# which is not supported (as in: the config framework is not meant
2915
# to be used as a sharing mechanism).
2916
if expected != reloaded:
2917
if actual is _DeletedOption:
2918
actual = '<DELETED>'
2919
if reloaded is _NewlyCreatedOption:
2920
reloaded = '<CREATED>'
2921
if expected is _NewlyCreatedOption:
2922
expected = '<CREATED>'
2923
# Someone changed the value since we get it from the persistent
2925
trace.warning(gettext(
2926
"Option {0} in section {1} of {2} was changed"
2927
" from {3} to {4}. The {5} value will be saved.".format(
2928
k, self.id, store.external_url(), expected,
2930
# No need to keep track of these changes
2931
self.reset_changes()
2934
class Store(object):
2935
"""Abstract interface to persistent storage for configuration options."""
2937
readonly_section_class = Section
2938
mutable_section_class = MutableSection
2941
# Which sections need to be saved (by section id). We use a dict here
2942
# so the dirty sections can be shared by multiple callers.
2943
self.dirty_sections = {}
2945
def is_loaded(self):
2946
"""Returns True if the Store has been loaded.
2948
This is used to implement lazy loading and ensure the persistent
2949
storage is queried only when needed.
2951
raise NotImplementedError(self.is_loaded)
2954
"""Loads the Store from persistent storage."""
2955
raise NotImplementedError(self.load)
2957
def _load_from_string(self, bytes):
2958
"""Create a store from a string in configobj syntax.
2960
:param bytes: A string representing the file content.
2962
raise NotImplementedError(self._load_from_string)
2965
"""Unloads the Store.
2967
This should make is_loaded() return False. This is used when the caller
2968
knows that the persistent storage has changed or may have change since
2971
raise NotImplementedError(self.unload)
2973
def quote(self, value):
2974
"""Quote a configuration option value for storing purposes.
2976
This allows Stacks to present values as they will be stored.
2980
def unquote(self, value):
2981
"""Unquote a configuration option value into unicode.
2983
The received value is quoted as stored.
2988
"""Saves the Store to persistent storage."""
2989
raise NotImplementedError(self.save)
2991
def _need_saving(self):
2992
for s in self.dirty_sections.values():
2994
# At least one dirty section contains a modification
2998
def apply_changes(self, dirty_sections):
2999
"""Apply changes from dirty sections while checking for coherency.
3001
The Store content is discarded and reloaded from persistent storage to
3002
acquire up-to-date values.
3004
Dirty sections are MutableSection which kept track of the value they
3005
are expected to update.
3007
# We need an up-to-date version from the persistent storage, unload the
3008
# store. The reload will occur when needed (triggered by the first
3009
# get_mutable_section() call below.
3011
# Apply the changes from the preserved dirty sections
3012
for section_id, dirty in dirty_sections.items():
3013
clean = self.get_mutable_section(section_id)
3014
clean.apply_changes(dirty, self)
3015
# Everything is clean now
3016
self.dirty_sections = {}
3018
def save_changes(self):
3019
"""Saves the Store to persistent storage if changes occurred.
3021
Apply the changes recorded in the mutable sections to a store content
3022
refreshed from persistent storage.
3024
raise NotImplementedError(self.save_changes)
3026
def external_url(self):
3027
raise NotImplementedError(self.external_url)
3029
def get_sections(self):
3030
"""Returns an ordered iterable of existing sections.
3032
:returns: An iterable of (store, section).
3034
raise NotImplementedError(self.get_sections)
3036
def get_mutable_section(self, section_id=None):
3037
"""Returns the specified mutable section.
3039
:param section_id: The section identifier
3041
raise NotImplementedError(self.get_mutable_section)
3044
# Mostly for debugging use
3045
return "<config.%s(%s)>" % (self.__class__.__name__,
3046
self.external_url())
3049
class CommandLineStore(Store):
3050
"A store to carry command line overrides for the config options."""
3052
def __init__(self, opts=None):
3053
super(CommandLineStore, self).__init__()
3060
# The dict should be cleared but not replaced so it can be shared.
3061
self.options.clear()
3063
def _from_cmdline(self, overrides):
3064
# Reset before accepting new definitions
3066
for over in overrides:
3068
name, value = over.split('=', 1)
3070
raise errors.BzrCommandError(
3071
gettext("Invalid '%s', should be of the form 'name=value'")
3073
self.options[name] = value
3075
def external_url(self):
3076
# Not an url but it makes debugging easier and is never needed
3080
def get_sections(self):
3081
yield self, self.readonly_section_class(None, self.options)
3084
class IniFileStore(Store):
3085
"""A config Store using ConfigObj for storage.
3087
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3088
serialize/deserialize the config file.
3092
"""A config Store using ConfigObj for storage.
3094
super(IniFileStore, self).__init__()
3095
self._config_obj = None
3097
def is_loaded(self):
3098
return self._config_obj != None
3101
self._config_obj = None
3102
self.dirty_sections = {}
3104
def _load_content(self):
3105
"""Load the config file bytes.
3107
This should be provided by subclasses
3109
:return: Byte string
3111
raise NotImplementedError(self._load_content)
3113
def _save_content(self, content):
3114
"""Save the config file bytes.
3116
This should be provided by subclasses
3118
:param content: Config file bytes to write
3120
raise NotImplementedError(self._save_content)
3123
"""Load the store from the associated file."""
3124
if self.is_loaded():
3126
content = self._load_content()
3127
self._load_from_string(content)
3128
for hook in ConfigHooks['load']:
3131
def _load_from_string(self, bytes):
3132
"""Create a config store from a string.
3134
:param bytes: A string representing the file content.
3136
if self.is_loaded():
3137
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3138
co_input = BytesIO(bytes)
3140
# The config files are always stored utf8-encoded
3141
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3143
except configobj.ConfigObjError as e:
3144
self._config_obj = None
3145
raise errors.ParseConfigError(e.errors, self.external_url())
3146
except UnicodeDecodeError:
3147
raise errors.ConfigContentError(self.external_url())
3149
def save_changes(self):
3150
if not self.is_loaded():
3153
if not self._need_saving():
3155
# Preserve the current version
3156
dirty_sections = self.dirty_sections.copy()
3157
self.apply_changes(dirty_sections)
3158
# Save to the persistent storage
3162
if not self.is_loaded():
3166
self._config_obj.write(out)
3167
self._save_content(out.getvalue())
3168
for hook in ConfigHooks['save']:
3171
def get_sections(self):
3172
"""Get the configobj section in the file order.
3174
:returns: An iterable of (store, section).
3176
# We need a loaded store
3179
except (errors.NoSuchFile, errors.PermissionDenied):
3180
# If the file can't be read, there is no sections
3182
cobj = self._config_obj
3184
yield self, self.readonly_section_class(None, cobj)
3185
for section_name in cobj.sections:
3187
self.readonly_section_class(section_name,
3188
cobj[section_name]))
3190
def get_mutable_section(self, section_id=None):
3191
# We need a loaded store
3194
except errors.NoSuchFile:
3195
# The file doesn't exist, let's pretend it was empty
3196
self._load_from_string('')
3197
if section_id in self.dirty_sections:
3198
# We already created a mutable section for this id
3199
return self.dirty_sections[section_id]
3200
if section_id is None:
3201
section = self._config_obj
3203
section = self._config_obj.setdefault(section_id, {})
3204
mutable_section = self.mutable_section_class(section_id, section)
3205
# All mutable sections can become dirty
3206
self.dirty_sections[section_id] = mutable_section
3207
return mutable_section
3209
def quote(self, value):
3211
# configobj conflates automagical list values and quoting
3212
self._config_obj.list_values = True
3213
return self._config_obj._quote(value)
3215
self._config_obj.list_values = False
3217
def unquote(self, value):
3218
if value and isinstance(value, string_types):
3219
# _unquote doesn't handle None nor empty strings nor anything that
3220
# is not a string, really.
3221
value = self._config_obj._unquote(value)
3224
def external_url(self):
3225
# Since an IniFileStore can be used without a file (at least in tests),
3226
# it's better to provide something than raising a NotImplementedError.
3227
# All daughter classes are supposed to provide an implementation
3229
return 'In-Process Store, no URL'
3232
class TransportIniFileStore(IniFileStore):
3233
"""IniFileStore that loads files from a transport.
3235
:ivar transport: The transport object where the config file is located.
3237
:ivar file_name: The config file basename in the transport directory.
3240
def __init__(self, transport, file_name):
3241
"""A Store using a ini file on a Transport
3243
:param transport: The transport object where the config file is located.
3244
:param file_name: The config file basename in the transport directory.
3246
super(TransportIniFileStore, self).__init__()
3247
self.transport = transport
3248
self.file_name = file_name
3250
def _load_content(self):
3252
return self.transport.get_bytes(self.file_name)
3253
except errors.PermissionDenied:
3254
trace.warning("Permission denied while trying to load "
3255
"configuration store %s.", self.external_url())
3258
def _save_content(self, content):
3259
self.transport.put_bytes(self.file_name, content)
3261
def external_url(self):
3262
# FIXME: external_url should really accepts an optional relpath
3263
# parameter (bug #750169) :-/ -- vila 2011-04-04
3264
# The following will do in the interim but maybe we don't want to
3265
# expose a path here but rather a config ID and its associated
3266
# object </hand wawe>.
3267
return urlutils.join(self.transport.external_url(), self.file_name.encode("ascii"))
3270
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3271
# unlockable stores for use with objects that can already ensure the locking
3272
# (think branches). If different stores (not based on ConfigObj) are created,
3273
# they may face the same issue.
3276
class LockableIniFileStore(TransportIniFileStore):
3277
"""A ConfigObjStore using locks on save to ensure store integrity."""
3279
def __init__(self, transport, file_name, lock_dir_name=None):
3280
"""A config Store using ConfigObj for storage.
3282
:param transport: The transport object where the config file is located.
3284
:param file_name: The config file basename in the transport directory.
3286
if lock_dir_name is None:
3287
lock_dir_name = 'lock'
3288
self.lock_dir_name = lock_dir_name
3289
super(LockableIniFileStore, self).__init__(transport, file_name)
3290
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3292
def lock_write(self, token=None):
3293
"""Takes a write lock in the directory containing the config file.
3295
If the directory doesn't exist it is created.
3297
# FIXME: This doesn't check the ownership of the created directories as
3298
# ensure_config_dir_exists does. It should if the transport is local
3299
# -- vila 2011-04-06
3300
self.transport.create_prefix()
3301
return self._lock.lock_write(token)
3306
def break_lock(self):
3307
self._lock.break_lock()
3311
# We need to be able to override the undecorated implementation
3312
self.save_without_locking()
3314
def save_without_locking(self):
3315
super(LockableIniFileStore, self).save()
3318
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3319
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3320
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3322
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3323
# functions or a registry will make it easier and clearer for tests, focusing
3324
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3325
# on a poolie's remark)
3326
class GlobalStore(LockableIniFileStore):
3327
"""A config store for global options.
3329
There is a single GlobalStore for a given process.
3332
def __init__(self, possible_transports=None):
3333
t = transport.get_transport_from_path(
3334
config_dir(), possible_transports=possible_transports)
3335
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3339
class LocationStore(LockableIniFileStore):
3340
"""A config store for options specific to a location.
3342
There is a single LocationStore for a given process.
3345
def __init__(self, possible_transports=None):
3346
t = transport.get_transport_from_path(
3347
config_dir(), possible_transports=possible_transports)
3348
super(LocationStore, self).__init__(t, 'locations.conf')
3349
self.id = 'locations'
3352
class BranchStore(TransportIniFileStore):
3353
"""A config store for branch options.
3355
There is a single BranchStore for a given branch.
3358
def __init__(self, branch):
3359
super(BranchStore, self).__init__(branch.control_transport,
3361
self.branch = branch
3365
class ControlStore(LockableIniFileStore):
3367
def __init__(self, bzrdir):
3368
super(ControlStore, self).__init__(bzrdir.transport,
3370
lock_dir_name='branch_lock')
3374
class SectionMatcher(object):
3375
"""Select sections into a given Store.
3377
This is intended to be used to postpone getting an iterable of sections
3381
def __init__(self, store):
3384
def get_sections(self):
3385
# This is where we require loading the store so we can see all defined
3387
sections = self.store.get_sections()
3388
# Walk the revisions in the order provided
3389
for store, s in sections:
3393
def match(self, section):
3394
"""Does the proposed section match.
3396
:param section: A Section object.
3398
:returns: True if the section matches, False otherwise.
3400
raise NotImplementedError(self.match)
3403
class NameMatcher(SectionMatcher):
3405
def __init__(self, store, section_id):
3406
super(NameMatcher, self).__init__(store)
3407
self.section_id = section_id
3409
def match(self, section):
3410
return section.id == self.section_id
3413
class LocationSection(Section):
3415
def __init__(self, section, extra_path, branch_name=None):
3416
super(LocationSection, self).__init__(section.id, section.options)
3417
self.extra_path = extra_path
3418
if branch_name is None:
3420
self.locals = {'relpath': extra_path,
3421
'basename': urlutils.basename(extra_path),
3422
'branchname': branch_name}
3424
def get(self, name, default=None, expand=True):
3425
value = super(LocationSection, self).get(name, default)
3426
if value is not None and expand:
3427
policy_name = self.get(name + ':policy', None)
3428
policy = _policy_value.get(policy_name, POLICY_NONE)
3429
if policy == POLICY_APPENDPATH:
3430
value = urlutils.join(value, self.extra_path)
3431
# expand section local options right now (since POLICY_APPENDPATH
3432
# will never add options references, it's ok to expand after it).
3434
for is_ref, chunk in iter_option_refs(value):
3436
chunks.append(chunk)
3439
if ref in self.locals:
3440
chunks.append(self.locals[ref])
3442
chunks.append(chunk)
3443
value = ''.join(chunks)
3447
class StartingPathMatcher(SectionMatcher):
3448
"""Select sections for a given location respecting the Store order."""
3450
# FIXME: Both local paths and urls can be used for section names as well as
3451
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3452
# inherited the fuzziness from the previous ``LocationConfig``
3453
# implementation. We probably need to revisit which encoding is allowed for
3454
# both ``location`` and section names and how we normalize
3455
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3456
# related too. -- vila 2012-01-04
3458
def __init__(self, store, location):
3459
super(StartingPathMatcher, self).__init__(store)
3460
if location.startswith('file://'):
3461
location = urlutils.local_path_from_url(location)
3462
self.location = location
3464
def get_sections(self):
3465
"""Get all sections matching ``location`` in the store.
3467
The most generic sections are described first in the store, then more
3468
specific ones can be provided for reduced scopes.
3470
The returned section are therefore returned in the reversed order so
3471
the most specific ones can be found first.
3473
location_parts = self.location.rstrip('/').split('/')
3475
# Later sections are more specific, they should be returned first
3476
for _, section in reversed(list(store.get_sections())):
3477
if section.id is None:
3478
# The no-name section is always included if present
3479
yield store, LocationSection(section, self.location)
3481
section_path = section.id
3482
if section_path.startswith('file://'):
3483
# the location is already a local path or URL, convert the
3484
# section id to the same format
3485
section_path = urlutils.local_path_from_url(section_path)
3486
if (self.location.startswith(section_path)
3487
or fnmatch.fnmatch(self.location, section_path)):
3488
section_parts = section_path.rstrip('/').split('/')
3489
extra_path = '/'.join(location_parts[len(section_parts):])
3490
yield store, LocationSection(section, extra_path)
3493
class LocationMatcher(SectionMatcher):
3495
def __init__(self, store, location):
3496
super(LocationMatcher, self).__init__(store)
3497
url, params = urlutils.split_segment_parameters(location)
3498
if location.startswith('file://'):
3499
location = urlutils.local_path_from_url(location)
3500
self.location = location
3501
branch_name = params.get('branch')
3502
if branch_name is None:
3503
self.branch_name = urlutils.basename(self.location)
3505
self.branch_name = urlutils.unescape(branch_name)
3507
def _get_matching_sections(self):
3508
"""Get all sections matching ``location``."""
3509
# We slightly diverge from LocalConfig here by allowing the no-name
3510
# section as the most generic one and the lower priority.
3511
no_name_section = None
3513
# Filter out the no_name_section so _iter_for_location_by_parts can be
3514
# used (it assumes all sections have a name).
3515
for _, section in self.store.get_sections():
3516
if section.id is None:
3517
no_name_section = section
3519
all_sections.append(section)
3520
# Unfortunately _iter_for_location_by_parts deals with section names so
3521
# we have to resync.
3522
filtered_sections = _iter_for_location_by_parts(
3523
[s.id for s in all_sections], self.location)
3524
iter_all_sections = iter(all_sections)
3525
matching_sections = []
3526
if no_name_section is not None:
3527
matching_sections.append(
3528
(0, LocationSection(no_name_section, self.location)))
3529
for section_id, extra_path, length in filtered_sections:
3530
# a section id is unique for a given store so it's safe to take the
3531
# first matching section while iterating. Also, all filtered
3532
# sections are part of 'all_sections' and will always be found
3535
section = next(iter_all_sections)
3536
if section_id == section.id:
3537
section = LocationSection(section, extra_path,
3539
matching_sections.append((length, section))
3541
return matching_sections
3543
def get_sections(self):
3544
# Override the default implementation as we want to change the order
3545
# We want the longest (aka more specific) locations first
3546
sections = sorted(self._get_matching_sections(),
3547
key=lambda match: (match[0], match[1].id),
3549
# Sections mentioning 'ignore_parents' restrict the selection
3550
for _, section in sections:
3551
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3552
ignore = section.get('ignore_parents', None)
3553
if ignore is not None:
3554
ignore = ui.bool_from_string(ignore)
3557
# Finally, we have a valid section
3558
yield self.store, section
3561
# FIXME: _shared_stores should be an attribute of a library state once a
3562
# library_state object is always available.
3564
_shared_stores_at_exit_installed = False
3566
class Stack(object):
3567
"""A stack of configurations where an option can be defined"""
3569
def __init__(self, sections_def, store=None, mutable_section_id=None):
3570
"""Creates a stack of sections with an optional store for changes.
3572
:param sections_def: A list of Section or callables that returns an
3573
iterable of Section. This defines the Sections for the Stack and
3574
can be called repeatedly if needed.
3576
:param store: The optional Store where modifications will be
3577
recorded. If none is specified, no modifications can be done.
3579
:param mutable_section_id: The id of the MutableSection where changes
3580
are recorded. This requires the ``store`` parameter to be
3583
self.sections_def = sections_def
3585
self.mutable_section_id = mutable_section_id
3587
def iter_sections(self):
3588
"""Iterate all the defined sections."""
3589
# Ensuring lazy loading is achieved by delaying section matching (which
3590
# implies querying the persistent storage) until it can't be avoided
3591
# anymore by using callables to describe (possibly empty) section
3593
for sections in self.sections_def:
3594
for store, section in sections():
3595
yield store, section
3597
def get(self, name, expand=True, convert=True):
3598
"""Return the *first* option value found in the sections.
3600
This is where we guarantee that sections coming from Store are loaded
3601
lazily: the loading is delayed until we need to either check that an
3602
option exists or get its value, which in turn may require to discover
3603
in which sections it can be defined. Both of these (section and option
3604
existence) require loading the store (even partially).
3606
:param name: The queried option.
3608
:param expand: Whether options references should be expanded.
3610
:param convert: Whether the option value should be converted from
3611
unicode (do nothing for non-registered options).
3613
:returns: The value of the option.
3615
# FIXME: No caching of options nor sections yet -- vila 20110503
3617
found_store = None # Where the option value has been found
3618
# If the option is registered, it may provide additional info about
3621
opt = option_registry.get(name)
3626
def expand_and_convert(val):
3627
# This may need to be called in different contexts if the value is
3628
# None or ends up being None during expansion or conversion.
3631
if isinstance(val, string_types):
3632
val = self._expand_options_in_string(val)
3634
trace.warning('Cannot expand "%s":'
3635
' %s does not support option expansion'
3636
% (name, type(val)))
3638
val = found_store.unquote(val)
3640
val = opt.convert_from_unicode(found_store, val)
3643
# First of all, check if the environment can override the configuration
3645
if opt is not None and opt.override_from_env:
3646
value = opt.get_override()
3647
value = expand_and_convert(value)
3649
for store, section in self.iter_sections():
3650
value = section.get(name)
3651
if value is not None:
3654
value = expand_and_convert(value)
3655
if opt is not None and value is None:
3656
# If the option is registered, it may provide a default value
3657
value = opt.get_default()
3658
value = expand_and_convert(value)
3659
for hook in ConfigHooks['get']:
3660
hook(self, name, value)
3663
def expand_options(self, string, env=None):
3664
"""Expand option references in the string in the configuration context.
3666
:param string: The string containing option(s) to expand.
3668
:param env: An option dict defining additional configuration options or
3669
overriding existing ones.
3671
:returns: The expanded string.
3673
return self._expand_options_in_string(string, env)
3675
def _expand_options_in_string(self, string, env=None, _refs=None):
3676
"""Expand options in the string in the configuration context.
3678
:param string: The string to be expanded.
3680
:param env: An option dict defining additional configuration options or
3681
overriding existing ones.
3683
:param _refs: Private list (FIFO) containing the options being expanded
3686
:returns: The expanded string.
3689
# Not much to expand there
3692
# What references are currently resolved (to detect loops)
3695
# We need to iterate until no more refs appear ({{foo}} will need two
3696
# iterations for example).
3701
for is_ref, chunk in iter_option_refs(result):
3703
chunks.append(chunk)
3708
raise errors.OptionExpansionLoop(string, _refs)
3710
value = self._expand_option(name, env, _refs)
3712
raise errors.ExpandingUnknownOption(name, string)
3713
chunks.append(value)
3715
result = ''.join(chunks)
3718
def _expand_option(self, name, env, _refs):
3719
if env is not None and name in env:
3720
# Special case, values provided in env takes precedence over
3724
value = self.get(name, expand=False, convert=False)
3725
value = self._expand_options_in_string(value, env, _refs)
3728
def _get_mutable_section(self):
3729
"""Get the MutableSection for the Stack.
3731
This is where we guarantee that the mutable section is lazily loaded:
3732
this means we won't load the corresponding store before setting a value
3733
or deleting an option. In practice the store will often be loaded but
3734
this helps catching some programming errors.
3737
section = store.get_mutable_section(self.mutable_section_id)
3738
return store, section
3740
def set(self, name, value):
3741
"""Set a new value for the option."""
3742
store, section = self._get_mutable_section()
3743
section.set(name, store.quote(value))
3744
for hook in ConfigHooks['set']:
3745
hook(self, name, value)
3747
def remove(self, name):
3748
"""Remove an existing option."""
3749
_, section = self._get_mutable_section()
3750
section.remove(name)
3751
for hook in ConfigHooks['remove']:
3755
# Mostly for debugging use
3756
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3758
def _get_overrides(self):
3759
# FIXME: Hack around library_state.initialize never called
3760
if breezy.global_state is not None:
3761
return breezy.global_state.cmdline_overrides.get_sections()
3764
def get_shared_store(self, store, state=None):
3765
"""Get a known shared store.
3767
Store urls uniquely identify them and are used to ensure a single copy
3768
is shared across all users.
3770
:param store: The store known to the caller.
3772
:param state: The library state where the known stores are kept.
3774
:returns: The store received if it's not a known one, an already known
3778
state = breezy.global_state
3780
global _shared_stores_at_exit_installed
3781
stores = _shared_stores
3782
def save_config_changes():
3783
for k, store in stores.iteritems():
3784
store.save_changes()
3785
if not _shared_stores_at_exit_installed:
3786
# FIXME: Ugly hack waiting for library_state to always be
3787
# available. -- vila 20120731
3789
atexit.register(save_config_changes)
3790
_shared_stores_at_exit_installed = True
3792
stores = state.config_stores
3793
url = store.external_url()
3801
class MemoryStack(Stack):
3802
"""A configuration stack defined from a string.
3804
This is mainly intended for tests and requires no disk resources.
3807
def __init__(self, content=None):
3808
"""Create an in-memory stack from a given content.
3810
It uses a single store based on configobj and support reading and
3813
:param content: The initial content of the store. If None, the store is
3814
not loaded and ``_load_from_string`` can and should be used if
3817
store = IniFileStore()
3818
if content is not None:
3819
store._load_from_string(content)
3820
super(MemoryStack, self).__init__(
3821
[store.get_sections], store)
3824
class _CompatibleStack(Stack):
3825
"""Place holder for compatibility with previous design.
3827
This is intended to ease the transition from the Config-based design to the
3828
Stack-based design and should not be used nor relied upon by plugins.
3830
One assumption made here is that the daughter classes will all use Stores
3831
derived from LockableIniFileStore).
3833
It implements set() and remove () by re-loading the store before applying
3834
the modification and saving it.
3836
The long term plan being to implement a single write by store to save
3837
all modifications, this class should not be used in the interim.
3840
def set(self, name, value):
3843
super(_CompatibleStack, self).set(name, value)
3844
# Force a write to persistent storage
3847
def remove(self, name):
3850
super(_CompatibleStack, self).remove(name)
3851
# Force a write to persistent storage
3855
class GlobalStack(Stack):
3856
"""Global options only stack.
3858
The following sections are queried:
3860
* command-line overrides,
3862
* the 'DEFAULT' section in bazaar.conf
3864
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3869
gstore = self.get_shared_store(GlobalStore())
3870
super(GlobalStack, self).__init__(
3871
[self._get_overrides,
3872
NameMatcher(gstore, 'DEFAULT').get_sections],
3873
gstore, mutable_section_id='DEFAULT')
3876
class LocationStack(Stack):
3877
"""Per-location options falling back to global options stack.
3880
The following sections are queried:
3882
* command-line overrides,
3884
* the sections matching ``location`` in ``locations.conf``, the order being
3885
defined by the number of path components in the section glob, higher
3886
numbers first (from most specific section to most generic).
3888
* the 'DEFAULT' section in bazaar.conf
3890
This stack will use the ``location`` section in locations.conf as its
3894
def __init__(self, location):
3895
"""Make a new stack for a location and global configuration.
3897
:param location: A URL prefix to """
3898
lstore = self.get_shared_store(LocationStore())
3899
if location.startswith('file://'):
3900
location = urlutils.local_path_from_url(location)
3901
gstore = self.get_shared_store(GlobalStore())
3902
super(LocationStack, self).__init__(
3903
[self._get_overrides,
3904
LocationMatcher(lstore, location).get_sections,
3905
NameMatcher(gstore, 'DEFAULT').get_sections],
3906
lstore, mutable_section_id=location)
3909
class BranchStack(Stack):
3910
"""Per-location options falling back to branch then global options stack.
3912
The following sections are queried:
3914
* command-line overrides,
3916
* the sections matching ``location`` in ``locations.conf``, the order being
3917
defined by the number of path components in the section glob, higher
3918
numbers first (from most specific section to most generic),
3920
* the no-name section in branch.conf,
3922
* the ``DEFAULT`` section in ``bazaar.conf``.
3924
This stack will use the no-name section in ``branch.conf`` as its
3928
def __init__(self, branch):
3929
lstore = self.get_shared_store(LocationStore())
3930
bstore = branch._get_config_store()
3931
gstore = self.get_shared_store(GlobalStore())
3932
super(BranchStack, self).__init__(
3933
[self._get_overrides,
3934
LocationMatcher(lstore, branch.base).get_sections,
3935
NameMatcher(bstore, None).get_sections,
3936
NameMatcher(gstore, 'DEFAULT').get_sections],
3938
self.branch = branch
3940
def lock_write(self, token=None):
3941
return self.branch.lock_write(token)
3944
return self.branch.unlock()
3947
def set(self, name, value):
3948
super(BranchStack, self).set(name, value)
3949
# Unlocking the branch will trigger a store.save_changes() so the last
3950
# unlock saves all the changes.
3953
def remove(self, name):
3954
super(BranchStack, self).remove(name)
3955
# Unlocking the branch will trigger a store.save_changes() so the last
3956
# unlock saves all the changes.
3959
class RemoteControlStack(Stack):
3960
"""Remote control-only options stack."""
3962
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3963
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3964
# control.conf and is used only for stack options.
3966
def __init__(self, bzrdir):
3967
cstore = bzrdir._get_config_store()
3968
super(RemoteControlStack, self).__init__(
3969
[NameMatcher(cstore, None).get_sections],
3971
self.bzrdir = bzrdir
3974
class BranchOnlyStack(Stack):
3975
"""Branch-only options stack."""
3977
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3978
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3979
# -- vila 2011-12-16
3981
def __init__(self, branch):
3982
bstore = branch._get_config_store()
3983
super(BranchOnlyStack, self).__init__(
3984
[NameMatcher(bstore, None).get_sections],
3986
self.branch = branch
3988
def lock_write(self, token=None):
3989
return self.branch.lock_write(token)
3992
return self.branch.unlock()
3995
def set(self, name, value):
3996
super(BranchOnlyStack, self).set(name, value)
3997
# Force a write to persistent storage
3998
self.store.save_changes()
4001
def remove(self, name):
4002
super(BranchOnlyStack, self).remove(name)
4003
# Force a write to persistent storage
4004
self.store.save_changes()
4007
class cmd_config(commands.Command):
4008
__doc__ = """Display, set or remove a configuration option.
4010
Display the active value for option NAME.
4012
If --all is specified, NAME is interpreted as a regular expression and all
4013
matching options are displayed mentioning their scope and without resolving
4014
option references in the value). The active value that bzr will take into
4015
account is the first one displayed for each option.
4017
If NAME is not given, --all .* is implied (all options are displayed for the
4020
Setting a value is achieved by using NAME=value without spaces. The value
4021
is set in the most relevant scope and can be checked by displaying the
4024
Removing a value is achieved by using --remove NAME.
4027
takes_args = ['name?']
4031
# FIXME: This should be a registry option so that plugins can register
4032
# their own config files (or not) and will also address
4033
# http://pad.lv/788991 -- vila 20101115
4034
commands.Option('scope', help='Reduce the scope to the specified'
4035
' configuration file.',
4037
commands.Option('all',
4038
help='Display all the defined values for the matching options.',
4040
commands.Option('remove', help='Remove the option from'
4041
' the configuration file.'),
4044
_see_also = ['configuration']
4046
@commands.display_command
4047
def run(self, name=None, all=False, directory=None, scope=None,
4049
if directory is None:
4051
directory = directory_service.directories.dereference(directory)
4052
directory = urlutils.normalize_url(directory)
4054
raise errors.BzrError(
4055
'--all and --remove are mutually exclusive.')
4057
# Delete the option in the given scope
4058
self._remove_config_option(name, directory, scope)
4060
# Defaults to all options
4061
self._show_matching_options('.*', directory, scope)
4064
name, value = name.split('=', 1)
4066
# Display the option(s) value(s)
4068
self._show_matching_options(name, directory, scope)
4070
self._show_value(name, directory, scope)
4073
raise errors.BzrError(
4074
'Only one option can be set.')
4075
# Set the option value
4076
self._set_config_option(name, value, directory, scope)
4078
def _get_stack(self, directory, scope=None, write_access=False):
4079
"""Get the configuration stack specified by ``directory`` and ``scope``.
4081
:param directory: Where the configurations are derived from.
4083
:param scope: A specific config to start from.
4085
:param write_access: Whether a write access to the stack will be
4088
# FIXME: scope should allow access to plugin-specific stacks (even
4089
# reduced to the plugin-specific store), related to
4090
# http://pad.lv/788991 -- vila 2011-11-15
4091
if scope is not None:
4092
if scope == 'bazaar':
4093
return GlobalStack()
4094
elif scope == 'locations':
4095
return LocationStack(directory)
4096
elif scope == 'branch':
4098
controldir.ControlDir.open_containing_tree_or_branch(
4101
self.add_cleanup(br.lock_write().unlock)
4102
return br.get_config_stack()
4103
raise errors.NoSuchConfig(scope)
4107
controldir.ControlDir.open_containing_tree_or_branch(
4110
self.add_cleanup(br.lock_write().unlock)
4111
return br.get_config_stack()
4112
except errors.NotBranchError:
4113
return LocationStack(directory)
4115
def _quote_multiline(self, value):
4117
value = '"""' + value + '"""'
4120
def _show_value(self, name, directory, scope):
4121
conf = self._get_stack(directory, scope)
4122
value = conf.get(name, expand=True, convert=False)
4123
if value is not None:
4124
# Quote the value appropriately
4125
value = self._quote_multiline(value)
4126
self.outf.write('%s\n' % (value,))
4128
raise errors.NoSuchConfigOption(name)
4130
def _show_matching_options(self, name, directory, scope):
4131
name = lazy_regex.lazy_compile(name)
4132
# We want any error in the regexp to be raised *now* so we need to
4133
# avoid the delay introduced by the lazy regexp. But, we still do
4134
# want the nicer errors raised by lazy_regex.
4135
name._compile_and_collapse()
4138
conf = self._get_stack(directory, scope)
4139
for store, section in conf.iter_sections():
4140
for oname in section.iter_option_names():
4141
if name.search(oname):
4142
if cur_store_id != store.id:
4143
# Explain where the options are defined
4144
self.outf.write('%s:\n' % (store.id,))
4145
cur_store_id = store.id
4147
if (section.id is not None and cur_section != section.id):
4148
# Display the section id as it appears in the store
4149
# (None doesn't appear by definition)
4150
self.outf.write(' [%s]\n' % (section.id,))
4151
cur_section = section.id
4152
value = section.get(oname, expand=False)
4153
# Quote the value appropriately
4154
value = self._quote_multiline(value)
4155
self.outf.write(' %s = %s\n' % (oname, value))
4157
def _set_config_option(self, name, value, directory, scope):
4158
conf = self._get_stack(directory, scope, write_access=True)
4159
conf.set(name, value)
4160
# Explicitly save the changes
4161
conf.store.save_changes()
4163
def _remove_config_option(self, name, directory, scope):
4165
raise errors.BzrCommandError(
4166
'--remove expects an option to remove.')
4167
conf = self._get_stack(directory, scope, write_access=True)
4170
# Explicitly save the changes
4171
conf.store.save_changes()
4173
raise errors.NoSuchConfigOption(name)
4178
# We need adapters that can build a Store or a Stack in a test context. Test
4179
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4180
# themselves. The builder will receive a test instance and should return a
4181
# ready-to-use store or stack. Plugins that define new store/stacks can also
4182
# register themselves here to be tested against the tests defined in
4183
# breezy.tests.test_config. Note that the builder can be called multiple times
4184
# for the same test.
4186
# The registered object should be a callable receiving a test instance
4187
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4189
test_store_builder_registry = registry.Registry()
4191
# The registered object should be a callable receiving a test instance
4192
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4194
test_stack_builder_registry = registry.Registry()
added
removed
breezy/config.py
