1
# Copyright (C) 2005-2012 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
32
validate_signatures_in_log=true|false(default)
33
acceptable_keys=pattern1,pattern2
34
gpg_signing_key=amy@example.com
36
in locations.conf, you specify the url of a branch and options for it.
37
Wildcards may be used - * and ? as normal in shell completion. Options
38
set in both bazaar.conf and locations.conf are overridden by the locations.conf
40
[/home/robertc/source]
41
recurse=False|True(default)
43
check_signatures= as above
44
create_signatures= as above.
45
validate_signatures_in_log=as above
46
acceptable_keys=as above
48
explanation of options
49
----------------------
50
editor - this option sets the pop up editor to use during commits.
51
email - this option sets the user id bzr will use when committing.
52
check_signatures - this option will control whether bzr will require good gpg
53
signatures, ignore them, or check them if they are
54
present. Currently it is unused except that check_signatures
55
turns on create_signatures.
56
create_signatures - this option controls whether bzr will always create
57
gpg signatures or not on commits. There is an unused
58
option which in future is expected to work if
59
branch settings require signatures.
60
log_format - this option sets the default log format. Possible values are
61
long, short, line, or a plugin can register new formats.
62
validate_signatures_in_log - show GPG signature validity in log output
63
acceptable_keys - comma separated list of key patterns acceptable for
64
verify-signatures command
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
69
lastlog=log --line -r-10..-1
70
ll=log --line -r-10..-1
75
from __future__ import absolute_import
76
from cStringIO import StringIO
81
from bzrlib.decorators import needs_write_lock
82
from bzrlib.lazy_import import lazy_import
83
lazy_import(globals(), """
104
from bzrlib.i18n import gettext
105
from bzrlib.util.configobj import configobj
113
from bzrlib.symbol_versioning import (
131
POLICY_APPENDPATH = 2
135
POLICY_NORECURSE: 'norecurse',
136
POLICY_APPENDPATH: 'appendpath',
141
'norecurse': POLICY_NORECURSE,
142
'appendpath': POLICY_APPENDPATH,
146
STORE_LOCATION = POLICY_NONE
147
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
148
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
153
def signature_policy_from_unicode(signature_string):
154
"""Convert a string to a signing policy."""
155
if signature_string.lower() == 'check-available':
156
return CHECK_IF_POSSIBLE
157
if signature_string.lower() == 'ignore':
159
if signature_string.lower() == 'require':
161
raise ValueError("Invalid signatures policy '%s'"
165
def signing_policy_from_unicode(signature_string):
166
"""Convert a string to a signing policy."""
167
if signature_string.lower() == 'when-required':
168
return SIGN_WHEN_REQUIRED
169
if signature_string.lower() == 'never':
171
if signature_string.lower() == 'always':
173
raise ValueError("Invalid signing policy '%s'"
177
class ConfigObj(configobj.ConfigObj):
179
def __init__(self, infile=None, **kwargs):
180
# We define our own interpolation mechanism calling it option expansion
181
super(ConfigObj, self).__init__(infile=infile,
185
def get_bool(self, section, key):
186
return self[section].as_bool(key)
188
def get_value(self, section, name):
189
# Try [] for the old DEFAULT section.
190
if section == "DEFAULT":
195
return self[section][name]
198
# FIXME: Until we can guarantee that each config file is loaded once and
199
# only once for a given bzrlib session, we don't want to re-read the file every
200
# time we query for an option so we cache the value (bad ! watch out for tests
201
# needing to restore the proper value). -- vila 20110219
202
_expand_default_value = None
203
def _get_expand_default_value():
204
global _expand_default_value
205
if _expand_default_value is not None:
206
return _expand_default_value
207
conf = GlobalConfig()
208
# Note that we must not use None for the expand value below or we'll run
209
# into infinite recursion. Using False really would be quite silly ;)
210
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
212
# This is an opt-in feature, you *really* need to clearly say you want
215
_expand_default_value = expand
219
class Config(object):
220
"""A configuration policy - what username, editor, gpg needs etc."""
223
super(Config, self).__init__()
226
"""Returns a unique ID for the config."""
227
raise NotImplementedError(self.config_id)
229
@deprecated_method(deprecated_in((2, 4, 0)))
230
def get_editor(self):
231
"""Get the users pop up editor."""
232
raise NotImplementedError
234
def get_change_editor(self, old_tree, new_tree):
235
from bzrlib import diff
236
cmd = self._get_change_editor()
239
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
242
def _get_signature_checking(self):
243
"""Template method to override signature checking policy."""
245
def _get_signing_policy(self):
246
"""Template method to override signature creation policy."""
250
def expand_options(self, string, env=None):
251
"""Expand option references in the string in the configuration context.
253
:param string: The string containing option to expand.
255
:param env: An option dict defining additional configuration options or
256
overriding existing ones.
258
:returns: The expanded string.
260
return self._expand_options_in_string(string, env)
262
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
263
"""Expand options in a list of strings in the configuration context.
265
:param slist: A list of strings.
267
:param env: An option dict defining additional configuration options or
268
overriding existing ones.
270
:param _ref_stack: Private list containing the options being
271
expanded to detect loops.
273
:returns: The flatten list of expanded strings.
275
# expand options in each value separately flattening lists
278
value = self._expand_options_in_string(s, env, _ref_stack)
279
if isinstance(value, list):
285
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
286
"""Expand options in the string in the configuration context.
288
:param string: The string to be expanded.
290
:param env: An option dict defining additional configuration options or
291
overriding existing ones.
293
:param _ref_stack: Private list containing the options being
294
expanded to detect loops.
296
:returns: The expanded string.
299
# Not much to expand there
301
if _ref_stack is None:
302
# What references are currently resolved (to detect loops)
304
if self.option_ref_re is None:
305
# We want to match the most embedded reference first (i.e. for
306
# '{{foo}}' we will get '{foo}',
307
# for '{bar{baz}}' we will get '{baz}'
308
self.option_ref_re = re.compile('({[^{}]+})')
310
# We need to iterate until no more refs appear ({{foo}} will need two
311
# iterations for example).
313
raw_chunks = self.option_ref_re.split(result)
314
if len(raw_chunks) == 1:
315
# Shorcut the trivial case: no refs
319
# Split will isolate refs so that every other chunk is a ref
321
for chunk in raw_chunks:
324
# Keep only non-empty strings (or we get bogus empty
325
# slots when a list value is involved).
330
if name in _ref_stack:
331
raise errors.OptionExpansionLoop(string, _ref_stack)
332
_ref_stack.append(name)
333
value = self._expand_option(name, env, _ref_stack)
335
raise errors.ExpandingUnknownOption(name, string)
336
if isinstance(value, list):
344
# Once a list appears as the result of an expansion, all
345
# callers will get a list result. This allows a consistent
346
# behavior even when some options in the expansion chain
347
# defined as strings (no comma in their value) but their
348
# expanded value is a list.
349
return self._expand_options_in_list(chunks, env, _ref_stack)
351
result = ''.join(chunks)
354
def _expand_option(self, name, env, _ref_stack):
355
if env is not None and name in env:
356
# Special case, values provided in env takes precedence over
360
# FIXME: This is a limited implementation, what we really need is a
361
# way to query the bzr config for the value of an option,
362
# respecting the scope rules (That is, once we implement fallback
363
# configs, getting the option value should restart from the top
364
# config, not the current one) -- vila 20101222
365
value = self.get_user_option(name, expand=False)
366
if isinstance(value, list):
367
value = self._expand_options_in_list(value, env, _ref_stack)
369
value = self._expand_options_in_string(value, env, _ref_stack)
372
def _get_user_option(self, option_name):
373
"""Template method to provide a user option."""
376
def get_user_option(self, option_name, expand=None):
377
"""Get a generic option - no special process, no default.
379
:param option_name: The queried option.
381
:param expand: Whether options references should be expanded.
383
:returns: The value of the option.
386
expand = _get_expand_default_value()
387
value = self._get_user_option(option_name)
389
if isinstance(value, list):
390
value = self._expand_options_in_list(value)
391
elif isinstance(value, dict):
392
trace.warning('Cannot expand "%s":'
393
' Dicts do not support option expansion'
396
value = self._expand_options_in_string(value)
397
for hook in OldConfigHooks['get']:
398
hook(self, option_name, value)
401
def get_user_option_as_bool(self, option_name, expand=None, default=None):
402
"""Get a generic option as a boolean.
404
:param expand: Allow expanding references to other config values.
405
:param default: Default value if nothing is configured
406
:return None if the option doesn't exist or its value can't be
407
interpreted as a boolean. Returns True or False otherwise.
409
s = self.get_user_option(option_name, expand=expand)
411
# The option doesn't exist
413
val = ui.bool_from_string(s)
415
# The value can't be interpreted as a boolean
416
trace.warning('Value "%s" is not a boolean for "%s"',
420
def get_user_option_as_list(self, option_name, expand=None):
421
"""Get a generic option as a list - no special process, no default.
423
:return None if the option doesn't exist. Returns the value as a list
426
l = self.get_user_option(option_name, expand=expand)
427
if isinstance(l, (str, unicode)):
428
# A single value, most probably the user forgot (or didn't care to
433
@deprecated_method(deprecated_in((2, 5, 0)))
434
def get_user_option_as_int_from_SI(self, option_name, default=None):
435
"""Get a generic option from a human readable size in SI units, e.g 10MB
437
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
438
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
441
:return Integer, expanded to its base-10 value if a proper SI unit is
442
found. If the option doesn't exist, or isn't a value in
443
SI units, return default (which defaults to None)
445
val = self.get_user_option(option_name)
446
if isinstance(val, list):
451
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
455
val = int(m.group(1))
456
if m.group(2) is not None:
457
if m.group(2).lower() == 'k':
459
elif m.group(2).lower() == 'm':
461
elif m.group(2).lower() == 'g':
464
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
465
' value {1!r} is not an SI unit.').format(
472
@deprecated_method(deprecated_in((2, 5, 0)))
473
def gpg_signing_command(self):
474
"""What program should be used to sign signatures?"""
475
result = self._gpg_signing_command()
480
def _gpg_signing_command(self):
481
"""See gpg_signing_command()."""
484
@deprecated_method(deprecated_in((2, 5, 0)))
485
def log_format(self):
486
"""What log format should be used"""
487
result = self._log_format()
492
def _log_format(self):
493
"""See log_format()."""
496
def validate_signatures_in_log(self):
497
"""Show GPG signature validity in log"""
498
result = self._validate_signatures_in_log()
505
def _validate_signatures_in_log(self):
506
"""See validate_signatures_in_log()."""
509
@deprecated_method(deprecated_in((2, 5, 0)))
510
def acceptable_keys(self):
511
"""Comma separated list of key patterns acceptable to
512
verify-signatures command"""
513
result = self._acceptable_keys()
516
def _acceptable_keys(self):
517
"""See acceptable_keys()."""
520
@deprecated_method(deprecated_in((2, 5, 0)))
521
def post_commit(self):
522
"""An ordered list of python functions to call.
524
Each function takes branch, rev_id as parameters.
526
return self._post_commit()
528
def _post_commit(self):
529
"""See Config.post_commit."""
532
def user_email(self):
533
"""Return just the email component of a username."""
534
return extract_email_address(self.username())
537
"""Return email-style username.
539
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
541
$BZR_EMAIL can be set to override this, then
542
the concrete policy type is checked, and finally
544
If no username can be found, errors.NoWhoami exception is raised.
546
v = os.environ.get('BZR_EMAIL')
548
return v.decode(osutils.get_user_encoding())
549
v = self._get_user_id()
552
return default_email()
554
def ensure_username(self):
555
"""Raise errors.NoWhoami if username is not set.
557
This method relies on the username() function raising the error.
561
@deprecated_method(deprecated_in((2, 5, 0)))
562
def signature_checking(self):
563
"""What is the current policy for signature checking?."""
564
policy = self._get_signature_checking()
565
if policy is not None:
567
return CHECK_IF_POSSIBLE
569
@deprecated_method(deprecated_in((2, 5, 0)))
570
def signing_policy(self):
571
"""What is the current policy for signature checking?."""
572
policy = self._get_signing_policy()
573
if policy is not None:
575
return SIGN_WHEN_REQUIRED
577
@deprecated_method(deprecated_in((2, 5, 0)))
578
def signature_needed(self):
579
"""Is a signature needed when committing ?."""
580
policy = self._get_signing_policy()
582
policy = self._get_signature_checking()
583
if policy is not None:
584
#this warning should go away once check_signatures is
585
#implemented (if not before)
586
trace.warning("Please use create_signatures,"
587
" not check_signatures to set signing policy.")
588
elif policy == SIGN_ALWAYS:
592
@deprecated_method(deprecated_in((2, 5, 0)))
593
def gpg_signing_key(self):
594
"""GPG user-id to sign commits"""
595
key = self.get_user_option('gpg_signing_key')
596
if key == "default" or key == None:
597
return self.user_email()
601
def get_alias(self, value):
602
return self._get_alias(value)
604
def _get_alias(self, value):
607
def get_nickname(self):
608
return self._get_nickname()
610
def _get_nickname(self):
613
def get_bzr_remote_path(self):
615
return os.environ['BZR_REMOTE_PATH']
617
path = self.get_user_option("bzr_remote_path")
622
def suppress_warning(self, warning):
623
"""Should the warning be suppressed or emitted.
625
:param warning: The name of the warning being tested.
627
:returns: True if the warning should be suppressed, False otherwise.
629
warnings = self.get_user_option_as_list('suppress_warnings')
630
if warnings is None or warning not in warnings:
635
def get_merge_tools(self):
637
for (oname, value, section, conf_id, parser) in self._get_options():
638
if oname.startswith('bzr.mergetool.'):
639
tool_name = oname[len('bzr.mergetool.'):]
640
tools[tool_name] = self.get_user_option(oname)
641
trace.mutter('loaded merge tools: %r' % tools)
644
def find_merge_tool(self, name):
645
# We fake a defaults mechanism here by checking if the given name can
646
# be found in the known_merge_tools if it's not found in the config.
647
# This should be done through the proposed config defaults mechanism
648
# when it becomes available in the future.
649
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
651
or mergetools.known_merge_tools.get(name, None))
655
class _ConfigHooks(hooks.Hooks):
656
"""A dict mapping hook names and a list of callables for configs.
660
"""Create the default hooks.
662
These are all empty initially, because by default nothing should get
665
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
666
self.add_hook('load',
667
'Invoked when a config store is loaded.'
668
' The signature is (store).',
670
self.add_hook('save',
671
'Invoked when a config store is saved.'
672
' The signature is (store).',
674
# The hooks for config options
676
'Invoked when a config option is read.'
677
' The signature is (stack, name, value).',
680
'Invoked when a config option is set.'
681
' The signature is (stack, name, value).',
683
self.add_hook('remove',
684
'Invoked when a config option is removed.'
685
' The signature is (stack, name).',
687
ConfigHooks = _ConfigHooks()
690
class _OldConfigHooks(hooks.Hooks):
691
"""A dict mapping hook names and a list of callables for configs.
695
"""Create the default hooks.
697
These are all empty initially, because by default nothing should get
700
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
701
self.add_hook('load',
702
'Invoked when a config store is loaded.'
703
' The signature is (config).',
705
self.add_hook('save',
706
'Invoked when a config store is saved.'
707
' The signature is (config).',
709
# The hooks for config options
711
'Invoked when a config option is read.'
712
' The signature is (config, name, value).',
715
'Invoked when a config option is set.'
716
' The signature is (config, name, value).',
718
self.add_hook('remove',
719
'Invoked when a config option is removed.'
720
' The signature is (config, name).',
722
OldConfigHooks = _OldConfigHooks()
725
class IniBasedConfig(Config):
726
"""A configuration policy that draws from ini files."""
728
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
730
"""Base class for configuration files using an ini-like syntax.
732
:param file_name: The configuration file path.
734
super(IniBasedConfig, self).__init__()
735
self.file_name = file_name
736
if symbol_versioning.deprecated_passed(get_filename):
737
symbol_versioning.warn(
738
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
739
' Use file_name instead.',
742
if get_filename is not None:
743
self.file_name = get_filename()
745
self.file_name = file_name
750
def from_string(cls, str_or_unicode, file_name=None, save=False):
751
"""Create a config object from a string.
753
:param str_or_unicode: A string representing the file content. This will
756
:param file_name: The configuration file path.
758
:param _save: Whether the file should be saved upon creation.
760
conf = cls(file_name=file_name)
761
conf._create_from_string(str_or_unicode, save)
764
def _create_from_string(self, str_or_unicode, save):
765
self._content = StringIO(str_or_unicode.encode('utf-8'))
766
# Some tests use in-memory configs, some other always need the config
767
# file to exist on disk.
769
self._write_config_file()
771
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
772
if self._parser is not None:
774
if symbol_versioning.deprecated_passed(file):
775
symbol_versioning.warn(
776
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
777
' Use IniBasedConfig(_content=xxx) instead.',
780
if self._content is not None:
781
co_input = self._content
782
elif self.file_name is None:
783
raise AssertionError('We have no content to create the config')
785
co_input = self.file_name
787
self._parser = ConfigObj(co_input, encoding='utf-8')
788
except configobj.ConfigObjError, e:
789
raise errors.ParseConfigError(e.errors, e.config.filename)
790
except UnicodeDecodeError:
791
raise errors.ConfigContentError(self.file_name)
792
# Make sure self.reload() will use the right file name
793
self._parser.filename = self.file_name
794
for hook in OldConfigHooks['load']:
799
"""Reload the config file from disk."""
800
if self.file_name is None:
801
raise AssertionError('We need a file name to reload the config')
802
if self._parser is not None:
803
self._parser.reload()
804
for hook in ConfigHooks['load']:
807
def _get_matching_sections(self):
808
"""Return an ordered list of (section_name, extra_path) pairs.
810
If the section contains inherited configuration, extra_path is
811
a string containing the additional path components.
813
section = self._get_section()
814
if section is not None:
815
return [(section, '')]
819
def _get_section(self):
820
"""Override this to define the section used by the config."""
823
def _get_sections(self, name=None):
824
"""Returns an iterator of the sections specified by ``name``.
826
:param name: The section name. If None is supplied, the default
827
configurations are yielded.
829
:return: A tuple (name, section, config_id) for all sections that will
830
be walked by user_get_option() in the 'right' order. The first one
831
is where set_user_option() will update the value.
833
parser = self._get_parser()
835
yield (name, parser[name], self.config_id())
837
# No section name has been given so we fallback to the configobj
838
# itself which holds the variables defined outside of any section.
839
yield (None, parser, self.config_id())
841
def _get_options(self, sections=None):
842
"""Return an ordered list of (name, value, section, config_id) tuples.
844
All options are returned with their associated value and the section
845
they appeared in. ``config_id`` is a unique identifier for the
846
configuration file the option is defined in.
848
:param sections: Default to ``_get_matching_sections`` if not
849
specified. This gives a better control to daughter classes about
850
which sections should be searched. This is a list of (name,
855
parser = self._get_parser()
857
for (section_name, _) in self._get_matching_sections():
859
section = parser[section_name]
861
# This could happen for an empty file for which we define a
862
# DEFAULT section. FIXME: Force callers to provide sections
863
# instead ? -- vila 20100930
865
sections.append((section_name, section))
866
config_id = self.config_id()
867
for (section_name, section) in sections:
868
for (name, value) in section.iteritems():
869
yield (name, parser._quote(value), section_name,
872
def _get_option_policy(self, section, option_name):
873
"""Return the policy for the given (section, option_name) pair."""
876
def _get_change_editor(self):
877
return self.get_user_option('change_editor')
879
def _get_signature_checking(self):
880
"""See Config._get_signature_checking."""
881
policy = self._get_user_option('check_signatures')
883
return signature_policy_from_unicode(policy)
885
def _get_signing_policy(self):
886
"""See Config._get_signing_policy"""
887
policy = self._get_user_option('create_signatures')
889
return signing_policy_from_unicode(policy)
891
def _get_user_id(self):
892
"""Get the user id from the 'email' key in the current section."""
893
return self._get_user_option('email')
895
def _get_user_option(self, option_name):
896
"""See Config._get_user_option."""
897
for (section, extra_path) in self._get_matching_sections():
899
value = self._get_parser().get_value(section, option_name)
902
policy = self._get_option_policy(section, option_name)
903
if policy == POLICY_NONE:
905
elif policy == POLICY_NORECURSE:
906
# norecurse items only apply to the exact path
911
elif policy == POLICY_APPENDPATH:
913
value = urlutils.join(value, extra_path)
916
raise AssertionError('Unexpected config policy %r' % policy)
920
def _gpg_signing_command(self):
921
"""See Config.gpg_signing_command."""
922
return self._get_user_option('gpg_signing_command')
924
def _log_format(self):
925
"""See Config.log_format."""
926
return self._get_user_option('log_format')
928
def _validate_signatures_in_log(self):
929
"""See Config.validate_signatures_in_log."""
930
return self._get_user_option('validate_signatures_in_log')
932
def _acceptable_keys(self):
933
"""See Config.acceptable_keys."""
934
return self._get_user_option('acceptable_keys')
936
def _post_commit(self):
937
"""See Config.post_commit."""
938
return self._get_user_option('post_commit')
940
def _get_alias(self, value):
942
return self._get_parser().get_value("ALIASES",
947
def _get_nickname(self):
948
return self.get_user_option('nickname')
950
def remove_user_option(self, option_name, section_name=None):
951
"""Remove a user option and save the configuration file.
953
:param option_name: The option to be removed.
955
:param section_name: The section the option is defined in, default to
959
parser = self._get_parser()
960
if section_name is None:
963
section = parser[section_name]
965
del section[option_name]
967
raise errors.NoSuchConfigOption(option_name)
968
self._write_config_file()
969
for hook in OldConfigHooks['remove']:
970
hook(self, option_name)
972
def _write_config_file(self):
973
if self.file_name is None:
974
raise AssertionError('We cannot save, self.file_name is None')
975
conf_dir = os.path.dirname(self.file_name)
976
ensure_config_dir_exists(conf_dir)
977
atomic_file = atomicfile.AtomicFile(self.file_name)
978
self._get_parser().write(atomic_file)
981
osutils.copy_ownership_from_path(self.file_name)
982
for hook in OldConfigHooks['save']:
986
class LockableConfig(IniBasedConfig):
987
"""A configuration needing explicit locking for access.
989
If several processes try to write the config file, the accesses need to be
992
Daughter classes should decorate all methods that update a config with the
993
``@needs_write_lock`` decorator (they call, directly or indirectly, the
994
``_write_config_file()`` method. These methods (typically ``set_option()``
995
and variants must reload the config file from disk before calling
996
``_write_config_file()``), this can be achieved by calling the
997
``self.reload()`` method. Note that the lock scope should cover both the
998
reading and the writing of the config file which is why the decorator can't
999
be applied to ``_write_config_file()`` only.
1001
This should be enough to implement the following logic:
1002
- lock for exclusive write access,
1003
- reload the config file from disk,
1007
This logic guarantees that a writer can update a value without erasing an
1008
update made by another writer.
1013
def __init__(self, file_name):
1014
super(LockableConfig, self).__init__(file_name=file_name)
1015
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1016
# FIXME: It doesn't matter that we don't provide possible_transports
1017
# below since this is currently used only for local config files ;
1018
# local transports are not shared. But if/when we start using
1019
# LockableConfig for other kind of transports, we will need to reuse
1020
# whatever connection is already established -- vila 20100929
1021
self.transport = transport.get_transport_from_path(self.dir)
1022
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1024
def _create_from_string(self, unicode_bytes, save):
1025
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1027
# We need to handle the saving here (as opposed to IniBasedConfig)
1028
# to be able to lock
1030
self._write_config_file()
1033
def lock_write(self, token=None):
1034
"""Takes a write lock in the directory containing the config file.
1036
If the directory doesn't exist it is created.
1038
ensure_config_dir_exists(self.dir)
1039
return self._lock.lock_write(token)
1044
def break_lock(self):
1045
self._lock.break_lock()
1048
def remove_user_option(self, option_name, section_name=None):
1049
super(LockableConfig, self).remove_user_option(option_name,
1052
def _write_config_file(self):
1053
if self._lock is None or not self._lock.is_held:
1054
# NB: if the following exception is raised it probably means a
1055
# missing @needs_write_lock decorator on one of the callers.
1056
raise errors.ObjectNotLocked(self)
1057
super(LockableConfig, self)._write_config_file()
1060
class GlobalConfig(LockableConfig):
1061
"""The configuration that should be used for a specific location."""
1064
super(GlobalConfig, self).__init__(file_name=config_filename())
1066
def config_id(self):
1070
def from_string(cls, str_or_unicode, save=False):
1071
"""Create a config object from a string.
1073
:param str_or_unicode: A string representing the file content. This
1074
will be utf-8 encoded.
1076
:param save: Whether the file should be saved upon creation.
1079
conf._create_from_string(str_or_unicode, save)
1082
@deprecated_method(deprecated_in((2, 4, 0)))
1083
def get_editor(self):
1084
return self._get_user_option('editor')
1087
def set_user_option(self, option, value):
1088
"""Save option and its value in the configuration."""
1089
self._set_option(option, value, 'DEFAULT')
1091
def get_aliases(self):
1092
"""Return the aliases section."""
1093
if 'ALIASES' in self._get_parser():
1094
return self._get_parser()['ALIASES']
1099
def set_alias(self, alias_name, alias_command):
1100
"""Save the alias in the configuration."""
1101
self._set_option(alias_name, alias_command, 'ALIASES')
1104
def unset_alias(self, alias_name):
1105
"""Unset an existing alias."""
1107
aliases = self._get_parser().get('ALIASES')
1108
if not aliases or alias_name not in aliases:
1109
raise errors.NoSuchAlias(alias_name)
1110
del aliases[alias_name]
1111
self._write_config_file()
1113
def _set_option(self, option, value, section):
1115
self._get_parser().setdefault(section, {})[option] = value
1116
self._write_config_file()
1117
for hook in OldConfigHooks['set']:
1118
hook(self, option, value)
1120
def _get_sections(self, name=None):
1121
"""See IniBasedConfig._get_sections()."""
1122
parser = self._get_parser()
1123
# We don't give access to options defined outside of any section, we
1124
# used the DEFAULT section by... default.
1125
if name in (None, 'DEFAULT'):
1126
# This could happen for an empty file where the DEFAULT section
1127
# doesn't exist yet. So we force DEFAULT when yielding
1129
if 'DEFAULT' not in parser:
1130
parser['DEFAULT']= {}
1131
yield (name, parser[name], self.config_id())
1134
def remove_user_option(self, option_name, section_name=None):
1135
if section_name is None:
1136
# We need to force the default section.
1137
section_name = 'DEFAULT'
1138
# We need to avoid the LockableConfig implementation or we'll lock
1140
super(LockableConfig, self).remove_user_option(option_name,
1143
def _iter_for_location_by_parts(sections, location):
1144
"""Keep only the sessions matching the specified location.
1146
:param sections: An iterable of section names.
1148
:param location: An url or a local path to match against.
1150
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1151
number of path components in the section name, section is the section
1152
name and extra_path is the difference between location and the section
1155
``location`` will always be a local path and never a 'file://' url but the
1156
section names themselves can be in either form.
1158
location_parts = location.rstrip('/').split('/')
1160
for section in sections:
1161
# location is a local path if possible, so we need to convert 'file://'
1162
# urls in section names to local paths if necessary.
1164
# This also avoids having file:///path be a more exact
1165
# match than '/path'.
1167
# FIXME: This still raises an issue if a user defines both file:///path
1168
# *and* /path. Should we raise an error in this case -- vila 20110505
1170
if section.startswith('file://'):
1171
section_path = urlutils.local_path_from_url(section)
1173
section_path = section
1174
section_parts = section_path.rstrip('/').split('/')
1177
if len(section_parts) > len(location_parts):
1178
# More path components in the section, they can't match
1181
# Rely on zip truncating in length to the length of the shortest
1182
# argument sequence.
1183
names = zip(location_parts, section_parts)
1185
if not fnmatch.fnmatch(name[0], name[1]):
1190
# build the path difference between the section and the location
1191
extra_path = '/'.join(location_parts[len(section_parts):])
1192
yield section, extra_path, len(section_parts)
1195
class LocationConfig(LockableConfig):
1196
"""A configuration object that gives the policy for a location."""
1198
def __init__(self, location):
1199
super(LocationConfig, self).__init__(
1200
file_name=locations_config_filename())
1201
# local file locations are looked up by local path, rather than
1202
# by file url. This is because the config file is a user
1203
# file, and we would rather not expose the user to file urls.
1204
if location.startswith('file://'):
1205
location = urlutils.local_path_from_url(location)
1206
self.location = location
1208
def config_id(self):
1212
def from_string(cls, str_or_unicode, location, save=False):
1213
"""Create a config object from a string.
1215
:param str_or_unicode: A string representing the file content. This will
1218
:param location: The location url to filter the configuration.
1220
:param save: Whether the file should be saved upon creation.
1222
conf = cls(location)
1223
conf._create_from_string(str_or_unicode, save)
1226
def _get_matching_sections(self):
1227
"""Return an ordered list of section names matching this location."""
1228
matches = list(_iter_for_location_by_parts(self._get_parser(),
1230
# put the longest (aka more specific) locations first
1232
key=lambda (section, extra_path, length): (length, section),
1234
for (section, extra_path, length) in matches:
1235
yield section, extra_path
1236
# should we stop looking for parent configs here?
1238
if self._get_parser()[section].as_bool('ignore_parents'):
1243
def _get_sections(self, name=None):
1244
"""See IniBasedConfig._get_sections()."""
1245
# We ignore the name here as the only sections handled are named with
1246
# the location path and we don't expose embedded sections either.
1247
parser = self._get_parser()
1248
for name, extra_path in self._get_matching_sections():
1249
yield (name, parser[name], self.config_id())
1251
def _get_option_policy(self, section, option_name):
1252
"""Return the policy for the given (section, option_name) pair."""
1253
# check for the old 'recurse=False' flag
1255
recurse = self._get_parser()[section].as_bool('recurse')
1259
return POLICY_NORECURSE
1261
policy_key = option_name + ':policy'
1263
policy_name = self._get_parser()[section][policy_key]
1267
return _policy_value[policy_name]
1269
def _set_option_policy(self, section, option_name, option_policy):
1270
"""Set the policy for the given option name in the given section."""
1271
# The old recurse=False option affects all options in the
1272
# section. To handle multiple policies in the section, we
1273
# need to convert it to a policy_norecurse key.
1275
recurse = self._get_parser()[section].as_bool('recurse')
1279
symbol_versioning.warn(
1280
'The recurse option is deprecated as of 0.14. '
1281
'The section "%s" has been converted to use policies.'
1284
del self._get_parser()[section]['recurse']
1286
for key in self._get_parser()[section].keys():
1287
if not key.endswith(':policy'):
1288
self._get_parser()[section][key +
1289
':policy'] = 'norecurse'
1291
policy_key = option_name + ':policy'
1292
policy_name = _policy_name[option_policy]
1293
if policy_name is not None:
1294
self._get_parser()[section][policy_key] = policy_name
1296
if policy_key in self._get_parser()[section]:
1297
del self._get_parser()[section][policy_key]
1300
def set_user_option(self, option, value, store=STORE_LOCATION):
1301
"""Save option and its value in the configuration."""
1302
if store not in [STORE_LOCATION,
1303
STORE_LOCATION_NORECURSE,
1304
STORE_LOCATION_APPENDPATH]:
1305
raise ValueError('bad storage policy %r for %r' %
1308
location = self.location
1309
if location.endswith('/'):
1310
location = location[:-1]
1311
parser = self._get_parser()
1312
if not location in parser and not location + '/' in parser:
1313
parser[location] = {}
1314
elif location + '/' in parser:
1315
location = location + '/'
1316
parser[location][option]=value
1317
# the allowed values of store match the config policies
1318
self._set_option_policy(location, option, store)
1319
self._write_config_file()
1320
for hook in OldConfigHooks['set']:
1321
hook(self, option, value)
1324
class BranchConfig(Config):
1325
"""A configuration object giving the policy for a branch."""
1327
def __init__(self, branch):
1328
super(BranchConfig, self).__init__()
1329
self._location_config = None
1330
self._branch_data_config = None
1331
self._global_config = None
1332
self.branch = branch
1333
self.option_sources = (self._get_location_config,
1334
self._get_branch_data_config,
1335
self._get_global_config)
1337
def config_id(self):
1340
def _get_branch_data_config(self):
1341
if self._branch_data_config is None:
1342
self._branch_data_config = TreeConfig(self.branch)
1343
self._branch_data_config.config_id = self.config_id
1344
return self._branch_data_config
1346
def _get_location_config(self):
1347
if self._location_config is None:
1348
self._location_config = LocationConfig(self.branch.base)
1349
return self._location_config
1351
def _get_global_config(self):
1352
if self._global_config is None:
1353
self._global_config = GlobalConfig()
1354
return self._global_config
1356
def _get_best_value(self, option_name):
1357
"""This returns a user option from local, tree or global config.
1359
They are tried in that order. Use get_safe_value if trusted values
1362
for source in self.option_sources:
1363
value = getattr(source(), option_name)()
1364
if value is not None:
1368
def _get_safe_value(self, option_name):
1369
"""This variant of get_best_value never returns untrusted values.
1371
It does not return values from the branch data, because the branch may
1372
not be controlled by the user.
1374
We may wish to allow locations.conf to control whether branches are
1375
trusted in the future.
1377
for source in (self._get_location_config, self._get_global_config):
1378
value = getattr(source(), option_name)()
1379
if value is not None:
1383
def _get_user_id(self):
1384
"""Return the full user id for the branch.
1386
e.g. "John Hacker <jhacker@example.com>"
1387
This is looked up in the email controlfile for the branch.
1389
return self._get_best_value('_get_user_id')
1391
def _get_change_editor(self):
1392
return self._get_best_value('_get_change_editor')
1394
def _get_signature_checking(self):
1395
"""See Config._get_signature_checking."""
1396
return self._get_best_value('_get_signature_checking')
1398
def _get_signing_policy(self):
1399
"""See Config._get_signing_policy."""
1400
return self._get_best_value('_get_signing_policy')
1402
def _get_user_option(self, option_name):
1403
"""See Config._get_user_option."""
1404
for source in self.option_sources:
1405
value = source()._get_user_option(option_name)
1406
if value is not None:
1410
def _get_sections(self, name=None):
1411
"""See IniBasedConfig.get_sections()."""
1412
for source in self.option_sources:
1413
for section in source()._get_sections(name):
1416
def _get_options(self, sections=None):
1418
# First the locations options
1419
for option in self._get_location_config()._get_options():
1421
# Then the branch options
1422
branch_config = self._get_branch_data_config()
1423
if sections is None:
1424
sections = [('DEFAULT', branch_config._get_parser())]
1425
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1426
# Config itself has no notion of sections :( -- vila 20101001
1427
config_id = self.config_id()
1428
for (section_name, section) in sections:
1429
for (name, value) in section.iteritems():
1430
yield (name, value, section_name,
1431
config_id, branch_config._get_parser())
1432
# Then the global options
1433
for option in self._get_global_config()._get_options():
1436
def set_user_option(self, name, value, store=STORE_BRANCH,
1438
if store == STORE_BRANCH:
1439
self._get_branch_data_config().set_option(value, name)
1440
elif store == STORE_GLOBAL:
1441
self._get_global_config().set_user_option(name, value)
1443
self._get_location_config().set_user_option(name, value, store)
1446
if store in (STORE_GLOBAL, STORE_BRANCH):
1447
mask_value = self._get_location_config().get_user_option(name)
1448
if mask_value is not None:
1449
trace.warning('Value "%s" is masked by "%s" from'
1450
' locations.conf', value, mask_value)
1452
if store == STORE_GLOBAL:
1453
branch_config = self._get_branch_data_config()
1454
mask_value = branch_config.get_user_option(name)
1455
if mask_value is not None:
1456
trace.warning('Value "%s" is masked by "%s" from'
1457
' branch.conf', value, mask_value)
1459
def remove_user_option(self, option_name, section_name=None):
1460
self._get_branch_data_config().remove_option(option_name, section_name)
1462
def _gpg_signing_command(self):
1463
"""See Config.gpg_signing_command."""
1464
return self._get_safe_value('_gpg_signing_command')
1466
def _post_commit(self):
1467
"""See Config.post_commit."""
1468
return self._get_safe_value('_post_commit')
1470
def _get_nickname(self):
1471
value = self._get_explicit_nickname()
1472
if value is not None:
1474
return urlutils.unescape(self.branch.base.split('/')[-2])
1476
def has_explicit_nickname(self):
1477
"""Return true if a nickname has been explicitly assigned."""
1478
return self._get_explicit_nickname() is not None
1480
def _get_explicit_nickname(self):
1481
return self._get_best_value('_get_nickname')
1483
def _log_format(self):
1484
"""See Config.log_format."""
1485
return self._get_best_value('_log_format')
1487
def _validate_signatures_in_log(self):
1488
"""See Config.validate_signatures_in_log."""
1489
return self._get_best_value('_validate_signatures_in_log')
1491
def _acceptable_keys(self):
1492
"""See Config.acceptable_keys."""
1493
return self._get_best_value('_acceptable_keys')
1496
def ensure_config_dir_exists(path=None):
1497
"""Make sure a configuration directory exists.
1498
This makes sure that the directory exists.
1499
On windows, since configuration directories are 2 levels deep,
1500
it makes sure both the directory and the parent directory exists.
1504
if not os.path.isdir(path):
1505
if sys.platform == 'win32':
1506
parent_dir = os.path.dirname(path)
1507
if not os.path.isdir(parent_dir):
1508
trace.mutter('creating config parent directory: %r', parent_dir)
1509
os.mkdir(parent_dir)
1510
trace.mutter('creating config directory: %r', path)
1512
osutils.copy_ownership_from_path(path)
1516
"""Return per-user configuration directory as unicode string
1518
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1519
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1520
that will be used instead.
1522
TODO: Global option --config-dir to override this.
1524
base = osutils.path_from_environ('BZR_HOME')
1525
if sys.platform == 'win32':
1527
base = win32utils.get_appdata_location()
1529
base = win32utils.get_home_location()
1530
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1531
# APPDATA, but hard to move. See bug 348640 for more.
1532
return osutils.pathjoin(base, 'bazaar', '2.0')
1534
# GZ 2012-02-01: What should OSX use instead of XDG if anything?
1535
if sys.platform != 'darwin':
1536
xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1538
xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1539
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1540
if osutils.isdir(xdg_dir):
1542
"Using configuration in XDG directory %s." % xdg_dir)
1544
base = osutils._get_home_dir()
1545
return osutils.pathjoin(base, ".bazaar")
1548
def config_filename():
1549
"""Return per-user configuration ini file filename."""
1550
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1553
def locations_config_filename():
1554
"""Return per-user configuration ini file filename."""
1555
return osutils.pathjoin(config_dir(), 'locations.conf')
1558
def authentication_config_filename():
1559
"""Return per-user authentication ini file filename."""
1560
return osutils.pathjoin(config_dir(), 'authentication.conf')
1563
def user_ignore_config_filename():
1564
"""Return the user default ignore filename"""
1565
return osutils.pathjoin(config_dir(), 'ignore')
1569
"""Return the directory name to store crash files.
1571
This doesn't implicitly create it.
1573
On Windows it's in the config directory; elsewhere it's /var/crash
1574
which may be monitored by apport. It can be overridden by
1577
if sys.platform == 'win32':
1578
return osutils.pathjoin(config_dir(), 'Crash')
1580
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1582
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1585
def xdg_cache_dir():
1586
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1587
# Possibly this should be different on Windows?
1588
e = os.environ.get('XDG_CACHE_DIR', None)
1592
return os.path.expanduser('~/.cache')
1595
def _get_default_mail_domain():
1596
"""If possible, return the assumed default email domain.
1598
:returns: string mail domain, or None.
1600
if sys.platform == 'win32':
1601
# No implementation yet; patches welcome
1604
f = open('/etc/mailname')
1605
except (IOError, OSError), e:
1608
domain = f.read().strip()
1614
def default_email():
1615
v = os.environ.get('BZR_EMAIL')
1617
return v.decode(osutils.get_user_encoding())
1618
v = os.environ.get('EMAIL')
1620
return v.decode(osutils.get_user_encoding())
1621
name, email = _auto_user_id()
1623
return u'%s <%s>' % (name, email)
1626
raise errors.NoWhoami()
1629
def _auto_user_id():
1630
"""Calculate automatic user identification.
1632
:returns: (realname, email), either of which may be None if they can't be
1635
Only used when none is set in the environment or the id file.
1637
This only returns an email address if we can be fairly sure the
1638
address is reasonable, ie if /etc/mailname is set on unix.
1640
This doesn't use the FQDN as the default domain because that may be
1641
slow, and it doesn't use the hostname alone because that's not normally
1642
a reasonable address.
1644
if sys.platform == 'win32':
1645
# No implementation to reliably determine Windows default mail
1646
# address; please add one.
1649
default_mail_domain = _get_default_mail_domain()
1650
if not default_mail_domain:
1656
w = pwd.getpwuid(uid)
1658
trace.mutter('no passwd entry for uid %d?' % uid)
1661
# we try utf-8 first, because on many variants (like Linux),
1662
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1663
# false positives. (many users will have their user encoding set to
1664
# latin-1, which cannot raise UnicodeError.)
1666
gecos = w.pw_gecos.decode('utf-8')
1668
except UnicodeError:
1670
encoding = osutils.get_user_encoding()
1671
gecos = w.pw_gecos.decode(encoding)
1672
except UnicodeError, e:
1673
trace.mutter("cannot decode passwd entry %s" % w)
1676
username = w.pw_name.decode(encoding)
1677
except UnicodeError, e:
1678
trace.mutter("cannot decode passwd entry %s" % w)
1681
comma = gecos.find(',')
1685
realname = gecos[:comma]
1687
return realname, (username + '@' + default_mail_domain)
1690
def parse_username(username):
1691
"""Parse e-mail username and return a (name, address) tuple."""
1692
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1694
return (username, '')
1696
return (match.group(1), match.group(2))
1699
def extract_email_address(e):
1700
"""Return just the address part of an email string.
1702
That is just the user@domain part, nothing else.
1703
This part is required to contain only ascii characters.
1704
If it can't be extracted, raises an error.
1706
>>> extract_email_address('Jane Tester <jane@test.com>')
1709
name, email = parse_username(e)
1711
raise errors.NoEmailInUsername(e)
1715
class TreeConfig(IniBasedConfig):
1716
"""Branch configuration data associated with its contents, not location"""
1718
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1720
def __init__(self, branch):
1721
self._config = branch._get_config()
1722
self.branch = branch
1724
def _get_parser(self, file=None):
1725
if file is not None:
1726
return IniBasedConfig._get_parser(file)
1727
return self._config._get_configobj()
1729
def get_option(self, name, section=None, default=None):
1730
self.branch.lock_read()
1732
return self._config.get_option(name, section, default)
1734
self.branch.unlock()
1736
def set_option(self, value, name, section=None):
1737
"""Set a per-branch configuration option"""
1738
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1739
# higher levels providing the right lock -- vila 20101004
1740
self.branch.lock_write()
1742
self._config.set_option(value, name, section)
1744
self.branch.unlock()
1746
def remove_option(self, option_name, section_name=None):
1747
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1748
# higher levels providing the right lock -- vila 20101004
1749
self.branch.lock_write()
1751
self._config.remove_option(option_name, section_name)
1753
self.branch.unlock()
1756
class AuthenticationConfig(object):
1757
"""The authentication configuration file based on a ini file.
1759
Implements the authentication.conf file described in
1760
doc/developers/authentication-ring.txt.
1763
def __init__(self, _file=None):
1764
self._config = None # The ConfigObj
1766
self._filename = authentication_config_filename()
1767
self._input = self._filename = authentication_config_filename()
1769
# Tests can provide a string as _file
1770
self._filename = None
1773
def _get_config(self):
1774
if self._config is not None:
1777
# FIXME: Should we validate something here ? Includes: empty
1778
# sections are useless, at least one of
1779
# user/password/password_encoding should be defined, etc.
1781
# Note: the encoding below declares that the file itself is utf-8
1782
# encoded, but the values in the ConfigObj are always Unicode.
1783
self._config = ConfigObj(self._input, encoding='utf-8')
1784
except configobj.ConfigObjError, e:
1785
raise errors.ParseConfigError(e.errors, e.config.filename)
1786
except UnicodeError:
1787
raise errors.ConfigContentError(self._filename)
1791
"""Save the config file, only tests should use it for now."""
1792
conf_dir = os.path.dirname(self._filename)
1793
ensure_config_dir_exists(conf_dir)
1794
f = file(self._filename, 'wb')
1796
self._get_config().write(f)
1800
def _set_option(self, section_name, option_name, value):
1801
"""Set an authentication configuration option"""
1802
conf = self._get_config()
1803
section = conf.get(section_name)
1806
section = conf[section]
1807
section[option_name] = value
1810
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1812
"""Returns the matching credentials from authentication.conf file.
1814
:param scheme: protocol
1816
:param host: the server address
1818
:param port: the associated port (optional)
1820
:param user: login (optional)
1822
:param path: the absolute path on the server (optional)
1824
:param realm: the http authentication realm (optional)
1826
:return: A dict containing the matching credentials or None.
1828
- name: the section name of the credentials in the
1829
authentication.conf file,
1830
- user: can't be different from the provided user if any,
1831
- scheme: the server protocol,
1832
- host: the server address,
1833
- port: the server port (can be None),
1834
- path: the absolute server path (can be None),
1835
- realm: the http specific authentication realm (can be None),
1836
- password: the decoded password, could be None if the credential
1837
defines only the user
1838
- verify_certificates: https specific, True if the server
1839
certificate should be verified, False otherwise.
1842
for auth_def_name, auth_def in self._get_config().items():
1843
if type(auth_def) is not configobj.Section:
1844
raise ValueError("%s defined outside a section" % auth_def_name)
1846
a_scheme, a_host, a_user, a_path = map(
1847
auth_def.get, ['scheme', 'host', 'user', 'path'])
1850
a_port = auth_def.as_int('port')
1854
raise ValueError("'port' not numeric in %s" % auth_def_name)
1856
a_verify_certificates = auth_def.as_bool('verify_certificates')
1858
a_verify_certificates = True
1861
"'verify_certificates' not boolean in %s" % auth_def_name)
1864
if a_scheme is not None and scheme != a_scheme:
1866
if a_host is not None:
1867
if not (host == a_host
1868
or (a_host.startswith('.') and host.endswith(a_host))):
1870
if a_port is not None and port != a_port:
1872
if (a_path is not None and path is not None
1873
and not path.startswith(a_path)):
1875
if (a_user is not None and user is not None
1876
and a_user != user):
1877
# Never contradict the caller about the user to be used
1882
# Prepare a credentials dictionary with additional keys
1883
# for the credential providers
1884
credentials = dict(name=auth_def_name,
1891
password=auth_def.get('password', None),
1892
verify_certificates=a_verify_certificates)
1893
# Decode the password in the credentials (or get one)
1894
self.decode_password(credentials,
1895
auth_def.get('password_encoding', None))
1896
if 'auth' in debug.debug_flags:
1897
trace.mutter("Using authentication section: %r", auth_def_name)
1900
if credentials is None:
1901
# No credentials were found in authentication.conf, try the fallback
1902
# credentials stores.
1903
credentials = credential_store_registry.get_fallback_credentials(
1904
scheme, host, port, user, path, realm)
1908
def set_credentials(self, name, host, user, scheme=None, password=None,
1909
port=None, path=None, verify_certificates=None,
1911
"""Set authentication credentials for a host.
1913
Any existing credentials with matching scheme, host, port and path
1914
will be deleted, regardless of name.
1916
:param name: An arbitrary name to describe this set of credentials.
1917
:param host: Name of the host that accepts these credentials.
1918
:param user: The username portion of these credentials.
1919
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1921
:param password: Password portion of these credentials.
1922
:param port: The IP port on the host that these credentials apply to.
1923
:param path: A filesystem path on the host that these credentials
1925
:param verify_certificates: On https, verify server certificates if
1927
:param realm: The http authentication realm (optional).
1929
values = {'host': host, 'user': user}
1930
if password is not None:
1931
values['password'] = password
1932
if scheme is not None:
1933
values['scheme'] = scheme
1934
if port is not None:
1935
values['port'] = '%d' % port
1936
if path is not None:
1937
values['path'] = path
1938
if verify_certificates is not None:
1939
values['verify_certificates'] = str(verify_certificates)
1940
if realm is not None:
1941
values['realm'] = realm
1942
config = self._get_config()
1944
for section, existing_values in config.items():
1945
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1946
if existing_values.get(key) != values.get(key):
1950
config.update({name: values})
1953
def get_user(self, scheme, host, port=None, realm=None, path=None,
1954
prompt=None, ask=False, default=None):
1955
"""Get a user from authentication file.
1957
:param scheme: protocol
1959
:param host: the server address
1961
:param port: the associated port (optional)
1963
:param realm: the realm sent by the server (optional)
1965
:param path: the absolute path on the server (optional)
1967
:param ask: Ask the user if there is no explicitly configured username
1970
:param default: The username returned if none is defined (optional).
1972
:return: The found user.
1974
credentials = self.get_credentials(scheme, host, port, user=None,
1975
path=path, realm=realm)
1976
if credentials is not None:
1977
user = credentials['user']
1983
# Create a default prompt suitable for most cases
1984
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1985
# Special handling for optional fields in the prompt
1986
if port is not None:
1987
prompt_host = '%s:%d' % (host, port)
1990
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1995
def get_password(self, scheme, host, user, port=None,
1996
realm=None, path=None, prompt=None):
1997
"""Get a password from authentication file or prompt the user for one.
1999
:param scheme: protocol
2001
:param host: the server address
2003
:param port: the associated port (optional)
2007
:param realm: the realm sent by the server (optional)
2009
:param path: the absolute path on the server (optional)
2011
:return: The found password or the one entered by the user.
2013
credentials = self.get_credentials(scheme, host, port, user, path,
2015
if credentials is not None:
2016
password = credentials['password']
2017
if password is not None and scheme is 'ssh':
2018
trace.warning('password ignored in section [%s],'
2019
' use an ssh agent instead'
2020
% credentials['name'])
2024
# Prompt user only if we could't find a password
2025
if password is None:
2027
# Create a default prompt suitable for most cases
2028
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2029
# Special handling for optional fields in the prompt
2030
if port is not None:
2031
prompt_host = '%s:%d' % (host, port)
2034
password = ui.ui_factory.get_password(prompt,
2035
host=prompt_host, user=user)
2038
def decode_password(self, credentials, encoding):
2040
cs = credential_store_registry.get_credential_store(encoding)
2042
raise ValueError('%r is not a known password_encoding' % encoding)
2043
credentials['password'] = cs.decode_password(credentials)
2047
class CredentialStoreRegistry(registry.Registry):
2048
"""A class that registers credential stores.
2050
A credential store provides access to credentials via the password_encoding
2051
field in authentication.conf sections.
2053
Except for stores provided by bzr itself, most stores are expected to be
2054
provided by plugins that will therefore use
2055
register_lazy(password_encoding, module_name, member_name, help=help,
2056
fallback=fallback) to install themselves.
2058
A fallback credential store is one that is queried if no credentials can be
2059
found via authentication.conf.
2062
def get_credential_store(self, encoding=None):
2063
cs = self.get(encoding)
2068
def is_fallback(self, name):
2069
"""Check if the named credentials store should be used as fallback."""
2070
return self.get_info(name)
2072
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2073
path=None, realm=None):
2074
"""Request credentials from all fallback credentials stores.
2076
The first credentials store that can provide credentials wins.
2079
for name in self.keys():
2080
if not self.is_fallback(name):
2082
cs = self.get_credential_store(name)
2083
credentials = cs.get_credentials(scheme, host, port, user,
2085
if credentials is not None:
2086
# We found some credentials
2090
def register(self, key, obj, help=None, override_existing=False,
2092
"""Register a new object to a name.
2094
:param key: This is the key to use to request the object later.
2095
:param obj: The object to register.
2096
:param help: Help text for this entry. This may be a string or
2097
a callable. If it is a callable, it should take two
2098
parameters (registry, key): this registry and the key that
2099
the help was registered under.
2100
:param override_existing: Raise KeyErorr if False and something has
2101
already been registered for that key. If True, ignore if there
2102
is an existing key (always register the new value).
2103
:param fallback: Whether this credential store should be
2106
return super(CredentialStoreRegistry,
2107
self).register(key, obj, help, info=fallback,
2108
override_existing=override_existing)
2110
def register_lazy(self, key, module_name, member_name,
2111
help=None, override_existing=False,
2113
"""Register a new credential store to be loaded on request.
2115
:param module_name: The python path to the module. Such as 'os.path'.
2116
:param member_name: The member of the module to return. If empty or
2117
None, get() will return the module itself.
2118
:param help: Help text for this entry. This may be a string or
2120
:param override_existing: If True, replace the existing object
2121
with the new one. If False, if there is already something
2122
registered with the same key, raise a KeyError
2123
:param fallback: Whether this credential store should be
2126
return super(CredentialStoreRegistry, self).register_lazy(
2127
key, module_name, member_name, help,
2128
info=fallback, override_existing=override_existing)
2131
credential_store_registry = CredentialStoreRegistry()
2134
class CredentialStore(object):
2135
"""An abstract class to implement storage for credentials"""
2137
def decode_password(self, credentials):
2138
"""Returns a clear text password for the provided credentials."""
2139
raise NotImplementedError(self.decode_password)
2141
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2143
"""Return the matching credentials from this credential store.
2145
This method is only called on fallback credential stores.
2147
raise NotImplementedError(self.get_credentials)
2151
class PlainTextCredentialStore(CredentialStore):
2152
__doc__ = """Plain text credential store for the authentication.conf file"""
2154
def decode_password(self, credentials):
2155
"""See CredentialStore.decode_password."""
2156
return credentials['password']
2159
credential_store_registry.register('plain', PlainTextCredentialStore,
2160
help=PlainTextCredentialStore.__doc__)
2161
credential_store_registry.default_key = 'plain'
2164
class BzrDirConfig(object):
2166
def __init__(self, bzrdir):
2167
self._bzrdir = bzrdir
2168
self._config = bzrdir._get_config()
2170
def set_default_stack_on(self, value):
2171
"""Set the default stacking location.
2173
It may be set to a location, or None.
2175
This policy affects all branches contained by this bzrdir, except for
2176
those under repositories.
2178
if self._config is None:
2179
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2181
self._config.set_option('', 'default_stack_on')
2183
self._config.set_option(value, 'default_stack_on')
2185
def get_default_stack_on(self):
2186
"""Return the default stacking location.
2188
This will either be a location, or None.
2190
This policy affects all branches contained by this bzrdir, except for
2191
those under repositories.
2193
if self._config is None:
2195
value = self._config.get_option('default_stack_on')
2201
class TransportConfig(object):
2202
"""A Config that reads/writes a config file on a Transport.
2204
It is a low-level object that considers config data to be name/value pairs
2205
that may be associated with a section. Assigning meaning to these values
2206
is done at higher levels like TreeConfig.
2209
def __init__(self, transport, filename):
2210
self._transport = transport
2211
self._filename = filename
2213
def get_option(self, name, section=None, default=None):
2214
"""Return the value associated with a named option.
2216
:param name: The name of the value
2217
:param section: The section the option is in (if any)
2218
:param default: The value to return if the value is not set
2219
:return: The value or default value
2221
configobj = self._get_configobj()
2223
section_obj = configobj
2226
section_obj = configobj[section]
2229
value = section_obj.get(name, default)
2230
for hook in OldConfigHooks['get']:
2231
hook(self, name, value)
2234
def set_option(self, value, name, section=None):
2235
"""Set the value associated with a named option.
2237
:param value: The value to set
2238
:param name: The name of the value to set
2239
:param section: The section the option is in (if any)
2241
configobj = self._get_configobj()
2243
configobj[name] = value
2245
configobj.setdefault(section, {})[name] = value
2246
for hook in OldConfigHooks['set']:
2247
hook(self, name, value)
2248
self._set_configobj(configobj)
2250
def remove_option(self, option_name, section_name=None):
2251
configobj = self._get_configobj()
2252
if section_name is None:
2253
del configobj[option_name]
2255
del configobj[section_name][option_name]
2256
for hook in OldConfigHooks['remove']:
2257
hook(self, option_name)
2258
self._set_configobj(configobj)
2260
def _get_config_file(self):
2262
f = StringIO(self._transport.get_bytes(self._filename))
2263
for hook in OldConfigHooks['load']:
2266
except errors.NoSuchFile:
2268
except errors.PermissionDenied, e:
2269
trace.warning("Permission denied while trying to open "
2270
"configuration file %s.", urlutils.unescape_for_display(
2271
urlutils.join(self._transport.base, self._filename), "utf-8"))
2274
def _external_url(self):
2275
return urlutils.join(self._transport.external_url(), self._filename)
2277
def _get_configobj(self):
2278
f = self._get_config_file()
2281
conf = ConfigObj(f, encoding='utf-8')
2282
except configobj.ConfigObjError, e:
2283
raise errors.ParseConfigError(e.errors, self._external_url())
2284
except UnicodeDecodeError:
2285
raise errors.ConfigContentError(self._external_url())
2290
def _set_configobj(self, configobj):
2291
out_file = StringIO()
2292
configobj.write(out_file)
2294
self._transport.put_file(self._filename, out_file)
2295
for hook in OldConfigHooks['save']:
2299
class Option(object):
2300
"""An option definition.
2302
The option *values* are stored in config files and found in sections.
2304
Here we define various properties about the option itself, its default
2305
value, how to convert it from stores, what to do when invalid values are
2306
encoutered, in which config files it can be stored.
2309
def __init__(self, name, override_from_env=None,
2310
default=None, default_from_env=None,
2311
help=None, from_unicode=None, invalid=None, unquote=True):
2312
"""Build an option definition.
2314
:param name: the name used to refer to the option.
2316
:param override_from_env: A list of environment variables which can
2317
provide override any configuration setting.
2319
:param default: the default value to use when none exist in the config
2320
stores. This is either a string that ``from_unicode`` will convert
2321
into the proper type, a callable returning a unicode string so that
2322
``from_unicode`` can be used on the return value, or a python
2323
object that can be stringified (so only the empty list is supported
2326
:param default_from_env: A list of environment variables which can
2327
provide a default value. 'default' will be used only if none of the
2328
variables specified here are set in the environment.
2330
:param help: a doc string to explain the option to the user.
2332
:param from_unicode: a callable to convert the unicode string
2333
representing the option value in a store. This is not called for
2336
:param invalid: the action to be taken when an invalid value is
2337
encountered in a store. This is called only when from_unicode is
2338
invoked to convert a string and returns None or raise ValueError or
2339
TypeError. Accepted values are: None (ignore invalid values),
2340
'warning' (emit a warning), 'error' (emit an error message and
2343
:param unquote: should the unicode value be unquoted before conversion.
2344
This should be used only when the store providing the values cannot
2345
safely unquote them (see http://pad.lv/906897). It is provided so
2346
daughter classes can handle the quoting themselves.
2348
if override_from_env is None:
2349
override_from_env = []
2350
if default_from_env is None:
2351
default_from_env = []
2353
self.override_from_env = override_from_env
2354
# Convert the default value to a unicode string so all values are
2355
# strings internally before conversion (via from_unicode) is attempted.
2358
elif isinstance(default, list):
2359
# Only the empty list is supported
2361
raise AssertionError(
2362
'Only empty lists are supported as default values')
2364
elif isinstance(default, (str, unicode, bool, int, float)):
2365
# Rely on python to convert strings, booleans and integers
2366
self.default = u'%s' % (default,)
2367
elif callable(default):
2368
self.default = default
2370
# other python objects are not expected
2371
raise AssertionError('%r is not supported as a default value'
2373
self.default_from_env = default_from_env
2375
self.from_unicode = from_unicode
2376
self.unquote = unquote
2377
if invalid and invalid not in ('warning', 'error'):
2378
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2379
self.invalid = invalid
2385
def convert_from_unicode(self, store, unicode_value):
2386
if self.unquote and store is not None and unicode_value is not None:
2387
unicode_value = store.unquote(unicode_value)
2388
if self.from_unicode is None or unicode_value is None:
2389
# Don't convert or nothing to convert
2390
return unicode_value
2392
converted = self.from_unicode(unicode_value)
2393
except (ValueError, TypeError):
2394
# Invalid values are ignored
2396
if converted is None and self.invalid is not None:
2397
# The conversion failed
2398
if self.invalid == 'warning':
2399
trace.warning('Value "%s" is not valid for "%s"',
2400
unicode_value, self.name)
2401
elif self.invalid == 'error':
2402
raise errors.ConfigOptionValueError(self.name, unicode_value)
2405
def get_override(self):
2407
for var in self.override_from_env:
2409
# If the env variable is defined, its value takes precedence
2410
value = os.environ[var].decode(osutils.get_user_encoding())
2416
def get_default(self):
2418
for var in self.default_from_env:
2420
# If the env variable is defined, its value is the default one
2421
value = os.environ[var].decode(osutils.get_user_encoding())
2426
# Otherwise, fallback to the value defined at registration
2427
if callable(self.default):
2428
value = self.default()
2429
if not isinstance(value, unicode):
2430
raise AssertionError(
2431
'Callable default values should be unicode')
2433
value = self.default
2436
def get_help_text(self, additional_see_also=None, plain=True):
2438
from bzrlib import help_topics
2439
result += help_topics._format_see_also(additional_see_also)
2441
result = help_topics.help_as_plain_text(result)
2445
# Predefined converters to get proper values from store
2447
def bool_from_store(unicode_str):
2448
return ui.bool_from_string(unicode_str)
2451
def int_from_store(unicode_str):
2452
return int(unicode_str)
2455
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2457
def int_SI_from_store(unicode_str):
2458
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2460
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2461
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2464
:return Integer, expanded to its base-10 value if a proper SI unit is
2465
found, None otherwise.
2467
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2468
p = re.compile(regexp, re.IGNORECASE)
2469
m = p.match(unicode_str)
2472
val, _, unit = m.groups()
2476
coeff = _unit_suffixes[unit.upper()]
2478
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2483
def float_from_store(unicode_str):
2484
return float(unicode_str)
2487
# Use a an empty dict to initialize an empty configobj avoiding all
2488
# parsing and encoding checks
2489
_list_converter_config = configobj.ConfigObj(
2490
{}, encoding='utf-8', list_values=True, interpolation=False)
2493
class ListOption(Option):
2495
def __init__(self, name, default=None, default_from_env=None,
2496
help=None, invalid=None):
2497
"""A list Option definition.
2499
This overrides the base class so the conversion from a unicode string
2500
can take quoting into account.
2502
super(ListOption, self).__init__(
2503
name, default=default, default_from_env=default_from_env,
2504
from_unicode=self.from_unicode, help=help,
2505
invalid=invalid, unquote=False)
2507
def from_unicode(self, unicode_str):
2508
if not isinstance(unicode_str, basestring):
2510
# Now inject our string directly as unicode. All callers got their
2511
# value from configobj, so values that need to be quoted are already
2513
_list_converter_config.reset()
2514
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2515
maybe_list = _list_converter_config['list']
2516
if isinstance(maybe_list, basestring):
2518
# A single value, most probably the user forgot (or didn't care
2519
# to add) the final ','
2522
# The empty string, convert to empty list
2525
# We rely on ConfigObj providing us with a list already
2530
class RegistryOption(Option):
2531
"""Option for a choice from a registry."""
2533
def __init__(self, name, registry, default_from_env=None,
2534
help=None, invalid=None):
2535
"""A registry based Option definition.
2537
This overrides the base class so the conversion from a unicode string
2538
can take quoting into account.
2540
super(RegistryOption, self).__init__(
2541
name, default=lambda: unicode(registry.default_key),
2542
default_from_env=default_from_env,
2543
from_unicode=self.from_unicode, help=help,
2544
invalid=invalid, unquote=False)
2545
self.registry = registry
2547
def from_unicode(self, unicode_str):
2548
if not isinstance(unicode_str, basestring):
2551
return self.registry.get(unicode_str)
2554
"Invalid value %s for %s."
2555
"See help for a list of possible values." % (unicode_str,
2560
ret = [self._help, "\n\nThe following values are supported:\n"]
2561
for key in self.registry.keys():
2562
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2566
class OptionRegistry(registry.Registry):
2567
"""Register config options by their name.
2569
This overrides ``registry.Registry`` to simplify registration by acquiring
2570
some information from the option object itself.
2573
def register(self, option):
2574
"""Register a new option to its name.
2576
:param option: The option to register. Its name is used as the key.
2578
super(OptionRegistry, self).register(option.name, option,
2581
def register_lazy(self, key, module_name, member_name):
2582
"""Register a new option to be loaded on request.
2584
:param key: the key to request the option later. Since the registration
2585
is lazy, it should be provided and match the option name.
2587
:param module_name: the python path to the module. Such as 'os.path'.
2589
:param member_name: the member of the module to return. If empty or
2590
None, get() will return the module itself.
2592
super(OptionRegistry, self).register_lazy(key,
2593
module_name, member_name)
2595
def get_help(self, key=None):
2596
"""Get the help text associated with the given key"""
2597
option = self.get(key)
2598
the_help = option.help
2599
if callable(the_help):
2600
return the_help(self, key)
2604
option_registry = OptionRegistry()
2607
# Registered options in lexicographical order
2609
option_registry.register(
2610
Option('append_revisions_only',
2611
default=None, from_unicode=bool_from_store, invalid='warning',
2613
Whether to only append revisions to the mainline.
2615
If this is set to true, then it is not possible to change the
2616
existing mainline of the branch.
2618
option_registry.register(
2619
ListOption('acceptable_keys',
2622
List of GPG key patterns which are acceptable for verification.
2624
option_registry.register(
2625
Option('add.maximum_file_size',
2626
default=u'20MB', from_unicode=int_SI_from_store,
2628
Size above which files should be added manually.
2630
Files below this size are added automatically when using ``bzr add`` without
2633
A negative value means disable the size check.
2635
option_registry.register(
2637
default=None, from_unicode=bool_from_store,
2639
Is the branch bound to ``bound_location``.
2641
If set to "True", the branch should act as a checkout, and push each commit to
2642
the bound_location. This option is normally set by ``bind``/``unbind``.
2644
See also: bound_location.
2646
option_registry.register(
2647
Option('bound_location',
2650
The location that commits should go to when acting as a checkout.
2652
This option is normally set by ``bind``.
2656
option_registry.register(
2657
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2659
Whether revisions associated with tags should be fetched.
2661
option_registry.register_lazy(
2662
'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
2663
option_registry.register(
2664
Option('bzr.workingtree.worth_saving_limit', default=10,
2665
from_unicode=int_from_store, invalid='warning',
2667
How many changes before saving the dirstate.
2669
-1 means that we will never rewrite the dirstate file for only
2670
stat-cache changes. Regardless of this setting, we will always rewrite
2671
the dirstate file if a file is added/removed/renamed/etc. This flag only
2672
affects the behavior of updating the dirstate file after we notice that
2673
a file has been touched.
2675
option_registry.register(
2676
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2677
from_unicode=signature_policy_from_unicode,
2679
GPG checking policy.
2681
Possible values: require, ignore, check-available (default)
2683
this option will control whether bzr will require good gpg
2684
signatures, ignore them, or check them if they are
2687
option_registry.register(
2688
Option('child_submit_format',
2689
help='''The preferred format of submissions to this branch.'''))
2690
option_registry.register(
2691
Option('child_submit_to',
2692
help='''Where submissions to this branch are mailed to.'''))
2693
option_registry.register(
2694
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2695
from_unicode=signing_policy_from_unicode,
2699
Possible values: always, never, when-required (default)
2701
This option controls whether bzr will always create
2702
gpg signatures or not on commits.
2704
option_registry.register(
2705
Option('dirstate.fdatasync', default=True,
2706
from_unicode=bool_from_store,
2708
Flush dirstate changes onto physical disk?
2710
If true (default), working tree metadata changes are flushed through the
2711
OS buffers to physical disk. This is somewhat slower, but means data
2712
should not be lost if the machine crashes. See also repository.fdatasync.
2714
option_registry.register(
2715
ListOption('debug_flags', default=[],
2716
help='Debug flags to activate.'))
2717
option_registry.register(
2718
Option('default_format', default='2a',
2719
help='Format used when creating branches.'))
2720
option_registry.register(
2721
Option('dpush_strict', default=None,
2722
from_unicode=bool_from_store,
2724
The default value for ``dpush --strict``.
2726
If present, defines the ``--strict`` option default value for checking
2727
uncommitted changes before pushing into a different VCS without any
2728
custom bzr metadata.
2730
option_registry.register(
2732
help='The command called to launch an editor to enter a message.'))
2733
option_registry.register(
2734
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2735
help='The users identity'))
2736
option_registry.register(
2737
Option('gpg_signing_command',
2740
Program to use use for creating signatures.
2742
This should support at least the -u and --clearsign options.
2744
option_registry.register(
2745
Option('gpg_signing_key',
2748
GPG key to use for signing.
2750
This defaults to the first key associated with the users email.
2752
option_registry.register(
2753
Option('ignore_missing_extensions', default=False,
2754
from_unicode=bool_from_store,
2756
Control the missing extensions warning display.
2758
The warning will not be emitted if set to True.
2760
option_registry.register(
2762
help='Language to translate messages into.'))
2763
option_registry.register(
2764
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2766
Steal locks that appears to be dead.
2768
If set to True, bzr will check if a lock is supposed to be held by an
2769
active process from the same user on the same machine. If the user and
2770
machine match, but no process with the given PID is active, then bzr
2771
will automatically break the stale lock, and create a new lock for
2773
Otherwise, bzr will prompt as normal to break the lock.
2775
option_registry.register(
2776
Option('log_format', default='long',
2778
Log format to use when displaying revisions.
2780
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2781
may be provided by plugins.
2783
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2785
option_registry.register(
2786
Option('output_encoding',
2787
help= 'Unicode encoding for output'
2788
' (terminal encoding if not specified).'))
2789
option_registry.register(
2790
Option('parent_location',
2793
The location of the default branch for pull or merge.
2795
This option is normally set when creating a branch, the first ``pull`` or by
2796
``pull --remember``.
2798
option_registry.register(
2799
Option('post_commit', default=None,
2801
Post commit functions.
2803
An ordered list of python functions to call, separated by spaces.
2805
Each function takes branch, rev_id as parameters.
2807
option_registry.register(
2808
Option('public_branch',
2811
A publically-accessible version of this branch.
2813
This implies that the branch setting this option is not publically-accessible.
2814
Used and set by ``bzr send``.
2816
option_registry.register(
2817
Option('push_location',
2820
The location of the default branch for push.
2822
This option is normally set by the first ``push`` or ``push --remember``.
2824
option_registry.register(
2825
Option('push_strict', default=None,
2826
from_unicode=bool_from_store,
2828
The default value for ``push --strict``.
2830
If present, defines the ``--strict`` option default value for checking
2831
uncommitted changes before sending a merge directive.
2833
option_registry.register(
2834
Option('repository.fdatasync', default=True,
2835
from_unicode=bool_from_store,
2837
Flush repository changes onto physical disk?
2839
If true (default), repository changes are flushed through the OS buffers
2840
to physical disk. This is somewhat slower, but means data should not be
2841
lost if the machine crashes. See also dirstate.fdatasync.
2843
option_registry.register_lazy('smtp_server',
2844
'bzrlib.smtp_connection', 'smtp_server')
2845
option_registry.register_lazy('smtp_password',
2846
'bzrlib.smtp_connection', 'smtp_password')
2847
option_registry.register_lazy('smtp_username',
2848
'bzrlib.smtp_connection', 'smtp_username')
2849
option_registry.register(
2850
Option('selftest.timeout',
2852
from_unicode=int_from_store,
2853
help='Abort selftest if one test takes longer than this many seconds',
2856
option_registry.register(
2857
Option('send_strict', default=None,
2858
from_unicode=bool_from_store,
2860
The default value for ``send --strict``.
2862
If present, defines the ``--strict`` option default value for checking
2863
uncommitted changes before sending a bundle.
2866
option_registry.register(
2867
Option('serve.client_timeout',
2868
default=300.0, from_unicode=float_from_store,
2869
help="If we wait for a new request from a client for more than"
2870
" X seconds, consider the client idle, and hangup."))
2871
option_registry.register(
2872
Option('stacked_on_location',
2874
help="""The location where this branch is stacked on."""))
2875
option_registry.register(
2876
Option('submit_branch',
2879
The branch you intend to submit your current work to.
2881
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2882
by the ``submit:`` revision spec.
2884
option_registry.register(
2886
help='''Where submissions from this branch are mailed to.'''))
2887
option_registry.register(
2888
ListOption('suppress_warnings',
2890
help="List of warning classes to suppress."))
2891
option_registry.register(
2892
Option('validate_signatures_in_log', default=False,
2893
from_unicode=bool_from_store, invalid='warning',
2894
help='''Whether to validate signatures in bzr log.'''))
2895
option_registry.register_lazy('ssl.ca_certs',
2896
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2898
option_registry.register_lazy('ssl.cert_reqs',
2899
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2903
class Section(object):
2904
"""A section defines a dict of option name => value.
2906
This is merely a read-only dict which can add some knowledge about the
2907
options. It is *not* a python dict object though and doesn't try to mimic
2911
def __init__(self, section_id, options):
2912
self.id = section_id
2913
# We re-use the dict-like object received
2914
self.options = options
2916
def get(self, name, default=None, expand=True):
2917
return self.options.get(name, default)
2919
def iter_option_names(self):
2920
for k in self.options.iterkeys():
2924
# Mostly for debugging use
2925
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2928
_NewlyCreatedOption = object()
2929
"""Was the option created during the MutableSection lifetime"""
2930
_DeletedOption = object()
2931
"""Was the option deleted during the MutableSection lifetime"""
2934
class MutableSection(Section):
2935
"""A section allowing changes and keeping track of the original values."""
2937
def __init__(self, section_id, options):
2938
super(MutableSection, self).__init__(section_id, options)
2939
self.reset_changes()
2941
def set(self, name, value):
2942
if name not in self.options:
2943
# This is a new option
2944
self.orig[name] = _NewlyCreatedOption
2945
elif name not in self.orig:
2946
self.orig[name] = self.get(name, None)
2947
self.options[name] = value
2949
def remove(self, name):
2950
if name not in self.orig:
2951
self.orig[name] = self.get(name, None)
2952
del self.options[name]
2954
def reset_changes(self):
2957
def apply_changes(self, dirty, store):
2958
"""Apply option value changes.
2960
``self`` has been reloaded from the persistent storage. ``dirty``
2961
contains the changes made since the previous loading.
2963
:param dirty: the mutable section containing the changes.
2965
:param store: the store containing the section
2967
for k, expected in dirty.orig.iteritems():
2968
actual = dirty.get(k, _DeletedOption)
2969
reloaded = self.get(k, _NewlyCreatedOption)
2970
if actual is _DeletedOption:
2971
if k in self.options:
2975
# Report concurrent updates in an ad-hoc way. This should only
2976
# occurs when different processes try to update the same option
2977
# which is not supported (as in: the config framework is not meant
2978
# to be used a sharing mechanism).
2979
if expected != reloaded:
2980
if actual is _DeletedOption:
2981
actual = '<DELETED>'
2982
if reloaded is _NewlyCreatedOption:
2983
reloaded = '<CREATED>'
2984
if expected is _NewlyCreatedOption:
2985
expected = '<CREATED>'
2986
# Someone changed the value since we get it from the persistent
2988
trace.warning(gettext(
2989
"Option {0} in section {1} of {2} was changed"
2990
" from {3} to {4}. The {5} value will be saved.".format(
2991
k, self.id, store.external_url(), expected,
2993
# No need to keep track of these changes
2994
self.reset_changes()
2997
class Store(object):
2998
"""Abstract interface to persistent storage for configuration options."""
3000
readonly_section_class = Section
3001
mutable_section_class = MutableSection
3004
# Which sections need to be saved
3005
self.dirty_sections = []
3007
def is_loaded(self):
3008
"""Returns True if the Store has been loaded.
3010
This is used to implement lazy loading and ensure the persistent
3011
storage is queried only when needed.
3013
raise NotImplementedError(self.is_loaded)
3016
"""Loads the Store from persistent storage."""
3017
raise NotImplementedError(self.load)
3019
def _load_from_string(self, bytes):
3020
"""Create a store from a string in configobj syntax.
3022
:param bytes: A string representing the file content.
3024
raise NotImplementedError(self._load_from_string)
3027
"""Unloads the Store.
3029
This should make is_loaded() return False. This is used when the caller
3030
knows that the persistent storage has changed or may have change since
3033
raise NotImplementedError(self.unload)
3035
def quote(self, value):
3036
"""Quote a configuration option value for storing purposes.
3038
This allows Stacks to present values as they will be stored.
3042
def unquote(self, value):
3043
"""Unquote a configuration option value into unicode.
3045
The received value is quoted as stored.
3050
"""Saves the Store to persistent storage."""
3051
raise NotImplementedError(self.save)
3053
def _need_saving(self):
3054
for s in self.dirty_sections:
3056
# At least one dirty section contains a modification
3060
def apply_changes(self, dirty_sections):
3061
"""Apply changes from dirty sections while checking for coherency.
3063
The Store content is discarded and reloaded from persistent storage to
3064
acquire up-to-date values.
3066
Dirty sections are MutableSection which kept track of the value they
3067
are expected to update.
3069
# We need an up-to-date version from the persistent storage, unload the
3070
# store. The reload will occur when needed (triggered by the first
3071
# get_mutable_section() call below.
3073
# Apply the changes from the preserved dirty sections
3074
for dirty in dirty_sections:
3075
clean = self.get_mutable_section(dirty.id)
3076
clean.apply_changes(dirty, self)
3077
# Everything is clean now
3078
self.dirty_sections = []
3080
def save_changes(self):
3081
"""Saves the Store to persistent storage if changes occurred.
3083
Apply the changes recorded in the mutable sections to a store content
3084
refreshed from persistent storage.
3086
raise NotImplementedError(self.save_changes)
3088
def external_url(self):
3089
raise NotImplementedError(self.external_url)
3091
def get_sections(self):
3092
"""Returns an ordered iterable of existing sections.
3094
:returns: An iterable of (store, section).
3096
raise NotImplementedError(self.get_sections)
3098
def get_mutable_section(self, section_id=None):
3099
"""Returns the specified mutable section.
3101
:param section_id: The section identifier
3103
raise NotImplementedError(self.get_mutable_section)
3106
# Mostly for debugging use
3107
return "<config.%s(%s)>" % (self.__class__.__name__,
3108
self.external_url())
3111
class CommandLineStore(Store):
3112
"A store to carry command line overrides for the config options."""
3114
def __init__(self, opts=None):
3115
super(CommandLineStore, self).__init__()
3122
# The dict should be cleared but not replaced so it can be shared.
3123
self.options.clear()
3125
def _from_cmdline(self, overrides):
3126
# Reset before accepting new definitions
3128
for over in overrides:
3130
name, value = over.split('=', 1)
3132
raise errors.BzrCommandError(
3133
gettext("Invalid '%s', should be of the form 'name=value'")
3135
self.options[name] = value
3137
def external_url(self):
3138
# Not an url but it makes debugging easier and is never needed
3142
def get_sections(self):
3143
yield self, self.readonly_section_class(None, self.options)
3146
class IniFileStore(Store):
3147
"""A config Store using ConfigObj for storage.
3149
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3150
serialize/deserialize the config file.
3154
"""A config Store using ConfigObj for storage.
3156
super(IniFileStore, self).__init__()
3157
self._config_obj = None
3159
def is_loaded(self):
3160
return self._config_obj != None
3163
self._config_obj = None
3164
self.dirty_sections = []
3166
def _load_content(self):
3167
"""Load the config file bytes.
3169
This should be provided by subclasses
3171
:return: Byte string
3173
raise NotImplementedError(self._load_content)
3175
def _save_content(self, content):
3176
"""Save the config file bytes.
3178
This should be provided by subclasses
3180
:param content: Config file bytes to write
3182
raise NotImplementedError(self._save_content)
3185
"""Load the store from the associated file."""
3186
if self.is_loaded():
3188
content = self._load_content()
3189
self._load_from_string(content)
3190
for hook in ConfigHooks['load']:
3193
def _load_from_string(self, bytes):
3194
"""Create a config store from a string.
3196
:param bytes: A string representing the file content.
3198
if self.is_loaded():
3199
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3200
co_input = StringIO(bytes)
3202
# The config files are always stored utf8-encoded
3203
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3205
except configobj.ConfigObjError, e:
3206
self._config_obj = None
3207
raise errors.ParseConfigError(e.errors, self.external_url())
3208
except UnicodeDecodeError:
3209
raise errors.ConfigContentError(self.external_url())
3211
def save_changes(self):
3212
if not self.is_loaded():
3215
if not self._need_saving():
3217
# Preserve the current version
3218
current = self._config_obj
3219
dirty_sections = list(self.dirty_sections)
3220
self.apply_changes(dirty_sections)
3221
# Save to the persistent storage
3225
if not self.is_loaded():
3229
self._config_obj.write(out)
3230
self._save_content(out.getvalue())
3231
for hook in ConfigHooks['save']:
3234
def get_sections(self):
3235
"""Get the configobj section in the file order.
3237
:returns: An iterable of (store, section).
3239
# We need a loaded store
3242
except (errors.NoSuchFile, errors.PermissionDenied):
3243
# If the file can't be read, there is no sections
3245
cobj = self._config_obj
3247
yield self, self.readonly_section_class(None, cobj)
3248
for section_name in cobj.sections:
3250
self.readonly_section_class(section_name,
3251
cobj[section_name]))
3253
def get_mutable_section(self, section_id=None):
3254
# We need a loaded store
3257
except errors.NoSuchFile:
3258
# The file doesn't exist, let's pretend it was empty
3259
self._load_from_string('')
3260
if section_id is None:
3261
section = self._config_obj
3263
section = self._config_obj.setdefault(section_id, {})
3264
mutable_section = self.mutable_section_class(section_id, section)
3265
# All mutable sections can become dirty
3266
self.dirty_sections.append(mutable_section)
3267
return mutable_section
3269
def quote(self, value):
3271
# configobj conflates automagical list values and quoting
3272
self._config_obj.list_values = True
3273
return self._config_obj._quote(value)
3275
self._config_obj.list_values = False
3277
def unquote(self, value):
3278
if value and isinstance(value, basestring):
3279
# _unquote doesn't handle None nor empty strings nor anything that
3280
# is not a string, really.
3281
value = self._config_obj._unquote(value)
3284
def external_url(self):
3285
# Since an IniFileStore can be used without a file (at least in tests),
3286
# it's better to provide something than raising a NotImplementedError.
3287
# All daughter classes are supposed to provide an implementation
3289
return 'In-Process Store, no URL'
3291
class TransportIniFileStore(IniFileStore):
3292
"""IniFileStore that loads files from a transport.
3294
:ivar transport: The transport object where the config file is located.
3296
:ivar file_name: The config file basename in the transport directory.
3299
def __init__(self, transport, file_name):
3300
"""A Store using a ini file on a Transport
3302
:param transport: The transport object where the config file is located.
3303
:param file_name: The config file basename in the transport directory.
3305
super(TransportIniFileStore, self).__init__()
3306
self.transport = transport
3307
self.file_name = file_name
3309
def _load_content(self):
3311
return self.transport.get_bytes(self.file_name)
3312
except errors.PermissionDenied:
3313
trace.warning("Permission denied while trying to load "
3314
"configuration store %s.", self.external_url())
3317
def _save_content(self, content):
3318
self.transport.put_bytes(self.file_name, content)
3320
def external_url(self):
3321
# FIXME: external_url should really accepts an optional relpath
3322
# parameter (bug #750169) :-/ -- vila 2011-04-04
3323
# The following will do in the interim but maybe we don't want to
3324
# expose a path here but rather a config ID and its associated
3325
# object </hand wawe>.
3326
return urlutils.join(self.transport.external_url(), self.file_name)
3329
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3330
# unlockable stores for use with objects that can already ensure the locking
3331
# (think branches). If different stores (not based on ConfigObj) are created,
3332
# they may face the same issue.
3335
class LockableIniFileStore(TransportIniFileStore):
3336
"""A ConfigObjStore using locks on save to ensure store integrity."""
3338
def __init__(self, transport, file_name, lock_dir_name=None):
3339
"""A config Store using ConfigObj for storage.
3341
:param transport: The transport object where the config file is located.
3343
:param file_name: The config file basename in the transport directory.
3345
if lock_dir_name is None:
3346
lock_dir_name = 'lock'
3347
self.lock_dir_name = lock_dir_name
3348
super(LockableIniFileStore, self).__init__(transport, file_name)
3349
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3351
def lock_write(self, token=None):
3352
"""Takes a write lock in the directory containing the config file.
3354
If the directory doesn't exist it is created.
3356
# FIXME: This doesn't check the ownership of the created directories as
3357
# ensure_config_dir_exists does. It should if the transport is local
3358
# -- vila 2011-04-06
3359
self.transport.create_prefix()
3360
return self._lock.lock_write(token)
3365
def break_lock(self):
3366
self._lock.break_lock()
3370
# We need to be able to override the undecorated implementation
3371
self.save_without_locking()
3373
def save_without_locking(self):
3374
super(LockableIniFileStore, self).save()
3377
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3378
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3379
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3381
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3382
# functions or a registry will make it easier and clearer for tests, focusing
3383
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3384
# on a poolie's remark)
3385
class GlobalStore(LockableIniFileStore):
3387
def __init__(self, possible_transports=None):
3388
t = transport.get_transport_from_path(
3389
config_dir(), possible_transports=possible_transports)
3390
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3394
class LocationStore(LockableIniFileStore):
3396
def __init__(self, possible_transports=None):
3397
t = transport.get_transport_from_path(
3398
config_dir(), possible_transports=possible_transports)
3399
super(LocationStore, self).__init__(t, 'locations.conf')
3400
self.id = 'locations'
3403
class BranchStore(TransportIniFileStore):
3405
def __init__(self, branch):
3406
super(BranchStore, self).__init__(branch.control_transport,
3408
self.branch = branch
3411
def lock_write(self, token=None):
3412
return self.branch.lock_write(token)
3415
return self.branch.unlock()
3419
# We need to be able to override the undecorated implementation
3420
self.save_without_locking()
3422
def save_without_locking(self):
3423
super(BranchStore, self).save()
3426
class ControlStore(LockableIniFileStore):
3428
def __init__(self, bzrdir):
3429
super(ControlStore, self).__init__(bzrdir.transport,
3431
lock_dir_name='branch_lock')
3435
class SectionMatcher(object):
3436
"""Select sections into a given Store.
3438
This is intended to be used to postpone getting an iterable of sections
3442
def __init__(self, store):
3445
def get_sections(self):
3446
# This is where we require loading the store so we can see all defined
3448
sections = self.store.get_sections()
3449
# Walk the revisions in the order provided
3450
for store, s in sections:
3454
def match(self, section):
3455
"""Does the proposed section match.
3457
:param section: A Section object.
3459
:returns: True if the section matches, False otherwise.
3461
raise NotImplementedError(self.match)
3464
class NameMatcher(SectionMatcher):
3466
def __init__(self, store, section_id):
3467
super(NameMatcher, self).__init__(store)
3468
self.section_id = section_id
3470
def match(self, section):
3471
return section.id == self.section_id
3474
class LocationSection(Section):
3476
def __init__(self, section, extra_path):
3477
super(LocationSection, self).__init__(section.id, section.options)
3478
self.extra_path = extra_path
3479
self.locals = {'relpath': extra_path,
3480
'basename': urlutils.basename(extra_path)}
3482
def get(self, name, default=None, expand=True):
3483
value = super(LocationSection, self).get(name, default)
3484
if value is not None and expand:
3485
policy_name = self.get(name + ':policy', None)
3486
policy = _policy_value.get(policy_name, POLICY_NONE)
3487
if policy == POLICY_APPENDPATH:
3488
value = urlutils.join(value, self.extra_path)
3489
# expand section local options right now (since POLICY_APPENDPATH
3490
# will never add options references, it's ok to expand after it).
3492
for is_ref, chunk in iter_option_refs(value):
3494
chunks.append(chunk)
3497
if ref in self.locals:
3498
chunks.append(self.locals[ref])
3500
chunks.append(chunk)
3501
value = ''.join(chunks)
3505
class StartingPathMatcher(SectionMatcher):
3506
"""Select sections for a given location respecting the Store order."""
3508
# FIXME: Both local paths and urls can be used for section names as well as
3509
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3510
# inherited the fuzziness from the previous ``LocationConfig``
3511
# implementation. We probably need to revisit which encoding is allowed for
3512
# both ``location`` and section names and how we normalize
3513
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3514
# related too. -- vila 2012-01-04
3516
def __init__(self, store, location):
3517
super(StartingPathMatcher, self).__init__(store)
3518
if location.startswith('file://'):
3519
location = urlutils.local_path_from_url(location)
3520
self.location = location
3522
def get_sections(self):
3523
"""Get all sections matching ``location`` in the store.
3525
The most generic sections are described first in the store, then more
3526
specific ones can be provided for reduced scopes.
3528
The returned section are therefore returned in the reversed order so
3529
the most specific ones can be found first.
3531
location_parts = self.location.rstrip('/').split('/')
3534
# Later sections are more specific, they should be returned first
3535
for _, section in reversed(list(store.get_sections())):
3536
if section.id is None:
3537
# The no-name section is always included if present
3538
yield store, LocationSection(section, self.location)
3540
section_path = section.id
3541
if section_path.startswith('file://'):
3542
# the location is already a local path or URL, convert the
3543
# section id to the same format
3544
section_path = urlutils.local_path_from_url(section_path)
3545
if (self.location.startswith(section_path)
3546
or fnmatch.fnmatch(self.location, section_path)):
3547
section_parts = section_path.rstrip('/').split('/')
3548
extra_path = '/'.join(location_parts[len(section_parts):])
3549
yield store, LocationSection(section, extra_path)
3552
class LocationMatcher(SectionMatcher):
3554
def __init__(self, store, location):
3555
super(LocationMatcher, self).__init__(store)
3556
if location.startswith('file://'):
3557
location = urlutils.local_path_from_url(location)
3558
self.location = location
3560
def _get_matching_sections(self):
3561
"""Get all sections matching ``location``."""
3562
# We slightly diverge from LocalConfig here by allowing the no-name
3563
# section as the most generic one and the lower priority.
3564
no_name_section = None
3566
# Filter out the no_name_section so _iter_for_location_by_parts can be
3567
# used (it assumes all sections have a name).
3568
for _, section in self.store.get_sections():
3569
if section.id is None:
3570
no_name_section = section
3572
all_sections.append(section)
3573
# Unfortunately _iter_for_location_by_parts deals with section names so
3574
# we have to resync.
3575
filtered_sections = _iter_for_location_by_parts(
3576
[s.id for s in all_sections], self.location)
3577
iter_all_sections = iter(all_sections)
3578
matching_sections = []
3579
if no_name_section is not None:
3580
matching_sections.append(
3581
(0, LocationSection(no_name_section, self.location)))
3582
for section_id, extra_path, length in filtered_sections:
3583
# a section id is unique for a given store so it's safe to take the
3584
# first matching section while iterating. Also, all filtered
3585
# sections are part of 'all_sections' and will always be found
3588
section = iter_all_sections.next()
3589
if section_id == section.id:
3590
matching_sections.append(
3591
(length, LocationSection(section, extra_path)))
3593
return matching_sections
3595
def get_sections(self):
3596
# Override the default implementation as we want to change the order
3597
matching_sections = self._get_matching_sections()
3598
# We want the longest (aka more specific) locations first
3599
sections = sorted(matching_sections,
3600
key=lambda (length, section): (length, section.id),
3602
# Sections mentioning 'ignore_parents' restrict the selection
3603
for _, section in sections:
3604
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3605
ignore = section.get('ignore_parents', None)
3606
if ignore is not None:
3607
ignore = ui.bool_from_string(ignore)
3610
# Finally, we have a valid section
3611
yield self.store, section
3614
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3615
"""Describes an expandable option reference.
3617
We want to match the most embedded reference first.
3619
I.e. for '{{foo}}' we will get '{foo}',
3620
for '{bar{baz}}' we will get '{baz}'
3623
def iter_option_refs(string):
3624
# Split isolate refs so every other chunk is a ref
3626
for chunk in _option_ref_re.split(string):
3631
class Stack(object):
3632
"""A stack of configurations where an option can be defined"""
3634
def __init__(self, sections_def, store=None, mutable_section_id=None):
3635
"""Creates a stack of sections with an optional store for changes.
3637
:param sections_def: A list of Section or callables that returns an
3638
iterable of Section. This defines the Sections for the Stack and
3639
can be called repeatedly if needed.
3641
:param store: The optional Store where modifications will be
3642
recorded. If none is specified, no modifications can be done.
3644
:param mutable_section_id: The id of the MutableSection where changes
3645
are recorded. This requires the ``store`` parameter to be
3648
self.sections_def = sections_def
3650
self.mutable_section_id = mutable_section_id
3652
def get(self, name, expand=None):
3653
"""Return the *first* option value found in the sections.
3655
This is where we guarantee that sections coming from Store are loaded
3656
lazily: the loading is delayed until we need to either check that an
3657
option exists or get its value, which in turn may require to discover
3658
in which sections it can be defined. Both of these (section and option
3659
existence) require loading the store (even partially).
3661
:param name: The queried option.
3663
:param expand: Whether options references should be expanded.
3665
:returns: The value of the option.
3667
# FIXME: No caching of options nor sections yet -- vila 20110503
3669
expand = _get_expand_default_value()
3671
found_store = None # Where the option value has been found
3672
# If the option is registered, it may provide additional info about
3675
opt = option_registry.get(name)
3680
def expand_and_convert(val):
3681
# This may need to be called in different contexts if the value is
3682
# None or ends up being None during expansion or conversion.
3685
if isinstance(val, basestring):
3686
val = self._expand_options_in_string(val)
3688
trace.warning('Cannot expand "%s":'
3689
' %s does not support option expansion'
3690
% (name, type(val)))
3692
val = found_store.unquote(val)
3694
val = opt.convert_from_unicode(found_store, val)
3697
# First of all, check if the environment can override the configuration
3699
if opt is not None and opt.override_from_env:
3700
value = opt.get_override()
3701
value = expand_and_convert(value)
3703
# Ensuring lazy loading is achieved by delaying section matching
3704
# (which implies querying the persistent storage) until it can't be
3705
# avoided anymore by using callables to describe (possibly empty)
3707
for sections in self.sections_def:
3708
for store, section in sections():
3709
value = section.get(name)
3710
if value is not None:
3713
if value is not None:
3715
value = expand_and_convert(value)
3716
if opt is not None and value is None:
3717
# If the option is registered, it may provide a default value
3718
value = opt.get_default()
3719
value = expand_and_convert(value)
3720
for hook in ConfigHooks['get']:
3721
hook(self, name, value)
3724
def expand_options(self, string, env=None):
3725
"""Expand option references in the string in the configuration context.
3727
:param string: The string containing option(s) to expand.
3729
:param env: An option dict defining additional configuration options or
3730
overriding existing ones.
3732
:returns: The expanded string.
3734
return self._expand_options_in_string(string, env)
3736
def _expand_options_in_string(self, string, env=None, _refs=None):
3737
"""Expand options in the string in the configuration context.
3739
:param string: The string to be expanded.
3741
:param env: An option dict defining additional configuration options or
3742
overriding existing ones.
3744
:param _refs: Private list (FIFO) containing the options being expanded
3747
:returns: The expanded string.
3750
# Not much to expand there
3753
# What references are currently resolved (to detect loops)
3756
# We need to iterate until no more refs appear ({{foo}} will need two
3757
# iterations for example).
3762
for is_ref, chunk in iter_option_refs(result):
3764
chunks.append(chunk)
3769
raise errors.OptionExpansionLoop(string, _refs)
3771
value = self._expand_option(name, env, _refs)
3773
raise errors.ExpandingUnknownOption(name, string)
3774
chunks.append(value)
3776
result = ''.join(chunks)
3779
def _expand_option(self, name, env, _refs):
3780
if env is not None and name in env:
3781
# Special case, values provided in env takes precedence over
3785
value = self.get(name, expand=False)
3786
value = self._expand_options_in_string(value, env, _refs)
3789
def _get_mutable_section(self):
3790
"""Get the MutableSection for the Stack.
3792
This is where we guarantee that the mutable section is lazily loaded:
3793
this means we won't load the corresponding store before setting a value
3794
or deleting an option. In practice the store will often be loaded but
3795
this helps catching some programming errors.
3798
section = store.get_mutable_section(self.mutable_section_id)
3799
return store, section
3801
def set(self, name, value):
3802
"""Set a new value for the option."""
3803
store, section = self._get_mutable_section()
3804
section.set(name, store.quote(value))
3805
for hook in ConfigHooks['set']:
3806
hook(self, name, value)
3808
def remove(self, name):
3809
"""Remove an existing option."""
3810
_, section = self._get_mutable_section()
3811
section.remove(name)
3812
for hook in ConfigHooks['remove']:
3816
# Mostly for debugging use
3817
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3819
def _get_overrides(self):
3820
# Hack around library_state.initialize never called
3821
if bzrlib.global_state is not None:
3822
return bzrlib.global_state.cmdline_overrides.get_sections()
3826
class MemoryStack(Stack):
3827
"""A configuration stack defined from a string.
3829
This is mainly intended for tests and requires no disk resources.
3832
def __init__(self, content=None):
3833
"""Create an in-memory stack from a given content.
3835
It uses a single store based on configobj and support reading and
3838
:param content: The initial content of the store. If None, the store is
3839
not loaded and ``_load_from_string`` can and should be used if
3842
store = IniFileStore()
3843
if content is not None:
3844
store._load_from_string(content)
3845
super(MemoryStack, self).__init__(
3846
[store.get_sections], store)
3849
class _CompatibleStack(Stack):
3850
"""Place holder for compatibility with previous design.
3852
This is intended to ease the transition from the Config-based design to the
3853
Stack-based design and should not be used nor relied upon by plugins.
3855
One assumption made here is that the daughter classes will all use Stores
3856
derived from LockableIniFileStore).
3858
It implements set() and remove () by re-loading the store before applying
3859
the modification and saving it.
3861
The long term plan being to implement a single write by store to save
3862
all modifications, this class should not be used in the interim.
3865
def set(self, name, value):
3868
super(_CompatibleStack, self).set(name, value)
3869
# Force a write to persistent storage
3872
def remove(self, name):
3875
super(_CompatibleStack, self).remove(name)
3876
# Force a write to persistent storage
3880
class GlobalStack(_CompatibleStack):
3881
"""Global options only stack.
3883
The following sections are queried:
3885
* command-line overrides,
3887
* the 'DEFAULT' section in bazaar.conf
3889
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3894
gstore = GlobalStore()
3895
super(GlobalStack, self).__init__(
3896
[self._get_overrides,
3897
NameMatcher(gstore, 'DEFAULT').get_sections],
3898
gstore, mutable_section_id='DEFAULT')
3901
class LocationStack(_CompatibleStack):
3902
"""Per-location options falling back to global options stack.
3905
The following sections are queried:
3907
* command-line overrides,
3909
* the sections matching ``location`` in ``locations.conf``, the order being
3910
defined by the number of path components in the section glob, higher
3911
numbers first (from most specific section to most generic).
3913
* the 'DEFAULT' section in bazaar.conf
3915
This stack will use the ``location`` section in locations.conf as its
3919
def __init__(self, location):
3920
"""Make a new stack for a location and global configuration.
3922
:param location: A URL prefix to """
3923
lstore = LocationStore()
3924
if location.startswith('file://'):
3925
location = urlutils.local_path_from_url(location)
3926
gstore = GlobalStore()
3927
super(LocationStack, self).__init__(
3928
[self._get_overrides,
3929
LocationMatcher(lstore, location).get_sections,
3930
NameMatcher(gstore, 'DEFAULT').get_sections],
3931
lstore, mutable_section_id=location)
3934
class BranchStack(_CompatibleStack):
3935
"""Per-location options falling back to branch then global options stack.
3937
The following sections are queried:
3939
* command-line overrides,
3941
* the sections matching ``location`` in ``locations.conf``, the order being
3942
defined by the number of path components in the section glob, higher
3943
numbers first (from most specific section to most generic),
3945
* the no-name section in branch.conf,
3947
* the ``DEFAULT`` section in ``bazaar.conf``.
3949
This stack will use the no-name section in ``branch.conf`` as its
3953
def __init__(self, branch):
3954
lstore = LocationStore()
3955
bstore = branch._get_config_store()
3956
gstore = GlobalStore()
3957
super(BranchStack, self).__init__(
3958
[self._get_overrides,
3959
LocationMatcher(lstore, branch.base).get_sections,
3960
NameMatcher(bstore, None).get_sections,
3961
NameMatcher(gstore, 'DEFAULT').get_sections],
3963
self.branch = branch
3966
class RemoteControlStack(_CompatibleStack):
3967
"""Remote control-only options stack."""
3969
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3970
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3971
# control.conf and is used only for stack options.
3973
def __init__(self, bzrdir):
3974
cstore = bzrdir._get_config_store()
3975
super(RemoteControlStack, self).__init__(
3976
[NameMatcher(cstore, None).get_sections],
3978
self.bzrdir = bzrdir
3981
class BranchOnlyStack(_CompatibleStack):
3982
"""Branch-only options stack."""
3984
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3985
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3986
# -- vila 2011-12-16
3988
def __init__(self, branch):
3989
bstore = branch._get_config_store()
3990
super(BranchOnlyStack, self).__init__(
3991
[NameMatcher(bstore, None).get_sections],
3993
self.branch = branch
3996
# Use a an empty dict to initialize an empty configobj avoiding all
3997
# parsing and encoding checks
3998
_quoting_config = configobj.ConfigObj(
3999
{}, encoding='utf-8', interpolation=False, list_values=True)
4001
class cmd_config(commands.Command):
4002
__doc__ = """Display, set or remove a configuration option.
4004
Display the active value for a given option.
4006
If --all is specified, NAME is interpreted as a regular expression and all
4007
matching options are displayed mentioning their scope. The active value
4008
that bzr will take into account is the first one displayed for each option.
4010
If no NAME is given, --all .* is implied.
4012
Setting a value is achieved by using name=value without spaces. The value
4013
is set in the most relevant scope and can be checked by displaying the
4017
takes_args = ['name?']
4021
# FIXME: This should be a registry option so that plugins can register
4022
# their own config files (or not) and will also address
4023
# http://pad.lv/788991 -- vila 20101115
4024
commands.Option('scope', help='Reduce the scope to the specified'
4025
' configuration file.',
4027
commands.Option('all',
4028
help='Display all the defined values for the matching options.',
4030
commands.Option('remove', help='Remove the option from'
4031
' the configuration file.'),
4034
_see_also = ['configuration']
4036
@commands.display_command
4037
def run(self, name=None, all=False, directory=None, scope=None,
4039
if directory is None:
4041
directory = urlutils.normalize_url(directory)
4043
raise errors.BzrError(
4044
'--all and --remove are mutually exclusive.')
4046
# Delete the option in the given scope
4047
self._remove_config_option(name, directory, scope)
4049
# Defaults to all options
4050
self._show_matching_options('.*', directory, scope)
4053
name, value = name.split('=', 1)
4055
# Display the option(s) value(s)
4057
self._show_matching_options(name, directory, scope)
4059
self._show_value(name, directory, scope)
4062
raise errors.BzrError(
4063
'Only one option can be set.')
4064
# Set the option value
4065
self._set_config_option(name, value, directory, scope)
4067
def _get_stack(self, directory, scope=None):
4068
"""Get the configuration stack specified by ``directory`` and ``scope``.
4070
:param directory: Where the configurations are derived from.
4072
:param scope: A specific config to start from.
4074
# FIXME: scope should allow access to plugin-specific stacks (even
4075
# reduced to the plugin-specific store), related to
4076
# http://pad.lv/788991 -- vila 2011-11-15
4077
if scope is not None:
4078
if scope == 'bazaar':
4079
return GlobalStack()
4080
elif scope == 'locations':
4081
return LocationStack(directory)
4082
elif scope == 'branch':
4084
controldir.ControlDir.open_containing_tree_or_branch(
4086
return br.get_config_stack()
4087
raise errors.NoSuchConfig(scope)
4091
controldir.ControlDir.open_containing_tree_or_branch(
4093
return br.get_config_stack()
4094
except errors.NotBranchError:
4095
return LocationStack(directory)
4097
def _show_value(self, name, directory, scope):
4098
conf = self._get_stack(directory, scope)
4099
value = conf.get(name, expand=True)
4100
if value is not None:
4101
# Quote the value appropriately
4102
value = _quoting_config._quote(value)
4103
self.outf.write('%s\n' % (value,))
4105
raise errors.NoSuchConfigOption(name)
4107
def _show_matching_options(self, name, directory, scope):
4108
name = lazy_regex.lazy_compile(name)
4109
# We want any error in the regexp to be raised *now* so we need to
4110
# avoid the delay introduced by the lazy regexp. But, we still do
4111
# want the nicer errors raised by lazy_regex.
4112
name._compile_and_collapse()
4115
conf = self._get_stack(directory, scope)
4116
for sections in conf.sections_def:
4117
for store, section in sections():
4118
for oname in section.iter_option_names():
4119
if name.search(oname):
4120
if cur_store_id != store.id:
4121
# Explain where the options are defined
4122
self.outf.write('%s:\n' % (store.id,))
4123
cur_store_id = store.id
4125
if (section.id is not None
4126
and cur_section != section.id):
4127
# Display the section id as it appears in the store
4128
# (None doesn't appear by definition)
4129
self.outf.write(' [%s]\n' % (section.id,))
4130
cur_section = section.id
4131
value = section.get(oname, expand=False)
4132
# Since we don't use the stack, we need to restore a
4135
opt = option_registry.get(oname)
4136
value = opt.convert_from_unicode(store, value)
4138
value = store.unquote(value)
4139
value = _quoting_config._quote(value)
4140
self.outf.write(' %s = %s\n' % (oname, value))
4142
def _set_config_option(self, name, value, directory, scope):
4143
conf = self._get_stack(directory, scope)
4144
conf.set(name, value)
4146
def _remove_config_option(self, name, directory, scope):
4148
raise errors.BzrCommandError(
4149
'--remove expects an option to remove.')
4150
conf = self._get_stack(directory, scope)
4154
raise errors.NoSuchConfigOption(name)
4159
# We need adapters that can build a Store or a Stack in a test context. Test
4160
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4161
# themselves. The builder will receive a test instance and should return a
4162
# ready-to-use store or stack. Plugins that define new store/stacks can also
4163
# register themselves here to be tested against the tests defined in
4164
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4165
# for the same test.
4167
# The registered object should be a callable receiving a test instance
4168
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4170
test_store_builder_registry = registry.Registry()
4172
# The registered object should be a callable receiving a test instance
4173
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4175
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
